xref: /openbsd/gnu/llvm/libunwind/src/config.h (revision a0747c9f)
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_HIDE_SYMBOLS)
56   // The CMake file passes -fvisibility=hidden to control ELF/Mach-O visibility.
57   #define _LIBUNWIND_EXPORT
58   #define _LIBUNWIND_HIDDEN
59 #else
60   #if !defined(__ELF__) && !defined(__MACH__)
61     #define _LIBUNWIND_EXPORT __declspec(dllexport)
62     #define _LIBUNWIND_HIDDEN
63   #else
64     #define _LIBUNWIND_EXPORT __attribute__((visibility("default")))
65     #define _LIBUNWIND_HIDDEN __attribute__((visibility("hidden")))
66   #endif
67 #endif
68 
69 #define STR(a) #a
70 #define XSTR(a) STR(a)
71 #define SYMBOL_NAME(name) XSTR(__USER_LABEL_PREFIX__) #name
72 
73 #if defined(__APPLE__)
74 #if defined(_LIBUNWIND_HIDE_SYMBOLS)
75 #define _LIBUNWIND_ALIAS_VISIBILITY(name) __asm__(".private_extern " name);
76 #else
77 #define _LIBUNWIND_ALIAS_VISIBILITY(name)
78 #endif
79 #define _LIBUNWIND_WEAK_ALIAS(name, aliasname)                                 \
80   __asm__(".globl " SYMBOL_NAME(aliasname));                                   \
81   __asm__(SYMBOL_NAME(aliasname) " = " SYMBOL_NAME(name));                     \
82   _LIBUNWIND_ALIAS_VISIBILITY(SYMBOL_NAME(aliasname))
83 #elif defined(__ELF__)
84 #define _LIBUNWIND_WEAK_ALIAS(name, aliasname)                                 \
85   extern "C" _LIBUNWIND_EXPORT __typeof(name) aliasname                        \
86       __attribute__((weak, alias(#name)));
87 #elif defined(_WIN32)
88 #if defined(__MINGW32__)
89 #define _LIBUNWIND_WEAK_ALIAS(name, aliasname)                                 \
90   extern "C" _LIBUNWIND_EXPORT __typeof(name) aliasname                        \
91       __attribute__((alias(#name)));
92 #else
93 #define _LIBUNWIND_WEAK_ALIAS(name, aliasname)                                 \
94   __pragma(comment(linker, "/alternatename:" SYMBOL_NAME(aliasname) "="        \
95                                              SYMBOL_NAME(name)))               \
96   extern "C" _LIBUNWIND_EXPORT __typeof(name) aliasname;
97 #endif
98 #else
99 #error Unsupported target
100 #endif
101 
102 // Apple/armv7k defaults to DWARF/Compact unwinding, but its libunwind also
103 // needs to include the SJLJ APIs.
104 #if (defined(__APPLE__) && defined(__arm__)) || defined(__USING_SJLJ_EXCEPTIONS__)
105 #define _LIBUNWIND_BUILD_SJLJ_APIS
106 #endif
107 
108 #if defined(__i386__) || defined(__x86_64__) || defined(__ppc__) || defined(__ppc64__) || defined(__powerpc64__)
109 #define _LIBUNWIND_SUPPORT_FRAME_APIS
110 #endif
111 
112 #if defined(__i386__) || defined(__x86_64__) ||                                \
113     defined(__ppc__) || defined(__ppc64__) || defined(__powerpc64__) ||        \
114     (!defined(__APPLE__) && defined(__arm__)) ||                               \
115     defined(__aarch64__) ||                                                    \
116     defined(__mips__) ||                                                       \
117     defined(__riscv) ||                                                        \
118     defined(__sparc64__) ||                                                    \
119     defined(__hexagon__)
120 #if !defined(_LIBUNWIND_BUILD_SJLJ_APIS)
121 #define _LIBUNWIND_BUILD_ZERO_COST_APIS
122 #endif
123 #endif
124 
125 #ifndef _LIBUNWIND_REMEMBER_HEAP_ALLOC
126 #if defined(_LIBUNWIND_REMEMBER_STACK_ALLOC) || defined(__APPLE__) ||          \
127     defined(__linux__) || defined(__ANDROID__) || defined(__MINGW32__) ||      \
128     defined(_LIBUNWIND_IS_BAREMETAL)
129 #define _LIBUNWIND_REMEMBER_ALLOC(_size) alloca(_size)
130 #define _LIBUNWIND_REMEMBER_FREE(_ptr)                                         \
131   do {                                                                         \
132   } while (0)
133 #elif defined(_WIN32)
134 #define _LIBUNWIND_REMEMBER_ALLOC(_size) _malloca(_size)
135 #define _LIBUNWIND_REMEMBER_FREE(_ptr) _freea(_ptr)
136 #define _LIBUNWIND_REMEMBER_CLEANUP_NEEDED
137 #else
138 #define _LIBUNWIND_REMEMBER_ALLOC(_size) malloc(_size)
139 #define _LIBUNWIND_REMEMBER_FREE(_ptr) free(_ptr)
140 #define _LIBUNWIND_REMEMBER_CLEANUP_NEEDED
141 #endif
142 #else /* _LIBUNWIND_REMEMBER_HEAP_ALLOC */
143 #define _LIBUNWIND_REMEMBER_ALLOC(_size) malloc(_size)
144 #define _LIBUNWIND_REMEMBER_FREE(_ptr) free(_ptr)
145 #define _LIBUNWIND_REMEMBER_CLEANUP_NEEDED
146 #endif
147 
148 #if defined(NDEBUG) && defined(_LIBUNWIND_IS_BAREMETAL)
149 #define _LIBUNWIND_ABORT(msg)                                                  \
150   do {                                                                         \
151     abort();                                                                   \
152   } while (0)
153 #else
154 #define _LIBUNWIND_ABORT(msg)                                                  \
155   do {                                                                         \
156     fprintf(stderr, "libunwind: %s - %s\n", __func__, msg);                    \
157     fflush(stderr);                                                            \
158     abort();                                                                   \
159   } while (0)
160 #endif
161 
162 #if defined(NDEBUG) && defined(_LIBUNWIND_IS_BAREMETAL)
163 #define _LIBUNWIND_LOG0(msg)
164 #define _LIBUNWIND_LOG(msg, ...)
165 #else
166 #define _LIBUNWIND_LOG0(msg)                                               \
167   fprintf(stderr, "libunwind: " msg "\n")
168 #define _LIBUNWIND_LOG(msg, ...)                                               \
169   fprintf(stderr, "libunwind: " msg "\n", __VA_ARGS__)
170 #endif
171 
172 #if defined(NDEBUG)
173   #define _LIBUNWIND_LOG_IF_FALSE(x) x
174 #else
175   #define _LIBUNWIND_LOG_IF_FALSE(x)                                           \
176     do {                                                                       \
177       bool _ret = x;                                                           \
178       if (!_ret)                                                               \
179         _LIBUNWIND_LOG("" #x " failed in %s", __FUNCTION__);                   \
180     } while (0)
181 #endif
182 
183 // Macros that define away in non-Debug builds
184 #ifdef NDEBUG
185   #define _LIBUNWIND_DEBUG_LOG(msg, ...)
186   #define _LIBUNWIND_TRACE_API(msg, ...)
187   #define _LIBUNWIND_TRACING_UNWINDING (0)
188   #define _LIBUNWIND_TRACING_DWARF (0)
189   #define _LIBUNWIND_TRACE_UNWINDING(msg, ...)
190   #define _LIBUNWIND_TRACE_DWARF(...)
191 #else
192   #ifdef __cplusplus
193     extern "C" {
194   #endif
195     extern  bool logAPIs();
196     extern  bool logUnwinding();
197     extern  bool logDWARF();
198   #ifdef __cplusplus
199     }
200   #endif
201   #define _LIBUNWIND_DEBUG_LOG(msg, ...)  _LIBUNWIND_LOG(msg, __VA_ARGS__)
202   #define _LIBUNWIND_TRACE_API(msg, ...)                                       \
203     do {                                                                       \
204       if (logAPIs())                                                           \
205         _LIBUNWIND_LOG(msg, __VA_ARGS__);                                      \
206     } while (0)
207   #define _LIBUNWIND_TRACING_UNWINDING logUnwinding()
208   #define _LIBUNWIND_TRACING_DWARF logDWARF()
209   #define _LIBUNWIND_TRACE_UNWINDING(msg, ...)                                 \
210     do {                                                                       \
211       if (logUnwinding())                                                      \
212         _LIBUNWIND_LOG(msg, __VA_ARGS__);                                      \
213     } while (0)
214   #define _LIBUNWIND_TRACE_DWARF(...)                                          \
215     do {                                                                       \
216       if (logDWARF())                                                          \
217         fprintf(stderr, __VA_ARGS__);                                          \
218     } while (0)
219 #endif
220 
221 #ifdef __cplusplus
222 // Used to fit UnwindCursor and Registers_xxx types against unw_context_t /
223 // unw_cursor_t sized memory blocks.
224 #if defined(_LIBUNWIND_IS_NATIVE_ONLY)
225 # define COMP_OP ==
226 #else
227 # define COMP_OP <=
228 #endif
229 template <typename _Type, typename _Mem>
230 struct check_fit {
231   template <typename T>
232   struct blk_count {
233     static const size_t count =
234       (sizeof(T) + sizeof(uint64_t) - 1) / sizeof(uint64_t);
235   };
236   static const bool does_fit =
237     (blk_count<_Type>::count COMP_OP blk_count<_Mem>::count);
238 };
239 #undef COMP_OP
240 #endif // __cplusplus
241 
242 #endif // LIBUNWIND_CONFIG_H
243