add comments and subroutines

Author: soheilshahrouz

libs/EXTERNAL/CMakeLists.txt

@@ -9,8 +9,6 @@ add_subdirectory(libsdcparse)
 add_subdirectory(libblifparse)
 add_subdirectory(libtatum)
 add_subdirectory(libcatch2)
-
-#SET(BUILD_DEPS ON CACHE BOOL "Build libfoo shared library")
 #add_subdirectory(parmys)
 
 #VPR_USE_SERVER is initialized in the root CMakeLists

vpr/src/base/echo_files.cpp

@@ -32,8 +32,7 @@ void setEchoEnabled(bool echo_enabled) {
 }
 
 void setAllEchoFileEnabled(bool value) {
-    int i;
-    for (i = 0; i < (int)E_ECHO_END_TOKEN; i++) {
+    for (int i = 0; i < (int)E_ECHO_END_TOKEN; i++) {
         echoFileEnabled[i] = value;
     }
 }
@@ -67,7 +66,7 @@ void alloc_and_load_echo_file_info() {
     echoFileNames = new char*[(int)E_ECHO_END_TOKEN];
     for (auto i = 0; i < (int)E_ECHO_END_TOKEN; i++) {
         echoFileEnabled[i] = false;
-        echoFileNames[i] = NULL;
+        echoFileNames[i] = nullptr;
     }
 
     setAllEchoFileEnabled(getEchoEnabled());
@@ -136,9 +135,8 @@ void alloc_and_load_echo_file_info() {
 }
 
 void free_echo_file_info() {
-    int i;
     if (echoFileEnabled != nullptr) {
-        for (i = 0; i < (int)E_ECHO_END_TOKEN; i++) {
+        for (int i = 0; i < (int)E_ECHO_END_TOKEN; i++) {
             if (echoFileNames[i] != nullptr) {
                 delete[] echoFileNames[i];
             }
@@ -165,7 +163,7 @@ char* getOutputFileName(enum e_output_files ename) {
     return outputFileNames[(int)ename];
 }
 
-void alloc_and_load_output_file_names(const std::string default_name) {
+void alloc_and_load_output_file_names(const std::string& default_name) {
     std::string name;
 
     if (outputFileNames == nullptr) {
@@ -185,9 +183,8 @@ void alloc_and_load_output_file_names(const std::string default_name) {
 }
 
 void free_output_file_names() {
-    int i;
     if (outputFileNames != nullptr) {
-        for (i = 0; i < (int)E_FILE_END_TOKEN; i++) {
+        for (int i = 0; i < (int)E_FILE_END_TOKEN; i++) {
             if (outputFileNames[i] != nullptr) {
                 delete[] outputFileNames[i];
                 outputFileNames[i] = nullptr;

vpr/src/base/echo_files.h

@@ -92,7 +92,7 @@ void free_echo_file_info();
 
 void setOutputFileName(enum e_output_files ename, const char* name, const char* default_name);
 char* getOutputFileName(enum e_output_files ename);
-void alloc_and_load_output_file_names(const std::string default_name);
+void alloc_and_load_output_file_names(const std::string& default_name);
 void free_output_file_names();
 
 #endif

vpr/src/draw/draw_noc.cpp

@@ -34,8 +34,8 @@ void draw_noc(ezgl::renderer* g) {
         return;
     }
 
-    // check that the NoC tile has a capacity greater than 0 (can we assume it always will?) and if not then we cant draw anythign as the NoC tile wont be drawn
-    /* since the vector of routers all have a reference positions on the grid to the corresponding physical tile, just use the first router in the vector and get its position, then use this to get the capcity of a noc router tile
+    // check that the NoC tile has a capacity greater than 0 (can we assume it always will?) and if not then we cant draw anything as the NoC tile won't be drawn
+    /* since the vector of routers all have a reference positions on the grid to the corresponding physical tile, just use the first router in the vector and get its position, then use this to get the capacity of a noc router tile
      */
     const auto& type = device_ctx.grid.get_physical_type({router_list.begin()->get_router_grid_position_x(),
                                                           router_list.begin()->get_router_grid_position_y(),
@@ -239,7 +239,7 @@ void draw_noc_links(ezgl::renderer* g, t_logical_block_type_ptr noc_router_logic
     NocLinkType link_type;
 
     // get half the width and height of the noc connection marker
-    // we will shift the links based on this parameters since the links will be drawn at the boundaries of connection marker instead of the center
+    // we will shift the links based on these parameters since the links will be drawn at the boundaries of connection marker instead of the center
     double noc_connection_marker_quarter_width = (noc_connection_marker_bbox.center().x - noc_connection_marker_bbox.bottom_left().x) / 2;
     double noc_connection_marker_quarter_height = (noc_connection_marker_bbox.center().y - noc_connection_marker_bbox.bottom_left().y) / 2;
 
@@ -293,15 +293,15 @@ void determine_direction_to_shift_noc_links(vtr::vector<NocLinkId, NocLinkShift>
 
     int number_of_links = list_of_noc_link_shift_directions.size();
 
-    // store the parallel link of wach link we process
+    // store the parallel link of each link we process
     NocLinkId parallel_link;
 
     // go through all the noc links and assign how the link should be shifted
     for (int link = 0; link < number_of_links; link++) {
         // convert the link to a link id
         NocLinkId link_id(link);
 
-        // only assign a shift direction if we havent already
+        // only assign a shift direction if we haven't already
         if (list_of_noc_link_shift_directions[link_id] == NocLinkShift::NO_SHIFT) {
             // the current link will always have a TOP_shift
             list_of_noc_link_shift_directions[link_id] = NocLinkShift::TOP_SHIFT;
@@ -310,8 +310,8 @@ void determine_direction_to_shift_noc_links(vtr::vector<NocLinkId, NocLinkShift>
             parallel_link = noc_ctx.noc_model.get_parallel_link(link_id);
 
             // check first if a legal link id was found
-            if (parallel_link == INVALID_LINK_ID) {
-                // if we are here, then a parallel link wasnt found, so that means there is only a single link and there is no need to perform any shifting on the single link
+            if (parallel_link == NocLinkId::INVALID()) {
+                // if we are here, then a parallel link wasn't found, so that means there is only a single link and there is no need to perform any shifting on the single link
                 list_of_noc_link_shift_directions[link_id] = NocLinkShift::NO_SHIFT;
 
                 continue;
@@ -334,13 +334,13 @@ NocLinkType determine_noc_link_type(ezgl::point2d link_start_point, ezgl::point2
     double x_coord_horizontal_start = link_start_point.x;
     double y_coord_horizontal_start = link_start_point.y;
 
-    double x_coord_horziontal_end = x_coord_horizontal_start + HORIZONTAL_LINE_LENGTH;
+    double x_coord_horizontal_end = x_coord_horizontal_start + HORIZONTAL_LINE_LENGTH;
     double y_coord_horizontal_end = link_start_point.y;
 
     // stores the link type
     NocLinkType result = NocLinkType::INVALID_TYPE;
 
-    // we can check quickly if the link is vertical or horizontal without calculating the dot product. If it is vertical or horizontal then we just return. Otherwise we have to calculate it.
+    // we can check quickly if the link is vertical or horizontal without calculating the dot product. If it is vertical or horizontal then we just return. Otherwise, we have to calculate it.
 
     // check if the link is vertical by determining if there is any horizontal change
     if (vtr::isclose(x_coord_end - x_coord_start, 0.0)) {
@@ -349,7 +349,7 @@ NocLinkType determine_noc_link_type(ezgl::point2d link_start_point, ezgl::point2
         return result;
     }
 
-    // check if the link is horizontal by determinig if there is any vertical shift
+    // check if the link is horizontal by determining if there is any vertical shift
     if (vtr::isclose(y_coord_end - y_coord_start, 0.0)) {
         result = NocLinkType::HORIZONTAL;
 
@@ -361,11 +361,11 @@ NocLinkType determine_noc_link_type(ezgl::point2d link_start_point, ezgl::point2
     // get the magnitude of the link
     double link_magnitude = sqrt(pow(x_coord_end - x_coord_start, 2.0) + pow(y_coord_end - y_coord_start, 2.0));
     // get the dot product of the two connecting line
-    double dot_product_of_link_and_horizontal_line = (x_coord_end - x_coord_start) * (x_coord_horziontal_end - x_coord_horizontal_start) + (y_coord_end - y_coord_start) * (y_coord_horizontal_end - y_coord_horizontal_start);
+    double dot_product_of_link_and_horizontal_line = (x_coord_end - x_coord_start) * (x_coord_horizontal_end - x_coord_horizontal_start) + (y_coord_end - y_coord_start) * (y_coord_horizontal_end - y_coord_horizontal_start);
     // calculate the angle
     double angle = acos(dot_product_of_link_and_horizontal_line / (link_magnitude * HORIZONTAL_LINE_LENGTH));
 
-    // the angle is in the first or fourth quandrant of the unit circle
+    // the angle is in the first or fourth quadrant of the unit circle
     if ((angle > 0) && (angle < (PI_RADIAN / 2))) {
         // if the link is a positive sloped line, then its end point must be higher than its start point (must be higher than the connected horizontal line)
         if (y_coord_end > y_coord_horizontal_end) {
@@ -375,7 +375,7 @@ NocLinkType determine_noc_link_type(ezgl::point2d link_start_point, ezgl::point2
             result = NocLinkType::NEGATIVE_SLOPE;
         }
 
-    } else { // the case where the angle is in the 3rd and 4th quandrant of the unit cirle
+    } else { // the case where the angle is in the 3rd and 4th quadrant of the unit circle
 
         // if the link is a positive sloped line, then its end point must be lower than its start point (must be lower than the connected horizontal line)
         if (y_coord_end < y_coord_horizontal_end) {
@@ -415,7 +415,7 @@ void shift_noc_link(noc_link_draw_coords& link_coords, NocLinkShift link_shift_d
                 link_coords.start.x += noc_connection_marker_quarter_width;
                 link_coords.end.x += noc_connection_marker_quarter_width;
             }
-            // dont change anything if we arent shifting at all
+            // don't change anything if we aren't shifting at all
             break;
         case NocLinkType::HORIZONTAL:
             if (link_shift_direction == NocLinkShift::TOP_SHIFT) {
@@ -427,7 +427,7 @@ void shift_noc_link(noc_link_draw_coords& link_coords, NocLinkShift link_shift_d
                 link_coords.start.y -= noc_connection_marker_quarter_height;
                 link_coords.end.y -= noc_connection_marker_quarter_height;
             }
-            // dont change anything if we arent shifting at all
+            // don't change anything if we aren't shifting at all
             break;
         case NocLinkType::POSITVE_SLOPE:
             if (link_shift_direction == NocLinkShift::TOP_SHIFT) {
@@ -445,7 +445,7 @@ void shift_noc_link(noc_link_draw_coords& link_coords, NocLinkShift link_shift_d
                 link_coords.start.y -= noc_connection_marker_quarter_height;
                 link_coords.end.y -= noc_connection_marker_quarter_height;
             }
-            // dont change anything if we arent shifting at all
+            // don't change anything if we aren't shifting at all
             break;
         case NocLinkType::NEGATIVE_SLOPE:
             if (link_shift_direction == NocLinkShift::TOP_SHIFT) {

vpr/src/noc/noc_storage.cpp

@@ -1,5 +1,8 @@
 
 #include "noc_storage.h"
+#include "vtr_assert.h"
+#include "vpr_error.h"
+
 
 #include <algorithm>
 
@@ -20,7 +23,7 @@ const vtr::vector<NocRouterId, NocRouter>& NocStorage::get_noc_routers() const {
     return router_storage;
 }
 
-int NocStorage::get_number_of_noc_routers(void) const {
+int NocStorage::get_number_of_noc_routers() const {
     return router_storage.size();
 }
 
@@ -281,12 +284,12 @@ NocLinkId NocStorage::get_parallel_link(NocLinkId current_link) const {
     NocRouterId curr_sink_router = link_storage[current_link].get_sink_router();
 
     // get the link list of the sink router
-    const std::vector<NocLinkId>* sink_router_links = &(router_outgoing_links_list[curr_sink_router]);
+    const std::vector<NocLinkId>& sink_router_links = router_outgoing_links_list[curr_sink_router];
 
-    NocLinkId parallel_link = INVALID_LINK_ID;
+    NocLinkId parallel_link = NocLinkId::INVALID();
 
     // go through the links of the sink router and the link that has the current source router as the sink router of the link is the parallel link we are looking for
-    for (auto sink_router_link : *sink_router_links) {
+    for (auto sink_router_link : sink_router_links) {
         if (link_storage[sink_router_link].get_sink_router() == curr_source_router) {
             parallel_link = sink_router_link;
             break;

vpr/src/noc/noc_storage.h

@@ -35,21 +35,13 @@
  * 
  */
 
-#include <iostream>
 #include <vector>
 #include <string>
 #include <unordered_map>
 #include "noc_data_types.h"
 #include "vtr_vector.h"
 #include "noc_router.h"
 #include "noc_link.h"
-#include "vtr_assert.h"
-#include "vpr_error.h"
-#include "echo_files.h"
-// \cond
-// represents the id of a link that does not exist in the NoC
-constexpr NocLinkId INVALID_LINK_ID(-1);
-// \endcond
 
 class NocStorage {
   private:
@@ -61,10 +53,14 @@ class NocStorage {
      * @brief Stores outgoing links for each router in the NoC. These
      * links can be used by the router to communicate to other routers
      * in the NoC.
-     * 
      */
     vtr::vector<NocRouterId, std::vector<NocLinkId>> router_outgoing_links_list;
 
+    /**
+     * @brief Stores incoming links for each router in the NoC. These
+     * links can be used by the router to communicate to other routers
+     * in the NoC.
+     */
     vtr::vector<NocRouterId, std::vector<NocLinkId>> router_incoming_links_list;
 
     /** Contains all the links in the NoC*/
@@ -78,7 +74,6 @@ class NocStorage {
      * are dense since it is used to index the routers. The datastructure
      * below is a conversiont able that maps the user router IDs to the
      * corresponding internal ones.
-     * 
      */
     std::unordered_map<int, NocRouterId> router_id_conversion_table;
 
@@ -180,14 +175,22 @@ class NocStorage {
 
     /**
      * @brief Gets a vector of outgoing links for a given router
-     * in the NoC. THe link vector cannot be modified.
+     * in the NoC. The link vector cannot be modified.
      * 
      * @param id A unique identifier that represents a router
      * @return A vector of links. The links are represented by a unique
      * identifier.
      */
     const std::vector<NocLinkId>& get_noc_router_outgoing_links(NocRouterId id) const;
 
+    /**
+     * @brief Gets a vector of incoming links for a given router
+     * in the NoC.
+     *
+     * @param id A unique identifier that represents a router
+     * @return A vector of links. The links are represented by a unique
+     * identifier.
+     */
     const std::vector<NocLinkId>& get_noc_router_incoming_links(NocRouterId id) const;
 
     /**

vpr/src/noc/turn_model_routing.cpp

@@ -237,6 +237,12 @@ TurnModelRouting::Direction TurnModelRouting::select_direction_other_than(const
 std::vector<std::pair<NocLinkId, NocLinkId>> TurnModelRouting::get_all_illegal_turns(const NocStorage& noc_model) const {
     std::vector<std::pair<NocLinkId, NocLinkId>> illegal_turns;
 
+    /* Iterate over all sets of three routers that can be traversed in sequence.
+     * Check if traversing these three routes involves any turns, and if so,
+     * check if the resulting turn is illegal under the restrictions of a turn model
+     * routing algorithm. Store all illegal turns and return them.
+     */
+
     for (const auto& noc_router : noc_model.get_noc_routers()) {
         const int noc_router_user_id = noc_router.get_router_user_id();
         const NocRouterId noc_router_id = noc_model.convert_router_id(noc_router_user_id);

vpr/src/place/noc_place_utils.cpp

@@ -11,6 +11,7 @@
 #include "noc_routing.h"
 #include "place_constraints.h"
 #include "move_transactions.h"
+#include "sat_routing.h"
 
 #include <fstream>
 
@@ -67,13 +68,18 @@ void initial_noc_routing(const vtr::vector<NocTrafficFlowId, std::vector<NocLink
     /* We need all the traffic flow ids to be able to access them. The range
      * of traffic flow ids go from 0 to the total number of traffic flows within
      * the NoC.
-     * go through all the traffic flows and route them. Then once routed, update the links used in the routed traffic flows with their usages
+     * Go through all the traffic flows and route them. Then once routed,
+     * update the links used in the routed traffic flows with their usages
      */
     for (const auto& traffic_flow_id : noc_traffic_flows_storage.get_all_traffic_flow_id()) {
         const t_noc_traffic_flow& curr_traffic_flow = noc_traffic_flows_storage.get_single_noc_traffic_flow(traffic_flow_id);
 
-        // update the traffic flow route based on where the router cluster blocks are placed
-        const std::vector<NocLinkId>& curr_traffic_flow_route = new_traffic_flow_routes.empty() ? route_traffic_flow(traffic_flow_id, noc_ctx.noc_model, noc_traffic_flows_storage, *noc_ctx.noc_flows_router) : new_traffic_flow_routes[traffic_flow_id];
+        /* Update the traffic flow route based on where the router cluster blocks are placed.
+         * If the caller has not provided traffic flow routes, route traffic flow, otherwise use the provided route.
+         */
+        const std::vector<NocLinkId>& curr_traffic_flow_route = new_traffic_flow_routes.empty()
+                                                                    ? route_traffic_flow(traffic_flow_id, noc_ctx.noc_model, noc_traffic_flows_storage, *noc_ctx.noc_flows_router)
+                                                                    : new_traffic_flow_routes[traffic_flow_id];
 
         if (!new_traffic_flow_routes.empty()) {
             noc_traffic_flows_storage.get_mutable_traffic_flow_route(traffic_flow_id) = curr_traffic_flow_route;
@@ -217,7 +223,10 @@ std::vector<NocLinkId>& route_traffic_flow(NocTrafficFlowId traffic_flow_id,
     return curr_traffic_flow_route;
 }
 
-void update_traffic_flow_link_usage(const std::vector<NocLinkId>& traffic_flow_route, NocStorage& noc_model, int inc_or_dec, double traffic_flow_bandwidth) {
+void update_traffic_flow_link_usage(const std::vector<NocLinkId>& traffic_flow_route,
+                                    NocStorage& noc_model,
+                                    int inc_or_dec,
+                                    double traffic_flow_bandwidth) {
     // go through the links within the traffic flow route and update their bandwidth usage
     for (auto& link_in_route_id : traffic_flow_route) {
         // get the link to update and its current bandwidth
@@ -920,6 +929,46 @@ bool noc_routing_has_cycle(const vtr::vector<NocTrafficFlowId, std::vector<NocLi
     return has_cycles;
 }
 
+void invoke_sat_router(t_placer_costs& costs, const t_noc_opts& noc_opts, int seed) {
+
+    auto traffic_flow_routes = noc_sat_route(true, noc_opts, seed);
+
+    if (!traffic_flow_routes.empty()) {
+        bool has_cycle = noc_routing_has_cycle(traffic_flow_routes);
+        if (has_cycle) {
+            VTR_LOG("SAT NoC routing has cycles.\n");
+        }
+
+        reinitialize_noc_routing(costs, traffic_flow_routes);
+
+        print_noc_costs("\nNoC Placement Costs after SAT routing", costs, noc_opts);
+
+    } else {
+        VTR_LOG("SAT routing failed.\n");
+    }
+}
+
+void print_noc_costs(std::string_view header, const t_placer_costs& costs, const t_noc_opts& noc_opts) {
+    VTR_LOG("%s. "
+        "cost: %g, "
+        "aggregate_bandwidth_cost: %g, "
+        "latency_cost: %g, "
+        "n_met_latency_constraints: %d, "
+        "latency_overrun_cost: %g, "
+        "congestion_cost: %g, "
+        "accum_congested_ratio: %g, "
+        "n_congested_links: %d \n",
+        header,
+        calculate_noc_cost(costs.noc_cost_terms, costs.noc_cost_norm_factors, noc_opts),
+        costs.noc_cost_terms.aggregate_bandwidth,
+        costs.noc_cost_terms.latency,
+        get_number_of_traffic_flows_with_latency_cons_met(),
+        costs.noc_cost_terms.latency_overrun,
+        costs.noc_cost_terms.congestion,
+        get_total_congestion_bandwidth_ratio(),
+        get_number_of_congested_noc_links());
+}
+
 static std::vector<NocLinkId> find_affected_links_by_flow_reroute(std::vector<NocLinkId>& prev_links,
                                                                   std::vector<NocLinkId>& curr_links) {
     // Sort both link containers