2 * Debugger memory handling
4 * Copyright 1993 Eric Youngdale
5 * Copyright 1995 Alexandre Julliard
6 * Copyright 2000-2005 Eric Pouech
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
24 #include "wine/port.h"
31 #include "wine/debug.h"
33 WINE_DEFAULT_DEBUG_CHANNEL(winedbg);
35 void* be_cpu_linearize(HANDLE hThread, const ADDRESS64* addr)
37 assert(addr->Mode == AddrModeFlat);
38 return (void*)(DWORD_PTR)addr->Offset;
41 unsigned be_cpu_build_addr(HANDLE hThread, const CONTEXT* ctx, ADDRESS64* addr,
42 unsigned seg, unsigned long offset)
44 addr->Mode = AddrModeFlat;
45 addr->Segment = 0; /* don't need segment */
46 addr->Offset = offset;
50 void* memory_to_linear_addr(const ADDRESS64* addr)
52 return be_cpu->linearize(dbg_curr_thread->handle, addr);
55 BOOL memory_get_current_pc(ADDRESS64* addr)
57 assert(be_cpu->get_addr);
58 return be_cpu->get_addr(dbg_curr_thread->handle, &dbg_context,
59 be_cpu_addr_pc, addr);
62 BOOL memory_get_current_stack(ADDRESS64* addr)
64 assert(be_cpu->get_addr);
65 return be_cpu->get_addr(dbg_curr_thread->handle, &dbg_context,
66 be_cpu_addr_stack, addr);
69 BOOL memory_get_current_frame(ADDRESS64* addr)
71 assert(be_cpu->get_addr);
72 return be_cpu->get_addr(dbg_curr_thread->handle, &dbg_context,
73 be_cpu_addr_frame, addr);
76 static void memory_report_invalid_addr(const void* addr)
80 address.Mode = AddrModeFlat;
82 address.Offset = (unsigned long)addr;
83 dbg_printf("*** Invalid address ");
84 print_address(&address, FALSE);
88 /***********************************************************************
91 * Read a memory value.
93 BOOL memory_read_value(const struct dbg_lvalue* lvalue, DWORD size, void* result)
97 if (lvalue->cookie == DLV_TARGET)
99 void* linear = memory_to_linear_addr(&lvalue->addr);
100 if (!(ret = dbg_read_memory(linear, result, size)))
101 memory_report_invalid_addr(linear);
105 if (lvalue->addr.Offset)
107 memcpy(result, (void*)(DWORD_PTR)lvalue->addr.Offset, size);
114 /***********************************************************************
117 * Store a value in memory.
119 BOOL memory_write_value(const struct dbg_lvalue* lvalue, DWORD size, void* value)
124 if (!types_get_info(&lvalue->type, TI_GET_LENGTH, &os)) return FALSE;
127 dbg_printf("Size mismatch in memory_write_value, got %u from type while expecting %u\n",
132 /* FIXME: only works on little endian systems */
133 if (lvalue->cookie == DLV_TARGET)
135 void* linear = memory_to_linear_addr(&lvalue->addr);
136 if (!(ret = dbg_write_memory(linear, value, size)))
137 memory_report_invalid_addr(linear);
141 memcpy((void*)(DWORD_PTR)lvalue->addr.Offset, value, size);
146 /***********************************************************************
149 * Implementation of the 'x' command.
151 void memory_examine(const struct dbg_lvalue *lvalue, int count, char format)
158 types_extract_as_address(lvalue, &addr);
159 linear = memory_to_linear_addr(&addr);
161 if (format != 'i' && count > 1)
163 print_address(&addr, FALSE);
170 if (count == 1) count = 256;
171 memory_get_string(dbg_curr_process, linear,
172 TRUE, TRUE, buffer, min(count, sizeof(buffer)));
173 dbg_printf("%s\n", buffer);
176 if (count == 1) count = 256;
177 memory_get_string(dbg_curr_process, linear,
178 TRUE, FALSE, buffer, min(count, sizeof(buffer)));
179 dbg_printf("%s\n", buffer);
182 while (count-- && memory_disasm_one_insn(&addr));
188 if (!dbg_read_memory(linear, &guid, sizeof(guid)))
190 memory_report_invalid_addr(linear);
193 dbg_printf("{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}\n",
194 guid.Data1, guid.Data2, guid.Data3,
195 guid.Data4[0], guid.Data4[1], guid.Data4[2], guid.Data4[3],
196 guid.Data4[4], guid.Data4[5], guid.Data4[6], guid.Data4[7]);
197 linear = (char*)linear + sizeof(guid);
198 addr.Offset += sizeof(guid);
201 print_address(&addr, FALSE);
207 #define DO_DUMP2(_t,_l,_f,_vv) { \
209 for (i = 0; i < count; i++) { \
210 if (!dbg_read_memory(linear, &_v, sizeof(_t))) \
211 { memory_report_invalid_addr(linear); break; } \
212 dbg_printf(_f, (_vv)); \
213 addr.Offset += sizeof(_t); \
214 linear = (char*)linear + sizeof(_t); \
215 if ((i % (_l)) == (_l) - 1 && i != count - 1) \
218 print_address(&addr, FALSE); \
224 #define DO_DUMP(_t,_l,_f) DO_DUMP2(_t,_l,_f,_v)
226 case 'x': DO_DUMP(int, 4, " %8.8x"); break;
227 case 'd': DO_DUMP(unsigned int, 4, " %4.4d"); break;
228 case 'w': DO_DUMP(unsigned short, 8, " %04x"); break;
230 if (sizeof(DWORD_PTR) == 4)
232 DO_DUMP(DWORD_PTR, 4, " %8.8lx");
236 DO_DUMP(DWORD_PTR, 2, " %16.16lx");
239 case 'c': DO_DUMP2(char, 32, " %c", (_v < 0x20) ? ' ' : _v); break;
240 case 'b': DO_DUMP2(char, 16, " %02x", (_v) & 0xff); break;
244 BOOL memory_get_string(struct dbg_process* pcs, void* addr, BOOL in_debuggee,
245 BOOL unicode, char* buffer, int size)
251 if (!addr) return FALSE;
256 if (!unicode) ret = pcs->process_io->read(pcs->handle, addr, buffer, size, &sz);
259 buffW = HeapAlloc(GetProcessHeap(), 0, size * sizeof(WCHAR));
260 ret = pcs->process_io->read(pcs->handle, addr, buffW, size * sizeof(WCHAR), &sz);
261 WideCharToMultiByte(CP_ACP, 0, buffW, sz / sizeof(WCHAR), buffer, size,
263 HeapFree(GetProcessHeap(), 0, buffW);
265 if (size) buffer[size-1] = 0;
270 lstrcpynA(buffer, addr, size);
275 BOOL memory_get_string_indirect(struct dbg_process* pcs, void* addr, BOOL unicode, WCHAR* buffer, int size)
282 pcs->process_io->read(pcs->handle, addr, &ad, sizeof(ad), &sz) && sz == sizeof(ad) && ad)
288 ret = pcs->process_io->read(pcs->handle, ad, buffer, size * sizeof(WCHAR), &sz) && sz != 0;
291 if ((buff = HeapAlloc(GetProcessHeap(), 0, size)))
293 ret = pcs->process_io->read(pcs->handle, ad, buff, size, &sz) && sz != 0;
294 MultiByteToWideChar(CP_ACP, 0, buff, sz, buffer, size);
295 HeapFree(GetProcessHeap(), 0, buff);
299 if (size) buffer[size-1] = 0;
306 * Convert an address offset to hex string. If mode == 32, treat offset as
307 * 32 bits (discard upper 32 bits), if mode == 64 use all 64 bits, if mode == 0
308 * treat as either 32 or 64 bits, depending on whether we're running as
311 char* memory_offset_to_string(char *str, DWORD64 offset, unsigned mode)
313 if (mode != 32 && mode != 64)
323 sprintf(str, "0x%08x", (unsigned int) offset);
325 sprintf(str, "0x%08x%08x", (unsigned int)(offset >> 32),
326 (unsigned int)offset);
331 static void dbg_print_longlong(LONGLONG sv, BOOL is_signed)
333 char tmp[24], *ptr = tmp + sizeof(tmp) - 1;
336 if (is_signed && sv < 0) uv = -sv;
337 else { uv = sv; is_signed = FALSE; }
338 for (div = 10; uv; div *= 10, uv /= 10)
339 *--ptr = '0' + (uv % 10);
340 if (ptr == tmp + sizeof(tmp) - 1) *--ptr = '0';
341 if (is_signed) *--ptr = '-';
342 dbg_printf("%s", ptr);
345 static void dbg_print_hex(DWORD size, ULONGLONG sv)
349 else if (size > 4 && (sv >> 32))
350 dbg_printf("0x%x%08x", (DWORD)(sv >> 32), (DWORD)sv);
352 dbg_printf("0x%x", (DWORD)sv);
355 static void print_typed_basic(const struct dbg_lvalue* lvalue)
359 long double val_real;
361 DWORD tag, size, count, bt;
362 struct dbg_type type = lvalue->type;
363 struct dbg_type sub_type;
364 struct dbg_lvalue sub_lvalue;
366 if (!types_get_real_type(&type, &tag)) return;
371 if (!types_get_info(&type, TI_GET_LENGTH, &size64) ||
372 !types_get_info(&type, TI_GET_BASETYPE, &bt))
374 WINE_ERR("Couldn't get information\n");
375 RaiseException(DEBUG_STATUS_INTERNAL_ERROR, 0, 0, NULL);
377 size = (DWORD)size64;
382 if (!be_cpu->fetch_integer(lvalue, size, TRUE, &val_int)) return;
383 if (size == 1) goto print_char;
384 dbg_print_hex(size, val_int);
388 if (!be_cpu->fetch_integer(lvalue, size, FALSE, &val_int)) return;
389 dbg_print_hex(size, val_int);
392 if (!be_cpu->fetch_float(lvalue, size, &val_real)) return;
393 dbg_printf("%Lf", val_real);
396 if (!be_cpu->fetch_integer(lvalue, size, TRUE, &val_int)) return;
397 /* FIXME: should do the same for a Unicode character (size == 2) */
399 if (size == 1 && (val_int < 0x20 || val_int > 0x80))
400 dbg_printf("%d", (int)val_int);
403 WCHAR wch = (WCHAR)val_int;
404 dbg_outputW(&wch, 1);
407 dbg_printf("'%c'", (char)val_int);
410 if (!be_cpu->fetch_integer(lvalue, size, TRUE, &val_int)) return;
411 dbg_printf("%s", val_int ? "true" : "false");
414 WINE_FIXME("Unsupported basetype %u\n", bt);
418 case SymTagPointerType:
419 if (!types_array_index(lvalue, 0, &sub_lvalue))
421 dbg_printf("Internal symbol error: unable to access memory location %p",
422 memory_to_linear_addr(&lvalue->addr));
425 val_ptr = memory_to_linear_addr(&sub_lvalue.addr);
426 if (types_get_real_type(&sub_lvalue.type, &tag) && tag == SymTagBaseType &&
427 types_get_info(&sub_lvalue.type, TI_GET_BASETYPE, &bt) &&
428 types_get_info(&sub_lvalue.type, TI_GET_LENGTH, &size64))
432 if (!val_ptr) dbg_printf("0x0");
433 else if (((bt == btChar || bt == btInt) && size64 == 1) || (bt == btUInt && size64 == 2))
435 if (memory_get_string(dbg_curr_process, val_ptr, sub_lvalue.cookie == DLV_TARGET,
436 size64 == 2, buffer, sizeof(buffer)))
437 dbg_printf("\"%s\"", buffer);
439 dbg_printf("*** invalid address %p ***", val_ptr);
443 dbg_printf("%p", val_ptr);
445 case SymTagArrayType:
447 if (!memory_read_value(lvalue, sizeof(val_ptr), &val_ptr)) return;
448 dbg_printf("%p", val_ptr);
454 /* FIXME: it depends on underlying type for enums
455 * (not supported yet in dbghelp)
456 * Assuming 4 as for an int
458 if (!be_cpu->fetch_integer(lvalue, 4, TRUE, &val_int)) return;
460 if (types_get_info(&type, TI_GET_CHILDRENCOUNT, &count))
462 char buffer[sizeof(TI_FINDCHILDREN_PARAMS) + 256 * sizeof(DWORD)];
463 TI_FINDCHILDREN_PARAMS* fcp = (TI_FINDCHILDREN_PARAMS*)buffer;
472 fcp->Count = min(count, 256);
473 if (types_get_info(&type, TI_FINDCHILDREN, fcp))
475 sub_type.module = type.module;
476 for (i = 0; i < min(fcp->Count, count); i++)
478 sub_type.id = fcp->ChildId[i];
479 if (!types_get_info(&sub_type, TI_GET_VALUE, &variant))
481 switch (variant.n1.n2.vt)
483 case VT_I4: ok = (val_int == variant.n1.n2.n3.lVal); break;
484 default: WINE_FIXME("Unsupported variant type (%u)\n", variant.n1.n2.vt);
489 types_get_info(&sub_type, TI_GET_SYMNAME, &ptr);
491 WideCharToMultiByte(CP_ACP, 0, ptr, -1, tmp, sizeof(tmp), NULL, NULL);
492 HeapFree(GetProcessHeap(), 0, ptr);
493 dbg_printf("%s", tmp);
494 count = 0; /* so that we'll get away from outter loop */
499 count -= min(count, 256);
503 if (!ok) dbg_print_longlong(val_int, TRUE);
507 WINE_FIXME("Unsupported tag %u\n", tag);
512 /***********************************************************************
515 * Implementation of the 'print' command.
517 void print_basic(const struct dbg_lvalue* lvalue, char format)
519 if (lvalue->type.id == dbg_itype_none)
521 dbg_printf("Unable to evaluate expression\n");
528 LONGLONG res = types_extract_as_longlong(lvalue, &size);
534 dbg_print_hex(size, (ULONGLONG)res);
538 dbg_print_longlong(res, TRUE);
542 dbg_printf("%d = '%c'", (char)(res & 0xff), (char)(res & 0xff));
546 wch = (WCHAR)(res & 0xFFFF);
547 dbg_printf("%d = '", wch);
548 dbg_outputW(&wch, 1);
556 dbg_printf("Format specifier '%c' is meaningless in 'print' command\n", format);
559 if (lvalue->type.id == dbg_itype_segptr)
561 dbg_print_longlong(types_extract_as_longlong(lvalue, NULL), TRUE);
563 else print_typed_basic(lvalue);
566 void print_bare_address(const ADDRESS64* addr)
568 char hexbuf[MAX_OFFSET_TO_STR_LEN];
573 dbg_printf("%s", memory_offset_to_string(hexbuf, addr->Offset, 0));
577 dbg_printf("0x%04x:0x%04x", addr->Segment, (unsigned) addr->Offset);
580 dbg_printf("0x%04x:%s", addr->Segment,
581 memory_offset_to_string(hexbuf, addr->Offset, 32));
584 dbg_printf("Unknown mode %x\n", addr->Mode);
589 /***********************************************************************
592 * Print an 16- or 32-bit address, with the nearest symbol if any.
594 void print_address(const ADDRESS64* addr, BOOLEAN with_line)
596 char buffer[sizeof(SYMBOL_INFO) + 256];
597 SYMBOL_INFO* si = (SYMBOL_INFO*)buffer;
598 void* lin = memory_to_linear_addr(addr);
602 print_bare_address(addr);
604 si->SizeOfStruct = sizeof(*si);
605 si->MaxNameLen = 256;
606 if (!SymFromAddr(dbg_curr_process->handle, (DWORD_PTR)lin, &disp64, si)) return;
607 dbg_printf(" %s", si->Name);
608 if (disp64) dbg_printf("+0x%lx", (DWORD_PTR)disp64);
614 il.SizeOfStruct = sizeof(il);
615 if (SymGetLineFromAddr64(dbg_curr_process->handle, (DWORD_PTR)lin, &disp, &il))
616 dbg_printf(" [%s:%u]", il.FileName, il.LineNumber);
617 im.SizeOfStruct = sizeof(im);
618 if (SymGetModuleInfo(dbg_curr_process->handle, (DWORD_PTR)lin, &im))
619 dbg_printf(" in %s", im.ModuleName);
623 BOOL memory_disasm_one_insn(ADDRESS64* addr)
627 print_address(addr, TRUE);
629 if (!dbg_read_memory(memory_to_linear_addr(addr), &ch, sizeof(ch)))
631 dbg_printf("-- no code accessible --\n");
634 be_cpu->disasm_one_insn(addr, TRUE);
639 void memory_disassemble(const struct dbg_lvalue* xstart,
640 const struct dbg_lvalue* xend, int instruction_count)
642 static ADDRESS64 last = {0,0,0};
646 if (!xstart && !xend)
648 if (!last.Segment && !last.Offset) memory_get_current_pc(&last);
653 types_extract_as_address(xstart, &last);
655 stop = types_extract_as_integer(xend);
657 for (i = 0; (instruction_count == 0 || i < instruction_count) &&
658 (stop == 0 || last.Offset <= stop); i++)
659 memory_disasm_one_insn(&last);
662 BOOL memory_get_register(DWORD regno, DWORD_PTR** value, char* buffer, int len)
664 const struct dbg_internal_var* div;
666 /* negative register values are wine's dbghelp hacks
667 * see dlls/dbghelp/dbghelp_private.h for the details
672 if (buffer) snprintf(buffer, len, "<internal error>");
675 if (buffer) snprintf(buffer, len, "<couldn't compute location>");
678 if (buffer) snprintf(buffer, len, "<is not available>");
681 if (buffer) snprintf(buffer, len, "<couldn't read memory>");
684 if (buffer) snprintf(buffer, len, "<has been optimized away by compiler>");
688 for (div = be_cpu->context_vars; div->name; div++)
690 if (div->val == regno)
692 if (!stack_get_register_frame(div, value))
694 if (buffer) snprintf(buffer, len, "<register %s not accessible in this frame>", div->name);
698 if (buffer) lstrcpynA(buffer, div->name, len);
702 if (buffer) snprintf(buffer, len, "<unknown register %u>", regno);