Loading [MathJax]/extensions/tex2jax.js
CIRCT 22.0.0git
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
RTGModule.cpp
Go to the documentation of this file.
1//===- RTGModule.cpp - RTG API nanobind 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#include "CIRCTModules.h"
10
11#include "circt-c/Dialect/RTG.h"
12
13#include "mlir/Bindings/Python/NanobindAdaptors.h"
14
15#include <nanobind/nanobind.h>
16
17namespace nb = nanobind;
18
19using namespace circt;
20using namespace mlir::python::nanobind_adaptors;
21
22/// Populate the rtg python module.
24 m.doc() = "RTG dialect Python native extension";
25
26 //===--------------------------------------------------------------------===//
27 // Types
28 //===--------------------------------------------------------------------===//
29
30 // Sequence Types
31 //===--------------------------------------------------------------------===//
32
33 mlir_type_subclass(m, "SequenceType", rtgTypeIsASequence)
34 .def_classmethod(
35 "get",
36 [](nb::object cls, std::vector<MlirType> &elementTypes,
37 MlirContext ctxt) {
38 return cls(rtgSequenceTypeGet(ctxt, elementTypes.size(),
39 elementTypes.data()));
40 },
41 nb::arg("self"), nb::arg("elementTypes") = std::vector<MlirType>(),
42 nb::arg("ctxt") = nullptr)
43 .def_property_readonly(
44 "num_elements",
45 [](MlirType self) { return rtgSequenceTypeGetNumElements(self); })
46 .def("get_element", [](MlirType self, unsigned i) {
47 return rtgSequenceTypeGetElement(self, i);
48 });
49
50 mlir_type_subclass(m, "RandomizedSequenceType", rtgTypeIsARandomizedSequence)
51 .def_classmethod(
52 "get",
53 [](nb::object cls, MlirContext ctxt) {
54 return cls(rtgRandomizedSequenceTypeGet(ctxt));
55 },
56 nb::arg("self"), nb::arg("ctxt") = nullptr);
57
58 // Common Datastructure Types
59 //===--------------------------------------------------------------------===//
60
61 mlir_type_subclass(m, "SetType", rtgTypeIsASet)
62 .def_classmethod(
63 "get",
64 [](nb::object cls, MlirType elementType) {
65 return cls(rtgSetTypeGet(elementType));
66 },
67 nb::arg("self"), nb::arg("element_type"))
68 .def_property_readonly("element_type", [](MlirType self) {
69 return rtgSetTypeGetElementType(self);
70 });
71
72 mlir_type_subclass(m, "BagType", rtgTypeIsABag)
73 .def_classmethod(
74 "get",
75 [](nb::object cls, MlirType elementType) {
76 return cls(rtgBagTypeGet(elementType));
77 },
78 nb::arg("self"), nb::arg("element_type"))
79 .def_property_readonly("element_type", [](MlirType self) {
80 return rtgBagTypeGetElementType(self);
81 });
82
83 mlir_type_subclass(m, "DictType", rtgTypeIsADict)
84 .def_classmethod(
85 "get",
86 [](nb::object cls,
87 const std::vector<std::pair<MlirAttribute, MlirType>> &entries,
88 MlirContext ctxt) {
89 std::vector<MlirAttribute> names;
90 std::vector<MlirType> types;
91 for (auto entry : entries) {
92 names.push_back(entry.first);
93 types.push_back(entry.second);
94 }
95 return cls(
96 rtgDictTypeGet(ctxt, types.size(), names.data(), types.data()));
97 },
98 nb::arg("self"),
99 nb::arg("entries") =
100 std::vector<std::pair<MlirAttribute, MlirType>>(),
101 nb::arg("ctxt") = nullptr);
102
103 mlir_type_subclass(m, "ArrayType", rtgTypeIsAArray)
104 .def_classmethod(
105 "get",
106 [](nb::object cls, MlirType elementType, MlirContext ctxt) {
107 return cls(rtgArrayTypeGet(elementType));
108 },
109 nb::arg("self"), nb::arg("element_type"), nb::arg("ctxt") = nullptr)
110 .def_property_readonly("element_type", [](MlirType self) {
111 return rtgArrayTypeGetElementType(self);
112 });
113
114 mlir_type_subclass(m, "TupleType", rtgTypeIsATuple)
115 .def_classmethod(
116 "get",
117 [](nb::object cls, const std::vector<MlirType> &fieldTypes,
118 MlirContext ctxt) {
119 return cls(
120 rtgTupleTypeGet(ctxt, fieldTypes.size(), fieldTypes.data()));
121 },
122 nb::arg("self"), nb::arg("field_types") = std::vector<MlirType>(),
123 nb::arg("ctxt") = nullptr)
124 .def_property_readonly("fields", [](MlirType self) {
125 std::vector<MlirType> fields;
126 for (intptr_t i = 0; i < rtgTypeGetNumFields(self); ++i)
127 fields.push_back(rtgTupleTypeGetFieldType(self, i));
128 return fields;
129 });
130
131 // Types for ISA targets
132 //===--------------------------------------------------------------------===//
133
134 mlir_type_subclass(m, "LabelType", rtgTypeIsALabel)
135 .def_classmethod(
136 "get",
137 [](nb::object cls, MlirContext ctxt) {
138 return cls(rtgLabelTypeGet(ctxt));
139 },
140 nb::arg("self"), nb::arg("ctxt") = nullptr);
141
142 mlir_type_subclass(m, "ImmediateType", rtgTypeIsAImmediate)
143 .def_classmethod(
144 "get",
145 [](nb::object cls, uint32_t width, MlirContext ctx) {
146 return cls(rtgImmediateTypeGet(ctx, width));
147 },
148 nb::arg("self"), nb::arg("width"), nb::arg("ctx") = nullptr)
149 .def_property_readonly("width", [](MlirType self) {
150 return rtgImmediateTypeGetWidth(self);
151 });
152
153 mlir_type_subclass(m, "MemoryBlockType", rtgTypeIsAMemoryBlock)
154 .def_classmethod(
155 "get",
156 [](nb::object cls, uint32_t addressWidth, MlirContext ctxt) {
157 return cls(rtgMemoryBlockTypeGet(ctxt, addressWidth));
158 },
159 nb::arg("self"), nb::arg("address_width"), nb::arg("ctxt") = nullptr)
160 .def_property_readonly("address_width", [](MlirType self) {
162 });
163
164 mlir_type_subclass(m, "MemoryType", rtgTypeIsAMemory)
165 .def_classmethod(
166 "get",
167 [](nb::object cls, uint32_t addressWidth, MlirContext ctxt) {
168 return cls(rtgMemoryTypeGet(ctxt, addressWidth));
169 },
170 nb::arg("self"), nb::arg("address_width"), nb::arg("ctxt") = nullptr)
171 .def_property_readonly("address_width", [](MlirType self) {
172 return rtgMemoryTypeGetAddressWidth(self);
173 });
174
175 //===--------------------------------------------------------------------===//
176 // Attributes
177 //===--------------------------------------------------------------------===//
178
179 mlir_attribute_subclass(m, "DefaultContextAttr", rtgAttrIsADefaultContextAttr)
180 .def_classmethod(
181 "get",
182 [](nb::object cls, MlirType type, MlirContext ctxt) {
183 return cls(rtgDefaultContextAttrGet(ctxt, type));
184 },
185 nb::arg("self"), nb::arg("type"), nb::arg("ctxt") = nullptr);
186
187 mlir_attribute_subclass(m, "AnyContextAttr", rtgAttrIsAAnyContextAttr)
188 .def_classmethod(
189 "get",
190 [](nb::object cls, MlirType type, MlirContext ctxt) {
191 return cls(rtgAnyContextAttrGet(ctxt, type));
192 },
193 nb::arg("self"), nb::arg("type"), nb::arg("ctxt") = nullptr);
194
195 // Attributes for ISA targets
196 //===--------------------------------------------------------------------===//
197
198 nb::enum_<RTGLabelVisibility>(m, "LabelVisibility")
199 .value("LOCAL", RTG_LABEL_VISIBILITY_LOCAL)
200 .value("GLOBAL", RTG_LABEL_VISIBILITY_GLOBAL)
201 .value("EXTERNAL", RTG_LABEL_VISIBILITY_EXTERNAL)
202 .export_values();
203
204 mlir_attribute_subclass(m, "LabelVisibilityAttr",
206 .def_classmethod(
207 "get",
208 [](nb::object cls, RTGLabelVisibility visibility, MlirContext ctxt) {
209 return cls(rtgLabelVisibilityAttrGet(ctxt, visibility));
210 },
211 nb::arg("self"), nb::arg("visibility"), nb::arg("ctxt") = nullptr)
212 .def_property_readonly("value", [](MlirAttribute self) {
214 });
215
216 mlir_attribute_subclass(m, "ImmediateAttr", rtgAttrIsAImmediate)
217 .def_classmethod(
218 "get",
219 [](nb::object cls, uint32_t width, uint64_t value, MlirContext ctx) {
220 return cls(rtgImmediateAttrGet(ctx, width, value));
221 },
222 nb::arg("self"), nb::arg("width"), nb::arg("value"),
223 nb::arg("ctx") = nullptr)
224 .def_property_readonly(
225 "width",
226 [](MlirAttribute self) { return rtgImmediateAttrGetWidth(self); })
227 .def_property_readonly("value", [](MlirAttribute self) {
228 return rtgImmediateAttrGetValue(self);
229 });
230}
MlirType elementType
Definition CHIRRTL.cpp:29
MLIR_CAPI_EXPORTED MlirAttribute rtgAnyContextAttrGet(MlirContext ctxt, MlirType type)
Creates an RTG any context attribute in the context.
Definition RTG.cpp:283
MLIR_CAPI_EXPORTED bool rtgTypeIsAMemory(MlirType type)
If the type is an RTG memory.
Definition RTG.cpp:180
MLIR_CAPI_EXPORTED bool rtgAttrIsAAnyContextAttr(MlirAttribute attr)
If the attribute is an RTG any context attribute.
Definition RTG.cpp:279
MLIR_CAPI_EXPORTED MlirType rtgLabelTypeGet(MlirContext ctxt)
Creates an RTG mode type in the context.
Definition RTG.cpp:75
MLIR_CAPI_EXPORTED RTGLabelVisibility rtgLabelVisibilityAttrGetValue(MlirAttribute attr)
Get the RTG label visibility from the attribute.
Definition RTG.cpp:227
MLIR_CAPI_EXPORTED uint32_t rtgImmediateAttrGetWidth(MlirAttribute attr)
Returns the width of the RTG immediate attribute.
Definition RTG.cpp:268
RTGLabelVisibility
Definition RTG.h:141
@ RTG_LABEL_VISIBILITY_EXTERNAL
Definition RTG.h:144
@ RTG_LABEL_VISIBILITY_GLOBAL
Definition RTG.h:143
@ RTG_LABEL_VISIBILITY_LOCAL
Definition RTG.h:142
MLIR_CAPI_EXPORTED MlirType rtgSequenceTypeGetElement(MlirType type, unsigned i)
The type of of the substitution element at the given index.
Definition RTG.cpp:55
MLIR_CAPI_EXPORTED MlirAttribute rtgDefaultContextAttrGet(MlirContext ctxt, MlirType type)
Creates an RTG default context attribute in the context.
Definition RTG.cpp:216
MLIR_CAPI_EXPORTED MlirType rtgImmediateTypeGet(MlirContext ctx, uint32_t width)
Creates an RTG immediate type in the context.
Definition RTG.cpp:169
MLIR_CAPI_EXPORTED uint32_t rtgMemoryTypeGetAddressWidth(MlirType type)
Returns the address with of an RTG memory type.
Definition RTG.cpp:186
MLIR_CAPI_EXPORTED bool rtgTypeIsAArray(MlirType type)
If the type is an RTG array.
Definition RTG.cpp:133
MLIR_CAPI_EXPORTED bool rtgAttrIsALabelVisibilityAttr(MlirAttribute attr)
If the attribute is an RTG label visibility.
Definition RTG.cpp:223
MLIR_CAPI_EXPORTED intptr_t rtgTypeGetNumFields(MlirType type)
Returns the number of fields in the RTG tuple.
Definition RTG.cpp:154
MLIR_CAPI_EXPORTED MlirAttribute rtgLabelVisibilityAttrGet(MlirContext ctxt, RTGLabelVisibility visibility)
Creates an RTG label visibility attribute in the context.
Definition RTG.cpp:241
MLIR_CAPI_EXPORTED MlirType rtgArrayTypeGetElementType(MlirType type)
Returns the element type of the RTG array.
Definition RTG.cpp:135
MLIR_CAPI_EXPORTED bool rtgTypeIsATuple(MlirType type)
If the type is an RTG tuple.
Definition RTG.cpp:150
MLIR_CAPI_EXPORTED bool rtgTypeIsABag(MlirType type)
If the type is an RTG bag.
Definition RTG.cpp:96
MLIR_CAPI_EXPORTED MlirType rtgSequenceTypeGet(MlirContext ctxt, intptr_t numElements, MlirType const *elementTypes)
Creates an RTG sequence type in the context.
Definition RTG.cpp:43
MLIR_CAPI_EXPORTED MlirAttribute rtgImmediateAttrGet(MlirContext ctx, uint32_t width, uint64_t value)
Creates an RTG immediate attribute in the context with the given width and value.
Definition RTG.cpp:263
MLIR_CAPI_EXPORTED unsigned rtgSequenceTypeGetNumElements(MlirType type)
The number of substitution elements of the RTG sequence.
Definition RTG.cpp:51
MLIR_CAPI_EXPORTED MlirType rtgSetTypeGet(MlirType elementType)
Creates an RTG set type in the context.
Definition RTG.cpp:84
MLIR_CAPI_EXPORTED bool rtgTypeIsASet(MlirType type)
If the type is an RTG set.
Definition RTG.cpp:82
MLIR_CAPI_EXPORTED MlirType rtgTupleTypeGet(MlirContext ctxt, intptr_t numFields, MlirType const *fieldTypes)
Creates an RTG tuple type in the context.
Definition RTG.cpp:142
MLIR_CAPI_EXPORTED MlirType rtgMemoryTypeGet(MlirContext ctx, uint32_t addressWidth)
Creates an RTG memory type in the context.
Definition RTG.cpp:182
MLIR_CAPI_EXPORTED MlirType rtgRandomizedSequenceTypeGet(MlirContext ctxt)
Creates an RTG randomized sequence type in the context.
Definition RTG.cpp:66
MLIR_CAPI_EXPORTED uint64_t rtgImmediateAttrGetValue(MlirAttribute attr)
Returns the value of the RTG immediate attribute.
Definition RTG.cpp:272
MLIR_CAPI_EXPORTED bool rtgTypeIsAMemoryBlock(MlirType type)
If the type is an RTG memory block.
Definition RTG.cpp:193
MLIR_CAPI_EXPORTED bool rtgAttrIsAImmediate(MlirAttribute attr)
Checks if the attribute is an RTG immediate attribute.
Definition RTG.cpp:259
MLIR_CAPI_EXPORTED bool rtgTypeIsARandomizedSequence(MlirType type)
If the type is an RTG randomized sequence.
Definition RTG.cpp:62
MLIR_CAPI_EXPORTED bool rtgTypeIsADict(MlirType type)
If the type is an RTG dict.
Definition RTG.cpp:110
MLIR_CAPI_EXPORTED MlirType rtgTupleTypeGetFieldType(MlirType type, intptr_t idx)
Returns a field type of the RTG tuple.
Definition RTG.cpp:158
MLIR_CAPI_EXPORTED bool rtgTypeIsAImmediate(MlirType type)
If the type is an RTG immediate.
Definition RTG.cpp:165
MLIR_CAPI_EXPORTED MlirType rtgDictTypeGet(MlirContext ctxt, intptr_t numEntries, MlirAttribute const *entryNames, MlirType const *entryTypes)
Creates an RTG dict type in the context.
Definition RTG.cpp:112
MLIR_CAPI_EXPORTED MlirType rtgBagTypeGet(MlirType elementType)
Creates an RTG bag type in the context.
Definition RTG.cpp:98
MLIR_CAPI_EXPORTED uint32_t rtgMemoryBlockTypeGetAddressWidth(MlirType type)
Returns the address with of an RTG memory block type.
Definition RTG.cpp:201
MLIR_CAPI_EXPORTED MlirType rtgArrayTypeGet(MlirType elementType)
Creates an RTG array type in the context.
Definition RTG.cpp:128
MLIR_CAPI_EXPORTED MlirType rtgBagTypeGetElementType(MlirType type)
Return the element type of the RTG bag.
Definition RTG.cpp:103
MLIR_CAPI_EXPORTED bool rtgTypeIsASequence(MlirType type)
If the type is an RTG sequence.
Definition RTG.cpp:39
MLIR_CAPI_EXPORTED bool rtgTypeIsALabel(MlirType type)
If the type is an RTG label.
Definition RTG.cpp:73
MLIR_CAPI_EXPORTED uint32_t rtgImmediateTypeGetWidth(MlirType type)
Returns the width of the RTG immediate type.
Definition RTG.cpp:173
MLIR_CAPI_EXPORTED MlirType rtgMemoryBlockTypeGet(MlirContext ctx, uint32_t addressWidth)
Creates an RTG memory block type in the context.
Definition RTG.cpp:197
MLIR_CAPI_EXPORTED MlirType rtgSetTypeGetElementType(MlirType type)
Return the element type of the RTG set.
Definition RTG.cpp:89
MLIR_CAPI_EXPORTED bool rtgAttrIsADefaultContextAttr(MlirAttribute attr)
If the attribute is an RTG default context.
Definition RTG.cpp:212
void populateDialectRTGSubmodule(nanobind::module_ &m)
The InstanceGraph op interface, see InstanceGraphInterface.td for more details.