| //===-- internal_defs.h -----------------------------------------*- C++ -*-===// |
| // |
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| // See https://llvm.org/LICENSE.txt for license information. |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #ifndef SCUDO_INTERNAL_DEFS_H_ |
| #define SCUDO_INTERNAL_DEFS_H_ |
| |
| #include "platform.h" |
| |
| #include <stdint.h> |
| |
| #ifndef SCUDO_DEBUG |
| #define SCUDO_DEBUG 0 |
| #endif |
| |
| #define ARRAY_SIZE(A) (sizeof(A) / sizeof((A)[0])) |
| |
| // String related macros. |
| |
| #define STRINGIFY_(S) #S |
| #define STRINGIFY(S) STRINGIFY_(S) |
| #define CONCATENATE_(S, C) S##C |
| #define CONCATENATE(S, C) CONCATENATE_(S, C) |
| |
| // Attributes & builtins related macros. |
| |
| #define INTERFACE __attribute__((visibility("default"))) |
| #define HIDDEN __attribute__((visibility("hidden"))) |
| #define WEAK __attribute__((weak)) |
| #define ALWAYS_INLINE inline __attribute__((always_inline)) |
| #define ALIAS(X) __attribute__((alias(X))) |
| #define FORMAT(F, A) __attribute__((format(printf, F, A))) |
| #define NOINLINE __attribute__((noinline)) |
| #define NORETURN __attribute__((noreturn)) |
| #define LIKELY(X) __builtin_expect(!!(X), 1) |
| #define UNLIKELY(X) __builtin_expect(!!(X), 0) |
| #if defined(__i386__) || defined(__x86_64__) |
| // __builtin_prefetch(X) generates prefetchnt0 on x86 |
| #define PREFETCH(X) __asm__("prefetchnta (%0)" : : "r"(X)) |
| #else |
| #define PREFETCH(X) __builtin_prefetch(X) |
| #endif |
| #define UNUSED __attribute__((unused)) |
| #define USED __attribute__((used)) |
| #define NOEXCEPT noexcept |
| |
| namespace scudo { |
| |
| typedef unsigned long uptr; |
| typedef unsigned char u8; |
| typedef unsigned short u16; |
| typedef unsigned int u32; |
| typedef unsigned long long u64; |
| typedef signed long sptr; |
| typedef signed char s8; |
| typedef signed short s16; |
| typedef signed int s32; |
| typedef signed long long s64; |
| |
| // The following two functions have platform specific implementations. |
| void outputRaw(const char *Buffer); |
| void NORETURN die(); |
| |
| #define RAW_CHECK_MSG(Expr, Msg) \ |
| do { \ |
| if (UNLIKELY(!(Expr))) { \ |
| outputRaw(Msg); \ |
| die(); \ |
| } \ |
| } while (false) |
| |
| #define RAW_CHECK(Expr) RAW_CHECK_MSG(Expr, #Expr) |
| |
| void NORETURN reportCheckFailed(const char *File, int Line, |
| const char *Condition, u64 Value1, u64 Value2); |
| |
| #define CHECK_IMPL(C1, Op, C2) \ |
| do { \ |
| scudo::u64 V1 = (scudo::u64)(C1); \ |
| scudo::u64 V2 = (scudo::u64)(C2); \ |
| if (UNLIKELY(!(V1 Op V2))) { \ |
| scudo::reportCheckFailed(__FILE__, __LINE__, \ |
| "(" #C1 ") " #Op " (" #C2 ")", V1, V2); \ |
| scudo::die(); \ |
| } \ |
| } while (false) |
| |
| #define CHECK(A) CHECK_IMPL((A), !=, 0) |
| #define CHECK_EQ(A, B) CHECK_IMPL((A), ==, (B)) |
| #define CHECK_NE(A, B) CHECK_IMPL((A), !=, (B)) |
| #define CHECK_LT(A, B) CHECK_IMPL((A), <, (B)) |
| #define CHECK_LE(A, B) CHECK_IMPL((A), <=, (B)) |
| #define CHECK_GT(A, B) CHECK_IMPL((A), >, (B)) |
| #define CHECK_GE(A, B) CHECK_IMPL((A), >=, (B)) |
| |
| #if SCUDO_DEBUG |
| #define DCHECK(A) CHECK(A) |
| #define DCHECK_EQ(A, B) CHECK_EQ(A, B) |
| #define DCHECK_NE(A, B) CHECK_NE(A, B) |
| #define DCHECK_LT(A, B) CHECK_LT(A, B) |
| #define DCHECK_LE(A, B) CHECK_LE(A, B) |
| #define DCHECK_GT(A, B) CHECK_GT(A, B) |
| #define DCHECK_GE(A, B) CHECK_GE(A, B) |
| #else |
| #define DCHECK(A) |
| #define DCHECK_EQ(A, B) |
| #define DCHECK_NE(A, B) |
| #define DCHECK_LT(A, B) |
| #define DCHECK_LE(A, B) |
| #define DCHECK_GT(A, B) |
| #define DCHECK_GE(A, B) |
| #endif |
| |
| // The superfluous die() call effectively makes this macro NORETURN. |
| #define UNREACHABLE(Msg) \ |
| do { \ |
| CHECK(0 && Msg); \ |
| die(); \ |
| } while (0) |
| |
| } // namespace scudo |
| |
| #endif // SCUDO_INTERNAL_DEFS_H_ |