Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
More spell checking of the documentation
[simgrid.git] / src / xbt / backtrace_windows.c
index b2df7e8..e2e60e6 100644 (file)
@@ -9,67 +9,70 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-/* 
+/*
  * Win32 (x86) implementation backtrace, backtrace_symbols:
  *  support for application self-debugging.
  */
 
-#include <dbghelp.h>
+#if defined(_XBT_BORLAND_COMPILER) || defined(_XBT_VISUALC_COMPILER)
+/* native windows build */
+#  include <dbghelp.h>
+#else
+/* gcc-based cross-compiling */
+#  include "xbt/wine_dbghelp.h"
+#endif
 
 
-/* Pointer function to SymInitialize() */
-BOOL (* fun_initialize) (HANDLE, PSTR, BOOL);
-void (*fun_cleanup)(void);
-void *fun_function_table_access;
-void *fun_get_line_from_addr;
-void *fun_get_module_base;
-void *fun_get_options;
-void *fun_set_options;
-void *fun_get_sym_from_addr;
-void *fun_stack_walk;
+/* SymInitialize() */
+typedef BOOL(WINAPI * fun_initialize_t) (HANDLE, PSTR, BOOL);
+static fun_initialize_t fun_initialize;
 
-#if 0
-BOOL(WINAPI * fun_initialize) (HANDLE, PSTR, BOOL);
+/* SymCleanup() */
+typedef BOOL(WINAPI * fun_cleanup_t) (HANDLE hProcess);
+static fun_cleanup_t fun_cleanup;
 
-/* Pointer function to SymCleanup() */
-static BOOL(WINAPI * fun_cleanup) (HANDLE hProcess);
+/* SymFunctionTableAccess() */
+typedef PVOID(WINAPI * fun_function_table_access_t) (HANDLE, DWORD);
+static fun_function_table_access_t fun_function_table_access;
 
-/* Pointer function to SymFunctionTableAccess() */
-static PVOID(WINAPI * fun_function_table_access) (HANDLE, DWORD);
+/* SymGetLineFromAddr() */
+typedef BOOL(WINAPI * fun_get_line_from_addr_t) (HANDLE, DWORD,
+    PDWORD,
+    PIMAGEHLP_LINE);
+static fun_get_line_from_addr_t fun_get_line_from_addr;
 
-/* Pointer function to SymGetLineFromAddr() */
-static BOOL(WINAPI * fun_get_line_from_addr) (HANDLE, DWORD,
-                                               PDWORD,
-                                               PIMAGEHLP_LINE);
+/* SymGetModuleBase() */
+typedef DWORD(WINAPI *fun_get_module_base_t) (HANDLE, DWORD);
+static fun_get_module_base_t fun_get_module_base;
 
-/* Pointer function to SymGetModuleBase() */
-static DWORD(WINAPI * fun_get_module_base) (HANDLE, DWORD);
+/* SymGetOptions() */
+typedef DWORD(WINAPI *fun_get_options_t) (VOID);
+static fun_get_options_t fun_get_options;
 
-/* Pointer function to SymGetOptions() */
-static DWORD(WINAPI * fun_get_options) (VOID);
+/* SymSetOptions() */
+typedef DWORD(WINAPI *fun_set_options_t) (DWORD);
+static fun_set_options_t fun_set_options;
 
 /* Pointer function to SymGetSymFromAddr() */
-static BOOL(WINAPI * fun_get_sym_from_addr) (HANDLE, DWORD, PDWORD,
-                                              OUT PIMAGEHLP_SYMBOL);
-
-/* Pointer function to SymSetOptions() */
-static DWORD(WINAPI * fun_set_options) (DWORD);
+typedef BOOL(WINAPI *fun_get_sym_from_addr_t) (HANDLE, DWORD, PDWORD,
+    OUT PIMAGEHLP_SYMBOL);
+static fun_get_sym_from_addr_t fun_get_sym_from_addr;
 
 /* Pointer function to StackWalk() */
-static BOOL(WINAPI * fun_stack_walk) (DWORD, HANDLE, HANDLE,
-                                           LPSTACKFRAME, PVOID,
-                                           PREAD_PROCESS_MEMORY_ROUTINE,
-                                           PFUNCTION_TABLE_ACCESS_ROUTINE,
-                                           PGET_MODULE_BASE_ROUTINE,
-                                           PTRANSLATE_ADDRESS_ROUTINE);
-#endif
+typedef BOOL(WINAPI * fun_stack_walk_t) (DWORD, HANDLE, HANDLE,
+    LPSTACKFRAME, PVOID,
+    PREAD_PROCESS_MEMORY_ROUTINE,
+    PFUNCTION_TABLE_ACCESS_ROUTINE,
+    PGET_MODULE_BASE_ROUTINE,
+    PTRANSLATE_ADDRESS_ROUTINE);
+static fun_stack_walk_t fun_stack_walk;
 
 static HINSTANCE hlp_dbg_instance = NULL;
 static HANDLE process_handle = NULL;
 
 
 /* Module creation/destruction: nothing to do on linux */
-void xbt_backtrace_init(void) { 
+void xbt_backtrace_init(void) {
   process_handle = GetCurrentProcess();
 
   if (hlp_dbg_instance) {
@@ -82,43 +85,52 @@ void xbt_backtrace_init(void) {
 
   if (!hlp_dbg_instance)
     return;
+
   /* get the pointers to debug help library exported functions */
-  fun_initialize = GetProcAddress(hlp_dbg_instance, "SymInitialize");
-  fun_cleanup = GetProcAddress(hlp_dbg_instance, "SymCleanup");
-  fun_function_table_access = GetProcAddress(hlp_dbg_instance, "SymFunctionTableAccess");
-  fun_get_line_from_addr = GetProcAddress(hlp_dbg_instance, "SymGetLineFromAddr");
-  fun_get_module_base = GetProcAddress(hlp_dbg_instance, "SymGetModuleBase");
-  fun_get_options = GetProcAddress(hlp_dbg_instance, "SymGetOptions");
-  fun_get_sym_from_addr = GetProcAddress(hlp_dbg_instance, "SymGetSymFromAddr");
-  fun_set_options = GetProcAddress(hlp_dbg_instance, "SymSetOptions");
-  fun_stack_walk = GetProcAddress(hlp_dbg_instance, "StackWalk");
+  fun_initialize =
+    (fun_initialize_t) GetProcAddress(hlp_dbg_instance, "SymInitialize");
+  fun_cleanup =
+    (fun_cleanup_t) GetProcAddress(hlp_dbg_instance, "SymCleanup");
+  fun_function_table_access =
+    (fun_function_table_access_t) GetProcAddress(hlp_dbg_instance, "SymFunctionTableAccess");
+  fun_get_line_from_addr =
+    (fun_get_line_from_addr_t) GetProcAddress(hlp_dbg_instance, "SymGetLineFromAddr");
+  fun_get_module_base =
+    (fun_get_module_base_t) GetProcAddress(hlp_dbg_instance, "SymGetModuleBase");
+  fun_get_options =
+    (fun_get_options_t) GetProcAddress(hlp_dbg_instance, "SymGetOptions");
+  fun_get_sym_from_addr =
+    (fun_get_sym_from_addr_t) GetProcAddress(hlp_dbg_instance, "SymGetSymFromAddr");
+  fun_set_options =
+    (fun_set_options_t) GetProcAddress(hlp_dbg_instance, "SymSetOptions");
+  fun_stack_walk =
+    (fun_stack_walk_t) GetProcAddress(hlp_dbg_instance, "StackWalk");
 
   /* Check that everything worked well */
   if (!fun_initialize ||
       !fun_cleanup ||
-      !fun_function_table_access || 
+      !fun_function_table_access ||
       !fun_get_line_from_addr ||
       !fun_get_module_base ||
       !fun_get_options ||
       !fun_get_sym_from_addr ||
       !fun_set_options ||
       !fun_stack_walk
-      ) {
+  ) {
     FreeLibrary(hlp_dbg_instance);
     hlp_dbg_instance = NULL;
     return;
   }
 
   (*fun_set_options) ((*fun_get_options) () |
-                       SYMOPT_LOAD_LINES | SYMOPT_DEFERRED_LOADS);
+      SYMOPT_LOAD_LINES | SYMOPT_DEFERRED_LOADS);
 
   if (!(*fun_initialize) (process_handle, 0, 1)) {
     FreeLibrary(hlp_dbg_instance);
     hlp_dbg_instance = NULL;
   }
 }
-void xbt_backtrace_exit(void) { 
+void xbt_backtrace_exit(void) {
   if (!hlp_dbg_instance)
     return;
 
@@ -153,12 +165,19 @@ int backtrace(void **buffer, int size);
  */
 char **backtrace_symbols(void *const *buffer, int size);
 
+void xbt_backtrace_current(xbt_ex_t * e) {
+  e->used = backtrace((void **) e->bt, XBT_BACKTRACE_SIZE);
+}
+
+
 void xbt_ex_setup_backtrace(xbt_ex_t * e)
 {
   int i;
-  char **backtrace_syms = backtrace_symbols(e->bt, e->used);
+  char **backtrace_syms;
 
-  e->used = backtrace((void **) e->bt, XBT_BACKTRACE_SIZE);
+  xbt_assert0(e && e->used,"Backtrace not setup yet, cannot set it up for display");
+
+  backtrace_syms = backtrace_symbols(e->bt, e->used);
   e->bt_strings = NULL;
   /* parse the output and build a new backtrace */
   e->bt_strings = xbt_new(char *, e->used);
@@ -180,8 +199,8 @@ int backtrace(void **buffer, int size)
   unsigned long offset = 0;
   IMAGEHLP_LINE line_info = { 0 };
   byte
-    __buffer[(sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR) +
-              sizeof(ULONG64) - 1) / sizeof(ULONG64)];
+  __buffer[(sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR) +
+      sizeof(ULONG64) - 1) / sizeof(ULONG64)];
 
   CONTEXT context = { CONTEXT_FULL };
   GetThreadContext(GetCurrentThread(), &context);
@@ -193,7 +212,7 @@ int backtrace(void **buffer, int size)
   _asm mov context.Eip, eax
   _asm mov eax, esp
   _asm mov context.Esp, eax
-  _asm mov context.Ebp, ebp 
+  _asm mov context.Ebp, ebp
 
   if ((NULL == hlp_dbg_instance) || (size <= 0) || (NULL == buffer)) {
     errno = EINVAL;
@@ -227,13 +246,13 @@ int backtrace(void **buffer, int size)
     stack_frame->AddrStack.Mode = AddrModeFlat;
 
     if ((*fun_stack_walk) (IMAGE_FILE_MACHINE_I386,
-                          process_handle,
-                          GetCurrentThread(),
-                          stack_frame,
-                          &context,
-                          NULL,
-                          fun_function_table_access,
-                          fun_get_module_base, NULL)
+        process_handle,
+        GetCurrentThread(),
+        stack_frame,
+        &context,
+        NULL,
+        fun_function_table_access,
+        fun_get_module_base, NULL)
         && !first) {
       if (stack_frame->AddrReturn.Offset) {
 
@@ -269,8 +288,8 @@ char **backtrace_symbols(void *const *buffer, int size)
   IMAGEHLP_LINE line_info = { 0 };
   IMAGEHLP_MODULE module = { 0 };
   byte
-    __buffer[(sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR) +
-              sizeof(ULONG64) - 1) / sizeof(ULONG64)];
+  __buffer[(sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR) +
+      sizeof(ULONG64) - 1) / sizeof(ULONG64)];
 
   if ((NULL == hlp_dbg_instance) || (size <= 0) || (NULL == buffer)) {
     errno = EINVAL;
@@ -297,7 +316,7 @@ char **backtrace_symbols(void *const *buffer, int size)
         if ((*fun_get_line_from_addr) (process_handle, stack_frame->AddrPC.Offset, &offset, &line_info)) {
           strings[pos] =
             bprintf("**   In %s() at %s:%d", pSym->Name, line_info.FileName,
-                    line_info.LineNumber);
+                    (int)line_info.LineNumber);
         } else {
           strings[pos] = bprintf("**   In %s()", pSym->Name);
         }