#include "Globals.h"
#include "IRModule.h"
#include "NanobindUtils.h"
#include "mlir-c/Bindings/Python/Interop.h"
#include "mlir-c/BuiltinAttributes.h"
#include "mlir-c/Debug.h"
#include "mlir-c/Diagnostics.h"
#include "mlir-c/IR.h"
#include "mlir-c/Support.h"
#include "mlir/Bindings/Python/Nanobind.h"
#include "mlir/Bindings/Python/NanobindAdaptors.h"
#include "nanobind/nanobind.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/SmallVector.h"
#include <optional>

Classes
struct	PyGlobalDebugFlag
	Wrapper for the global LLVM debugging flag. More...

struct	PyAttrBuilderMap

class	PyOpResult
	Python wrapper for MlirOpResult. More...

class	PyOpResultList
	A list of operation results. More...

Macros
#define	_Py_CAST(type, expr) ((type)(expr))

#define	_Py_NULL NULL

#define	Py_XNewRef(obj) _Py_XNewRef(_PyObject_CAST(obj))

#define	Py_NewRef(obj) _Py_NewRef(_PyObject_CAST(obj))

Functions
template<class Func , typename... Args>
static nb::object	classmethod (Func f, Args... args)
	Helper for creating an @classmethod. More...

static nb::object	createCustomDialectWrapper (const std::string &dialectNamespace, nb::object dialectDescriptor)

static MlirStringRef	toMlirStringRef (const std::string &s)

static MlirStringRef	toMlirStringRef (std::string_view s)

static MlirStringRef	toMlirStringRef (const nb::bytes &s)

static MlirBlock	createBlock (const nb::sequence &pyArgTypes, const std::optional< nb::sequence > &pyArgLocs)
	Create a block, using the current location context if no locations are specified. More...

static void	maybeInsertOperation (PyOperationRef &op, const nb::object &maybeIp)

template<typename Container >
static std::vector< nb::object >	getValueTypes (Container &container, PyMlirContextRef &context)
	Returns the list of types of the values held by container. More...

static void	populateResultTypes (StringRef name, nb::list resultTypeList, const nb::object &resultSegmentSpecObj, std::vector< int32_t > &resultSegmentLengths, std::vector< PyType * > &resultTypes)

static MlirValue	getUniqueResult (MlirOperation operation)

static MlirValue	getOpResultOrValue (nb::handle operand)

Variables
static const char	kContextParseTypeDocstring []

static const char	kContextGetCallSiteLocationDocstring []

static const char	kContextGetFileLocationDocstring []

static const char	kContextGetFileRangeDocstring []

static const char	kContextGetFusedLocationDocstring []

static const char	kContextGetNameLocationDocString []

static const char	kModuleParseDocstring []

static const char	kModuleCAPICreate []

static const char	kOperationCreateDocstring []

static const char	kOperationPrintDocstring []

static const char	kOperationPrintStateDocstring []

static const char	kOperationGetAsmDocstring []

static const char	kOperationPrintBytecodeDocstring []

static const char	kOperationStrDunderDocstring []

static const char	kDumpDocstring []

static const char	kAppendBlockDocstring []

static const char	kValueDunderStrDocstring []

static const char	kGetNameAsOperand []

static const char	kValueReplaceAllUsesWithDocstring []

static const char	kValueReplaceAllUsesExceptDocstring []

Macro Definition Documentation

◆ _Py_CAST

#define _Py_CAST	(	type,
		expr
	)	((type)(expr))

Definition at line 2743 of file IRCore.cpp.

◆ _Py_NULL

#define _Py_NULL NULL

Definition at line 2754 of file IRCore.cpp.

◆ Py_NewRef

#define Py_NewRef ( obj ) _Py_NewRef(_PyObject_CAST(obj))

Definition at line 2776 of file IRCore.cpp.

◆ Py_XNewRef

#define Py_XNewRef ( obj ) _Py_XNewRef(_PyObject_CAST(obj))

Definition at line 2767 of file IRCore.cpp.

Function Documentation

◆ classmethod()

template<class Func , typename... Args>

static nb::object classmethod	(	Func	f,
		Args...	args
	)

static

Helper for creating an @classmethod.

Definition at line 205 of file IRCore.cpp.

◆ createBlock()

static MlirBlock createBlock	(	const nb::sequence &	pyArgTypes,
		const std::optional< nb::sequence > &	pyArgLocs
	)

static

Create a block, using the current location context if no locations are specified.

Definition at line 237 of file IRCore.cpp.

References mlirBlockCreate().

Referenced by mlirRewriterBaseCreateBlockBefore().

◆ createCustomDialectWrapper()

static nb::object createCustomDialectWrapper	(	const std::string &	dialectNamespace,
		nb::object	dialectDescriptor
	)

static

Definition at line 211 of file IRCore.cpp.

References mlir::get().

◆ getOpResultOrValue()

static MlirValue getOpResultOrValue ( nb::handle operand )

static

Definition at line 1818 of file IRCore.cpp.

References mlir::python::PyValue::get(), mlir::python::PyOperation::get(), PyOpResultList::getOperation(), mlir::python::PyOperationBase::getOperation(), and getUniqueResult().

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

◆ getUniqueResult()

static MlirValue getUniqueResult ( MlirOperation operation )

static

Definition at line 1803 of file IRCore.cpp.

References mlirIdentifierStr(), mlirOperationGetName(), mlirOperationGetNumResults(), and mlirOperationGetResult().

Referenced by getOpResultOrValue().

◆ getValueTypes()

template<typename Container >

static std::vector<nb::object> getValueTypes	(	Container &	container,
		PyMlirContextRef &	context
	)

static

Returns the list of types of the values held by container.

Definition at line 1641 of file IRCore.cpp.

References mlir::python::PyMlirContext::getRef(), mlir::python::PyType::maybeDownCast(), and mlirValueGetType().

Referenced by PyOpResultList::bindDerived().

◆ maybeInsertOperation()

static void maybeInsertOperation	(	PyOperationRef &	op,
		const nb::object &	maybeIp
	)

static

Definition at line 1407 of file IRCore.cpp.

References mlir::python::PyObjectRef< T >::get(), mlir::python::PyThreadContextEntry::getDefaultInsertionPoint(), and mlir::python::PyInsertionPoint::insert().

Referenced by mlir::python::PyOperation::clone().

◆ populateResultTypes()

static void populateResultTypes	(	StringRef	name,
		nb::list	resultTypeList,
		const nb::object &	resultSegmentSpecObj,
		std::vector< int32_t > &	resultSegmentLengths,
		std::vector< PyType * > &	resultTypes
	)

static

Definition at line 1706 of file IRCore.cpp.

References mlir::detail::enumerate().

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

◆ toMlirStringRef() [1/3]

static MlirStringRef toMlirStringRef ( const nb::bytes & s )

static

Definition at line 231 of file IRCore.cpp.

References mlirStringRefCreate().

◆ toMlirStringRef() [2/3]

static MlirStringRef toMlirStringRef ( const std::string & s )

static

Definition at line 223 of file IRCore.cpp.

References mlirStringRefCreate().

Referenced by mlir::python::PyStringAttribute::bindDerived(), mlir::python::PyOperation::parse(), mlir::python::PyNamedAttribute::PyNamedAttribute(), mlir::python::PySymbolTable::replaceAllSymbolUses(), mlir::python::PySymbolTable::setSymbolName(), and mlir::python::PySymbolTable::setVisibility().

◆ toMlirStringRef() [3/3]

static MlirStringRef toMlirStringRef ( std::string_view s )

static

Definition at line 227 of file IRCore.cpp.

References mlirStringRefCreate().

Variable Documentation

◆ kAppendBlockDocstring

const char kAppendBlockDocstring[]

static

Initial value:

=
    R"(Appends a new block, with argument types as positional args.
 
Returns:
  The created block.
)"

Definition at line 169 of file IRCore.cpp.

◆ kContextGetCallSiteLocationDocstring

const char kContextGetCallSiteLocationDocstring[]

static

Initial value:

=

R"(Gets a Location representing a caller and callsite)"

Definition at line 47 of file IRCore.cpp.

◆ kContextGetFileLocationDocstring

const char kContextGetFileLocationDocstring[]

static

Initial value:

=

R"(Gets a Location representing a file, line and column)"

Definition at line 50 of file IRCore.cpp.

◆ kContextGetFileRangeDocstring

const char kContextGetFileRangeDocstring[]

static

Initial value:

=

R"(Gets a Location representing a file, line and column range)"

Definition at line 53 of file IRCore.cpp.

◆ kContextGetFusedLocationDocstring

const char kContextGetFusedLocationDocstring[]

static

Initial value:

=

R"(Gets a Location representing a fused location with optional metadata)"

Definition at line 56 of file IRCore.cpp.

◆ kContextGetNameLocationDocString

const char kContextGetNameLocationDocString[]

static

Initial value:

=

R"(Gets a Location representing a named location with optional child location)"

Definition at line 59 of file IRCore.cpp.

◆ kContextParseTypeDocstring

const char kContextParseTypeDocstring[]

static

Initial value:

=
    R"(Parses the assembly form of a type.
 
Returns a Type object or raises an MLIRError if the type cannot be parsed.
 
See also: https://mlir.llvm.org/docs/LangRef/#type-system
)"

Definition at line 39 of file IRCore.cpp.

◆ kDumpDocstring

const char kDumpDocstring[]

static

Initial value:

=

R"(Dumps a debug representation of the object to stderr.)"

Definition at line 166 of file IRCore.cpp.

◆ kGetNameAsOperand

const char kGetNameAsOperand[]

static

Initial value:

=
    R"(Returns the string form of value as an operand (i.e., the ValueID).
)"

Definition at line 184 of file IRCore.cpp.

◆ kModuleCAPICreate

const char kModuleCAPICreate[]

static

Initial value:

=
    R"(Creates a Module from a MlirModule wrapped by a capsule (i.e. module._CAPIPtr).
Note this returns a new object BUT _clear_mlir_module(module) must be called to
prevent double-frees (of the underlying mlir::Module).
)"

Definition at line 70 of file IRCore.cpp.

◆ kModuleParseDocstring

const char kModuleParseDocstring[]

static

Initial value:

=
    R"(Parses a module's assembly format from a string.
 
Returns a new MlirModule or raises an MLIRError if the parsing fails.
 
See also: https://mlir.llvm.org/docs/LangRef/
)"

Definition at line 62 of file IRCore.cpp.

◆ kOperationCreateDocstring

const char kOperationCreateDocstring[]

static

Initial value:

=
    R"(Creates a new operation.
 
Args:
  name: Operation name (e.g. "dialect.operation").
  results: Sequence of Type representing op result types.
  attributes: Dict of str:Attribute.
  successors: List of Block for the operation's successors.
  regions: Number of regions to create.
  location: A Location object (defaults to resolve from context manager).
  ip: An InsertionPoint (defaults to resolve from context manager or set to
    False to disable insertion, even with an insertion point set in the
    context manager).
  infer_type: Whether to infer result types.
Returns:
  A new "detached" Operation object. Detached operations can be added
  to blocks, which causes them to become "attached."
)"

Definition at line 76 of file IRCore.cpp.

◆ kOperationGetAsmDocstring

const char kOperationGetAsmDocstring[]

static

Initial value:

=
    R"(Gets the assembly form of the operation with all options available.
 
Args:
  binary: Whether to return a bytes (True) or str (False) object. Defaults to
    False.
  ... others ...: See the print() method for common keyword arguments for
    configuring the printout.
Returns:
  Either a bytes or str object, depending on the setting of the 'binary'
  argument.
)"

Definition at line 135 of file IRCore.cpp.

◆ kOperationPrintBytecodeDocstring

const char kOperationPrintBytecodeDocstring[]

static

Initial value:

=
    R"(Write the bytecode form of the operation to a file like object.
 
Args:
  file: The file like object to write to.
  desired_version: The version of bytecode to emit.
Returns:
  The bytecode writer status.
)"

Definition at line 148 of file IRCore.cpp.

◆ kOperationPrintDocstring

const char kOperationPrintDocstring[]

static

Initial value:

=
    R"(Prints the assembly form of the operation to a file like object.
 
Args:
  file: The file like object to write to. Defaults to sys.stdout.
  binary: Whether to write bytes (True) or str (False). Defaults to False.
  large_elements_limit: Whether to elide elements attributes above this
    number of elements. Defaults to None (no limit).
  large_resource_limit: Whether to elide resource attributes above this
    number of characters. Defaults to None (no limit). If large_elements_limit
    is set and this is None, the behavior will be to use large_elements_limit
    as large_resource_limit.
  enable_debug_info: Whether to print debug/location information. Defaults
    to False.
  pretty_debug_info: Whether to format debug information for easier reading
    by a human (warning: the result is unparseable).
  print_generic_op_form: Whether to print the generic assembly forms of all
    ops. Defaults to False.
  use_local_Scope: Whether to print in a way that is more optimized for
    multi-threaded access but may not be consistent with how the overall
    module prints.
  assume_verified: By default, if not printing generic form, the verifier
    will be run and if it fails, generic form will be printed with a comment
    about failed verification. While a reasonable default for interactive use,
    for systematic use, it is often better for the caller to verify explicitly
    and report failures in a more robust fashion. Set this to True if doing this
    in order to avoid running a redundant verification. If the IR is actually
    invalid, behavior is undefined.
  skip_regions: Whether to skip printing regions. Defaults to False.
)"

Definition at line 95 of file IRCore.cpp.

◆ kOperationPrintStateDocstring

const char kOperationPrintStateDocstring[]

static

Initial value:

=
    R"(Prints the assembly form of the operation to a file like object.
 
Args:
  file: The file like object to write to. Defaults to sys.stdout.
  binary: Whether to write bytes (True) or str (False). Defaults to False.
  state: AsmState capturing the operation numbering and flags.
)"

Definition at line 126 of file IRCore.cpp.

◆ kOperationStrDunderDocstring

const char kOperationStrDunderDocstring[]

static

Initial value:

=
    R"(Gets the assembly form of the operation with default options.
 
If more advanced control over the assembly formatting or I/O options is needed,
use the dedicated print or get_asm method, which supports keyword arguments to
customize behavior.
)"

Definition at line 158 of file IRCore.cpp.

◆ kValueDunderStrDocstring

const char kValueDunderStrDocstring[]

static

Initial value:

=
    R"(Returns the string form of the value.
 
If the value is a block argument, this is the assembly form of its type and the
position in the argument list. If the value is an operation result, this is
equivalent to printing the operation that produced it.
)"

Definition at line 176 of file IRCore.cpp.

◆ kValueReplaceAllUsesExceptDocstring

const char kValueReplaceAllUsesExceptDocstring[]

static

Initial value:

=
    R"("Replace all uses of this value with the 'with' value, except for those
in 'exceptions'. 'exceptions' can be either a single operation or a list of
operations.
)"

Definition at line 193 of file IRCore.cpp.

◆ kValueReplaceAllUsesWithDocstring

const char kValueReplaceAllUsesWithDocstring[]

static

Initial value:

=
    R"(Replace all uses of value with the new value, updating anything in
the IR that uses 'self' to use the other value instead.
)"

Definition at line 188 of file IRCore.cpp.

Classes

Macros

Functions

Variables

Macro Definition Documentation

◆ _Py_CAST

◆ _Py_NULL

◆ Py_NewRef

◆ Py_XNewRef

Function Documentation

◆ classmethod()

◆ createBlock()

◆ createCustomDialectWrapper()

◆ getOpResultOrValue()

◆ getUniqueResult()

◆ getValueTypes()

◆ maybeInsertOperation()

◆ populateResultTypes()

◆ toMlirStringRef() [1/3]

◆ toMlirStringRef() [2/3]

◆ toMlirStringRef() [3/3]

Variable Documentation

◆ kAppendBlockDocstring

◆ kContextGetCallSiteLocationDocstring

◆ kContextGetFileLocationDocstring

◆ kContextGetFileRangeDocstring

◆ kContextGetFusedLocationDocstring

◆ kContextGetNameLocationDocString

◆ kContextParseTypeDocstring

◆ kDumpDocstring

◆ kGetNameAsOperand

◆ kModuleCAPICreate

◆ kModuleParseDocstring

◆ kOperationCreateDocstring

◆ kOperationGetAsmDocstring

◆ kOperationPrintBytecodeDocstring

◆ kOperationPrintDocstring

◆ kOperationPrintStateDocstring

◆ kOperationStrDunderDocstring

◆ kValueDunderStrDocstring

◆ kValueReplaceAllUsesExceptDocstring

◆ kValueReplaceAllUsesWithDocstring