//===-- 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 … #endif #define ARRAY_SIZE(A) … // String related macros. #define STRINGIFY_(S) … #define STRINGIFY(S) … #define CONCATENATE_(S, C) … #define CONCATENATE(S, C) … // Attributes & builtins related macros. #define INTERFACE … #define HIDDEN … #define WEAK … #define ALWAYS_INLINE … #define ALIAS(X) … #define FORMAT(F, A) … #define NOINLINE … #define NORETURN … #define LIKELY(X) … #define UNLIKELY(X) … #if defined(__i386__) || defined(__x86_64__) // __builtin_prefetch(X) generates prefetchnt0 on x86 #define PREFETCH(X) … #else #define PREFETCH … #endif #define UNUSED … #define USED … #define NOEXCEPT … // This check is only available on Clang. This is essentially an alias of // C++20's 'constinit' specifier which will take care of this when (if?) we can // ask all libc's that use Scudo to compile us with C++20. Dynamic // initialization is bad; Scudo is designed to be lazy-initializated on the // first call to malloc/free (and friends), and this generally happens in the // loader somewhere in libdl's init. After the loader is done, control is // transferred to libc's initialization, and the dynamic initializers are run. // If there's a dynamic initializer for Scudo, then it will clobber the // already-initialized Scudo, and re-initialize all its members back to default // values, causing various explosions. Unfortunately, marking // scudo::Allocator<>'s constructor as 'constexpr' isn't sufficient to prevent // dynamic initialization, as default initialization is fine under 'constexpr' // (but not 'constinit'). Clang at -O0, and gcc at all opt levels will emit a // dynamic initializer for any constant-initialized variables if there is a mix // of default-initialized and constant-initialized variables. // // If you're looking at this because your build failed, you probably introduced // a new member to scudo::Allocator<> (possibly transiently) that didn't have an // initializer. The fix is easy - just add one. #if defined(__has_attribute) #if __has_attribute(require_constant_initialization) #define SCUDO_REQUIRE_CONSTANT_INITIALIZATION … #else #define SCUDO_REQUIRE_CONSTANT_INITIALIZATION #endif #endif namespace scudo { uptr; u8; u16; u32; u64; sptr; s8; s16; s32; s64; // The following two functions have platform specific implementations. void outputRaw(const char *Buffer); void NORETURN die(); #define RAW_CHECK_MSG(Expr, Msg) … #define RAW_CHECK(Expr) … void NORETURN reportCheckFailed(const char *File, int Line, const char *Condition, u64 Value1, u64 Value2); #define CHECK_IMPL(C1, Op, C2) … #define CHECK(A) … #define CHECK_EQ(A, B) … #define CHECK_NE(A, B) … #define CHECK_LT(A, B) … #define CHECK_LE(A, B) … #define CHECK_GT(A, B) … #define CHECK_GE(A, B) … #if SCUDO_DEBUG #define DCHECK … #define DCHECK_EQ … #define DCHECK_NE … #define DCHECK_LT … #define DCHECK_LE … #define DCHECK_GT … #define DCHECK_GE … #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) … } // namespace scudo #endif // SCUDO_INTERNAL_DEFS_H_