]>
Commit | Line | Data |
---|---|---|
b9adb4a6 | 1 | /* General "disassemble this chunk" code. Used for debugging. */ |
d38ea87a | 2 | #include "qemu/osdep.h" |
3979fca4 | 3 | #include "disas/dis-asm.h" |
b9adb4a6 | 4 | #include "elf.h" |
30cc9831 | 5 | #include "qemu/qemu-print.h" |
b9adb4a6 | 6 | |
76cad711 | 7 | #include "disas/disas.h" |
8ca80760 | 8 | #include "disas/capstone.h" |
c6105c0a | 9 | |
f4359b9f BS |
10 | typedef struct CPUDebug { |
11 | struct disassemble_info info; | |
d49190c4 | 12 | CPUState *cpu; |
f4359b9f BS |
13 | } CPUDebug; |
14 | ||
b9adb4a6 | 15 | /* Filled in by elfload.c. Simplistic, but will do for now. */ |
e80cfcfc | 16 | struct syminfo *syminfos = NULL; |
b9adb4a6 | 17 | |
12b6e9b2 RH |
18 | /* |
19 | * Get LENGTH bytes from info's buffer, at host address memaddr. | |
20 | * Transfer them to myaddr. | |
21 | */ | |
22 | static int host_read_memory(bfd_vma memaddr, bfd_byte *myaddr, int length, | |
23 | struct disassemble_info *info) | |
aa0aa4fa | 24 | { |
c6105c0a | 25 | if (memaddr < info->buffer_vma |
12b6e9b2 | 26 | || memaddr + length > info->buffer_vma + info->buffer_length) { |
c6105c0a FB |
27 | /* Out of bounds. Use EIO because GDB uses it. */ |
28 | return EIO; | |
12b6e9b2 | 29 | } |
c6105c0a FB |
30 | memcpy (myaddr, info->buffer + (memaddr - info->buffer_vma), length); |
31 | return 0; | |
aa0aa4fa FB |
32 | } |
33 | ||
12b6e9b2 RH |
34 | /* |
35 | * Get LENGTH bytes from info's buffer, at target address memaddr. | |
36 | * Transfer them to myaddr. | |
37 | */ | |
38 | static int target_read_memory(bfd_vma memaddr, bfd_byte *myaddr, int length, | |
39 | struct disassemble_info *info) | |
c6105c0a | 40 | { |
f4359b9f | 41 | CPUDebug *s = container_of(info, CPUDebug, info); |
12b6e9b2 | 42 | int r = cpu_memory_rw_debug(s->cpu, memaddr, myaddr, length, 0); |
6766ba50 | 43 | return r ? EIO : 0; |
c6105c0a | 44 | } |
c6105c0a | 45 | |
12b6e9b2 RH |
46 | /* |
47 | * Print an error message. We can assume that this is in response to | |
48 | * an error return from {host,target}_read_memory. | |
49 | */ | |
50 | static void perror_memory(int status, bfd_vma memaddr, | |
51 | struct disassemble_info *info) | |
aa0aa4fa | 52 | { |
12b6e9b2 RH |
53 | if (status != EIO) { |
54 | /* Can't happen. */ | |
55 | info->fprintf_func(info->stream, "Unknown error %d\n", status); | |
56 | } else { | |
57 | /* Address between memaddr and memaddr + len was out of bounds. */ | |
58 | info->fprintf_func(info->stream, | |
59 | "Address 0x%" PRIx64 " is out of bounds.\n", | |
60 | memaddr); | |
61 | } | |
aa0aa4fa FB |
62 | } |
63 | ||
12b6e9b2 RH |
64 | /* Print address in hex. */ |
65 | static void print_address(bfd_vma addr, struct disassemble_info *info) | |
aa0aa4fa | 66 | { |
12b6e9b2 | 67 | info->fprintf_func(info->stream, "0x%" PRIx64, addr); |
aa0aa4fa FB |
68 | } |
69 | ||
636bd289 | 70 | /* Print address in hex, truncated to the width of a host virtual address. */ |
12b6e9b2 | 71 | static void host_print_address(bfd_vma addr, struct disassemble_info *info) |
636bd289 | 72 | { |
12b6e9b2 | 73 | print_address((uintptr_t)addr, info); |
636bd289 PM |
74 | } |
75 | ||
12b6e9b2 RH |
76 | /* Stub prevents some fruitless earching in optabs disassemblers. */ |
77 | static int symbol_at_address(bfd_vma addr, struct disassemble_info *info) | |
aa0aa4fa | 78 | { |
12b6e9b2 | 79 | return 1; |
aa0aa4fa FB |
80 | } |
81 | ||
c46ffd57 RH |
82 | static int print_insn_objdump(bfd_vma pc, disassemble_info *info, |
83 | const char *prefix) | |
84 | { | |
85 | int i, n = info->buffer_length; | |
90bbf9d9 AB |
86 | g_autofree uint8_t *buf = g_malloc(n); |
87 | ||
88 | if (info->read_memory_func(pc, buf, n, info) == 0) { | |
89 | for (i = 0; i < n; ++i) { | |
90 | if (i % 32 == 0) { | |
91 | info->fprintf_func(info->stream, "\n%s: ", prefix); | |
92 | } | |
93 | info->fprintf_func(info->stream, "%02x", buf[i]); | |
c46ffd57 | 94 | } |
90bbf9d9 AB |
95 | } else { |
96 | info->fprintf_func(info->stream, "unable to read memory"); | |
c46ffd57 | 97 | } |
c46ffd57 RH |
98 | return n; |
99 | } | |
100 | ||
101 | static int print_insn_od_host(bfd_vma pc, disassemble_info *info) | |
102 | { | |
103 | return print_insn_objdump(pc, info, "OBJD-H"); | |
104 | } | |
105 | ||
106 | static int print_insn_od_target(bfd_vma pc, disassemble_info *info) | |
107 | { | |
108 | return print_insn_objdump(pc, info, "OBJD-T"); | |
109 | } | |
110 | ||
12b6e9b2 RH |
111 | static void initialize_debug(CPUDebug *s) |
112 | { | |
113 | memset(s, 0, sizeof(*s)); | |
114 | s->info.arch = bfd_arch_unknown; | |
115 | s->info.cap_arch = -1; | |
116 | s->info.cap_insn_unit = 4; | |
117 | s->info.cap_insn_split = 4; | |
118 | s->info.memory_error_func = perror_memory; | |
119 | s->info.symbol_at_address_func = symbol_at_address; | |
120 | } | |
121 | ||
122 | static void initialize_debug_target(CPUDebug *s, CPUState *cpu) | |
123 | { | |
124 | initialize_debug(s); | |
125 | ||
126 | s->cpu = cpu; | |
127 | s->info.read_memory_func = target_read_memory; | |
128 | s->info.print_address_func = print_address; | |
ee3eb3a7 | 129 | #if TARGET_BIG_ENDIAN |
12b6e9b2 RH |
130 | s->info.endian = BFD_ENDIAN_BIG; |
131 | #else | |
132 | s->info.endian = BFD_ENDIAN_LITTLE; | |
133 | #endif | |
134 | ||
135 | CPUClass *cc = CPU_GET_CLASS(cpu); | |
136 | if (cc->disas_set_info) { | |
137 | cc->disas_set_info(cpu, &s->info); | |
138 | } | |
139 | } | |
140 | ||
141 | static void initialize_debug_host(CPUDebug *s) | |
142 | { | |
143 | initialize_debug(s); | |
144 | ||
145 | s->info.read_memory_func = host_read_memory; | |
146 | s->info.print_address_func = host_print_address; | |
e03b5686 | 147 | #if HOST_BIG_ENDIAN |
12b6e9b2 RH |
148 | s->info.endian = BFD_ENDIAN_BIG; |
149 | #else | |
150 | s->info.endian = BFD_ENDIAN_LITTLE; | |
151 | #endif | |
152 | #if defined(CONFIG_TCG_INTERPRETER) | |
153 | s->info.print_insn = print_insn_tci; | |
154 | #elif defined(__i386__) | |
155 | s->info.mach = bfd_mach_i386_i386; | |
12b6e9b2 RH |
156 | s->info.cap_arch = CS_ARCH_X86; |
157 | s->info.cap_mode = CS_MODE_32; | |
158 | s->info.cap_insn_unit = 1; | |
159 | s->info.cap_insn_split = 8; | |
160 | #elif defined(__x86_64__) | |
161 | s->info.mach = bfd_mach_x86_64; | |
12b6e9b2 RH |
162 | s->info.cap_arch = CS_ARCH_X86; |
163 | s->info.cap_mode = CS_MODE_64; | |
164 | s->info.cap_insn_unit = 1; | |
165 | s->info.cap_insn_split = 8; | |
166 | #elif defined(_ARCH_PPC) | |
12b6e9b2 RH |
167 | s->info.cap_arch = CS_ARCH_PPC; |
168 | # ifdef _ARCH_PPC64 | |
169 | s->info.cap_mode = CS_MODE_64; | |
170 | # endif | |
171 | #elif defined(__riscv) && defined(CONFIG_RISCV_DIS) | |
172 | #if defined(_ILP32) || (__riscv_xlen == 32) | |
173 | s->info.print_insn = print_insn_riscv32; | |
174 | #elif defined(_LP64) | |
175 | s->info.print_insn = print_insn_riscv64; | |
176 | #else | |
177 | #error unsupported RISC-V ABI | |
178 | #endif | |
a4038a00 | 179 | #elif defined(__aarch64__) |
12b6e9b2 RH |
180 | s->info.cap_arch = CS_ARCH_ARM64; |
181 | #elif defined(__alpha__) | |
182 | s->info.print_insn = print_insn_alpha; | |
183 | #elif defined(__sparc__) | |
184 | s->info.print_insn = print_insn_sparc; | |
185 | s->info.mach = bfd_mach_sparc_v9b; | |
186 | #elif defined(__arm__) | |
187 | /* TCG only generates code for arm mode. */ | |
12b6e9b2 RH |
188 | s->info.cap_arch = CS_ARCH_ARM; |
189 | #elif defined(__MIPSEB__) | |
190 | s->info.print_insn = print_insn_big_mips; | |
191 | #elif defined(__MIPSEL__) | |
192 | s->info.print_insn = print_insn_little_mips; | |
193 | #elif defined(__m68k__) | |
194 | s->info.print_insn = print_insn_m68k; | |
195 | #elif defined(__s390__) | |
3d562845 RH |
196 | s->info.cap_arch = CS_ARCH_SYSZ; |
197 | s->info.cap_insn_unit = 2; | |
198 | s->info.cap_insn_split = 6; | |
12b6e9b2 RH |
199 | #elif defined(__hppa__) |
200 | s->info.print_insn = print_insn_hppa; | |
201 | #endif | |
202 | } | |
203 | ||
1d48474d | 204 | /* Disassemble this for me please... (debugging). */ |
d49190c4 | 205 | void target_disas(FILE *out, CPUState *cpu, target_ulong code, |
1d48474d | 206 | target_ulong size) |
b9adb4a6 | 207 | { |
c27004ec | 208 | target_ulong pc; |
b9adb4a6 | 209 | int count; |
f4359b9f | 210 | CPUDebug s; |
b9adb4a6 | 211 | |
12b6e9b2 RH |
212 | initialize_debug_target(&s, cpu); |
213 | s.info.fprintf_func = fprintf; | |
214 | s.info.stream = out; | |
f4359b9f BS |
215 | s.info.buffer_vma = code; |
216 | s.info.buffer_length = size; | |
37b9de46 | 217 | |
8ca80760 RH |
218 | if (s.info.cap_arch >= 0 && cap_disas_target(&s.info, code, size)) { |
219 | return; | |
220 | } | |
221 | ||
2de295c5 PC |
222 | if (s.info.print_insn == NULL) { |
223 | s.info.print_insn = print_insn_od_target; | |
c46ffd57 | 224 | } |
c6105c0a | 225 | |
7e000c2e | 226 | for (pc = code; size > 0; pc += count, size -= count) { |
fa15e030 | 227 | fprintf(out, "0x" TARGET_FMT_lx ": ", pc); |
2de295c5 | 228 | count = s.info.print_insn(pc, &s.info); |
c27004ec FB |
229 | fprintf(out, "\n"); |
230 | if (count < 0) | |
231 | break; | |
754d00ae | 232 | if (size < count) { |
233 | fprintf(out, | |
234 | "Disassembler disagrees with translator over instruction " | |
235 | "decoding\n" | |
236 | "Please report this to [email protected]\n"); | |
237 | break; | |
238 | } | |
c27004ec FB |
239 | } |
240 | } | |
241 | ||
4332099f | 242 | static int gstring_printf(FILE *stream, const char *fmt, ...) |
cbafa236 | 243 | { |
b71f3a68 RH |
244 | /* We abuse the FILE parameter to pass a GString. */ |
245 | GString *s = (GString *)stream; | |
cbafa236 | 246 | int initial_len = s->len; |
b71f3a68 | 247 | va_list va; |
cbafa236 AB |
248 | |
249 | va_start(va, fmt); | |
250 | g_string_append_vprintf(s, fmt, va); | |
251 | va_end(va); | |
252 | ||
253 | return s->len - initial_len; | |
254 | } | |
255 | ||
256 | static void plugin_print_address(bfd_vma addr, struct disassemble_info *info) | |
257 | { | |
258 | /* does nothing */ | |
259 | } | |
260 | ||
261 | ||
cbafa236 AB |
262 | /* |
263 | * We should only be dissembling one instruction at a time here. If | |
264 | * there is left over it usually indicates the front end has read more | |
265 | * bytes than it needed. | |
266 | */ | |
267 | char *plugin_disas(CPUState *cpu, uint64_t addr, size_t size) | |
268 | { | |
cbafa236 | 269 | CPUDebug s; |
b71f3a68 | 270 | GString *ds = g_string_new(NULL); |
cbafa236 | 271 | |
12b6e9b2 | 272 | initialize_debug_target(&s, cpu); |
4332099f | 273 | s.info.fprintf_func = gstring_printf; |
b71f3a68 | 274 | s.info.stream = (FILE *)ds; /* abuse this slot */ |
cbafa236 AB |
275 | s.info.buffer_vma = addr; |
276 | s.info.buffer_length = size; | |
277 | s.info.print_address_func = plugin_print_address; | |
cbafa236 AB |
278 | |
279 | if (s.info.cap_arch >= 0 && cap_disas_plugin(&s.info, addr, size)) { | |
b71f3a68 RH |
280 | ; /* done */ |
281 | } else if (s.info.print_insn) { | |
282 | s.info.print_insn(addr, &s.info); | |
283 | } else { | |
284 | ; /* cannot disassemble -- return empty string */ | |
cbafa236 AB |
285 | } |
286 | ||
b71f3a68 RH |
287 | /* Return the buffer, freeing the GString container. */ |
288 | return g_string_free(ds, false); | |
cbafa236 AB |
289 | } |
290 | ||
c27004ec | 291 | /* Disassemble this for me please... (debugging). */ |
f06176be | 292 | void disas(FILE *out, const void *code, unsigned long size) |
c27004ec | 293 | { |
b0b0f1c9 | 294 | uintptr_t pc; |
c27004ec | 295 | int count; |
f4359b9f | 296 | CPUDebug s; |
c27004ec | 297 | |
12b6e9b2 RH |
298 | initialize_debug_host(&s); |
299 | s.info.fprintf_func = fprintf; | |
300 | s.info.stream = out; | |
f4359b9f BS |
301 | s.info.buffer = code; |
302 | s.info.buffer_vma = (uintptr_t)code; | |
303 | s.info.buffer_length = size; | |
8ca80760 | 304 | |
4c389f6e | 305 | if (s.info.cap_arch >= 0 && cap_disas_host(&s.info, code, size)) { |
8ca80760 RH |
306 | return; |
307 | } | |
308 | ||
12b6e9b2 RH |
309 | if (s.info.print_insn == NULL) { |
310 | s.info.print_insn = print_insn_od_host; | |
c46ffd57 | 311 | } |
b0b0f1c9 SW |
312 | for (pc = (uintptr_t)code; size > 0; pc += count, size -= count) { |
313 | fprintf(out, "0x%08" PRIxPTR ": ", pc); | |
12b6e9b2 | 314 | count = s.info.print_insn(pc, &s.info); |
e5ef4ec2 AB |
315 | fprintf(out, "\n"); |
316 | if (count < 0) { | |
317 | break; | |
318 | } | |
b9adb4a6 | 319 | } |
e5ef4ec2 | 320 | |
b9adb4a6 FB |
321 | } |
322 | ||
323 | /* Look up symbol for debugging purpose. Returns "" if unknown. */ | |
c27004ec | 324 | const char *lookup_symbol(target_ulong orig_addr) |
b9adb4a6 | 325 | { |
49918a75 | 326 | const char *symbol = ""; |
e80cfcfc | 327 | struct syminfo *s; |
3b46e624 | 328 | |
e80cfcfc | 329 | for (s = syminfos; s; s = s->next) { |
49918a75 PB |
330 | symbol = s->lookup_symbol(s, orig_addr); |
331 | if (symbol[0] != '\0') { | |
332 | break; | |
333 | } | |
b9adb4a6 | 334 | } |
49918a75 PB |
335 | |
336 | return symbol; | |
b9adb4a6 | 337 | } |
9307c4c1 FB |
338 | |
339 | #if !defined(CONFIG_USER_ONLY) | |
340 | ||
83c9089e | 341 | #include "monitor/monitor.h" |
3d2cfdf1 | 342 | |
9307c4c1 | 343 | static int |
b8d87208 | 344 | physical_read_memory(bfd_vma memaddr, bfd_byte *myaddr, int length, |
a5f1b965 | 345 | struct disassemble_info *info) |
9307c4c1 | 346 | { |
f2c6abc8 | 347 | CPUDebug *s = container_of(info, CPUDebug, info); |
6766ba50 | 348 | MemTxResult res; |
f2c6abc8 | 349 | |
6766ba50 PMD |
350 | res = address_space_read(s->cpu->as, memaddr, MEMTXATTRS_UNSPECIFIED, |
351 | myaddr, length); | |
352 | return res == MEMTX_OK ? 0 : EIO; | |
9307c4c1 FB |
353 | } |
354 | ||
1d48474d | 355 | /* Disassembler for the monitor. */ |
d49190c4 | 356 | void monitor_disas(Monitor *mon, CPUState *cpu, |
1d48474d | 357 | target_ulong pc, int nb_insn, int is_physical) |
9307c4c1 | 358 | { |
9307c4c1 | 359 | int count, i; |
f4359b9f | 360 | CPUDebug s; |
4332099f | 361 | g_autoptr(GString) ds = g_string_new(""); |
9307c4c1 | 362 | |
12b6e9b2 | 363 | initialize_debug_target(&s, cpu); |
4332099f AB |
364 | s.info.fprintf_func = gstring_printf; |
365 | s.info.stream = (FILE *)ds; /* abuse this slot */ | |
366 | ||
12b6e9b2 RH |
367 | if (is_physical) { |
368 | s.info.read_memory_func = physical_read_memory; | |
37b9de46 | 369 | } |
12b6e9b2 | 370 | s.info.buffer_vma = pc; |
37b9de46 | 371 | |
8ca80760 | 372 | if (s.info.cap_arch >= 0 && cap_disas_monitor(&s.info, pc, nb_insn)) { |
4332099f | 373 | monitor_puts(mon, ds->str); |
8ca80760 RH |
374 | return; |
375 | } | |
376 | ||
37b9de46 PC |
377 | if (!s.info.print_insn) { |
378 | monitor_printf(mon, "0x" TARGET_FMT_lx | |
379 | ": Asm output not supported on this arch\n", pc); | |
380 | return; | |
381 | } | |
9307c4c1 | 382 | |
4332099f AB |
383 | for (i = 0; i < nb_insn; i++) { |
384 | g_string_append_printf(ds, "0x" TARGET_FMT_lx ": ", pc); | |
2de295c5 | 385 | count = s.info.print_insn(pc, &s.info); |
4332099f AB |
386 | g_string_append_c(ds, '\n'); |
387 | if (count < 0) { | |
388 | break; | |
389 | } | |
9307c4c1 FB |
390 | pc += count; |
391 | } | |
4332099f AB |
392 | |
393 | monitor_puts(mon, ds->str); | |
9307c4c1 FB |
394 | } |
395 | #endif |