Converter from rr_nodes to RRGraph object

README.md

@@ -1,5 +1,5 @@
 # Verilog to Routing (VTR)
-[![Build Status](https://travis-ci.org/verilog-to-routing/vtr-verilog-to-routing.svg?branch=master)](https://travis-ci.org/verilog-to-routing/vtr-verilog-to-routing) [![Documentation Status](https://readthedocs.org/projects/vtr/badge/?version=latest)](http://docs.verilogtorouting.org/en/latest/?badge=latest)
+[![Build Status](https://travis-ci.com/verilog-to-routing/vtr-verilog-to-routing.svg?branch=master)](https://travis-ci.org/verilog-to-routing/vtr-verilog-to-routing) [![Documentation Status](https://readthedocs.org/projects/vtr/badge/?version=latest)](http://docs.verilogtorouting.org/en/latest/?badge=latest)
 
 ## Introduction
 The Verilog-to-Routing (VTR) project is a world-wide collaborative effort to provide a open-source framework for conducting FPGA architecture and CAD research and development.

libs/libvtrutil/src/vtr_geometry.h

@@ -48,6 +48,7 @@ template<class T>
 class Point {
   public: //Constructors
     Point(T x_val, T y_val) noexcept;
+    Point();
 
   public: //Accessors
     //Coordinates

libs/libvtrutil/src/vtr_geometry.tpp

@@ -10,6 +10,11 @@ Point<T>::Point(T x_val, T y_val) noexcept
     //pass
 }
 
+template<class T>
+Point<T>::Point() {
+    //pass
+}
+
 template<class T>
 T Point<T>::x() const {
     return x_;
@@ -74,6 +79,11 @@ Rect<T>::Rect(Point<T> bottom_left_val, Point<T> top_right_val)
     //pass
 }
 
+template<class T>
+Rect<T>::Rect() {
+    //pass
+}
+
 template<class T>
 T Rect<T>::xmin() const {
     return bottom_left_.x();

vpr/src/base/vpr_api.cpp

@@ -374,7 +374,7 @@ bool vpr_flow(t_vpr_setup& vpr_setup, t_arch& arch) {
 }
 
 void vpr_create_device(t_vpr_setup& vpr_setup, const t_arch& arch) {
-    vtr::ScopedStartFinishTimer timer("Create Device");
+    //vtr::ScopedStartFinishTimer timer("Create Device");
     vpr_create_device_grid(vpr_setup, arch);
 
     vpr_setup_clock_networks(vpr_setup, arch);

vpr/src/base/vpr_context.h

@@ -21,6 +21,7 @@
 #include "router_lookahead.h"
 #include "place_macro.h"
 #include "compressed_grid.h"
+#include "rr_graph_obj.h"
 
 //A Context is collection of state relating to a particular part of VPR
 //
@@ -136,6 +137,9 @@ struct DeviceContext : public Context {
     /* chan_width is for x|y-directed channels; i.e. between rows */
     t_chan_width chan_width;
 
+    /* Object to define routing resources */
+    RRGraph rr_graph;
+
     /* Structures to define the routing architecture of the FPGA.           */
     std::vector<t_rr_node> rr_nodes; /* autogenerated in build_rr_graph */
 

vpr/src/base/vpr_types.h

@@ -1133,10 +1133,6 @@ struct t_linked_f_pointer {
 
 typedef std::vector<std::vector<std::vector<std::vector<std::vector<int>>>>> t_rr_node_indices; //[0..num_rr_types-1][0..grid_width-1][0..grid_height-1][0..NUM_SIDES-1][0..max_ptc-1]
 
-/* Uncomment lines below to save some memory, at the cost of debugging ease. */
-/*enum e_rr_type {SOURCE, SINK, IPIN, OPIN, CHANX, CHANY}; */
-/* typedef short t_rr_type */
-
 /* Type of a routing resource node.  x-directed channel segment,   *
  * y-directed channel segment, input pin to a clb to pad, output   *
  * from a clb or pad (i.e. output pin of a net) and:               *
@@ -1151,12 +1147,11 @@ typedef enum e_rr_type : unsigned char {
     OPIN,
     CHANX,
     CHANY,
-    INTRA_CLUSTER_EDGE,
     NUM_RR_TYPES
 } t_rr_type;
 
-constexpr std::array<t_rr_type, NUM_RR_TYPES> RR_TYPES = {{SOURCE, SINK, IPIN, OPIN, CHANX, CHANY, INTRA_CLUSTER_EDGE}};
-constexpr std::array<const char*, NUM_RR_TYPES> rr_node_typename{{"SOURCE", "SINK", "IPIN", "OPIN", "CHANX", "CHANY", "INTRA_CLUSTER_EDGE"}};
+constexpr std::array<t_rr_type, NUM_RR_TYPES> RR_TYPES = {{SOURCE, SINK, IPIN, OPIN, CHANX, CHANY}};
+constexpr std::array<const char*, NUM_RR_TYPES> rr_node_typename{{"SOURCE", "SINK", "IPIN", "OPIN", "CHANX", "CHANY"}};
 
 /* Basic element used to store the traceback (routing) of each net.        *
  * index:   Array index (ID) of this routing resource node.                *

vpr/src/device/check_rr_graph_obj.cpp

@@ -107,7 +107,7 @@ static bool check_rr_graph_source_nodes(const RRGraph& rr_graph) {
         }
     }
 
-    return invalid_sources;
+    return !invalid_sources;
 }
 
 /*********************************************************************** 
@@ -136,7 +136,7 @@ static bool check_rr_graph_sink_nodes(const RRGraph& rr_graph) {
         }
     }
 
-    return invalid_sinks;
+    return !invalid_sinks;
 }
 
 /*********************************************************************** 
@@ -153,48 +153,43 @@ static bool check_rr_graph_sink_nodes(const RRGraph& rr_graph) {
  * will work properly.
  **********************************************************************/
 bool check_rr_graph(const RRGraph& rr_graph) {
-    bool check_flag = true;
     size_t num_err = 0;
 
     if (false == check_rr_graph_duplicated_edges(rr_graph)) {
         VTR_LOG_WARN("Fail in checking duplicated edges !\n");
-        check_flag = false;
         num_err++;
     }
 
     if (false == check_rr_graph_dangling_nodes(rr_graph)) {
         VTR_LOG_WARN("Fail in checking dangling nodes !\n");
-        check_flag = false;
         num_err++;
     }
 
     if (false == check_rr_graph_source_nodes(rr_graph)) {
         VTR_LOG_WARN("Fail in checking source nodes!\n");
-        check_flag = false;
         num_err++;
     }
 
     if (false == check_rr_graph_sink_nodes(rr_graph)) {
         VTR_LOG_WARN("Fail in checking sink nodes!\n");
-        check_flag = false;
         num_err++;
     }
 
     if (false == check_rr_graph_source_nodes(rr_graph)) {
         VTR_LOG_WARN("Fail in checking source nodes!\n");
-        check_flag = false;
         num_err++;
     }
 
     if (false == check_rr_graph_sink_nodes(rr_graph)) {
         VTR_LOG_WARN("Fail in checking sink nodes!\n");
-        check_flag = false;
         num_err++;
     }
 
     /* Error out if there is any fatal errors found */
-    VTR_LOG_WARN("Checked Routing Resource graph with %d errors !\n",
-                 num_err);
+    if (0 < num_err) {
+        VTR_LOG_WARN("Checked Routing Resource graph with %d errors !\n",
+                     num_err);
+    }
 
-    return check_flag;
+    return (0 == num_err);
 }

vpr/src/device/create_rr_graph.cpp

@@ -0,0 +1,138 @@
+/* Standard header files required go first */
+#include <map>
+
+/* EXTERNAL library header files go second*/
+#include "vtr_assert.h"
+#include "vtr_time.h"
+#include "vtr_memory.h"
+
+/* VPR header files go then */
+#include "vpr_types.h"
+#include "rr_graph_obj.h"
+#include "check_rr_graph_obj.h"
+#include "create_rr_graph.h"
+
+/* Finally we include global variables */
+#include "globals.h"
+
+/********************************************************************
+ * TODO: remove when this conversion (from traditional to new data structure)
+ * is no longer needed
+ * This function will convert an existing rr_graph in device_ctx to the RRGraph
+ *object
+ * This function is used to test our RRGraph if it is acceptable in downstream
+ *routers
+ ********************************************************************/
+void convert_rr_graph(std::vector<t_segment_inf>& vpr_segments) {
+    /* Release freed memory before start building rr_graph */
+    vtr::malloc_trim(0);
+
+    vtr::ScopedStartFinishTimer timer("Conversion to routing resource graph object");
+
+    /* IMPORTANT: to build clock tree,
+     * vpr added segments to the original arch segments
+     * This is why to use vpr_segments as an inputs!!!
+     */
+    auto& device_ctx = g_vpr_ctx.mutable_device();
+
+    /* The number of switches are in general small,
+     * reserve switches may not bring significant memory efficiency
+     * So, we just use create_switch to push_back each time
+     */
+    device_ctx.rr_graph.reserve_switches(device_ctx.rr_switch_inf.size());
+    // Create the switches
+    for (size_t iswitch = 0; iswitch < device_ctx.rr_switch_inf.size(); ++iswitch) {
+        device_ctx.rr_graph.create_switch(device_ctx.rr_switch_inf[iswitch]);
+    }
+
+    /* The number of segments are in general small, reserve segments may not bring
+     * significant memory efficiency */
+    device_ctx.rr_graph.reserve_segments(vpr_segments.size());
+    // Create the segments
+    for (size_t iseg = 0; iseg < vpr_segments.size(); ++iseg) {
+        device_ctx.rr_graph.create_segment(vpr_segments[iseg]);
+    }
+
+    /* Reserve list of nodes to be memory efficient */
+    device_ctx.rr_graph.reserve_nodes((unsigned long)device_ctx.rr_nodes.size());
+
+    // Create the nodes
+    for (size_t inode = 0; inode < device_ctx.rr_nodes.size(); ++inode) {
+        auto& node = device_ctx.rr_nodes[inode];
+        RRNodeId rr_node = device_ctx.rr_graph.create_node(node.type());
+
+        device_ctx.rr_graph.set_node_xlow(rr_node, node.xlow());
+        device_ctx.rr_graph.set_node_ylow(rr_node, node.ylow());
+        device_ctx.rr_graph.set_node_xhigh(rr_node, node.xhigh());
+        device_ctx.rr_graph.set_node_yhigh(rr_node, node.yhigh());
+
+        device_ctx.rr_graph.set_node_capacity(rr_node, node.capacity());
+
+        device_ctx.rr_graph.set_node_ptc_num(rr_node, node.ptc_num());
+
+        device_ctx.rr_graph.set_node_cost_index(rr_node, node.cost_index());
+
+        if (CHANX == node.type() || CHANY == node.type()) {
+            device_ctx.rr_graph.set_node_direction(rr_node, node.direction());
+        }
+        if (IPIN == node.type() || OPIN == node.type()) {
+            device_ctx.rr_graph.set_node_side(rr_node, node.side());
+        }
+        device_ctx.rr_graph.set_node_R(rr_node, node.R());
+        device_ctx.rr_graph.set_node_C(rr_node, node.C());
+
+        /* Set up segment id */
+        short irc_data = node.cost_index();
+        short iseg = device_ctx.rr_indexed_data[irc_data].seg_index;
+        device_ctx.rr_graph.set_node_segment(rr_node, RRSegmentId(iseg));
+    }
+
+    /* Reserve list of edges to be memory efficient */
+    unsigned long num_edges_to_reserve = 0;
+    for (size_t inode = 0; inode < device_ctx.rr_nodes.size(); ++inode) {
+        const auto& node = device_ctx.rr_nodes[inode];
+        num_edges_to_reserve += node.num_edges();
+    }
+    device_ctx.rr_graph.reserve_edges(num_edges_to_reserve);
+
+    /* Add edges for each node */
+    for (size_t inode = 0; inode < device_ctx.rr_nodes.size(); ++inode) {
+        const auto& node = device_ctx.rr_nodes[inode];
+        for (int iedge = 0; iedge < node.num_edges(); ++iedge) {
+            size_t isink_node = node.edge_sink_node(iedge);
+            int iswitch = node.edge_switch(iedge);
+
+            device_ctx.rr_graph.create_edge(RRNodeId(inode),
+                                            RRNodeId(isink_node),
+                                            RRSwitchId(iswitch));
+        }
+    }
+
+    /* Ensure that we reserved what we want */
+    VTR_ASSERT(num_edges_to_reserve == (unsigned long)device_ctx.rr_graph.edges().size());
+
+    /* Partition edges to be two class: configurable (1st part) and
+     * non-configurable (2nd part)
+     * See how the router will use the edges and determine the strategy
+     * if we want to partition the edges first or depends on the routing needs
+     */
+    device_ctx.rr_graph.rebuild_node_edges();
+
+    /* Essential check for rr_graph, build look-up and  */
+    if (false == device_ctx.rr_graph.validate()) {
+        /* Error out if built-in validator of rr_graph fails */
+        vpr_throw(VPR_ERROR_ROUTE,
+                  __FILE__,
+                  __LINE__,
+                  "Fundamental errors occurred when validating rr_graph object!\n");
+    }
+
+    /* Error out if advanced checker of rr_graph fails */
+    if (false == check_rr_graph(device_ctx.rr_graph)) {
+        vpr_throw(VPR_ERROR_ROUTE,
+                  __FILE__,
+                  __LINE__,
+                  "Advanced checking rr_graph object fails! Routing may still work "
+                  "but not smooth\n");
+    }
+}

vpr/src/device/create_rr_graph.h

@@ -0,0 +1,17 @@
+#ifndef CREATE_RR_GRAPH_H
+#define CREATE_RR_GRAPH_H
+
+/*
+ * Notes in include header files in a head file 
+ * Only include the neccessary header files 
+ * that is required by the data types in the function/class declarations!
+ */
+#include "rr_graph_obj.h"
+
+/* IMPORTANT: to build clock tree,
+ * vpr added segments to the original arch segments  
+ * This is why to use vpr_segments as an inputs!!!
+ */
+void convert_rr_graph(std::vector<t_segment_inf>& vpr_segments);
+
+#endif