Merge pull request #8684 from The-OpenROAD-Project-staging/secure-fix-swap-master

Fixed wrong netlist editing issues caused by dbModInst::swapMaster().

Author: maliberty

src/dbSta/include/db_sta/dbNetwork.hh

@@ -72,14 +72,14 @@ class dbNetwork : public ConcreteNetwork
   CellPortIterator* portIterator(const Cell* cell) const override;
 
   // sanity checkers
-  void checkAxioms() const;
+  void checkAxioms(odb::dbObject* obj = nullptr) const;
   void checkSanityModBTerms() const;
   void checkSanityModITerms() const;
   void checkSanityModuleInsts() const;
   void checkSanityModInstTerms() const;
   void checkSanityUnusedModules() const;
   void checkSanityTermConnectivity() const;
-  void checkSanityNetConnectivity() const;
+  void checkSanityNetConnectivity(odb::dbObject* obj = nullptr) const;
   void checkSanityInstNames() const;
   void checkSanityNetNames() const;
   void checkSanityModNetNamesInModule(odb::dbModule* module) const;

src/dbSta/src/dbNetwork.cc

@@ -65,6 +65,7 @@ Recommended conclusion: use map for concrete cells. They are invariant.
 #include "odb/dbSet.h"
 #include "odb/dbTypes.h"
 #include "sta/Liberty.hh"
+#include "sta/Network.hh"
 #include "sta/NetworkClass.hh"
 #include "sta/PatternMatch.hh"
 #include "sta/PortDirection.hh"
@@ -4130,8 +4131,15 @@ void dbNetwork::accumulateFlatLoadPinsOnNet(
 }
 
 // Use this API to check if flat & hier connectivities are ok
-void dbNetwork::checkAxioms() const
+void dbNetwork::checkAxioms(odb::dbObject* obj) const
 {
+  // Check with an object if provided
+  if (obj != nullptr) {
+    checkSanityNetConnectivity(obj);
+    return;
+  }
+
+  // Otherwise, check the whole design
   checkSanityModBTerms();
   checkSanityModITerms();
   checkSanityModInstTerms();
@@ -4458,79 +4466,90 @@ void dbNetwork::checkSanityTermConnectivity() const
   }
 }
 
-void dbNetwork::checkSanityNetConnectivity() const
+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) {
-    findRelatedDbNet(mod_net);
-  }
-
-  // Check for incomplete flat net connections
-  for (odb::dbNet* net_db : block_->getNets()) {
-    // Check for multiple drivers.
-    Net* net = dbToSta(net_db);
-    PinSeq loads;
-    PinSeq drvrs;
-    PinSet visited_drvrs(this);
-    FindNetDrvrLoads visitor(nullptr, visited_drvrs, loads, drvrs, this);
-    NetSet visited_nets(this);
-    visitConnectedPins(net, visitor, visited_nets);
-
-    if (drvrs.size() > 1) {
-      bool all_tristate = true;
-      for (const Pin* drvr : drvrs) {
-        LibertyPort* port = libertyPort(drvr);
-        if (!port || !port->direction()->isAnyTristate()) {
-          all_tristate = false;
-          break;
+  //
+  // Check for a specific object if provided
+  //
+  if (obj != nullptr) {
+    // Collect relevant nets from the provided object
+    std::set<odb::dbNet*> nets_to_check;
+    std::set<odb::dbModNet*> mod_nets_to_check;
+
+    auto const obj_type = obj->getObjectType();
+    if (obj_type == odb::dbNetObj) {
+      nets_to_check.insert(static_cast<odb::dbNet*>(obj));
+    } else if (obj_type == odb::dbModNetObj) {
+      mod_nets_to_check.insert(static_cast<odb::dbModNet*>(obj));
+    } else if (obj_type == odb::dbInstObj) {
+      auto inst = static_cast<odb::dbInst*>(obj);
+      for (auto iterm : inst->getITerms()) {
+        if (iterm->getNet() != nullptr) {
+          nets_to_check.insert(iterm->getNet());
+        }
+        if (iterm->getModNet() != nullptr) {
+          mod_nets_to_check.insert(iterm->getModNet());
         }
       }
-
-      if (!all_tristate) {
-        std::string drivers_str;
-        for (const Pin* drvr : drvrs) {
-          drivers_str += " " + std::string(pathName(drvr));
+    } else if (obj_type == odb::dbModInstObj) {
+      auto mod_inst = static_cast<odb::dbModInst*>(obj);
+      for (auto mod_iterm : mod_inst->getModITerms()) {
+        if (mod_iterm->getModNet() != nullptr) {
+          mod_nets_to_check.insert(mod_iterm->getModNet());
         }
-        logger_->error(
-            ORD,
-            2049,
-            "SanityCheck: Net '{}' has multiple non-tristate drivers:{}",
-            name(net),
-            drivers_str);
       }
-    }
-    const uint iterm_count = net_db->getITerms().size();
-    const uint bterm_count = net_db->getBTerms().size();
-    if (iterm_count + bterm_count >= 2) {
-      continue;
+    } else if (obj_type == odb::dbITermObj) {
+      auto iterm = static_cast<odb::dbITerm*>(obj);
+      if (iterm->getNet() != nullptr) {
+        nets_to_check.insert(iterm->getNet());
+      }
+      if (iterm->getModNet() != nullptr) {
+        mod_nets_to_check.insert(iterm->getModNet());
+      }
+    } else if (obj_type == odb::dbBTermObj) {
+      auto bterm = static_cast<odb::dbBTerm*>(obj);
+      if (bterm->getNet() != nullptr) {
+        nets_to_check.insert(bterm->getNet());
+      }
+      if (bterm->getModNet() != nullptr) {
+        mod_nets_to_check.insert(bterm->getModNet());
+      }
+    } else if (obj_type == odb::dbModITermObj) {
+      auto mod_iterm = static_cast<odb::dbModITerm*>(obj);
+      if (mod_iterm->getModNet() != nullptr) {
+        mod_nets_to_check.insert(mod_iterm->getModNet());
+      }
+    } else if (obj_type == odb::dbModBTermObj) {
+      auto mod_bterm = static_cast<odb::dbModBTerm*>(obj);
+      if (mod_bterm->getModNet() != nullptr) {
+        mod_nets_to_check.insert(mod_bterm->getModNet());
+      }
     }
 
-    // Skip power/ground net
-    if (net_db->getSigType().isSupply()) {
-      continue;  // OK: Unconnected power/ground net
+    // Now run checks on the collected nets.
+    for (odb::dbModNet* mod_net : mod_nets_to_check) {
+      findRelatedDbNet(mod_net);
     }
 
-    // A net connected to 1 terminal
-    if (iterm_count == 1) {
-      odb::dbITerm* iterm = *(net_db->getITerms().begin());
-      if (iterm->getIoType() == odb::dbIoType::OUTPUT) {
-        continue;  // OK: Unconnected output pin
-      }
-    } else if (bterm_count == 1) {  // This is a top level port
-      odb::dbBTerm* bterm = *(net_db->getBTerms().begin());
-      if (bterm->getIoType() == odb::dbIoType::INPUT) {
-        continue;  // OK: Unconnected input port
-      }
+    for (odb::dbNet* net_db : nets_to_check) {
+      net_db->checkSanity();
     }
+    return;
+  }
 
-    logger_->warn(ORD,
-                  2039,
-                  "SanityCheck: Net '{}' has less than 2 connections (# of "
-                  "ITerms = {}, # of BTerms = {}).",
-                  net_db->getName(),
-                  iterm_count,
-                  bterm_count);
+  //
+  // Check for all nets in the design
+  //
+
+  // Check for hier net and flat net connectivity
+  dbSet<dbModNet> mod_nets = block()->getModNets();
+  for (dbModNet* mod_net : mod_nets) {
+    findRelatedDbNet(mod_net);
+  }
+
+  // Check for incomplete flat net connections
+  for (odb::dbNet* net_db : block()->getNets()) {
+    net_db->checkSanity();
   }
 }
 

src/dbSta/test/check_axioms.ok

@@ -1,7 +1,10 @@
 [INFO ODB-0227] LEF file: Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
-[WARNING ORD-2039] SanityCheck: Net 'out_unconnected' has less than 2 connections (# of ITerms = 0, # of BTerms = 1).
-[WARNING ORD-2039] SanityCheck: Net 'single_conn_wire' has less than 2 connections (# of ITerms = 0, # of BTerms = 0).
-[WARNING ORD-2039] SanityCheck: Net 'w2' has less than 2 connections (# of ITerms = 0, # of BTerms = 1).
+[WARNING ORD-0011] Hierarchical flow (-hier) is currently in development and may cause multiple issues. Do not use in production environments.
+[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).
+[WARNING ODB-0050] SanityCheck: dbNet 'w2' has no driver.
+[WARNING ODB-0051] SanityCheck: dbNet 'w2' is dangling. It has less than 2 connections (# of ITerms = 0, # of BTerms = 1).
 [WARNING ORD-2038] SanityCheck: Module 'i_empty' has no instances.
 [WARNING ORD-2038] SanityCheck: Module 'u1' has no instances.
 [WARNING ORD-2038] SanityCheck: Module 'u2' has no instances.

src/dbSta/test/check_axioms.tcl

@@ -5,7 +5,7 @@ source "helpers.tcl"
 read_liberty Nangate45/Nangate45_typ.lib
 read_lef Nangate45/Nangate45.lef
 read_verilog check_axioms.v
-link_design top
+link_design top -hier
 
 # Run the checks and capture output.
 # The 'catch' command is used because sta::check_axioms will exit with an

src/dbSta/test/check_axioms.v

@@ -1,5 +1,4 @@
 // A standard cell definition for the test.
-// Defined as a blackbox to prevent yosys from optimizing it away.
 module and2 (input A, input B, output Z);
 endmodule
 
@@ -19,18 +18,19 @@ module top (
     output out_unconnected // For ORD-2040
 );
 
-    // For ORD-2038: An instance of a module that has no instances inside.
+    // [WARNING ORD-2038] SanityCheck: Module 'i_empty' has no instances.
     empty_module i_empty();
 
-    // For ORD-2041: non-output ITerm not connected.
+    // [ODB-0050] SanityCheck: 'w2' has no driver.
+    // [ODB-0051] SanityCheck: 'w2' has less than 2 connections
     wire w1, w2;
     and2 u1 (.A(w1), .B(), .Z(w2));
 
-    // For ORD-2039: Net with < 2 connections.
+    // [ODB-0051] SanityCheck: 'single_conn_wire' has less than 2 connections
     wire single_conn_wire;
     and2 u2 (.A(single_conn_wire), .B(top_in), .Z());
 
-    wire dangling_wire; // another case for ORD-2039
+    wire dangling_wire;
 
     // Normal connection to make the design valid for linking.
     assign top_out = w2;

src/odb/include/odb/db.h

@@ -943,7 +943,7 @@ class dbBlock : public dbObject
   /// A hierarchy delimiter can only be set at the time
   /// a block is created.
   ///
-  char getHierarchyDelimiter();
+  char getHierarchyDelimiter() const;
 
   ///
   /// Set the bus name delimiters
@@ -1306,6 +1306,8 @@ class dbBlock : public dbObject
                               const dbNameUniquifyType& uniquify
                               = dbNameUniquifyType::ALWAYS);
 
+  const char* getBaseName(const char* full_name) const;
+
   ///
   /// return the regions of this design
   ///
@@ -1845,7 +1847,7 @@ class dbNet : public dbObject
   ///
   /// Get the Regular Wiring of a net (TODO: per path)
   ///
-  dbWireType getWireType();
+  dbWireType getWireType() const;
 
   ///
   /// Set the Regular Wiring of a net (TODO: per path)
@@ -1855,7 +1857,7 @@ class dbNet : public dbObject
   ///
   /// Get the signal type of this block-net.
   ///
-  dbSigType getSigType();
+  dbSigType getSigType() const;
 
   ///
   /// Get the signal type of this block-net.
@@ -1964,7 +1966,7 @@ class dbNet : public dbObject
   ///
   /// Returns true if the don't-touch flag is set.
   ///
-  bool isDoNotTouch();
+  bool isDoNotTouch() const;
 
   ///
   /// Get the block this net belongs to.
@@ -2028,7 +2030,7 @@ class dbNet : public dbObject
   /// Returns true if this dbNet is marked as special. Special nets/iterms are
   /// declared in the SPECIAL NETS section of a DEF file.
   ///
-  bool isSpecial();
+  bool isSpecial() const;
 
   ///
   /// Mark this dbNet as special.
@@ -2501,6 +2503,16 @@ class dbNet : public dbObject
   /// related to this flat net.
   ///
   void renameWithModNetInHighestHier();
+
+  ///
+  /// Check issues such as multiple drivers, no driver, or dangling net
+  ///
+  void checkSanity() const;
+
+  ///
+  /// Dump dbNet info for debugging
+  ///
+  void dump() const;
 };
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -8380,6 +8392,12 @@ class dbModNet : public dbObject
   void disconnectAllTerms();
   void dump() const;
 
+  // Find the flat net (dbNet) associated with this hierarchical net (dbModNet).
+  // A dbModNet should be associated with a single dbNet.
+  // This function traverses the terminals connected to this dbModNet
+  // and returns the first dbNet it finds.
+  dbNet* findRelatedNet() const;
+
   static dbModNet* getModNet(dbBlock* block, uint id);
   static dbModNet* create(dbModule* parentModule, const char* base_name);
   static dbSet<dbModNet>::iterator destroy(dbSet<dbModNet>::iterator& itr);
@@ -8408,15 +8426,15 @@ class dbModule : public dbObject
 
   dbBlock* getOwner();
 
-  dbSet<dbModInst> getChildren();
-  dbSet<dbModInst> getModInsts();
+  dbSet<dbModInst> getChildren() const;
+  dbSet<dbModInst> getModInsts() const;
   dbSet<dbModNet> getModNets();
   // Get the ports of a module (STA world uses ports, which contain members).
   dbSet<dbModBTerm> getPorts();
   // Get the leaf level connections on a module (flat connected view).
   dbSet<dbModBTerm> getModBTerms() const;
   dbModBTerm* getModBTerm(uint id);
-  dbSet<dbInst> getInsts();
+  dbSet<dbInst> getInsts() const;
 
   dbModInst* findModInst(const char* name);
   dbInst* findDbInst(const char* name);
@@ -8430,6 +8448,8 @@ class dbModule : public dbObject
   const dbModBTerm* getHeadDbModBTerm() const;
   bool canSwapWith(dbModule* new_module) const;
   bool isTop() const;
+  bool containsDbInst(dbInst* inst) const;
+  bool containsDbModInst(dbModInst* inst) const;
 
   static dbModule* create(dbBlock* block, const char* name);
 

src/odb/src/db/dbBlock.cpp

@@ -2164,7 +2164,7 @@ int64_t dbBlock::micronsAreaToDbu(const double micronsArea)
   return static_cast<int64_t>(std::round(dbuArea));
 }
 
-char dbBlock::getHierarchyDelimiter()
+char dbBlock::getHierarchyDelimiter() const
 {
   _dbBlock* block = (_dbBlock*) this;
   return block->_hier_delimiter;
@@ -3855,4 +3855,17 @@ std::string dbBlock::makeNewInstName(dbModInst* parent,
       parent, base_name, uniquify, block->_unique_inst_index, exists);
 }
 
+const char* dbBlock::getBaseName(const char* full_name) const
+{
+  // If name contains the hierarchy delimiter, use the partial string
+  // after the last occurrence of the hierarchy delimiter.
+  // This prevents a very long term/net name creation when the name
+  // begins with a back-slash as "\soc/module1/instance_a/.../clk_port"
+  const char* last_hier_delimiter = strrchr(full_name, getHierarchyDelimiter());
+  if (last_hier_delimiter != nullptr) {
+    return last_hier_delimiter + 1;
+  }
+  return full_name;
+}
+
 }  // namespace odb