Merge branch 'master' of https://github.com/verilog-to-routing/vtr-verilog-to-routing into map_lookahead_bug_fix

Author: amin1377

.github/workflows/test.yml

@@ -67,6 +67,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
@@ -79,10 +86,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

ODIN_II/SRC/include/odin_error.h

@@ -39,25 +39,29 @@ extern std::vector<std::pair<std::string, int>> include_file_names;
 extern int delayed_errors;
 extern const loc_t unknown_location;
 
-#ifdef ODIN_USE_YOSYS
+#define SYSTEMVERILOG_PARSER_ERROR                        \
+    "The SystemVerilog parser is provided within Yosys. " \
+    "Please use the Yosys elaborator to synthesize SystemVerilog files.\n"
+#define UHDM_PARSER_ERROR                        \
+    "The UHDM parser is provided within Yosys. " \
+    "Please use the Yosys elaborator to synthesize UHDM files.\n"
+
+#ifndef ODIN_USE_YOSYS
+#    define YOSYS_INSTALLATION_ERROR                              \
+        "It seems Yosys is not installed in the VTR repository. " \
+        "Please compile the VTR with (\" -DODIN_USE_YOSYS=ON \") flag.\n"
+#else
 #    define YOSYS_ELABORATION_ERROR             \
         "Yosys failed to perform elaboration, " \
         "Please look at the log file for the failure cause or pass \'--show_yosys_log\' to Odin-II to see the logs.\n"
 #    define YOSYS_FORK_ERROR \
         "Yosys child process failed to be created\n"
-#    define YOSYS_PLUGINS_WITH_ODIN_ERROR \
-        "Utilizing SystemVerilog/UHDM plugins requires activating the Yosys frontend.\
-        Please recompile the VTR project either with the \"WITH_YOSYS\" or \"ODIN_USE_YOSYS\" flag on."
-#else
-#    define YOSYS_INSTALLATION_ERROR                             \
-        "It seems Yosys is not installed in the VTR repository." \
-        " Please compile the VTR with (\" -DODIN_USE_YOSYS=ON \") flag.\n"
 #endif
 
 #ifndef YOSYS_SV_UHDM_PLUGIN
-#    define YOSYS_PLUGINS_NOT_COMPILED \
-        "SystemVerilog/UHDM plugins are not compiled.\
-        Please recompile the VTR project with the \"YOSYS_SV_UHDM_PLUGIN\" flag on."
+#    define YOSYS_PLUGINS_NOT_COMPILED                  \
+        "SystemVerilog/UHDM plugins are not compiled. " \
+        "Please recompile the VTR project with the \"YOSYS_SV_UHDM_PLUGIN\" flag on."
 #endif
 
 // causes an interrupt in GDB

ODIN_II/SRC/include/odin_util.h

@@ -12,7 +12,7 @@ long shift_left_value_with_overflow_check(long input_value, long shift_by, loc_t
 std::string get_file_extension(std::string input_file);
 std::string get_directory(std::string input_file);
 void create_directory(std::string path);
-void assert_valid_file_extenstion(std::vector<std::string> name_list, file_type_e type);
+void report_frontend_elaborator();
 void assert_supported_file_extension(std::string input_file, loc_t loc);
 FILE* open_file(const char* file_name, const char* open_type);
 void get_current_path();

ODIN_II/SRC/odin_ii.cpp

@@ -349,7 +349,7 @@ netlist_t* start_odin_ii(int argc, char** argv) {
         ODIN_ERROR_CODE error_code;
 
         print_input_files_info();
-        assert_valid_file_extenstion(configuration.list_of_file_names, configuration.input_file_type);
+        report_frontend_elaborator();
 
         if (configuration.input_file_type != file_type_e::_BLIF || configuration.coarsen) {
             try {

ODIN_II/SRC/odin_util.cpp

@@ -92,80 +92,56 @@ void create_directory(std::string path) {
 }
 
 /**
- * @brief assert all input files have valid type and extenstion
- * 
- * @param name_list list of input files
- * @param type the type to be checked with
+ * @brief report the frontend elaborator and its parser
  */
-void assert_valid_file_extenstion(std::vector<std::string> name_list, file_type_e type) {
-    for (auto file_name : name_list) {
-        // lookup the file type string from file extension map
-        auto file_ext_str = string_to_lower(get_file_extension(file_name));
-        auto file_ext_it = file_extension_strmap.find(file_ext_str);
-
-        // Unsupported file types should be already check.
-        // However, we double-check here
-        if (file_ext_it == file_extension_strmap.end()) {
-            assert_supported_file_extension(file_name, unknown_location);
-        } else {
-            file_type_e file_type = file_ext_it->second;
-            // Check if the file_name extension matches with type
-            switch (type) {
-                case (file_type_e::_VERILOG): // fallthrough
-                case (file_type_e::_VERILOG_HEADER): {
-                    if (file_type != file_type_e::_VERILOG && file_type != file_type_e::_VERILOG_HEADER)
-                        error_message(UTIL, unknown_location,
-                                      "File (%s) has an invalid extension (%s), supposed to be a %s or %s file { %s, %s },\
-                                      please see ./odin --help",
-                                      file_name.c_str(),
-                                      file_ext_str.c_str(),
-                                      file_type_strmap.find(file_type_e::_VERILOG)->second.c_str(),
-                                      file_type_strmap.find(file_type_e::_VERILOG_HEADER)->second.c_str(),
-                                      file_extension_strmap.find(file_type_e::_VERILOG)->second.c_str(),
-                                      file_extension_strmap.find(file_type_e::_VERILOG_HEADER)->second.c_str());
-                    break;
-                }
-                case (file_type_e::_SYSTEM_VERILOG): //fallthrough
-                case (file_type_e::_UHDM): {
-                    if (configuration.elaborator_type != elaborator_e::_YOSYS) {
-#ifndef ODIN_USE_YOSYS
-                        error_message(PARSE_ARGS, unknown_location, "%s", YOSYS_INSTALLATION_ERROR);
+void report_frontend_elaborator() {
+    // Check if the file_name extension matches with type
+    switch (configuration.input_file_type) {
+        case (file_type_e::_VERILOG): // fallthrough
+        case (file_type_e::_VERILOG_HEADER): {
+            if (configuration.elaborator_type == elaborator_e::_ODIN) {
+                printf("Using the ODIN_II parser for elaboration\n");
+            } else if (configuration.elaborator_type == elaborator_e::_YOSYS) {
+                printf("Using the Yosys elaborator with it's conventional Verilog/SystemVerilog parser\n");
+            }
+            break;
+        }
+        case (file_type_e::_SYSTEM_VERILOG): {
+            if (configuration.elaborator_type != elaborator_e::_YOSYS) {
+                error_message(PARSE_ARGS, unknown_location, "%s", SYSTEMVERILOG_PARSER_ERROR);
+            }
+#ifndef YOSYS_SV_UHDM_PLUGIN
+            printf("Using the Yosys elaborator with it's conventional Verilog/SystemVerilog parser\n");
 #else
-                        error_message(UTIL, unknown_location, "%s", YOSYS_PLUGINS_WITH_ODIN_ERROR);
+            printf("Using the Yosys elaborator with the Yosys-F4PGA-Plugin parser for SystemVerilog\n");
 #endif
-                    } else {
-#ifndef YOSYS_SV_UHDM_PLUGIN
-                        error_message(UTIL, unknown_location, "%s", YOSYS_PLUGINS_NOT_COMPILED);
+            break;
+        }
+        case (file_type_e::_UHDM): {
+            if (configuration.elaborator_type != elaborator_e::_YOSYS) {
+                error_message(PARSE_ARGS, unknown_location, "%s", UHDM_PARSER_ERROR);
+
+            } else if (configuration.elaborator_type == elaborator_e::_YOSYS) {
+#ifndef ODIN_USE_YOSYS
+                error_message(PARSE_ARGS, unknown_location, "%s", YOSYS_INSTALLATION_ERROR);
+#else
+#    ifndef YOSYS_SV_UHDM_PLUGIN
+                error_message(PARSE_ARGS, unknown_location, "%s", YOSYS_PLUGINS_NOT_COMPILED);
+#    endif
 #endif
-                    }
-                    if (file_type != type && type != file_type_e::_UHDM)
-                        error_message(UTIL, unknown_location,
-                                      "File (%s) has an invalid extension (%s), supposed to be a %s file { %s },\
-                                      please see ./odin --help",
-                                      file_name.c_str(),
-                                      file_ext_str.c_str(),
-                                      file_type_strmap.find(type)->second.c_str(),
-                                      file_extension_strmap.find(type)->second.c_str());
-                    break;
-                }
-                case (file_type_e::_BLIF): {
-                    if (file_type != type)
-                        error_message(UTIL, unknown_location,
-                                      "File (%s) has an invalid extension (%s), supposed to be a %s file { %s },\
-                                      please see ./odin --help",
-                                      file_name.c_str(),
-                                      file_ext_str.c_str(),
-                                      file_type_strmap.find(type)->second.c_str(),
-                                      file_extension_strmap.find(type)->second.c_str());
-                    break;
-                }
-                case (file_type_e::_EBLIF): //fallthrough
-                case (file_type_e::_ILANG): // fallthrough
-                default: {
-                    assert_supported_file_extension(file_name, unknown_location);
-                    break;
-                }
             }
+            printf("Using the Yosys elaborator with the Surelog parser for UHDM\n");
+            break;
+        }
+        case (file_type_e::_BLIF): {
+            printf("Using the ODIN_II BLIF parser\n");
+            break;
+        }
+        case (file_type_e::_EBLIF): //fallthrough
+        case (file_type_e::_ILANG): //fallthrough
+        default: {
+            error_message(UTIL, unknown_location, "%s", "Invalid file type");
+            break;
         }
     }
 }

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.