Revert "Revert "Merge pull request #346 from The-OpenROAD-Project/ARC""

This reverts commit 53ff70d.

Author: maliberty

include/openroad/OpenRoad.hh

@@ -98,6 +98,11 @@ namespace pdnsim {
 class PDNSim;
 }
 
+namespace antenna_checker {
+class AntennaChecker;
+}
+
+
 namespace ord {
 
 using std::string;
@@ -128,6 +133,7 @@ public:
   replace::Replace* getReplace() { return replace_; }
   pdnsim::PDNSim* getPDNSim() { return pdnsim_; }
   FastRoute::FastRouteKernel* getFastRoute() { return fastRoute_; }
+  antenna_checker::AntennaChecker *getAntennaChecker(){ return antennaChecker_; }
   // Return the bounding box of the db rows.
   odb::Rect getCore();
   // Return true if the command units have been initialized.
@@ -186,6 +192,7 @@ private:
   TritonCTS::TritonCTSKernel *tritonCts_;
   tapcell::Tapcell *tapcell_;
   OpenRCX::Ext *extractor_;
+  antenna_checker::AntennaChecker *antennaChecker_;
 #ifdef BUILD_OPENPHYSYN
   psn::Psn *psn_;
 #endif

src/CMakeLists.txt

@@ -30,6 +30,7 @@ set(OPENRCX_HOME ${OPENROAD_HOME}/src/OpenRCX)
 set(MPLACE_HOME ${PROJECT_SOURCE_DIR}/src/TritonMacroPlace)
 set(OPENPHYSYN_HOME ${PROJECT_SOURCE_DIR}/src/OpenPhySyn)
 set(PDNSIM_HOME ${PROJECT_SOURCE_DIR}/src/PDNSim)
+set(ANTENNACHECKER_HOME ${PROJECT_SOURCE_DIR}/src/antennachecker)
 
 set(OPENROAD_TCL_INIT ${CMAKE_CURRENT_BINARY_DIR}/OpenRoadTclInitVar.cc)
 
@@ -220,6 +221,7 @@ add_subdirectory(tapcell)
 add_subdirectory(TritonMacroPlace)
 add_subdirectory(OpenRCX)
 add_subdirectory(PDNSim)
+add_subdirectory(antennachecker)
 
 if(BUILD_OPENPHYSYN)
   add_subdirectory(OpenPhySyn)
@@ -255,6 +257,7 @@ target_include_directories(openroad
   ${TAPCELL_HOME}/include
   ${OPENRCX_HOME}/include
   ${PDNSIM_HOME}/include
+  ${ANTENNACHECKER_HOME}/include
   ${TCL_INCLUDE_PATH}
   ${Boost_INCLUDE_DIRS}
   )
@@ -285,6 +288,7 @@ target_link_libraries(openroad
   defout
   lefin
   lefout
+  antennachecker
   zutil
   ${TCL_LIBRARY}
 )

src/FastRoute

@@ -65,6 +65,7 @@
 #include "tapcell/MakeTapcell.h"
 #include "OpenRCX/MakeOpenRCX.h"
 #include "pdnsim/MakePDNSim.hh"
+#include "antennachecker/MakeAntennaChecker.hh"
 #ifdef BUILD_OPENPHYSYN
   #include "OpenPhySyn/MakeOpenPhySyn.hpp"
 #endif
@@ -157,6 +158,7 @@ OpenRoad::init(Tcl_Interp *tcl_interp)
   extractor_ = makeOpenRCX();
   replace_ = makeReplace();
   pdnsim_ = makePDNSim();
+  antennaChecker_ = makeAntennaChecker();
 #ifdef BUILD_OPENPHYSYN
   psn_ = makePsn();
 #endif
@@ -181,6 +183,7 @@ OpenRoad::init(Tcl_Interp *tcl_interp)
   initTritonMp(this);
   initOpenRCX(this);
   initPDNSim(this);
+  initAntennaChecker(this);
 #ifdef BUILD_OPENPHYSYN
     initPsn(this);
 #endif

src/OpenRoad.cc

@@ -0,0 +1,32 @@
+# BSD 3-Clause License
+#
+# Copyright (c) 2020, MICL, DD-Lab, University of Michigan
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+add_subdirectory(src)

src/antennachecker/CMakeLists.txt

@@ -0,0 +1,29 @@
+# Antenna Rule Checker
+
+Check antenna violations based on an input LEF and DEF file, a report
+will be generated to indicate violated nets. 4 APIs are provided as an interface with FastRoute to preemptively fix antenna violation as well as used for the diode insertion flow:
+
+## Antenna check Commands
+
+---
+
+ - `load_antenna_rules`: import antenna rules to ARC, must be called before other commands
+ - `check_antennas`: check antenna violations on all nets and generate a reportt
+
+## Antenna fix Commands
+
+---
+
+### Tcl commands
+
+ - `check_net_violation`: check if an input net is violated, return 1 if the net is violated
+   - -net_name: set the net name for checking
+ - `get_met_avail_length`: print the available metal length that can be added to a net, while keeping other layers unchange and PAR values meet the ratio
+   - -net_name: set the net name for calculation
+   - -routing_level: set the layer whose rest metal length will be returned
+
+### C++ commands
+
+ - `PAR_max_wire_length(dbNet * net, int routing_level)`
+   This function returns the max wire length allowed to add for a given net, in a
+   specific layer.

src/antennachecker/README.md

@@ -0,0 +1,186 @@
+
+// BSD 3-Clause License
+// 
+// Copyright (c) 2020, MICL, DD-Lab, University of Michigan
+// All rights reserved.
+// 
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+// 
+// * Redistributions of source code must retain the above copyright notice, this
+//   list of conditions and the following disclaimer.
+// 
+// * Redistributions in binary form must reproduce the above copyright notice,
+//   this list of conditions and the following disclaimer in the documentation
+//   and/or other materials provided with the distribution.
+// 
+// * Neither the name of the copyright holder nor the names of its
+//   contributors may be used to endorse or promote products derived from
+//   this software without specific prior written permission.
+// 
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+
+#include <tcl.h>
+#include <map>
+#include "opendb/db.h"
+#include "opendb/dbWireGraph.h"
+
+
+struct PARinfo
+{
+    std::pair<odb::dbWireGraph::Node*, std::vector<odb::dbWireGraph::Node*>> WirerootNode;
+    long unsigned int num_iterms;
+    double wire_area;
+    double side_wire_area;
+    double iterm_areas[2];
+    double PAR_value;
+    double PSR_value;
+    double diff_PAR_value;
+    double diff_PSR_value;
+};
+
+struct ARinfo
+{
+    odb::dbWireGraph::Node * WirerootNode;
+    odb::dbWireGraph::Node * GateNode;
+    bool violated_net;
+    double PAR_value;
+    double PSR_value;
+    double diff_PAR_value;
+    double diff_PSR_value;
+    double CAR_value;
+    double CSR_value;
+    double diff_CAR_value;
+    double diff_CSR_value;
+    double diff_area;
+};
+
+struct ANTENNAmodel
+{
+    odb::dbTechLayer* layer;
+
+    double metal_factor;
+    double diff_metal_factor;
+
+    double cut_factor;
+    double diff_cut_factor;
+
+    double side_metal_factor;
+    double diff_side_metal_factor;
+
+    double minus_diff_factor;
+    double plus_diff_factor;
+    double diff_metal_reduce_factor;
+
+    ANTENNAmodel& operator =(const ANTENNAmodel& am)
+    {
+        metal_factor = am.metal_factor;
+        diff_metal_factor = am.diff_metal_factor;
+        cut_factor = am.cut_factor;
+        diff_cut_factor = am.diff_cut_factor;
+        side_metal_factor = am.side_metal_factor;
+        diff_side_metal_factor = am.diff_side_metal_factor;
+        minus_diff_factor = am.minus_diff_factor;
+        plus_diff_factor = am.plus_diff_factor;
+        diff_metal_reduce_factor = am.diff_metal_reduce_factor;
+
+        return *this;
+    }
+
+
+};
+
+namespace antenna_checker  {
+
+using odb::dbNet;
+using odb::dbWire;
+using odb::dbSWire;
+using odb::dbInst;
+using odb::dbWireGraph;
+using odb::dbTechLayer;
+using odb::dbITerm;
+
+typedef std::pair<dbWireGraph::Node*, std::vector<dbWireGraph::Node*>> wireroots_info_vec;
+
+class AntennaChecker
+{
+
+public:
+    AntennaChecker();
+    ~AntennaChecker();
+    
+    void setDb( odb::dbDatabase *db ) { db_ = db; }
+    void set_verbose( bool verbose ) { verbose_ = verbose; }
+    void set_net_name( std::string net_name ) { net_name_ = net_name; }
+    void set_route_level( int route_level ) { route_level_ = route_level; }
+
+    dbNet* get_net( std::string net_name );
+    
+    template <class valueType>
+    double defdist( valueType value );
+
+    wireroots_info_vec find_segment_root(std::pair<dbWireGraph::Node*, std::vector<dbWireGraph::Node*>> node_info, int wire_level );
+    dbWireGraph::Node * find_segment_start( dbWireGraph::Node * node );
+    bool if_segment_root( dbWireGraph::Node * node, int wire_level );
+    
+    void find_wire_below_iterms( dbWireGraph::Node * node, double iterm_areas[2], int wire_level, std::set<dbITerm*>& iv, std::set<dbWireGraph::Node*>& nv);
+    std::pair<double, double> calculate_wire_area( dbWireGraph::Node * node, int wire_level, std::set<dbWireGraph::Node*>& nv, std::set<dbWireGraph::Node*>& level_nodes );
+
+    double get_via_area( dbWireGraph::Edge * edge );
+    dbTechLayer * get_via_layer( dbWireGraph::Edge * edge );
+    std::string get_via_name( dbWireGraph::Edge * edge );
+    double calculate_via_area( dbWireGraph::Node * node, int wire_level );
+    dbWireGraph::Edge * find_via( dbWireGraph::Node * node, int wire_level );
+
+    void find_car_path( dbWireGraph::Node * node, int wire_level, dbWireGraph::Node * goal, std::vector<dbWireGraph::Node *> &current_path, std::vector<dbWireGraph::Node *> &path_found );
+
+    void print_graph_info( dbWireGraph graph );
+    void calculate_PAR_table( std::vector<PARinfo>& PARtable );
+    bool check_iterm( dbWireGraph::Node* node, double iterm_areas[2] );
+    double get_pwl_factor(odb::dbTechLayerAntennaRule::pwl_pair pwl_info, double ref_val, double def);
+    
+    void build_wire_PAR_table( std::vector<PARinfo> &PARtable, std::vector<std::pair<dbWireGraph::Node *, std::vector<dbWireGraph::Node*>>> wireroots_info );
+    void build_wire_CAR_table( std::vector<ARinfo> &CARtable, std::vector<PARinfo> PARtable, std::vector<PARinfo> VIA_PARtable, std::vector<dbWireGraph::Node *> gate_iterms );
+    void build_VIA_PAR_table( std::vector<PARinfo> &VIA_PARtable, std::vector<std::pair<dbWireGraph::Node *,std::vector<dbWireGraph::Node*>>> wireroots_info );
+    void build_VIA_CAR_table( std::vector<ARinfo> &VIA_CARtable, std::vector<PARinfo> PARtable, std::vector<PARinfo> VIA_PARtable, std::vector<dbWireGraph::Node *> gate_iterms );
+
+    std::vector<wireroots_info_vec> get_wireroots(dbWireGraph graph);
+
+    bool check_wire_PAR( ARinfo AntennaRatio );
+    bool check_wire_CAR( ARinfo AntennaRatio );
+    bool check_VIA_PAR( ARinfo AntennaRatio );
+    bool check_VIA_CAR( ARinfo AntennaRatio );
+
+    std::vector<int> GetAntennaRatio();
+
+    void load_antenna_rules();
+    void check_antennas();
+    
+    void find_wireroot_iterms( dbWireGraph::Node * node, int wire_level, std::vector<dbITerm *>& gates );
+    std::vector<std::pair<double, std::vector<dbITerm *>>> PAR_max_wire_length( dbNet * net, int route_level );
+    void check_par_max_length();
+    std::vector<std::pair<int, std::vector<dbITerm *>>> get_net_antenna_violations( dbNet * net );
+    std::vector<std::pair<double, std::vector<dbITerm *>>> get_violated_wire_length( dbNet * net, int routing_level );
+
+private:
+    odb::dbDatabase *db_;
+    FILE* _out;
+    bool verbose_;
+    std::string net_name_;
+    int route_level_;
+    std::map<odb::dbTechLayer*, ANTENNAmodel> layer_info;
+
+
+};
+
+}

src/antennachecker/include/antennachecker/AntennaChecker.hh

@@ -0,0 +1,53 @@
+// BSD 3-Clause License
+// 
+// Copyright (c) 2020, MICL, DD-Lab, University of Michigan
+// All rights reserved.
+// 
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+// 
+// * Redistributions of source code must retain the above copyright notice, this
+//   list of conditions and the following disclaimer.
+// 
+// * Redistributions in binary form must reproduce the above copyright notice,
+//   this list of conditions and the following disclaimer in the documentation
+//   and/or other materials provided with the distribution.
+// 
+// * Neither the name of the copyright holder nor the names of its
+//   contributors may be used to endorse or promote products derived from
+//   this software without specific prior written permission.
+// 
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+
+#ifndef MAKE_ANTENNACHECKER_H
+#define MAKE_ANTENNACHECKER_H
+
+namespace antenna_checker {
+class AntennaChecker;
+}
+
+namespace ord {
+
+class OpenRoad;
+
+antenna_checker::AntennaChecker *
+makeAntennaChecker();
+
+void
+deleteAntennaChecker(antenna_checker::AntennaChecker *antennachecker);
+
+void
+initAntennaChecker(OpenRoad *openroad);
+
+} // namespace
+#endif