Merge pull request #8753 from The-OpenROAD-Project-staging/secure-fix-bus-port-io-type

dbSta: Fixed wrong dbModBTerm direction for bus port

Author: maliberty

src/dbSta/src/dbNetwork.cc

@@ -4544,6 +4544,7 @@ void dbNetwork::checkSanityNetConnectivity(odb::dbObject* obj) const
   // Check for hier net and flat net connectivity
   dbSet<dbModNet> mod_nets = block()->getModNets();
   for (dbModNet* mod_net : mod_nets) {
+    mod_net->checkSanity();
     findRelatedDbNet(mod_net);
   }
 

src/dbSta/src/dbReadVerilog.cc

@@ -438,6 +438,7 @@ void Verilog2db::makeModBTerms(Cell* cell, dbModule* module)
   std::unique_ptr<CellPortIterator> cp_iter{network_->portIterator(cell)};
   while (cp_iter->hasNext()) {
     Port* port = cp_iter->next();
+    const dbIoType io_type = staToDb(network_->direction(port));
     if (network_->isBus(port)) {
       // make the bus port as part of the port set for the cell.
       const char* port_name = network_->name(port);
@@ -447,7 +448,6 @@ void Verilog2db::makeModBTerms(Cell* cell, dbModule* module)
                                     network_->fromIndex(port),
                                     network_->toIndex(port));
       bmodterm->setBusPort(dbbusport);
-      const dbIoType io_type = staToDb(network_->direction(port));
       bmodterm->setIoType(io_type);
 
       //
@@ -475,12 +475,11 @@ void Verilog2db::makeModBTerms(Cell* cell, dbModule* module)
           dbbusport->setLast(modbterm);
         }
         dbIoType io_type = staToDb(network_->direction(port));
-        bmodterm->setIoType(io_type);
+        modbterm->setIoType(io_type);
       }
     } else {
       const std::string port_name = network_->name(port);
       dbModBTerm* bmodterm = dbModBTerm::create(module, port_name.c_str());
-      const dbIoType io_type = staToDb(network_->direction(port));
       bmodterm->setIoType(io_type);
       debugPrint(logger_,
                  utl::ODB,

src/dbSta/test/check_axioms.ok

@@ -1,5 +1,9 @@
 [INFO ODB-0227] LEF file: Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
 [WARNING ORD-0011] Hierarchical flow (-hier) is currently in development and may cause multiple issues. Do not use in production environments.
+[WARNING ODB-0482] SanityCheck: dbModNet 'u1/Z' has no driver.
+[WARNING ODB-0483] SanityCheck: dbModNet 'u1/Z' is dangling. It has less than 2 connections (# of ITerms = 0, # of BTerms = 0, # of ModITerms = 0, # of ModBTerms = 1).
+[WARNING ODB-0482] SanityCheck: dbModNet 'single_conn_wire' has no driver.
+[WARNING ODB-0483] SanityCheck: dbModNet 'single_conn_wire' is dangling. It has less than 2 connections (# of ITerms = 0, # of BTerms = 0, # of ModITerms = 1, # of ModBTerms = 0).
 [WARNING ODB-0050] SanityCheck: dbNet 'out_unconnected' has no driver.
 [WARNING ODB-0051] SanityCheck: dbNet 'out_unconnected' is dangling. It has less than 2 connections (# of ITerms = 0, # of BTerms = 1).
 [WARNING ODB-0051] SanityCheck: dbNet 'single_conn_wire' is dangling. It has less than 2 connections (# of ITerms = 0, # of BTerms = 0).

src/dbSta/test/hierclock_out.vok

@@ -238,6 +238,10 @@ module counter (clk_i,
     .Q(counter_q[3]),
     .QN(_38_));
  assign count_valid_o = count_valid_q;
+ assign count_value_o[0] = counter_q[0];
+ assign count_value_o[1] = counter_q[1];
+ assign count_value_o[2] = counter_q[2];
+ assign count_value_o[3] = counter_q[3];
 endmodule
 module counter_U3 (clk_i,
     rst_n_i,
@@ -352,4 +356,8 @@ module counter_U3 (clk_i,
     .Q(counter_q[3]),
     .QN(_38_));
  assign count_valid_o = count_valid_q;
+ assign count_value_o[0] = counter_q[0];
+ assign count_value_o[1] = counter_q[1];
+ assign count_value_o[2] = counter_q[2];
+ assign count_value_o[3] = counter_q[3];
 endmodule

src/odb/include/odb/db.h

@@ -8291,6 +8291,7 @@ class dbModBTerm : public dbObject
   dbModule* getParent() const;
 
   // User Code Begin dbModBTerm
+  std::string getHierarchicalName() const;
   void setParentModITerm(dbModITerm* parent_pin);
   dbModITerm* getParentModITerm() const;
   void setModNet(dbModNet* modNet);
@@ -8366,6 +8367,7 @@ class dbModITerm : public dbObject
   dbModInst* getParent() const;
 
   // User Code Begin dbModITerm
+  std::string getHierarchicalName() const;
   void setModNet(dbModNet* modNet);
   dbModNet* getModNet() const;
   void setChildModBTerm(dbModBTerm* child_port);
@@ -8391,7 +8393,7 @@ class dbModNet : public dbObject
   dbSet<dbModBTerm> getModBTerms() const;
   dbSet<dbITerm> getITerms() const;
   dbSet<dbBTerm> getBTerms() const;
-  unsigned connectionCount();
+  unsigned connectionCount() const;
   std::string getName() const;
   const char* getConstName() const;
   std::string getHierarchicalName() const;
@@ -8404,6 +8406,7 @@ class dbModNet : public dbObject
   // This function traverses the terminals connected to this dbModNet
   // and returns the first dbNet it finds.
   dbNet* findRelatedNet() const;
+  void checkSanity() const;
 
   static dbModNet* getModNet(dbBlock* block, uint id);
   static dbModNet* create(dbModule* parentModule, const char* base_name);

src/odb/src/db/dbModBTerm.cpp

@@ -16,6 +16,8 @@
 #include "dbTable.hpp"
 #include "odb/db.h"
 // User Code Begin Includes
+#include <string>
+
 #include "odb/dbBlockCallBackObj.h"
 // User Code End Includes
 namespace odb {
@@ -168,6 +170,23 @@ dbModule* dbModBTerm::getParent() const
 }
 
 // User Code Begin dbModBTermPublicMethods
+std::string dbModBTerm::getHierarchicalName() const
+{
+  dbModule* parent = getParent();
+  if (parent == nullptr) {
+    return getName();
+  }
+
+  dbBlock* block = parent->getOwner();
+  if (parent == block->getTopModule()) {
+    return getName();
+  }
+
+  return fmt::format("{}{}{}",  // NOLINT(misc-include-cleaner)
+                     parent->getModInst()->getHierarchicalName(),
+                     block->getHierarchyDelimiter(),
+                     getName());
+}
 
 void dbModBTerm::setModNet(dbModNet* modNet)
 {

src/odb/src/db/dbModITerm.cpp

@@ -15,6 +15,8 @@
 #include "dbTable.hpp"
 #include "odb/db.h"
 // User Code Begin Includes
+#include <string>
+
 #include "odb/dbBlockCallBackObj.h"
 // User Code End Includes
 namespace odb {
@@ -154,6 +156,28 @@ dbModInst* dbModITerm::getParent() const
 }
 
 // User Code Begin dbModITermPublicMethods
+std::string dbModITerm::getHierarchicalName() const
+{
+  dbModInst* modinst = getParent();
+  if (modinst == nullptr) {
+    return getName();
+  }
+
+  dbModule* module = modinst->getParent();
+  if (module == nullptr) {
+    return getName();
+  }
+
+  dbBlock* block = module->getOwner();
+  if (module == block->getTopModule()) {
+    return getName();
+  }
+
+  return fmt::format("{}{}{}",  // NOLINT(misc-include-cleaner)
+                     modinst->getHierarchicalName(),
+                     block->getHierarchyDelimiter(),
+                     getName());
+}
 
 void dbModITerm::setModNet(dbModNet* modNet)
 {

src/odb/src/db/dbModNet.cpp

@@ -25,6 +25,7 @@
 #include "dbModuleModNetITermItr.h"
 #include "dbModuleModNetModBTermItr.h"
 #include "dbModuleModNetModITermItr.h"
+#include "dbUtil.h"
 #include "odb/dbBlockCallBackObj.h"
 #include "utl/Logger.h"
 // User Code End Includes
@@ -413,9 +414,10 @@ dbSet<dbITerm> dbModNet::getITerms() const
   return dbSet<dbITerm>(_mod_net, _block->_module_modnet_iterm_itr);
 }
 
-unsigned dbModNet::connectionCount()
+unsigned dbModNet::connectionCount() const
 {
-  return (getITerms().size() + getBTerms().size() + getModITerms().size());
+  return (getITerms().size() + getBTerms().size() + getModITerms().size()
+          + getModBTerms().size());
 }
 
 dbNet* dbModNet::findRelatedNet() const
@@ -490,6 +492,17 @@ dbNet* dbModNet::findRelatedNet() const
   return nullptr;
 }
 
+void dbModNet::checkSanity() const
+{
+  std::vector<std::string> drvr_info_list;
+  dbUtil::findBTermDrivers(this, drvr_info_list);
+  dbUtil::findITermDrivers(this, drvr_info_list);
+  dbUtil::findModBTermDrivers(this, drvr_info_list);
+  dbUtil::findModITermDrivers(this, drvr_info_list);
+
+  dbUtil::checkNetSanity(this, drvr_info_list);
+}
+
 // User Code End dbModNetPublicMethods
 }  // namespace odb
    // Generator Code End Cpp

src/odb/src/db/dbNet.cpp

@@ -40,6 +40,7 @@
 #include "dbTable.hpp"
 #include "dbTech.h"
 #include "dbTechNonDefaultRule.h"
+#include "dbUtil.h"
 #include "dbWire.h"
 #include "odb/db.h"
 #include "odb/dbBlockCallBackObj.h"
@@ -2348,100 +2349,11 @@ void dbNet::setJumpers(bool has_jumpers)
 
 void dbNet::checkSanity() const
 {
-  _dbNet* net = (_dbNet*) this;
-  utl::Logger* logger = net->getImpl()->getLogger();
   std::vector<std::string> drvr_info_list;
+  dbUtil::findBTermDrivers(this, drvr_info_list);
+  dbUtil::findITermDrivers(this, drvr_info_list);
 
-  // Find BTerm drivers
-  for (dbBTerm* bterm : getBTerms()) {
-    if (bterm->getIoType() == dbIoType::INPUT
-        || bterm->getIoType() == dbIoType::INOUT) {
-      dbBlock* block = bterm->getBlock();
-      dbModule* parent_module = block->getTopModule();
-      drvr_info_list.push_back(
-          // NOLINTNEXTLINE(misc-include-cleaner)
-          fmt::format("\n  - bterm: '{}' (parent_module: '{}', block: '{}')",
-                      bterm->getName(),
-                      parent_module->getName(),
-                      block->getName()));
-    }
-  }
-
-  // Find ITerm drivers
-  for (dbITerm* iterm : getITerms()) {
-    if (iterm->getIoType() == dbIoType::OUTPUT
-        || iterm->getIoType() == dbIoType::INOUT) {
-      dbInst* inst = iterm->getInst();
-      dbMaster* master = inst->getMaster();
-      dbModule* parent_module = inst->getModule();
-      dbBlock* block = inst->getBlock();
-
-      std::string parent_module_name = "null";
-      if (parent_module) {
-        parent_module_name = parent_module->getName();
-      }
-
-      std::string master_name = "null";
-      if (master) {
-        master_name = master->getName();
-      }
-
-      std::string block_name = "null";
-      if (block) {
-        block_name = block->getName();
-      }
-
-      drvr_info_list.push_back(fmt::format(  // NOLINT(misc-include-cleaner)
-          "\n  - iterm: '{}' (block: '{}', parent_module: '{}', master: '{}')",
-          iterm->getName('/'),
-          block_name,
-          parent_module_name,
-          master_name));
-    }
-  }
-
-  size_t drvr_count = drvr_info_list.size();
-  if (drvr_count > 1) {
-    // Multiple drivers found.
-    logger->error(
-        utl::ODB,
-        49,
-        "SanityCheck: dbNet '{}' has multiple drivers: {}",
-        getName(),
-        fmt::join(drvr_info_list, ""));  // NOLINT(misc-include-cleaner)
-  }
-
-  const uint iterm_count = getITerms().size();
-  const uint bterm_count = getBTerms().size();
-
-  if (drvr_count == 0 && (iterm_count + bterm_count > 0)) {
-    logger->warn(
-        utl::ODB, 50, "SanityCheck: dbNet '{}' has no driver.", getName());
-  }
-
-  if (iterm_count + bterm_count < 2) {
-    // Skip power/ground net
-    if (getSigType().isSupply()) {
-      return;  // OK: Unconnected power/ground net
-    }
-
-    // A net connected to 1 terminal
-    if (iterm_count == 1
-        && (*(getITerms().begin()))->getIoType() == dbIoType::OUTPUT) {
-      return;  // OK: Unconnected output pin
-    }
-    if (bterm_count == 1
-        && (*(getBTerms().begin()))->getIoType() == dbIoType::INPUT) {
-      return;  // OK: Unconnected input port
-    }
-    logger->warn(utl::ODB,
-                 51,
-                 "SanityCheck: dbNet '{}' is dangling. It has less than 2 "
-                 "connections (# of ITerms = {}, # of BTerms = {}).",
-                 getName(),
-                 iterm_count,
-                 bterm_count);
-  }
+  dbUtil::checkNetSanity(this, drvr_info_list);
 }
 
 dbModInst* dbNet::findMainParentModInst() const