Modules represent the top-level structure in an LLVM program. More...

Collaboration diagram for Modules:

Functions
LLVMModuleRef	LLVMModuleCreateWithName (const char *ModuleID)
	Create a new, empty module in the global context.

LLVMModuleRef	LLVMModuleCreateWithNameInContext (const char *ModuleID, LLVMContextRef C)
	Create a new, empty module in a specific context.

LLVMModuleRef	LLVMCloneModule (LLVMModuleRef M)
	Return an exact copy of the specified module.

void	LLVMDisposeModule (LLVMModuleRef M)
	Destroy a module instance.

LLVMBool	LLVMIsNewDbgInfoFormat (LLVMModuleRef M)
	Soon to be deprecated.

void	LLVMSetIsNewDbgInfoFormat (LLVMModuleRef M, LLVMBool UseNewFormat)
	Soon to be deprecated.

const char *	LLVMGetModuleIdentifier (LLVMModuleRef M, size_t *Len)
	Obtain the identifier of a module.

void	LLVMSetModuleIdentifier (LLVMModuleRef M, const char *Ident, size_t Len)
	Set the identifier of a module to a string Ident with length Len.

const char *	LLVMGetSourceFileName (LLVMModuleRef M, size_t *Len)
	Obtain the module's original source file name.

void	LLVMSetSourceFileName (LLVMModuleRef M, const char *Name, size_t Len)
	Set the original source file name of a module to a string Name with length Len.

const char *	LLVMGetDataLayoutStr (LLVMModuleRef M)
	Obtain the data layout for a module.

const char *	LLVMGetDataLayout (LLVMModuleRef M)

void	LLVMSetDataLayout (LLVMModuleRef M, const char *DataLayoutStr)
	Set the data layout for a module.

const char *	LLVMGetTarget (LLVMModuleRef M)
	Obtain the target triple for a module.

void	LLVMSetTarget (LLVMModuleRef M, const char *Triple)
	Set the target triple for a module.

LLVMModuleFlagEntry *	LLVMCopyModuleFlagsMetadata (LLVMModuleRef M, size_t *Len)
	Returns the module flags as an array of flag-key-value triples.

void	LLVMDisposeModuleFlagsMetadata (LLVMModuleFlagEntry *Entries)
	Destroys module flags metadata entries.

LLVMModuleFlagBehavior	LLVMModuleFlagEntriesGetFlagBehavior (LLVMModuleFlagEntry *Entries, unsigned Index)
	Returns the flag behavior for a module flag entry at a specific index.

const char *	LLVMModuleFlagEntriesGetKey (LLVMModuleFlagEntry Entries, unsigned Index, size_t Len)
	Returns the key for a module flag entry at a specific index.

LLVMMetadataRef	LLVMModuleFlagEntriesGetMetadata (LLVMModuleFlagEntry *Entries, unsigned Index)
	Returns the metadata for a module flag entry at a specific index.

LLVMMetadataRef	LLVMGetModuleFlag (LLVMModuleRef M, const char *Key, size_t KeyLen)
	Add a module-level flag to the module-level flags metadata if it doesn't already exist.

void	LLVMAddModuleFlag (LLVMModuleRef M, LLVMModuleFlagBehavior Behavior, const char *Key, size_t KeyLen, LLVMMetadataRef Val)
	Add a module-level flag to the module-level flags metadata if it doesn't already exist.

void	LLVMDumpModule (LLVMModuleRef M)
	Dump a representation of a module to stderr.

LLVMBool	LLVMPrintModuleToFile (LLVMModuleRef M, const char Filename, char *ErrorMessage)
	Print a representation of a module to a file.

char *	LLVMPrintModuleToString (LLVMModuleRef M)
	Return a string representation of the module.

const char *	LLVMGetModuleInlineAsm (LLVMModuleRef M, size_t *Len)
	Get inline assembly for a module.

void	LLVMSetModuleInlineAsm2 (LLVMModuleRef M, const char *Asm, size_t Len)
	Set inline assembly for a module.

void	LLVMAppendModuleInlineAsm (LLVMModuleRef M, const char *Asm, size_t Len)
	Append inline assembly to a module.

LLVMValueRef	LLVMGetInlineAsm (LLVMTypeRef Ty, const char AsmString, size_t AsmStringSize, const char Constraints, size_t ConstraintsSize, LLVMBool HasSideEffects, LLVMBool IsAlignStack, LLVMInlineAsmDialect Dialect, LLVMBool CanThrow)
	Create the specified uniqued inline asm string.

const char *	LLVMGetInlineAsmAsmString (LLVMValueRef InlineAsmVal, size_t *Len)
	Get the template string used for an inline assembly snippet.

const char *	LLVMGetInlineAsmConstraintString (LLVMValueRef InlineAsmVal, size_t *Len)
	Get the raw constraint string for an inline assembly snippet.

LLVMInlineAsmDialect	LLVMGetInlineAsmDialect (LLVMValueRef InlineAsmVal)
	Get the dialect used by the inline asm snippet.

LLVMTypeRef	LLVMGetInlineAsmFunctionType (LLVMValueRef InlineAsmVal)
	Get the function type of the inline assembly snippet.

LLVMBool	LLVMGetInlineAsmHasSideEffects (LLVMValueRef InlineAsmVal)
	Get if the inline asm snippet has side effects.

LLVMBool	LLVMGetInlineAsmNeedsAlignedStack (LLVMValueRef InlineAsmVal)
	Get if the inline asm snippet needs an aligned stack.

LLVMBool	LLVMGetInlineAsmCanUnwind (LLVMValueRef InlineAsmVal)
	Get if the inline asm snippet may unwind the stack.

LLVMContextRef	LLVMGetModuleContext (LLVMModuleRef M)
	Obtain the context to which this module is associated.

LLVMTypeRef	LLVMGetTypeByName (LLVMModuleRef M, const char *Name)
	Deprecated: Use LLVMGetTypeByName2 instead.

LLVMNamedMDNodeRef	LLVMGetFirstNamedMetadata (LLVMModuleRef M)
	Obtain an iterator to the first NamedMDNode in a Module.

LLVMNamedMDNodeRef	LLVMGetLastNamedMetadata (LLVMModuleRef M)
	Obtain an iterator to the last NamedMDNode in a Module.

LLVMNamedMDNodeRef	LLVMGetNextNamedMetadata (LLVMNamedMDNodeRef NamedMDNode)
	Advance a NamedMDNode iterator to the next NamedMDNode.

LLVMNamedMDNodeRef	LLVMGetPreviousNamedMetadata (LLVMNamedMDNodeRef NamedMDNode)
	Decrement a NamedMDNode iterator to the previous NamedMDNode.

LLVMNamedMDNodeRef	LLVMGetNamedMetadata (LLVMModuleRef M, const char *Name, size_t NameLen)
	Retrieve a NamedMDNode with the given name, returning NULL if no such node exists.

LLVMNamedMDNodeRef	LLVMGetOrInsertNamedMetadata (LLVMModuleRef M, const char *Name, size_t NameLen)
	Retrieve a NamedMDNode with the given name, creating a new node if no such node exists.

const char *	LLVMGetNamedMetadataName (LLVMNamedMDNodeRef NamedMD, size_t *NameLen)
	Retrieve the name of a NamedMDNode.

unsigned	LLVMGetNamedMetadataNumOperands (LLVMModuleRef M, const char *Name)
	Obtain the number of operands for named metadata in a module.

void	LLVMGetNamedMetadataOperands (LLVMModuleRef M, const char Name, LLVMValueRef Dest)
	Obtain the named metadata operands for a module.

void	LLVMAddNamedMetadataOperand (LLVMModuleRef M, const char *Name, LLVMValueRef Val)
	Add an operand to named metadata.

const char *	LLVMGetDebugLocDirectory (LLVMValueRef Val, unsigned *Length)
	Return the directory of the debug location for this value, which must be an llvm::Instruction, llvm::GlobalVariable, or llvm::Function.

const char *	LLVMGetDebugLocFilename (LLVMValueRef Val, unsigned *Length)
	Return the filename of the debug location for this value, which must be an llvm::Instruction, llvm::GlobalVariable, or llvm::Function.

unsigned	LLVMGetDebugLocLine (LLVMValueRef Val)
	Return the line number of the debug location for this value, which must be an llvm::Instruction, llvm::GlobalVariable, or llvm::Function.

unsigned	LLVMGetDebugLocColumn (LLVMValueRef Val)
	Return the column number of the debug location for this value, which must be an llvm::Instruction.

LLVMValueRef	LLVMAddFunction (LLVMModuleRef M, const char *Name, LLVMTypeRef FunctionTy)
	Add a function to a module under a specified name.

LLVMValueRef	LLVMGetNamedFunction (LLVMModuleRef M, const char *Name)
	Obtain a Function value from a Module by its name.

LLVMValueRef	LLVMGetNamedFunctionWithLength (LLVMModuleRef M, const char *Name, size_t Length)
	Obtain a Function value from a Module by its name.

LLVMValueRef	LLVMGetFirstFunction (LLVMModuleRef M)
	Obtain an iterator to the first Function in a Module.

LLVMValueRef	LLVMGetLastFunction (LLVMModuleRef M)
	Obtain an iterator to the last Function in a Module.

LLVMValueRef	LLVMGetNextFunction (LLVMValueRef Fn)
	Advance a Function iterator to the next Function.

LLVMValueRef	LLVMGetPreviousFunction (LLVMValueRef Fn)
	Decrement a Function iterator to the previous Function.

void	LLVMSetModuleInlineAsm (LLVMModuleRef M, const char *Asm)
	Deprecated: Use LLVMSetModuleInlineAsm2 instead.

Detailed Description

Modules represent the top-level structure in an LLVM program.

An LLVM module is effectively a translation unit or a collection of translation units merged together.

Function Documentation

◆ LLVMAddFunction()

LLVMValueRef LLVMAddFunction	(	LLVMModuleRef	M,
		const char *	Name,
		LLVMTypeRef	FunctionTy
	)

Add a function to a module under a specified name.

See also: llvm::Function::Create()

Definition at line 2388 of file Core.cpp.

References llvm::Function::Create(), llvm::GlobalValue::ExternalLinkage, Name, unwrap(), and llvm::wrap().

◆ LLVMAddModuleFlag()

void LLVMAddModuleFlag	(	LLVMModuleRef	M,
		LLVMModuleFlagBehavior	Behavior,
		const char *	Key,
		size_t	KeyLen,
		LLVMMetadataRef	Val
	)

Add a module-level flag to the module-level flags metadata if it doesn't already exist.

See also: Module::addModuleFlag()

Definition at line 425 of file Core.cpp.

References map_to_llvmModFlagBehavior(), and unwrap().

◆ LLVMAddNamedMetadataOperand()

void LLVMAddNamedMetadataOperand	(	LLVMModuleRef	M,
		const char *	Name,
		LLVMValueRef	Val
	)

Add an operand to named metadata.

See also: llvm::Module::getNamedMetadata(); llvm::MDNode::addOperand()

Definition at line 1446 of file Core.cpp.

References extractMDNode(), N, Name, and unwrap().

◆ LLVMAppendModuleInlineAsm()

void LLVMAppendModuleInlineAsm	(	LLVMModuleRef	M,
		const char *	Asm,
		size_t	Len
	)

Append inline assembly to a module.

See also: Module::appendModuleInlineAsm()

Definition at line 488 of file Core.cpp.

References unwrap().

◆ LLVMCloneModule()

LLVMModuleRef LLVMCloneModule ( LLVMModuleRef M )

Return an exact copy of the specified module.

Definition at line 220 of file CloneModule.cpp.

References llvm::CloneModule(), llvm::release, llvm::unwrap(), and llvm::wrap().

◆ LLVMCopyModuleFlagsMetadata()

LLVMModuleFlagEntry * LLVMCopyModuleFlagsMetadata	(	LLVMModuleRef	M,
		size_t *	Len
	)

Returns the module flags as an array of flag-key-value triples.

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

See also: Module::getModuleFlagsMetadata()

Definition at line 376 of file Core.cpp.

References map_from_llvmModFlagBehavior(), llvm::safe_malloc(), llvm::SmallVectorBase< Size_T >::size(), unwrap(), and llvm::wrap().

◆ LLVMDisposeModule()

void LLVMDisposeModule ( LLVMModuleRef M )

Destroy a module instance.

This must be called for every created module or memory will be leaked.

Definition at line 283 of file Core.cpp.

References unwrap().

◆ LLVMDisposeModuleFlagsMetadata()

void LLVMDisposeModuleFlagsMetadata ( LLVMModuleFlagEntry * Entries )

Destroys module flags metadata entries.

Definition at line 393 of file Core.cpp.

◆ LLVMDumpModule()

void LLVMDumpModule ( LLVMModuleRef M )

Dump a representation of a module to stderr.

See also: Module::dump()

Definition at line 442 of file Core.cpp.

References llvm::errs(), llvm::BasicBlock::print(), and unwrap().

◆ LLVMGetDataLayout()

const char * LLVMGetDataLayout ( LLVMModuleRef M )

Definition at line 312 of file Core.cpp.

References LLVMGetDataLayoutStr().

◆ LLVMGetDataLayoutStr()

const char * LLVMGetDataLayoutStr ( LLVMModuleRef M )

Obtain the data layout for a module.

See also: Module::getDataLayoutStr()

LLVMGetDataLayout is DEPRECATED, as the name is not only incorrect, but match the name of another method on the module. Prefer the use of LLVMGetDataLayoutStr, which is not ambiguous.

Definition at line 308 of file Core.cpp.

References unwrap().

Referenced by LLVMGetDataLayout().

◆ LLVMGetDebugLocColumn()

unsigned LLVMGetDebugLocColumn ( LLVMValueRef Val )

Return the column number of the debug location for this value, which must be an llvm::Instruction.

See also: llvm::Instruction::getDebugLoc()

Definition at line 1526 of file Core.cpp.

References llvm::CallingConv::C, DL, I, and unwrap().

◆ LLVMGetDebugLocDirectory()

const char * LLVMGetDebugLocDirectory	(	LLVMValueRef	Val,
		unsigned *	Length
	)

Return the directory of the debug location for this value, which must be an llvm::Instruction, llvm::GlobalVariable, or llvm::Function.

See also: llvm::Instruction::getDebugLoc(); llvm::GlobalVariable::getDebugInfo(); llvm::Function::getSubprogram()

Definition at line 1456 of file Core.cpp.

References assert(), llvm::StringRef::data(), DL, F, I, llvm::Length, llvm::SmallVectorBase< Size_T >::size(), llvm::StringRef::size(), and unwrap().

◆ LLVMGetDebugLocFilename()

const char * LLVMGetDebugLocFilename	(	LLVMValueRef	Val,
		unsigned *	Length
	)

Return the filename of the debug location for this value, which must be an llvm::Instruction, llvm::GlobalVariable, or llvm::Function.

See also: llvm::Instruction::getDebugLoc(); llvm::GlobalVariable::getDebugInfo(); llvm::Function::getSubprogram()

Definition at line 1480 of file Core.cpp.

References assert(), llvm::StringRef::data(), DL, F, I, llvm::Length, llvm::SmallVectorBase< Size_T >::size(), llvm::StringRef::size(), and unwrap().

◆ LLVMGetDebugLocLine()

unsigned LLVMGetDebugLocLine ( LLVMValueRef Val )

Return the line number of the debug location for this value, which must be an llvm::Instruction, llvm::GlobalVariable, or llvm::Function.

See also: llvm::Instruction::getDebugLoc(); llvm::GlobalVariable::getDebugInfo(); llvm::Function::getSubprogram()

Definition at line 1504 of file Core.cpp.

References assert(), DL, F, I, llvm::SmallVectorBase< Size_T >::size(), and unwrap().

◆ LLVMGetFirstFunction()

LLVMValueRef LLVMGetFirstFunction ( LLVMModuleRef M )

Obtain an iterator to the first Function in a Module.

See also: llvm::Module::begin()

Definition at line 2403 of file Core.cpp.

References I, Mod, unwrap(), and llvm::wrap().

◆ LLVMGetFirstNamedMetadata()

LLVMNamedMDNodeRef LLVMGetFirstNamedMetadata ( LLVMModuleRef M )

Obtain an iterator to the first NamedMDNode in a Module.

See also: llvm::Module::named_metadata_begin()

Definition at line 1361 of file Core.cpp.

References I, Mod, unwrap(), and llvm::wrap().

◆ LLVMGetInlineAsm()

LLVMValueRef LLVMGetInlineAsm	(	LLVMTypeRef	Ty,
		const char *	AsmString,
		size_t	AsmStringSize,
		const char *	Constraints,
		size_t	ConstraintsSize,
		LLVMBool	HasSideEffects,
		LLVMBool	IsAlignStack,
		LLVMInlineAsmDialect	Dialect,
		LLVMBool	CanThrow
	)

Create the specified uniqued inline asm string.

See also: InlineAsm::get()

Definition at line 498 of file Core.cpp.

References llvm::InlineAsm::AD_ATT, llvm::InlineAsm::AD_Intel, llvm::InlineAsm::get(), LLVMInlineAsmDialectATT, LLVMInlineAsmDialectIntel, and llvm::wrap().

◆ LLVMGetInlineAsmAsmString()

const char * LLVMGetInlineAsmAsmString	(	LLVMValueRef	InlineAsmVal,
		size_t *	Len
	)

Get the template string used for an inline assembly snippet.

Definition at line 518 of file Core.cpp.

◆ LLVMGetInlineAsmCanUnwind()

LLVMBool LLVMGetInlineAsmCanUnwind ( LLVMValueRef InlineAsmVal )

Get if the inline asm snippet may unwind the stack.

Definition at line 568 of file Core.cpp.

◆ LLVMGetInlineAsmConstraintString()

const char * LLVMGetInlineAsmConstraintString	(	LLVMValueRef	InlineAsmVal,
		size_t *	Len
	)

Get the raw constraint string for an inline assembly snippet.

Definition at line 527 of file Core.cpp.

◆ LLVMGetInlineAsmDialect()

LLVMInlineAsmDialect LLVMGetInlineAsmDialect ( LLVMValueRef InlineAsmVal )

Get the dialect used by the inline asm snippet.

Definition at line 537 of file Core.cpp.

References llvm::InlineAsm::AD_ATT, llvm::InlineAsm::AD_Intel, llvm_unreachable, LLVMInlineAsmDialectATT, and LLVMInlineAsmDialectIntel.

◆ LLVMGetInlineAsmFunctionType()

LLVMTypeRef LLVMGetInlineAsmFunctionType ( LLVMValueRef InlineAsmVal )

Get the function type of the inline assembly snippet.

The same type that was passed into LLVMGetInlineAsm originally

See also: LLVMGetInlineAsm

Definition at line 553 of file Core.cpp.

◆ LLVMGetInlineAsmHasSideEffects()

LLVMBool LLVMGetInlineAsmHasSideEffects ( LLVMValueRef InlineAsmVal )

Get if the inline asm snippet has side effects.

Definition at line 558 of file Core.cpp.

◆ LLVMGetInlineAsmNeedsAlignedStack()

LLVMBool LLVMGetInlineAsmNeedsAlignedStack ( LLVMValueRef InlineAsmVal )

Get if the inline asm snippet needs an aligned stack.

Definition at line 563 of file Core.cpp.

◆ LLVMGetLastFunction()

LLVMValueRef LLVMGetLastFunction ( LLVMModuleRef M )

Obtain an iterator to the last Function in a Module.

See also: llvm::Module::end()

Definition at line 2411 of file Core.cpp.

References I, Mod, unwrap(), and llvm::wrap().

◆ LLVMGetLastNamedMetadata()

LLVMNamedMDNodeRef LLVMGetLastNamedMetadata ( LLVMModuleRef M )

Obtain an iterator to the last NamedMDNode in a Module.

See also: llvm::Module::named_metadata_end()

Definition at line 1369 of file Core.cpp.

References I, Mod, unwrap(), and llvm::wrap().

◆ LLVMGetModuleContext()

LLVMContextRef LLVMGetModuleContext ( LLVMModuleRef M )

Obtain the context to which this module is associated.

See also: Module::getContext()

Definition at line 574 of file Core.cpp.

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

◆ LLVMGetModuleFlag()

LLVMMetadataRef LLVMGetModuleFlag	(	LLVMModuleRef	M,
		const char *	Key,
		size_t	KeyLen
	)

Add a module-level flag to the module-level flags metadata if it doesn't already exist.

See also: Module::getModuleFlag()

Definition at line 420 of file Core.cpp.

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

◆ LLVMGetModuleIdentifier()

const char * LLVMGetModuleIdentifier	(	LLVMModuleRef	M,
		size_t *	Len
	)

Obtain the identifier of a module.

Parameters

M	Module to obtain identifier of
Len	Out parameter which holds the length of the returned string.

Returns: The identifier of M.

See also: Module::getModuleIdentifier()

Definition at line 287 of file Core.cpp.

References unwrap().

◆ LLVMGetModuleInlineAsm()

const char * LLVMGetModuleInlineAsm	(	LLVMModuleRef	M,
		size_t *	Len
	)

Get inline assembly for a module.

See also: Module::getModuleInlineAsm()

Definition at line 492 of file Core.cpp.

References unwrap().

◆ LLVMGetNamedFunction()

LLVMValueRef LLVMGetNamedFunction	(	LLVMModuleRef	M,
		const char *	Name
	)

Obtain a Function value from a Module by its name.

The returned value corresponds to a llvm::Function value.

See also: llvm::Module::getFunction()

Definition at line 2394 of file Core.cpp.

References getFunction(), Name, unwrap(), and llvm::wrap().

◆ LLVMGetNamedFunctionWithLength()

LLVMValueRef LLVMGetNamedFunctionWithLength	(	LLVMModuleRef	M,
		const char *	Name,
		size_t	Length
	)

Obtain a Function value from a Module by its name.

The returned value corresponds to a llvm::Function value.

See also: llvm::Module::getFunction()

Definition at line 2398 of file Core.cpp.

References getFunction(), llvm::Length, Name, unwrap(), and llvm::wrap().

◆ LLVMGetNamedMetadata()

LLVMNamedMDNodeRef LLVMGetNamedMetadata	(	LLVMModuleRef	M,
		const char *	Name,
		size_t	NameLen
	)

Retrieve a NamedMDNode with the given name, returning NULL if no such node exists.

See also: llvm::Module::getNamedMetadata()

Definition at line 1393 of file Core.cpp.

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

◆ LLVMGetNamedMetadataName()

const char * LLVMGetNamedMetadataName	(	LLVMNamedMDNodeRef	NamedMD,
		size_t *	NameLen
	)

Retrieve the name of a NamedMDNode.

See also: llvm::NamedMDNode::getName()

Definition at line 1403 of file Core.cpp.

References llvm::StringRef::data(), llvm::NamedMDNode::getName(), llvm::StringRef::size(), and unwrap().

◆ LLVMGetNamedMetadataNumOperands()

unsigned LLVMGetNamedMetadataNumOperands	(	LLVMModuleRef	M,
		const char *	Name
	)

Obtain the number of operands for named metadata in a module.

See also: llvm::Module::getNamedMetadata()

Definition at line 1429 of file Core.cpp.

References N, Name, and unwrap().

◆ LLVMGetNamedMetadataOperands()

void LLVMGetNamedMetadataOperands	(	LLVMModuleRef	M,
		const char *	Name,
		LLVMValueRef *	Dest
	)

Obtain the named metadata operands for a module.

The passed LLVMValueRef pointer should refer to an array of LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This array will be populated with the LLVMValueRef instances. Each instance corresponds to a llvm::MDNode.

See also: llvm::Module::getNamedMetadata(); llvm::MDNode::getOperand()

Definition at line 1436 of file Core.cpp.

References llvm::MetadataAsValue::get(), llvm::BasicBlock::getContext(), N, Name, unwrap(), and llvm::wrap().

◆ LLVMGetNextFunction()

LLVMValueRef LLVMGetNextFunction ( LLVMValueRef Fn )

Advance a Function iterator to the next Function.

Returns NULL if the iterator was already at the end and there are no more functions.

Definition at line 2419 of file Core.cpp.

References I, and llvm::wrap().

◆ LLVMGetNextNamedMetadata()

LLVMNamedMDNodeRef LLVMGetNextNamedMetadata ( LLVMNamedMDNodeRef NamedMDNode )

Advance a NamedMDNode iterator to the next NamedMDNode.

Returns NULL if the iterator was already at the end and there are no more named metadata nodes.

Definition at line 1377 of file Core.cpp.

References llvm::NamedMDNode::getParent(), I, llvm::Module::named_metadata_end(), unwrap(), and llvm::wrap().

◆ LLVMGetOrInsertNamedMetadata()

LLVMNamedMDNodeRef LLVMGetOrInsertNamedMetadata	(	LLVMModuleRef	M,
		const char *	Name,
		size_t	NameLen
	)

Retrieve a NamedMDNode with the given name, creating a new node if no such node exists.

See also: llvm::Module::getOrInsertNamedMetadata()

Definition at line 1398 of file Core.cpp.

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

◆ LLVMGetPreviousFunction()

LLVMValueRef LLVMGetPreviousFunction ( LLVMValueRef Fn )

Decrement a Function iterator to the previous Function.

Returns NULL if the iterator was already at the beginning and there are no previous functions.

Definition at line 2427 of file Core.cpp.

References I, and llvm::wrap().

◆ LLVMGetPreviousNamedMetadata()

LLVMNamedMDNodeRef LLVMGetPreviousNamedMetadata ( LLVMNamedMDNodeRef NamedMDNode )

Decrement a NamedMDNode iterator to the previous NamedMDNode.

Returns NULL if the iterator was already at the beginning and there are no previous named metadata nodes.

Definition at line 1385 of file Core.cpp.

References llvm::NamedMDNode::getParent(), I, llvm::Module::named_metadata_begin(), unwrap(), and llvm::wrap().

◆ LLVMGetSourceFileName()

const char * LLVMGetSourceFileName	(	LLVMModuleRef	M,
		size_t *	Len
	)

Obtain the module's original source file name.

Parameters

M	Module to obtain the name of
Len	Out parameter which holds the length of the returned string

Returns: The original source file name of M

See also: Module::getSourceFileName()

Definition at line 297 of file Core.cpp.

References unwrap().

◆ LLVMGetTarget()

const char * LLVMGetTarget ( LLVMModuleRef M )

Obtain the target triple for a module.

See also: Module::getTargetTriple()

Definition at line 321 of file Core.cpp.

References unwrap().

◆ LLVMGetTypeByName()

LLVMTypeRef LLVMGetTypeByName	(	LLVMModuleRef	M,
		const char *	Name
	)

Deprecated: Use LLVMGetTypeByName2 instead.

Definition at line 847 of file Core.cpp.

References llvm::StructType::getTypeByName(), Name, unwrap(), and llvm::wrap().

◆ LLVMIsNewDbgInfoFormat()

LLVMBool LLVMIsNewDbgInfoFormat ( LLVMModuleRef M )

Soon to be deprecated.

See https://llvm.org/docs/RemoveDIsDebugInfo.html#c-api-changes

Returns true if the module is in the new debug info mode which uses non-instruction debug records instead of debug intrinsics for variable location tracking.

Definition at line 432 of file Core.cpp.

References llvm::BasicBlock::IsNewDbgInfoFormat, and unwrap().

◆ LLVMModuleCreateWithName()

LLVMModuleRef LLVMModuleCreateWithName ( const char * ModuleID )

Create a new, empty module in the global context.

This is equivalent to calling LLVMModuleCreateWithNameInContext with LLVMGetGlobalContext() as the context parameter.

Every invocation should be paired with LLVMDisposeModule() or memory will be leaked.

Definition at line 274 of file Core.cpp.

References getGlobalContext(), and llvm::wrap().

◆ LLVMModuleCreateWithNameInContext()

LLVMModuleRef LLVMModuleCreateWithNameInContext	(	const char *	ModuleID,
		LLVMContextRef	C
	)

Create a new, empty module in a specific context.

Every invocation should be paired with LLVMDisposeModule() or memory will be leaked.

Definition at line 278 of file Core.cpp.

References llvm::CallingConv::C, unwrap(), and llvm::wrap().

◆ LLVMModuleFlagEntriesGetFlagBehavior()

LLVMModuleFlagBehavior LLVMModuleFlagEntriesGetFlagBehavior	(	LLVMModuleFlagEntry *	Entries,
		unsigned	Index
	)

Returns the flag behavior for a module flag entry at a specific index.

See also: Module::ModuleFlagEntry::Behavior

Definition at line 398 of file Core.cpp.

References LLVMOpaqueModuleFlagEntry::Behavior.

◆ LLVMModuleFlagEntriesGetKey()

const char * LLVMModuleFlagEntriesGetKey	(	LLVMModuleFlagEntry *	Entries,
		unsigned	Index,
		size_t *	Len
	)

Returns the key for a module flag entry at a specific index.

See also: Module::ModuleFlagEntry::Key

Definition at line 405 of file Core.cpp.

References LLVMOpaqueModuleFlagEntry::Key, and LLVMOpaqueModuleFlagEntry::KeyLen.

◆ LLVMModuleFlagEntriesGetMetadata()

LLVMMetadataRef LLVMModuleFlagEntriesGetMetadata	(	LLVMModuleFlagEntry *	Entries,
		unsigned	Index
	)

Returns the metadata for a module flag entry at a specific index.

See also: Module::ModuleFlagEntry::Val

Definition at line 413 of file Core.cpp.

References LLVMOpaqueModuleFlagEntry::Metadata.

◆ LLVMPrintModuleToFile()

LLVMBool LLVMPrintModuleToFile	(	LLVMModuleRef	M,
		const char *	Filename,
		char **	ErrorMessage
	)

Print a representation of a module to a file.

The ErrorMessage needs to be disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise.

See also: Module::print()

Definition at line 447 of file Core.cpp.

References llvm::raw_fd_ostream::close(), llvm::raw_fd_ostream::error(), llvm::raw_fd_ostream::has_error(), llvm::sys::fs::OF_TextWithCRLF, llvm::BasicBlock::print(), and unwrap().

◆ LLVMPrintModuleToString()

char * LLVMPrintModuleToString ( LLVMModuleRef M )

Return a string representation of the module.

Use LLVMDisposeMessage to free the string.

See also: Module::print()

Definition at line 469 of file Core.cpp.

References llvm::raw_ostream::flush(), llvm::BasicBlock::print(), and unwrap().

◆ LLVMSetDataLayout()

void LLVMSetDataLayout	(	LLVMModuleRef	M,
		const char *	DataLayoutStr
	)

Set the data layout for a module.

See also: Module::setDataLayout()

Definition at line 316 of file Core.cpp.

References unwrap().

◆ LLVMSetIsNewDbgInfoFormat()

void LLVMSetIsNewDbgInfoFormat	(	LLVMModuleRef	M,
		LLVMBool	UseNewFormat
	)

Soon to be deprecated.

See https://llvm.org/docs/RemoveDIsDebugInfo.html#c-api-changes

Convert module into desired debug info format.

Definition at line 436 of file Core.cpp.

References llvm::BasicBlock::setIsNewDbgInfoFormat(), and unwrap().

◆ LLVMSetModuleIdentifier()

void LLVMSetModuleIdentifier	(	LLVMModuleRef	M,
		const char *	Ident,
		size_t	Len
	)

Set the identifier of a module to a string Ident with length Len.

Parameters

M	The module to set identifier
Ident	The string to set M's identifier to
Len	Length of Ident

See also: Module::setModuleIdentifier()

Definition at line 293 of file Core.cpp.

References unwrap().

◆ LLVMSetModuleInlineAsm()

void LLVMSetModuleInlineAsm	(	LLVMModuleRef	M,
		const char *	Asm
	)

Deprecated: Use LLVMSetModuleInlineAsm2 instead.

Definition at line 484 of file Core.cpp.

References unwrap().

◆ LLVMSetModuleInlineAsm2()

void LLVMSetModuleInlineAsm2	(	LLVMModuleRef	M,
		const char *	Asm,
		size_t	Len
	)

Set inline assembly for a module.

See also: Module::setModuleInlineAsm()

Definition at line 480 of file Core.cpp.

References unwrap().

◆ LLVMSetSourceFileName()

void LLVMSetSourceFileName	(	LLVMModuleRef	M,
		const char *	Name,
		size_t	Len
	)

Set the original source file name of a module to a string Name with length Len.

Parameters

M	The module to set the source file name of
Name	The string to set M's source file name to
Len	Length of Name

See also: Module::setSourceFileName()

Definition at line 303 of file Core.cpp.

References Name, and unwrap().

◆ LLVMSetTarget()

void LLVMSetTarget	(	LLVMModuleRef	M,
		const char *	Triple
	)

Set the target triple for a module.

See also: Module::setTargetTriple()

Definition at line 325 of file Core.cpp.

References unwrap().

Functions

Detailed Description

Function Documentation

◆ LLVMAddFunction()

◆ LLVMAddModuleFlag()

◆ LLVMAddNamedMetadataOperand()

◆ LLVMAppendModuleInlineAsm()

◆ LLVMCloneModule()

◆ LLVMCopyModuleFlagsMetadata()

◆ LLVMDisposeModule()

◆ LLVMDisposeModuleFlagsMetadata()

◆ LLVMDumpModule()

◆ LLVMGetDataLayout()

◆ LLVMGetDataLayoutStr()

◆ LLVMGetDebugLocColumn()

◆ LLVMGetDebugLocDirectory()

◆ LLVMGetDebugLocFilename()

◆ LLVMGetDebugLocLine()

◆ LLVMGetFirstFunction()

◆ LLVMGetFirstNamedMetadata()

◆ LLVMGetInlineAsm()

◆ LLVMGetInlineAsmAsmString()

◆ LLVMGetInlineAsmCanUnwind()

◆ LLVMGetInlineAsmConstraintString()

◆ LLVMGetInlineAsmDialect()

◆ LLVMGetInlineAsmFunctionType()

◆ LLVMGetInlineAsmHasSideEffects()

◆ LLVMGetInlineAsmNeedsAlignedStack()

◆ LLVMGetLastFunction()

◆ LLVMGetLastNamedMetadata()

◆ LLVMGetModuleContext()

◆ LLVMGetModuleFlag()

◆ LLVMGetModuleIdentifier()

◆ LLVMGetModuleInlineAsm()

◆ LLVMGetNamedFunction()

◆ LLVMGetNamedFunctionWithLength()

◆ LLVMGetNamedMetadata()

◆ LLVMGetNamedMetadataName()

◆ LLVMGetNamedMetadataNumOperands()

◆ LLVMGetNamedMetadataOperands()

◆ LLVMGetNextFunction()

◆ LLVMGetNextNamedMetadata()

◆ LLVMGetOrInsertNamedMetadata()

◆ LLVMGetPreviousFunction()

◆ LLVMGetPreviousNamedMetadata()

◆ LLVMGetSourceFileName()

◆ LLVMGetTarget()

◆ LLVMGetTypeByName()

◆ LLVMIsNewDbgInfoFormat()

◆ LLVMModuleCreateWithName()

◆ LLVMModuleCreateWithNameInContext()

◆ LLVMModuleFlagEntriesGetFlagBehavior()

◆ LLVMModuleFlagEntriesGetKey()

◆ LLVMModuleFlagEntriesGetMetadata()

◆ LLVMPrintModuleToFile()

◆ LLVMPrintModuleToString()

◆ LLVMSetDataLayout()

◆ LLVMSetIsNewDbgInfoFormat()

◆ LLVMSetModuleIdentifier()

◆ LLVMSetModuleInlineAsm()

◆ LLVMSetModuleInlineAsm2()

◆ LLVMSetSourceFileName()

◆ LLVMSetTarget()