1 /* $Id: ex.c 5173 2008-01-07 22:10:52Z mquinson $ */
3 /* backtrace_windows - backtrace displaying on windows platform */
4 /* This file is included by ex.c on need (windows x86) */
6 /* Copyright (c) 2007 The SimGrid team */
7 /* All rights reserved. */
9 /* This program is free software; you can redistribute it and/or modify it
10 * under the terms of the license (GNU LGPL) which comes with this package. */
13 * Win32 (x86) implementation backtrace, backtrace_symbols
14 * : support for application self-debugging.
19 /* Pointer function to SymInitialize() */
20 typedef BOOL(WINAPI * xbt_pfn_sym_initialize_t) (HANDLE, PSTR, BOOL);
22 /* Pointer function to SymCleanup() */
23 typedef BOOL(WINAPI * xbt_pfn_sym_cleanup_t) (HANDLE hProcess);
25 /* Pointer function to SymFunctionTableAccess() */
26 typedef PVOID(WINAPI * xbt_pfn_sym_function_table_access_t) (HANDLE, DWORD);
28 /* Pointer function to SymGetLineFromAddr() */
29 typedef BOOL(WINAPI * xbt_pfn_sym_get_line_from_addr_t) (HANDLE, DWORD,
33 /* Pointer function to SymGetModuleBase() */
34 typedef DWORD(WINAPI * xbt_pfn_sym_get_module_base_t) (HANDLE, DWORD);
36 /* Pointer function to SymGetOptions() */
37 typedef DWORD(WINAPI * xbt_pfn_sym_get_options_t) (VOID);
39 /* Pointer function to SymGetSymFromAddr() */
40 typedef BOOL(WINAPI * xbt_pfn_sym_get_sym_from_addr_t) (HANDLE, DWORD, PDWORD,
41 OUT PIMAGEHLP_SYMBOL);
43 /* Pointer function to SymSetOptions() */
44 typedef DWORD(WINAPI * xbt_pfn_sym_set_options_t) (DWORD);
46 /* Pointer function to StackWalk() */
47 typedef BOOL(WINAPI * xbt_pfn_stack_walk_t) (DWORD, HANDLE, HANDLE,
49 PREAD_PROCESS_MEMORY_ROUTINE,
50 PFUNCTION_TABLE_ACCESS_ROUTINE,
51 PGET_MODULE_BASE_ROUTINE,
52 PTRANSLATE_ADDRESS_ROUTINE);
54 /* This structure represents the debug_help library used interface */
55 typedef struct s_xbt_debug_help {
57 HANDLE process_handle;
58 xbt_pfn_sym_initialize_t sym_initialize;
59 xbt_pfn_sym_cleanup_t sym_cleanup;
60 xbt_pfn_sym_function_table_access_t sym_function_table_access;
61 xbt_pfn_sym_get_line_from_addr_t sym_get_line_from_addr;
62 xbt_pfn_sym_get_module_base_t sym_get_module_base;
63 xbt_pfn_sym_get_options_t sym_get_options;
64 xbt_pfn_sym_get_sym_from_addr_t sym_get_sym_from_addr;
65 xbt_pfn_sym_set_options_t sym_set_options;
66 xbt_pfn_stack_walk_t stack_walk;
67 } s_xbt_debug_hlp_t, *xbt_debug_hlp_t;
70 /* the address to the unique reference to the debug help library interface */
71 static xbt_debug_hlp_t dbg_hlp = NULL;
73 /* initialize the debug help library */
74 static int dbg_hlp_init(HANDLE process_handle);
76 /* finalize the debug help library */
77 static int dbg_hlp_finalize(void);
80 * backtrace() function.
82 * Returns a backtrace for the calling program, in the array
83 * pointed to by buffer. A backtrace is the series of currently active
84 * function calls for the program. Each item in the array pointed to by
85 * buffer is of type void *, and is the return address from the corre-
86 * sponding stack frame. The size argument specifies the maximum number
87 * of addresses that can be stored in buffer. If the backtrace is larger
88 * than size, then the addresses corresponding to the size most recent
89 * function calls are returned; to obtain the complete backtrace, make
90 * sure that buffer and size are large enough.
93 int backtrace(void **buffer, int size);
96 * backtrace_symbols() function.
98 * Given the set of addresses returned by backtrace() in buffer, back-
99 * trace_symbols() translates the addresses into an array of strings containing
100 * the name, the source file and the line number or the las called functions.
102 char **backtrace_symbols(void *const *buffer, int size);
104 void xbt_ex_setup_backtrace(xbt_ex_t * e)
107 char **backtrace_syms = backtrace_symbols(e->bt, e->used);
109 e->used = backtrace((void **) e->bt, XBT_BACKTRACE_SIZE);
110 e->bt_strings = NULL;
111 /* parse the output and build a new backtrace */
112 e->bt_strings = xbt_new(char *, e->used);
115 for (i = 0; i < e->used; i++) {
116 e->bt_strings[i] = xbt_strdup(backtrace_syms[i]);
117 free(backtrace_syms[i]);
120 free(backtrace_syms);
123 int backtrace(void **buffer, int size)
126 STACKFRAME *stack_frame;
129 IMAGEHLP_SYMBOL *pSym;
130 unsigned long offset = 0;
131 IMAGEHLP_LINE line_info = { 0 };
133 __buffer[(sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR) +
134 sizeof(ULONG64) - 1) / sizeof(ULONG64)];
136 CONTEXT context = { CONTEXT_FULL };
137 GetThreadContext(GetCurrentThread(), &context);
139 /* ebp points on stack base */
140 /* esp points on stack pointer, ie on last stacked element (current element) */
143 _asm mov context.Eip, eax
145 _asm mov context.Esp, eax
146 _asm mov context.Ebp, ebp
148 dbg_hlp_init(GetCurrentProcess());
150 if ((NULL == dbg_hlp) || (size <= 0) || (NULL == buffer)) {
155 for (pos = 0; pos < size; pos++)
160 pSym = (IMAGEHLP_SYMBOL *) __buffer;
162 pSym->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL);
163 pSym->MaxNameLength = MAX_SYM_NAME;
166 line_info.SizeOfStruct = sizeof(IMAGEHLP_LINE);
170 stack_frame = (void *) xbt_new0(STACKFRAME, 1);
177 stack_frame->AddrPC.Offset = context.Eip;
178 stack_frame->AddrPC.Mode = AddrModeFlat;
180 stack_frame->AddrFrame.Offset = context.Ebp;
181 stack_frame->AddrFrame.Mode = AddrModeFlat;
183 stack_frame->AddrStack.Offset = context.Esp;
184 stack_frame->AddrStack.Mode = AddrModeFlat;
186 if ((*(dbg_hlp->stack_walk)) (IMAGE_FILE_MACHINE_I386,
187 dbg_hlp->process_handle,
192 dbg_hlp->sym_function_table_access,
193 dbg_hlp->sym_get_module_base, NULL)
195 if (stack_frame->AddrReturn.Offset) {
197 if ((*(dbg_hlp->sym_get_sym_from_addr))
198 (dbg_hlp->process_handle, stack_frame->AddrPC.Offset, &offset,
200 if ((*(dbg_hlp->sym_get_line_from_addr))
201 (dbg_hlp->process_handle, stack_frame->AddrPC.Offset, &offset,
203 buffer[pos++] = (void *) stack_frame;
206 free(stack_frame); /* no symbol or no line info */
222 char **backtrace_symbols(void *const *buffer, int size)
227 STACKFRAME *stack_frame;
228 IMAGEHLP_SYMBOL *pSym;
229 unsigned long offset = 0;
230 IMAGEHLP_LINE line_info = { 0 };
231 IMAGEHLP_MODULE module = { 0 };
233 __buffer[(sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR) +
234 sizeof(ULONG64) - 1) / sizeof(ULONG64)];
236 if ((NULL == dbg_hlp) || (size <= 0) || (NULL == buffer)) {
241 strings = xbt_new0(char *, size);
243 if (NULL == strings) {
248 pSym = (IMAGEHLP_SYMBOL *) __buffer;
250 pSym->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL);
251 pSym->MaxNameLength = MAX_SYM_NAME;
254 line_info.SizeOfStruct = sizeof(IMAGEHLP_LINE);
255 module.SizeOfStruct = sizeof(IMAGEHLP_MODULE);
257 for (pos = 0; pos < size; pos++) {
258 stack_frame = (STACKFRAME *) (buffer[pos]);
260 if (NULL != stack_frame) {
262 if ((*(dbg_hlp->sym_get_sym_from_addr))
263 (dbg_hlp->process_handle, stack_frame->AddrPC.Offset, &offset,
265 if ((*(dbg_hlp->sym_get_line_from_addr))
266 (dbg_hlp->process_handle, stack_frame->AddrPC.Offset, &offset,
269 bprintf("** In %s() at %s:%d", pSym->Name, line_info.FileName,
270 line_info.LineNumber);
272 strings[pos] = bprintf("** In %s()", pSym->Name);
276 strings[pos] = xbt_strdup("** <no symbol>");
294 static int dbg_hlp_init(HANDLE process_handle)
297 /* debug help is already loaded */
302 dbg_hlp = xbt_new0(s_xbt_debug_hlp_t, 1);
307 /* load the library */
308 dbg_hlp->instance = LoadLibraryA("Dbghelp.dll");
310 if (!(dbg_hlp->instance)) {
313 return (int) GetLastError();
316 /* get the pointers to debug help library exported functions */
319 ((dbg_hlp->sym_initialize) =
320 (xbt_pfn_sym_initialize_t) GetProcAddress(dbg_hlp->instance,
322 FreeLibrary(dbg_hlp->instance);
325 return (int) GetLastError();
329 ((dbg_hlp->sym_cleanup) =
330 (xbt_pfn_sym_cleanup_t) GetProcAddress(dbg_hlp->instance,
332 FreeLibrary(dbg_hlp->instance);
335 return (int) GetLastError();
339 ((dbg_hlp->sym_function_table_access) =
340 (xbt_pfn_sym_function_table_access_t) GetProcAddress(dbg_hlp->instance,
341 "SymFunctionTableAccess")))
343 FreeLibrary(dbg_hlp->instance);
346 return (int) GetLastError();
350 ((dbg_hlp->sym_get_line_from_addr) =
351 (xbt_pfn_sym_get_line_from_addr_t) GetProcAddress(dbg_hlp->instance,
352 "SymGetLineFromAddr")))
354 FreeLibrary(dbg_hlp->instance);
357 return (int) GetLastError();
361 ((dbg_hlp->sym_get_module_base) =
362 (xbt_pfn_sym_get_module_base_t) GetProcAddress(dbg_hlp->instance,
363 "SymGetModuleBase"))) {
364 FreeLibrary(dbg_hlp->instance);
367 return (int) GetLastError();
371 ((dbg_hlp->sym_get_options) =
372 (xbt_pfn_sym_get_options_t) GetProcAddress(dbg_hlp->instance,
374 FreeLibrary(dbg_hlp->instance);
377 return (int) GetLastError();
381 ((dbg_hlp->sym_get_sym_from_addr) =
382 (xbt_pfn_sym_get_sym_from_addr_t) GetProcAddress(dbg_hlp->instance,
383 "SymGetSymFromAddr")))
385 FreeLibrary(dbg_hlp->instance);
388 return (int) GetLastError();
392 ((dbg_hlp->sym_set_options) =
393 (xbt_pfn_sym_set_options_t) GetProcAddress(dbg_hlp->instance,
395 FreeLibrary(dbg_hlp->instance);
398 return (int) GetLastError();
402 ((dbg_hlp->stack_walk) =
403 (xbt_pfn_stack_walk_t) GetProcAddress(dbg_hlp->instance,
405 FreeLibrary(dbg_hlp->instance);
408 return (int) GetLastError();
411 dbg_hlp->process_handle = process_handle;
413 (*(dbg_hlp->sym_set_options)) ((*(dbg_hlp->sym_get_options)) () |
414 SYMOPT_LOAD_LINES | SYMOPT_DEFERRED_LOADS);
416 if (!(*(dbg_hlp->sym_initialize)) (dbg_hlp->process_handle, 0, 1)) {
417 FreeLibrary(dbg_hlp->instance);
420 return (int) GetLastError();
427 static int dbg_hlp_finalize(void)
432 if (!(*(dbg_hlp->sym_cleanup)) (dbg_hlp->process_handle))
433 return (int) GetLastError();
435 if (!FreeLibrary(dbg_hlp->instance))
436 return (int) GetLastError();