MLIR  19.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mlir::gpu::TargetOptions Class Reference

This class serves as an opaque interface for passing options to the TargetAttrInterface methods. More...

#include "mlir/Dialect/GPU/IR/CompilationInterfaces.h"

Public Member Functions

 TargetOptions (StringRef toolkitPath={}, ArrayRef< std::string > linkFiles={}, StringRef cmdOptions={}, CompilationTarget compilationTarget=getDefaultCompilationTarget(), function_ref< SymbolTable *()> getSymbolTableCallback={})
 Constructor initializing the toolkit path, the list of files to link to, extra command line options, the compilation target and a callback for obtaining the parent symbol table. More...
 
TypeID getTypeID () const
 Returns the typeID. More...
 
StringRef getToolkitPath () const
 Returns the toolkit path. More...
 
ArrayRef< std::string > getLinkFiles () const
 Returns the files to link to. More...
 
StringRef getCmdOptions () const
 Returns the command line options. More...
 
std::pair< llvm::BumpPtrAllocator, SmallVector< const char * > > tokenizeCmdOptions () const
 Returns a tokenization of the command line options. More...
 
CompilationTarget getCompilationTarget () const
 Returns the compilation target. More...
 
SymbolTablegetSymbolTable () const
 Returns the result of the getSymbolTableCallback callback or a nullptr if no callback was provided. More...
 

Static Public Member Functions

static CompilationTarget getDefaultCompilationTarget ()
 Returns the default compilation target: CompilationTarget::Fatbin. More...
 

Protected Member Functions

 TargetOptions (TypeID typeID, StringRef toolkitPath={}, ArrayRef< std::string > linkFiles={}, StringRef cmdOptions={}, CompilationTarget compilationTarget=getDefaultCompilationTarget(), function_ref< SymbolTable *()> getSymbolTableCallback={})
 Derived classes must use this constructor to initialize typeID to the appropiate value: ie. More...
 

Protected Attributes

std::string toolkitPath
 Path to the target toolkit. More...
 
SmallVector< std::string > linkFiles
 List of files to link with the LLVM module. More...
 
std::string cmdOptions
 An optional set of command line options to be used by the compilation process. More...
 
CompilationTarget compilationTarget
 Compilation process target format. More...
 
function_ref< SymbolTable *()> getSymbolTableCallback
 Callback for obtaining the parent symbol table of all the GPU modules being serialized. More...
 

Detailed Description

This class serves as an opaque interface for passing options to the TargetAttrInterface methods.

Users of this class must implement the classof method as well as using the macros MLIR_*_EXPLICIT_TYPE_ID to ensure type safeness. Targets are free to ignore these options.

Definition at line 45 of file CompilationInterfaces.h.

Constructor & Destructor Documentation

◆ TargetOptions() [1/2]

TargetOptions::TargetOptions ( StringRef  toolkitPath = {},
ArrayRef< std::string >  linkFiles = {},
StringRef  cmdOptions = {},
CompilationTarget  compilationTarget = getDefaultCompilationTarget(),
function_ref< SymbolTable *()>  getSymbolTableCallback = {} 
)

Constructor initializing the toolkit path, the list of files to link to, extra command line options, the compilation target and a callback for obtaining the parent symbol table.

The default compilation target is Fatbin.

Definition at line 2241 of file GPUDialect.cpp.

◆ TargetOptions() [2/2]

TargetOptions::TargetOptions ( TypeID  typeID,
StringRef  toolkitPath = {},
ArrayRef< std::string >  linkFiles = {},
StringRef  cmdOptions = {},
CompilationTarget  compilationTarget = getDefaultCompilationTarget(),
function_ref< SymbolTable *()>  getSymbolTableCallback = {} 
)
protected

Derived classes must use this constructor to initialize typeID to the appropiate value: ie.

TargetOptions(TypeID::get<DerivedClass>()).

Definition at line 2248 of file GPUDialect.cpp.

Member Function Documentation

◆ getCmdOptions()

StringRef TargetOptions::getCmdOptions ( ) const

Returns the command line options.

Definition at line 2262 of file GPUDialect.cpp.

◆ getCompilationTarget()

CompilationTarget TargetOptions::getCompilationTarget ( ) const

Returns the compilation target.

Definition at line 2268 of file GPUDialect.cpp.

◆ getDefaultCompilationTarget()

CompilationTarget TargetOptions::getDefaultCompilationTarget ( )
static

Returns the default compilation target: CompilationTarget::Fatbin.

Definition at line 2272 of file GPUDialect.cpp.

◆ getLinkFiles()

ArrayRef< std::string > TargetOptions::getLinkFiles ( ) const

Returns the files to link to.

Definition at line 2260 of file GPUDialect.cpp.

◆ getSymbolTable()

SymbolTable * TargetOptions::getSymbolTable ( ) const

Returns the result of the getSymbolTableCallback callback or a nullptr if no callback was provided.

Note: The callback itself can return nullptr. It is up to the target how to react to getting a nullptr, e.g., emitting an error or constructing the table.

Definition at line 2264 of file GPUDialect.cpp.

◆ getToolkitPath()

StringRef TargetOptions::getToolkitPath ( ) const

Returns the toolkit path.

Definition at line 2258 of file GPUDialect.cpp.

◆ getTypeID()

TypeID TargetOptions::getTypeID ( ) const

Returns the typeID.

Definition at line 2256 of file GPUDialect.cpp.

◆ tokenizeCmdOptions()

std::pair< llvm::BumpPtrAllocator, SmallVector< const char * > > TargetOptions::tokenizeCmdOptions ( ) const

Returns a tokenization of the command line options.

Definition at line 2277 of file GPUDialect.cpp.

Member Data Documentation

◆ cmdOptions

std::string mlir::gpu::TargetOptions::cmdOptions
protected

An optional set of command line options to be used by the compilation process.

Definition at line 103 of file CompilationInterfaces.h.

◆ compilationTarget

CompilationTarget mlir::gpu::TargetOptions::compilationTarget
protected

Compilation process target format.

Definition at line 106 of file CompilationInterfaces.h.

◆ getSymbolTableCallback

function_ref<SymbolTable *()> mlir::gpu::TargetOptions::getSymbolTableCallback
protected

Callback for obtaining the parent symbol table of all the GPU modules being serialized.

Definition at line 110 of file CompilationInterfaces.h.

◆ linkFiles

SmallVector<std::string> mlir::gpu::TargetOptions::linkFiles
protected

List of files to link with the LLVM module.

Definition at line 99 of file CompilationInterfaces.h.

◆ toolkitPath

std::string mlir::gpu::TargetOptions::toolkitPath
protected

Path to the target toolkit.

Definition at line 96 of file CompilationInterfaces.h.


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