RR Graph Overlay Creation and Deploy new node_type() API of Overlay

vpr/src/base/vpr_context.h

@@ -9,6 +9,7 @@
 #include "vtr_vector.h"
 #include "atom_netlist.h"
 #include "clustered_netlist.h"
+#include "rr_graph_view.h"
 #include "rr_graph_storage.h"
 #include "rr_node.h"
 #include "rr_rc_data.h"
@@ -145,6 +146,7 @@ struct DeviceContext : public Context {
     /*
      * Structures to define the routing architecture of the FPGA.
      */
+    RRGraphView rr_graph; // A read-only view of routing resource graph to be the ONLY database for client functions: GUI, placer, router, timing analyzer etc.
 
     t_rr_graph_storage rr_nodes; // autogenerated in build_rr_graph
 

vpr/src/device/rr_graph_builder_view.cpp

@@ -0,0 +1,47 @@
+/***************************************
+ * Methods for Object RRGraphBuilderView
+ ***************************************/
+#include "vtr_assert.h"
+#include "rr_graph_builder_view.h"
+
+/****************************
+ * Constructors
+ ****************************/
+RRGraphBuilderView::RRGraphBuilderView(t_rr_graph_storage* node_storage,
+                                       t_rr_node_indices* rr_node_indices) {
+    node_storage_ = node_storage;
+    rr_node_indices_ = rr_node_indices;
+}
+
+/****************************
+ * Mutators
+ ****************************/
+void RRGraphBuilderView::add_node_to_fast_lookup(const RRNodeId& node,
+                                                 const int& x,
+                                                 const int& y,
+                                                 const t_rr_type& type,
+                                                 const int& ptc,
+                                                 const e_side& side) {
+    VTR_ASSERT_SAFE(3 == (*rr_node_indices_)[type].ndims());
+
+    /* Expand the fast look-up if the new node is out-of-range
+     * This may seldom happen because the rr_graph building function
+     * should ensure the fast look-up well organized  
+     */
+    VTR_ASSERT(type < (*rr_node_indices_).size());
+
+    if ((size_t(x) >= (*rr_node_indices_)[type].dim_size(0))
+        || (size_t(y) >= (*rr_node_indices_)[type].dim_size(1))
+        || (size_t(side) >= (*rr_node_indices_)[type].dim_size(2))) {
+        (*rr_node_indices_)[type].resize({std::max((*rr_node_indices_)[type].dim_size(0), size_t(x) + 1),
+                                          std::max((*rr_node_indices_)[type].dim_size(1), size_t(y) + 1),
+                                          std::max((*rr_node_indices_)[type].dim_size(2), size_t(side) + 1)});
+    }
+
+    if (size_t(ptc) >= (*rr_node_indices_)[type][x][y][side].size()) {
+        (*rr_node_indices_)[type][x][y][side].resize(ptc + 1);
+    }
+
+    /* Resize on demand finished; Register the node */
+    (*rr_node_indices_)[type][x][y][side][ptc] = int(size_t(node));
+}

vpr/src/device/rr_graph_builder_view.h

@@ -0,0 +1,53 @@
+#ifndef _RR_GRAPH_BUILDER_VIEW_
+#define _RR_GRAPH_BUILDER_VIEW_
+
+#include <exception>
+
+#include "rr_graph_fwd.h"
+#include "rr_node_fwd.h"
+#include "rr_graph2.h"
+#include "vtr_log.h"
+#include "vtr_memory.h"
+#include "vpr_utils.h"
+#include "vtr_strong_id_range.h"
+#include "vtr_array_view.h"
+#include "rr_graph_storage.h"
+#include "rr_graph_view.h"
+
+/* An builder of routing resource graph which extends 
+ * the read-only frame view RRGraphView
+ *
+ * Note that the builder does not own the storage
+ * It serves a virtual protocol for
+ * - rr_graph builder, which requires both mutators and accessors
+ *
+ * Note:
+ * - This is the only data structre allowed to modify a routing resource graph
+ *
+ */
+class RRGraphBuilderView : public RRGraphView {
+    /****************
+     * Constructors
+     ****************/
+  public:
+    RRGraphBuilderView(t_rr_graph_storage* node_storage,
+                       t_rr_node_indices* rr_node_indices);
+
+    /****************
+     * Accessors all come from RRGraph View
+     ****************/
+
+    /****************
+     * Mutators
+     ****************/
+  public:
+    /* Register a node in the fast look-up */
+    void add_node_to_fast_lookup(const RRNodeId& node,
+                                 const int& x,
+                                 const int& y,
+                                 const t_rr_type& type,
+                                 const int& ptc,
+                                 const e_side& side);
+};
+
+#endif

vpr/src/device/rr_graph_view.cpp

@@ -0,0 +1,87 @@
+/***************************************
+ * Methods for Object RRGraphView
+ ***************************************/
+#include "vtr_assert.h"
+#include "rr_graph_view.h"
+
+/****************************
+ * Constructors
+ ****************************/
+RRGraphView::RRGraphView() {
+    node_storage_ = nullptr;
+    rr_node_indices_ = nullptr;
+}
+
+/****************************
+ * Accessors
+ ****************************/
+t_rr_type RRGraphView::node_type(const RRNodeId& node) const {
+    return node_storage_->node_type(node);
+}
+
+RRNodeId RRGraphView::find_node(const int& x,
+                                const int& y,
+                                const t_rr_type& type,
+                                const int& ptc,
+                                const e_side& side) const {
+    /* Find actual side to be used */
+    e_side node_side = side;
+    if (type == IPIN || type == OPIN) {
+        VTR_ASSERT_MSG(side != NUM_SIDES, "IPIN/OPIN must specify desired side (can not be default NUM_SIDES)");
+    } else {
+        VTR_ASSERT(type != IPIN && type != OPIN);
+        node_side = SIDES[0];
+    }
+
+    /* Currently need to swap x and y for CHANX because of chan, seg convention */
+    size_t node_x = x;
+    size_t node_y = y;
+    if (CHANX == type) {
+        std::swap(node_x, node_y);
+    }
+
+    VTR_ASSERT_SAFE(3 == (*rr_node_indices_)[type].ndims());
+
+    /* Sanity check to ensure the x, y, side and ptc are in range 
+     * Data type of rr_node_indice:
+     *   typedef std::array<vtr::NdMatrix<std::vector<int>, 3>, NUM_RR_TYPES> t_rr_node_indices;
+     * Note that x, y and side are the 1st, 2nd and 3rd dimensions of the vtr::NdMatrix
+     * ptc is in the std::vector<int>
+     */
+    if (size_t(type) >= (*rr_node_indices_).size()) {
+        /* Node type is out of range, return an invalid index */
+        return RRNodeId::INVALID();
+    }
+
+    if (node_x >= (*rr_node_indices_)[type].dim_size(0)) {
+        /* Node x is out of range, return an invalid index */
+        return RRNodeId::INVALID();
+    }
+
+    if (node_y >= (*rr_node_indices_)[type].dim_size(1)) {
+        /* Node y is out of range, return an invalid index */
+        return RRNodeId::INVALID();
+    }
+
+    if (node_side >= (*rr_node_indices_)[type].dim_size(2)) {
+        /* Node side is out of range, return an invalid index */
+        return RRNodeId::INVALID();
+    }
+
+    if (size_t(ptc) >= (*rr_node_indices_)[type][node_x][node_y][node_side].size()) {
+        /* Ptc is out of range, return an invalid index */
+        return RRNodeId::INVALID();
+    }
+
+    /* Reaching here, it means that node exists in the look-up, return the id */
+    return RRNodeId((*rr_node_indices_)[type][node_x][node_y][node_side][ptc]);
+}
+
+/****************************
+ * Mutators
+ ****************************/
+void RRGraphView::set_internal_data(t_rr_graph_storage* node_storage,
+                                    t_rr_node_indices* rr_node_indices) {
+    node_storage_ = node_storage;
+    rr_node_indices_ = rr_node_indices;
+}

vpr/src/device/rr_graph_view.h

@@ -0,0 +1,99 @@
+#ifndef _RR_GRAPH_OVERLAY_
+#define _RR_GRAPH_OVERLAY_
+
+#include <exception>
+
+#include "rr_graph_fwd.h"
+#include "rr_node_fwd.h"
+#include "rr_graph2.h"
+#include "vtr_log.h"
+#include "vtr_memory.h"
+#include "vpr_utils.h"
+#include "vtr_strong_id_range.h"
+#include "vtr_array_view.h"
+#include "rr_graph_storage.h"
+
+/* An read-only routing resource graph
+ * which is an unified object including pointors to
+ * - node storage
+ * - edge_storage
+ * - node_ptc_storage
+ * - node_fan_in_storage
+ * - rr_node_indices
+ *
+ * Note that the RRGraphView does not own the storage
+ * It serves a virtual read-only protocol for
+ * - placer
+ * - router
+ * - timing analyzer
+ * - GUI
+ *
+ * Note that each client of rr_graph may get a frame view of the object
+ * The RRGraphView is the complete frame view of the routing resource graph
+ * - This helps to reduce the memory footprint for each client
+ * - This avoids massive changes for each client on using the APIs
+ *   as each frame view provides adhoc APIs for each client
+ *
+ * TODO: more compact frame views will be created, e.g., 
+ * - a mini frame view: contains only node and edges, representing the connectivity of the graph
+ * - a geometry frame view: an extended mini frame view with node-level attributes, 
+ *                          in particular geometry information (type, x, y etc).
+ *
+ */
+class RRGraphView {
+    /****************
+     * Constructors
+     ****************/
+  public:
+    RRGraphView();
+
+    /****************
+     * Accessors
+     ****************/
+  public:
+    /* Get the type of a routing resource node */
+    t_rr_type node_type(const RRNodeId& node) const;
+
+    /* Returns the index of the specified routing resource node.  (x,y) are
+     * the location within the FPGA, rr_type specifies the type of resource,
+     * and ptc gives the number of this resource.  ptc is the class number,
+     * pin number or track number, depending on what type of resource this
+     * is.  All ptcs start at 0 and go up to pins_per_clb-1 or the equivalent.
+     * There are class_inf size SOURCEs + SINKs, type->num_pins IPINs + OPINs,
+     * and max_chan_width CHANX and CHANY (each).
+     *
+     * Note that for segments (CHANX and CHANY) of length > 1, the segment is
+     * given an rr_index based on the (x,y) location at which it starts (i.e.
+     * lowest (x,y) location at which this segment exists).
+     * This routine also performs error checking to make sure the node in
+     * question exists.
+     *
+     * The 'side' argument only applies to IPIN/OPIN types, and specifies which
+     * side of the grid tile the node should be located on. The value is ignored
+     * for non-IPIN/OPIN types
+     */
+    RRNodeId find_node(const int& x,
+                       const int& y,
+                       const t_rr_type& type,
+                       const int& ptc,
+                       const e_side& side = NUM_SIDES) const;
+
+    /****************
+     * Mutators
+     ****************/
+  public:
+    /* The ONLY mutators allowed */
+    void set_internal_data(t_rr_graph_storage* node_storage,
+                           t_rr_node_indices* rr_node_indices);
+
+    /****************
+     * internal data storage, can be accessed by parent class RRGraphBuilderView
+     ****************/
+  protected:
+    /* node-level storage including edge storages */
+    t_rr_graph_storage* node_storage_;
+    /* Fast look-up */
+    t_rr_node_indices* rr_node_indices_;
+};
+
+#endif