check_route: add option to disable, quick check or full check

The difference between the "quick" and "full" check is the non-configurable
nodes that are checked in the "full" and skipped with the "quick" option

Signed-off-by: Alessandro Comodi <[email protected]>

Author: acomodi

vpr/src/base/SetupVPR.cpp

@@ -381,8 +381,7 @@ static void SetupRouterOpts(const t_options& Options, t_router_opts* RouterOpts)
     RouterOpts->router_heap = Options.router_heap;
     RouterOpts->exit_after_first_routing_iteration = Options.exit_after_first_routing_iteration;
 
-    RouterOpts->disable_check_route = Options.disable_check_route;
-    RouterOpts->quick_check_route = Options.quick_check_route;
+    RouterOpts->check_route = Options.check_route;
 }
 
 static void SetupAnnealSched(const t_options& Options,

vpr/src/base/read_options.cpp

@@ -858,6 +858,41 @@ struct ParseRouterHeap {
     }
 };
 
+struct ParseCheckRoute {
+    ConvertedValue<e_check_route_option> from_str(std::string str) {
+        ConvertedValue<e_check_route_option> conv_value;
+        if (str == "off")
+            conv_value.set_value(e_check_route_option::OFF);
+        else if (str == "quick")
+            conv_value.set_value(e_check_route_option::QUICK);
+        else if (str == "full")
+            conv_value.set_value(e_check_route_option::FULL);
+        else {
+            std::stringstream msg;
+            msg << "Invalid conversion from '" << str << "' to e_check_route_option (expected one of: " << argparse::join(default_choices(), ", ") << ")";
+            conv_value.set_error(msg.str());
+        }
+        return conv_value;
+    }
+
+    ConvertedValue<std::string> to_str(e_check_route_option val) {
+        ConvertedValue<std::string> conv_value;
+        if (val == e_check_route_option::OFF)
+            conv_value.set_value("off");
+        else if (val == e_check_route_option::QUICK)
+            conv_value.set_value("quick");
+        else {
+            VTR_ASSERT(val == e_check_route_option::FULL);
+            conv_value.set_value("full");
+        }
+        return conv_value;
+    }
+
+    std::vector<std::string> default_choices() {
+        return {"off", "quick", "full"};
+    }
+};
+
 struct ParsePlaceEfforScaling {
     ConvertedValue<e_place_effort_scaling> from_str(std::string str) {
         ConvertedValue<e_place_effort_scaling> conv_value;
@@ -1887,14 +1922,13 @@ argparse::ArgumentParser create_arg_parser(std::string prog_name, t_options& arg
         .default_value("off")
         .show_in(argparse::ShowIn::HELP_ONLY);
 
-    route_timing_grp.add_argument<bool, ParseOnOff>(args.disable_check_route, "--disable_check_route")
-        .help("Disables check_route once routing step has finished or when routing file is loaded")
-        .default_value("off")
-        .show_in(argparse::ShowIn::HELP_ONLY);
-
-    route_timing_grp.add_argument<bool, ParseOnOff>(args.quick_check_route, "--quick_check_route")
-        .help("Runs check_route, disabling slow checks, once routing step has finished or when routing file is loaded")
-        .default_value("off")
+    route_timing_grp.add_argument<e_check_route_option, ParseCheckRoute>(args.check_route, "--check_route")
+        .help(
+            "Options to run check route in three different modes.\n"
+            " * off    : check route is completely disabled.\n"
+            " * quick  : runs check route with slow checks disabled.\n"
+            " * full   : runs the full check route step.\n")
+        .default_value("quick")
         .show_in(argparse::ShowIn::HELP_ONLY);
 
     route_timing_grp.add_argument(args.router_debug_net, "--router_debug_net")

vpr/src/base/read_options.h

@@ -140,8 +140,7 @@ struct t_options {
     argparse::ArgValue<int> min_incremental_reroute_fanout;
     argparse::ArgValue<bool> read_rr_edge_metadata;
     argparse::ArgValue<bool> exit_after_first_routing_iteration;
-    argparse::ArgValue<bool> disable_check_route;
-    argparse::ArgValue<bool> quick_check_route;
+    argparse::ArgValue<e_check_route_option> check_route;
 
     /* Timing-driven router options only */
     argparse::ArgValue<float> astar_fac;

vpr/src/base/vpr_api.cpp

@@ -710,8 +710,12 @@ RouteStatus vpr_route_flow(t_vpr_setup& vpr_setup, const t_arch& arch) {
         std::string graphics_msg;
         if (route_status.success()) {
             //Sanity check the routing
-            if (!router_opts.disable_check_route) {
-                check_route(router_opts.route_type, router_opts.quick_check_route);
+            if (router_opts.check_route == e_check_route_option::QUICK) {
+                check_route(router_opts.route_type, /*quick=*/true);
+            } else if (router_opts.check_route == e_check_route_option::FULL) {
+                check_route(router_opts.route_type, /*quick=*/false);
+            } else {
+                VTR_LOG_WARN("The user disabled the check route step.");
             }
             get_serial_num();
 

vpr/src/base/vpr_types.h

@@ -139,6 +139,12 @@ enum class e_balance_block_type_util {
     AUTO
 };
 
+enum class e_check_route_option {
+    OFF,
+    QUICK,
+    FULL
+};
+
 /* Selection algorithm for selecting next seed  */
 enum class e_cluster_seed {
     TIMING,
@@ -1000,8 +1006,7 @@ struct t_router_opts {
     e_heap_type router_heap;
     bool exit_after_first_routing_iteration;
 
-    bool disable_check_route;
-    bool quick_check_route;
+    e_check_route_option check_route;
 };
 
 struct t_analysis_opts {