MLIR
15.0.0git
|
This class allows for representing and managing the symbol table used by operations with the 'SymbolTable' trait. More...
#include "mlir/IR/SymbolTable.h"
Classes | |
class | SymbolUse |
This class represents a specific symbol use. More... | |
class | UseRange |
This class implements a range of SymbolRef uses. More... | |
Public Types | |
enum | Visibility { Visibility::Public, Visibility::Private, Visibility::Nested } |
An enumeration detailing the different visibility types that a symbol may have. More... | |
Public Member Functions | |
SymbolTable (Operation *symbolTableOp) | |
Build a symbol table with the symbols within the given operation. More... | |
Operation * | lookup (StringRef name) const |
Look up a symbol with the specified name, returning null if no such name exists. More... | |
template<typename T > | |
T | lookup (StringRef name) const |
Operation * | lookup (StringAttr name) const |
Look up a symbol with the specified name, returning null if no such name exists. More... | |
template<typename T > | |
T | lookup (StringAttr name) const |
void | erase (Operation *symbol) |
Erase the given symbol from the table. More... | |
StringAttr | insert (Operation *symbol, Block::iterator insertPt={}) |
Insert a new symbol into the table, and rename it as necessary to avoid collisions. More... | |
Operation * | getOp () const |
Returns the associated operation. More... | |
Static Public Member Functions | |
static StringRef | getSymbolAttrName () |
Return the name of the attribute used for symbol names. More... | |
static StringRef | getVisibilityAttrName () |
Return the name of the attribute used for symbol visibility. More... | |
static StringAttr | getSymbolName (Operation *symbol) |
Returns the name of the given symbol operation, aborting if no symbol is present. More... | |
static void | setSymbolName (Operation *symbol, StringAttr name) |
Sets the name of the given symbol operation. More... | |
static void | setSymbolName (Operation *symbol, StringRef name) |
static Visibility | getSymbolVisibility (Operation *symbol) |
Returns the visibility of the given symbol operation. More... | |
static void | setSymbolVisibility (Operation *symbol, Visibility vis) |
Sets the visibility of the given symbol operation. More... | |
static Operation * | getNearestSymbolTable (Operation *from) |
Returns the nearest symbol table from a given operation from . More... | |
static void | walkSymbolTables (Operation *op, bool allSymUsesVisible, function_ref< void(Operation *, bool)> callback) |
Walks all symbol table operations nested within, and including, op . More... | |
static Operation * | lookupSymbolIn (Operation *op, StringAttr symbol) |
Returns the operation registered with the given symbol name with the regions of 'symbolTableOp'. More... | |
static Operation * | lookupSymbolIn (Operation *op, StringRef symbol) |
static Operation * | lookupSymbolIn (Operation *op, SymbolRefAttr symbol) |
static LogicalResult | lookupSymbolIn (Operation *op, SymbolRefAttr symbol, SmallVectorImpl< Operation *> &symbols) |
A variant of 'lookupSymbolIn' that returns all of the symbols referenced by a given SymbolRefAttr. More... | |
static Operation * | lookupNearestSymbolFrom (Operation *from, StringAttr symbol) |
Returns the operation registered with the given symbol name within the closest parent operation of, or including, 'from' with the 'OpTrait::SymbolTable' trait. More... | |
static Operation * | lookupNearestSymbolFrom (Operation *from, SymbolRefAttr symbol) |
template<typename T > | |
static T | lookupNearestSymbolFrom (Operation *from, StringAttr symbol) |
template<typename T > | |
static T | lookupNearestSymbolFrom (Operation *from, SymbolRefAttr symbol) |
static Optional< UseRange > | getSymbolUses (Operation *from) |
Get an iterator range for all of the uses, for any symbol, that are nested within the given operation 'from'. More... | |
static Optional< UseRange > | getSymbolUses (Region *from) |
static Optional< UseRange > | getSymbolUses (StringAttr symbol, Operation *from) |
Get all of the uses of the given symbol that are nested within the given operation 'from'. More... | |
static Optional< UseRange > | getSymbolUses (Operation *symbol, Operation *from) |
static Optional< UseRange > | getSymbolUses (StringAttr symbol, Region *from) |
static Optional< UseRange > | getSymbolUses (Operation *symbol, Region *from) |
static bool | symbolKnownUseEmpty (StringAttr symbol, Operation *from) |
Return if the given symbol is known to have no uses that are nested within the given operation 'from'. More... | |
static bool | symbolKnownUseEmpty (Operation *symbol, Operation *from) |
static bool | symbolKnownUseEmpty (StringAttr symbol, Region *from) |
static bool | symbolKnownUseEmpty (Operation *symbol, Region *from) |
static LogicalResult | replaceAllSymbolUses (StringAttr oldSymbol, StringAttr newSymbol, Operation *from) |
Attempt to replace all uses of the given symbol 'oldSymbol' with the provided symbol 'newSymbol' that are nested within the given operation 'from'. More... | |
static LogicalResult | replaceAllSymbolUses (Operation *oldSymbol, StringAttr newSymbolName, Operation *from) |
static LogicalResult | replaceAllSymbolUses (StringAttr oldSymbol, StringAttr newSymbol, Region *from) |
static LogicalResult | replaceAllSymbolUses (Operation *oldSymbol, StringAttr newSymbolName, Region *from) |
This class allows for representing and managing the symbol table used by operations with the 'SymbolTable' trait.
Inserting into and erasing from this SymbolTable will also insert and erase from the Operation given to it at construction.
Definition at line 23 of file SymbolTable.h.
|
strong |
An enumeration detailing the different visibility types that a symbol may have.
Definition at line 69 of file SymbolTable.h.
SymbolTable::SymbolTable | ( | Operation * | symbolTableOp | ) |
Build a symbol table with the symbols within the given operation.
Definition at line 105 of file SymbolTable.cpp.
References mlir::Region::front(), mlir::Operation::getContext(), getNameIfSymbol(), mlir::Operation::getNumRegions(), mlir::Operation::getRegion(), getSymbolAttrName(), and mlir::Operation::hasTrait().
Erase the given symbol from the table.
Definition at line 138 of file SymbolTable.cpp.
References mlir::Operation::erase(), getNameIfSymbol(), and mlir::Operation::getParentOp().
Referenced by lookup().
Returns the nearest symbol table from a given operation from
.
Returns nullptr if no valid parent symbol table could be found.
Definition at line 252 of file SymbolTable.cpp.
References mlir::Operation::getParentOp(), mlir::Operation::hasTrait(), and isPotentiallyUnknownSymbolTable().
Referenced by castBoolToIntN(), collectSymbolScopes(), declareReduction(), getOrInsertBuiltinVariable(), mlir::spirv::getPushConstantValue(), lookupNearestSymbolFrom(), mlir::SymbolTableCollection::lookupNearestSymbolFrom(), mlir::spirv::lookupTargetEnv(), and setSymbolName().
|
inline |
Returns the associated operation.
Definition at line 58 of file SymbolTable.h.
|
inlinestatic |
Return the name of the attribute used for symbol names.
Definition at line 55 of file SymbolTable.h.
Referenced by buildLLVMFunctionType(), collectValidReferencesFor(), computeHash(), filterFuncAttributes(), findDuplicateElement(), getNameIfSymbol(), hasOneBranchOpTo(), isZeroAttribute(), lookupSymbolIn(), lookupSymbolInModule(), lowerAsEntryFunction(), mlir::GPUFuncOpLowering::matchAndRewrite(), mlirSymbolTableGetSymbolAttributeName(), parseAttributions(), mlir::function_interface_impl::parseFunctionOp(), mlir::function_interface_impl::printFunctionAttributes(), mlir::function_interface_impl::printFunctionOp(), printIR(), printLaunchFuncOperands(), setSymbolName(), mlir::SPIRVTypeConverter::SPIRVTypeConverter(), SymbolTable(), verifyAttributions(), verifyConstantType(), verifyCoopMatrixMulAdd(), mlir::detail::verifySymbol(), mlir::detail::verifySymbolTable(), and visitInPrettyBlockOrder().
|
static |
Returns the name of the given symbol operation, aborting if no symbol is present.
Returns the name of the given symbol operation.
Definition at line 207 of file SymbolTable.cpp.
References getNameIfSymbol().
Referenced by collectSymbolScopes(), and insert().
|
static |
Get an iterator range for all of the uses, for any symbol, that are nested within the given operation 'from'.
This does not traverse into any nested symbol tables. This function returns None if there are any unknown operations that may potentially be symbol tables.
This does not traverse into any nested symbol tables, and will also only return uses on 'from' if it does not also define a symbol table. This is because we treat the region as the boundary of the symbol table, and not the op itself. This function returns None if there are any unknown operations that may potentially be symbol tables.
Definition at line 741 of file SymbolTable.cpp.
References getSymbolUsesImpl().
Referenced by convertToLaunchFuncOp(), mlir::SymbolTable::UseRange::empty(), mlir::SymbolUserMap::SymbolUserMap(), and walkReferencedSymbolNodes().
|
static |
Definition at line 744 of file SymbolTable.cpp.
References getSymbolUsesImpl().
|
static |
Get all of the uses of the given symbol that are nested within the given operation 'from'.
Get all of the uses of the given symbol that are nested within the given operation 'from', invoking the provided callback for each.
This does not traverse into any nested symbol tables. This function returns None if there are any unknown operations that may potentially be symbol tables.
Definition at line 770 of file SymbolTable.cpp.
References getSymbolUsesImpl().
Definition at line 774 of file SymbolTable.cpp.
References getSymbolUsesImpl().
|
static |
Definition at line 778 of file SymbolTable.cpp.
References getSymbolUsesImpl().
Definition at line 782 of file SymbolTable.cpp.
References getSymbolUsesImpl().
|
static |
Returns the visibility of the given symbol operation.
Definition at line 219 of file SymbolTable.cpp.
References mlir::Operation::getAttrOfType(), getVisibilityAttrName(), Nested, Private, and Public.
Referenced by setSymbolName().
|
inlinestatic |
Return the name of the attribute used for symbol visibility.
Definition at line 61 of file SymbolTable.h.
Referenced by getSymbolVisibility(), mlirSymbolTableGetVisibilityAttributeName(), mlir::function_interface_impl::parseFunctionOp(), mlir::impl::parseOptionalVisibilityKeyword(), mlir::function_interface_impl::printFunctionOp(), setSymbolVisibility(), and mlir::detail::verifySymbol().
StringAttr SymbolTable::insert | ( | Operation * | symbol, |
Block::iterator | insertPt = {} |
||
) |
Insert a new symbol into the table, and rename it as necessary to avoid collisions.
Insert a new symbol into the table and associated operation if not already there and rename it as necessary to avoid collisions.
Also insert at the specified location in the body of the associated operation if it is not already there. It is asserted that the symbol is not inside another operation. Return the name of the symbol after insertion as attribute.
Return the name of the symbol after insertion as attribute.
Definition at line 156 of file SymbolTable.cpp.
References mlir::Region::front(), mlir::Operation::getContext(), mlir::Operation::getParentOp(), mlir::Operation::getRegion(), getSymbolName(), and setSymbolName().
Referenced by convertToLaunchFuncOp(), createAsyncDispatchFunction(), createDecl(), createParallelComputeFunction(), lookup(), and outlineExecuteOp().
Operation * SymbolTable::lookup | ( | StringRef | name | ) | const |
Look up a symbol with the specified name, returning null if no such name exists.
Names never include the @ on them.
Definition at line 130 of file SymbolTable.cpp.
References mlir::Operation::getContext().
Referenced by convertToLaunchFuncOp(), hasOneBranchOpTo(), and lookup().
|
inline |
Definition at line 32 of file SymbolTable.h.
References lookup().
Operation * SymbolTable::lookup | ( | StringAttr | name | ) | const |
Look up a symbol with the specified name, returning null if no such name exists.
Names never include the @ on them.
Definition at line 133 of file SymbolTable.cpp.
|
inline |
Definition at line 40 of file SymbolTable.h.
Returns the operation registered with the given symbol name within the closest parent operation of, or including, 'from' with the 'OpTrait::SymbolTable' trait.
Returns the operation registered with the given symbol name within the closes parent operation with the 'OpTrait::SymbolTable' trait.
Returns nullptr if no valid symbol was found.
Definition at line 370 of file SymbolTable.cpp.
References getNearestSymbolTable(), and lookupSymbolIn().
Referenced by mlir::LLVM::ModuleTranslation::getAccessGroup(), mlir::LLVM::ModuleTranslation::getAliasScope(), mlir::bufferization::func_ext::getCalledFunction(), getCalledFunction(), getLoadStoreElementType(), hasOneBranchOpTo(), lookupNearestSymbolFrom(), mlir::SymbolTableCollection::lookupNearestSymbolFrom(), lookupSymbolIn(), mlir::SymbolTableCollection::lookupSymbolIn(), mlir::OpToFuncCallLowering< SourceOp >::matchAndRewrite(), mlir::LLVM::ModuleTranslation::setAccessGroupsMetadata(), verifyAccessChain(), verifyConstantType(), verifyCoopMatrixMulAdd(), and verifySymbolAttribute().
Definition at line 375 of file SymbolTable.cpp.
References getNearestSymbolTable(), and lookupSymbolIn().
|
inlinestatic |
Definition at line 135 of file SymbolTable.h.
References lookupNearestSymbolFrom().
|
inlinestatic |
Definition at line 139 of file SymbolTable.h.
References lookupNearestSymbolFrom().
Returns the operation registered with the given symbol name with the regions of 'symbolTableOp'.
'symbolTableOp' is required to be an operation with the 'OpTrait::SymbolTable' trait.
'symbolTableOp' is required to be an operation with the 'OpTrait::SymbolTable' trait. Returns nullptr if no valid symbol was found.
Definition at line 300 of file SymbolTable.cpp.
References mlir::Region::empty(), mlir::Region::front(), mlir::Operation::getContext(), getNameIfSymbol(), mlir::Operation::getRegion(), getSymbolAttrName(), and mlir::Operation::hasTrait().
Referenced by eachHasOnlyOneOfTypes(), hasSameBitwidthScalarType(), lookupNearestSymbolFrom(), mlir::SymbolTableCollection::lookupNearestSymbolFrom(), mlir::OpTrait::SymbolTable< ConcreteType >::lookupSymbol(), lookupSymbolIn(), mlir::SymbolTableCollection::lookupSymbolIn(), lookupSymbolInModule(), ConvertAddressOf::matchAndRewrite(), ConvertAccessChain::matchAndRewrite(), renameSymbol(), setSymbolName(), updateSymbolAndAllUses(), and verifyMemoryOpIndexing().
|
inlinestatic |
Definition at line 117 of file SymbolTable.h.
References mlir::Operation::getContext(), lookupNearestSymbolFrom(), and lookupSymbolIn().
Definition at line 315 of file SymbolTable.cpp.
References mlir::failed(), and lookupSymbolIn().
|
static |
A variant of 'lookupSymbolIn' that returns all of the symbols referenced by a given SymbolRefAttr.
Returns failure if any of the nested references could not be resolved.
Definition at line 359 of file SymbolTable.cpp.
References lookupSymbolIn(), and lookupSymbolInImpl().
|
static |
Attempt to replace all uses of the given symbol 'oldSymbol' with the provided symbol 'newSymbol' that are nested within the given operation 'from'.
This does not traverse into any nested symbol tables. If there are any unknown operations that may potentially be symbol tables, no uses are replaced and failure is returned.
Definition at line 962 of file SymbolTable.cpp.
References replaceAllSymbolUsesImpl().
Referenced by mlir::spirv::combine(), mlir::SymbolTable::UseRange::empty(), mlir::encodeBindAttribute(), encodeKernelName(), mlirSymbolTableReplaceAllSymbolUses(), mlir::SymbolUserMap::replaceAllUsesWith(), and updateSymbolAndAllUses().
|
static |
Definition at line 967 of file SymbolTable.cpp.
References replaceAllSymbolUsesImpl().
|
static |
Definition at line 972 of file SymbolTable.cpp.
References replaceAllSymbolUsesImpl().
|
static |
Definition at line 977 of file SymbolTable.cpp.
References replaceAllSymbolUsesImpl().
Sets the name of the given symbol operation.
Definition at line 214 of file SymbolTable.cpp.
References getSymbolAttrName(), and mlir::Operation::setAttr().
Referenced by mlir::encodeBindAttribute(), encodeKernelName(), insert(), setSymbolName(), and updateSymbolAndAllUses().
Definition at line 91 of file SymbolTable.h.
References mlir::Operation::getContext(), getNearestSymbolTable(), getSymbolVisibility(), lookupSymbolIn(), setSymbolName(), setSymbolVisibility(), and walkSymbolTables().
|
static |
Sets the visibility of the given symbol operation.
Definition at line 232 of file SymbolTable.cpp.
References mlir::Operation::getContext(), getVisibilityAttrName(), Nested, Private, Public, mlir::Operation::removeAttr(), and mlir::Operation::setAttr().
Referenced by outlineExecuteOp(), and setSymbolName().
|
static |
Return if the given symbol is known to have no uses that are nested within the given operation 'from'.
This does not traverse into any nested symbol tables. This function will also return false if there are any unknown operations that may potentially be symbol tables. This doesn't necessarily mean that there are no uses, we just can't conservatively prove it.
This does not traverse into any nested symbol tables. This function will also return false if there are any unknown operations that may potentially be symbol tables.
Definition at line 809 of file SymbolTable.cpp.
References symbolKnownUseEmptyImpl().
Referenced by mlir::SymbolTable::UseRange::empty().
Definition at line 812 of file SymbolTable.cpp.
References symbolKnownUseEmptyImpl().
|
static |
Definition at line 815 of file SymbolTable.cpp.
References symbolKnownUseEmptyImpl().
Definition at line 818 of file SymbolTable.cpp.
References symbolKnownUseEmptyImpl().
|
static |
Walks all symbol table operations nested within, and including, op
.
For each symbol table operation, the provided callback is invoked with the op and a boolean signifying if the symbols within that symbol table can be treated as if all uses within the IR are visible to the caller. allSymUsesVisible
identifies whether all of the symbol uses of symbols within op
are visible.
For each symbol table operation, the provided callback is invoked with the op and a boolean signifying if the symbols within that symbol table can be treated as if all uses are visible. allSymUsesVisible
identifies whether all of the symbol uses of symbols within op
are visible.
Definition at line 272 of file SymbolTable.cpp.
References mlir::Operation::getRegions(), and mlir::Operation::hasTrait().
Referenced by mlirSymbolTableWalkSymbolTables(), setSymbolName(), and mlir::SymbolUserMap::SymbolUserMap().