Logo AND Algorithmique Numérique Distribuée

Private GIT Repository
Update extract.pl.
[loba.git] / options.cpp
index 56049ed98fd641a14a7ff5e13d9c12806d20e269..c5f5c290b007b2154801069faf60e7da87bc37ee 100644 (file)
@@ -1,3 +1,4 @@
+#include <ctime>
 #include <iomanip>
 #include <iostream>
 #include <sstream>
@@ -7,11 +8,23 @@
 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
 
-#include "loba_simple.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_lln.h"
+#include "loba_makhoul.h"
+#include "loba_makhoul2.h"
+#include "loba_makhoul3.h"
+#include "loba_simple.h"
+#include "misc.h"
 
 #include "options.h"
 
+#define DATA_DESCR_WIDTH 42
+
 namespace opt {
 
     // Constants
@@ -24,9 +37,12 @@ namespace opt {
     std::string program_name;
     int help_requested = 0;
     bool version_requested = false;
+    int option_x = 0;           // hidden option (int)
+    double option_X = 0.0;      // hidden option (double)
 
     // Simulation parameters
-    unsigned log_rate = 1;
+    int log_rate = 1;
+    volatile std::sig_atomic_t exit_request = 0;
 
     // Platform and deployment
     std::string platform_file;
@@ -37,27 +53,57 @@ 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;
     }
 
     // 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
-    cost_func comm_cost("1, 0"); // fixme: find better defaults
-    unsigned comp_maxiter = 10;  // fixme: find better defaults
-    unsigned lb_maxiter = comp_maxiter; // fixme: find better defaults
-    bool exit_on_close = false;
+    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;
+    unsigned comp_maxiter = 0;
+    double time_limit = 0;
+    bool exit_on_close = true;
 
     // Named parameters lists
     loba_algorithms_type loba_algorithms;
     loba_algorithms_type::loba_algorithms_type()
     {
-        NOL_INSERT("fairstrategy", "balance with fair strategy", loba_fairstrategy);
-        NOL_INSERT("none", "no load-balancing (for testing only)", process);
-        NOL_INSERT("simple", "balance with least loaded neighbor", loba_simple);
+        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", "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",
+                   loba_simple);
     }
 
     topologies_type topologies;
@@ -82,6 +128,8 @@ namespace {
     // 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>
@@ -98,6 +146,16 @@ 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";
@@ -105,10 +163,9 @@ const char* opt_helper::on_off(bool b)
 
 const char* opt_helper::descr(const char* str)
 {
-    const int descr_width = 35;
     std::string& res = descr_str;
     res = str;
-    res.resize(descr_width, '.');
+    res.resize(DATA_DESCR_WIDTH, '.');
     return res.c_str();
 }
 
@@ -141,18 +198,18 @@ bool opt_helper::nol_find_prefix(const T& nol, const char* descr,
         }
         switch (candidates.size()) {
         case 0:
-            ERROR2("unknownw %s -- %s", descr, name.c_str());
+            XBT_ERROR("unknownw %s -- %s", descr, name.c_str());
             break;
         case 1:
             name = candidates.top();
             candidates.pop();
             result = true;
-            DEBUG2("infered %s -- %s", descr, name.c_str());
+            XBT_DEBUG("infered %s -- %s", descr, name.c_str());
             break;
         default:
-            ERROR2("ambiguous %s -- %s", descr, name.c_str());
+            XBT_ERROR("ambiguous %s -- %s", descr, name.c_str());
             while (!candidates.empty()) {
-                ERROR1("  candidates are -- %s", candidates.top().c_str());
+                XBT_ERROR("  candidates are -- %s", candidates.top().c_str());
                 candidates.pop();
             }
             break;
@@ -167,10 +224,14 @@ 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('/'));
-    
+
+#define PARSE_ARG(x) result = opt_helper::parse_arg(c, optarg, (x)) && result
+
     int c;
     opterr = 0;
-    while ((c = getopt(*argc, argv, "a:bc:C:ehi:I:l:L:N:T:vV")) != -1) {
+    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"))
+           != -1) {
         switch (c) {
         case 'a':
             opt::loba_algo = optarg;
@@ -180,36 +241,77 @@ bool opt::parse_args(int* argc, char* argv[])
                 && result;
             break;
         case 'b':
-            opt::bookkeeping = true;
+            opt::bookkeeping = !opt::bookkeeping;
+            break;
+        case 'c':
+            try {
+                opt::comp_cost = cost_func(optarg);
+            } catch (...) {
+                XBT_ERROR("invalid argument for option '-%c' -- \"%s\"",
+                          c, optarg);
+                result = false;
+            }
+            break;
+        case 'C':
+            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 'e':
-            opt::exit_on_close = true;
+            opt::exit_on_close = !opt::exit_on_close;
+            break;
+        case 'E':
+            opt::egocentric = !opt::egocentric;
             break;
         case 'h':
             opt::help_requested++;
             break;
-        case 'c':
-            opt::comp_cost = cost_func(optarg);
-            break;
-        case 'C':
-            opt::comm_cost = cost_func(optarg);
-            break;
         case 'i':
-            std::istringstream(optarg) >> opt::comp_maxiter;
+            PARSE_ARG(opt::lb_maxiter);
             break;
         case 'I':
-            std::istringstream(optarg) >> opt::lb_maxiter;
-            ERROR0("option -I not implemented yet");
-            result = false;
+            PARSE_ARG(opt::comp_maxiter);
             break;
         case 'l':
-            std::istringstream(optarg) >> opt::log_rate;
+            PARSE_ARG(opt::log_rate);
             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':
-            std::istringstream(optarg) >> opt::auto_depl::nhosts;
+            PARSE_ARG(opt::auto_depl::nhosts);
+            break;
+        case 'r':
+            PARSE_ARG(opt::auto_depl::random_seed);
+            break;
+        case 'R':
+            opt::auto_depl::random_distribution =
+                !opt::auto_depl::random_distribution;
+            break;
+        case 's':
+            PARSE_ARG(opt::min_lb_iter_duration);
+            break;
+        case 'S':
+            PARSE_ARG(opt::min_comp_iter_duration);
+            break;
+        case 't':
+            PARSE_ARG(opt::time_limit);
             break;
         case 'T':
             opt::auto_depl::topology = optarg;
@@ -224,20 +326,33 @@ bool opt::parse_args(int* argc, char* argv[])
         case 'V':
             opt::version_requested = true;
             break;
+        case 'x':
+            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 '?':
-            ERROR1("invalid option -- '%c'", optopt);
+            XBT_ERROR("invalid option -- '%c'", optopt);
             result = false;
             break;
         }
     }
 
+#undef PARSE_ARG
+
     if (opt::version_requested || opt::help_requested)
         return 1;
 
     if (optind < *argc) {
         opt::platform_file = argv[optind++];
     } else {
-        ERROR0("missing parameter -- <plaform_file>");
+        XBT_ERROR("missing parameter -- <plaform_file>");
         result = false;
     }
     if (optind < *argc) {
@@ -246,10 +361,19 @@ bool opt::parse_args(int* argc, char* argv[])
     opt::auto_depl::enabled = opt::deployment_file.empty();
 
     while (optind < *argc) {
-        ERROR1("unused parameter -- \"%s\"", argv[optind++]);
+        XBT_ERROR("unused parameter -- \"%s\"", argv[optind++]);
         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;
+    }
+
+    if (!opt::auto_depl::random_seed)
+        opt::auto_depl::random_seed = time(NULL);
+
     return result;
 }
 
@@ -258,31 +382,50 @@ void opt::print()
     opt_helper h;
 
 #define DESCR(description, format, value) \
-    INFO2("| %s: " format, h.descr(description), value)
+    XBT_INFO("| %s: " format, h.descr(description), value)
 
-    INFO0(",----[ Simulation parameters ]");
-    DESCR("log rate", "%s",          h.val_or_string(log_rate, "disabled"));
+    XBT_INFO(",----[ Simulation parameters ]");
+    DESCR("log rate", "%s", h.val_or_string(log_rate, "disabled"));
     DESCR("platform file", "\"%s\"", platform_file.c_str());
     if (auto_depl::enabled) {
-        INFO0("| automatic deployment enabled");
-        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"));
+        XBT_INFO("| automatic deployment enabled");
+        DESCR("- topology", "%s", auto_depl::topology.c_str());
+        DESCR("- number of hosts", "%s", h.val_or_string(auto_depl::nhosts,
+                                                         "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", // 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));
-    DESCR("computation cost factors", "[%s]",   comp_cost.to_string().c_str());
+    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("maximum number of comp. iterations", "%s",
-          h.val_or_string(comp_maxiter, "infinity"));
+    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);
+    DESCR("computations start after time", "%g", comp_time_delay);
     DESCR("maximum number of lb. iterations", "%s",
-          h.val_or_string(lb_maxiter, "infinity"));
-    DESCR("exit on close", "%s",                h.on_off(exit_on_close));
-    INFO0("`----");
+          h.val_or_string(lb_maxiter, "no limit"));
+    DESCR("maximum number of comp. iterations", "%s",
+          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("`----");
 
 #undef DESCR
 }
@@ -305,8 +448,9 @@ void opt::usage()
 
     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)
@@ -315,52 +459,103 @@ 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 << "\nSimulation parameters\n";
+    std::clog << "\nSimulator output:\n";
     std::clog << o("-l value")
-              << "print current load every n-th iterations, 0 to disable"
-              << " (" << opt::log_rate << ")\n";
+              << "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";
+              << " [" << 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"
-              << " (" << opt::auto_depl::load << ")\n";
+              << "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::nhosts << ")\n";
+              << "number of hosts to use with auto deployment, 0 for max."
+              << " [" << opt::auto_depl::nhosts << "]\n";
+    std::clog << o("-R")
+              << "toggle random initial load distribution"
+              << " [" << opt_helper::on_off(opt::auto_depl::random_distribution)
+              << "]\n";
+    std::clog << o("-r value")
+              << "random seed for initial load distribution, or 0, or 1"
+              << " [" << 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";
+              << " [" << opt::loba_algo << "]\n";
     if (opt::help_requested > 1)
         so_list(opt::loba_algorithms);
-    std::clog << o("-b") << "enable bookkeeping\n";
-
-    std::clog << "\nApplication parameters\n";
-    std::clog << o("-c [fn,...]f0")
+    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")
+              << "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 << "\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 [fn,...]f0")
+              << " [" << opt::comp_cost.to_string() << "]\n";
+    std::clog << o("-C [aN,...]a0")
               << "polynomial factors for communication cost"
-              << " (" << opt::comm_cost.to_string() << ")\n";
-    std::clog << o("-e") << "exit on reception of \"close\" message\n";
+              << " [" << opt::comm_cost.to_string() << "]\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("-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")
-              << "maximum number of comp. iterations, 0 for infinity"
-              << " (" << opt::comp_maxiter << ")\n";
+              << "maximum number of lb. iterations, 0 for no limit"
+              << " [" << opt::lb_maxiter << "]\n";
     std::clog << o("-I value")
-              << "maximum number of lb. iterations, 0 for infinity"
-              << " (" << opt::lb_maxiter << ")\n";
+              << "maximum number of comp. iterations, 0 for no limit"
+              << " [" << opt::comp_maxiter << "]\n";
+    std::clog << o("-t value")
+              << "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";
 
     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"
@@ -369,7 +564,10 @@ void opt::usage()
               << "        depl : messages from auto deployment (inherited from main)\n"
               << "        comm : messages from asynchronous pipes\n"
               << "        proc : messages from base process class\n"
-              << "        loba : messages from load-balancer\n";
+              << "        loba : messages from load-balancer\n"
+              << "        thrd : messages from thread wrapper class\n";
+
+    // std::clog << "\nMiscellaneous low-level parameters\n";
 
 #undef so_list
 #undef so