Merge branch 'master' into fix_fixed_clusters_issue

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/EXTERNAL/libargparse/src/argparse.cpp

@@ -1,10 +1,10 @@
 #include <algorithm>
-#include <array>
 #include <list>
 #include <cassert>
 #include <string>
 #include <set>
 #include <limits>
+#include <utility>
 
 #include "argparse.hpp"
 #include "argparse_util.hpp"
@@ -16,16 +16,16 @@ namespace argparse {
      * ArgumentParser
      */
 
-    ArgumentParser::ArgumentParser(std::string prog_name, std::string description_str, std::ostream& os)
-        : description_(description_str)
+    ArgumentParser::ArgumentParser(const std::string& prog_name, std::string description_str, std::ostream& os)
+        : description_(std::move(description_str))
         , formatter_(new DefaultFormatter())
         , os_(os)
         {
         prog(prog_name);
         argument_groups_.push_back(ArgumentGroup("arguments"));
     }
 
-    ArgumentParser& ArgumentParser::prog(std::string prog_name, bool basename_only) {
+    ArgumentParser& ArgumentParser::prog(const std::string& prog_name, bool basename_only) {
         if (basename_only) {
             prog_ = basename(prog_name);
         } else {
@@ -35,17 +35,17 @@ namespace argparse {
     }
 
     ArgumentParser& ArgumentParser::version(std::string version_str) {
-        version_ = version_str;
+        version_ = std::move(version_str);
         return *this;
     }
 
     ArgumentParser& ArgumentParser::epilog(std::string epilog_str) {
-        epilog_ = epilog_str;
+        epilog_ = std::move(epilog_str);
         return *this;
     }
 
     ArgumentGroup& ArgumentParser::add_argument_group(std::string description_str) {
-        argument_groups_.push_back(ArgumentGroup(description_str));
+        argument_groups_.push_back(ArgumentGroup(std::move(description_str)));
         return argument_groups_[argument_groups_.size() - 1];
     }
 
@@ -72,7 +72,7 @@ namespace argparse {
     void ArgumentParser::parse_args_throw(int argc, const char* const* argv) {
         std::vector<std::string> arg_strs;
         for (int i = 1; i < argc; ++i) {
-            arg_strs.push_back(argv[i]);
+            arg_strs.emplace_back(argv[i]);
         }
 
         parse_args_throw(arg_strs);
@@ -241,7 +241,7 @@ namespace argparse {
                     } else if (arg->nargs() == '+' || arg->nargs() == '*') {
                         if (arg->nargs() == '+') {
                             assert(nargs_read >= 1);
-                            assert(values.size() >= 1);
+                            assert(!values.empty());
                         }
 
                         for (const auto& value : values) {
@@ -410,11 +410,11 @@ namespace argparse {
      * ArgumentGroup
      */
     ArgumentGroup::ArgumentGroup(std::string name_str)
-        : name_(name_str)
+        : name_(std::move(name_str))
         {}
 
     ArgumentGroup& ArgumentGroup::epilog(std::string str) {
-        epilog_ = str;
+        epilog_ = std::move(str);
         return *this;
     }
     std::string ArgumentGroup::name() const { return name_; }
@@ -425,10 +425,10 @@ namespace argparse {
      * Argument
      */
     Argument::Argument(std::string long_opt, std::string short_opt)
-        : long_opt_(long_opt)
-        , short_opt_(short_opt) {
+        : long_opt_(std::move(long_opt))
+        , short_opt_(std::move(short_opt)) {
 
-        if (long_opt_.size() < 1) {
+        if (long_opt_.empty()) {
             throw ArgParseError("Argument must be at least one character long");
         }
 
@@ -445,7 +445,7 @@ namespace argparse {
     }
 
     Argument& Argument::help(std::string help_str) {
-        help_ = help_str;
+        help_ = std::move(help_str);
         return *this;
     }
 
@@ -476,12 +476,12 @@ namespace argparse {
     }
 
     Argument& Argument::metavar(std::string metavar_str) {
-        metavar_ = metavar_str;
+        metavar_ = std::move(metavar_str);
         return *this;
     }
 
     Argument& Argument::choices(std::vector<std::string> choice_values) {
-        choices_ = choice_values;
+        choices_ = std::move(choice_values);
         return *this;
     }
 
@@ -536,7 +536,7 @@ namespace argparse {
     }
 
     Argument& Argument::group_name(std::string grp) {
-        group_name_ = grp;
+        group_name_ = std::move(grp);
         return *this;
     }
 

libs/EXTERNAL/libargparse/src/argparse.hpp

@@ -34,10 +34,10 @@ namespace argparse {
     class ArgumentParser {
         public:
             //Initializes an argument parser
-            ArgumentParser(std::string prog_name, std::string description_str=std::string(), std::ostream& os=std::cout);
+            ArgumentParser(const std::string& prog_name, std::string description_str=std::string(), std::ostream& os=std::cout);
 
             //Overrides the program name
-            ArgumentParser& prog(std::string prog, bool basename_only=true);
+            ArgumentParser& prog(const std::string& prog, bool basename_only=true);
 
             //Sets the program version
             ArgumentParser& version(std::string version);

libs/EXTERNAL/libcatch2

@@ -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/CMakeLists.txt

@@ -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.cpp

@@ -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/libarchfpga/src/read_fpga_interchange_arch.h

@@ -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/CMakeLists.txt

@@ -155,6 +155,13 @@ class edge_sort_iterator {
     using pointer = edge_swapper*;
     using difference_type = ssize_t;
 
+    // In order for this class to be used as an iterator within the std library,
+    // it needs to "act" like a pointer. One thing that it should do is that a
+    // const variable of this type should be de-referenceable. Therefore, this
+    // method should be const method; however, this requires modifying the class
+    // and may yield worst performance. For now the std::stable_sort allows this
+    // but in the future it may not. If this breaks, this is why.
+    // See issue #2517 and PR #2522
     edge_swapper& operator*() {
         return this->swapper_;
     }
@@ -419,7 +426,7 @@ size_t t_rr_graph_storage::count_rr_switches(
     // values.
     //
     // This sort is safe to do because partition_edges() has not been invoked yet.
-    std::sort(
+    std::stable_sort(
         edge_sort_iterator(this, 0),
         edge_sort_iterator(this, edge_dest_node_.size()),
         edge_compare_dest_node());
@@ -527,7 +534,7 @@ void t_rr_graph_storage::partition_edges(const vtr::vector<RRSwitchId, t_rr_swit
     //    by assign_first_edges()
     //  - Edges within a source node have the configurable edges before the
     //    non-configurable edges.
-    std::sort(
+    std::stable_sort(
         edge_sort_iterator(this, 0),
         edge_sort_iterator(this, edge_src_node_.size()),
         edge_compare_src_node_and_configurable_first(rr_switches));

libs/librrgraph/src/base/rr_graph_storage.cpp

@@ -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_storage.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.*/