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...

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	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...

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 std::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 std::optional< UseRange >	getSymbolUses (Region *from)

static std::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 std::optional< UseRange >	getSymbolUses (Operation symbol, Operation from)

static std::optional< UseRange >	getSymbolUses (StringAttr symbol, Region *from)

static std::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)

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

enum mlir::SymbolTable::Visibility

strong

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 73 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::Region::front(), mlir::Operation::getContext(), getNameIfSymbol(), 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().

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

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

Referenced by collectSymbolScopes(), declareReduction(), mlir::spirv::getPushConstantValue(), lookupNearestSymbolFrom(), mlir::SymbolTableCollection::lookupNearestSymbolFrom(), and mlir::spirv::lookupTargetEnv().

◆ getOp()

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

inline

Returns the associated operation.

Definition at line 62 of file SymbolTable.h.

Referenced by mlir::SymbolTableAnalysis::getTopLevelOp().

◆ getSymbolAttrName()

static StringRef mlir::SymbolTable::getSymbolAttrName ( )

inlinestatic

Return the name of the attribute used for symbol names.

Definition at line 59 of file SymbolTable.h.

Referenced by collectValidReferencesFor(), filterFuncAttributes(), getNameIfSymbol(), lookupSymbolIn(), lowerAsEntryFunction(), mlir::GPUFuncOpLowering::matchAndRewrite(), mlirSymbolTableGetSymbolAttributeName(), printIR(), setSymbolName(), SymbolTable(), mlir::detail::verifySymbol(), and mlir::detail::verifySymbolTable().

◆ 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 222 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 705 of file SymbolTable.cpp.

References getSymbolUsesImpl().

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

◆ getSymbolUses() [2/6]

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

static

Definition at line 738 of file SymbolTable.cpp.

References getSymbolUsesImpl().

◆ getSymbolUses() [3/6]

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

static

Definition at line 746 of file SymbolTable.cpp.

References getSymbolUsesImpl().

◆ getSymbolUses() [4/6]

auto SymbolTable::getSymbolUses ( Region * from )

static

Definition at line 708 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 734 of file SymbolTable.cpp.

References getSymbolUsesImpl().

◆ getSymbolUses() [6/6]

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

static

Definition at line 742 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 234 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 65 of file SymbolTable.h.

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

◆ 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(), getSymbolName(), and setSymbolName().

Referenced by createAsyncDispatchFunction(), createDecl(), createParallelComputeFunction(), mlir::bufferization::getGlobalFor(), 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::Operation::getContext().

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

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

References getNearestSymbolTable(), and lookupSymbolIn().

Referenced by mlir::LLVM::detail::LoopAnnotationTranslation::getAccessGroup(), mlir::LLVM::ModuleTranslation::getAliasScope(), getCalledFunction(), mlir::bufferization::func_ext::getCalledFunction(), lookupNearestSymbolFrom(), verifyLoopAnnotationAttr(), and verifySymbolRefs().

◆ lookupNearestSymbolFrom() [2/4]

template<typename T >

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

inlinestatic

Definition at line 139 of file SymbolTable.h.

References lookupNearestSymbolFrom().

◆ lookupNearestSymbolFrom() [3/4]

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

static

Definition at line 390 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 143 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 315 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 compileAndExecuteSingleReturnFunction(), compileAndExecuteVoidFunction(), lookupNearestSymbolFrom(), mlir::OpTrait::SymbolTable< ConcreteType >::lookupSymbol(), lookupSymbolIn(), renameSymbol(), and updateSymbolAndAllUses().

◆ lookupSymbolIn() [2/4]

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

inlinestatic

Definition at line 121 of file SymbolTable.h.

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

◆ lookupSymbolIn() [3/4]

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

static

Definition at line 330 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 374 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.

References getNameIfSymbol(), and mlir::Operation::getParentOp().

Referenced by erase().

◆ replaceAllSymbolUses() [1/4]

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

static

Definition at line 851 of file SymbolTable.cpp.

References replaceAllSymbolUsesImpl().

◆ replaceAllSymbolUses() [2/4]

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

static

Definition at line 861 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 846 of file SymbolTable.cpp.

References replaceAllSymbolUsesImpl().

Referenced by mlir::spirv::combine(), mlir::encodeBindAttribute(), encodeKernelName(), mlirSymbolTableReplaceAllSymbolUses(), mlir::SymbolUserMap::replaceAllUsesWith(), and updateSymbolAndAllUses().

◆ replaceAllSymbolUses() [4/4]

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

static

Definition at line 856 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 229 of file SymbolTable.cpp.

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

Referenced by mlir::encodeBindAttribute(), encodeKernelName(), insert(), setSymbolName(), and updateSymbolAndAllUses().

◆ setSymbolName() [2/2]

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

inlinestatic

Definition at line 95 of file SymbolTable.h.

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

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

References symbolKnownUseEmptyImpl().

◆ symbolKnownUseEmpty() [2/4]

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

static

Definition at line 782 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 773 of file SymbolTable.cpp.

References symbolKnownUseEmptyImpl().

◆ symbolKnownUseEmpty() [4/4]

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

static

Definition at line 779 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 287 of file SymbolTable.cpp.

References mlir::Operation::getRegions(), and mlir::Operation::hasTrait().

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

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

include/mlir/IR/SymbolTable.h
lib/IR/SymbolTable.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Visibility

Constructor & Destructor Documentation

◆ SymbolTable()

Member Function Documentation

◆ erase()

◆ getNearestSymbolTable()

◆ getOp()

◆ getSymbolAttrName()

◆ getSymbolName()

◆ getSymbolUses() [1/6]

◆ getSymbolUses() [2/6]

◆ getSymbolUses() [3/6]

◆ getSymbolUses() [4/6]

◆ getSymbolUses() [5/6]

◆ getSymbolUses() [6/6]

◆ getSymbolVisibility()

◆ getVisibilityAttrName()

◆ insert()

◆ lookup() [1/4]

◆ lookup() [2/4]

◆ lookup() [3/4]

◆ lookup() [4/4]

◆ lookupNearestSymbolFrom() [1/4]

◆ lookupNearestSymbolFrom() [2/4]

◆ lookupNearestSymbolFrom() [3/4]

◆ lookupNearestSymbolFrom() [4/4]

◆ lookupSymbolIn() [1/4]

◆ lookupSymbolIn() [2/4]

◆ lookupSymbolIn() [3/4]

◆ lookupSymbolIn() [4/4]

◆ remove()

◆ replaceAllSymbolUses() [1/4]

◆ replaceAllSymbolUses() [2/4]

◆ replaceAllSymbolUses() [3/4]

◆ replaceAllSymbolUses() [4/4]

◆ setSymbolName() [1/2]

◆ setSymbolName() [2/2]

◆ setSymbolVisibility()

◆ symbolKnownUseEmpty() [1/4]

◆ symbolKnownUseEmpty() [2/4]

◆ symbolKnownUseEmpty() [3/4]

◆ symbolKnownUseEmpty() [4/4]

◆ walkSymbolTables()