• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //===----------------------------- config.h -------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //
8 //  Defines macros used within libunwind project.
9 //
10 //===----------------------------------------------------------------------===//
11 
12 
13 #ifndef LIBUNWIND_CONFIG_H
14 #define LIBUNWIND_CONFIG_H
15 
16 #include <assert.h>
17 #include <stdio.h>
18 #include <stdint.h>
19 #include <stdlib.h>
20 
21 #include <__libunwind_config.h>
22 
23 // Platform specific configuration defines.
24 #ifdef __APPLE__
25   #if defined(FOR_DYLD)
26     #define _LIBUNWIND_SUPPORT_COMPACT_UNWIND 1
27   #else
28     #define _LIBUNWIND_SUPPORT_COMPACT_UNWIND 1
29     #define _LIBUNWIND_SUPPORT_DWARF_UNWIND 1
30   #endif
31 #elif defined(_WIN32)
32   #ifdef __SEH__
33     #define _LIBUNWIND_SUPPORT_SEH_UNWIND 1
34   #else
35     #define _LIBUNWIND_SUPPORT_DWARF_UNWIND 1
36   #endif
37 #elif defined(_LIBUNWIND_IS_BAREMETAL)
38   #if !defined(_LIBUNWIND_ARM_EHABI)
39     #define _LIBUNWIND_SUPPORT_DWARF_UNWIND 1
40     #define _LIBUNWIND_SUPPORT_DWARF_INDEX 1
41   #endif
42 #elif defined(__BIONIC__) && defined(_LIBUNWIND_ARM_EHABI)
43   // For ARM EHABI, Bionic didn't implement dl_iterate_phdr until API 21. After
44   // API 21, dl_iterate_phdr exists, but dl_unwind_find_exidx is much faster.
45   #define _LIBUNWIND_USE_DL_UNWIND_FIND_EXIDX 1
46 #else
47   // Assume an ELF system with a dl_iterate_phdr function.
48   #define _LIBUNWIND_USE_DL_ITERATE_PHDR 1
49   #if !defined(_LIBUNWIND_ARM_EHABI)
50     #define _LIBUNWIND_SUPPORT_DWARF_UNWIND 1
51     #define _LIBUNWIND_SUPPORT_DWARF_INDEX 1
52   #endif
53 #endif
54 
55 #if defined(_LIBUNWIND_DISABLE_VISIBILITY_ANNOTATIONS)
56   #define _LIBUNWIND_EXPORT
57   #define _LIBUNWIND_HIDDEN
58 #else
59   #if !defined(__ELF__) && !defined(__MACH__)
60     #define _LIBUNWIND_EXPORT __declspec(dllexport)
61     #define _LIBUNWIND_HIDDEN
62   #else
63     #define _LIBUNWIND_EXPORT __attribute__((visibility("default")))
64     #define _LIBUNWIND_HIDDEN __attribute__((visibility("hidden")))
65   #endif
66 #endif
67 
68 #define STR(a) #a
69 #define XSTR(a) STR(a)
70 #define SYMBOL_NAME(name) XSTR(__USER_LABEL_PREFIX__) #name
71 
72 #if defined(__APPLE__)
73 #define _LIBUNWIND_WEAK_ALIAS(name, aliasname)                                 \
74   __asm__(".globl " SYMBOL_NAME(aliasname));                                   \
75   __asm__(SYMBOL_NAME(aliasname) " = " SYMBOL_NAME(name));                     \
76   extern "C" _LIBUNWIND_EXPORT __typeof(name) aliasname                        \
77       __attribute__((weak_import));
78 #elif defined(__ELF__)
79 #define _LIBUNWIND_WEAK_ALIAS(name, aliasname)                                 \
80   extern "C" _LIBUNWIND_EXPORT __typeof(name) aliasname                        \
81       __attribute__((weak, alias(#name)));
82 #elif defined(_WIN32)
83 #if defined(__MINGW32__)
84 #define _LIBUNWIND_WEAK_ALIAS(name, aliasname)                                 \
85   extern "C" _LIBUNWIND_EXPORT __typeof(name) aliasname                        \
86       __attribute__((alias(#name)));
87 #else
88 #define _LIBUNWIND_WEAK_ALIAS(name, aliasname)                                 \
89   __pragma(comment(linker, "/alternatename:" SYMBOL_NAME(aliasname) "="        \
90                                              SYMBOL_NAME(name)))               \
91   extern "C" _LIBUNWIND_EXPORT __typeof(name) aliasname;
92 #endif
93 #else
94 #error Unsupported target
95 #endif
96 
97 // Apple/armv7k defaults to DWARF/Compact unwinding, but its libunwind also
98 // needs to include the SJLJ APIs.
99 #if (defined(__APPLE__) && defined(__arm__)) || defined(__USING_SJLJ_EXCEPTIONS__)
100 #define _LIBUNWIND_BUILD_SJLJ_APIS
101 #endif
102 
103 #if defined(__i386__) || defined(__x86_64__) || defined(__ppc__) || defined(__ppc64__) || defined(__powerpc64__)
104 #define _LIBUNWIND_SUPPORT_FRAME_APIS
105 #endif
106 
107 #if defined(__i386__) || defined(__x86_64__) ||                                \
108     defined(__ppc__) || defined(__ppc64__) || defined(__powerpc64__) ||        \
109     (!defined(__APPLE__) && defined(__arm__)) ||                               \
110     defined(__aarch64__) ||                                                    \
111     defined(__mips__) ||                                                       \
112     defined(__riscv) ||                                                        \
113     defined(__hexagon__)
114 #if !defined(_LIBUNWIND_BUILD_SJLJ_APIS)
115 #define _LIBUNWIND_BUILD_ZERO_COST_APIS
116 #endif
117 #endif
118 
119 #ifndef _LIBUNWIND_REMEMBER_HEAP_ALLOC
120 #if defined(_LIBUNWIND_REMEMBER_STACK_ALLOC) || defined(__APPLE__) ||          \
121     defined(__linux__) || defined(__ANDROID__) || defined(__MINGW32__) ||      \
122     defined(_LIBUNWIND_IS_BAREMETAL)
123 #define _LIBUNWIND_REMEMBER_ALLOC(_size) alloca(_size)
124 #define _LIBUNWIND_REMEMBER_FREE(_ptr)                                         \
125   do {                                                                         \
126   } while (0)
127 #elif defined(_WIN32)
128 #define _LIBUNWIND_REMEMBER_ALLOC(_size) _malloca(_size)
129 #define _LIBUNWIND_REMEMBER_FREE(_ptr) _freea(_ptr)
130 #define _LIBUNWIND_REMEMBER_CLEANUP_NEEDED
131 #else
132 #define _LIBUNWIND_REMEMBER_ALLOC(_size) malloc(_size)
133 #define _LIBUNWIND_REMEMBER_FREE(_ptr) free(_ptr)
134 #define _LIBUNWIND_REMEMBER_CLEANUP_NEEDED
135 #endif
136 #else /* _LIBUNWIND_REMEMBER_HEAP_ALLOC */
137 #define _LIBUNWIND_REMEMBER_ALLOC(_size) malloc(_size)
138 #define _LIBUNWIND_REMEMBER_FREE(_ptr) free(_ptr)
139 #define _LIBUNWIND_REMEMBER_CLEANUP_NEEDED
140 #endif
141 
142 #if defined(NDEBUG) && defined(_LIBUNWIND_IS_BAREMETAL)
143 #define _LIBUNWIND_ABORT(msg)                                                  \
144   do {                                                                         \
145     abort();                                                                   \
146   } while (0)
147 #else
148 #define _LIBUNWIND_ABORT(msg)                                                  \
149   do {                                                                         \
150     fprintf(stderr, "libunwind: %s - %s\n", __func__, msg);                    \
151     fflush(stderr);                                                            \
152     abort();                                                                   \
153   } while (0)
154 #endif
155 
156 #if defined(NDEBUG) && defined(_LIBUNWIND_IS_BAREMETAL)
157 #define _LIBUNWIND_LOG0(msg)
158 #define _LIBUNWIND_LOG(msg, ...)
159 #else
160 #define _LIBUNWIND_LOG0(msg)                                               \
161   fprintf(stderr, "libunwind: " msg "\n")
162 #define _LIBUNWIND_LOG(msg, ...)                                               \
163   fprintf(stderr, "libunwind: " msg "\n", __VA_ARGS__)
164 #endif
165 
166 #if defined(NDEBUG)
167   #define _LIBUNWIND_LOG_IF_FALSE(x) x
168 #else
169   #define _LIBUNWIND_LOG_IF_FALSE(x)                                           \
170     do {                                                                       \
171       bool _ret = x;                                                           \
172       if (!_ret)                                                               \
173         _LIBUNWIND_LOG("" #x " failed in %s", __FUNCTION__);                   \
174     } while (0)
175 #endif
176 
177 // Macros that define away in non-Debug builds
178 #ifdef NDEBUG
179   #define _LIBUNWIND_DEBUG_LOG(msg, ...)
180   #define _LIBUNWIND_TRACE_API(msg, ...)
181   #define _LIBUNWIND_TRACING_UNWINDING (0)
182   #define _LIBUNWIND_TRACING_DWARF (0)
183   #define _LIBUNWIND_TRACE_UNWINDING(msg, ...)
184   #define _LIBUNWIND_TRACE_DWARF(...)
185 #else
186   #ifdef __cplusplus
187     extern "C" {
188   #endif
189     extern  bool logAPIs();
190     extern  bool logUnwinding();
191     extern  bool logDWARF();
192   #ifdef __cplusplus
193     }
194   #endif
195   #define _LIBUNWIND_DEBUG_LOG(msg, ...)  _LIBUNWIND_LOG(msg, __VA_ARGS__)
196   #define _LIBUNWIND_TRACE_API(msg, ...)                                       \
197     do {                                                                       \
198       if (logAPIs())                                                           \
199         _LIBUNWIND_LOG(msg, __VA_ARGS__);                                      \
200     } while (0)
201   #define _LIBUNWIND_TRACING_UNWINDING logUnwinding()
202   #define _LIBUNWIND_TRACING_DWARF logDWARF()
203   #define _LIBUNWIND_TRACE_UNWINDING(msg, ...)                                 \
204     do {                                                                       \
205       if (logUnwinding())                                                      \
206         _LIBUNWIND_LOG(msg, __VA_ARGS__);                                      \
207     } while (0)
208   #define _LIBUNWIND_TRACE_DWARF(...)                                          \
209     do {                                                                       \
210       if (logDWARF())                                                          \
211         fprintf(stderr, __VA_ARGS__);                                          \
212     } while (0)
213 #endif
214 
215 #ifdef __cplusplus
216 // Used to fit UnwindCursor and Registers_xxx types against unw_context_t /
217 // unw_cursor_t sized memory blocks.
218 #if defined(_LIBUNWIND_IS_NATIVE_ONLY)
219 # define COMP_OP ==
220 #else
221 # define COMP_OP <=
222 #endif
223 template <typename _Type, typename _Mem>
224 struct check_fit {
225   template <typename T>
226   struct blk_count {
227     static const size_t count =
228       (sizeof(T) + sizeof(uint64_t) - 1) / sizeof(uint64_t);
229   };
230   static const bool does_fit =
231     (blk_count<_Type>::count COMP_OP blk_count<_Mem>::count);
232 };
233 #undef COMP_OP
234 #endif // __cplusplus
235 
236 #endif // LIBUNWIND_CONFIG_H
237