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