Merge pull request #8861 from The-OpenROAD-Project-staging/secure-fix-dbsta-for-read-vcd

dbSta: Fixed `find*()` and `isConnected()` APIs for `read_spef` and `read_vcd`

Author: maliberty

src/dbSta/include/db_sta/dbNetwork.hh

@@ -9,6 +9,7 @@
 #include "odb/db.h"
 #include "sta/ConcreteNetwork.hh"
 #include "sta/GraphClass.hh"
+#include "sta/Network.hh"
 
 namespace utl {
 class Logger;
@@ -177,7 +178,10 @@ class dbNetwork : public ConcreteNetwork
                                      bool hier = false);
   Instance* getOwningInstanceParent(Pin* pin);
 
-  bool connected(Pin* source_pin, Pin* dest_pin);
+  using Network::isConnected;
+  bool isConnected(const Net* net, const Pin* pin) const override;
+  bool isConnected(const Net* net1, const Net* net2) const override;
+  bool isConnected(const Pin* source_pin, const Pin* dest_pin) const;
   void hierarchicalConnect(dbITerm* source_pin,
                            dbITerm* dest_pin,
                            const char* connection_name = "net");

src/dbSta/src/dbEditHierarchy.cc

@@ -293,8 +293,8 @@ void dbEditHierarchy::hierarchicalConnect(dbITerm* source_pin,
     source_pin->connect(source_db_net);
     dlogHierConnConnectSrcToFlatNet(source_pin, connection_name);
   }
-  if (!db_network_->connected(db_network_->dbToSta(source_pin),
-                              db_network_->dbToSta(dest_pin))) {
+  if (!db_network_->isConnected(db_network_->dbToSta(source_pin),
+                                db_network_->dbToSta(dest_pin))) {
     dest_pin->connect(source_db_net);
     dlogHierConnConnectDstToFlatNet(dest_pin, source_db_net);
   }

src/dbSta/src/dbNetwork.cc

@@ -1132,6 +1132,12 @@ bool dbNetwork::isLeaf(const Instance* instance) const
 Instance* dbNetwork::findInstance(const char* path_name) const
 {
   if (hierarchy_) {  // are we in hierarchical mode ?
+    // find a hierarchical module instance first
+    dbModInst* mod_inst = block()->findModInst(path_name);
+    if (mod_inst) {
+      return dbToSta(mod_inst);
+    }
+
     std::string path_name_str = path_name;
     // search for the last token in the string, which is the leaf instance name
     size_t last_idx = path_name_str.find_last_of('/');
@@ -3745,13 +3751,6 @@ bool PinConnections::connected(const Pin* pin) const
   return pins_.find(pin) != pins_.end();
 }
 
-bool dbNetwork::connected(Pin* source_pin, Pin* dest_pin)
-{
-  PinConnections visitor;
-  network_->visitConnectedPins(source_pin, visitor);
-  return visitor.connected(dest_pin);
-}
-
 void dbNetwork::removeUnusedPortsAndPinsOnModuleInstances()
 {
   for (dbModInst* mi : block()->getModInsts()) {
@@ -3777,6 +3776,45 @@ class DbNetConnectedToBTerm : public PinVisitor
   dbBTerm* bterm_{nullptr};
 };
 
+bool dbNetwork::isConnected(const Pin* source_pin, const Pin* dest_pin) const
+{
+  PinConnections visitor;
+  network_->visitConnectedPins(source_pin, visitor);
+  return visitor.connected(dest_pin);
+}
+
+bool dbNetwork::isConnected(const Net* net, const Pin* pin) const
+{
+  dbNet* dbnet;
+  dbModNet* modnet;
+  staToDb(net, dbnet, modnet);
+
+  dbNet* pin_dbnet = findFlatDbNet(pin);
+  if (dbnet != nullptr) {
+    return dbnet->isConnected(pin_dbnet);
+  }
+  if (modnet != nullptr) {
+    return modnet->isConnected(pin_dbnet);
+  }
+
+  return false;
+}
+
+bool dbNetwork::isConnected(const Net* net1, const Net* net2) const
+{
+  if (net1 == net2) {
+    return true;
+  }
+
+  dbNet* flat_net1 = findFlatDbNet(net1);
+  dbNet* flat_net2 = findFlatDbNet(net2);
+  if (flat_net1 != nullptr && flat_net1 == flat_net2) {
+    return true;
+  }
+
+  return false;
+}
+
 void DbNetConnectedToBTerm::operator()(const Pin* pin)
 {
   dbITerm* iterm;
@@ -4293,14 +4331,13 @@ Net* dbNetwork::findFlatNet(const Pin* pin) const
 // This function handles both internal instance pins and top-level port pins.
 dbNet* dbNetwork::findFlatDbNet(const Pin* pin) const
 {
-  dbNet* db_net = nullptr;
+  Net* sta_net = nullptr;
   if (isTopLevelPort(pin)) {
-    Net* net = this->net(term(pin));
-    db_net = flatNet(net);
+    sta_net = net(term(pin));
   } else {
-    db_net = flatNet(pin);
+    sta_net = net(pin);
   }
-  return db_net;
+  return findFlatDbNet(sta_net);
 }
 
 dbModInst* dbNetwork::getModInst(Instance* inst) const

src/dbSta/test/BUILD

@@ -12,8 +12,8 @@ COMPULSORY_TESTS = [
     "check_axioms",
     "clock_pin",
     "constant1",
-    #"escape_slash", # different result compared to CMake
-    #"escape_slash_hier", # different result compared to CMake
+    # "escape_slash", # different result compared to CMake
+    # "escape_slash_hier", # different result compared to CMake
     "find_clks1",
     "find_clks2",
     "get_ports1",
@@ -26,6 +26,7 @@ COMPULSORY_TESTS = [
     "network_edit1",
     "power1",
     "read_liberty1",
+    "read_vcd",
     "read_verilog1",
     "read_verilog2",
     "read_verilog3",
@@ -154,6 +155,13 @@ filegroup(
                 test_name + ".*",
             ],
         ) + {
+            "read_vcd": glob(
+                [
+                    "Element.*",
+                    "MockArray.*",
+                    "asap7/*",
+                ],
+            ),
             "report_cell_usage_file": [
                 "report_cell_usage.def",
             ],
@@ -193,3 +201,23 @@ cc_test(
         "@googletest//:gtest_main",
     ],
 )
+
+cc_test(
+    name = "dbsta_unittest",
+    srcs = ["cpp/TestDbSta.cc"],
+    data = [
+        "Nangate45/Nangate45.lef",
+        "Nangate45/Nangate45_typ.lib",
+        "cpp/TestDbSta_0.v",
+    ],
+    deps = [
+        "//src/dbSta",
+        "//src/dbSta:dbNetwork",
+        "//src/odb",
+        "//src/sta:opensta_lib",
+        "//src/tst:integrated_fixture",
+        "//src/utl",
+        "@googletest//:gtest",
+        "@googletest//:gtest_main",
+    ],
+)

src/dbSta/test/CMakeLists.txt

@@ -19,6 +19,7 @@ or_integration_tests(
     network_edit1
     power1
     read_liberty1
+    read_vcd
     read_verilog1
     read_verilog2
     read_verilog3