1 //===-- internal_defs.h -----------------------------------------*- C++ -*-===// 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 9 #ifndef SCUDO_INTERNAL_DEFS_H_ 10 #define SCUDO_INTERNAL_DEFS_H_ 11 12 #include "platform.h" 13 14 #include <stdint.h> 15 16 #ifndef SCUDO_DEBUG 17 #define SCUDO_DEBUG 0 18 #endif 19 20 #define ARRAY_SIZE(A) (sizeof(A) / sizeof((A)[0])) 21 22 // String related macros. 23 24 #define STRINGIFY_(S) #S 25 #define STRINGIFY(S) STRINGIFY_(S) 26 #define CONCATENATE_(S, C) S##C 27 #define CONCATENATE(S, C) CONCATENATE_(S, C) 28 29 // Attributes & builtins related macros. 30 31 #define INTERFACE __attribute__((visibility("default"))) 32 #define HIDDEN __attribute__((visibility("hidden"))) 33 #define WEAK __attribute__((weak)) 34 #define ALWAYS_INLINE inline __attribute__((always_inline)) 35 #define ALIAS(X) __attribute__((alias(X))) 36 #define FORMAT(F, A) __attribute__((format(printf, F, A))) 37 #define NOINLINE __attribute__((noinline)) 38 #define NORETURN __attribute__((noreturn)) 39 #define LIKELY(X) __builtin_expect(!!(X), 1) 40 #define UNLIKELY(X) __builtin_expect(!!(X), 0) 41 #if defined(__i386__) || defined(__x86_64__) 42 // __builtin_prefetch(X) generates prefetchnt0 on x86 43 #define PREFETCH(X) __asm__("prefetchnta (%0)" : : "r"(X)) 44 #else 45 #define PREFETCH(X) __builtin_prefetch(X) 46 #endif 47 #define UNUSED __attribute__((unused)) 48 #define USED __attribute__((used)) 49 #define NOEXCEPT noexcept 50 51 namespace scudo { 52 53 typedef unsigned long uptr; 54 typedef unsigned char u8; 55 typedef unsigned short u16; 56 typedef unsigned int u32; 57 typedef unsigned long long u64; 58 typedef signed long sptr; 59 typedef signed char s8; 60 typedef signed short s16; 61 typedef signed int s32; 62 typedef signed long long s64; 63 64 // The following two functions have platform specific implementations. 65 void outputRaw(const char *Buffer); 66 void NORETURN die(); 67 68 #define RAW_CHECK_MSG(Expr, Msg) \ 69 do { \ 70 if (UNLIKELY(!(Expr))) { \ 71 outputRaw(Msg); \ 72 die(); \ 73 } \ 74 } while (false) 75 76 #define RAW_CHECK(Expr) RAW_CHECK_MSG(Expr, #Expr) 77 78 void NORETURN reportCheckFailed(const char *File, int Line, 79 const char *Condition, u64 Value1, u64 Value2); 80 81 #define CHECK_IMPL(C1, Op, C2) \ 82 do { \ 83 scudo::u64 V1 = (scudo::u64)(C1); \ 84 scudo::u64 V2 = (scudo::u64)(C2); \ 85 if (UNLIKELY(!(V1 Op V2))) { \ 86 scudo::reportCheckFailed(__FILE__, __LINE__, \ 87 "(" #C1 ") " #Op " (" #C2 ")", V1, V2); \ 88 scudo::die(); \ 89 } \ 90 } while (false) 91 92 #define CHECK(A) CHECK_IMPL((A), !=, 0) 93 #define CHECK_EQ(A, B) CHECK_IMPL((A), ==, (B)) 94 #define CHECK_NE(A, B) CHECK_IMPL((A), !=, (B)) 95 #define CHECK_LT(A, B) CHECK_IMPL((A), <, (B)) 96 #define CHECK_LE(A, B) CHECK_IMPL((A), <=, (B)) 97 #define CHECK_GT(A, B) CHECK_IMPL((A), >, (B)) 98 #define CHECK_GE(A, B) CHECK_IMPL((A), >=, (B)) 99 100 #if SCUDO_DEBUG 101 #define DCHECK(A) CHECK(A) 102 #define DCHECK_EQ(A, B) CHECK_EQ(A, B) 103 #define DCHECK_NE(A, B) CHECK_NE(A, B) 104 #define DCHECK_LT(A, B) CHECK_LT(A, B) 105 #define DCHECK_LE(A, B) CHECK_LE(A, B) 106 #define DCHECK_GT(A, B) CHECK_GT(A, B) 107 #define DCHECK_GE(A, B) CHECK_GE(A, B) 108 #else 109 #define DCHECK(A) 110 #define DCHECK_EQ(A, B) 111 #define DCHECK_NE(A, B) 112 #define DCHECK_LT(A, B) 113 #define DCHECK_LE(A, B) 114 #define DCHECK_GT(A, B) 115 #define DCHECK_GE(A, B) 116 #endif 117 118 // The superfluous die() call effectively makes this macro NORETURN. 119 #define UNREACHABLE(Msg) \ 120 do { \ 121 CHECK(0 && Msg); \ 122 die(); \ 123 } while (0) 124 125 } // namespace scudo 126 127 #endif // SCUDO_INTERNAL_DEFS_H_ 128