removed NoC drawing functions from draw.cpp to draw_noc.cpp. Added doxygen comments to explain a few of the NoC drawing functions that were poorly commented before.

Author: Srivat97

vpr/src/draw/draw.cpp

@@ -96,7 +96,6 @@ static void draw_routing_bb(ezgl::renderer* g);
 static void draw_routing_util(ezgl::renderer* g);
 static void draw_crit_path(ezgl::renderer* g);
 static void draw_placement_macros(ezgl::renderer* g);
-static void draw_noc(ezgl::renderer* g);
 
 void act_on_key_press(ezgl::application* /*app*/, GdkEventKey* /*event*/, char* key_name);
 void act_on_mouse_press(ezgl::application* app, GdkEventButton* event, double x, double y);
@@ -154,8 +153,6 @@ static bool trace_routed_connection_rr_nodes_recurr(const t_rt_node* rt_node,
                                                     std::vector<int>& rr_nodes_on_path);
 static t_edge_size find_edge(int prev_inode, int inode);
 
-static void draw_color_map_legend(const vtr::ColorMap& cmap, ezgl::renderer* g);
-
 ezgl::color lighten_color(ezgl::color color, float amount);
 
 static void draw_block_pin_util();
@@ -189,26 +186,13 @@ static void set_block_text(GtkWidget* widget, gint /*response_id*/, gpointer /*d
 static void clip_routing_util(GtkWidget* widget, gint /*response_id*/, gpointer /*data*/);
 static void run_graphics_commands(std::string commands);
 
-// draw_noc helper functions
-static ezgl::rectangle get_noc_connection_marker_bbox(const t_logical_block_type_ptr noc_router_logical_block_type);
-
-static void draw_noc_connection_marker(ezgl::renderer* g, const vtr::vector<NocRouterId, NocRouter>& router_list, ezgl::rectangle connection_marker_bbox);
-
-static void draw_noc_links(ezgl::renderer* g, const t_logical_block_type_ptr noc_router_logical_block_type, vtr::vector<NocLinkId, ezgl::color>& noc_link_colors, ezgl::rectangle noc_connection_marker_bbox, const vtr::vector<NocLinkId, NocLinkShift>& list_of_noc_link_shift_directions);
-
-static void draw_noc_usage(vtr::vector<NocLinkId, ezgl::color>& noc_link_colors);
-
 /************************** File Scope Variables ****************************/
 
 //The arrow head position for turning/straight-thru connections in a switch box
 constexpr float SB_EDGE_TURN_ARROW_POSITION = 0.2;
 constexpr float SB_EDGE_STRAIGHT_ARROW_POSITION = 0.95;
 constexpr float EMPTY_BLOCK_LIGHTEN_FACTOR = 0.20;
 
-// defines the area of the marker that represents connection points between links
-// area is equivalent to the %x of the area of the router
-constexpr float SIZE_OF_NOC_MARKER = 0.30;
-
 //Kelly's maximum contrast colors are selected to be easily distinguishable as described in:
 //  Kenneth Kelly, "Twenty-Two Colors of Maximum Contrast", Color Eng. 3(6), 1943
 //We use these to highlight a relatively small number of things (e.g. stages in a critical path,
@@ -3680,292 +3664,6 @@ static void draw_routed_timing_edge(tatum::NodeId start_tnode,
     g->set_line_dash(ezgl::line_dash::none);
 }
 
-/*
- * Draw the NoC by drawing the links of the NoC and highlights the connection points between links.The drawing is done on top of all the placment and routing, so this acts as an overlay.
- *
- */
-static void draw_noc(ezgl::renderer* g) {
-    t_draw_state* draw_state = get_draw_state_vars();
-    auto& noc_ctx = g_vpr_ctx.noc();
-    auto& device_ctx = g_vpr_ctx.device();
-
-    // vector of routers in the NoC
-    vtr::vector<NocRouterId, NocRouter> router_list = noc_ctx.noc_model.get_noc_routers();
-
-    // a vector of colors to use for the NoC links, determines the colors used when drawing each link
-    vtr::vector<NocLinkId, ezgl::color> noc_link_colors;
-
-    // initialize all the link colors to black and set the vector size to the total number of links
-    noc_link_colors.resize(noc_ctx.noc_model.get_noc_links().size(), ezgl::BLACK);
-
-    // variables to keep track of how each link is drawn
-    vtr::vector<NocLinkId, NocLinkShift> list_of_noc_link_shift_directions;
-
-    // initialize all the link shift directions to no shift and set the vector size to the total number of links
-    list_of_noc_link_shift_directions.resize(noc_ctx.noc_model.get_noc_links().size(), NocLinkShift::NO_SHIFT);
-
-    // start by checking to see if the NoC display button was selected
-    // if the noc display option was not selected then don't draw the noc
-    if (draw_state->draw_noc == DRAW_NO_NOC) {
-        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
-     */
-    int num_subtiles = device_ctx.grid[router_list.begin()->get_router_grid_position_x()][router_list.begin()->get_router_grid_position_y()].type->capacity;
-
-    if (num_subtiles == 0) {
-        return;
-    }
-
-    // get the logical type of a noc router tile
-    t_logical_block_type_ptr noc_router_logical_type = pick_logical_type(device_ctx.grid[router_list.begin()->get_router_grid_position_x()][router_list.begin()->get_router_grid_position_y()].type);
-
-    // Now construct the coordinates for the markers that represent the connections between links (relative to the noc router tile position)
-    ezgl::rectangle noc_connection_marker_bbox = get_noc_connection_marker_bbox(noc_router_logical_type);
-
-    // only draw the noc useage if the user selected the option
-    if (draw_state->draw_noc == DRAW_NOC_LINK_USAGE) {
-        draw_noc_usage(noc_link_colors);
-
-        // draw the color map legend
-        draw_color_map_legend(*(draw_state->noc_usage_color_map), g);
-    }
-
-    // go through all the pairs of parallel links (if there are any) and assign a shift direction to them.
-    // One link will shift in one direction (knows as TOP) and the other link will shift in the opposite direction (known as BOTTOM)
-    determine_direction_to_shift_noc_links(list_of_noc_link_shift_directions);
-
-    draw_noc_links(g, noc_router_logical_type, noc_link_colors, noc_connection_marker_bbox, list_of_noc_link_shift_directions);
-
-    draw_noc_connection_marker(g, router_list, noc_connection_marker_bbox);
-
-    return;
-}
-
-/*
- * Go through each NoC link and assign a color based on how much the link is being used (its bandwidth). The colors are determined from the PLasma colormap.
- */
-static void draw_noc_usage(vtr::vector<NocLinkId, ezgl::color>& noc_link_colors) {
-    t_draw_state* draw_state = get_draw_state_vars();
-    auto& noc_ctx = g_vpr_ctx.noc();
-
-    // get the maximum badnwidth per link
-    double max_noc_link_bandwidth = noc_ctx.noc_model.get_noc_link_bandwidth();
-
-    // check to see if a color map was already created previously
-    if (draw_state->noc_usage_color_map == nullptr) {
-        // we havent created a color map yet for the noc link usage, so create it here
-        // the color map creates a color spectrum that gradually changes from a dark to light color. Where a dark color represents low noc link usage (low bandwidth) and a light color represents high noc link usage (high bandwidth)
-        // The color map needs a min and max value to generate the color range.
-        // The noc usage is calculated by taking the ratio of the links current bandwidth over the maximum allowable bandwidth
-        // for the NoC, the min value is 0, since you cannot go lower than 0 badnwidth.
-        // The max value is going to be 1 and represents the case where the link is used to full capacity on the noc link (as provided by the user)
-        draw_state->noc_usage_color_map = std::make_shared<vtr::PlasmaColorMap>(0.0, 1.0);
-    }
-
-    // get the list of links in the NoC
-    vtr::vector<NocLinkId, NocLink> link_list = noc_ctx.noc_model.get_noc_links();
-
-    // store each links bandwidth usage
-    double link_bandwidth_usage;
-
-    // represents the color to draw each noc link
-    ezgl::color current_noc_link_color;
-
-    // now we need to determine the colors for each link
-    for (int link = 0; link < (int)link_list.size(); link++) {
-        // get the current link id
-        NocLinkId link_id(link);
-
-        // only update the color of the link if it wasnt updated previously
-        if (noc_link_colors[link_id] == ezgl::BLACK) {
-            // if we are here then the link was not updated previously, so assign the color here
-
-            //get the current link bandwidth usage (ratio calculation)
-            link_bandwidth_usage = (link_list[link_id].get_bandwidth_usage()) / max_noc_link_bandwidth;
-
-            // check if the link is being overused and if it is then cap it at 1.0
-            if (link_bandwidth_usage > 1.0) {
-                link_bandwidth_usage = 1.0;
-            }
-
-            // get the corresponding color that represents the link bandwidth usgae
-            current_noc_link_color = to_ezgl_color(draw_state->noc_usage_color_map->color(link_bandwidth_usage));
-
-            // set the colors of the link
-            noc_link_colors[link_id] = current_noc_link_color;
-        }
-    }
-
-    return;
-}
-
-/************* draw_noc helper functions below *************/
-
-/*
- * This function calculates the position of the marker that will be drawn inside the noc router tile on the FPGA. This marker will be located in the center of the tile and represents a connection point between links that connect to the router.
- */
-static ezgl::rectangle get_noc_connection_marker_bbox(const t_logical_block_type_ptr noc_router_logical_block_type) {
-    t_draw_coords* draw_coords = get_draw_coords_vars();
-
-    // get the drawing information for a noc router
-    t_draw_pb_type_info& blk_type_info = draw_coords->blk_info.at(noc_router_logical_block_type->index);
-
-    // get the drawing coordinates for the noc router tile
-    auto& pb_gnode = *noc_router_logical_block_type->pb_graph_head;
-    ezgl::rectangle noc_router_pb_bbox = blk_type_info.get_pb_bbox(pb_gnode);
-
-    /*
-     * The connection marker will be positioned at the center of the noc router tile. For example it will look like below:
-     *
-     *********************
-     *                   *
-     *                   *
-     *       ****        *
-     *       *  *        *
-     *       ****        *
-     *                   *
-     *                   *
-     *********************
-     *
-     * We do the following to calculate the position of the marker:
-     * 1. Get the area of the larger router tile
-     * 2. Calculate the area of the marker (based on a predefined percentage of the area of the larger noc tile)
-     * 3. The marker is a square, so we can can calculate the lengths 
-     * of the sides of the marker
-     * 4. Divide the side length by 2 and subtract this from the x & y coordinates of the center of the larger noc router tile. This is the bottom left corner of the rectangle.
-     * 5. Then add the side length to the x & y coordinate of the center of the larger noc router tile. THis is the top right corner of the rectangle.    
-     */
-    double noc_router_bbox_area = noc_router_pb_bbox.area();
-    ezgl::point2d noc_router_bbox_center = noc_router_pb_bbox.center();
-
-    double connection_marker_bbox_area = noc_router_bbox_area * SIZE_OF_NOC_MARKER;
-    double connection_marker_bbox_side_length = sqrt(connection_marker_bbox_area);
-
-    double half_of_connection_marker_bbox_side_length = connection_marker_bbox_side_length / 2;
-
-    // calculate bottom left corner coordinate of marker
-    ezgl::point2d connection_marker_origin_pt(noc_router_bbox_center.x - half_of_connection_marker_bbox_side_length, noc_router_bbox_center.y - half_of_connection_marker_bbox_side_length);
-    // calculate upper right corner coordinate of marker
-    ezgl::point2d connection_marker_top_right_pt(noc_router_bbox_center.x + half_of_connection_marker_bbox_side_length, noc_router_bbox_center.y + half_of_connection_marker_bbox_side_length);
-
-    ezgl::rectangle connection_marker_bbox(connection_marker_origin_pt, connection_marker_top_right_pt);
-
-    return connection_marker_bbox;
-}
-
-/*
- * This function draws the markers inside the noc router tiles. This marker represents a connection that is an intersection points between multiple links.
- */
-static void draw_noc_connection_marker(ezgl::renderer* g, const vtr::vector<NocRouterId, NocRouter>& router_list, ezgl::rectangle connection_marker_bbox) {
-    t_draw_coords* draw_coords = get_draw_coords_vars();
-
-    //set the color of the marker
-    g->set_color(ezgl::BLACK);
-
-    int router_grid_position_x = 0;
-    int router_grid_position_y = 0;
-
-    ezgl::rectangle updated_connection_marker_bbox;
-
-    // go through the routers and create the connection marker
-    for (auto router = router_list.begin(); router != router_list.end(); router++) {
-        router_grid_position_x = router->get_router_grid_position_x();
-        router_grid_position_y = router->get_router_grid_position_y();
-
-        // get the coordinates to draw the marker given the current routers tile position
-        updated_connection_marker_bbox = connection_marker_bbox + ezgl::point2d(draw_coords->tile_x[router_grid_position_x], draw_coords->tile_y[router_grid_position_y]);
-
-        // draw the marker
-        g->fill_rectangle(updated_connection_marker_bbox);
-    }
-
-    return;
-}
-
-/*
- * This function draws the links within the noc. So based on a given noc topology, this function draws the links that connect the routers in the noc together.
- */
-static void draw_noc_links(ezgl::renderer* g, const t_logical_block_type_ptr noc_router_logical_block_type, vtr::vector<NocLinkId, ezgl::color>& noc_link_colors, ezgl::rectangle noc_connection_marker_bbox, const vtr::vector<NocLinkId, NocLinkShift>& list_of_noc_link_shift_directions) {
-    t_draw_coords* draw_coords = get_draw_coords_vars();
-    auto& noc_ctx = g_vpr_ctx.noc();
-
-    // vector of routers in the NoC
-    vtr::vector<NocRouterId, NocRouter> router_list = noc_ctx.noc_model.get_noc_routers();
-
-    // get the links of the NoC
-    vtr::vector<NocLinkId, NocLink> link_list = noc_ctx.noc_model.get_noc_links();
-
-    // set the width of the link
-    g->set_line_width(2);
-
-    // routers connecting links
-    NocRouterId source_router;
-    NocRouterId sink_router;
-
-    // source router grid coordinates
-    int source_router_x_position = 0;
-    int source_router_y_position = 0;
-
-    // sink router grid coordinates
-    int sink_router_x_position = 0;
-    int sink_router_y_position = 0;
-
-    // coordinates of source and sink routers
-    ezgl::rectangle abs_source_router_bbox;
-    ezgl::rectangle abs_sink_router_bbox;
-
-    // the coordinates to draw the link
-    noc_link_draw_coords link_coords;
-
-    // the type of the noc link
-    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
-    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;
-
-    // loop through the links and draw them
-    for (int link = 0; link < (int)link_list.size(); link++) {
-        // get the converted link if
-        NocLinkId link_id(link);
-
-        // get the routers
-        source_router = link_list[link_id].get_source_router();
-        sink_router = link_list[link_id].get_sink_router();
-
-        // calculate the grid positions of the source and sink routers
-        source_router_x_position = router_list[source_router].get_router_grid_position_x();
-        source_router_y_position = router_list[source_router].get_router_grid_position_y();
-
-        sink_router_x_position = router_list[sink_router].get_router_grid_position_x();
-        sink_router_y_position = router_list[sink_router].get_router_grid_position_y();
-
-        // get the initial drawing coordinates of the noc link
-        // it will be drawn from the center of two routers it connects
-        link_coords.start = draw_coords->get_absolute_clb_bbox(source_router_x_position, source_router_y_position, 0, noc_router_logical_block_type).center();
-        link_coords.end = draw_coords->get_absolute_clb_bbox(sink_router_x_position, sink_router_y_position, 0, noc_router_logical_block_type).center();
-
-        // determine the current noc link type
-        link_type = determine_noc_link_type(link_coords.start, link_coords.end);
-
-        shift_noc_link(link_coords, list_of_noc_link_shift_directions[link_id], link_type, noc_connection_marker_quarter_width, noc_connection_marker_quarter_height);
-
-        // set the color to draw the current link
-        g->set_color(noc_link_colors[link_id]);
-
-        //draw a line between the center of the two routers this link connects
-        g->draw_line(link_coords.start, link_coords.end);
-    }
-
-    return;
-}
-
-/************* end of draw_noc helper functions *************/
-
 //Collect all the drawing locations associated with the timing edge between start and end
 static void draw_routed_timing_edge_connection(tatum::NodeId src_tnode,
                                                tatum::NodeId sink_tnode,
@@ -4125,7 +3823,7 @@ ezgl::color to_ezgl_color(vtr::Color<float> color) {
     return ezgl::color(color.r * 255, color.g * 255, color.b * 255);
 }
 
-static void draw_color_map_legend(const vtr::ColorMap& cmap,
+void draw_color_map_legend(const vtr::ColorMap& cmap,
                                   ezgl::renderer* g) {
     constexpr float LEGEND_WIDTH_FAC = 0.075;
     constexpr float LEGEND_VERT_OFFSET_FAC = 0.05;

vpr/src/draw/draw.h

@@ -67,6 +67,8 @@ void draw_highlight_fan_in_fan_out(const std::set<int>& nodes);
 std::set<int> draw_expand_non_configurable_rr_nodes(int hit_node);
 void deselect_all();
 
+void draw_color_map_legend(const vtr::ColorMap& cmap, ezgl::renderer* g);
+
 // toggle functions
 void toggle_nets(GtkWidget* /*widget*/, gint /*response_id*/, gpointer /*data*/);
 void toggle_rr(GtkWidget* /*widget*/, gint /*response_id*/, gpointer /*data*/);