#include "Bindings/Python/IRModule.h"

Inheritance diagram for mlir::python::PyOperation:

Public Member Functions
	~PyOperation () override

PyOperation &	getOperation () override
	Each must provide access to the raw Operation. More...

void	detachFromParent ()
	Detaches the operation from its parent block and updates its state accordingly. More...

	operator MlirOperation () const
	Gets the backing operation. More...

MlirOperation	get () const

PyOperationRef	getRef ()

bool	isAttached ()

void	setAttached (const pybind11::object &parent=pybind11::object())

void	setDetached ()

void	checkValid () const

PyBlock	getBlock ()
	Gets the owning block or raises an exception if the operation has no owning block. More...

std::optional< PyOperationRef >	getParentOperation ()
	Gets the parent operation or raises an exception if the operation has no parent. More...

pybind11::object	getCapsule ()
	Gets a capsule wrapping the void* within the MlirOperation. More...

pybind11::object	createOpView ()
	Creates an OpView suitable for this operation. More...

void	erase ()
	Erases the underlying MlirOperation, removes its pointer from the parent context's live operations map, and sets the valid bit false. More...

void	setInvalid ()
	Invalidate the operation. More...

pybind11::object	clone (const pybind11::object &ip)
	Clones this operation. More...

Public Member Functions inherited from mlir::python::PyOperationBase
virtual	~PyOperationBase ()=default

void	print (pybind11::object fileObject, bool binary, std::optional< int64_t > largeElementsLimit, bool enableDebugInfo, bool prettyDebugInfo, bool printGenericOpForm, bool useLocalScope, bool assumeVerified)
	Implements the bound 'print' method and helps with others. More...

pybind11::object	getAsm (bool binary, std::optional< int64_t > largeElementsLimit, bool enableDebugInfo, bool prettyDebugInfo, bool printGenericOpForm, bool useLocalScope, bool assumeVerified)

void	writeBytecode (const pybind11::object &fileObject, std::optional< int64_t > bytecodeVersion)

void	moveAfter (PyOperationBase &other)
	Moves the operation before or after the other operation. More...

void	moveBefore (PyOperationBase &other)

bool	verify ()
	Verify the operation. More...

Public Member Functions inherited from mlir::python::BaseContextObject
	BaseContextObject (PyMlirContextRef ref)

PyMlirContextRef &	getContext ()
	Accesses the context reference. More...

Static Public Member Functions
static PyOperationRef	forOperation (PyMlirContextRef contextRef, MlirOperation operation, pybind11::object parentKeepAlive=pybind11::object())
	Returns a PyOperation for the given MlirOperation, optionally associating it with a parentKeepAlive. More...

static PyOperationRef	createDetached (PyMlirContextRef contextRef, MlirOperation operation, pybind11::object parentKeepAlive=pybind11::object())
	Creates a detached operation. More...

static PyOperationRef	parse (PyMlirContextRef contextRef, const std::string &sourceStr, const std::string &sourceName)
	Parses a source string (either text assembly or bytecode), creating a detached operation. More...

static pybind11::object	createFromCapsule (pybind11::object capsule)
	Creates a PyOperation from the MlirOperation wrapped by a capsule. More...

static pybind11::object	create (const std::string &name, std::optional< std::vector< PyType * >> results, std::optional< std::vector< PyValue * >> operands, std::optional< pybind11::dict > attributes, std::optional< std::vector< PyBlock * >> successors, int regions, DefaultingPyLocation location, const pybind11::object &ip)
	Creates an operation. See corresponding python docstring. More...

Friends
class	PyOperationBase

class	PySymbolTable

Detailed Description

Definition at line 582 of file IRModule.h.

Constructor & Destructor Documentation

◆ ~PyOperation()

PyOperation::~PyOperation ( )

override

Definition at line 1050 of file IRCore.cpp.

References mlir::python::BaseContextObject::getContext(), isAttached(), and mlirOperationDestroy().

Member Function Documentation

◆ checkValid()

void PyOperation::checkValid ( ) const

◆ clone()

py::object PyOperation::clone ( const pybind11::object & ip )

Clones this operation.

Definition at line 1399 of file IRCore.cpp.

References createDetached(), createOpView(), mlir::python::BaseContextObject::getContext(), maybeInsertOperation(), and mlirOperationClone().

◆ create()

py::object PyOperation::create	(	const std::string &	name,
		std::optional< std::vector< PyType * >>	results,
		std::optional< std::vector< PyValue * >>	operands,
		std::optional< pybind11::dict >	attributes,
		std::optional< std::vector< PyBlock * >>	successors,
		int	regions,
		DefaultingPyLocation	location,
		const pybind11::object &	ip
	)

static

Creates an operation. See corresponding python docstring.

Definition at line 1276 of file IRCore.cpp.

References createDetached(), createOpView(), maybeInsertOperation(), mlirAttributeGetContext(), mlirIdentifierGet(), mlirNamedAttributeGet(), mlirOperationCreate(), mlirOperationStateAddAttributes(), mlirOperationStateAddOperands(), mlirOperationStateAddOwnedRegions(), mlirOperationStateAddResults(), mlirOperationStateAddSuccessors(), mlirOperationStateGet(), mlirRegionCreate(), and toMlirStringRef().

Referenced by mlir::python::PyOpView::buildGeneric().

◆ createDetached()

PyOperationRef PyOperation::createDetached	(	PyMlirContextRef	contextRef,
		MlirOperation	operation,
		pybind11::object	parentKeepAlive = `pybind11::object()`
	)

static

Creates a detached operation.

The operation must not be associated with any existing live operation.

Definition at line 1099 of file IRCore.cpp.

Referenced by clone(), and create().

◆ createFromCapsule()

py::object PyOperation::createFromCapsule ( pybind11::object capsule )

static

Creates a PyOperation from the MlirOperation wrapped by a capsule.

Ownership of the underlying MlirOperation is taken by calling this function.

Definition at line 1252 of file IRCore.cpp.

References mlir::python::PyMlirContext::forContext(), forOperation(), mlirOperationGetContext(), mlirOperationIsNull(), mlirPythonCapsuleToOperation(), and mlir::python::PyObjectRef< T >::releaseObject().

◆ createOpView()

py::object PyOperation::createOpView ( )

Creates an OpView suitable for this operation.

Definition at line 1408 of file IRCore.cpp.

References checkValid(), mlir::python::PyOpView::constructDerived(), MlirStringRef::data, mlir::python::PyGlobals::get(), get(), getRef(), MlirStringRef::length, mlir::python::PyGlobals::lookupOperationClass(), mlirIdentifierStr(), and mlirOperationGetName().

Referenced by clone(), create(), mlir::python::PySymbolTable::dunderGetItem(), and mlir::python::PyConcreteOpInterface< ConcreteIface >::getOpView().

◆ detachFromParent()

void mlir::python::PyOperation::detachFromParent ( )

inline

Detaches the operation from its parent block and updates its state accordingly.

Definition at line 607 of file IRModule.h.

References getOperation(), mlirOperationRemoveFromParent(), and setDetached().

◆ erase()

void PyOperation::erase ( )

Erases the underlying MlirOperation, removes its pointer from the parent context's live operations map, and sets the valid bit false.

Definition at line 1419 of file IRCore.cpp.

References checkValid(), mlir::python::BaseContextObject::getContext(), and mlirOperationDestroy().

◆ forOperation()

PyOperationRef PyOperation::forOperation	(	PyMlirContextRef	contextRef,
		MlirOperation	operation,
		pybind11::object	parentKeepAlive = `pybind11::object()`
	)

static

Returns a PyOperation for the given MlirOperation, optionally associating it with a parentKeepAlive.

Definition at line 1083 of file IRCore.cpp.

Referenced by mlir::python::PyInsertionPoint::atBlockBegin(), mlir::python::PyInsertionPoint::atBlockTerminator(), createFromCapsule(), mlir::python::PyValue::createFromCapsule(), mlir::python::PySymbolTable::dunderGetItem(), and getParentOperation().

◆ get()

MlirOperation mlir::python::PyOperation::get ( ) const

inline

Definition at line 615 of file IRModule.h.

References checkValid().

Referenced by createOpView(), mlir::python::PySymbolTable::erase(), getBlock(), getCapsule(), getParentOperation(), mlir::python::PySymbolTable::getSymbolName(), mlir::python::PySymbolTable::getVisibility(), mlir::python::PySymbolTable::insert(), operator MlirOperation(), mlir::python::PySymbolTable::PySymbolTable(), mlir::python::PySymbolTable::setSymbolName(), mlir::python::PySymbolTable::setVisibility(), and mlir::python::PySymbolTable::walkSymbolTables().

◆ getBlock()

PyBlock PyOperation::getBlock ( )

Gets the owning block or raises an exception if the operation has no owning block.

Definition at line 1238 of file IRCore.cpp.

References checkValid(), get(), getParentOperation(), mlirBlockIsNull(), and mlirOperationGetBlock().

◆ getCapsule()

py::object PyOperation::getCapsule ( )

Gets a capsule wrapping the void* within the MlirOperation.

Definition at line 1247 of file IRCore.cpp.

References checkValid(), get(), and mlirPythonOperationToCapsule().

◆ getOperation()

PyOperation& mlir::python::PyOperation::getOperation ( )

inlineoverridevirtual

Each must provide access to the raw Operation.

Implements mlir::python::PyOperationBase.

Definition at line 585 of file IRModule.h.

Referenced by detachFromParent(), and mlir::python::PyConcreteOpInterface< ConcreteIface >::PyConcreteOpInterface().

◆ getParentOperation()

std::optional< PyOperationRef > PyOperation::getParentOperation ( )

Gets the parent operation or raises an exception if the operation has no parent.

Definition at line 1228 of file IRCore.cpp.

References checkValid(), forOperation(), get(), mlir::python::BaseContextObject::getContext(), isAttached(), mlirOperationGetParentOperation(), and mlirOperationIsNull().

Referenced by getBlock().

◆ getRef()

PyOperationRef mlir::python::PyOperation::getRef ( )

inline

Definition at line 620 of file IRModule.h.

Referenced by createOpView(), and mlir::python::PyConcreteOpInterface< ConcreteIface >::getOperationObject().

◆ isAttached()

bool mlir::python::PyOperation::isAttached ( )

inline

Definition at line 625 of file IRModule.h.

Referenced by getParentOperation(), mlir::python::PyInsertionPoint::insert(), and ~PyOperation().

◆ operator MlirOperation()

mlir::python::PyOperation::operator MlirOperation ( ) const

inline

Gets the backing operation.

Definition at line 614 of file IRModule.h.

References get().

◆ parse()

PyOperationRef PyOperation::parse	(	PyMlirContextRef	contextRef,
		const std::string &	sourceStr,
		const std::string &	sourceName
	)

static

Parses a source string (either text assembly or bytecode), creating a detached operation.

Definition at line 1113 of file IRCore.cpp.

◆ setAttached()

void mlir::python::PyOperation::setAttached ( const pybind11::object & parent = pybind11::object() )

inline

Definition at line 626 of file IRModule.h.

Referenced by mlir::python::PyInsertionPoint::insert().

◆ setDetached()

void mlir::python::PyOperation::setDetached ( )

inline

Definition at line 630 of file IRModule.h.

Referenced by detachFromParent().

◆ setInvalid()

void mlir::python::PyOperation::setInvalid ( )

inline

Invalidate the operation.

Definition at line 668 of file IRModule.h.

Friends And Related Function Documentation

◆ PyOperationBase

friend class PyOperationBase

friend

Definition at line 691 of file IRModule.h.

◆ PySymbolTable

friend class PySymbolTable

friend

Definition at line 692 of file IRModule.h.

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

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~PyOperation()

Member Function Documentation

◆ checkValid()

◆ clone()

◆ create()

◆ createDetached()

◆ createFromCapsule()

◆ createOpView()

◆ detachFromParent()

◆ erase()

◆ forOperation()

◆ get()

◆ getBlock()

◆ getCapsule()

◆ getOperation()

◆ getParentOperation()

◆ getRef()

◆ isAttached()

◆ operator MlirOperation()

◆ parse()

◆ setAttached()

◆ setDetached()

◆ setInvalid()

Friends And Related Function Documentation

◆ PyOperationBase

◆ PySymbolTable