Module import implementation class that provides methods to import globals and functions from an LLVM module into an MLIR module. More...

#include "mlir/Target/LLVMIR/ModuleImport.h"

Public Member Functions
	ModuleImport (ModuleOp mlirModule, std::unique_ptr< llvm::Module > llvmModule, bool emitExpensiveWarnings, bool importEmptyDICompositeTypes)

LogicalResult	initializeImportInterface ()
	Calls the LLVMImportInterface initialization that queries the registered dialect interfaces for the supported LLVM IR intrinsics and metadata kinds and builds the dispatch tables. More...

LogicalResult	convertFunctions ()
	Converts all functions of the LLVM module to MLIR functions. More...

LogicalResult	convertComdats ()
	Converts all comdat selectors of the LLVM module to MLIR comdat operations. More...

LogicalResult	convertGlobals ()
	Converts all global variables of the LLVM module to MLIR global variables. More...

LogicalResult	convertDataLayout ()
	Converts the data layout of the LLVM module to an MLIR data layout specification. More...

void	mapValue (llvm::Value *llvm, Value mlir)
	Stores the mapping between an LLVM value and its MLIR counterpart. More...

Value &	mapValue (llvm::Value *value)
	Provides write-once access to store the MLIR value corresponding to the given LLVM value. More...

Value	lookupValue (llvm::Value *value)
	Returns the MLIR value mapped to the given LLVM value. More...

void	mapNoResultOp (llvm::Instruction llvm, Operation mlir)
	Stores a mapping between an LLVM instruction and the imported MLIR operation if the operation returns no result. More...

Operation *&	mapNoResultOp (llvm::Instruction *inst)
	Provides write-once access to store the MLIR operation corresponding to the given LLVM instruction if the operation returns no result. More...

Operation *	lookupOperation (llvm::Instruction *inst)
	Returns the MLIR operation mapped to the given LLVM instruction. More...

void	mapBlock (llvm::BasicBlock llvm, Block mlir)
	Stores the mapping between an LLVM block and its MLIR counterpart. More...

Block *	lookupBlock (llvm::BasicBlock *block) const
	Returns the MLIR block mapped to the given LLVM block. More...

FailureOr< Value >	convertValue (llvm::Value *value)
	Converts an LLVM value to an MLIR value, or returns failure if the conversion fails. More...

FailureOr< Value >	convertMetadataValue (llvm::Value *value)
	Converts an LLVM metadata value to an MLIR value, or returns failure if the conversion fails. More...

FailureOr< SmallVector< Value > >	convertValues (ArrayRef< llvm::Value * > values)
	Converts a range of LLVM values to a range of MLIR values using the `convertValue` method, or returns failure if the conversion fails. More...

IntegerAttr	matchIntegerAttr (llvm::Value *value)
	Converts `value` to an integer attribute. Asserts if the matching fails. More...

FloatAttr	matchFloatAttr (llvm::Value *value)
	Converts `value` to a float attribute. Asserts if the matching fails. More...

DILocalVariableAttr	matchLocalVariableAttr (llvm::Value *value)
	Converts `value` to a local variable attribute. More...

DILabelAttr	matchLabelAttr (llvm::Value *value)
	Converts `value` to a label attribute. Asserts if the matching fails. More...

FPExceptionBehaviorAttr	matchFPExceptionBehaviorAttr (llvm::Value *value)
	Converts `value` to a FP exception behavior attribute. More...

RoundingModeAttr	matchRoundingModeAttr (llvm::Value *value)
	Converts `value` to a rounding mode attribute. More...

FailureOr< SmallVector< AliasScopeAttr > >	matchAliasScopeAttrs (llvm::Value *value)
	Converts `value` to an array of alias scopes or returns failure if the conversion fails. More...

Location	translateLoc (llvm::DILocation *loc)
	Translates the debug location. More...

Type	convertType (llvm::Type *type)
	Converts the type from LLVM to MLIR LLVM dialect. More...

LogicalResult	processFunction (llvm::Function *func)
	Imports `func` into the current module. More...

void	processFunctionAttributes (llvm::Function *func, LLVMFuncOp funcOp)
	Converts function attributes of LLVM Function `func` into LLVM dialect attributes of LLVMFuncOp `funcOp`. More...

void	setIntegerOverflowFlags (llvm::Instruction inst, Operation op) const
	Sets the integer overflow flags (nsw/nuw) attribute for the imported operation `op` given the original instruction `inst`. More...

void	setFastmathFlagsAttr (llvm::Instruction inst, Operation op) const
	Sets the fastmath flags attribute for the imported operation `op` given the original instruction `inst`. More...

LogicalResult	convertLinkerOptionsMetadata ()
	Converts !llvm.linker.options metadata to the llvm.linker.options LLVM dialect operation. More...

LogicalResult	convertMetadata ()
	Converts all LLVM metadata nodes that translate to attributes such as alias analysis or access group metadata, and builds a map from the metadata nodes to the converted attributes. More...

Attribute	lookupTBAAAttr (const llvm::MDNode *node) const
	Returns the MLIR attribute mapped to the given LLVM TBAA metadata `node`. More...

FailureOr< SmallVector< AccessGroupAttr > >	lookupAccessGroupAttrs (const llvm::MDNode *node) const
	Returns the access group attributes that map to the access group nodes starting from the access group metadata `node`. More...

LoopAnnotationAttr	translateLoopAnnotationAttr (const llvm::MDNode *node, Location loc) const
	Returns the loop annotation attribute that corresponds to the given LLVM loop metadata `node`. More...

FailureOr< SmallVector< AliasScopeAttr > >	lookupAliasScopeAttrs (const llvm::MDNode *node) const
	Returns the alias scope attributes that map to the alias scope nodes starting from the metadata `node`. More...

void	addDebugIntrinsic (llvm::CallInst *intrinsic)
	Adds a debug intrinsics to the list of intrinsics that should be converted after the function conversion has finished. More...

LogicalResult	convertIntrinsicArguments (ArrayRef< llvm::Value * > values, ArrayRef< unsigned > immArgPositions, ArrayRef< StringLiteral > immArgAttrNames, SmallVectorImpl< Value > &valuesOut, SmallVectorImpl< NamedAttribute > &attrsOut)
	Converts the LLVM values for an intrinsic to mixed MLIR values and attributes for LLVM_IntrOpBase. More...

Detailed Description

Module import implementation class that provides methods to import globals and functions from an LLVM module into an MLIR module.

It holds mappings between the original and translated globals, basic blocks, and values used during the translation. Additionally, it keeps track of the current constant insertion point since LLVM immediate values translate to MLIR operations that are introduced at the beginning of the region.

Definition at line 47 of file ModuleImport.h.

Constructor & Destructor Documentation

◆ ModuleImport()

ModuleImport::ModuleImport	(	ModuleOp	mlirModule,
		std::unique_ptr< llvm::Module >	llvmModule,
		bool	emitExpensiveWarnings,
		bool	importEmptyDICompositeTypes
	)

Definition at line 156 of file ModuleImport.cpp.

References mlir::OpBuilder::setInsertionPointToStart().

Member Function Documentation

◆ addDebugIntrinsic()

void ModuleImport::addDebugIntrinsic ( llvm::CallInst * intrinsic )

Adds a debug intrinsics to the list of intrinsics that should be converted after the function conversion has finished.

Definition at line 494 of file ModuleImport.cpp.

◆ convertComdats()

LogicalResult ModuleImport::convertComdats ( )

Converts all comdat selectors of the LLVM module to MLIR comdat operations.

Definition at line 562 of file ModuleImport.cpp.

References mlir::success().

Referenced by mlir::translateLLVMIRToModule().

◆ convertDataLayout()

LogicalResult ModuleImport::convertDataLayout ( )

Converts the data layout of the LLVM module to an MLIR data layout specification.

Definition at line 590 of file ModuleImport.cpp.

References mlir::emitError(), mlir::emitWarning(), mlir::LLVM::detail::DataLayoutImporter::getDataLayout(), mlir::LLVM::detail::DataLayoutImporter::getLastToken(), mlir::LLVM::detail::DataLayoutImporter::getUnhandledTokens(), and mlir::success().

Referenced by mlir::translateLLVMIRToModule().

◆ convertFunctions()

LogicalResult ModuleImport::convertFunctions ( )

Converts all functions of the LLVM module to MLIR functions.

Definition at line 605 of file ModuleImport.cpp.

References mlir::failed(), mlir::failure(), processFunction(), and mlir::success().

Referenced by mlir::translateLLVMIRToModule().

◆ convertGlobals()

LogicalResult ModuleImport::convertGlobals ( )

Converts all global variables of the LLVM module to MLIR global variables.

Definition at line 572 of file ModuleImport.cpp.

References diag(), mlir::emitError(), mlir::failed(), mlir::get(), getGlobalCtorsVarName(), getGlobalDtorsVarName(), and mlir::success().

Referenced by mlir::translateLLVMIRToModule().

◆ convertIntrinsicArguments()

LogicalResult ModuleImport::convertIntrinsicArguments	(	ArrayRef< llvm::Value * >	values,
		ArrayRef< unsigned >	immArgPositions,
		ArrayRef< StringLiteral >	immArgAttrNames,
		SmallVectorImpl< Value > &	valuesOut,
		SmallVectorImpl< NamedAttribute > &	attrsOut
	)

Converts the LLVM values for an intrinsic to mixed MLIR values and attributes for LLVM_IntrOpBase.

Attributes correspond to LLVM immargs. The list immArgPositions contains the positions of immargs on the LLVM intrinsic, and immArgAttrNames list (of the same length) contains the corresponding MLIR attribute names.

Definition at line 1234 of file ModuleImport.cpp.

References convertValue(), mlir::failed(), mlir::failure(), mlir::get(), getScalarConstantAsAttr(), and mlir::success().

◆ convertLinkerOptionsMetadata()

LogicalResult ModuleImport::convertLinkerOptionsMetadata ( )

Converts !llvm.linker.options metadata to the llvm.linker.options LLVM dialect operation.

Definition at line 498 of file ModuleImport.cpp.

References mlir::OpBuilder::create(), mlir::Builder::getStrArrayAttr(), options, and mlir::success().

Referenced by convertMetadata().

◆ convertMetadata()

LogicalResult ModuleImport::convertMetadata ( )

Converts all LLVM metadata nodes that translate to attributes such as alias analysis or access group metadata, and builds a map from the metadata nodes to the converted attributes.

Returns success if all conversions succeed and failure otherwise.

Definition at line 515 of file ModuleImport.cpp.

References convertLinkerOptionsMetadata(), mlir::failed(), mlir::failure(), mlir::OpBuilder::setInsertionPointToEnd(), and mlir::success().

Referenced by mlir::translateLLVMIRToModule().

◆ convertMetadataValue()

FailureOr< Value > ModuleImport::convertMetadataValue ( llvm::Value * value )

Converts an LLVM metadata value to an MLIR value, or returns failure if the conversion fails.

Uses the convertConstant method to translate constant LLVM values.

Definition at line 1199 of file ModuleImport.cpp.

References mlir::failure().

◆ convertType()

Type mlir::LLVM::ModuleImport::convertType ( llvm::Type * type )

inline

Converts the type from LLVM to MLIR LLVM dialect.

Definition at line 172 of file ModuleImport.h.

References mlir::LLVM::TypeFromLLVMIRTranslator::translateType().

Referenced by processFunction().

◆ convertValue()

FailureOr< Value > ModuleImport::convertValue ( llvm::Value * value )

Converts an LLVM value to an MLIR value, or returns failure if the conversion fails.

Uses the convertConstant method to translate constant LLVM values.

Definition at line 1180 of file ModuleImport.cpp.

References diag(), mlir::emitError(), mlir::get(), and translateLoc().

Referenced by convertIntrinsicArguments(), convertValues(), matchFloatAttr(), and matchIntegerAttr().

◆ convertValues()

FailureOr< SmallVector< Value > > ModuleImport::convertValues ( ArrayRef< llvm::Value * > values )

Converts a range of LLVM values to a range of MLIR values using the convertValue method, or returns failure if the conversion fails.

Definition at line 1222 of file ModuleImport.cpp.

References convertValue(), mlir::failed(), and mlir::failure().

◆ initializeImportInterface()

LogicalResult mlir::LLVM::ModuleImport::initializeImportInterface ( )

inline

Calls the LLVMImportInterface initialization that queries the registered dialect interfaces for the supported LLVM IR intrinsics and metadata kinds and builds the dispatch tables.

Returns failure if multiple dialect interfaces translate the same LLVM IR intrinsic.

Definition at line 56 of file ModuleImport.h.

References mlir::LLVMImportInterface::initializeImport().

Referenced by mlir::translateLLVMIRToModule().

◆ lookupAccessGroupAttrs()

FailureOr< SmallVector< AccessGroupAttr > > ModuleImport::lookupAccessGroupAttrs ( const llvm::MDNode * node ) const

Returns the access group attributes that map to the access group nodes starting from the access group metadata node.

Returns failure, if any of the attributes cannot be found.

Definition at line 2084 of file ModuleImport.cpp.

◆ lookupAliasScopeAttrs()

FailureOr< SmallVector< AliasScopeAttr > > ModuleImport::lookupAliasScopeAttrs ( const llvm::MDNode * node ) const

Returns the alias scope attributes that map to the alias scope nodes starting from the metadata node.

Returns failure, if any of the attributes cannot be found.

Definition at line 480 of file ModuleImport.cpp.

References mlir::failure().

Referenced by matchAliasScopeAttrs().

◆ lookupBlock()

Block* mlir::LLVM::ModuleImport::lookupBlock ( llvm::BasicBlock * block ) const

inline

Returns the MLIR block mapped to the given LLVM block.

Definition at line 124 of file ModuleImport.h.

◆ lookupOperation()

Operation* mlir::LLVM::ModuleImport::lookupOperation ( llvm::Instruction * inst )

inline

Returns the MLIR operation mapped to the given LLVM instruction.

Queries valueMapping and noResultOpMapping to support operations with and without result.

Definition at line 110 of file ModuleImport.h.

References lookupValue().

◆ lookupTBAAAttr()

Attribute mlir::LLVM::ModuleImport::lookupTBAAAttr ( const llvm::MDNode * node ) const

inline

Returns the MLIR attribute mapped to the given LLVM TBAA metadata node.

Definition at line 205 of file ModuleImport.h.

◆ lookupValue()

Value mlir::LLVM::ModuleImport::lookupValue ( llvm::Value * value )

inline

Returns the MLIR value mapped to the given LLVM value.

Definition at line 85 of file ModuleImport.h.

Referenced by lookupOperation().

◆ mapBlock()

void mlir::LLVM::ModuleImport::mapBlock	(	llvm::BasicBlock *	llvm,
		Block *	mlir
	)

inline

Stores the mapping between an LLVM block and its MLIR counterpart.

Definition at line 117 of file ModuleImport.h.

◆ mapNoResultOp() [1/2]

Operation*& mlir::LLVM::ModuleImport::mapNoResultOp ( llvm::Instruction * inst )

inline

Provides write-once access to store the MLIR operation corresponding to the given LLVM instruction if the operation returns no result.

Asserts if the operation returns a result and should be added to valueMapping instead.

Definition at line 98 of file ModuleImport.h.

◆ mapNoResultOp() [2/2]

void mlir::LLVM::ModuleImport::mapNoResultOp	(	llvm::Instruction *	llvm,
		Operation *	mlir
	)

inline

Stores a mapping between an LLVM instruction and the imported MLIR operation if the operation returns no result.

Asserts if the operation returns a result and should be added to valueMapping instead.

Definition at line 90 of file ModuleImport.h.

◆ mapValue() [1/2]

void mlir::LLVM::ModuleImport::mapValue	(	llvm::Value *	llvm,
		Value	mlir
	)

inline

Stores the mapping between an LLVM value and its MLIR counterpart.

Definition at line 73 of file ModuleImport.h.

References mapValue().

Referenced by mapValue().

◆ mapValue() [2/2]

Value& mlir::LLVM::ModuleImport::mapValue ( llvm::Value * value )

inline

Provides write-once access to store the MLIR value corresponding to the given LLVM value.

Definition at line 77 of file ModuleImport.h.

◆ matchAliasScopeAttrs()

FailureOr< SmallVector< AliasScopeAttr > > ModuleImport::matchAliasScopeAttrs ( llvm::Value * value )

Converts value to an array of alias scopes or returns failure if the conversion fails.

Definition at line 1322 of file ModuleImport.cpp.

References lookupAliasScopeAttrs().

◆ matchFloatAttr()

FloatAttr ModuleImport::matchFloatAttr ( llvm::Value * value )

Converts value to a float attribute. Asserts if the matching fails.

Definition at line 1278 of file ModuleImport.cpp.

References convertValue(), mlir::m_Constant(), mlir::matchPattern(), mlir::succeeded(), and mlir::success().

◆ matchFPExceptionBehaviorAttr()

FPExceptionBehaviorAttr ModuleImport::matchFPExceptionBehaviorAttr ( llvm::Value * value )

Converts value to a FP exception behavior attribute.

Asserts if the matching fails.

Definition at line 1301 of file ModuleImport.cpp.

References mlir::Builder::getAttr().

◆ matchIntegerAttr()

IntegerAttr ModuleImport::matchIntegerAttr ( llvm::Value * value )

Converts value to an integer attribute. Asserts if the matching fails.

Definition at line 1268 of file ModuleImport.cpp.

References convertValue(), mlir::m_Constant(), mlir::matchPattern(), mlir::succeeded(), and mlir::success().

◆ matchLabelAttr()

DILabelAttr ModuleImport::matchLabelAttr ( llvm::Value * value )

Converts value to a label attribute. Asserts if the matching fails.

Definition at line 1294 of file ModuleImport.cpp.

◆ matchLocalVariableAttr()

DILocalVariableAttr ModuleImport::matchLocalVariableAttr ( llvm::Value * value )

Converts value to a local variable attribute.

Asserts if the matching fails.

Definition at line 1288 of file ModuleImport.cpp.

◆ matchRoundingModeAttr()

RoundingModeAttr ModuleImport::matchRoundingModeAttr ( llvm::Value * value )

Converts value to a rounding mode attribute.

Asserts if the matching fails.

Definition at line 1311 of file ModuleImport.cpp.

References mlir::Builder::getAttr().

◆ processFunction()

LogicalResult ModuleImport::processFunction ( llvm::Function * func )

Imports func into the current module.

Definition at line 1856 of file ModuleImport.cpp.

References convertType(), mlir::OpBuilder::create(), mlir::emitWarning(), mlir::LLVMImportInterface::isConvertibleIntrinsic(), processFunctionAttributes(), mlir::OpBuilder::setInsertionPoint(), and mlir::success().

Referenced by convertFunctions().

◆ processFunctionAttributes()

void ModuleImport::processFunctionAttributes	(	llvm::Function *	func,
		LLVMFuncOp	funcOp
	)

Converts function attributes of LLVM Function func into LLVM dialect attributes of LLVMFuncOp funcOp.

Definition at line 1743 of file ModuleImport.cpp.

References mlir::get(), processMemoryEffects(), and processPassthroughAttrs().

Referenced by processFunction().

◆ setFastmathFlagsAttr()

void ModuleImport::setFastmathFlagsAttr	(	llvm::Instruction *	inst,
		Operation *	op
	)		const

Sets the fastmath flags attribute for the imported operation op given the original instruction inst.

Asserts if the operation does not implement the fastmath interface.

Definition at line 642 of file ModuleImport.cpp.

◆ setIntegerOverflowFlags()

void ModuleImport::setIntegerOverflowFlags	(	llvm::Instruction *	inst,
		Operation *	op
	)		const

Sets the integer overflow flags (nsw/nuw) attribute for the imported operation op given the original instruction inst.

Asserts if the operation does not implement the integer overflow flag interface.

Definition at line 630 of file ModuleImport.cpp.

◆ translateLoc()

Location ModuleImport::translateLoc ( llvm::DILocation * loc )

Translates the debug location.

Definition at line 1328 of file ModuleImport.cpp.

Referenced by convertValue().

◆ translateLoopAnnotationAttr()

LoopAnnotationAttr ModuleImport::translateLoopAnnotationAttr	(	const llvm::MDNode *	node,
		Location	loc
	)		const

Returns the loop annotation attribute that corresponds to the given LLVM loop metadata node.

Definition at line 2089 of file ModuleImport.cpp.

The documentation for this class was generated from the following files:

include/mlir/Target/LLVMIR/ModuleImport.h
lib/Target/LLVMIR/ModuleImport.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ModuleImport()

Member Function Documentation

◆ addDebugIntrinsic()

◆ convertComdats()

◆ convertDataLayout()

◆ convertFunctions()

◆ convertGlobals()

◆ convertIntrinsicArguments()

◆ convertLinkerOptionsMetadata()

◆ convertMetadata()

◆ convertMetadataValue()

◆ convertType()

◆ convertValue()

◆ convertValues()

◆ initializeImportInterface()

◆ lookupAccessGroupAttrs()

◆ lookupAliasScopeAttrs()

◆ lookupBlock()

◆ lookupOperation()

◆ lookupTBAAAttr()

◆ lookupValue()

◆ mapBlock()

◆ mapNoResultOp() [1/2]

◆ mapNoResultOp() [2/2]

◆ mapValue() [1/2]

◆ mapValue() [2/2]

◆ matchAliasScopeAttrs()

◆ matchFloatAttr()

◆ matchFPExceptionBehaviorAttr()

◆ matchIntegerAttr()

◆ matchLabelAttr()

◆ matchLocalVariableAttr()

◆ matchRoundingModeAttr()

◆ processFunction()

◆ processFunctionAttributes()

◆ setFastmathFlagsAttr()

◆ setIntegerOverflowFlags()

◆ translateLoc()

◆ translateLoopAnnotationAttr()