1 /************************************************************************** 2 * 3 * Copyright 2009 VMware, Inc. 4 * All Rights Reserved. 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a 7 * copy of this software and associated documentation files (the 8 * "Software"), to deal in the Software without restriction, including 9 * without limitation the rights to use, copy, modify, merge, publish, 10 * distribute, sub license, and/or sell copies of the Software, and to 11 * permit persons to whom the Software is furnished to do so, subject to 12 * the following conditions: 13 * 14 * The above copyright notice and this permission notice (including the 15 * next paragraph) shall be included in all copies or substantial portions 16 * of the Software. 17 * 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR 22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25 * 26 **************************************************************************/ 27 28 #ifndef U_DEBUG_STACK_H_ 29 #define U_DEBUG_STACK_H_ 30 31 #include <stdio.h> 32 33 #ifdef HAVE_LIBUNWIND 34 #define UNW_LOCAL_ONLY 35 #include <libunwind.h> 36 #endif 37 38 /** 39 * @file 40 * Stack backtracing. 41 * 42 * @author Jose Fonseca <jfonseca@vmware.com> 43 */ 44 45 46 #ifdef __cplusplus 47 extern "C" { 48 #endif 49 50 51 /** 52 * Represent a frame from a stack backtrace. 53 * 54 #if defined(PIPE_OS_WINDOWS) && !defined(HAVE_LIBUNWIND) 55 * XXX: Do not change this. (passed to Windows' CaptureStackBackTrace()) 56 #endif 57 * 58 * TODO: This should be refactored as a void * typedef. 59 */ 60 struct debug_stack_frame 61 { 62 #ifdef HAVE_LIBUNWIND 63 unw_word_t start_ip; 64 unsigned int off; 65 const char *procname; 66 #else 67 const void *function; 68 #endif 69 }; 70 71 72 void 73 debug_backtrace_capture(struct debug_stack_frame *backtrace, 74 unsigned start_frame, 75 unsigned nr_frames); 76 77 void 78 debug_backtrace_dump(const struct debug_stack_frame *backtrace, 79 unsigned nr_frames); 80 81 void 82 debug_backtrace_print(FILE *f, 83 const struct debug_stack_frame *backtrace, 84 unsigned nr_frames); 85 86 #ifdef __cplusplus 87 } 88 #endif 89 90 #endif /* U_DEBUG_STACK_H_ */ 91