Merge branch 'master' into noc_turn_model_routing

Author: soheilshahrouz

.github/workflows/test.yml

@@ -197,6 +197,11 @@ jobs:
             params: '-DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DVPR_USE_EZGL=off',
             suite: 'vtr_reg_basic'
           },
+          {
+            name: 'Basic with CAPNPROTO disabled',
+            params: '-DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DVTR_ENABLE_CAPNPROTO=off',
+            suite: 'vtr_reg_basic'
+          },
           {
             name: 'Basic with VTR_ENABLE_DEBUG_LOGGING',
             params: '-DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DVTR_ENABLE_DEBUG_LOGGING=on',
@@ -297,7 +302,13 @@ jobs:
         CMAKE_PARAMS: ${{ matrix.params }}
         BUILD_TYPE: debug
         LSAN_OPTIONS: 'exitcode=42' #Use a non-standard exit code to ensure LSAN errors are detected
+        # In Ubuntu 20240310.1.0, the entropy of ASLR has increased (28 -> 32). LLVM 14 in this
+        # image is not compatible with this increased ASLR entropy. Apparently, memory sanitizer
+        # depends on LLVM and all CI tests where VTR_ENABLE_SANITIZE is enabled fail. For a temporary
+        # fix, we manually reduce the entropy. This quick fix should be removed in the future
+        # when github deploys a more stable Ubuntu image.
       run: |
+        sudo sysctl -w vm.mmap_rnd_bits=28
         export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
         ./.github/scripts/build.sh
         # We skip QoR since we are only checking for errors in sanitizer runs
@@ -349,6 +360,7 @@ jobs:
         CMAKE_PARAMS: '-DVTR_ASSERT_LEVEL=3 -DVTR_ENABLE_SANITIZE=on -DVTR_IPO_BUILD=off -DWITH_BLIFEXPLORER=on -DWITH_PARMYS=OFF -DWITH_ODIN=on'
         BUILD_TYPE: debug
       run: |
+        sudo sysctl -w vm.mmap_rnd_bits=28
         export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
         ./.github/scripts/build.sh
         ./run_reg_test.py odin_reg_basic -show_failures -j2

CMakeLists.txt

@@ -23,7 +23,7 @@ set(VTR_IPO_BUILD "auto" CACHE STRING "Should VTR be compiled with interprocedur
 set_property(CACHE VTR_IPO_BUILD PROPERTY STRINGS auto on off)
 
 #Allow the user to configure how much assertion checking should occur
-set(VTR_ASSERT_LEVEL "2" CACHE STRING "VTR assertion checking level. 0: no assertions, 1: fast assertions, 2: regular assertions, 3: additional assertions with noticable run-time overhead, 4: all assertions (including those with significant run-time cost)")
+set(VTR_ASSERT_LEVEL "2" CACHE STRING "VTR assertion checking level. 0: no assertions, 1: fast assertions, 2: regular assertions, 3: additional assertions with noticeable run-time overhead, 4: all assertions (including those with significant run-time cost)")
 set_property(CACHE VTR_ASSERT_LEVEL PROPERTY STRINGS 0 1 2 3 4)
 
 option(VTR_ENABLE_STRICT_COMPILE "Specifies whether compiler warnings should be treated as errors (e.g. -Werror)" OFF)

libs/EXTERNAL/libargparse/README.md

@@ -2,7 +2,7 @@ libargparse
 ===========
 This is (yet another) simple command-line parser for C++ applications, inspired by Python's agparse module.
 
-It requires only a C++11 compiler, and has no external dependancies.
+It requires only a C++11 compiler, and has no external dependencies.
 
 One of the advantages of libargparse is that all conversions from command-line strings to program types (bool, int etc.) are performed when the command line is parsed (and not when the options are accessed).
 This avoids command-line related errors from showing up deep in the program execution, which can be problematic for long-running programs.

libs/libarchfpga/CMakeLists.txt

@@ -17,14 +17,38 @@ target_include_directories(libarchfpga PUBLIC ${LIB_INCLUDE_DIRS})
 
 set_target_properties(libarchfpga PROPERTIES PREFIX "") #Avoid extra 'lib' prefix
 
-#Specify link-time dependancies
+#Specify link-time dependencies
 target_link_libraries(libarchfpga
                         libvtrutil
                         libpugixml
                         libpugiutil
-                        libvtrcapnproto
 )
 
+if(${VTR_ENABLE_CAPNPROTO})
+    target_link_libraries(libarchfpga libvtrcapnproto)
+    target_compile_definitions(libarchfpga PRIVATE VTR_ENABLE_CAPNPROTO)
+endif()
+
+# Using filesystem library requires additional compiler/linker options for GNU implementation prior to 9.1
+# and LLVM implementation prior to LLVM 9.0;
+if(CMAKE_C_COMPILER_ID STREQUAL "GNU")
+    # Get the compiler version string
+    execute_process(COMMAND ${CMAKE_C_COMPILER} --version OUTPUT_VARIABLE _gcc_output)
+    string(REGEX MATCH "[0-9]+\\.[0-9]+(\\.[0-9]+)?" _gcc_version ${_gcc_output})
+
+    if(_gcc_version VERSION_LESS "9.1")
+        target_link_libraries(libarchfpga stdc++fs)
+    endif()
+elseif(CMAKE_C_COMPILER_ID STREQUAL "Clang")
+    # Get the compiler version string
+    execute_process(COMMAND ${CMAKE_C_COMPILER} --version OUTPUT_VARIABLE _clang_output)
+    string(REGEX MATCH "[0-9]+\\.[0-9]+(\\.[0-9]+)?" _clang_version ${_clang_output})
+
+    if(_clang_version VERSION_LESS "9.0")
+        target_link_libraries(libarchfpga c++fs)
+    endif()
+endif()
+
 target_compile_definitions(libarchfpga PUBLIC ${INTERCHANGE_SCHEMA_HEADERS})
 
 #Create the test executable

libs/libarchfpga/src/read_fpga_interchange_arch.cpp

@@ -1,3 +1,10 @@
+
+
+#include "read_fpga_interchange_arch.h"
+#include "vtr_error.h"
+
+#ifdef VTR_ENABLE_CAPNPROTO
+
 #include <algorithm>
 #include <kj/std/iostream.h>
 #include <limits>
@@ -21,7 +28,6 @@
 #include "arch_util.h"
 #include "arch_types.h"
 
-#include "read_fpga_interchange_arch.h"
 
 /*
  * FPGA Interchange Device frontend
@@ -2497,11 +2503,14 @@ struct ArchReader {
     }
 };
 
+#endif  // VTR_ENABLE_CAPNPROTO
+
 void FPGAInterchangeReadArch(const char* FPGAInterchangeDeviceFile,
                              const bool /*timing_enabled*/,
                              t_arch* arch,
                              std::vector<t_physical_tile_type>& PhysicalTileTypes,
                              std::vector<t_logical_block_type>& LogicalBlockTypes) {
+#ifdef VTR_ENABLE_CAPNPROTO
     // Decompress GZipped capnproto device file
     gzFile file = gzopen(FPGAInterchangeDeviceFile, "r");
     VTR_ASSERT(file != Z_NULL);
@@ -2542,4 +2551,12 @@ void FPGAInterchangeReadArch(const char* FPGAInterchangeDeviceFile,
 
     ArchReader reader(arch, device_reader, FPGAInterchangeDeviceFile, PhysicalTileTypes, LogicalBlockTypes);
     reader.read_arch();
+#else   // VTR_ENABLE_CAPNPROTO
+    // If CAPNPROTO is disabled, throw an error.
+    (void)FPGAInterchangeDeviceFile;
+    (void)arch;
+    (void)PhysicalTileTypes;
+    (void)LogicalBlockTypes;
+    throw vtr::VtrError("Unable to read FPGA interchange if CAPNPROTO is not enabled", __FILE__, __LINE__);
+#endif  // VTR_ENABLE_CAPNPROTO
 }

libs/libarchfpga/src/read_fpga_interchange_arch.h

@@ -3,13 +3,17 @@
 
 #include "arch_types.h"
 
+#ifdef VTR_ENABLE_CAPNPROTO
+
 #include "DeviceResources.capnp.h"
 #include "LogicalNetlist.capnp.h"
 #include "capnp/serialize.h"
 #include "capnp/serialize-packed.h"
 #include <fcntl.h>
 #include <unistd.h>
 
+#endif  // VTR_ENABLE_CAPNPROTO
+
 #ifdef __cplusplus
 extern "C" {
 #endif

libs/librrgraph/CMakeLists.txt

@@ -21,7 +21,7 @@ target_include_directories(librrgraph PUBLIC ${LIB_INCLUDE_DIRS})
 
 set_target_properties(librrgraph PROPERTIES PREFIX "") #Avoid extra 'lib' prefix
 
-#Specify link-time dependancies
+#Specify link-time dependencies
 target_link_libraries(librrgraph
                       libvtrutil
                       libarchfpga

libs/librrgraph/src/base/rr_graph_storage.h

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

libs/librrgraph/src/base/rr_graph_view.h

@@ -321,6 +321,12 @@ class RRGraphView {
     inline short edge_switch(RRNodeId id, t_edge_size iedge) const {
         return node_storage_.edge_switch(id, iedge);
     }
+
+    /** @brief Get the source node for the specified edge. */
+    inline RRNodeId edge_src_node(const RREdgeId edge_id) const {
+        return node_storage_.edge_src_node(edge_id);
+    }
+
     /** @brief Get the destination node for the iedge'th edge from specified RRNodeId.
      *  This method should generally not be used, and instead first_edge and
      *  last_edge should be used.*/

libs/libvtrutil/CMakeLists.txt

@@ -100,10 +100,30 @@ set_target_properties(libvtrutil PROPERTIES PREFIX "") #Avoid extra 'lib' prefix
 #Ensure version is always up to date by requiring version to be run first
 add_dependencies(libvtrutil version)
 
-#Specify link-time dependancies
+#Specify link-time dependencies
 target_link_libraries(libvtrutil
                         liblog)
 
+# Using filesystem library requires additional compiler/linker options for GNU implementation prior to 9.1
+# and LLVM implementation prior to LLVM 9.0;
+if(CMAKE_C_COMPILER_ID STREQUAL "GNU")
+    # Get the compiler version string
+    execute_process(COMMAND ${CMAKE_C_COMPILER} --version OUTPUT_VARIABLE _gcc_output)
+    string(REGEX MATCH "[0-9]+\\.[0-9]+(\\.[0-9]+)?" _gcc_version ${_gcc_output})
+
+    if(_gcc_version VERSION_LESS "9.1")
+        target_link_libraries(libvtrutil stdc++fs)
+    endif()
+elseif(CMAKE_C_COMPILER_ID STREQUAL "Clang")
+    # Get the compiler version string
+    execute_process(COMMAND ${CMAKE_C_COMPILER} --version OUTPUT_VARIABLE _clang_output)
+    string(REGEX MATCH "[0-9]+\\.[0-9]+(\\.[0-9]+)?" _clang_version ${_clang_output})
+
+    if(_clang_version VERSION_LESS "9.0")
+        target_link_libraries(libvtrutil c++fs)
+    endif()
+endif()
+
 install(TARGETS libvtrutil DESTINATION bin)
 install(FILES ${LIB_HEADERS} DESTINATION include/libvtrutil)
 

libs/libvtrutil/cmake/modules/configure_version.cmake

@@ -4,10 +4,11 @@
 #Figure out the git revision
 find_package(Git QUIET)
 if(GIT_FOUND)
-    exec_program(${GIT_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}
-                 ARGS describe --always --long --dirty
-                 OUTPUT_VARIABLE VTR_VCS_REVISION
-                 RETURN_VALUE GIT_DESCRIBE_RETURN_VALUE)
+    execute_process(COMMAND ${GIT_EXECUTABLE} describe --always --long --dirty
+                    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                    OUTPUT_VARIABLE VTR_VCS_REVISION
+                    OUTPUT_STRIP_TRAILING_WHITESPACE
+                    RESULT_VARIABLE GIT_DESCRIBE_RETURN_VALUE)
 
     if(NOT GIT_DESCRIBE_RETURN_VALUE EQUAL 0)
         #Git describe failed, usually this means we
@@ -18,10 +19,12 @@ if(GIT_FOUND)
 
     #Call again with exclude to get the revision excluding any tags
     #(i.e. just the commit ID and dirty flag)
-    exec_program(${GIT_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}
-                 ARGS describe --always --long --dirty --exclude '*'
-                 OUTPUT_VARIABLE VTR_VCS_REVISION_SHORT
-                 RETURN_VALUE GIT_DESCRIBE_RETURN_VALUE)
+    execute_process(COMMAND ${GIT_EXECUTABLE} describe --always --long --dirty --exclude '*'
+                    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                    OUTPUT_VARIABLE VTR_VCS_REVISION_SHORT
+                    OUTPUT_STRIP_TRAILING_WHITESPACE
+                    RESULT_VARIABLE GIT_DESCRIBE_RETURN_VALUE)
+
     if(NOT GIT_DESCRIBE_RETURN_VALUE EQUAL 0)
         #Git describe failed, usually this means we
         #aren't in a git repo -- so don't set a VCS 

libs/libvtrutil/src/vtr_util.cpp

@@ -31,7 +31,7 @@ std::vector<std::string> split(const char* text, const std::string& delims) {
         std::string text_str(text);
         return split(text_str, delims);
     }
-    return std::vector<std::string>();
+    return {};
 }
 
 /**

libs/libvtrutil/test/test_array_view.cpp

@@ -8,7 +8,7 @@ struct test_tag;
 using TestStrongId = vtr::StrongId<test_tag>;
 
 TEST_CASE("Array view", "[array_view/array_view]") {
-    std::array<uint16_t, 10> arr;
+    std::array<uint16_t, 10> arr = {0};
     vtr::array_view<uint16_t> arr_view(arr.data(), arr.size());
 
     const vtr::array_view<uint16_t>& carr_view = arr_view;
@@ -56,7 +56,7 @@ TEST_CASE("Array view", "[array_view/array_view]") {
 }
 
 TEST_CASE("Array view id", "[array_view/array_view_id]") {
-    std::array<uint16_t, 10> arr;
+    std::array<uint16_t, 10> arr = {0};
     vtr::array_view_id<TestStrongId, uint16_t> arr_view(arr.data(), arr.size());
 
     const vtr::array_view_id<TestStrongId, uint16_t>& carr_view = arr_view;

utils/fasm/CMakeLists.txt

@@ -33,7 +33,7 @@ if (GENFASM_USES_IPO)
     set_property(TARGET genfasm APPEND PROPERTY LINK_FLAGS ${IPO_LINK_WARN_SUPRESS_FLAGS})
 endif()
 
-#Specify link-time dependancies
+#Specify link-time dependencies
 install(TARGETS genfasm DESTINATION bin)
 
 #
@@ -49,7 +49,7 @@ set(TEST_SOURCES
 add_executable(test_fasm ${TEST_SOURCES})
 target_link_libraries(test_fasm fasm Catch2::Catch2WithMain)
 
-#Supress IPO link warnings if IPO is enabled
+#Suppress IPO link warnings if IPO is enabled
 get_target_property(TEST_FASM_USES_IPO test_fasm INTERPROCEDURAL_OPTIMIZATION)
 if (TEST_FASM_USES_IPO)
     set_property(TARGET test_fasm APPEND PROPERTY LINK_FLAGS ${IPO_LINK_WARN_SUPRESS_FLAGS})

utils/vqm2blif/CMakeLists.txt

@@ -15,7 +15,7 @@ add_library(libvqm2blif STATIC
 target_include_directories(libvqm2blif PUBLIC ${LIB_INCLUDE_DIRS})
 set_target_properties(libvqm2blif PROPERTIES PREFIX "") #Avoid extra 'lib' prefix
 
-#Specify link-time dependancies
+#Specify link-time dependencies
 target_link_libraries(libvqm2blif
                         libarchfpga
                         libvqm)

utils/vqm2blif/src/base/cleanup.cpp

@@ -297,7 +297,7 @@ void remove_one_lut_nodes ( busvec* buses, std::unordered_map<std::string, int>
 	t_node_port_association* source_port;
 	t_node_port_association* prev_port;
 	netvec* prev_bus;
-	t_net* prev_net;
+	t_net* prev_net = nullptr;
 
 	netvec* vcc_bus = get_bus_from_hash (hash_table, const_cast<char*>("vcc"), buses);
 	VTR_ASSERT(vcc_bus != NULL);
@@ -658,7 +658,7 @@ void verify_netlist ( t_node** nodes, int num_nodes, busvec* buses, std::unorder
 		auto hash_entry = hash_table.find(ref_pin->name);
 
 		VTR_ASSERT(hash_entry != hash_table.end());
-		VTR_ASSERT((unsigned int)hash_entry->second == i);
+		VTR_ASSERT((unsigned int)hash_entry->second == (unsigned int)i);
 
 		for (int j = 0; (unsigned int)j < temp_bus->size(); j++){
 			temp_net = &(temp_bus->at(j));
@@ -903,4 +903,4 @@ void reorganize_module_node_list(t_module* module)
 }
 
 //============================================================================================
-//============================================================================================
+//============================================================================================

vpr/CMakeLists.txt

@@ -43,10 +43,6 @@ file(GLOB_RECURSE LIB_SOURCES src/*/*.cpp)
 file(GLOB_RECURSE LIB_HEADERS src/*/*.h)
 files_to_dirs(LIB_HEADERS LIB_INCLUDE_DIRS)
 
-if(${VTR_ENABLE_CAPNPROTO})
-    add_definitions("-DVTR_ENABLE_CAPNPROTO")
-endif()
-
 if(${VPR_DEBUG_PARTITION_TREE})
     message(STATUS "VPR: Partition tree debug logs: enabled")
     add_definitions("-DVPR_DEBUG_PARTITION_TREE")
@@ -61,7 +57,7 @@ add_library(libvpr STATIC
 
 target_include_directories(libvpr PUBLIC ${LIB_INCLUDE_DIRS})
 
-#VPR_ANALYTIC_PLACE is inisitalized in the root CMakeLists
+#VPR_ANALYTIC_PLACE is initialized in the root CMakeLists
 #Check Eigen dependency
 if(${VPR_ANALYTIC_PLACE})
 	message(STATUS "VPR Analytic Placement: Requested")
@@ -79,7 +75,7 @@ endif()
 
 set_target_properties(libvpr PROPERTIES PREFIX "") #Avoid extra 'lib' prefix
 
-#Specify link-time dependancies
+#Specify link-time dependencies
 target_link_libraries(libvpr
                         libvtrutil
                         libarchfpga
@@ -131,6 +127,7 @@ target_compile_definitions(libvpr PUBLIC ${GRAPHICS_DEFINES})
 
 if(${VTR_ENABLE_CAPNPROTO})
     target_link_libraries(libvpr libvtrcapnproto)
+    target_compile_definitions(libvpr PRIVATE VTR_ENABLE_CAPNPROTO)
 endif()
 
 add_executable(vpr ${EXEC_SOURCES})
@@ -249,7 +246,7 @@ endif()
 # Signal handler configuration
 #
 if (VPR_USE_SIGNAL_HANDLER)
-    #Check wheter VPR can use sigaction to handle signals (only supported by POSIX)
+    #Check whether VPR can use sigaction to handle signals (only supported by POSIX)
     CHECK_CXX_SYMBOL_EXISTS(sigaction csignal HAVE_SIGACTION)
     if(HAVE_SIGACTION)
         target_compile_definitions(libvpr PRIVATE VPR_USE_SIGACTION)