Merge branch 'master' into ipa_end_user_doc

Author: w0lek

.github/workflows/containers.yml

@@ -1,12 +1,24 @@
 name: Containers
 
 on:
+  # We want to run the CI when anything is pushed to master.
+  # Since master is a protected branch this only happens when a PR is merged.
+  # This is a double check in case the PR was stale and had some issues.
   push:
+    branches:
+      - master
   pull_request:
   workflow_dispatch:
   schedule:
   - cron: '0 0 * * 0' # weekly
 
+# We want to cancel previous runs for a given PR or branch / ref if another CI
+# run is requested.
+# See: https://docs.github.com/en/actions/using-jobs/using-concurrency
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
 
   Image:

.github/workflows/test.yml

@@ -1,12 +1,24 @@
 name: Test
 
 on:
+  # We want to run the CI when anything is pushed to master.
+  # Since master is a protected branch this only happens when a PR is merged.
+  # This is a double check in case the PR was stale and had some issues.
   push:
+    branches:
+      - master
   pull_request:
   workflow_dispatch:
   schedule:
   - cron: '0 0 * * *' # daily
 
+# We want to cancel previous runs for a given PR or branch / ref if another CI
+# run is requested.
+# See: https://docs.github.com/en/actions/using-jobs/using-concurrency
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 env:
   # default compiler for all non-compatibility tests
   MATRIX_EVAL: "CC=gcc-11 && CXX=g++-11"

README.developers.md

@@ -1326,13 +1326,51 @@ Code included in VTR by subtrees should *not be modified within the VTR source t
 Instead changes should be made in the relevant up-stream repository, and then synced into the VTR tree.
 
 ## Updating an existing Subtree
+
+The following are instructions on how to pull in external changes from an
+existing subtree. Which instructions to follow depend on if you are changing
+the external ref or not.
+
+### External Ref Does Not Change
+
+These instructions are for if the subtree is tracking a ref of a repo which has
+changes we want to pull in. For example, if the subtree is tracking main/master.
+
 1. From the VTR root run: `./dev/external_subtrees.py $SUBTREE_NAME`, where `$SUBTREE_NAME` is the name of an existing subtree.
 
     For example to update the `libtatum` subtree:
     ```shell
     ./dev/external_subtrees.py --update libtatum -m "commit message describing why component is being updated"
     ```
 
+### External Ref Changes
+
+These instructions are for if you want to change the ref that a subtree is
+tracking. For example, if you want to change the version of a subtree (which
+exists on a different branch).
+
+1. Update `./dev/subtree_config.xml` with the new external ref.
+
+2. Run `git log <internal_path>` and take note of any local changes to the
+   subtree. It is bad practice to have local changes to subtrees you cannot
+   modify; however, some changes must be made to allow the library to work in
+   VTR. The next step will clear all these changes, and they may be important
+   and need to be recreated.
+
+3. Delete the subtree folder (the internal path) entirely and commit it to git.
+   The issue is that changing the external ref basically creates a new subtree,
+   so the regular way of updating the subtree does not work. You need to
+   completely wipe all of the code from the old subtree. NOTE: This will remove
+   all changes locally made to the subtree.
+
+4. Run `./dev/external_subtrees.py --update $SUBTREE_NAME`. This will pull in
+   the most recent version of the subtree, squash the changes, and raise a
+   commit.
+
+5. Recreate the local changes from step 2 above, such that the library builds
+   without issue; preferrably in a concise way such that the library can be
+   easily updated in the future.
+
 ## Adding a new Subtree
 
 To add a new external subtree to VTR do the following:

libs/librrgraph/src/base/rr_graph_storage.h

@@ -401,11 +401,13 @@ class t_rr_graph_storage {
 
     /** @brief Get the source node for the specified edge. */
     RRNodeId edge_src_node(const RREdgeId& edge) const {
+        VTR_ASSERT_DEBUG(edge.is_valid());
         return edge_src_node_[edge];
     }
 
     /** @brief Get the destination node for the specified edge. */
     RRNodeId edge_sink_node(const RREdgeId& edge) const {
+        VTR_ASSERT_DEBUG(edge.is_valid());
         return edge_dest_node_[edge];
     }
 

vpr/src/pack/re_cluster_util.h

@@ -76,6 +76,7 @@ void remove_mol_from_cluster(const t_pack_molecule* molecule,
  *                          (is updated if this function is called during packing, especially intra_lb_routing data member).
  * @param router_data: returns the intra logic block router data.
  * @param temp_cluster_pr: returns the partition region of the new cluster.
+ * @param temp_cluster_noc_grp_id returns the NoC group ID of the new cluster
  */
 bool start_new_cluster_for_mol(t_pack_molecule* molecule,
                                const t_logical_block_type_ptr& type,

vpr/src/route/connection_router.cpp

@@ -372,7 +372,7 @@ void ConnectionRouter<Heap>::timing_driven_expand_cheapest(t_heap* cheapest,
         VTR_LOGV_DEBUG(router_debug_, "    Better cost to %d\n", inode);
         VTR_LOGV_DEBUG(router_debug_, "    New total cost: %g\n", new_total_cost);
         VTR_LOGV_DEBUG(router_debug_, "    New back cost: %g\n", new_back_cost);
-        VTR_LOGV_DEBUG(router_debug_, "      Setting path costs for associated node %d (from %d edge %zu)\n",
+        VTR_LOGV_DEBUG(router_debug_ && (rr_nodes_.node_type(RRNodeId(cheapest->index)) != t_rr_type::SOURCE), "      Setting path costs for associated node %d (from %d edge %zu)\n",
                        cheapest->index,
                        static_cast<size_t>(rr_graph_->edge_src_node(cheapest->prev_edge())),
                        static_cast<size_t>(cheapest->prev_edge()));