HWModule.cpp

Go to the documentation of this file.

//===- HWModule.cpp - HW API nanobind module ------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
 
#include "CIRCTModules.h"
 
#include "circt-c/Dialect/HW.h"
 
#include "mlir-c/BuiltinAttributes.h"
#include "mlir/Bindings/Python/NanobindAdaptors.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/Support/raw_ostream.h"
 
#include "NanobindUtils.h"
#include "mlir-c/IR.h"
#include "mlir-c/Support.h"
#include "mlir/Bindings/Python/IRCore.h"
#include "mlir/Bindings/Python/NanobindAdaptors.h"
#include <nanobind/nanobind.h>
namespace nb = nanobind;
 
using namespace circt;
using namespace mlir::python::nanobind_adaptors;
using mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::DefaultingPyMlirContext;
 
/// Populate the hw python module.
void circt::python::populateDialectHWSubmodule(nb::module_ &m) {
  m.doc() = "HW dialect Python native extension";
 
  m.def("get_bitwidth", &hwGetBitWidth);
 
  mlir_type_subclass(m, "InOutType", hwTypeIsAInOut)
      .def_classmethod("get",
                       [](nb::object cls, MlirType innerType) {
                         return cls(hwInOutTypeGet(innerType));
                       })
      .def_property_readonly("element_type", [](MlirType self) {
        return hwInOutTypeGetElementType(self);
      });
 
  mlir_type_subclass(m, "ArrayType", hwTypeIsAArrayType)
      .def_classmethod("get",
                       [](nb::object cls, MlirType elementType, intptr_t size) {
                         return cls(hwArrayTypeGet(elementType, size));
                       })
      .def_property_readonly(
          "element_type",
          [](MlirType self) { return hwArrayTypeGetElementType(self); })
      .def_property_readonly(
          "size", [](MlirType self) { return hwArrayTypeGetSize(self); });
 
  nb::enum_<HWModulePortDirection>(m, "ModulePortDirection")
      .value("INPUT", HWModulePortDirection::Input)
      .value("OUTPUT", HWModulePortDirection::Output)
      .value("INOUT", HWModulePortDirection::InOut)
      .export_values();
 
  nb::class_<HWModulePort>(m, "ModulePort")
      .def(nb::init<MlirAttribute, MlirType, HWModulePortDirection>());
 
  mlir_type_subclass(m, "ModuleType", hwTypeIsAModuleType)
      .def_classmethod(
          "get",
          [](nb::object cls, nb::list pyModulePorts, MlirContext ctx) {
            std::vector<HWModulePort> modulePorts;
            for (auto pyModulePort : pyModulePorts)
              modulePorts.push_back(nb::cast<HWModulePort>(pyModulePort));
 
            return cls(
                hwModuleTypeGet(ctx, modulePorts.size(), modulePorts.data()));
          },
          nb::arg("cls"), nb::arg("ports"), nb::arg("context") = nb::none())
      .def_property_readonly(
          "input_types",
          [](MlirType self) {
            nb::list inputTypes;
            intptr_t numInputs = hwModuleTypeGetNumInputs(self);
            for (intptr_t i = 0; i < numInputs; ++i)
              inputTypes.append(hwModuleTypeGetInputType(self, i));
            return inputTypes;
          })
      .def_property_readonly(
          "input_names",
          [](MlirType self) {
            std::vector<std::string> inputNames;
            intptr_t numInputs = hwModuleTypeGetNumInputs(self);
            for (intptr_t i = 0; i < numInputs; ++i) {
              auto name = hwModuleTypeGetInputName(self, i);
              inputNames.emplace_back(name.data, name.length);
            }
            return inputNames;
          })
      .def_property_readonly(
          "output_types",
          [](MlirType self) {
            nb::list outputTypes;
            intptr_t numOutputs = hwModuleTypeGetNumOutputs(self);
            for (intptr_t i = 0; i < numOutputs; ++i)
              outputTypes.append(hwModuleTypeGetOutputType(self, i));
            return outputTypes;
          })
      .def_property_readonly("output_names", [](MlirType self) {
        std::vector<std::string> outputNames;
        intptr_t numOutputs = hwModuleTypeGetNumOutputs(self);
        for (intptr_t i = 0; i < numOutputs; ++i) {
          auto name = hwModuleTypeGetOutputName(self, i);
          outputNames.emplace_back(name.data, name.length);
        }
        return outputNames;
      });
 
  mlir_type_subclass(m, "ParamIntType", hwTypeIsAIntType)
      .def_classmethod(
          "get_from_param",
          [](nb::object cls, MlirContext ctx, MlirAttribute param) {
            return cls(hwParamIntTypeGet(param));
          })
      .def_property_readonly("width", [](MlirType self) {
        return hwParamIntTypeGetWidthAttr(self);
      });
 
  mlir_type_subclass(m, "StructType", hwTypeIsAStructType)
      .def_classmethod(
          "get",
          [](nb::object cls, nb::list pyFieldInfos,
             DefaultingPyMlirContext context) {
            llvm::SmallVector<HWStructFieldInfo> mlirFieldInfos;
            MlirContext ctx = context.resolve().get();
 
            // Since we're just passing string refs to the type constructor,
            // copy them into a temporary vector to give them all new addresses.
            llvm::SmallVector<llvm::SmallString<8>> names;
            for (size_t i = 0, e = pyFieldInfos.size(); i < e; ++i) {
              auto tuple = nb::cast<nb::tuple>(pyFieldInfos[i]);
              auto type = nb::cast<MlirType>(tuple[1]);
              // Only override if the context is null.
              if (mlirContextIsNull(ctx)) {
                ctx = mlirTypeGetContext(type);
              }
              names.emplace_back(nb::cast<std::string>(tuple[0]));
              auto nameStringRef =
                  mlirStringRefCreate(names[i].data(), names[i].size());
              mlirFieldInfos.push_back(HWStructFieldInfo{
                  mlirIdentifierGet(ctx, nameStringRef), type});
            }
            if (mlirContextIsNull(ctx)) {
              throw std::invalid_argument(
                  "StructType requires a context if no fields provided.");
            }
            return cls(hwStructTypeGet(ctx, mlirFieldInfos.size(),
                                       mlirFieldInfos.data()));
          },
          nb::arg("cls"), nb::arg("fields"), nb::arg("context") = nb::none())
      .def("get_field",
           [](MlirType self, std::string fieldName) {
             return hwStructTypeGetField(
                 self, mlirStringRefCreateFromCString(fieldName.c_str()));
           })
      .def("get_field_index",
           [](MlirType self, const std::string &fieldName) {
             return hwStructTypeGetFieldIndex(
                 self, mlirStringRefCreateFromCString(fieldName.c_str()));
           })
      .def("get_fields", [](MlirType self) {
        intptr_t num_fields = hwStructTypeGetNumFields(self);
        nb::list fields;
        for (intptr_t i = 0; i < num_fields; ++i) {
          auto field = hwStructTypeGetFieldNum(self, i);
          auto fieldName = mlirIdentifierStr(field.name);
          std::string name(fieldName.data, fieldName.length);
          fields.append(nb::make_tuple(name, field.type));
        }
        return fields;
      });
 
  mlir_type_subclass(m, "UnionType", hwTypeIsAUnionType)
      .def_classmethod(
          "get",
          [](nb::object cls, nb::list pyFieldInfos) {
            llvm::SmallVector<HWUnionFieldInfo> mlirFieldInfos;
            MlirContext ctx;
 
            // Since we're just passing string refs to the type constructor,
            // copy them into a temporary vector to give them all new addresses.
            llvm::SmallVector<llvm::SmallString<8>> names;
            for (size_t i = 0, e = pyFieldInfos.size(); i < e; ++i) {
              auto tuple = nb::cast<nb::tuple>(pyFieldInfos[i]);
              if (tuple.size() < 3)
                throw std::invalid_argument(
                    "UnionType field info must be a tuple of (name, type, "
                    "offset)");
              auto type = nb::cast<MlirType>(tuple[1]);
              size_t offset = nb::cast<size_t>(tuple[2]);
              ctx = mlirTypeGetContext(type);
              names.emplace_back(nb::cast<std::string>(tuple[0]));
              auto nameStringRef =
                  mlirStringRefCreate(names[i].data(), names[i].size());
              mlirFieldInfos.push_back(HWUnionFieldInfo{
                  mlirIdentifierGet(ctx, nameStringRef), type, offset});
            }
            return cls(hwUnionTypeGet(ctx, mlirFieldInfos.size(),
                                      mlirFieldInfos.data()));
          })
      .def("get_field",
           [](MlirType self, std::string fieldName) {
             return hwUnionTypeGetField(
                 self, mlirStringRefCreateFromCString(fieldName.c_str()));
           })
      .def("get_field_index",
           [](MlirType self, const std::string &fieldName) {
             return hwUnionTypeGetFieldIndex(
                 self, mlirStringRefCreateFromCString(fieldName.c_str()));
           })
      .def("get_fields", [](MlirType self) {
        intptr_t num_fields = hwUnionTypeGetNumFields(self);
        nb::list fields;
        for (intptr_t i = 0; i < num_fields; ++i) {
          auto field = hwUnionTypeGetFieldNum(self, i);
          auto fieldName = mlirIdentifierStr(field.name);
          std::string name(fieldName.data, fieldName.length);
          fields.append(nb::make_tuple(name, field.type, field.offset));
        }
        return fields;
      });
 
  mlir_type_subclass(m, "TypeAliasType", hwTypeIsATypeAliasType)
      .def_classmethod("get",
                       [](nb::object cls, std::string scope, std::string name,
                          MlirType innerType) {
                         return cls(hwTypeAliasTypeGet(
                             mlirStringRefCreateFromCString(scope.c_str()),
                             mlirStringRefCreateFromCString(name.c_str()),
                             innerType));
                       })
      .def_property_readonly(
          "canonical_type",
          [](MlirType self) { return hwTypeAliasTypeGetCanonicalType(self); })
      .def_property_readonly(
          "inner_type",
          [](MlirType self) { return hwTypeAliasTypeGetInnerType(self); })
      .def_property_readonly("name",
                             [](MlirType self) {
                               MlirStringRef cStr =
                                   hwTypeAliasTypeGetName(self);
                               return std::string(cStr.data, cStr.length);
                             })
      .def_property_readonly("scope", [](MlirType self) {
        MlirStringRef cStr = hwTypeAliasTypeGetScope(self);
        return std::string(cStr.data, cStr.length);
      });
 
  mlir_attribute_subclass(m, "ParamDeclAttr", hwAttrIsAParamDeclAttr)
      .def_classmethod(
          "get",
          [](nb::object cls, std::string name, MlirType type,
             MlirAttribute value) {
            return cls(hwParamDeclAttrGet(
                mlirStringRefCreateFromCString(name.c_str()), type, value));
          })
      .def_classmethod("get_nodefault",
                       [](nb::object cls, std::string name, MlirType type) {
                         return cls(hwParamDeclAttrGet(
                             mlirStringRefCreateFromCString(name.c_str()), type,
                             MlirAttribute{nullptr}));
                       })
      .def_property_readonly(
          "value",
          [](MlirAttribute self) { return hwParamDeclAttrGetValue(self); })
      .def_property_readonly(
          "param_type",
          [](MlirAttribute self) { return hwParamDeclAttrGetType(self); })
      .def_property_readonly("name", [](MlirAttribute self) {
        MlirStringRef cStr = hwParamDeclAttrGetName(self);
        return std::string(cStr.data, cStr.length);
      });
 
  mlir_attribute_subclass(m, "ParamDeclRefAttr", hwAttrIsAParamDeclRefAttr)
      .def_classmethod(
          "get",
          [](nb::object cls, MlirContext ctx, std::string name) {
            return cls(hwParamDeclRefAttrGet(
                ctx, mlirStringRefCreateFromCString(name.c_str())));
          })
      .def_property_readonly(
          "param_type",
          [](MlirAttribute self) { return hwParamDeclRefAttrGetType(self); })
      .def_property_readonly("name", [](MlirAttribute self) {
        MlirStringRef cStr = hwParamDeclRefAttrGetName(self);
        return std::string(cStr.data, cStr.length);
      });
 
  mlir_attribute_subclass(m, "ParamVerbatimAttr", hwAttrIsAParamVerbatimAttr)
      .def_classmethod("get", [](nb::object cls, MlirAttribute text) {
        return cls(hwParamVerbatimAttrGet(text));
      });
 
  mlir_attribute_subclass(m, "OutputFileAttr", hwAttrIsAOutputFileAttr)
      .def_classmethod(
          "get_from_filename",
          [](nb::object cls, MlirAttribute fileName, bool excludeFromFileList,
             bool includeReplicatedOp) {
            return cls(hwOutputFileGetFromFileName(
                fileName, excludeFromFileList, includeReplicatedOp));
          })
      .def_property_readonly("filename", [](MlirAttribute self) {
        MlirStringRef cStr = hwOutputFileGetFileName(self);
        return std::string(cStr.data, cStr.length);
      });
 
  mlir_attribute_subclass(m, "InnerSymAttr", hwAttrIsAInnerSymAttr)
      .def_classmethod("get",
                       [](nb::object cls, MlirAttribute symName) {
                         return cls(hwInnerSymAttrGet(symName));
                       })
      .def_property_readonly("symName", [](MlirAttribute self) {
        return hwInnerSymAttrGetSymName(self);
      });
 
  mlir_attribute_subclass(m, "InnerRefAttr", hwAttrIsAInnerRefAttr)
      .def_classmethod(
          "get",
          [](nb::object cls, MlirAttribute moduleName, MlirAttribute innerSym) {
            return cls(hwInnerRefAttrGet(moduleName, innerSym));
          })
      .def_property_readonly(
          "module",
          [](MlirAttribute self) { return hwInnerRefAttrGetModule(self); })
      .def_property_readonly("name", [](MlirAttribute self) {
        return hwInnerRefAttrGetName(self);
      });
}