Merge pull request #8222 from hongted/mbff

gpl: Allow for MBFF tray identification on flops that have scan, preset, and clear pins.

Author: maliberty

MODULE.bazel

@@ -112,6 +112,8 @@ git_override(
 
 bazel_dep(name = "googletest", version = "1.17.0", dev_dependency = True)
 
+bazel_dep(name = "abseil-cpp", version = "20240722.0", repo_name = "com_google_absl")
+
 # Dependencies needed by one of the rules_hdl repos. Once they are on
 # BCR, they should depend on their own version.
 bazel_dep(name = "glpk", version = "5.0.bcr.3", repo_name = "org_gnu_glpk")

src/gpl/BUILD

@@ -23,11 +23,9 @@ cc_library(
         "src/graphicsImpl.cpp",
         "src/graphicsImpl.h",
         "src/graphicsNone.cpp",
-        "src/graphicsNone.h",
         "src/initialPlace.cpp",
         "src/initialPlace.h",
         "src/mbff.cpp",
-        "src/mbff.h",
         "src/nesterovBase.cpp",
         "src/nesterovBase.h",
         "src/nesterovPlace.cpp",
@@ -49,6 +47,8 @@ cc_library(
         "include/gpl/AbstractGraphics.h",
         "include/gpl/MakeReplace.h",
         "include/gpl/Replace.h",
+        "src/graphicsNone.h",
+        "src/mbff.h",
     ],
     copts = [
         "-fopenmp",

src/gpl/CMakeLists.txt

@@ -62,7 +62,6 @@ target_include_directories(gpl_lib
 )
 
 target_link_libraries(gpl_lib
-  PRIVATE
     utl_lib
     Eigen3::Eigen
     odb

src/gpl/src/mbff.cpp

@@ -352,7 +352,6 @@ bool MBFF::IsClearPin(dbITerm* iterm)
 {
   dbInst* inst = iterm->getInst();
   const sta::Cell* cell = network_->dbToSta(inst->getMaster());
-  const sta::LibertyCell* lib_cell = getLibertyCell(cell);
   const sta::Pin* pin = network_->dbToSta(iterm);
   if (pin == nullptr) {
     return false;
@@ -361,11 +360,41 @@ bool MBFF::IsClearPin(dbITerm* iterm)
   if (lib_port == nullptr) {
     return false;
   }
+
+  const sta::LibertyCell* lib_cell = network_->libertyCell(cell);
+  if (lib_cell == nullptr) {
+    return false;
+  }
+
+  // Check the lib cell if the port is a clear.
   for (const sta::Sequential* seq : lib_cell->sequentials()) {
     if (seq->clear() && seq->clear()->hasPort(lib_port)) {
       return true;
     }
   }
+
+  // If it exists, check the test lib cell if the port is a clear.
+  const sta::LibertyCell* test_cell = lib_cell->testCell();
+  if (test_cell == nullptr) {
+    return false;
+  }
+
+  // Find the equivalent lib_port on the test cell by name.
+  //
+  // TODO: NA - Make retrieving the port on the lib cell possible without doing
+  // a name match each time
+  const sta::LibertyPort* test_lib_port
+      = test_cell->findLibertyPort(lib_port->name());
+  if (test_lib_port == nullptr) {
+    return false;
+  }
+
+  for (const sta::Sequential* seq : test_cell->sequentials()) {
+    if (seq->clear() && seq->clear()->hasPort(test_lib_port)) {
+      return true;
+    }
+  }
+
   return false;
 }
 
@@ -385,7 +414,6 @@ bool MBFF::IsPresetPin(dbITerm* iterm)
 {
   dbInst* inst = iterm->getInst();
   const sta::Cell* cell = network_->dbToSta(inst->getMaster());
-  const sta::LibertyCell* lib_cell = getLibertyCell(cell);
   const sta::Pin* pin = network_->dbToSta(iterm);
   if (pin == nullptr) {
     return false;
@@ -394,11 +422,41 @@ bool MBFF::IsPresetPin(dbITerm* iterm)
   if (lib_port == nullptr) {
     return false;
   }
+
+  const sta::LibertyCell* lib_cell = network_->libertyCell(cell);
+  if (lib_cell == nullptr) {
+    return false;
+  }
+
+  // Check the lib cell if the port is a preset.
   for (const sta::Sequential* seq : lib_cell->sequentials()) {
     if (seq->preset() && seq->preset()->hasPort(lib_port)) {
       return true;
     }
   }
+
+  // If it exists, check the test lib cell if the port is a preset.
+  const sta::LibertyCell* test_cell = lib_cell->testCell();
+  if (test_cell == nullptr) {
+    return false;
+  }
+
+  // Find the equivalent lib_port on the test cell by name.
+  //
+  // TODO: NA - Make retrieving the port on the lib cell possible without doing
+  // a name match each time
+  const sta::LibertyPort* test_lib_port
+      = test_cell->findLibertyPort(lib_port->name());
+  if (test_lib_port == nullptr) {
+    return false;
+  }
+
+  for (const sta::Sequential* seq : test_cell->sequentials()) {
+    if (seq->preset() && seq->preset()->hasPort(test_lib_port)) {
+      return true;
+    }
+  }
+
   return false;
 }
 

src/gpl/src/mbff.h

@@ -3,10 +3,8 @@
 
 #pragma once
 
-#include <fstream>
 #include <map>
 #include <memory>
-#include <set>
 #include <string>
 #include <utility>
 #include <vector>
@@ -54,6 +52,8 @@ enum PortName
 
 class MBFF
 {
+  friend class MBFFTestPeer;
+
  public:
   MBFF(odb::dbDatabase* db,
        sta::dbSta* sta,

src/gpl/test/BUILD

@@ -152,3 +152,31 @@ cc_test(
         "@spdlog",
     ],
 )
+
+cc_test(
+    name = "mbff_test",
+    srcs = ["mbff_test.cpp"],
+    data = [
+        "library/test/test0.lef",
+        "library/test/test0.lib",
+    ],
+    deps = [
+        "//:openroad_lib",
+        "//bazel:runfiles",
+        "//src/ant",
+        "//src/dbSta",
+        "//src/dbSta:dbReadVerilog",
+        "//src/dpl",
+        "//src/est",
+        "//src/gpl",
+        "//src/grt",
+        "//src/odb",
+        "//src/rsz",
+        "//src/stt",
+        "//src/tst",
+        "//src/utl",
+        "@com_google_absl//absl/strings",
+        "@googletest//:gtest",
+        "@googletest//:gtest_main",
+    ],
+)

src/gpl/test/CMakeLists.txt

@@ -66,5 +66,30 @@ target_sources(fft_test
   ../src/fftsg2d.cpp
 )
 
+add_executable(mbff_test 
+  mbff_test.cpp
+)
+
+target_include_directories(mbff_test
+  PRIVATE
+  ${PROJECT_SOURCE_DIR}
+)
+
+target_link_libraries(mbff_test PUBLIC
+  absl::strings
+  GTest::gtest
+  GTest::gtest_main
+  gpl_lib
+  tst
+)
+
+gtest_discover_tests(mbff_test
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+)
+
+target_sources(mbff_test
+  PRIVATE
+  mbff_test.cpp
+)
 
-add_dependencies(build_and_test fft_test)
+add_dependencies(build_and_test fft_test mbff_test)