Terminate smoothly on CTRL-C.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index dc29495c236ee34f7ec47924fd966e5cc6c08fe5..2994640bf6e7f0c766ea6ca66637bcbd5ab804a7 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -9,11 +9,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_fairstrategy.h"

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

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

+#define DATA_DESCR_WIDTH 42
+

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


@@ -28,7 +34,8 @@ namespace opt {
     bool version_requested = false;
 
     // Simulation parameters
     bool version_requested = false;
 
     // 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;


@@ -45,27 +52,39 @@ namespace opt {
     // 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("1, 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
 
     // Parameters for the end of the simulation

-    // fixme: find better defaults
-    unsigned comp_maxiter = 10;
-    unsigned lb_maxiter = comp_maxiter;
+    unsigned lb_maxiter = 0;
+    unsigned comp_maxiter = 0;

     double time_limit = 0;
     double time_limit = 0;

-    bool exit_on_close = false;
+    bool exit_on_close = true;

 
     // Named parameters lists
     loba_algorithms_type loba_algorithms;
     loba_algorithms_type::loba_algorithms_type()
     {
 
     // 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("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;


@@ -90,6 +109,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>


@@ -106,6 +127,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";


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


@@ -149,18 +179,18 @@ bool opt_helper::nol_find_prefix(const T& nol, const char* descr,
         }
         switch (candidates.size()) {
         case 0:
         }
         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;
             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:
             break;
         default:

-            ERROR2("ambiguous %s -- %s", descr, name.c_str());
+            XBT_ERROR("ambiguous %s -- %s", descr, name.c_str());

             while (!candidates.empty()) {
             while (!candidates.empty()) {

-                ERROR1("  candidates are -- %s", candidates.top().c_str());
+                XBT_ERROR("  candidates are -- %s", candidates.top().c_str());

                 candidates.pop();
             }
             break;
                 candidates.pop();
             }
             break;


@@ -175,10 +205,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:s:S:t:T:vV")) != -1) {

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


@@ -188,42 +221,67 @@ bool opt::parse_args(int* argc, char* argv[])
                 && result;
             break;
         case 'b':
                 && result;
             break;
         case 'b':

-            opt::bookkeeping = true;
+            opt::bookkeeping = !opt::bookkeeping;

             break;
         case 'e':
             break;
         case 'e':

-            opt::exit_on_close = true;
+            opt::exit_on_close = !opt::exit_on_close;

             break;
         case 'h':
             opt::help_requested++;
             break;
         case 'c':
             break;
         case 'h':
             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::comp_maxiter;
+            PARSE_ARG(opt::lb_maxiter);

             break;
         case 'I':
             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':
             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 '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;


@@ -239,19 +297,21 @@ bool opt::parse_args(int* argc, char* argv[])
             opt::version_requested = true;
             break;
         case '?':
             opt::version_requested = true;
             break;
         case '?':

-            ERROR1("invalid option -- '%c'", optopt);
+            XBT_ERROR("invalid option -- '%c'", optopt);

             result = false;
             break;
         }
     }
 
             result = false;
             break;
         }
     }
 

+#undef PARSE_ARG
+

     if (opt::version_requested || opt::help_requested)
         return 1;
 
     if (optind < *argc) {
         opt::platform_file = argv[optind++];
     } else {
     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) {
         result = false;
     }
     if (optind < *argc) {


@@ -260,7 +320,13 @@ bool opt::parse_args(int* argc, char* argv[])
     opt::auto_depl::enabled = opt::deployment_file.empty();
 
     while (optind < *argc) {
     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;
     }
 
         result = false;
     }
 


@@ -272,13 +338,13 @@ void opt::print()
     opt_helper h;
 
 #define DESCR(description, format, value) \
     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 ]");
+    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) {
     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");
+        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"));
         DESCR("- topology", "%s", auto_depl::topology.c_str());
         DESCR("- number of hosts", "%s", h.val_or_string(auto_depl::nhosts,
                                                          "auto"));


@@ -289,16 +355,24 @@ void opt::print()
     }
     DESCR("load balancing algorithm", "%s", loba_algo.c_str());
     DESCR("bookkeeping", "%s", h.on_off(bookkeeping));
     }
     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("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("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"));
-    DESCR("time limit", "%s", h.val_or_string(time_limit, "infinity"));
+          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));
     DESCR("exit on close", "%s", h.on_off(exit_on_close));

-    INFO0("`----");
+    XBT_INFO("`----");

 
 #undef DESCR
 }
 
 #undef DESCR
 }


@@ -333,53 +407,70 @@ void opt::usage()
 
     std::clog << "\nSimulation parameters\n";
     std::clog << o("-l value")
 
     std::clog << "\nSimulation parameters\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 << o("-T name")
               << "enable automatic deployment with selected topology"
     std::clog << o("-v")
               << "verbose: do not override the default logging parameters\n";
 
     std::clog << "\nAutomatic deployment options\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"
     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";
+              << " [" << opt::auto_depl::load << "]\n";

     std::clog << o("-N value")
     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 << "\nLoad balancing algorithm\n";
     std::clog << o("-a name") << "load balancing algorithm"
 
     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);
     if (opt::help_requested > 1)
         so_list(opt::loba_algorithms);

-    std::clog << o("-b") << "enable bookkeeping (\"virtual load\")\n";
+    std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
+              << " [" << opt_helper::on_off(opt::bookkeeping) << "]\n";
+    std::clog << o("-s value")
+              << "minimum duration between lb. iterations"
+              << " [" << opt::min_lb_iter_duration << "]\n";

 
     std::clog << "\nApplication parameters\n";
 
     std::clog << "\nApplication parameters\n";

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

               << "polynomial factors for computation cost"
               << "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"
               << "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";
+              << " [" << 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("-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 << "\nParameters for the end of the simulation\n";
     std::clog << o("-i value")
 
     std::clog << "\nParameters for the end 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")
     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")
     std::clog << o("-t value")

-              << "time limit (simulated time), 0 for infinity"
-              << " (" << opt::time_limit << ")\n";
-    std::clog << o("-e") << "exit on reception of \"close\" message\n";
+              << "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;
 
     if (opt::help_requested < 3)
         return;


@@ -393,7 +484,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";