Cosmetics: improve help message.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index c5f5c290b007b2154801069faf60e7da87bc37ee..9b427bc26119987689c7579349cdd76e6caf87cd 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -66,6 +66,7 @@ namespace opt {
     double min_transfer_amount = 0.0;
     double max_transfer_amount = 0.0;
     bool integer_transfer = false;
+    unsigned loba_best_divisor = 1;
 
     // Application parameters
     cost_func comp_cost("1e9, 0");              // fixme: find better defaults
@@ -75,9 +76,11 @@ namespace opt {
     double comp_time_delay = 0.0;               // fixme: find better defaults
 
     // Parameters for the end of the simulation
+    double avg_load_ratio = 0.0;
     unsigned lb_maxiter = 0;
     unsigned comp_maxiter = 0;
     double time_limit = 0;
+    bool exit_on_convergence = false;
     bool exit_on_close = true;
 
     // Named parameters lists
@@ -230,9 +233,13 @@ bool opt::parse_args(int* argc, char* argv[])
     int c;
     opterr = 0;
     while ((c = getopt(*argc, argv,
-                       "a:bc:C:d:D:eEhi:I:l:L:m:M:N:r:Rs:S:t:T:vVx:X:Z"))
+                       "%:"
+                       "a:bc:C:d:D:eEGhi:I:k:l:L:m:M:N:r:Rs:S:t:T:vVx:X:Z"))
            != -1) {
         switch (c) {
+        case '%':
+            PARSE_ARG(opt::avg_load_ratio);
+            break;
         case 'a':
             opt::loba_algo = optarg;
             result = opt_helper::nol_find_prefix(opt::loba_algorithms,
@@ -273,12 +280,18 @@ bool opt::parse_args(int* argc, char* argv[])
         case 'E':
             opt::egocentric = !opt::egocentric;
             break;
+        case 'G':
+            opt::exit_on_convergence = !opt::exit_on_convergence;
+            break;
         case 'h':
             opt::help_requested++;
             break;
         case 'i':
             PARSE_ARG(opt::lb_maxiter);
             break;
+        case 'k':
+            PARSE_ARG(opt::loba_best_divisor);
+            break;
         case 'I':
             PARSE_ARG(opt::comp_maxiter);
             break;
@@ -367,7 +380,15 @@ bool opt::parse_args(int* argc, char* argv[])
 
     if (opt::max_transfer_amount &&
         opt::max_transfer_amount < opt::min_transfer_amount) {
-        XBT_ERROR("max. data transfer amount < min. data transfer amount");
+        XBT_ERROR("max. data transfer amount (%g) <"
+                  " min. data transfer amount (%g)",
+                  opt::max_transfer_amount, opt::min_transfer_amount);
+        result = false;
+    }
+
+    if (opt::loba_best_divisor <= 0) {
+        XBT_ERROR("divisor for algorithms *best* (%u) should be positive",
+                  opt::loba_best_divisor);
         result = false;
     }
 
@@ -406,8 +427,6 @@ void opt::print()
     DESCR("load balancing algorithm", "%s", loba_algo.c_str());
     DESCR("bookkeeping", "%s", h.on_off(bookkeeping));
     DESCR("egocentric mode", "%s", h.on_off(egocentric));
-    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);
@@ -415,6 +434,9 @@ void opt::print()
           h.val_or_string(max_transfer_amount, "no limit"));
     DESCR("only transfer integer data shares", "%s",
           h.on_off(integer_transfer));
+    DESCR("divisor for algorithms *best*", "%u", loba_best_divisor);
+    DESCR("minimum duration between lb. iterations", "%g",
+          min_lb_iter_duration);
     DESCR("minimum duration between comp. iterations", "%g",
           min_comp_iter_duration);
     DESCR("computations start after lb. iter", "%u", comp_iter_delay);
@@ -423,7 +445,9 @@ void opt::print()
           h.val_or_string(lb_maxiter, "no limit"));
     DESCR("maximum number of comp. iterations", "%s",
           h.val_or_string(comp_maxiter, "no limit"));
+    DESCR("convergence is assumed within (\%)", "%g", opt::avg_load_ratio);
     DESCR("time limit", "%s", h.val_or_string(time_limit, "no limit"));
+    DESCR("exit on convergence", "%s", h.on_off(exit_on_convergence));
     DESCR("exit on close", "%s", h.on_off(exit_on_close));
     XBT_INFO("`----");
 
@@ -501,6 +525,8 @@ void opt::usage()
     if (opt::help_requested > 1)
         std::clog << o("")
                   << "(a not so good idea introduced by git commit f5336c5)\n";
+    std::clog << o("-k value") << "divisor for algorithms *best*"
+              << " [" << opt::loba_best_divisor << "]\n";
 
     std::clog << "\nLb. and comp. iterations:\n";
     std::clog << o("-s value")
@@ -540,6 +566,14 @@ void opt::usage()
     std::clog << o("-I value")
               << "maximum number of comp. iterations, 0 for no limit"
               << " [" << opt::comp_maxiter << "]\n";
+    std::clog << o("-% value")
+              << "percent of the load average to assume the convergence"
+              << " [" << opt::avg_load_ratio << "]\n";
+    if (opt::help_requested > 1)
+        std::clog << o("")
+                  << "- if negative: use 100 * (nhosts / -value) / avg_load\n";
+    std::clog << o("-G") << "toggle exit on detection of convergence"
+              << " [" << opt_helper::on_off(opt::exit_on_convergence) << "]\n";
     std::clog << o("-t value")
               << "time limit (simulated time), 0 for no limit"
               << " [" << opt::time_limit << "]\n";