Magic-Mirror/radare2
1
0
Fork 0
mirror of https://github.com/radareorg/radare2.git synced 2024-12-11 15:04:23 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity
2b783319e8
radare2/libr/include/r_debug.h
Ren Kimura 863e3566d2 Add snap_set command (#7032)
2017-03-16 10:09:17 +01:00

541 lines
16 KiB
C
Executable File
Raw Blame History

#ifndef R2_DEBUG_H
#define R2_DEBUG_H
#include <r_types.h>
#include <r_anal.h>
#include <r_cons.h>
#include <r_util.h>
#include <r_reg.h>
#include <r_bp.h>
#include <r_io.h>
#include <r_syscall.h>
#include <r_config.h>
#include "r_bind.h"
#ifdef __cplusplus
extern "C" {
#endif
R_LIB_VERSION_HEADER(r_debug);
/* hack to fix compilation of debugger on BSD systems */
/* This needs some testing (netbsd, freebsd, openbsd, kfreebsd) */
#if __BSD__
#include <machine/reg.h>
/* hakish hack to hack the openbsd/sparc64 hack */
#undef reg
#undef fpreg
#undef fpstate
#undef trapframe
#undef rwindow
#define PTRACE_PEEKTEXT PT_READ_I
#define PTRACE_POKETEXT PT_WRITE_I
#define PTRACE_PEEKDATA PT_READ_D
#define PTRACE_POKEDATA PT_WRITE_D
#define PTRACE_ATTACH PT_ATTACH
#define PTRACE_DETACH PT_DETACH
#define PTRACE_SINGLESTEP PT_STEP
#define PTRACE_CONT PT_CONTINUE
#define PTRACE_GETREGS PT_GETREGS
#define PTRACE_SETREGS PT_SETREGS
#define PTRACE_SYSCALL PT_STEP
#endif
/*
* states that a process can be in
*/
typedef enum {
R_DBG_PROC_STOP = 's',
R_DBG_PROC_RUN = 'r',
R_DBG_PROC_SLEEP = 'S',
R_DBG_PROC_ZOMBIE = 'z',
R_DBG_PROC_DEAD = 'd',
R_DBG_PROC_RAISED = 'R' // has produced a signal, breakpoint, etc..
} RDebugPidState;
// signal handling must support application and debugger level options
typedef enum {
R_DBG_SIGNAL_IGNORE = 0, // ignore signal handler
R_DBG_SIGNAL_CONT = 1, // pass signal to chlidren and continue execution
R_DBG_SIGNAL_SKIP = 2, //
//..
} RDebugSignalMode;
/*
* when a user wants to resume from a breakpoint, we need to know how they want
* to proceed. these values indicate their intention.
*/
typedef enum {
R_DBG_RECOIL_NONE = 0,
R_DBG_RECOIL_STEP,
R_DBG_RECOIL_CONTINUE
} RDebugRecoilMode;
/*
* List of reasons that an inferior might have stopped
*/
typedef enum {
R_DEBUG_REASON_DEAD = -1,
R_DEBUG_REASON_NONE = 0,
R_DEBUG_REASON_SIGNAL,
R_DEBUG_REASON_SEGFAULT,
R_DEBUG_REASON_BREAKPOINT,
R_DEBUG_REASON_TRACEPOINT,
R_DEBUG_REASON_COND,
R_DEBUG_REASON_READERR,
R_DEBUG_REASON_STEP,
R_DEBUG_REASON_ABORT,
R_DEBUG_REASON_WRITERR,
R_DEBUG_REASON_DIVBYZERO,
R_DEBUG_REASON_ILLEGAL,
R_DEBUG_REASON_UNKNOWN,
R_DEBUG_REASON_ERROR,
R_DEBUG_REASON_NEW_PID,
R_DEBUG_REASON_NEW_TID,
R_DEBUG_REASON_NEW_LIB,
R_DEBUG_REASON_EXIT_PID,
R_DEBUG_REASON_EXIT_TID,
R_DEBUG_REASON_EXIT_LIB,
R_DEBUG_REASON_TRAP,
R_DEBUG_REASON_SWI,
R_DEBUG_REASON_INT,
R_DEBUG_REASON_FPU,
} RDebugReasonType;
/* TODO: move to r_anal */
typedef struct r_debug_frame_t {
ut64 addr;
int size;
ut64 sp;
ut64 bp;
} RDebugFrame;
typedef struct r_debug_reason_t {
int /*RDebugReasonType*/ type;
int tid;
int signum;
ut64 bp_addr;
ut64 timestamp;
ut64 addr;
ut64 ptr;
} RDebugReason;
typedef struct r_debug_map_t {
char *name;
ut64 addr;
ut64 addr_end;
ut64 size;
ut64 offset;
char *file;
int perm;
int user;
bool shared;
} RDebugMap;
typedef struct r_debug_signal_t {
int type;
int num;
ut64 handler;
} RDebugSignal;
typedef struct r_debug_desc_t {
int fd;
char *path;
int perm;
int type;
ut64 off;
} RDebugDesc;
typedef struct r_debug_snap_t {
ut64 addr;
ut64 addr_end;
ut8 *data;
ut32 size;
ut64 timestamp;
ut32 crc;
char *comment;
} RDebugSnap;
typedef struct r_debug_trace_t {
RList *traces;
int count;
int enabled;
//int changed;
int tag;
int dup;
char *addresses;
// TODO: add range here
Sdb *db;
} RDebugTrace;
typedef struct r_debug_tracepoint_t {
ut64 addr;
ut64 tags; // XXX
int tag; // XXX
int size;
int count;
int times;
ut64 stamp;
} RDebugTracepoint;
typedef struct r_debug_t {
char *arch;
int bits; /// XXX: MUST SET ///
int hitinfo;
int main_pid;
int pid; /* selected process id */
int tid; /* selected thread id */
int forked_pid; /* last pid created by fork */
RList *threads; /* NOTE: list contents are platform-specific */
/* dbg.* config options (see e?dbg)
* NOTE: some settings are checked inline instead of tracked here.
*/
int bpsize; /* size of a breakpoint */
char *btalgo; /* select backtrace algorithm */
int btdepth; /* backtrace depth */
int regcols; /* display columns */
int swstep; /* steps with software traps */
int stop_all_threads; /* stop all threads at any stop */
int trace_forks; /* stop on new children */
int trace_execs; /* stop on new execs */
int trace_aftersyscall; /* stop after the syscall (before if disabled) */
int trace_clone; /* stop on new threads */
int follow_child; /* On fork, trace the child */
char *glob_libs; /* stop on lib load */
char *glob_unlibs; /* stop on lib unload */
bool consbreak; /* SIGINT handle for attached processes */
/* tracking debugger state */
int steps; /* counter of steps done */
RDebugReason reason; /* stop reason */
RDebugRecoilMode recoil_mode; /* what did the user want to do? */
/* tracing vars */
RDebugTrace *trace;
Sdb *tracenodes;
RTree *tree;
RReg *reg;
const char *creg; // current register value
RBreakpoint *bp;
void *user; // XXX(jjd): unused?? meant for caller's use??
/* io */
PrintfCallback cb_printf;
RIOBind iob;
struct r_debug_plugin_t *h;
RList *plugins;
RAnal *anal;
RList *maps; // <RDebugMap>
RList *maps_user; // <RDebugMap>
RList *snaps; // <RDebugSnap>
Sdb *sgnls;
RCoreBind corebind;
// internal use only
int _mode;
RNum *num;
} RDebug;
typedef struct r_debug_desc_plugin_t {
int (*open)(const char *path);
int (*close)(int fd);
int (*read)(int fd, ut64 addr, int len);
int (*write)(int fd, ut64 addr, int len);
int (*seek)(int fd, ut64 addr);
int (*dup)(int fd, int newfd);
RList* (*list)(int pid);
} RDebugDescPlugin;
typedef struct r_debug_info_t {
int pid;
int tid;
int uid;
int gid;
char *exe;
char *cmdline;
char *libname;
char *cwd;
int status; // zombie, running, sleeping, ...
int signum;
void * lib;
void * thread;
char *kernel_stack;
// retrieve mem/fd/core limits?
// list of threads ? hasthreads? counter?
// environment?
// /proc/pid/syscall ???
} RDebugInfo;
/* TODO: pass dbg and user data pointer everywhere */
typedef struct r_debug_plugin_t {
const char *name;
const char *license;
const char *author;
const char *version;
//const char **archs; // MUST BE DEPREACTED!!!!
ut32 bits;
const char *arch;
int canstep;
int keepio;
/* life */
RDebugInfo* (*info)(RDebug *dbg, const char *arg);
int (*startv)(int argc, char **argv);
int (*attach)(RDebug *dbg, int pid);
int (*detach)(RDebug *dbg, int pid);
int (*select)(int pid, int tid);
RList *(*threads)(RDebug *dbg, int pid);
RList *(*pids)(RDebug *dbg, int pid);
RList *(*tids)(RDebug *dbg, int pid);
RFList (*backtrace)(RDebug *dbg, int count);
/* flow */
int (*stop)(RDebug *dbg);
int (*step)(RDebug *dbg);
int (*step_over)(RDebug *dbg);
int (*cont)(RDebug *dbg, int pid, int tid, int sig);
int (*wait)(RDebug *dbg, int pid);
bool (*gcore)(RDebug *dbg, RBuffer *dest);
int (*kill)(RDebug *dbg, int pid, int tid, int sig);
RList* (*kill_list)(RDebug *dbg);
int (*contsc)(RDebug *dbg, int pid, int sc);
RList* (*frames)(RDebug *dbg, ut64 at);
RBreakpointCallback breakpoint;
// XXX: specify, pid, tid, or RDebug ?
int (*reg_read)(RDebug *dbg, int type, ut8 *buf, int size);
int (*reg_write)(RDebug *dbg, int type, const ut8 *buf, int size); //XXX struct r_regset_t regs);
char* (*reg_profile)(RDebug *dbg);
/* memory */
RList *(*map_get)(RDebug *dbg);
RList *(*modules_get)(RDebug *dbg);
RDebugMap* (*map_alloc)(RDebug *dbg, ut64 addr, int size);
int (*map_dealloc)(RDebug *dbg, ut64 addr, int size);
int (*map_protect)(RDebug *dbg, ut64 addr, int size, int perms);
int (*init)(RDebug *dbg);
int (*drx)(RDebug *dbg, int n, ut64 addr, int size, int rwx, int g);
RDebugDescPlugin desc;
// TODO: use RList here
} RDebugPlugin;
// TODO: rename to r_debug_process_t ? maybe a thread too ?
typedef struct r_debug_pid_t {
int pid;
char status; /* stopped, running, zombie, sleeping ,... */
int runnable; /* when using 'run', 'continue', .. this proc will be runnable */
bool signalled;
char *path;
int uid;
int gid;
ut64 pc;
} RDebugPid;
/*
* Radare's debugger has both an external and internal API.
*
* TODO(jjd): reconcile external API and extend it for better funcitonality
* when using R2 as a library.
*/
#ifdef R_API
R_API RDebug *r_debug_new(int hard);
R_API RDebug *r_debug_free(RDebug *dbg);
R_API int r_debug_attach(RDebug *dbg, int pid);
R_API int r_debug_detach(RDebug *dbg, int pid);
R_API int r_debug_startv(RDebug *dbg, int argc, char **argv);
R_API int r_debug_start(RDebug *dbg, const char *cmd);
/* reason we stopped */
R_API RDebugReasonType r_debug_stop_reason(RDebug *dbg);
R_API const char *r_debug_reason_to_string(int type);
/* wait for another event */
R_API RDebugReasonType r_debug_wait(RDebug *dbg, RBreakpointItem **bp);
/* continuations */
R_API int r_debug_step(RDebug *dbg, int steps);
R_API int r_debug_step_over(RDebug *dbg, int steps);
R_API int r_debug_continue_until(RDebug *dbg, ut64 addr);
R_API int r_debug_continue_until_optype(RDebug *dbg, int type, int over);
R_API int r_debug_continue_until_nontraced(RDebug *dbg);
R_API int r_debug_continue_syscall(RDebug *dbg, int sc);
R_API int r_debug_continue_syscalls(RDebug *dbg, int *sc, int n_sc);
R_API int r_debug_continue(RDebug *dbg);
R_API int r_debug_continue_kill(RDebug *dbg, int signal);
#if __WINDOWS__ && !__CYGWIN__
R_API int r_debug_continue_pass_exception(RDebug *dbg);
#endif
/* process/thread handling */
R_API int r_debug_select(RDebug *dbg, int pid, int tid);
//R_API int r_debug_pid_add(RDebug *dbg);
//R_API int r_debug_pid_add_thread(RDebug *dbg);
//R_API int r_debug_pid_del(RDebug *dbg);
//R_API int r_debug_pid_del_thread(RDebug *dbg);
R_API int r_debug_pid_list(RDebug *dbg, int pid, char fmt);
R_API RDebugPid *r_debug_pid_new(const char *path, int pid, char status, ut64 pc);
R_API RDebugPid *r_debug_pid_free(RDebugPid *pid);
R_API RList *r_debug_pids(RDebug *dbg, int pid);
R_API bool r_debug_set_arch(RDebug *dbg, const char *arch, int bits);
R_API bool r_debug_use(RDebug *dbg, const char *str);
R_API RDebugInfo *r_debug_info(RDebug *dbg, const char *arg);
R_API void r_debug_info_free (RDebugInfo *rdi);
/* send signals */
R_API void r_debug_signal_init(RDebug *dbg);
R_API int r_debug_signal_send(RDebug *dbg, int num);
R_API int r_debug_signal_what(RDebug *dbg, int num);
R_API int r_debug_signal_resolve(RDebug *dbg, const char *signame);
R_API const char *r_debug_signal_resolve_i(RDebug *dbg, int signum);
R_API void r_debug_signal_setup(RDebug *dbg, int num, int opt);
R_API int r_debug_signal_set(RDebug *dbg, int num, ut64 addr);
R_API void r_debug_signal_list(RDebug *dbg, int mode);
R_API int r_debug_kill(RDebug *dbg, int pid, int tid, int sig);
R_API RList *r_debug_kill_list(RDebug *dbg);
// XXX: must be uint64 action
R_API int r_debug_kill_setup(RDebug *dbg, int sig, int action);
/* handle.c */
R_API void r_debug_plugin_init(RDebug *dbg);
R_API int r_debug_plugin_set(RDebug *dbg, const char *str);
R_API int r_debug_plugin_list(RDebug *dbg, int mode);
R_API bool r_debug_plugin_add(RDebug *dbg, RDebugPlugin *foo);
/* memory */
R_API RList *r_debug_modules_list(RDebug*);
R_API RDebugMap *r_debug_map_alloc(RDebug *dbg, ut64 addr, int size);
R_API int r_debug_map_dealloc(RDebug *dbg, RDebugMap *map);
R_API RList *r_debug_map_list_new(void);
R_API RDebugMap *r_debug_map_get(RDebug *dbg, ut64 addr);
R_API RDebugMap *r_debug_map_new (char *name, ut64 addr, ut64 addr_end, int perm, int user);
R_API void r_debug_map_free(RDebugMap *map);
R_API void r_debug_map_list(RDebug *dbg, ut64 addr, int rad);
R_API void r_debug_map_list_visual(RDebug *dbg, ut64 addr, int use_color, int cons_cols);
/* descriptors */
R_API RDebugDesc *r_debug_desc_new (int fd, char* path, int perm, int type, int off);
R_API void r_debug_desc_free (RDebugDesc *p);
R_API int r_debug_desc_open(RDebug *dbg, const char *path);
R_API int r_debug_desc_close(RDebug *dbg, int fd);
R_API int r_debug_desc_dup(RDebug *dbg, int fd, int newfd);
R_API int r_debug_desc_read(RDebug *dbg, int fd, ut64 addr, int len);
R_API int r_debug_desc_seek(RDebug *dbg, int fd, ut64 addr); // TODO: whence?
R_API int r_debug_desc_write(RDebug *dbg, int fd, ut64 addr, int len);
R_API int r_debug_desc_list(RDebug *dbg, int rad);
/* registers */
R_API int r_debug_reg_sync(RDebug *dbg, int type, int write);
R_API int r_debug_reg_list(RDebug *dbg, int type, int size, int rad, const char *use_color);
R_API int r_debug_reg_set(RDebug *dbg, const char *name, ut64 num);
R_API ut64 r_debug_reg_get(RDebug *dbg, const char *name);
R_API ut64 r_debug_reg_get_err(RDebug *dbg, const char *name, int *err, utX *value);
R_API void r_debug_io_bind(RDebug *dbg, RIO *io);
R_API ut64 r_debug_execute(RDebug *dbg, const ut8 *buf, int len, int restore);
R_API int r_debug_map_sync(RDebug *dbg);
R_API int r_debug_stop(RDebug *dbg);
/* backtrace */
R_API RList *r_debug_frames(RDebug *dbg, ut64 at);
R_API int r_debug_is_dead(RDebug *dbg);
R_API int r_debug_map_protect(RDebug *dbg, ut64 addr, int size, int perms);
/* args XXX: weird food */
R_API ut64 r_debug_arg_get(RDebug *dbg, int fast, int num);
R_API bool r_debug_arg_set(RDebug *dbg, int fast, int num, ut64 value);
/* breakpoints (most in r_bp, this calls those) */
R_API RBreakpointItem *r_debug_bp_add(RDebug *dbg, ut64 addr, int hw, char *module, st64 m_delta);
/* pid */
R_API int r_debug_thread_list(RDebug *dbg, int pid);
R_API void r_debug_tracenodes_reset(RDebug *dbg);
R_API void r_debug_trace_reset(RDebug *dbg);
R_API int r_debug_trace_pc(RDebug *dbg, ut64 pc);
R_API void r_debug_trace_at(RDebug *dbg, const char *str);
R_API RDebugTracepoint *r_debug_trace_get(RDebug *dbg, ut64 addr);
R_API void r_debug_trace_list(RDebug *dbg, int mode);
R_API RDebugTracepoint *r_debug_trace_add(RDebug *dbg, ut64 addr, int size);
R_API RDebugTrace *r_debug_trace_new(void);
R_API void r_debug_trace_free(RDebugTrace *dbg);
R_API int r_debug_trace_tag(RDebug *dbg, int tag);
R_API int r_debug_child_fork(RDebug *dbg);
R_API int r_debug_child_clone(RDebug *dbg);
R_API void r_debug_drx_list(RDebug *dbg);
R_API int r_debug_drx_set(RDebug *dbg, int idx, ut64 addr, int len, int rwx, int g);
R_API int r_debug_drx_unset(RDebug *dbg, int idx);
/* esil */
R_API ut64 r_debug_num_callback(RNum *userptr, const char *str, int *ok);
R_API int r_debug_esil_stepi(RDebug *dbg);
R_API ut64 r_debug_esil_step(RDebug *dbg, ut32 count);
R_API ut64 r_debug_esil_continue(RDebug *dbg);
R_API void r_debug_esil_watch(RDebug *dbg, int rwx, int dev, const char *expr);
R_API void r_debug_esil_watch_reset(RDebug *dbg);
R_API void r_debug_esil_watch_list(RDebug *dbg);
R_API int r_debug_esil_watch_empty(RDebug *dbg);
R_API void r_debug_esil_prestep (RDebug *d, int p);
/* snap */
R_API void r_debug_snap_free(void *snap);
R_API int r_debug_snap_delete(RDebug *dbg, int idx);
R_API void r_debug_snap_list(RDebug *dbg, int idx, int mode);
R_API int r_debug_snap_diff(RDebug *dbg, int idx);
R_API int r_debug_snap(RDebug *dbg, ut64 addr);
R_API int r_debug_snap_comment (RDebug *dbg, int idx, const char *msg);
R_API int r_debug_snap_all(RDebug *dbg, int perms);
R_API RDebugSnap* r_debug_snap_get (RDebug *dbg, ut64 addr);
R_API int r_debug_snap_set (RDebug *dbg, int idx);
/* plugin pointers */
extern RDebugPlugin r_debug_plugin_native;
extern RDebugPlugin r_debug_plugin_esil;
extern RDebugPlugin r_debug_plugin_rap;
extern RDebugPlugin r_debug_plugin_gdb;
extern RDebugPlugin r_debug_plugin_bf;
extern RDebugPlugin r_debug_plugin_io;
extern RDebugPlugin r_debug_plugin_wind;
extern RDebugPlugin r_debug_plugin_bochs;
extern RDebugPlugin r_debug_plugin_qnx;
#endif
#ifdef __cplusplus
}
#endif
#endif
/* regset */
//R_API struct r_regset_t* r_regset_diff(struct r_regset_t *a, struct r_regset_t *b);
//R_API int r_regset_set(struct r_regset_t *r, int idx, const char *name, ut64 value);
//R_API struct r_regset_t *r_regset_new(int size);
//R_API void r_regset_free(struct r_regset_t *r);
#if 0
Missing callbacks
=================
- alloc
- dealloc
- list maps (memory regions)
- change memory protections
- touchtrace
- filedescriptor set/get/mod..
- get/set signals
- get regs, set regs
#endif
Reference in New Issue View Git Blame Copy Permalink