Add script to run experimentations.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 4e8de7428b11bedd364d1af48904f7954e4d6c9a..3602fbffdccd562df03a7ff8d89337382dadb62e 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -1,3 +1,4 @@
+#include <ctime>

 #include <iomanip>
 #include <iostream>
 #include <sstream>
 #include <iomanip>
 #include <iostream>
 #include <sstream>


@@ -9,13 +10,17 @@ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
 
 #include "deployment.h"
 #include "process.h"
 
 #include "deployment.h"
 #include "process.h"

-#include "loba_simple.h"
+#include "loba_besteffort.h"

 #include "loba_fairstrategy.h"
 #include "loba_makhoul.h"
 #include "loba_fairstrategy.h"
 #include "loba_makhoul.h"

+#include "loba_makhoul2.h"
+#include "loba_simple.h"

 #include "misc.h"
 
 #include "options.h"
 
 #include "misc.h"
 
 #include "options.h"
 

+#define DATA_DESCR_WIDTH 42
+

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


@@ -28,9 +33,11 @@ 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

 
     // Simulation parameters
 
     // Simulation parameters

-    unsigned log_rate = 1;
+    int log_rate = 1;
+    bool exit_request = false;

 
     // Platform and deployment
     std::string platform_file;
 
     // Platform and deployment
     std::string platform_file;


@@ -42,17 +49,23 @@ namespace opt {
         std::string topology("clique");
         unsigned    nhosts = 0;
         double      load = 0.0;
         std::string topology("clique");
         unsigned    nhosts = 0;
         double      load = 0.0;

+        bool        random_distribution = false;
+        unsigned long random_seed = 0;

     }
 
     // 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_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;


@@ -64,10 +77,18 @@ 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("besteffort", "balance with best effort strategy",
+                   loba_besteffort);
+        NOL_INSERT("fairstrategy", "balance with fair strategy",
+                   loba_fairstrategy);
+        NOL_INSERT("makhoul", "balance with Makhoul's PhD algorithm",
+                   loba_makhoul);
+        NOL_INSERT("makhoul2", "balance with Makhoul's source code",
+                   loba_makhoul2);
+        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;


@@ -92,6 +113,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>


@@ -108,6 +131,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";


@@ -115,10 +148,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();
 }
 


@@ -177,10 +209,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:t:T:vV")) != -1) {
+    while ((c = getopt(*argc, argv,
+                       "a:bc:C:d:D:ehi:I:l:L:m:M:N:r:Rs:S:t:T:vVx:")) != -1) {

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


@@ -199,31 +234,65 @@ 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 'r':
+            PARSE_ARG(opt::auto_depl::random_seed);
+            break;
+        case 'R':
+            opt::auto_depl::random_distribution =
+                !opt::auto_depl::random_distribution;

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

-            std::istringstream(optarg) >> opt::min_iter_duration;
+            PARSE_ARG(opt::min_lb_iter_duration);
+            break;
+        case 'S':
+            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;


@@ -238,6 +307,10 @@ bool opt::parse_args(int* argc, char* argv[])
         case 'V':
             opt::version_requested = true;
             break;
         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 '?':
             XBT_ERROR("invalid option -- '%c'", optopt);
             result = false;
         case '?':
             XBT_ERROR("invalid option -- '%c'", optopt);
             result = false;


@@ -245,6 +318,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;
 


@@ -264,6 +339,15 @@ 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;
+    }
+
+    if (!opt::auto_depl::random_seed)
+        opt::auto_depl::random_seed = time(NULL);
+

     return result;
 }
 
     return result;
 }
 


@@ -284,19 +368,31 @@ void opt::print()
                                                          "auto"));
         DESCR("- initial load", "%s", h.val_or_string(auto_depl::load,
                                                       "auto"));
                                                          "auto"));
         DESCR("- initial load", "%s", h.val_or_string(auto_depl::load,
                                                       "auto"));

+        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"));

     } 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("computation cost factors", "[%s]", comp_cost.to_string().c_str());
     DESCR("communication cost factors", "[%s]", comm_cost.to_string().c_str());
     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 iterations", "%g", min_iter_duration);
+    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("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("`----");
 


@@ -321,8 +417,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)


@@ -331,14 +428,14 @@ 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";
     std::clog << o("-T name")
               << "enable automatic deployment with selected topology"
               << " [" << opt::auto_depl::topology << "]\n";


@@ -350,8 +447,15 @@ void opt::usage()
     std::clog << o("-N value")
               << "number of hosts to use with auto deployment, 0 for max."
               << " [" << opt::auto_depl::nhosts << "]\n";
     std::clog << o("-N value")
               << "number of hosts to use with auto deployment, 0 for max."
               << " [" << opt::auto_depl::nhosts << "]\n";

-
-    std::clog << "\nLoad balancing algorithm\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, 0 for a seed based on current date"
+              << " [" << opt::auto_depl::random_seed << "]\n";
+
+    std::clog << "\nLoad balancing algorithm:\n";

     std::clog << o("-a name") << "load balancing algorithm"
               << " [" << opt::loba_algo << "]\n";
     if (opt::help_requested > 1)
     std::clog << o("-a name") << "load balancing algorithm"
               << " [" << opt::loba_algo << "]\n";
     if (opt::help_requested > 1)


@@ -359,26 +463,43 @@ void opt::usage()
     std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
               << " [" << opt_helper::on_off(opt::bookkeeping) << "]\n";
 
     std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
               << " [" << opt_helper::on_off(opt::bookkeeping) << "]\n";
 

-    std::clog << "\nApplication parameters\n";
-    std::clog << o("-c [fn,...]f0")
+    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";
               << "polynomial factors for computation cost"
               << " [" << opt::comp_cost.to_string() << "]\n";

-    std::clog << o("-C [fn,...]f0")
+    std::clog << o("-C [aN,...]a0")

               << "polynomial factors for communication cost"
               << " [" << opt::comm_cost.to_string() << "]\n";
               << "polynomial factors for communication cost"
               << " [" << opt::comm_cost.to_string() << "]\n";

-    std::clog << o("-s value")
-              << "minimum duration between iterations"
-              << " [" << opt::min_iter_duration << "]\n";
-
-    std::clog << "\nParameters for the end of the simulation\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 << "\nEnd of the simulation:\n";

     std::clog << o("-i value")
     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";


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

-    std::clog << "\nLogging support\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"


@@ -395,7 +516,8 @@ 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"
               << "        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";
 
 
     // std::clog << "\nMiscellaneous low-level parameters\n";