| /************************************************************************** |
| * |
| * Copyright 2009 VMware, Inc. |
| * All Rights Reserved. |
| * |
| * Permission is hereby granted, free of charge, to any person obtaining a |
| * copy of this software and associated documentation files (the |
| * "Software"), to deal in the Software without restriction, including |
| * without limitation the rights to use, copy, modify, merge, publish, |
| * distribute, sub license, and/or sell copies of the Software, and to |
| * permit persons to whom the Software is furnished to do so, subject to |
| * the following conditions: |
| * |
| * The above copyright notice and this permission notice (including the |
| * next paragraph) shall be included in all copies or substantial portions |
| * of the Software. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
| * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. |
| * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR |
| * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
| * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
| * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| * |
| **************************************************************************/ |
| |
| /** |
| * @file |
| * Stack backtracing. |
| * |
| * @author Jose Fonseca <jfonseca@vmware.com> |
| */ |
| |
| #include "u_debug.h" |
| #include "u_debug_symbol.h" |
| #include "u_debug_stack.h" |
| |
| #if defined(HAVE_LIBUNWIND) |
| |
| #ifndef _GNU_SOURCE |
| #define _GNU_SOURCE |
| #endif |
| #include <dlfcn.h> |
| |
| void |
| debug_backtrace_capture(struct debug_stack_frame *backtrace, |
| unsigned start_frame, |
| unsigned nr_frames) |
| { |
| unw_cursor_t cursor; |
| unw_context_t context; |
| unw_proc_info_t pip; |
| unsigned i = 0; |
| int ret; |
| |
| pip.unwind_info = NULL; |
| |
| unw_getcontext(&context); |
| unw_init_local(&cursor, &context); |
| |
| while ((start_frame > 0) && (unw_step(&cursor) > 0)) |
| start_frame--; |
| |
| while (unw_step(&cursor) > 0) { |
| char procname[256]; |
| const char *filename; |
| unw_word_t off; |
| Dl_info dlinfo; |
| |
| unw_get_proc_info(&cursor, &pip); |
| |
| ret = unw_get_proc_name(&cursor, procname, 256, &off); |
| if (ret && ret != -UNW_ENOMEM) { |
| procname[0] = '?'; |
| procname[1] = 0; |
| } |
| |
| if (dladdr((void *)(uintptr_t)(pip.start_ip + off), &dlinfo) && dlinfo.dli_fname && |
| *dlinfo.dli_fname) |
| filename = dlinfo.dli_fname; |
| else |
| filename = "?"; |
| |
| snprintf(backtrace[i].buf, sizeof(backtrace[i].buf), |
| "%u: %s (%s%s+0x%x) [%p]", i, filename, procname, |
| ret == -UNW_ENOMEM ? "..." : "", (int)off, |
| (void *)(uintptr_t)(pip.start_ip + off)); |
| |
| i++; |
| } |
| |
| while (i < nr_frames) { |
| backtrace[i].buf[0] = '\0'; |
| i++; |
| } |
| } |
| |
| void |
| debug_backtrace_dump(const struct debug_stack_frame *backtrace, |
| unsigned nr_frames) |
| { |
| unsigned i; |
| |
| for (i = 0; i < nr_frames; ++i) { |
| if (backtrace[i].buf[0] == '\0') |
| break; |
| debug_printf("\t%s\n", backtrace[i].buf); |
| } |
| } |
| |
| void |
| debug_backtrace_print(FILE *f, |
| const struct debug_stack_frame *backtrace, |
| unsigned nr_frames) |
| { |
| unsigned i; |
| |
| for (i = 0; i < nr_frames; ++i) { |
| if (backtrace[i].buf[0] == '\0') |
| break; |
| fprintf(f, "\t%s\n", backtrace[i].buf); |
| } |
| } |
| |
| #else /* ! HAVE_LIBUNWIND */ |
| |
| #if defined(PIPE_OS_WINDOWS) |
| #include <windows.h> |
| #endif |
| |
| |
| /** |
| * Capture stack backtrace. |
| * |
| * NOTE: The implementation of this function is quite big, but it is important |
| * not to break it down in smaller functions to avoid adding new frames to the |
| * calling stack. |
| */ |
| void |
| debug_backtrace_capture(struct debug_stack_frame *backtrace, |
| unsigned start_frame, |
| unsigned nr_frames) |
| { |
| const void **frame_pointer = NULL; |
| unsigned i = 0; |
| |
| if (!nr_frames) { |
| return; |
| } |
| |
| /* |
| * On Windows try obtaining the stack backtrace via CaptureStackBackTrace. |
| * |
| * It works reliably both for x86 for x86_64. |
| */ |
| #if defined(PIPE_OS_WINDOWS) |
| { |
| typedef USHORT (WINAPI *PFNCAPTURESTACKBACKTRACE)(ULONG, ULONG, |
| PVOID *, PULONG); |
| static PFNCAPTURESTACKBACKTRACE pfnCaptureStackBackTrace = NULL; |
| |
| if (!pfnCaptureStackBackTrace) { |
| static HMODULE hModule = NULL; |
| if (!hModule) { |
| hModule = LoadLibraryA("kernel32"); |
| assert(hModule); |
| } |
| if (hModule) { |
| pfnCaptureStackBackTrace = |
| (PFNCAPTURESTACKBACKTRACE)GetProcAddress(hModule, |
| "RtlCaptureStackBackTrace"); |
| } |
| } |
| if (pfnCaptureStackBackTrace) { |
| /* |
| * Skip this (debug_backtrace_capture) function's frame. |
| */ |
| |
| start_frame += 1; |
| |
| assert(start_frame + nr_frames < 63); |
| i = pfnCaptureStackBackTrace(start_frame, nr_frames, |
| (PVOID *) &backtrace->function, NULL); |
| |
| /* Pad remaing requested frames with NULL */ |
| while (i < nr_frames) { |
| backtrace[i++].function = NULL; |
| } |
| |
| return; |
| } |
| } |
| #endif |
| |
| #if defined(PIPE_CC_GCC) |
| frame_pointer = ((const void **)__builtin_frame_address(1)); |
| #elif defined(PIPE_CC_MSVC) && defined(PIPE_ARCH_X86) |
| __asm { |
| mov frame_pointer, ebp |
| } |
| frame_pointer = (const void **)frame_pointer[0]; |
| #else |
| frame_pointer = NULL; |
| #endif |
| |
| #ifdef PIPE_ARCH_X86 |
| while (nr_frames) { |
| const void **next_frame_pointer; |
| |
| if (!frame_pointer) |
| break; |
| |
| if (start_frame) |
| --start_frame; |
| else { |
| backtrace[i++].function = frame_pointer[1]; |
| --nr_frames; |
| } |
| |
| next_frame_pointer = (const void **)frame_pointer[0]; |
| |
| /* Limit the stack walk to avoid referencing undefined memory */ |
| if ((uintptr_t)next_frame_pointer <= (uintptr_t)frame_pointer || |
| (uintptr_t)next_frame_pointer > (uintptr_t)frame_pointer + 64*1024) |
| break; |
| |
| frame_pointer = next_frame_pointer; |
| } |
| #else |
| (void) frame_pointer; |
| #endif |
| |
| while (nr_frames) { |
| backtrace[i++].function = NULL; |
| --nr_frames; |
| } |
| } |
| |
| |
| void |
| debug_backtrace_dump(const struct debug_stack_frame *backtrace, |
| unsigned nr_frames) |
| { |
| unsigned i; |
| |
| for (i = 0; i < nr_frames; ++i) { |
| if (!backtrace[i].function) |
| break; |
| debug_symbol_print(backtrace[i].function); |
| } |
| } |
| |
| |
| void |
| debug_backtrace_print(FILE *f, |
| const struct debug_stack_frame *backtrace, |
| unsigned nr_frames) |
| { |
| unsigned i; |
| |
| for (i = 0; i < nr_frames; ++i) { |
| const char *symbol; |
| if (!backtrace[i].function) |
| break; |
| symbol = debug_symbol_name_cached(backtrace[i].function); |
| if (symbol) |
| fprintf(f, "%s\n", symbol); |
| } |
| } |
| |
| #endif /* HAVE_LIBUNWIND */ |