Merge pull request #8081 from The-OpenROAD-Project-staging/secure-refactor-api-name

Refactor: Changed API names (getOrFindFlat*Net -> findFlat*Net)

Author: maliberty

src/dbSta/include/db_sta/dbNetwork.hh

@@ -298,11 +298,26 @@ class dbNetwork : public ConcreteNetwork
   NetTermIterator* termIterator(const Net* net) const override;
   const Net* highestConnectedNet(Net* net) const override;
   bool isSpecial(Net* net);
+
+  // Get the flat net (dbNet) with the Net*.
+  // If the net is a hierarchical net (dbModNet), return nullptr
   dbNet* flatNet(const Net* net) const;
-  Net* getOrFindFlatNet(const Net* net) const;
-  dbNet* getOrFindFlatDbNet(const Net* net) const;
-  Net* getOrFindFlatNet(const Pin* pin) const;
-  dbNet* getOrFindFlatDbNet(const Pin* pin) const;
+
+  // Given a net or pin that may be hierarchical, find the corresponding flat
+  // dbNet by traversing the netlist.
+  // If the net is already a flat net (dbNet), it is returned as is.
+  // If the net is a hierarchical net (dbModNet), find the associated dbNet.
+  dbNet* findFlatDbNet(const Net* net) const;
+  dbNet* findFlatDbNet(const Pin* pin) const;
+
+  // Given a net that may be hierarchical, find the corresponding flat dbNet by
+  // traversing the netlist and return it as Net*.
+  // If the net is already a flat net, it is returned as is.
+  // If the net is a hierarchical net (dbModNet), find the associated dbNet and
+  // return it as Net*.
+  Net* findFlatNet(const Net* net) const;
+  Net* findFlatNet(const Pin* pin) const;
+
   bool hasPort(const Net* net) const;
 
   ////////////////////////////////////////////////////////////////

src/dbSta/src/dbNetwork.cc

@@ -2655,7 +2655,7 @@ Net* dbNetwork::mergedInto(Net*)
 
 bool dbNetwork::isSpecial(Net* net)
 {
-  dbNet* db_net = getOrFindFlatDbNet(net);
+  dbNet* db_net = findFlatDbNet(net);
   return (db_net && db_net->isSpecial());
 }
 
@@ -3977,15 +3977,15 @@ void dbNetwork::checkAxioms()
 // If the net is already a flat net, it is returned as is.
 // If the net is a hierarchical net (dbModNet), find the associated dbNet and
 // return it as Net*.
-Net* dbNetwork::getOrFindFlatNet(const Net* net) const
+Net* dbNetwork::findFlatNet(const Net* net) const
 {
-  return dbToSta(getOrFindFlatDbNet(net));
+  return dbToSta(findFlatDbNet(net));
 }
 
 // Given a net that may be hierarchical, find the corresponding flat dbNet.
 // If the net is already a flat net (dbNet), it is returned as is.
 // If the net is a hierarchical net (dbModNet), find the associated dbNet.
-dbNet* dbNetwork::getOrFindFlatDbNet(const Net* net) const
+dbNet* dbNetwork::findFlatDbNet(const Net* net) const
 {
   if (!net) {
     return nullptr;
@@ -4010,14 +4010,14 @@ dbNet* dbNetwork::getOrFindFlatDbNet(const Net* net) const
 
 // Find the flat net connected to the pin.
 // This function handles both internal instance pins and top-level port pins.
-Net* dbNetwork::getOrFindFlatNet(const Pin* pin) const
+Net* dbNetwork::findFlatNet(const Pin* pin) const
 {
-  return dbToSta(getOrFindFlatDbNet(pin));
+  return dbToSta(findFlatDbNet(pin));
 }
 
 // Find the flat net (dbNet) connected to the pin in the OpenDB database.
 // This function handles both internal instance pins and top-level port pins.
-dbNet* dbNetwork::getOrFindFlatDbNet(const Pin* pin) const
+dbNet* dbNetwork::findFlatDbNet(const Pin* pin) const
 {
   dbNet* db_net = nullptr;
   if (isTopLevelPort(pin)) {

src/est/src/EstimateParasitics.cpp

@@ -993,7 +993,7 @@ SteinerTree* EstimateParasitics::makeSteinerTree(const Pin* drvr_pin)
   /*
     Handle hierarchy. Make sure all traversal on dbNets.
    */
-  odb::dbNet* db_net = db_network_->getOrFindFlatDbNet(drvr_pin);
+  odb::dbNet* db_net = db_network_->findFlatDbNet(drvr_pin);
   Net* net = db_network_->dbToSta(db_net);
 
   debugPrint(logger_, EST, "steiner", 1, "Net {}", sdc_network->pathName(net));

src/gui/src/staGuiInterface.cpp

@@ -724,7 +724,7 @@ sta::Net* ClockTree::getNet(const sta::Pin* pin) const
 {
   sta::Term* term = network_->term(pin);
   sta::Net* net = term ? network_->net(term) : network_->net(pin);
-  return network_->getOrFindFlatNet(net);
+  return network_->findFlatNet(net);
 }
 
 bool ClockTree::isLeaf(const sta::Pin* pin) const

src/rsz/src/BufferedNet.cc

@@ -743,7 +743,7 @@ static BufferedNetPtr makeBufferedNet(
 BufferedNetPtr Resizer::makeBufferedNetGroute(const Pin* drvr_pin,
                                               const Corner* corner)
 {
-  dbNet* db_net = db_network_->getOrFindFlatDbNet(drvr_pin);
+  dbNet* db_net = db_network_->findFlatDbNet(drvr_pin);
   const Net* net = db_network_->dbToSta(db_net);
   assert(db_net != nullptr);
   std::vector<grt::PinGridLocation> pin_grid_locs

src/rsz/src/Resizer.cc

@@ -3999,8 +3999,8 @@ void Resizer::cloneClkInverter(Instance* inv)
   inv_cell->bufferPorts(in_port, out_port);
   Pin* in_pin = network_->findPin(inv, in_port);
   Pin* out_pin = network_->findPin(inv, out_port);
-  Net* in_net = db_network_->getOrFindFlatNet(in_pin);
-  dbNet* in_net_db = db_network_->getOrFindFlatDbNet(in_net);
+  Net* in_net = db_network_->findFlatNet(in_pin);
+  dbNet* in_net_db = db_network_->findFlatDbNet(in_net);
   Net* out_net = network_->isTopLevelPort(out_pin)
                      ? network_->net(network_->term(out_pin))
                      : network_->net(out_pin);

src/rsz/src/UnbufferMove.cc

@@ -303,8 +303,8 @@ bool UnbufferMove::canRemoveBuffer(Instance* buffer, bool honorDontTouchFixed)
   Pin* out_pin = db_network_->findPin(buffer, out_port);
   Net* in_net = db_network_->net(in_pin);
   Net* out_net = db_network_->net(out_pin);
-  dbNet* in_db_net = db_network_->getOrFindFlatDbNet(in_net);
-  dbNet* out_db_net = db_network_->getOrFindFlatDbNet(out_net);
+  dbNet* in_db_net = db_network_->findFlatDbNet(in_net);
+  dbNet* out_db_net = db_network_->findFlatDbNet(out_net);
   // honor net dont-touch on input net or output net
   if ((in_db_net && in_db_net->isDoNotTouch())
       || (out_db_net && out_db_net->isDoNotTouch())) {