LLVM 24.0.0git
Topics | Functions
Global Values
LLVM-C: C interface to LLVM » Core » Values » Constants

This group contains functions that operate on global values. More...

Collaboration diagram for Global Values:

Topics

 Values with alignment
 Functions in this group only apply to values with alignment, i.e.

Functions

LLVM_C_ABI LLVMModuleRef LLVMGetGlobalParent (LLVMValueRef Global)
LLVM_C_ABI LLVMBool LLVMIsDeclaration (LLVMValueRef Global)
LLVM_C_ABI LLVMLinkage LLVMGetLinkage (LLVMValueRef Global)
LLVM_C_ABI void LLVMSetLinkage (LLVMValueRef Global, LLVMLinkage Linkage)
LLVM_C_ABI const char * LLVMGetSection (LLVMValueRef Global)
LLVM_C_ABI void LLVMSetSection (LLVMValueRef Global, const char *Section)
LLVM_C_ABI LLVMVisibility LLVMGetVisibility (LLVMValueRef Global)
LLVM_C_ABI void LLVMSetVisibility (LLVMValueRef Global, LLVMVisibility Viz)
LLVM_C_ABI LLVMDLLStorageClass LLVMGetDLLStorageClass (LLVMValueRef Global)
LLVM_C_ABI void LLVMSetDLLStorageClass (LLVMValueRef Global, LLVMDLLStorageClass Class)
LLVM_C_ABI LLVMUnnamedAddr LLVMGetUnnamedAddress (LLVMValueRef Global)
LLVM_C_ABI void LLVMSetUnnamedAddress (LLVMValueRef Global, LLVMUnnamedAddr UnnamedAddr)
LLVM_C_ABI LLVMBool LLVMIsDSOLocal (LLVMValueRef Global)
 Returns whether the global value is marked as dso_local, i.e.
LLVM_C_ABI void LLVMSetDSOLocal (LLVMValueRef Global, LLVMBool IsDSOLocal)
 Sets whether the global value is marked as dso_local.
LLVM_C_ABI LLVMTypeRef LLVMGlobalGetValueType (LLVMValueRef Global)
 Returns the "value type" of a global value.
LLVM_C_ABI LLVMBool LLVMHasUnnamedAddr (LLVMValueRef Global)
 Deprecated: Use LLVMGetUnnamedAddress instead.
LLVM_C_ABI void LLVMSetUnnamedAddr (LLVMValueRef Global, LLVMBool HasUnnamedAddr)
 Deprecated: Use LLVMSetUnnamedAddress instead.
LLVM_C_ABI unsigned LLVMGetAlignment (LLVMValueRef V)
 Obtain the preferred alignment of the value.
LLVM_C_ABI void LLVMSetAlignment (LLVMValueRef V, unsigned Bytes)
 Set the preferred alignment of the value.
LLVM_C_ABI void LLVMGlobalSetMetadata (LLVMValueRef Global, unsigned Kind, LLVMMetadataRef MD)
 Sets a metadata attachment, erasing the existing metadata attachment if it already exists for the given kind.
LLVM_C_ABI void LLVMGlobalAddMetadata (LLVMValueRef Global, unsigned Kind, LLVMMetadataRef MD)
 Adds a metadata attachment.
LLVM_C_ABI void LLVMGlobalEraseMetadata (LLVMValueRef Global, unsigned Kind)
 Erases a metadata attachment of the given kind if it exists.
LLVM_C_ABI void LLVMGlobalClearMetadata (LLVMValueRef Global)
 Removes all metadata attachments from this value.
LLVM_C_ABI void LLVMGlobalAddDebugInfo (LLVMValueRef Global, LLVMMetadataRef GVE)
 Add debuginfo metadata to this global.
LLVM_C_ABI LLVMValueMetadataEntry * LLVMGlobalCopyAllMetadata (LLVMValueRef Value, size_t *NumEntries)
 Retrieves an array of metadata entries representing the metadata attached to this value.
LLVM_C_ABI void LLVMDisposeValueMetadataEntries (LLVMValueMetadataEntry *Entries)
 Destroys value metadata entries.
LLVM_C_ABI unsigned LLVMValueMetadataEntriesGetKind (LLVMValueMetadataEntry *Entries, unsigned Index)
 Returns the kind of a value metadata entry at a specific index.
LLVM_C_ABI LLVMMetadataRef LLVMValueMetadataEntriesGetMetadata (LLVMValueMetadataEntry *Entries, unsigned Index)
 Returns the underlying metadata node of a value metadata entry at a specific index.

Detailed Description

This group contains functions that operate on global values.

Functions in this group relate to functions in the llvm::GlobalValue class tree.

See also
llvm::GlobalValue

Function Documentation

◆ LLVMDisposeValueMetadataEntries()

LLVM_C_ABI void LLVMDisposeValueMetadataEntries ( LLVMValueMetadataEntry * Entries)

Destroys value metadata entries.

Definition at line 2312 of file Core.cpp.

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGetAlignment()

LLVM_C_ABI unsigned LLVMGetAlignment ( LLVMValueRef V)

Obtain the preferred alignment of the value.

See also
llvm::AllocaInst::getAlignment()
llvm::LoadInst::getAlignment()
llvm::StoreInst::getAlignment()
llvm::AtomicRMWInst::setAlignment()
llvm::AtomicCmpXchgInst::setAlignment()
llvm::GlobalValue::getAlignment()

Definition at line 2241 of file Core.cpp.

References llvm::dyn_cast(), F, llvm_unreachable, P, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGetDLLStorageClass()

LLVM_C_ABI LLVMDLLStorageClass LLVMGetDLLStorageClass ( LLVMValueRef Global)

Definition at line 2182 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGetGlobalParent()

LLVM_C_ABI LLVMModuleRef LLVMGetGlobalParent ( LLVMValueRef Global)

Definition at line 2060 of file Core.cpp.

References getParent(), llvm::Global, llvm::unwrap(), and llvm::wrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGetLinkage()

LLVM_C_ABI LLVMLinkage LLVMGetLinkage ( LLVMValueRef Global)

Definition at line 2068 of file Core.cpp.

References llvm::GlobalValue::AppendingLinkage, llvm::GlobalValue::AvailableExternallyLinkage, llvm::GlobalValue::CommonLinkage, llvm::GlobalValue::ExternalLinkage, llvm::GlobalValue::ExternalWeakLinkage, llvm::Global, llvm::GlobalValue::InternalLinkage, llvm::GlobalValue::LinkOnceAnyLinkage, llvm::GlobalValue::LinkOnceODRLinkage, llvm_unreachable, LLVMAppendingLinkage, LLVMAvailableExternallyLinkage, LLVMCommonLinkage, LLVMExternalLinkage, LLVMExternalWeakLinkage, LLVMInternalLinkage, LLVMLinkOnceAnyLinkage, LLVMLinkOnceODRLinkage, LLVMPrivateLinkage, LLVMWeakAnyLinkage, LLVMWeakODRLinkage, llvm::GlobalValue::PrivateLinkage, llvm::unwrap(), llvm::GlobalValue::WeakAnyLinkage, and llvm::GlobalValue::WeakODRLinkage.

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGetSection()

LLVM_C_ABI const char * LLVMGetSection ( LLVMValueRef Global)

Definition at line 2162 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGetUnnamedAddress()

LLVM_C_ABI LLVMUnnamedAddr LLVMGetUnnamedAddress ( LLVMValueRef Global)

Definition at line 2192 of file Core.cpp.

References llvm::Global, llvm::GlobalValue::Global, llvm_unreachable, LLVMGlobalUnnamedAddr, LLVMLocalUnnamedAddr, LLVMNoUnnamedAddr, llvm::GlobalValue::Local, llvm::GlobalValue::None, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGetVisibility()

LLVM_C_ABI LLVMVisibility LLVMGetVisibility ( LLVMValueRef Global)

Definition at line 2172 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGlobalAddDebugInfo()

LLVM_C_ABI void LLVMGlobalAddDebugInfo ( LLVMValueRef Global,
LLVMMetadataRef GVE )

Add debuginfo metadata to this global.

See also
llvm::GlobalVariable::addDebugInfo()

Definition at line 2334 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGlobalAddMetadata()

LLVM_C_ABI void LLVMGlobalAddMetadata ( LLVMValueRef Global,
unsigned Kind,
LLVMMetadataRef MD )

Adds a metadata attachment.

See also
llvm::GlobalObject::addMetadata()

Definition at line 2321 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGlobalClearMetadata()

LLVM_C_ABI void LLVMGlobalClearMetadata ( LLVMValueRef Global)

Removes all metadata attachments from this value.

See also
llvm::GlobalObject::clearMetadata()

Definition at line 2330 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGlobalCopyAllMetadata()

LLVM_C_ABI LLVMValueMetadataEntry * LLVMGlobalCopyAllMetadata ( LLVMValueRef Value,
size_t * NumEntries )

Retrieves an array of metadata entries representing the metadata attached to this value.

The caller is responsible for freeing this array by calling LLVMDisposeValueMetadataEntries.

See also
llvm::GlobalObject::getAllMetadata()

Definition at line 2285 of file Core.cpp.

References llvm::SmallVectorImpl< T >::clear(), llvm::dyn_cast(), llvm_getMetadata(), and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGlobalEraseMetadata()

LLVM_C_ABI void LLVMGlobalEraseMetadata ( LLVMValueRef Global,
unsigned Kind )

Erases a metadata attachment of the given kind if it exists.

See also
llvm::GlobalObject::eraseMetadata()

Definition at line 2326 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGlobalGetValueType()

LLVM_C_ABI LLVMTypeRef LLVMGlobalGetValueType ( LLVMValueRef Global)

Returns the "value type" of a global value.

This differs from the formal type of a global value which is always a pointer type.

See also
llvm::GlobalValue::getValueType()
llvm::Function::getFunctionType()

Definition at line 2235 of file Core.cpp.

References llvm::Global, llvm::unwrap(), and llvm::wrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMGlobalSetMetadata()

LLVM_C_ABI void LLVMGlobalSetMetadata ( LLVMValueRef Global,
unsigned Kind,
LLVMMetadataRef MD )

Sets a metadata attachment, erasing the existing metadata attachment if it already exists for the given kind.

See also
llvm::GlobalObject::setMetadata()

Definition at line 2316 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMHasUnnamedAddr()

LLVM_C_ABI LLVMBool LLVMHasUnnamedAddr ( LLVMValueRef Global)

Deprecated: Use LLVMGetUnnamedAddress instead.

Definition at line 2225 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMIsDeclaration()

LLVM_C_ABI LLVMBool LLVMIsDeclaration ( LLVMValueRef Global)

Definition at line 2064 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMIsDSOLocal()

LLVM_C_ABI LLVMBool LLVMIsDSOLocal ( LLVMValueRef Global)

Returns whether the global value is marked as dso_local, i.e.

whether it will resolve to a symbol within the same linkage unit.

See also
llvm::GlobalValue::isDSOLocal()

Definition at line 2217 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMSetAlignment()

LLVM_C_ABI void LLVMSetAlignment ( LLVMValueRef V,
unsigned Bytes )

Set the preferred alignment of the value.

See also
llvm::AllocaInst::setAlignment()
llvm::LoadInst::setAlignment()
llvm::StoreInst::setAlignment()
llvm::AtomicRMWInst::setAlignment()
llvm::AtomicCmpXchgInst::setAlignment()
llvm::GlobalValue::setAlignment()

Definition at line 2263 of file Core.cpp.

References llvm::dyn_cast(), F, llvm_unreachable, P, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMSetDLLStorageClass()

LLVM_C_ABI void LLVMSetDLLStorageClass ( LLVMValueRef Global,
LLVMDLLStorageClass Class )

Definition at line 2187 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMSetDSOLocal()

LLVM_C_ABI void LLVMSetDSOLocal ( LLVMValueRef Global,
LLVMBool IsDSOLocal )

Sets whether the global value is marked as dso_local.

Note that globals with local linkage or non-default visibility are always implicitly dso_local.

See also
llvm::GlobalValue::setDSOLocal()

Definition at line 2221 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMSetLinkage()

LLVM_C_ABI void LLVMSetLinkage ( LLVMValueRef Global,
LLVMLinkage Linkage )

Definition at line 2097 of file Core.cpp.

References llvm::GlobalValue::AppendingLinkage, llvm::GlobalValue::AvailableExternallyLinkage, llvm::GlobalValue::CommonLinkage, llvm::errs(), llvm::GlobalValue::ExternalLinkage, llvm::GlobalValue::ExternalWeakLinkage, llvm::Global, llvm::GlobalValue::InternalLinkage, Linkage, llvm::GlobalValue::LinkOnceAnyLinkage, llvm::GlobalValue::LinkOnceODRLinkage, LLVM_DEBUG, LLVMAppendingLinkage, LLVMAvailableExternallyLinkage, LLVMCommonLinkage, LLVMDLLExportLinkage, LLVMDLLImportLinkage, LLVMExternalLinkage, LLVMExternalWeakLinkage, LLVMGhostLinkage, LLVMInternalLinkage, LLVMLinkerPrivateLinkage, LLVMLinkerPrivateWeakLinkage, LLVMLinkOnceAnyLinkage, LLVMLinkOnceODRAutoHideLinkage, LLVMLinkOnceODRLinkage, LLVMPrivateLinkage, LLVMWeakAnyLinkage, LLVMWeakODRLinkage, llvm::GlobalValue::PrivateLinkage, llvm::GlobalValue::setLinkage(), llvm::unwrap(), llvm::GlobalValue::WeakAnyLinkage, and llvm::GlobalValue::WeakODRLinkage.

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMSetSection()

LLVM_C_ABI void LLVMSetSection ( LLVMValueRef Global,
const char * Section )

Definition at line 2168 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMSetUnnamedAddr()

LLVM_C_ABI void LLVMSetUnnamedAddr ( LLVMValueRef Global,
LLVMBool HasUnnamedAddr )

Deprecated: Use LLVMSetUnnamedAddress instead.

Definition at line 2229 of file Core.cpp.

References llvm::Global, llvm::GlobalValue::Global, llvm::GlobalValue::None, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMSetUnnamedAddress()

LLVM_C_ABI void LLVMSetUnnamedAddress ( LLVMValueRef Global,
LLVMUnnamedAddr UnnamedAddr )

Definition at line 2204 of file Core.cpp.

References llvm::Global, llvm::GlobalValue::Global, LLVMGlobalUnnamedAddr, LLVMLocalUnnamedAddr, LLVMNoUnnamedAddr, llvm::GlobalValue::Local, llvm::GlobalValue::None, llvm::GlobalValue::setUnnamedAddr(), and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMSetVisibility()

LLVM_C_ABI void LLVMSetVisibility ( LLVMValueRef Global,
LLVMVisibility Viz )

Definition at line 2177 of file Core.cpp.

References llvm::Global, and llvm::unwrap().

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMValueMetadataEntriesGetKind()

LLVM_C_ABI unsigned LLVMValueMetadataEntriesGetKind ( LLVMValueMetadataEntry * Entries,
unsigned Index )

Returns the kind of a value metadata entry at a specific index.

Definition at line 2297 of file Core.cpp.

References LLVMOpaqueValueMetadataEntry::Kind.

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

◆ LLVMValueMetadataEntriesGetMetadata()

LLVM_C_ABI LLVMMetadataRef LLVMValueMetadataEntriesGetMetadata ( LLVMValueMetadataEntry * Entries,
unsigned Index )

Returns the underlying metadata node of a value metadata entry at a specific index.

Definition at line 2305 of file Core.cpp.

References LLVMOpaqueValueMetadataEntry::Metadata.

Referenced by LLVM_ATTRIBUTE_C_DEPRECATED().

Generated on for LLVM by doxygen 1.14.0