programs/winedbg/memory.c

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