[#index]
= Global namespace
:mrdocs:

== Namespaces

[cols="1,4"]
|===
| Name| Description
| xref:llvm.adoc[`llvm`] 
| Top‐level LLVM library namespace.
|===


== Macros

[cols="1,4"]
|===
| Name| Description
| xref:BEGIN_REGISTER_VP_SDNODE.adoc[`BEGIN_REGISTER_VP_SDNODE`] 
| Emit a Vector Predication SDNode enumerator from `VPSDID.`
| xref:CTXPROF_FUNCTION_DATA.adoc[`CTXPROF_FUNCTION_DATA`] 
| Declares the fields of FunctionData shared with LLVM.
| xref:DEBUG_WITH_TYPE.adoc[`DEBUG_WITH_TYPE`] 
| Execute `*VA_ARGS*` when ‐debug is enabled for `TYPE.`
| xref:DECLARE_TRANSPARENT_OPERAND_ACCESSORS.adoc[`DECLARE_TRANSPARENT_OPERAND_ACCESSORS`] 
| Macro for generating in‐class operand accessor declarations. It should only be called in the public section of the interface.
| xref:DEFINE_TRANSPARENT_OPERAND_ACCESSORS.adoc[`DEFINE_TRANSPARENT_OPERAND_ACCESSORS`] 
| Macro for generating out‐of‐class operand accessor definitions.
| xref:DEF_CONST.adoc[`DEF_CONST`] 
| Expand to a ClassID enumerator for a Constant subclass.
| xref:DEF_INSTR.adoc[`DEF_INSTR`] 
| Expand to a ClassID enumerator for an Instruction subclass.
| xref:DEF_USER.adoc[`DEF_USER`] 
| Expand to a ClassID enumerator for a User subclass.
| xref:DEF_VALUE.adoc[`DEF_VALUE`] 
| Expand to a ClassID enumerator for a Value subclass.
| xref:GET_R600_GPU_ENUM.adoc[`GET_R600_GPU_ENUM`] 
| Not specified processor.
| xref:GET_RUNTIME_LIBCALL_ENUM.adoc[`GET_RUNTIME_LIBCALL_ENUM`] 
| Include RuntimeLibcalls.inc to define RTLIB::Libcall and LibcallImpl enums.
| xref:GET_RUNTIME_LIBCALL_FP_SELECTOR_DECLS.adoc[`GET_RUNTIME_LIBCALL_FP_SELECTOR_DECLS`] 
| Declare floating‐point libcall selector overloads for each family.
| xref:HANDLE_BB_ADDR_MAP_FEATURE.adoc[`HANDLE_BB_ADDR_MAP_FEATURE`] 
| Expand a feature name into a bit‐index enumerator.
| xref:HANDLE_BINARY_INST-08.adoc[`HANDLE_BINARY_INST`] 
| Declare a Create helper that forwards to Create for one binary opcode.
| xref:HANDLE_BINARY_INST-04.adoc[`HANDLE_BINARY_INST`] 
| Declare a Create helper with an explicit insertion point for one binary opcode.
| xref:HANDLE_DIEVALUE.adoc[`HANDLE_DIEVALUE`] 
| Expand to the DIEValue::Type enumerator for payload type `T.`
| xref:HANDLE_DIEVALUE_SMALL.adoc[`HANDLE_DIEVALUE_SMALL`] 
| Return the stored small DIE value of type `DIE##T.`
| xref:HANDLE_DW_LANG.adoc[`HANDLE_DW_LANG`] 
| Expand one DWARF source‐language enumerator from Dwarf.def.
| xref:HANDLE_DW_SECT.adoc[`HANDLE_DW_SECT`] 
| Expand one DWARF package‐file section kind enumerator from Dwarf.def.
| xref:HANDLE_OUTPUT_CONFIG_FLAG.adoc[`HANDLE_OUTPUT_CONFIG_FLAG`] 
| Expand to a member initializer for one OutputConfig flag.
| xref:HANDLE_UNARY_INST-05.adoc[`HANDLE_UNARY_INST`] 
| Declare a Create helper that forwards to Create for one unary opcode.
| xref:HANDLE_UNARY_INST-00.adoc[`HANDLE_UNARY_INST`] 
| Declare a Create helper with an explicit insertion point for one unary opcode.
| xref:LAST_OTHER_INST.adoc[`LAST_OTHER_INST`] 
| Capture the maximum opcode number from Instruction.def as MaxOpcodes.
| xref:LDBG.adoc[`LDBG`] 
| output. The default level is 1, and is in increasing level of verbosity.
| xref:LDBG_GET_DEBUG_TYPE_STR__.adoc[`LDBG_GET_DEBUG_TYPE_STR__`] 
| Helpers to get DEBUG_TYPE as a StringRef, even when DEBUG_TYPE is not defined (in which case it expands to "DEBUG_TYPE")
| xref:LDBG_GET_DEFAULT_TYPE_OR_LEVEL.adoc[`LDBG_GET_DEFAULT_TYPE_OR_LEVEL`] 
| Provide the default level (=1) or type (=DEBUG_TYPE) for a single argument.
| xref:LDBG_LEVEL_OR_TYPE.adoc[`LDBG_LEVEL_OR_TYPE`] 
| Expand LDBG() when a single level‐or‐type argument is provided.
| xref:LDBG_OS.adoc[`LDBG_OS`] 
| Invoke a callback with a prefixed debug `raw_ostream`, like LDBG().
| xref:LDBG_OS_IMPL.adoc[`LDBG_OS_IMPL`] 
| This macro is the core of the LDBG_OS() macros. It is used to print the debug output with the given stream, level, type, file, and line number.
| xref:LDBG_STREAM.adoc[`LDBG_STREAM`] 
| This macro expands to the stream to use for output, we use a macro to allow unit‐testing to override.
| xref:LDBG_STREAM_LEVEL_TYPE_AND_FILE.adoc[`LDBG_STREAM_LEVEL_TYPE_AND_FILE`] 
| These macros are helpers to implement LDBG() with an increasing amount of optional arguments made explicit.
| xref:LDBG_STREAM_LEVEL_TYPE_FILE_AND_LINE.adoc[`LDBG_STREAM_LEVEL_TYPE_FILE_AND_LINE`] 
| This macro is the core of the LDBG() implementation. It is used to print the debug output with the given stream, level, type, file, and line number.
| xref:LDBG_TYPE_AND_LEVEL.adoc[`LDBG_TYPE_AND_LEVEL`] 
| Expand LDBG() when both a debug type and a level are provided.
| xref:LLVM_DECLARE_ENUM_AS_BITMASK.adoc[`LLVM_DECLARE_ENUM_AS_BITMASK`] 
| LLVM_DECLARE_ENUM_AS_BITMASK can be used to declare an enum type as a bit set, so that bitwise operation on such enum does not require static_cast.
| xref:LLVM_DECLARE_REGISTRY.adoc[`LLVM_DECLARE_REGISTRY`] 
| Helper macro to declare registry class.
| xref:LLVM_DECLARE_REGISTRY_EX.adoc[`LLVM_DECLARE_REGISTRY_EX`] 
| Helper macro to declare a registry class with an explicit export annotation.
| xref:LLVM_DEFINE_REGISTRY.adoc[`LLVM_DEFINE_REGISTRY`] 
| Helper macro to define registry class.
| xref:LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE.adoc[`LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE`] 
| LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE() pulls the operator overloads used by LLVM_MARK_AS_BITMASK_ENUM into the current namespace.
| xref:LLVM_MARK_AS_BITMASK_ENUM.adoc[`LLVM_MARK_AS_BITMASK_ENUM`] 
| LLVM_MARK_AS_BITMASK_ENUM lets you opt in an individual enum type so you can perform bitwise operations on it without putting static_cast everywhere.
| xref:LLVM_PLUGIN_API_VERSION.adoc[`LLVM_PLUGIN_API_VERSION`] 
| macro LLVM_PLUGIN_API_VERSION Identifies the API version understood by this plugin.
| xref:LLVM_YAML_IS_DOCUMENT_LIST_VECTOR.adoc[`LLVM_YAML_IS_DOCUMENT_LIST_VECTOR`] 
| Utility for declaring that a std::vector of a particular type should be considered a YAML document list.
| xref:LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR.adoc[`LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR`] 
| Utility for declaring that a std::vector of a particular type should be considered a YAML flow sequence.
| xref:LLVM_YAML_IS_SEQUENCE_VECTOR.adoc[`LLVM_YAML_IS_SEQUENCE_VECTOR`] 
| Utility for declaring that a std::vector of a particular type should be considered a YAML sequence.
| xref:LLVM_YAML_IS_STRING_MAP.adoc[`LLVM_YAML_IS_STRING_MAP`] 
| Utility for declaring that std::map<std::string, _type> should be considered a YAML map.
| xref:LLVM_YAML_STRONG_TYPEDEF.adoc[`LLVM_YAML_STRONG_TYPEDEF`] 
| Define a distinct strong typedef `_type` over integral base `_base.`
| xref:MAKE_CAS_HANDLE_CONSTRUCTOR.adoc[`MAKE_CAS_HANDLE_CONSTRUCTOR`] 
| Allow ObjectStore implementations to create internal handles.
| xref:MIBEntryDef.adoc[`MIBEntryDef`] 
| Declare one MemInfoBlock schema field as a Meta enumerator.
| xref:NVPTX_GPU.adoc[`NVPTX_GPU`] 
| Expand one NVPTX GPU enumerator from NVPTXTargetParser.def.
| xref:OMP_TYPE.adoc[`OMP_TYPE`] 
| Declarations for OpenMP LLVM‐IR types from OpenMPKinds.def.
| xref:R_TYPE_SHIFT.adoc[`R_TYPE_SHIFT`] 
| Bit shift for the primary N64 relocation type field.
| xref:SUPPORTED_TENSOR_TYPES.adoc[`SUPPORTED_TENSOR_TYPES`] 
| X‐macro listing C element types paired with TensorType enumerator names.
|===


== Using Namespace Directives

[cols="1,4"]
|===
| Name| Description
| xref:llvm/support/endian.adoc[`endian`] 
| Helpers to read and write values with an explicit byte order.
| xref:llvm.adoc[`llvm`] 
| Top‐level LLVM library namespace.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#