MLIR 24.0.0git
Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members
mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext Class Reference

#include "mlir/Bindings/Python/IRCore.h"

Classes

struct  ErrorCapture
 RAII object that captures any error diagnostics emitted to the provided context. More...

Public Member Functions

 PyMlirContext ()=delete
 PyMlirContext (MlirContext context)
 PyMlirContext (const PyMlirContext &)=delete
 PyMlirContext (PyMlirContext &&)=delete
 ~PyMlirContext ()
MlirContext get ()
 Accesses the underlying MlirContext.
PyMlirContextRef getRef ()
 Gets a strong reference to this context, which will ensure it is kept alive for the life of the reference.
nanobind::object getCapsule ()
 Gets a capsule wrapping the void* within the MlirContext.
size_t getLiveModuleCount ()
 Gets the count of live modules associated with this context.
void contextExit (const nanobind::object &excType, const nanobind::object &excVal, const nanobind::object &excTb)
nanobind::object attachDiagnosticHandler (nanobind::object callback)
 Attaches a Python callback as a diagnostic handler, returning a registration object (internally a PyDiagnosticHandler).
void enableRemarks (PyRemarkPolicy policy, const std::optional< std::string > &outputFile, PyRemarkFormat format, const std::string &allFilter, const std::string &passedFilter, const std::string &missedFilter, const std::string &analysisFilter, const std::string &failedFilter, nanobind::object callback, std::optional< bool > printAsEmitRemarks)
 Enables the optimization remark engine of the context, streaming to outputFile, to callback, or (without either) to MLIR remark diagnostics.
void finalizeRemarks ()
 Finalizes and removes the remark engine; no-op when none is enabled.
bool getRemarksEnabled ()
 Whether a remark engine is enabled on the context.
void setEmitErrorDiagnostics (bool value)
 Controls whether error diagnostics should be propagated to diagnostic handlers, instead of being captured by ErrorCapture.
bool getEmitErrorDiagnostics ()

Static Public Member Functions

static PyMlirContextRef forContext (MlirContext context)
 Returns a context reference for the singleton PyMlirContext wrapper for the given context.
static nanobind::object createFromCapsule (nanobind::object capsule)
 Creates a PyMlirContext from the MlirContext wrapped by a capsule.
static size_t getLiveCount ()
 Gets the count of live context objects. Used for testing.
static nanobind::object contextEnter (nanobind::object context)
 Enter and exit the context manager.
static bool isLiveContext (MlirContext context)
 Whether context still has a live Python wrapper (false while it is being destroyed).

Friends

class PyModule
class PyOperation

Detailed Description

Definition at line 232 of file IRCore.h.

Constructor & Destructor Documentation

◆ PyMlirContext() [1/4]

mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::PyMlirContext ( )
delete

References PyMlirContext().

Referenced by PyMlirContext(), PyMlirContext(), and PyMlirContext().

◆ PyMlirContext() [2/4]

mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::PyMlirContext ( MlirContext context)

Definition at line 427 of file IRCore.cpp.

◆ PyMlirContext() [3/4]

mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::PyMlirContext ( const PyMlirContext & )
delete

References PyMlirContext().

◆ PyMlirContext() [4/4]

mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::PyMlirContext ( PyMlirContext && )
delete

References forContext(), and PyMlirContext().

◆ ~PyMlirContext()

mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::~PyMlirContext ( )

Definition at line 434 of file IRCore.cpp.

Member Function Documentation

◆ attachDiagnosticHandler()

nb::object mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::attachDiagnosticHandler ( nanobind::object callback)

Attaches a Python callback as a diagnostic handler, returning a registration object (internally a PyDiagnosticHandler).

Definition at line 501 of file IRCore.cpp.

References mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyThreadContextEntry::popContext().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ contextEnter()

nb::object mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::contextEnter ( nanobind::object context)
static

Enter and exit the context manager.

Definition at line 491 of file IRCore.cpp.

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ contextExit()

void mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::contextExit ( const nanobind::object & excType,
const nanobind::object & excVal,
const nanobind::object & excTb )

Definition at line 495 of file IRCore.cpp.

References mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyThreadContextEntry::pushContext().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ createFromCapsule()

nb::object mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::createFromCapsule ( nanobind::object capsule)
static

Creates a PyMlirContext from the MlirContext wrapped by a capsule.

Note that PyMlirContext instances are uniqued, so the returned object may be a pre-existing object. Ownership of the underlying MlirContext is taken by calling this function.

Definition at line 454 of file IRCore.cpp.

References get(), and mlirPythonContextToCapsule().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ enableRemarks()

void mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::enableRemarks ( PyRemarkPolicy policy,
const std::optional< std::string > & outputFile,
PyRemarkFormat format,
const std::string & allFilter,
const std::string & passedFilter,
const std::string & missedFilter,
const std::string & analysisFilter,
const std::string & failedFilter,
nanobind::object callback,
std::optional< bool > printAsEmitRemarks )

Enables the optimization remark engine of the context, streaming to outputFile, to callback, or (without either) to MLIR remark diagnostics.

Raises ValueError on an invalid combination, when an engine is already enabled or when the file cannot be written.

Definition at line 65 of file IRRemarks.cpp.

References get(), mlirContextEnableOptimizationRemarks(), mlirContextEnableOptimizationRemarksToFile(), mlirContextEnableOptimizationRemarksWithCallback(), mlirContextHasRemarkEngine(), mlirLogicalResultIsFailure(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::pyRemarkCallback(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::pyRemarkCallbackDelete(), result, and mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::toMlirStringRef().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ finalizeRemarks()

void mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::finalizeRemarks ( )

Finalizes and removes the remark engine; no-op when none is enabled.

Definition at line 112 of file IRRemarks.cpp.

References get(), and mlirContextFinalizeOptimizationRemarks().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ forContext()

PyMlirContextRef mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::forContext ( MlirContext context)
static

Returns a context reference for the singleton PyMlirContext wrapper for the given context.

Definition at line 461 of file IRCore.cpp.

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRewritePatternSet::add(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRewritePatternSet::addConversion(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyTypeConverter::addConversion(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyConditionallySpeculatableOpInterface::attach(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMemoryEffectsOpInterface::attach(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::transform::PyPatternDescriptorOpInterface::attach(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::transform::PyTransformOpInterface::attach(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyLocation::contextEnter(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyTypeConverter::convertType(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyAffineExpr::createFromCapsule(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyAffineMap::createFromCapsule(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyIntegerSet::createFromCapsule(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::getLocation(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyDiagnostic::getMessage(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMemoryEffectInstance::getParameters(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyDenseElementsAttribute::getSplat(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMemoryEffectInstance::getSymbolRef(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMemoryEffectInstance::getValue(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyAttribute::maybeDownCast(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyType::maybeDownCast(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyValue::maybeDownCast(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::maybeInsertOperation(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore(), and PyMlirContext().

◆ get()

MlirContext mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::get ( )
inline

Accesses the underlying MlirContext.

Definition at line 245 of file IRCore.h.

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRewritePatternSet::bind(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyArrayAttribute::bindDerived(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyFloatAttribute::bindDerived(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyFusedLocation::bindDerived(), createFromCapsule(), enableRemarks(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::ErrorCapture::ErrorCapture(), finalizeRemarks(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PySymbolRefAttribute::fromList(), getRemarksEnabled(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyInferShapedTypeOpInterface::inferReturnTypeComponents(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyInferTypeOpInterface::inferReturnTypes(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore(), and mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyConcreteOpInterface< ConcreteIface >::PyConcreteOpInterface().

◆ getCapsule()

nb::object mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::getCapsule ( )

Gets a capsule wrapping the void* within the MlirContext.

Definition at line 450 of file IRCore.cpp.

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ getEmitErrorDiagnostics()

bool mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::getEmitErrorDiagnostics ( )
inline

Definition at line 300 of file IRCore.h.

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ getLiveCount()

size_t mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::getLiveCount ( )
static

Gets the count of live context objects. Used for testing.

Definition at line 486 of file IRCore.cpp.

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ getLiveModuleCount()

size_t mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::getLiveModuleCount ( )

Gets the count of live modules associated with this context.

Used for testing.

Definition at line 1838 of file IRCore.cpp.

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ getRef()

PyMlirContextRef mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::getRef ( )

Gets a strong reference to this context, which will ensure it is kept alive for the life of the reference.

Definition at line 446 of file IRCore.cpp.

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PySymbolRefAttribute::fromList(), and mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ getRemarksEnabled()

bool mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::getRemarksEnabled ( )

Whether a remark engine is enabled on the context.

Definition at line 116 of file IRRemarks.cpp.

References get(), and mlirContextHasRemarkEngine().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ isLiveContext()

bool mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::isLiveContext ( MlirContext context)
static

Whether context still has a live Python wrapper (false while it is being destroyed).

Definition at line 60 of file IRRemarks.cpp.

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::pyRemarkCallback().

◆ setEmitErrorDiagnostics()

void mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::setEmitErrorDiagnostics ( bool value)
inline

Controls whether error diagnostics should be propagated to diagnostic handlers, instead of being captured by ErrorCapture.

Definition at line 299 of file IRCore.h.

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRCore().

◆ PyModule

friend class PyModule
friend

Definition at line 325 of file IRCore.h.

References PyModule.

Referenced by PyModule.

◆ PyOperation

friend class PyOperation
friend

Definition at line 326 of file IRCore.h.

References PyOperation.

Referenced by PyOperation.

The documentation for this class was generated from the following files:
Generated on for MLIR by doxygen 1.14.0