ant: use pimpl to simplify the public interface

Signed-off-by: Matt Liberty <[email protected]>

Author: maliberty

src/ant/BUILD

@@ -15,6 +15,7 @@ cc_library(
     name = "ant",
     srcs = [
         "src/AntennaChecker.cc",
+        "src/AntennaCheckerImpl.hh",
         "src/PinType.hh",
         "src/Polygon.cc",
         "src/Polygon.hh",

src/ant/include/ant/AntennaChecker.hh

@@ -3,90 +3,14 @@
 
 #pragma once
 
-#include <map>
-#include <mutex>
-#include <queue>
-#include <set>
-
 #include "odb/db.h"
-#include "odb/dbWireGraph.h"
 
 namespace utl {
 class Logger;
 }
 
 namespace ant {
 
-struct PARinfo;
-struct ARinfo;
-struct AntennaModel;
-class WireBuilder;
-
-///////////////////////////////////////
-struct GraphNode;
-
-struct NodeInfo
-{
-  double PAR;
-  double PSR;
-  double diff_PAR;
-  double diff_PSR;
-  double area;
-  double side_area;
-  double iterm_gate_area;
-  double iterm_diff_area;
-
-  double CAR;
-  double CSR;
-  double diff_CAR;
-  double diff_CSR;
-
-  // Defines the ratio between the current PAR and the allowed PAR
-  double excess_ratio_PAR;
-  // Defines the ratio between the current PSR and the allowed PSR
-  double excess_ratio_PSR;
-
-  std::vector<odb::dbITerm*> iterms;
-
-  NodeInfo& operator+=(const NodeInfo& a)
-  {
-    PAR += a.PAR;
-    PSR += a.PSR;
-    diff_PAR += a.diff_PAR;
-    diff_PSR += a.diff_PSR;
-    area += a.area;
-    side_area += a.side_area;
-    return *this;
-  }
-  NodeInfo()
-  {
-    PAR = 0.0;
-    PSR = 0.0;
-    diff_PAR = 0.0;
-    diff_PSR = 0.0;
-
-    area = 0.0;
-    side_area = 0.0;
-    iterm_gate_area = 0.0;
-    iterm_diff_area = 0.0;
-
-    CAR = 0.0;
-    CSR = 0.0;
-    diff_CAR = 0.0;
-    diff_CSR = 0.0;
-
-    excess_ratio_PAR = 1.0;
-    excess_ratio_PSR = 1.0;
-  }
-};
-
-struct ViolationReport
-{
-  bool violated;
-  std::string report;
-  ViolationReport() { violated = false; }
-};
-
 struct Violation
 {
   int routing_level;
@@ -95,13 +19,7 @@ struct Violation
   double excess_ratio;
 };
 
-using LayerToNodeInfo = std::map<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 Violations = std::vector<Violation>;
-using GateToViolationLayers
-    = std::map<odb::dbITerm*, std::set<odb::dbTechLayer*>>;
 
 class AntennaChecker
 {
@@ -117,96 +35,15 @@ class AntennaChecker
   Violations getAntennaViolations(odb::dbNet* net,
                                   odb::dbMTerm* diode_mterm,
                                   float ratio_margin);
-  void initAntennaRules();
   void setReportFileName(const char* file_name);
+
+  // Used in repair
+  void initAntennaRules();
   void makeNetWiresFromGuides(const std::vector<odb::dbNet*>& nets);
 
  private:
-  bool haveRoutedNets();
-  bool designIsPlaced();
-  bool haveGuides();
-  double getPwlFactor(odb::dbTechLayerAntennaRule::pwl_pair pwl_info,
-                      double ref_val,
-                      double def);
-  double diffArea(odb::dbMTerm* mterm);
-  double gateArea(odb::dbMTerm* mterm);
-  std::vector<std::pair<double, std::vector<odb::dbITerm*>>> parMaxWireLength(
-      odb::dbNet* net,
-      int layer);
-  std::vector<std::pair<double, std::vector<odb::dbITerm*>>>
-  getViolatedWireLength(odb::dbNet* net, int routing_level);
-  bool isValidGate(odb::dbMTerm* mterm);
-  void buildLayerMaps(odb::dbNet* net, LayerToGraphNodes& node_by_layer_map);
-  int checkNet(odb::dbNet* net,
-               bool verbose,
-               bool save_report,
-               odb::dbMTerm* diode_mterm,
-               float ratio_margin,
-               Violations& antenna_violations);
-  void saveGates(odb::dbNet* db_net,
-                 LayerToGraphNodes& node_by_layer_map,
-                 int node_count);
-  void calculateAreas(const LayerToGraphNodes& node_by_layer_map,
-                      GateToLayerToNodeInfo& gate_info);
-  void calculatePAR(GateToLayerToNodeInfo& gate_info);
-  void calculateCAR(GateToLayerToNodeInfo& gate_info);
-  bool checkRatioViolations(odb::dbNet* db_net,
-                            odb::dbTechLayer* layer,
-                            NodeInfo& node_info,
-                            float ratio_margin,
-                            bool verbose,
-                            bool report,
-                            ViolationReport& net_report);
-  void writeReport(std::ofstream& report_file, bool verbose);
-  void printReport(odb::dbNet* db_net);
-  int checkGates(odb::dbNet* db_net,
-                 bool verbose,
-                 bool save_report,
-                 odb::dbMTerm* diode_mterm,
-                 float ratio_margin,
-                 GateToLayerToNodeInfo& gate_info,
-                 Violations& antenna_violations);
-  void calculateViaPar(odb::dbTechLayer* tech_layer, NodeInfo& info);
-  void calculateWirePar(odb::dbTechLayer* tech_layer, NodeInfo& info);
-  bool checkPAR(odb::dbNet* db_net,
-                odb::dbTechLayer* tech_layer,
-                NodeInfo& info,
-                float ratio_margin,
-                bool verbose,
-                bool report,
-                ViolationReport& net_report);
-  bool checkPSR(odb::dbNet* db_net,
-                odb::dbTechLayer* tech_layer,
-                NodeInfo& info,
-                float ratio_margin,
-                bool verbose,
-                bool report,
-                ViolationReport& net_report);
-  bool checkCAR(odb::dbNet* db_net,
-                odb::dbTechLayer* tech_layer,
-                const NodeInfo& info,
-                bool verbose,
-                bool report,
-                ViolationReport& net_report);
-  bool checkCSR(odb::dbNet* db_net,
-                odb::dbTechLayer* tech_layer,
-                const NodeInfo& info,
-                bool verbose,
-                bool report,
-                ViolationReport& net_report);
-
-  std::unique_ptr<ant::WireBuilder> wire_builder_;
-  odb::dbDatabase* db_{nullptr};
-  odb::dbBlock* block_{nullptr};
-  utl::Logger* logger_{nullptr};
-  std::map<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_;
-  std::mutex map_mutex_;
-  // consts
-  static constexpr int max_diode_count_per_gate = 10;
+  class Impl;
+  std::unique_ptr<Impl> impl_;
 };
 
 }  // namespace ant