global.hpp

// Copyright 2019-2022 Laurynas Biveinis
#ifndef UNODB_DETAIL_GLOBAL_HPP
#define UNODB_DETAIL_GLOBAL_HPP

// Defines that must precede includes

#ifdef UNODB_DETAIL_STANDALONE

#if !defined(NDEBUG) && !defined(__clang__)

#ifndef _GLIBCXX_DEBUG
#define _GLIBCXX_DEBUG
#endif

#ifndef _GLIBCXX_DEBUG_PEDANTIC
#define _GLIBCXX_DEBUG_PEDANTIC
#endif

#endif  // !defined(NDEBUG) && !defined(__clang__)

#if defined(__has_feature) && !defined(__clang__)
#if __has_feature(address_sanitizer)
#define _GLIBCXX_SANITIZE_VECTOR 1
#endif
#elif defined(__SANITIZE_ADDRESS__)
#define _GLIBCXX_SANITIZE_VECTOR 1
#endif

#endif  // UNODB_DETAIL_STANDALONE

#ifdef _MSC_VER
#define NOMINMAX
#if !defined(NDEBUG) && defined(__SANITIZE_ADDRESS__)
// Workaround bug of _aligned_free not being hooked for ASan under MSVC debug
// build -
// https://developercommunity.visualstudio.com/t/asan-check-failed-using-aligned-free-in-debug-buil/1406956
#undef _CRTDBG_MAP_ALLOC
#endif
#endif

// Architecture

#if defined(_MSC_VER) && defined(_M_X64)
#define UNODB_DETAIL_MSVC_X86_64
#endif

#if defined(__x86_64) || defined(UNODB_DETAIL_MSVC_X86_64)
#define UNODB_DETAIL_X86_64
#endif

#ifdef UNODB_DETAIL_X86_64
#ifdef __AVX2__
#define UNODB_DETAIL_AVX2
#else
#define UNODB_DETAIL_SSE4_2
#endif
#endif

#if defined(UNODB_DETAIL_X86_64) || \
    defined(__BYTE_ORDER__) && __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
#define UNODB_DETAIL_LITTLE_ENDIAN
#endif

// Compiler

#if defined(_MSC_VER)
#if !defined(__clang__)
// MSVC with the MSVC frontend, not the LLVM one
#define UNODB_DETAIL_MSVC
#else  // #if !defined(__clang__)
#define UNODB_DETAIL_MSVC_CLANG
#endif  // #if !defined(__clang__)
#endif  // #if defined(_MSC_VER)

#ifndef UNODB_DETAIL_MSVC

#ifdef __clang__

#define UNODB_DETAIL_BUILTIN_ASSUME(x) __builtin_assume(x)
#define UNODB_DETAIL_LIFETIMEBOUND [[clang::lifetimebound]]
#define UNODB_DETAIL_C_STRING_ARG(x)

#else

#define UNODB_DETAIL_BUILTIN_ASSUME(x) \
  do {                                 \
    if (!(x)) __builtin_unreachable(); \
  } while (0)

#define UNODB_DETAIL_LIFETIMEBOUND

#if __GNUG__ >= 14

#define UNODB_DETAIL_C_STRING_ARG(x) \
  __attribute__((null_terminated_string_arg(x)))

#else

#define UNODB_DETAIL_C_STRING_ARG(x)

#endif

#endif

#define UNODB_DETAIL_LIKELY(x) __builtin_expect(x, 1)
#define UNODB_DETAIL_UNLIKELY(x) __builtin_expect(x, 0)
#define UNODB_DETAIL_UNUSED [[gnu::unused]]
#define UNODB_DETAIL_FORCE_INLINE __attribute__((always_inline))
#define UNODB_DETAIL_NOINLINE __attribute__((noinline))
#define UNODB_DETAIL_UNREACHABLE() __builtin_unreachable()
#define UNODB_DETAIL_CONSTEXPR_NOT_MSVC constexpr

#else  // #ifndef UNODB_DETAIL_MSVC

#define UNODB_DETAIL_BUILTIN_ASSUME(x) __assume(x)
#define UNODB_DETAIL_LIKELY(x) (!!(x))
#define UNODB_DETAIL_UNLIKELY(x) (!!(x))
#define UNODB_DETAIL_UNUSED [[maybe_unused]]
#define UNODB_DETAIL_FORCE_INLINE __forceinline
#define UNODB_DETAIL_NOINLINE __declspec(noinline)
#define UNODB_DETAIL_UNREACHABLE() __assume(0)
#define UNODB_DETAIL_CONSTEXPR_NOT_MSVC inline
#define UNODB_DETAIL_LIFETIMEBOUND
#define UNODB_DETAIL_C_STRING_ARG(x)

#endif  // #ifndef UNODB_DETAIL_MSVC

// Sanitizers

#if defined(__has_feature)
#if __has_feature(address_sanitizer)
#define UNODB_DETAIL_ADDRESS_SANITIZER 1
#endif
#if __has_feature(thread_sanitizer)
#define UNODB_DETAIL_THREAD_SANITIZER 1
#endif
#else
#ifdef __SANITIZE_ADDRESS__
#define UNODB_DETAIL_ADDRESS_SANITIZER 1
#endif
#ifdef __SANITIZE_THREAD__
#define UNODB_DETAIL_THREAD_SANITIZER 1
#endif
#endif

// Warnings

#define UNODB_DETAIL_DO_PRAGMA(x) _Pragma(#x)

#ifndef UNODB_DETAIL_MSVC

#define UNODB_DETAIL_DISABLE_WARNING(x) \
  _Pragma("GCC diagnostic push")        \
      UNODB_DETAIL_DO_PRAGMA(GCC diagnostic ignored x)

#define UNODB_DETAIL_RESTORE_WARNINGS() _Pragma("GCC diagnostic pop")

#define UNODB_DETAIL_DISABLE_MSVC_WARNING(x)
#define UNODB_DETAIL_RESTORE_MSVC_WARNINGS()

#else  // #ifndef UNODB_DETAIL_MSVC

#define UNODB_DETAIL_DISABLE_MSVC_WARNING(x) \
  _Pragma("warning(push)") UNODB_DETAIL_DO_PRAGMA(warning(disable : x))

#define UNODB_DETAIL_RESTORE_MSVC_WARNINGS() _Pragma("warning(pop)")

#endif  // #ifndef UNODB_DETAIL_MSVC

#ifdef __clang__
#define UNODB_DETAIL_DISABLE_CLANG_WARNING(x) UNODB_DETAIL_DISABLE_WARNING(x)
#define UNODB_DETAIL_RESTORE_CLANG_WARNINGS() UNODB_DETAIL_RESTORE_WARNINGS()
#else
#define UNODB_DETAIL_DISABLE_CLANG_WARNING(x)
#define UNODB_DETAIL_RESTORE_CLANG_WARNINGS()
#endif

#if defined(__GNUG__) && !defined(__clang__)
#define UNODB_DETAIL_DISABLE_GCC_WARNING(x) UNODB_DETAIL_DISABLE_WARNING(x)
#define UNODB_DETAIL_RESTORE_GCC_WARNINGS() UNODB_DETAIL_RESTORE_WARNINGS()
#if __GNUG__ == 10
#define UNODB_DETAIL_DISABLE_GCC_10_WARNING(x) UNODB_DETAIL_DISABLE_WARNING(x)
#define UNODB_DETAIL_RESTORE_GCC_10_WARNINGS() UNODB_DETAIL_RESTORE_WARNINGS()
#else  // __GNUG__ == 10
#define UNODB_DETAIL_DISABLE_GCC_10_WARNING(x)
#define UNODB_DETAIL_RESTORE_GCC_10_WARNINGS()
#endif  // __GNUG__ == 10
#if __GNUG__ >= 11
#define UNODB_DETAIL_DISABLE_GCC_11_WARNING(x) UNODB_DETAIL_DISABLE_WARNING(x)
#define UNODB_DETAIL_RESTORE_GCC_11_WARNINGS() UNODB_DETAIL_RESTORE_WARNINGS()
#else  // __GNUG__ >= 11
#define UNODB_DETAIL_DISABLE_GCC_11_WARNING(x)
#define UNODB_DETAIL_RESTORE_GCC_11_WARNINGS()
#endif  // __GNUG__ >= 11
#else   // defined(__GNUG__) && !defined(__clang__)
#define UNODB_DETAIL_DISABLE_GCC_WARNING(x)
#define UNODB_DETAIL_RESTORE_GCC_WARNINGS()
#define UNODB_DETAIL_DISABLE_GCC_10_WARNING(x)
#define UNODB_DETAIL_RESTORE_GCC_10_WARNINGS()
#define UNODB_DETAIL_DISABLE_GCC_11_WARNING(x)
#define UNODB_DETAIL_RESTORE_GCC_11_WARNINGS()
#endif  // defined(__GNUG__) && !defined(__clang__)

// Debug or release build

#ifdef NDEBUG
#define UNODB_DETAIL_RELEASE_CONSTEXPR constexpr
#define UNODB_DETAIL_RELEASE_CONST const
#define UNODB_DETAIL_RELEASE_EXPLICIT explicit
#define UNODB_DETAIL_USED_IN_DEBUG UNODB_DETAIL_UNUSED
#else
#define UNODB_DETAIL_RELEASE_CONSTEXPR
#define UNODB_DETAIL_RELEASE_CONST
#define UNODB_DETAIL_RELEASE_EXPLICIT
#define UNODB_DETAIL_USED_IN_DEBUG
#endif

#endif  // UNODB_DETAIL_GLOBAL_HPP