Add a new API set_node_rc_index() to RRGraphBuilder #1887

m-hariszafar · 2021-10-20T12:10:34Z

Description
This PR focuses on updating routing resource graph builder functions, where we use the refactored data structure RRGraphBuilder to shadow the discrete data structure rr_graph_storage.
This PR aims to fully refactored/deprecate the direct use of the legacy API set_node_rc_index() from the rr_node data structure.

After this PR, the set_rc_index() API is fully deprecated, and the set_node_rc_index() from the refactored data structure RRGraphBuilder is the only way to use it.

Checklist:

Removed the legacy API set_rc_index() from rr_node.cpp and rr_node.h
Added new APIs set_node_rc_index to data structures RRGraphBuilder, whose comments are Doxygen compatible
Replaced all the use of set_rc_index() with respective set_node_rc_index in builder functions

Related Issue
This pull request is a follow-up PR on the routing resource graph refactoring effort #1805, #1868

Motivation and Context
This PR is a continuation of the refactoring effort with a focus on shadowing the rr_graph_storage APIs in the RRGraphBuilder data structure.
This PR refactored the set_node_rc_index() API among the other APIs in #1847, #1868

How Has This Been Tested?

All vtr basic and strong tests are passing.

Types of changes

Bug fix (change which fixes an issue)
New feature (change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My change requires a change to the documentation
I have updated the documentation accordingly
I have added tests to cover my changes
All new and existing tests passed

m-hariszafar · 2021-10-20T12:15:23Z

QoR tests are completed and a quick summary is given below. QoR comparison files are also attached.

titan_quick_qor test:
flow run time 2.66% on average.
critical path delay 1.21% on average.
Peak memory usage -1.81% on average

vtr_reg_qor_chain_depop test:
Flow run time 11.89% on average.
critical path delay 49405681.66% on average. (This high change is occurring after merging the last 3 PRs.)
Peak memory usage didn't appear in parse_results. (This change is occurring after merging the last 3 PRs.)

Here are the attached files
vtr_chain_depop.xlsx
titan_quick_tor.xlsx

m-hariszafar · 2021-10-21T07:20:14Z

After fixing the spreadsheet manually (removing the newly added columns and rerunning the compare script)
Here are the new results

titan_quick_qor test:
flow run time 2.66% on average.
critical path delay 1.21% on average.
Peak memory usage -1.81% on average

vtr_reg_qor_chain_depop test:
Flow run time 11.89% on average.
critical path delay 0.11% on average.
Peak memory usage is 1.18% on average.

Here are the attached files
vtr_chain_depop.xlsx
titan_quick_qor.xlsx

tangxifan · 2021-10-21T18:19:54Z

vpr/src/device/rr_graph_builder.h

@@ -102,6 +102,11 @@ class RRGraphBuilder {
        node_storage_.set_node_direction(id, new_direction);
    }

+    /** @brief Set the rc_index of routing resource node. */
+    inline void set_node_rc_index(RRNodeId id, short new_rc_index) {


@hariszafar-lm I had a discussion with @vaughnbetz . We believe it is better to use a strong id here, e.g., NodeRcIndex, rather than an integer. Can you look into the implementation here:

vtr-verilog-to-routing/vpr/src/device/rr_graph_fwd.h

Line 18 in b3e8685

struct rr_indexed_data_id_tag;

And then create a strong id for the RC index? For internal data of RRGraphBuilder, you can still use integer.
But for the API, we force the use of strong ids.

Let me know if this makes sense or not.

Hi @tangxifan, could you review it now. I had created and implemented strong id for it in this commit.

tangxifan · 2021-10-21T18:26:46Z

vpr/src/route/rr_graph.cpp

@@ -1437,7 +1437,7 @@ static void build_rr_sinks_sources(RRGraphBuilder& rr_graph_builder,
        rr_graph_builder.set_node_coordinates(inode, i, j, i + type->width - 1, j + type->height - 1);
        float R = 0.;
        float C = 0.;
-        L_rr_node.set_node_rc_index(inode, find_create_rr_rc_data(R, C));
+        rr_graph_builder.set_node_rc_index(inode, find_create_rr_rc_data(R, C));


@hariszafar-lm If you see any functions in rr_graph.cpp and rr_graph2.cpp which no longer use the old data structure L_rr_node, please take a note. We can create a separated pull request where we rework the input argument list by using RRGraphBuilder and RRGraphView. Let me know what you think.

Noted, I'll create a separate PR for this.

tangxifan · 2021-10-22T23:10:11Z

vpr/src/route/clock_connection_builders.cpp

@@ -114,7 +114,7 @@ RRNodeId RoutingToClockConnection::create_virtual_clock_network_sink_node(int x,

    float R = 0.;
    float C = 0.;
-    rr_graph.set_node_rc_index(node_index, find_create_rr_rc_data(R, C));
+    rr_graph_builder.set_node_rc_index(node_index, NodeRCIndex(find_create_rr_rc_data(R, C)));


@hariszafar-lm Can you quickly check if we can change the data type that function find_create_rr_rc_data() returns? We can avoid these changes.

I tried that before but it gives a lot of errors related to conversions and ambiguating new declaration of NodeRCIndex find_create_rr_rc_data(float, float)

No worries. Can you share the output of grep -r "find_create_rr_rc_data" .? So that I know how many times it is called in all the source files. Thanks

Here is the output on the master branch. It has been calling 11 times.

vpr/src/route/clock_connection_builders.cpp: rr_graph.set_node_rc_index(node_index, find_create_rr_rc_data(R, C)); vpr/src/route/clock_network_builders.cpp: node.set_rc_index(find_create_rr_rc_data( vpr/src/route/clock_network_builders.cpp: node.set_rc_index(find_create_rr_rc_data( vpr/src/route/rr_graph.cpp: L_rr_node.set_node_rc_index(inode, find_create_rr_rc_data(R, C)); vpr/src/route/rr_graph.cpp: L_rr_node.set_node_rc_index(inode, find_create_rr_rc_data(R, C)); vpr/src/route/rr_graph.cpp: L_rr_node.set_node_rc_index(node, find_create_rr_rc_data(R, C)); vpr/src/route/rr_graph_timing_params.cpp: mutable_device_ctx.rr_nodes[inode].set_rc_index(find_create_rr_rc_data(rr_graph.node_R(RRNodeId(inode)), rr_node_C[inode])); vpr/src/route/rr_graph_uxsdcxx_serializer.h: node.set_rc_index(find_create_rr_rc_data(R, C)); vpr/src/route/rr_graph_uxsdcxx_serializer.h: node.set_rc_index(find_create_rr_rc_data(0, 0)); vpr/src/route/rr_rc_data.cpp:short find_create_rr_rc_data(const float R, const float C) { vpr/src/route/rr_rc_data.h:short find_create_rr_rc_data(const float R, const float C);

@hariszafar-lm This is not big. If you want to avoid big changes in this PR. We can do it in a follow-up PR.

We'll look at this in some other PR.

tangxifan · 2021-10-27T05:01:58Z

@hariszafar-lm Please resolve the conflicts.
@vaughnbetz I think this PR is also ready to merge. If you see anything wrong, just let me know. We can fix in follow-up pull requests

tangxifan · 2021-10-27T16:47:04Z

@vaughnbetz @hariszafar-lm The doc build failure may be due to a dependency issue: #1898

Since this PR does not change documentation settings, I think we should merge. I will be on the doc issue if we see anything coming from this PR.

Muhammad Haris Zafar added 4 commits October 18, 2021 16:09

Adding api set_node_rc_index to rr_graph_builder.h

71d9f17

Replacing api set_rc_index from respective .cpp.h files

e535241

Removing old api set_rc_index from rr_node.h/.cpp

cf31a73

Fixing format

e0e97c5

m-hariszafar requested a review from tangxifan October 20, 2021 12:15

github-actions bot added the VPR VPR FPGA Placement & Routing Tool label Oct 20, 2021

m-hariszafar marked this pull request as ready for review October 21, 2021 07:20

tangxifan mentioned this pull request Oct 21, 2021

Dashboard for RRGraph API refactoring status #1868

Open

44 tasks

tangxifan requested changes Oct 21, 2021

View reviewed changes

Muhammad Haris Zafar added 2 commits October 22, 2021 17:21

Creating and using of strong id for set_node_rc_index

abb68da

fixing format

94a6827

tangxifan reviewed Oct 22, 2021

View reviewed changes

Merge branch 'master' into api_set_node_rc_index

82c5913

tangxifan merged commit 92556fe into verilog-to-routing:master Oct 27, 2021

tangxifan deleted the api_set_node_rc_index branch October 27, 2021 16:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add a new API set_node_rc_index() to RRGraphBuilder #1887

Add a new API set_node_rc_index() to RRGraphBuilder #1887

Uh oh!

m-hariszafar commented Oct 20, 2021 •

edited

Loading

Uh oh!

m-hariszafar commented Oct 20, 2021

Uh oh!

m-hariszafar commented Oct 21, 2021

Uh oh!

tangxifan Oct 21, 2021

Uh oh!

m-hariszafar Oct 22, 2021

Uh oh!

tangxifan Oct 21, 2021

Uh oh!

m-hariszafar Oct 25, 2021

Uh oh!

tangxifan Oct 22, 2021

Uh oh!

m-hariszafar Oct 25, 2021

Uh oh!

tangxifan Oct 25, 2021

Uh oh!

m-hariszafar Oct 25, 2021

Uh oh!

tangxifan Oct 27, 2021

Uh oh!

m-hariszafar Oct 27, 2021

Uh oh!

tangxifan commented Oct 27, 2021

Uh oh!

tangxifan commented Oct 27, 2021

Uh oh!

Uh oh!

Add a new API set_node_rc_index() to RRGraphBuilder #1887

Add a new API set_node_rc_index() to RRGraphBuilder #1887

Uh oh!

Conversation

m-hariszafar commented Oct 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

m-hariszafar commented Oct 20, 2021

Uh oh!

m-hariszafar commented Oct 21, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tangxifan commented Oct 27, 2021

Uh oh!

tangxifan commented Oct 27, 2021

Uh oh!

Uh oh!

m-hariszafar commented Oct 20, 2021 •

edited

Loading