MLIR 23.0.0git
IRCore.cpp
Go to the documentation of this file.
1//===- IRModules.cpp - IR Submodules of pybind module ---------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9// clang-format off
13#include "mlir-c/Bindings/Python/Interop.h" // This is expected after nanobind.
14// clang-format on
16#include "mlir-c/Debug.h"
17#include "mlir-c/Diagnostics.h"
19#include "mlir-c/IR.h"
20#include "mlir-c/Support.h"
21
22#include <array>
23#include <cassert>
24#include <functional>
25#include <optional>
26#include <string>
27
28namespace nb = nanobind;
29using namespace nb::literals;
30using namespace mlir;
32
33static const char kModuleParseDocstring[] =
34 R"(Parses a module's assembly format from a string.
35
36Returns a new MlirModule or raises an MLIRError if the parsing fails.
37
38See also: https://mlir.llvm.org/docs/LangRef/
39)";
40
41static const char kDumpDocstring[] =
42 "Dumps a debug representation of the object to stderr.";
43
45 R"(Replace all uses of this value with the `with` value, except for those
46in `exceptions`. `exceptions` can be either a single operation or a list of
47operations.
48)";
49
50//------------------------------------------------------------------------------
51// Utilities.
52//------------------------------------------------------------------------------
53
54/// Local helper to compute std::hash for a value.
55template <typename T>
56static size_t hash(const T &value) {
57 return std::hash<T>{}(value);
58}
59
60static nb::object
61createCustomDialectWrapper(const std::string &dialectNamespace,
62 nb::object dialectDescriptor) {
63 auto dialectClass =
65 dialectNamespace);
66 if (!dialectClass) {
67 // Use the base class.
69 std::move(dialectDescriptor)));
70 }
71
72 // Create the custom implementation.
73 return (*dialectClass)(std::move(dialectDescriptor));
74}
75
76namespace mlir {
77namespace python {
79
80MlirBlock createBlock(
81 const nb::typed<nb::sequence, PyType> &pyArgTypes,
82 const std::optional<nb::typed<nb::sequence, PyLocation>> &pyArgLocs) {
83 std::vector<MlirType> argTypes;
84 argTypes.reserve(nb::len(pyArgTypes));
85 for (nb::handle pyType : pyArgTypes)
86 argTypes.push_back(
87 nb::cast<python::MLIR_BINDINGS_PYTHON_DOMAIN::PyType &>(pyType));
88
89 std::vector<MlirLocation> argLocs;
90 if (pyArgLocs) {
91 argLocs.reserve(nb::len(*pyArgLocs));
92 for (nb::handle pyLoc : *pyArgLocs)
93 argLocs.push_back(
94 nb::cast<python::MLIR_BINDINGS_PYTHON_DOMAIN::PyLocation &>(pyLoc));
95 } else if (!argTypes.empty()) {
96 argLocs.assign(
97 argTypes.size(),
99 }
100
101 if (argTypes.size() != argLocs.size())
102 throw nb::value_error(
103 join("Expected ", argTypes.size(), " locations, got: ", argLocs.size())
104 .c_str());
105 return mlirBlockCreate(argTypes.size(), argTypes.data(), argLocs.data());
106}
107
108void PyGlobalDebugFlag::set(nb::object &o, bool enable) {
109 nb::ft_lock_guard lock(mutex);
110 mlirEnableGlobalDebug(enable);
111}
112
113bool PyGlobalDebugFlag::get(const nb::object &) {
114 nb::ft_lock_guard lock(mutex);
116}
117
118void PyGlobalDebugFlag::bind(nb::module_ &m) {
119 // Debug flags.
120 nb::class_<PyGlobalDebugFlag>(m, "_GlobalDebug")
121 .def_prop_rw_static("flag", &PyGlobalDebugFlag::get,
122 &PyGlobalDebugFlag::set, "LLVM-wide debug flag.")
123 .def_static(
124 "set_types",
125 [](const std::string &type) {
126 nb::ft_lock_guard lock(mutex);
127 mlirSetGlobalDebugType(type.c_str());
128 },
129 "types"_a, "Sets specific debug types to be produced by LLVM.")
130 .def_static(
131 "set_types",
132 [](const std::vector<std::string> &types) {
133 std::vector<const char *> pointers;
134 pointers.reserve(types.size());
135 for (const std::string &str : types)
136 pointers.push_back(str.c_str());
137 nb::ft_lock_guard lock(mutex);
138 mlirSetGlobalDebugTypes(pointers.data(), pointers.size());
139 },
140 "types"_a,
141 "Sets multiple specific debug types to be produced by LLVM.");
142}
143
144nb::ft_mutex PyGlobalDebugFlag::mutex;
145
146bool PyAttrBuilderMap::dunderContains(const std::string &attributeKind) {
147 return PyGlobals::get().lookupAttributeBuilder(attributeKind).has_value();
148}
149
150nb::callable
151PyAttrBuilderMap::dunderGetItemNamed(const std::string &attributeKind) {
152 auto builder = PyGlobals::get().lookupAttributeBuilder(attributeKind);
153 if (!builder)
154 throw nb::key_error(attributeKind.c_str());
155 return *builder;
156}
157
158void PyAttrBuilderMap::dunderSetItemNamed(const std::string &attributeKind,
159 nb::callable func, bool replace,
160 bool allow_existing) {
161 PyGlobals::get().registerAttributeBuilder(attributeKind, std::move(func),
162 replace, allow_existing);
163}
164
165void PyAttrBuilderMap::bind(nb::module_ &m) {
166 nb::class_<PyAttrBuilderMap>(m, "AttrBuilder")
167 .def_static("contains", &PyAttrBuilderMap::dunderContains,
168 "attribute_kind"_a,
169 "Checks whether an attribute builder is registered for the "
170 "given attribute kind.")
171 .def_static("get", &PyAttrBuilderMap::dunderGetItemNamed,
172 "attribute_kind"_a,
173 "Gets the registered attribute builder for the given "
174 "attribute kind.")
175 .def_static("insert", &PyAttrBuilderMap::dunderSetItemNamed,
176 "attribute_kind"_a, "attr_builder"_a, "replace"_a = false,
177 "allow_existing"_a = false,
178 "Register an attribute builder for building MLIR "
179 "attributes from Python values.");
180}
181
182//------------------------------------------------------------------------------
183// PyBlock
184//------------------------------------------------------------------------------
185
187 return nb::steal<nb::object>(mlirPythonBlockToCapsule(get()));
188}
189
190//------------------------------------------------------------------------------
191// Collections.
192//------------------------------------------------------------------------------
193
197 length == -1 ? mlirOperationGetNumRegions(operation->get())
198 : length,
199 step),
200 operation(std::move(operation)) {}
201
202intptr_t PyRegionList::getRawNumElements() {
203 operation->checkValid();
204 return mlirOperationGetNumRegions(operation->get());
205}
206
207PyRegion PyRegionList::getRawElement(intptr_t pos) {
208 operation->checkValid();
209 return PyRegion(operation, mlirOperationGetRegion(operation->get(), pos));
210}
211
212PyRegionList PyRegionList::slice(intptr_t startIndex, intptr_t length,
213 intptr_t step) const {
214 return PyRegionList(operation, startIndex, length, step);
215}
216
217nb::typed<nb::object, PyBlock> PyBlockIterator::dunderNext() {
218 operation->checkValid();
219 if (mlirBlockIsNull(next)) {
220 PyErr_SetNone(PyExc_StopIteration);
221 // python functions should return NULL after setting any exception
222 return nb::object();
223 }
224
225 PyBlock returnBlock(operation, next);
226 next = mlirBlockGetNextInRegion(next);
227 return nb::cast(returnBlock);
228}
229
230void PyBlockIterator::bind(nb::module_ &m) {
231 nb::class_<PyBlockIterator>(m, "BlockIterator")
232 .def("__iter__", &PyBlockIterator::dunderIter,
233 "Returns an iterator over the blocks in the operation's region.")
234 .def("__next__", &PyBlockIterator::dunderNext,
235 "Returns the next block in the iteration.");
236}
237
239 operation->checkValid();
240 return PyBlockIterator(operation, mlirRegionGetFirstBlock(region));
241}
242
244 operation->checkValid();
245 intptr_t count = 0;
246 MlirBlock block = mlirRegionGetFirstBlock(region);
247 while (!mlirBlockIsNull(block)) {
248 count += 1;
249 block = mlirBlockGetNextInRegion(block);
250 }
251 return count;
252}
253
255 operation->checkValid();
256 if (index < 0) {
257 index += dunderLen();
258 }
259 if (index < 0) {
260 throw nb::index_error("attempt to access out of bounds block");
261 }
262 MlirBlock block = mlirRegionGetFirstBlock(region);
263 while (!mlirBlockIsNull(block)) {
264 if (index == 0) {
265 return PyBlock(operation, block);
266 }
267 block = mlirBlockGetNextInRegion(block);
268 index -= 1;
269 }
270 throw nb::index_error("attempt to access out of bounds block");
271}
272
273PyBlock PyBlockList::appendBlock(const nb::args &pyArgTypes,
274 const std::optional<nb::sequence> &pyArgLocs) {
275 operation->checkValid();
276 MlirBlock block = createBlock(nb::cast<nb::sequence>(pyArgTypes), pyArgLocs);
277 mlirRegionAppendOwnedBlock(region, block);
278 return PyBlock(operation, block);
279}
280
281void PyBlockList::bind(nb::module_ &m) {
282 nb::class_<PyBlockList>(m, "BlockList")
283 .def("__getitem__", &PyBlockList::dunderGetItem,
284 "Returns the block at the specified index.")
285 .def("__iter__", &PyBlockList::dunderIter,
286 "Returns an iterator over blocks in the operation's region.")
287 .def("__len__", &PyBlockList::dunderLen,
288 "Returns the number of blocks in the operation's region.")
289 .def("append", &PyBlockList::appendBlock,
290 R"(
291 Appends a new block, with argument types as positional args.
292
293 Returns:
294 The created block.
295 )",
296 "args"_a, nb::kw_only(), "arg_locs"_a = std::nullopt);
297}
298
299nb::typed<nb::object, PyOpView> PyOperationIterator::dunderNext() {
300 parentOperation->checkValid();
301 if (mlirOperationIsNull(next)) {
302 PyErr_SetNone(PyExc_StopIteration);
303 // python functions should return NULL after setting any exception
304 return nb::object();
305 }
306
307 PyOperationRef returnOperation =
308 PyOperation::forOperation(parentOperation->getContext(), next);
309 next = mlirOperationGetNextInBlock(next);
310 return returnOperation->createOpView();
311}
312
313void PyOperationIterator::bind(nb::module_ &m) {
314 nb::class_<PyOperationIterator>(m, "OperationIterator")
315 .def("__iter__", &PyOperationIterator::dunderIter,
316 "Returns an iterator over the operations in an operation's block.")
317 .def("__next__", &PyOperationIterator::dunderNext,
318 "Returns the next operation in the iteration.");
319}
320
322 parentOperation->checkValid();
323 return PyOperationIterator(parentOperation,
325}
326
328 parentOperation->checkValid();
329 intptr_t count = 0;
330 MlirOperation childOp = mlirBlockGetFirstOperation(block);
331 while (!mlirOperationIsNull(childOp)) {
332 count += 1;
333 childOp = mlirOperationGetNextInBlock(childOp);
334 }
335 return count;
336}
337
338nb::typed<nb::object, PyOpView> PyOperationList::dunderGetItem(intptr_t index) {
339 parentOperation->checkValid();
340 if (index < 0) {
341 index += dunderLen();
342 }
343 if (index < 0) {
344 throw nb::index_error("attempt to access out of bounds operation");
345 }
346 MlirOperation childOp = mlirBlockGetFirstOperation(block);
347 while (!mlirOperationIsNull(childOp)) {
348 if (index == 0) {
349 return PyOperation::forOperation(parentOperation->getContext(), childOp)
350 ->createOpView();
351 }
352 childOp = mlirOperationGetNextInBlock(childOp);
353 index -= 1;
354 }
355 throw nb::index_error("attempt to access out of bounds operation");
356}
357
358void PyOperationList::bind(nb::module_ &m) {
359 nb::class_<PyOperationList>(m, "OperationList")
360 .def("__getitem__", &PyOperationList::dunderGetItem,
361 "Returns the operation at the specified index.")
362 .def("__iter__", &PyOperationList::dunderIter,
363 "Returns an iterator over operations in the list.")
364 .def("__len__", &PyOperationList::dunderLen,
365 "Returns the number of operations in the list.");
366}
367
368nb::typed<nb::object, PyOpView> PyOpOperand::getOwner() const {
369 MlirOperation owner = mlirOpOperandGetOwner(opOperand);
373}
375size_t PyOpOperand::getOperandNumber() const {
376 return mlirOpOperandGetOperandNumber(opOperand);
377}
378
379void PyOpOperand::bind(nb::module_ &m) {
380 nb::class_<PyOpOperand>(m, "OpOperand")
381 .def_prop_ro("owner", &PyOpOperand::getOwner,
382 "Returns the operation that owns this operand.")
383 .def_prop_ro("operand_number", &PyOpOperand::getOperandNumber,
384 "Returns the operand number in the owning operation.");
385}
386
387nb::typed<nb::object, PyOpOperand> PyOpOperandIterator::dunderNext() {
388 if (mlirOpOperandIsNull(opOperand)) {
389 PyErr_SetNone(PyExc_StopIteration);
390 // python functions should return NULL after setting any exception
391 return nb::object();
392 }
393
394 PyOpOperand returnOpOperand(opOperand);
395 opOperand = mlirOpOperandGetNextUse(opOperand);
396 return nb::cast(returnOpOperand);
397}
398
399void PyOpOperandIterator::bind(nb::module_ &m) {
400 nb::class_<PyOpOperandIterator>(m, "OpOperandIterator")
401 .def("__iter__", &PyOpOperandIterator::dunderIter,
402 "Returns an iterator over operands.")
403 .def("__next__", &PyOpOperandIterator::dunderNext,
404 "Returns the next operand in the iteration.");
405}
407//------------------------------------------------------------------------------
408// PyThreadPool
409//------------------------------------------------------------------------------
410
412
414 if (threadPool.ptr)
415 mlirLlvmThreadPoolDestroy(threadPool);
416}
419 return mlirLlvmThreadPoolGetMaxConcurrency(threadPool);
420}
421
422std::string PyThreadPool::_mlir_thread_pool_ptr() const {
423 std::stringstream ss;
424 ss << threadPool.ptr;
425 return ss.str();
426}
428//------------------------------------------------------------------------------
429// PyMlirContext
430//------------------------------------------------------------------------------
431
432PyMlirContext::PyMlirContext(MlirContext context) : context(context) {
433 nb::gil_scoped_acquire acquire;
434 nb::ft_lock_guard lock(live_contexts_mutex);
435 auto &liveContexts = getLiveContexts();
436 liveContexts[context.ptr] = this;
437}
438
440 // Note that the only public way to construct an instance is via the
441 // forContext method, which always puts the associated handle into
442 // liveContexts.
443 nb::gil_scoped_acquire acquire;
444 {
445 nb::ft_lock_guard lock(live_contexts_mutex);
446 getLiveContexts().erase(context.ptr);
447 }
448 mlirContextDestroy(context);
449}
452 return PyMlirContextRef(this, nb::cast(this));
453}
455nb::object PyMlirContext::getCapsule() {
456 return nb::steal<nb::object>(mlirPythonContextToCapsule(get()));
457}
458
459nb::object PyMlirContext::createFromCapsule(nb::object capsule) {
460 MlirContext rawContext = mlirPythonCapsuleToContext(capsule.ptr());
461 if (mlirContextIsNull(rawContext))
462 throw nb::python_error();
463 return forContext(rawContext).releaseObject();
464}
465
466PyMlirContextRef PyMlirContext::forContext(MlirContext context) {
467 nb::gil_scoped_acquire acquire;
468 nb::ft_lock_guard lock(live_contexts_mutex);
469 auto &liveContexts = getLiveContexts();
470 auto it = liveContexts.find(context.ptr);
471 if (it == liveContexts.end()) {
472 // Create.
473 PyMlirContext *unownedContextWrapper = new PyMlirContext(context);
474 nb::object pyRef = nb::cast(unownedContextWrapper);
475 assert(pyRef && "cast to nb::object failed");
476 liveContexts[context.ptr] = unownedContextWrapper;
477 return PyMlirContextRef(unownedContextWrapper, std::move(pyRef));
478 }
479 // Use existing.
480 nb::object pyRef = nb::cast(it->second);
481 return PyMlirContextRef(it->second, std::move(pyRef));
482}
483
484nb::ft_mutex PyMlirContext::live_contexts_mutex;
485
486PyMlirContext::LiveContextMap &PyMlirContext::getLiveContexts() {
487 static LiveContextMap liveContexts;
488 return liveContexts;
489}
490
492 nb::ft_lock_guard lock(live_contexts_mutex);
493 return getLiveContexts().size();
494}
496nb::object PyMlirContext::contextEnter(nb::object context) {
497 return PyThreadContextEntry::pushContext(context);
498}
499
500void PyMlirContext::contextExit(const nb::object &excType,
501 const nb::object &excVal,
502 const nb::object &excTb) {
504}
505
506nb::object PyMlirContext::attachDiagnosticHandler(nb::object callback) {
507 // Note that ownership is transferred to the delete callback below by way of
508 // an explicit inc_ref (borrow).
509 PyDiagnosticHandler *pyHandler =
510 new PyDiagnosticHandler(get(), std::move(callback));
511 nb::object pyHandlerObject =
512 nb::cast(pyHandler, nb::rv_policy::take_ownership);
513 (void)pyHandlerObject.inc_ref();
514
515 // In these C callbacks, the userData is a PyDiagnosticHandler* that is
516 // guaranteed to be known to pybind.
517 auto handlerCallback =
518 +[](MlirDiagnostic diagnostic, void *userData) -> MlirLogicalResult {
519 PyDiagnostic *pyDiagnostic = new PyDiagnostic(diagnostic);
520 nb::object pyDiagnosticObject =
521 nb::cast(pyDiagnostic, nb::rv_policy::take_ownership);
522
523 auto *pyHandler = static_cast<PyDiagnosticHandler *>(userData);
524 bool result = false;
525 {
526 // Since this can be called from arbitrary C++ contexts, always get the
527 // gil.
528 nb::gil_scoped_acquire gil;
529 try {
530 result = nb::cast<bool>(pyHandler->callback(pyDiagnostic));
531 } catch (std::exception &e) {
532 fprintf(stderr, "MLIR Python Diagnostic handler raised exception: %s\n",
533 e.what());
534 pyHandler->hadError = true;
535 }
536 }
537
538 pyDiagnostic->invalidate();
540 };
541 auto deleteCallback = +[](void *userData) {
542 auto *pyHandler = static_cast<PyDiagnosticHandler *>(userData);
543 assert(pyHandler->registeredID && "handler is not registered");
544 pyHandler->registeredID.reset();
545
546 // Decrement reference, balancing the inc_ref() above.
547 nb::object pyHandlerObject = nb::cast(pyHandler, nb::rv_policy::reference);
548 pyHandlerObject.dec_ref();
549 };
550
551 pyHandler->registeredID = mlirContextAttachDiagnosticHandler(
552 get(), handlerCallback, static_cast<void *>(pyHandler), deleteCallback);
553 return pyHandlerObject;
554}
555
556MlirLogicalResult PyMlirContext::ErrorCapture::handler(MlirDiagnostic diag,
557 void *userData) {
558 auto *self = static_cast<ErrorCapture *>(userData);
559 // Check if the context requested we emit errors instead of capturing them.
560 if (self->ctx->emitErrorDiagnostics)
562
564 MlirDiagnosticSeverity::MlirDiagnosticError)
567 self->errors.emplace_back(PyDiagnostic(diag).getInfo());
569}
570
573 if (!context) {
574 throw std::runtime_error(
575 "An MLIR function requires a Context but none was provided in the call "
576 "or from the surrounding environment. Either pass to the function with "
577 "a 'context=' argument or establish a default using 'with Context():'");
578 }
579 return *context;
580}
582//------------------------------------------------------------------------------
583// PyThreadContextEntry management
584//------------------------------------------------------------------------------
585
586std::vector<PyThreadContextEntry> &PyThreadContextEntry::getStack() {
587 static thread_local std::vector<PyThreadContextEntry> stack;
588 return stack;
589}
590
592 auto &stack = getStack();
593 if (stack.empty())
594 return nullptr;
595 return &stack.back();
596}
597
598void PyThreadContextEntry::push(FrameKind frameKind, nb::object context,
599 nb::object insertionPoint,
600 nb::object location) {
601 auto &stack = getStack();
602 stack.emplace_back(frameKind, std::move(context), std::move(insertionPoint),
603 std::move(location));
604 // If the new stack has more than one entry and the context of the new top
605 // entry matches the previous, copy the insertionPoint and location from the
606 // previous entry if missing from the new top entry.
607 if (stack.size() > 1) {
608 auto &prev = *(stack.rbegin() + 1);
609 auto &current = stack.back();
610 if (current.context.is(prev.context)) {
611 // Default non-context objects from the previous entry.
612 if (!current.insertionPoint)
613 current.insertionPoint = prev.insertionPoint;
614 if (!current.location)
615 current.location = prev.location;
616 }
617 }
618}
619
621 if (!context)
622 return nullptr;
623 return nb::cast<PyMlirContext *>(context);
624}
625
627 if (!insertionPoint)
628 return nullptr;
629 return nb::cast<PyInsertionPoint *>(insertionPoint);
630}
631
633 if (!location)
634 return nullptr;
635 return nb::cast<PyLocation *>(location);
636}
637
639 auto *tos = getTopOfStack();
640 return tos ? tos->getContext() : nullptr;
641}
642
644 auto *tos = getTopOfStack();
645 return tos ? tos->getInsertionPoint() : nullptr;
646}
647
649 auto *tos = getTopOfStack();
650 return tos ? tos->getLocation() : nullptr;
651}
652
653nb::object PyThreadContextEntry::pushContext(nb::object context) {
654 push(FrameKind::Context, /*context=*/context,
655 /*insertionPoint=*/nb::object(),
656 /*location=*/nb::object());
657 return context;
658}
659
661 auto &stack = getStack();
662 if (stack.empty())
663 throw std::runtime_error("Unbalanced Context enter/exit");
664 auto &tos = stack.back();
665 if (tos.frameKind != FrameKind::Context && tos.getContext() != &context)
666 throw std::runtime_error("Unbalanced Context enter/exit");
667 stack.pop_back();
668}
669
670nb::object
671PyThreadContextEntry::pushInsertionPoint(nb::object insertionPointObj) {
672 PyInsertionPoint &insertionPoint =
673 nb::cast<PyInsertionPoint &>(insertionPointObj);
674 nb::object contextObj =
675 insertionPoint.getBlock().getParentOperation()->getContext().getObject();
676 push(FrameKind::InsertionPoint,
677 /*context=*/contextObj,
678 /*insertionPoint=*/insertionPointObj,
679 /*location=*/nb::object());
680 return insertionPointObj;
681}
682
684 auto &stack = getStack();
685 if (stack.empty())
686 throw std::runtime_error("Unbalanced InsertionPoint enter/exit");
687 auto &tos = stack.back();
688 if (tos.frameKind != FrameKind::InsertionPoint &&
689 tos.getInsertionPoint() != &insertionPoint)
690 throw std::runtime_error("Unbalanced InsertionPoint enter/exit");
691 stack.pop_back();
692}
693
694nb::object PyThreadContextEntry::pushLocation(nb::object locationObj) {
695 PyLocation &location = nb::cast<PyLocation &>(locationObj);
696 nb::object contextObj = location.getContext().getObject();
697 push(FrameKind::Location, /*context=*/contextObj,
698 /*insertionPoint=*/nb::object(),
699 /*location=*/locationObj);
700 return locationObj;
701}
702
704 auto &stack = getStack();
705 if (stack.empty())
706 throw std::runtime_error("Unbalanced Location enter/exit");
707 auto &tos = stack.back();
708 if (tos.frameKind != FrameKind::Location && tos.getLocation() != &location)
709 throw std::runtime_error("Unbalanced Location enter/exit");
710 stack.pop_back();
711}
713//------------------------------------------------------------------------------
714// PyDiagnostic*
715//------------------------------------------------------------------------------
716
718 valid = false;
719 if (materializedNotes) {
720 for (nb::handle noteObject : *materializedNotes) {
721 PyDiagnostic *note = nb::cast<PyDiagnostic *>(noteObject);
722 note->invalidate();
723 }
724 }
725}
726
728 nb::object callback)
729 : context(context), callback(std::move(callback)) {}
730
732
734 if (!registeredID)
735 return;
736 MlirDiagnosticHandlerID localID = *registeredID;
737 mlirContextDetachDiagnosticHandler(context, localID);
738 assert(!registeredID && "should have unregistered");
739 // Not strictly necessary but keeps stale pointers from being around to cause
740 // issues.
741 context = {nullptr};
742}
743
744void PyDiagnostic::checkValid() {
745 if (!valid) {
746 throw std::invalid_argument(
747 "Diagnostic is invalid (used outside of callback)");
748 }
749}
750
752 checkValid();
753 return static_cast<PyDiagnosticSeverity>(
754 mlirDiagnosticGetSeverity(diagnostic));
755}
756
758 checkValid();
759 MlirLocation loc = mlirDiagnosticGetLocation(diagnostic);
760 MlirContext context = mlirLocationGetContext(loc);
761 return PyLocation(PyMlirContext::forContext(context), loc);
762}
763
764nb::str PyDiagnostic::getMessage() {
765 checkValid();
766 nb::object fileObject = nb::module_::import_("io").attr("StringIO")();
767 PyFileAccumulator accum(fileObject, /*binary=*/false);
768 mlirDiagnosticPrint(diagnostic, accum.getCallback(), accum.getUserData());
769 return nb::cast<nb::str>(fileObject.attr("getvalue")());
770}
771
772nb::typed<nb::tuple, PyDiagnostic> PyDiagnostic::getNotes() {
773 checkValid();
774 if (materializedNotes)
775 return *materializedNotes;
776 intptr_t numNotes = mlirDiagnosticGetNumNotes(diagnostic);
777 nb::tuple notes = nb::steal<nb::tuple>(PyTuple_New(numNotes));
778 for (intptr_t i = 0; i < numNotes; ++i) {
779 MlirDiagnostic noteDiag = mlirDiagnosticGetNote(diagnostic, i);
780 nb::object diagnostic = nb::cast(PyDiagnostic(noteDiag));
781 PyTuple_SetItem(notes.ptr(), i, diagnostic.release().ptr());
782 }
783 materializedNotes = std::move(notes);
784
785 return *materializedNotes;
786}
787
789 std::vector<DiagnosticInfo> notes;
790 for (nb::handle n : getNotes())
791 notes.emplace_back(nb::cast<PyDiagnostic>(n).getInfo());
792 return {getSeverity(), getLocation(), nb::cast<std::string>(getMessage()),
793 std::move(notes)};
794}
796//------------------------------------------------------------------------------
797// PyDialect, PyDialectDescriptor, PyDialects, PyDialectRegistry
798//------------------------------------------------------------------------------
799
800MlirDialect PyDialects::getDialectForKey(const std::string &key,
801 bool attrError) {
802 MlirDialect dialect = mlirContextGetOrLoadDialect(getContext()->get(),
803 {key.data(), key.size()});
804 if (mlirDialectIsNull(dialect)) {
805 std::string msg = join("Dialect '", key, "' not found");
806 if (attrError)
807 throw nb::attribute_error(msg.c_str());
808 throw nb::index_error(msg.c_str());
809 }
810 return dialect;
811}
814 return nb::steal<nb::object>(mlirPythonDialectRegistryToCapsule(*this));
815}
816
818 MlirDialectRegistry rawRegistry =
820 if (mlirDialectRegistryIsNull(rawRegistry))
821 throw nb::python_error();
822 return PyDialectRegistry(rawRegistry);
823}
825//------------------------------------------------------------------------------
826// PyLocation
827//------------------------------------------------------------------------------
829nb::object PyLocation::getCapsule() {
830 return nb::steal<nb::object>(mlirPythonLocationToCapsule(*this));
831}
832
833PyLocation PyLocation::createFromCapsule(nb::object capsule) {
834 MlirLocation rawLoc = mlirPythonCapsuleToLocation(capsule.ptr());
835 if (mlirLocationIsNull(rawLoc))
836 throw nb::python_error();
838 rawLoc);
839}
841nb::object PyLocation::contextEnter(nb::object locationObj) {
842 return PyThreadContextEntry::pushLocation(locationObj);
843}
844
845void PyLocation::contextExit(const nb::object &excType,
846 const nb::object &excVal,
847 const nb::object &excTb) {
849}
850
853 if (!location) {
854 throw std::runtime_error(
855 "An MLIR function requires a Location but none was provided in the "
856 "call or from the surrounding environment. Either pass to the function "
857 "with a 'loc=' argument or establish a default using 'with loc:'");
858 }
859 return *location;
860}
861
862//------------------------------------------------------------------------------
863// PyModule
864//------------------------------------------------------------------------------
865
866PyModule::PyModule(PyMlirContextRef contextRef, MlirModule module)
867 : BaseContextObject(std::move(contextRef)), module(module) {}
868
870 nb::gil_scoped_acquire acquire;
871 auto &liveModules = getContext()->liveModules;
872 assert(liveModules.count(module.ptr) == 1 &&
873 "destroying module not in live map");
874 liveModules.erase(module.ptr);
875 mlirModuleDestroy(module);
876}
877
878PyModuleRef PyModule::forModule(MlirModule module) {
879 MlirContext context = mlirModuleGetContext(module);
880 PyMlirContextRef contextRef = PyMlirContext::forContext(context);
881
882 nb::gil_scoped_acquire acquire;
883 auto &liveModules = contextRef->liveModules;
884 auto it = liveModules.find(module.ptr);
885 if (it == liveModules.end()) {
886 // Create.
887 PyModule *unownedModule = new PyModule(std::move(contextRef), module);
888 // Note that the default return value policy on cast is automatic_reference,
889 // which does not take ownership (delete will not be called).
890 // Just be explicit.
891 nb::object pyRef = nb::cast(unownedModule, nb::rv_policy::take_ownership);
892 unownedModule->handle = pyRef;
893 liveModules[module.ptr] =
894 std::make_pair(unownedModule->handle, unownedModule);
895 return PyModuleRef(unownedModule, std::move(pyRef));
896 }
897 // Use existing.
898 PyModule *existing = it->second.second;
899 nb::object pyRef = nb::borrow<nb::object>(it->second.first);
900 return PyModuleRef(existing, std::move(pyRef));
901}
902
903nb::object PyModule::createFromCapsule(nb::object capsule) {
904 MlirModule rawModule = mlirPythonCapsuleToModule(capsule.ptr());
905 if (mlirModuleIsNull(rawModule))
906 throw nb::python_error();
907 return forModule(rawModule).releaseObject();
908}
909
910nb::object PyModule::getCapsule() {
911 return nb::steal<nb::object>(mlirPythonModuleToCapsule(get()));
912}
914//------------------------------------------------------------------------------
915// PyOperation
916//------------------------------------------------------------------------------
917
918PyOperation::PyOperation(PyMlirContextRef contextRef, MlirOperation operation)
919 : BaseContextObject(std::move(contextRef)), operation(operation) {}
920
922 // If the operation has already been invalidated there is nothing to do.
923 if (!valid)
924 return;
925 // Otherwise, invalidate the operation when it is attached.
926 if (isAttached())
927 setInvalid();
928 else {
929 // And destroy it when it is detached, i.e. owned by Python.
930 erase();
931 }
932}
933
934namespace {
935
936// Constructs a new object of type T in-place on the Python heap, returning a
937// PyObjectRef to it, loosely analogous to std::make_shared<T>().
938template <typename T, class... Args>
939PyObjectRef<T> makeObjectRef(Args &&...args) {
940 nb::handle type = nb::type<T>();
941 nb::object instance = nb::inst_alloc(type);
942 T *ptr = nb::inst_ptr<T>(instance);
943 new (ptr) T(std::forward<Args>(args)...);
944 nb::inst_mark_ready(instance);
945 return PyObjectRef<T>(ptr, std::move(instance));
946}
947
948} // namespace
949
950PyOperationRef PyOperation::createInstance(PyMlirContextRef contextRef,
951 MlirOperation operation,
952 nb::object parentKeepAlive) {
953 // Create.
954 PyOperationRef unownedOperation =
955 makeObjectRef<PyOperation>(std::move(contextRef), operation);
956 unownedOperation->handle = unownedOperation.getObject();
957 if (parentKeepAlive) {
958 unownedOperation->parentKeepAlive = std::move(parentKeepAlive);
959 }
960 return unownedOperation;
961}
962
964 MlirOperation operation,
965 nb::object parentKeepAlive) {
966 return createInstance(std::move(contextRef), operation,
967 std::move(parentKeepAlive));
968}
969
971 MlirOperation operation,
972 nb::object parentKeepAlive) {
973 PyOperationRef created = createInstance(std::move(contextRef), operation,
974 std::move(parentKeepAlive));
975 created->attached = false;
976 return created;
977}
978
980 const std::string &sourceStr,
981 const std::string &sourceName) {
982 PyMlirContext::ErrorCapture errors(contextRef);
983 MlirOperation op =
984 mlirOperationCreateParse(contextRef->get(), toMlirStringRef(sourceStr),
985 toMlirStringRef(sourceName));
986 if (mlirOperationIsNull(op))
987 throw MLIRError("Unable to parse operation assembly", errors.take());
988 return PyOperation::createDetached(std::move(contextRef), op);
989}
990
993 setDetached();
994 parentKeepAlive = nb::object();
995}
996
997MlirOperation PyOperation::get() const {
998 checkValid();
999 return operation;
1000}
1003 return PyOperationRef(this, nb::borrow<nb::object>(handle));
1004}
1005
1006void PyOperation::setAttached(const nb::object &parent) {
1007 assert(!attached && "operation already attached");
1008 attached = true;
1009}
1010
1012 assert(attached && "operation already detached");
1013 attached = false;
1014}
1015
1016void PyOperation::checkValid() const {
1017 if (!valid) {
1018 throw std::runtime_error("the operation has been invalidated");
1019 }
1020}
1021
1022void PyOperationBase::print(std::optional<int64_t> largeElementsLimit,
1023 std::optional<int64_t> largeResourceLimit,
1024 bool enableDebugInfo, bool prettyDebugInfo,
1025 bool printGenericOpForm, bool useLocalScope,
1026 bool useNameLocAsPrefix, bool assumeVerified,
1027 nb::object fileObject, bool binary,
1028 bool skipRegions) {
1029 PyOperation &operation = getOperation();
1030 operation.checkValid();
1031 if (fileObject.is_none())
1032 fileObject = nb::module_::import_("sys").attr("stdout");
1033
1034 MlirOpPrintingFlags flags = mlirOpPrintingFlagsCreate();
1035 if (largeElementsLimit)
1036 mlirOpPrintingFlagsElideLargeElementsAttrs(flags, *largeElementsLimit);
1037 if (largeResourceLimit)
1038 mlirOpPrintingFlagsElideLargeResourceString(flags, *largeResourceLimit);
1039 if (enableDebugInfo)
1040 mlirOpPrintingFlagsEnableDebugInfo(flags, /*enable=*/true,
1041 /*prettyForm=*/prettyDebugInfo);
1042 if (printGenericOpForm)
1044 if (useLocalScope)
1046 if (assumeVerified)
1048 if (skipRegions)
1050 if (useNameLocAsPrefix)
1052
1053 PyFileAccumulator accum(fileObject, binary);
1054 mlirOperationPrintWithFlags(operation, flags, accum.getCallback(),
1055 accum.getUserData());
1057}
1058
1059void PyOperationBase::print(PyAsmState &state, nb::object fileObject,
1060 bool binary) {
1061 PyOperation &operation = getOperation();
1062 operation.checkValid();
1063 if (fileObject.is_none())
1064 fileObject = nb::module_::import_("sys").attr("stdout");
1065 PyFileAccumulator accum(fileObject, binary);
1066 mlirOperationPrintWithState(operation, state.get(), accum.getCallback(),
1067 accum.getUserData());
1068}
1069
1070void PyOperationBase::writeBytecode(const nb::object &fileOrStringObject,
1071 std::optional<int64_t> bytecodeVersion) {
1072 PyOperation &operation = getOperation();
1073 operation.checkValid();
1074 PyFileAccumulator accum(fileOrStringObject, /*binary=*/true);
1075
1076 if (!bytecodeVersion.has_value())
1077 return mlirOperationWriteBytecode(operation, accum.getCallback(),
1078 accum.getUserData());
1079
1080 MlirBytecodeWriterConfig config = mlirBytecodeWriterConfigCreate();
1081 mlirBytecodeWriterConfigDesiredEmitVersion(config, *bytecodeVersion);
1083 operation, config, accum.getCallback(), accum.getUserData());
1086 throw nb::value_error(
1087 join("Unable to honor desired bytecode version ", *bytecodeVersion)
1088 .c_str());
1089}
1090
1091void PyOperationBase::walk(std::function<PyWalkResult(MlirOperation)> callback,
1092 PyWalkOrder walkOrder) {
1093 PyOperation &operation = getOperation();
1094 operation.checkValid();
1095 struct UserData {
1096 std::function<PyWalkResult(MlirOperation)> callback;
1097 bool gotException;
1098 std::string exceptionWhat;
1099 nb::object exceptionType;
1100 };
1101 UserData userData{callback, false, {}, {}};
1102 MlirOperationWalkCallback walkCallback = [](MlirOperation op,
1103 void *userData) {
1104 UserData *calleeUserData = static_cast<UserData *>(userData);
1105 try {
1106 return static_cast<MlirWalkResult>((calleeUserData->callback)(op));
1107 } catch (nb::python_error &e) {
1108 calleeUserData->gotException = true;
1109 calleeUserData->exceptionWhat = std::string(e.what());
1110 calleeUserData->exceptionType = nb::borrow(e.type());
1111 return MlirWalkResult::MlirWalkResultInterrupt;
1112 }
1113 };
1114 mlirOperationWalk(operation, walkCallback, &userData,
1115 static_cast<MlirWalkOrder>(walkOrder));
1116 if (userData.gotException) {
1117 std::string message("Exception raised in callback: ");
1118 message.append(userData.exceptionWhat);
1119 throw std::runtime_error(message);
1120 }
1121}
1122
1123nb::object PyOperationBase::getAsm(bool binary,
1124 std::optional<int64_t> largeElementsLimit,
1125 std::optional<int64_t> largeResourceLimit,
1126 bool enableDebugInfo, bool prettyDebugInfo,
1127 bool printGenericOpForm, bool useLocalScope,
1128 bool useNameLocAsPrefix, bool assumeVerified,
1129 bool skipRegions) {
1130 nb::object fileObject;
1131 if (binary) {
1132 fileObject = nb::module_::import_("io").attr("BytesIO")();
1133 } else {
1134 fileObject = nb::module_::import_("io").attr("StringIO")();
1135 }
1136 print(/*largeElementsLimit=*/largeElementsLimit,
1137 /*largeResourceLimit=*/largeResourceLimit,
1138 /*enableDebugInfo=*/enableDebugInfo,
1139 /*prettyDebugInfo=*/prettyDebugInfo,
1140 /*printGenericOpForm=*/printGenericOpForm,
1141 /*useLocalScope=*/useLocalScope,
1142 /*useNameLocAsPrefix=*/useNameLocAsPrefix,
1143 /*assumeVerified=*/assumeVerified,
1144 /*fileObject=*/fileObject,
1145 /*binary=*/binary,
1146 /*skipRegions=*/skipRegions);
1147
1148 return fileObject.attr("getvalue")();
1149}
1150
1152 PyOperation &operation = getOperation();
1153 PyOperation &otherOp = other.getOperation();
1154 operation.checkValid();
1155 otherOp.checkValid();
1156 mlirOperationMoveAfter(operation, otherOp);
1157 operation.parentKeepAlive = otherOp.parentKeepAlive;
1158}
1159
1161 PyOperation &operation = getOperation();
1162 PyOperation &otherOp = other.getOperation();
1163 operation.checkValid();
1164 otherOp.checkValid();
1165 mlirOperationMoveBefore(operation, otherOp);
1166 operation.parentKeepAlive = otherOp.parentKeepAlive;
1167}
1168
1170 PyOperation &operation = getOperation();
1171 PyOperation &otherOp = other.getOperation();
1172 operation.checkValid();
1173 otherOp.checkValid();
1174 return mlirOperationIsBeforeInBlock(operation, otherOp);
1175}
1176
1178 PyOperation &op = getOperation();
1181 throw MLIRError("Verification failed", errors.take());
1182 return true;
1183}
1184
1185std::optional<PyOperationRef> PyOperation::getParentOperation() {
1186 checkValid();
1187 if (!isAttached())
1188 throw nb::value_error("Detached operations have no parent");
1189 MlirOperation operation = mlirOperationGetParentOperation(get());
1190 if (mlirOperationIsNull(operation))
1191 return {};
1192 return PyOperation::forOperation(getContext(), operation);
1193}
1194
1196 checkValid();
1197 std::optional<PyOperationRef> parentOperation = getParentOperation();
1198 MlirBlock block = mlirOperationGetBlock(get());
1199 assert(!mlirBlockIsNull(block) && "Attached operation has null parent");
1200 assert(parentOperation && "Operation has no parent");
1201 return PyBlock{std::move(*parentOperation), block};
1202}
1203
1205 checkValid();
1206 return nb::steal<nb::object>(mlirPythonOperationToCapsule(get()));
1207}
1208
1209nb::object PyOperation::createFromCapsule(const nb::object &capsule) {
1210 MlirOperation rawOperation = mlirPythonCapsuleToOperation(capsule.ptr());
1211 if (mlirOperationIsNull(rawOperation))
1212 throw nb::python_error();
1213 MlirContext rawCtxt = mlirOperationGetContext(rawOperation);
1214 return forOperation(PyMlirContext::forContext(rawCtxt), rawOperation)
1215 .releaseObject();
1216}
1217
1218static void maybeInsertOperation(PyOperationRef &op,
1219 const nb::object &maybeIp) {
1220 // InsertPoint active?
1221 if (!maybeIp.is(nb::cast(false))) {
1222 PyInsertionPoint *ip;
1223 if (maybeIp.is_none()) {
1225 } else {
1226 ip = nb::cast<PyInsertionPoint *>(maybeIp);
1227 }
1228 if (ip)
1229 ip->insert(*op.get());
1230 }
1231}
1232
1233nb::object PyOperation::create(std::string_view name,
1234 std::optional<std::vector<PyType *>> results,
1235 const MlirValue *operands, size_t numOperands,
1236 std::optional<nb::dict> attributes,
1237 std::optional<std::vector<PyBlock *>> successors,
1238 int regions, PyLocation &location,
1239 const nb::object &maybeIp, bool inferType) {
1240 std::vector<MlirType> mlirResults;
1241 std::vector<MlirBlock> mlirSuccessors;
1242 std::vector<std::pair<std::string, MlirAttribute>> mlirAttributes;
1243
1244 // General parameter validation.
1245 if (regions < 0)
1246 throw nb::value_error("number of regions must be >= 0");
1247
1248 // Unpack/validate results.
1249 if (results) {
1250 mlirResults.reserve(results->size());
1251 for (PyType *result : *results) {
1252 // TODO: Verify result type originate from the same context.
1253 if (!result)
1254 throw nb::value_error("result type cannot be None");
1255 mlirResults.push_back(*result);
1256 }
1257 }
1258 // Unpack/validate attributes.
1259 if (attributes) {
1260 mlirAttributes.reserve(attributes->size());
1261 for (std::pair<nb::handle, nb::handle> it : *attributes) {
1262 std::string key;
1263 try {
1264 key = nb::cast<std::string>(it.first);
1265 } catch (nb::cast_error &err) {
1266 std::string msg = join("Invalid attribute key (not a string) when "
1267 "attempting to create the operation \"",
1268 name, "\" (", err.what(), ")");
1269 throw nb::type_error(msg.c_str());
1270 }
1271 try {
1272 auto &attribute = nb::cast<PyAttribute &>(it.second);
1273 // TODO: Verify attribute originates from the same context.
1274 mlirAttributes.emplace_back(std::move(key), attribute);
1275 } catch (nb::cast_error &err) {
1276 std::string msg = join("Invalid attribute value for the key \"", key,
1277 "\" when attempting to create the operation \"",
1278 name, "\" (", err.what(), ")");
1279 throw nb::type_error(msg.c_str());
1280 } catch (std::runtime_error &) {
1281 // This exception seems thrown when the value is "None".
1282 std::string msg = join(
1283 "Found an invalid (`None`?) attribute value for the key \"", key,
1284 "\" when attempting to create the operation \"", name, "\"");
1285 throw std::runtime_error(msg);
1286 }
1287 }
1288 }
1289 // Unpack/validate successors.
1290 if (successors) {
1291 mlirSuccessors.reserve(successors->size());
1292 for (PyBlock *successor : *successors) {
1293 // TODO: Verify successor originate from the same context.
1294 if (!successor)
1295 throw nb::value_error("successor block cannot be None");
1296 mlirSuccessors.push_back(successor->get());
1297 }
1298 }
1299
1300 // Apply unpacked/validated to the operation state. Beyond this
1301 // point, exceptions cannot be thrown or else the state will leak.
1302 MlirOperationState state =
1303 mlirOperationStateGet(toMlirStringRef(name), location);
1304 if (numOperands > 0)
1305 mlirOperationStateAddOperands(&state, numOperands, operands);
1306 state.enableResultTypeInference = inferType;
1307 if (!mlirResults.empty())
1308 mlirOperationStateAddResults(&state, mlirResults.size(),
1309 mlirResults.data());
1310 if (!mlirAttributes.empty()) {
1311 // Note that the attribute names directly reference bytes in
1312 // mlirAttributes, so that vector must not be changed from here
1313 // on.
1314 std::vector<MlirNamedAttribute> mlirNamedAttributes;
1315 mlirNamedAttributes.reserve(mlirAttributes.size());
1316 for (const std::pair<std::string, MlirAttribute> &it : mlirAttributes)
1317 mlirNamedAttributes.push_back(mlirNamedAttributeGet(
1319 toMlirStringRef(it.first)),
1320 it.second));
1321 mlirOperationStateAddAttributes(&state, mlirNamedAttributes.size(),
1322 mlirNamedAttributes.data());
1323 }
1324 if (!mlirSuccessors.empty())
1325 mlirOperationStateAddSuccessors(&state, mlirSuccessors.size(),
1326 mlirSuccessors.data());
1327 if (regions) {
1328 std::vector<MlirRegion> mlirRegions;
1329 mlirRegions.resize(regions);
1330 for (int i = 0; i < regions; ++i)
1331 mlirRegions[i] = mlirRegionCreate();
1332 mlirOperationStateAddOwnedRegions(&state, mlirRegions.size(),
1333 mlirRegions.data());
1334 }
1335
1336 // Construct the operation.
1337 PyMlirContext::ErrorCapture errors(location.getContext());
1338 MlirOperation operation = mlirOperationCreate(&state);
1339 if (!operation.ptr)
1340 throw MLIRError("Operation creation failed", errors.take());
1341 PyOperationRef created =
1342 PyOperation::createDetached(location.getContext(), operation);
1343 maybeInsertOperation(created, maybeIp);
1344
1345 return created.getObject();
1346}
1347
1348nb::object PyOperation::clone(const nb::object &maybeIp) {
1349 MlirOperation clonedOperation = mlirOperationClone(operation);
1350 PyOperationRef cloned =
1351 PyOperation::createDetached(getContext(), clonedOperation);
1352 maybeInsertOperation(cloned, maybeIp);
1353
1354 return cloned->createOpView();
1355}
1356
1357nb::object PyOperation::createOpView() {
1358 checkValid();
1359 MlirIdentifier ident = mlirOperationGetName(get());
1360 MlirStringRef identStr = mlirIdentifierStr(ident);
1361 auto operationCls = PyGlobals::get().lookupOperationClass(
1362 std::string_view(identStr.data, identStr.length));
1363 if (operationCls)
1364 return PyOpView::constructDerived(*operationCls, getRef().getObject());
1365 return nb::cast(PyOpView(getRef().getObject()));
1366}
1367
1368void PyOperation::erase() {
1370 setInvalid();
1371 mlirOperationDestroy(operation);
1372}
1373
1374void PyOpResult::bindDerived(ClassTy &c) {
1375 c.def_prop_ro(
1376 "owner",
1377 [](PyOpResult &self) -> nb::typed<nb::object, PyOpView> {
1378 assert(mlirOperationEqual(self.getParentOperation()->get(),
1379 mlirOpResultGetOwner(self.get())) &&
1380 "expected the owner of the value in Python to match that in "
1381 "the IR");
1382 return self.getParentOperation()->createOpView();
1383 },
1384 "Returns the operation that produces this result.");
1385 c.def_prop_ro(
1386 "result_number",
1387 [](PyOpResult &self) { return mlirOpResultGetResultNumber(self.get()); },
1388 "Returns the position of this result in the operation's result list.");
1390
1391/// Returns the list of types of the values held by container.
1392template <typename Container>
1393static std::vector<nb::typed<nb::object, PyType>>
1394getValueTypes(Container &container, PyMlirContextRef &context) {
1395 std::vector<nb::typed<nb::object, PyType>> result;
1396 result.reserve(container.size());
1397 for (int i = 0, e = container.size(); i < e; ++i) {
1398 result.push_back(PyType(context->getRef(),
1399 mlirValueGetType(container.getElement(i).get()))
1401 }
1402 return result;
1403}
1404
1406 intptr_t length, intptr_t step)
1407 : Sliceable(startIndex,
1409 : length,
1410 step),
1411 operation(std::move(operation)) {}
1412
1413void PyOpResultList::bindDerived(ClassTy &c) {
1414 c.def_prop_ro(
1415 "types",
1416 [](PyOpResultList &self) {
1417 return getValueTypes(self, self.operation->getContext());
1418 },
1419 "Returns a list of types for all results in this result list.");
1420 c.def_prop_ro(
1421 "owner",
1422 [](PyOpResultList &self) -> nb::typed<nb::object, PyOpView> {
1423 return self.operation->createOpView();
1424 },
1425 "Returns the operation that owns this result list.");
1426}
1427
1428intptr_t PyOpResultList::getRawNumElements() {
1429 operation->checkValid();
1430 return mlirOperationGetNumResults(operation->get());
1431}
1432
1433PyOpResult PyOpResultList::getRawElement(intptr_t index) {
1434 PyValue value(operation, mlirOperationGetResult(operation->get(), index));
1435 return PyOpResult(value);
1436}
1437
1438PyOpResultList PyOpResultList::slice(intptr_t startIndex, intptr_t length,
1439 intptr_t step) const {
1440 return PyOpResultList(operation, startIndex, length, step);
1441}
1443//------------------------------------------------------------------------------
1444// PyOpView
1445//------------------------------------------------------------------------------
1446
1447static void populateResultTypes(std::string_view name,
1448 nb::sequence resultTypeList,
1449 const nb::object &resultSegmentSpecObj,
1450 std::vector<int32_t> &resultSegmentLengths,
1451 std::vector<PyType *> &resultTypes) {
1452 resultTypes.reserve(nb::len(resultTypeList));
1453 if (resultSegmentSpecObj.is_none()) {
1454 // Non-variadic result unpacking.
1455 size_t index = 0;
1456 for (nb::handle resultType : resultTypeList) {
1457 try {
1458 resultTypes.push_back(nb::cast<PyType *>(resultType));
1459 if (!resultTypes.back())
1460 throw nb::cast_error();
1461 } catch (nb::cast_error &err) {
1462 throw nb::value_error(join("Result ", index, " of operation \"", name,
1463 "\" must be a Type (", err.what(), ")")
1464 .c_str());
1465 }
1466 ++index;
1467 }
1468 } else {
1469 // Sized result unpacking.
1470 auto resultSegmentSpec = nb::cast<std::vector<int>>(resultSegmentSpecObj);
1471 if (resultSegmentSpec.size() != nb::len(resultTypeList)) {
1472 throw nb::value_error(
1473 join("Operation \"", name, "\" requires ", resultSegmentSpec.size(),
1474 " result segments but was provided ", nb::len(resultTypeList))
1475 .c_str());
1476 }
1477 resultSegmentLengths.reserve(nb::len(resultTypeList));
1478 for (size_t i = 0, e = resultSegmentSpec.size(); i < e; ++i) {
1479 int segmentSpec = resultSegmentSpec[i];
1480 if (segmentSpec == 1 || segmentSpec == 0) {
1481 // Unpack unary element.
1482 try {
1483 auto *resultType = nb::cast<PyType *>(resultTypeList[i]);
1484 if (resultType) {
1485 resultTypes.push_back(resultType);
1486 resultSegmentLengths.push_back(1);
1487 } else if (segmentSpec == 0) {
1488 // Allowed to be optional.
1489 resultSegmentLengths.push_back(0);
1490 } else {
1491 throw nb::value_error(
1492 join("Result ", i, " of operation \"", name,
1493 "\" must be a Type (was None and result is not optional)")
1494 .c_str());
1495 }
1496 } catch (nb::cast_error &err) {
1497 throw nb::value_error(join("Result ", i, " of operation \"", name,
1498 "\" must be a Type (", err.what(), ")")
1499 .c_str());
1500 }
1501 } else if (segmentSpec == -1) {
1502 // Unpack sequence by appending.
1503 try {
1504 if (resultTypeList[i].is_none()) {
1505 // Treat it as an empty list.
1506 resultSegmentLengths.push_back(0);
1507 } else {
1508 // Unpack the list.
1509 auto segment = nb::cast<nb::sequence>(resultTypeList[i]);
1510 for (nb::handle segmentItem : segment) {
1511 resultTypes.push_back(nb::cast<PyType *>(segmentItem));
1512 if (!resultTypes.back()) {
1513 throw nb::type_error("contained a None item");
1514 }
1515 }
1516 resultSegmentLengths.push_back(nb::len(segment));
1517 }
1518 } catch (std::exception &err) {
1519 // NOTE: Sloppy to be using a catch-all here, but there are at least
1520 // three different unrelated exceptions that can be thrown in the
1521 // above "casts". Just keep the scope above small and catch them all.
1522 throw nb::value_error(join("Result ", i, " of operation \"", name,
1523 "\" must be a Sequence of Types (",
1524 err.what(), ")")
1525 .c_str());
1526 }
1527 } else {
1528 throw nb::value_error("Unexpected segment spec");
1530 }
1531 }
1532}
1533
1534MlirValue getUniqueResult(MlirOperation operation) {
1535 auto numResults = mlirOperationGetNumResults(operation);
1536 if (numResults != 1) {
1537 auto name = mlirIdentifierStr(mlirOperationGetName(operation));
1538 throw nb::value_error(
1539 join("Cannot call .result on operation ",
1540 std::string_view(name.data, name.length), " which has ",
1541 numResults,
1542 " results (it is only valid for operations with a "
1543 "single result)")
1544 .c_str());
1545 }
1546 return mlirOperationGetResult(operation, 0);
1547}
1548
1549static MlirValue getOpResultOrValue(nb::handle operand) {
1550 if (operand.is_none()) {
1551 throw nb::value_error("contained a None item");
1552 }
1553 PyOperationBase *op;
1554 if (nb::try_cast<PyOperationBase *>(operand, op)) {
1555 return getUniqueResult(op->getOperation());
1556 }
1557 PyOpResultList *opResultList;
1558 if (nb::try_cast<PyOpResultList *>(operand, opResultList)) {
1559 return getUniqueResult(opResultList->getOperation()->get());
1560 }
1561 PyValue *value;
1562 if (nb::try_cast<PyValue *>(operand, value)) {
1563 return value->get();
1564 }
1565 throw nb::value_error("is not a Value");
1566}
1567
1568nb::typed<nb::object, PyOperation> PyOpView::buildGeneric(
1569 std::string_view name, std::tuple<int, bool> opRegionSpec,
1570 nb::object operandSegmentSpecObj, nb::object resultSegmentSpecObj,
1571 std::optional<nb::sequence> resultTypeList, nb::sequence operandList,
1572 std::optional<nb::dict> attributes,
1573 std::optional<std::vector<PyBlock *>> successors,
1574 std::optional<int> regions, PyLocation &location,
1575 const nb::object &maybeIp) {
1576 PyMlirContextRef context = location.getContext();
1577
1578 // Class level operation construction metadata.
1579 // Operand and result segment specs are either none, which does no
1580 // variadic unpacking, or a list of ints with segment sizes, where each
1581 // element is either a positive number (typically 1 for a scalar) or -1 to
1582 // indicate that it is derived from the length of the same-indexed operand
1583 // or result (implying that it is a list at that position).
1584 std::vector<int32_t> operandSegmentLengths;
1585 std::vector<int32_t> resultSegmentLengths;
1586
1587 // Validate/determine region count.
1588 int opMinRegionCount = std::get<0>(opRegionSpec);
1589 bool opHasNoVariadicRegions = std::get<1>(opRegionSpec);
1590 if (!regions) {
1591 regions = opMinRegionCount;
1592 }
1593 if (*regions < opMinRegionCount) {
1594 throw nb::value_error(join("Operation \"", name,
1595 "\" requires a minimum of ", opMinRegionCount,
1596 " regions but was built with regions=", *regions)
1597 .c_str());
1598 }
1599 if (opHasNoVariadicRegions && *regions > opMinRegionCount) {
1600 throw nb::value_error(join("Operation \"", name,
1601 "\" requires a maximum of ", opMinRegionCount,
1602 " regions but was built with regions=", *regions)
1603 .c_str());
1604 }
1605
1606 // Unpack results.
1607 std::vector<PyType *> resultTypes;
1608 if (resultTypeList.has_value()) {
1609 populateResultTypes(name, *resultTypeList, resultSegmentSpecObj,
1610 resultSegmentLengths, resultTypes);
1611 }
1612
1613 // Unpack operands.
1614 std::vector<MlirValue> operands;
1615 operands.reserve(operands.size());
1616 size_t index = 0;
1617 if (operandSegmentSpecObj.is_none()) {
1618 // Non-sized operand unpacking.
1619 for (nb::handle operand : operandList) {
1620 try {
1621 operands.push_back(getOpResultOrValue(operand));
1622 } catch (nb::builtin_exception &err) {
1623 throw nb::value_error(join("Operand ", index, " of operation \"", name,
1624 "\" must be a Value (", err.what(), ")")
1625 .c_str());
1626 }
1627 ++index;
1628 }
1629 } else {
1630 // Sized operand unpacking.
1631 auto operandSegmentSpec = nb::cast<std::vector<int>>(operandSegmentSpecObj);
1632 if (operandSegmentSpec.size() != nb::len(operandList)) {
1633 throw nb::value_error(
1634 join("Operation \"", name, "\" requires ", operandSegmentSpec.size(),
1635 "operand segments but was provided ", nb::len(operandList))
1636 .c_str());
1637 }
1638 operandSegmentLengths.reserve(nb::len(operandList));
1639 for (size_t i = 0, e = operandSegmentSpec.size(); i < e; ++i) {
1640 int segmentSpec = operandSegmentSpec[i];
1641 if (segmentSpec == 1 || segmentSpec == 0) {
1642 // Unpack unary element.
1643 const nanobind::handle operand = operandList[i];
1644 if (!operand.is_none()) {
1645 try {
1646 operands.push_back(getOpResultOrValue(operand));
1647 } catch (nb::builtin_exception &err) {
1648 throw nb::value_error(join("Operand ", i, " of operation \"", name,
1649 "\" must be a Value (", err.what(), ")")
1650 .c_str());
1651 }
1652
1653 operandSegmentLengths.push_back(1);
1654 } else if (segmentSpec == 0) {
1655 // Allowed to be optional.
1656 operandSegmentLengths.push_back(0);
1657 } else {
1658 throw nb::value_error(
1659 join("Operand ", i, " of operation \"", name,
1660 "\" must be a Value (was None and operand is not optional)")
1661 .c_str());
1662 }
1663 } else if (segmentSpec == -1) {
1664 // Unpack sequence by appending.
1665 try {
1666 if (operandList[i].is_none()) {
1667 // Treat it as an empty list.
1668 operandSegmentLengths.push_back(0);
1669 } else {
1670 // Unpack the list.
1671 auto segment = nb::cast<nb::sequence>(operandList[i]);
1672 for (nb::handle segmentItem : segment) {
1673 operands.push_back(getOpResultOrValue(segmentItem));
1674 }
1675 operandSegmentLengths.push_back(nb::len(segment));
1676 }
1677 } catch (std::exception &err) {
1678 // NOTE: Sloppy to be using a catch-all here, but there are at least
1679 // three different unrelated exceptions that can be thrown in the
1680 // above "casts". Just keep the scope above small and catch them all.
1681 throw nb::value_error(join("Operand ", i, " of operation \"", name,
1682 "\" must be a Sequence of Values (",
1683 err.what(), ")")
1684 .c_str());
1685 }
1686 } else {
1687 throw nb::value_error("Unexpected segment spec");
1688 }
1689 }
1690 }
1691
1692 // Merge operand/result segment lengths into attributes if needed.
1693 if (!operandSegmentLengths.empty() || !resultSegmentLengths.empty()) {
1694 // Dup.
1695 if (attributes) {
1696 attributes = nb::dict(*attributes);
1697 } else {
1698 attributes = nb::dict();
1699 }
1700 if (attributes->contains("resultSegmentSizes") ||
1701 attributes->contains("operandSegmentSizes")) {
1702 throw nb::value_error("Manually setting a 'resultSegmentSizes' or "
1703 "'operandSegmentSizes' attribute is unsupported. "
1704 "Use Operation.create for such low-level access.");
1705 }
1706
1707 // Add resultSegmentSizes attribute.
1708 if (!resultSegmentLengths.empty()) {
1709 MlirAttribute segmentLengthAttr =
1710 mlirDenseI32ArrayGet(context->get(), resultSegmentLengths.size(),
1711 resultSegmentLengths.data());
1712 (*attributes)["resultSegmentSizes"] =
1713 PyAttribute(context, segmentLengthAttr);
1714 }
1715
1716 // Add operandSegmentSizes attribute.
1717 if (!operandSegmentLengths.empty()) {
1718 MlirAttribute segmentLengthAttr =
1719 mlirDenseI32ArrayGet(context->get(), operandSegmentLengths.size(),
1720 operandSegmentLengths.data());
1721 (*attributes)["operandSegmentSizes"] =
1722 PyAttribute(context, segmentLengthAttr);
1723 }
1724 }
1725
1726 // Delegate to create.
1727 return PyOperation::create(name,
1728 /*results=*/std::move(resultTypes),
1729 /*operands=*/operands.data(),
1730 /*numOperands=*/operands.size(),
1731 /*attributes=*/std::move(attributes),
1732 /*successors=*/std::move(successors),
1733 /*regions=*/*regions, location, maybeIp,
1734 !resultTypeList);
1735}
1736
1737nb::object PyOpView::constructDerived(const nb::object &cls,
1738 const nb::object &operation) {
1739 nb::handle opViewType = nb::type<PyOpView>();
1740 nb::object instance = cls.attr("__new__")(cls);
1741 opViewType.attr("__init__")(instance, operation);
1742 return instance;
1743}
1744
1745PyOpView::PyOpView(const nb::object &operationObject)
1746 // Casting through the PyOperationBase base-class and then back to the
1747 // Operation lets us accept any PyOperationBase subclass.
1748 : operation(nb::cast<PyOperationBase &>(operationObject).getOperation()),
1749 operationObject(operation.getRef().getObject()) {}
1751//------------------------------------------------------------------------------
1752// PyAsmState
1753//------------------------------------------------------------------------------
1754
1755PyAsmState::PyAsmState(MlirValue value, bool useLocalScope) {
1756 flags = mlirOpPrintingFlagsCreate();
1757 // The OpPrintingFlags are not exposed Python side, create locally and
1758 // associate lifetime with the state.
1759 if (useLocalScope)
1761 state = mlirAsmStateCreateForValue(value, flags);
1762}
1763
1764PyAsmState::PyAsmState(PyOperationBase &operation, bool useLocalScope) {
1765 flags = mlirOpPrintingFlagsCreate();
1766 // The OpPrintingFlags are not exposed Python side, create locally and
1767 // associate lifetime with the state.
1768 if (useLocalScope)
1770 state = mlirAsmStateCreateForOperation(operation.getOperation().get(), flags);
1771}
1773//------------------------------------------------------------------------------
1774// PyInsertionPoint.
1775//------------------------------------------------------------------------------
1776
1777PyInsertionPoint::PyInsertionPoint(const PyBlock &block) : block(block) {}
1780 : refOperation(beforeOperationBase.getOperation().getRef()),
1781 block((*refOperation)->getBlock()) {}
1782
1784 : refOperation(beforeOperationRef), block((*refOperation)->getBlock()) {}
1785
1786void PyInsertionPoint::insert(PyOperationBase &operationBase) {
1787 PyOperation &operation = operationBase.getOperation();
1788 if (operation.isAttached())
1789 throw nb::value_error(
1790 "Attempt to insert operation that is already attached");
1791 block.getParentOperation()->checkValid();
1792 MlirOperation beforeOp = {nullptr};
1793 if (refOperation) {
1794 // Insert before operation.
1795 (*refOperation)->checkValid();
1796 beforeOp = (*refOperation)->get();
1797 } else {
1798 // Insert at end (before null) is only valid if the block does not
1799 // already end in a known terminator (violating this will cause assertion
1800 // failures later).
1801 if (!mlirOperationIsNull(mlirBlockGetTerminator(block.get()))) {
1802 throw nb::index_error("Cannot insert operation at the end of a block "
1803 "that already has a terminator. Did you mean to "
1804 "use 'InsertionPoint.at_block_terminator(block)' "
1805 "versus 'InsertionPoint(block)'?");
1806 }
1808 mlirBlockInsertOwnedOperationBefore(block.get(), beforeOp, operation);
1809 operation.setAttached();
1810}
1811
1813 MlirOperation firstOp = mlirBlockGetFirstOperation(block.get());
1814 if (mlirOperationIsNull(firstOp)) {
1815 // Just insert at end.
1816 return PyInsertionPoint(block);
1817 }
1818
1819 // Insert before first op.
1821 block.getParentOperation()->getContext(), firstOp);
1822 return PyInsertionPoint{block, std::move(firstOpRef)};
1823}
1824
1826 MlirOperation terminator = mlirBlockGetTerminator(block.get());
1827 if (mlirOperationIsNull(terminator))
1828 throw nb::value_error("Block has no terminator");
1830 block.getParentOperation()->getContext(), terminator);
1831 return PyInsertionPoint{block, std::move(terminatorOpRef)};
1832}
1833
1835 PyOperation &operation = op.getOperation();
1836 PyBlock block = operation.getBlock();
1837 MlirOperation nextOperation = mlirOperationGetNextInBlock(operation);
1838 if (mlirOperationIsNull(nextOperation))
1839 return PyInsertionPoint(block);
1841 block.getParentOperation()->getContext(), nextOperation);
1842 return PyInsertionPoint{block, std::move(nextOpRef)};
1843}
1844
1845size_t PyMlirContext::getLiveModuleCount() { return liveModules.size(); }
1847nb::object PyInsertionPoint::contextEnter(nb::object insertPoint) {
1848 return PyThreadContextEntry::pushInsertionPoint(std::move(insertPoint));
1849}
1850
1851void PyInsertionPoint::contextExit(const nb::object &excType,
1852 const nb::object &excVal,
1853 const nb::object &excTb) {
1855}
1857//------------------------------------------------------------------------------
1858// PyAttribute.
1859//------------------------------------------------------------------------------
1861bool PyAttribute::operator==(const PyAttribute &other) const {
1862 return mlirAttributeEqual(attr, other.attr);
1863}
1865nb::object PyAttribute::getCapsule() {
1866 return nb::steal<nb::object>(mlirPythonAttributeToCapsule(*this));
1867}
1868
1869PyAttribute PyAttribute::createFromCapsule(const nb::object &capsule) {
1870 MlirAttribute rawAttr = mlirPythonCapsuleToAttribute(capsule.ptr());
1871 if (mlirAttributeIsNull(rawAttr))
1872 throw nb::python_error();
1873 return PyAttribute(
1875}
1876
1877nb::typed<nb::object, PyAttribute> PyAttribute::maybeDownCast() {
1878 MlirTypeID mlirTypeID = mlirAttributeGetTypeID(this->get());
1879 assert(!mlirTypeIDIsNull(mlirTypeID) &&
1880 "mlirTypeID was expected to be non-null.");
1881 std::optional<nb::callable> typeCaster = PyGlobals::get().lookupTypeCaster(
1882 mlirTypeID, mlirAttributeGetDialect(this->get()));
1883 // nb::rv_policy::move means use std::move to move the return value
1884 // contents into a new instance that will be owned by Python.
1885 nb::object thisObj = nb::cast(this, nb::rv_policy::move);
1886 if (!typeCaster)
1887 return thisObj;
1888 return typeCaster.value()(thisObj);
1889}
1891//------------------------------------------------------------------------------
1892// PyNamedAttribute.
1893//------------------------------------------------------------------------------
1894
1895PyNamedAttribute::PyNamedAttribute(MlirAttribute attr, std::string ownedName)
1896 : ownedName(new std::string(std::move(ownedName))) {
1899 toMlirStringRef(*this->ownedName)),
1900 attr);
1901}
1903//------------------------------------------------------------------------------
1904// PyType.
1905//------------------------------------------------------------------------------
1907bool PyType::operator==(const PyType &other) const {
1908 return mlirTypeEqual(type, other.type);
1909}
1911nb::object PyType::getCapsule() {
1912 return nb::steal<nb::object>(mlirPythonTypeToCapsule(*this));
1913}
1914
1915PyType PyType::createFromCapsule(nb::object capsule) {
1916 MlirType rawType = mlirPythonCapsuleToType(capsule.ptr());
1917 if (mlirTypeIsNull(rawType))
1918 throw nb::python_error();
1920 rawType);
1921}
1922
1923nb::typed<nb::object, PyType> PyType::maybeDownCast() {
1924 MlirTypeID mlirTypeID = mlirTypeGetTypeID(this->get());
1925 assert(!mlirTypeIDIsNull(mlirTypeID) &&
1926 "mlirTypeID was expected to be non-null.");
1927 std::optional<nb::callable> typeCaster = PyGlobals::get().lookupTypeCaster(
1928 mlirTypeID, mlirTypeGetDialect(this->get()));
1929 // nb::rv_policy::move means use std::move to move the return value
1930 // contents into a new instance that will be owned by Python.
1931 nb::object thisObj = nb::cast(this, nb::rv_policy::move);
1932 if (!typeCaster)
1933 return thisObj;
1934 return typeCaster.value()(thisObj);
1935}
1937//------------------------------------------------------------------------------
1938// PyTypeID.
1939//------------------------------------------------------------------------------
1941nb::object PyTypeID::getCapsule() {
1942 return nb::steal<nb::object>(mlirPythonTypeIDToCapsule(*this));
1943}
1944
1945PyTypeID PyTypeID::createFromCapsule(nb::object capsule) {
1946 MlirTypeID mlirTypeID = mlirPythonCapsuleToTypeID(capsule.ptr());
1947 if (mlirTypeIDIsNull(mlirTypeID))
1948 throw nb::python_error();
1949 return PyTypeID(mlirTypeID);
1950}
1951bool PyTypeID::operator==(const PyTypeID &other) const {
1952 return mlirTypeIDEqual(typeID, other.typeID);
1953}
1955//------------------------------------------------------------------------------
1956// PyValue and subclasses.
1957//------------------------------------------------------------------------------
1959nb::object PyValue::getCapsule() {
1960 return nb::steal<nb::object>(mlirPythonValueToCapsule(get()));
1961}
1962
1963static PyOperationRef getValueOwnerRef(MlirValue value) {
1964 MlirOperation owner;
1965 if (mlirValueIsAOpResult(value))
1966 owner = mlirOpResultGetOwner(value);
1967 else if (mlirValueIsABlockArgument(value))
1969 else
1970 assert(false && "Value must be an block arg or op result.");
1971 if (mlirOperationIsNull(owner))
1972 throw nb::python_error();
1973 MlirContext ctx = mlirOperationGetContext(owner);
1975}
1976
1977nb::typed<nb::object, std::variant<PyBlockArgument, PyOpResult, PyValue>>
1979 MlirType type = mlirValueGetType(get());
1980 MlirTypeID mlirTypeID = mlirTypeGetTypeID(type);
1981 assert(!mlirTypeIDIsNull(mlirTypeID) &&
1982 "mlirTypeID was expected to be non-null.");
1983 std::optional<nb::callable> valueCaster =
1985 // nb::rv_policy::move means use std::move to move the return value
1986 // contents into a new instance that will be owned by Python.
1987 nb::object thisObj;
1988 if (mlirValueIsAOpResult(value))
1989 thisObj = nb::cast<PyOpResult>(*this, nb::rv_policy::move);
1990 else if (mlirValueIsABlockArgument(value))
1991 thisObj = nb::cast<PyBlockArgument>(*this, nb::rv_policy::move);
1992 else
1993 assert(false && "Value must be an block arg or op result.");
1994 if (valueCaster)
1995 return valueCaster.value()(thisObj);
1996 return thisObj;
1997}
1998
1999PyValue PyValue::createFromCapsule(nb::object capsule) {
2000 MlirValue value = mlirPythonCapsuleToValue(capsule.ptr());
2001 if (mlirValueIsNull(value))
2002 throw nb::python_error();
2003 PyOperationRef ownerRef = getValueOwnerRef(value);
2004 return PyValue(ownerRef, value);
2005}
2007//------------------------------------------------------------------------------
2008// PySymbolTable.
2009//------------------------------------------------------------------------------
2010
2012 : operation(operation.getOperation().getRef()) {
2013 symbolTable = mlirSymbolTableCreate(operation.getOperation().get());
2014 if (mlirSymbolTableIsNull(symbolTable)) {
2015 throw nb::type_error("Operation is not a Symbol Table.");
2016 }
2017}
2018
2019nb::object PySymbolTable::dunderGetItem(const std::string &name) {
2020 operation->checkValid();
2021 MlirOperation symbol = mlirSymbolTableLookup(
2022 symbolTable, mlirStringRefCreate(name.data(), name.length()));
2023 if (mlirOperationIsNull(symbol))
2024 throw nb::key_error(
2025 join("Symbol '", name, "' not in the symbol table.").c_str());
2026
2027 return PyOperation::forOperation(operation->getContext(), symbol,
2028 operation.getObject())
2029 ->createOpView();
2030}
2031
2033 operation->checkValid();
2034 symbol.getOperation().checkValid();
2035 mlirSymbolTableErase(symbolTable, symbol.getOperation().get());
2036 // The operation is also erased, so we must invalidate it. There may be Python
2037 // references to this operation so we don't want to delete it from the list of
2038 // live operations here.
2039 symbol.getOperation().valid = false;
2040}
2041
2042void PySymbolTable::dunderDel(const std::string &name) {
2043 nb::object operation = dunderGetItem(name);
2044 erase(nb::cast<PyOperationBase &>(operation));
2045}
2046
2048 operation->checkValid();
2049 symbol.getOperation().checkValid();
2050 MlirAttribute symbolAttr = mlirOperationGetAttributeByName(
2052 if (mlirAttributeIsNull(symbolAttr))
2053 throw nb::value_error("Expected operation to have a symbol name.");
2055 symbol.getOperation().getContext(),
2056 mlirSymbolTableInsert(symbolTable, symbol.getOperation().get()));
2057}
2058
2060 // Op must already be a symbol.
2061 PyOperation &operation = symbol.getOperation();
2062 operation.checkValid();
2064 MlirAttribute existingNameAttr =
2065 mlirOperationGetAttributeByName(operation.get(), attrName);
2066 if (mlirAttributeIsNull(existingNameAttr))
2067 throw nb::value_error("Expected operation to have a symbol name.");
2068 return PyStringAttribute(symbol.getOperation().getContext(),
2069 existingNameAttr);
2070}
2071
2073 const std::string &name) {
2074 // Op must already be a symbol.
2075 PyOperation &operation = symbol.getOperation();
2076 operation.checkValid();
2078 MlirAttribute existingNameAttr =
2079 mlirOperationGetAttributeByName(operation.get(), attrName);
2080 if (mlirAttributeIsNull(existingNameAttr))
2081 throw nb::value_error("Expected operation to have a symbol name.");
2082 MlirAttribute newNameAttr =
2083 mlirStringAttrGet(operation.getContext()->get(), toMlirStringRef(name));
2084 mlirOperationSetAttributeByName(operation.get(), attrName, newNameAttr);
2085}
2086
2088 PyOperation &operation = symbol.getOperation();
2089 operation.checkValid();
2091 MlirAttribute existingVisAttr =
2092 mlirOperationGetAttributeByName(operation.get(), attrName);
2093 if (mlirAttributeIsNull(existingVisAttr))
2094 throw nb::value_error("Expected operation to have a symbol visibility.");
2095 return PyStringAttribute(symbol.getOperation().getContext(), existingVisAttr);
2096}
2097
2099 const std::string &visibility) {
2100 if (visibility != "public" && visibility != "private" &&
2101 visibility != "nested")
2102 throw nb::value_error(
2103 "Expected visibility to be 'public', 'private' or 'nested'");
2104 PyOperation &operation = symbol.getOperation();
2105 operation.checkValid();
2107 MlirAttribute existingVisAttr =
2108 mlirOperationGetAttributeByName(operation.get(), attrName);
2109 if (mlirAttributeIsNull(existingVisAttr))
2110 throw nb::value_error("Expected operation to have a symbol visibility.");
2111 MlirAttribute newVisAttr = mlirStringAttrGet(operation.getContext()->get(),
2112 toMlirStringRef(visibility));
2113 mlirOperationSetAttributeByName(operation.get(), attrName, newVisAttr);
2114}
2115
2116void PySymbolTable::replaceAllSymbolUses(const std::string &oldSymbol,
2117 const std::string &newSymbol,
2118 PyOperationBase &from) {
2119 PyOperation &fromOperation = from.getOperation();
2120 fromOperation.checkValid();
2122 toMlirStringRef(oldSymbol), toMlirStringRef(newSymbol),
2124
2125 throw nb::value_error("Symbol rename failed");
2126}
2127
2129 bool allSymUsesVisible,
2130 nb::object callback) {
2131 PyOperation &fromOperation = from.getOperation();
2132 fromOperation.checkValid();
2133 struct UserData {
2134 PyMlirContextRef context;
2135 nb::object callback;
2136 bool gotException;
2137 std::string exceptionWhat;
2138 nb::object exceptionType;
2139 };
2140 UserData userData{
2141 fromOperation.getContext(), std::move(callback), false, {}, {}};
2143 fromOperation.get(), allSymUsesVisible,
2144 [](MlirOperation foundOp, bool isVisible, void *calleeUserDataVoid) {
2145 UserData *calleeUserData = static_cast<UserData *>(calleeUserDataVoid);
2146 auto pyFoundOp =
2147 PyOperation::forOperation(calleeUserData->context, foundOp);
2148 if (calleeUserData->gotException)
2149 return;
2150 try {
2151 calleeUserData->callback(pyFoundOp.getObject(), isVisible);
2152 } catch (nb::python_error &e) {
2153 calleeUserData->gotException = true;
2154 calleeUserData->exceptionWhat = e.what();
2155 calleeUserData->exceptionType = nb::borrow(e.type());
2156 }
2157 },
2158 static_cast<void *>(&userData));
2159 if (userData.gotException) {
2160 std::string message("Exception raised in callback: ");
2161 message.append(userData.exceptionWhat);
2162 throw std::runtime_error(message);
2163 }
2164}
2165
2166void PyBlockArgument::bindDerived(ClassTy &c) {
2167 c.def_prop_ro(
2168 "owner",
2169 [](PyBlockArgument &self) {
2170 return PyBlock(self.getParentOperation(),
2172 },
2173 "Returns the block that owns this argument.");
2174 c.def_prop_ro(
2175 "arg_number",
2176 [](PyBlockArgument &self) {
2177 return mlirBlockArgumentGetArgNumber(self.get());
2178 },
2179 "Returns the position of this argument in the block's argument list.");
2180 c.def(
2181 "set_type",
2182 [](PyBlockArgument &self, PyType type) {
2183 return mlirBlockArgumentSetType(self.get(), type);
2184 },
2185 "type"_a, "Sets the type of this block argument.");
2186 c.def(
2187 "set_location",
2188 [](PyBlockArgument &self, PyLocation loc) {
2190 },
2191 "loc"_a, "Sets the location of this block argument.");
2192}
2193
2195 MlirBlock block, intptr_t startIndex,
2198 length == -1 ? mlirBlockGetNumArguments(block) : length, step),
2199 operation(std::move(operation)), block(block) {}
2200
2201void PyBlockArgumentList::bindDerived(ClassTy &c) {
2202 c.def_prop_ro(
2203 "types",
2204 [](PyBlockArgumentList &self) {
2205 return getValueTypes(self, self.operation->getContext());
2206 },
2207 "Returns a list of types for all arguments in this argument list.");
2208}
2209
2210intptr_t PyBlockArgumentList::getRawNumElements() {
2211 operation->checkValid();
2212 return mlirBlockGetNumArguments(block);
2213}
2214
2215PyBlockArgument PyBlockArgumentList::getRawElement(intptr_t pos) const {
2216 MlirValue argument = mlirBlockGetArgument(block, pos);
2217 return PyBlockArgument(operation, argument);
2218}
2219
2220PyBlockArgumentList PyBlockArgumentList::slice(intptr_t startIndex,
2222 intptr_t step) const {
2223 return PyBlockArgumentList(operation, block, startIndex, length, step);
2224}
2225
2227 intptr_t length, intptr_t step)
2228 : Sliceable(startIndex,
2230 : length,
2231 step),
2232 operation(operation) {}
2233
2236 mlirOperationSetOperand(operation->get(), index, value.get());
2237}
2238
2239void PyOpOperandList::bindDerived(ClassTy &c) {
2240 c.def("__setitem__", &PyOpOperandList::dunderSetItem, "index"_a, "value"_a,
2241 "Sets the operand at the specified index to a new value.");
2242}
2243
2244intptr_t PyOpOperandList::getRawNumElements() {
2245 operation->checkValid();
2246 return mlirOperationGetNumOperands(operation->get());
2247}
2248
2249PyValue PyOpOperandList::getRawElement(intptr_t pos) {
2250 MlirValue operand = mlirOperationGetOperand(operation->get(), pos);
2251 PyOperationRef pyOwner = getValueOwnerRef(operand);
2252 return PyValue(pyOwner, operand);
2253}
2254
2255PyOpOperandList PyOpOperandList::slice(intptr_t startIndex, intptr_t length,
2256 intptr_t step) const {
2257 return PyOpOperandList(operation, startIndex, length, step);
2258}
2260/// A list of OpOperands. Internally, these are stored as consecutive elements,
2261/// random access is cheap. The (returned) OpOperand list is associated with the
2262/// operation whose operands these are, and thus extends the lifetime of this
2263/// operation.
2264class PyOpOperands : public Sliceable<PyOpOperands, PyOpOperand> {
2265public:
2266 static constexpr const char *pyClassName = "OpOperands";
2268
2270 intptr_t length = -1, intptr_t step = 1)
2272 length == -1 ? mlirOperationGetNumOperands(operation->get())
2273 : length,
2274 step),
2275 operation(operation) {}
2276
2277private:
2278 /// Give the parent CRTP class access to hook implementations below.
2279 friend class Sliceable<PyOpOperands, PyOpOperand>;
2280
2281 intptr_t getRawNumElements() {
2282 operation->checkValid();
2283 return mlirOperationGetNumOperands(operation->get());
2284 }
2285
2286 PyOpOperand getRawElement(intptr_t pos) {
2287 MlirOpOperand opOperand = mlirOperationGetOpOperand(operation->get(), pos);
2288 return PyOpOperand(opOperand);
2289 }
2290
2292 return PyOpOperands(operation, startIndex, length, step);
2294
2295 PyOperationRef operation;
2296};
2297
2299 intptr_t length, intptr_t step)
2300 : Sliceable(startIndex,
2302 : length,
2303 step),
2304 operation(operation) {}
2305
2308 mlirOperationSetSuccessor(operation->get(), index, block.get());
2309}
2310
2311void PyOpSuccessors::bindDerived(ClassTy &c) {
2312 c.def("__setitem__", &PyOpSuccessors::dunderSetItem, "index"_a, "block"_a,
2313 "Sets the successor block at the specified index.");
2314}
2315
2316intptr_t PyOpSuccessors::getRawNumElements() {
2317 operation->checkValid();
2318 return mlirOperationGetNumSuccessors(operation->get());
2319}
2320
2321PyBlock PyOpSuccessors::getRawElement(intptr_t pos) {
2322 MlirBlock block = mlirOperationGetSuccessor(operation->get(), pos);
2323 return PyBlock(operation, block);
2324}
2325
2327 intptr_t step) const {
2328 return PyOpSuccessors(operation, startIndex, length, step);
2329}
2330
2332 intptr_t startIndex, intptr_t length,
2333 intptr_t step)
2334 : Sliceable(startIndex,
2335 length == -1 ? mlirBlockGetNumSuccessors(block.get()) : length,
2336 step),
2337 operation(operation), block(block) {}
2338
2339intptr_t PyBlockSuccessors::getRawNumElements() {
2340 block.checkValid();
2341 return mlirBlockGetNumSuccessors(block.get());
2342}
2343
2344PyBlock PyBlockSuccessors::getRawElement(intptr_t pos) {
2345 MlirBlock block = mlirBlockGetSuccessor(this->block.get(), pos);
2346 return PyBlock(operation, block);
2347}
2348
2350 intptr_t step) const {
2351 return PyBlockSuccessors(block, operation, startIndex, length, step);
2352}
2353
2355 PyOperationRef operation,
2356 intptr_t startIndex, intptr_t length,
2357 intptr_t step)
2358 : Sliceable(startIndex,
2359 length == -1 ? mlirBlockGetNumPredecessors(block.get())
2360 : length,
2361 step),
2362 operation(operation), block(block) {}
2363
2364intptr_t PyBlockPredecessors::getRawNumElements() {
2365 block.checkValid();
2366 return mlirBlockGetNumPredecessors(block.get());
2367}
2368
2369PyBlock PyBlockPredecessors::getRawElement(intptr_t pos) {
2370 MlirBlock block = mlirBlockGetPredecessor(this->block.get(), pos);
2371 return PyBlock(operation, block);
2372}
2373
2374PyBlockPredecessors PyBlockPredecessors::slice(intptr_t startIndex,
2375 intptr_t length,
2376 intptr_t step) const {
2377 return PyBlockPredecessors(block, operation, startIndex, length, step);
2378}
2379
2380nb::typed<nb::object, PyAttribute>
2381PyOpAttributeMap::dunderGetItemNamed(const std::string &name) {
2382 MlirAttribute attr =
2384 if (mlirAttributeIsNull(attr)) {
2385 throw nb::key_error("attempt to access a non-existent attribute");
2387 return PyAttribute(operation->getContext(), attr).maybeDownCast();
2388}
2389
2390nb::typed<nb::object, std::optional<PyAttribute>>
2391PyOpAttributeMap::get(const std::string &key, nb::object defaultValue) {
2392 MlirAttribute attr =
2394 if (mlirAttributeIsNull(attr))
2395 return defaultValue;
2396 return PyAttribute(operation->getContext(), attr).maybeDownCast();
2397}
2398
2400 if (index < 0) {
2401 index += dunderLen();
2402 }
2403 if (index < 0 || index >= dunderLen()) {
2404 throw nb::index_error("attempt to access out of bounds attribute");
2405 }
2406 MlirNamedAttribute namedAttr =
2407 mlirOperationGetAttribute(operation->get(), index);
2408 return PyNamedAttribute(
2409 namedAttr.attribute,
2410 std::string(mlirIdentifierStr(namedAttr.name).data,
2411 mlirIdentifierStr(namedAttr.name).length));
2412}
2413
2414void PyOpAttributeMap::dunderSetItem(const std::string &name,
2415 const PyAttribute &attr) {
2416 mlirOperationSetAttributeByName(operation->get(), toMlirStringRef(name),
2417 attr);
2418}
2419
2420void PyOpAttributeMap::dunderDelItem(const std::string &name) {
2421 int removed = mlirOperationRemoveAttributeByName(operation->get(),
2423 if (!removed)
2424 throw nb::key_error("attempt to delete a non-existent attribute");
2425}
2428 return mlirOperationGetNumAttributes(operation->get());
2429}
2430
2431bool PyOpAttributeMap::dunderContains(const std::string &name) {
2432 return !mlirAttributeIsNull(
2433 mlirOperationGetAttributeByName(operation->get(), toMlirStringRef(name)));
2434}
2435
2437 MlirOperation op, std::function<void(MlirStringRef, MlirAttribute)> fn) {
2439 for (intptr_t i = 0; i < n; ++i) {
2442 fn(name, na.attribute);
2443 }
2444}
2445
2446void PyOpAttributeMap::bind(nb::module_ &m) {
2447 nb::class_<PyOpAttributeMap>(m, "OpAttributeMap")
2448 .def("__contains__", &PyOpAttributeMap::dunderContains, "name"_a,
2449 "Checks if an attribute with the given name exists in the map.")
2450 .def("__len__", &PyOpAttributeMap::dunderLen,
2451 "Returns the number of attributes in the map.")
2452 .def("__getitem__", &PyOpAttributeMap::dunderGetItemNamed, "name"_a,
2453 "Gets an attribute by name.")
2454 .def("__getitem__", &PyOpAttributeMap::dunderGetItemIndexed, "index"_a,
2455 "Gets a named attribute by index.")
2456 .def("__setitem__", &PyOpAttributeMap::dunderSetItem, "name"_a, "attr"_a,
2457 "Sets an attribute with the given name.")
2458 .def("__delitem__", &PyOpAttributeMap::dunderDelItem, "name"_a,
2459 "Deletes an attribute with the given name.")
2460 .def("get", &PyOpAttributeMap::get, nb::arg("key"),
2461 nb::arg("default") = nb::none(),
2462 "Gets an attribute by name or the default value, if it does not "
2463 "exist.")
2464 .def(
2465 "__iter__",
2466 [](PyOpAttributeMap &self) -> nb::typed<nb::iterator, nb::str> {
2467 nb::list keys;
2469 self.operation->get(), [&](MlirStringRef name, MlirAttribute) {
2470 keys.append(nb::str(name.data, name.length));
2471 });
2472 return nb::iter(keys);
2473 },
2474 "Iterates over attribute names.")
2475 .def(
2476 "keys",
2477 [](PyOpAttributeMap &self) -> nb::typed<nb::list, nb::str> {
2478 nb::list out;
2480 self.operation->get(), [&](MlirStringRef name, MlirAttribute) {
2481 out.append(nb::str(name.data, name.length));
2482 });
2483 return out;
2484 },
2485 "Returns a list of attribute names.")
2486 .def(
2487 "values",
2488 [](PyOpAttributeMap &self) -> nb::typed<nb::list, PyAttribute> {
2489 nb::list out;
2491 self.operation->get(), [&](MlirStringRef, MlirAttribute attr) {
2492 out.append(PyAttribute(self.operation->getContext(), attr)
2493 .maybeDownCast());
2494 });
2495 return out;
2496 },
2497 "Returns a list of attribute values.")
2498 .def(
2499 "items",
2500 [](PyOpAttributeMap &self)
2501 -> nb::typed<nb::list,
2502 nb::typed<nb::tuple, nb::str, PyAttribute>> {
2503 nb::list out;
2505 self.operation->get(),
2506 [&](MlirStringRef name, MlirAttribute attr) {
2507 out.append(nb::make_tuple(
2508 nb::str(name.data, name.length),
2509 PyAttribute(self.operation->getContext(), attr)
2510 .maybeDownCast()));
2511 });
2512 return out;
2513 },
2514 "Returns a list of `(name, attribute)` tuples.");
2515}
2516
2517void PyOpAdaptor::bind(nb::module_ &m) {
2518 nb::class_<PyOpAdaptor>(m, "OpAdaptor")
2519 .def(nb::init<nb::typed<nb::list, PyValue>, PyOpAttributeMap>(),
2520 "Creates an OpAdaptor with the given operands and attributes.",
2521 "operands"_a, "attributes"_a)
2522 .def(nb::init<nb::typed<nb::list, PyValue>, PyOpView &>(),
2523 "Creates an OpAdaptor with the given operands and operation view.",
2524 "operands"_a, "opview"_a)
2525 .def_prop_ro(
2526 "operands", [](PyOpAdaptor &self) { return self.operands; },
2527 "Returns the operands of the adaptor.")
2528 .def_prop_ro(
2529 "attributes", [](PyOpAdaptor &self) { return self.attributes; },
2530 "Returns the attributes of the adaptor.");
2531}
2532
2533static MlirLogicalResult verifyTraitByMethod(MlirOperation op, void *userData,
2534 const char *methodName) {
2535 nb::handle targetObj(static_cast<PyObject *>(userData));
2536 if (!nb::hasattr(targetObj, methodName))
2537 return mlirLogicalResultSuccess();
2539 nb::object opView = PyOperation::forOperation(ctx, op)->createOpView();
2540 bool success = nb::cast<bool>(targetObj.attr(methodName)(opView));
2542};
2543
2544static bool attachOpTrait(const nb::object &opName, MlirDynamicOpTrait trait,
2545 PyMlirContext &context) {
2546 std::string opNameStr;
2547 if (opName.is_type()) {
2548 opNameStr = nb::cast<std::string>(opName.attr("OPERATION_NAME"));
2549 } else if (nb::isinstance<nb::str>(opName)) {
2550 opNameStr = nb::cast<std::string>(opName);
2551 } else {
2552 throw nb::type_error("the root argument must be a type or a string");
2553 }
2556 trait, MlirStringRef{opNameStr.data(), opNameStr.size()}, context.get());
2557}
2558
2559bool PyDynamicOpTrait::attach(const nb::object &opName,
2560 const nb::object &target,
2561 PyMlirContext &context) {
2562 if (!nb::hasattr(target, "verify_invariants") &&
2563 !nb::hasattr(target, "verify_region_invariants"))
2564 throw nb::type_error(
2565 "the target object must have at least one of 'verify_invariants' or "
2566 "'verify_region_invariants' methods");
2567
2569 callbacks.construct = [](void *userData) {
2570 nb::handle(static_cast<PyObject *>(userData)).inc_ref();
2571 };
2572 callbacks.destruct = [](void *userData) {
2573 nb::handle(static_cast<PyObject *>(userData)).dec_ref();
2574 };
2575
2576 callbacks.verifyTrait = [](MlirOperation op,
2577 void *userData) -> MlirLogicalResult {
2578 return verifyTraitByMethod(op, userData, "verify_invariants");
2579 };
2580 callbacks.verifyRegionTrait = [](MlirOperation op,
2581 void *userData) -> MlirLogicalResult {
2582 return verifyTraitByMethod(op, userData, "verify_region_invariants");
2583 };
2584
2585 // To ensure that the same dynamic trait gets the same TypeID despite how many
2586 // times `attach` is called, we store it as an attribute on the target class.
2587 if (!nb::hasattr(target, typeIDAttr)) {
2588 nb::setattr(target, typeIDAttr,
2589 nb::cast(PyTypeID(PyGlobals::get().allocateTypeID())));
2590 }
2591 MlirDynamicOpTrait trait = mlirDynamicOpTraitCreate(
2592 nb::cast<PyTypeID>(target.attr(typeIDAttr)).get(), callbacks,
2593 static_cast<void *>(target.ptr()));
2594 return attachOpTrait(opName, trait, context);
2595}
2596
2597void PyDynamicOpTrait::bind(nb::module_ &m) {
2598 nb::class_<PyDynamicOpTrait> cls(m, "DynamicOpTrait");
2599 cls.attr("attach") = classmethod(
2600 [](const nb::object &cls, const nb::object &opName, nb::object target,
2601 DefaultingPyMlirContext context) {
2602 if (target.is_none())
2603 target = cls;
2604 return PyDynamicOpTrait::attach(opName, target, *context.get());
2605 },
2606 nb::arg("cls"), nb::arg("op_name"), nb::arg("target").none() = nb::none(),
2607 nb::arg("context").none() = nb::none(),
2608 "Attach the dynamic op trait subclass to the given operation name.");
2609}
2610
2611bool PyDynamicOpTraits::IsTerminator::attach(const nb::object &opName,
2612 PyMlirContext &context) {
2613 MlirDynamicOpTrait trait = mlirDynamicOpTraitIsTerminatorCreate();
2614 return attachOpTrait(opName, trait, context);
2615}
2616
2617void PyDynamicOpTraits::IsTerminator::bind(nb::module_ &m) {
2618 nb::class_<PyDynamicOpTraits::IsTerminator, PyDynamicOpTrait> cls(
2619 m, "IsTerminatorTrait");
2620 cls.attr(typeIDAttr) = PyTypeID(mlirDynamicOpTraitIsTerminatorGetTypeID());
2621 cls.attr("attach") = classmethod(
2622 [](const nb::object &cls, const nb::object &opName,
2623 DefaultingPyMlirContext context) {
2624 return PyDynamicOpTraits::IsTerminator::attach(opName, *context.get());
2626 "Attach IsTerminator trait to the given operation name.", nb::arg("cls"),
2627 nb::arg("op_name"), nb::arg("context").none() = nb::none());
2628}
2629
2630bool PyDynamicOpTraits::NoTerminator::attach(const nb::object &opName,
2631 PyMlirContext &context) {
2632 MlirDynamicOpTrait trait = mlirDynamicOpTraitNoTerminatorCreate();
2633 return attachOpTrait(opName, trait, context);
2634}
2635
2636void PyDynamicOpTraits::NoTerminator::bind(nb::module_ &m) {
2637 nb::class_<PyDynamicOpTraits::NoTerminator, PyDynamicOpTrait> cls(
2638 m, "NoTerminatorTrait");
2639 cls.attr(typeIDAttr) = PyTypeID(mlirDynamicOpTraitNoTerminatorGetTypeID());
2640 cls.attr("attach") = classmethod(
2641 [](const nb::object &cls, const nb::object &opName,
2642 DefaultingPyMlirContext context) {
2643 return PyDynamicOpTraits::NoTerminator::attach(opName, *context.get());
2644 },
2645 "Attach NoTerminator trait to the given operation name.", nb::arg("cls"),
2646 nb::arg("op_name"), nb::arg("context").none() = nb::none());
2647}
2648
2649} // namespace MLIR_BINDINGS_PYTHON_DOMAIN
2650} // namespace python
2651} // namespace mlir
2652
2653namespace {
2654
2655using namespace mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN;
2656
2657MlirLocation tracebackToLocation(MlirContext ctx) {
2658#if defined(Py_LIMITED_API)
2659 // Frame introspection C APIs are not available under the limited API.
2660 // Traceback-based auto-location is not supported; return unknown.
2661 return mlirLocationUnknownGet(ctx);
2662#else
2663 size_t framesLimit =
2665 // Use a thread_local here to avoid requiring a large amount of space.
2666 thread_local std::array<MlirLocation, PyGlobals::TracebackLoc::kMaxFrames>
2667 frames;
2668 size_t count = 0;
2669
2670 nb::gil_scoped_acquire acquire;
2671
2672 PyThreadState *tstate = PyThreadState_GET();
2673 PyFrameObject *next;
2674 PyFrameObject *pyFrame = PyThreadState_GetFrame(tstate);
2675 // In the increment expression:
2676 // 1. get the next prev frame;
2677 // 2. decrement the ref count on the current frame (in order that it can get
2678 // gc'd, along with any objects in its closure and etc);
2679 // 3. set current = next.
2680 for (; pyFrame != nullptr && count < framesLimit;
2681 next = PyFrame_GetBack(pyFrame), Py_XDECREF(pyFrame), pyFrame = next) {
2682 PyCodeObject *code = PyFrame_GetCode(pyFrame);
2683 auto fileNameStr =
2684 nb::cast<std::string>(nb::borrow<nb::str>(code->co_filename));
2685 std::string_view fileName(fileNameStr);
2686 if (!PyGlobals::get().getTracebackLoc().isUserTracebackFilename(fileName))
2687 continue;
2688
2689 // co_qualname and PyCode_Addr2Location added in py3.11
2690#if PY_VERSION_HEX < 0x030B00F0
2691 std::string name =
2692 nb::cast<std::string>(nb::borrow<nb::str>(code->co_name));
2693 std::string_view funcName(name);
2694 int startLine = PyFrame_GetLineNumber(pyFrame);
2695 MlirLocation loc = mlirLocationFileLineColGet(
2696 ctx, mlirStringRefCreate(fileName.data(), fileName.size()), startLine,
2697 0);
2698#else
2699 std::string name =
2700 nb::cast<std::string>(nb::borrow<nb::str>(code->co_qualname));
2701 std::string_view funcName(name);
2702 int startLine, startCol, endLine, endCol;
2703 int lasti = PyFrame_GetLasti(pyFrame);
2704 if (!PyCode_Addr2Location(code, lasti, &startLine, &startCol, &endLine,
2705 &endCol)) {
2706 throw nb::python_error();
2707 }
2708 MlirLocation loc = mlirLocationFileLineColRangeGet(
2709 ctx, mlirStringRefCreate(fileName.data(), fileName.size()), startLine,
2710 startCol, endLine, endCol);
2711#endif
2712
2713 frames[count] = mlirLocationNameGet(
2714 ctx, mlirStringRefCreate(funcName.data(), funcName.size()), loc);
2715 ++count;
2716 }
2717 // When the loop breaks (after the last iter), current frame (if non-null)
2718 // is leaked without this.
2719 Py_XDECREF(pyFrame);
2720
2721 if (count == 0)
2722 return mlirLocationUnknownGet(ctx);
2723
2724 MlirLocation callee = frames[0];
2725 assert(!mlirLocationIsNull(callee) && "expected non-null callee location");
2726 if (count == 1)
2727 return callee;
2728
2729 MlirLocation caller = frames[count - 1];
2730 assert(!mlirLocationIsNull(caller) && "expected non-null caller location");
2731 for (int i = count - 2; i >= 1; i--)
2732 caller = mlirLocationCallSiteGet(frames[i], caller);
2733
2734 return mlirLocationCallSiteGet(callee, caller);
2735#endif
2736}
2737
2738/// Apply currentLocAction: wrap or fuse Location.current onto baseLoc.
2739static MlirLocation
2740applyCurrentLocAction(MlirContext ctx, MlirLocation baseLoc,
2743 if (action == Action::Fallback)
2744 return baseLoc;
2745
2746 auto *currentLoc = PyThreadContextEntry::getDefaultLocation();
2747 if (!currentLoc)
2748 return baseLoc;
2749 assert(mlirLocationGetContext(currentLoc->get()).ptr == ctx.ptr &&
2750 "Location.current must belong to the current MLIR context");
2751
2752 // NamelocWrap: walk the NameLoc chain on Location.current, collect scope
2753 // names, wrap baseLoc innermost-first so result is Outer(Inner(baseLoc)).
2754 // If Location.current is not a NameLoc, scopeNames is empty and baseLoc
2755 // is returned unchanged (nameloc_wrap is a no-op for non-NameLoc contexts).
2756 thread_local std::vector<MlirStringRef> scopeNames;
2757 scopeNames.clear();
2758 MlirLocation walk = currentLoc->get();
2759 while (mlirLocationIsAName(walk)) {
2760 scopeNames.push_back(mlirIdentifierStr(mlirLocationNameGetName(walk)));
2762 }
2763 for (auto it = scopeNames.rbegin(); it != scopeNames.rend(); ++it)
2764 baseLoc = mlirLocationNameGet(ctx, *it, baseLoc);
2765 return baseLoc;
2766}
2767
2768PyLocation
2769maybeGetTracebackLocation(const std::optional<PyLocation> &location) {
2770 auto &tbl = PyGlobals::get().getTracebackLoc();
2771
2772 // Tracebacks not enabled — return explicit loc or fall back to
2773 // Location.current.
2774 if (!tbl.locTracebacksEnabled())
2775 return location.has_value() ? location.value()
2777
2778 // From here: tracebacks are enabled.
2780 PyMlirContext &ctx = DefaultingPyMlirContext::resolve();
2781 MlirLocation baseLoc;
2782
2783 // Step 1: on_explicit — resolve explicit loc= vs traceback.
2784 if (location.has_value()) {
2785 switch (tbl.tracebackActionOnExplicitLoc()) {
2786 case OnExplicit::UseExplicit:
2787 baseLoc = location->get();
2788 break;
2789 case OnExplicit::UseTraceback:
2790 baseLoc = tracebackToLocation(ctx.get());
2791 break;
2792 }
2793 } else {
2794 baseLoc = tracebackToLocation(ctx.get());
2795 }
2796
2797 // Step 2: current_loc — compose with Location.current.
2798 baseLoc = applyCurrentLocAction(ctx.get(), baseLoc,
2799 tbl.tracebackActionOnCurrentLoc());
2800
2802 return {ref, baseLoc};
2803}
2804} // namespace
2805
2806namespace mlir {
2807namespace python {
2809
2810static std::string formatMLIRError(const MLIRError &e) {
2811 auto locStr = [](const PyLocation &loc) {
2812 PyPrintAccumulator accum;
2813 mlirLocationPrint(loc, accum.getCallback(), accum.getUserData());
2814 std::string s = nb::cast<std::string>(nb::str(accum.join()));
2815 std::string_view sv(s);
2816 if (sv.size() > 5) {
2817 sv.remove_prefix(4); // "loc("
2818 sv.remove_suffix(1); // ")"
2819 }
2820 return std::string(sv);
2821 };
2822 auto indent = [](std::string s) {
2823 size_t pos = 0;
2824 while ((pos = s.find('\n', pos)) != std::string::npos) {
2825 s.replace(pos, 1, "\n ");
2826 pos += 3;
2827 }
2828 return s;
2829 };
2830
2831 std::ostringstream os;
2832 os << e.message;
2833 if (!e.errorDiagnostics.empty())
2834 os << ":";
2835 for (const auto &diag : e.errorDiagnostics) {
2836 os << "\nerror: " << locStr(diag.location) << ": " << indent(diag.message);
2837 for (const auto &note : diag.notes) {
2838 os << "\n note: " << locStr(note.location) << ": "
2839 << indent(note.message);
2840 }
2841 }
2842 return os.str();
2843}
2844
2845void MLIRError::bind(nb::module_ &m) {
2846 auto cls = nb::exception<MLIRError>(m, "MLIRError", PyExc_Exception);
2847 nb::register_exception_translator(
2848 [](const std::exception_ptr &p, void *payload) {
2849 try {
2850 if (p)
2851 std::rethrow_exception(p);
2852 } catch (MLIRError &e) {
2853 std::string formatted = formatMLIRError(e);
2854 nb::object ty = nb::borrow(static_cast<PyObject *>(payload));
2855 nb::object obj = ty(formatted);
2856 obj.attr("_message") = nb::cast(std::move(e.message));
2857 obj.attr("_error_diagnostics") =
2858 nb::cast(std::move(e.errorDiagnostics));
2859 PyErr_SetObject(static_cast<PyObject *>(payload), obj.ptr());
2860 }
2861 },
2862 cls.ptr());
2863 auto propertyType = nb::borrow<nb::type_object>(
2864 reinterpret_cast<PyObject *>(&PyProperty_Type));
2865 nb::setattr(
2866 cls, "message",
2867 propertyType(nb::cpp_function(
2868 [](nb::object self) -> nb::str { return self.attr("_message"); },
2869 nb::is_method())));
2870 nb::setattr(cls, "error_diagnostics",
2871 propertyType(nb::cpp_function(
2872 [](nb::object self)
2873 -> nb::typed<nb::list, PyDiagnostic::DiagnosticInfo> {
2874 return self.attr("_error_diagnostics");
2875 },
2876 nb::is_method())));
2877}
2878
2879void populateRoot(nb::module_ &m) {
2880 m.attr("T") = nb::type_var("T");
2881 m.attr("U") = nb::type_var("U");
2882
2883 // Policies for how loc_tracebacks() composes the three location sources
2884 // (explicit loc=, generated traceback, Location.current).
2885 nb::enum_<PyGlobals::TracebackLoc::OnExplicitAction>(m, "OnExplicitAction")
2886 .value("USE_EXPLICIT",
2888 .value("USE_TRACEBACK",
2890
2891 nb::enum_<PyGlobals::TracebackLoc::CurrentLocAction>(m, "CurrentLocAction")
2893 .value("NAMELOC_WRAP",
2895
2896 nb::class_<PyGlobals>(m, "_Globals")
2897 .def_prop_rw("dialect_search_modules",
2900 .def("append_dialect_search_prefix", &PyGlobals::addDialectSearchPrefix,
2901 "module_name"_a)
2902 .def(
2903 "_check_dialect_module_loaded",
2904 [](PyGlobals &self, const std::string &dialectNamespace) {
2905 return self.loadDialectModule(dialectNamespace);
2906 },
2907 "dialect_namespace"_a)
2908 .def("_register_dialect_impl", &PyGlobals::registerDialectImpl,
2909 "dialect_namespace"_a, "dialect_class"_a, nb::kw_only(),
2910 "replace"_a = false,
2911 "Testing hook for directly registering a dialect")
2912 .def("_register_operation_impl", &PyGlobals::registerOperationImpl,
2913 "operation_name"_a, "operation_class"_a, nb::kw_only(),
2914 "replace"_a = false,
2915 "Testing hook for directly registering an operation")
2916 .def("loc_tracebacks_enabled",
2917 [](PyGlobals &self) {
2918 return self.getTracebackLoc().locTracebacksEnabled();
2919 })
2920 .def("set_loc_tracebacks_enabled",
2921 [](PyGlobals &self, bool enabled) {
2923 })
2924 .def("loc_tracebacks_frame_limit",
2925 [](PyGlobals &self) {
2927 })
2928 .def("set_loc_tracebacks_frame_limit",
2929 [](PyGlobals &self, std::optional<int> n) {
2932 })
2933 .def("register_traceback_file_inclusion",
2934 [](PyGlobals &self, const std::string &filename) {
2936 })
2937 .def("register_traceback_file_exclusion",
2938 [](PyGlobals &self, const std::string &filename) {
2940 })
2941 .def("traceback_action_on_explicit_loc",
2942 [](PyGlobals &self) {
2944 })
2945 .def("set_traceback_action_on_explicit_loc",
2946 [](PyGlobals &self,
2949 })
2950 .def("traceback_action_on_current_loc",
2951 [](PyGlobals &self) {
2953 })
2954 .def("set_traceback_action_on_current_loc",
2955 [](PyGlobals &self,
2958 });
2959
2960 // Aside from making the globals accessible to python, having python manage
2961 // it is necessary to make sure it is destroyed (and releases its python
2962 // resources) properly.
2963 m.attr("globals") = nb::cast(new PyGlobals, nb::rv_policy::take_ownership);
2964
2965 // Registration decorators.
2966 m.def(
2967 "register_dialect",
2968 [](nb::type_object pyClass) {
2969 std::string dialectNamespace =
2970 nb::cast<std::string>(pyClass.attr("DIALECT_NAMESPACE"));
2971 PyGlobals::get().registerDialectImpl(dialectNamespace, pyClass);
2972 return pyClass;
2973 },
2974 "dialect_class"_a,
2975 "Class decorator for registering a custom Dialect wrapper");
2976 m.def(
2977 "register_operation",
2978 [](const nb::type_object &dialectClass, bool replace) -> nb::object {
2979 return nb::cpp_function(
2980 [dialectClass,
2981 replace](nb::type_object opClass) -> nb::type_object {
2982 std::string operationName =
2983 nb::cast<std::string>(opClass.attr("OPERATION_NAME"));
2984 PyGlobals::get().registerOperationImpl(operationName, opClass,
2985 replace);
2986 // Dict-stuff the new opClass by name onto the dialect class.
2987 nb::object opClassName = opClass.attr("__name__");
2988 dialectClass.attr(opClassName) = opClass;
2989 return opClass;
2990 });
2991 },
2992 // clang-format off
2993 nb::sig("def register_operation(dialect_class: type, *, replace: bool = False) "
2994 "-> typing.Callable[[type[T]], type[T]]"),
2995 // clang-format on
2996 "dialect_class"_a, nb::kw_only(), "replace"_a = false,
2997 "Produce a class decorator for registering an Operation class as part of "
2998 "a dialect");
2999 m.def(
3000 "register_op_adaptor",
3001 [](const nb::type_object &opClass, bool replace) -> nb::object {
3002 return nb::cpp_function(
3003 [opClass,
3004 replace](nb::type_object adaptorClass) -> nb::type_object {
3005 std::string operationName =
3006 nb::cast<std::string>(adaptorClass.attr("OPERATION_NAME"));
3007 PyGlobals::get().registerOpAdaptorImpl(operationName,
3008 adaptorClass, replace);
3009 // Dict-stuff the new adaptorClass by name onto the opClass.
3010 opClass.attr("Adaptor") = adaptorClass;
3011 return adaptorClass;
3012 });
3013 },
3014 // clang-format off
3015 nb::sig("def register_op_adaptor(op_class: type, *, replace: bool = False) "
3016 "-> typing.Callable[[type[T]], type[T]]"),
3017 // clang-format on
3018 "op_class"_a, nb::kw_only(), "replace"_a = false,
3019 "Produce a class decorator for registering an OpAdaptor class for an "
3020 "operation.");
3021 m.def(
3023 [](PyTypeID mlirTypeID, bool replace) -> nb::object {
3024 return nb::cpp_function([mlirTypeID, replace](
3025 nb::callable typeCaster) -> nb::object {
3026 PyGlobals::get().registerTypeCaster(mlirTypeID, typeCaster, replace);
3027 return typeCaster;
3028 });
3029 },
3030 // clang-format off
3031 nb::sig("def register_type_caster(typeid: _mlir.ir.TypeID, *, replace: bool = False) "
3032 "-> typing.Callable[[typing.Callable[[T], U]], typing.Callable[[T], U]]"),
3033 // clang-format on
3034 "typeid"_a, nb::kw_only(), "replace"_a = false,
3035 "Register a type caster for casting MLIR types to custom user types.");
3036 m.def(
3038 [](PyTypeID mlirTypeID, bool replace) -> nb::object {
3039 return nb::cpp_function(
3040 [mlirTypeID, replace](nb::callable valueCaster) -> nb::object {
3041 PyGlobals::get().registerValueCaster(mlirTypeID, valueCaster,
3042 replace);
3043 return valueCaster;
3044 });
3045 },
3046 // clang-format off
3047 nb::sig("def register_value_caster(typeid: _mlir.ir.TypeID, *, replace: bool = False) "
3048 "-> typing.Callable[[typing.Callable[[T], U]], typing.Callable[[T], U]]"),
3049 // clang-format on
3050 "typeid"_a, nb::kw_only(), "replace"_a = false,
3051 "Register a value caster for casting MLIR values to custom user values.");
3052}
3053
3054//------------------------------------------------------------------------------
3055// Populates the core exports of the 'ir' submodule.
3056//------------------------------------------------------------------------------
3057void populateIRCore(nb::module_ &m) {
3058 //----------------------------------------------------------------------------
3059 // Enums.
3060 //----------------------------------------------------------------------------
3061 nb::enum_<PyDiagnosticSeverity>(m, "DiagnosticSeverity")
3062 .value("ERROR", PyDiagnosticSeverity::Error)
3063 .value("WARNING", PyDiagnosticSeverity::Warning)
3064 .value("NOTE", PyDiagnosticSeverity::Note)
3065 .value("REMARK", PyDiagnosticSeverity::Remark);
3066
3067 nb::enum_<PyWalkOrder>(m, "WalkOrder")
3068 .value("PRE_ORDER", PyWalkOrder::PreOrder)
3069 .value("POST_ORDER", PyWalkOrder::PostOrder);
3070 nb::enum_<PyWalkResult>(m, "WalkResult")
3071 .value("ADVANCE", PyWalkResult::Advance)
3072 .value("INTERRUPT", PyWalkResult::Interrupt)
3073 .value("SKIP", PyWalkResult::Skip);
3074
3075 //----------------------------------------------------------------------------
3076 // Mapping of Diagnostics.
3077 //----------------------------------------------------------------------------
3078 nb::class_<PyDiagnostic>(m, "Diagnostic")
3079 .def_prop_ro("severity", &PyDiagnostic::getSeverity,
3080 "Returns the severity of the diagnostic.")
3081 .def_prop_ro("location", &PyDiagnostic::getLocation,
3082 "Returns the location associated with the diagnostic.")
3083 .def_prop_ro("message", &PyDiagnostic::getMessage,
3084 "Returns the message text of the diagnostic.")
3085 .def_prop_ro("notes", &PyDiagnostic::getNotes,
3086 "Returns a tuple of attached note diagnostics.")
3087 .def(
3088 "__str__",
3089 [](PyDiagnostic &self) -> nb::str {
3090 if (!self.isValid())
3091 return nb::str("<Invalid Diagnostic>");
3092 return self.getMessage();
3093 },
3094 "Returns the diagnostic message as a string.");
3095
3096 nb::class_<PyDiagnostic::DiagnosticInfo>(m, "DiagnosticInfo")
3097 .def(
3098 "__init__",
3100 new (&self) PyDiagnostic::DiagnosticInfo(diag.getInfo());
3101 },
3102 "diag"_a, "Creates a DiagnosticInfo from a Diagnostic.")
3103 .def_ro("severity", &PyDiagnostic::DiagnosticInfo::severity,
3104 "The severity level of the diagnostic.")
3105 .def_ro("location", &PyDiagnostic::DiagnosticInfo::location,
3106 "The location associated with the diagnostic.")
3107 .def_ro("message", &PyDiagnostic::DiagnosticInfo::message,
3108 "The message text of the diagnostic.")
3109 .def_ro("notes", &PyDiagnostic::DiagnosticInfo::notes,
3110 "List of attached note diagnostics.")
3111 .def(
3112 "__str__",
3113 [](PyDiagnostic::DiagnosticInfo &self) { return self.message; },
3114 "Returns the diagnostic message as a string.");
3115
3116 nb::class_<PyDiagnosticHandler>(m, "DiagnosticHandler")
3117 .def("detach", &PyDiagnosticHandler::detach,
3118 "Detaches the diagnostic handler from the context.")
3119 .def_prop_ro("attached", &PyDiagnosticHandler::isAttached,
3120 "Returns True if the handler is attached to a context.")
3121 .def_prop_ro("had_error", &PyDiagnosticHandler::getHadError,
3122 "Returns True if an error was encountered during diagnostic "
3123 "handling.")
3124 .def("__enter__", &PyDiagnosticHandler::contextEnter,
3125 "Enters the diagnostic handler as a context manager.",
3126 nb::sig("def __enter__(self, /) -> DiagnosticHandler"))
3127 .def("__exit__", &PyDiagnosticHandler::contextExit, "exc_type"_a.none(),
3128 "exc_value"_a.none(), "traceback"_a.none(),
3129 "Exits the diagnostic handler context manager.");
3130
3131 // Expose DefaultThreadPool to python
3132 nb::class_<PyThreadPool>(m, "ThreadPool")
3133 .def(
3134 "__init__", [](PyThreadPool &self) { new (&self) PyThreadPool(); },
3135 "Creates a new thread pool with default concurrency.")
3136 .def("get_max_concurrency", &PyThreadPool::getMaxConcurrency,
3137 "Returns the maximum number of threads in the pool.")
3138 .def("_mlir_thread_pool_ptr", &PyThreadPool::_mlir_thread_pool_ptr,
3139 "Returns the raw pointer to the LLVM thread pool as a string.");
3140
3141 nb::class_<PyMlirContext>(m, "Context")
3142 .def(
3143 "__init__",
3144 [](PyMlirContext &self) {
3145 MlirContext context = mlirContextCreateWithThreading(false);
3146 new (&self) PyMlirContext(context);
3147 },
3148 R"(
3149 Creates a new MLIR context.
3150
3151 The context is the top-level container for all MLIR objects. It owns the storage
3152 for types, attributes, locations, and other core IR objects. A context can be
3153 configured to allow or disallow unregistered dialects and can have dialects
3154 loaded on-demand.)")
3155 .def_static("_get_live_count", &PyMlirContext::getLiveCount,
3156 "Gets the number of live Context objects.")
3157 .def(
3158 "_get_context_again",
3159 [](PyMlirContext &self) -> nb::typed<nb::object, PyMlirContext> {
3161 return ref.releaseObject();
3162 },
3163 "Gets another reference to the same context.")
3164 .def("_get_live_module_count", &PyMlirContext::getLiveModuleCount,
3165 "Gets the number of live modules owned by this context.")
3167 "Gets a capsule wrapping the MlirContext.")
3170 "Creates a Context from a capsule wrapping MlirContext.")
3171 .def("__enter__", &PyMlirContext::contextEnter,
3172 "Enters the context as a context manager.",
3173 nb::sig("def __enter__(self, /) -> Context"))
3174 .def("__exit__", &PyMlirContext::contextExit, "exc_type"_a.none(),
3175 "exc_value"_a.none(), "traceback"_a.none(),
3176 "Exits the context manager.")
3177 .def_prop_ro_static(
3178 "current",
3179 [](nb::object & /*class*/)
3180 -> std::optional<nb::typed<nb::object, PyMlirContext>> {
3182 if (!context)
3183 return {};
3184 return nb::cast(context);
3185 },
3186 nb::sig("def current(/) -> Context | None"),
3187 "Gets the Context bound to the current thread or returns None if no "
3188 "context is set.")
3189 .def_prop_ro(
3190 "dialects",
3191 [](PyMlirContext &self) { return PyDialects(self.getRef()); },
3192 "Gets a container for accessing dialects by name.")
3193 .def_prop_ro(
3194 "d", [](PyMlirContext &self) { return PyDialects(self.getRef()); },
3195 "Alias for `dialects`.")
3196 .def(
3197 "get_dialect_descriptor",
3198 [=](PyMlirContext &self, std::string &name) {
3199 MlirDialect dialect = mlirContextGetOrLoadDialect(
3200 self.get(), {name.data(), name.size()});
3201 if (mlirDialectIsNull(dialect)) {
3202 throw nb::value_error(
3203 join("Dialect '", name, "' not found").c_str());
3204 }
3205 return PyDialectDescriptor(self.getRef(), dialect);
3206 },
3207 "dialect_name"_a,
3208 "Gets or loads a dialect by name, returning its descriptor object.")
3209 .def_prop_rw(
3210 "allow_unregistered_dialects",
3211 [](PyMlirContext &self) -> bool {
3212 return mlirContextGetAllowUnregisteredDialects(self.get());
3213 },
3214 [](PyMlirContext &self, bool value) {
3215 mlirContextSetAllowUnregisteredDialects(self.get(), value);
3216 },
3217 "Controls whether unregistered dialects are allowed in this context.")
3218 .def("attach_diagnostic_handler", &PyMlirContext::attachDiagnosticHandler,
3219 "callback"_a,
3220 "Attaches a diagnostic handler that will receive callbacks.")
3221 .def(
3222 "enable_multithreading",
3223 [](PyMlirContext &self, bool enable) {
3224 mlirContextEnableMultithreading(self.get(), enable);
3225 },
3226 "enable"_a,
3227 R"(
3228 Enables or disables multi-threading support in the context.
3229
3230 Args:
3231 enable: Whether to enable (True) or disable (False) multi-threading.
3232 )")
3233 .def(
3234 "set_thread_pool",
3235 [](PyMlirContext &self, PyThreadPool &pool) {
3236 // we should disable multi-threading first before setting
3237 // new thread pool otherwise the assert in
3238 // MLIRContext::setThreadPool will be raised.
3239 mlirContextEnableMultithreading(self.get(), false);
3240 mlirContextSetThreadPool(self.get(), pool.get());
3241 },
3242 R"(
3243 Sets a custom thread pool for the context to use.
3244
3245 Args:
3246 pool: A ThreadPool object to use for parallel operations.
3247
3248 Note:
3249 Multi-threading is automatically disabled before setting the thread pool.)")
3250 .def(
3251 "get_num_threads",
3252 [](PyMlirContext &self) {
3253 return mlirContextGetNumThreads(self.get());
3254 },
3255 "Gets the number of threads in the context's thread pool.")
3256 .def(
3257 "_mlir_thread_pool_ptr",
3258 [](PyMlirContext &self) {
3259 MlirLlvmThreadPool pool = mlirContextGetThreadPool(self.get());
3260 std::stringstream ss;
3261 ss << pool.ptr;
3262 return ss.str();
3263 },
3264 "Gets the raw pointer to the LLVM thread pool as a string.")
3265 .def(
3266 "is_registered_operation",
3267 [](PyMlirContext &self, std::string &name) {
3269 self.get(), MlirStringRef{name.data(), name.size()});
3270 },
3271 "operation_name"_a,
3272 R"(
3273 Checks whether an operation with the given name is registered.
3274
3275 Args:
3276 operation_name: The fully qualified name of the operation (e.g., `arith.addf`).
3277
3278 Returns:
3279 True if the operation is registered, False otherwise.)")
3280 .def(
3281 "append_dialect_registry",
3282 [](PyMlirContext &self, PyDialectRegistry &registry) {
3283 mlirContextAppendDialectRegistry(self.get(), registry);
3284 },
3285 "registry"_a,
3286 R"(
3287 Appends the contents of a dialect registry to the context.
3288
3289 Args:
3290 registry: A DialectRegistry containing dialects to append.)")
3291 .def_prop_rw("emit_error_diagnostics",
3294 R"(
3295 Controls whether error diagnostics are emitted to diagnostic handlers.
3296
3297 By default, error diagnostics are captured and reported through MLIRError exceptions.)")
3298 .def(
3299 "load_all_available_dialects",
3300 [](PyMlirContext &self) {
3302 },
3303 R"(
3304 Loads all dialects available in the registry into the context.
3305
3306 This eagerly loads all dialects that have been registered, making them
3307 immediately available for use.)");
3308
3309 //----------------------------------------------------------------------------
3310 // Mapping of PyDialectDescriptor
3311 //----------------------------------------------------------------------------
3312 nb::class_<PyDialectDescriptor>(m, "DialectDescriptor")
3313 .def_prop_ro(
3314 "namespace",
3315 [](PyDialectDescriptor &self) {
3316 MlirStringRef ns = mlirDialectGetNamespace(self.get());
3317 return nb::str(ns.data, ns.length);
3318 },
3319 "Returns the namespace of the dialect.")
3320 .def(
3321 "__repr__",
3322 [](PyDialectDescriptor &self) {
3323 MlirStringRef ns = mlirDialectGetNamespace(self.get());
3324 std::string repr("<DialectDescriptor ");
3325 repr.append(ns.data, ns.length);
3326 repr.append(">");
3327 return repr;
3328 },
3329 nb::sig("def __repr__(self) -> str"),
3330 "Returns a string representation of the dialect descriptor.");
3331
3332 //----------------------------------------------------------------------------
3333 // Mapping of PyDialects
3334 //----------------------------------------------------------------------------
3335 nb::class_<PyDialects>(m, "Dialects")
3336 .def(
3337 "__getitem__",
3338 [=](PyDialects &self, std::string keyName) {
3339 MlirDialect dialect =
3340 self.getDialectForKey(keyName, /*attrError=*/false);
3341 nb::object descriptor =
3342 nb::cast(PyDialectDescriptor{self.getContext(), dialect});
3343 return createCustomDialectWrapper(keyName, std::move(descriptor));
3344 },
3345 "Gets a dialect by name using subscript notation.")
3346 .def(
3347 "__getattr__",
3348 [=](PyDialects &self, std::string attrName) {
3349 MlirDialect dialect =
3350 self.getDialectForKey(attrName, /*attrError=*/true);
3351 nb::object descriptor =
3352 nb::cast(PyDialectDescriptor{self.getContext(), dialect});
3353 return createCustomDialectWrapper(attrName, std::move(descriptor));
3354 },
3355 "Gets a dialect by name using attribute notation.");
3356
3357 //----------------------------------------------------------------------------
3358 // Mapping of PyDialect
3359 //----------------------------------------------------------------------------
3360 nb::class_<PyDialect>(m, "Dialect")
3361 .def(nb::init<nb::object>(), "descriptor"_a,
3362 "Creates a Dialect from a DialectDescriptor.")
3363 .def_prop_ro(
3364 "descriptor", [](PyDialect &self) { return self.getDescriptor(); },
3365 "Returns the DialectDescriptor for this dialect.")
3366 .def(
3367 "__repr__",
3368 [](const nb::object &self) {
3369 auto clazz = self.attr("__class__");
3370 return nb::str("<Dialect ") +
3371 self.attr("descriptor").attr("namespace") +
3372 nb::str(" (class ") + clazz.attr("__module__") +
3373 nb::str(".") + clazz.attr("__name__") + nb::str(")>");
3374 },
3375 nb::sig("def __repr__(self) -> str"),
3376 "Returns a string representation of the dialect.");
3377
3378 //----------------------------------------------------------------------------
3379 // Mapping of PyDialectRegistry
3380 //----------------------------------------------------------------------------
3381 nb::class_<PyDialectRegistry>(m, "DialectRegistry")
3383 "Gets a capsule wrapping the MlirDialectRegistry.")
3386 "Creates a DialectRegistry from a capsule wrapping "
3387 "`MlirDialectRegistry`.")
3388 .def(nb::init<>(), "Creates a new empty dialect registry.");
3389
3390 //----------------------------------------------------------------------------
3391 // Mapping of Location
3392 //----------------------------------------------------------------------------
3393 nb::class_<PyLocation>(m, "Location")
3395 "Gets a capsule wrapping the MlirLocation.")
3397 "Creates a Location from a capsule wrapping MlirLocation.")
3398 .def("__enter__", &PyLocation::contextEnter,
3399 "Enters the location as a context manager.",
3400 nb::sig("def __enter__(self, /) -> Location"))
3401 .def("__exit__", &PyLocation::contextExit, "exc_type"_a.none(),
3402 "exc_value"_a.none(), "traceback"_a.none(),
3403 "Exits the location context manager.")
3404 .def(
3405 "__eq__",
3406 [](PyLocation &self, PyLocation &other) -> bool {
3407 return mlirLocationEqual(self, other);
3408 },
3409 "Compares two locations for equality.")
3410 .def(
3411 "__eq__", [](PyLocation &self, nb::object other) { return false; },
3412 "Compares location with non-location object (always returns False).")
3413 .def_prop_ro_static(
3414 "current",
3415 [](nb::object & /*class*/) -> std::optional<PyLocation *> {
3417 if (!loc)
3418 return std::nullopt;
3419 return loc;
3420 },
3421 // clang-format off
3422 nb::sig("def current(/) -> Location | None"),
3423 // clang-format on
3424 "Gets the Location bound to the current thread or raises ValueError.")
3425 .def_static(
3426 "unknown",
3427 [](DefaultingPyMlirContext context) {
3428 return PyLocation(context->getRef(),
3429 mlirLocationUnknownGet(context->get()));
3430 },
3431 "context"_a = nb::none(),
3432 "Gets a Location representing an unknown location.")
3433 .def_static(
3434 "callsite",
3435 [](PyLocation callee, const std::vector<PyLocation> &frames,
3436 DefaultingPyMlirContext context) {
3437 if (frames.empty())
3438 throw nb::value_error("No caller frames provided.");
3439 MlirLocation caller = frames.back().get();
3440 for (size_t index = frames.size() - 1; index-- > 0;) {
3441 caller = mlirLocationCallSiteGet(frames[index].get(), caller);
3442 }
3443 return PyLocation(context->getRef(),
3444 mlirLocationCallSiteGet(callee.get(), caller));
3445 },
3446 "callee"_a, "frames"_a, "context"_a = nb::none(),
3447 "Gets a Location representing a caller and callsite.")
3448 .def("is_a_callsite", mlirLocationIsACallSite,
3449 "Returns True if this location is a CallSiteLoc.")
3450 .def_prop_ro(
3451 "callee",
3452 [](PyLocation &self) {
3453 return PyLocation(self.getContext(),
3455 },
3456 "Gets the callee location from a CallSiteLoc.")
3457 .def_prop_ro(
3458 "caller",
3459 [](PyLocation &self) {
3460 return PyLocation(self.getContext(),
3462 },
3463 "Gets the caller location from a CallSiteLoc.")
3464 .def_static(
3465 "file",
3466 [](std::string filename, int line, int col,
3467 DefaultingPyMlirContext context) {
3468 return PyLocation(
3469 context->getRef(),
3471 context->get(), toMlirStringRef(filename), line, col));
3472 },
3473 "filename"_a, "line"_a, "col"_a, "context"_a = nb::none(),
3474 "Gets a Location representing a file, line and column.")
3475 .def_static(
3476 "file",
3477 [](std::string filename, int startLine, int startCol, int endLine,
3478 int endCol, DefaultingPyMlirContext context) {
3479 return PyLocation(context->getRef(),
3481 context->get(), toMlirStringRef(filename),
3482 startLine, startCol, endLine, endCol));
3483 },
3484 "filename"_a, "start_line"_a, "start_col"_a, "end_line"_a,
3485 "end_col"_a, "context"_a = nb::none(),
3486 "Gets a Location representing a file, line and column range.")
3487 .def("is_a_file", mlirLocationIsAFileLineColRange,
3488 "Returns True if this location is a FileLineColLoc.")
3489 .def_prop_ro(
3490 "filename",
3491 [](PyLocation loc) {
3492 return mlirIdentifierStr(
3494 },
3495 "Gets the filename from a FileLineColLoc.")
3496 .def_prop_ro("start_line", mlirLocationFileLineColRangeGetStartLine,
3497 "Gets the start line number from a `FileLineColLoc`.")
3498 .def_prop_ro("start_col", mlirLocationFileLineColRangeGetStartColumn,
3499 "Gets the start column number from a `FileLineColLoc`.")
3500 .def_prop_ro("end_line", mlirLocationFileLineColRangeGetEndLine,
3501 "Gets the end line number from a `FileLineColLoc`.")
3502 .def_prop_ro("end_col", mlirLocationFileLineColRangeGetEndColumn,
3503 "Gets the end column number from a `FileLineColLoc`.")
3504 .def_static(
3505 "fused",
3506 [](const std::vector<PyLocation> &pyLocations,
3507 std::optional<PyAttribute> metadata,
3508 DefaultingPyMlirContext context) {
3509 std::vector<MlirLocation> locations;
3510 locations.reserve(pyLocations.size());
3511 for (const PyLocation &pyLocation : pyLocations)
3512 locations.push_back(pyLocation.get());
3513 MlirLocation location = mlirLocationFusedGet(
3514 context->get(), locations.size(), locations.data(),
3515 metadata ? metadata->get() : MlirAttribute{0});
3516 return PyLocation(context->getRef(), location);
3517 },
3518 "locations"_a, "metadata"_a = nb::none(), "context"_a = nb::none(),
3519 "Gets a Location representing a fused location with optional "
3520 "metadata.")
3521 .def("is_a_fused", mlirLocationIsAFused,
3522 "Returns True if this location is a `FusedLoc`.")
3523 .def_prop_ro(
3524 "locations",
3525 [](PyLocation &self) {
3526 unsigned numLocations = mlirLocationFusedGetNumLocations(self);
3527 std::vector<MlirLocation> locations(numLocations);
3528 if (numLocations)
3529 mlirLocationFusedGetLocations(self, locations.data());
3530 std::vector<PyLocation> pyLocations{};
3531 pyLocations.reserve(numLocations);
3532 for (unsigned i = 0; i < numLocations; ++i)
3533 pyLocations.emplace_back(self.getContext(), locations[i]);
3534 return pyLocations;
3535 },
3536 "Gets the list of locations from a `FusedLoc`.")
3537 .def_static(
3538 "name",
3539 [](std::string name, std::optional<PyLocation> childLoc,
3540 DefaultingPyMlirContext context) {
3541 return PyLocation(
3542 context->getRef(),
3544 context->get(), toMlirStringRef(name),
3545 childLoc ? childLoc->get()
3546 : mlirLocationUnknownGet(context->get())));
3547 },
3548 "name"_a, "childLoc"_a = nb::none(), "context"_a = nb::none(),
3549 "Gets a Location representing a named location with optional child "
3550 "location.")
3551 .def("is_a_name", mlirLocationIsAName,
3552 "Returns True if this location is a `NameLoc`.")
3553 .def_prop_ro(
3554 "name_str",
3555 [](PyLocation loc) {
3557 },
3558 "Gets the name string from a `NameLoc`.")
3559 .def_prop_ro(
3560 "child_loc",
3561 [](PyLocation &self) {
3562 return PyLocation(self.getContext(),
3564 },
3565 "Gets the child location from a `NameLoc`.")
3566 .def_static(
3567 "from_attr",
3568 [](PyAttribute &attribute, DefaultingPyMlirContext context) {
3569 return PyLocation(context->getRef(),
3570 mlirLocationFromAttribute(attribute));
3571 },
3572 "attribute"_a, "context"_a = nb::none(),
3573 "Gets a Location from a `LocationAttr`.")
3574 .def_prop_ro(
3575 "context",
3576 [](PyLocation &self) -> nb::typed<nb::object, PyMlirContext> {
3577 return self.getContext().getObject();
3578 },
3579 "Context that owns the `Location`.")
3580 .def_prop_ro(
3581 "attr",
3582 [](PyLocation &self) {
3583 return PyAttribute(self.getContext(),
3585 },
3586 "Get the underlying `LocationAttr`.")
3587 .def(
3588 "emit_error",
3589 [](PyLocation &self, std::string message) {
3590 mlirEmitError(self, message.c_str());
3591 },
3592 "message"_a,
3593 R"(
3594 Emits an error diagnostic at this location.
3595
3596 Args:
3597 message: The error message to emit.)")
3598 .def(
3599 "__repr__",
3600 [](PyLocation &self) {
3601 PyPrintAccumulator printAccum;
3602 mlirLocationPrint(self, printAccum.getCallback(),
3603 printAccum.getUserData());
3604 return printAccum.join();
3605 },
3606 "Returns the assembly representation of the location.");
3607
3608 //----------------------------------------------------------------------------
3609 // Mapping of Module
3610 //----------------------------------------------------------------------------
3611 nb::class_<PyModule>(m, "Module", nb::is_weak_referenceable())
3613 "Gets a capsule wrapping the MlirModule.")
3615 R"(
3616 Creates a Module from a `MlirModule` wrapped by a capsule (i.e. `module._CAPIPtr`).
3617
3618 This returns a new object **BUT** `_clear_mlir_module(module)` must be called to
3619 prevent double-frees (of the underlying `mlir::Module`).)")
3620 .def("_clear_mlir_module", &PyModule::clearMlirModule,
3621 R"(
3622 Clears the internal MLIR module reference.
3623
3624 This is used internally to prevent double-free when ownership is transferred
3625 via the C API capsule mechanism. Not intended for normal use.)")
3626 .def_static(
3627 "parse",
3628 [](const std::string &moduleAsm, DefaultingPyMlirContext context)
3629 -> nb::typed<nb::object, PyModule> {
3630 PyMlirContext::ErrorCapture errors(context->getRef());
3631 MlirModule module = mlirModuleCreateParse(
3632 context->get(), toMlirStringRef(moduleAsm));
3633 if (mlirModuleIsNull(module))
3634 throw MLIRError("Unable to parse module assembly", errors.take());
3635 return PyModule::forModule(module).releaseObject();
3636 },
3637 "asm"_a, "context"_a = nb::none(), kModuleParseDocstring)
3638 .def_static(
3639 "parse",
3640 [](nb::bytes moduleAsm, DefaultingPyMlirContext context)
3641 -> nb::typed<nb::object, PyModule> {
3642 PyMlirContext::ErrorCapture errors(context->getRef());
3643 MlirModule module = mlirModuleCreateParse(
3644 context->get(), toMlirStringRef(moduleAsm));
3645 if (mlirModuleIsNull(module))
3646 throw MLIRError("Unable to parse module assembly", errors.take());
3647 return PyModule::forModule(module).releaseObject();
3648 },
3649 "asm"_a, "context"_a = nb::none(), kModuleParseDocstring)
3650 .def_static(
3651 "parseFile",
3652 [](const std::string &path, DefaultingPyMlirContext context)
3653 -> nb::typed<nb::object, PyModule> {
3654 PyMlirContext::ErrorCapture errors(context->getRef());
3655 MlirModule module = mlirModuleCreateParseFromFile(
3656 context->get(), toMlirStringRef(path));
3657 if (mlirModuleIsNull(module))
3658 throw MLIRError("Unable to parse module assembly", errors.take());
3659 return PyModule::forModule(module).releaseObject();
3660 },
3661 "path"_a, "context"_a = nb::none(), kModuleParseDocstring)
3662 .def_static(
3663 "create",
3664 [](const std::optional<PyLocation> &loc)
3665 -> nb::typed<nb::object, PyModule> {
3666 PyLocation pyLoc = maybeGetTracebackLocation(loc);
3667 MlirModule module = mlirModuleCreateEmpty(pyLoc.get());
3668 return PyModule::forModule(module).releaseObject();
3669 },
3670 "loc"_a = nb::none(), "Creates an empty module.")
3671 .def_prop_ro(
3672 "context",
3673 [](PyModule &self) -> nb::typed<nb::object, PyMlirContext> {
3674 return self.getContext().getObject();
3675 },
3676 "Context that created the `Module`.")
3677 .def_prop_ro(
3678 "operation",
3679 [](PyModule &self) -> nb::typed<nb::object, PyOperation> {
3680 return PyOperation::forOperation(self.getContext(),
3681 mlirModuleGetOperation(self.get()),
3682 self.getRef().releaseObject())
3683 .releaseObject();
3684 },
3685 "Accesses the module as an operation.")
3686 .def_prop_ro(
3687 "body",
3688 [](PyModule &self) {
3690 self.getContext(), mlirModuleGetOperation(self.get()),
3691 self.getRef().releaseObject());
3692 PyBlock returnBlock(moduleOp, mlirModuleGetBody(self.get()));
3693 return returnBlock;
3694 },
3695 "Return the block for this module.")
3696 .def(
3697 "dump",
3698 [](PyModule &self) {
3700 },
3702 .def(
3703 "__str__",
3704 [](const nb::object &self) {
3705 // Defer to the operation's __str__.
3706 return self.attr("operation").attr("__str__")();
3707 },
3708 nb::sig("def __str__(self) -> str"),
3709 R"(
3710 Gets the assembly form of the operation with default options.
3711
3712 If more advanced control over the assembly formatting or I/O options is needed,
3713 use the dedicated print or get_asm method, which supports keyword arguments to
3714 customize behavior.
3715 )")
3716 .def(
3717 "__eq__",
3718 [](PyModule &self, PyModule &other) {
3719 return mlirModuleEqual(self.get(), other.get());
3720 },
3721 "other"_a, "Compares two modules for equality.")
3722 .def(
3723 "__hash__",
3724 [](PyModule &self) { return mlirModuleHashValue(self.get()); },
3725 "Returns the hash value of the module.");
3726
3727 //----------------------------------------------------------------------------
3728 // Mapping of Operation.
3729 //----------------------------------------------------------------------------
3730 nb::class_<PyOperationBase>(m, "_OperationBase")
3731 .def_prop_ro(
3733 [](PyOperationBase &self) {
3734 return self.getOperation().getCapsule();
3735 },
3736 "Gets a capsule wrapping the `MlirOperation`.")
3737 .def(
3738 "__eq__",
3739 [](PyOperationBase &self, PyOperationBase &other) {
3740 return mlirOperationEqual(self.getOperation().get(),
3741 other.getOperation().get());
3742 },
3743 "Compares two operations for equality.")
3744 .def(
3745 "__eq__",
3746 [](PyOperationBase &self, nb::object other) { return false; },
3747 "Compares operation with non-operation object (always returns "
3748 "False).")
3749 .def(
3750 "__hash__",
3751 [](PyOperationBase &self) {
3752 return mlirOperationHashValue(self.getOperation().get());
3753 },
3754 "Returns the hash value of the operation.")
3755 .def_prop_ro(
3756 "attributes",
3757 [](PyOperationBase &self) {
3758 return PyOpAttributeMap(self.getOperation().getRef());
3759 },
3760 "Returns a dictionary-like map of operation attributes.")
3761 .def_prop_ro(
3762 "context",
3763 [](PyOperationBase &self) -> nb::typed<nb::object, PyMlirContext> {
3764 PyOperation &concreteOperation = self.getOperation();
3765 concreteOperation.checkValid();
3766 return concreteOperation.getContext().getObject();
3767 },
3768 "Context that owns the operation.")
3769 .def_prop_ro(
3770 "name",
3771 [](PyOperationBase &self) {
3772 auto &concreteOperation = self.getOperation();
3773 concreteOperation.checkValid();
3774 MlirOperation operation = concreteOperation.get();
3775 return mlirIdentifierStr(mlirOperationGetName(operation));
3776 },
3777 "Returns the fully qualified name of the operation.")
3778 .def_prop_ro(
3779 "operands",
3780 [](PyOperationBase &self) {
3781 return PyOpOperandList(self.getOperation().getRef());
3782 },
3783 "Returns the list of operation operands.")
3784 .def_prop_ro(
3785 "op_operands",
3786 [](PyOperationBase &self) {
3787 return PyOpOperands(self.getOperation().getRef());
3788 },
3789 "Returns the list of op operands.")
3790 .def_prop_ro(
3791 "regions",
3792 [](PyOperationBase &self) {
3793 return PyRegionList(self.getOperation().getRef());
3794 },
3795 "Returns the list of operation regions.")
3796 .def_prop_ro(
3797 "results",
3798 [](PyOperationBase &self) {
3799 return PyOpResultList(self.getOperation().getRef());
3800 },
3801 "Returns the list of Operation results.")
3802 .def_prop_ro(
3803 "result",
3804 [](PyOperationBase &self) -> nb::typed<nb::object, PyOpResult> {
3805 auto &operation = self.getOperation();
3806 return PyOpResult(operation.getRef(), getUniqueResult(operation))
3807 .maybeDownCast();
3808 },
3809 "Shortcut to get an op result if it has only one (throws an error "
3810 "otherwise).")
3811 .def_prop_rw(
3812 "location",
3813 [](PyOperationBase &self) {
3814 PyOperation &operation = self.getOperation();
3815 return PyLocation(operation.getContext(),
3816 mlirOperationGetLocation(operation.get()));
3817 },
3818 [](PyOperationBase &self, const PyLocation &location) {
3819 PyOperation &operation = self.getOperation();
3820 mlirOperationSetLocation(operation.get(), location.get());
3821 },
3822 nb::for_getter("Returns the source location the operation was "
3823 "defined or derived from."),
3824 nb::for_setter("Sets the source location the operation was defined "
3825 "or derived from."))
3826 .def_prop_ro(
3827 "parent",
3828 [](PyOperationBase &self)
3829 -> std::optional<nb::typed<nb::object, PyOperation>> {
3830 auto parent = self.getOperation().getParentOperation();
3831 if (parent)
3832 return parent->getObject();
3833 return {};
3834 },
3835 "Returns the parent operation, or `None` if at top level.")
3836 .def(
3837 "__str__",
3838 [](PyOperationBase &self) {
3839 return self.getAsm(/*binary=*/false,
3840 /*largeElementsLimit=*/std::nullopt,
3841 /*largeResourceLimit=*/std::nullopt,
3842 /*enableDebugInfo=*/false,
3843 /*prettyDebugInfo=*/false,
3844 /*printGenericOpForm=*/false,
3845 /*useLocalScope=*/false,
3846 /*useNameLocAsPrefix=*/false,
3847 /*assumeVerified=*/false,
3848 /*skipRegions=*/false);
3849 },
3850 nb::sig("def __str__(self) -> str"),
3851 "Returns the assembly form of the operation.")
3852 .def("print",
3853 nb::overload_cast<PyAsmState &, nb::object, bool>(
3855 "state"_a, "file"_a = nb::none(), "binary"_a = false,
3856 R"(
3857 Prints the assembly form of the operation to a file like object.
3858
3859 Args:
3860 state: `AsmState` capturing the operation numbering and flags.
3861 file: Optional file like object to write to. Defaults to sys.stdout.
3862 binary: Whether to write `bytes` (True) or `str` (False). Defaults to False.)")
3863 .def("print",
3864 nb::overload_cast<std::optional<int64_t>, std::optional<int64_t>,
3865 bool, bool, bool, bool, bool, bool, nb::object,
3866 bool, bool>(&PyOperationBase::print),
3867 // Careful: Lots of arguments must match up with print method.
3868 "large_elements_limit"_a = nb::none(),
3869 "large_resource_limit"_a = nb::none(), "enable_debug_info"_a = false,
3870 "pretty_debug_info"_a = false, "print_generic_op_form"_a = false,
3871 "use_local_scope"_a = false, "use_name_loc_as_prefix"_a = false,
3872 "assume_verified"_a = false, "file"_a = nb::none(),
3873 "binary"_a = false, "skip_regions"_a = false,
3874 R"(
3875 Prints the assembly form of the operation to a file like object.
3876
3877 Args:
3878 large_elements_limit: Whether to elide elements attributes above this
3879 number of elements. Defaults to None (no limit).
3880 large_resource_limit: Whether to elide resource attributes above this
3881 number of characters. Defaults to None (no limit). If large_elements_limit
3882 is set and this is None, the behavior will be to use large_elements_limit
3883 as large_resource_limit.
3884 enable_debug_info: Whether to print debug/location information. Defaults
3885 to False.
3886 pretty_debug_info: Whether to format debug information for easier reading
3887 by a human (warning: the result is unparseable). Defaults to False.
3888 print_generic_op_form: Whether to print the generic assembly forms of all
3889 ops. Defaults to False.
3890 use_local_scope: Whether to print in a way that is more optimized for
3891 multi-threaded access but may not be consistent with how the overall
3892 module prints.
3893 use_name_loc_as_prefix: Whether to use location attributes (NameLoc) as
3894 prefixes for the SSA identifiers. Defaults to False.
3895 assume_verified: By default, if not printing generic form, the verifier
3896 will be run and if it fails, generic form will be printed with a comment
3897 about failed verification. While a reasonable default for interactive use,
3898 for systematic use, it is often better for the caller to verify explicitly
3899 and report failures in a more robust fashion. Set this to True if doing this
3900 in order to avoid running a redundant verification. If the IR is actually
3901 invalid, behavior is undefined.
3902 file: The file like object to write to. Defaults to sys.stdout.
3903 binary: Whether to write bytes (True) or str (False). Defaults to False.
3904 skip_regions: Whether to skip printing regions. Defaults to False.)")
3905 .def("write_bytecode", &PyOperationBase::writeBytecode, "file"_a,
3906 "desired_version"_a = nb::none(),
3907 R"(
3908 Write the bytecode form of the operation to a file like object.
3909
3910 Args:
3911 file: The file like object to write to.
3912 desired_version: Optional version of bytecode to emit.
3913 Returns:
3914 The bytecode writer status.)")
3915 .def("get_asm", &PyOperationBase::getAsm,
3916 // Careful: Lots of arguments must match up with get_asm method.
3917 "binary"_a = false, "large_elements_limit"_a = nb::none(),
3918 "large_resource_limit"_a = nb::none(), "enable_debug_info"_a = false,
3919 "pretty_debug_info"_a = false, "print_generic_op_form"_a = false,
3920 "use_local_scope"_a = false, "use_name_loc_as_prefix"_a = false,
3921 "assume_verified"_a = false, "skip_regions"_a = false,
3922 R"(
3923 Gets the assembly form of the operation with all options available.
3924
3925 Args:
3926 binary: Whether to return a bytes (True) or str (False) object. Defaults to
3927 False.
3928 ... others ...: See the print() method for common keyword arguments for
3929 configuring the printout.
3930 Returns:
3931 Either a bytes or str object, depending on the setting of the `binary`
3932 argument.)")
3933 .def("verify", &PyOperationBase::verify,
3934 "Verify the operation. Raises MLIRError if verification fails, and "
3935 "returns true otherwise.")
3936 .def("move_after", &PyOperationBase::moveAfter, "other"_a,
3937 "Puts self immediately after the other operation in its parent "
3938 "block.")
3939 .def("move_before", &PyOperationBase::moveBefore, "other"_a,
3940 "Puts self immediately before the other operation in its parent "
3941 "block.")
3942 .def("is_before_in_block", &PyOperationBase::isBeforeInBlock, "other"_a,
3943 R"(
3944 Checks if this operation is before another in the same block.
3945
3946 Args:
3947 other: Another operation in the same parent block.
3948
3949 Returns:
3950 True if this operation is before `other` in the operation list of the parent block.)")
3951 .def(
3952 "clone",
3953 [](PyOperationBase &self,
3954 const nb::object &ip) -> nb::typed<nb::object, PyOperation> {
3955 return self.getOperation().clone(ip);
3956 },
3957 "ip"_a = nb::none(),
3958 R"(
3959 Creates a deep copy of the operation.
3960
3961 Args:
3962 ip: Optional insertion point where the cloned operation should be inserted.
3963 If None, the current insertion point is used. If False, the operation
3964 remains detached.
3965
3966 Returns:
3967 A new Operation that is a clone of this operation.)")
3968 .def(
3969 "detach_from_parent",
3970 [](PyOperationBase &self) -> nb::typed<nb::object, PyOpView> {
3971 PyOperation &operation = self.getOperation();
3972 operation.checkValid();
3973 if (!operation.isAttached())
3974 throw nb::value_error("Detached operation has no parent.");
3975
3976 operation.detachFromParent();
3977 return operation.createOpView();
3978 },
3979 "Detaches the operation from its parent block.")
3980 .def_prop_ro(
3981 "attached",
3982 [](PyOperationBase &self) {
3983 PyOperation &operation = self.getOperation();
3984 operation.checkValid();
3985 return operation.isAttached();
3986 },
3987 "Reports if the operation is attached to its parent block.")
3988 .def(
3989 "erase", [](PyOperationBase &self) { self.getOperation().erase(); },
3990 R"(
3991 Erases the operation and frees its memory.
3992
3993 Note:
3994 After erasing, any Python references to the operation become invalid.)")
3995 .def(
3996 "walk",
3997 [](PyOperationBase &self,
3998 std::function<PyWalkResult(MlirOperation)> callback,
3999 PyWalkOrder walkOrder, std::optional<nb::object> opClass) {
4000 if (!opClass)
4001 return self.walk(callback, walkOrder);
4002 self.walk(
4003 [&](MlirOperation mlirOp) -> PyWalkResult {
4004 nb::object opview =
4006 self.getOperation().getContext(), mlirOp)
4007 ->createOpView();
4008 if (nb::isinstance(opview, *opClass))
4009 return callback(mlirOp);
4010 return PyWalkResult::Advance;
4011 },
4012 walkOrder);
4013 },
4014 "callback"_a, "walk_order"_a = PyWalkOrder::PostOrder,
4015 "op_class"_a = nb::none(),
4016 // clang-format off
4017 nb::sig("def walk(self, callback: Callable[[Operation], WalkResult], walk_order: WalkOrder = ..., op_class: type[OpView] | None = None) -> None"),
4018 // clang-format on
4019 R"(
4020 Walks the operation tree with a callback function.
4021
4022 If op_class is provided, the callback is only invoked on operations
4023 of that type; all other operations are skipped silently.
4024
4025 Args:
4026 callback: A callable that takes an Operation and returns a WalkResult.
4027 walk_order: The order of traversal (PRE_ORDER or POST_ORDER).
4028 op_class: If provided, only operations of this type are passed to the callback.)")
4029 .def(
4030 "has_trait",
4031 [](PyOperationBase &self, nb::type_object &traitCls) {
4032 PyTypeID traitTypeID =
4033 nb::cast<PyTypeID>(traitCls.attr(PyDynamicOpTrait::typeIDAttr));
4034 MlirIdentifier opName =
4035 mlirOperationGetName(self.getOperation().get());
4037 mlirIdentifierStr(opName), traitTypeID.get(),
4038 self.getOperation().getContext()->get());
4039 },
4040 "trait_cls"_a, "Checks if the operation has a given trait.");
4041
4042 nb::class_<PyOperation, PyOperationBase>(m, "Operation")
4043 .def_static(
4044 "create",
4045 [](std::string_view name,
4046 std::optional<std::vector<PyType *>> results,
4047 std::optional<std::vector<PyValue *>> operands,
4048 std::optional<nb::typed<nb::dict, nb::str, PyAttribute>>
4049 attributes,
4050 std::optional<std::vector<PyBlock *>> successors, int regions,
4051 const std::optional<PyLocation> &location,
4052 const nb::object &maybeIp,
4053 bool inferType) -> nb::typed<nb::object, PyOperation> {
4054 // Unpack/validate operands.
4055 std::vector<MlirValue> mlirOperands;
4056 if (operands) {
4057 mlirOperands.reserve(operands->size());
4058 for (PyValue *operand : *operands) {
4059 if (!operand)
4060 throw nb::value_error("operand value cannot be None");
4061 mlirOperands.push_back(operand->get());
4062 }
4063 }
4064
4065 PyLocation pyLoc = maybeGetTracebackLocation(location);
4066 return PyOperation::create(
4067 name, results, mlirOperands.data(), mlirOperands.size(),
4068 attributes, successors, regions, pyLoc, maybeIp, inferType);
4069 },
4070 "name"_a, "results"_a = nb::none(), "operands"_a = nb::none(),
4071 "attributes"_a = nb::none(), "successors"_a = nb::none(),
4072 "regions"_a = 0, "loc"_a = nb::none(), "ip"_a = nb::none(),
4073 "infer_type"_a = false,
4074 R"(
4075 Creates a new operation.
4076
4077 Args:
4078 name: Operation name (e.g. `dialect.operation`).
4079 results: Optional sequence of Type representing op result types.
4080 operands: Optional operands of the operation.
4081 attributes: Optional Dict of {str: Attribute}.
4082 successors: Optional List of Block for the operation's successors.
4083 regions: Number of regions to create (default = 0).
4084 location: Optional Location object (defaults to resolve from context manager).
4085 ip: Optional InsertionPoint (defaults to resolve from context manager or set to False to disable insertion, even with an insertion point set in the context manager).
4086 infer_type: Whether to infer result types (default = False).
4087 Returns:
4088 A new detached Operation object. Detached operations can be added to blocks, which causes them to become attached.)")
4089 .def_static(
4090 "parse",
4091 [](const std::string &sourceStr, const std::string &sourceName,
4093 -> nb::typed<nb::object, PyOpView> {
4094 return PyOperation::parse(context->getRef(), sourceStr, sourceName)
4095 ->createOpView();
4096 },
4097 "source"_a, nb::kw_only(), "source_name"_a = "",
4098 "context"_a = nb::none(),
4099 "Parses an operation. Supports both text assembly format and binary "
4100 "bytecode format.")
4102 "Gets a capsule wrapping the MlirOperation.")
4105 "Creates an Operation from a capsule wrapping MlirOperation.")
4106 .def_prop_ro(
4107 "operation",
4108 [](nb::object self) -> nb::typed<nb::object, PyOperation> {
4109 return self;
4110 },
4111 "Returns self (the operation).")
4112 .def_prop_ro(
4113 "opview",
4114 [](PyOperation &self) -> nb::typed<nb::object, PyOpView> {
4115 return self.createOpView();
4116 },
4117 R"(
4118 Returns an OpView of this operation.
4119
4120 Note:
4121 If the operation has a registered and loaded dialect then this OpView will
4122 be concrete wrapper class.)")
4123 .def_prop_ro("block", &PyOperation::getBlock,
4124 "Returns the block containing this operation.")
4125 .def_prop_ro(
4126 "successors",
4127 [](PyOperationBase &self) {
4128 return PyOpSuccessors(self.getOperation().getRef());
4129 },
4130 "Returns the list of Operation successors.")
4131 .def(
4132 "replace_uses_of_with",
4133 [](PyOperation &self, PyValue &of, PyValue &with) {
4134 mlirOperationReplaceUsesOfWith(self.get(), of.get(), with.get());
4135 },
4136 "of"_a, "with_"_a,
4137 "Replaces uses of the 'of' value with the 'with' value inside the "
4138 "operation.")
4139 .def("_set_invalid", &PyOperation::setInvalid,
4140 "Invalidate the operation.");
4141
4142 auto opViewClass =
4143 nb::class_<PyOpView, PyOperationBase>(m, "OpView")
4144 .def(nb::init<nb::typed<nb::object, PyOperation>>(), "operation"_a)
4145 .def(
4146 "__init__",
4147 [](PyOpView *self, std::string_view name,
4148 std::tuple<int, bool> opRegionSpec,
4149 nb::object operandSegmentSpecObj,
4150 nb::object resultSegmentSpecObj,
4151 std::optional<nb::sequence> resultTypeList,
4152 nb::sequence operandList,
4153 std::optional<nb::typed<nb::dict, nb::str, PyAttribute>>
4154 attributes,
4155 std::optional<std::vector<PyBlock *>> successors,
4156 std::optional<int> regions,
4157 const std::optional<PyLocation> &location,
4158 const nb::object &maybeIp) {
4159 PyLocation pyLoc = maybeGetTracebackLocation(location);
4161 name, opRegionSpec, operandSegmentSpecObj,
4162 resultSegmentSpecObj, resultTypeList, operandList,
4163 attributes, successors, regions, pyLoc, maybeIp));
4164 },
4165 "name"_a, "opRegionSpec"_a,
4166 "operandSegmentSpecObj"_a = nb::none(),
4167 "resultSegmentSpecObj"_a = nb::none(), "results"_a = nb::none(),
4168 "operands"_a = nb::none(), "attributes"_a = nb::none(),
4169 "successors"_a = nb::none(), "regions"_a = nb::none(),
4170 "loc"_a = nb::none(), "ip"_a = nb::none())
4171 .def_prop_ro(
4172 "operation",
4173 [](PyOpView &self) -> nb::typed<nb::object, PyOperation> {
4174 return self.getOperationObject();
4175 })
4176 .def_prop_ro("opview",
4177 [](nb::object self) -> nb::typed<nb::object, PyOpView> {
4178 return self;
4179 })
4180 .def(
4181 "__str__",
4182 [](PyOpView &self) { return nb::str(self.getOperationObject()); })
4183 .def_prop_ro(
4184 "successors",
4185 [](PyOperationBase &self) {
4186 return PyOpSuccessors(self.getOperation().getRef());
4187 },
4188 "Returns the list of Operation successors.")
4189 .def(
4190 "_set_invalid",
4191 [](PyOpView &self) { self.getOperation().setInvalid(); },
4192 "Invalidate the operation.");
4193 opViewClass.attr("_ODS_REGIONS") = nb::make_tuple(0, true);
4194 opViewClass.attr("_ODS_OPERAND_SEGMENTS") = nb::none();
4195 opViewClass.attr("_ODS_RESULT_SEGMENTS") = nb::none();
4196 // It is faster to pass the operation_name, ods_regions, and
4197 // ods_operand_segments/ods_result_segments as arguments to the constructor,
4198 // rather than to access them as attributes.
4199 opViewClass.attr("build_generic") = classmethod(
4200 [](nb::handle cls, std::optional<nb::sequence> resultTypeList,
4201 nb::sequence operandList,
4202 std::optional<nb::typed<nb::dict, nb::str, PyAttribute>> attributes,
4203 std::optional<std::vector<PyBlock *>> successors,
4204 std::optional<int> regions, std::optional<PyLocation> location,
4205 const nb::object &maybeIp) {
4206 std::string name = nb::cast<std::string>(cls.attr("OPERATION_NAME"));
4207 std::tuple<int, bool> opRegionSpec =
4208 nb::cast<std::tuple<int, bool>>(cls.attr("_ODS_REGIONS"));
4209 nb::object operandSegmentSpec = cls.attr("_ODS_OPERAND_SEGMENTS");
4210 nb::object resultSegmentSpec = cls.attr("_ODS_RESULT_SEGMENTS");
4211 PyLocation pyLoc = maybeGetTracebackLocation(location);
4212 return PyOpView::buildGeneric(name, opRegionSpec, operandSegmentSpec,
4213 resultSegmentSpec, resultTypeList,
4214 operandList, attributes, successors,
4215 regions, pyLoc, maybeIp);
4216 },
4217 "cls"_a, "results"_a = nb::none(), "operands"_a = nb::none(),
4218 "attributes"_a = nb::none(), "successors"_a = nb::none(),
4219 "regions"_a = nb::none(), "loc"_a = nb::none(), "ip"_a = nb::none(),
4220 // clang-format off
4221 nb::sig("def build_generic(cls, results: Sequence[Type] | None = None, operands: Sequence[Value] | None = None, attributes: dict[str, Attribute] | None = None, successors: Sequence[Block] | None = None, regions: int | None = None, loc: Location | None = None, ip: InsertionPoint | None = None) -> typing.Self"),
4222 // clang-format on
4223 "Builds a specific, generated OpView based on class level attributes.");
4224 opViewClass.attr("parse") = classmethod(
4225 [](const nb::object &cls, const std::string &sourceStr,
4226 const std::string &sourceName,
4227 DefaultingPyMlirContext context) -> nb::typed<nb::object, PyOpView> {
4228 PyOperationRef parsed =
4229 PyOperation::parse(context->getRef(), sourceStr, sourceName);
4230
4231 // Check if the expected operation was parsed, and cast to to the
4232 // appropriate `OpView` subclass if successful.
4233 // NOTE: This accesses attributes that have been automatically added to
4234 // `OpView` subclasses, and is not intended to be used on `OpView`
4235 // directly.
4236 std::string clsOpName =
4237 nb::cast<std::string>(cls.attr("OPERATION_NAME"));
4238 MlirStringRef identifier =
4240 std::string_view parsedOpName(identifier.data, identifier.length);
4241 if (clsOpName != parsedOpName)
4242 throw MLIRError(join("Expected a '", clsOpName, "' op, got: '",
4243 parsedOpName, "'"));
4244 return PyOpView::constructDerived(cls, parsed.getObject());
4245 },
4246 "cls"_a, "source"_a, nb::kw_only(), "source_name"_a = "",
4247 "context"_a = nb::none(),
4248 // clang-format off
4249 nb::sig("def parse(cls, source: str, *, source_name: str = '', context: Context | None = None) -> typing.Self"),
4250 // clang-format on
4251 "Parses a specific, generated OpView based on class level attributes.");
4252 opViewClass.attr("has_trait") = classmethod(
4253 [](nb::object &self, nb::type_object &traitCls,
4254 DefaultingPyMlirContext &context) {
4255 PyTypeID traitTypeID =
4256 nb::cast<PyTypeID>(traitCls.attr(PyDynamicOpTrait::typeIDAttr));
4257 std::string opName = nb::cast<std::string>(self.attr("OPERATION_NAME"));
4259 mlirStringRefCreate(opName.data(), opName.size()),
4260 traitTypeID.get(), context->get());
4261 },
4262 "cls"_a, "trait_cls"_a, "context"_a = nb::none(),
4263 "Checks if the operation has a given trait.");
4264
4266
4267 //----------------------------------------------------------------------------
4268 // Mapping of PyRegion.
4269 //----------------------------------------------------------------------------
4270 nb::class_<PyRegion>(m, "Region")
4271 .def_prop_ro(
4272 "blocks",
4273 [](PyRegion &self) {
4274 return PyBlockList(self.getParentOperation(), self.get());
4275 },
4276 "Returns a forward-optimized sequence of blocks.")
4277 .def_prop_ro(
4278 "owner",
4279 [](PyRegion &self) -> nb::typed<nb::object, PyOpView> {
4280 return self.getParentOperation()->createOpView();
4281 },
4282 "Returns the operation owning this region.")
4283 .def(
4284 "__iter__",
4285 [](PyRegion &self) {
4286 self.checkValid();
4287 MlirBlock firstBlock = mlirRegionGetFirstBlock(self.get());
4288 return PyBlockIterator(self.getParentOperation(), firstBlock);
4289 },
4290 "Iterates over blocks in the region.")
4291 .def(
4292 "__eq__",
4293 [](PyRegion &self, PyRegion &other) {
4294 return self.get().ptr == other.get().ptr;
4295 },
4296 "Compares two regions for pointer equality.")
4297 .def(
4298 "__eq__", [](PyRegion &self, nb::object &other) { return false; },
4299 "Compares region with non-region object (always returns False).");
4300
4301 //----------------------------------------------------------------------------
4302 // Mapping of PyBlock.
4303 //----------------------------------------------------------------------------
4304 nb::class_<PyBlock>(m, "Block")
4306 "Gets a capsule wrapping the MlirBlock.")
4307 .def_prop_ro(
4308 "owner",
4309 [](PyBlock &self) -> nb::typed<nb::object, PyOpView> {
4310 return self.getParentOperation()->createOpView();
4311 },
4312 "Returns the owning operation of this block.")
4313 .def_prop_ro(
4314 "region",
4315 [](PyBlock &self) {
4316 MlirRegion region = mlirBlockGetParentRegion(self.get());
4317 return PyRegion(self.getParentOperation(), region);
4318 },
4319 "Returns the owning region of this block.")
4320 .def_prop_ro(
4321 "arguments",
4322 [](PyBlock &self) {
4323 return PyBlockArgumentList(self.getParentOperation(), self.get());
4324 },
4325 "Returns a list of block arguments.")
4326 .def(
4327 "add_argument",
4328 [](PyBlock &self, const PyType &type, const PyLocation &loc) {
4329 return PyBlockArgument(self.getParentOperation(),
4330 mlirBlockAddArgument(self.get(), type, loc));
4331 },
4332 "type"_a, "loc"_a,
4333 R"(
4334 Appends an argument of the specified type to the block.
4335
4336 Args:
4337 type: The type of the argument to add.
4338 loc: The source location for the argument.
4339
4340 Returns:
4341 The newly added block argument.)")
4342 .def(
4343 "erase_argument",
4344 [](PyBlock &self, unsigned index) {
4345 return mlirBlockEraseArgument(self.get(), index);
4346 },
4347 "index"_a,
4348 R"(
4349 Erases the argument at the specified index.
4350
4351 Args:
4352 index: The index of the argument to erase.)")
4353 .def_prop_ro(
4354 "operations",
4355 [](PyBlock &self) {
4356 return PyOperationList(self.getParentOperation(), self.get());
4357 },
4358 "Returns a forward-optimized sequence of operations.")
4359 .def_static(
4360 "create_at_start",
4361 [](PyRegion &parent, nb::typed<nb::sequence, PyType> pyArgTypes,
4362 const std::optional<nb::typed<nb::sequence, PyLocation>>
4363 &pyArgLocs) {
4364 parent.checkValid();
4365 MlirBlock block = createBlock(pyArgTypes, pyArgLocs);
4366 mlirRegionInsertOwnedBlock(parent, 0, block);
4367 return PyBlock(parent.getParentOperation(), block);
4368 },
4369 "parent"_a, "arg_types"_a = nb::list(), "arg_locs"_a = std::nullopt,
4370 "Creates and returns a new Block at the beginning of the given "
4371 "region (with given argument types and locations).")
4372 .def(
4373 "append_to",
4374 [](PyBlock &self, PyRegion &region) {
4375 MlirBlock b = self.get();
4378 mlirRegionAppendOwnedBlock(region.get(), b);
4379 },
4380 "region"_a,
4381 R"(
4382 Appends this block to a region.
4383
4384 Transfers ownership if the block is currently owned by another region.
4385
4386 Args:
4387 region: The region to append the block to.)")
4388 .def(
4389 "create_before",
4390 [](PyBlock &self, const nb::args &pyArgTypes,
4391 const std::optional<nb::typed<nb::sequence, PyLocation>>
4392 &pyArgLocs) {
4393 self.checkValid();
4394 MlirBlock block =
4395 createBlock(nb::cast<nb::sequence>(pyArgTypes), pyArgLocs);
4396 MlirRegion region = mlirBlockGetParentRegion(self.get());
4397 mlirRegionInsertOwnedBlockBefore(region, self.get(), block);
4398 return PyBlock(self.getParentOperation(), block);
4399 },
4400 "arg_types"_a, nb::kw_only(), "arg_locs"_a = std::nullopt,
4401 "Creates and returns a new Block before this block "
4402 "(with given argument types and locations).")
4403 .def(
4404 "create_after",
4405 [](PyBlock &self, const nb::args &pyArgTypes,
4406 const std::optional<nb::typed<nb::sequence, PyLocation>>
4407 &pyArgLocs) {
4408 self.checkValid();
4409 MlirBlock block =
4410 createBlock(nb::cast<nb::sequence>(pyArgTypes), pyArgLocs);
4411 MlirRegion region = mlirBlockGetParentRegion(self.get());
4412 mlirRegionInsertOwnedBlockAfter(region, self.get(), block);
4413 return PyBlock(self.getParentOperation(), block);
4414 },
4415 "arg_types"_a, nb::kw_only(), "arg_locs"_a = std::nullopt,
4416 "Creates and returns a new Block after this block "
4417 "(with given argument types and locations).")
4418 .def(
4419 "__iter__",
4420 [](PyBlock &self) {
4421 self.checkValid();
4422 MlirOperation firstOperation =
4423 mlirBlockGetFirstOperation(self.get());
4424 return PyOperationIterator(self.getParentOperation(),
4425 firstOperation);
4426 },
4427 "Iterates over operations in the block.")
4428 .def(
4429 "__eq__",
4430 [](PyBlock &self, PyBlock &other) {
4431 return self.get().ptr == other.get().ptr;
4432 },
4433 "Compares two blocks for pointer equality.")
4434 .def(
4435 "__eq__", [](PyBlock &self, nb::object &other) { return false; },
4436 "Compares block with non-block object (always returns False).")
4437 .def(
4438 "__hash__", [](PyBlock &self) { return hash(self.get().ptr); },
4439 "Returns the hash value of the block.")
4440 .def(
4441 "__str__",
4442 [](PyBlock &self) {
4443 self.checkValid();
4444 PyPrintAccumulator printAccum;
4445 mlirBlockPrint(self.get(), printAccum.getCallback(),
4446 printAccum.getUserData());
4447 return printAccum.join();
4448 },
4449 "Returns the assembly form of the block.")
4450 .def(
4451 "append",
4452 [](PyBlock &self, PyOperationBase &operation) {
4453 if (operation.getOperation().isAttached())
4454 operation.getOperation().detachFromParent();
4455
4456 MlirOperation mlirOperation = operation.getOperation().get();
4457 mlirBlockAppendOwnedOperation(self.get(), mlirOperation);
4458 operation.getOperation().setAttached(
4459 self.getParentOperation().getObject());
4460 },
4461 "operation"_a,
4462 R"(
4463 Appends an operation to this block.
4464
4465 If the operation is currently in another block, it will be moved.
4466
4467 Args:
4468 operation: The operation to append to the block.)")
4469 .def_prop_ro(
4470 "successors",
4471 [](PyBlock &self) {
4472 return PyBlockSuccessors(self, self.getParentOperation());
4473 },
4474 "Returns the list of Block successors.")
4475 .def_prop_ro(
4476 "predecessors",
4477 [](PyBlock &self) {
4478 return PyBlockPredecessors(self, self.getParentOperation());
4479 },
4480 "Returns the list of Block predecessors.");
4481
4482 //----------------------------------------------------------------------------
4483 // Mapping of PyInsertionPoint.
4484 //----------------------------------------------------------------------------
4485
4486 nb::class_<PyInsertionPoint>(m, "InsertionPoint")
4487 .def(nb::init<PyBlock &>(), "block"_a,
4488 "Inserts after the last operation but still inside the block.")
4489 .def("__enter__", &PyInsertionPoint::contextEnter,
4490 "Enters the insertion point as a context manager.",
4491 nb::sig("def __enter__(self, /) -> InsertionPoint"))
4492 .def("__exit__", &PyInsertionPoint::contextExit, "exc_type"_a.none(),
4493 "exc_value"_a.none(), "traceback"_a.none(),
4494 "Exits the insertion point context manager.")
4495 .def_prop_ro_static(
4496 "current",
4497 [](nb::object & /*class*/) {
4499 if (!ip)
4500 throw nb::value_error("No current InsertionPoint");
4501 return ip;
4502 },
4503 nb::sig("def current(/) -> InsertionPoint"),
4504 "Gets the InsertionPoint bound to the current thread or raises "
4505 "ValueError if none has been set.")
4506 .def(nb::init<PyOperationBase &>(), "beforeOperation"_a,
4507 "Inserts before a referenced operation.")
4508 .def_static("at_block_begin", &PyInsertionPoint::atBlockBegin, "block"_a,
4509 R"(
4510 Creates an insertion point at the beginning of a block.
4511
4512 Args:
4513 block: The block at whose beginning operations should be inserted.
4514
4515 Returns:
4516 An InsertionPoint at the block's beginning.)")
4517 .def_static("at_block_terminator", &PyInsertionPoint::atBlockTerminator,
4518 "block"_a,
4519 R"(
4520 Creates an insertion point before a block's terminator.
4521
4522 Args:
4523 block: The block whose terminator to insert before.
4524
4525 Returns:
4526 An InsertionPoint before the terminator.
4527
4528 Raises:
4529 ValueError: If the block has no terminator.)")
4530 .def_static("after", &PyInsertionPoint::after, "operation"_a,
4531 R"(
4532 Creates an insertion point immediately after an operation.
4533
4534 Args:
4535 operation: The operation after which to insert.
4536
4537 Returns:
4538 An InsertionPoint after the operation.)")
4539 .def("insert", &PyInsertionPoint::insert, "operation"_a,
4540 R"(
4541 Inserts an operation at this insertion point.
4542
4543 Args:
4544 operation: The operation to insert.)")
4545 .def_prop_ro(
4546 "block", [](PyInsertionPoint &self) { return self.getBlock(); },
4547 "Returns the block that this `InsertionPoint` points to.")
4548 .def_prop_ro(
4549 "ref_operation",
4550 [](PyInsertionPoint &self)
4551 -> std::optional<nb::typed<nb::object, PyOperation>> {
4552 auto refOperation = self.getRefOperation();
4553 if (refOperation)
4554 return refOperation->getObject();
4555 return {};
4556 },
4557 "The reference operation before which new operations are "
4558 "inserted, or None if the insertion point is at the end of "
4559 "the block.");
4560
4561 //----------------------------------------------------------------------------
4562 // Mapping of PyAttribute.
4563 //----------------------------------------------------------------------------
4564 nb::class_<PyAttribute>(m, "Attribute")
4565 // Delegate to the PyAttribute copy constructor, which will also lifetime
4566 // extend the backing context which owns the MlirAttribute.
4567 .def(nb::init<PyAttribute &>(), "cast_from_type"_a,
4568 "Casts the passed attribute to the generic `Attribute`.")
4570 "Gets a capsule wrapping the MlirAttribute.")
4571 .def_static(
4573 "Creates an Attribute from a capsule wrapping `MlirAttribute`.")
4574 .def_static(
4575 "parse",
4576 [](const std::string &attrSpec, DefaultingPyMlirContext context)
4577 -> nb::typed<nb::object, PyAttribute> {
4578 PyMlirContext::ErrorCapture errors(context->getRef());
4579 MlirAttribute attr = mlirAttributeParseGet(
4580 context->get(), toMlirStringRef(attrSpec));
4581 if (mlirAttributeIsNull(attr))
4582 throw MLIRError("Unable to parse attribute", errors.take());
4583 return PyAttribute(context.get()->getRef(), attr).maybeDownCast();
4584 },
4585 "asm"_a, "context"_a = nb::none(),
4586 "Parses an attribute from an assembly form. Raises an `MLIRError` on "
4587 "failure.")
4588 .def_prop_ro(
4589 "context",
4590 [](PyAttribute &self) -> nb::typed<nb::object, PyMlirContext> {
4591 return self.getContext().getObject();
4592 },
4593 "Context that owns the `Attribute`.")
4594 .def_prop_ro(
4595 "type",
4596 [](PyAttribute &self) -> nb::typed<nb::object, PyType> {
4597 return PyType(self.getContext(), mlirAttributeGetType(self))
4598 .maybeDownCast();
4599 },
4600 "Returns the type of the `Attribute`.")
4601 .def(
4602 "get_named",
4603 [](PyAttribute &self, std::string name) {
4604 return PyNamedAttribute(self, std::move(name));
4605 },
4606 nb::keep_alive<0, 1>(),
4607 R"(
4608 Binds a name to the attribute, creating a `NamedAttribute`.
4609
4610 Args:
4611 name: The name to bind to the `Attribute`.
4612
4613 Returns:
4614 A `NamedAttribute` with the given name and this attribute.)")
4615 .def(
4616 "__eq__",
4617 [](PyAttribute &self, PyAttribute &other) { return self == other; },
4618 "Compares two attributes for equality.")
4619 .def(
4620 "__eq__", [](PyAttribute &self, nb::object &other) { return false; },
4621 "Compares attribute with non-attribute object (always returns "
4622 "False).")
4623 .def(
4624 "__hash__", [](PyAttribute &self) { return hash(self.get().ptr); },
4625 "Returns the hash value of the attribute.")
4626 .def(
4627 "dump", [](PyAttribute &self) { mlirAttributeDump(self); },
4629 .def(
4630 "__str__",
4631 [](PyAttribute &self) {
4632 PyPrintAccumulator printAccum;
4633 mlirAttributePrint(self, printAccum.getCallback(),
4634 printAccum.getUserData());
4635 return printAccum.join();
4636 },
4637 "Returns the assembly form of the Attribute.")
4638 .def(
4639 "__repr__",
4640 [](PyAttribute &self) {
4641 // Generally, assembly formats are not printed for __repr__ because
4642 // this can cause exceptionally long debug output and exceptions.
4643 // However, attribute values are generally considered useful and
4644 // are printed. This may need to be re-evaluated if debug dumps end
4645 // up being excessive.
4646 PyPrintAccumulator printAccum;
4647 printAccum.parts.append("Attribute(");
4648 mlirAttributePrint(self, printAccum.getCallback(),
4649 printAccum.getUserData());
4650 printAccum.parts.append(")");
4651 return printAccum.join();
4652 },
4653 "Returns a string representation of the attribute.")
4654 .def_prop_ro(
4655 "typeid",
4656 [](PyAttribute &self) {
4657 MlirTypeID mlirTypeID = mlirAttributeGetTypeID(self);
4658 assert(!mlirTypeIDIsNull(mlirTypeID) &&
4659 "mlirTypeID was expected to be non-null.");
4660 return PyTypeID(mlirTypeID);
4661 },
4662 "Returns the `TypeID` of the attribute.")
4663 .def(
4665 [](PyAttribute &self) -> nb::typed<nb::object, PyAttribute> {
4666 return self.maybeDownCast();
4667 },
4668 "Downcasts the attribute to a more specific attribute if possible.");
4669
4670 //----------------------------------------------------------------------------
4671 // Mapping of PyNamedAttribute
4672 //----------------------------------------------------------------------------
4673 nb::class_<PyNamedAttribute>(m, "NamedAttribute")
4674 .def(
4675 "__repr__",
4676 [](PyNamedAttribute &self) {
4677 PyPrintAccumulator printAccum;
4678 printAccum.parts.append("NamedAttribute(");
4679 printAccum.parts.append(
4680 nb::str(mlirIdentifierStr(self.namedAttr.name).data,
4681 mlirIdentifierStr(self.namedAttr.name).length));
4682 printAccum.parts.append("=");
4683 mlirAttributePrint(self.namedAttr.attribute,
4684 printAccum.getCallback(),
4685 printAccum.getUserData());
4686 printAccum.parts.append(")");
4687 return printAccum.join();
4688 },
4689 "Returns a string representation of the named attribute.")
4690 .def_prop_ro(
4691 "name",
4692 [](PyNamedAttribute &self) {
4693 return mlirIdentifierStr(self.namedAttr.name);
4694 },
4695 "The name of the `NamedAttribute` binding.")
4696 .def_prop_ro(
4697 "attr",
4698 [](PyNamedAttribute &self) { return self.namedAttr.attribute; },
4699 nb::keep_alive<0, 1>(), nb::sig("def attr(self) -> Attribute"),
4700 "The underlying generic attribute of the `NamedAttribute` binding.");
4701
4702 //----------------------------------------------------------------------------
4703 // Mapping of PyType.
4704 //----------------------------------------------------------------------------
4705 nb::class_<PyType>(m, "Type")
4706 // Delegate to the PyType copy constructor, which will also lifetime
4707 // extend the backing context which owns the MlirType.
4708 .def(nb::init<PyType &>(), "cast_from_type"_a,
4709 "Casts the passed type to the generic `Type`.")
4711 "Gets a capsule wrapping the `MlirType`.")
4713 "Creates a Type from a capsule wrapping `MlirType`.")
4714 .def_static(
4715 "parse",
4716 [](std::string typeSpec,
4717 DefaultingPyMlirContext context) -> nb::typed<nb::object, PyType> {
4718 PyMlirContext::ErrorCapture errors(context->getRef());
4719 MlirType type =
4720 mlirTypeParseGet(context->get(), toMlirStringRef(typeSpec));
4721 if (mlirTypeIsNull(type))
4722 throw MLIRError("Unable to parse type", errors.take());
4723 return PyType(context.get()->getRef(), type).maybeDownCast();
4724 },
4725 "asm"_a, "context"_a = nb::none(),
4726 R"(
4727 Parses the assembly form of a type.
4728
4729 Returns a Type object or raises an `MLIRError` if the type cannot be parsed.
4730
4731 See also: https://mlir.llvm.org/docs/LangRef/#type-system)")
4732 .def_prop_ro(
4733 "context",
4734 [](PyType &self) -> nb::typed<nb::object, PyMlirContext> {
4735 return self.getContext().getObject();
4736 },
4737 "Context that owns the `Type`.")
4738 .def(
4739 "__eq__", [](PyType &self, PyType &other) { return self == other; },
4740 "Compares two types for equality.")
4741 .def(
4742 "__eq__", [](PyType &self, nb::object &other) { return false; },
4743 "other"_a.none(),
4744 "Compares type with non-type object (always returns False).")
4745 .def(
4746 "__hash__", [](PyType &self) { return hash(self.get().ptr); },
4747 "Returns the hash value of the `Type`.")
4748 .def(
4749 "dump", [](PyType &self) { mlirTypeDump(self); }, kDumpDocstring)
4750 .def(
4751 "__str__",
4752 [](PyType &self) {
4753 PyPrintAccumulator printAccum;
4754 mlirTypePrint(self, printAccum.getCallback(),
4755 printAccum.getUserData());
4756 return printAccum.join();
4757 },
4758 "Returns the assembly form of the `Type`.")
4759 .def(
4760 "__repr__",
4761 [](PyType &self) {
4762 // Generally, assembly formats are not printed for __repr__ because
4763 // this can cause exceptionally long debug output and exceptions.
4764 // However, types are an exception as they typically have compact
4765 // assembly forms and printing them is useful.
4766 PyPrintAccumulator printAccum;
4767 printAccum.parts.append("Type(");
4768 mlirTypePrint(self, printAccum.getCallback(),
4769 printAccum.getUserData());
4770 printAccum.parts.append(")");
4771 return printAccum.join();
4772 },
4773 "Returns a string representation of the `Type`.")
4774 .def(
4776 [](PyType &self) -> nb::typed<nb::object, PyType> {
4777 return self.maybeDownCast();
4778 },
4779 "Downcasts the Type to a more specific `Type` if possible.")
4780 .def_prop_ro(
4781 "typeid",
4782 [](PyType &self) {
4783 MlirTypeID mlirTypeID = mlirTypeGetTypeID(self);
4784 if (!mlirTypeIDIsNull(mlirTypeID))
4785 return PyTypeID(mlirTypeID);
4786 auto origRepr = nb::cast<std::string>(nb::repr(nb::cast(self)));
4787 throw nb::value_error(join(origRepr, " has no typeid.").c_str());
4788 },
4789 "Returns the `TypeID` of the `Type`, or raises `ValueError` if "
4790 "`Type` has no "
4791 "`TypeID`.");
4792
4793 //----------------------------------------------------------------------------
4794 // Mapping of PyTypeID.
4795 //----------------------------------------------------------------------------
4796 nb::class_<PyTypeID>(m, "TypeID")
4798 "Gets a capsule wrapping the `MlirTypeID`.")
4800 "Creates a `TypeID` from a capsule wrapping `MlirTypeID`.")
4801 // Note, this tests whether the underlying TypeIDs are the same,
4802 // not whether the wrapper MlirTypeIDs are the same, nor whether
4803 // the Python objects are the same (i.e., PyTypeID is a value type).
4804 .def(
4805 "__eq__",
4806 [](PyTypeID &self, PyTypeID &other) { return self == other; },
4807 "Compares two `TypeID`s for equality.")
4808 .def(
4809 "__eq__",
4810 [](PyTypeID &self, const nb::object &other) { return false; },
4811 "Compares TypeID with non-TypeID object (always returns False).")
4812 // Note, this gives the hash value of the underlying TypeID, not the
4813 // hash value of the Python object, nor the hash value of the
4814 // MlirTypeID wrapper.
4815 .def(
4816 "__hash__",
4817 [](PyTypeID &self) {
4818 return static_cast<size_t>(mlirTypeIDHashValue(self));
4819 },
4820 "Returns the hash value of the `TypeID`.");
4821
4822 //----------------------------------------------------------------------------
4823 // Mapping of Value.
4824 //----------------------------------------------------------------------------
4825 m.attr("_T") = nb::type_var("_T", "bound"_a = m.attr("Type"));
4826
4827 nb::class_<PyValue>(m, "Value", nb::is_generic(),
4828 nb::sig("class Value(typing.Generic[_T])"))
4829 .def(nb::init<PyValue &>(), nb::keep_alive<0, 1>(), "value"_a,
4830 "Creates a Value reference from another `Value`.")
4832 "Gets a capsule wrapping the `MlirValue`.")
4834 "Creates a `Value` from a capsule wrapping `MlirValue`.")
4835 .def_prop_ro(
4836 "context",
4837 [](PyValue &self) -> nb::typed<nb::object, PyMlirContext> {
4838 return self.getParentOperation()->getContext().getObject();
4839 },
4840 "Context in which the value lives.")
4841 .def(
4842 "dump", [](PyValue &self) { mlirValueDump(self.get()); },
4844 .def_prop_ro(
4845 "owner",
4846 [](PyValue &self)
4847 -> nb::typed<nb::object, std::variant<PyOpView, PyBlock>> {
4848 MlirValue v = self.get();
4849 if (mlirValueIsAOpResult(v)) {
4850 assert(mlirOperationEqual(self.getParentOperation()->get(),
4851 mlirOpResultGetOwner(self.get())) &&
4852 "expected the owner of the value in Python to match "
4853 "that in "
4854 "the IR");
4855 return self.getParentOperation()->createOpView();
4856 }
4857
4859 MlirBlock block = mlirBlockArgumentGetOwner(self.get());
4860 return nb::cast(PyBlock(self.getParentOperation(), block));
4861 }
4862
4863 assert(false && "Value must be a block argument or an op result");
4864 return nb::none();
4865 },
4866 "Returns the owner of the value (`Operation` for results, `Block` "
4867 "for "
4868 "arguments).")
4869 .def_prop_ro(
4870 "uses",
4871 [](PyValue &self) {
4872 return PyOpOperandIterator(mlirValueGetFirstUse(self.get()));
4873 },
4874 "Returns an iterator over uses of this value.")
4875 .def(
4876 "__eq__",
4877 [](PyValue &self, PyValue &other) {
4878 return self.get().ptr == other.get().ptr;
4879 },
4880 "Compares two values for pointer equality.")
4881 .def(
4882 "__eq__", [](PyValue &self, nb::object other) { return false; },
4883 "Compares value with non-value object (always returns False).")
4884 .def(
4885 "__hash__", [](PyValue &self) { return hash(self.get().ptr); },
4886 "Returns the hash value of the value.")
4887 .def(
4888 "__str__",
4889 [](PyValue &self) {
4890 PyPrintAccumulator printAccum;
4891 printAccum.parts.append("Value(");
4892 mlirValuePrint(self.get(), printAccum.getCallback(),
4893 printAccum.getUserData());
4894 printAccum.parts.append(")");
4895 return printAccum.join();
4896 },
4897 R"(
4898 Returns the string form of the value.
4899
4900 If the value is a block argument, this is the assembly form of its type and the
4901 position in the argument list. If the value is an operation result, this is
4902 equivalent to printing the operation that produced it.
4903 )")
4904 .def(
4905 "get_name",
4906 [](PyValue &self, bool useLocalScope, bool useNameLocAsPrefix) {
4907 PyPrintAccumulator printAccum;
4908 MlirOpPrintingFlags flags = mlirOpPrintingFlagsCreate();
4909 if (useLocalScope)
4911 if (useNameLocAsPrefix)
4913 MlirAsmState valueState =
4914 mlirAsmStateCreateForValue(self.get(), flags);
4915 mlirValuePrintAsOperand(self.get(), valueState,
4916 printAccum.getCallback(),
4917 printAccum.getUserData());
4919 mlirAsmStateDestroy(valueState);
4920 return printAccum.join();
4921 },
4922 "use_local_scope"_a = false, "use_name_loc_as_prefix"_a = false,
4923 R"(
4924 Returns the string form of value as an operand.
4925
4926 Args:
4927 use_local_scope: Whether to use local scope for naming.
4928 use_name_loc_as_prefix: Whether to use the location attribute (NameLoc) as prefix.
4929
4930 Returns:
4931 The value's name as it appears in IR (e.g., `%0`, `%arg0`).)")
4932 .def(
4933 "get_name",
4934 [](PyValue &self, PyAsmState &state) {
4935 PyPrintAccumulator printAccum;
4936 MlirAsmState valueState = state.get();
4937 mlirValuePrintAsOperand(self.get(), valueState,
4938 printAccum.getCallback(),
4939 printAccum.getUserData());
4940 return printAccum.join();
4941 },
4942 "state"_a,
4943 "Returns the string form of value as an operand (i.e., the ValueID).")
4944 .def_prop_ro(
4945 "type",
4946 [](PyValue &self) {
4947 return PyType(self.getParentOperation()->getContext(),
4948 mlirValueGetType(self.get()))
4949 .maybeDownCast();
4950 },
4951 "Returns the type of the value.", nb::sig("def type(self) -> _T"))
4952 .def(
4953 "set_type",
4954 [](PyValue &self, const PyType &type) {
4955 mlirValueSetType(self.get(), type);
4956 },
4957 "type"_a, "Sets the type of the value.",
4958 nb::sig("def set_type(self, type: _T)"))
4959 .def(
4960 "replace_all_uses_with",
4961 [](PyValue &self, PyValue &with) {
4962 mlirValueReplaceAllUsesOfWith(self.get(), with.get());
4963 },
4964 "Replace all uses of value with the new value, updating anything in "
4965 "the IR that uses `self` to use the other value instead.")
4966 .def(
4967 "replace_all_uses_except",
4968 [](PyValue &self, PyValue &with, PyOperation &exception) {
4969 MlirOperation exceptedUser = exception.get();
4970 mlirValueReplaceAllUsesExcept(self, with, 1, &exceptedUser);
4971 },
4972 "with_"_a, "exceptions"_a, kValueReplaceAllUsesExceptDocstring)
4973 .def(
4974 "replace_all_uses_except",
4975 [](PyValue &self, PyValue &with,
4976 std::vector<PyOperation> &exceptions) {
4977 // Convert Python list to a std::vector of MlirOperations
4978 std::vector<MlirOperation> exceptionOps;
4979 for (PyOperation &exception : exceptions)
4980 exceptionOps.push_back(exception);
4982 self, with, static_cast<intptr_t>(exceptionOps.size()),
4983 exceptionOps.data());
4984 },
4985 "with_"_a, "exceptions"_a, kValueReplaceAllUsesExceptDocstring)
4986 .def(
4988 [](PyValue &self) { return self.maybeDownCast(); },
4989 "Downcasts the `Value` to a more specific kind if possible.")
4990 .def_prop_ro(
4991 "location",
4992 [](PyValue self) {
4993 return PyLocation(
4995 mlirValueGetLocation(self));
4996 },
4997 "Returns the source location of the value.");
4998
5002
5003 nb::class_<PyAsmState>(m, "AsmState")
5004 .def(nb::init<PyValue &, bool>(), "value"_a, "use_local_scope"_a = false,
5005 R"(
5006 Creates an `AsmState` for consistent SSA value naming.
5007
5008 Args:
5009 value: The value to create state for.
5010 use_local_scope: Whether to use local scope for naming.)")
5011 .def(nb::init<PyOperationBase &, bool>(), "op"_a,
5012 "use_local_scope"_a = false,
5013 R"(
5014 Creates an AsmState for consistent SSA value naming.
5015
5016 Args:
5017 op: The operation to create state for.
5018 use_local_scope: Whether to use local scope for naming.)");
5019
5020 //----------------------------------------------------------------------------
5021 // Mapping of SymbolTable.
5022 //----------------------------------------------------------------------------
5023 nb::class_<PySymbolTable>(m, "SymbolTable")
5024 .def(nb::init<PyOperationBase &>(),
5025 R"(
5026 Creates a symbol table for an operation.
5027
5028 Args:
5029 operation: The `Operation` that defines a symbol table (e.g., a `ModuleOp`).
5030
5031 Raises:
5032 TypeError: If the operation is not a symbol table.)")
5033 .def(
5034 "__getitem__",
5035 [](PySymbolTable &self,
5036 const std::string &name) -> nb::typed<nb::object, PyOpView> {
5037 return self.dunderGetItem(name);
5038 },
5039 R"(
5040 Looks up a symbol by name in the symbol table.
5041
5042 Args:
5043 name: The name of the symbol to look up.
5044
5045 Returns:
5046 The operation defining the symbol.
5047
5048 Raises:
5049 KeyError: If the symbol is not found.)")
5050 .def("insert", &PySymbolTable::insert, "operation"_a,
5051 R"(
5052 Inserts a symbol operation into the symbol table.
5053
5054 Args:
5055 operation: An operation with a symbol name to insert.
5056
5057 Returns:
5058 The symbol name attribute of the inserted operation.
5059
5060 Raises:
5061 ValueError: If the operation does not have a symbol name.)")
5062 .def("erase", &PySymbolTable::erase, "operation"_a,
5063 R"(
5064 Erases a symbol operation from the symbol table.
5065
5066 Args:
5067 operation: The symbol operation to erase.
5068
5069 Note:
5070 The operation is also erased from the IR and invalidated.)")
5071 .def("__delitem__", &PySymbolTable::dunderDel,
5072 "Deletes a symbol by name from the symbol table.")
5073 .def(
5074 "__contains__",
5075 [](PySymbolTable &table, const std::string &name) {
5076 return !mlirOperationIsNull(mlirSymbolTableLookup(
5077 table, mlirStringRefCreate(name.data(), name.length())));
5078 },
5079 "Checks if a symbol with the given name exists in the table.")
5080 // Static helpers.
5081 .def_static("set_symbol_name", &PySymbolTable::setSymbolName, "symbol"_a,
5082 "name"_a, "Sets the symbol name for a symbol operation.")
5083 .def_static("get_symbol_name", &PySymbolTable::getSymbolName, "symbol"_a,
5084 "Gets the symbol name from a symbol operation.")
5085 .def_static("get_visibility", &PySymbolTable::getVisibility, "symbol"_a,
5086 "Gets the visibility attribute of a symbol operation.")
5087 .def_static("set_visibility", &PySymbolTable::setVisibility, "symbol"_a,
5088 "visibility"_a,
5089 "Sets the visibility attribute of a symbol operation.")
5090 .def_static("replace_all_symbol_uses",
5091 &PySymbolTable::replaceAllSymbolUses, "old_symbol"_a,
5092 "new_symbol"_a, "from_op"_a,
5093 "Replaces all uses of a symbol with a new symbol name within "
5094 "the given operation.")
5095 .def_static("walk_symbol_tables", &PySymbolTable::walkSymbolTables,
5096 "from_op"_a, "all_sym_uses_visible"_a, "callback"_a,
5097 "Walks symbol tables starting from an operation with a "
5098 "callback function.");
5099
5100 // Container bindings.
5115
5116 // Debug bindings.
5118
5119 // Attribute builder getter.
5121
5122 // Extensible Dialect
5126
5127 // MLIRError exception.
5128 MLIRError::bind(m);
5129}
5130} // namespace MLIR_BINDINGS_PYTHON_DOMAIN
5131} // namespace python
5132} // namespace mlir
return success()
void mlirSetGlobalDebugTypes(const char **types, intptr_t n)
Definition Debug.cpp:28
MLIR_CAPI_EXPORTED void mlirSetGlobalDebugType(const char *type)
Sets the current debug type, similarly to -debug-only=type in the command-line tools.
Definition Debug.cpp:20
MLIR_CAPI_EXPORTED bool mlirIsGlobalDebugEnabled()
Retuns true if the global debugging flag is set, false otherwise.
Definition Debug.cpp:18
MLIR_CAPI_EXPORTED void mlirEnableGlobalDebug(bool enable)
Sets the global debugging flag.
Definition Debug.cpp:16
static const char kDumpDocstring[]
Definition IRAffine.cpp:32
static const char kModuleParseDocstring[]
Definition IRCore.cpp:33
static size_t hash(const T &value)
Local helper to compute std::hash for a value.
Definition IRCore.cpp:56
static nb::object createCustomDialectWrapper(const std::string &dialectNamespace, nb::object dialectDescriptor)
Definition IRCore.cpp:61
std::string join(const Ts &...args)
Helper function to concatenate arguments into a std::string.
static const char kValueReplaceAllUsesExceptDocstring[]
Definition IRCore.cpp:44
MlirContext mlirModuleGetContext(MlirModule module)
Definition IR.cpp:445
size_t mlirModuleHashValue(MlirModule mod)
Definition IR.cpp:471
intptr_t mlirBlockGetNumPredecessors(MlirBlock block)
Definition IR.cpp:1105
MlirIdentifier mlirOperationGetName(MlirOperation op)
Definition IR.cpp:674
bool mlirValueIsABlockArgument(MlirValue value)
Definition IR.cpp:1125
intptr_t mlirOperationGetNumRegions(MlirOperation op)
Definition IR.cpp:686
MlirBlock mlirOperationGetBlock(MlirOperation op)
Definition IR.cpp:678
void mlirBlockArgumentSetType(MlirValue value, MlirType type)
Definition IR.cpp:1142
void mlirOperationStateAddAttributes(MlirOperationState *state, intptr_t n, MlirNamedAttribute const *attributes)
Definition IR.cpp:520
MlirValue mlirOperationGetResult(MlirOperation op, intptr_t pos)
Definition IR.cpp:741
MlirModule mlirModuleCreateParseFromFile(MlirContext context, MlirStringRef fileName)
Definition IR.cpp:436
bool mlirOperationNameHasTrait(MlirStringRef opName, MlirTypeID traitTypeID, MlirContext context)
Definition IR.cpp:654
MlirAsmState mlirAsmStateCreateForValue(MlirValue value, MlirOpPrintingFlags flags)
Definition IR.cpp:177
intptr_t mlirOperationGetNumResults(MlirOperation op)
Definition IR.cpp:737
void mlirOperationDestroy(MlirOperation op)
Definition IR.cpp:638
MlirContext mlirAttributeGetContext(MlirAttribute attribute)
Definition IR.cpp:1290
MlirType mlirValueGetType(MlirValue value)
Definition IR.cpp:1161
void mlirBlockPrint(MlirBlock block, MlirStringCallback callback, void *userData)
Definition IR.cpp:1091
MlirOpPrintingFlags mlirOpPrintingFlagsCreate()
Definition IR.cpp:201
bool mlirModuleEqual(MlirModule lhs, MlirModule rhs)
Definition IR.cpp:467
void mlirOpPrintingFlagsElideLargeElementsAttrs(MlirOpPrintingFlags flags, intptr_t largeElementLimit)
Definition IR.cpp:209
void mlirOperationSetSuccessor(MlirOperation op, intptr_t pos, MlirBlock block)
Definition IR.cpp:802
MlirOperation mlirOperationGetNextInBlock(MlirOperation op)
Definition IR.cpp:710
void mlirOpPrintingFlagsEnableDebugInfo(MlirOpPrintingFlags flags, bool enable, bool prettyForm)
Definition IR.cpp:219
MlirOperation mlirModuleGetOperation(MlirModule module)
Definition IR.cpp:459
void mlirOpPrintingFlagsElideLargeResourceString(MlirOpPrintingFlags flags, intptr_t largeResourceLimit)
Definition IR.cpp:214
void mlirOpPrintingFlagsUseLocalScope(MlirOpPrintingFlags flags)
Definition IR.cpp:232
intptr_t mlirBlockArgumentGetArgNumber(MlirValue value)
Definition IR.cpp:1137
MlirBlock mlirOperationGetSuccessor(MlirOperation op, intptr_t pos)
Definition IR.cpp:749
bool mlirAttributeEqual(MlirAttribute a1, MlirAttribute a2)
Definition IR.cpp:1309
MlirAsmState mlirAsmStateCreateForOperation(MlirOperation op, MlirOpPrintingFlags flags)
Definition IR.cpp:156
bool mlirOperationEqual(MlirOperation op, MlirOperation other)
Definition IR.cpp:642
void mlirOpPrintingFlagsAssumeVerified(MlirOpPrintingFlags flags)
Definition IR.cpp:236
void mlirBytecodeWriterConfigDestroy(MlirBytecodeWriterConfig config)
Definition IR.cpp:251
MlirBlock mlirBlockGetSuccessor(MlirBlock block, intptr_t pos)
Definition IR.cpp:1101
void mlirModuleDestroy(MlirModule module)
Definition IR.cpp:453
MlirModule mlirModuleCreateEmpty(MlirLocation location)
Definition IR.cpp:424
void mlirOpPrintingFlagsPrintGenericOpForm(MlirOpPrintingFlags flags)
Definition IR.cpp:224
MlirOperation mlirOperationGetParentOperation(MlirOperation op)
Definition IR.cpp:682
void mlirValueSetType(MlirValue value, MlirType type)
Definition IR.cpp:1165
intptr_t mlirOperationGetNumSuccessors(MlirOperation op)
Definition IR.cpp:745
MlirDialect mlirAttributeGetDialect(MlirAttribute attr)
Definition IR.cpp:1305
void mlirLocationPrint(MlirLocation location, MlirStringCallback callback, void *userData)
Definition IR.cpp:414
void mlirOperationSetAttributeByName(MlirOperation op, MlirStringRef name, MlirAttribute attr)
Definition IR.cpp:821
void mlirOperationSetOperand(MlirOperation op, intptr_t pos, MlirValue newValue)
Definition IR.cpp:726
MlirOperation mlirOpResultGetOwner(MlirValue value)
Definition IR.cpp:1152
MlirModule mlirModuleCreateParse(MlirContext context, MlirStringRef module)
Definition IR.cpp:428
size_t mlirOperationHashValue(MlirOperation op)
Definition IR.cpp:646
void mlirOperationStateAddResults(MlirOperationState *state, intptr_t n, MlirType const *results)
Definition IR.cpp:503
MlirOperation mlirOperationClone(MlirOperation op)
Definition IR.cpp:634
MlirBlock mlirBlockArgumentGetOwner(MlirValue value)
Definition IR.cpp:1133
void mlirBlockArgumentSetLocation(MlirValue value, MlirLocation loc)
Definition IR.cpp:1147
MlirValue mlirOperationGetOperand(MlirOperation op, intptr_t pos)
Definition IR.cpp:718
MlirOpOperand mlirOperationGetOpOperand(MlirOperation op, intptr_t pos)
Definition IR.cpp:722
MlirLocation mlirOperationGetLocation(MlirOperation op)
Definition IR.cpp:660
MlirAttribute mlirOperationGetAttributeByName(MlirOperation op, MlirStringRef name)
Definition IR.cpp:816
MlirTypeID mlirAttributeGetTypeID(MlirAttribute attr)
Definition IR.cpp:1301
void mlirOperationStateAddOwnedRegions(MlirOperationState *state, intptr_t n, MlirRegion const *regions)
Definition IR.cpp:512
void mlirOperationSetLocation(MlirOperation op, MlirLocation loc)
Definition IR.cpp:664
MlirType mlirAttributeGetType(MlirAttribute attribute)
Definition IR.cpp:1294
bool mlirOperationRemoveAttributeByName(MlirOperation op, MlirStringRef name)
Definition IR.cpp:826
bool mlirValueIsAOpResult(MlirValue value)
Definition IR.cpp:1129
MlirBlock mlirBlockGetPredecessor(MlirBlock block, intptr_t pos)
Definition IR.cpp:1110
MlirRegion mlirOperationGetRegion(MlirOperation op, intptr_t pos)
Definition IR.cpp:690
MlirOperation mlirOperationCreate(MlirOperationState *state)
Definition IR.cpp:588
void mlirBytecodeWriterConfigDesiredEmitVersion(MlirBytecodeWriterConfig flags, int64_t version)
Definition IR.cpp:255
MlirAttribute mlirAttributeParseGet(MlirContext context, MlirStringRef attr)
Definition IR.cpp:1286
void mlirOperationRemoveFromParent(MlirOperation op)
Definition IR.cpp:640
intptr_t mlirBlockGetNumSuccessors(MlirBlock block)
Definition IR.cpp:1097
MlirNamedAttribute mlirOperationGetAttribute(MlirOperation op, intptr_t pos)
Definition IR.cpp:811
void mlirOpPrintingFlagsDestroy(MlirOpPrintingFlags flags)
Definition IR.cpp:205
void mlirValueDump(MlirValue value)
Definition IR.cpp:1169
void mlirTypePrint(MlirType type, MlirStringCallback callback, void *userData)
Definition IR.cpp:1275
MlirBlock mlirModuleGetBody(MlirModule module)
Definition IR.cpp:449
MlirOperation mlirOperationCreateParse(MlirContext context, MlirStringRef sourceStr, MlirStringRef sourceName)
Definition IR.cpp:625
void mlirAsmStateDestroy(MlirAsmState state)
Destroys printing flags created with mlirAsmStateCreate.
Definition IR.cpp:195
MlirContext mlirOperationGetContext(MlirOperation op)
Definition IR.cpp:650
intptr_t mlirOpResultGetResultNumber(MlirValue value)
Definition IR.cpp:1156
void mlirOperationStateAddSuccessors(MlirOperationState *state, intptr_t n, MlirBlock const *successors)
Definition IR.cpp:516
MlirBytecodeWriterConfig mlirBytecodeWriterConfigCreate()
Definition IR.cpp:247
void mlirOpPrintingFlagsPrintNameLocAsPrefix(MlirOpPrintingFlags flags)
Definition IR.cpp:228
void mlirOpPrintingFlagsSkipRegions(MlirOpPrintingFlags flags)
Definition IR.cpp:240
void mlirOperationStateAddOperands(MlirOperationState *state, intptr_t n, MlirValue const *operands)
Definition IR.cpp:508
MlirOperationState mlirOperationStateGet(MlirStringRef name, MlirLocation loc)
Definition IR.cpp:479
intptr_t mlirOperationGetNumOperands(MlirOperation op)
Definition IR.cpp:714
void mlirTypeDump(MlirType type)
Definition IR.cpp:1280
intptr_t mlirOperationGetNumAttributes(MlirOperation op)
Definition IR.cpp:807
static PyObject * mlirPythonTypeIDToCapsule(MlirTypeID typeID)
Creates a capsule object encapsulating the raw C-API MlirTypeID.
Definition Interop.h:348
static PyObject * mlirPythonContextToCapsule(MlirContext context)
Creates a capsule object encapsulating the raw C-API MlirContext.
Definition Interop.h:216
#define MLIR_PYTHON_MAYBE_DOWNCAST_ATTR
Attribute on MLIR Python objects that expose a function for downcasting the corresponding Python obje...
Definition Interop.h:118
static MlirOperation mlirPythonCapsuleToOperation(PyObject *capsule)
Extracts an MlirOperations from a capsule as produced from mlirPythonOperationToCapsule.
Definition Interop.h:338
#define MLIR_PYTHON_CAPI_PTR_ATTR
Attribute on MLIR Python objects that expose their C-API pointer.
Definition Interop.h:97
static MlirAttribute mlirPythonCapsuleToAttribute(PyObject *capsule)
Extracts an MlirAttribute from a capsule as produced from mlirPythonAttributeToCapsule.
Definition Interop.h:189
static PyObject * mlirPythonTypeToCapsule(MlirType type)
Creates a capsule object encapsulating the raw C-API MlirType.
Definition Interop.h:367
static PyObject * mlirPythonOperationToCapsule(MlirOperation operation)
Creates a capsule object encapsulating the raw C-API MlirOperation.
Definition Interop.h:330
static PyObject * mlirPythonAttributeToCapsule(MlirAttribute attribute)
Creates a capsule object encapsulating the raw C-API MlirAttribute.
Definition Interop.h:180
#define MLIR_PYTHON_CAPI_FACTORY_ATTR
Attribute on MLIR Python objects that exposes a factory function for constructing the corresponding P...
Definition Interop.h:110
static MlirModule mlirPythonCapsuleToModule(PyObject *capsule)
Extracts an MlirModule from a capsule as produced from mlirPythonModuleToCapsule.
Definition Interop.h:282
static MlirContext mlirPythonCapsuleToContext(PyObject *capsule)
Extracts a MlirContext from a capsule as produced from mlirPythonContextToCapsule.
Definition Interop.h:224
static MlirTypeID mlirPythonCapsuleToTypeID(PyObject *capsule)
Extracts an MlirTypeID from a capsule as produced from mlirPythonTypeIDToCapsule.
Definition Interop.h:357
#define MLIR_PYTHON_CAPI_VALUE_CASTER_REGISTER_ATTR
Attribute on main C extension module (_mlir) that corresponds to the value caster registration bindin...
Definition Interop.h:142
static PyObject * mlirPythonBlockToCapsule(MlirBlock block)
Creates a capsule object encapsulating the raw C-API MlirBlock.
Definition Interop.h:198
static PyObject * mlirPythonLocationToCapsule(MlirLocation loc)
Creates a capsule object encapsulating the raw C-API MlirLocation.
Definition Interop.h:255
static MlirDialectRegistry mlirPythonCapsuleToDialectRegistry(PyObject *capsule)
Extracts an MlirDialectRegistry from a capsule as produced from mlirPythonDialectRegistryToCapsule.
Definition Interop.h:245
static MlirType mlirPythonCapsuleToType(PyObject *capsule)
Extracts an MlirType from a capsule as produced from mlirPythonTypeToCapsule.
Definition Interop.h:376
static MlirValue mlirPythonCapsuleToValue(PyObject *capsule)
Extracts an MlirValue from a capsule as produced from mlirPythonValueToCapsule.
Definition Interop.h:454
static PyObject * mlirPythonValueToCapsule(MlirValue value)
Creates a capsule object encapsulating the raw C-API MlirValue.
Definition Interop.h:445
static PyObject * mlirPythonModuleToCapsule(MlirModule module)
Creates a capsule object encapsulating the raw C-API MlirModule.
Definition Interop.h:273
static MlirLocation mlirPythonCapsuleToLocation(PyObject *capsule)
Extracts an MlirLocation from a capsule as produced from mlirPythonLocationToCapsule.
Definition Interop.h:264
#define MLIR_PYTHON_CAPI_TYPE_CASTER_REGISTER_ATTR
Attribute on main C extension module (_mlir) that corresponds to the type caster registration binding...
Definition Interop.h:130
static PyObject * mlirPythonDialectRegistryToCapsule(MlirDialectRegistry registry)
Creates a capsule object encapsulating the raw C-API MlirDialectRegistry.
Definition Interop.h:235
b
Return true if permutation is a valid permutation of the outer_dims_perm (case OuterOrInnerPerm::Oute...
static std::string diag(const llvm::Value &value)
Accumulates into a file, either writing text (default) or binary.
A CRTP base class for pseudo-containers willing to support Python-type slicing access on top of index...
Sliceable(intptr_t startIndex, intptr_t length, intptr_t step)
ReferrentTy * get() const
PyMlirContextRef & getContext()
Accesses the context reference.
Definition IRCore.h:310
Used in function arguments when None should resolve to the current context manager set instance.
Definition IRCore.h:291
PyAsmState(MlirValue value, bool useLocalScope)
Definition IRCore.cpp:1750
Wrapper around the generic MlirAttribute.
Definition IRCore.h:1014
PyAttribute(PyMlirContextRef contextRef, MlirAttribute attr)
Definition IRCore.h:1016
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirAttribute.
Definition IRCore.cpp:1860
bool operator==(const PyAttribute &other) const
Definition IRCore.cpp:1856
static PyAttribute createFromCapsule(const nanobind::object &capsule)
Creates a PyAttribute from the MlirAttribute wrapped by a capsule.
Definition IRCore.cpp:1864
nanobind::typed< nanobind::object, PyAttribute > maybeDownCast()
Definition IRCore.cpp:1872
PyBlockArgumentList(PyOperationRef operation, MlirBlock block, intptr_t startIndex=0, intptr_t length=-1, intptr_t step=1)
Definition IRCore.cpp:2189
Python wrapper for MlirBlockArgument.
Definition IRCore.h:1629
nanobind::typed< nanobind::object, PyBlock > dunderNext()
Definition IRCore.cpp:217
Blocks are exposed by the C-API as a forward-only linked list.
Definition IRCore.h:1424
PyBlock appendBlock(const nanobind::args &pyArgTypes, const std::optional< nanobind::sequence > &pyArgLocs)
Definition IRCore.cpp:273
PyBlockPredecessors(PyBlock block, PyOperationRef operation, intptr_t startIndex=0, intptr_t length=-1, intptr_t step=1)
Definition IRCore.cpp:2349
PyBlockSuccessors(PyBlock block, PyOperationRef operation, intptr_t startIndex=0, intptr_t length=-1, intptr_t step=1)
Definition IRCore.cpp:2326
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirBlock.
Definition IRCore.cpp:186
Represents a diagnostic handler attached to the context.
Definition IRCore.h:418
void detach()
Detaches the handler. Does nothing if not attached.
Definition IRCore.cpp:728
PyDiagnosticHandler(MlirContext context, nanobind::object callback)
Definition IRCore.cpp:722
void contextExit(const nanobind::object &excType, const nanobind::object &excVal, const nanobind::object &excTb)
Definition IRCore.h:430
Python class mirroring the C MlirDiagnostic struct.
Definition IRCore.h:368
nanobind::typed< nanobind::tuple, PyDiagnostic > getNotes()
Definition IRCore.cpp:767
Wrapper around an MlirDialectRegistry.
Definition IRCore.h:510
static PyDialectRegistry createFromCapsule(nanobind::object capsule)
Definition IRCore.cpp:812
User-level object for accessing dialects with dotted syntax such as: ctx.dialect.std.
Definition IRCore.h:486
MlirDialect getDialectForKey(const std::string &key, bool attrError)
Definition IRCore.cpp:795
static bool attach(const nanobind::object &opName, const nanobind::object &target, PyMlirContext &context)
Definition IRCore.cpp:2554
static bool attach(const nanobind::object &opName, PyMlirContext &context)
Definition IRCore.cpp:2606
static bool attach(const nanobind::object &opName, PyMlirContext &context)
Definition IRCore.cpp:2625
CurrentLocAction
Policy for composing Location.current with the computed location.
Definition Globals.h:141
OnExplicitAction
Policy for handling explicit loc= when loc_tracebacks() is active.
Definition Globals.h:133
Globals that are always accessible once the extension has been initialized.
Definition Globals.h:29
void registerOpAdaptorImpl(const std::string &operationName, nanobind::object pyClass, bool replace=false)
Adds an operation adaptor class.
Definition Globals.cpp:167
std::optional< nanobind::callable > lookupValueCaster(MlirTypeID mlirTypeID, MlirDialect dialect)
Returns the custom value caster for MlirTypeID mlirTypeID.
Definition Globals.cpp:203
bool loadDialectModule(std::string_view dialectNamespace)
Loads a python module corresponding to the given dialect namespace.
Definition Globals.cpp:64
void registerDialectImpl(const std::string &dialectNamespace, nanobind::object pyClass, bool replace=false)
Adds a concrete implementation dialect class.
Definition Globals.cpp:145
static PyGlobals & get()
Most code should get the globals via this static accessor.
Definition Globals.cpp:59
std::optional< nanobind::object > lookupOperationClass(std::string_view operationName)
Looks up a registered operation class (deriving from OpView) by operation name.
Definition Globals.cpp:233
void registerTypeCaster(MlirTypeID mlirTypeID, nanobind::callable typeCaster, bool replace=false)
Adds a user-friendly type caster.
Definition Globals.cpp:125
void registerOperationImpl(const std::string &operationName, nanobind::object pyClass, bool replace=false)
Adds a concrete implementation operation class.
Definition Globals.cpp:156
void setDialectSearchPrefixes(std::vector< std::string > newValues)
Definition Globals.h:43
std::optional< nanobind::callable > lookupTypeCaster(MlirTypeID mlirTypeID, MlirDialect dialect)
Returns the custom type caster for MlirTypeID mlirTypeID.
Definition Globals.cpp:189
void registerValueCaster(MlirTypeID mlirTypeID, nanobind::callable valueCaster, bool replace=false)
Adds a user-friendly value caster.
Definition Globals.cpp:135
std::optional< nanobind::callable > lookupAttributeBuilder(const std::string &attributeKind)
Returns the custom Attribute builder for Attribute kind.
Definition Globals.cpp:179
std::optional< nanobind::object > lookupDialectClass(const std::string &dialectNamespace)
Looks up a registered dialect class by namespace.
Definition Globals.cpp:218
std::vector< std::string > getDialectSearchPrefixes()
Get and set the list of parent modules to search for dialect implementation classes.
Definition Globals.h:39
void registerAttributeBuilder(const std::string &attributeKind, nanobind::callable pyFunc, bool replace=false, bool allow_existing=false)
Adds a user-friendly Attribute builder.
Definition Globals.cpp:99
An insertion point maintains a pointer to a Block and a reference operation.
Definition IRCore.h:845
void insert(PyOperationBase &operationBase)
Inserts an operation.
Definition IRCore.cpp:1781
void contextExit(const nanobind::object &excType, const nanobind::object &excVal, const nanobind::object &excTb)
Definition IRCore.cpp:1846
static PyInsertionPoint atBlockTerminator(PyBlock &block)
Shortcut to create an insertion point before the block terminator.
Definition IRCore.cpp:1820
static PyInsertionPoint after(PyOperationBase &op)
Shortcut to create an insertion point to the node after the specified operation.
Definition IRCore.cpp:1829
static PyInsertionPoint atBlockBegin(PyBlock &block)
Shortcut to create an insertion point at the beginning of the block.
Definition IRCore.cpp:1807
PyInsertionPoint(const PyBlock &block)
Creates an insertion point positioned after the last operation in the block, but still inside the blo...
Definition IRCore.cpp:1772
static nanobind::object contextEnter(nanobind::object insertionPoint)
Enter and exit the context manager.
Definition IRCore.cpp:1842
static nanobind::object contextEnter(nanobind::object location)
Enter and exit the context manager.
Definition IRCore.cpp:836
static PyLocation createFromCapsule(nanobind::object capsule)
Creates a PyLocation from the MlirLocation wrapped by a capsule.
Definition IRCore.cpp:828
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirLocation.
Definition IRCore.cpp:824
void contextExit(const nanobind::object &excType, const nanobind::object &excVal, const nanobind::object &excTb)
Definition IRCore.cpp:840
PyLocation(PyMlirContextRef contextRef, MlirLocation loc)
Definition IRCore.h:319
static PyMlirContextRef forContext(MlirContext context)
Returns a context reference for the singleton PyMlirContext wrapper for the given context.
Definition IRCore.cpp:461
static size_t getLiveCount()
Gets the count of live context objects. Used for testing.
Definition IRCore.cpp:486
static nanobind::object createFromCapsule(nanobind::object capsule)
Creates a PyMlirContext from the MlirContext wrapped by a capsule.
Definition IRCore.cpp:454
nanobind::object attachDiagnosticHandler(nanobind::object callback)
Attaches a Python callback as a diagnostic handler, returning a registration object (internally a PyD...
Definition IRCore.cpp:501
void contextExit(const nanobind::object &excType, const nanobind::object &excVal, const nanobind::object &excTb)
Definition IRCore.cpp:495
MlirContext get()
Accesses the underlying MlirContext.
Definition IRCore.h:224
PyMlirContextRef getRef()
Gets a strong reference to this context, which will ensure it is kept alive for the life of the refer...
Definition IRCore.cpp:446
void setEmitErrorDiagnostics(bool value)
Controls whether error diagnostics should be propagated to diagnostic handlers, instead of being capt...
Definition IRCore.h:258
static nanobind::object contextEnter(nanobind::object context)
Enter and exit the context manager.
Definition IRCore.cpp:491
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirContext.
Definition IRCore.cpp:450
size_t getLiveModuleCount()
Gets the count of live modules associated with this context.
Definition IRCore.cpp:1840
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirModule.
Definition IRCore.cpp:905
MlirModule get()
Gets the backing MlirModule.
Definition IRCore.h:560
static PyModuleRef forModule(MlirModule module)
Returns a PyModule reference for the given MlirModule.
Definition IRCore.cpp:873
static nanobind::object createFromCapsule(nanobind::object capsule)
Creates a PyModule from the MlirModule wrapped by a capsule.
Definition IRCore.cpp:898
Represents a Python MlirNamedAttr, carrying an optional owned name.
Definition IRCore.h:1040
PyNamedAttribute(MlirAttribute attr, std::string ownedName)
Constructs a PyNamedAttr that retains an owned name.
Definition IRCore.cpp:1890
Template for a reference to a concrete type which captures a python reference to its underlying pytho...
Definition IRCore.h:66
nanobind::object releaseObject()
Releases the object held by this instance, returning it.
Definition IRCore.h:104
void dunderSetItem(const std::string &name, const PyAttribute &attr)
Definition IRCore.cpp:2409
nanobind::typed< nanobind::object, PyAttribute > dunderGetItemNamed(const std::string &name)
Definition IRCore.cpp:2376
nanobind::typed< nanobind::object, std::optional< PyAttribute > > get(const std::string &key, nanobind::object defaultValue)
Definition IRCore.cpp:2386
static void forEachAttr(MlirOperation op, std::function< void(MlirStringRef, MlirAttribute)> fn)
Definition IRCore.cpp:2431
PyNamedAttribute dunderGetItemIndexed(intptr_t index)
Definition IRCore.cpp:2394
nanobind::typed< nanobind::object, PyOpOperand > dunderNext()
Definition IRCore.cpp:382
PyOpOperandList(PyOperationRef operation, intptr_t startIndex=0, intptr_t length=-1, intptr_t step=1)
Definition IRCore.cpp:2221
void dunderSetItem(intptr_t index, PyValue value)
Definition IRCore.cpp:2229
nanobind::typed< nanobind::object, PyOpView > getOwner() const
Definition IRCore.cpp:363
PyOpOperands(PyOperationRef operation, intptr_t startIndex=0, intptr_t length=-1, intptr_t step=1)
Definition IRCore.cpp:2264
Sliceable< PyOpOperandList, PyOpOperand > SliceableT
Definition IRCore.cpp:2262
PyOpResultList(PyOperationRef operation, intptr_t startIndex=0, intptr_t length=-1, intptr_t step=1)
Definition IRCore.cpp:1400
PyOpSuccessors(PyOperationRef operation, intptr_t startIndex=0, intptr_t length=-1, intptr_t step=1)
Definition IRCore.cpp:2293
void dunderSetItem(intptr_t index, PyBlock block)
Definition IRCore.cpp:2301
A PyOpView is equivalent to the C++ "Op" wrappers: these are the basis for providing more instance-sp...
Definition IRCore.h:747
PyOpView(const nanobind::object &operationObject)
Definition IRCore.cpp:1740
static nanobind::typed< nanobind::object, PyOperation > buildGeneric(std::string_view name, std::tuple< int, bool > opRegionSpec, nanobind::object operandSegmentSpecObj, nanobind::object resultSegmentSpecObj, std::optional< nanobind::sequence > resultTypeList, nanobind::sequence operandList, std::optional< nanobind::dict > attributes, std::optional< std::vector< PyBlock * > > successors, std::optional< int > regions, PyLocation &location, const nanobind::object &maybeIp)
Definition IRCore.cpp:1563
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.
Definition IRCore.cpp:1732
Base class for PyOperation and PyOpView which exposes the primary, user visible methods for manipulat...
Definition IRCore.h:590
bool isBeforeInBlock(PyOperationBase &other)
Given an operation 'other' that is within the same parent block, return whether the current operation...
Definition IRCore.cpp:1164
nanobind::object getAsm(bool binary, std::optional< int64_t > largeElementsLimit, std::optional< int64_t > largeResourceLimit, bool enableDebugInfo, bool prettyDebugInfo, bool printGenericOpForm, bool useLocalScope, bool useNameLocAsPrefix, bool assumeVerified, bool skipRegions)
Definition IRCore.cpp:1118
void print(std::optional< int64_t > largeElementsLimit, std::optional< int64_t > largeResourceLimit, 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.
Definition IRCore.cpp:1017
void writeBytecode(const nanobind::object &fileObject, std::optional< int64_t > bytecodeVersion)
Definition IRCore.cpp:1065
virtual PyOperation & getOperation()=0
Each must provide access to the raw Operation.
void moveAfter(PyOperationBase &other)
Moves the operation before or after the other operation.
Definition IRCore.cpp:1146
void walk(std::function< PyWalkResult(MlirOperation)> callback, PyWalkOrder walkOrder)
Definition IRCore.cpp:1086
nanobind::typed< nanobind::object, PyOpView > dunderNext()
Definition IRCore.cpp:294
Operations are exposed by the C-API as a forward-only linked list.
Definition IRCore.h:1465
nanobind::typed< nanobind::object, PyOpView > dunderGetItem(intptr_t index)
Definition IRCore.cpp:333
static nanobind::object create(std::string_view name, std::optional< std::vector< PyType * > > results, const MlirValue *operands, size_t numOperands, std::optional< nanobind::dict > attributes, std::optional< std::vector< PyBlock * > > successors, int regions, PyLocation &location, const nanobind::object &ip, bool inferType)
Creates an operation. See corresponding python docstring.
Definition IRCore.cpp:1228
void setInvalid()
Invalidate the operation.
Definition IRCore.h:714
PyOperation & getOperation() override
Each must provide access to the raw Operation.
Definition IRCore.h:647
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.
Definition IRCore.cpp:974
nanobind::object clone(const nanobind::object &ip)
Clones this operation.
Definition IRCore.cpp:1343
static nanobind::object createFromCapsule(const nanobind::object &capsule)
Creates a PyOperation from the MlirOperation wrapped by a capsule.
Definition IRCore.cpp:1204
std::optional< PyOperationRef > getParentOperation()
Gets the parent operation or raises an exception if the operation has no parent.
Definition IRCore.cpp:1180
nanobind::object createOpView()
Creates an OpView suitable for this operation.
Definition IRCore.cpp:1352
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirOperation.
Definition IRCore.cpp:1199
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.
Definition IRCore.cpp:958
void detachFromParent()
Detaches the operation from its parent block and updates its state accordingly.
Definition IRCore.cpp:986
void erase()
Erases the underlying MlirOperation, removes its pointer from the parent context's live operations ma...
Definition IRCore.cpp:1363
PyBlock getBlock()
Gets the owning block or raises an exception if the operation has no owning block.
Definition IRCore.cpp:1190
static PyOperationRef createDetached(PyMlirContextRef contextRef, MlirOperation operation, nanobind::object parentKeepAlive=nanobind::object())
Creates a detached operation.
Definition IRCore.cpp:965
PyOperation(PyMlirContextRef contextRef, MlirOperation operation)
Definition IRCore.cpp:913
void setAttached(const nanobind::object &parent=nanobind::object())
Definition IRCore.cpp:1001
Regions of an op are fixed length and indexed numerically so are represented with a sequence-like con...
Definition IRCore.h:1385
PyRegionList(PyOperationRef operation, intptr_t startIndex=0, intptr_t length=-1, intptr_t step=1)
Definition IRCore.cpp:194
PyStringAttribute insert(PyOperationBase &symbol)
Inserts the given operation into the symbol table.
Definition IRCore.cpp:2042
PySymbolTable(PyOperationBase &operation)
Constructs a symbol table for the given operation.
Definition IRCore.cpp:2006
static PyStringAttribute getVisibility(PyOperationBase &symbol)
Gets and sets the visibility of a symbol op.
Definition IRCore.cpp:2082
void erase(PyOperationBase &symbol)
Removes the given operation from the symbol table and erases it.
Definition IRCore.cpp:2027
static void walkSymbolTables(PyOperationBase &from, bool allSymUsesVisible, nanobind::object callback)
Walks all symbol tables under and including 'from'.
Definition IRCore.cpp:2123
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.
Definition IRCore.cpp:2014
static void replaceAllSymbolUses(const std::string &oldSymbol, const std::string &newSymbol, PyOperationBase &from)
Replaces all symbol uses within an operation.
Definition IRCore.cpp:2111
static PyStringAttribute getSymbolName(PyOperationBase &symbol)
Gets and sets the name of a symbol op.
Definition IRCore.cpp:2054
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 ...
Definition IRCore.cpp:2037
static void setSymbolName(PyOperationBase &symbol, const std::string &name)
Definition IRCore.cpp:2067
static void setVisibility(PyOperationBase &symbol, const std::string &visibility)
Definition IRCore.cpp:2093
Tracks an entry in the thread context stack.
Definition IRCore.h:137
static PyInsertionPoint * getDefaultInsertionPoint()
Gets the top of stack insertion point and return nullptr if not defined.
Definition IRCore.cpp:638
static nanobind::object pushInsertionPoint(nanobind::object insertionPoint)
Definition IRCore.cpp:666
static void popInsertionPoint(PyInsertionPoint &insertionPoint)
Definition IRCore.cpp:678
static PyLocation * getDefaultLocation()
Gets the top of stack location and returns nullptr if not defined.
Definition IRCore.cpp:643
static PyThreadContextEntry * getTopOfStack()
Stack management.
Definition IRCore.cpp:586
static nanobind::object pushLocation(nanobind::object location)
Definition IRCore.cpp:689
static nanobind::object pushContext(nanobind::object context)
Definition IRCore.cpp:648
static PyMlirContext * getDefaultContext()
Gets the top of stack context and return nullptr if not defined.
Definition IRCore.cpp:633
static std::vector< PyThreadContextEntry > & getStack()
Gets the thread local stack.
Definition IRCore.cpp:581
Wrapper around MlirLlvmThreadPool Python object owns the C++ thread pool.
Definition IRCore.h:193
A TypeID provides an efficient and unique identifier for a specific C++ type.
Definition IRCore.h:913
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirTypeID.
Definition IRCore.cpp:1936
bool operator==(const PyTypeID &other) const
Definition IRCore.cpp:1946
static PyTypeID createFromCapsule(nanobind::object capsule)
Creates a PyTypeID from the MlirTypeID wrapped by a capsule.
Definition IRCore.cpp:1940
Wrapper around the generic MlirType.
Definition IRCore.h:887
PyType(PyMlirContextRef contextRef, MlirType type)
Definition IRCore.h:889
bool operator==(const PyType &other) const
Definition IRCore.cpp:1902
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirType.
Definition IRCore.cpp:1906
static PyType createFromCapsule(nanobind::object capsule)
Creates a PyType from the MlirType wrapped by a capsule.
Definition IRCore.cpp:1910
nanobind::typed< nanobind::object, PyType > maybeDownCast()
Definition IRCore.cpp:1918
nanobind::object getCapsule()
Gets a capsule wrapping the void* within the MlirValue.
Definition IRCore.cpp:1954
PyValue(PyOperationRef parentOperation, MlirValue value)
Definition IRCore.h:1181
nanobind::typed< nanobind::object, std::variant< PyBlockArgument, PyOpResult, PyValue > > maybeDownCast()
Definition IRCore.cpp:1973
static PyValue createFromCapsule(nanobind::object capsule)
Creates a PyValue from the MlirValue wrapped by a capsule.
Definition IRCore.cpp:1994
MLIR_CAPI_EXPORTED intptr_t mlirDiagnosticGetNumNotes(MlirDiagnostic diagnostic)
Returns the number of notes attached to the diagnostic.
MLIR_CAPI_EXPORTED MlirDiagnosticSeverity mlirDiagnosticGetSeverity(MlirDiagnostic diagnostic)
Returns the severity of the diagnostic.
MLIR_CAPI_EXPORTED void mlirDiagnosticPrint(MlirDiagnostic diagnostic, MlirStringCallback callback, void *userData)
Prints a diagnostic using the provided callback.
MLIR_CAPI_EXPORTED MlirDiagnostic mlirDiagnosticGetNote(MlirDiagnostic diagnostic, intptr_t pos)
Returns pos-th note attached to the diagnostic.
MLIR_CAPI_EXPORTED void mlirEmitError(MlirLocation location, const char *message)
Emits an error at the given location through the diagnostics engine.
MLIR_CAPI_EXPORTED MlirDiagnosticHandlerID mlirContextAttachDiagnosticHandler(MlirContext context, MlirDiagnosticHandler handler, void *userData, void(*deleteUserData)(void *))
Attaches the diagnostic handler to the context.
struct MlirDiagnostic MlirDiagnostic
Definition Diagnostics.h:29
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.
Definition Diagnostics.h:41
MLIR_CAPI_EXPORTED MlirLocation mlirDiagnosticGetLocation(MlirDiagnostic diagnostic)
Returns the location at which the diagnostic is reported.
MLIR_CAPI_EXPORTED MlirAttribute mlirDenseI32ArrayGet(MlirContext ctx, intptr_t size, int32_t const *values)
MLIR_CAPI_EXPORTED MlirAttribute mlirStringAttrGet(MlirContext ctx, MlirStringRef str)
Creates a string attribute in the given context containing the given string.
MLIR_CAPI_EXPORTED MlirDynamicOpTrait mlirDynamicOpTraitIsTerminatorCreate(void)
Get the dynamic op trait that indicates the operation is a terminator.
MLIR_CAPI_EXPORTED MlirTypeID mlirDynamicOpTraitIsTerminatorGetTypeID(void)
Get the type ID of the dynamic op trait that indicates the operation is a terminator.
MLIR_CAPI_EXPORTED MlirDynamicOpTrait mlirDynamicOpTraitCreate(MlirTypeID typeID, MlirDynamicOpTraitCallbacks callbacks, void *userData)
Create a custom dynamic op trait with the given type ID and callbacks.
MLIR_CAPI_EXPORTED bool mlirDynamicOpTraitAttach(MlirDynamicOpTrait dynamicOpTrait, MlirStringRef opName, MlirContext context)
Attach a dynamic op trait to the given operation name.
MLIR_CAPI_EXPORTED MlirTypeID mlirDynamicOpTraitNoTerminatorGetTypeID(void)
Get the type ID of the dynamic op trait that indicates regions have no terminator.
MLIR_CAPI_EXPORTED MlirDynamicOpTrait mlirDynamicOpTraitNoTerminatorCreate(void)
Get the dynamic op trait that indicates regions have no terminator.
MLIR_CAPI_EXPORTED MlirAttribute mlirLocationGetAttribute(MlirLocation location)
Returns the underlying location attribute of this location.
Definition IR.cpp:264
MlirWalkResult(* MlirOperationWalkCallback)(MlirOperation, void *userData)
Operation walker type.
Definition IR.h:860
MLIR_CAPI_EXPORTED MlirLocation mlirValueGetLocation(MlirValue v)
Gets the location of the value.
Definition IR.cpp:1212
MLIR_CAPI_EXPORTED unsigned mlirContextGetNumThreads(MlirContext context)
Gets the number of threads of the thread pool of the context when multithreading is enabled.
Definition IR.cpp:116
MLIR_CAPI_EXPORTED void mlirOperationWriteBytecode(MlirOperation op, MlirStringCallback callback, void *userData)
Same as mlirOperationPrint but writing the bytecode format.
Definition IR.cpp:851
MLIR_CAPI_EXPORTED MlirLocation mlirLocationFileLineColGet(MlirContext context, MlirStringRef filename, unsigned line, unsigned col)
Creates an File/Line/Column location owned by the given context.
Definition IR.cpp:272
MLIR_CAPI_EXPORTED void mlirSymbolTableWalkSymbolTables(MlirOperation from, bool allSymUsesVisible, void(*callback)(MlirOperation, bool, void *userData), void *userData)
Walks all symbol table operations nested within, and including, op.
Definition IR.cpp:1394
MLIR_CAPI_EXPORTED MlirStringRef mlirDialectGetNamespace(MlirDialect dialect)
Returns the namespace of the given dialect.
Definition IR.cpp:136
MLIR_CAPI_EXPORTED int mlirLocationFileLineColRangeGetEndColumn(MlirLocation location)
Getter for end_column of FileLineColRange.
Definition IR.cpp:310
MLIR_CAPI_EXPORTED MlirAttribute mlirSymbolTableInsert(MlirSymbolTable symbolTable, MlirOperation operation)
Inserts the given operation into the given symbol table.
Definition IR.cpp:1373
MlirWalkOrder
Traversal order for operation walk.
Definition IR.h:853
MLIR_CAPI_EXPORTED MlirNamedAttribute mlirNamedAttributeGet(MlirIdentifier name, MlirAttribute attr)
Associates an attribute with the name. Takes ownership of neither.
Definition IR.cpp:1321
MLIR_CAPI_EXPORTED MlirLocation mlirLocationNameGetChildLoc(MlirLocation location)
Getter for childLoc of Name.
Definition IR.cpp:391
MLIR_CAPI_EXPORTED void mlirSymbolTableErase(MlirSymbolTable symbolTable, MlirOperation operation)
Removes the given operation from the symbol table and erases it.
Definition IR.cpp:1378
MLIR_CAPI_EXPORTED void mlirContextAppendDialectRegistry(MlirContext ctx, MlirDialectRegistry registry)
Append the contents of the given dialect registry to the registry associated with the context.
Definition IR.cpp:83
MLIR_CAPI_EXPORTED MlirStringRef mlirIdentifierStr(MlirIdentifier ident)
Gets the string value of the identifier.
Definition IR.cpp:1342
MLIR_CAPI_EXPORTED MlirType mlirTypeParseGet(MlirContext context, MlirStringRef type)
Parses a type. The type is owned by the context.
Definition IR.cpp:1255
MLIR_CAPI_EXPORTED MlirOpOperand mlirOpOperandGetNextUse(MlirOpOperand opOperand)
Returns an op operand representing the next use of the value, or a null op operand if there is no nex...
Definition IR.cpp:1238
MLIR_CAPI_EXPORTED void mlirContextSetAllowUnregisteredDialects(MlirContext context, bool allow)
Sets whether unregistered dialects are allowed in this context.
Definition IR.cpp:72
MLIR_CAPI_EXPORTED void mlirRegionInsertOwnedBlockBefore(MlirRegion region, MlirBlock reference, MlirBlock block)
Takes a block owned by the caller and inserts it before the (non-owned) reference block in the given ...
Definition IR.cpp:961
MLIR_CAPI_EXPORTED bool mlirLocationIsAFileLineColRange(MlirLocation location)
Checks whether the given location is an FileLineColRange.
Definition IR.cpp:320
MLIR_CAPI_EXPORTED unsigned mlirLocationFusedGetNumLocations(MlirLocation location)
Getter for number of locations fused together.
Definition IR.cpp:354
MLIR_CAPI_EXPORTED void mlirValueReplaceAllUsesOfWith(MlirValue of, MlirValue with)
Replace all uses of 'of' value with the 'with' value, updating anything in the IR that uses 'of' to u...
Definition IR.cpp:1194
MLIR_CAPI_EXPORTED void mlirValuePrintAsOperand(MlirValue value, MlirAsmState state, MlirStringCallback callback, void *userData)
Prints a value as an operand (i.e., the ValueID).
Definition IR.cpp:1177
MLIR_CAPI_EXPORTED MlirLocation mlirLocationUnknownGet(MlirContext context)
Creates a location with unknown position owned by the given context.
Definition IR.cpp:402
MLIR_CAPI_EXPORTED MlirOperation mlirOpOperandGetOwner(MlirOpOperand opOperand)
Returns the owner operation of an op operand.
Definition IR.cpp:1226
MLIR_CAPI_EXPORTED MlirIdentifier mlirLocationFileLineColRangeGetFilename(MlirLocation location)
Getter for filename of FileLineColRange.
Definition IR.cpp:288
MLIR_CAPI_EXPORTED void mlirLocationFusedGetLocations(MlirLocation location, MlirLocation *locationsCPtr)
Getter for locations of Fused.
Definition IR.cpp:360
MLIR_CAPI_EXPORTED void mlirAttributePrint(MlirAttribute attr, MlirStringCallback callback, void *userData)
Prints a location by sending chunks of the string representation and forwarding userData to callback`...
Definition IR.cpp:1313
MLIR_CAPI_EXPORTED MlirRegion mlirBlockGetParentRegion(MlirBlock block)
Returns the region that contains this block.
Definition IR.cpp:1000
MLIR_CAPI_EXPORTED void mlirOperationMoveBefore(MlirOperation op, MlirOperation other)
Moves the given operation immediately before the other operation in its parent block.
Definition IR.cpp:875
MLIR_CAPI_EXPORTED void mlirValueReplaceAllUsesExcept(MlirValue of, MlirValue with, intptr_t numExceptions, MlirOperation *exceptions)
Replace all uses of 'of' value with 'with' value, updating anything in the IR that uses 'of' to use '...
Definition IR.cpp:1198
MLIR_CAPI_EXPORTED void mlirOperationPrintWithState(MlirOperation op, MlirAsmState state, MlirStringCallback callback, void *userData)
Same as mlirOperationPrint but accepts AsmState controlling the printing behavior as well as caching ...
Definition IR.cpp:842
MlirWalkResult
Operation walk result.
Definition IR.h:846
MLIR_CAPI_EXPORTED void mlirRegionInsertOwnedBlock(MlirRegion region, intptr_t pos, MlirBlock block)
Takes a block owned by the caller and inserts it at pos to the given region.
Definition IR.cpp:941
static bool mlirTypeIsNull(MlirType type)
Checks whether a type is null.
Definition IR.h:1165
MLIR_CAPI_EXPORTED bool mlirContextIsRegisteredOperation(MlirContext context, MlirStringRef name)
Returns whether the given fully-qualified operation (i.e.
Definition IR.cpp:99
MLIR_CAPI_EXPORTED intptr_t mlirBlockGetNumArguments(MlirBlock block)
Returns the number of arguments of the block.
Definition IR.cpp:1069
MLIR_CAPI_EXPORTED int mlirLocationFileLineColRangeGetStartLine(MlirLocation location)
Getter for start_line of FileLineColRange.
Definition IR.cpp:292
MLIR_CAPI_EXPORTED MlirLocation mlirLocationFusedGet(MlirContext ctx, intptr_t nLocations, MlirLocation const *locations, MlirAttribute metadata)
Creates a fused location with an array of locations and metadata.
Definition IR.cpp:346
MLIR_CAPI_EXPORTED void mlirBlockInsertOwnedOperationBefore(MlirBlock block, MlirOperation reference, MlirOperation operation)
Takes an operation owned by the caller and inserts it before the (non-owned) reference operation in t...
Definition IR.cpp:1050
static bool mlirContextIsNull(MlirContext context)
Checks whether a context is null.
Definition IR.h:104
MLIR_CAPI_EXPORTED MlirDialect mlirContextGetOrLoadDialect(MlirContext context, MlirStringRef name)
Gets the dialect instance owned by the given context using the dialect namespace to identify it,...
Definition IR.cpp:94
MLIR_CAPI_EXPORTED bool mlirLocationIsACallSite(MlirLocation location)
Checks whether the given location is an CallSite.
Definition IR.cpp:342
MLIR_CAPI_EXPORTED void mlirRegionInsertOwnedBlockAfter(MlirRegion region, MlirBlock reference, MlirBlock block)
Takes a block owned by the caller and inserts it after the (non-owned) reference block in the given r...
Definition IR.cpp:947
MLIR_CAPI_EXPORTED MlirBlock mlirBlockCreate(intptr_t nArgs, MlirType const *args, MlirLocation const *locs)
Creates a new empty block with the given argument types and transfers ownership to the caller.
Definition IR.cpp:984
static bool mlirBlockIsNull(MlirBlock block)
Checks whether a block is null.
Definition IR.h:946
MLIR_CAPI_EXPORTED void mlirBlockAppendOwnedOperation(MlirBlock block, MlirOperation operation)
Takes an operation owned by the caller and appends it to the block.
Definition IR.cpp:1025
MLIR_CAPI_EXPORTED MlirValue mlirBlockGetArgument(MlirBlock block, intptr_t pos)
Returns pos-th argument of the block.
Definition IR.cpp:1087
MLIR_CAPI_EXPORTED MlirOperation mlirSymbolTableLookup(MlirSymbolTable symbolTable, MlirStringRef name)
Looks up a symbol with the given name in the given symbol table and returns the operation that corres...
Definition IR.cpp:1368
MLIR_CAPI_EXPORTED MlirContext mlirTypeGetContext(MlirType type)
Gets the context that a type was created with.
Definition IR.cpp:1259
MLIR_CAPI_EXPORTED MlirLocation mlirLocationFileLineColRangeGet(MlirContext context, MlirStringRef filename, unsigned start_line, unsigned start_col, unsigned end_line, unsigned end_col)
Creates an File/Line/Column range location owned by the given context.
Definition IR.cpp:280
MLIR_CAPI_EXPORTED bool mlirOpOperandIsNull(MlirOpOperand opOperand)
Returns whether the op operand is null.
Definition IR.cpp:1224
MLIR_CAPI_EXPORTED MlirSymbolTable mlirSymbolTableCreate(MlirOperation operation)
Creates a symbol table for the given operation.
Definition IR.cpp:1358
MLIR_CAPI_EXPORTED bool mlirLocationEqual(MlirLocation l1, MlirLocation l2)
Checks if two locations are equal.
Definition IR.cpp:406
MLIR_CAPI_EXPORTED int mlirLocationFileLineColRangeGetStartColumn(MlirLocation location)
Getter for start_column of FileLineColRange.
Definition IR.cpp:298
MLIR_CAPI_EXPORTED bool mlirLocationIsAFused(MlirLocation location)
Checks whether the given location is an Fused.
Definition IR.cpp:374
static bool mlirLocationIsNull(MlirLocation location)
Checks if the location is null.
Definition IR.h:370
MLIR_CAPI_EXPORTED MlirValue mlirBlockAddArgument(MlirBlock block, MlirType type, MlirLocation loc)
Appends an argument of the specified type to the block.
Definition IR.cpp:1073
MLIR_CAPI_EXPORTED void mlirOperationPrintWithFlags(MlirOperation op, MlirOpPrintingFlags flags, MlirStringCallback callback, void *userData)
Same as mlirOperationPrint but accepts flags controlling the printing behavior.
Definition IR.cpp:836
MLIR_CAPI_EXPORTED MlirOpOperand mlirValueGetFirstUse(MlirValue value)
Returns an op operand representing the first use of the value, or a null op operand if there are no u...
Definition IR.cpp:1184
MLIR_CAPI_EXPORTED void mlirContextSetThreadPool(MlirContext context, MlirLlvmThreadPool threadPool)
Sets the thread pool of the context explicitly, enabling multithreading in the process.
Definition IR.cpp:111
MLIR_CAPI_EXPORTED bool mlirOperationVerify(MlirOperation op)
Verify the operation and return true if it passes, false if it fails.
Definition IR.cpp:867
MLIR_CAPI_EXPORTED bool mlirTypeEqual(MlirType t1, MlirType t2)
Checks if two types are equal.
Definition IR.cpp:1271
MLIR_CAPI_EXPORTED unsigned mlirOpOperandGetOperandNumber(MlirOpOperand opOperand)
Returns the operand number of an op operand.
Definition IR.cpp:1234
MLIR_CAPI_EXPORTED MlirLocation mlirLocationCallSiteGetCaller(MlirLocation location)
Getter for caller of CallSite.
Definition IR.cpp:333
MLIR_CAPI_EXPORTED MlirOperation mlirBlockGetTerminator(MlirBlock block)
Returns the terminator operation in the block or null if no terminator.
Definition IR.cpp:1015
MLIR_CAPI_EXPORTED MlirIdentifier mlirLocationNameGetName(MlirLocation location)
Getter for name of Name.
Definition IR.cpp:387
MLIR_CAPI_EXPORTED bool mlirOperationIsBeforeInBlock(MlirOperation op, MlirOperation other)
Given an operation 'other' that is within the same parent block, return whether the current operation...
Definition IR.cpp:879
MLIR_CAPI_EXPORTED MlirLocation mlirLocationFromAttribute(MlirAttribute attribute)
Creates a location from a location attribute.
Definition IR.cpp:268
MLIR_CAPI_EXPORTED MlirTypeID mlirTypeGetTypeID(MlirType type)
Gets the type ID of the type.
Definition IR.cpp:1263
MLIR_CAPI_EXPORTED MlirStringRef mlirSymbolTableGetVisibilityAttributeName(void)
Returns the name of the attribute used to store symbol visibility.
Definition IR.cpp:1354
static bool mlirDialectIsNull(MlirDialect dialect)
Checks if the dialect is null.
Definition IR.h:182
MLIR_CAPI_EXPORTED MlirBlock mlirBlockGetNextInRegion(MlirBlock block)
Returns the block immediately following the given block in its parent region.
Definition IR.cpp:1004
MLIR_CAPI_EXPORTED MlirLocation mlirLocationCallSiteGet(MlirLocation callee, MlirLocation caller)
Creates a call site location with a callee and a caller.
Definition IR.cpp:324
MLIR_CAPI_EXPORTED bool mlirLocationIsAName(MlirLocation location)
Checks whether the given location is an Name.
Definition IR.cpp:398
static bool mlirDialectRegistryIsNull(MlirDialectRegistry registry)
Checks if the dialect registry is null.
Definition IR.h:244
MLIR_CAPI_EXPORTED void mlirOperationWalk(MlirOperation op, MlirOperationWalkCallback callback, void *userData, MlirWalkOrder walkOrder)
Walks operation op in walkOrder and calls callback on that operation.
Definition IR.cpp:897
MLIR_CAPI_EXPORTED MlirContext mlirContextCreateWithThreading(bool threadingEnabled)
Creates an MLIR context with an explicit setting of the multithreading setting and transfers its owne...
Definition IR.cpp:54
MLIR_CAPI_EXPORTED MlirOperation mlirBlockGetParentOperation(MlirBlock)
Returns the closest surrounding operation that contains this block.
Definition IR.cpp:996
MLIR_CAPI_EXPORTED MlirContext mlirLocationGetContext(MlirLocation location)
Gets the context that a location was created with.
Definition IR.cpp:410
MLIR_CAPI_EXPORTED void mlirBlockEraseArgument(MlirBlock block, unsigned index)
Erase the argument at 'index' and remove it from the argument list.
Definition IR.cpp:1078
MLIR_CAPI_EXPORTED void mlirAttributeDump(MlirAttribute attr)
Prints the attribute to the standard error stream.
Definition IR.cpp:1319
MLIR_CAPI_EXPORTED MlirLogicalResult mlirSymbolTableReplaceAllSymbolUses(MlirStringRef oldSymbol, MlirStringRef newSymbol, MlirOperation from)
Attempt to replace all uses that are nested within the given operation of the given symbol 'oldSymbol...
Definition IR.cpp:1383
MLIR_CAPI_EXPORTED void mlirRegionAppendOwnedBlock(MlirRegion region, MlirBlock block)
Takes a block owned by the caller and appends it to the given region.
Definition IR.cpp:937
MLIR_CAPI_EXPORTED MlirOperation mlirBlockGetFirstOperation(MlirBlock block)
Returns the first operation in the block.
Definition IR.cpp:1008
static bool mlirRegionIsNull(MlirRegion region)
Checks whether a region is null.
Definition IR.h:885
MLIR_CAPI_EXPORTED MlirDialect mlirTypeGetDialect(MlirType type)
Gets the dialect a type belongs to.
Definition IR.cpp:1267
MLIR_CAPI_EXPORTED MlirIdentifier mlirIdentifierGet(MlirContext context, MlirStringRef str)
Gets an identifier with the given string value.
Definition IR.cpp:1330
MLIR_CAPI_EXPORTED void mlirContextLoadAllAvailableDialects(MlirContext context)
Eagerly loads all available dialects registered with a context, making them available for use for IR ...
Definition IR.cpp:107
MLIR_CAPI_EXPORTED MlirLlvmThreadPool mlirContextGetThreadPool(MlirContext context)
Gets the thread pool of the context when enabled multithreading, otherwise an assertion is raised.
Definition IR.cpp:120
MLIR_CAPI_EXPORTED int mlirLocationFileLineColRangeGetEndLine(MlirLocation location)
Getter for end_line of FileLineColRange.
Definition IR.cpp:304
MLIR_CAPI_EXPORTED MlirLocation mlirLocationNameGet(MlirContext context, MlirStringRef name, MlirLocation childLoc)
Creates a name location owned by the given context.
Definition IR.cpp:378
MLIR_CAPI_EXPORTED void mlirContextEnableMultithreading(MlirContext context, bool enable)
Set threading mode (must be set to false to mlir-print-ir-after-all).
Definition IR.cpp:103
MLIR_CAPI_EXPORTED MlirLocation mlirLocationCallSiteGetCallee(MlirLocation location)
Getter for callee of CallSite.
Definition IR.cpp:328
MLIR_CAPI_EXPORTED MlirContext mlirValueGetContext(MlirValue v)
Gets the context that a value was created with.
Definition IR.cpp:1216
MLIR_CAPI_EXPORTED MlirStringRef mlirSymbolTableGetSymbolAttributeName(void)
Returns the name of the attribute used to store symbol names compatible with symbol tables.
Definition IR.cpp:1350
MLIR_CAPI_EXPORTED MlirRegion mlirRegionCreate(void)
Creates a new empty region and transfers ownership to the caller.
Definition IR.cpp:924
MLIR_CAPI_EXPORTED void mlirBlockDetach(MlirBlock block)
Detach a block from the owning region and assume ownership.
Definition IR.cpp:1064
MLIR_CAPI_EXPORTED void mlirOperationDump(MlirOperation op)
Prints an operation to stderr.
Definition IR.cpp:865
static bool mlirSymbolTableIsNull(MlirSymbolTable symbolTable)
Returns true if the symbol table is null.
Definition IR.h:1255
MLIR_CAPI_EXPORTED bool mlirContextGetAllowUnregisteredDialects(MlirContext context)
Returns whether the context allows unregistered dialects.
Definition IR.cpp:76
MLIR_CAPI_EXPORTED void mlirOperationReplaceUsesOfWith(MlirOperation op, MlirValue of, MlirValue with)
Replace uses of 'of' value with the 'with' value inside the 'op' operation.
Definition IR.cpp:915
MLIR_CAPI_EXPORTED void mlirOperationMoveAfter(MlirOperation op, MlirOperation other)
Moves the given operation immediately after the other operation in its parent block.
Definition IR.cpp:871
MLIR_CAPI_EXPORTED void mlirValuePrint(MlirValue value, MlirStringCallback callback, void *userData)
Prints a block by sending chunks of the string representation and forwarding userData to callback`.
Definition IR.cpp:1171
MLIR_CAPI_EXPORTED MlirLogicalResult mlirOperationWriteBytecodeWithConfig(MlirOperation op, MlirBytecodeWriterConfig config, MlirStringCallback callback, void *userData)
Same as mlirOperationWriteBytecode but with writer config and returns failure only if desired bytecod...
Definition IR.cpp:858
MLIR_CAPI_EXPORTED void mlirContextDestroy(MlirContext context)
Takes an MLIR context owned by the caller and destroys it.
Definition IR.cpp:70
MLIR_CAPI_EXPORTED MlirBlock mlirRegionGetFirstBlock(MlirRegion region)
Gets the first block in the region.
Definition IR.cpp:930
static MlirStringRef mlirStringRefCreate(const char *str, size_t length)
Constructs a string reference from the pointer and length.
Definition Support.h:87
static MlirLogicalResult mlirLogicalResultFailure(void)
Creates a logical result representing a failure.
Definition Support.h:143
struct MlirLogicalResult MlirLogicalResult
Definition Support.h:124
MLIR_CAPI_EXPORTED int mlirLlvmThreadPoolGetMaxConcurrency(MlirLlvmThreadPool pool)
Returns the maximum number of threads in the thread pool.
Definition Support.cpp:38
MLIR_CAPI_EXPORTED void mlirLlvmThreadPoolDestroy(MlirLlvmThreadPool pool)
Destroy an LLVM thread pool.
Definition Support.cpp:34
MLIR_CAPI_EXPORTED MlirLlvmThreadPool mlirLlvmThreadPoolCreate(void)
Create an LLVM thread pool.
Definition Support.cpp:30
MLIR_CAPI_EXPORTED size_t mlirTypeIDHashValue(MlirTypeID typeID)
Returns the hash value of the type id.
Definition Support.cpp:93
static MlirLogicalResult mlirLogicalResultSuccess(void)
Creates a logical result representing a success.
Definition Support.h:137
struct MlirStringRef MlirStringRef
Definition Support.h:82
static bool mlirLogicalResultIsFailure(MlirLogicalResult res)
Checks if the given logical result represents a failure.
Definition Support.h:132
static bool mlirTypeIDIsNull(MlirTypeID typeID)
Checks whether a type id is null.
Definition Support.h:201
MLIR_CAPI_EXPORTED bool mlirTypeIDEqual(MlirTypeID typeID1, MlirTypeID typeID2)
Checks if two type ids are equal.
Definition Support.cpp:89
void walk(Operation *op, function_ref< void(Region *)> callback, WalkOrder order)
Walk all of the regions, blocks, or operations nested under (and including) the given operation.
Definition Visitors.h:102
MLIR_PYTHON_API_EXPORTED MlirValue getUniqueResult(MlirOperation operation)
Definition IRCore.cpp:1529
static std::string formatMLIRError(const MLIRError &e)
Definition IRCore.cpp:2810
MLIR_PYTHON_API_EXPORTED void populateRoot(nanobind::module_ &m)
static void maybeInsertOperation(PyOperationRef &op, const nb::object &maybeIp)
Definition IRCore.cpp:1213
static void populateResultTypes(std::string_view name, nb::sequence resultTypeList, const nb::object &resultSegmentSpecObj, std::vector< int32_t > &resultSegmentLengths, std::vector< PyType * > &resultTypes)
Definition IRCore.cpp:1442
PyObjectRef< PyMlirContext > PyMlirContextRef
Wrapper around MlirContext.
Definition IRCore.h:210
static MlirValue getOpResultOrValue(nb::handle operand)
Definition IRCore.cpp:1544
PyObjectRef< PyOperation > PyOperationRef
Definition IRCore.h:642
MlirStringRef toMlirStringRef(const std::string &s)
Definition IRCore.h:1348
static bool attachOpTrait(const nb::object &opName, MlirDynamicOpTrait trait, PyMlirContext &context)
Definition IRCore.cpp:2539
PyObjectRef< PyModule > PyModuleRef
Definition IRCore.h:549
static MlirLogicalResult verifyTraitByMethod(MlirOperation op, void *userData, const char *methodName)
Definition IRCore.cpp:2528
static PyOperationRef getValueOwnerRef(MlirValue value)
Definition IRCore.cpp:1958
MlirBlock MLIR_PYTHON_API_EXPORTED createBlock(const nanobind::typed< nanobind::sequence, PyType > &pyArgTypes, const std::optional< nanobind::typed< nanobind::sequence, PyLocation > > &pyArgLocs)
Create a block, using the current location context if no locations are specified.
static std::vector< nb::typed< nb::object, PyType > > getValueTypes(Container &container, PyMlirContextRef &context)
Returns the list of types of the values held by container.
Definition IRCore.cpp:1389
PyWalkOrder
Traversal order for operation walk.
Definition IRCore.h:359
MLIR_PYTHON_API_EXPORTED void populateIRCore(nanobind::module_ &m)
nanobind::object classmethod(Func f, Args... args)
Helper for creating an @classmethod.
Definition IRCore.h:1873
Action
The actions performed by @newSparseTensor.
Definition Enums.h:146
Include the generated interface declarations.
auto get(MLIRContext *context, Ts &&...params)
Helper method that injects context only if needed, this helps unify some of the attribute constructio...
std::string join(const Ts &...args)
Helper function to concatenate arguments into a std::string.
An opaque reference to a diagnostic, always owned by the diagnostics engine (context).
Definition Diagnostics.h:26
MlirLogicalResult(* verifyTrait)(MlirOperation op, void *userData)
The callback function to verify the operation.
void(* construct)(void *userData)
Optional constructor for the user data.
void(* destruct)(void *userData)
Optional destructor for the user data.
MlirLogicalResult(* verifyRegionTrait)(MlirOperation op, void *userData)
The callback function to verify the operation with access to regions.
A logical result value, essentially a boolean with named states.
Definition Support.h:121
Named MLIR attribute.
Definition IR.h:76
MlirAttribute attribute
Definition IR.h:78
MlirIdentifier name
Definition IR.h:77
A pointer to a sized fragment of a string, not necessarily null-terminated.
Definition Support.h:78
const char * data
Pointer to the first symbol.
Definition Support.h:79
size_t length
Length of the fragment.
Definition Support.h:80
Accumulates into a python string from a method that accepts an MlirStringCallback.
MlirStringCallback getCallback()
Custom exception that allows access to error diagnostic information.
Definition IRCore.h:1330
MLIRError(std::string message, std::vector< PyDiagnostic::DiagnosticInfo > &&errorDiagnostics={})
Definition IRCore.h:1331
std::vector< PyDiagnostic::DiagnosticInfo > errorDiagnostics
Definition IRCore.h:1341
static void bind(nanobind::module_ &m)
Bind the MLIRError exception class to the given module.
Definition IRCore.cpp:2845
static bool dunderContains(const std::string &attributeKind)
Definition IRCore.cpp:146
static nanobind::callable dunderGetItemNamed(const std::string &attributeKind)
Definition IRCore.cpp:151
static void dunderSetItemNamed(const std::string &attributeKind, nanobind::callable func, bool replace, bool allow_existing)
Definition IRCore.cpp:158
static void set(nanobind::object &o, bool enable)
Definition IRCore.cpp:108
RAII object that captures any error diagnostics emitted to the provided context.
Definition IRCore.h:446
std::vector< PyDiagnostic::DiagnosticInfo > take()
Definition IRCore.h:456