Utility base class for transforming operations into binary objects, by default it returns the serialized LLVM bitcode for the module. More...

#include "mlir/Target/LLVM/ModuleToObject.h"

Inheritance diagram for mlir::LLVM::ModuleToObject:

Public Member Functions
	ModuleToObject (Operation &module, StringRef triple, StringRef chip, StringRef features={}, int optLevel=3, function_ref< void(llvm::Module &)> initialLlvmIRCallback={}, function_ref< void(llvm::Module &)> linkedLlvmIRCallback={}, function_ref< void(llvm::Module &)> optimizedLlvmIRCallback={}, function_ref< void(StringRef)> isaCallback={})

virtual	~ModuleToObject ()

Operation &	getOperation ()
	Returns the operation being serialized. More...

virtual std::optional< SmallVector< char, 0 > >	run ()
	Runs the serialization pipeline, returning `std::nullopt` on error. More...

Protected Member Functions
virtual void	setDataLayoutAndTriple (llvm::Module &module)
	Hook for computing the Datalayout. More...

virtual std::optional< SmallVector< std::unique_ptr< llvm::Module > > >	loadBitcodeFiles (llvm::Module &module)
	Hook for loading bitcode files, returns std::nullopt on failure. More...

virtual LogicalResult	handleBitcodeFile (llvm::Module &module)
	Hook for performing additional actions on a loaded bitcode file. More...

virtual void	handleModulePreLink (llvm::Module &module)
	Hook for performing additional actions on the llvmModule pre linking. More...

virtual void	handleModulePostLink (llvm::Module &module)
	Hook for performing additional actions on the llvmModule post linking. More...

virtual std::optional< SmallVector< char, 0 > >	moduleToObject (llvm::Module &llvmModule)
	Serializes the LLVM IR bitcode to an object file, by default it serializes to LLVM bitcode. More...

std::optional< llvm::TargetMachine * >	getOrCreateTargetMachine ()
	Create the target machine based on the target triple and chip. More...

std::unique_ptr< llvm::Module >	loadBitcodeFile (llvm::LLVMContext &context, StringRef path)
	Loads a bitcode file from path. More...

LogicalResult	loadBitcodeFilesFromList (llvm::LLVMContext &context, ArrayRef< Attribute > librariesToLink, SmallVector< std::unique_ptr< llvm::Module >> &llvmModules, bool failureOnError=true)
	Loads multiple bitcode files. More...

std::unique_ptr< llvm::Module >	translateToLLVMIR (llvm::LLVMContext &llvmContext)
	Translates the operation to LLVM IR. More...

LogicalResult	linkFiles (llvm::Module &module, SmallVector< std::unique_ptr< llvm::Module >> &&libs)
	Link the llvmModule to other bitcode file. More...

virtual LogicalResult	optimizeModule (llvm::Module &module, int optL)
	Optimize the module. More...

Static Protected Member Functions
static std::optional< std::string >	translateToISA (llvm::Module &llvmModule, llvm::TargetMachine &targetMachine)
	Utility function for translating to ISA, returns `std::nullopt` on failure. More...

Protected Attributes
Operation &	module
	Module to transform to a binary object. More...

StringRef	triple
	Target triple. More...

StringRef	chip
	Target chip. More...

StringRef	features
	Target features. More...

int	optLevel
	Optimization level. More...

function_ref< void(llvm::Module &)>	initialLlvmIRCallback
	Callback invoked with the initial LLVM IR for the device module. More...

function_ref< void(llvm::Module &)>	linkedLlvmIRCallback
	Callback invoked with LLVM IR for the device module after linking the device libraries. More...

function_ref< void(llvm::Module &)>	optimizedLlvmIRCallback
	Callback invoked with LLVM IR for the device module after LLVM optimizations but before codegen. More...

function_ref< void(StringRef)>	isaCallback
	Callback invoked with the target ISA for the device, for example PTX assembly. More...

Detailed Description

Utility base class for transforming operations into binary objects, by default it returns the serialized LLVM bitcode for the module.

The operations being transformed must be translatable into LLVM IR.

Definition at line 30 of file ModuleToObject.h.

Constructor & Destructor Documentation

◆ ModuleToObject()

ModuleToObject::ModuleToObject	(	Operation &	module,
		StringRef	triple,
		StringRef	chip,
		StringRef	features = `{}`,
		int	optLevel = `3`,
		function_ref< void(llvm::Module &)>	initialLlvmIRCallback = `{}`,
		function_ref< void(llvm::Module &)>	linkedLlvmIRCallback = `{}`,
		function_ref< void(llvm::Module &)>	optimizedLlvmIRCallback = `{}`,
		function_ref< void(StringRef)>	isaCallback = `{}`
	)

Definition at line 40 of file ModuleToObject.cpp.

◆ ~ModuleToObject()

ModuleToObject::~ModuleToObject ( )

virtualdefault

Member Function Documentation

◆ getOperation()

Operation & ModuleToObject::getOperation ( )

Returns the operation being serialized.

Definition at line 54 of file ModuleToObject.cpp.

References module.

Referenced by mlir::NVVM::SerializeGPUModuleBase::appendStandardLibs(), mlir::ROCDL::SerializeGPUModuleBase::appendStandardLibs(), mlir::ROCDL::SerializeGPUModuleBase::assembleIsa(), mlir::ROCDL::SerializeGPUModuleBase::compileToBinary(), getOrCreateTargetMachine(), loadBitcodeFile(), loadBitcodeFilesFromList(), mlir::ROCDL::SerializeGPUModuleBase::moduleToObjectImpl(), optimizeModule(), run(), and translateToLLVMIR().

◆ getOrCreateTargetMachine()

std::optional< llvm::TargetMachine * > ModuleToObject::getOrCreateTargetMachine ( )

protected

Create the target machine based on the target triple and chip.

This can fail if the target is not available.

Definition at line 57 of file ModuleToObject.cpp.

References chip, mlir::Operation::emitError(), features, getOperation(), and triple.

Referenced by mlir::ROCDL::SerializeGPUModuleBase::moduleToObjectImpl(), optimizeModule(), and setDataLayoutAndTriple().

◆ handleBitcodeFile()

virtual LogicalResult mlir::LLVM::ModuleToObject::handleBitcodeFile ( llvm::Module & module )

inlineprotectedvirtual

Hook for performing additional actions on a loaded bitcode file.

Reimplemented in mlir::ROCDL::SerializeGPUModuleBase.

Definition at line 60 of file ModuleToObject.h.

Referenced by loadBitcodeFile(), and loadBitcodeFilesFromList().

◆ handleModulePostLink()

virtual void mlir::LLVM::ModuleToObject::handleModulePostLink ( llvm::Module & module )

inlineprotectedvirtual

Hook for performing additional actions on the llvmModule post linking.

Definition at line 68 of file ModuleToObject.h.

Referenced by run().

◆ handleModulePreLink()

virtual void mlir::LLVM::ModuleToObject::handleModulePreLink ( llvm::Module & module )

inlineprotectedvirtual

Hook for performing additional actions on the llvmModule pre linking.

Reimplemented in mlir::ROCDL::SerializeGPUModuleBase.

Definition at line 65 of file ModuleToObject.h.

Referenced by run().

◆ linkFiles()

LogicalResult ModuleToObject::linkFiles	(	llvm::Module &	module,
		SmallVector< std::unique_ptr< llvm::Module >> &&	libs
	)

protected

Link the llvmModule to other bitcode file.

Definition at line 152 of file ModuleToObject.cpp.

References module.

Referenced by run().

◆ loadBitcodeFile()

std::unique_ptr< llvm::Module > ModuleToObject::loadBitcodeFile	(	llvm::LLVMContext &	context,
		StringRef	path
	)

protected

Loads a bitcode file from path.

Definition at line 79 of file ModuleToObject.cpp.

References mlir::Operation::emitError(), getOperation(), and handleBitcodeFile().

Referenced by loadBitcodeFilesFromList().

◆ loadBitcodeFiles()

virtual std::optional<SmallVector<std::unique_ptr<llvm::Module> > > mlir::LLVM::ModuleToObject::loadBitcodeFiles ( llvm::Module & module )

inlineprotectedvirtual

Hook for loading bitcode files, returns std::nullopt on failure.

Reimplemented in mlir::ROCDL::SerializeGPUModuleBase, and mlir::NVVM::SerializeGPUModuleBase.

Definition at line 55 of file ModuleToObject.h.

Referenced by run().

◆ loadBitcodeFilesFromList()

LogicalResult ModuleToObject::loadBitcodeFilesFromList	(	llvm::LLVMContext &	context,
		ArrayRef< Attribute >	librariesToLink,
		SmallVector< std::unique_ptr< llvm::Module >> &	llvmModules,
		bool	failureOnError = `true`
	)

protected

Loads multiple bitcode files.

Definition at line 94 of file ModuleToObject.cpp.

References mlir::Operation::emitError(), getOperation(), handleBitcodeFile(), and loadBitcodeFile().

Referenced by mlir::NVVM::SerializeGPUModuleBase::loadBitcodeFiles(), and mlir::ROCDL::SerializeGPUModuleBase::loadBitcodeFiles().

◆ moduleToObject()

std::optional< SmallVector< char, 0 > > ModuleToObject::moduleToObject ( llvm::Module & llvmModule )

protectedvirtual

Serializes the LLVM IR bitcode to an object file, by default it serializes to LLVM bitcode.

Definition at line 241 of file ModuleToObject.cpp.

Referenced by mlir::ROCDL::SerializeGPUModuleBase::moduleToObjectImpl(), and run().

◆ optimizeModule()

LogicalResult ModuleToObject::optimizeModule	(	llvm::Module &	module,
		int	optL
	)

protectedvirtual

Optimize the module.

Definition at line 181 of file ModuleToObject.cpp.

References mlir::Operation::emitError(), getOperation(), getOrCreateTargetMachine(), mlir::makeOptimizingTransformer(), module, optLevel, and triple.

Referenced by run().

◆ run()

std::optional< SmallVector< char, 0 > > ModuleToObject::run ( )

virtual

Runs the serialization pipeline, returning std::nullopt on error.

Definition at line 249 of file ModuleToObject.cpp.

References mlir::Operation::emitError(), getOperation(), handleModulePostLink(), handleModulePreLink(), initialLlvmIRCallback, linkedLlvmIRCallback, linkFiles(), loadBitcodeFiles(), moduleToObject(), optimizedLlvmIRCallback, optimizeModule(), optLevel, setDataLayoutAndTriple(), and translateToLLVMIR().

◆ setDataLayoutAndTriple()

void ModuleToObject::setDataLayoutAndTriple ( llvm::Module & module )

protectedvirtual

Hook for computing the Datalayout.

Definition at line 229 of file ModuleToObject.cpp.

References getOrCreateTargetMachine(), and module.

Referenced by mlir::ROCDL::SerializeGPUModuleBase::handleBitcodeFile(), and run().

◆ translateToISA()

std::optional< std::string > ModuleToObject::translateToISA	(	llvm::Module &	llvmModule,
		llvm::TargetMachine &	targetMachine
	)

staticprotected

Utility function for translating to ISA, returns std::nullopt on failure.

Definition at line 211 of file ModuleToObject.cpp.

Referenced by mlir::ROCDL::SerializeGPUModuleBase::moduleToObjectImpl().

◆ translateToLLVMIR()

std::unique_ptr< llvm::Module > ModuleToObject::translateToLLVMIR ( llvm::LLVMContext & llvmContext )

protected

Translates the operation to LLVM IR.

Definition at line 147 of file ModuleToObject.cpp.

References getOperation(), and mlir::translateModuleToLLVMIR().

Referenced by run().

Member Data Documentation

◆ chip

StringRef mlir::LLVM::ModuleToObject::chip

protected

Target chip.

Definition at line 114 of file ModuleToObject.h.

Referenced by mlir::ROCDL::SerializeGPUModuleBase::addControlVariables(), mlir::ROCDL::SerializeGPUModuleBase::assembleIsa(), and getOrCreateTargetMachine().

◆ features

StringRef mlir::LLVM::ModuleToObject::features

protected

Target features.

Definition at line 117 of file ModuleToObject.h.

Referenced by mlir::ROCDL::SerializeGPUModuleBase::assembleIsa(), and getOrCreateTargetMachine().

◆ initialLlvmIRCallback

function_ref<void(llvm::Module &)> mlir::LLVM::ModuleToObject::initialLlvmIRCallback

protected

Callback invoked with the initial LLVM IR for the device module.

Definition at line 123 of file ModuleToObject.h.

Referenced by run().

◆ isaCallback

function_ref<void(StringRef)> mlir::LLVM::ModuleToObject::isaCallback

protected

Callback invoked with the target ISA for the device, for example PTX assembly.

Definition at line 135 of file ModuleToObject.h.

◆ linkedLlvmIRCallback

function_ref<void(llvm::Module &)> mlir::LLVM::ModuleToObject::linkedLlvmIRCallback

protected

Callback invoked with LLVM IR for the device module after linking the device libraries.

Definition at line 127 of file ModuleToObject.h.

Referenced by run().

◆ module

Operation& mlir::LLVM::ModuleToObject::module

protected

Module to transform to a binary object.

Definition at line 108 of file ModuleToObject.h.

Referenced by mlir::ROCDL::SerializeGPUModuleBase::addControlVariables(), getOperation(), mlir::ROCDL::SerializeGPUModuleBase::handleBitcodeFile(), mlir::ROCDL::SerializeGPUModuleBase::handleModulePreLink(), linkFiles(), mlir::NVVM::SerializeGPUModuleBase::loadBitcodeFiles(), mlir::ROCDL::SerializeGPUModuleBase::loadBitcodeFiles(), optimizeModule(), and setDataLayoutAndTriple().

◆ optimizedLlvmIRCallback

function_ref<void(llvm::Module &)> mlir::LLVM::ModuleToObject::optimizedLlvmIRCallback

protected

Callback invoked with LLVM IR for the device module after LLVM optimizations but before codegen.

Definition at line 131 of file ModuleToObject.h.

Referenced by run().

◆ optLevel

int mlir::LLVM::ModuleToObject::optLevel

protected

Optimization level.

Definition at line 120 of file ModuleToObject.h.

Referenced by optimizeModule(), and run().

◆ triple

StringRef mlir::LLVM::ModuleToObject::triple

protected

Target triple.

Definition at line 111 of file ModuleToObject.h.

Referenced by mlir::ROCDL::SerializeGPUModuleBase::assembleIsa(), getOrCreateTargetMachine(), mlir::ROCDL::SerializeGPUModuleBase::moduleToObjectImpl(), and optimizeModule().

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

include/mlir/Target/LLVM/ModuleToObject.h
lib/Target/LLVM/ModuleToObject.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ModuleToObject()

◆ ~ModuleToObject()

Member Function Documentation

◆ getOperation()

◆ getOrCreateTargetMachine()

◆ handleBitcodeFile()

◆ handleModulePostLink()

◆ handleModulePreLink()

◆ linkFiles()

◆ loadBitcodeFile()

◆ loadBitcodeFiles()

◆ loadBitcodeFilesFromList()

◆ moduleToObject()

◆ optimizeModule()

◆ run()

◆ setDataLayoutAndTriple()

◆ translateToISA()

◆ translateToLLVMIR()

Member Data Documentation

◆ chip

◆ features

◆ initialLlvmIRCallback

◆ isaCallback

◆ linkedLlvmIRCallback

◆ module

◆ optimizedLlvmIRCallback

◆ optLevel

◆ triple