Loading [MathJax]/extensions/tex2jax.js
CIRCT 21.0.0git
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CIRCTModule.cpp
Go to the documentation of this file.
1//===- CIRCTModule.cpp - Main 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/Conversion.h"
12#include "circt-c/Dialect/AIG.h"
13#include "circt-c/Dialect/Arc.h"
15#include "circt-c/Dialect/DC.h"
17#include "circt-c/Dialect/ESI.h"
19#include "circt-c/Dialect/FSM.h"
20#include "circt-c/Dialect/HW.h"
24#include "circt-c/Dialect/LTL.h"
26#include "circt-c/Dialect/OM.h"
28#include "circt-c/Dialect/RTG.h"
29#include "circt-c/Transforms.h"
30#ifdef CIRCT_INCLUDE_TESTS
32#endif
33#include "circt-c/Dialect/SV.h"
34#include "circt-c/Dialect/Seq.h"
37#include "mlir-c/Bindings/Python/Interop.h"
38#include "mlir-c/Dialect/Index.h"
39#include "mlir-c/Dialect/SCF.h"
40#include "mlir-c/Dialect/SMT.h"
41#include "mlir-c/IR.h"
42#include "mlir-c/Transforms.h"
43#include "mlir/Bindings/Python/NanobindAdaptors.h"
44
45#include "llvm-c/ErrorHandling.h"
46#include "llvm/Support/Signals.h"
47
48#include "NanobindUtils.h"
49#include <nanobind/nanobind.h>
50namespace nb = nanobind;
51
52static void registerPasses() {
66 mlirRegisterCIRCTConversionPasses();
67 mlirRegisterCIRCTTransformsPasses();
68 mlirRegisterTransformsCSE();
69}
70
71NB_MODULE(_circt, m) {
72 m.doc() = "CIRCT Python Native Extension";
74 llvm::sys::PrintStackTraceOnErrorSignal(/*argv=*/"");
75 LLVMEnablePrettyStackTrace();
76
77 m.def(
78 "register_dialects",
79 [](nb::object capsule) {
80 // Get the MlirContext capsule from PyMlirContext capsule.
81 auto wrappedCapsule = capsule.attr(MLIR_PYTHON_CAPI_PTR_ATTR);
82 MlirContext context = mlirPythonCapsuleToContext(wrappedCapsule.ptr());
83
84 // Collect CIRCT dialects to register.
85 MlirDialectHandle aig = mlirGetDialectHandle__aig__();
86 mlirDialectHandleRegisterDialect(aig, context);
87 mlirDialectHandleLoadDialect(aig, context);
88
89 MlirDialectHandle comb = mlirGetDialectHandle__comb__();
90 mlirDialectHandleRegisterDialect(comb, context);
91 mlirDialectHandleLoadDialect(comb, context);
92
93 MlirDialectHandle debug = mlirGetDialectHandle__debug__();
94 mlirDialectHandleRegisterDialect(debug, context);
95 mlirDialectHandleLoadDialect(debug, context);
96
97 MlirDialectHandle emit = mlirGetDialectHandle__emit__();
98 mlirDialectHandleRegisterDialect(emit, context);
99 mlirDialectHandleLoadDialect(emit, context);
100
101 MlirDialectHandle esi = mlirGetDialectHandle__esi__();
102 mlirDialectHandleRegisterDialect(esi, context);
103 mlirDialectHandleLoadDialect(esi, context);
104
105 MlirDialectHandle msft = mlirGetDialectHandle__msft__();
106 mlirDialectHandleRegisterDialect(msft, context);
107 mlirDialectHandleLoadDialect(msft, context);
108
109 MlirDialectHandle hw = mlirGetDialectHandle__hw__();
110 mlirDialectHandleRegisterDialect(hw, context);
111 mlirDialectHandleLoadDialect(hw, context);
112
113 MlirDialectHandle hwarith = mlirGetDialectHandle__hwarith__();
114 mlirDialectHandleRegisterDialect(hwarith, context);
115 mlirDialectHandleLoadDialect(hwarith, context);
116
117 MlirDialectHandle index = mlirGetDialectHandle__index__();
118 mlirDialectHandleRegisterDialect(index, context);
119 mlirDialectHandleLoadDialect(index, context);
120
121 MlirDialectHandle scf = mlirGetDialectHandle__scf__();
122 mlirDialectHandleRegisterDialect(scf, context);
123 mlirDialectHandleLoadDialect(scf, context);
124
125 MlirDialectHandle om = mlirGetDialectHandle__om__();
126 mlirDialectHandleRegisterDialect(om, context);
127 mlirDialectHandleLoadDialect(om, context);
128
129 MlirDialectHandle pipeline = mlirGetDialectHandle__pipeline__();
130 mlirDialectHandleRegisterDialect(pipeline, context);
131 mlirDialectHandleLoadDialect(pipeline, context);
132
133 MlirDialectHandle rtg = mlirGetDialectHandle__rtg__();
134 mlirDialectHandleRegisterDialect(rtg, context);
135 mlirDialectHandleLoadDialect(rtg, context);
136
137#ifdef CIRCT_INCLUDE_TESTS
138 MlirDialectHandle rtgtest = mlirGetDialectHandle__rtgtest__();
139 mlirDialectHandleRegisterDialect(rtgtest, context);
140 mlirDialectHandleLoadDialect(rtgtest, context);
141#endif
142
143 MlirDialectHandle seq = mlirGetDialectHandle__seq__();
144 mlirDialectHandleRegisterDialect(seq, context);
145 mlirDialectHandleLoadDialect(seq, context);
146
147 MlirDialectHandle sv = mlirGetDialectHandle__sv__();
148 mlirDialectHandleRegisterDialect(sv, context);
149 mlirDialectHandleLoadDialect(sv, context);
150
151 MlirDialectHandle fsm = mlirGetDialectHandle__fsm__();
152 mlirDialectHandleRegisterDialect(fsm, context);
153 mlirDialectHandleLoadDialect(fsm, context);
154
155 MlirDialectHandle handshake = mlirGetDialectHandle__handshake__();
156 mlirDialectHandleRegisterDialect(handshake, context);
157 mlirDialectHandleLoadDialect(handshake, context);
158
159 MlirDialectHandle kanagawa = mlirGetDialectHandle__kanagawa__();
160 mlirDialectHandleRegisterDialect(kanagawa, context);
161 mlirDialectHandleLoadDialect(kanagawa, context);
162
163 MlirDialectHandle ltl = mlirGetDialectHandle__ltl__();
164 mlirDialectHandleRegisterDialect(ltl, context);
165 mlirDialectHandleLoadDialect(ltl, context);
166
167 MlirDialectHandle verif = mlirGetDialectHandle__verif__();
168 mlirDialectHandleRegisterDialect(verif, context);
169 mlirDialectHandleLoadDialect(verif, context);
170
171 MlirDialectHandle smt = mlirGetDialectHandle__smt__();
172 mlirDialectHandleRegisterDialect(smt, context);
173 mlirDialectHandleLoadDialect(smt, context);
174 },
175 "Register CIRCT dialects on a PyMlirContext.");
176
177 m.def("export_verilog", [](MlirModule mod, nb::object fileObject) {
178 circt::python::PyFileAccumulator accum(fileObject, false);
179 nb::gil_scoped_release();
180 mlirExportVerilog(mod, accum.getCallback(), accum.getUserData());
181 });
182
183 m.def("export_split_verilog", [](MlirModule mod, std::string directory) {
184 auto cDirectory = mlirStringRefCreateFromCString(directory.c_str());
185 mlirExportSplitVerilog(mod, cDirectory);
186 });
187
188 nb::module_ aig = m.def_submodule("_aig", "AIG API");
190 nb::module_ esi = m.def_submodule("_esi", "ESI API");
192 nb::module_ msft = m.def_submodule("_msft", "MSFT API");
194 nb::module_ hw = m.def_submodule("_hw", "HW API");
196 nb::module_ seq = m.def_submodule("_seq", "Seq API");
198 nb::module_ om = m.def_submodule("_om", "OM API");
200 nb::module_ rtg = m.def_submodule("_rtg", "RTG API");
202 nb::module_ rtgtool = m.def_submodule("_rtgtool", "RTGTool API");
204#ifdef CIRCT_INCLUDE_TESTS
205 nb::module_ rtgtest = m.def_submodule("_rtgtest", "RTGTest API");
206 circt::python::populateDialectRTGTestSubmodule(rtgtest);
207#endif
208 nb::module_ sv = m.def_submodule("_sv", "SV API");
210 nb::module_ support = m.def_submodule("_support", "CIRCT support");
212}
MLIR_CAPI_EXPORTED void registerAIGPasses(void)
Definition AIG.cpp:27
MLIR_CAPI_EXPORTED void registerArcPasses(void)
Definition Arc.cpp:18
NB_MODULE(_circt, m)
static void registerPasses()
MLIR_CAPI_EXPORTED void registerCombPasses(void)
Definition Comb.cpp:16
MLIR_CAPI_EXPORTED void registerDCPasses(void)
Definition DC.cpp:18
MLIR_CAPI_EXPORTED void registerFSMPasses(void)
Definition FSM.cpp:19
MLIR_CAPI_EXPORTED void registerHWArithPasses(void)
Definition HWArith.cpp:16
MLIR_CAPI_EXPORTED void registerHWPasses(void)
Definition HW.cpp:32
MLIR_CAPI_EXPORTED void registerHandshakePasses(void)
Definition Handshake.cpp:18
MLIR_CAPI_EXPORTED void registerKanagawaPasses(void)
MLIR_CAPI_EXPORTED void registerPipelinePasses(void)
MLIR_CAPI_EXPORTED void registerRTGPasses(void)
Definition RTG.cpp:26
MLIR_CAPI_EXPORTED void registerSVPasses(void)
Definition SV.cpp:19
MLIR_CAPI_EXPORTED void registerSeqPasses(void)
Definition Seq.cpp:20
MLIR_CAPI_EXPORTED MlirLogicalResult mlirExportSplitVerilog(MlirModule, MlirStringRef)
Emits split Verilog files for the specified module into the given directory.
MLIR_CAPI_EXPORTED MlirLogicalResult mlirExportVerilog(MlirModule, MlirStringCallback, void *userData)
Emits verilog for the specified module using the provided callback and user data.
Taken from NanobindUtils.h in MLIR.
MlirStringCallback getCallback()
Definition aig.py:1
void populateDialectSVSubmodule(nanobind::module_ &m)
void populateDialectRTGSubmodule(nanobind::module_ &m)
void populateDialectRTGToolSubmodule(nanobind::module_ &m)
void populateDialectESISubmodule(nanobind::module_ &m)
void populateDialectHWSubmodule(nanobind::module_ &m)
void populateSupportSubmodule(nanobind::module_ &m)
void populateDialectOMSubmodule(nanobind::module_ &m)
void populateDialectMSFTSubmodule(nanobind::module_ &m)
void populateDialectAIGSubmodule(nanobind::module_ &m)
void populateDialectSeqSubmodule(nanobind::module_ &m)
Definition comb.py:1
Definition debug.py:1
Definition emit.py:1
Definition esi.py:1
Definition fsm.py:1
Definition hw.py:1
Definition ltl.py:1
Definition msft.py:1
Definition om.py:1
Definition rtg.py:1
Definition seq.py:1
Definition sv.py:1
Definition verif.py:1