xref: /llvm-project/mlir/lib/Bindings/Python/IRAttributes.cpp (revision 308d8b8c6618f570166bcc7dbb87f97c04bba1b2)
1436c6c9cSStella Laurenzo //===- IRAttributes.cpp - Exports builtin and standard attributes ---------===//
2436c6c9cSStella Laurenzo //
3436c6c9cSStella Laurenzo // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4436c6c9cSStella Laurenzo // See https://llvm.org/LICENSE.txt for license information.
5436c6c9cSStella Laurenzo // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6436c6c9cSStella Laurenzo //
7436c6c9cSStella Laurenzo //===----------------------------------------------------------------------===//
8436c6c9cSStella Laurenzo 
91fc096afSMehdi Amini #include <utility>
101fc096afSMehdi Amini 
11436c6c9cSStella Laurenzo #include "IRModule.h"
12436c6c9cSStella Laurenzo 
13436c6c9cSStella Laurenzo #include "PybindUtils.h"
14436c6c9cSStella Laurenzo 
15436c6c9cSStella Laurenzo #include "mlir-c/BuiltinAttributes.h"
16436c6c9cSStella Laurenzo #include "mlir-c/BuiltinTypes.h"
17436c6c9cSStella Laurenzo 
18436c6c9cSStella Laurenzo namespace py = pybind11;
19436c6c9cSStella Laurenzo using namespace mlir;
20436c6c9cSStella Laurenzo using namespace mlir::python;
21436c6c9cSStella Laurenzo 
225d6d30edSStella Laurenzo using llvm::Optional;
23436c6c9cSStella Laurenzo using llvm::SmallVector;
24436c6c9cSStella Laurenzo using llvm::Twine;
25436c6c9cSStella Laurenzo 
265d6d30edSStella Laurenzo //------------------------------------------------------------------------------
275d6d30edSStella Laurenzo // Docstrings (trivial, non-duplicated docstrings are included inline).
285d6d30edSStella Laurenzo //------------------------------------------------------------------------------
295d6d30edSStella Laurenzo 
305d6d30edSStella Laurenzo static const char kDenseElementsAttrGetDocstring[] =
315d6d30edSStella Laurenzo     R"(Gets a DenseElementsAttr from a Python buffer or array.
325d6d30edSStella Laurenzo 
335d6d30edSStella Laurenzo When `type` is not provided, then some limited type inferencing is done based
345d6d30edSStella Laurenzo on the buffer format. Support presently exists for 8/16/32/64 signed and
355d6d30edSStella Laurenzo unsigned integers and float16/float32/float64. DenseElementsAttrs of these
365d6d30edSStella Laurenzo types can also be converted back to a corresponding buffer.
375d6d30edSStella Laurenzo 
385d6d30edSStella Laurenzo For conversions outside of these types, a `type=` must be explicitly provided
395d6d30edSStella Laurenzo and the buffer contents must be bit-castable to the MLIR internal
405d6d30edSStella Laurenzo representation:
415d6d30edSStella Laurenzo 
425d6d30edSStella Laurenzo   * Integer types (except for i1): the buffer must be byte aligned to the
435d6d30edSStella Laurenzo     next byte boundary.
445d6d30edSStella Laurenzo   * Floating point types: Must be bit-castable to the given floating point
455d6d30edSStella Laurenzo     size.
465d6d30edSStella Laurenzo   * i1 (bool): Bit packed into 8bit words where the bit pattern matches a
475d6d30edSStella Laurenzo     row major ordering. An arbitrary Numpy `bool_` array can be bit packed to
485d6d30edSStella Laurenzo     this specification with: `np.packbits(ary, axis=None, bitorder='little')`.
495d6d30edSStella Laurenzo 
505d6d30edSStella Laurenzo If a single element buffer is passed (or for i1, a single byte with value 0
515d6d30edSStella Laurenzo or 255), then a splat will be created.
525d6d30edSStella Laurenzo 
535d6d30edSStella Laurenzo Args:
545d6d30edSStella Laurenzo   array: The array or buffer to convert.
555d6d30edSStella Laurenzo   signless: If inferring an appropriate MLIR type, use signless types for
565d6d30edSStella Laurenzo     integers (defaults True).
575d6d30edSStella Laurenzo   type: Skips inference of the MLIR element type and uses this instead. The
585d6d30edSStella Laurenzo     storage size must be consistent with the actual contents of the buffer.
595d6d30edSStella Laurenzo   shape: Overrides the shape of the buffer when constructing the MLIR
605d6d30edSStella Laurenzo     shaped type. This is needed when the physical and logical shape differ (as
615d6d30edSStella Laurenzo     for i1).
625d6d30edSStella Laurenzo   context: Explicit context, if not from context manager.
635d6d30edSStella Laurenzo 
645d6d30edSStella Laurenzo Returns:
655d6d30edSStella Laurenzo   DenseElementsAttr on success.
665d6d30edSStella Laurenzo 
675d6d30edSStella Laurenzo Raises:
685d6d30edSStella Laurenzo   ValueError: If the type of the buffer or array cannot be matched to an MLIR
695d6d30edSStella Laurenzo     type or if the buffer does not meet expectations.
705d6d30edSStella Laurenzo )";
715d6d30edSStella Laurenzo 
72436c6c9cSStella Laurenzo namespace {
73436c6c9cSStella Laurenzo 
74436c6c9cSStella Laurenzo static MlirStringRef toMlirStringRef(const std::string &s) {
75436c6c9cSStella Laurenzo   return mlirStringRefCreate(s.data(), s.size());
76436c6c9cSStella Laurenzo }
77436c6c9cSStella Laurenzo 
78436c6c9cSStella Laurenzo class PyAffineMapAttribute : public PyConcreteAttribute<PyAffineMapAttribute> {
79436c6c9cSStella Laurenzo public:
80436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsAAffineMap;
81436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "AffineMapAttr";
82436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
83436c6c9cSStella Laurenzo 
84436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
85436c6c9cSStella Laurenzo     c.def_static(
86436c6c9cSStella Laurenzo         "get",
87436c6c9cSStella Laurenzo         [](PyAffineMap &affineMap) {
88436c6c9cSStella Laurenzo           MlirAttribute attr = mlirAffineMapAttrGet(affineMap.get());
89436c6c9cSStella Laurenzo           return PyAffineMapAttribute(affineMap.getContext(), attr);
90436c6c9cSStella Laurenzo         },
91436c6c9cSStella Laurenzo         py::arg("affine_map"), "Gets an attribute wrapping an AffineMap.");
92436c6c9cSStella Laurenzo   }
93436c6c9cSStella Laurenzo };
94436c6c9cSStella Laurenzo 
95ed9e52f3SAlex Zinenko template <typename T>
96ed9e52f3SAlex Zinenko static T pyTryCast(py::handle object) {
97ed9e52f3SAlex Zinenko   try {
98ed9e52f3SAlex Zinenko     return object.cast<T>();
99ed9e52f3SAlex Zinenko   } catch (py::cast_error &err) {
100ed9e52f3SAlex Zinenko     std::string msg =
101ed9e52f3SAlex Zinenko         std::string(
102ed9e52f3SAlex Zinenko             "Invalid attribute when attempting to create an ArrayAttribute (") +
103ed9e52f3SAlex Zinenko         err.what() + ")";
104ed9e52f3SAlex Zinenko     throw py::cast_error(msg);
105ed9e52f3SAlex Zinenko   } catch (py::reference_cast_error &err) {
106ed9e52f3SAlex Zinenko     std::string msg = std::string("Invalid attribute (None?) when attempting "
107ed9e52f3SAlex Zinenko                                   "to create an ArrayAttribute (") +
108ed9e52f3SAlex Zinenko                       err.what() + ")";
109ed9e52f3SAlex Zinenko     throw py::cast_error(msg);
110ed9e52f3SAlex Zinenko   }
111ed9e52f3SAlex Zinenko }
112ed9e52f3SAlex Zinenko 
113436c6c9cSStella Laurenzo class PyArrayAttribute : public PyConcreteAttribute<PyArrayAttribute> {
114436c6c9cSStella Laurenzo public:
115436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsAArray;
116436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "ArrayAttr";
117436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
118436c6c9cSStella Laurenzo 
119436c6c9cSStella Laurenzo   class PyArrayAttributeIterator {
120436c6c9cSStella Laurenzo   public:
1211fc096afSMehdi Amini     PyArrayAttributeIterator(PyAttribute attr) : attr(std::move(attr)) {}
122436c6c9cSStella Laurenzo 
123436c6c9cSStella Laurenzo     PyArrayAttributeIterator &dunderIter() { return *this; }
124436c6c9cSStella Laurenzo 
125436c6c9cSStella Laurenzo     PyAttribute dunderNext() {
126436c6c9cSStella Laurenzo       if (nextIndex >= mlirArrayAttrGetNumElements(attr.get())) {
127436c6c9cSStella Laurenzo         throw py::stop_iteration();
128436c6c9cSStella Laurenzo       }
129436c6c9cSStella Laurenzo       return PyAttribute(attr.getContext(),
130436c6c9cSStella Laurenzo                          mlirArrayAttrGetElement(attr.get(), nextIndex++));
131436c6c9cSStella Laurenzo     }
132436c6c9cSStella Laurenzo 
133436c6c9cSStella Laurenzo     static void bind(py::module &m) {
134f05ff4f7SStella Laurenzo       py::class_<PyArrayAttributeIterator>(m, "ArrayAttributeIterator",
135f05ff4f7SStella Laurenzo                                            py::module_local())
136436c6c9cSStella Laurenzo           .def("__iter__", &PyArrayAttributeIterator::dunderIter)
137436c6c9cSStella Laurenzo           .def("__next__", &PyArrayAttributeIterator::dunderNext);
138436c6c9cSStella Laurenzo     }
139436c6c9cSStella Laurenzo 
140436c6c9cSStella Laurenzo   private:
141436c6c9cSStella Laurenzo     PyAttribute attr;
142436c6c9cSStella Laurenzo     int nextIndex = 0;
143436c6c9cSStella Laurenzo   };
144436c6c9cSStella Laurenzo 
145ed9e52f3SAlex Zinenko   PyAttribute getItem(intptr_t i) {
146ed9e52f3SAlex Zinenko     return PyAttribute(getContext(), mlirArrayAttrGetElement(*this, i));
147ed9e52f3SAlex Zinenko   }
148ed9e52f3SAlex Zinenko 
149436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
150436c6c9cSStella Laurenzo     c.def_static(
151436c6c9cSStella Laurenzo         "get",
152436c6c9cSStella Laurenzo         [](py::list attributes, DefaultingPyMlirContext context) {
153436c6c9cSStella Laurenzo           SmallVector<MlirAttribute> mlirAttributes;
154436c6c9cSStella Laurenzo           mlirAttributes.reserve(py::len(attributes));
155436c6c9cSStella Laurenzo           for (auto attribute : attributes) {
156ed9e52f3SAlex Zinenko             mlirAttributes.push_back(pyTryCast<PyAttribute>(attribute));
157436c6c9cSStella Laurenzo           }
158436c6c9cSStella Laurenzo           MlirAttribute attr = mlirArrayAttrGet(
159436c6c9cSStella Laurenzo               context->get(), mlirAttributes.size(), mlirAttributes.data());
160436c6c9cSStella Laurenzo           return PyArrayAttribute(context->getRef(), attr);
161436c6c9cSStella Laurenzo         },
162436c6c9cSStella Laurenzo         py::arg("attributes"), py::arg("context") = py::none(),
163436c6c9cSStella Laurenzo         "Gets a uniqued Array attribute");
164436c6c9cSStella Laurenzo     c.def("__getitem__",
165436c6c9cSStella Laurenzo           [](PyArrayAttribute &arr, intptr_t i) {
166436c6c9cSStella Laurenzo             if (i >= mlirArrayAttrGetNumElements(arr))
167436c6c9cSStella Laurenzo               throw py::index_error("ArrayAttribute index out of range");
168ed9e52f3SAlex Zinenko             return arr.getItem(i);
169436c6c9cSStella Laurenzo           })
170436c6c9cSStella Laurenzo         .def("__len__",
171436c6c9cSStella Laurenzo              [](const PyArrayAttribute &arr) {
172436c6c9cSStella Laurenzo                return mlirArrayAttrGetNumElements(arr);
173436c6c9cSStella Laurenzo              })
174436c6c9cSStella Laurenzo         .def("__iter__", [](const PyArrayAttribute &arr) {
175436c6c9cSStella Laurenzo           return PyArrayAttributeIterator(arr);
176436c6c9cSStella Laurenzo         });
177ed9e52f3SAlex Zinenko     c.def("__add__", [](PyArrayAttribute arr, py::list extras) {
178ed9e52f3SAlex Zinenko       std::vector<MlirAttribute> attributes;
179ed9e52f3SAlex Zinenko       intptr_t numOldElements = mlirArrayAttrGetNumElements(arr);
180ed9e52f3SAlex Zinenko       attributes.reserve(numOldElements + py::len(extras));
181ed9e52f3SAlex Zinenko       for (intptr_t i = 0; i < numOldElements; ++i)
182ed9e52f3SAlex Zinenko         attributes.push_back(arr.getItem(i));
183ed9e52f3SAlex Zinenko       for (py::handle attr : extras)
184ed9e52f3SAlex Zinenko         attributes.push_back(pyTryCast<PyAttribute>(attr));
185ed9e52f3SAlex Zinenko       MlirAttribute arrayAttr = mlirArrayAttrGet(
186ed9e52f3SAlex Zinenko           arr.getContext()->get(), attributes.size(), attributes.data());
187ed9e52f3SAlex Zinenko       return PyArrayAttribute(arr.getContext(), arrayAttr);
188ed9e52f3SAlex Zinenko     });
189436c6c9cSStella Laurenzo   }
190436c6c9cSStella Laurenzo };
191436c6c9cSStella Laurenzo 
192436c6c9cSStella Laurenzo /// Float Point Attribute subclass - FloatAttr.
193436c6c9cSStella Laurenzo class PyFloatAttribute : public PyConcreteAttribute<PyFloatAttribute> {
194436c6c9cSStella Laurenzo public:
195436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsAFloat;
196436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "FloatAttr";
197436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
198436c6c9cSStella Laurenzo 
199436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
200436c6c9cSStella Laurenzo     c.def_static(
201436c6c9cSStella Laurenzo         "get",
202436c6c9cSStella Laurenzo         [](PyType &type, double value, DefaultingPyLocation loc) {
203436c6c9cSStella Laurenzo           MlirAttribute attr = mlirFloatAttrDoubleGetChecked(loc, type, value);
204436c6c9cSStella Laurenzo           // TODO: Rework error reporting once diagnostic engine is exposed
205436c6c9cSStella Laurenzo           // in C API.
206436c6c9cSStella Laurenzo           if (mlirAttributeIsNull(attr)) {
207436c6c9cSStella Laurenzo             throw SetPyError(PyExc_ValueError,
208436c6c9cSStella Laurenzo                              Twine("invalid '") +
209436c6c9cSStella Laurenzo                                  py::repr(py::cast(type)).cast<std::string>() +
210436c6c9cSStella Laurenzo                                  "' and expected floating point type.");
211436c6c9cSStella Laurenzo           }
212436c6c9cSStella Laurenzo           return PyFloatAttribute(type.getContext(), attr);
213436c6c9cSStella Laurenzo         },
214436c6c9cSStella Laurenzo         py::arg("type"), py::arg("value"), py::arg("loc") = py::none(),
215436c6c9cSStella Laurenzo         "Gets an uniqued float point attribute associated to a type");
216436c6c9cSStella Laurenzo     c.def_static(
217436c6c9cSStella Laurenzo         "get_f32",
218436c6c9cSStella Laurenzo         [](double value, DefaultingPyMlirContext context) {
219436c6c9cSStella Laurenzo           MlirAttribute attr = mlirFloatAttrDoubleGet(
220436c6c9cSStella Laurenzo               context->get(), mlirF32TypeGet(context->get()), value);
221436c6c9cSStella Laurenzo           return PyFloatAttribute(context->getRef(), attr);
222436c6c9cSStella Laurenzo         },
223436c6c9cSStella Laurenzo         py::arg("value"), py::arg("context") = py::none(),
224436c6c9cSStella Laurenzo         "Gets an uniqued float point attribute associated to a f32 type");
225436c6c9cSStella Laurenzo     c.def_static(
226436c6c9cSStella Laurenzo         "get_f64",
227436c6c9cSStella Laurenzo         [](double value, DefaultingPyMlirContext context) {
228436c6c9cSStella Laurenzo           MlirAttribute attr = mlirFloatAttrDoubleGet(
229436c6c9cSStella Laurenzo               context->get(), mlirF64TypeGet(context->get()), value);
230436c6c9cSStella Laurenzo           return PyFloatAttribute(context->getRef(), attr);
231436c6c9cSStella Laurenzo         },
232436c6c9cSStella Laurenzo         py::arg("value"), py::arg("context") = py::none(),
233436c6c9cSStella Laurenzo         "Gets an uniqued float point attribute associated to a f64 type");
234436c6c9cSStella Laurenzo     c.def_property_readonly(
235436c6c9cSStella Laurenzo         "value",
236436c6c9cSStella Laurenzo         [](PyFloatAttribute &self) {
237436c6c9cSStella Laurenzo           return mlirFloatAttrGetValueDouble(self);
238436c6c9cSStella Laurenzo         },
239436c6c9cSStella Laurenzo         "Returns the value of the float point attribute");
240436c6c9cSStella Laurenzo   }
241436c6c9cSStella Laurenzo };
242436c6c9cSStella Laurenzo 
243436c6c9cSStella Laurenzo /// Integer Attribute subclass - IntegerAttr.
244436c6c9cSStella Laurenzo class PyIntegerAttribute : public PyConcreteAttribute<PyIntegerAttribute> {
245436c6c9cSStella Laurenzo public:
246436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsAInteger;
247436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "IntegerAttr";
248436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
249436c6c9cSStella Laurenzo 
250436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
251436c6c9cSStella Laurenzo     c.def_static(
252436c6c9cSStella Laurenzo         "get",
253436c6c9cSStella Laurenzo         [](PyType &type, int64_t value) {
254436c6c9cSStella Laurenzo           MlirAttribute attr = mlirIntegerAttrGet(type, value);
255436c6c9cSStella Laurenzo           return PyIntegerAttribute(type.getContext(), attr);
256436c6c9cSStella Laurenzo         },
257436c6c9cSStella Laurenzo         py::arg("type"), py::arg("value"),
258436c6c9cSStella Laurenzo         "Gets an uniqued integer attribute associated to a type");
259436c6c9cSStella Laurenzo     c.def_property_readonly(
260436c6c9cSStella Laurenzo         "value",
261436c6c9cSStella Laurenzo         [](PyIntegerAttribute &self) {
262436c6c9cSStella Laurenzo           return mlirIntegerAttrGetValueInt(self);
263436c6c9cSStella Laurenzo         },
264436c6c9cSStella Laurenzo         "Returns the value of the integer attribute");
265436c6c9cSStella Laurenzo   }
266436c6c9cSStella Laurenzo };
267436c6c9cSStella Laurenzo 
268436c6c9cSStella Laurenzo /// Bool Attribute subclass - BoolAttr.
269436c6c9cSStella Laurenzo class PyBoolAttribute : public PyConcreteAttribute<PyBoolAttribute> {
270436c6c9cSStella Laurenzo public:
271436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsABool;
272436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "BoolAttr";
273436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
274436c6c9cSStella Laurenzo 
275436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
276436c6c9cSStella Laurenzo     c.def_static(
277436c6c9cSStella Laurenzo         "get",
278436c6c9cSStella Laurenzo         [](bool value, DefaultingPyMlirContext context) {
279436c6c9cSStella Laurenzo           MlirAttribute attr = mlirBoolAttrGet(context->get(), value);
280436c6c9cSStella Laurenzo           return PyBoolAttribute(context->getRef(), attr);
281436c6c9cSStella Laurenzo         },
282436c6c9cSStella Laurenzo         py::arg("value"), py::arg("context") = py::none(),
283436c6c9cSStella Laurenzo         "Gets an uniqued bool attribute");
284436c6c9cSStella Laurenzo     c.def_property_readonly(
285436c6c9cSStella Laurenzo         "value",
286436c6c9cSStella Laurenzo         [](PyBoolAttribute &self) { return mlirBoolAttrGetValue(self); },
287436c6c9cSStella Laurenzo         "Returns the value of the bool attribute");
288436c6c9cSStella Laurenzo   }
289436c6c9cSStella Laurenzo };
290436c6c9cSStella Laurenzo 
291436c6c9cSStella Laurenzo class PyFlatSymbolRefAttribute
292436c6c9cSStella Laurenzo     : public PyConcreteAttribute<PyFlatSymbolRefAttribute> {
293436c6c9cSStella Laurenzo public:
294436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsAFlatSymbolRef;
295436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "FlatSymbolRefAttr";
296436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
297436c6c9cSStella Laurenzo 
298436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
299436c6c9cSStella Laurenzo     c.def_static(
300436c6c9cSStella Laurenzo         "get",
301436c6c9cSStella Laurenzo         [](std::string value, DefaultingPyMlirContext context) {
302436c6c9cSStella Laurenzo           MlirAttribute attr =
303436c6c9cSStella Laurenzo               mlirFlatSymbolRefAttrGet(context->get(), toMlirStringRef(value));
304436c6c9cSStella Laurenzo           return PyFlatSymbolRefAttribute(context->getRef(), attr);
305436c6c9cSStella Laurenzo         },
306436c6c9cSStella Laurenzo         py::arg("value"), py::arg("context") = py::none(),
307436c6c9cSStella Laurenzo         "Gets a uniqued FlatSymbolRef attribute");
308436c6c9cSStella Laurenzo     c.def_property_readonly(
309436c6c9cSStella Laurenzo         "value",
310436c6c9cSStella Laurenzo         [](PyFlatSymbolRefAttribute &self) {
311436c6c9cSStella Laurenzo           MlirStringRef stringRef = mlirFlatSymbolRefAttrGetValue(self);
312436c6c9cSStella Laurenzo           return py::str(stringRef.data, stringRef.length);
313436c6c9cSStella Laurenzo         },
314436c6c9cSStella Laurenzo         "Returns the value of the FlatSymbolRef attribute as a string");
315436c6c9cSStella Laurenzo   }
316436c6c9cSStella Laurenzo };
317436c6c9cSStella Laurenzo 
318436c6c9cSStella Laurenzo class PyStringAttribute : public PyConcreteAttribute<PyStringAttribute> {
319436c6c9cSStella Laurenzo public:
320436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsAString;
321436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "StringAttr";
322436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
323436c6c9cSStella Laurenzo 
324436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
325436c6c9cSStella Laurenzo     c.def_static(
326436c6c9cSStella Laurenzo         "get",
327436c6c9cSStella Laurenzo         [](std::string value, DefaultingPyMlirContext context) {
328436c6c9cSStella Laurenzo           MlirAttribute attr =
329436c6c9cSStella Laurenzo               mlirStringAttrGet(context->get(), toMlirStringRef(value));
330436c6c9cSStella Laurenzo           return PyStringAttribute(context->getRef(), attr);
331436c6c9cSStella Laurenzo         },
332436c6c9cSStella Laurenzo         py::arg("value"), py::arg("context") = py::none(),
333436c6c9cSStella Laurenzo         "Gets a uniqued string attribute");
334436c6c9cSStella Laurenzo     c.def_static(
335436c6c9cSStella Laurenzo         "get_typed",
336436c6c9cSStella Laurenzo         [](PyType &type, std::string value) {
337436c6c9cSStella Laurenzo           MlirAttribute attr =
338436c6c9cSStella Laurenzo               mlirStringAttrTypedGet(type, toMlirStringRef(value));
339436c6c9cSStella Laurenzo           return PyStringAttribute(type.getContext(), attr);
340436c6c9cSStella Laurenzo         },
341a6e7d024SStella Laurenzo         py::arg("type"), py::arg("value"),
342436c6c9cSStella Laurenzo         "Gets a uniqued string attribute associated to a type");
343436c6c9cSStella Laurenzo     c.def_property_readonly(
344436c6c9cSStella Laurenzo         "value",
345436c6c9cSStella Laurenzo         [](PyStringAttribute &self) {
346436c6c9cSStella Laurenzo           MlirStringRef stringRef = mlirStringAttrGetValue(self);
347436c6c9cSStella Laurenzo           return py::str(stringRef.data, stringRef.length);
348436c6c9cSStella Laurenzo         },
349436c6c9cSStella Laurenzo         "Returns the value of the string attribute");
350436c6c9cSStella Laurenzo   }
351436c6c9cSStella Laurenzo };
352436c6c9cSStella Laurenzo 
353436c6c9cSStella Laurenzo // TODO: Support construction of string elements.
354436c6c9cSStella Laurenzo class PyDenseElementsAttribute
355436c6c9cSStella Laurenzo     : public PyConcreteAttribute<PyDenseElementsAttribute> {
356436c6c9cSStella Laurenzo public:
357436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsADenseElements;
358436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "DenseElementsAttr";
359436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
360436c6c9cSStella Laurenzo 
361436c6c9cSStella Laurenzo   static PyDenseElementsAttribute
3625d6d30edSStella Laurenzo   getFromBuffer(py::buffer array, bool signless, Optional<PyType> explicitType,
3635d6d30edSStella Laurenzo                 Optional<std::vector<int64_t>> explicitShape,
364436c6c9cSStella Laurenzo                 DefaultingPyMlirContext contextWrapper) {
365436c6c9cSStella Laurenzo     // Request a contiguous view. In exotic cases, this will cause a copy.
366436c6c9cSStella Laurenzo     int flags = PyBUF_C_CONTIGUOUS | PyBUF_FORMAT;
367436c6c9cSStella Laurenzo     Py_buffer *view = new Py_buffer();
368436c6c9cSStella Laurenzo     if (PyObject_GetBuffer(array.ptr(), view, flags) != 0) {
369436c6c9cSStella Laurenzo       delete view;
370436c6c9cSStella Laurenzo       throw py::error_already_set();
371436c6c9cSStella Laurenzo     }
372436c6c9cSStella Laurenzo     py::buffer_info arrayInfo(view);
3735d6d30edSStella Laurenzo     SmallVector<int64_t> shape;
3745d6d30edSStella Laurenzo     if (explicitShape) {
3755d6d30edSStella Laurenzo       shape.append(explicitShape->begin(), explicitShape->end());
3765d6d30edSStella Laurenzo     } else {
3775d6d30edSStella Laurenzo       shape.append(arrayInfo.shape.begin(),
3785d6d30edSStella Laurenzo                    arrayInfo.shape.begin() + arrayInfo.ndim);
3795d6d30edSStella Laurenzo     }
380436c6c9cSStella Laurenzo 
3815d6d30edSStella Laurenzo     MlirAttribute encodingAttr = mlirAttributeGetNull();
382436c6c9cSStella Laurenzo     MlirContext context = contextWrapper->get();
3835d6d30edSStella Laurenzo 
3845d6d30edSStella Laurenzo     // Detect format codes that are suitable for bulk loading. This includes
3855d6d30edSStella Laurenzo     // all byte aligned integer and floating point types up to 8 bytes.
3865d6d30edSStella Laurenzo     // Notably, this excludes, bool (which needs to be bit-packed) and
3875d6d30edSStella Laurenzo     // other exotics which do not have a direct representation in the buffer
3885d6d30edSStella Laurenzo     // protocol (i.e. complex, etc).
3895d6d30edSStella Laurenzo     Optional<MlirType> bulkLoadElementType;
3905d6d30edSStella Laurenzo     if (explicitType) {
3915d6d30edSStella Laurenzo       bulkLoadElementType = *explicitType;
3925d6d30edSStella Laurenzo     } else if (arrayInfo.format == "f") {
393436c6c9cSStella Laurenzo       // f32
394436c6c9cSStella Laurenzo       assert(arrayInfo.itemsize == 4 && "mismatched array itemsize");
3955d6d30edSStella Laurenzo       bulkLoadElementType = mlirF32TypeGet(context);
396436c6c9cSStella Laurenzo     } else if (arrayInfo.format == "d") {
397436c6c9cSStella Laurenzo       // f64
398436c6c9cSStella Laurenzo       assert(arrayInfo.itemsize == 8 && "mismatched array itemsize");
3995d6d30edSStella Laurenzo       bulkLoadElementType = mlirF64TypeGet(context);
4005d6d30edSStella Laurenzo     } else if (arrayInfo.format == "e") {
4015d6d30edSStella Laurenzo       // f16
4025d6d30edSStella Laurenzo       assert(arrayInfo.itemsize == 2 && "mismatched array itemsize");
4035d6d30edSStella Laurenzo       bulkLoadElementType = mlirF16TypeGet(context);
404436c6c9cSStella Laurenzo     } else if (isSignedIntegerFormat(arrayInfo.format)) {
405436c6c9cSStella Laurenzo       if (arrayInfo.itemsize == 4) {
406436c6c9cSStella Laurenzo         // i32
4075d6d30edSStella Laurenzo         bulkLoadElementType = signless ? mlirIntegerTypeGet(context, 32)
408436c6c9cSStella Laurenzo                                        : mlirIntegerTypeSignedGet(context, 32);
409436c6c9cSStella Laurenzo       } else if (arrayInfo.itemsize == 8) {
410436c6c9cSStella Laurenzo         // i64
4115d6d30edSStella Laurenzo         bulkLoadElementType = signless ? mlirIntegerTypeGet(context, 64)
412436c6c9cSStella Laurenzo                                        : mlirIntegerTypeSignedGet(context, 64);
4135d6d30edSStella Laurenzo       } else if (arrayInfo.itemsize == 1) {
4145d6d30edSStella Laurenzo         // i8
4155d6d30edSStella Laurenzo         bulkLoadElementType = signless ? mlirIntegerTypeGet(context, 8)
4165d6d30edSStella Laurenzo                                        : mlirIntegerTypeSignedGet(context, 8);
4175d6d30edSStella Laurenzo       } else if (arrayInfo.itemsize == 2) {
4185d6d30edSStella Laurenzo         // i16
4195d6d30edSStella Laurenzo         bulkLoadElementType = signless ? mlirIntegerTypeGet(context, 16)
4205d6d30edSStella Laurenzo                                        : mlirIntegerTypeSignedGet(context, 16);
421436c6c9cSStella Laurenzo       }
422436c6c9cSStella Laurenzo     } else if (isUnsignedIntegerFormat(arrayInfo.format)) {
423436c6c9cSStella Laurenzo       if (arrayInfo.itemsize == 4) {
424436c6c9cSStella Laurenzo         // unsigned i32
4255d6d30edSStella Laurenzo         bulkLoadElementType = signless
426436c6c9cSStella Laurenzo                                   ? mlirIntegerTypeGet(context, 32)
427436c6c9cSStella Laurenzo                                   : mlirIntegerTypeUnsignedGet(context, 32);
428436c6c9cSStella Laurenzo       } else if (arrayInfo.itemsize == 8) {
429436c6c9cSStella Laurenzo         // unsigned i64
4305d6d30edSStella Laurenzo         bulkLoadElementType = signless
431436c6c9cSStella Laurenzo                                   ? mlirIntegerTypeGet(context, 64)
432436c6c9cSStella Laurenzo                                   : mlirIntegerTypeUnsignedGet(context, 64);
4335d6d30edSStella Laurenzo       } else if (arrayInfo.itemsize == 1) {
4345d6d30edSStella Laurenzo         // i8
4355d6d30edSStella Laurenzo         bulkLoadElementType = signless ? mlirIntegerTypeGet(context, 8)
4365d6d30edSStella Laurenzo                                        : mlirIntegerTypeUnsignedGet(context, 8);
4375d6d30edSStella Laurenzo       } else if (arrayInfo.itemsize == 2) {
4385d6d30edSStella Laurenzo         // i16
4395d6d30edSStella Laurenzo         bulkLoadElementType = signless
4405d6d30edSStella Laurenzo                                   ? mlirIntegerTypeGet(context, 16)
4415d6d30edSStella Laurenzo                                   : mlirIntegerTypeUnsignedGet(context, 16);
442436c6c9cSStella Laurenzo       }
443436c6c9cSStella Laurenzo     }
4445d6d30edSStella Laurenzo     if (bulkLoadElementType) {
4455d6d30edSStella Laurenzo       auto shapedType = mlirRankedTensorTypeGet(
4465d6d30edSStella Laurenzo           shape.size(), shape.data(), *bulkLoadElementType, encodingAttr);
4475d6d30edSStella Laurenzo       size_t rawBufferSize = arrayInfo.size * arrayInfo.itemsize;
4485d6d30edSStella Laurenzo       MlirAttribute attr = mlirDenseElementsAttrRawBufferGet(
4495d6d30edSStella Laurenzo           shapedType, rawBufferSize, arrayInfo.ptr);
4505d6d30edSStella Laurenzo       if (mlirAttributeIsNull(attr)) {
4515d6d30edSStella Laurenzo         throw std::invalid_argument(
4525d6d30edSStella Laurenzo             "DenseElementsAttr could not be constructed from the given buffer. "
4535d6d30edSStella Laurenzo             "This may mean that the Python buffer layout does not match that "
4545d6d30edSStella Laurenzo             "MLIR expected layout and is a bug.");
4555d6d30edSStella Laurenzo       }
4565d6d30edSStella Laurenzo       return PyDenseElementsAttribute(contextWrapper->getRef(), attr);
4575d6d30edSStella Laurenzo     }
458436c6c9cSStella Laurenzo 
4595d6d30edSStella Laurenzo     throw std::invalid_argument(
4605d6d30edSStella Laurenzo         std::string("unimplemented array format conversion from format: ") +
4615d6d30edSStella Laurenzo         arrayInfo.format);
462436c6c9cSStella Laurenzo   }
463436c6c9cSStella Laurenzo 
4641fc096afSMehdi Amini   static PyDenseElementsAttribute getSplat(const PyType &shapedType,
465436c6c9cSStella Laurenzo                                            PyAttribute &elementAttr) {
466436c6c9cSStella Laurenzo     auto contextWrapper =
467436c6c9cSStella Laurenzo         PyMlirContext::forContext(mlirTypeGetContext(shapedType));
468436c6c9cSStella Laurenzo     if (!mlirAttributeIsAInteger(elementAttr) &&
469436c6c9cSStella Laurenzo         !mlirAttributeIsAFloat(elementAttr)) {
470436c6c9cSStella Laurenzo       std::string message = "Illegal element type for DenseElementsAttr: ";
471436c6c9cSStella Laurenzo       message.append(py::repr(py::cast(elementAttr)));
472436c6c9cSStella Laurenzo       throw SetPyError(PyExc_ValueError, message);
473436c6c9cSStella Laurenzo     }
474436c6c9cSStella Laurenzo     if (!mlirTypeIsAShaped(shapedType) ||
475436c6c9cSStella Laurenzo         !mlirShapedTypeHasStaticShape(shapedType)) {
476436c6c9cSStella Laurenzo       std::string message =
477436c6c9cSStella Laurenzo           "Expected a static ShapedType for the shaped_type parameter: ";
478436c6c9cSStella Laurenzo       message.append(py::repr(py::cast(shapedType)));
479436c6c9cSStella Laurenzo       throw SetPyError(PyExc_ValueError, message);
480436c6c9cSStella Laurenzo     }
481436c6c9cSStella Laurenzo     MlirType shapedElementType = mlirShapedTypeGetElementType(shapedType);
482436c6c9cSStella Laurenzo     MlirType attrType = mlirAttributeGetType(elementAttr);
483436c6c9cSStella Laurenzo     if (!mlirTypeEqual(shapedElementType, attrType)) {
484436c6c9cSStella Laurenzo       std::string message =
485436c6c9cSStella Laurenzo           "Shaped element type and attribute type must be equal: shaped=";
486436c6c9cSStella Laurenzo       message.append(py::repr(py::cast(shapedType)));
487436c6c9cSStella Laurenzo       message.append(", element=");
488436c6c9cSStella Laurenzo       message.append(py::repr(py::cast(elementAttr)));
489436c6c9cSStella Laurenzo       throw SetPyError(PyExc_ValueError, message);
490436c6c9cSStella Laurenzo     }
491436c6c9cSStella Laurenzo 
492436c6c9cSStella Laurenzo     MlirAttribute elements =
493436c6c9cSStella Laurenzo         mlirDenseElementsAttrSplatGet(shapedType, elementAttr);
494436c6c9cSStella Laurenzo     return PyDenseElementsAttribute(contextWrapper->getRef(), elements);
495436c6c9cSStella Laurenzo   }
496436c6c9cSStella Laurenzo 
497436c6c9cSStella Laurenzo   intptr_t dunderLen() { return mlirElementsAttrGetNumElements(*this); }
498436c6c9cSStella Laurenzo 
499436c6c9cSStella Laurenzo   py::buffer_info accessBuffer() {
5005d6d30edSStella Laurenzo     if (mlirDenseElementsAttrIsSplat(*this)) {
501c5f445d1SStella Laurenzo       // TODO: Currently crashes the program.
5025d6d30edSStella Laurenzo       // Reported as https://github.com/pybind/pybind11/issues/3336
503c5f445d1SStella Laurenzo       throw std::invalid_argument(
504c5f445d1SStella Laurenzo           "unsupported data type for conversion to Python buffer");
5055d6d30edSStella Laurenzo     }
5065d6d30edSStella Laurenzo 
507436c6c9cSStella Laurenzo     MlirType shapedType = mlirAttributeGetType(*this);
508436c6c9cSStella Laurenzo     MlirType elementType = mlirShapedTypeGetElementType(shapedType);
5095d6d30edSStella Laurenzo     std::string format;
510436c6c9cSStella Laurenzo 
511436c6c9cSStella Laurenzo     if (mlirTypeIsAF32(elementType)) {
512436c6c9cSStella Laurenzo       // f32
5135d6d30edSStella Laurenzo       return bufferInfo<float>(shapedType);
51402b6fb21SMehdi Amini     }
51502b6fb21SMehdi Amini     if (mlirTypeIsAF64(elementType)) {
516436c6c9cSStella Laurenzo       // f64
5175d6d30edSStella Laurenzo       return bufferInfo<double>(shapedType);
518bb56c2b3SMehdi Amini     }
519bb56c2b3SMehdi Amini     if (mlirTypeIsAF16(elementType)) {
5205d6d30edSStella Laurenzo       // f16
5215d6d30edSStella Laurenzo       return bufferInfo<uint16_t>(shapedType, "e");
522bb56c2b3SMehdi Amini     }
523bb56c2b3SMehdi Amini     if (mlirTypeIsAInteger(elementType) &&
524436c6c9cSStella Laurenzo         mlirIntegerTypeGetWidth(elementType) == 32) {
525436c6c9cSStella Laurenzo       if (mlirIntegerTypeIsSignless(elementType) ||
526436c6c9cSStella Laurenzo           mlirIntegerTypeIsSigned(elementType)) {
527436c6c9cSStella Laurenzo         // i32
5285d6d30edSStella Laurenzo         return bufferInfo<int32_t>(shapedType);
529e5639b3fSMehdi Amini       }
530e5639b3fSMehdi Amini       if (mlirIntegerTypeIsUnsigned(elementType)) {
531436c6c9cSStella Laurenzo         // unsigned i32
5325d6d30edSStella Laurenzo         return bufferInfo<uint32_t>(shapedType);
533436c6c9cSStella Laurenzo       }
534436c6c9cSStella Laurenzo     } else if (mlirTypeIsAInteger(elementType) &&
535436c6c9cSStella Laurenzo                mlirIntegerTypeGetWidth(elementType) == 64) {
536436c6c9cSStella Laurenzo       if (mlirIntegerTypeIsSignless(elementType) ||
537436c6c9cSStella Laurenzo           mlirIntegerTypeIsSigned(elementType)) {
538436c6c9cSStella Laurenzo         // i64
5395d6d30edSStella Laurenzo         return bufferInfo<int64_t>(shapedType);
540e5639b3fSMehdi Amini       }
541e5639b3fSMehdi Amini       if (mlirIntegerTypeIsUnsigned(elementType)) {
542436c6c9cSStella Laurenzo         // unsigned i64
5435d6d30edSStella Laurenzo         return bufferInfo<uint64_t>(shapedType);
5445d6d30edSStella Laurenzo       }
5455d6d30edSStella Laurenzo     } else if (mlirTypeIsAInteger(elementType) &&
5465d6d30edSStella Laurenzo                mlirIntegerTypeGetWidth(elementType) == 8) {
5475d6d30edSStella Laurenzo       if (mlirIntegerTypeIsSignless(elementType) ||
5485d6d30edSStella Laurenzo           mlirIntegerTypeIsSigned(elementType)) {
5495d6d30edSStella Laurenzo         // i8
5505d6d30edSStella Laurenzo         return bufferInfo<int8_t>(shapedType);
551e5639b3fSMehdi Amini       }
552e5639b3fSMehdi Amini       if (mlirIntegerTypeIsUnsigned(elementType)) {
5535d6d30edSStella Laurenzo         // unsigned i8
5545d6d30edSStella Laurenzo         return bufferInfo<uint8_t>(shapedType);
5555d6d30edSStella Laurenzo       }
5565d6d30edSStella Laurenzo     } else if (mlirTypeIsAInteger(elementType) &&
5575d6d30edSStella Laurenzo                mlirIntegerTypeGetWidth(elementType) == 16) {
5585d6d30edSStella Laurenzo       if (mlirIntegerTypeIsSignless(elementType) ||
5595d6d30edSStella Laurenzo           mlirIntegerTypeIsSigned(elementType)) {
5605d6d30edSStella Laurenzo         // i16
5615d6d30edSStella Laurenzo         return bufferInfo<int16_t>(shapedType);
562e5639b3fSMehdi Amini       }
563e5639b3fSMehdi Amini       if (mlirIntegerTypeIsUnsigned(elementType)) {
5645d6d30edSStella Laurenzo         // unsigned i16
5655d6d30edSStella Laurenzo         return bufferInfo<uint16_t>(shapedType);
566436c6c9cSStella Laurenzo       }
567436c6c9cSStella Laurenzo     }
568436c6c9cSStella Laurenzo 
569c5f445d1SStella Laurenzo     // TODO: Currently crashes the program.
5705d6d30edSStella Laurenzo     // Reported as https://github.com/pybind/pybind11/issues/3336
571c5f445d1SStella Laurenzo     throw std::invalid_argument(
572c5f445d1SStella Laurenzo         "unsupported data type for conversion to Python buffer");
573436c6c9cSStella Laurenzo   }
574436c6c9cSStella Laurenzo 
575436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
576436c6c9cSStella Laurenzo     c.def("__len__", &PyDenseElementsAttribute::dunderLen)
577436c6c9cSStella Laurenzo         .def_static("get", PyDenseElementsAttribute::getFromBuffer,
578436c6c9cSStella Laurenzo                     py::arg("array"), py::arg("signless") = true,
5795d6d30edSStella Laurenzo                     py::arg("type") = py::none(), py::arg("shape") = py::none(),
580436c6c9cSStella Laurenzo                     py::arg("context") = py::none(),
5815d6d30edSStella Laurenzo                     kDenseElementsAttrGetDocstring)
582436c6c9cSStella Laurenzo         .def_static("get_splat", PyDenseElementsAttribute::getSplat,
583436c6c9cSStella Laurenzo                     py::arg("shaped_type"), py::arg("element_attr"),
584436c6c9cSStella Laurenzo                     "Gets a DenseElementsAttr where all values are the same")
585436c6c9cSStella Laurenzo         .def_property_readonly("is_splat",
586436c6c9cSStella Laurenzo                                [](PyDenseElementsAttribute &self) -> bool {
587436c6c9cSStella Laurenzo                                  return mlirDenseElementsAttrIsSplat(self);
588436c6c9cSStella Laurenzo                                })
589436c6c9cSStella Laurenzo         .def_buffer(&PyDenseElementsAttribute::accessBuffer);
590436c6c9cSStella Laurenzo   }
591436c6c9cSStella Laurenzo 
592436c6c9cSStella Laurenzo private:
593436c6c9cSStella Laurenzo   static bool isUnsignedIntegerFormat(const std::string &format) {
594436c6c9cSStella Laurenzo     if (format.empty())
595436c6c9cSStella Laurenzo       return false;
596436c6c9cSStella Laurenzo     char code = format[0];
597436c6c9cSStella Laurenzo     return code == 'I' || code == 'B' || code == 'H' || code == 'L' ||
598436c6c9cSStella Laurenzo            code == 'Q';
599436c6c9cSStella Laurenzo   }
600436c6c9cSStella Laurenzo 
601436c6c9cSStella Laurenzo   static bool isSignedIntegerFormat(const std::string &format) {
602436c6c9cSStella Laurenzo     if (format.empty())
603436c6c9cSStella Laurenzo       return false;
604436c6c9cSStella Laurenzo     char code = format[0];
605436c6c9cSStella Laurenzo     return code == 'i' || code == 'b' || code == 'h' || code == 'l' ||
606436c6c9cSStella Laurenzo            code == 'q';
607436c6c9cSStella Laurenzo   }
608436c6c9cSStella Laurenzo 
609436c6c9cSStella Laurenzo   template <typename Type>
610436c6c9cSStella Laurenzo   py::buffer_info bufferInfo(MlirType shapedType,
6115d6d30edSStella Laurenzo                              const char *explicitFormat = nullptr) {
612436c6c9cSStella Laurenzo     intptr_t rank = mlirShapedTypeGetRank(shapedType);
613436c6c9cSStella Laurenzo     // Prepare the data for the buffer_info.
614436c6c9cSStella Laurenzo     // Buffer is configured for read-only access below.
615436c6c9cSStella Laurenzo     Type *data = static_cast<Type *>(
616436c6c9cSStella Laurenzo         const_cast<void *>(mlirDenseElementsAttrGetRawData(*this)));
617436c6c9cSStella Laurenzo     // Prepare the shape for the buffer_info.
618436c6c9cSStella Laurenzo     SmallVector<intptr_t, 4> shape;
619436c6c9cSStella Laurenzo     for (intptr_t i = 0; i < rank; ++i)
620436c6c9cSStella Laurenzo       shape.push_back(mlirShapedTypeGetDimSize(shapedType, i));
621436c6c9cSStella Laurenzo     // Prepare the strides for the buffer_info.
622436c6c9cSStella Laurenzo     SmallVector<intptr_t, 4> strides;
623436c6c9cSStella Laurenzo     intptr_t strideFactor = 1;
624436c6c9cSStella Laurenzo     for (intptr_t i = 1; i < rank; ++i) {
625436c6c9cSStella Laurenzo       strideFactor = 1;
626436c6c9cSStella Laurenzo       for (intptr_t j = i; j < rank; ++j) {
627436c6c9cSStella Laurenzo         strideFactor *= mlirShapedTypeGetDimSize(shapedType, j);
628436c6c9cSStella Laurenzo       }
629436c6c9cSStella Laurenzo       strides.push_back(sizeof(Type) * strideFactor);
630436c6c9cSStella Laurenzo     }
631436c6c9cSStella Laurenzo     strides.push_back(sizeof(Type));
6325d6d30edSStella Laurenzo     std::string format;
6335d6d30edSStella Laurenzo     if (explicitFormat) {
6345d6d30edSStella Laurenzo       format = explicitFormat;
6355d6d30edSStella Laurenzo     } else {
6365d6d30edSStella Laurenzo       format = py::format_descriptor<Type>::format();
6375d6d30edSStella Laurenzo     }
6385d6d30edSStella Laurenzo     return py::buffer_info(data, sizeof(Type), format, rank, shape, strides,
6395d6d30edSStella Laurenzo                            /*readonly=*/true);
640436c6c9cSStella Laurenzo   }
641436c6c9cSStella Laurenzo }; // namespace
642436c6c9cSStella Laurenzo 
643436c6c9cSStella Laurenzo /// Refinement of the PyDenseElementsAttribute for attributes containing integer
644436c6c9cSStella Laurenzo /// (and boolean) values. Supports element access.
645436c6c9cSStella Laurenzo class PyDenseIntElementsAttribute
646436c6c9cSStella Laurenzo     : public PyConcreteAttribute<PyDenseIntElementsAttribute,
647436c6c9cSStella Laurenzo                                  PyDenseElementsAttribute> {
648436c6c9cSStella Laurenzo public:
649436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsADenseIntElements;
650436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "DenseIntElementsAttr";
651436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
652436c6c9cSStella Laurenzo 
653436c6c9cSStella Laurenzo   /// Returns the element at the given linear position. Asserts if the index is
654436c6c9cSStella Laurenzo   /// out of range.
655436c6c9cSStella Laurenzo   py::int_ dunderGetItem(intptr_t pos) {
656436c6c9cSStella Laurenzo     if (pos < 0 || pos >= dunderLen()) {
657436c6c9cSStella Laurenzo       throw SetPyError(PyExc_IndexError,
658436c6c9cSStella Laurenzo                        "attempt to access out of bounds element");
659436c6c9cSStella Laurenzo     }
660436c6c9cSStella Laurenzo 
661436c6c9cSStella Laurenzo     MlirType type = mlirAttributeGetType(*this);
662436c6c9cSStella Laurenzo     type = mlirShapedTypeGetElementType(type);
663436c6c9cSStella Laurenzo     assert(mlirTypeIsAInteger(type) &&
664436c6c9cSStella Laurenzo            "expected integer element type in dense int elements attribute");
665436c6c9cSStella Laurenzo     // Dispatch element extraction to an appropriate C function based on the
666436c6c9cSStella Laurenzo     // elemental type of the attribute. py::int_ is implicitly constructible
667436c6c9cSStella Laurenzo     // from any C++ integral type and handles bitwidth correctly.
668436c6c9cSStella Laurenzo     // TODO: consider caching the type properties in the constructor to avoid
669436c6c9cSStella Laurenzo     // querying them on each element access.
670436c6c9cSStella Laurenzo     unsigned width = mlirIntegerTypeGetWidth(type);
671436c6c9cSStella Laurenzo     bool isUnsigned = mlirIntegerTypeIsUnsigned(type);
672436c6c9cSStella Laurenzo     if (isUnsigned) {
673436c6c9cSStella Laurenzo       if (width == 1) {
674436c6c9cSStella Laurenzo         return mlirDenseElementsAttrGetBoolValue(*this, pos);
675436c6c9cSStella Laurenzo       }
676*308d8b8cSRahul Kayaith       if (width == 8) {
677*308d8b8cSRahul Kayaith         return mlirDenseElementsAttrGetUInt8Value(*this, pos);
678*308d8b8cSRahul Kayaith       }
679*308d8b8cSRahul Kayaith       if (width == 16) {
680*308d8b8cSRahul Kayaith         return mlirDenseElementsAttrGetUInt16Value(*this, pos);
681*308d8b8cSRahul Kayaith       }
682436c6c9cSStella Laurenzo       if (width == 32) {
683436c6c9cSStella Laurenzo         return mlirDenseElementsAttrGetUInt32Value(*this, pos);
684436c6c9cSStella Laurenzo       }
685436c6c9cSStella Laurenzo       if (width == 64) {
686436c6c9cSStella Laurenzo         return mlirDenseElementsAttrGetUInt64Value(*this, pos);
687436c6c9cSStella Laurenzo       }
688436c6c9cSStella Laurenzo     } else {
689436c6c9cSStella Laurenzo       if (width == 1) {
690436c6c9cSStella Laurenzo         return mlirDenseElementsAttrGetBoolValue(*this, pos);
691436c6c9cSStella Laurenzo       }
692*308d8b8cSRahul Kayaith       if (width == 8) {
693*308d8b8cSRahul Kayaith         return mlirDenseElementsAttrGetInt8Value(*this, pos);
694*308d8b8cSRahul Kayaith       }
695*308d8b8cSRahul Kayaith       if (width == 16) {
696*308d8b8cSRahul Kayaith         return mlirDenseElementsAttrGetInt16Value(*this, pos);
697*308d8b8cSRahul Kayaith       }
698436c6c9cSStella Laurenzo       if (width == 32) {
699436c6c9cSStella Laurenzo         return mlirDenseElementsAttrGetInt32Value(*this, pos);
700436c6c9cSStella Laurenzo       }
701436c6c9cSStella Laurenzo       if (width == 64) {
702436c6c9cSStella Laurenzo         return mlirDenseElementsAttrGetInt64Value(*this, pos);
703436c6c9cSStella Laurenzo       }
704436c6c9cSStella Laurenzo     }
705436c6c9cSStella Laurenzo     throw SetPyError(PyExc_TypeError, "Unsupported integer type");
706436c6c9cSStella Laurenzo   }
707436c6c9cSStella Laurenzo 
708436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
709436c6c9cSStella Laurenzo     c.def("__getitem__", &PyDenseIntElementsAttribute::dunderGetItem);
710436c6c9cSStella Laurenzo   }
711436c6c9cSStella Laurenzo };
712436c6c9cSStella Laurenzo 
713436c6c9cSStella Laurenzo class PyDictAttribute : public PyConcreteAttribute<PyDictAttribute> {
714436c6c9cSStella Laurenzo public:
715436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsADictionary;
716436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "DictAttr";
717436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
718436c6c9cSStella Laurenzo 
719436c6c9cSStella Laurenzo   intptr_t dunderLen() { return mlirDictionaryAttrGetNumElements(*this); }
720436c6c9cSStella Laurenzo 
7219fb1086bSAdrian Kuegel   bool dunderContains(const std::string &name) {
7229fb1086bSAdrian Kuegel     return !mlirAttributeIsNull(
7239fb1086bSAdrian Kuegel         mlirDictionaryAttrGetElementByName(*this, toMlirStringRef(name)));
7249fb1086bSAdrian Kuegel   }
7259fb1086bSAdrian Kuegel 
726436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
7279fb1086bSAdrian Kuegel     c.def("__contains__", &PyDictAttribute::dunderContains);
728436c6c9cSStella Laurenzo     c.def("__len__", &PyDictAttribute::dunderLen);
729436c6c9cSStella Laurenzo     c.def_static(
730436c6c9cSStella Laurenzo         "get",
731436c6c9cSStella Laurenzo         [](py::dict attributes, DefaultingPyMlirContext context) {
732436c6c9cSStella Laurenzo           SmallVector<MlirNamedAttribute> mlirNamedAttributes;
733436c6c9cSStella Laurenzo           mlirNamedAttributes.reserve(attributes.size());
734436c6c9cSStella Laurenzo           for (auto &it : attributes) {
73502b6fb21SMehdi Amini             auto &mlirAttr = it.second.cast<PyAttribute &>();
736436c6c9cSStella Laurenzo             auto name = it.first.cast<std::string>();
737436c6c9cSStella Laurenzo             mlirNamedAttributes.push_back(mlirNamedAttributeGet(
73802b6fb21SMehdi Amini                 mlirIdentifierGet(mlirAttributeGetContext(mlirAttr),
739436c6c9cSStella Laurenzo                                   toMlirStringRef(name)),
74002b6fb21SMehdi Amini                 mlirAttr));
741436c6c9cSStella Laurenzo           }
742436c6c9cSStella Laurenzo           MlirAttribute attr =
743436c6c9cSStella Laurenzo               mlirDictionaryAttrGet(context->get(), mlirNamedAttributes.size(),
744436c6c9cSStella Laurenzo                                     mlirNamedAttributes.data());
745436c6c9cSStella Laurenzo           return PyDictAttribute(context->getRef(), attr);
746436c6c9cSStella Laurenzo         },
747ed9e52f3SAlex Zinenko         py::arg("value") = py::dict(), py::arg("context") = py::none(),
748436c6c9cSStella Laurenzo         "Gets an uniqued dict attribute");
749436c6c9cSStella Laurenzo     c.def("__getitem__", [](PyDictAttribute &self, const std::string &name) {
750436c6c9cSStella Laurenzo       MlirAttribute attr =
751436c6c9cSStella Laurenzo           mlirDictionaryAttrGetElementByName(self, toMlirStringRef(name));
752436c6c9cSStella Laurenzo       if (mlirAttributeIsNull(attr)) {
753436c6c9cSStella Laurenzo         throw SetPyError(PyExc_KeyError,
754436c6c9cSStella Laurenzo                          "attempt to access a non-existent attribute");
755436c6c9cSStella Laurenzo       }
756436c6c9cSStella Laurenzo       return PyAttribute(self.getContext(), attr);
757436c6c9cSStella Laurenzo     });
758436c6c9cSStella Laurenzo     c.def("__getitem__", [](PyDictAttribute &self, intptr_t index) {
759436c6c9cSStella Laurenzo       if (index < 0 || index >= self.dunderLen()) {
760436c6c9cSStella Laurenzo         throw SetPyError(PyExc_IndexError,
761436c6c9cSStella Laurenzo                          "attempt to access out of bounds attribute");
762436c6c9cSStella Laurenzo       }
763436c6c9cSStella Laurenzo       MlirNamedAttribute namedAttr = mlirDictionaryAttrGetElement(self, index);
764436c6c9cSStella Laurenzo       return PyNamedAttribute(
765436c6c9cSStella Laurenzo           namedAttr.attribute,
766436c6c9cSStella Laurenzo           std::string(mlirIdentifierStr(namedAttr.name).data));
767436c6c9cSStella Laurenzo     });
768436c6c9cSStella Laurenzo   }
769436c6c9cSStella Laurenzo };
770436c6c9cSStella Laurenzo 
771436c6c9cSStella Laurenzo /// Refinement of PyDenseElementsAttribute for attributes containing
772436c6c9cSStella Laurenzo /// floating-point values. Supports element access.
773436c6c9cSStella Laurenzo class PyDenseFPElementsAttribute
774436c6c9cSStella Laurenzo     : public PyConcreteAttribute<PyDenseFPElementsAttribute,
775436c6c9cSStella Laurenzo                                  PyDenseElementsAttribute> {
776436c6c9cSStella Laurenzo public:
777436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsADenseFPElements;
778436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "DenseFPElementsAttr";
779436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
780436c6c9cSStella Laurenzo 
781436c6c9cSStella Laurenzo   py::float_ dunderGetItem(intptr_t pos) {
782436c6c9cSStella Laurenzo     if (pos < 0 || pos >= dunderLen()) {
783436c6c9cSStella Laurenzo       throw SetPyError(PyExc_IndexError,
784436c6c9cSStella Laurenzo                        "attempt to access out of bounds element");
785436c6c9cSStella Laurenzo     }
786436c6c9cSStella Laurenzo 
787436c6c9cSStella Laurenzo     MlirType type = mlirAttributeGetType(*this);
788436c6c9cSStella Laurenzo     type = mlirShapedTypeGetElementType(type);
789436c6c9cSStella Laurenzo     // Dispatch element extraction to an appropriate C function based on the
790436c6c9cSStella Laurenzo     // elemental type of the attribute. py::float_ is implicitly constructible
791436c6c9cSStella Laurenzo     // from float and double.
792436c6c9cSStella Laurenzo     // TODO: consider caching the type properties in the constructor to avoid
793436c6c9cSStella Laurenzo     // querying them on each element access.
794436c6c9cSStella Laurenzo     if (mlirTypeIsAF32(type)) {
795436c6c9cSStella Laurenzo       return mlirDenseElementsAttrGetFloatValue(*this, pos);
796436c6c9cSStella Laurenzo     }
797436c6c9cSStella Laurenzo     if (mlirTypeIsAF64(type)) {
798436c6c9cSStella Laurenzo       return mlirDenseElementsAttrGetDoubleValue(*this, pos);
799436c6c9cSStella Laurenzo     }
800436c6c9cSStella Laurenzo     throw SetPyError(PyExc_TypeError, "Unsupported floating-point type");
801436c6c9cSStella Laurenzo   }
802436c6c9cSStella Laurenzo 
803436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
804436c6c9cSStella Laurenzo     c.def("__getitem__", &PyDenseFPElementsAttribute::dunderGetItem);
805436c6c9cSStella Laurenzo   }
806436c6c9cSStella Laurenzo };
807436c6c9cSStella Laurenzo 
808436c6c9cSStella Laurenzo class PyTypeAttribute : public PyConcreteAttribute<PyTypeAttribute> {
809436c6c9cSStella Laurenzo public:
810436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsAType;
811436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "TypeAttr";
812436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
813436c6c9cSStella Laurenzo 
814436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
815436c6c9cSStella Laurenzo     c.def_static(
816436c6c9cSStella Laurenzo         "get",
817436c6c9cSStella Laurenzo         [](PyType value, DefaultingPyMlirContext context) {
818436c6c9cSStella Laurenzo           MlirAttribute attr = mlirTypeAttrGet(value.get());
819436c6c9cSStella Laurenzo           return PyTypeAttribute(context->getRef(), attr);
820436c6c9cSStella Laurenzo         },
821436c6c9cSStella Laurenzo         py::arg("value"), py::arg("context") = py::none(),
822436c6c9cSStella Laurenzo         "Gets a uniqued Type attribute");
823436c6c9cSStella Laurenzo     c.def_property_readonly("value", [](PyTypeAttribute &self) {
824436c6c9cSStella Laurenzo       return PyType(self.getContext()->getRef(),
825436c6c9cSStella Laurenzo                     mlirTypeAttrGetValue(self.get()));
826436c6c9cSStella Laurenzo     });
827436c6c9cSStella Laurenzo   }
828436c6c9cSStella Laurenzo };
829436c6c9cSStella Laurenzo 
830436c6c9cSStella Laurenzo /// Unit Attribute subclass. Unit attributes don't have values.
831436c6c9cSStella Laurenzo class PyUnitAttribute : public PyConcreteAttribute<PyUnitAttribute> {
832436c6c9cSStella Laurenzo public:
833436c6c9cSStella Laurenzo   static constexpr IsAFunctionTy isaFunction = mlirAttributeIsAUnit;
834436c6c9cSStella Laurenzo   static constexpr const char *pyClassName = "UnitAttr";
835436c6c9cSStella Laurenzo   using PyConcreteAttribute::PyConcreteAttribute;
836436c6c9cSStella Laurenzo 
837436c6c9cSStella Laurenzo   static void bindDerived(ClassTy &c) {
838436c6c9cSStella Laurenzo     c.def_static(
839436c6c9cSStella Laurenzo         "get",
840436c6c9cSStella Laurenzo         [](DefaultingPyMlirContext context) {
841436c6c9cSStella Laurenzo           return PyUnitAttribute(context->getRef(),
842436c6c9cSStella Laurenzo                                  mlirUnitAttrGet(context->get()));
843436c6c9cSStella Laurenzo         },
844436c6c9cSStella Laurenzo         py::arg("context") = py::none(), "Create a Unit attribute.");
845436c6c9cSStella Laurenzo   }
846436c6c9cSStella Laurenzo };
847436c6c9cSStella Laurenzo 
848436c6c9cSStella Laurenzo } // namespace
849436c6c9cSStella Laurenzo 
850436c6c9cSStella Laurenzo void mlir::python::populateIRAttributes(py::module &m) {
851436c6c9cSStella Laurenzo   PyAffineMapAttribute::bind(m);
852436c6c9cSStella Laurenzo   PyArrayAttribute::bind(m);
853436c6c9cSStella Laurenzo   PyArrayAttribute::PyArrayAttributeIterator::bind(m);
854436c6c9cSStella Laurenzo   PyBoolAttribute::bind(m);
855436c6c9cSStella Laurenzo   PyDenseElementsAttribute::bind(m);
856436c6c9cSStella Laurenzo   PyDenseFPElementsAttribute::bind(m);
857436c6c9cSStella Laurenzo   PyDenseIntElementsAttribute::bind(m);
858436c6c9cSStella Laurenzo   PyDictAttribute::bind(m);
859436c6c9cSStella Laurenzo   PyFlatSymbolRefAttribute::bind(m);
860436c6c9cSStella Laurenzo   PyFloatAttribute::bind(m);
861436c6c9cSStella Laurenzo   PyIntegerAttribute::bind(m);
862436c6c9cSStella Laurenzo   PyStringAttribute::bind(m);
863436c6c9cSStella Laurenzo   PyTypeAttribute::bind(m);
864436c6c9cSStella Laurenzo   PyUnitAttribute::bind(m);
865436c6c9cSStella Laurenzo }
866