Merge branch 'master' into 2089_tight_floorplan_regression_test

Author: zhaisitong

.github/workflows/test.yml

@@ -68,6 +68,13 @@ jobs:
   Build:
     name: 'B: Building VtR'
     runs-on: ubuntu-18.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - { build_type: 'release', verbose: '0' }
+        - { build_type: 'debug',   verbose: '0' }
+        - { build_type: 'debug',   verbose: '1' }
     steps:
 
     - uses: actions/setup-python@v2
@@ -80,10 +87,10 @@ jobs:
 
     - name: Test
       env:
-        BUILD_TYPE: release
+        BUILD_TYPE: ${{ matrix.build_type }}
       run: |
         export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
-        ./.github/scripts/build.sh
+        ./.github/scripts/build.sh VERBOSE=${{ matrix.verbose }}
 
 
   Format:

CMakeLists.txt

@@ -31,6 +31,7 @@ option(VTR_ENABLE_SANITIZE "Enable address/leak/undefined-behaviour sanitizers (
 option(VTR_ENABLE_PROFILING "Enable performance profiler (gprof)" OFF)
 option(VTR_ENABLE_COVERAGE "Enable code coverage tracking (gcov)" OFF)
 option(VTR_ENABLE_DEBUG_LOGGING "Enable debug logging" OFF)
+option(VTR_ENABLE_VERBOSE "Enable increased debug verbosity" OFF)
 
 #Allow the user to decide whether to compile the graphics library
 set(VPR_USE_EZGL "auto" CACHE STRING "Specify whether vpr uses the graphics library")
@@ -285,6 +286,14 @@ if(VTR_ENABLE_DEBUG_LOGGING)
     message(STATUS "Logging Flags: ${LOGGING_FLAGS}")
 endif()
 
+#
+# Increased debugging vebosity
+#
+if(VTR_ENABLE_VERBOSE)
+    set(EXTRA_FLAGS "${EXTRA_FLAGS} -DVTR_ENABLE_DEBUG_LOGGING")
+    message(STATUS "Enabling increased debugging verbosity")
+endif()
+
 if (CMAKE_MAKE_PROGRAM EQUAL "ninja" )
     #Only for coloured output for ninja, it may be desired
     #to not force colours with other make programs (e.g. if

Makefile

@@ -10,6 +10,10 @@
 #
 # To perform a debug build use:
 #   'make BUILD_TYPE=debug'
+#
+# To enable debugging verbose messages as well use:
+#
+#   'make BUILD_TYPE=debug VERBOSE=1'
 
 #Default build type
 # Possible values:
@@ -19,6 +23,9 @@
 #    strict			#Build VPR with warnings treated as errors
 BUILD_TYPE ?= release
 
+#Debugging verbosity enable
+VERBOSE ?= 0
+
 #Convert to lower case for consistency
 BUILD_TYPE := $(shell echo $(BUILD_TYPE) | tr '[:upper:]' '[:lower:]')
 
@@ -36,6 +43,11 @@ ifneq (,$(findstring strict,$(BUILD_TYPE)))
 override CMAKE_PARAMS := -DVTR_ENABLE_STRICT_COMPILE=on ${CMAKE_PARAMS}
 endif #Strict build type
 
+#Enable verbosity
+ifeq ($(VERBOSE),1)
+override CMAKE_PARAMS := -DVTR_ENABLE_VERBOSE=on ${CMAKE_PARAMS}
+endif
+
 # -s : Suppresss makefile output (e.g. entering/leaving directories)
 # --output-sync target : For parallel compilation ensure output for each target is synchronized (make version >= 4.0)
 MAKEFLAGS := -s

doc/src/dev/tutorials/edit_vpr_ui.rst

@@ -1,9 +1,13 @@
 .. _edit_vpr_ui:
 
-Editing VPR UI
+VPR UI and Graphics
 --------------
 
 VPR's UI is created with GTK, and actively maintained/edited through the use of Glade and a main.ui file. We prefer to not use code initializations of Gtk Buttons/UI objects, and instead make them with Glade. 
-This allows for better organized menus and visual editing of the UI. Please consult the attached guide for Glade: <Link Glade/Gtk quickstart> (WIP as of August 8th, 2022). 
+This allows for better organized menus and visual editing of the UI. Please consult the attached guide for Glade: <Link Glade/Gtk quickstart> (WIP as of August 24th, 2022). 
 
-When connecting a button to its function, place it in an appropriate function depending on the drop down menu it will go in. Button setups are done in ui_setup.cpp/h and callback functions are in draw_toggle_functions.cpp/h.
+When connecting a button to its function, place it in an appropriate function depending on the drop down menu it will go in. Button setups are done in ui_setup.cpp/h and callback functions are in draw_toggle_functions.cpp/h.
+
+VPR Graphics are drawn using the EZGL graphics library, which is a wrapper around the GTK graphics library (which is used for the UI). EZGL Documentation is found here: http://ug251.eecg.utoronto.ca/ece297s/ezgl_doc/index.html and GTK documentation is found here: https://docs.gtk.org/gtk3/
+
+Make sure to test the UI when you edit it. Ensure that the graphics window opens (using the --disp on command) and click around the UI to ensure the buttons still work. Test all phases (Placement -> Routing) as the UI changes between them. 

vpr/src/base/read_circuit.cpp

@@ -33,7 +33,7 @@ AtomNetlist read_and_process_circuit(e_circuit_format circuit_format, t_vpr_setu
     bool should_sweep_dangling_nets = vpr_setup.NetlistOpts.sweep_dangling_nets;
     bool should_sweep_dangling_blocks = vpr_setup.NetlistOpts.sweep_dangling_blocks;
     bool should_sweep_constant_primary_outputs = vpr_setup.NetlistOpts.sweep_constant_primary_outputs;
-    bool verbosity = vpr_setup.NetlistOpts.netlist_verbosity;
+    int verbosity = vpr_setup.NetlistOpts.netlist_verbosity;
 
     if (circuit_format == e_circuit_format::AUTO) {
         auto name_ext = vtr::split_ext(circuit_file);

vpr/src/place/initial_placement.cpp

@@ -16,6 +16,10 @@
 #include <chrono>
 #include <time.h>
 
+#ifdef VERBOSE
+void print_clb_placement(const char* fname);
+#endif
+
 /**
  * @brief Used to assign each block a score for how difficult it is to place. 
  * The higher numbers indicate a block is expected to be more difficult to place.

vpr/src/place/place.cpp

@@ -245,7 +245,7 @@ std::unique_ptr<FILE, decltype(&vtr::fclose)> f_move_stats_file(nullptr,
 
 /********************* Static subroutines local to place.c *******************/
 #ifdef VERBOSE
-static void print_clb_placement(const char* fname);
+void print_clb_placement(const char* fname);
 #endif
 
 static void alloc_and_load_placement_structs(float place_cost_exp,
@@ -2849,7 +2849,7 @@ int check_macro_placement_consistency() {
 }
 
 #ifdef VERBOSE
-static void print_clb_placement(const char* fname) {
+void print_clb_placement(const char* fname) {
     /* Prints out the clb placements to a file.  */
     FILE* fp;
     auto& cluster_ctx = g_vpr_ctx.clustering();
@@ -2860,7 +2860,7 @@ static void print_clb_placement(const char* fname) {
 
     fprintf(fp, "Block #\tName\t(X, Y, Z).\n");
     for (auto i : cluster_ctx.clb_nlist.blocks()) {
-        fprintf(fp, "#%d\t%s\t(%d, %d, %d).\n", i, cluster_ctx.clb_nlist.block_name(i), place_ctx.block_locs[i].x, place_ctx.block_locs[i].y, place_ctx.block_locs[i].sub_tile);
+        fprintf(fp, "#%d\t%s\t(%d, %d, %d).\n", i, cluster_ctx.clb_nlist.block_name(i).c_str(), place_ctx.block_locs[i].loc.x, place_ctx.block_locs[i].loc.y, place_ctx.block_locs[i].loc.sub_tile);
     }
 
     fclose(fp);

vpr/src/place/timing_place_lookup.cpp

@@ -513,7 +513,7 @@ static void generic_compute_matrix_dijkstra_expansion(
 
 #ifdef VERBOSE
                         VTR_LOG("Computed delay: %12g delta: %d,%d (src: %d,%d sink: %d,%d)\n",
-                                delay,
+                                delays[size_t(sink_rr_node)],
                                 delta_x, delta_y,
                                 source_x, source_y,
                                 sink_x, sink_y);