bfb1ba7526
depends on D150839
This diff uses `MlirTypeID` to register `TypeCaster`s (i.e., `[](PyType pyType) -> DerivedTy { return pyType; }`) for all concrete types (i.e., `PyConcrete<...>`) that are then queried for (by `MlirTypeID`) and called in `struct type_caster<MlirType>::cast`. The result is that anywhere an `MlirType mlirType` is returned from a python binding, that `mlirType` is automatically cast to the correct concrete type. For example:
```
c0 = arith.ConstantOp(f32, 0.0)
# CHECK: F32Type(f32)
print(repr(c0.result.type))
unranked_tensor_type = UnrankedTensorType.get(f32)
unranked_tensor = tensor.FromElementsOp(unranked_tensor_type, [c0]).result
# CHECK: UnrankedTensorType
print(type(unranked_tensor.type).__name__)
# CHECK: UnrankedTensorType(tensor<*xf32>)
print(repr(unranked_tensor.type))
```
This functionality immediately extends to typed attributes (i.e., `attr.type`).
The diff also implements similar functionality for `mlir_type_subclass`es but in a slightly different way - for such types (which have no cpp corresponding `class` or `struct`) the user must provide a type caster in python (similar to how `AttrBuilder` works) or in cpp as a `py::cpp_function`.
Reviewed By: ftynse
Differential Revision: https://reviews.llvm.org/D150927
131 lines
5.1 KiB
C++
131 lines
5.1 KiB
C++
//===- Globals.h - MLIR Python extension globals --------------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef MLIR_BINDINGS_PYTHON_GLOBALS_H
|
|
#define MLIR_BINDINGS_PYTHON_GLOBALS_H
|
|
|
|
#include <optional>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "PybindUtils.h"
|
|
|
|
#include "mlir-c/IR.h"
|
|
#include "mlir/CAPI/Support.h"
|
|
#include "llvm/ADT/DenseMap.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/ADT/StringSet.h"
|
|
|
|
namespace mlir {
|
|
namespace python {
|
|
|
|
/// Globals that are always accessible once the extension has been initialized.
|
|
class PyGlobals {
|
|
public:
|
|
PyGlobals();
|
|
~PyGlobals();
|
|
|
|
/// Most code should get the globals via this static accessor.
|
|
static PyGlobals &get() {
|
|
assert(instance && "PyGlobals is null");
|
|
return *instance;
|
|
}
|
|
|
|
/// Get and set the list of parent modules to search for dialect
|
|
/// implementation classes.
|
|
std::vector<std::string> &getDialectSearchPrefixes() {
|
|
return dialectSearchPrefixes;
|
|
}
|
|
void setDialectSearchPrefixes(std::vector<std::string> newValues) {
|
|
dialectSearchPrefixes.swap(newValues);
|
|
}
|
|
|
|
/// Clears positive and negative caches regarding what implementations are
|
|
/// available. Future lookups will do more expensive existence checks.
|
|
void clearImportCache();
|
|
|
|
/// Loads a python module corresponding to the given dialect namespace.
|
|
/// No-ops if the module has already been loaded or is not found. Raises
|
|
/// an error on any evaluation issues.
|
|
/// Note that this returns void because it is expected that the module
|
|
/// contains calls to decorators and helpers that register the salient
|
|
/// entities.
|
|
void loadDialectModule(llvm::StringRef dialectNamespace);
|
|
|
|
/// Adds a user-friendly Attribute builder.
|
|
/// Raises an exception if the mapping already exists.
|
|
/// This is intended to be called by implementation code.
|
|
void registerAttributeBuilder(const std::string &attributeKind,
|
|
pybind11::function pyFunc);
|
|
|
|
/// Adds a user-friendly type caster. Raises an exception if the mapping
|
|
/// already exists and replace == false. This is intended to be called by
|
|
/// implementation code.
|
|
void registerTypeCaster(MlirTypeID mlirTypeID, pybind11::function typeCaster,
|
|
bool replace = false);
|
|
|
|
/// Adds a concrete implementation dialect class.
|
|
/// Raises an exception if the mapping already exists.
|
|
/// This is intended to be called by implementation code.
|
|
void registerDialectImpl(const std::string &dialectNamespace,
|
|
pybind11::object pyClass);
|
|
|
|
/// Adds a concrete implementation operation class.
|
|
/// Raises an exception if the mapping already exists.
|
|
/// This is intended to be called by implementation code.
|
|
void registerOperationImpl(const std::string &operationName,
|
|
pybind11::object pyClass);
|
|
|
|
/// Returns the custom Attribute builder for Attribute kind.
|
|
std::optional<pybind11::function>
|
|
lookupAttributeBuilder(const std::string &attributeKind);
|
|
|
|
/// Returns the custom type caster for MlirTypeID mlirTypeID.
|
|
std::optional<pybind11::function> lookupTypeCaster(MlirTypeID mlirTypeID,
|
|
MlirDialect dialect);
|
|
|
|
/// Looks up a registered dialect class by namespace. Note that this may
|
|
/// trigger loading of the defining module and can arbitrarily re-enter.
|
|
std::optional<pybind11::object>
|
|
lookupDialectClass(const std::string &dialectNamespace);
|
|
|
|
/// Looks up a registered operation class (deriving from OpView) by operation
|
|
/// name. Note that this may trigger a load of the dialect, which can
|
|
/// arbitrarily re-enter.
|
|
std::optional<pybind11::object>
|
|
lookupOperationClass(llvm::StringRef operationName);
|
|
|
|
private:
|
|
static PyGlobals *instance;
|
|
/// Module name prefixes to search under for dialect implementation modules.
|
|
std::vector<std::string> dialectSearchPrefixes;
|
|
/// Map of dialect namespace to external dialect class object.
|
|
llvm::StringMap<pybind11::object> dialectClassMap;
|
|
/// Map of full operation name to external operation class object.
|
|
llvm::StringMap<pybind11::object> operationClassMap;
|
|
/// Map of attribute ODS name to custom builder.
|
|
llvm::StringMap<pybind11::object> attributeBuilderMap;
|
|
/// Map of MlirTypeID to custom type caster.
|
|
llvm::DenseMap<MlirTypeID, pybind11::object> typeCasterMap;
|
|
/// Cache for map of MlirTypeID to custom type caster.
|
|
llvm::DenseMap<MlirTypeID, pybind11::object> typeCasterMapCache;
|
|
|
|
/// Set of dialect namespaces that we have attempted to import implementation
|
|
/// modules for.
|
|
llvm::StringSet<> loadedDialectModulesCache;
|
|
/// Cache of operation name to external operation class object. This is
|
|
/// maintained on lookup as a shadow of operationClassMap in order for repeat
|
|
/// lookups of the classes to only incur the cost of one hashtable lookup.
|
|
llvm::StringMap<pybind11::object> operationClassMapCache;
|
|
};
|
|
|
|
} // namespace python
|
|
} // namespace mlir
|
|
|
|
#endif // MLIR_BINDINGS_PYTHON_GLOBALS_H
|