Bindings for MLIR symbol tables. More...

#include "Bindings/Python/IRModule.h"

Public Member Functions
	PySymbolTable (PyOperationBase &operation)
	Constructs a symbol table for the given operation.
	~PySymbolTable ()
	Destroys the symbol table.
nanobind::object	dunderGetItem (const std::string &name)
	Returns the symbol (opview) with the given name, throws if there is no such symbol in the table.
void	erase (PyOperationBase &symbol)
	Removes the given operation from the symbol table and erases it.
void	dunderDel (const std::string &name)
	Removes the operation with the given name from the symbol table and erases it, throws if there is no such symbol in the table.
PyStringAttribute	insert (PyOperationBase &symbol)
	Inserts the given operation into the symbol table.
	operator MlirSymbolTable ()
	Casts the bindings class into the C API structure.

Static Public Member Functions
static PyStringAttribute	getSymbolName (PyOperationBase &symbol)
	Gets and sets the name of a symbol op.
static void	setSymbolName (PyOperationBase &symbol, const std::string &name)
static PyStringAttribute	getVisibility (PyOperationBase &symbol)
	Gets and sets the visibility of a symbol op.
static void	setVisibility (PyOperationBase &symbol, const std::string &visibility)
static void	replaceAllSymbolUses (const std::string &oldSymbol, const std::string &newSymbol, PyOperationBase &from)
	Replaces all symbol uses within an operation.
static void	walkSymbolTables (PyOperationBase &from, bool allSymUsesVisible, nanobind::object callback)
	Walks all symbol tables under and including 'from'.

Detailed Description

Bindings for MLIR symbol tables.

Definition at line 1266 of file IRModule.h.

Constructor & Destructor Documentation

◆ PySymbolTable()

PySymbolTable::PySymbolTable ( PyOperationBase & operation )

explicit

Constructs a symbol table for the given operation.

Definition at line 2166 of file IRCore.cpp.

References mlirSymbolTableCreate(), and mlirSymbolTableIsNull().

◆ ~PySymbolTable()

mlir::python::PySymbolTable::~PySymbolTable ( )

inline

Destroys the symbol table.

Definition at line 1272 of file IRModule.h.

References mlirSymbolTableDestroy().

Member Function Documentation

◆ dunderDel()

void PySymbolTable::dunderDel ( const std::string & name )

Removes the operation with the given name from the symbol table and erases it, throws if there is no such symbol in the table.

Definition at line 2197 of file IRCore.cpp.

References dunderGetItem(), and erase().

◆ dunderGetItem()

nb::object PySymbolTable::dunderGetItem ( const std::string & name )

Returns the symbol (opview) with the given name, throws if there is no such symbol in the table.

Definition at line 2174 of file IRCore.cpp.

References mlir::python::PyOperation::createOpView(), mlir::python::PyOperation::forOperation(), mlirStringRefCreate(), and mlirSymbolTableLookup().

Referenced by dunderDel().

◆ erase()

void PySymbolTable::erase ( PyOperationBase & symbol )

Removes the given operation from the symbol table and erases it.

Definition at line 2187 of file IRCore.cpp.

References mlir::python::PyOperation::checkValid(), mlir::python::PyOperation::get(), mlir::python::PyOperationBase::getOperation(), and mlirSymbolTableErase().

Referenced by dunderDel().

◆ getSymbolName()

PyStringAttribute PySymbolTable::getSymbolName ( PyOperationBase & symbol )

static

Gets and sets the name of a symbol op.

Definition at line 2214 of file IRCore.cpp.

References mlir::python::PyOperation::checkValid(), mlir::python::BaseContextObject::getContext(), mlir::python::PyOperationBase::getOperation(), mlirOperationGetAttributeByName(), and mlirSymbolTableGetSymbolAttributeName().

◆ getVisibility()

PyStringAttribute PySymbolTable::getVisibility ( PyOperationBase & symbol )

static

Gets and sets the visibility of a symbol op.

Definition at line 2242 of file IRCore.cpp.

References mlir::python::PyOperation::checkValid(), mlir::python::BaseContextObject::getContext(), mlir::python::PyOperationBase::getOperation(), mlirOperationGetAttributeByName(), and mlirSymbolTableGetVisibilityAttributeName().

◆ insert()

PyStringAttribute PySymbolTable::insert ( PyOperationBase & symbol )

Inserts the given operation into the symbol table.

The operation must have the symbol trait.

Definition at line 2202 of file IRCore.cpp.

References mlir::python::PyOperation::checkValid(), mlir::python::PyOperation::get(), mlir::python::BaseContextObject::getContext(), mlir::python::PyOperationBase::getOperation(), mlirOperationGetAttributeByName(), mlirSymbolTableGetSymbolAttributeName(), and mlirSymbolTableInsert().

◆ operator MlirSymbolTable()

mlir::python::PySymbolTable::operator MlirSymbolTable ( )

inline

Casts the bindings class into the C API structure.

Definition at line 1309 of file IRModule.h.

◆ replaceAllSymbolUses()

void PySymbolTable::replaceAllSymbolUses	(	const std::string &	oldSymbol,
		const std::string &	newSymbol,
		PyOperationBase &	from )

static

Replaces all symbol uses within an operation.

See the API mlirSymbolTableReplaceAllSymbolUses for all caveats.

Definition at line 2271 of file IRCore.cpp.

References mlir::python::PyOperation::checkValid(), mlir::python::PyOperationBase::getOperation(), mlirLogicalResultIsFailure(), mlirSymbolTableReplaceAllSymbolUses(), and toMlirStringRef().

◆ setSymbolName()

void PySymbolTable::setSymbolName	(	PyOperationBase &	symbol,
		const std::string &	name )

static

Definition at line 2227 of file IRCore.cpp.

References mlir::python::PyOperation::checkValid(), mlir::python::PyOperationBase::getOperation(), mlirOperationGetAttributeByName(), mlirOperationSetAttributeByName(), mlirStringAttrGet(), mlirSymbolTableGetSymbolAttributeName(), and toMlirStringRef().

◆ setVisibility()

void PySymbolTable::setVisibility	(	PyOperationBase &	symbol,
		const std::string &	visibility )

static

Definition at line 2253 of file IRCore.cpp.

References mlir::python::PyOperation::checkValid(), mlir::python::PyOperationBase::getOperation(), mlirOperationGetAttributeByName(), mlirOperationSetAttributeByName(), mlirStringAttrGet(), mlirSymbolTableGetVisibilityAttributeName(), and toMlirStringRef().

◆ walkSymbolTables()

void PySymbolTable::walkSymbolTables	(	PyOperationBase &	from,
		bool	allSymUsesVisible,
		nanobind::object	callback )

static

Walks all symbol tables under and including 'from'.

Definition at line 2283 of file IRCore.cpp.

References mlir::python::PyOperation::checkValid(), mlir::python::PyOperation::get(), mlir::python::BaseContextObject::getContext(), mlir::python::PyOperationBase::getOperation(), and mlirSymbolTableWalkSymbolTables().

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

lib/Bindings/Python/IRModule.h
lib/Bindings/Python/IRCore.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PySymbolTable()

◆ ~PySymbolTable()

Member Function Documentation

◆ dunderDel()

◆ dunderGetItem()

◆ erase()

◆ getSymbolName()

◆ getVisibility()

◆ insert()

◆ operator MlirSymbolTable()

◆ replaceAllSymbolUses()

◆ setSymbolName()

◆ setVisibility()

◆ walkSymbolTables()