circt_tcl.cpp

Go to the documentation of this file.

#include <stdlib.h>
#include <tcl.h>
 
#include "circt/Dialect/Comb/CombDialect.h"
#include "circt/Dialect/FIRRTL/FIRRTLDialect.h"
#include "circt/Dialect/HW/HWDialect.h"
#include "circt/Dialect/SV/SVDialect.h"
#include "mlir/CAPI/IR.h"
#include "mlir/Parser/Parser.h"
#include "mlir/Support/FileUtilities.h"
#include "llvm/Support/SourceMgr.h"
 
static int operationTypeSetFromAnyProc(Tcl_Interp *interp, Tcl_Obj *obj) {
  return TCL_ERROR;
}
 
static void operationTypeUpdateStringProc(Tcl_Obj *obj) {
  std::string str;
  auto *op = unwrap(MlirOperation{obj->internalRep.otherValuePtr});
  llvm::raw_string_ostream stream(str);
  op->print(stream);
  obj->length = str.length();
  obj->bytes = Tcl_Alloc(obj->length);
  memcpy(obj->bytes, str.c_str(), obj->length);
  obj->bytes[obj->length] = '\0';
}
 
static void operationTypeDupIntRepProc(Tcl_Obj *src, Tcl_Obj *dup) {
  auto *op = unwrap(MlirOperation{src->internalRep.otherValuePtr})->clone();
  dup->internalRep.otherValuePtr = wrap(op).ptr;
}
 
static void operationTypeFreeIntRepProc(Tcl_Obj *obj) {
  auto *op = unwrap(MlirOperation{obj->internalRep.otherValuePtr});
  op->erase();
}
 
static int returnErrorStr(Tcl_Interp *interp, const char *error) {
  Tcl_SetObjResult(interp, Tcl_NewStringObj(error, -1));
  return TCL_ERROR;
}
 
static int loadFirMlirFile(mlir::MLIRContext *context, Tcl_Interp *interp,
                           int objc, Tcl_Obj *const objv[]) {
  if (objc != 3) {
    Tcl_WrongNumArgs(interp, objc, objv, "usage: circt load [MLIR|FIR] [file]");
    return TCL_ERROR;
  }
 
  std::string errorMessage;
  auto input = mlir::openInputFile(llvm::StringRef(Tcl_GetString(objv[2])),
                                   &errorMessage);
 
  if (!input)
    return returnErrorStr(interp, errorMessage.c_str());
 
  llvm::SourceMgr sourceMgr;
  sourceMgr.AddNewSourceBuffer(std::move(input), llvm::SMLoc());
  mlir::SourceMgrDiagnosticHandler sourceMgrHandler(sourceMgr, context);
 
  MlirOperation module;
  if (!strcmp(Tcl_GetString(objv[1]), "MLIR"))
    module = wrap(mlir::parseSourceFile<mlir::ModuleOp>(sourceMgr, context)
                      .release()
                      .getOperation());
  else if (!strcmp(Tcl_GetString(objv[1]), "FIR"))
    // TODO
    return returnErrorStr(interp, "loading FIR files is unimplemented :(");
  else
    return TCL_ERROR;
 
  if (mlirOperationIsNull(module))
    return returnErrorStr(interp, "error loading module");
 
  auto *m = module.ptr;
 
  auto *obj = Tcl_NewObj();
  obj->typePtr = Tcl_GetObjType("MlirOperation");
  obj->internalRep.otherValuePtr = (void *)m;
  obj->length = 0;
  obj->bytes = nullptr;
  Tcl_SetObjResult(interp, obj);
 
  return TCL_OK;
}
 
static int circtTclFunction(ClientData cdata, Tcl_Interp *interp, int objc,
                            Tcl_Obj *const objv[]) {
  if (objc < 2) {
    Tcl_WrongNumArgs(interp, objc, objv, "usage: circt load");
    return TCL_ERROR;
  }
 
  auto *context = (mlir::MLIRContext *)cdata;
 
  if (!strcmp("load", Tcl_GetString(objv[1])))
    return loadFirMlirFile(context, interp, objc - 1, objv + 1);
 
  return returnErrorStr(interp, "usage: circt load");
}
 
static void deleteContext(ClientData data) { delete (mlir::MLIRContext *)data; }
 
extern "C" {
 
int DLLEXPORT Circt_Init(Tcl_Interp *interp) {
  if (Tcl_InitStubs(interp, TCL_VERSION, 0) == NULL)
    return TCL_ERROR;
 
  // Register types
  Tcl_ObjType *operationType = new Tcl_ObjType;
  operationType->name = "MlirOperation";
  operationType->setFromAnyProc = operationTypeSetFromAnyProc;
  operationType->updateStringProc = operationTypeUpdateStringProc;
  operationType->dupIntRepProc = operationTypeDupIntRepProc;
  operationType->freeIntRepProc = operationTypeFreeIntRepProc;
  Tcl_RegisterObjType(operationType);
 
  // Register package
  if (Tcl_PkgProvide(interp, "Circt", "1.0") == TCL_ERROR)
    return TCL_ERROR;
 
  // Register commands
  auto *context = new mlir::MLIRContext;
  context->loadDialect<circt::hw::HWDialect, circt::comb::CombDialect,
                       circt::sv::SVDialect>();
  Tcl_CreateObjCommand(interp, "circt", circtTclFunction, context,
                       deleteContext);
  return TCL_OK;
}
}