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 #include "util/detect_os.h"
34 
35 #ifdef HAVE_LIBUNWIND
36 #define UNW_LOCAL_ONLY
37 #include <libunwind.h>
38 #endif
39 
40 /**
41  * @file
42  * Stack backtracing.
43  *
44  * @author Jose Fonseca <jfonseca@vmware.com>
45  */
46 
47 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 
53 /**
54  * Represent a frame from a stack backtrace.
55  *
56 #if DETECT_OS_WINDOWS && !defined(HAVE_LIBUNWIND)
57  * XXX: Do not change this. (passed to Windows' CaptureStackBackTrace())
58 #endif
59  *
60  * TODO: This should be refactored as a void * typedef.
61  */
62 struct debug_stack_frame
63 {
64 #if defined(HAVE_ANDROID_PLATFORM) || defined(HAVE_LIBUNWIND)
65    const char *procname;
66    uint64_t start_ip;
67    unsigned off;
68    const char *map;
69    unsigned int map_off;
70 #else
71    const void *function;
72 #endif
73 };
74 
75 
76 void
77 debug_backtrace_capture(struct debug_stack_frame *backtrace,
78                         unsigned start_frame,
79                         unsigned nr_frames);
80 
81 void
82 debug_backtrace_dump(const struct debug_stack_frame *backtrace,
83                      unsigned nr_frames);
84 
85 void
86 debug_backtrace_print(FILE *f,
87                       const struct debug_stack_frame *backtrace,
88                       unsigned nr_frames);
89 
90 #ifdef __cplusplus
91 }
92 #endif
93 
94 #endif /* U_DEBUG_STACK_H_ */
95