LLVM: include/llvm/Support/Compiler.h File Reference (original) (raw)

#include "llvm/Config/llvm-config.h"
#include <stddef.h>

Go to the source code of this file.

◆ __asan_poison_memory_region

| #define __asan_poison_memory_region | ( | | p, | | ---------------------------------------- | - | | -- | | | size | | | | | ) | | | |

◆ __asan_unpoison_memory_region

| #define __asan_unpoison_memory_region | ( | | p, | | ------------------------------------------ | - | | -- | | | size | | | | | ) | | | |

◆ __has_attribute

| #define __has_attribute | ( | | x | ) | 0 | | -------------------------- | - | | - | - | - |

◆ __has_builtin

| #define __has_builtin | ( | | x | ) | 0 | | ------------------------ | - | | - | - | - |

◆ __has_extension

| #define __has_extension | ( | | x | ) | 0 | | -------------------------- | - | | - | - | - |

◆ __has_feature

| #define __has_feature | ( | | x | ) | 0 | | ------------------------ | - | | - | - | - |

◆ __msan_allocated_memory

| #define __msan_allocated_memory | ( | | p, | | ----------------------------------- | - | | -- | | | size | | | | | ) | | | |

◆ __msan_unpoison

| #define __msan_unpoison | ( | | p, | | -------------------------- | - | | -- | | | size | | | | | ) | | | |

◆ LLVM_ABI_NOT_EXPORTED

#define LLVM_ABI_NOT_EXPORTED

LLVM_ABI is the main export/visibility macro to mark something as explicitly exported when llvm is built as a shared library with everything else that is unannotated will have internal visibility.

LLVM_ABI_EXPORT is for the special case for things like plugin symbol declarations or definitions where we don't want the macro to be switching between dllexport and dllimport on windows based on what codebase is being built, it will only be dllexport. For non windows platforms this macro behaves the same as LLVM_ABI.

LLVM_EXPORT_TEMPLATE is used on explicit template instantiations in source files that were declared extern in a header. This macro is only set as a compiler export attribute on windows, on other platforms it does nothing.

LLVM_TEMPLATE_ABI is for annotating extern template declarations in headers for both functions and classes. On windows its turned in to dllimport for library consumers, for other platforms its a default visibility attribute.

LLVM_C_ABI is used to annotated functions and data that need to be exported for the libllvm-c API. This used both for the llvm-c headers and for the functions declared in the different Target's c++ source files that don't include the header forward declaring them.

Definition at line 177 of file Compiler.h.

◆ LLVM_ADDRESS_SANITIZER_BUILD

#define LLVM_ADDRESS_SANITIZER_BUILD 0

\macro LLVM_ADDRESS_SANITIZER_BUILD Whether LLVM itself is built with AddressSanitizer instrumentation.

Definition at line 551 of file Compiler.h.

◆ LLVM_ALWAYS_EXPORT

◆ LLVM_ASSUME_ALIGNED

| #define LLVM_ASSUME_ALIGNED | ( | | p, | | ----------------------------- | --- | | -- | | | a | | | | | ) | (p) | | |

\macro LLVM_ASSUME_ALIGNED Returns a pointer with an assumed alignment.

Definition at line 488 of file Compiler.h.

◆ LLVM_ATTRIBUTE_ALWAYS_INLINE

#define LLVM_ATTRIBUTE_ALWAYS_INLINE inline

LLVM_ATTRIBUTE_ALWAYS_INLINE - On compilers where we have a directive to do so, mark a method "always inline" because it is performance sensitive.

Definition at line 340 of file Compiler.h.

◆ LLVM_ATTRIBUTE_MINSIZE

#define LLVM_ATTRIBUTE_MINSIZE

◆ LLVM_ATTRIBUTE_NODEBUG

#define LLVM_ATTRIBUTE_NODEBUG

LLVM_ATTRIBUTE_NO_DEBUG - On compilers where we have a directive to do so, mark a method "no debug" because debug info makes the debugger experience worse.

Definition at line 349 of file Compiler.h.

◆ LLVM_ATTRIBUTE_NOINLINE

#define LLVM_ATTRIBUTE_NOINLINE

LLVM_ATTRIBUTE_NOINLINE - On compilers where we have a directive to do so, mark a method "not for inlining".

Definition at line 330 of file Compiler.h.

◆ LLVM_ATTRIBUTE_REINITIALIZES

#define LLVM_ATTRIBUTE_REINITIALIZES

◆ LLVM_ATTRIBUTE_RESTRICT

#define LLVM_ATTRIBUTE_RESTRICT

LLVM_ATTRIBUTE_RESTRICT - Annotates a pointer to tell the compiler that it is not aliased in the current scope.

Definition at line 365 of file Compiler.h.

◆ LLVM_ATTRIBUTE_RETURNS_NOALIAS

#define LLVM_ATTRIBUTE_RETURNS_NOALIAS

\macro LLVM_ATTRIBUTE_RETURNS_NOALIAS Used to mark a function as returning a pointer that does not alias any other valid pointer.

Definition at line 375 of file Compiler.h.

◆ LLVM_ATTRIBUTE_RETURNS_NONNULL

#define LLVM_ATTRIBUTE_RETURNS_NONNULL

◆ LLVM_ATTRIBUTE_UNUSED

#define LLVM_ATTRIBUTE_UNUSED

◆ LLVM_ATTRIBUTE_USED

#define LLVM_ATTRIBUTE_USED

◆ LLVM_ATTRIBUTE_VISIBILITY_DEFAULT

#define LLVM_ATTRIBUTE_VISIBILITY_DEFAULT

◆ LLVM_ATTRIBUTE_VISIBILITY_HIDDEN

#define LLVM_ATTRIBUTE_VISIBILITY_HIDDEN

LLVM_LIBRARY_VISIBILITY - If a class marked with this attribute is linked into a shared library, then the class should be private to the library and not accessible from outside it.

Can also be used to mark variables and functions, making them private to any shared library they are linked into. On PE/COFF targets, library visibility is the default, so this isn't needed.

LLVM_EXTERNAL_VISIBILITY - classes, functions, and variables marked with this attribute will be made public and visible outside of any shared library they are linked in to.

Definition at line 121 of file Compiler.h.

◆ LLVM_ATTRIBUTE_WEAK

#define LLVM_ATTRIBUTE_WEAK

◆ LLVM_BUILTIN_DEBUGTRAP

#define LLVM_BUILTIN_DEBUGTRAP

LLVM_BUILTIN_DEBUGTRAP - On compilers which support it, expands to an expression which causes the program to break while running under a debugger.

Definition at line 477 of file Compiler.h.

◆ LLVM_BUILTIN_TRAP

#define LLVM_BUILTIN_TRAP *(volatile int*)0x11 = 0

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.

'else' is intentionally left out so that other macro logic (e.g., LLVM_ASSUME_ALIGNED and llvm_unreachable()) can detect whether LLVM_BUILTIN_UNREACHABLE has a definition. LLVM_BUILTIN_TRAP - On compilers which support it, expands to an expression which causes the program to exit abnormally.

Definition at line 460 of file Compiler.h.

◆ LLVM_C_ABI

#define LLVM_C_ABI LLVM_ABI

◆ LLVM_CTOR_NODISCARD

#define LLVM_CTOR_NODISCARD

◆ LLVM_DEPRECATED

| #define LLVM_DEPRECATED | ( | | MSG, | | ------------------------ | ----------------------- | | ---- | | | FIX | | | | | ) | [[deprecated(MSG)]] | | |

◆ LLVM_DUMP_METHOD

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.

Definition at line 622 of file Compiler.h.

◆ LLVM_EXTENSION

LLVM_EXTENSION - Support compilers where we have a keyword to suppress pedantic diagnostics.

Definition at line 433 of file Compiler.h.

◆ LLVM_EXTERNAL_VISIBILITY

#define LLVM_EXTERNAL_VISIBILITY

◆ LLVM_FALLTHROUGH

LLVM_FALLTHROUGH - Mark fallthrough cases in switch statements.

Definition at line 388 of file Compiler.h.

◆ LLVM_GNUC_PREREQ

| #define LLVM_GNUC_PREREQ | ( | | maj, | | -------------------------- | - | | ---- | | | min, | | | | | | patch | | | | | ) | 0 | | |

\macro LLVM_GNUC_PREREQ Extend the default __GNUC_PREREQ even if glibc's features.h isn't available.

Definition at line 64 of file Compiler.h.

◆ LLVM_GSL_OWNER

LLVM_GSL_OWNER - Apply this to owning classes like SmallVector to enable lifetime warnings.

Definition at line 405 of file Compiler.h.

◆ LLVM_GSL_POINTER

LLVM_GSL_POINTER - Apply this to non-owning classes like StringRef to enable lifetime warnings.

Definition at line 413 of file Compiler.h.

◆ LLVM_HAS_CPP_ATTRIBUTE

| #define LLVM_HAS_CPP_ATTRIBUTE | ( | | x | ) | 0 | | --------------------------------- | - | | - | - | - |

◆ LLVM_HWADDRESS_SANITIZER_BUILD

#define LLVM_HWADDRESS_SANITIZER_BUILD 0

\macro LLVM_HWADDRESS_SANITIZER_BUILD Whether LLVM itself is built with HWAddressSanitizer instrumentation.

Definition at line 561 of file Compiler.h.

◆ LLVM_LIBRARY_VISIBILITY

◆ LLVM_LIBRARY_VISIBILITY_NAMESPACE

◆ LLVM_LIFETIME_BOUND

#define LLVM_LIFETIME_BOUND

◆ LLVM_LIKELY

| #define LLVM_LIKELY | ( | | EXPR | ) | (EXPR) | | -------------------- | - | | ---- | - | ------ |

◆ LLVM_MEMORY_SANITIZER_BUILD

#define LLVM_MEMORY_SANITIZER_BUILD 0

\macro LLVM_MEMORY_SANITIZER_BUILD Whether LLVM itself is built with MemorySanitizer instrumentation.

Definition at line 526 of file Compiler.h.

◆ LLVM_MSC_PREREQ

| #define LLVM_MSC_PREREQ | ( | | version | ) | 0 | | ------------------------- | - | | ------- | - | - |

\macro LLVM_MSC_PREREQ Is the compiler MSVC of at least the specified version? The common

Parameters

Definition at line 100 of file Compiler.h.

◆ LLVM_NO_PROFILE_INSTRUMENT_FUNCTION

#define LLVM_NO_PROFILE_INSTRUMENT_FUNCTION

\macro LLVM_ENABLE_EXCEPTIONS Whether LLVM is built with exception support.

\macro LLVM_NO_PROFILE_INSTRUMENT_FUNCTION Disable the profile instrument for a function.

Definition at line 681 of file Compiler.h.

◆ LLVM_NO_SANITIZE

| #define LLVM_NO_SANITIZE | ( | | KIND | ) | | -------------------------- | - | | ------------------------------------------------------------- | - |

\macro LLVM_NO_SANITIZE Disable a particular sanitizer for a function.

Definition at line 612 of file Compiler.h.

◆ LLVM_NO_SANITIZE_MEMORY_ATTRIBUTE

#define LLVM_NO_SANITIZE_MEMORY_ATTRIBUTE

◆ LLVM_PACKED

| #define LLVM_PACKED | ( | | d | ) | d __attribute__((packed)) | | -------------------- | - | | - | - | ----------------------------- |

\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

Definition at line 514 of file Compiler.h.

◆ LLVM_PACKED_END

#define LLVM_PACKED_END _Pragma("pack(pop)")

◆ LLVM_PACKED_START

#define LLVM_PACKED_START _Pragma("pack(push, 1)")

◆ LLVM_PREFERRED_TYPE

| #define LLVM_PREFERRED_TYPE | ( | | T | ) | | ----------------------------- | - | | ---------------- | - |

\macro LLVM_PREFERRED_TYPE Adjust type of bit-field in debug info.

Definition at line 689 of file Compiler.h.

◆ LLVM_PREFETCH

| #define LLVM_PREFETCH | ( | | addr, | | ---------------------- | - | | ----- | | | rw, | | | | | | locality | | | | | ) | | | |

◆ LLVM_PRETTY_FUNCTION

#define LLVM_PRETTY_FUNCTION __func__

\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.

Definition at line 637 of file Compiler.h.

◆ LLVM_READNONE

◆ LLVM_READONLY

◆ LLVM_REQUIRE_CONSTANT_INITIALIZATION

#define LLVM_REQUIRE_CONSTANT_INITIALIZATION

LLVM_REQUIRE_CONSTANT_INITIALIZATION - Apply this to globals to ensure that they are constant initialized.

Definition at line 397 of file Compiler.h.

◆ LLVM_SUPPRESS_DEPRECATED_DECLARATIONS_POP

#define LLVM_SUPPRESS_DEPRECATED_DECLARATIONS_POP

◆ LLVM_SUPPRESS_DEPRECATED_DECLARATIONS_PUSH

#define LLVM_SUPPRESS_DEPRECATED_DECLARATIONS_PUSH

◆ LLVM_THREAD_LOCAL

#define LLVM_THREAD_LOCAL

\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. It uses thread_local if available, falling back on gcc __thread if not. __thread doesn'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.

Definition at line 662 of file Compiler.h.

◆ LLVM_THREAD_SANITIZER_BUILD

#define LLVM_THREAD_SANITIZER_BUILD 0

\macro LLVM_THREAD_SANITIZER_BUILD Whether LLVM itself is built with ThreadSanitizer instrumentation.

Definition at line 569 of file Compiler.h.

◆ LLVM_UNLIKELY

| #define LLVM_UNLIKELY | ( | | EXPR | ) | (EXPR) | | ---------------------- | - | | ---- | - | ------ |

◆ TsanHappensAfter

| #define TsanHappensAfter | ( | | cv | ) | | ------------------------ | - | | -- | - |

◆ TsanHappensBefore

| #define TsanHappensBefore | ( | | cv | ) | | ------------------------- | - | | -- | - |

◆ TsanIgnoreWritesBegin

◆ TsanIgnoreWritesEnd