1 /* Wine internal debugger
2 * Interface to Windows debugger API
3 * Copyright 2000-2004 Eric Pouech
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 #include "wine/port.h"
29 #include "wine/exception.h"
30 #include "wine/library.h"
32 #include "wine/debug.h"
37 * + ensure that all commands work as expected in minidump reload function
38 * (and reenable parser usager)
40 * + we always assume the stack grows as on i386 (ie downwards)
42 * + enable back the limited output (depth of structure printing and number of
44 * + make the output as close as possible to what gdb does
45 * - symbol management:
46 * + symbol table loading is broken
47 * + in symbol_get_lvalue, we don't do any scoping (as C does) between local and
48 * global vars (we may need this to force some display for example). A solution
49 * would be always to return arrays with: local vars, global vars, thunks
51 * + some bits of internal types are missing (like type casts and the address
53 * + the type for an enum's value is always inferred as int (winedbg & dbghelp)
54 * + most of the code implies that sizeof(void*) = sizeof(int)
55 * + all computations should be made on long long
56 * o expr computations are in int:s
57 * o bitfield size is on a 4-bytes
58 * + array_index and deref should be the same function (or should share the same
61 * + set a better fix for gdb (proxy mode) than the step-mode hack
62 * + implement function call in debuggee
63 * + trampoline management is broken when getting 16 <=> 32 thunk destination
65 * + thunking of delayed imports doesn't work as expected (ie, when stepping,
66 * it currently stops at first insn with line number during the library
67 * loading). We should identify this (__wine_delay_import) and set a
68 * breakpoint instead of single stepping the library loading.
69 * + it's wrong to copy thread->step_over_bp into process->bp[0] (when
70 * we have a multi-thread debuggee). complete fix must include storing all
71 * thread's step-over bp in process-wide bp array, and not to handle bp
72 * when we have the wrong thread running into that bp
73 * + code in CREATE_PROCESS debug event doesn't work on Windows, as we cannot
74 * get the name of the main module this way. We should rewrite all this code
75 * and store in struct dbg_process as early as possible (before process
76 * creation or attachment), the name of the main module
78 * + define a better way to enable the wine extensions (either DBG SDK function
79 * in dbghelp, or TLS variable, or environment variable or ...)
80 * + audit all files to ensure that we check all potential return values from
81 * every function call to catch the errors
82 * + BTW check also whether the exception mechanism is the best way to return
83 * errors (or find a proper fix for MinGW port)
84 * + use Wine standard list mechanism for all list handling
87 WINE_DEFAULT_DEBUG_CHANNEL(winedbg);
89 struct dbg_process* dbg_curr_process = NULL;
90 struct dbg_thread* dbg_curr_thread = NULL;
94 BOOL dbg_interactiveP = FALSE;
96 static struct dbg_process* dbg_process_list = NULL;
98 struct dbg_internal_var dbg_internal_vars[DBG_IV_LAST];
99 const struct dbg_internal_var* dbg_context_vars;
100 static HANDLE dbg_houtput;
102 void dbg_outputA(const char* buffer, int len)
104 static char line_buff[4096];
105 static unsigned int line_pos;
111 unsigned int count = min( len, sizeof(line_buff) - line_pos );
112 memcpy( line_buff + line_pos, buffer, count );
116 for (i = line_pos; i > 0; i--) if (line_buff[i-1] == '\n') break;
117 if (!i) /* no newline found */
119 if (len > 0) i = line_pos; /* buffer is full, flush anyway */
122 WriteFile(dbg_houtput, line_buff, i, &w, NULL);
123 memmove( line_buff, line_buff + i, line_pos - i );
128 void dbg_outputW(const WCHAR* buffer, int len)
133 /* do a serious Unicode to ANSI conversion
134 * FIXME: should CP_ACP be GetConsoleCP()?
136 newlen = WideCharToMultiByte(CP_ACP, 0, buffer, len, NULL, 0, NULL, NULL);
139 if (!(ansi = HeapAlloc(GetProcessHeap(), 0, newlen))) return;
140 WideCharToMultiByte(CP_ACP, 0, buffer, len, ansi, newlen, NULL, NULL);
141 dbg_outputA(ansi, newlen);
142 HeapFree(GetProcessHeap(), 0, ansi);
146 int dbg_printf(const char* format, ...)
148 static char buf[4*1024];
152 va_start(valist, format);
153 len = vsnprintf(buf, sizeof(buf), format, valist);
156 if (len <= -1 || len >= sizeof(buf))
158 len = sizeof(buf) - 1;
160 buf[len - 1] = buf[len - 2] = buf[len - 3] = '.';
162 dbg_outputA(buf, len);
166 static unsigned dbg_load_internal_vars(void)
169 DWORD type = REG_DWORD;
171 DWORD count = sizeof(val);
173 struct dbg_internal_var* div = dbg_internal_vars;
175 /* initializes internal vars table */
176 #define INTERNAL_VAR(_var,_val,_ref,_tid) \
177 div->val = _val; div->name = #_var; div->pval = _ref; \
178 div->typeid = _tid; div++;
182 /* @@ Wine registry key: HKCU\Software\Wine\WineDbg */
183 if (RegCreateKeyA(HKEY_CURRENT_USER, "Software\\Wine\\WineDbg", &hkey))
185 WINE_ERR("Cannot create WineDbg key in registry\n");
189 for (i = 0; i < DBG_IV_LAST; i++)
191 if (!dbg_internal_vars[i].pval)
193 if (!RegQueryValueEx(hkey, dbg_internal_vars[i].name, 0,
194 &type, (LPBYTE)&val, &count))
195 dbg_internal_vars[i].val = val;
196 dbg_internal_vars[i].pval = &dbg_internal_vars[i].val;
200 /* set up the debug variables for the CPU context */
201 dbg_context_vars = be_cpu->init_registers(&dbg_context);
205 static unsigned dbg_save_internal_vars(void)
210 /* @@ Wine registry key: HKCU\Software\Wine\WineDbg */
211 if (RegCreateKeyA(HKEY_CURRENT_USER, "Software\\Wine\\WineDbg", &hkey))
213 WINE_ERR("Cannot create WineDbg key in registry\n");
217 for (i = 0; i < DBG_IV_LAST; i++)
219 /* FIXME: type should be inferred from basic type -if any- of intvar */
220 if (dbg_internal_vars[i].pval == &dbg_internal_vars[i].val)
221 RegSetValueEx(hkey, dbg_internal_vars[i].name, 0,
222 REG_DWORD, (const void*)dbg_internal_vars[i].pval,
223 sizeof(*dbg_internal_vars[i].pval));
229 const struct dbg_internal_var* dbg_get_internal_var(const char* name)
231 const struct dbg_internal_var* div;
233 for (div = &dbg_internal_vars[DBG_IV_LAST - 1]; div >= dbg_internal_vars; div--)
235 if (!strcmp(div->name, name)) return div;
237 for (div = dbg_context_vars; div->name; div++)
239 if (!strcasecmp(div->name, name)) return div;
245 unsigned dbg_num_processes(void)
247 struct dbg_process* p;
250 for (p = dbg_process_list; p; p = p->next)
255 struct dbg_process* dbg_get_process(DWORD pid)
257 struct dbg_process* p;
259 for (p = dbg_process_list; p; p = p->next)
260 if (p->pid == pid) break;
264 struct dbg_process* dbg_get_process_h(HANDLE h)
266 struct dbg_process* p;
268 for (p = dbg_process_list; p; p = p->next)
269 if (p->handle == h) break;
273 struct dbg_process* dbg_add_process(const struct be_process_io* pio, DWORD pid, HANDLE h)
275 struct dbg_process* p;
277 if ((p = dbg_get_process(pid)))
281 WINE_ERR("Process (%04x) is already defined\n", pid);
292 if (!(p = HeapAlloc(GetProcessHeap(), 0, sizeof(struct dbg_process)))) return NULL;
299 p->continue_on_first_exception = FALSE;
300 p->active_debuggee = FALSE;
301 p->next_bp = 1; /* breakpoint 0 is reserved for step-over */
302 memset(p->bp, 0, sizeof(p->bp));
303 p->delayed_bp = NULL;
304 p->num_delayed_bp = 0;
305 p->source_ofiles = NULL;
306 p->search_path = NULL;
307 p->source_current_file[0] = '\0';
308 p->source_start_line = -1;
309 p->source_end_line = -1;
311 p->next = dbg_process_list;
313 if (dbg_process_list) dbg_process_list->prev = p;
314 dbg_process_list = p;
318 void dbg_set_process_name(struct dbg_process* p, const char* imageName)
320 assert(p->imageName == NULL);
323 char* tmp = HeapAlloc(GetProcessHeap(), 0, strlen(imageName) + 1);
324 if (tmp) p->imageName = strcpy(tmp, imageName);
328 void dbg_del_process(struct dbg_process* p)
332 while (p->threads) dbg_del_thread(p->threads);
334 for (i = 0; i < p->num_delayed_bp; i++)
335 if (p->delayed_bp[i].is_symbol)
336 HeapFree(GetProcessHeap(), 0, p->delayed_bp[i].u.symbol.name);
338 HeapFree(GetProcessHeap(), 0, p->delayed_bp);
340 source_free_files(p);
341 if (p->prev) p->prev->next = p->next;
342 if (p->next) p->next->prev = p->prev;
343 if (p == dbg_process_list) dbg_process_list = p->next;
344 if (p == dbg_curr_process) dbg_curr_process = NULL;
345 HeapFree(GetProcessHeap(), 0, (char*)p->imageName);
346 HeapFree(GetProcessHeap(), 0, p);
349 struct mod_loader_info
352 IMAGEHLP_MODULE* imh_mod;
355 static BOOL CALLBACK mod_loader_cb(PCSTR mod_name, ULONG base, PVOID ctx)
357 struct mod_loader_info* mli = (struct mod_loader_info*)ctx;
359 if (!strcmp(mod_name, "<wine-loader>"))
361 if (SymGetModuleInfo(mli->handle, base, mli->imh_mod))
362 return FALSE; /* stop enum */
367 BOOL dbg_get_debuggee_info(HANDLE hProcess, IMAGEHLP_MODULE* imh_mod)
369 struct mod_loader_info mli;
372 /* this will resynchronize builtin dbghelp's internal ELF module list */
373 SymLoadModule(hProcess, 0, 0, 0, 0, 0);
374 mli.handle = hProcess;
375 mli.imh_mod = imh_mod;
376 imh_mod->SizeOfStruct = sizeof(*imh_mod);
377 imh_mod->BaseOfImage = 0;
378 /* this is a wine specific options to return also ELF modules in the
381 SymSetOptions((opt = SymGetOptions()) | 0x40000000);
382 SymEnumerateModules(hProcess, mod_loader_cb, (void*)&mli);
385 return imh_mod->BaseOfImage != 0;
388 struct dbg_thread* dbg_get_thread(struct dbg_process* p, DWORD tid)
390 struct dbg_thread* t;
393 for (t = p->threads; t; t = t->next)
394 if (t->tid == tid) break;
398 struct dbg_thread* dbg_add_thread(struct dbg_process* p, DWORD tid,
401 struct dbg_thread* t = HeapAlloc(GetProcessHeap(), 0, sizeof(struct dbg_thread));
410 t->exec_mode = dbg_exec_cont;
412 t->step_over_bp.enabled = FALSE;
413 t->step_over_bp.refcount = 0;
414 t->stopped_xpoint = -1;
415 t->in_exception = FALSE;
419 t->addr_mode = AddrModeFlat;
421 snprintf(t->name, sizeof(t->name), "%04x", tid);
423 t->next = p->threads;
425 if (p->threads) p->threads->prev = t;
431 void dbg_del_thread(struct dbg_thread* t)
433 HeapFree(GetProcessHeap(), 0, t->frames);
434 if (t->prev) t->prev->next = t->next;
435 if (t->next) t->next->prev = t->prev;
436 if (t == t->process->threads) t->process->threads = t->next;
437 if (t == dbg_curr_thread) dbg_curr_thread = NULL;
438 HeapFree(GetProcessHeap(), 0, t);
441 BOOL dbg_interrupt_debuggee(void)
443 if (!dbg_process_list) return FALSE;
444 /* FIXME: since we likely have a single process, signal the first process
447 if (dbg_process_list->next) dbg_printf("Ctrl-C: only stopping the first process\n");
448 else dbg_printf("Ctrl-C: stopping debuggee\n");
449 dbg_process_list->continue_on_first_exception = FALSE;
450 return DebugBreakProcess(dbg_process_list->handle);
453 static BOOL WINAPI ctrl_c_handler(DWORD dwCtrlType)
455 if (dwCtrlType == CTRL_C_EVENT)
457 return dbg_interrupt_debuggee();
462 static void dbg_init_console(void)
464 /* set our control-C handler */
465 SetConsoleCtrlHandler(ctrl_c_handler, TRUE);
467 /* set our own title */
468 SetConsoleTitle("Wine Debugger");
471 static int dbg_winedbg_usage(BOOL advanced)
475 dbg_printf("Usage:\n"
476 " winedbg cmdline launch process 'cmdline' (as if you were starting\n"
477 " it with wine) and run WineDbg on it\n"
478 " winedbg <num> attach to running process of pid <num> and run\n"
480 " winedbg --gdb cmdline launch process 'cmdline' (as if you were starting\n"
481 " wine) and run gdb (proxied) on it\n"
482 " winedbg --gdb <num> attach to running process of pid <num> and run\n"
483 " gdb (proxied) on it\n"
484 " winedbg file.mdmp reload the minidump file.mdmp into memory and run\n"
486 " winedbg --help prints advanced options\n");
489 dbg_printf("Usage:\n\twinedbg [ [ --gdb ] [ prog-name [ prog-args ] | <num> | file.mdmp | --help ]\n");
493 struct backend_cpu* be_cpu;
495 extern struct backend_cpu be_i386;
497 extern struct backend_cpu be_ppc;
499 extern struct backend_cpu be_alpha;
501 extern struct backend_cpu be_x86_64;
506 int main(int argc, char** argv)
509 HANDLE hFile = INVALID_HANDLE_VALUE;
523 /* Initialize the output */
524 dbg_houtput = GetStdHandle(STD_OUTPUT_HANDLE);
526 /* Initialize internal vars */
527 if (!dbg_load_internal_vars()) return -1;
529 /* as we don't care about exec name */
532 if (argc && !strcmp(argv[0], "--help"))
533 return dbg_winedbg_usage(TRUE);
535 if (argc && !strcmp(argv[0], "--gdb"))
537 retv = gdb_main(argc, argv);
538 if (retv == -1) dbg_winedbg_usage(FALSE);
543 SymSetOptions((SymGetOptions() & ~(SYMOPT_UNDNAME)) |
544 SYMOPT_LOAD_LINES | SYMOPT_DEFERRED_LOADS | SYMOPT_AUTO_PUBLICS);
546 if (argc && (!strcmp(argv[0], "--auto") || !strcmp(argv[0], "--minidump")))
548 /* force some internal variables */
549 DBG_IVAR(BreakOnDllLoad) = 0;
550 dbg_houtput = GetStdHandle(STD_ERROR_HANDLE);
551 switch (dbg_active_auto(argc, argv))
553 case start_ok: return 0;
554 case start_error_parse: return dbg_winedbg_usage(FALSE);
555 case start_error_init: return -1;
559 while (argc > 0 && argv[0][0] == '-')
561 if (!strcmp(argv[0], "--command"))
564 hFile = parser_generate_command_file(argv[0], NULL);
565 if (hFile == INVALID_HANDLE_VALUE)
567 dbg_printf("Couldn't open temp file (%u)\n", GetLastError());
573 if (!strcmp(argv[0], "--file"))
576 hFile = CreateFileA(argv[0], GENERIC_READ|DELETE, 0,
577 NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
578 if (hFile == INVALID_HANDLE_VALUE)
580 dbg_printf("Couldn't open file %s (%u)\n", argv[0], GetLastError());
586 if (!strcmp(argv[0], "--"))
591 return dbg_winedbg_usage(FALSE);
593 if (!argc) ds = start_ok;
594 else if ((ds = dbg_active_attach(argc, argv)) == start_error_parse &&
595 (ds = minidump_reload(argc, argv)) == start_error_parse)
596 ds = dbg_active_launch(argc, argv);
599 case start_ok: break;
600 case start_error_parse: return dbg_winedbg_usage(FALSE);
601 case start_error_init: return -1;
604 if (dbg_curr_process)
606 dbg_printf("WineDbg starting on pid %04x\n", dbg_curr_pid);
607 if (dbg_curr_process->active_debuggee) dbg_active_wait_for_first_exception();
610 dbg_interactiveP = TRUE;
611 parser_handle(hFile);
613 while (dbg_process_list)
614 dbg_process_list->process_io->close_process(dbg_process_list, FALSE);
616 dbg_save_internal_vars();