MLIR  19.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
mlir::SymbolTable Class Reference

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 class  Visibility { Public , Private , 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...
 
Operationlookup (StringRef name) const
 Look up a symbol with the specified name, returning null if no such name exists. More...
 
template<typename T >
lookup (StringRef name) const
 
Operationlookup (StringAttr name) const
 Look up a symbol with the specified name, returning null if no such name exists. More...
 
template<typename T >
lookup (StringAttr name) const
 
void remove (Operation *op)
 Remove the given symbol from the table, without deleting it. More...
 
void erase (Operation *symbol)
 Erase the given symbol from the table and delete the operation. More...
 
StringAttr insert (Operation *symbol, Block::iterator insertPt={})
 Insert a new symbol into the table, and rename it as necessary to avoid collisions. More...
 
LogicalResult rename (StringAttr from, StringAttr to)
 Renames the given op or the op refered to by the given name to the given new name and updates the symbol table and all usages of the symbol accordingly. More...
 
LogicalResult rename (Operation *op, StringAttr to)
 
LogicalResult rename (StringAttr from, StringRef to)
 
LogicalResult rename (Operation *op, StringRef to)
 
FailureOr< StringAttr > renameToUnique (StringAttr from, ArrayRef< SymbolTable * > others)
 Renames the given op or the op refered to by the given name to the a name that is unique within this and the provided other symbol tables and updates the symbol table and all usages of the symbol accordingly. More...
 
FailureOr< StringAttr > renameToUnique (Operation *op, ArrayRef< SymbolTable * > others)
 
OperationgetOp () 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...
 
template<unsigned N, typename UniqueChecker >
static SmallString< N > generateSymbolName (StringRef name, UniqueChecker uniqueChecker, unsigned &uniquingCounter)
 Generate a unique symbol name. 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 OperationgetNearestSymbolTable (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 OperationlookupSymbolIn (Operation *op, StringAttr symbol)
 Returns the operation registered with the given symbol name with the regions of 'symbolTableOp'. More...
 
static OperationlookupSymbolIn (Operation *op, StringRef symbol)
 
static OperationlookupSymbolIn (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 OperationlookupNearestSymbolFrom (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 OperationlookupNearestSymbolFrom (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 std::optional< UseRangegetSymbolUses (Operation *from)
 Get an iterator range for all of the uses, for any symbol, that are nested within the given operation 'from'. More...
 
static std::optional< UseRangegetSymbolUses (Region *from)
 
static std::optional< UseRangegetSymbolUses (StringAttr symbol, Operation *from)
 Get all of the uses of the given symbol that are nested within the given operation 'from'. More...
 
static std::optional< UseRangegetSymbolUses (Operation *symbol, Operation *from)
 
static std::optional< UseRangegetSymbolUses (StringAttr symbol, Region *from)
 
static std::optional< UseRangegetSymbolUses (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)
 

Detailed Description

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 24 of file SymbolTable.h.

Member Enumeration Documentation

◆ Visibility

An enumeration detailing the different visibility types that a symbol may have.

Enumerator
Public 

The symbol is public and may be referenced anywhere internal or external to the visible references in the IR.

Private 

The symbol is private and may only be referenced by SymbolRefAttrs local to the operations within the current symbol table.

Nested 

The symbol is visible to the current IR, which may include operations in symbol tables above the one that owns the current symbol.

Nested visibility allows for referencing a symbol outside of its current symbol table, while retaining the ability to observe all uses.

Definition at line 90 of file SymbolTable.h.

Constructor & Destructor Documentation

◆ SymbolTable()

SymbolTable::SymbolTable ( Operation symbolTableOp)

Build a symbol table with the symbols within the given operation.

Definition at line 118 of file SymbolTable.cpp.

References mlir::get(), mlir::Operation::getContext(), mlir::Operation::getNumRegions(), mlir::Operation::getRegion(), getSymbolAttrName(), and mlir::Operation::hasTrait().

Member Function Documentation

◆ erase()

void SymbolTable::erase ( Operation symbol)

Erase the given symbol from the table and delete the operation.

Definition at line 162 of file SymbolTable.cpp.

References mlir::Operation::erase(), and remove().

◆ generateSymbolName()

template<unsigned N, typename UniqueChecker >
static SmallString<N> mlir::SymbolTable::generateSymbolName ( StringRef  name,
UniqueChecker  uniqueChecker,
unsigned &  uniquingCounter 
)
inlinestatic

Generate a unique symbol name.

Iteratively increase uniquingCounter and use it as a suffix for symbol names until uniqueChecker does not detect any conflict.

Definition at line 110 of file SymbolTable.h.

◆ getNearestSymbolTable()

Operation * SymbolTable::getNearestSymbolTable ( Operation from)
static

Returns the nearest symbol table from a given operation from.

Returns nullptr if no valid parent symbol table could be found.

Definition at line 337 of file SymbolTable.cpp.

References mlir::Operation::getParentOp(), mlir::Operation::hasTrait(), and isPotentiallyUnknownSymbolTable().

Referenced by mlir::transform::applyTransformNamedSequence(), collectSymbolScopes(), declareReduction(), lookupNearestSymbolFrom(), and mlir::SymbolTableCollection::lookupNearestSymbolFrom().

◆ getOp()

Operation* mlir::SymbolTable::getOp ( ) const
inline

Returns the associated operation.

Definition at line 79 of file SymbolTable.h.

Referenced by mlir::SymbolTableAnalysis::getTopLevelOp(), and rename().

◆ getSymbolAttrName()

static StringRef mlir::SymbolTable::getSymbolAttrName ( )
inlinestatic

◆ getSymbolName()

StringAttr SymbolTable::getSymbolName ( Operation symbol)
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 292 of file SymbolTable.cpp.

References getNameIfSymbol().

Referenced by collectSymbolScopes(), and insert().

◆ getSymbolUses() [1/6]

auto SymbolTable::getSymbolUses ( Operation from)
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 std::nullopt 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 std::nullopt if there are any unknown operations that may potentially be symbol tables.

Definition at line 783 of file SymbolTable.cpp.

References getSymbolUsesImpl().

Referenced by mlir::SymbolUserMap::SymbolUserMap().

◆ getSymbolUses() [2/6]

auto SymbolTable::getSymbolUses ( Operation symbol,
Operation from 
)
static

Definition at line 816 of file SymbolTable.cpp.

References getSymbolUsesImpl().

◆ getSymbolUses() [3/6]

auto SymbolTable::getSymbolUses ( Operation symbol,
Region from 
)
static

Definition at line 824 of file SymbolTable.cpp.

References getSymbolUsesImpl().

◆ getSymbolUses() [4/6]

auto SymbolTable::getSymbolUses ( Region from)
static

Definition at line 786 of file SymbolTable.cpp.

References getSymbolUsesImpl().

◆ getSymbolUses() [5/6]

auto SymbolTable::getSymbolUses ( StringAttr  symbol,
Operation from 
)
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 std::nullopt if there are any unknown operations that may potentially be symbol tables.

Definition at line 812 of file SymbolTable.cpp.

References getSymbolUsesImpl().

◆ getSymbolUses() [6/6]

auto SymbolTable::getSymbolUses ( StringAttr  symbol,
Region from 
)
static

Definition at line 820 of file SymbolTable.cpp.

References getSymbolUsesImpl().

◆ getSymbolVisibility()

SymbolTable::Visibility SymbolTable::getSymbolVisibility ( Operation symbol)
static

Returns the visibility of the given symbol operation.

Definition at line 304 of file SymbolTable.cpp.

References mlir::Operation::getAttrOfType(), getVisibilityAttrName(), Nested, Private, and Public.

◆ getVisibilityAttrName()

static StringRef mlir::SymbolTable::getVisibilityAttrName ( )
inlinestatic

Return the name of the attribute used for symbol visibility.

Definition at line 82 of file SymbolTable.h.

Referenced by getSymbolVisibility(), mlirSymbolTableGetVisibilityAttributeName(), mlir::impl::parseOptionalVisibilityKeyword(), and setSymbolVisibility().

◆ insert()

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 171 of file SymbolTable.cpp.

References mlir::Region::front(), mlir::Operation::getContext(), mlir::Operation::getParentOp(), mlir::Operation::getRegion(), and getSymbolName().

Referenced by mlir::bufferization::buildDeallocationLibraryFunction(), createAsyncDispatchFunction(), createDecl(), and outlineExecuteOp().

◆ lookup() [1/4]

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 146 of file SymbolTable.cpp.

◆ lookup() [2/4]

template<typename T >
T mlir::SymbolTable::lookup ( StringAttr  name) const
inline

Definition at line 41 of file SymbolTable.h.

References lookup().

◆ lookup() [3/4]

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 143 of file SymbolTable.cpp.

References mlir::get(), and mlir::Operation::getContext().

Referenced by lookup(), mlir::SymbolTableCollection::lookupSymbolIn(), and mlir::LockedSymbolTableCollection::lookupSymbolIn().

◆ lookup() [4/4]

template<typename T >
T mlir::SymbolTable::lookup ( StringRef  name) const
inline

Definition at line 33 of file SymbolTable.h.

References lookup().

◆ lookupNearestSymbolFrom() [1/4]

Operation * SymbolTable::lookupNearestSymbolFrom ( Operation from,
StringAttr  symbol 
)
static

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 455 of file SymbolTable.cpp.

References getNearestSymbolTable(), and lookupSymbolIn().

Referenced by getCalledFunction(), mlir::bufferization::func_ext::getCalledFunction(), and lookupNearestSymbolFrom().

◆ lookupNearestSymbolFrom() [2/4]

template<typename T >
static T mlir::SymbolTable::lookupNearestSymbolFrom ( Operation from,
StringAttr  symbol 
)
inlinestatic

Definition at line 174 of file SymbolTable.h.

References lookupNearestSymbolFrom().

◆ lookupNearestSymbolFrom() [3/4]

Operation * SymbolTable::lookupNearestSymbolFrom ( Operation from,
SymbolRefAttr  symbol 
)
static

Definition at line 460 of file SymbolTable.cpp.

References getNearestSymbolTable(), and lookupSymbolIn().

◆ lookupNearestSymbolFrom() [4/4]

template<typename T >
static T mlir::SymbolTable::lookupNearestSymbolFrom ( Operation from,
SymbolRefAttr  symbol 
)
inlinestatic

Definition at line 178 of file SymbolTable.h.

References lookupNearestSymbolFrom().

◆ lookupSymbolIn() [1/4]

Operation * SymbolTable::lookupSymbolIn ( Operation symbolTableOp,
StringAttr  symbol 
)
static

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 385 of file SymbolTable.cpp.

References mlir::Region::empty(), mlir::get(), mlir::Operation::getContext(), mlir::Operation::getRegion(), getSymbolAttrName(), and mlir::Operation::hasTrait().

Referenced by compileAndExecuteSingleReturnFunction(), compileAndExecuteVoidFunction(), lookupNearestSymbolFrom(), mlir::OpTrait::SymbolTable< ConcreteType >::lookupSymbol(), lookupSymbolIn(), and renameSymbol().

◆ lookupSymbolIn() [2/4]

static Operation* mlir::SymbolTable::lookupSymbolIn ( Operation op,
StringRef  symbol 
)
inlinestatic

Definition at line 156 of file SymbolTable.h.

◆ lookupSymbolIn() [3/4]

Operation * SymbolTable::lookupSymbolIn ( Operation op,
SymbolRefAttr  symbol 
)
static

Definition at line 400 of file SymbolTable.cpp.

References mlir::failed(), and lookupSymbolIn().

◆ lookupSymbolIn() [4/4]

LogicalResult SymbolTable::lookupSymbolIn ( Operation op,
SymbolRefAttr  symbol,
SmallVectorImpl< Operation * > &  symbols 
)
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 444 of file SymbolTable.cpp.

References lookupSymbolIn(), and lookupSymbolInImpl().

◆ remove()

void SymbolTable::remove ( Operation op)

Remove the given symbol from the table, without deleting it.

Definition at line 150 of file SymbolTable.cpp.

Referenced by erase().

◆ rename() [1/4]

LogicalResult SymbolTable::rename ( Operation op,
StringAttr  to 
)

Definition at line 222 of file SymbolTable.cpp.

◆ rename() [2/4]

LogicalResult SymbolTable::rename ( Operation op,
StringRef  to 
)

Definition at line 253 of file SymbolTable.cpp.

◆ rename() [3/4]

LogicalResult SymbolTable::rename ( StringAttr  from,
StringAttr  to 
)

Renames the given op or the op refered to by the given name to the given new name and updates the symbol table and all usages of the symbol accordingly.

Fails if the updating of the usages fails.

Definition at line 217 of file SymbolTable.cpp.

Referenced by rename(), and renameToUnique().

◆ rename() [4/4]

LogicalResult SymbolTable::rename ( StringAttr  from,
StringRef  to 
)

Definition at line 248 of file SymbolTable.cpp.

References mlir::get(), getContext(), getOp(), and rename().

◆ renameToUnique() [1/2]

FailureOr< StringAttr > SymbolTable::renameToUnique ( Operation op,
ArrayRef< SymbolTable * >  others 
)

Definition at line 285 of file SymbolTable.cpp.

◆ renameToUnique() [2/2]

FailureOr< StringAttr > SymbolTable::renameToUnique ( StringAttr  from,
ArrayRef< SymbolTable * >  others 
)

Renames the given op or the op refered to by the given name to the a name that is unique within this and the provided other symbol tables and updates the symbol table and all usages of the symbol accordingly.

Returns the new name or failure if the renaming fails.

Definition at line 259 of file SymbolTable.cpp.

References mlir::failed(), mlir::failure(), mlir::get(), and rename().

◆ replaceAllSymbolUses() [1/4]

LogicalResult SymbolTable::replaceAllSymbolUses ( Operation oldSymbol,
StringAttr  newSymbolName,
Operation from 
)
static

Definition at line 929 of file SymbolTable.cpp.

References replaceAllSymbolUsesImpl().

◆ replaceAllSymbolUses() [2/4]

LogicalResult SymbolTable::replaceAllSymbolUses ( Operation oldSymbol,
StringAttr  newSymbolName,
Region from 
)
static

Definition at line 939 of file SymbolTable.cpp.

References replaceAllSymbolUsesImpl().

◆ replaceAllSymbolUses() [3/4]

LogicalResult SymbolTable::replaceAllSymbolUses ( StringAttr  oldSymbol,
StringAttr  newSymbol,
Operation from 
)
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 924 of file SymbolTable.cpp.

References replaceAllSymbolUsesImpl().

Referenced by encodeKernelName(), mlirSymbolTableReplaceAllSymbolUses(), and mlir::SymbolUserMap::replaceAllUsesWith().

◆ replaceAllSymbolUses() [4/4]

LogicalResult SymbolTable::replaceAllSymbolUses ( StringAttr  oldSymbol,
StringAttr  newSymbol,
Region from 
)
static

Definition at line 934 of file SymbolTable.cpp.

References replaceAllSymbolUsesImpl().

◆ setSymbolName() [1/2]

void SymbolTable::setSymbolName ( Operation symbol,
StringAttr  name 
)
static

Sets the name of the given symbol operation.

Definition at line 299 of file SymbolTable.cpp.

References getSymbolAttrName(), and mlir::Operation::setAttr().

Referenced by encodeKernelName(), and setSymbolName().

◆ setSymbolName() [2/2]

static void mlir::SymbolTable::setSymbolName ( Operation symbol,
StringRef  name 
)
inlinestatic

Definition at line 130 of file SymbolTable.h.

References mlir::get(), mlir::Operation::getContext(), and setSymbolName().

◆ setSymbolVisibility()

void SymbolTable::setSymbolVisibility ( Operation symbol,
Visibility  vis 
)
static

Sets the visibility of the given symbol operation.

Definition at line 317 of file SymbolTable.cpp.

References mlir::get(), mlir::Operation::getContext(), getVisibilityAttrName(), Nested, Private, Public, mlir::Operation::removeAttr(), and mlir::Operation::setAttr().

Referenced by outlineExecuteOp().

◆ symbolKnownUseEmpty() [1/4]

bool SymbolTable::symbolKnownUseEmpty ( Operation symbol,
Operation from 
)
static

Definition at line 854 of file SymbolTable.cpp.

References symbolKnownUseEmptyImpl().

◆ symbolKnownUseEmpty() [2/4]

bool SymbolTable::symbolKnownUseEmpty ( Operation symbol,
Region from 
)
static

Definition at line 860 of file SymbolTable.cpp.

References symbolKnownUseEmptyImpl().

◆ symbolKnownUseEmpty() [3/4]

bool SymbolTable::symbolKnownUseEmpty ( StringAttr  symbol,
Operation from 
)
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 851 of file SymbolTable.cpp.

References symbolKnownUseEmptyImpl().

◆ symbolKnownUseEmpty() [4/4]

bool SymbolTable::symbolKnownUseEmpty ( StringAttr  symbol,
Region from 
)
static

Definition at line 857 of file SymbolTable.cpp.

References symbolKnownUseEmptyImpl().

◆ walkSymbolTables()

void SymbolTable::walkSymbolTables ( Operation op,
bool  allSymUsesVisible,
function_ref< void(Operation *, bool)>  callback 
)
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 357 of file SymbolTable.cpp.

Referenced by mlirSymbolTableWalkSymbolTables(), and mlir::SymbolUserMap::SymbolUserMap().


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