Short documentation for makhoul3, and reindentation.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 9b1344aade28af3378c0f5cd6e6d615b41589f8b..908a797f0048849a2b3e5ea641d8137b09024386 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -10,11 +10,14 @@ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
 
 #include "deployment.h"
 #include "process.h"
+#include "loba_2besteffort.h"
 #include "loba_besteffort.h"
 #include "loba_bulk.h"
 #include "loba_fairstrategy.h"
+#include "loba_lln.h"
 #include "loba_makhoul.h"
 #include "loba_makhoul2.h"
+#include "loba_makhoul3.h"
 #include "loba_simple.h"
 #include "misc.h"
 
@@ -38,7 +41,7 @@ namespace opt {
 
     // Simulation parameters
     int log_rate = 1;
-    bool exit_request = false;
+    volatile std::sig_atomic_t exit_request = 0;
 
     // Platform and deployment
     std::string platform_file;
@@ -49,7 +52,7 @@ namespace opt {
         bool        enabled = false;
         std::string topology("clique");
         unsigned    nhosts = 0;
-        double      load = 0.0;
+        double      load = -1.0;
         bool        random_distribution = false;
         unsigned long random_seed = 0;
     }
@@ -57,9 +60,11 @@ namespace opt {
     // Load balancing algorithm
     std::string loba_algo("simple");
     bool bookkeeping = false;
+    bool egocentric = false;
     double min_lb_iter_duration = 1.0;          // fixme: find better defaults
     double min_transfer_amount = 0.0;
     double max_transfer_amount = 0.0;
+    bool integer_transfer = false;
 
     // Application parameters
     cost_func comp_cost("1e9, 0");              // fixme: find better defaults
@@ -78,16 +83,22 @@ namespace opt {
     loba_algorithms_type loba_algorithms;
     loba_algorithms_type::loba_algorithms_type()
     {
+        NOL_INSERT("2besteffort", "balance with best effort strategy (take #2)",
+                   loba_2besteffort);
         NOL_INSERT("besteffort", "balance with best effort strategy",
                    loba_besteffort);
-        NOL_INSERT("bulk", "describe your algorithm here...",
+        NOL_INSERT("bulk", "a multi-load-units assignation rule without ordering...",
                    loba_bulk);
         NOL_INSERT("fairstrategy", "balance with fair strategy",
                    loba_fairstrategy);
+        NOL_INSERT("lln", "balance with less loaded neighbors without ordering-bulk method",
+                   loba_lln);
         NOL_INSERT("makhoul", "balance with Makhoul's PhD algorithm",
                    loba_makhoul);
         NOL_INSERT("makhoul2", "balance with Makhoul's source code",
                    loba_makhoul2);
+        NOL_INSERT("makhoul3", "variation on Makhoul's algorithm",
+                   loba_makhoul3);
         NOL_INSERT("none", "no load-balancing (for testing only)",
                    process);
         NOL_INSERT("simple", "balance with least loaded neighbor",
@@ -218,7 +229,7 @@ bool opt::parse_args(int* argc, char* argv[])
     int c;
     opterr = 0;
     while ((c = getopt(*argc, argv,
-                       "a:bc:C:d:D:ehi:I:l:L:m:M:N:r:Rs:S:t:T:vVx:")) != -1) {
+                       "a:bc:C:d:D:eEhi:I:l:L:m:M:N:r:Rs:S:t:T:vVx:Z")) != -1) {
         switch (c) {
         case 'a':
             opt::loba_algo = optarg;
@@ -230,12 +241,6 @@ bool opt::parse_args(int* argc, char* argv[])
         case 'b':
             opt::bookkeeping = !opt::bookkeeping;
             break;
-        case 'e':
-            opt::exit_on_close = !opt::exit_on_close;
-            break;
-        case 'h':
-            opt::help_requested++;
-            break;
         case 'c':
             try {
                 opt::comp_cost = cost_func(optarg);
@@ -260,6 +265,15 @@ bool opt::parse_args(int* argc, char* argv[])
         case 'D':
             PARSE_ARG(opt::comp_time_delay);
             break;
+        case 'e':
+            opt::exit_on_close = !opt::exit_on_close;
+            break;
+        case 'E':
+            opt::egocentric = !opt::egocentric;
+            break;
+        case 'h':
+            opt::help_requested++;
+            break;
         case 'i':
             PARSE_ARG(opt::lb_maxiter);
             break;
@@ -314,6 +328,9 @@ bool opt::parse_args(int* argc, char* argv[])
             PARSE_ARG(opt::option_x);
             XBT_WARN("option_x set to %d", opt::option_x);
             break;
+        case 'Z':
+            opt::integer_transfer = !opt::integer_transfer;
+            break;
         case '?':
             XBT_ERROR("invalid option -- '%c'", optopt);
             result = false;
@@ -369,8 +386,10 @@ void opt::print()
         DESCR("- topology", "%s", auto_depl::topology.c_str());
         DESCR("- number of hosts", "%s", h.val_or_string(auto_depl::nhosts,
                                                          "auto"));
-        DESCR("- initial load", "%s", h.val_or_string(auto_depl::load,
-                                                      "auto"));
+        if (auto_depl::load < 0.0)
+            DESCR("- initial load (average)", "%g", -auto_depl::load);
+        else
+            DESCR("- initial load (total)", "%g", auto_depl::load);
         DESCR("- random initial load distribution", "%s",
               h.on_off(auto_depl::random_distribution));
         DESCR("- random seed", "%s",
@@ -380,6 +399,7 @@ 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());
@@ -387,6 +407,8 @@ void opt::print()
     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("only transfer integer data shares", "%s",
+          h.on_off(integer_transfer));
     DESCR("minimum duration between comp. iterations", "%g",
           min_comp_iter_duration);
     DESCR("computations start after lb. iter", "%u", comp_iter_delay);
@@ -445,7 +467,7 @@ void opt::usage()
     if (opt::help_requested > 1)
         so_list(opt::topologies);
     std::clog << o("-L value")
-              << "total load with auto deployment, 0 for number of hosts"
+              << "total load with auto deployment, average if negative"
               << " [" << opt::auto_depl::load << "]\n";
     std::clog << o("-N value")
               << "number of hosts to use with auto deployment, 0 for max."
@@ -465,6 +487,11 @@ void opt::usage()
         so_list(opt::loba_algorithms);
     std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
               << " [" << opt_helper::on_off(opt::bookkeeping) << "]\n";
+    std::clog << o("-E") << "toggle egocentric mode when bookkeeping"
+              << " [" << opt_helper::on_off(opt::egocentric) << "]\n";
+    if (opt::help_requested > 1)
+        std::clog << o("")
+                  << "(a not so good idea introduced by git commit f5336c5)\n";
 
     std::clog << "\nLb. and comp. iterations:\n";
     std::clog << o("-s value")
@@ -493,6 +520,9 @@ void opt::usage()
     std::clog << o("-M value")
               << "maximum data transfer amount, 0 for no limit"
               << " [" << opt::max_transfer_amount << "]\n";
+    std::clog << o("-Z")
+              << "toggle transfer of integer data shares only"
+              << " [" << opt_helper::on_off(opt::integer_transfer) << "]\n";
 
     std::clog << "\nEnd of the simulation:\n";
     std::clog << o("-i value")