mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-22 01:11:42 +00:00
a2ecb1027a
Also change header guards to WPI header guards. Remove StringRef::c_str() customization, replacing the handful of uses with Twine or SmallString. TCPStream: Include errno.h and make Windows includes lowercase for consistency. Upstream LLVM version: eb4186cca7924fb1706357545311a2fa3de40c59
427 lines
13 KiB
C++
427 lines
13 KiB
C++
//===-- llvm/Support/Compiler.h - Compiler abstraction support --*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file defines several macros, based on the current compiler. This allows
|
|
// use of compiler-specific features in a way that remains portable.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef WPIUTIL_WPI_COMPILER_H
|
|
#define WPIUTIL_WPI_COMPILER_H
|
|
|
|
#if defined(_MSC_VER)
|
|
#include <sal.h>
|
|
#endif
|
|
|
|
#ifndef __has_feature
|
|
# define __has_feature(x) 0
|
|
#endif
|
|
|
|
#ifndef __has_extension
|
|
# define __has_extension(x) 0
|
|
#endif
|
|
|
|
#ifndef __has_attribute
|
|
# define __has_attribute(x) 0
|
|
#endif
|
|
|
|
#ifndef __has_cpp_attribute
|
|
# define __has_cpp_attribute(x) 0
|
|
#endif
|
|
|
|
#ifndef __has_builtin
|
|
# define __has_builtin(x) 0
|
|
#endif
|
|
|
|
/// \macro LLVM_GNUC_PREREQ
|
|
/// Extend the default __GNUC_PREREQ even if glibc's features.h isn't
|
|
/// available.
|
|
#ifndef LLVM_GNUC_PREREQ
|
|
# if defined(__GNUC__) && defined(__GNUC_MINOR__) && defined(__GNUC_PATCHLEVEL__)
|
|
# define LLVM_GNUC_PREREQ(maj, min, patch) \
|
|
((__GNUC__ << 20) + (__GNUC_MINOR__ << 10) + __GNUC_PATCHLEVEL__ >= \
|
|
((maj) << 20) + ((min) << 10) + (patch))
|
|
# elif defined(__GNUC__) && defined(__GNUC_MINOR__)
|
|
# define LLVM_GNUC_PREREQ(maj, min, patch) \
|
|
((__GNUC__ << 20) + (__GNUC_MINOR__ << 10) >= ((maj) << 20) + ((min) << 10))
|
|
# else
|
|
# define LLVM_GNUC_PREREQ(maj, min, patch) 0
|
|
# endif
|
|
#endif
|
|
|
|
/// \macro LLVM_MSC_PREREQ
|
|
/// Is the compiler MSVC of at least the specified version?
|
|
/// The common \param version values to check for are:
|
|
/// * 1900: Microsoft Visual Studio 2015 / 14.0
|
|
#ifndef LLVM_MSC_PREREQ
|
|
#ifdef _MSC_VER
|
|
#define LLVM_MSC_PREREQ(version) (_MSC_VER >= (version))
|
|
|
|
// We require at least MSVC 2015.
|
|
#if !LLVM_MSC_PREREQ(1900)
|
|
#error wpiutil requires at least MSVC 2015.
|
|
#endif
|
|
|
|
#else
|
|
#define LLVM_MSC_PREREQ(version) 0
|
|
#endif
|
|
#endif
|
|
|
|
/// Does the compiler support ref-qualifiers for *this?
|
|
///
|
|
/// Sadly, this is separate from just rvalue reference support because GCC
|
|
/// and MSVC implemented this later than everything else.
|
|
#ifndef LLVM_HAS_RVALUE_REFERENCE_THIS
|
|
#if __has_feature(cxx_rvalue_references) || LLVM_GNUC_PREREQ(4, 8, 1)
|
|
#define LLVM_HAS_RVALUE_REFERENCE_THIS 1
|
|
#else
|
|
#define LLVM_HAS_RVALUE_REFERENCE_THIS 0
|
|
#endif
|
|
#endif
|
|
|
|
/// Expands to '&' if ref-qualifiers for *this are supported.
|
|
///
|
|
/// This can be used to provide lvalue/rvalue overrides of member functions.
|
|
/// The rvalue override should be guarded by LLVM_HAS_RVALUE_REFERENCE_THIS
|
|
#ifndef LLVM_LVALUE_FUNCTION
|
|
#if LLVM_HAS_RVALUE_REFERENCE_THIS
|
|
#define LLVM_LVALUE_FUNCTION &
|
|
#else
|
|
#define LLVM_LVALUE_FUNCTION
|
|
#endif
|
|
#endif
|
|
|
|
#ifndef LLVM_PREFETCH
|
|
#if defined(__GNUC__)
|
|
#define LLVM_PREFETCH(addr, rw, locality) __builtin_prefetch(addr, rw, locality)
|
|
#else
|
|
#define LLVM_PREFETCH(addr, rw, locality)
|
|
#endif
|
|
#endif
|
|
|
|
#ifndef LLVM_ATTRIBUTE_USED
|
|
#if __has_attribute(used) || LLVM_GNUC_PREREQ(3, 1, 0)
|
|
#define LLVM_ATTRIBUTE_USED __attribute__((__used__))
|
|
#else
|
|
#define LLVM_ATTRIBUTE_USED
|
|
#endif
|
|
#endif
|
|
|
|
/// LLVM_NODISCARD - Warn if a type or return value is discarded.
|
|
#ifndef LLVM_NODISCARD
|
|
#if __cplusplus > 201402L && __has_cpp_attribute(nodiscard)
|
|
#define LLVM_NODISCARD [[nodiscard]]
|
|
#elif !__cplusplus
|
|
// Workaround for llvm.org/PR23435, since clang 3.6 and below emit a spurious
|
|
// error when __has_cpp_attribute is given a scoped attribute in C mode.
|
|
#define LLVM_NODISCARD
|
|
#elif __has_cpp_attribute(clang::warn_unused_result)
|
|
#define LLVM_NODISCARD [[clang::warn_unused_result]]
|
|
#else
|
|
#define LLVM_NODISCARD
|
|
#endif
|
|
#endif
|
|
|
|
// Some compilers warn about unused functions. When a function is sometimes
|
|
// used or not depending on build settings (e.g. a function only called from
|
|
// within "assert"), this attribute can be used to suppress such warnings.
|
|
//
|
|
// However, it shouldn't be used for unused *variables*, as those have a much
|
|
// more portable solution:
|
|
// (void)unused_var_name;
|
|
// Prefer cast-to-void wherever it is sufficient.
|
|
#ifndef LLVM_ATTRIBUTE_UNUSED
|
|
#if __has_attribute(unused) || LLVM_GNUC_PREREQ(3, 1, 0)
|
|
#define LLVM_ATTRIBUTE_UNUSED __attribute__((__unused__))
|
|
#else
|
|
#define LLVM_ATTRIBUTE_UNUSED
|
|
#endif
|
|
#endif
|
|
|
|
#ifndef LLVM_READNONE
|
|
// Prior to clang 3.2, clang did not accept any spelling of
|
|
// __has_attribute(const), so assume it is supported.
|
|
#if defined(__clang__) || defined(__GNUC__)
|
|
// aka 'CONST' but following LLVM Conventions.
|
|
#define LLVM_READNONE __attribute__((__const__))
|
|
#else
|
|
#define LLVM_READNONE
|
|
#endif
|
|
#endif
|
|
|
|
#ifndef LLVM_READONLY
|
|
#if __has_attribute(pure) || defined(__GNUC__)
|
|
// aka 'PURE' but following LLVM Conventions.
|
|
#define LLVM_READONLY __attribute__((__pure__))
|
|
#else
|
|
#define LLVM_READONLY
|
|
#endif
|
|
#endif
|
|
|
|
#ifndef LLVM_LIKELY
|
|
#if __has_builtin(__builtin_expect) || LLVM_GNUC_PREREQ(4, 0, 0)
|
|
#define LLVM_LIKELY(EXPR) __builtin_expect((bool)(EXPR), true)
|
|
#define LLVM_UNLIKELY(EXPR) __builtin_expect((bool)(EXPR), false)
|
|
#else
|
|
#define LLVM_LIKELY(EXPR) (EXPR)
|
|
#define LLVM_UNLIKELY(EXPR) (EXPR)
|
|
#endif
|
|
#endif
|
|
|
|
/// LLVM_ATTRIBUTE_NOINLINE - On compilers where we have a directive to do so,
|
|
/// mark a method "not for inlining".
|
|
#ifndef LLVM_ATTRIBUTE_NOINLINE
|
|
#if __has_attribute(noinline) || LLVM_GNUC_PREREQ(3, 4, 0)
|
|
#define LLVM_ATTRIBUTE_NOINLINE __attribute__((noinline))
|
|
#elif defined(_MSC_VER)
|
|
#define LLVM_ATTRIBUTE_NOINLINE __declspec(noinline)
|
|
#else
|
|
#define LLVM_ATTRIBUTE_NOINLINE
|
|
#endif
|
|
#endif
|
|
|
|
/// LLVM_ATTRIBUTE_ALWAYS_INLINE - On compilers where we have a directive to do
|
|
/// so, mark a method "always inline" because it is performance sensitive. GCC
|
|
/// 3.4 supported this but is buggy in various cases and produces unimplemented
|
|
/// errors, just use it in GCC 4.0 and later.
|
|
#ifndef LLVM_ATTRIBUTE_ALWAYS_INLINE
|
|
#if __has_attribute(always_inline) || LLVM_GNUC_PREREQ(4, 0, 0)
|
|
#define LLVM_ATTRIBUTE_ALWAYS_INLINE __attribute__((always_inline)) inline
|
|
#elif defined(_MSC_VER)
|
|
#define LLVM_ATTRIBUTE_ALWAYS_INLINE __forceinline
|
|
#else
|
|
#define LLVM_ATTRIBUTE_ALWAYS_INLINE inline
|
|
#endif
|
|
#endif
|
|
|
|
#ifndef LLVM_ATTRIBUTE_NORETURN
|
|
#ifdef __GNUC__
|
|
#define LLVM_ATTRIBUTE_NORETURN __attribute__((noreturn))
|
|
#elif defined(_MSC_VER)
|
|
#define LLVM_ATTRIBUTE_NORETURN __declspec(noreturn)
|
|
#else
|
|
#define LLVM_ATTRIBUTE_NORETURN
|
|
#endif
|
|
#endif
|
|
|
|
#ifndef LLVM_ATTRIBUTE_RETURNS_NONNULL
|
|
#if __has_attribute(returns_nonnull) || LLVM_GNUC_PREREQ(4, 9, 0)
|
|
#define LLVM_ATTRIBUTE_RETURNS_NONNULL __attribute__((returns_nonnull))
|
|
#elif defined(_MSC_VER)
|
|
#define LLVM_ATTRIBUTE_RETURNS_NONNULL _Ret_notnull_
|
|
#else
|
|
#define LLVM_ATTRIBUTE_RETURNS_NONNULL
|
|
#endif
|
|
#endif
|
|
|
|
/// \macro LLVM_ATTRIBUTE_RETURNS_NOALIAS Used to mark a function as returning a
|
|
/// pointer that does not alias any other valid pointer.
|
|
#ifndef LLVM_ATTRIBUTE_RETURNS_NOALIAS
|
|
#ifdef __GNUC__
|
|
#define LLVM_ATTRIBUTE_RETURNS_NOALIAS __attribute__((__malloc__))
|
|
#elif defined(_MSC_VER)
|
|
#define LLVM_ATTRIBUTE_RETURNS_NOALIAS __declspec(restrict)
|
|
#else
|
|
#define LLVM_ATTRIBUTE_RETURNS_NOALIAS
|
|
#endif
|
|
#endif
|
|
|
|
/// LLVM_FALLTHROUGH - Mark fallthrough cases in switch statements.
|
|
#ifndef LLVM_FALLTHROUGH
|
|
#if __cplusplus > 201402L && __has_cpp_attribute(fallthrough)
|
|
#define LLVM_FALLTHROUGH [[fallthrough]]
|
|
#elif __has_cpp_attribute(gnu::fallthrough)
|
|
#define LLVM_FALLTHROUGH [[gnu::fallthrough]]
|
|
#elif !__cplusplus
|
|
// Workaround for llvm.org/PR23435, since clang 3.6 and below emit a spurious
|
|
// error when __has_cpp_attribute is given a scoped attribute in C mode.
|
|
#define LLVM_FALLTHROUGH
|
|
#elif __has_cpp_attribute(clang::fallthrough)
|
|
#define LLVM_FALLTHROUGH [[clang::fallthrough]]
|
|
#else
|
|
#define LLVM_FALLTHROUGH
|
|
#endif
|
|
#endif
|
|
|
|
/// LLVM_EXTENSION - Support compilers where we have a keyword to suppress
|
|
/// pedantic diagnostics.
|
|
#ifndef LLVM_EXTENSION
|
|
#ifdef __GNUC__
|
|
#define LLVM_EXTENSION __extension__
|
|
#else
|
|
#define LLVM_EXTENSION
|
|
#endif
|
|
#endif
|
|
|
|
// LLVM_ATTRIBUTE_DEPRECATED(decl, "message")
|
|
#ifndef LLVM_ATTRIBUTE_DEPRECATED
|
|
#if __has_feature(attribute_deprecated_with_message)
|
|
# define LLVM_ATTRIBUTE_DEPRECATED(decl, message) \
|
|
decl __attribute__((deprecated(message)))
|
|
#elif defined(__GNUC__)
|
|
# define LLVM_ATTRIBUTE_DEPRECATED(decl, message) \
|
|
decl __attribute__((deprecated))
|
|
#elif defined(_MSC_VER)
|
|
# define LLVM_ATTRIBUTE_DEPRECATED(decl, message) \
|
|
__declspec(deprecated(message)) decl
|
|
#else
|
|
# define LLVM_ATTRIBUTE_DEPRECATED(decl, message) \
|
|
decl
|
|
#endif
|
|
#endif
|
|
|
|
/// LLVM_BUILTIN_UNREACHABLE - On compilers which support it, expands
|
|
/// to an expression which states that it is undefined behavior for the
|
|
/// compiler to reach this point. Otherwise is not defined.
|
|
#ifndef LLVM_BUILTIN_UNREACHABLE
|
|
#if __has_builtin(__builtin_unreachable) || LLVM_GNUC_PREREQ(4, 5, 0)
|
|
# define LLVM_BUILTIN_UNREACHABLE __builtin_unreachable()
|
|
#elif defined(_MSC_VER)
|
|
# define LLVM_BUILTIN_UNREACHABLE __assume(false)
|
|
#endif
|
|
#endif
|
|
|
|
/// \macro LLVM_ASSUME_ALIGNED
|
|
/// Returns a pointer with an assumed alignment.
|
|
#ifndef LLVM_ASSUME_ALIGNED
|
|
#if __has_builtin(__builtin_assume_aligned) || LLVM_GNUC_PREREQ(4, 7, 0)
|
|
# define LLVM_ASSUME_ALIGNED(p, a) __builtin_assume_aligned(p, a)
|
|
#elif defined(LLVM_BUILTIN_UNREACHABLE)
|
|
// As of today, clang does not support __builtin_assume_aligned.
|
|
# define LLVM_ASSUME_ALIGNED(p, a) \
|
|
(((uintptr_t(p) % (a)) == 0) ? (p) : (LLVM_BUILTIN_UNREACHABLE, (p)))
|
|
#else
|
|
# define LLVM_ASSUME_ALIGNED(p, a) (p)
|
|
#endif
|
|
#endif
|
|
|
|
/// \macro LLVM_ALIGNAS
|
|
/// Used to specify a minimum alignment for a structure or variable.
|
|
#ifndef LLVM_ALIGNAS
|
|
#if __GNUC__ && !__has_feature(cxx_alignas) && !LLVM_GNUC_PREREQ(4, 8, 1)
|
|
# define LLVM_ALIGNAS(x) __attribute__((aligned(x)))
|
|
#else
|
|
# define LLVM_ALIGNAS(x) alignas(x)
|
|
#endif
|
|
#endif
|
|
|
|
/// \macro LLVM_PACKED
|
|
/// Used to specify a packed structure.
|
|
/// LLVM_PACKED(
|
|
/// struct A {
|
|
/// int i;
|
|
/// int j;
|
|
/// int k;
|
|
/// long long l;
|
|
/// });
|
|
///
|
|
/// LLVM_PACKED_START
|
|
/// struct B {
|
|
/// int i;
|
|
/// int j;
|
|
/// int k;
|
|
/// long long l;
|
|
/// };
|
|
/// LLVM_PACKED_END
|
|
#ifndef LLVM_PACKED
|
|
#ifdef _MSC_VER
|
|
# define LLVM_PACKED(d) __pragma(pack(push, 1)) d __pragma(pack(pop))
|
|
# define LLVM_PACKED_START __pragma(pack(push, 1))
|
|
# define LLVM_PACKED_END __pragma(pack(pop))
|
|
#else
|
|
# define LLVM_PACKED(d) d __attribute__((packed))
|
|
# define LLVM_PACKED_START _Pragma("pack(push, 1)")
|
|
# define LLVM_PACKED_END _Pragma("pack(pop)")
|
|
#endif
|
|
#endif
|
|
|
|
/// \macro LLVM_PTR_SIZE
|
|
/// A constant integer equivalent to the value of sizeof(void*).
|
|
/// Generally used in combination with LLVM_ALIGNAS or when doing computation in
|
|
/// the preprocessor.
|
|
#ifndef LLVM_PTR_SIZE
|
|
#ifdef __SIZEOF_POINTER__
|
|
# define LLVM_PTR_SIZE __SIZEOF_POINTER__
|
|
#elif defined(_WIN64)
|
|
# define LLVM_PTR_SIZE 8
|
|
#elif defined(_WIN32)
|
|
# define LLVM_PTR_SIZE 4
|
|
#elif defined(_MSC_VER)
|
|
# error "could not determine LLVM_PTR_SIZE as a constant int for MSVC"
|
|
#else
|
|
# define LLVM_PTR_SIZE sizeof(void *)
|
|
#endif
|
|
#endif
|
|
|
|
/// \macro LLVM_NO_SANITIZE
|
|
/// Disable a particular sanitizer for a function.
|
|
#ifndef LLVM_NO_SANITIZE
|
|
#if __has_attribute(no_sanitize)
|
|
#define LLVM_NO_SANITIZE(KIND) __attribute__((no_sanitize(KIND)))
|
|
#else
|
|
#define LLVM_NO_SANITIZE(KIND)
|
|
#endif
|
|
#endif
|
|
|
|
/// Mark debug helper function definitions like dump() that should not be
|
|
/// stripped from debug builds.
|
|
/// Note that you should also surround dump() functions with
|
|
/// `#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)` so they do always
|
|
/// get stripped in release builds.
|
|
// FIXME: Move this to a private config.h as it's not usable in public headers.
|
|
#ifndef LLVM_DUMP_METHOD
|
|
#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
|
|
#define LLVM_DUMP_METHOD LLVM_ATTRIBUTE_NOINLINE LLVM_ATTRIBUTE_USED
|
|
#else
|
|
#define LLVM_DUMP_METHOD LLVM_ATTRIBUTE_NOINLINE
|
|
#endif
|
|
#endif
|
|
|
|
/// \macro LLVM_PRETTY_FUNCTION
|
|
/// Gets a user-friendly looking function signature for the current scope
|
|
/// using the best available method on each platform. The exact format of the
|
|
/// resulting string is implementation specific and non-portable, so this should
|
|
/// only be used, for example, for logging or diagnostics.
|
|
#ifndef LLVM_PRETTY_FUNCTION
|
|
#if defined(_MSC_VER)
|
|
#define LLVM_PRETTY_FUNCTION __FUNCSIG__
|
|
#elif defined(__GNUC__) || defined(__clang__)
|
|
#define LLVM_PRETTY_FUNCTION __PRETTY_FUNCTION__
|
|
#else
|
|
#define LLVM_PRETTY_FUNCTION __func__
|
|
#endif
|
|
#endif
|
|
|
|
/// \macro LLVM_THREAD_LOCAL
|
|
/// A thread-local storage specifier which can be used with globals,
|
|
/// extern globals, and static globals.
|
|
///
|
|
/// This is essentially an extremely restricted analog to C++11's thread_local
|
|
/// support, and uses that when available. However, it falls back on
|
|
/// platform-specific or vendor-provided extensions when necessary. These
|
|
/// extensions don't support many of the C++11 thread_local's features. You
|
|
/// should only use this for PODs that you can statically initialize to
|
|
/// some constant value. In almost all circumstances this is most appropriate
|
|
/// for use with a pointer, integer, or small aggregation of pointers and
|
|
/// integers.
|
|
#ifndef LLVM_THREAD_LOCAL
|
|
#if __has_feature(cxx_thread_local)
|
|
#define LLVM_THREAD_LOCAL thread_local
|
|
#elif defined(_MSC_VER)
|
|
// MSVC supports this with a __declspec.
|
|
#define LLVM_THREAD_LOCAL __declspec(thread)
|
|
#else
|
|
// Clang, GCC, and other compatible compilers used __thread prior to C++11 and
|
|
// we only need the restricted functionality that provides.
|
|
#define LLVM_THREAD_LOCAL __thread
|
|
#endif
|
|
#endif
|
|
|
|
#endif
|