[vpr][base] remove update_rr_switch_id and update validate_traceback to validate_and_update_traceback

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_route_file_switch_id  = Options.verify_route_file_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/old_traceback.cpp

@@ -6,9 +6,9 @@
 #include "route_common.h"
 
 #include <vector>
+#include <stack>
 
 std::pair<t_trace*, t_trace*> traceback_from_route_tree_recurr(t_trace* head, t_trace* tail, const RouteTreeNode& node);
-bool validate_traceback_recurr(t_trace* trace, std::set<int>& seen_rr_nodes);
 void free_trace_data(t_trace* tptr);
 
 /** Build a route tree from a traceback */
@@ -109,7 +109,7 @@ t_trace* TracebackCompat::traceback_from_route_tree(const RouteTree& tree) {
 
     std::tie(head, tail) = traceback_from_route_tree_recurr(nullptr, nullptr, tree.root());
 
-    VTR_ASSERT(validate_traceback(head));
+    VTR_ASSERT(validate_and_update_traceback(head));
 
     return head;
 }
@@ -141,70 +141,64 @@ void print_traceback(const t_trace* trace) {
     VTR_LOG("\n");
 }
 
-bool validate_traceback(t_trace* trace) {
-    std::set<int> seen_rr_nodes;
-
-    return validate_traceback_recurr(trace, seen_rr_nodes);
-}
-
-bool validate_traceback_recurr(t_trace* trace, std::set<int>& seen_rr_nodes) {
+bool validate_and_update_traceback(t_trace* trace, bool verify_switch_id /* = true */) {
     if (!trace) {
         return true;
     }
 
-    seen_rr_nodes.insert(trace->index);
+    std::set<int> seen_rr_nodes;
+    std::stack<t_trace*> trace_stack;
 
-    t_trace* next = trace->next;
+    while (!trace_stack.empty()) {
+        trace = trace_stack.top();
+        trace_stack.pop();
+        seen_rr_nodes.insert(trace->index);
+        t_trace* next = trace->next;
 
-    if (next) {
-        if (trace->iswitch == OPEN) { //End of a branch
+        if (next == nullptr) {
+            continue;
+        }
 
+        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 {
-                //Recurse along the new branch
-                return validate_traceback_recurr(next, seen_rr_nodes);
             }
         } 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;
+            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
                     int rr_iswitch = rr_graph.edge_switch(RRNodeId(trace->index), iedge);
-                    if (trace->iswitch != rr_iswitch) {
-                        VPR_FATAL_ERROR(VPR_ERROR_ROUTE, "Traceback mismatched switch type: traceback %d rr_graph %d (RR nodes %d -> %d)\n",
-                                        trace->iswitch, rr_iswitch,
-                                        trace->index, to_node);
+                    if (verify_switch_id) {
+                        // Verify that the switch matches
+                        if (trace->iswitch != rr_iswitch) {
+                            VPR_FATAL_ERROR(VPR_ERROR_ROUTE, "Traceback mismatched switch type: traceback %d rr_graph %d (RR nodes %d -> %d)\n",
+                                            trace->iswitch, rr_iswitch,
+                                            trace->index, to_node);
+                        }
+                    } else {
+                        // Update the switch ID in the traceback to match the RR Graph
+                        trace->iswitch = rr_iswitch;
                     }
                     break;
                 }
             }
-
             if (!found) {
                 VPR_FATAL_ERROR(VPR_ERROR_ROUTE, "Traceback no RR edge between RR nodes %d -> %d\n", trace->index, next->index);
             }
-
-            //Recurse
-            return validate_traceback_recurr(next, seen_rr_nodes);
         }
+        // Recurse
+        trace_stack.push(next);
     }
 
-    VTR_ASSERT(!next);
-    return true; //End of traceback
+    return true;
 }
 
-t_trace*
-alloc_trace_data() {
+t_trace* alloc_trace_data() {
     return (t_trace*)malloc(sizeof(t_trace));
 }
 

vpr/src/base/old_traceback.h

@@ -46,4 +46,14 @@ class TracebackCompat {
 t_trace* alloc_trace_data();
 void free_traceback(t_trace* trace);
 void print_traceback(const t_trace* trace);
-bool validate_traceback(t_trace* trace);
+
+/**
+ * @brief Validate the routing traceback if verify_switch_id is true, otherwise update the 
+ *        switch IDs in the traceback to match the RR Graph.
+ * 
+ * @param trace Pointer to the head of the routing trace of the net to validate and update.
+ * @param verify_switch_id Whether to verify the switch IDs in the traceback.
+ * 
+ * @return true if the traceback is valid, false otherwise.
+ */
+bool validate_and_update_traceback(t_trace* trace, bool verify_switch_id = true);

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_route_file_switch_id , "--verify_route_file_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_route.cpp

@@ -48,14 +48,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_route_file_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_route_file_switch_id ,
+                          bool verify_route_file_switch_id,
                           bool is_flat);
 
 /**
@@ -65,13 +65,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_route_file_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_route_file_switch_id ,
+                          bool verify_route_file_switch_id,
                           int& lineno);
 
 /**
@@ -84,7 +84,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_route_file_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,
@@ -94,16 +94,9 @@ static void process_nets(const Netlist<>& net_list,
                          std::vector<std::string> input_tokens,
                          const char* filename,
                          int& lineno,
-                         bool verify_route_file_switch_id ,
+                         bool verify_route_file_switch_id,
                          bool is_flat);
 
-/**
- * @brief Update the switch IDs in the routing trace to match the RR Graph.
- *
- * @param trace Pointer to the head of the routing trace of the net to update.
- */
-static void update_rr_switch_id(t_trace* trace);
-
 /**
  * @brief This function goes through all the blocks in a global net and verify
  *        it with the clustered netlist and the placement
@@ -203,7 +196,7 @@ bool read_route(const char* route_file,
     }
 
     /* Read in every net */
-    process_route(router_net_list, fp, route_file, lineno, router_opts.verify_route_file_switch_id , is_flat);
+    process_route(router_net_list, fp, route_file, lineno, router_opts.verify_route_file_switch_id, is_flat);
 
     fp.close();
 
@@ -239,7 +232,7 @@ static void process_route(const Netlist<>& net_list,
                           std::ifstream& fp,
                           const char* filename,
                           int& lineno,
-                          bool verify_route_file_switch_id ,
+                          bool verify_route_file_switch_id,
                           bool is_flat) {
     std::string input;
     std::vector<std::string> tokens;
@@ -260,7 +253,7 @@ static void process_route(const Netlist<>& net_list,
                          tokens,
                          filename,
                          lineno,
-                         verify_route_file_switch_id ,
+                         verify_route_file_switch_id,
                          is_flat);
         }
     }
@@ -275,7 +268,7 @@ static void process_nets(const Netlist<>& net_list,
                          std::vector<std::string> input_tokens,
                          const char* filename,
                          int& lineno,
-                         bool verify_route_file_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:") {
@@ -313,7 +306,7 @@ static void process_nets(const Netlist<>& net_list,
                       fp,
                       inet,
                       filename,
-                      verify_route_file_switch_id ,
+                      verify_route_file_switch_id,
                       lineno);
     }
     input_tokens.clear();
@@ -323,7 +316,7 @@ static void process_nodes(const Netlist<>& net_list,
                           std::ifstream& fp,
                           ClusterNetId inet,
                           const char* filename,
-                          bool verify_route_file_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();
@@ -516,66 +509,13 @@ static void process_nodes(const Netlist<>& net_list,
         oldpos = fp.tellg();
     }
 
-    if (verify_route_file_switch_id ) {
-        VTR_ASSERT(validate_traceback(head_ptr));
-    } else {
-        update_rr_switch_id(head_ptr);
-    }
+    VTR_ASSERT(validate_and_update_traceback(head_ptr, verify_route_file_switch_id));
 
     /* Convert to route_tree after reading */
     route_ctx.route_trees[inet] = TracebackCompat::traceback_to_route_tree(head_ptr);
     free_traceback(head_ptr);
 }
 
-static void update_rr_switch_id(t_trace* trace) {
-    if (trace == nullptr) {
-        return;
-    }
-
-    std::set<int> seen_rr_nodes;
-
-    std::stack<t_trace*> trace_stack;
-    trace_stack.push(trace);
-
-
-    while (!trace_stack.empty()) {
-        trace = trace_stack.top();
-        trace_stack.pop();
-        seen_rr_nodes.insert(trace->index);
-        t_trace* next = trace->next;
-
-        if (next == nullptr) {
-            continue;
-        }
-
-        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
-            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
-                    int rr_iswitch = rr_graph.edge_switch(RRNodeId(trace->index), iedge);
-                    trace->iswitch = rr_iswitch;
-                    break;
-                }
-            }
-            if (!found) {
-                VPR_FATAL_ERROR(VPR_ERROR_ROUTE, "Traceback no RR edge between RR nodes %d -> %d\n", trace->index, next->index);
-            }
-        }
-        trace_stack.push(next);
-    }
-}
-
 static void process_global_blocks(const Netlist<>& net_list, std::ifstream& fp, ClusterNetId inet, const char* filename, int& lineno, bool is_flat) {
     std::string block, bnum_str;
     int layer_num, x, y;