Dashboard for RRGraph API refactoring status

#### Motivation of Refactoring effort
A detailed technical plan can be found at [link](https://docs.google.com/document/d/15m7IbVRbQYLxFQjIVNIZT3VjYDhAqK6cjqCxVuSVDGU/edit?usp=sharing)

The overall refactoring effort aims to 
- create a unified data structure ``RRGraphView`` as a centralized storage for all the routing resource graph -related information. See Fig. 1
- create a set of frame view object from the centralized storage ``RRGraph`` for client functions, which are suitable for ``rr_graph builder``, ``placer``, ``router``, ``GUI``, ``timing analyzer`` etc. See Fig. 2.
- This is to avoid massive updates to the codes of client functions when there is a change on the unified data structure. 
- Also it avoid large memory footprint for client functions, since each client function may only use a small portion (typically <50%) APIs of the unified object.

![image](https://user-images.githubusercontent.com/11499826/114082095-95ac8980-986a-11eb-99f1-adf93a2f4881.png)
Fig. 1 Illustration of the relationship between data structures

![image](https://user-images.githubusercontent.com/11499826/112546797-8a902e80-8d7f-11eb-8438-81fc409359db.png)
Fig. 2 Different levels of frame views of routing resource graphs to satisfy various needs from client functions.

The result/benefits of the refactoring efforts is
- The routing resource graph can be decoupled from VPR's core engine as a library. Unit tests can be enabled
- It is much easier for developers to develop custom routing resource graph builders thanks to the APIs of the unified data structure ``RRGraph``. A routing resource graph builder can be a library, decoupled from VPR's core engine. Many checking codes can be efficiently merged into the data structure and developers can save a lot of efforts in writing the atom-level sanity checks.
- Ensure that each client functions have a clean view of the routing resource graph, i.e. ``RRGraphView``. In other words, routing resource graph will be read-only and only accessors are exposed to client functions. Developers have no worries on developing their own placer/router etc.

#### Checklist

RRGraphBuilder API to be refactored:
- [x] set_node_type() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1847
- [x] set_node_ptc_num() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1872
- [x] set_node_pin_num() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1872
- [x] set_node_track_num() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1872
- [x] set_node_class_num() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1872
- [x] set_node_coordinates() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1853
- [x] set_node_cost_index() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1884
- [x] set_node_rc_index() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1887
- [x] set_node_capacity() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1855
- [x] set_node_direction() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1856
- [x] add_node_side() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1889
- [x] reserve_nodes() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1905
- [x] resize_nodes() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1905
- [x] ~~add_node()~~ **Removed because it is not currently used in rr_graph builder; Will think it later.**
- [x] reserve_edges() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1892
- [x] emplace_back_edges() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1892
- [x] alloc_and_load_edges() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1892
- [x] count_rr_switches() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1896
- [x] remap_rr_node_switch_indices() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1897
- [x] make_edges_as_rr_switch_ids() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1902
- [x] partition_edges() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1900
- [x] init_fan_in() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1903
- [x] validate() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1899

RRGraphView API to be refactored:
- [x] node_type() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1742
- [x] node_type_string() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1873
- [x] node_rc_index() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1816
- [x] node_R() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1816
- [x] node_C() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1816
- [x] node_xlow/ylow/xhigh/yhigh() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1819
- [x] node_capacity() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1780
- [x] node_cost_index() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1843
- [x] node_direction() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1791
- [x] node_direction_string() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1791
- [x] is_node_on_specific_side() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1862
- [x] node_side_string() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1873
- [x] node_ptc_num()/node_pin_num()/node_track_num()/node_class_num() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1908
- [x] fan_in() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1799
- [x] edges()/num_edges() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1917
- [x] configurable_edges()/non_configurable_edges()/num_configurable_edges()/num_non_configurable_edges() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1917
- [x] first_edge()/last_edge() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1916
- [x] edge_sink_node()/edge_switch() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1930
- [x] nodes() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1932
- [x] rr_segments() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1910
- [x] rr_switches() https://github.com/verilog-to-routing/vtr-verilog-to-routing/pull/1945



Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Dashboard for RRGraph API refactoring status #1868

Motivation of Refactoring effort

Checklist

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Dashboard for RRGraph API refactoring status #1868

Description

Motivation of Refactoring effort

Checklist

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions