Loading [MathJax]/jax/output/HTML-CSS/config.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/Arc.h"
14#include "circt-c/Dialect/DC.h"
16#include "circt-c/Dialect/ESI.h"
18#include "circt-c/Dialect/FSM.h"
19#include "circt-c/Dialect/HW.h"
22#include "circt-c/Dialect/LTL.h"
24#include "circt-c/Dialect/OM.h"
25#include "circt-c/Dialect/RTG.h"
26#include "circt-c/Transforms.h"
27#ifdef CIRCT_INCLUDE_TESTS
29#endif
30#include "circt-c/Dialect/SV.h"
31#include "circt-c/Dialect/Seq.h"
34#include "mlir-c/Bindings/Python/Interop.h"
35#include "mlir-c/Dialect/Index.h"
36#include "mlir-c/Dialect/SCF.h"
37#include "mlir-c/Dialect/SMT.h"
38#include "mlir-c/IR.h"
39#include "mlir-c/Transforms.h"
40#include "mlir/Bindings/Python/NanobindAdaptors.h"
41
42#include "llvm-c/ErrorHandling.h"
43#include "llvm/Support/Signals.h"
44
45#include "NanobindUtils.h"
46#include <nanobind/nanobind.h>
47namespace nb = nanobind;
48
49static void registerPasses() {
59 mlirRegisterCIRCTConversionPasses();
60 mlirRegisterCIRCTTransformsPasses();
61 mlirRegisterTransformsCSE();
62}
63
64NB_MODULE(_circt, m) {
65 m.doc() = "CIRCT Python Native Extension";
67 llvm::sys::PrintStackTraceOnErrorSignal(/*argv=*/"");
68 LLVMEnablePrettyStackTrace();
69
70 m.def(
71 "register_dialects",
72 [](nb::object capsule) {
73 // Get the MlirContext capsule from PyMlirContext capsule.
74 auto wrappedCapsule = capsule.attr(MLIR_PYTHON_CAPI_PTR_ATTR);
75 MlirContext context = mlirPythonCapsuleToContext(wrappedCapsule.ptr());
76
77 // Collect CIRCT dialects to register.
78 MlirDialectHandle comb = mlirGetDialectHandle__comb__();
79 mlirDialectHandleRegisterDialect(comb, context);
80 mlirDialectHandleLoadDialect(comb, context);
81
82 MlirDialectHandle debug = mlirGetDialectHandle__debug__();
83 mlirDialectHandleRegisterDialect(debug, context);
84 mlirDialectHandleLoadDialect(debug, context);
85
86 MlirDialectHandle emit = mlirGetDialectHandle__emit__();
87 mlirDialectHandleRegisterDialect(emit, context);
88 mlirDialectHandleLoadDialect(emit, context);
89
90 MlirDialectHandle esi = mlirGetDialectHandle__esi__();
91 mlirDialectHandleRegisterDialect(esi, context);
92 mlirDialectHandleLoadDialect(esi, context);
93
94 MlirDialectHandle msft = mlirGetDialectHandle__msft__();
95 mlirDialectHandleRegisterDialect(msft, context);
96 mlirDialectHandleLoadDialect(msft, context);
97
98 MlirDialectHandle hw = mlirGetDialectHandle__hw__();
99 mlirDialectHandleRegisterDialect(hw, context);
100 mlirDialectHandleLoadDialect(hw, context);
101
102 MlirDialectHandle hwarith = mlirGetDialectHandle__hwarith__();
103 mlirDialectHandleRegisterDialect(hwarith, context);
104 mlirDialectHandleLoadDialect(hwarith, context);
105
106 MlirDialectHandle index = mlirGetDialectHandle__index__();
107 mlirDialectHandleRegisterDialect(index, context);
108 mlirDialectHandleLoadDialect(index, context);
109
110 MlirDialectHandle scf = mlirGetDialectHandle__scf__();
111 mlirDialectHandleRegisterDialect(scf, context);
112 mlirDialectHandleLoadDialect(scf, context);
113
114 MlirDialectHandle om = mlirGetDialectHandle__om__();
115 mlirDialectHandleRegisterDialect(om, context);
116 mlirDialectHandleLoadDialect(om, context);
117
118 MlirDialectHandle rtg = mlirGetDialectHandle__rtg__();
119 mlirDialectHandleRegisterDialect(rtg, context);
120 mlirDialectHandleLoadDialect(rtg, context);
121
122#ifdef CIRCT_INCLUDE_TESTS
123 MlirDialectHandle rtgtest = mlirGetDialectHandle__rtgtest__();
124 mlirDialectHandleRegisterDialect(rtgtest, context);
125 mlirDialectHandleLoadDialect(rtgtest, context);
126#endif
127
128 MlirDialectHandle seq = mlirGetDialectHandle__seq__();
129 mlirDialectHandleRegisterDialect(seq, context);
130 mlirDialectHandleLoadDialect(seq, context);
131
132 MlirDialectHandle sv = mlirGetDialectHandle__sv__();
133 mlirDialectHandleRegisterDialect(sv, context);
134 mlirDialectHandleLoadDialect(sv, context);
135
136 MlirDialectHandle fsm = mlirGetDialectHandle__fsm__();
137 mlirDialectHandleRegisterDialect(fsm, context);
138 mlirDialectHandleLoadDialect(fsm, context);
139
140 MlirDialectHandle handshake = mlirGetDialectHandle__handshake__();
141 mlirDialectHandleRegisterDialect(handshake, context);
142 mlirDialectHandleLoadDialect(handshake, context);
143
144 MlirDialectHandle ltl = mlirGetDialectHandle__ltl__();
145 mlirDialectHandleRegisterDialect(ltl, context);
146 mlirDialectHandleLoadDialect(ltl, context);
147
148 MlirDialectHandle verif = mlirGetDialectHandle__verif__();
149 mlirDialectHandleRegisterDialect(verif, context);
150 mlirDialectHandleLoadDialect(verif, context);
151
152 MlirDialectHandle smt = mlirGetDialectHandle__smt__();
153 mlirDialectHandleRegisterDialect(smt, context);
154 mlirDialectHandleLoadDialect(smt, context);
155 },
156 "Register CIRCT dialects on a PyMlirContext.");
157
158 m.def("export_verilog", [](MlirModule mod, nb::object fileObject) {
159 circt::python::PyFileAccumulator accum(fileObject, false);
160 nb::gil_scoped_release();
161 mlirExportVerilog(mod, accum.getCallback(), accum.getUserData());
162 });
163
164 m.def("export_split_verilog", [](MlirModule mod, std::string directory) {
165 auto cDirectory = mlirStringRefCreateFromCString(directory.c_str());
166 mlirExportSplitVerilog(mod, cDirectory);
167 });
168
169 nb::module_ esi = m.def_submodule("_esi", "ESI API");
171 nb::module_ msft = m.def_submodule("_msft", "MSFT API");
173 nb::module_ hw = m.def_submodule("_hw", "HW API");
175 nb::module_ seq = m.def_submodule("_seq", "Seq API");
177 nb::module_ om = m.def_submodule("_om", "OM API");
179 nb::module_ rtg = m.def_submodule("_rtg", "RTG API");
181 nb::module_ rtgtool = m.def_submodule("_rtgtool", "RTGTool API");
183#ifdef CIRCT_INCLUDE_TESTS
184 nb::module_ rtgtest = m.def_submodule("_rtgtest", "RTGTest API");
185 circt::python::populateDialectRTGTestSubmodule(rtgtest);
186#endif
187 nb::module_ sv = m.def_submodule("_sv", "SV API");
189 nb::module_ support = m.def_submodule("_support", "CIRCT support");
191}
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 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()
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 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