has_builtin_atomic.hpp

Go to the documentation of this file.

// Copyright 2024, Toyota Motor Corporation
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
#ifndef INCLUDE_GUARD_ARENE_BASE_ARENE_BASE_COMPILER_SUPPORT_PLATFORM_QUERIES_HAS_BUILTIN_ATOMIC_HPP_
#define INCLUDE_GUARD_ARENE_BASE_ARENE_BASE_COMPILER_SUPPORT_PLATFORM_QUERIES_HAS_BUILTIN_ATOMIC_HPP_
 
// IWYU pragma: private, include "arene/base/compiler_support/platform_queries.hpp"
// IWYU pragma: friend "arene/base/compiler_support/platform_queries/.*"
 
// parasoft-begin-suppress AUTOSAR-A16_2_2-a-2 "Arene Base aggregate headers permitted by A16-2-2 Permit #1"
#include "arene/base/compiler_support/platform_queries/compiler_info.hpp"  // IWYU pragma: keep
#include "arene/base/compiler_support/platform_queries/has_builtin.hpp"
#include "arene/base/compiler_support/preprocessor.hpp"
// parasoft-end-suppress AUTOSAR-A16_2_2-a-2
 
// NOLINTBEGIN(cppcoreguidelines-macro-usage)
// parasoft-begin-suppress AUTOSAR-A16_0_1-d-2 "Conditional defines permitted by A16-0-1 Permit #2"
// parasoft-begin-suppress AUTOSAR-A16_0_1-a-2 "Conditional defines permitted by A16-0-1 Permit #2"
 
/// @def ARENE_HAS_BUILTIN_ATOMIC
/// @brief A platform support query for testing if compiler atomic intrinsics are defined.
///
/// Usage:
/// @code{c++}
/// #if ARENE_IS_ON(ARENE_HAS_BUILTIN_ATOMIC)
/// @endcode
///
/// The value of this query is determined as follows, in order of precedence:
/// 1. If __atomic_add_fetch, __atomic_fetch_add, etc. intrinsics are available, it is @c ARENE_ON_BY_DEFAULT
/// 2. Otherwise, it is @c ARENE_OFF_BY_DEFAULT
 
#ifndef ARENE_HAS_BUILTIN_ATOMIC_I_
// Check for atomic intrinsics availability
// parasoft-begin-suppress AUTOSAR-M16_0_7-a-2 "False positive: not used as a macro"
#if ARENE_HAS_BUILTIN(__atomic_add_fetch) && ARENE_HAS_BUILTIN(__atomic_fetch_add) &&
    ARENE_HAS_BUILTIN(__atomic_sub_fetch) && ARENE_HAS_BUILTIN(__atomic_fetch_sub) &&
    ARENE_HAS_BUILTIN(__atomic_load_n)
// parasoft-end-suppress AUTOSAR-M16_0_7-a-2
#define ARENE_HAS_BUILTIN_ATOMIC_I_ ARENE_ON_BY_DEFAULT
#elif ARENE_IS_ON(ARENE_COMPILER_GCC) && __GNUC__ >= 8
// The __atomic() intrinsics exist in GCC (at least) 8 and later,
// but the __has_builtin query was not added until GCC 10 and so we
// may have returned a false negative when probing for the builtin above.
#define ARENE_HAS_BUILTIN_ATOMIC_I_ ARENE_ON_BY_DEFAULT
#else
#define ARENE_HAS_BUILTIN_ATOMIC_I_ ARENE_OFF_BY_DEFAULT
#endif
#endif
 
#ifdef ARENE_DOC_GENERATION_RUNNING  // make this appear when running doxygen, as it won't otherwise.
#ifndef ARENE_HAS_BUILTIN_ATOMIC
#define ARENE_HAS_BUILTIN_ATOMIC
#endif
#endif
 
// NOLINTEND(cppcoreguidelines-macro-usage)
// parasoft-end-suppress AUTOSAR-A16_0_1-d-2
// parasoft-end-suppress AUTOSAR-A16_0_1-a-2
 
#endif  // INCLUDE_GUARD_ARENE_BASE_ARENE_BASE_COMPILER_SUPPORT_PLATFORM_QUERIES_HAS_BUILTIN_ATOMIC_HPP_