programs/winedbg/memory.c

   1 /*
   2  * Debugger memory handling
   3  *
   4  * Copyright 1993 Eric Youngdale
   5  * Copyright 1995 Alexandre Julliard
   6  * Copyright 2000-2005 Eric Pouech
   7  *
   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.
  12  *
  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.
  17  *
  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
  21  */
  22
  23 #include "config.h"
  24 #include "wine/port.h"
  25
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <stdio.h>
  29
  30 #include "debugger.h"
  31 #include "wine/debug.h"
  32
  33 WINE_DEFAULT_DEBUG_CHANNEL(winedbg);
  34
  35 void* be_cpu_linearize(HANDLE hThread, const ADDRESS64* addr)
  36 {
  37     assert(addr->Mode == AddrModeFlat);
  38     return (void*)(DWORD_PTR)addr->Offset;
  39 }
  40
  41 unsigned be_cpu_build_addr(HANDLE hThread, const CONTEXT* ctx, ADDRESS64* addr,
  42                            unsigned seg, unsigned long offset)
  43 {
  44     addr->Mode    = AddrModeFlat;
  45     addr->Segment = 0; /* don't need segment */
  46     addr->Offset  = offset;
  47     return TRUE;
  48 }
  49
  50 void* memory_to_linear_addr(const ADDRESS64* addr)
  51 {
  52     return be_cpu->linearize(dbg_curr_thread->handle, addr);
  53 }
  54
  55 BOOL memory_get_current_pc(ADDRESS64* addr)
  56 {
  57     assert(be_cpu->get_addr);
  58     return be_cpu->get_addr(dbg_curr_thread->handle, &dbg_context,
  59                             be_cpu_addr_pc, addr);
  60 }
  61
  62 BOOL memory_get_current_stack(ADDRESS64* addr)
  63 {
  64     assert(be_cpu->get_addr);
  65     return be_cpu->get_addr(dbg_curr_thread->handle, &dbg_context,
  66                             be_cpu_addr_stack, addr);
  67 }
  68
  69 BOOL memory_get_current_frame(ADDRESS64* addr)
  70 {
  71     assert(be_cpu->get_addr);
  72     return be_cpu->get_addr(dbg_curr_thread->handle, &dbg_context,
  73                             be_cpu_addr_frame, addr);
  74 }
  75
  76 static void     memory_report_invalid_addr(const void* addr)
  77 {
  78     ADDRESS64   address;
  79
  80     address.Mode    = AddrModeFlat;
  81     address.Segment = 0;
  82     address.Offset  = (unsigned long)addr;
  83     dbg_printf("*** Invalid address ");
  84     print_address(&address, FALSE);
  85     dbg_printf("\n");
  86 }
  87
  88 /***********************************************************************
  89  *           memory_read_value
  90  *
  91  * Read a memory value.
  92  */
  93 BOOL memory_read_value(const struct dbg_lvalue* lvalue, DWORD size, void* result)
  94 {
  95     BOOL ret = FALSE;
  96
  97     if (lvalue->cookie == DLV_TARGET)
  98     {
  99         void*   linear = memory_to_linear_addr(&lvalue->addr);
 100         if (!(ret = dbg_read_memory(linear, result, size)))
 101             memory_report_invalid_addr(linear);
 102     }
 103     else
 104     {
 105         if (lvalue->addr.Offset)
 106         {
 107             memcpy(result, (void*)(DWORD_PTR)lvalue->addr.Offset, size);
 108             ret = TRUE;
 109         }
 110     }
 111     return TRUE;
 112 }
 113
 114 /***********************************************************************
 115  *           memory_write_value
 116  *
 117  * Store a value in memory.
 118  */
 119 BOOL memory_write_value(const struct dbg_lvalue* lvalue, DWORD size, void* value)
 120 {
 121     BOOL        ret = TRUE;
 122     DWORD64     os;
 123
 124     os = ~(DWORD64)size;
 125     types_get_info(&lvalue->type, TI_GET_LENGTH, &os);
 126     assert(size == os);
 127
 128     /* FIXME: only works on little endian systems */
 129     if (lvalue->cookie == DLV_TARGET)
 130     {
 131         void*       linear = memory_to_linear_addr(&lvalue->addr);
 132         if (!(ret = dbg_write_memory(linear, value, size)))
 133             memory_report_invalid_addr(linear);
 134     }
 135     else
 136     {
 137         memcpy((void*)(DWORD_PTR)lvalue->addr.Offset, value, size);
 138     }
 139     return ret;
 140 }
 141
 142 /***********************************************************************
 143  *           memory_examine
 144  *
 145  * Implementation of the 'x' command.
 146  */
 147 void memory_examine(const struct dbg_lvalue *lvalue, int count, char format)
 148 {
 149     int                 i;
 150     char                buffer[256];
 151     ADDRESS64           addr;
 152     void               *linear;
 153
 154     types_extract_as_address(lvalue, &addr);
 155     linear = memory_to_linear_addr(&addr);
 156
 157     if (format != 'i' && count > 1)
 158     {
 159         print_address(&addr, FALSE);
 160         dbg_printf(": ");
 161     }
 162
 163     switch (format)
 164     {
 165     case 'u':
 166         if (count == 1) count = 256;
 167         memory_get_string(dbg_curr_process, linear,
 168                           TRUE, TRUE, buffer, min(count, sizeof(buffer)));
 169         dbg_printf("%s\n", buffer);
 170         return;
 171     case 's':
 172         if (count == 1) count = 256;
 173         memory_get_string(dbg_curr_process, linear,
 174                           TRUE, FALSE, buffer, min(count, sizeof(buffer)));
 175         dbg_printf("%s\n", buffer);
 176         return;
 177     case 'i':
 178         while (count-- && memory_disasm_one_insn(&addr));
 179         return;
 180     case 'g':
 181         while (count--)
 182         {
 183             GUID guid;
 184             if (!dbg_read_memory(linear, &guid, sizeof(guid)))
 185             {
 186                 memory_report_invalid_addr(linear);
 187                 break;
 188             }
 189             dbg_printf("{%08lx-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}\n",
 190                        guid.Data1, guid.Data2, guid.Data3,
 191                        guid.Data4[0], guid.Data4[1], guid.Data4[2], guid.Data4[3],
 192                        guid.Data4[4], guid.Data4[5], guid.Data4[6], guid.Data4[7]);
 193             linear = (char*)linear + sizeof(guid);
 194             addr.Offset += sizeof(guid);
 195             if (count)
 196             {
 197                 print_address(&addr, FALSE);
 198                 dbg_printf(": ");
 199             }
 200         }
 201         return;
 202
 203 #define DO_DUMP2(_t,_l,_f,_vv) {                                        \
 204             _t _v;                                                      \
 205             for (i = 0; i < count; i++) {                               \
 206                 if (!dbg_read_memory(linear, &_v, sizeof(_t)))          \
 207                 { memory_report_invalid_addr(linear); break; }          \
 208                 dbg_printf(_f, (_vv));                                  \
 209                 addr.Offset += sizeof(_t);                              \
 210                 linear = (char*)linear + sizeof(_t);                    \
 211                 if ((i % (_l)) == (_l) - 1 && i != count - 1)           \
 212                 {                                                       \
 213                     dbg_printf("\n");                                   \
 214                     print_address(&addr, FALSE);                        \
 215                     dbg_printf(": ");                                   \
 216                 }                                                       \
 217             }                                                           \
 218             dbg_printf("\n");                                           \
 219         }                                                               \
 220         return
 221 #define DO_DUMP(_t,_l,_f) DO_DUMP2(_t,_l,_f,_v)
 222
 223     case 'x': DO_DUMP(int, 4, " %8.8x");
 224     case 'd': DO_DUMP(unsigned int, 4, " %10d");
 225     case 'w': DO_DUMP(unsigned short, 8, " %04x");
 226     case 'c': DO_DUMP2(char, 32, " %c", (_v < 0x20) ? ' ' : _v);
 227     case 'b': DO_DUMP2(char, 16, " %02x", (_v) & 0xff);
 228     }
 229 }
 230
 231 BOOL memory_get_string(struct dbg_process* pcs, void* addr, BOOL in_debuggee,
 232                        BOOL unicode, char* buffer, int size)
 233 {
 234     SIZE_T      sz;
 235     WCHAR*      buffW;
 236
 237     buffer[0] = 0;
 238     if (!addr) return FALSE;
 239     if (in_debuggee)
 240     {
 241         BOOL ret;
 242
 243         if (!unicode) ret = pcs->process_io->read(pcs->handle, addr, buffer, size, &sz);
 244         else
 245         {
 246             buffW = HeapAlloc(GetProcessHeap(), 0, size * sizeof(WCHAR));
 247             ret = pcs->process_io->read(pcs->handle, addr, buffW, size * sizeof(WCHAR), &sz);
 248             WideCharToMultiByte(CP_ACP, 0, buffW, sz / sizeof(WCHAR), buffer, size,
 249                                 NULL, NULL);
 250             HeapFree(GetProcessHeap(), 0, buffW);
 251         }
 252         if (size) buffer[size-1] = 0;
 253         return ret;
 254     }
 255     else
 256     {
 257         lstrcpynA(buffer, addr, size);
 258     }
 259     return TRUE;
 260 }
 261
 262 BOOL memory_get_string_indirect(struct dbg_process* pcs, void* addr, BOOL unicode, char* buffer, int size)
 263 {
 264     void*       ad;
 265     SIZE_T      sz;
 266
 267     buffer[0] = 0;
 268     if (addr &&
 269         pcs->process_io->read(pcs->handle, addr, &ad, sizeof(ad), &sz) && sz == sizeof(ad) && ad)
 270     {
 271         return memory_get_string(pcs, ad, TRUE, unicode, buffer, size);
 272     }
 273     return FALSE;
 274 }
 275
 276 /*
 277  * Convert an address offset to hex string. If mode == 32, treat offset as
 278  * 32 bits (discard upper 32 bits), if mode == 64 use all 64 bits, if mode == 0
 279  * treat as either 32 or 64 bits, depending on whether we're running as
 280  * Wine32 or Wine64.
 281  */
 282 char* memory_offset_to_string(char *str, DWORD64 offset, unsigned mode)
 283 {
 284     if (mode != 32 && mode != 64)
 285     {
 286 #ifdef _WIN64
 287         mode = 64;
 288 #else
 289         mode = 32;
 290 #endif
 291     }
 292
 293     if (mode == 32)
 294         sprintf(str, "0x%08x", (unsigned int) offset);
 295     else
 296         sprintf(str, "0x%08x%08x", (unsigned int)(offset >> 32),
 297                 (unsigned int)offset);
 298
 299     return str;
 300 }
 301
 302 static void print_typed_basic(const struct dbg_lvalue* lvalue)
 303 {
 304     LONGLONG            val_int;
 305     void*               val_ptr;
 306     long double         val_real;
 307     DWORD64             size64;
 308     DWORD               tag, size, count, bt;
 309     struct dbg_type     type = lvalue->type;
 310     struct dbg_type     sub_type;
 311
 312     if (!types_get_real_type(&type, &tag)) return;
 313
 314     switch (tag)
 315     {
 316     case SymTagBaseType:
 317         if (!types_get_info(&type, TI_GET_LENGTH, &size64) ||
 318             !types_get_info(&type, TI_GET_BASETYPE, &bt))
 319         {
 320             WINE_ERR("Couldn't get information\n");
 321             RaiseException(DEBUG_STATUS_INTERNAL_ERROR, 0, 0, NULL);
 322         }
 323         size = (DWORD)size64;
 324         switch (bt)
 325         {
 326         case btInt:
 327             if (!be_cpu->fetch_integer(lvalue, size, TRUE, &val_int)) return;
 328             dbg_printf("%s", wine_dbgstr_longlong(val_int));
 329             break;
 330         case btUInt:
 331             if (!be_cpu->fetch_integer(lvalue, size, FALSE, &val_int)) return;
 332             dbg_printf("%s", wine_dbgstr_longlong(val_int));
 333             break;
 334         case btFloat:
 335             if (!be_cpu->fetch_float(lvalue, size, &val_real)) return;
 336             dbg_printf("%Lf", val_real);
 337             break;
 338         case btChar:
 339             if (!be_cpu->fetch_integer(lvalue, size, TRUE, &val_int)) return;
 340             /* FIXME: should do the same for a Unicode character (size == 2) */
 341             if (size == 1 && (val_int < 0x20 || val_int > 0x80))
 342                 dbg_printf("%d", (int)val_int);
 343             else
 344                 dbg_printf("'%c'", (char)val_int);
 345             break;
 346         default:
 347             WINE_FIXME("Unsupported basetype %lu\n", bt);
 348             break;
 349         }
 350         break;
 351     case SymTagPointerType:
 352         if (!memory_read_value(lvalue, sizeof(void*), &val_ptr)) return;
 353
 354         sub_type.module = lvalue->type.module;
 355         if (!types_get_info(&type, TI_GET_TYPE, &sub_type.id) ||
 356             sub_type.id == dbg_itype_none)
 357         {
 358             dbg_printf("Internal symbol error: unable to access memory location %p", val_ptr);
 359             break;
 360         }
 361         if (!types_get_real_type(&sub_type, &tag)) return;
 362
 363         if (types_get_info(&sub_type, TI_GET_SYMTAG, &tag) && tag == SymTagBaseType &&
 364             types_get_info(&sub_type, TI_GET_BASETYPE, &bt) && bt == btChar &&
 365             types_get_info(&sub_type, TI_GET_LENGTH, &size64))
 366         {
 367             char    buffer[1024];
 368
 369             if (!val_ptr) dbg_printf("0x0");
 370             else if (memory_get_string(dbg_curr_process, val_ptr,
 371                                        lvalue->cookie == DLV_TARGET,
 372                                        size64 == 2, buffer, sizeof(buffer)))
 373                 dbg_printf("\"%s\"", buffer);
 374             else
 375                 dbg_printf("*** invalid address %p ***", val_ptr);
 376         }
 377         else dbg_printf("%p", val_ptr);
 378         break;
 379     case SymTagArrayType:
 380     case SymTagUDT:
 381         assert(lvalue->cookie == DLV_TARGET);
 382         if (!memory_read_value(lvalue, sizeof(val_ptr), &val_ptr)) return;
 383         dbg_printf("%p", val_ptr);
 384         break;
 385     case SymTagEnum:
 386         {
 387             BOOL        ok = FALSE;
 388
 389             assert(lvalue->cookie == DLV_TARGET);
 390             /* FIXME: it depends on underlying type for enums
 391              * (not supported yet in dbghelp)
 392              * Assuming 4 as for an int
 393              */
 394             if (!be_cpu->fetch_integer(lvalue, 4, TRUE, &val_int)) return;
 395
 396             if (types_get_info(&type, TI_GET_CHILDRENCOUNT, &count))
 397             {
 398                 char                    buffer[sizeof(TI_FINDCHILDREN_PARAMS) + 256 * sizeof(DWORD)];
 399                 TI_FINDCHILDREN_PARAMS* fcp = (TI_FINDCHILDREN_PARAMS*)buffer;
 400                 WCHAR*                  ptr;
 401                 char                    tmp[256];
 402                 VARIANT                 variant;
 403                 int                     i;
 404
 405                 fcp->Start = 0;
 406                 while (count)
 407                 {
 408                     fcp->Count = min(count, 256);
 409                     if (types_get_info(&type, TI_FINDCHILDREN, fcp))
 410                     {
 411                         sub_type.module = type.module;
 412                         for (i = 0; i < min(fcp->Count, count); i++)
 413                         {
 414                             sub_type.id = fcp->ChildId[i];
 415                             if (!types_get_info(&sub_type, TI_GET_VALUE, &variant))
 416                                 continue;
 417                             switch (variant.n1.n2.vt)
 418                             {
 419                             case VT_I4: ok = (val_int == variant.n1.n2.n3.lVal); break;
 420                             default: WINE_FIXME("Unsupported variant type (%u)\n", variant.n1.n2.vt);
 421                             }
 422                             if (ok)
 423                             {
 424                                 ptr = NULL;
 425                                 types_get_info(&sub_type, TI_GET_SYMNAME, &ptr);
 426                                 if (!ptr) continue;
 427                                 WideCharToMultiByte(CP_ACP, 0, ptr, -1, tmp, sizeof(tmp), NULL, NULL);
 428                                 HeapFree(GetProcessHeap(), 0, ptr);
 429                                 dbg_printf("%s", tmp);
 430                                 count = 0; /* so that we'll get away from outter loop */
 431                                 break;
 432                             }
 433                         }
 434                     }
 435                 }
 436                 count -= min(count, 256);
 437                 fcp->Start += 256;
 438             }
 439             if (!ok) dbg_printf("%s", wine_dbgstr_longlong(val_int));
 440         }
 441         break;
 442     default:
 443         WINE_FIXME("Unsupported tag %lu\n", tag);
 444         break;
 445     }
 446 }
 447
 448 /***********************************************************************
 449  *           print_basic
 450  *
 451  * Implementation of the 'print' command.
 452  */
 453 void print_basic(const struct dbg_lvalue* lvalue, int count, char format)
 454 {
 455     long int    res;
 456
 457     if (lvalue->type.id == dbg_itype_none)
 458     {
 459         dbg_printf("Unable to evaluate expression\n");
 460         return;
 461     }
 462
 463     res = types_extract_as_integer(lvalue);
 464
 465     /* FIXME: this implies i386 byte ordering */
 466     switch (format)
 467     {
 468     case 'x':
 469         if (lvalue->addr.Mode == AddrMode1616 ||
 470             lvalue->addr.Mode == AddrModeReal)
 471             dbg_printf("0x%04lx", res);
 472         else
 473             dbg_printf("0x%08lx", res);
 474         break;
 475
 476     case 'd':
 477         dbg_printf("%ld\n", res);
 478         break;
 479
 480     case 'c':
 481         dbg_printf("%d = '%c'", (char)(res & 0xff), (char)(res & 0xff));
 482         break;
 483
 484     case 'u':
 485         {
 486             WCHAR wch = (WCHAR)(res & 0xFFFF);
 487             dbg_printf("%d = '", wch);
 488             dbg_outputW(&wch, 1);
 489             dbg_printf("'");
 490         }
 491         break;
 492
 493     case 'i':
 494     case 's':
 495     case 'w':
 496     case 'b':
 497         dbg_printf("Format specifier '%c' is meaningless in 'print' command\n", format);
 498     case 0:
 499         if (lvalue->type.id == dbg_itype_segptr)
 500             dbg_printf("%ld", res);
 501         else
 502             print_typed_basic(lvalue);
 503         break;
 504     }
 505 }
 506
 507 void print_bare_address(const ADDRESS64* addr)
 508 {
 509     char hexbuf[MAX_OFFSET_TO_STR_LEN];
 510
 511     switch (addr->Mode)
 512     {
 513     case AddrModeFlat:
 514         dbg_printf("%s", memory_offset_to_string(hexbuf, addr->Offset, 0));
 515         break;
 516     case AddrModeReal:
 517     case AddrMode1616:
 518         dbg_printf("0x%04x:0x%04x", addr->Segment, (unsigned) addr->Offset);
 519         break;
 520     case AddrMode1632:
 521         dbg_printf("0x%04x:%s", addr->Segment,
 522                    memory_offset_to_string(hexbuf, addr->Offset, 32));
 523         break;
 524     default:
 525         dbg_printf("Unknown mode %x\n", addr->Mode);
 526         break;
 527     }
 528 }
 529
 530 /***********************************************************************
 531  *           print_address
 532  *
 533  * Print an 16- or 32-bit address, with the nearest symbol if any.
 534  */
 535 void print_address(const ADDRESS64* addr, BOOLEAN with_line)
 536 {
 537     char                buffer[sizeof(SYMBOL_INFO) + 256];
 538     SYMBOL_INFO*        si = (SYMBOL_INFO*)buffer;
 539     void*               lin = memory_to_linear_addr(addr);
 540     DWORD64             disp64;
 541     DWORD               disp;
 542
 543     print_bare_address(addr);
 544
 545     si->SizeOfStruct = sizeof(*si);
 546     si->MaxNameLen   = 256;
 547     if (!SymFromAddr(dbg_curr_process->handle, (DWORD_PTR)lin, &disp64, si)) return;
 548     dbg_printf(" %s", si->Name);
 549     if (disp64) dbg_printf("+0x%lx", (DWORD_PTR)disp64);
 550     if (with_line)
 551     {
 552         IMAGEHLP_LINE               il;
 553         IMAGEHLP_MODULE             im;
 554
 555         il.SizeOfStruct = sizeof(il);
 556         if (SymGetLineFromAddr(dbg_curr_process->handle, (DWORD_PTR)lin, &disp, &il))
 557             dbg_printf(" [%s:%lu]", il.FileName, il.LineNumber);
 558         im.SizeOfStruct = sizeof(im);
 559         if (SymGetModuleInfo(dbg_curr_process->handle, (DWORD_PTR)lin, &im))
 560             dbg_printf(" in %s", im.ModuleName);
 561     }
 562 }
 563
 564 BOOL memory_disasm_one_insn(ADDRESS64* addr)
 565 {
 566     char        ch;
 567
 568     print_address(addr, TRUE);
 569     dbg_printf(": ");
 570     if (!dbg_read_memory(memory_to_linear_addr(addr), &ch, sizeof(ch)))
 571     {
 572         dbg_printf("-- no code accessible --\n");
 573         return FALSE;
 574     }
 575     be_cpu->disasm_one_insn(addr, TRUE);
 576     dbg_printf("\n");
 577     return TRUE;
 578 }
 579
 580 void memory_disassemble(const struct dbg_lvalue* xstart,
 581                         const struct dbg_lvalue* xend, int instruction_count)
 582 {
 583     static ADDRESS64 last = {0,0,0};
 584     int stop = 0;
 585     int i;
 586
 587     if (!xstart && !xend)
 588     {
 589         if (!last.Segment && !last.Offset) memory_get_current_pc(&last);
 590     }
 591     else
 592     {
 593         if (xstart)
 594             types_extract_as_address(xstart, &last);
 595         if (xend)
 596             stop = types_extract_as_integer(xend);
 597     }
 598     for (i = 0; (instruction_count == 0 || i < instruction_count)  &&
 599                 (stop == 0 || last.Offset <= stop); i++)
 600         memory_disasm_one_insn(&last);
 601 }
 602
 603 BOOL memory_get_register(DWORD regno, DWORD** value, char* buffer, int len)
 604 {
 605     const struct dbg_internal_var*  div;
 606
 607     if (dbg_curr_thread->curr_frame != 0)
 608     {
 609         if (buffer) snprintf(buffer, len, "<register not in topmost frame>");
 610         return FALSE;
 611     }
 612     for (div = dbg_context_vars; div->name; div++)
 613     {
 614         if (div->val == regno)
 615         {
 616             *value = div->pval;
 617             snprintf(buffer, len, div->name);
 618             return TRUE;
 619         }
 620     }
 621     if (buffer) snprintf(buffer, len, "<unknown register %lu>", regno);
 622     return FALSE;
 623 }