Merge branch 'master' into RefactorPlaceCpp

Author: Bill-hbrhbr

.travis.yml

@@ -113,6 +113,22 @@ jobs:
       script:
         - ./.github/travis/build.sh
         - travis_wait 30 ./run_reg_test.pl vtr_reg_basic -show_failures -j2
+    - stage: Test
+      name: "Basic Regression Tests with NO_GRAPHICS"
+      env:
+        - CMAKE_PARAMS="-DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DVPR_USE_EZGL=off"
+        - MATRIX_EVAL="CC=gcc-5 && CXX=g++-5"
+      script:
+        - ./.github/travis/build.sh
+        - travis_wait 30 ./run_reg_test.pl vtr_reg_basic -show_failures -j2
+    - stage: Test
+      name: "Basic Regression Tests with VTR_ENABLE_DEBUG_LOGGING"
+      env:
+        - CMAKE_PARAMS="-DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DVTR_ENABLE_DEBUG_LOGGING=on"
+        - MATRIX_EVAL="CC=gcc-5 && CXX=g++-5"
+      script:
+        - ./.github/travis/build.sh
+        - travis_wait 30 ./run_reg_test.pl vtr_reg_basic -show_failures -j2
     - stage: Test
       name: "Strong Regression Tests"
       env:

CMakeLists.txt

@@ -32,11 +32,15 @@ option(VTR_ENABLE_PROFILING "Enable performance profiler (gprof)" OFF)
 option(VTR_ENABLE_COVERAGE "Enable code coverage tracking (gcov)" OFF)
 option(VTR_ENABLE_DEBUG_LOGGING "Enable debug logging" OFF)
 
-#Allow the user to decide weather to compile the graphics library
+#Allow the user to decide whether to compile the graphics library
 set(VPR_USE_EZGL "auto" CACHE STRING "Specify whether vpr uses the graphics library")
 set_property(CACHE VPR_USE_EZGL PROPERTY STRINGS auto off on)
 option(VTR_ENABLE_CAPNPROTO "Enable capnproto binary serialization support in VPR." ON)
 
+#Allow the user to enable/disable VPR analytic placement
+#VPR option --enable_analytic_placer is also required for Analytic Placement
+option(VPR_ANALYTIC_PLACE "Enable analytic placement in VPR." ON)
+
 option(WITH_BLIFEXPLORER "Enable build with blifexplorer" OFF)
 
 option(WITH_ABC "Enable building abc" ON)

ODIN_II/SRC/simulate_blif.cpp

@@ -557,11 +557,11 @@ static int is_node_ready(nnode_t* node, int cycle) {
         for (i = 0; i < node->num_input_pins; i++) {
             npin_t* pin = node->input_pins[i];
 
-            bool has_missing_driver = false;
-            for (int j = 0; j < pin->net->num_driver_pins && !has_missing_driver; j++)
+            bool has_missing_driver = pin->net == NULL;
+            for (int j = 0; !has_missing_driver && j < pin->net->num_driver_pins; j++)
                 has_missing_driver = pin->net->driver_pins[j]->node == NULL;
 
-            if (!pin->net || has_missing_driver) {
+            if (has_missing_driver) {
                 bool already_flagged = false;
                 int j;
                 for (j = 0; j < node->num_undriven_pins; j++) {

libs/libvtrutil/src/vtr_geometry.h

@@ -110,6 +110,9 @@ class Rect {
     //Returns true if the point is coincident with the rectangle (including the top-right edges)
     bool coincident(Point<T> point) const;
 
+    //Returns true if other is contained within the rectangle (including all edges)
+    bool contains(const Rect<T>& other) const;
+
     //Returns true if no points are contained in the rectangle
     //  rect.empty() => not exists p. rect.contains(p)
     //  This also implies either the width or height is 0.

libs/libvtrutil/src/vtr_geometry.tpp

@@ -151,6 +151,13 @@ bool Rect<T>::coincident(Point<T> point) const {
            && point.y() >= ymin() && point.y() <= ymax();
 }
 
+template<class T>
+bool Rect<T>::contains(const Rect<T>& other) const {
+    //Including all edges
+    return other.xmin() >= xmin() && other.xmax() <= xmax()
+           && other.ymin() >= ymin() && other.ymax() <= ymax();
+}
+
 template<class T>
 bool Rect<T>::empty() const {
     return xmax() <= xmin() || ymax() <= ymin();

vpr/CMakeLists.txt

@@ -51,7 +51,25 @@ add_library(libvpr STATIC
              ${LIB_SOURCES}
 )
 
+
 target_include_directories(libvpr PUBLIC ${LIB_INCLUDE_DIRS})
+
+#VPR_ANALYTIC_PLACE is inisitalized in the root CMakeLists
+#Check Eigen dependency
+if(${VPR_ANALYTIC_PLACE})
+	message(STATUS "VPR Analytic Placement: Requested")
+	find_package(Eigen3 3.3 NO_MODULE)
+	if (TARGET Eigen3::Eigen)
+		message(STATUS "VPR Analytic Placement dependency (Eigen3): Found")
+		message(STATUS "VPR Analytic Placement: Enabled")
+		target_link_libraries (libvpr Eigen3::Eigen)
+		target_compile_definitions(libvpr PUBLIC -DENABLE_ANALYTIC_PLACE)
+	else ()
+		message(STATUS "VPR Analytic Placement dependency (Eigen3): Not Found (Download manually with sudo apt install libeigen3-dev, and rebuild)")
+		message(STATUS "VPR Analytic Placement: Disabled")
+	endif(TARGET Eigen3::Eigen)
+endif()
+
 set_target_properties(libvpr PROPERTIES PREFIX "") #Avoid extra 'lib' prefix
 
 #Specify link-time dependancies
@@ -62,7 +80,8 @@ target_link_libraries(libvpr
                         libblifparse
                         libtatum
                         libargparse
-                        libpugixml)
+                        libpugixml
+)
 
 #link graphics library only when graphics set to on
 if (VPR_USE_EZGL STREQUAL "on")

vpr/src/base/SetupVPR.cpp

@@ -574,6 +574,7 @@ static void SetupPlacerOpts(const t_options& Options, t_placer_opts* PlacerOpts)
 
     PlacerOpts->effort_scaling = Options.place_effort_scaling;
     PlacerOpts->timing_update_type = Options.timing_update_type;
+    PlacerOpts->enable_analytic_placer = Options.enable_analytic_placer;
 }
 
 static void SetupAnalysisOpts(const t_options& Options, t_analysis_opts& analysis_opts) {

vpr/src/base/ShowSetup.cpp

@@ -352,6 +352,8 @@ static void ShowRouterOpts(const t_router_opts& RouterOpts) {
             VTR_LOG("RouterOpts.routing_budgets_algorithm = DISABLE\n");
         } else if (RouterOpts.routing_budgets_algorithm == MINIMAX) {
             VTR_LOG("RouterOpts.routing_budgets_algorithm = MINIMAX\n");
+        } else if (RouterOpts.routing_budgets_algorithm == YOYO) {
+            VTR_LOG("RouterOpts.routing_budgets_algorithm = YOYO\n");
         } else if (RouterOpts.routing_budgets_algorithm == SCALE_DELAY) {
             VTR_LOG("RouterOpts.routing_budgets_algorithm = SCALE_DELAY\n");
         }
@@ -544,7 +546,7 @@ static void ShowPlacerOpts(const t_placer_opts& PlacerOpts,
             VTR_LOG("PlacerOpts.td_place_exp_last: %f\n", PlacerOpts.td_place_exp_last);
             VTR_LOG("PlacerOpts.delay_offset: %f\n", PlacerOpts.delay_offset);
             VTR_LOG("PlacerOpts.delay_ramp_delta_threshold: %d\n", PlacerOpts.delay_ramp_delta_threshold);
-            VTR_LOG("PlacerOpts.delay_ramp_slope: %d\n", PlacerOpts.delay_ramp_slope);
+            VTR_LOG("PlacerOpts.delay_ramp_slope: %f\n", PlacerOpts.delay_ramp_slope);
             VTR_LOG("PlacerOpts.tsu_rel_margin: %f\n", PlacerOpts.tsu_rel_margin);
             VTR_LOG("PlacerOpts.tsu_abs_margin: %f\n", PlacerOpts.tsu_abs_margin);
             VTR_LOG("PlacerOpts.post_place_timing_report_file: %s\n", PlacerOpts.post_place_timing_report_file.c_str());

vpr/src/base/read_options.cpp

@@ -203,6 +203,8 @@ struct RouteBudgetsAlgorithm {
         ConvertedValue<e_routing_budgets_algorithm> conv_value;
         if (str == "minimax")
             conv_value.set_value(MINIMAX);
+        else if (str == "yoyo")
+            conv_value.set_value(YOYO);
         else if (str == "scale_delay")
             conv_value.set_value(SCALE_DELAY);
         else if (str == "disable")
@@ -220,6 +222,8 @@ struct RouteBudgetsAlgorithm {
         ConvertedValue<std::string> conv_value;
         if (val == MINIMAX)
             conv_value.set_value("minimax");
+        else if (val == YOYO)
+            conv_value.set_value("yoyo");
         else if (val == DISABLE)
             conv_value.set_value("disable");
         else {
@@ -1739,6 +1743,13 @@ argparse::ArgumentParser create_arg_parser(std::string prog_name, t_options& arg
         .default_value("0")
         .show_in(argparse::ShowIn::HELP_ONLY);
 
+    place_grp.add_argument(args.enable_analytic_placer, "--enable_analytic_placer")
+        .help(
+            "Enables the analytic placer. "
+            "Once analytic placement is done, the result is passed through the quench phase of the annealing placer for local improvement")
+        .default_value("false")
+        .show_in(argparse::ShowIn::HELP_ONLY);
+
     auto& place_timing_grp = parser.add_argument_group("timing-driven placement options");
 
     place_timing_grp.add_argument(args.PlaceTimingTradeoff, "--timing_tradeoff")
@@ -2031,12 +2042,13 @@ argparse::ArgumentParser create_arg_parser(std::string prog_name, t_options& arg
 
     route_timing_grp.add_argument<e_routing_budgets_algorithm, RouteBudgetsAlgorithm>(args.routing_budgets_algorithm, "--routing_budgets_algorithm")
         .help(
-            "Controls how the routing budgets are created.\n"
-            " * slack: Sets the budgets depending on the amount slack between connections and the current delay values. [EXPERIMENTAL]\n"
-            " * criticality: Sets the minimum budgets to 0 and the maximum budgets as a function of delay and criticality (net delay/ pin criticality) [EXPERIMENTAL]\n"
+            "Controls how the routing budgets are created and applied.\n"
+            " * yoyo: Allocates budgets using minimax algorithm, and enables hold slack resolution in the router using the RCV algorithm. [EXPERIMENTAL]\n"
+            " * minimax: Sets the budgets depending on the amount slack between connections and the current delay values. [EXPERIMENTAL]\n"
+            " * scale_delay: Sets the minimum budgets to 0 and the maximum budgets as a function of delay and criticality (net delay/ pin criticality) [EXPERIMENTAL]\n"
             " * disable: Removes the routing budgets, use the default VPR and ignore hold time constraints\n")
         .default_value("disable")
-        .choices({"minimax", "scale_delay", "disable"})
+        .choices({"minimax", "scale_delay", "yoyo", "disable"})
         .show_in(argparse::ShowIn::HELP_ONLY);
 
     route_timing_grp.add_argument<bool, ParseOnOff>(args.save_routing_per_iteration, "--save_routing_per_iteration")

vpr/src/base/read_options.h

@@ -112,6 +112,7 @@ struct t_options {
     argparse::ArgValue<int> placement_saves_per_temperature;
     argparse::ArgValue<e_place_effort_scaling> place_effort_scaling;
     argparse::ArgValue<e_place_delta_delay_algorithm> place_delta_delay_matrix_calculation_method;
+    argparse::ArgValue<bool> enable_analytic_placer;
 
     /* Timing-driven placement options only */
     argparse::ArgValue<float> PlaceTimingTradeoff;

vpr/src/base/read_place.cpp

@@ -205,7 +205,7 @@ void read_place_body(std::ifstream& placement_file,
         } else if (tokens[0][0] == '#') {
             continue; //Skip commented lines
 
-        } else if (tokens.size() == 4 || (tokens.size() == 5 && tokens[4][0] == '#')) {
+        } else if (tokens.size() == 4 || (tokens.size() > 4 && tokens[4][0] == '#')) {
             //Load the block location
             //
             //We should have 4 tokens of actual data, with an optional 5th (commented) token indicating VPR's

vpr/src/base/vpr_types.h

@@ -1035,6 +1035,14 @@ struct t_placer_opts {
     std::string allowed_tiles_for_delay_model;
 
     e_place_delta_delay_algorithm place_delta_delay_matrix_calculation_method;
+
+    /*
+     * @brief enables the analytic placer.
+     *
+     * Once analytic placement is done, the result is passed through the quench phase
+     * of the annealing placer for local improvement
+     */
+    bool enable_analytic_placer;
 };
 
 /* All the parameters controlling the router's operation are in this        *
@@ -1115,10 +1123,13 @@ enum e_routing_failure_predictor {
     SAFE,
     AGGRESSIVE
 };
+
+// How to allocate budgets, and if RCV should be enabled
 enum e_routing_budgets_algorithm {
-    MINIMAX,
+    MINIMAX, // Use MINIMAX-PERT algorithm to allocate budgets
+    YOYO,    // Use MINIMAX as above, and enable RCV algorithm to resolve negative hold slack
     SCALE_DELAY,
-    DISABLE
+    DISABLE // Do not allocate budgets and run default router
 };
 
 enum class e_timing_report_detail {

vpr/src/draw/breakpoint.cpp

@@ -3,6 +3,7 @@
 
 #include <iostream>
 
+#ifndef NO_GRAPHICS
 //if the user adds a "proceed move" breakpoint using the entry field in the UI, this function converts it to the equivalent expression and calls the expression evaluator. Returns true if a breakpoint is encountered
 //the way the proceed moves breakpoint works is that it proceeds the indicated number of moves from where the placer currently is i.e if at move 3 and proceed 4 ends up at move 7
 bool check_for_moves_breakpoints(int moves_to_proceed) {
@@ -92,3 +93,4 @@ void print_current_info(bool in_placer) {
     else
         std::cout << "\nrouter_iter: " << get_bp_state_globals()->get_glob_breakpoint_state()->router_iter << "\nnet_id: " << get_bp_state_globals()->get_glob_breakpoint_state()->route_net_id << "\n----------------------------\n";
 }
+#endif