[CLI] rename verify_rr_switch_id to verify_route_file_switch_id

Author: amin1377

vpr/src/base/SetupVPR.cpp

@@ -517,7 +517,7 @@ static void SetupRouterOpts(const t_options& Options, t_router_opts* RouterOpts)
     RouterOpts->custom_3d_sb_fanin_fanout = Options.custom_3d_sb_fanin_fanout;
     RouterOpts->with_timing_analysis = Options.timing_analysis;
 
-    RouterOpts->verify_rr_switch_id = Options.verify_rr_switch_id;
+    RouterOpts->verify_route_file_switch_id  = Options.verify_route_file_switch_id ;
 
     RouterOpts->generate_router_lookahead_report = Options.generate_router_lookahead_report.value();
 }

vpr/src/base/read_options.cpp

@@ -1637,7 +1637,7 @@ argparse::ArgumentParser create_arg_parser(const std::string& prog_name, t_optio
         .default_value("on")
         .show_in(argparse::ShowIn::HELP_ONLY);
 
-    gen_grp.add_argument<bool, ParseOnOff>(args.verify_rr_switch_id, "--verify_rr_switch_id")
+    gen_grp.add_argument<bool, ParseOnOff>(args.verify_route_file_switch_id , "--verify_route_file_switch_id")
         .help(
             "Verify that the switch IDs in the routing file are consistent with those in the RR Graph. "
             "Set this to false when switch IDs in the routing file may differ from the RR Graph. "

vpr/src/base/read_options.h

@@ -73,7 +73,7 @@ struct t_options {
     argparse::ArgValue<e_timing_update_type> timing_update_type;
     argparse::ArgValue<bool> CreateEchoFile;
     argparse::ArgValue<bool> verify_file_digests;
-    argparse::ArgValue<bool> verify_rr_switch_id;
+    argparse::ArgValue<bool> verify_route_file_switch_id ;
     argparse::ArgValue<std::string> device_layout;
     argparse::ArgValue<float> target_device_utilization;
     argparse::ArgValue<e_constant_net_method> constant_net_method;

vpr/src/base/read_route.cpp

@@ -47,14 +47,14 @@
  * @param fp The file stream to read from.
  * @param filename The name of the file to read from.
  * @param lineno The line number currently being processed.
- * @param verify_rr_switch_id Whether to verify the RR switch IDs in the routing file.
+ * @param verify_route_file_switch_id  Whether to verify the RR switch IDs in the routing file.
  * @param is_flat Whether flat-router is enabled.
  */
 static void process_route(const Netlist<>& net_list,
                           std::ifstream& fp,
                           const char* filename,
                           int& lineno,
-                          bool verify_rr_switch_id,
+                          bool verify_route_file_switch_id ,
                           bool is_flat);
 
 /**
@@ -64,13 +64,13 @@ static void process_route(const Netlist<>& net_list,
  * @param fp The file stream to read from.
  * @param inet The net ID to process.
  * @param filename The name of the file to read from.
- * @param verify_rr_switch_id Whether to verify the RR switch IDs in the routing file.
+ * @param verify_route_file_switch_id  Whether to verify the RR switch IDs in the routing file.
  */
 static void process_nodes(const Netlist<>& net_list,
                           std::ifstream& fp,
                           ClusterNetId inet,
                           const char* filename,
-                          bool verify_rr_switch_id,
+                          bool verify_route_file_switch_id ,
                           int& lineno);
 
 /**
@@ -83,7 +83,7 @@ static void process_nodes(const Netlist<>& net_list,
  * @param input_tokens The tokens of the net.
  * @param filename The name of the file to read from.
  * @param lineno The line number currently being processed.
- * @param verify_rr_switch_id Whether to verify the RR switch IDs in the routing file.
+ * @param verify_route_file_switch_id  Whether to verify the RR switch IDs in the routing file.
  * @param is_flat Whether flat-router is enabled.
  */
 static void process_nets(const Netlist<>& net_list,
@@ -93,7 +93,7 @@ static void process_nets(const Netlist<>& net_list,
                          std::vector<std::string> input_tokens,
                          const char* filename,
                          int& lineno,
-                         bool verify_rr_switch_id,
+                         bool verify_route_file_switch_id ,
                          bool is_flat);
 
 /**
@@ -206,7 +206,7 @@ bool read_route(const char* route_file,
     }
 
     /* Read in every net */
-    process_route(router_net_list, fp, route_file, lineno, router_opts.verify_rr_switch_id, is_flat);
+    process_route(router_net_list, fp, route_file, lineno, router_opts.verify_route_file_switch_id , is_flat);
 
     fp.close();
 
@@ -242,7 +242,7 @@ static void process_route(const Netlist<>& net_list,
                           std::ifstream& fp,
                           const char* filename,
                           int& lineno,
-                          bool verify_rr_switch_id,
+                          bool verify_route_file_switch_id ,
                           bool is_flat) {
     std::string input;
     std::vector<std::string> tokens;
@@ -263,7 +263,7 @@ static void process_route(const Netlist<>& net_list,
                          tokens,
                          filename,
                          lineno,
-                         verify_rr_switch_id,
+                         verify_route_file_switch_id ,
                          is_flat);
         }
     }
@@ -278,7 +278,7 @@ static void process_nets(const Netlist<>& net_list,
                          std::vector<std::string> input_tokens,
                          const char* filename,
                          int& lineno,
-                         bool verify_rr_switch_id,
+                         bool verify_route_file_switch_id ,
                          bool is_flat) {
     if (input_tokens.size() > 3 && input_tokens[3] == "global"
         && input_tokens[4] == "net" && input_tokens[5] == "connecting:") {
@@ -316,7 +316,7 @@ static void process_nets(const Netlist<>& net_list,
                       fp,
                       inet,
                       filename,
-                      verify_rr_switch_id,
+                      verify_route_file_switch_id ,
                       lineno);
     }
     input_tokens.clear();
@@ -326,7 +326,7 @@ static void process_nodes(const Netlist<>& net_list,
                           std::ifstream& fp,
                           ClusterNetId inet,
                           const char* filename,
-                          bool verify_rr_switch_id,
+                          bool verify_route_file_switch_id ,
                           int& lineno) {
     /* Not a global net. Goes through every node and add it into trace.head*/
     auto& device_ctx = g_vpr_ctx.mutable_device();
@@ -519,7 +519,7 @@ static void process_nodes(const Netlist<>& net_list,
         oldpos = fp.tellg();
     }
 
-    if (verify_rr_switch_id) {
+    if (verify_route_file_switch_id ) {
         VTR_ASSERT(validate_traceback(head_ptr));
     } else {
         std::set<int> seen_rr_nodes;
@@ -544,22 +544,21 @@ static void update_rr_switch_id(t_trace* trace, std::set<int>& seen_rr_nodes) {
         return;
     }
 
-    if (trace->iswitch == OPEN) { //End of a branch
-        //Verify that the next element (branch point) has been already seen in the traceback so far
+    if (trace->iswitch == OPEN) { // End of a branch
+        // Verify that the next element (branch point) has been already seen in the traceback so far
         if (!seen_rr_nodes.count(next->index)) {
             VPR_FATAL_ERROR(VPR_ERROR_ROUTE, "Traceback branch point %d not found", next->index);
         }
-    } else { //Midway along branch
-        //Check there is an edge connecting trace and next
-        auto& device_ctx = g_vpr_ctx.device();
-        const auto& rr_graph = device_ctx.rr_graph;
+    } else { // Midway along branch
+        // Check there is an edge connecting trace and next
+        const auto& rr_graph = g_vpr_ctx.device().rr_graph;
         bool found = false;
         for (t_edge_size iedge = 0; iedge < rr_graph.num_edges(RRNodeId(trace->index)); ++iedge) {
             int to_node = size_t(rr_graph.edge_sink_node(RRNodeId(trace->index), iedge));
             if (to_node == next->index) {
                 found = true;
 
-                //Verify that the switch matches
+                // Verify that the switch matches
                 int rr_iswitch = rr_graph.edge_switch(RRNodeId(trace->index), iedge);
                 trace->iswitch = rr_iswitch;
                 break;
@@ -569,7 +568,7 @@ static void update_rr_switch_id(t_trace* trace, std::set<int>& seen_rr_nodes) {
             VPR_FATAL_ERROR(VPR_ERROR_ROUTE, "Traceback no RR edge between RR nodes %d -> %d\n", trace->index, next->index);
         }
     }
-    //Recurse
+    // Recurse
     update_rr_switch_id(next, seen_rr_nodes);
 }
 

vpr/src/base/vpr_types.h

@@ -1343,9 +1343,10 @@ struct t_router_opts {
 
     bool with_timing_analysis;
 
-    bool verify_rr_switch_id;
+    /// Whether to verify the switch IDs in the route file with the RR Graph.
+    bool verify_route_file_switch_id;
 
-    // Options related to rr_node reordering, for testing and possible cache optimization
+    /// Options related to rr_node reordering, for testing and possible cache optimization
     e_rr_node_reorder_algorithm reorder_rr_graph_nodes_algorithm = DONT_REORDER;
     int reorder_rr_graph_nodes_threshold = 0;
     int reorder_rr_graph_nodes_seed = 1;