ag_parameters: update for last experimentations.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 78612a127b26b0c365ba13b540e60723e0fe2b1f..01ae4470bc092cfe0e37b95efa35697690f46655 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 "deployment.h"
 #include "process.h"

+#include "loba_2besteffort.h"

 #include "loba_besteffort.h"
 #include "loba_bulk.h"
 #include "loba_fairstrategy.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_makhoul.h"
 #include "loba_makhoul2.h"

+#include "loba_makhoul3.h"

 #include "loba_simple.h"
 #include "misc.h"
 
 #include "loba_simple.h"
 #include "misc.h"
 


@@ -34,11 +37,12 @@ namespace opt {
     std::string program_name;
     int help_requested = 0;
     bool version_requested = false;
     std::string program_name;
     int help_requested = 0;
     bool version_requested = false;

-    int option_x = 0;           // hidden option, for debugging purpose
+    int option_x = 0;           // hidden option (int)
+    double option_X = 0.0;      // hidden option (double)

 
     // Simulation parameters
     int log_rate = 1;
 
     // 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;
 
     // Platform and deployment
     std::string platform_file;


@@ -49,7 +53,7 @@ namespace opt {
         bool        enabled = false;
         std::string topology("clique");
         unsigned    nhosts = 0;
         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;
     }
         bool        random_distribution = false;
         unsigned long random_seed = 0;
     }


@@ -57,9 +61,12 @@ namespace opt {
     // Load balancing algorithm
     std::string loba_algo("simple");
     bool bookkeeping = false;
     // 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;
     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;
+    unsigned loba_best_divisor = 1;

 
     // Application parameters
     cost_func comp_cost("1e9, 0");              // fixme: find better defaults
 
     // Application parameters
     cost_func comp_cost("1e9, 0");              // fixme: find better defaults


@@ -69,6 +76,7 @@ namespace opt {
     double comp_time_delay = 0.0;               // fixme: find better defaults
 
     // Parameters for the end of the simulation
     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;
     unsigned lb_maxiter = 0;
     unsigned comp_maxiter = 0;
     double time_limit = 0;


@@ -78,16 +86,22 @@ 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("2besteffort", "balance with best effort strategy (take #2)",
+                   loba_2besteffort);

         NOL_INSERT("besteffort", "balance with best effort strategy",
                    loba_besteffort);
         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);
                    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("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",
         NOL_INSERT("none", "no load-balancing (for testing only)",
                    process);
         NOL_INSERT("simple", "balance with least loaded neighbor",


@@ -218,8 +232,13 @@ bool opt::parse_args(int* argc, char* argv[])
     int c;
     opterr = 0;
     while ((c = getopt(*argc, 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:k:l:L:m:M:N:r:Rs:S:t:T:vVx:X:Z"))
+           != -1) {

         switch (c) {
         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,
         case 'a':
             opt::loba_algo = optarg;
             result = opt_helper::nol_find_prefix(opt::loba_algorithms,


@@ -230,12 +249,6 @@ bool opt::parse_args(int* argc, char* argv[])
         case 'b':
             opt::bookkeeping = !opt::bookkeeping;
             break;
         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);
         case 'c':
             try {
                 opt::comp_cost = cost_func(optarg);


@@ -260,9 +273,21 @@ bool opt::parse_args(int* argc, char* argv[])
         case 'D':
             PARSE_ARG(opt::comp_time_delay);
             break;
         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;
         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;
         case 'I':
             PARSE_ARG(opt::comp_maxiter);
             break;


@@ -314,6 +339,13 @@ bool opt::parse_args(int* argc, char* argv[])
             PARSE_ARG(opt::option_x);
             XBT_WARN("option_x set to %d", opt::option_x);
             break;
             PARSE_ARG(opt::option_x);
             XBT_WARN("option_x set to %d", opt::option_x);
             break;

+        case 'X':
+            PARSE_ARG(opt::option_X);
+            XBT_WARN("option_X set to %g", opt::option_X);
+            break;
+        case 'Z':
+            opt::integer_transfer = !opt::integer_transfer;
+            break;

         case '?':
             XBT_ERROR("invalid option -- '%c'", optopt);
             result = false;
         case '?':
             XBT_ERROR("invalid option -- '%c'", optopt);
             result = false;


@@ -323,6 +355,13 @@ bool opt::parse_args(int* argc, char* argv[])
 
 #undef PARSE_ARG
 
 
 #undef PARSE_ARG
 

+    if (opt::option_x) {        // FIXME: remove this one day...
+        opt::loba_best_divisor = opt::option_x;
+        XBT_WARN("divisor for algorithms *best* set from option -x (%d => %u),"
+                 " use -k instead",
+                 opt::option_x, opt::loba_best_divisor);
+    }
+

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


@@ -344,7 +383,15 @@ bool opt::parse_args(int* argc, char* argv[])
 
     if (opt::max_transfer_amount &&
         opt::max_transfer_amount < opt::min_transfer_amount) {
 
     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;
     }
 
         result = false;
     }
 


@@ -369,24 +416,30 @@ 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("- 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 initial load distribution", "%s",
               h.on_off(auto_depl::random_distribution));

-        DESCR("- random seed", "%s",
-              h.val_or_string(auto_depl::random_seed, "time based"));
+        DESCR("- random seed", "%s", // NOTE: cannot be 0 here anymore
+              h.val_or_string(auto_depl::random_seed, "constant random", 1UL));

     } else {
         DESCR("deployment file", "\"%s\"", deployment_file.c_str());
     }
     DESCR("load balancing algorithm", "%s", loba_algo.c_str());
     DESCR("bookkeeping", "%s", h.on_off(bookkeeping));
     } else {
         DESCR("deployment file", "\"%s\"", deployment_file.c_str());
     }
     DESCR("load balancing algorithm", "%s", loba_algo.c_str());
     DESCR("bookkeeping", "%s", h.on_off(bookkeeping));

-    DESCR("minimum duration between lb. iterations", "%g",
-          min_lb_iter_duration);
+    DESCR("egocentric mode", "%s", h.on_off(egocentric));

     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("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("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);
     DESCR("minimum duration between comp. iterations", "%g",
           min_comp_iter_duration);
     DESCR("computations start after lb. iter", "%u", comp_iter_delay);


@@ -395,6 +448,7 @@ 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"));
           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 close", "%s", h.on_off(exit_on_close));
     XBT_INFO("`----");
     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("`----");


@@ -420,8 +474,9 @@ void opt::usage()
 
     std::clog << "Usage: " << opt::program_name
               << " [options] <platform_file> [<deployment_file>]\n";
 
     std::clog << "Usage: " << opt::program_name
               << " [options] <platform_file> [<deployment_file>]\n";

+    std::clog << "Current values for the parameters are given between square brackets.\n";

 
 

-    std::clog << "\nGlobal options\n";
+    std::clog << "\nGlobal options:\n";

     std::clog << o("-h")
               << "print help and exit (use -hh or -hhh for extended help)\n";
     if (opt::help_requested < 1)
     std::clog << o("-h")
               << "print help and exit (use -hh or -hhh for extended help)\n";
     if (opt::help_requested < 1)


@@ -430,21 +485,21 @@ void opt::usage()
     std::clog << o("--help") << "print help from SimGrid framework and exit\n";
     std::clog << o("-V") << "print version and exit\n";
 
     std::clog << o("--help") << "print help from SimGrid framework and exit\n";
     std::clog << o("-V") << "print version and exit\n";
 

-    std::clog << "\nSimulation parameters\n";
+    std::clog << "\nSimulator output:\n";

     std::clog << o("-l value")
               << "print current load every n lb iterations, 0 to disable"
               << " [" << opt::log_rate << "]\n";
     std::clog << o("-v")
               << "verbose: do not override the default logging parameters\n";
 
     std::clog << o("-l value")
               << "print current load every n lb iterations, 0 to disable"
               << " [" << opt::log_rate << "]\n";
     std::clog << o("-v")
               << "verbose: do not override the default logging parameters\n";
 

-    std::clog << "\nAutomatic deployment options\n";
+    std::clog << "\nAutomatic deployment:\n";

     std::clog << o("-T name")
               << "enable automatic deployment with selected topology"
               << " [" << opt::auto_depl::topology << "]\n";
     if (opt::help_requested > 1)
         so_list(opt::topologies);
     std::clog << o("-L value")
     std::clog << o("-T name")
               << "enable automatic deployment with selected topology"
               << " [" << opt::auto_depl::topology << "]\n";
     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."
               << " [" << opt::auto_depl::load << "]\n";
     std::clog << o("-N value")
               << "number of hosts to use with auto deployment, 0 for max."


@@ -454,21 +509,42 @@ void opt::usage()
               << " [" << opt_helper::on_off(opt::auto_depl::random_distribution)
               << "]\n";
     std::clog << o("-r value")
               << " [" << opt_helper::on_off(opt::auto_depl::random_distribution)
               << "]\n";
     std::clog << o("-r value")

-              << "random seed, 0 for using it on time()"
+              << "random seed for initial load distribution, or 0, or 1"

               << " [" << opt::auto_depl::random_seed << "]\n";
               << " [" << opt::auto_depl::random_seed << "]\n";

+    if (opt::help_requested > 1)
+        std::clog << o("") << "- use 0 for a seed based on current date\n"
+                  << o("") << "- use 1 for a constant random\n";

 
 

-    std::clog << "\nLoad balancing algorithm\n";
+    std::clog << "\nLoad balancing algorithm:\n";

     std::clog << o("-a name") << "load balancing algorithm"
               << " [" << opt::loba_algo << "]\n";
     if (opt::help_requested > 1)
         so_list(opt::loba_algorithms);
     std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
               << " [" << opt_helper::on_off(opt::bookkeeping) << "]\n";
     std::clog << o("-a name") << "load balancing algorithm"
               << " [" << opt::loba_algo << "]\n";
     if (opt::help_requested > 1)
         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 << o("-k value") << "divisor for algorithms *best*"
+              << " [" << opt::loba_best_divisor << "]\n";
+
+    std::clog << "\nLb. and comp. iterations:\n";

     std::clog << o("-s value")
               << "minimum duration between lb. iterations"
               << " [" << opt::min_lb_iter_duration << "]\n";
     std::clog << o("-s value")
               << "minimum duration between lb. iterations"
               << " [" << opt::min_lb_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 comp. iterations after given number of lb. iter."
+              << " [" << opt::comp_iter_delay << "]\n";
+    std::clog << o("-D value")
+              << "start comp. iterations after given time"
+              << " [" << opt::comp_time_delay << "]\n";

 
 

-    std::clog << "\nApplication parameters\n";
+    std::clog << "\nComputations and communications:\n";

     std::clog << o("-c [aN,...]a0")
               << "polynomial factors for computation cost"
               << " [" << opt::comp_cost.to_string() << "]\n";
     std::clog << o("-c [aN,...]a0")
               << "polynomial factors for computation cost"
               << " [" << opt::comp_cost.to_string() << "]\n";


@@ -481,23 +557,20 @@ void opt::usage()
     std::clog << o("-M value")
               << "maximum data transfer amount, 0 for no limit"
               << " [" << opt::max_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("-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 << o("-Z")
+              << "toggle transfer of integer data shares only"
+              << " [" << opt_helper::on_off(opt::integer_transfer) << "]\n";

 
 

-    std::clog << "\nParameters for the end of the simulation\n";
+    std::clog << "\nEnd of the simulation:\n";

     std::clog << o("-i value")
               << "maximum number of lb. iterations, 0 for no limit"
               << " [" << opt::lb_maxiter << "]\n";
     std::clog << o("-I value")
               << "maximum number of comp. iterations, 0 for no limit"
               << " [" << opt::comp_maxiter << "]\n";
     std::clog << o("-i value")
               << "maximum number of lb. iterations, 0 for no limit"
               << " [" << opt::lb_maxiter << "]\n";
     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";

     std::clog << o("-t value")
               << "time limit (simulated time), 0 for no limit"
               << " [" << opt::time_limit << "]\n";
     std::clog << o("-t value")
               << "time limit (simulated time), 0 for no limit"
               << " [" << opt::time_limit << "]\n";


@@ -507,7 +580,13 @@ void opt::usage()
     if (opt::help_requested < 3)
         return;
 
     if (opt::help_requested < 3)
         return;
 

-    std::clog << "\nLogging support\n"
+    std::clog << "\nHidden options:\n";
+    std::clog << o("-x value") << "value is an integer"
+              << " [" << opt::option_x << "]\n";
+    std::clog << o("-X value") << "value is a real number"
+              << " [" << opt::option_X << "]\n";
+
+    std::clog << "\nLogging support:\n"

               << "    See SimGrid documentation on:\n"
               << "        http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_user\n"
               << "    Existing categories are:\n"
               << "    See SimGrid documentation on:\n"
               << "        http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_user\n"
               << "    Existing categories are:\n"