Merge pull request #10398 from calewis/refactor-odb-ptr-sets-jetski

Refactor odb ptr sets and maps to be deterministic and not use std::less

Author: maliberty

BUILD.bazel

@@ -14,7 +14,7 @@ load("//bazel:tcl_wrap_cc.bzl", "tcl_wrap_cc")
 
 package(
     features = [
-        "-parse_headers",
+        "parse_headers",
         "layering_check",
         # TODO(b/299593765): Fix strict ordering.
         "-libcxx_assertions",

src/Timing.cc

@@ -13,6 +13,7 @@
 
 #include "db_sta/dbNetwork.hh"
 #include "db_sta/dbSta.hh"
+#include "odb/PtrSetMap.h"
 #include "odb/db.h"
 #include "ord/Design.h"
 #include "ord/OpenRoad.hh"
@@ -282,7 +283,7 @@ std::vector<odb::dbMTerm*> Timing::getTimingFanoutFrom(odb::dbMTerm* input)
   sta::Port* port = network->dbToSta(input);
   sta::LibertyPort* lib_port = network->libertyPort(port);
 
-  std::set<odb::dbMTerm*> outputs;
+  odb::PtrSet<odb::dbMTerm> outputs;
   for (auto arc_set : lib_cell->timingArcSets(lib_port, /* to */ nullptr)) {
     const sta::TimingRole* role = arc_set->role();
     if (role->isTimingCheck() || role->isAsyncTimingCheck()

src/ant/src/AntennaChecker.cc

@@ -23,6 +23,7 @@
 #include "absl/synchronization/mutex.h"
 #include "boost/pending/disjoint_sets.hpp"
 #include "boost/polygon/polygon.hpp"
+#include "odb/PtrSetMap.h"
 #include "odb/db.h"
 #include "odb/dbShape.h"
 #include "odb/dbTypes.h"
@@ -910,7 +911,7 @@ int AntennaChecker::Impl::checkGates(odb::dbNet* db_net,
   }
 
   std::unordered_map<odb::dbITerm*, int> num_diodes_added;
-  std::map<odb::dbTechLayer*, std::set<odb::dbITerm*>> pin_added;
+  odb::PtrMap<odb::dbTechLayer, odb::PtrSet<odb::dbITerm>> pin_added;
   // if checkGates is used by repair antennas
   if (pin_violation_count > 0) {
     for (const auto& [gate, violation_layers] : gates_with_violations) {
@@ -1051,7 +1052,7 @@ void AntennaChecker::Impl::buildLayerMaps(odb::dbNet* db_net,
 {
   odb::dbWire* wires = db_net->getWire();
 
-  std::map<odb::dbTechLayer*, PolygonSet> set_by_layer;
+  odb::PtrMap<odb::dbTechLayer, PolygonSet> set_by_layer;
 
   wiresToPolygonSetMap(wires, set_by_layer);
   avoidPinIntersection(db_net, set_by_layer);

src/ant/src/AntennaCheckerImpl.hh

@@ -13,6 +13,7 @@
 
 #include "absl/synchronization/mutex.h"
 #include "ant/AntennaChecker.hh"
+#include "odb/PtrSetMap.h"
 #include "odb/db.h"
 #include "odb/dbWireGraph.h"
 
@@ -72,12 +73,12 @@ struct ViolationReport
   ViolationReport() { violated = false; }
 };
 
-using LayerToNodeInfo = std::map<odb::dbTechLayer*, NodeInfo>;
+using LayerToNodeInfo = odb::PtrMap<odb::dbTechLayer, NodeInfo>;
 using GraphNodes = std::vector<std::unique_ptr<GraphNode>>;
-using LayerToGraphNodes = std::map<odb::dbTechLayer*, GraphNodes>;
-using GateToLayerToNodeInfo = std::map<odb::dbITerm*, LayerToNodeInfo>;
+using LayerToGraphNodes = odb::PtrMap<odb::dbTechLayer, GraphNodes>;
+using GateToLayerToNodeInfo = odb::PtrMap<odb::dbITerm, LayerToNodeInfo>;
 using GateToViolationLayers
-    = std::map<odb::dbITerm*, std::set<odb::dbTechLayer*>>;
+    = odb::PtrMap<odb::dbITerm, odb::PtrSet<odb::dbTechLayer>>;
 
 class AntennaChecker::Impl
 {
@@ -171,11 +172,11 @@ class AntennaChecker::Impl
   odb::dbDatabase* db_{nullptr};
   odb::dbBlock* block_{nullptr};
   utl::Logger* logger_{nullptr};
-  std::map<odb::dbTechLayer*, AntennaModel> layer_info_;
+  odb::PtrMap<odb::dbTechLayer, AntennaModel> layer_info_;
   int net_violation_count_{0};
   std::string report_file_name_;
   std::vector<odb::dbNet*> nets_;
-  std::map<odb::dbNet*, ViolationReport> net_to_report_;
+  odb::PtrMap<odb::dbNet, ViolationReport> net_to_report_;
   absl::Mutex map_mutex_;
   // consts
   static constexpr int kMaxDiodeCountPerGate = 10;

src/ant/src/Polygon.cc

@@ -8,6 +8,7 @@
 
 #include "AntennaCheckerImpl.hh"
 #include "boost/polygon/polygon.hpp"
+#include "odb/PtrSetMap.h"
 #include "odb/db.h"
 #include "odb/dbShape.h"
 #include "odb/dbTransform.h"
@@ -50,8 +51,9 @@ std::vector<int> findNodesWithIntersection(const GraphNodes& graph_nodes,
   return ids;
 }
 
-void wiresToPolygonSetMap(odb::dbWire* wires,
-                          std::map<odb::dbTechLayer*, PolygonSet>& set_by_layer)
+void wiresToPolygonSetMap(
+    odb::dbWire* wires,
+    odb::PtrMap<odb::dbTechLayer, PolygonSet>& set_by_layer)
 {
   using gtl::operators::operator+=;
 
@@ -84,8 +86,9 @@ void wiresToPolygonSetMap(odb::dbWire* wires,
   }
 }
 
-void avoidPinIntersection(odb::dbNet* db_net,
-                          std::map<odb::dbTechLayer*, PolygonSet>& set_by_layer)
+void avoidPinIntersection(
+    odb::dbNet* db_net,
+    odb::PtrMap<odb::dbTechLayer, PolygonSet>& set_by_layer)
 {
   using gtl::operators::operator-=;
 

src/ant/src/Polygon.hh

@@ -12,6 +12,7 @@
 #include "ant/AntennaChecker.hh"
 #include "boost/functional/hash.hpp"
 #include "boost/polygon/polygon.hpp"
+#include "odb/PtrSetMap.h"
 #include "odb/db.h"
 #include "odb/geom.h"
 
@@ -42,9 +43,9 @@ std::vector<int> findNodesWithIntersection(const GraphNodes& graph_nodes,
                                            const Polygon& pol);
 void wiresToPolygonSetMap(
     odb::dbWire* wires,
-    std::map<odb::dbTechLayer*, PolygonSet>& set_by_layer);
+    odb::PtrMap<odb::dbTechLayer, PolygonSet>& set_by_layer);
 void avoidPinIntersection(
     odb::dbNet* db_net,
-    std::map<odb::dbTechLayer*, PolygonSet>& set_by_layer);
+    odb::PtrMap<odb::dbTechLayer, PolygonSet>& set_by_layer);
 
 }  // namespace ant

src/ant/src/WireBuilder.hh

@@ -10,6 +10,7 @@
 #include <utility>
 #include <vector>
 
+#include "odb/PtrSetMap.h"
 #include "odb/db.h"
 #include "odb/dbWireGraph.h"
 #include "odb/geom.h"
@@ -110,7 +111,7 @@ class WireBuilder
   odb::dbDatabase* db_{nullptr};
   odb::dbBlock* block_{nullptr};
   utl::Logger* logger_{nullptr};
-  std::map<odb::dbTechLayer*, odb::dbTechVia*> default_vias_;
+  odb::PtrMap<odb::dbTechLayer, odb::dbTechVia*> default_vias_;
 };
 
 }  // namespace ant

src/cts/include/cts/TritonCTS.h

@@ -12,6 +12,7 @@
 #include <utility>
 #include <vector>
 
+#include "odb/PtrSetMap.h"
 #include "odb/db.h"
 #include "odb/geom.h"
 #include "utl/Logger.h"
@@ -114,7 +115,7 @@ class TritonCTS
   void populateTritonCTS();
   void destroyClockModNet(sta::Pin* pin_driver);
   void writeClockNetsToDb(TreeBuilder* builder,
-                          std::set<odb::dbNet*>& clkLeafNets);
+                          odb::PtrSet<odb::dbNet>& clkLeafNets);
   void writeClockNDRsToDb(TreeBuilder* builder);
   int getNetSpacing(odb::dbTechLayer* layer, int width1, int width2);
   void incrementNumClocks() { ++numberOfClocks_; }
@@ -187,7 +188,7 @@ class TritonCTS
                                         Clock& clockNet);
   odb::dbITerm* getFirstInput(odb::dbInst* inst) const;
   odb::dbITerm* getSingleOutput(odb::dbInst* inst, odb::dbITerm* input) const;
-  void findClockRoots(sta::Clock* clk, std::set<odb::dbNet*>& clockNets);
+  void findClockRoots(sta::Clock* clk, odb::PtrSet<odb::dbNet>& clockNets);
   float getInputPinCap(odb::dbITerm* iterm);
   bool isSink(odb::dbITerm* iterm);
   ClockInst* getClockFromInst(odb::dbInst* inst);
@@ -224,11 +225,11 @@ class TritonCTS
   rsz::Resizer* resizer_ = nullptr;
   est::EstimateParasitics* estimate_parasitics_ = nullptr;
   std::vector<std::unique_ptr<TreeBuilder>> builders_;
-  std::set<odb::dbNet*> staClockNets_;
-  std::set<odb::dbNet*> visitedClockNets_;
-  std::map<odb::dbInst*, ClockInst*> inst2clkbuf_;
+  odb::PtrSet<odb::dbNet> staClockNets_;
+  odb::PtrSet<odb::dbNet> visitedClockNets_;
+  odb::PtrMap<odb::dbInst, ClockInst*> inst2clkbuf_;
   std::map<ClockInst*, ClockSubNet*> driver2subnet_;
-  std::map<odb::dbNet*, TreeBuilder*> net2builder_;
+  odb::PtrMap<odb::dbNet, TreeBuilder*> net2builder_;
 
   // db vars
   odb::dbDatabase* db_ = nullptr;

src/cts/src/CtsOptions.h

@@ -15,6 +15,7 @@
 
 #include "CtsObserver.h"
 #include "Util.h"
+#include "odb/PtrSetMap.h"
 #include "odb/db.h"
 #include "odb/dbBlockCallBackObj.h"
 #include "utl/Logger.h"
@@ -40,7 +41,7 @@ class CtsOptions : public odb::dbBlockCallBackObj
     DUMMY,
     TREE
   };
-  using MasterCount = std::map<odb::dbMaster*, int>;
+  using MasterCount = odb::PtrMap<odb::dbMaster, int>;
 
   CtsOptions(utl::Logger* logger, stt::SteinerTreeBuilder* sttBuildder)
       : logger_(logger), sttBuilder_(sttBuildder)

src/cts/src/LatencyBalancer.cpp

@@ -19,6 +19,7 @@
 #include "TreeBuilder.h"
 #include "Util.h"
 #include "cts/TritonCTS.h"
+#include "odb/PtrSetMap.h"
 #include "odb/db.h"
 #include "odb/dbObject.h"
 #include "odb/dbSet.h"
@@ -529,7 +530,7 @@ odb::dbITerm* LatencyBalancer::insertDelayBuffers(
     odb::dbInst* lastBuffer = nullptr;
 
     // Use load pins buffering at the end
-    std::set<odb::dbObject*> load_pins;
+    odb::PtrSet<odb::dbObject> load_pins;
     for (odb::dbITerm* sinkInput : sinksInput) {
       load_pins.insert(sinkInput);
     }