1 #ifndef R2_REG_H 2 #define R2_REG_H 3 4 #include <r_types.h> 5 #include <r_list.h> 6 #include <r_util/r_hex.h> 7 #include <r_util/r_assert.h> 8 9 #ifdef __cplusplus 10 extern "C" { 11 #endif 12 13 R_LIB_VERSION_HEADER (r_reg); 14 15 /* 16 * various CPUs have registers within various types/classes 17 * this enum aims to cover them all. 18 */ 19 typedef enum { 20 R_REG_TYPE_GPR, 21 R_REG_TYPE_DRX, 22 R_REG_TYPE_FPU, 23 R_REG_TYPE_MMX, 24 R_REG_TYPE_XMM, 25 R_REG_TYPE_YMM, 26 R_REG_TYPE_FLG, 27 R_REG_TYPE_SEG, 28 R_REG_TYPE_LAST, 29 R_REG_TYPE_ALL = -1, // TODO; rename to ANY 30 } RRegisterType; 31 32 /* 33 * pretty much all CPUs share some common registers 34 * this enum aims to create an abstraction to ease cross-arch handling. 35 */ 36 typedef enum { 37 R_REG_NAME_PC, // program counter 38 R_REG_NAME_SP, // stack pointer 39 R_REG_NAME_SR, // status register 40 R_REG_NAME_BP, // base pointer 41 R_REG_NAME_LR, // link register 42 /* args */ 43 R_REG_NAME_A0, // arguments 44 R_REG_NAME_A1, 45 R_REG_NAME_A2, 46 R_REG_NAME_A3, 47 R_REG_NAME_A4, 48 R_REG_NAME_A5, 49 R_REG_NAME_A6, 50 R_REG_NAME_A7, 51 R_REG_NAME_A8, 52 R_REG_NAME_A9, 53 /* retval */ 54 R_REG_NAME_R0, // return registers 55 R_REG_NAME_R1, 56 R_REG_NAME_R2, 57 R_REG_NAME_R3, 58 /* flags */ 59 R_REG_NAME_ZF, 60 R_REG_NAME_SF, 61 R_REG_NAME_CF, 62 R_REG_NAME_OF, 63 /* syscall number (orig_eax,rax,r0,x0) */ 64 R_REG_NAME_SN, 65 R_REG_NAME_LAST, 66 } RRegisterId; 67 68 // TODO: use enum here? 69 #define R_REG_COND_EQ 0 70 #define R_REG_COND_NE 1 71 #define R_REG_COND_CF 2 72 #define R_REG_COND_CARRY 2 73 #define R_REG_COND_NEG 3 74 #define R_REG_COND_NEGATIVE 3 75 #define R_REG_COND_OF 4 76 #define R_REG_COND_OVERFLOW 4 77 // unsigned 78 #define R_REG_COND_HI 5 79 #define R_REG_COND_HE 6 80 #define R_REG_COND_LO 7 81 #define R_REG_COND_LOE 8 82 // signed 83 #define R_REG_COND_GE 9 84 #define R_REG_COND_GT 10 85 #define R_REG_COND_LT 11 86 #define R_REG_COND_LE 12 87 #define R_REG_COND_LAST 13 88 89 typedef struct r_reg_item_t { 90 char *name; 91 int /*RRegisterType*/ type; 92 int size; /* 8,16,32,64 ... 128/256 ??? */ 93 int offset; /* offset in data structure */ 94 int packed_size; /* 0 means no packed register, 1byte pack, 2b pack... */ 95 bool is_float; 96 char *flags; 97 char *comment; 98 int index; 99 int arena; /* in which arena is this reg living */ 100 } RRegItem; 101 102 typedef struct r_reg_arena_t { 103 ut8 *bytes; 104 int size; 105 } RRegArena; 106 107 typedef struct r_reg_set_t { 108 RRegArena *arena; 109 RList *pool; /* RRegArena */ 110 RList *regs; /* RRegItem */ 111 HtPP *ht_regs; /* name:RRegItem */ 112 RListIter *cur; 113 int maskregstype; /* which type of regs have this reg set (logic mask with RRegisterType R_REG_TYPE_XXX) */ 114 } RRegSet; 115 116 typedef struct r_reg_t { 117 char *profile; 118 char *reg_profile_cmt; 119 char *reg_profile_str; 120 char *name[R_REG_NAME_LAST]; // aliases 121 RRegSet regset[R_REG_TYPE_LAST]; 122 RList *allregs; 123 RList *roregs; 124 int iters; 125 int arch; 126 int bits; 127 int size; 128 bool is_thumb; 129 bool big_endian; 130 } RReg; 131 132 typedef struct r_reg_flags_t { 133 bool s; // sign, negative number (msb) 134 bool z; // zero 135 bool a; // half-carry adjust (if carry happens at nibble level) 136 bool c; // carry 137 bool o; // overflow 138 bool p; // parity (lsb) 139 } RRegFlags; 140 141 #ifdef R_API 142 R_API void r_reg_free(RReg *reg); 143 R_API void r_reg_free_internal(RReg *reg, bool init); 144 R_API RReg *r_reg_new(void); 145 R_API bool r_reg_set_name(RReg *reg, int role, const char *name); 146 R_API bool r_reg_set_profile_string(RReg *reg, const char *profile); 147 R_API char* r_reg_profile_to_cc(RReg *reg); 148 R_API bool r_reg_set_profile(RReg *reg, const char *profile); 149 R_API char *r_reg_parse_gdb_profile(const char *profile); 150 R_API bool r_reg_is_readonly(RReg *reg, RRegItem *item); 151 152 R_API RRegSet *r_reg_regset_get(RReg *r, int type); 153 R_API ut64 r_reg_getv(RReg *reg, const char *name); 154 R_API ut64 r_reg_setv(RReg *reg, const char *name, ut64 val); 155 R_API const char *r_reg_32_to_64(RReg *reg, const char *rreg32); 156 R_API const char *r_reg_64_to_32(RReg *reg, const char *rreg64); 157 R_API const char *r_reg_get_name_by_type(RReg *reg, const char *name); 158 R_API const char *r_reg_get_type(int idx); 159 R_API const char *r_reg_get_name(RReg *reg, int kind); 160 R_API const char *r_reg_get_role(int role); 161 R_API RRegItem *r_reg_get(RReg *reg, const char *name, int type); 162 R_API RList *r_reg_get_list(RReg *reg, int type); 163 R_API RRegItem *r_reg_get_at(RReg *reg, int type, int regsize, int delta); 164 R_API RRegItem *r_reg_next_diff(RReg *reg, int type, const ut8 *buf, int buflen, RRegItem *prev_ri, int regsize); 165 166 R_API void r_reg_reindex(RReg *reg); 167 R_API RRegItem *r_reg_index_get(RReg *reg, int idx); 168 169 /* Item */ 170 R_API void r_reg_item_free(RRegItem *item); 171 172 /* XXX: dupped ?? */ 173 R_API int r_reg_type_by_name(const char *str); 174 R_API int r_reg_get_name_idx(const char *type); 175 176 R_API RRegItem *r_reg_cond_get(RReg *reg, const char *name); 177 R_API void r_reg_cond_apply(RReg *r, RRegFlags *f); 178 R_API bool r_reg_cond_set(RReg *reg, const char *name, bool val); 179 R_API int r_reg_cond_get_value(RReg *r, const char *name); 180 R_API bool r_reg_cond_bits_set(RReg *r, int type, RRegFlags *f, bool v); 181 R_API int r_reg_cond_bits(RReg *r, int type, RRegFlags *f); 182 R_API RRegFlags *r_reg_cond_retrieve(RReg *r, RRegFlags *); 183 R_API int r_reg_cond(RReg *r, int type); 184 185 /* integer value 8-64 bits */ 186 R_API ut64 r_reg_get_value(RReg *reg, RRegItem *item); 187 R_API ut64 r_reg_get_value_big(RReg *reg, RRegItem *item, utX *val); 188 R_API ut64 r_reg_get_value_by_role(RReg *reg, RRegisterId role); 189 R_API bool r_reg_set_value(RReg *reg, RRegItem *item, ut64 value); 190 R_API bool r_reg_set_value_by_role(RReg *reg, RRegisterId role, ut64 value); 191 192 /* float */ 193 R_API float r_reg_get_float(RReg *reg, RRegItem *item); 194 R_API bool r_reg_set_float(RReg *reg, RRegItem *item, float value); 195 196 /* double */ 197 R_API double r_reg_get_double(RReg *reg, RRegItem *item); 198 R_API bool r_reg_set_double(RReg *reg, RRegItem *item, double value); 199 200 /* long double */ 201 R_API long double r_reg_get_longdouble(RReg *reg, RRegItem *item); 202 R_API bool r_reg_set_longdouble(RReg *reg, RRegItem *item, long double value); 203 204 /* boolean */ 205 R_API char *r_reg_get_bvalue(RReg *reg, RRegItem *item); 206 R_API ut64 r_reg_set_bvalue(RReg *reg, RRegItem *item, const char *str); 207 208 /* packed registers */ 209 R_API int r_reg_set_pack(RReg *reg, RRegItem *item, int packidx, int packbits, ut64 val); 210 R_API ut64 r_reg_get_pack(RReg *reg, RRegItem *item, int packidx, int packbits); 211 212 /* byte arena */ 213 R_API ut8 *r_reg_get_bytes(RReg *reg, int type, int *size); 214 R_API bool r_reg_set_bytes(RReg *reg, int type, const ut8 *buf, const int len); 215 R_API bool r_reg_read_regs(RReg *reg, ut8 *buf, const int len); 216 R_API int r_reg_arena_set_bytes(RReg *reg, const char *str); 217 R_API RRegArena *r_reg_arena_new(int size); 218 R_API void r_reg_arena_free(RRegArena *ra); 219 R_API int r_reg_fit_arena(RReg *reg); 220 R_API void r_reg_arena_swap(RReg *reg, int copy); 221 R_API int r_reg_arena_push(RReg *reg); 222 R_API void r_reg_arena_pop(RReg *reg); 223 R_API void r_reg_arena_zero(RReg *reg); 224 225 R_API ut8 *r_reg_arena_peek(RReg *reg); 226 R_API void r_reg_arena_poke(RReg *reg, const ut8 *buf); 227 R_API ut8 *r_reg_arena_dup(RReg *reg, const ut8 *source); 228 R_API const char *r_reg_cond_to_string(int n); 229 R_API int r_reg_cond_from_string(const char *str); 230 R_API void r_reg_arena_shrink(RReg *reg); 231 232 #ifdef __cplusplus 233 } 234 #endif 235 236 #endif 237 #endif 238