sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 1 | |
| 2 | /*---------------------------------------------------------------*/ |
| 3 | /*--- ---*/ |
sewardj | c0ee2ed | 2004-07-27 10:29:41 +0000 | [diff] [blame] | 4 | /*--- This file (main/vex_main.c) is ---*/ |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 5 | /*--- Copyright (c) 2004 OpenWorks LLP. All rights reserved. ---*/ |
| 6 | /*--- ---*/ |
| 7 | /*---------------------------------------------------------------*/ |
| 8 | |
sewardj | 887a11a | 2004-07-05 17:26:47 +0000 | [diff] [blame] | 9 | #include "libvex.h" |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 10 | |
sewardj | c0ee2ed | 2004-07-27 10:29:41 +0000 | [diff] [blame] | 11 | #include "main/vex_globals.h" |
| 12 | #include "main/vex_util.h" |
| 13 | #include "host-generic/h_generic_regs.h" |
| 14 | #include "host-x86/hdefs.h" |
| 15 | #include "guest-x86/gdefs.h" |
sewardj | edf4d69 | 2004-08-17 13:52:58 +0000 | [diff] [blame] | 16 | #include "ir/iropt.h" |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 17 | |
| 18 | |
| 19 | /* This file contains the top level interface to the library. */ |
| 20 | |
| 21 | /* --------- Initialise the library. --------- */ |
| 22 | |
| 23 | /* Exported to library client. */ |
| 24 | |
sewardj | 887a11a | 2004-07-05 17:26:47 +0000 | [diff] [blame] | 25 | void LibVEX_Init ( |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 26 | /* failure exit function */ |
sewardj | 2b51587 | 2004-07-05 20:50:45 +0000 | [diff] [blame] | 27 | __attribute__ ((noreturn)) |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 28 | void (*failure_exit) ( void ), |
| 29 | /* logging output function */ |
| 30 | void (*log_bytes) ( Char*, Int nbytes ), |
| 31 | /* debug paranoia level */ |
| 32 | Int debuglevel, |
sewardj | 58800ff | 2004-07-28 01:51:10 +0000 | [diff] [blame] | 33 | /* initial verbosity level */ |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 34 | Int verbosity, |
| 35 | /* Are we supporting valgrind checking? */ |
| 36 | Bool valgrind_support, |
| 37 | /* Max # guest insns per bb */ |
| 38 | Int guest_insns_per_bb |
| 39 | ) |
| 40 | { |
| 41 | vassert(!vex_initdone); |
| 42 | vassert(failure_exit); |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 43 | vassert(log_bytes); |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 44 | vassert(debuglevel >= 0); |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 45 | vassert(verbosity >= 0); |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 46 | vassert(guest_insns_per_bb >= 1 && guest_insns_per_bb <= 100); |
sewardj | 443cd9d | 2004-07-18 23:06:45 +0000 | [diff] [blame] | 47 | |
| 48 | vex_failure_exit = failure_exit; |
| 49 | vex_log_bytes = log_bytes; |
| 50 | vex_debuglevel = debuglevel; |
| 51 | vex_verbosity = verbosity; |
| 52 | vex_valgrind_support = valgrind_support; |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 53 | vex_guest_insns_per_bb = guest_insns_per_bb; |
sewardj | 443cd9d | 2004-07-18 23:06:45 +0000 | [diff] [blame] | 54 | vex_initdone = True; |
| 55 | LibVEX_SetAllocMode ( AllocModeTEMPORARY ); |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 56 | } |
| 57 | |
| 58 | |
| 59 | /* --------- Make a translation. --------- */ |
| 60 | |
| 61 | /* Exported to library client. */ |
| 62 | |
sewardj | 887a11a | 2004-07-05 17:26:47 +0000 | [diff] [blame] | 63 | TranslateResult LibVEX_Translate ( |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 64 | /* The instruction sets we are translating from and to. */ |
| 65 | InsnSet iset_guest, |
| 66 | InsnSet iset_host, |
| 67 | /* IN: the block to translate, and its guest address. */ |
sewardj | 81bd550 | 2004-07-21 18:49:27 +0000 | [diff] [blame] | 68 | UChar* guest_bytes, |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 69 | Addr64 guest_bytes_addr, |
| 70 | /* OUT: the number of bytes actually read */ |
| 71 | Int* guest_bytes_read, |
| 72 | /* IN: a place to put the resulting code, and its size */ |
sewardj | 81bd550 | 2004-07-21 18:49:27 +0000 | [diff] [blame] | 73 | UChar* host_bytes, |
| 74 | Int host_bytes_size, |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 75 | /* OUT: how much of the output area is used. */ |
| 76 | Int* host_bytes_used, |
| 77 | /* IN: optionally, an instrumentation function. */ |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 78 | IRBB* (*instrument) ( IRBB* ), |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 79 | /* IN: optionally, an access check function for guest code. */ |
sewardj | 58800ff | 2004-07-28 01:51:10 +0000 | [diff] [blame] | 80 | Bool (*byte_accessible) ( Addr64 ), |
| 81 | /* IN: if > 0, use this verbosity for this bb */ |
| 82 | Int bb_verbosity |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 83 | ) |
| 84 | { |
sewardj | 81bd550 | 2004-07-21 18:49:27 +0000 | [diff] [blame] | 85 | /* This the bundle of functions we need to do the back-end stuff |
| 86 | (insn selection, reg-alloc, assembly) whilst being insulated |
| 87 | from the target instruction set. */ |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 88 | HReg* available_real_regs; |
| 89 | Int n_available_real_regs; |
sewardj | 443cd9d | 2004-07-18 23:06:45 +0000 | [diff] [blame] | 90 | Bool (*isMove) (HInstr*, HReg*, HReg*); |
| 91 | void (*getRegUsage) (HRegUsage*, HInstr*); |
| 92 | void (*mapRegs) (HRegRemap*, HInstr*); |
| 93 | HInstr* (*genSpill) ( HReg, Int ); |
| 94 | HInstr* (*genReload) ( HReg, Int ); |
| 95 | void (*ppInstr) ( HInstr* ); |
| 96 | void (*ppReg) ( HReg ); |
sewardj | 36ca513 | 2004-07-24 13:12:23 +0000 | [diff] [blame] | 97 | HInstrArray* (*iselBB) ( IRBB*, Addr64(*)(Char*) ); |
sewardj | 443cd9d | 2004-07-18 23:06:45 +0000 | [diff] [blame] | 98 | IRBB* (*bbToIR) ( UChar*, Addr64, Int*, |
| 99 | Bool(*)(Addr64), Bool ); |
sewardj | 81bd550 | 2004-07-21 18:49:27 +0000 | [diff] [blame] | 100 | Int (*emit) ( UChar*, Int, HInstr* ); |
sewardj | 36ca513 | 2004-07-24 13:12:23 +0000 | [diff] [blame] | 101 | Addr64 (*findHelper) ( Char* ); |
sewardj | 84ff065 | 2004-08-23 16:16:08 +0000 | [diff] [blame] | 102 | IRExpr* (*specHelper) ( Char*, IRExpr** ); |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 103 | |
sewardj | c9a6570 | 2004-07-07 16:32:57 +0000 | [diff] [blame] | 104 | Bool host_is_bigendian = False; |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 105 | IRBB* irbb; |
| 106 | HInstrArray* vcode; |
| 107 | HInstrArray* rcode; |
sewardj | 58800ff | 2004-07-28 01:51:10 +0000 | [diff] [blame] | 108 | Int i, j, k, out_used, saved_verbosity; |
sewardj | 2e56f9f | 2004-07-24 01:24:38 +0000 | [diff] [blame] | 109 | UChar insn_bytes[32]; |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 110 | |
sewardj | 36ca513 | 2004-07-24 13:12:23 +0000 | [diff] [blame] | 111 | available_real_regs = NULL; |
| 112 | n_available_real_regs = 0; |
| 113 | isMove = NULL; |
| 114 | getRegUsage = NULL; |
| 115 | mapRegs = NULL; |
| 116 | genSpill = NULL; |
| 117 | genReload = NULL; |
| 118 | ppInstr = NULL; |
| 119 | ppReg = NULL; |
| 120 | iselBB = NULL; |
| 121 | bbToIR = NULL; |
| 122 | emit = NULL; |
| 123 | findHelper = NULL; |
sewardj | 84ff065 | 2004-08-23 16:16:08 +0000 | [diff] [blame] | 124 | specHelper = NULL; |
sewardj | 36ca513 | 2004-07-24 13:12:23 +0000 | [diff] [blame] | 125 | |
sewardj | 58800ff | 2004-07-28 01:51:10 +0000 | [diff] [blame] | 126 | saved_verbosity = vex_verbosity; |
| 127 | if (bb_verbosity > 0) |
| 128 | vex_verbosity = bb_verbosity; |
| 129 | |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 130 | vassert(vex_initdone); |
sewardj | 443cd9d | 2004-07-18 23:06:45 +0000 | [diff] [blame] | 131 | LibVEX_ClearTemporary(False); |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 132 | |
| 133 | /* First off, check that the guest and host insn sets |
| 134 | are supported. */ |
| 135 | switch (iset_host) { |
| 136 | case InsnSetX86: |
| 137 | getAllocableRegs_X86 ( &n_available_real_regs, |
| 138 | &available_real_regs ); |
| 139 | isMove = (Bool(*)(HInstr*,HReg*,HReg*)) isMove_X86Instr; |
| 140 | getRegUsage = (void(*)(HRegUsage*,HInstr*)) getRegUsage_X86Instr; |
| 141 | mapRegs = (void(*)(HRegRemap*,HInstr*)) mapRegs_X86Instr; |
| 142 | genSpill = (HInstr*(*)(HReg,Int)) genSpill_X86; |
| 143 | genReload = (HInstr*(*)(HReg,Int)) genReload_X86; |
sewardj | 2b51587 | 2004-07-05 20:50:45 +0000 | [diff] [blame] | 144 | ppInstr = (void(*)(HInstr*)) ppX86Instr; |
| 145 | ppReg = (void(*)(HReg)) ppHRegX86; |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 146 | iselBB = iselBB_X86; |
sewardj | 81bd550 | 2004-07-21 18:49:27 +0000 | [diff] [blame] | 147 | emit = (Int(*)(UChar*,Int,HInstr*)) emit_X86Instr; |
sewardj | c9a6570 | 2004-07-07 16:32:57 +0000 | [diff] [blame] | 148 | host_is_bigendian = False; |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 149 | break; |
| 150 | default: |
sewardj | 887a11a | 2004-07-05 17:26:47 +0000 | [diff] [blame] | 151 | vpanic("LibVEX_Translate: unsupported target insn set"); |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 152 | } |
| 153 | |
| 154 | switch (iset_guest) { |
| 155 | case InsnSetX86: |
sewardj | 36ca513 | 2004-07-24 13:12:23 +0000 | [diff] [blame] | 156 | bbToIR = bbToIR_X86Instr; |
| 157 | findHelper = x86guest_findhelper; |
sewardj | 84ff065 | 2004-08-23 16:16:08 +0000 | [diff] [blame] | 158 | specHelper = x86guest_spechelper; |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 159 | break; |
| 160 | default: |
sewardj | 887a11a | 2004-07-05 17:26:47 +0000 | [diff] [blame] | 161 | vpanic("LibVEX_Translate: unsupported guest insn set"); |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | irbb = bbToIR ( guest_bytes, |
| 165 | guest_bytes_addr, |
| 166 | guest_bytes_read, |
sewardj | c9a6570 | 2004-07-07 16:32:57 +0000 | [diff] [blame] | 167 | byte_accessible, |
| 168 | host_is_bigendian ); |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 169 | |
| 170 | if (irbb == NULL) { |
| 171 | /* Access failure. */ |
sewardj | 443cd9d | 2004-07-18 23:06:45 +0000 | [diff] [blame] | 172 | LibVEX_ClearTemporary(False); |
sewardj | 58800ff | 2004-07-28 01:51:10 +0000 | [diff] [blame] | 173 | vex_verbosity = saved_verbosity; |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 174 | return TransAccessFail; |
| 175 | } |
sewardj | aa59f94 | 2004-10-09 09:34:36 +0000 | [diff] [blame^] | 176 | |
| 177 | /* If debugging, show the raw guest bytes for this bb. */ |
| 178 | if (vex_verbosity >= 2) { |
| 179 | UChar* p = guest_bytes; |
| 180 | vex_printf("\n"); |
| 181 | vex_printf(". 0 %llx %d\n.", guest_bytes_addr, *guest_bytes_read ); |
| 182 | for (i = 0; i < *guest_bytes_read; i++) |
| 183 | vex_printf(" %02x", (Int)p[i] ); |
| 184 | vex_printf("\n"); |
| 185 | } |
| 186 | |
| 187 | /* Sanity check the initial IR. */ |
sewardj | 3543921 | 2004-07-14 22:36:10 +0000 | [diff] [blame] | 188 | sanityCheckIRBB(irbb, Ity_I32); |
sewardj | e8e9d73 | 2004-07-16 21:03:45 +0000 | [diff] [blame] | 189 | |
sewardj | edf4d69 | 2004-08-17 13:52:58 +0000 | [diff] [blame] | 190 | /* Clean it up, hopefully a lot. */ |
sewardj | 84ff065 | 2004-08-23 16:16:08 +0000 | [diff] [blame] | 191 | irbb = do_iropt_BB ( irbb, specHelper ); |
sewardj | d7cb853 | 2004-08-17 23:59:23 +0000 | [diff] [blame] | 192 | sanityCheckIRBB(irbb, Ity_I32); |
sewardj | edf4d69 | 2004-08-17 13:52:58 +0000 | [diff] [blame] | 193 | |
| 194 | if (vex_verbosity > 0) { |
| 195 | vex_printf("\n-------- After IR optimisation --------\n"); |
| 196 | ppIRBB ( irbb ); |
| 197 | vex_printf("\n"); |
| 198 | } |
| 199 | |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 200 | /* Get the thing instrumented. */ |
| 201 | if (instrument) |
| 202 | irbb = (*instrument)(irbb); |
| 203 | |
| 204 | /* Turn it into virtual-registerised code. */ |
sewardj | 36ca513 | 2004-07-24 13:12:23 +0000 | [diff] [blame] | 205 | vcode = iselBB ( irbb, findHelper ); |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 206 | |
sewardj | 1f40a0a | 2004-07-21 12:28:07 +0000 | [diff] [blame] | 207 | if (vex_verbosity > 0) { |
| 208 | vex_printf("\n-------- Virtual registerised code --------\n"); |
| 209 | for (i = 0; i < vcode->arr_used; i++) { |
| 210 | vex_printf("%3d ", i); |
| 211 | ppInstr(vcode->arr[i]); |
| 212 | vex_printf("\n"); |
| 213 | } |
sewardj | fbcaf33 | 2004-07-08 01:46:01 +0000 | [diff] [blame] | 214 | vex_printf("\n"); |
| 215 | } |
sewardj | fbcaf33 | 2004-07-08 01:46:01 +0000 | [diff] [blame] | 216 | |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 217 | /* Register allocate. */ |
| 218 | rcode = doRegisterAllocation ( vcode, available_real_regs, |
| 219 | n_available_real_regs, |
| 220 | isMove, getRegUsage, mapRegs, |
sewardj | 2b51587 | 2004-07-05 20:50:45 +0000 | [diff] [blame] | 221 | genSpill, genReload, |
| 222 | ppInstr, ppReg ); |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 223 | |
sewardj | 1f40a0a | 2004-07-21 12:28:07 +0000 | [diff] [blame] | 224 | if (vex_verbosity > 0) { |
| 225 | vex_printf("\n-------- Post-regalloc code --------\n"); |
| 226 | for (i = 0; i < rcode->arr_used; i++) { |
| 227 | vex_printf("%3d ", i); |
| 228 | ppInstr(rcode->arr[i]); |
| 229 | vex_printf("\n"); |
| 230 | } |
sewardj | fbcaf33 | 2004-07-08 01:46:01 +0000 | [diff] [blame] | 231 | vex_printf("\n"); |
| 232 | } |
sewardj | fbcaf33 | 2004-07-08 01:46:01 +0000 | [diff] [blame] | 233 | |
sewardj | 81bd550 | 2004-07-21 18:49:27 +0000 | [diff] [blame] | 234 | /* Assemble */ |
sewardj | 81bd550 | 2004-07-21 18:49:27 +0000 | [diff] [blame] | 235 | out_used = 0; /* tracks along the host_bytes array */ |
| 236 | for (i = 0; i < rcode->arr_used; i++) { |
sewardj | 14731f2 | 2004-07-25 01:24:28 +0000 | [diff] [blame] | 237 | if (vex_verbosity > 1) { |
sewardj | bad34a9 | 2004-07-22 01:14:11 +0000 | [diff] [blame] | 238 | ppInstr(rcode->arr[i]); |
| 239 | vex_printf("\n"); |
| 240 | } |
sewardj | 81bd550 | 2004-07-21 18:49:27 +0000 | [diff] [blame] | 241 | j = (*emit)( insn_bytes, 32, rcode->arr[i] ); |
sewardj | 14731f2 | 2004-07-25 01:24:28 +0000 | [diff] [blame] | 242 | if (vex_verbosity > 1) { |
sewardj | bad34a9 | 2004-07-22 01:14:11 +0000 | [diff] [blame] | 243 | for (k = 0; k < j; k++) |
sewardj | 86898e8 | 2004-07-22 17:26:12 +0000 | [diff] [blame] | 244 | if (insn_bytes[k] < 16) |
| 245 | vex_printf("0%x ", (UInt)insn_bytes[k]); |
| 246 | else |
| 247 | vex_printf("%x ", (UInt)insn_bytes[k]); |
sewardj | bad34a9 | 2004-07-22 01:14:11 +0000 | [diff] [blame] | 248 | vex_printf("\n\n"); |
| 249 | } |
sewardj | 81bd550 | 2004-07-21 18:49:27 +0000 | [diff] [blame] | 250 | if (out_used + j > host_bytes_size) { |
| 251 | LibVEX_ClearTemporary(False); |
sewardj | 58800ff | 2004-07-28 01:51:10 +0000 | [diff] [blame] | 252 | vex_verbosity = saved_verbosity; |
sewardj | 81bd550 | 2004-07-21 18:49:27 +0000 | [diff] [blame] | 253 | return TransOutputFull; |
| 254 | } |
| 255 | for (k = 0; k < j; k++) { |
| 256 | host_bytes[out_used] = insn_bytes[k]; |
| 257 | out_used++; |
| 258 | } |
| 259 | vassert(out_used <= host_bytes_size); |
| 260 | } |
| 261 | *host_bytes_used = out_used; |
| 262 | |
sewardj | 1f40a0a | 2004-07-21 12:28:07 +0000 | [diff] [blame] | 263 | // LibVEX_ClearTemporary(True); |
| 264 | LibVEX_ClearTemporary(False); |
sewardj | f13a16a | 2004-07-05 17:10:14 +0000 | [diff] [blame] | 265 | |
sewardj | 58800ff | 2004-07-28 01:51:10 +0000 | [diff] [blame] | 266 | vex_verbosity = saved_verbosity; |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 267 | return TransOK; |
| 268 | } |
| 269 | |
| 270 | |
| 271 | |
| 272 | /*---------------------------------------------------------------*/ |
sewardj | c0ee2ed | 2004-07-27 10:29:41 +0000 | [diff] [blame] | 273 | /*--- end main/vex_main.c ---*/ |
sewardj | 35421a3 | 2004-07-05 13:12:34 +0000 | [diff] [blame] | 274 | /*---------------------------------------------------------------*/ |