10 #ifndef MLIR_BINDINGS_PYTHON_IRMODULES_H
11 #define MLIR_BINDINGS_PYTHON_IRMODULES_H
28 #include "llvm/ADT/DenseMap.h"
29 #include "llvm/Support/ThreadPool.h"
36 class PyDiagnosticHandler;
37 class PyInsertionPoint;
39 class DefaultingPyLocation;
41 class DefaultingPyMlirContext;
44 class PyOperationBase;
55 : referrent(referrent), object(std::move(object)) {
56 assert(this->referrent &&
57 "cannot construct PyObjectRef with null referrent");
58 assert(this->
object &&
"cannot construct PyObjectRef with null object");
61 : referrent(other.referrent), object(std::move(other.object)) {
62 other.referrent =
nullptr;
63 assert(!other.object);
66 : referrent(other.referrent), object(other.object ) {}
72 return Py_REFCNT(
object.ptr());
79 assert(referrent &&
object);
81 auto stolen = std::move(
object);
85 T *
get() {
return referrent; }
87 assert(referrent &&
object);
91 assert(referrent &&
object);
94 operator bool()
const {
return referrent && object; }
98 nanobind::object object;
118 nanobind::object insertionPoint,
119 nanobind::object location)
120 : context(std::move(context)), insertionPoint(std::move(insertionPoint)),
121 location(std::move(location)), frameKind(frameKind) {}
139 static nanobind::object
pushContext(nanobind::object context);
143 static nanobind::object
pushLocation(nanobind::object location);
147 static std::vector<PyThreadContextEntry> &
getStack();
150 static void push(
FrameKind frameKind, nanobind::object context,
151 nanobind::object insertionPoint, nanobind::object location);
154 nanobind::object context;
156 nanobind::object insertionPoint;
158 nanobind::object location;
168 ownedThreadPool = std::make_unique<llvm::DefaultThreadPool>();
174 MlirLlvmThreadPool
get() {
return wrap(ownedThreadPool.get()); }
177 std::stringstream ss;
178 ss << ownedThreadPool.get();
183 std::unique_ptr<llvm::ThreadPoolInterface> ownedThreadPool;
211 MlirContext
get() {
return context; }
266 static nanobind::object
contextEnter(nanobind::object context);
268 const nanobind::object &excVal,
269 const nanobind::object &excTb);
288 static nanobind::ft_mutex live_contexts_mutex;
289 static LiveContextMap &getLiveContexts();
295 using LiveModuleMap =
297 LiveModuleMap liveModules;
303 using LiveOperationMap =
305 nanobind::ft_mutex liveOperationsMutex;
308 LiveOperationMap liveOperations;
310 bool emitErrorDiagnostics =
false;
320 :
public Defaulting<DefaultingPyMlirContext, PyMlirContext> {
334 assert(this->contextRef &&
335 "context object constructed with null context ref");
351 operator MlirLocation()
const {
return loc; }
352 MlirLocation
get()
const {
return loc; }
355 static nanobind::object
contextEnter(nanobind::object location);
357 const nanobind::object &excVal,
358 const nanobind::object &excTb);
404 std::optional<nanobind::tuple> materializedNotes;
440 const nanobind::object &excVal,
441 const nanobind::object &excTb) {
447 nanobind::object callback;
448 std::optional<MlirDiagnosticHandlerID> registeredID;
449 bool hadError =
false;
458 ctx->
get(), handler, this,
462 assert(errors.empty() &&
"unhandled captured errors");
465 std::vector<PyDiagnostic::DiagnosticInfo>
take() {
466 return std::move(errors);
472 std::vector<PyDiagnostic::DiagnosticInfo> errors;
487 MlirDialect
get() {
return dialect; }
508 PyDialect(nanobind::object descriptor) : descriptor(std::move(descriptor)) {}
513 nanobind::object descriptor;
529 : registry(other.registry) {
530 other.registry = {
nullptr};
533 operator MlirDialectRegistry()
const {
return registry; }
534 MlirDialectRegistry
get()
const {
return registry; }
540 MlirDialectRegistry registry;
546 :
public Defaulting<DefaultingPyLocation, PyLocation> {
552 operator MlirLocation()
const {
return *
get(); }
569 MlirModule
get() {
return module; }
573 return PyModuleRef(
this, nanobind::borrow<nanobind::object>(handle));
591 nanobind::handle handle;
602 void print(std::optional<int64_t> largeElementsLimit,
bool enableDebugInfo,
603 bool prettyDebugInfo,
bool printGenericOpForm,
bool useLocalScope,
604 bool useNameLocAsPrefix,
bool assumeVerified,
605 nanobind::object fileObject,
bool binary,
bool skipRegions);
608 nanobind::object
getAsm(
bool binary,
609 std::optional<int64_t> largeElementsLimit,
610 bool enableDebugInfo,
bool prettyDebugInfo,
611 bool printGenericOpForm,
bool useLocalScope,
612 bool useNameLocAsPrefix,
bool assumeVerified,
617 std::optional<int64_t> bytecodeVersion);
652 nanobind::object parentKeepAlive = nanobind::object());
658 nanobind::object parentKeepAlive = nanobind::object());
663 const std::string &sourceStr,
664 const std::string &sourceName);
671 parentKeepAlive = nanobind::object();
675 operator MlirOperation()
const {
return get(); }
676 MlirOperation
get()
const {
682 return PyOperationRef(
this, nanobind::borrow<nanobind::object>(handle));
686 void setAttached(
const nanobind::object &parent = nanobind::object()) {
687 assert(!attached &&
"operation already attached");
691 assert(attached &&
"operation already detached");
713 static nanobind::object
714 create(std::string_view name, std::optional<std::vector<PyType *>> results,
716 std::optional<nanobind::dict> attributes,
717 std::optional<std::vector<PyBlock *>> successors,
int regions,
732 nanobind::object
clone(
const nanobind::object &ip);
738 MlirOperation operation,
739 nanobind::object parentKeepAlive);
741 MlirOperation operation;
742 nanobind::handle handle;
749 nanobind::object parentKeepAlive;
750 bool attached =
true;
764 PyOpView(
const nanobind::object &operationObject);
769 static nanobind::object
770 buildGeneric(std::string_view name, std::tuple<int, bool> opRegionSpec,
771 nanobind::object operandSegmentSpecObj,
772 nanobind::object resultSegmentSpecObj,
773 std::optional<nanobind::list> resultTypeList,
774 nanobind::list operandList,
775 std::optional<nanobind::dict> attributes,
776 std::optional<std::vector<PyBlock *>> successors,
778 const nanobind::object &maybeIp);
788 const nanobind::object &operation);
792 nanobind::object operationObject;
801 : parentOperation(std::move(parentOperation)), region(region) {
804 operator MlirRegion()
const {
return region; }
806 MlirRegion
get() {
return region; }
842 MlirAsmState
get() {
return state; }
846 MlirOpPrintingFlags flags;
855 : parentOperation(std::move(parentOperation)), block(block) {
859 MlirBlock
get() {
return block; }
893 static nanobind::object
contextEnter(nanobind::object insertionPoint);
895 const nanobind::object &excVal,
896 const nanobind::object &excTb);
905 : refOperation(std::move(refOperation)), block(std::move(block)) {}
907 std::optional<PyOperationRef> refOperation;
917 operator MlirType()
const {
return type; }
918 MlirType
get()
const {
return type; }
943 operator MlirTypeID()
const {
return typeID; }
944 MlirTypeID
get() {
return typeID; }
961 template <
typename DerivedTy,
typename BaseTy = PyType>
967 using ClassTy = nanobind::class_<DerivedTy, BaseTy>;
974 : BaseTy(std::move(contextRef), t) {}
979 if (!DerivedTy::isaFunction(orig)) {
981 nanobind::cast<std::string>(nanobind::repr(nanobind::cast(orig)));
982 throw nanobind::value_error((llvm::Twine(
"Cannot cast type to ") +
983 DerivedTy::pyClassName +
" (from " +
991 static void bind(nanobind::module_ &m) {
992 auto cls =
ClassTy(m, DerivedTy::pyClassName);
993 cls.def(nanobind::init<PyType &>(), nanobind::keep_alive<0, 1>(),
994 nanobind::arg(
"cast_from_type"));
997 [](
PyType &otherType) ->
bool {
998 return DerivedTy::isaFunction(otherType);
1000 nanobind::arg(
"other"));
1001 cls.def_prop_ro_static(
1002 "static_typeid", [](nanobind::object & ) -> MlirTypeID {
1003 if (DerivedTy::getTypeIdFunction)
1004 return DerivedTy::getTypeIdFunction();
1005 throw nanobind::attribute_error(
1006 (DerivedTy::pyClassName + llvm::Twine(
" has no typeid."))
1010 cls.def_prop_ro(
"typeid", [](
PyType &
self) {
1011 return nanobind::cast<MlirTypeID>(nanobind::cast(
self).attr(
"typeid"));
1013 cls.def(
"__repr__", [](
DerivedTy &
self) {
1015 printAccum.
parts.append(DerivedTy::pyClassName);
1016 printAccum.
parts.append(
"(");
1018 printAccum.
parts.append(
")");
1019 return printAccum.
join();
1022 if (DerivedTy::getTypeIdFunction) {
1024 DerivedTy::getTypeIdFunction(),
1025 nanobind::cast<nanobind::callable>(nanobind::cpp_function(
1029 DerivedTy::bindDerived(cls);
1043 operator MlirAttribute()
const {
return attr; }
1044 MlirAttribute
get()
const {
return attr; }
1079 std::unique_ptr<std::string> ownedName;
1087 template <
typename DerivedTy,
typename BaseTy = PyAttribute>
1093 using ClassTy = nanobind::class_<DerivedTy, BaseTy>;
1100 : BaseTy(std::move(contextRef), attr) {}
1105 if (!DerivedTy::isaFunction(orig)) {
1107 nanobind::cast<std::string>(nanobind::repr(nanobind::cast(orig)));
1108 throw nanobind::value_error((llvm::Twine(
"Cannot cast attribute to ") +
1109 DerivedTy::pyClassName +
" (from " +
1117 static void bind(nanobind::module_ &m, PyType_Slot *slots =
nullptr) {
1120 cls =
ClassTy(m, DerivedTy::pyClassName, nanobind::type_slots(slots));
1122 cls =
ClassTy(m, DerivedTy::pyClassName);
1124 cls.def(nanobind::init<PyAttribute &>(), nanobind::keep_alive<0, 1>(),
1125 nanobind::arg(
"cast_from_attr"));
1129 return DerivedTy::isaFunction(otherAttr);
1131 nanobind::arg(
"other"));
1134 cls.def_prop_ro_static(
1135 "static_typeid", [](nanobind::object & ) -> MlirTypeID {
1136 if (DerivedTy::getTypeIdFunction)
1137 return DerivedTy::getTypeIdFunction();
1138 throw nanobind::attribute_error(
1139 (DerivedTy::pyClassName + llvm::Twine(
" has no typeid."))
1144 return nanobind::cast<MlirTypeID>(nanobind::cast(
self).attr(
"typeid"));
1146 cls.def(
"__repr__", [](
DerivedTy &
self) {
1148 printAccum.
parts.append(DerivedTy::pyClassName);
1149 printAccum.
parts.append(
"(");
1152 printAccum.
parts.append(
")");
1153 return printAccum.
join();
1156 if (DerivedTy::getTypeIdFunction) {
1158 DerivedTy::getTypeIdFunction(),
1159 nanobind::cast<nanobind::callable>(
1165 DerivedTy::bindDerived(cls);
1185 : parentOperation(std::move(parentOperation)), value(value) {}
1186 operator MlirValue()
const {
return value; }
1188 MlirValue
get() {
return value; }
1213 operator MlirAffineExpr()
const {
return affineExpr; }
1214 MlirAffineExpr
get()
const {
return affineExpr; }
1232 MlirAffineExpr affineExpr;
1240 operator MlirAffineMap()
const {
return affineMap; }
1241 MlirAffineMap
get()
const {
return affineMap; }
1253 MlirAffineMap affineMap;
1261 operator MlirIntegerSet()
const {
return integerSet; }
1262 MlirIntegerSet
get()
const {
return integerSet; }
1273 MlirIntegerSet integerSet;
1294 void dunderDel(
const std::string &name);
1307 const std::string &visibility);
1312 const std::string &newSymbol,
1317 nanobind::object callback);
1320 operator MlirSymbolTable() {
return symbolTable; }
1324 MlirSymbolTable symbolTable;
1350 struct type_caster<
mlir::python::DefaultingPyMlirContext>
1353 struct type_caster<
mlir::python::DefaultingPyLocation>
static std::string diag(const llvm::Value &value)
Base class for all objects that directly or indirectly depend on an MlirContext.
PyMlirContextRef & getContext()
Accesses the context reference.
BaseContextObject(PyMlirContextRef ref)
Used in function arguments when None should resolve to the current context manager set instance.
static PyLocation & resolve()
static constexpr const char kTypeDescription[]
Used in function arguments when None should resolve to the current context manager set instance.
static constexpr const char kTypeDescription[]
static PyMlirContext & resolve()
CRTP template for special wrapper types that are allowed to be passed in as 'None' function arguments...
ReferrentTy * get() const
Defaulting()=default
Type casters require the type to be default constructible, but using such an instance is illegal.
Wrapper around MlirAffineExpr. Affine expressions are owned by the context.
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirAffineExpr.
PyAffineExpr(PyMlirContextRef contextRef, MlirAffineExpr affineExpr)
PyAffineExpr ceilDiv(const PyAffineExpr &other) const
PyAffineExpr mul(const PyAffineExpr &other) const
static PyAffineExpr createFromCapsule(nanobind::object capsule)
Creates a PyAffineExpr from the MlirAffineExpr wrapped by a capsule.
PyAffineExpr mod(const PyAffineExpr &other) const
PyAffineExpr floorDiv(const PyAffineExpr &other) const
bool operator==(const PyAffineExpr &other) const
PyAffineExpr add(const PyAffineExpr &other) const
MlirAffineExpr get() const
PyAffineMap(PyMlirContextRef contextRef, MlirAffineMap affineMap)
bool operator==(const PyAffineMap &other) const
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirAffineMap.
static PyAffineMap createFromCapsule(nanobind::object capsule)
Creates a PyAffineMap from the MlirAffineMap wrapped by a capsule.
MlirAffineMap get() const
Wrapper around an MlirAsmState.
PyAsmState(PyOperationBase &operation, bool useLocalScope)
PyAsmState(MlirValue value, bool useLocalScope)
PyAsmState(PyAsmState &other)=delete
PyAsmState(const PyAsmState &other)=delete
Wrapper around the generic MlirAttribute.
PyAttribute(PyMlirContextRef contextRef, MlirAttribute attr)
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirAttribute.
static PyAttribute createFromCapsule(nanobind::object capsule)
Creates a PyAttribute from the MlirAttribute wrapped by a capsule.
MlirAttribute get() const
bool operator==(const PyAttribute &other) const
Wrapper around an MlirBlock.
PyOperationRef & getParentOperation()
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirBlock.
PyBlock(PyOperationRef parentOperation, MlirBlock block)
CRTP base classes for Python attributes that subclass Attribute and should be castable from it (i....
MlirTypeID(*)() GetTypeIDFunctionTy
static MlirAttribute castFrom(PyAttribute &orig)
nanobind::class_< DerivedTy, BaseTy > ClassTy
static constexpr GetTypeIDFunctionTy getTypeIdFunction
PyConcreteAttribute()=default
static void bind(nanobind::module_ &m, PyType_Slot *slots=nullptr)
bool(*)(MlirAttribute) IsAFunctionTy
PyConcreteAttribute(PyAttribute &orig)
PyConcreteAttribute(PyMlirContextRef contextRef, MlirAttribute attr)
static void bindDerived(ClassTy &m)
Implemented by derived classes to add methods to the Python subclass.
CRTP base classes for Python types that subclass Type and should be castable from it (i....
nanobind::class_< DerivedTy, BaseTy > ClassTy
static void bind(nanobind::module_ &m)
PyConcreteType(PyType &orig)
MlirTypeID(*)() GetTypeIDFunctionTy
bool(*)(MlirType) IsAFunctionTy
static void bindDerived(ClassTy &m)
Implemented by derived classes to add methods to the Python subclass.
static constexpr GetTypeIDFunctionTy getTypeIdFunction
PyConcreteType(PyMlirContextRef contextRef, MlirType t)
static MlirType castFrom(PyType &orig)
Represents a diagnostic handler attached to the context.
PyDiagnosticHandler(MlirContext context, nanobind::object callback)
nanobind::object contextEnter()
void detach()
Detaches the handler. Does nothing if not attached.
void contextExit(const nanobind::object &excType, const nanobind::object &excVal, const nanobind::object &excTb)
Python class mirroring the C MlirDiagnostic struct.
nanobind::tuple getNotes()
nanobind::str getMessage()
PyDiagnostic(MlirDiagnostic diagnostic)
MlirDiagnosticSeverity getSeverity()
Wrapper around an MlirDialect.
PyDialectDescriptor(PyMlirContextRef contextRef, MlirDialect dialect)
Wrapper around an MlirDialectRegistry.
PyDialectRegistry(PyDialectRegistry &&other) noexcept
nanobind::object getCapsule()
PyDialectRegistry(PyDialectRegistry &)=delete
static PyDialectRegistry createFromCapsule(nanobind::object capsule)
MlirDialectRegistry get() const
PyDialectRegistry(MlirDialectRegistry registry)
User-level dialect object.
PyDialect(nanobind::object descriptor)
nanobind::object getDescriptor()
User-level object for accessing dialects with dotted syntax such as: ctx.dialect.std.
PyDialects(PyMlirContextRef contextRef)
MlirDialect getDialectForKey(const std::string &key, bool attrError)
void registerTypeCaster(MlirTypeID mlirTypeID, nanobind::callable typeCaster, bool replace=false)
Adds a user-friendly type caster.
static PyGlobals & get()
Most code should get the globals via this static accessor.
An insertion point maintains a pointer to a Block and a reference operation.
static PyInsertionPoint atBlockTerminator(PyBlock &block)
Shortcut to create an insertion point before the block terminator.
PyInsertionPoint(PyBlock &block)
Creates an insertion point positioned after the last operation in the block, but still inside the blo...
static PyInsertionPoint atBlockBegin(PyBlock &block)
Shortcut to create an insertion point at the beginning of the block.
void contextExit(const nanobind::object &excType, const nanobind::object &excVal, const nanobind::object &excTb)
void insert(PyOperationBase &operationBase)
Inserts an operation.
std::optional< PyOperationRef > & getRefOperation()
static nanobind::object contextEnter(nanobind::object insertionPoint)
Enter and exit the context manager.
MlirIntegerSet get() const
bool operator==(const PyIntegerSet &other) const
static PyIntegerSet createFromCapsule(nanobind::object capsule)
Creates a PyIntegerSet from the MlirAffineMap wrapped by a capsule.
PyIntegerSet(PyMlirContextRef contextRef, MlirIntegerSet integerSet)
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirIntegerSet.
Wrapper around an MlirLocation.
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirLocation.
PyLocation(PyMlirContextRef contextRef, MlirLocation loc)
static PyLocation createFromCapsule(nanobind::object capsule)
Creates a PyLocation from the MlirLocation wrapped by a capsule.
void contextExit(const nanobind::object &excType, const nanobind::object &excVal, const nanobind::object &excTb)
static nanobind::object contextEnter(nanobind::object location)
Enter and exit the context manager.
PyMlirContext(const PyMlirContext &)=delete
PyMlirContext(PyMlirContext &&)=delete
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 refer...
void clearOperationsInside(PyOperationBase &op)
Clears all operations nested inside the given op using clearOperation(MlirOperation).
static size_t getLiveCount()
Gets the count of live context objects. Used for testing.
void clearOperationAndInside(PyOperationBase &op)
Clears the operaiton and all operations inside using clearOperation(MlirOperation).
size_t getLiveModuleCount()
Gets the count of live modules associated with this context.
static PyMlirContext * createNewContextForInit()
For the case of a python init (nanobind::init) method, pybind11 is quite strict about needing to retu...
nanobind::object attachDiagnosticHandler(nanobind::object callback)
Attaches a Python callback as a diagnostic handler, returning a registration object (internally a PyD...
size_t clearLiveOperations()
Clears the live operations map, returning the number of entries which were invalidated.
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirContext.
std::vector< PyOperation * > getLiveOperationObjects()
Get a list of Python objects which are still in the live context map.
void contextExit(const nanobind::object &excType, const nanobind::object &excVal, const nanobind::object &excTb)
void clearOperation(MlirOperation op)
Removes an operation from the live operations map and sets it invalid.
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.
size_t getLiveOperationCount()
Gets the count of live operations associated with this context.
static nanobind::object contextEnter(nanobind::object context)
Enter and exit the context manager.
void setEmitErrorDiagnostics(bool value)
Controls whether error diagnostics should be propagated to diagnostic handlers, instead of being capt...
MlirModule get()
Gets the backing MlirModule.
static PyModuleRef forModule(MlirModule module)
Returns a PyModule reference for the given MlirModule.
static nanobind::object createFromCapsule(nanobind::object capsule)
Creates a PyModule from the MlirModule wrapped by a capsule.
PyModuleRef getRef()
Gets a strong reference to this module.
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirModule.
PyModule(PyModule &)=delete
PyModule(PyMlirContext &&)=delete
Represents a Python MlirNamedAttr, carrying an optional owned name.
PyNamedAttribute(MlirAttribute attr, std::string ownedName)
Constructs a PyNamedAttr that retains an owned name.
MlirNamedAttribute namedAttr
Template for a reference to a concrete type which captures a python reference to its underlying pytho...
nanobind::object getObject()
PyObjectRef(T *referrent, nanobind::object object)
nanobind::object releaseObject()
Releases the object held by this instance, returning it.
PyObjectRef(PyObjectRef &&other) noexcept
PyObjectRef(const PyObjectRef &other)
A PyOpView is equivalent to the C++ "Op" wrappers: these are the basis for providing more instance-sp...
static nanobind::object constructDerived(const nanobind::object &cls, const nanobind::object &operation)
Construct an instance of a class deriving from OpView, bypassing its __init__ method.
static nanobind::object buildGeneric(std::string_view name, std::tuple< int, bool > opRegionSpec, nanobind::object operandSegmentSpecObj, nanobind::object resultSegmentSpecObj, std::optional< nanobind::list > resultTypeList, nanobind::list operandList, std::optional< nanobind::dict > attributes, std::optional< std::vector< PyBlock * >> successors, std::optional< int > regions, DefaultingPyLocation location, const nanobind::object &maybeIp)
nanobind::object getOperationObject()
PyOpView(const nanobind::object &operationObject)
PyOperation & getOperation() override
Each must provide access to the raw Operation.
Base class for PyOperation and PyOpView which exposes the primary, user visible methods for manipulat...
void walk(std::function< MlirWalkResult(MlirOperation)> callback, MlirWalkOrder walkOrder)
virtual PyOperation & getOperation()=0
Each must provide access to the raw Operation.
void print(PyAsmState &state, nanobind::object fileObject, bool binary)
virtual ~PyOperationBase()=default
void print(std::optional< int64_t > largeElementsLimit, bool enableDebugInfo, bool prettyDebugInfo, bool printGenericOpForm, bool useLocalScope, bool useNameLocAsPrefix, bool assumeVerified, nanobind::object fileObject, bool binary, bool skipRegions)
Implements the bound 'print' method and helps with others.
nanobind::object getAsm(bool binary, std::optional< int64_t > largeElementsLimit, bool enableDebugInfo, bool prettyDebugInfo, bool printGenericOpForm, bool useLocalScope, bool useNameLocAsPrefix, bool assumeVerified, bool skipRegions)
void moveAfter(PyOperationBase &other)
Moves the operation before or after the other operation.
void writeBytecode(const nanobind::object &fileObject, std::optional< int64_t > bytecodeVersion)
void moveBefore(PyOperationBase &other)
bool verify()
Verify the operation.
void detachFromParent()
Detaches the operation from its parent block and updates its state accordingly.
PyOperation(PyMlirContextRef contextRef, MlirOperation operation)
void erase()
Erases the underlying MlirOperation, removes its pointer from the parent context's live operations ma...
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirOperation.
static PyOperationRef createDetached(PyMlirContextRef contextRef, MlirOperation operation, nanobind::object parentKeepAlive=nanobind::object())
Creates a detached operation.
nanobind::object clone(const nanobind::object &ip)
Clones this operation.
PyOperation & getOperation() override
Each must provide access to the raw Operation.
static nanobind::object createFromCapsule(nanobind::object capsule)
Creates a PyOperation from the MlirOperation wrapped by a capsule.
MlirOperation get() const
static PyOperationRef forOperation(PyMlirContextRef contextRef, MlirOperation operation, nanobind::object parentKeepAlive=nanobind::object())
Returns a PyOperation for the given MlirOperation, optionally associating it with a parentKeepAlive.
void setAttached(const nanobind::object &parent=nanobind::object())
std::optional< PyOperationRef > getParentOperation()
Gets the parent operation or raises an exception if the operation has no parent.
nanobind::object createOpView()
Creates an OpView suitable for this operation.
PyBlock getBlock()
Gets the owning block or raises an exception if the operation has no owning block.
static nanobind::object create(std::string_view name, std::optional< std::vector< PyType * >> results, llvm::ArrayRef< MlirValue > operands, std::optional< nanobind::dict > attributes, std::optional< std::vector< PyBlock * >> successors, int regions, DefaultingPyLocation location, const nanobind::object &ip, bool inferType)
Creates an operation. See corresponding python docstring.
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.
void setInvalid()
Invalidate the operation.
Wrapper around an MlirRegion.
PyRegion(PyOperationRef parentOperation, MlirRegion region)
PyOperationRef & getParentOperation()
Bindings for MLIR symbol tables.
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 ...
static void walkSymbolTables(PyOperationBase &from, bool allSymUsesVisible, nanobind::object callback)
Walks all symbol tables under and including 'from'.
static void replaceAllSymbolUses(const std::string &oldSymbol, const std::string &newSymbol, PyOperationBase &from)
Replaces all symbol uses within an operation.
static void setVisibility(PyOperationBase &symbol, const std::string &visibility)
static void setSymbolName(PyOperationBase &symbol, const std::string &name)
~PySymbolTable()
Destroys the symbol table.
MlirAttribute insert(PyOperationBase &symbol)
Inserts the given operation into the symbol table.
void erase(PyOperationBase &symbol)
Removes the given operation from the symbol table and erases it.
PySymbolTable(PyOperationBase &operation)
Constructs a symbol table for the given operation.
static MlirAttribute getSymbolName(PyOperationBase &symbol)
Gets and sets the name of a symbol op.
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.
static MlirAttribute getVisibility(PyOperationBase &symbol)
Gets and sets the visibility of a symbol op.
Tracks an entry in the thread context stack.
static PyThreadContextEntry * getTopOfStack()
Stack management.
static void popLocation(PyLocation &location)
static nanobind::object pushLocation(nanobind::object location)
PyLocation * getLocation()
static nanobind::object pushContext(nanobind::object context)
static PyLocation * getDefaultLocation()
Gets the top of stack location and returns nullptr if not defined.
static void popInsertionPoint(PyInsertionPoint &insertionPoint)
static nanobind::object pushInsertionPoint(nanobind::object insertionPoint)
static void popContext(PyMlirContext &context)
static PyInsertionPoint * getDefaultInsertionPoint()
Gets the top of stack insertion point and return nullptr if not defined.
PyMlirContext * getContext()
static PyMlirContext * getDefaultContext()
Gets the top of stack context and return nullptr if not defined.
static std::vector< PyThreadContextEntry > & getStack()
Gets the thread local stack.
PyThreadContextEntry(FrameKind frameKind, nanobind::object context, nanobind::object insertionPoint, nanobind::object location)
PyInsertionPoint * getInsertionPoint()
Wrapper around MlirLlvmThreadPool Python object owns the C++ thread pool.
std::string _mlir_thread_pool_ptr() const
PyThreadPool(const PyThreadPool &)=delete
int getMaxConcurrency() const
PyThreadPool(PyThreadPool &&)=delete
A TypeID provides an efficient and unique identifier for a specific C++ type.
static PyTypeID createFromCapsule(nanobind::object capsule)
Creates a PyTypeID from the MlirTypeID wrapped by a capsule.
bool operator==(const PyTypeID &other) const
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirTypeID.
PyTypeID(MlirTypeID typeID)
Wrapper around the generic MlirType.
PyType(PyMlirContextRef contextRef, MlirType type)
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirType.
static PyType createFromCapsule(nanobind::object capsule)
Creates a PyType from the MlirType wrapped by a capsule.
bool operator==(const PyType &other) const
Wrapper around the generic MlirValue.
PyValue(PyOperationRef parentOperation, MlirValue value)
static PyValue createFromCapsule(nanobind::object capsule)
Creates a PyValue from the MlirValue wrapped by a capsule.
nanobind::object maybeDownCast()
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirValue.
virtual ~PyValue()=default
PyOperationRef & getParentOperation()
MlirDiagnosticSeverity
Severity of a diagnostic.
MLIR_CAPI_EXPORTED MlirDiagnosticHandlerID mlirContextAttachDiagnosticHandler(MlirContext context, MlirDiagnosticHandler handler, void *userData, void(*deleteUserData)(void *))
Attaches the diagnostic handler to the context.
MLIR_CAPI_EXPORTED void mlirContextDetachDiagnosticHandler(MlirContext context, MlirDiagnosticHandlerID id)
Detaches an attached diagnostic handler from the context given its identifier.
uint64_t MlirDiagnosticHandlerID
Opaque identifier of a diagnostic handler, useful to detach a handler.
MlirDiagnostic wrap(mlir::Diagnostic &diagnostic)
MlirWalkOrder
Traversal order for operation walk.
MLIR_CAPI_EXPORTED void mlirOpPrintingFlagsUseLocalScope(MlirOpPrintingFlags flags)
Use local scope when printing the operation.
MLIR_CAPI_EXPORTED void mlirDialectRegistryDestroy(MlirDialectRegistry registry)
Takes a dialect registry owned by the caller and destroys it.
MLIR_CAPI_EXPORTED MlirType mlirAttributeGetType(MlirAttribute attribute)
Gets the type of this attribute.
MLIR_CAPI_EXPORTED void mlirTypePrint(MlirType type, MlirStringCallback callback, void *userData)
Prints a location by sending chunks of the string representation and forwarding userData tocallback`.
MLIR_CAPI_EXPORTED void mlirAttributePrint(MlirAttribute attr, MlirStringCallback callback, void *userData)
Prints an attribute by sending chunks of the string representation and forwarding userData tocallback...
MlirWalkResult
Operation walk result.
MLIR_CAPI_EXPORTED MlirAsmState mlirAsmStateCreateForOperation(MlirOperation op, MlirOpPrintingFlags flags)
Creates new AsmState, as with AsmState the IR should not be mutated in-between using this state.
static bool mlirBlockIsNull(MlirBlock block)
Checks whether a block is null.
MLIR_CAPI_EXPORTED void mlirSymbolTableDestroy(MlirSymbolTable symbolTable)
Destroys the symbol table created with mlirSymbolTableCreate.
static bool mlirDialectRegistryIsNull(MlirDialectRegistry registry)
Checks if the dialect registry is null.
static bool mlirRegionIsNull(MlirRegion region)
Checks whether a region is null.
MLIR_CAPI_EXPORTED void mlirOpPrintingFlagsDestroy(MlirOpPrintingFlags flags)
Destroys printing flags created with mlirOpPrintingFlagsCreate.
MLIR_CAPI_EXPORTED MlirDialectRegistry mlirDialectRegistryCreate(void)
Creates a dialect registry and transfers its ownership to the caller.
MLIR_CAPI_EXPORTED void mlirOperationRemoveFromParent(MlirOperation op)
Removes the given operation from its parent block.
MLIR_CAPI_EXPORTED MlirOpPrintingFlags mlirOpPrintingFlagsCreate(void)
Creates new printing flags with defaults, intended for customization.
MLIR_CAPI_EXPORTED MlirAsmState mlirAsmStateCreateForValue(MlirValue value, MlirOpPrintingFlags flags)
Creates new AsmState from value.
PyObjectRef< PyMlirContext > PyMlirContextRef
Wrapper around MlirContext.
void populateIRAttributes(nanobind::module_ &m)
void populateIRInterfaces(nb::module_ &m)
PyObjectRef< PyModule > PyModuleRef
void populateIRAffine(nanobind::module_ &m)
void populateIRTypes(nanobind::module_ &m)
void populateIRCore(nanobind::module_ &m)
PyObjectRef< PyOperation > PyOperationRef
Include the generated interface declarations.
An opaque reference to a diagnostic, always owned by the diagnostics engine (context).
A logical result value, essentially a boolean with named states.
Accumulates into a python string from a method that accepts an MlirStringCallback.
MlirStringCallback getCallback()
Custom exception that allows access to error diagnostic information.
MLIRError(llvm::Twine message, std::vector< PyDiagnostic::DiagnosticInfo > &&errorDiagnostics={})
std::vector< PyDiagnostic::DiagnosticInfo > errorDiagnostics
Materialized diagnostic information.
MlirDiagnosticSeverity severity
std::vector< DiagnosticInfo > notes
RAII object that captures any error diagnostics emitted to the provided context.
std::vector< PyDiagnostic::DiagnosticInfo > take()
ErrorCapture(PyMlirContextRef ctx)