The new Python API for the ifp module (re #1812)

.gitignore

@@ -16,6 +16,7 @@ TAGS
 .~lock.*#
 .DS_Store
 Makefile
+__pycache__
 
 include/ord/Version.hh
 

include/ord/Design.h

@@ -0,0 +1,74 @@
+/////////////////////////////////////////////////////////////////////////////
+//
+// Copyright (c) 2022, The Regents of the University of California
+// All rights reserved.
+//
+// BSD 3-Clause License
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// * Redistributions of source code must retain the above copyright notice, this
+//   list of conditions and the following disclaimer.
+//
+// * Redistributions in binary form must reproduce the above copyright notice,
+//   this list of conditions and the following disclaimer in the documentation
+//   and/or other materials provided with the distribution.
+//
+// * Neither the name of the copyright holder nor the names of its
+//   contributors may be used to endorse or promote products derived from
+//   this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+//
+///////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include <string>
+
+namespace odb {
+class dbBlock;
+}  // namespace odb
+
+namespace ifp {
+class InitFloorplan;
+}
+
+namespace ord {
+
+class Tech;
+
+class Design
+{
+ public:
+  Design(Tech* tech);
+  void readVerilog(const std::string& file_name);
+  void link(const std::string& design_name);
+
+  void writeDb(const std::string& file_name);
+  void writeDef(const std::string& file_name);
+
+  odb::dbBlock* getBlock();
+  utl::Logger* getLogger();
+
+  int micronToDBU(double coord);
+
+  // Services
+  ifp::InitFloorplan* getFloorplan();
+
+ private:
+  Tech* tech_;
+};
+
+}  // namespace ord

include/ord/Tech.h

@@ -0,0 +1,62 @@
+/////////////////////////////////////////////////////////////////////////////
+//
+// Copyright (c) 2022, The Regents of the University of California
+// All rights reserved.
+//
+// BSD 3-Clause License
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// * Redistributions of source code must retain the above copyright notice, this
+//   list of conditions and the following disclaimer.
+//
+// * Redistributions in binary form must reproduce the above copyright notice,
+//   this list of conditions and the following disclaimer in the documentation
+//   and/or other materials provided with the distribution.
+//
+// * Neither the name of the copyright holder nor the names of its
+//   contributors may be used to endorse or promote products derived from
+//   this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+//
+///////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include <string>
+
+namespace odb {
+class dbDatabase;
+}
+
+namespace utl {
+class Logger;
+}
+
+namespace ord {
+
+class Tech
+{
+ public:
+  Tech();
+  void readLEF(const std::string& file_name);
+  void readLiberty(const std::string& file_name);
+  odb::dbDatabase* getDB();
+
+ private:
+  odb::dbDatabase* db_;
+};
+
+}  // namespace ord

src/CMakeLists.txt

@@ -31,6 +31,8 @@ set(RESIZER_HOME ${PROJECT_SOURCE_DIR}/src/rsz)
 set(PAD_HOME ${OPENROAD_HOME}/src/pad)
 
 set(OPENROAD_SOURCE
+  Design.cc
+  Tech.cc
   OpenRoad.cc
   Main.cc
   )
@@ -324,10 +326,10 @@ if (Python3_FOUND AND BUILD_PYTHON)
   target_compile_definitions(openroad PRIVATE ENABLE_PYTHON3)
 
   swig_lib(NAME      openroad_swig_py
-		   NAMESPACE ord
-		   LANGUAGE  python
-		   I_FILE    OpenRoad-py.i
-		   SCRIPTS   ${CMAKE_CURRENT_BINARY_DIR}/openroad_swig_py.py
+           NAMESPACE ord
+           LANGUAGE  python
+           I_FILE    OpenRoad-py.i
+           SCRIPTS   ${CMAKE_CURRENT_BINARY_DIR}/openroad_swig_py.py
   )
 
   target_link_libraries(openroad_swig_py
@@ -339,6 +341,7 @@ if (Python3_FOUND AND BUILD_PYTHON)
   target_link_libraries(openroad
     openroad_swig_py
     odbpy
+    ifp_py
   )
 else()
   message(STATUS "Python3 disabled")

src/Design.cc

@@ -0,0 +1,106 @@
+/////////////////////////////////////////////////////////////////////////////
+//
+// Copyright (c) 2022, The Regents of the University of California
+// All rights reserved.
+//
+// BSD 3-Clause License
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// * Redistributions of source code must retain the above copyright notice, this
+//   list of conditions and the following disclaimer.
+//
+// * Redistributions in binary form must reproduce the above copyright notice,
+//   this list of conditions and the following disclaimer in the documentation
+//   and/or other materials provided with the distribution.
+//
+// * Neither the name of the copyright holder nor the names of its
+//   contributors may be used to endorse or promote products derived from
+//   this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+//
+///////////////////////////////////////////////////////////////////////////////
+
+#include "odb/db.h"
+#include "ord/Design.h"
+#include "ifp/InitFloorplan.hh"
+#include "ord/OpenRoad.hh"
+#include "ord/Tech.h"
+#include "utl/Logger.h"
+
+namespace ord {
+
+Design::Design(Tech* tech) : tech_(tech)
+{
+}
+
+odb::dbBlock* Design::getBlock()
+{
+  auto chip = tech_->getDB()->getChip();
+  return chip ? chip->getBlock() : nullptr;
+}
+
+void Design::readVerilog(const std::string& file_name)
+{
+  auto chip = tech_->getDB()->getChip();
+  if (chip && chip->getBlock()) {
+    getLogger()->error(utl::ORD, 36, "A block already exists in the db");
+  }
+
+  auto app = OpenRoad::openRoad();
+  app->readVerilog(file_name.c_str());
+}
+
+void Design::link(const std::string& design_name)
+{
+  auto app = OpenRoad::openRoad();
+  app->linkDesign(design_name.c_str());
+}
+
+void Design::writeDb(const std::string& file_name)
+{
+  auto app = OpenRoad::openRoad();
+  app->writeDb(file_name.c_str());
+}
+
+void Design::writeDef(const std::string& file_name)
+{
+  auto app = OpenRoad::openRoad();
+  app->writeDef(file_name.c_str(), "5.8");
+}
+
+ifp::InitFloorplan* Design::getFloorplan()
+{
+  auto app = OpenRoad::openRoad();
+  auto block = getBlock();
+  if (!block) {
+    getLogger()->error(utl::ORD, 37, "No block loaded.");
+  }
+  return new ifp::InitFloorplan(block, app->getLogger(), app->getDbNetwork());
+}
+
+utl::Logger* Design::getLogger()
+{
+  auto app = OpenRoad::openRoad();
+  return app->getLogger();
+}
+
+int Design::micronToDBU(double coord)
+{
+  int dbuPerMicron = getBlock()->getDbUnitsPerMicron();
+  return round(coord * dbuPerMicron);
+}
+
+}  // namespace ord