2 * Wine debugger utility routines
4 * Copyright 1993 Eric Youngdale
5 * Copyright 1995 Alexandre Julliard
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 /***********************************************************************
35 * Implementation of the 'print' command.
37 void DEBUG_PrintBasic( const DBG_VALUE
* value
, int count
, char format
)
39 char * default_format
;
42 assert(value
->cookie
== DV_TARGET
|| value
->cookie
== DV_HOST
);
43 if (value
->type
== NULL
)
45 DEBUG_Printf(DBG_CHN_MESG
, "Unable to evaluate expression\n");
49 default_format
= NULL
;
50 res
= DEBUG_GetExprValue(value
, &default_format
);
57 DEBUG_nchar
+= DEBUG_Printf(DBG_CHN_MESG
, "0x%04lx", (long unsigned int)res
);
61 DEBUG_nchar
+= DEBUG_Printf(DBG_CHN_MESG
, "0x%08lx", (long unsigned int)res
);
66 DEBUG_nchar
+= DEBUG_Printf(DBG_CHN_MESG
, "%ld\n", (long int)res
);
70 DEBUG_nchar
+= DEBUG_Printf(DBG_CHN_MESG
, "%d = '%c'",
71 (char)(res
& 0xff), (char)(res
& 0xff));
76 WCHAR wch
= (WCHAR
)(res
& 0xFFFF);
77 DEBUG_nchar
+= DEBUG_Printf(DBG_CHN_MESG
, "%d = '", (unsigned)(res
& 0xffff));
78 DEBUG_OutputW(DBG_CHN_MESG
, &wch
, 1);
79 DEBUG_Printf(DBG_CHN_MESG
, "'");
87 DEBUG_Printf(DBG_CHN_MESG
, "Format specifier '%c' is meaningless in 'print' command\n", format
);
89 if (default_format
!= NULL
)
91 if (strstr(default_format
, "%S") != NULL
)
96 /* FIXME: simplistic implementation for default_format being
97 * foo%Sbar => will print foo, then string then bar
99 for (ptr
= default_format
; *ptr
; ptr
++)
112 addr
.off
= (long)res
;
113 DEBUG_nchar
+= DEBUG_PrintStringA(DBG_CHN_MESG
, &addr
, -1);
117 /* shouldn't happen */
118 DEBUG_Printf(DBG_CHN_MESG
, "%%%c", *ptr
);
125 DEBUG_OutputA(DBG_CHN_MESG
, ptr
, 1);
130 else if (strcmp(default_format
, "%B") == 0)
132 DEBUG_nchar
+= DEBUG_Printf(DBG_CHN_MESG
, "%s", res
? "true" : "false");
136 DEBUG_nchar
+= DEBUG_Printf(DBG_CHN_MESG
, default_format
, res
);
144 /***********************************************************************
147 * Print an 16- or 32-bit address, with the nearest symbol if any.
150 DEBUG_PrintAddress( const DBG_ADDR
*addr
, enum dbg_mode mode
, int flag
)
152 struct symbol_info rtn
;
154 const char *name
= DEBUG_FindNearestSymbol( addr
, flag
, &rtn
.sym
, 0,
157 if (addr
->seg
) DEBUG_Printf( DBG_CHN_MESG
, "0x%04lx:", addr
->seg
&0xFFFF );
158 if (mode
!= MODE_32
) DEBUG_Printf( DBG_CHN_MESG
, "0x%04lx", addr
->off
);
159 else DEBUG_Printf( DBG_CHN_MESG
, "0x%08lx", addr
->off
);
160 if (name
) DEBUG_Printf( DBG_CHN_MESG
, " (%s)", name
);
163 /***********************************************************************
164 * DEBUG_PrintAddressAndArgs
166 * Print an 16- or 32-bit address, with the nearest symbol if any.
167 * Similar to DEBUG_PrintAddress, but we print the arguments to
168 * each function (if known). This is useful in a backtrace.
171 DEBUG_PrintAddressAndArgs( const DBG_ADDR
*addr
, enum dbg_mode mode
,
172 unsigned int ebp
, int flag
)
174 struct symbol_info rtn
;
176 const char *name
= DEBUG_FindNearestSymbol( addr
, flag
, &rtn
.sym
, ebp
,
179 if (addr
->seg
) DEBUG_Printf( DBG_CHN_MESG
, "0x%04lx:", addr
->seg
);
180 if (mode
!= MODE_32
) DEBUG_Printf( DBG_CHN_MESG
, "0x%04lx", addr
->off
);
181 else DEBUG_Printf( DBG_CHN_MESG
, "0x%08lx", addr
->off
);
182 if (name
) DEBUG_Printf( DBG_CHN_MESG
, " (%s)", name
);
188 /***********************************************************************
191 * Implementation of the 'help' command.
193 void DEBUG_Help(void)
196 static const char * const helptext
[] =
198 "The commands accepted by the Wine debugger are a reasonable",
199 "subset of the commands that gdb accepts.",
200 "The commands currently are:",
202 " break [*<addr>] delete break bpnum",
203 " disable bpnum enable bpnum",
204 " condition <bpnum> [<expr>] pass",
206 " step [N] next [N]",
207 " stepi [N] nexti [N]",
208 " x <addr> print <expr>",
209 " set <reg> = <expr> set *<addr> = <expr>",
211 " list <lines> disassemble [<addr>][,<addr>]",
213 " show dir dir <path>",
214 " display <expr> undisplay <disnum>",
215 " delete display <disnum> debugmsg <class>[-+]<type>\n",
216 " mode [16,32,vm86] walk [wnd,class,queue,module,",
217 " whatis process,modref <pid>]",
218 " info (see 'help info' for options)\n",
220 "The 'x' command accepts repeat counts and formats (including 'i') in the",
221 "same way that gdb does.\n",
223 " The following are examples of legal expressions:",
224 " $eax $eax+0x3 0x1000 ($eip + 256) *$eax *($esp + 3)",
225 " Also, a nm format symbol table can be read from a file using the",
226 " symbolfile command. Symbols can also be defined individually with",
227 " the define command.",
232 while(helptext
[i
]) DEBUG_Printf(DBG_CHN_MESG
,"%s\n", helptext
[i
++]);
236 /***********************************************************************
239 * Implementation of the 'help info' command.
241 void DEBUG_HelpInfo(void)
244 static const char * const infotext
[] =
246 "The info commands allow you to get assorted bits of interesting stuff",
247 "to be displayed. The options are:",
248 " info break Dumps information about breakpoints",
249 " info display Shows auto-display expressions in use",
250 " info locals Displays values of all local vars for current frame",
251 " info maps Dumps all virtual memory mappings",
252 " info module <handle> Displays internal module state",
253 " info queue <handle> Displays internal queue state",
254 " info reg Displays values in all registers at top of stack",
255 " info segments Dumps information about all known segments",
256 " info share Dumps information about shared libraries",
257 " info stack Dumps information about top of stack",
258 " info wnd <handle> Displays internal window state",
263 while(infotext
[i
]) DEBUG_Printf(DBG_CHN_MESG
,"%s\n", infotext
[i
++]);
266 /* FIXME: merge InfoClass and InfoClass2 */
267 void DEBUG_InfoClass(const char* name
)
271 if (!GetClassInfoEx(0, name
, &wca
)) {
272 DEBUG_Printf(DBG_CHN_MESG
, "Cannot find class '%s'\n", name
);
276 DEBUG_Printf(DBG_CHN_MESG
, "Class '%s':\n", name
);
277 DEBUG_Printf(DBG_CHN_MESG
,
278 "style=%08x wndProc=%08lx\n"
279 "inst=%p icon=%p cursor=%p bkgnd=%p\n"
280 "clsExtra=%d winExtra=%d\n",
281 wca
.style
, (DWORD
)wca
.lpfnWndProc
, wca
.hInstance
,
282 wca
.hIcon
, wca
.hCursor
, wca
.hbrBackground
,
283 wca
.cbClsExtra
, wca
.cbWndExtra
);
286 * + print #windows (or even list of windows...)
287 * + print extra bytes => this requires a window handle on this very class...
291 static void DEBUG_InfoClass2(HWND hWnd
, const char* name
)
295 if (!GetClassInfoEx((HINSTANCE
)GetWindowLong(hWnd
, GWL_HINSTANCE
), name
, &wca
)) {
296 DEBUG_Printf(DBG_CHN_MESG
, "Cannot find class '%s'\n", name
);
300 DEBUG_Printf(DBG_CHN_MESG
, "Class '%s':\n", name
);
301 DEBUG_Printf(DBG_CHN_MESG
,
302 "style=%08x wndProc=%08lx\n"
303 "inst=%p icon=%p cursor=%p bkgnd=%p\n"
304 "clsExtra=%d winExtra=%d\n",
305 wca
.style
, (DWORD
)wca
.lpfnWndProc
, wca
.hInstance
,
306 wca
.hIcon
, wca
.hCursor
, wca
.hbrBackground
,
307 wca
.cbClsExtra
, wca
.cbWndExtra
);
309 if (wca
.cbClsExtra
) {
313 DEBUG_Printf(DBG_CHN_MESG
, "Extra bytes:" );
314 for (i
= 0; i
< wca
.cbClsExtra
/ 2; i
++) {
315 w
= GetClassWord(hWnd
, i
* 2);
316 /* FIXME: depends on i386 endian-ity */
317 DEBUG_Printf(DBG_CHN_MESG
, " %02x", HIBYTE(w
));
318 DEBUG_Printf(DBG_CHN_MESG
, " %02x", LOBYTE(w
));
320 DEBUG_Printf(DBG_CHN_MESG
, "\n" );
322 DEBUG_Printf(DBG_CHN_MESG
, "\n" );
325 struct class_walker
{
331 static void DEBUG_WalkClassesHelper(HWND hWnd
, struct class_walker
* cw
)
338 if (!GetClassName(hWnd
, clsName
, sizeof(clsName
)))
340 if ((atom
= FindAtom(clsName
)) == 0)
343 for (i
= 0; i
< cw
->used
; i
++) {
344 if (cw
->table
[i
] == atom
)
348 if (cw
->used
>= cw
->alloc
) {
350 cw
->table
= DBG_realloc(cw
->table
, cw
->alloc
* sizeof(ATOM
));
352 cw
->table
[cw
->used
++] = atom
;
353 DEBUG_InfoClass2(hWnd
, clsName
);
356 if ((child
= GetWindow(hWnd
, GW_CHILD
)) != 0)
357 DEBUG_WalkClassesHelper(child
, cw
);
358 } while ((hWnd
= GetWindow(hWnd
, GW_HWNDNEXT
)) != 0);
361 void DEBUG_WalkClasses(void)
363 struct class_walker cw
;
366 cw
.used
= cw
.alloc
= 0;
367 DEBUG_WalkClassesHelper(GetDesktopWindow(), &cw
);
371 void DEBUG_DumpQueue(DWORD q
)
373 DEBUG_Printf(DBG_CHN_MESG
, "No longer doing info queue '0x%08lx'\n", q
);
376 void DEBUG_WalkQueues(void)
378 DEBUG_Printf(DBG_CHN_MESG
, "No longer walking queues list\n");
381 void DEBUG_InfoWindow(HWND hWnd
)
390 if (!GetClassName(hWnd
, clsName
, sizeof(clsName
)))
391 strcpy(clsName
, "-- Unknown --");
392 if (!GetWindowText(hWnd
, wndName
, sizeof(wndName
)))
393 strcpy(wndName
, "-- Empty --");
394 if (!GetClientRect(hWnd
, &clientRect
))
395 SetRectEmpty(&clientRect
);
396 if (!GetWindowRect(hWnd
, &windowRect
))
397 SetRectEmpty(&windowRect
);
399 /* FIXME missing fields: hmemTaskQ, hrgnUpdate, dce, flags, pProp, scroll */
400 DEBUG_Printf(DBG_CHN_MESG
,
401 "next=%p child=%p parent=%p owner=%p class='%s'\n"
402 "inst=%p active=%p idmenu=%08lx\n"
403 "style=%08lx exstyle=%08lx wndproc=%08lx text='%s'\n"
404 "client=%d,%d-%d,%d window=%d,%d-%d,%d sysmenu=%p\n",
405 GetWindow(hWnd
, GW_HWNDNEXT
),
406 GetWindow(hWnd
, GW_CHILD
),
408 GetWindow(hWnd
, GW_OWNER
),
410 (HINSTANCE
)GetWindowLong(hWnd
, GWL_HINSTANCE
),
411 GetLastActivePopup(hWnd
),
412 GetWindowLong(hWnd
, GWL_ID
),
413 GetWindowLong(hWnd
, GWL_STYLE
),
414 GetWindowLong(hWnd
, GWL_EXSTYLE
),
415 GetWindowLong(hWnd
, GWL_WNDPROC
),
417 clientRect
.left
, clientRect
.top
, clientRect
.right
, clientRect
.bottom
,
418 windowRect
.left
, windowRect
.top
, windowRect
.right
, windowRect
.bottom
,
419 GetSystemMenu(hWnd
, FALSE
));
421 if (GetClassLong(hWnd
, GCL_CBWNDEXTRA
)) {
422 DEBUG_Printf(DBG_CHN_MESG
, "Extra bytes:" );
423 for (i
= 0; i
< GetClassLong(hWnd
, GCL_CBWNDEXTRA
) / 2; i
++) {
424 w
= GetWindowWord(hWnd
, i
* 2);
425 /* FIXME: depends on i386 endian-ity */
426 DEBUG_Printf(DBG_CHN_MESG
, " %02x", HIBYTE(w
));
427 DEBUG_Printf(DBG_CHN_MESG
, " %02x", LOBYTE(w
));
429 DEBUG_Printf(DBG_CHN_MESG
, "\n");
431 DEBUG_Printf(DBG_CHN_MESG
, "\n");
434 void DEBUG_WalkWindows(HWND hWnd
, int indent
)
441 hWnd
= GetDesktopWindow();
443 if (!indent
) /* first time around */
444 DEBUG_Printf(DBG_CHN_MESG
,
445 "%-16.16s %-17.17s %-8.8s %s\n",
446 "hwnd", "Class Name", " Style", " WndProc Text");
449 if (!GetClassName(hWnd
, clsName
, sizeof(clsName
)))
450 strcpy(clsName
, "-- Unknown --");
451 if (!GetWindowText(hWnd
, wndName
, sizeof(wndName
)))
452 strcpy(wndName
, "-- Empty --");
454 /* FIXME: missing hmemTaskQ */
455 DEBUG_Printf(DBG_CHN_MESG
, "%*s%04x%*s", indent
, "", (UINT
)hWnd
, 13-indent
,"");
456 DEBUG_Printf(DBG_CHN_MESG
, "%-17.17s %08lx %08lx %.14s\n",
457 clsName
, GetWindowLong(hWnd
, GWL_STYLE
),
458 GetWindowLong(hWnd
, GWL_WNDPROC
), wndName
);
460 if ((child
= GetWindow(hWnd
, GW_CHILD
)) != 0)
461 DEBUG_WalkWindows(child
, indent
+ 1 );
462 } while ((hWnd
= GetWindow(hWnd
, GW_HWNDNEXT
)) != 0);
465 void DEBUG_WalkProcess(void)
467 HANDLE snap
= CreateToolhelp32Snapshot( TH32CS_SNAPPROCESS
, 0 );
468 if (snap
!= INVALID_HANDLE_VALUE
)
470 PROCESSENTRY32 entry
;
471 DWORD current
= DEBUG_CurrProcess
? DEBUG_CurrProcess
->pid
: 0;
474 entry
.dwSize
= sizeof(entry
);
475 ok
= Process32First( snap
, &entry
);
477 DEBUG_Printf(DBG_CHN_MESG
, " %-8.8s %-8.8s %-8.8s %s\n",
478 "pid", "threads", "parent", "executable" );
481 if (entry
.th32ProcessID
!= GetCurrentProcessId())
482 DEBUG_Printf(DBG_CHN_MESG
, "%c%08lx %-8ld %08lx '%s'\n",
483 (entry
.th32ProcessID
== current
) ? '>' : ' ',
484 entry
.th32ProcessID
, entry
.cntThreads
,
485 entry
.th32ParentProcessID
, entry
.szExeFile
);
486 ok
= Process32Next( snap
, &entry
);
492 void DEBUG_WalkThreads(void)
494 HANDLE snap
= CreateToolhelp32Snapshot( TH32CS_SNAPTHREAD
, 0 );
495 if (snap
!= INVALID_HANDLE_VALUE
)
498 DWORD current
= DEBUG_CurrThread
? DEBUG_CurrThread
->tid
: 0;
500 DWORD lastProcessId
= 0;
502 entry
.dwSize
= sizeof(entry
);
503 ok
= Thread32First( snap
, &entry
);
505 DEBUG_Printf(DBG_CHN_MESG
, "%-8.8s %-8.8s %s\n", "process", "tid", "prio" );
508 if (entry
.th32OwnerProcessID
!= GetCurrentProcessId())
510 /* FIXME: this assumes that, in the snapshot, all threads of a same process are
511 * listed sequentially, which is not specified in the doc (Wine's implementation
514 if (entry
.th32OwnerProcessID
!= lastProcessId
)
516 DBG_PROCESS
* p
= DEBUG_GetProcess(entry
.th32OwnerProcessID
);
518 DEBUG_Printf(DBG_CHN_MESG
, "%08lx%s %s\n",
519 entry
.th32OwnerProcessID
, p
? " (D)" : "", p
? p
->imageName
: "");
520 lastProcessId
= entry
.th32OwnerProcessID
;
522 DEBUG_Printf(DBG_CHN_MESG
, "\t%08lx %4ld%s\n",
523 entry
.th32ThreadID
, entry
.tpBasePri
,
524 (entry
.th32ThreadID
== current
) ? " <==" : "");
527 ok
= Thread32Next( snap
, &entry
);
534 void DEBUG_WalkModref(DWORD p
)
536 DEBUG_Printf(DBG_CHN_MESG
, "No longer walking module references list\n");
539 void DEBUG_InfoSegments(DWORD start
, int length
)
545 if (length
== -1) length
= (8192 - start
);
547 for (i
= start
; i
< start
+ length
; i
++)
549 if (!GetThreadSelectorEntry(DEBUG_CurrThread
->handle
, (i
<< 3)|7, &le
))
552 if (le
.HighWord
.Bits
.Type
& 0x08)
554 flags
[0] = (le
.HighWord
.Bits
.Type
& 0x2) ? 'r' : '-';
561 flags
[1] = (le
.HighWord
.Bits
.Type
& 0x2) ? 'w' : '-';
564 DEBUG_Printf(DBG_CHN_MESG
,
565 "%04lx: sel=%04lx base=%08x limit=%08x %d-bit %c%c%c\n",
567 (le
.HighWord
.Bits
.BaseHi
<< 24) +
568 (le
.HighWord
.Bits
.BaseMid
<< 16) + le
.BaseLow
,
569 ((le
.HighWord
.Bits
.LimitHi
<< 8) + le
.LimitLow
) <<
570 (le
.HighWord
.Bits
.Granularity
? 12 : 0),
571 le
.HighWord
.Bits
.Default_Big
? 32 : 16,
572 flags
[0], flags
[1], flags
[2] );
576 void DEBUG_InfoVirtual(void)
578 MEMORY_BASIC_INFORMATION mbi
;
584 if (DEBUG_CurrProcess
== NULL
)
587 DEBUG_Printf(DBG_CHN_MESG
, "Address Size State Type RWX\n");
589 while (VirtualQueryEx(DEBUG_CurrProcess
->handle
, addr
, &mbi
, sizeof(mbi
)) >= sizeof(mbi
))
593 case MEM_COMMIT
: state
= "commit "; break;
594 case MEM_FREE
: state
= "free "; break;
595 case MEM_RESERVE
: state
= "reserve"; break;
596 default: state
= "??? "; break;
598 if (mbi
.State
!= MEM_FREE
)
602 case MEM_IMAGE
: type
= "image "; break;
603 case MEM_MAPPED
: type
= "mapped "; break;
604 case MEM_PRIVATE
: type
= "private"; break;
605 case 0: type
= " "; break;
606 default: type
= "??? "; break;
608 memset(prot
, ' ' , sizeof(prot
)-1);
609 prot
[sizeof(prot
)-1] = '\0';
610 if (mbi
.AllocationProtect
& (PAGE_READONLY
|PAGE_READWRITE
|PAGE_EXECUTE_READ
|PAGE_EXECUTE_READWRITE
))
612 if (mbi
.AllocationProtect
& (PAGE_READWRITE
|PAGE_EXECUTE_READWRITE
))
614 if (mbi
.AllocationProtect
& (PAGE_WRITECOPY
|PAGE_EXECUTE_WRITECOPY
))
616 if (mbi
.AllocationProtect
& (PAGE_EXECUTE
|PAGE_EXECUTE_READ
|PAGE_EXECUTE_READWRITE
))
624 DEBUG_Printf(DBG_CHN_MESG
, "%08lx %08lx %s %s %s\n",
625 (DWORD
)addr
, mbi
.RegionSize
, state
, type
, prot
);
626 if (addr
+ mbi
.RegionSize
< addr
) /* wrap around ? */
628 addr
+= mbi
.RegionSize
;
632 struct dll_option_layout
636 char* const* channels
;
640 void DEBUG_DbgChannel(BOOL turn_on
, const char* chnl
, const char* name
)
643 struct dll_option_layout dol
;
646 unsigned char buffer
[32];
652 if (!DEBUG_GetSymbolValue("first_dll", -1, &val
, FALSE
))
654 DEBUG_Printf(DBG_CHN_MESG
, "Can't get first_option symbol");
657 addr
= (void*)DEBUG_ToLinear(&val
.addr
);
658 if (!chnl
) mask
= 15;
659 else if (!strcmp(chnl
, "fixme")) mask
= 1;
660 else if (!strcmp(chnl
, "err")) mask
= 2;
661 else if (!strcmp(chnl
, "warn")) mask
= 4;
662 else if (!strcmp(chnl
, "trace")) mask
= 8;
663 else { DEBUG_Printf(DBG_CHN_MESG
, "Unknown channel %s\n", chnl
); return; }
665 bAll
= !strcmp("all", name
);
666 while (addr
&& DEBUG_READ_MEM(addr
, &dol
, sizeof(dol
)))
668 for (i
= 0; i
< dol
.nb_channels
; i
++)
670 if (DEBUG_READ_MEM((void*)(dol
.channels
+ i
), &str
, sizeof(str
)) &&
671 DEBUG_READ_MEM(str
, buffer
, sizeof(buffer
)) &&
672 (!strcmp(buffer
+ 1, name
) || bAll
))
674 if (turn_on
) buffer
[0] |= mask
; else buffer
[0] &= ~mask
;
675 if (DEBUG_WRITE_MEM(str
, buffer
, 1)) done
++;
680 if (!done
) DEBUG_Printf(DBG_CHN_MESG
, "Unable to find debug channel %s\n", name
);
681 else DEBUG_Printf(DBG_CHN_TRACE
, "Changed %d channel instances\n", done
);