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.
17 #if defined(_XBT_BORLAND_COMPILER) || defined(_XBT_VISUALC_COMPILER)
18 /* native windows build */
21 /* gcc-based cross-compiling */
22 # include "xbt/wine_dbghelp.h"
27 typedef BOOL(WINAPI * fun_initialize_t) (HANDLE, PSTR, BOOL);
28 static fun_initialize_t fun_initialize;
31 typedef BOOL(WINAPI * fun_cleanup_t) (HANDLE hProcess);
32 static fun_cleanup_t fun_cleanup;
34 /* SymFunctionTableAccess() */
35 typedef PVOID(WINAPI * fun_function_table_access_t) (HANDLE, DWORD);
36 static fun_function_table_access_t fun_function_table_access;
38 /* SymGetLineFromAddr() */
39 typedef BOOL(WINAPI * fun_get_line_from_addr_t) (HANDLE, DWORD,
40 PDWORD, PIMAGEHLP_LINE);
41 static fun_get_line_from_addr_t fun_get_line_from_addr;
43 /* SymGetModuleBase() */
44 typedef DWORD(WINAPI * fun_get_module_base_t) (HANDLE, DWORD);
45 static fun_get_module_base_t fun_get_module_base;
48 typedef DWORD(WINAPI * fun_get_options_t) (VOID);
49 static fun_get_options_t fun_get_options;
52 typedef DWORD(WINAPI * fun_set_options_t) (DWORD);
53 static fun_set_options_t fun_set_options;
55 /* Pointer function to SymGetSymFromAddr() */
56 typedef BOOL(WINAPI * fun_get_sym_from_addr_t) (HANDLE, DWORD, PDWORD,
57 OUT PIMAGEHLP_SYMBOL);
58 static fun_get_sym_from_addr_t fun_get_sym_from_addr;
60 /* Pointer function to StackWalk() */
61 typedef BOOL(WINAPI * fun_stack_walk_t) (DWORD, HANDLE, HANDLE,
63 PREAD_PROCESS_MEMORY_ROUTINE,
64 PFUNCTION_TABLE_ACCESS_ROUTINE,
65 PGET_MODULE_BASE_ROUTINE,
66 PTRANSLATE_ADDRESS_ROUTINE);
67 static fun_stack_walk_t fun_stack_walk;
69 static HINSTANCE hlp_dbg_instance = NULL;
70 static HANDLE process_handle = NULL;
73 /* Module creation/destruction: nothing to do on linux */
74 void xbt_backtrace_init(void)
76 process_handle = GetCurrentProcess();
78 if (hlp_dbg_instance) {
79 /* debug help is already loaded */
83 /* load the library */
84 hlp_dbg_instance = LoadLibraryA("Dbghelp.dll");
86 if (!hlp_dbg_instance)
89 /* get the pointers to debug help library exported functions */
91 (fun_initialize_t) GetProcAddress(hlp_dbg_instance, "SymInitialize");
93 (fun_cleanup_t) GetProcAddress(hlp_dbg_instance, "SymCleanup");
94 fun_function_table_access =
95 (fun_function_table_access_t) GetProcAddress(hlp_dbg_instance,
96 "SymFunctionTableAccess");
97 fun_get_line_from_addr =
98 (fun_get_line_from_addr_t) GetProcAddress(hlp_dbg_instance,
99 "SymGetLineFromAddr");
100 fun_get_module_base =
101 (fun_get_module_base_t) GetProcAddress(hlp_dbg_instance,
104 (fun_get_options_t) GetProcAddress(hlp_dbg_instance, "SymGetOptions");
105 fun_get_sym_from_addr =
106 (fun_get_sym_from_addr_t) GetProcAddress(hlp_dbg_instance,
107 "SymGetSymFromAddr");
109 (fun_set_options_t) GetProcAddress(hlp_dbg_instance, "SymSetOptions");
111 (fun_stack_walk_t) GetProcAddress(hlp_dbg_instance, "StackWalk");
113 /* Check that everything worked well */
114 if (!fun_initialize ||
116 !fun_function_table_access ||
117 !fun_get_line_from_addr ||
118 !fun_get_module_base ||
120 !fun_get_sym_from_addr || !fun_set_options || !fun_stack_walk) {
121 FreeLibrary(hlp_dbg_instance);
122 hlp_dbg_instance = NULL;
126 (*fun_set_options) ((*fun_get_options) () |
127 SYMOPT_LOAD_LINES | SYMOPT_DEFERRED_LOADS);
129 if (!(*fun_initialize) (process_handle, 0, 1)) {
130 FreeLibrary(hlp_dbg_instance);
131 hlp_dbg_instance = NULL;
135 void xbt_backtrace_exit(void)
137 if (!hlp_dbg_instance)
140 if ((*fun_cleanup) (process_handle))
141 FreeLibrary(hlp_dbg_instance);
143 hlp_dbg_instance = NULL;
147 * backtrace() function.
149 * Returns a backtrace for the calling program, in the array
150 * pointed to by buffer. A backtrace is the series of currently active
151 * function calls for the program. Each item in the array pointed to by
152 * buffer is of type void *, and is the return address from the corre-
153 * sponding stack frame. The size argument specifies the maximum number
154 * of addresses that can be stored in buffer. If the backtrace is larger
155 * than size, then the addresses corresponding to the size most recent
156 * function calls are returned; to obtain the complete backtrace, make
157 * sure that buffer and size are large enough.
160 int backtrace(void **buffer, int size);
163 * backtrace_symbols() function.
165 * Given the set of addresses returned by backtrace() in buffer, back-
166 * trace_symbols() translates the addresses into an array of strings containing
167 * the name, the source file and the line number or the las called functions.
169 char **backtrace_symbols(void *const *buffer, int size);
171 void xbt_backtrace_current(xbt_ex_t * e)
173 e->used = backtrace((void **) e->bt, XBT_BACKTRACE_SIZE);
177 void xbt_ex_setup_backtrace(xbt_ex_t * e)
180 char **backtrace_syms;
184 "Backtrace not setup yet, cannot set it up for display");
186 backtrace_syms = backtrace_symbols(e->bt, e->used);
187 e->bt_strings = NULL;
188 /* parse the output and build a new backtrace */
189 e->bt_strings = xbt_new(char *, e->used);
192 for (i = 0; i < e->used; i++)
193 e->bt_strings[i] = backtrace_syms[i];
195 free(backtrace_syms);
198 int backtrace(void **buffer, int size)
201 STACKFRAME *stack_frame;
204 IMAGEHLP_SYMBOL *pSym;
205 unsigned long offset = 0;
206 IMAGEHLP_LINE line_info = { 0 };
208 __buffer[(sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR) +
209 sizeof(ULONG64) - 1) / sizeof(ULONG64)];
211 CONTEXT context = { CONTEXT_FULL };
212 GetThreadContext(GetCurrentThread(), &context);
214 /* ebp points on stack base */
215 /* esp points on stack pointer, ie on last stacked element (current element) */
218 _asm mov context.Eip, eax
220 _asm mov context.Esp, eax
221 _asm mov context.Ebp, ebp
222 if ((NULL == hlp_dbg_instance) || (size <= 0) || (NULL == buffer)) {
227 for (pos = 0; pos < size; pos++)
232 pSym = (IMAGEHLP_SYMBOL *) __buffer;
234 pSym->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL);
235 pSym->MaxNameLength = MAX_SYM_NAME;
238 line_info.SizeOfStruct = sizeof(IMAGEHLP_LINE);
242 stack_frame = (void *) xbt_new0(STACKFRAME, 1);
244 stack_frame->AddrPC.Offset = context.Eip;
245 stack_frame->AddrPC.Mode = AddrModeFlat;
247 stack_frame->AddrFrame.Offset = context.Ebp;
248 stack_frame->AddrFrame.Mode = AddrModeFlat;
250 stack_frame->AddrStack.Offset = context.Esp;
251 stack_frame->AddrStack.Mode = AddrModeFlat;
253 if ((*fun_stack_walk) (IMAGE_FILE_MACHINE_I386,
259 fun_function_table_access,
260 fun_get_module_base, NULL)
262 if (stack_frame->AddrReturn.Offset) {
264 if ((*fun_get_sym_from_addr)
265 (process_handle, stack_frame->AddrPC.Offset, &offset, pSym)) {
266 if ((*fun_get_line_from_addr)
267 (process_handle, stack_frame->AddrPC.Offset, &offset,
269 buffer[pos++] = (void *) stack_frame;
272 free(stack_frame); /* no symbol or no line info */
288 char **backtrace_symbols(void *const *buffer, int size)
293 STACKFRAME *stack_frame;
294 IMAGEHLP_SYMBOL *pSym;
295 unsigned long offset = 0;
296 IMAGEHLP_LINE line_info = { 0 };
297 IMAGEHLP_MODULE module = { 0 };
299 __buffer[(sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR) +
300 sizeof(ULONG64) - 1) / sizeof(ULONG64)];
302 if ((NULL == hlp_dbg_instance) || (size <= 0) || (NULL == buffer)) {
307 strings = xbt_new0(char *, size);
309 pSym = (IMAGEHLP_SYMBOL *) __buffer;
311 pSym->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL);
312 pSym->MaxNameLength = MAX_SYM_NAME;
315 line_info.SizeOfStruct = sizeof(IMAGEHLP_LINE);
316 module.SizeOfStruct = sizeof(IMAGEHLP_MODULE);
318 for (pos = 0; pos < size; pos++) {
319 stack_frame = (STACKFRAME *) (buffer[pos]);
321 if (NULL != stack_frame) {
323 if ((*fun_get_sym_from_addr)
324 (process_handle, stack_frame->AddrPC.Offset, &offset, pSym)) {
325 if ((*fun_get_line_from_addr)
326 (process_handle, stack_frame->AddrPC.Offset, &offset, &line_info)) {
328 bprintf("** In %s() at %s:%d", pSym->Name, line_info.FileName,
329 (int) line_info.LineNumber);
331 strings[pos] = bprintf("** In %s()", pSym->Name);
335 strings[pos] = xbt_strdup("** <no symbol>");