update noc options in read_options.cpp

Author: soheilshahrouz

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);

vpr/src/base/read_options.cpp

@@ -5,7 +5,6 @@
 
 #include "argparse.hpp"
 
-#include "vtr_memory.h"
 #include "vtr_log.h"
 #include "vtr_util.h"
 #include "vtr_path.h"
@@ -14,7 +13,7 @@
 using argparse::ConvertedValue;
 using argparse::Provenance;
 
-///@brief Read and process VPR's command-line aruments
+///@brief Read and process VPR's command-line arguments
 t_options read_options(int argc, const char** argv) {
     t_options args = t_options(); //Explicitly initialize for zero initialization
 
@@ -1259,7 +1258,7 @@ struct ParsePostSynthNetlistUnconnOutputHandling {
     }
 };
 
-argparse::ArgumentParser create_arg_parser(std::string prog_name, t_options& args) {
+argparse::ArgumentParser create_arg_parser(const std::string& prog_name, t_options& args) {
     std::string description =
         "Implements the specified circuit onto the target FPGA architecture"
         " by performing packing/placement/routing, and analyzes the result.\n"
@@ -2807,8 +2806,12 @@ argparse::ArgumentParser create_arg_parser(std::string prog_name, t_options& arg
         .help(
             "Controls the algorithm used by the NoC to route packets.\n"
             "* xy_routing: Uses the direction oriented routing algorithm. This is recommended to be used with mesh NoC topologies.\n"
-            "* bfs_routing: Uses the breadth first search algorithm. The objective is to find a route that uses a minimum number of links.\n"
-            "This can be used with any NoC topology\n")
+            "* bfs_routing: Uses the breadth first search algorithm. The objective is to find a route that uses a minimum number of links."
+            " This algorithm is not guaranteed to generate deadlock-free traffic flow routes, but can be used with any NoC topology\n"
+            "* west_first_routing: Uses the west-first routing algorithm. This is recommended to be used with mesh NoC topologies.\n"
+            "* north_last_routing: Uses the north-last routing algorithm. This is recommended to be used with mesh NoC topologies.\n"
+            "* negative_first_routing: Uses the negative-first routing algorithm. This is recommended to be used with mesh NoC topologies.\n"
+            "* odd_even_routing: Uses the odd-even routing algorithm. This is recommended to be used with mesh NoC topologies.\n")
         .default_value("bfs_routing")
         .choices({"xy_routing", "bfs_routing", "west_first_routing", "north_last_routing", "negative_first_routing",
                   "odd_even_routing"})
@@ -2860,7 +2863,7 @@ argparse::ArgumentParser create_arg_parser(std::string prog_name, t_options& arg
             "Other positive numbers specify the importance of minimizing congestion to other NoC-related cost terms.\n"
             "Weighting factors for NoC-related cost terms are normalized internally. Therefore, their absolute values are not important, and"
             "only their relative ratios determine the importance of each cost term.")
-        .default_value("0.00")
+        .default_value("0.25")
         .show_in(argparse::ShowIn::HELP_ONLY);
 
     noc_grp.add_argument<double>(args.noc_swap_percentage, "--noc_swap_percentage")

vpr/src/base/read_options.h

@@ -242,7 +242,7 @@ struct t_options {
     argparse::ArgValue<std::string> write_timing_summary;
 };
 
-argparse::ArgumentParser create_arg_parser(std::string prog_name, t_options& args);
+argparse::ArgumentParser create_arg_parser(const std::string& prog_name, t_options& args);
 t_options read_options(int argc, const char** argv);
 void set_conditional_defaults(t_options& args);
 bool verify_args(const t_options& args);