Update description of fairstrategy algorithm.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index f3e2be399b7ea33bb35db9ac94ec8cd6e2e181af..0d269d65feb49d583fa53661537bf8607d7b1d48 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -16,6 +16,8 @@ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
 
 #include "options.h"
 
 
 #include "options.h"
 

+#define DATA_DESCR_WIDTH 42
+

 namespace opt {
 
     // Constants
 namespace opt {
 
     // Constants


@@ -47,13 +49,16 @@ namespace opt {
     // Load balancing algorithm
     std::string loba_algo("simple");
     bool bookkeeping = false;
     // Load balancing algorithm
     std::string loba_algo("simple");
     bool bookkeeping = false;

+    double min_lb_iter_duration = 1.0;          // fixme: find better defaults
+    double min_transfer_amount = 0.0;
+    double max_transfer_amount = 0.0;

 
     // Application parameters
 
     // Application parameters

-    // fixme: find better defaults
-    cost_func comp_cost("1e9, 0");
-    cost_func comm_cost("1e6, 0");
-    double min_lb_iter_duration = 1.0;
-    double min_comp_iter_duration = 1.0;
+    cost_func comp_cost("1e9, 0");              // fixme: find better defaults
+    cost_func comm_cost("1e6, 0");              // fixme: find better defaults
+    double min_comp_iter_duration = 1.0;        // fixme: find better defaults
+    unsigned comp_iter_delay = 0;               // fixme: find better defaults
+    double comp_time_delay = 0.0;               // fixme: find better defaults

 
     // Parameters for the end of the simulation
     unsigned lb_maxiter = 0;
 
     // Parameters for the end of the simulation
     unsigned lb_maxiter = 0;


@@ -65,10 +70,14 @@ namespace opt {
     loba_algorithms_type loba_algorithms;
     loba_algorithms_type::loba_algorithms_type()
     {
     loba_algorithms_type loba_algorithms;
     loba_algorithms_type::loba_algorithms_type()
     {

-        NOL_INSERT("fairstrategy", "balance with fair strategy", loba_fairstrategy);
-        NOL_INSERT("makhoul", "balance with Makhoul's PhD algorithm", loba_makhoul);
-        NOL_INSERT("none", "no load-balancing (for testing only)", process);
-        NOL_INSERT("simple", "balance with least loaded neighbor", loba_simple);
+        NOL_INSERT("fairstrategy", "balance with fair strategy",
+                   loba_fairstrategy);
+        NOL_INSERT("makhoul", "balance with Makhoul's PhD algorithm",
+                   loba_makhoul);
+        NOL_INSERT("none", "no load-balancing (for testing only)",
+                   process);
+        NOL_INSERT("simple", "balance with least loaded neighbor",
+                   loba_simple);

     }
 
     topologies_type topologies;
     }
 
     topologies_type topologies;


@@ -93,6 +102,8 @@ namespace {
     // local helper class
     class opt_helper {
     public:
     // local helper class
     class opt_helper {
     public:

+        template <typename T>
+        static bool parse_arg(char opt, const char *arg, T& val);

         static const char* on_off(bool b);
         const char* descr(const char* str);
         template <typename T>
         static const char* on_off(bool b);
         const char* descr(const char* str);
         template <typename T>


@@ -109,6 +120,16 @@ namespace {
 
 } // namespace
 
 
 } // namespace
 

+template <typename T>
+bool opt_helper::parse_arg(char opt, const char *arg, T& val)
+{
+    std::istringstream str(arg);
+    bool result = (str >> val) && str.eof();
+    if (!result)
+        XBT_ERROR("invalid argument for option '-%c' -- \"%s\"", opt, arg);
+    return result;
+}
+

 const char* opt_helper::on_off(bool b)
 {
     return b ? "on" : "off";
 const char* opt_helper::on_off(bool b)
 {
     return b ? "on" : "off";


@@ -116,10 +137,9 @@ const char* opt_helper::on_off(bool b)
 
 const char* opt_helper::descr(const char* str)
 {
 
 const char* opt_helper::descr(const char* str)
 {

-    const int descr_width = 40;

     std::string& res = descr_str;
     res = str;
     std::string& res = descr_str;
     res = str;

-    res.resize(descr_width, '.');
+    res.resize(DATA_DESCR_WIDTH, '.');

     return res.c_str();
 }
 
     return res.c_str();
 }
 


@@ -178,10 +198,13 @@ bool opt::parse_args(int* argc, char* argv[])
 
     opt::program_name = argv[0];
     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));
 
     opt::program_name = argv[0];
     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));

+
+#define PARSE_ARG(x) result = opt_helper::parse_arg(c, optarg, (x)) && result

     
     int c;
     opterr = 0;
     
     int c;
     opterr = 0;

-    while ((c = getopt(*argc, argv, "a:bc:C:ehi:I:l:L:N:s:S:t:T:vV")) != -1) {
+    while ((c = getopt(*argc, argv,
+                       "a:bc:C:d:D:ehi:I:l:L:m:M:N:s:S:t:T:vV")) != -1) {

         switch (c) {
         case 'a':
             opt::loba_algo = optarg;
         switch (c) {
         case 'a':
             opt::loba_algo = optarg;


@@ -200,34 +223,58 @@ bool opt::parse_args(int* argc, char* argv[])
             opt::help_requested++;
             break;
         case 'c':
             opt::help_requested++;
             break;
         case 'c':

-            opt::comp_cost = cost_func(optarg);
+            try {
+                opt::comp_cost = cost_func(optarg);
+            } catch (...) {
+                XBT_ERROR("invalid argument for option '-%c' -- \"%s\"",
+                          c, optarg);
+                result = false;
+            }

             break;
         case 'C':
             break;
         case 'C':

-            opt::comm_cost = cost_func(optarg);
+            try {
+                opt::comm_cost = cost_func(optarg);
+            } catch (...) {
+                XBT_ERROR("invalid argument for option '-%c' -- \"%s\"",
+                          c, optarg);
+                result = false;
+            }
+            break;
+        case 'd':
+            PARSE_ARG(opt::comp_iter_delay);
+            break;
+        case 'D':
+            PARSE_ARG(opt::comp_time_delay);

             break;
         case 'i':
             break;
         case 'i':

-            std::istringstream(optarg) >> opt::lb_maxiter;
+            PARSE_ARG(opt::lb_maxiter);

             break;
         case 'I':
             break;
         case 'I':

-            std::istringstream(optarg) >> opt::comp_maxiter;
+            PARSE_ARG(opt::comp_maxiter);

             break;
         case 'l':
             break;
         case 'l':

-            std::istringstream(optarg) >> opt::log_rate;
+            PARSE_ARG(opt::log_rate);

             break;
         case 'L':
             break;
         case 'L':

-            std::istringstream(optarg) >> opt::auto_depl::load;
+            PARSE_ARG(opt::auto_depl::load);
+            break;
+        case 'm':
+            PARSE_ARG(opt::min_transfer_amount);
+            break;
+        case 'M':
+            PARSE_ARG(opt::max_transfer_amount);

             break;
         case 'N':
             break;
         case 'N':

-            std::istringstream(optarg) >> opt::auto_depl::nhosts;
+            PARSE_ARG(opt::auto_depl::nhosts);

             break;
         case 's':
             break;
         case 's':

-            std::istringstream(optarg) >> opt::min_lb_iter_duration;
+            PARSE_ARG(opt::min_lb_iter_duration);

             break;
         case 'S':
             break;
         case 'S':

-            std::istringstream(optarg) >> opt::min_comp_iter_duration;
+            PARSE_ARG(opt::min_comp_iter_duration);

             break;
         case 't':
             break;
         case 't':

-            std::istringstream(optarg) >> opt::time_limit;
+            PARSE_ARG(opt::time_limit);

             break;
         case 'T':
             opt::auto_depl::topology = optarg;
             break;
         case 'T':
             opt::auto_depl::topology = optarg;


@@ -249,6 +296,8 @@ bool opt::parse_args(int* argc, char* argv[])
         }
     }
 
         }
     }
 

+#undef PARSE_ARG
+

     if (opt::version_requested || opt::help_requested)
         return 1;
 
     if (opt::version_requested || opt::help_requested)
         return 1;
 


@@ -268,6 +317,12 @@ bool opt::parse_args(int* argc, char* argv[])
         result = false;
     }
 
         result = false;
     }
 

+    if (opt::max_transfer_amount &&
+        opt::max_transfer_amount < opt::min_transfer_amount) {
+        XBT_ERROR("max. data transfer amount < min. data transfer amount");
+        result = false;
+    }
+

     return result;
 }
 
     return result;
 }
 


@@ -293,17 +348,22 @@ void opt::print()
     }
     DESCR("load balancing algorithm", "%s", loba_algo.c_str());
     DESCR("bookkeeping", "%s", h.on_off(bookkeeping));
     }
     DESCR("load balancing algorithm", "%s", loba_algo.c_str());
     DESCR("bookkeeping", "%s", h.on_off(bookkeeping));

-    DESCR("computation cost factors", "[%s]", comp_cost.to_string().c_str());
-    DESCR("communication cost factors", "[%s]", comm_cost.to_string().c_str());

     DESCR("minimum duration between lb. iterations", "%g",
           min_lb_iter_duration);
     DESCR("minimum duration between lb. iterations", "%g",
           min_lb_iter_duration);

+    DESCR("computation cost factors", "[%s]", comp_cost.to_string().c_str());
+    DESCR("communication cost factors", "[%s]", comm_cost.to_string().c_str());
+    DESCR("minimum data transfer amount", "%g", min_transfer_amount);
+    DESCR("maximum data transfer amount", "%s",
+          h.val_or_string(max_transfer_amount, "no limit"));

     DESCR("minimum duration between comp. iterations", "%g",
           min_comp_iter_duration);
     DESCR("minimum duration between comp. iterations", "%g",
           min_comp_iter_duration);

+    DESCR("computations start after lb. iter", "%u", comp_iter_delay);
+    DESCR("computations start after time", "%g", comp_time_delay);

     DESCR("maximum number of lb. iterations", "%s",
     DESCR("maximum number of lb. iterations", "%s",

-          h.val_or_string(lb_maxiter, "infinity"));
+          h.val_or_string(lb_maxiter, "no limit"));

     DESCR("maximum number of comp. iterations", "%s",
     DESCR("maximum number of comp. iterations", "%s",

-          h.val_or_string(comp_maxiter, "infinity"));
-    DESCR("time limit", "%s", h.val_or_string(time_limit, "infinity"));
+          h.val_or_string(comp_maxiter, "no limit"));
+    DESCR("time limit", "%s", h.val_or_string(time_limit, "no limit"));

     DESCR("exit on close", "%s", h.on_off(exit_on_close));
     XBT_INFO("`----");
 
     DESCR("exit on close", "%s", h.on_off(exit_on_close));
     XBT_INFO("`----");
 


@@ -365,6 +425,9 @@ void opt::usage()
         so_list(opt::loba_algorithms);
     std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
               << " [" << opt_helper::on_off(opt::bookkeeping) << "]\n";
         so_list(opt::loba_algorithms);
     std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
               << " [" << opt_helper::on_off(opt::bookkeeping) << "]\n";

+    std::clog << o("-s value")
+              << "minimum duration between lb. iterations"
+              << " [" << opt::min_lb_iter_duration << "]\n";

 
     std::clog << "\nApplication parameters\n";
     std::clog << o("-c [aN,...]a0")
 
     std::clog << "\nApplication parameters\n";
     std::clog << o("-c [aN,...]a0")


@@ -373,22 +436,31 @@ void opt::usage()
     std::clog << o("-C [aN,...]a0")
               << "polynomial factors for communication cost"
               << " [" << opt::comm_cost.to_string() << "]\n";
     std::clog << o("-C [aN,...]a0")
               << "polynomial factors for communication cost"
               << " [" << opt::comm_cost.to_string() << "]\n";

-    std::clog << o("-s value")
-              << "minimum duration between lb. iterations"
-              << " [" << opt::min_lb_iter_duration << "]\n";
+    std::clog << o("-m value")
+              << "minimum data transfer amount"
+              << " [" << opt::min_transfer_amount << "]\n";
+    std::clog << o("-M value")
+              << "maximum data transfer amount, 0 for no limit"
+              << " [" << opt::max_transfer_amount << "]\n";

     std::clog << o("-S value")
               << "minimum duration between comp. iterations"
               << " [" << opt::min_comp_iter_duration << "]\n";
     std::clog << o("-S value")
               << "minimum duration between comp. iterations"
               << " [" << opt::min_comp_iter_duration << "]\n";

+    std::clog << o("-d value")
+              << "start computations after given number of lb iterations"
+              << " [" << opt::comp_iter_delay << "]\n";
+    std::clog << o("-D value")
+              << "start computations after given time"
+              << " [" << opt::comp_time_delay << "]\n";

 
     std::clog << "\nParameters for the end of the simulation\n";
     std::clog << o("-i value")
 
     std::clog << "\nParameters for the end of the simulation\n";
     std::clog << o("-i value")

-              << "maximum number of lb. iterations, 0 for infinity"
+              << "maximum number of lb. iterations, 0 for no limit"

               << " [" << opt::lb_maxiter << "]\n";
     std::clog << o("-I value")
               << " [" << opt::lb_maxiter << "]\n";
     std::clog << o("-I value")

-              << "maximum number of comp. iterations, 0 for infinity"
+              << "maximum number of comp. iterations, 0 for no limit"

               << " [" << opt::comp_maxiter << "]\n";
     std::clog << o("-t value")
               << " [" << opt::comp_maxiter << "]\n";
     std::clog << o("-t value")

-              << "time limit (simulated time), 0 for infinity"
+              << "time limit (simulated time), 0 for no limit"

               << " [" << opt::time_limit << "]\n";
     std::clog << o("-e") << "toggle exit on reception of \"close\" message"
               << " [" << opt_helper::on_off(opt::exit_on_close) << "]\n";
               << " [" << opt::time_limit << "]\n";
     std::clog << o("-e") << "toggle exit on reception of \"close\" message"
               << " [" << opt_helper::on_off(opt::exit_on_close) << "]\n";