#ifndef R2_ANAL_OP_H #define R2_ANAL_OP_H #include #include #include #include #ifdef __cplusplus extern "C" { #endif typedef enum { R_ANAL_OP_PREFIX_COND = 1, R_ANAL_OP_PREFIX_REP = 1<<1, R_ANAL_OP_PREFIX_REPNE = 1<<2, R_ANAL_OP_PREFIX_LOCK = 1<<3, R_ANAL_OP_PREFIX_LIKELY = 1<<4, R_ANAL_OP_PREFIX_UNLIKELY = 1<<5 /* TODO: add segment override typemods? */ } RAnalOpPrefix; typedef enum { R_ANAL_STACK_NULL = 0, R_ANAL_STACK_NOP, R_ANAL_STACK_INC, R_ANAL_STACK_GET, R_ANAL_STACK_SET, R_ANAL_STACK_RESET, R_ANAL_STACK_ALIGN, } RAnalStackOp; typedef enum { R_ANAL_OP_DIR_READ = 1, R_ANAL_OP_DIR_WRITE = 2, R_ANAL_OP_DIR_EXEC = 4, R_ANAL_OP_DIR_REF = 8, // uhm? R_ANAL_OP_DIR_RW = R_ANAL_OP_DIR_READ | R_ANAL_OP_DIR_WRITE, } RAnalOpDirection; typedef enum { R_ANAL_OP_FAMILY_UNKNOWN = -1, R_ANAL_OP_FAMILY_CPU = 0, /* normal cpu instruction */ R_ANAL_OP_FAMILY_FPU, /* fpu (floating point) */ R_ANAL_OP_FAMILY_VEC, /* vector instruction (packed data) */ R_ANAL_OP_FAMILY_PRIV, /* privileged instruction */ R_ANAL_OP_FAMILY_CRYPTO, /* cryptographic instructions */ R_ANAL_OP_FAMILY_THREAD, /* thread/lock/sync instructions */ R_ANAL_OP_FAMILY_VIRT, /* virtualization instructions */ R_ANAL_OP_FAMILY_SECURITY, /* security instructions */ R_ANAL_OP_FAMILY_IO, /* IO instructions (i.e. IN/OUT) */ R_ANAL_OP_FAMILY_SIMD, /* SIMD instructions */ R_ANAL_OP_FAMILY_LAST } RAnalOpFamily; R_VEC_TYPE (RVecRArchValue, RArchValue); #if 0 On x86 according to Wikipedia Prefix group 1 0xF0: LOCK prefix 0xF2: REPNE/REPNZ prefix 0xF3: REP or REPE/REPZ prefix Prefix group 2 0x2E: CS segment override 0x36: SS segment override 0x3E: DS segment override 0x26: ES segment override 0x64: FS segment override 0x65: GS segment override 0x2E: Branch not taken (hinting) 0x3E: Branch taken Prefix group 3 0x66: Operand-size override prefix Prefix group 4 0x67: Address-size override prefix #endif #define R_ANAL_OP_TYPE_MASK 0x8000ffff #define R_ANAL_OP_MOD_MASK 0x8000ffff #define R_ANAL_OP_HINT_MASK 0xf0000000 typedef enum { // R2_600 - DEPRECATE R_ANAL_OP_TYPE_COND = 0x80000000, // TODO must be moved to prefix? // should not be TYPE those are modifiers! R_ANAL_OP_TYPE_REP = 0x40000000, /* repeats next instruction N times */ R_ANAL_OP_TYPE_MEM = 0x20000000, // TODO must be moved to prefix? R_ANAL_OP_TYPE_REG = 0x10000000, // operand is a register R_ANAL_OP_TYPE_IND = 0x08000000, // operand is indirect R_ANAL_OP_TYPE_NULL = 0, // this is like unknown, but acts like a nop. aka undefined type. rename? #if 1 R_ARCH_OP_MOD_COND = 0x80000000, // conditional instruction R_ARCH_OP_MOD_REP = 0x40000000, // repeats instruction N times R_ARCH_OP_MOD_MEM = 0x20000000, // requires memory access R_ARCH_OP_MOD_REG = 0x10000000, // operand is a register R_ARCH_OP_MOD_IND = 0x08000000, // operand is indirect #endif R_ANAL_OP_TYPE_JMP = 1, /* mandatory jump */ R_ANAL_OP_TYPE_UJMP = 2, /* unknown jump (register or so) */ R_ANAL_OP_TYPE_RJMP = R_ANAL_OP_TYPE_UJMP| R_ANAL_OP_TYPE_REG, R_ANAL_OP_TYPE_UCJMP = R_ANAL_OP_TYPE_UJMP | R_ANAL_OP_TYPE_COND, /* conditional unknown jump */ R_ANAL_OP_TYPE_IJMP = R_ANAL_OP_TYPE_UJMP | R_ANAL_OP_TYPE_IND, R_ANAL_OP_TYPE_IRJMP = R_ANAL_OP_TYPE_UJMP | R_ANAL_OP_TYPE_REG | R_ANAL_OP_TYPE_IND, R_ANAL_OP_TYPE_CJMP = R_ANAL_OP_TYPE_JMP | R_ANAL_OP_TYPE_COND, /* conditional jump */ R_ANAL_OP_TYPE_MJMP = R_ANAL_OP_TYPE_JMP | R_ANAL_OP_TYPE_MEM, /* memory jump */ R_ANAL_OP_TYPE_RCJMP = R_ANAL_OP_TYPE_CJMP | R_ANAL_OP_TYPE_REG, /* conditional jump register */ R_ANAL_OP_TYPE_MCJMP = R_ANAL_OP_TYPE_CJMP | R_ANAL_OP_TYPE_MEM, /* memory conditional jump */ R_ANAL_OP_TYPE_CALL = 3, /* call to subroutine (branch+link) */ R_ANAL_OP_TYPE_UCALL = 4, /* unknown call (register or so) */ R_ANAL_OP_TYPE_RCALL = R_ANAL_OP_TYPE_UCALL | R_ANAL_OP_TYPE_REG, R_ANAL_OP_TYPE_ICALL = R_ANAL_OP_TYPE_UCALL | R_ANAL_OP_TYPE_IND, R_ANAL_OP_TYPE_IRCALL= R_ANAL_OP_TYPE_UCALL | R_ANAL_OP_TYPE_REG | R_ANAL_OP_TYPE_IND, R_ANAL_OP_TYPE_CCALL = R_ANAL_OP_TYPE_CALL | R_ANAL_OP_TYPE_COND, /* conditional call to subroutine */ R_ANAL_OP_TYPE_UCCALL= R_ANAL_OP_TYPE_UCALL | R_ANAL_OP_TYPE_COND, /* conditional unknown call */ R_ANAL_OP_TYPE_RET = 5, /* returns from subroutine */ R_ANAL_OP_TYPE_CRET = R_ANAL_OP_TYPE_COND | R_ANAL_OP_TYPE_RET, /* conditional return from subroutine */ R_ANAL_OP_TYPE_ILL = 6, /* illegal instruction // trap */ R_ANAL_OP_TYPE_UNK = 7, /* unknown opcode type */ R_ANAL_OP_TYPE_NOP = 8, /* does nothing */ R_ANAL_OP_TYPE_MOV = 9, /* move immediate into register */ R_ANAL_OP_TYPE_RMOV = 9 | R_ANAL_OP_TYPE_REG, /* register move */ R_ANAL_OP_TYPE_CMOV = 9 | R_ANAL_OP_TYPE_COND, /* conditional move */ R_ANAL_OP_TYPE_TRAP = 10, /* it's a trap! */ R_ANAL_OP_TYPE_SWI = 11, /* syscall, software interrupt */ R_ANAL_OP_TYPE_CSWI = 11 | R_ANAL_OP_TYPE_COND, /* syscall, software interrupt */ R_ANAL_OP_TYPE_UPUSH = 12, /* unknown push of data into stack */ R_ANAL_OP_TYPE_RPUSH = R_ANAL_OP_TYPE_UPUSH | R_ANAL_OP_TYPE_REG, /* push register */ R_ANAL_OP_TYPE_PUSH = 13, /* push value into stack */ R_ANAL_OP_TYPE_POP = 14, /* pop value from stack to register */ R_ANAL_OP_TYPE_CMP = 15, /* compare something */ R_ANAL_OP_TYPE_ACMP = 16, /* compare via and */ R_ANAL_OP_TYPE_ADD = 17, R_ANAL_OP_TYPE_SUB = 18, R_ANAL_OP_TYPE_IO = 19, R_ANAL_OP_TYPE_MUL = 20, R_ANAL_OP_TYPE_DIV = 21, R_ANAL_OP_TYPE_SHR = 22, R_ANAL_OP_TYPE_SHL = 23, R_ANAL_OP_TYPE_SAL = 24, R_ANAL_OP_TYPE_SAR = 25, R_ANAL_OP_TYPE_OR = 26, R_ANAL_OP_TYPE_AND = 27, R_ANAL_OP_TYPE_XOR = 28, R_ANAL_OP_TYPE_NOR = 29, R_ANAL_OP_TYPE_NOT = 30, R_ANAL_OP_TYPE_STORE = 31, /* store from register to memory */ R_ANAL_OP_TYPE_LOAD = 32, /* load from memory to register */ R_ANAL_OP_TYPE_LEA = 33, /* like mov, but using memory addresspace */ R_ANAL_OP_TYPE_ULEA = 33 | R_ARCH_OP_MOD_REG, // destination cant be computed without emulation R_ANAL_OP_TYPE_LEAVE = 34, R_ANAL_OP_TYPE_ROR = 35, R_ANAL_OP_TYPE_ROL = 36, R_ANAL_OP_TYPE_XCHG = 37, R_ANAL_OP_TYPE_MOD = 38, R_ANAL_OP_TYPE_SWITCH = 39, R_ANAL_OP_TYPE_CASE = 40, R_ANAL_OP_TYPE_LENGTH = 41, R_ANAL_OP_TYPE_CAST = 42, R_ANAL_OP_TYPE_NEW = 43, R_ANAL_OP_TYPE_ABS = 44, R_ANAL_OP_TYPE_CPL = 45, /* complement */ R_ANAL_OP_TYPE_CRYPTO = 46, R_ANAL_OP_TYPE_SYNC = 47, R_ANAL_OP_TYPE_DEBUG = 48, // monitor/trace/breakpoint } _RAnalOpType; /* TODO: what to do with signed/unsigned conditionals? */ typedef enum { R_ANAL_CONDTYPE_AL = 0, // Always executed (no condition) R_ANAL_CONDTYPE_EQ, // Equal R_ANAL_CONDTYPE_NE, // Not equal R_ANAL_CONDTYPE_GE, // Greater or equal R_ANAL_CONDTYPE_GT, // Greater than R_ANAL_CONDTYPE_LE, // Less or equal R_ANAL_CONDTYPE_LT, // Less than R_ANAL_CONDTYPE_NV, // Never executed must be a nop? :D R_ANAL_CONDTYPE_HS, // Carry set >, ==, or unordered R_ANAL_CONDTYPE_LO, // Carry clear Less than R_ANAL_CONDTYPE_MI, // Minus, negative Less than R_ANAL_CONDTYPE_PL, // Plus, positive or zero >, ==, or unordered R_ANAL_CONDTYPE_VS, // Overflow Unordered R_ANAL_CONDTYPE_VC, // No overflow Not unordered R_ANAL_CONDTYPE_HI, // Unsigned higher Greater than, or unordered R_ANAL_CONDTYPE_LS, // Unsigned lower or same Less than or equal R_ANAL_CONDTYPE_LAST, // Amount of elements of the enum R_ANAL_CONDTYPE_ERR = -1 // Invalid type } RAnalCondType; enum { R_ANAL_RET_NOP = 0, R_ANAL_RET_ERROR = -1, R_ANAL_RET_DUP = -2, R_ANAL_RET_NEW = -3, R_ANAL_RET_END = -4 }; typedef struct r_anal_case_op_t { ut64 addr; ut64 jump; ut64 value; } RAnalCaseOp; // TODO: rename to RAnalSwitchCase // Flags describing how a jump table should be decoded. // Mirrors IDA's SWI_* family. See SW.md for the matching IDA constants. typedef enum { R_ANAL_SWITCH_F_SIGNED = 1 << 0, // sign-extend table entries R_ANAL_SWITCH_F_SUBTRACT = 1 << 1, // target = base - elem (vs base + elem) R_ANAL_SWITCH_F_INSN = 1 << 2, // entry IS the branch instruction R_ANAL_SWITCH_F_SELFREL = 1 << 3, // target = entry_addr + (signed) elem R_ANAL_SWITCH_F_INDIRECT = 1 << 4, // 2-stage: idx = vtbl[input]; target = jtbl[idx] R_ANAL_SWITCH_F_SPARSE = 1 << 5, // value table holds case keys (parallel arrays) R_ANAL_SWITCH_F_INVERSE = 1 << 6, // table walked in reverse R_ANAL_SWITCH_F_DEFINTBL = 1 << 7, // first/last entry is the default case R_ANAL_SWITCH_F_USER = 1 << 8, // pinned by the user, do not auto-overwrite R_ANAL_SWITCH_F_BASE = 1 << 9, // base is explicit (else defaults to jtbl_addr) } RAnalSwitchFlags; #define R_ANAL_SWITCH_MAXCASES 512 #define R_ANAL_SWITCH_OP_DEPS 8 // Declarative description of a switch/jump-table to analyse or render. // Used as the input of r_anal_switch_apply(). typedef struct r_anal_switch_spec_t { ut64 startea; // address of the dispatching insn ut64 jtbl_addr; // jump table base address ut64 vtbl_addr; // value/index table base (INDIRECT or SPARSE) ut64 base; // element base (added/subtracted from each entry) ut64 defjump; // default target, UT64_MAX = unknown ut32 ncases; // 0 = autodetect from cmpval ut8 esize; // jtbl entry size 1/2/4/8 ut8 vsize; // vtbl entry size 1/2/4 ut8 shift; // 0..3 st64 lowcase; // first input value (replaces start_casenum_shift) const char *reg; // borrowed input register name, NULL if unknown ut32 flags; // RAnalSwitchFlags bitfield } RAnalSwitchSpec; typedef struct r_anal_switch_op_t { ut64 addr; // address of the dispatching jump ut64 baddr; // element base value (when R_ANAL_SWITCH_F_BASE is set) ut64 daddr; // jump table base address (alias jtbl_addr) int dsize; // jump-table element size 1/2/4/8 (alias esize) int amount; // number of cases ut64 min_val; ut64 def_val; ut64 max_val; RList/**/ *cases; // Extended fields (since ABI 92). Add at the end to preserve layout // for code that only reads addr/cases/min_val/max_val/def_val. ut64 vtbl_addr; // value/index table address (INDIRECT or SPARSE) st64 lowcase; // first input value, propagates from RAnalSwitchSpec ut32 flags; // RAnalSwitchFlags ut8 vsize; // value-table element size ut8 shift; // shift amount const char *reg; // borrowed input register name (may be NULL) ut8 deps_count; // number of producer instruction addresses in deps[] ut64 deps[R_ANAL_SWITCH_OP_DEPS]; // jump-table producer instruction addresses ut64 jump_addr; // indirect branch instruction address } RAnalSwitchOp; // TODO: Rename to RAnalSwitch typedef enum r_anal_data_type_t { R_ANAL_DATATYPE_NULL = 0, R_ANAL_DATATYPE_ARRAY, R_ANAL_DATATYPE_OBJECT, // instance R_ANAL_DATATYPE_STRING, R_ANAL_DATATYPE_CLASS, R_ANAL_DATATYPE_BOOLEAN, R_ANAL_DATATYPE_INT16, R_ANAL_DATATYPE_INT32, R_ANAL_DATATYPE_INT64, R_ANAL_DATATYPE_FLOAT, } RAnalDataType; typedef struct r_anal_op_t { char *mnemonic; /* mnemonic.. it actually contains the args too, we should replace rasm with this */ ut64 addr; /* address */ ut32 type; /* type of opcode */ RAnalOpPrefix prefix; /* type of opcode prefix (rep,lock,..) */ ut32 type2; /* used by java */ RAnalStackOp stackop; /* operation on stack? */ RAnalCondType cond; /* condition type */ bool weakbytes; ut8 *bytes; /* can be null, but is used for encoding and decoding, malloc of `size` */ ut8 bytes_buf[64]; int size; /* size in bytes of opcode */ bool tlocal; // uses the thread local storage int nopcode; /* number of bytes representing the opcode (not the arguments) TODO: find better name */ int cycles; /* cpu-cycles taken by instruction */ int failcycles; /* conditional cpu-cycles */ RAnalOpFamily family; /* family of opcode */ int id; /* instruction id */ bool eob; /* end of block (boolean) */ bool sign; /* operates on signed values, false by default */ /* Run N instructions before executing the current one */ int delay; /* delay N slots (mips, ..)*/ ut64 jump; /* true jmp */ ut64 fail; /* false jmp */ RAnalOpDirection direction; st64 ptr; /* reference to memory */ /* XXX signed? */ ut64 val; /* reference to value */ /* XXX signed? */ int ptrsize; /* f.ex: zero extends for 8, 16 or 32 bits only */ st64 stackptr; /* stack pointer */ int refptr; /* if (0) ptr = "reference" else ptr = "load memory of refptr bytes" */ RVecRArchValue srcs; RVecRArchValue dsts; RList *access; /* RArchValue access information */ RStrBuf esil; RStrBuf opex; const char *reg; /* destination register rename to dreg or dst_reg */ const char *ireg; /* register used for indirect memory computation . TODO rename to ind_reg */ int scale; ut64 disp; // displace, used as offset to be added from a register base RAnalSwitchOp *switch_op; RAnalHint hint; RAnalDataType datatype; int vliw; // begin of opcode block. int payload; // used for instructions like dalvik's switch-payload } RAnalOp; R_API RAnalOp *r_anal_op_clone(RAnalOp *op); R_API void r_anal_op_free(void *_op); R_API bool r_anal_op_nonlinear(int t); R_API void r_anal_op_init(RAnalOp *op); R_API bool r_anal_op_set_bytes(RAnalOp *op, ut64 addr, const ut8* data, int size); R_API bool r_anal_op_set_mnemonic(RAnalOp *op, ut64 addr, const char *s); R_API const char *r_anal_op_direction_tostring(RAnalOp *op); R_API bool r_anal_op_ismemref(int t); R_API const char *r_anal_optype_tostring(int t); R_API const char *r_anal_optype_index(int idx); R_API int r_anal_optype_from_string(const char *type); R_API const char *r_anal_op_family_tostring(int n); R_API int r_anal_op_family_from_string(const char *f); R_API int r_anal_op_hint(RAnalOp *op, RAnalHint *hint); /* switch.c APIs */ R_API RAnalSwitchOp *r_anal_switch_op_new(ut64 addr, ut64 min_val, ut64 max_val, ut64 def_val); R_API void r_anal_switch_op_free(RAnalSwitchOp *swop); R_API RAnalCaseOp* r_anal_switch_op_add_case(RAnalSwitchOp *swop, ut64 addr, ut64 value, ut64 jump); R_API bool r_anal_switch_op_add_dep(RAnalSwitchOp *swop, ut64 addr); R_API bool r_anal_switch_op_has_dep(const RAnalSwitchOp *swop, ut64 addr); // Initialise a RAnalSwitchSpec to its conservative defaults. R_API void r_anal_switch_spec_init(RAnalSwitchSpec *spec); // Build a positional spec from the legacy "afbt addr esz n seg" arguments. R_API void r_anal_switch_spec_legacy(RAnalSwitchSpec *spec, ut64 startea, ut64 tbladdr, ut64 esize, ut64 ncases, ut64 base); // value.c R_API RArchValue *r_anal_value_new(void); R_API void r_anal_value_free(RArchValue *value); R_API RArchValue *r_anal_value_clone(RArchValue *ov); R_API RArchValue *r_anal_value_new_from_string(const char *str); R_API st64 r_anal_value_eval(RArchValue *value); R_API char *r_anal_value_tostring(RArchValue *value); R_API const char *r_anal_value_type_tostring(RArchValue *value); R_API void r_anal_value_free(RArchValue *value); #ifdef __cplusplus } #endif #endif