Disable logging completely with a negative log_rate.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 56049ed98fd641a14a7ff5e13d9c12806d20e269..f3e2be399b7ea33bb35db9ac94ec8cd6e2e181af 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -7,8 +7,12 @@
 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
 
 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
 

+#include "deployment.h"
+#include "process.h"

 #include "loba_simple.h"
 #include "loba_fairstrategy.h"
 #include "loba_simple.h"
 #include "loba_fairstrategy.h"

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

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


@@ -26,7 +30,7 @@ namespace opt {
     bool version_requested = false;
 
     // Simulation parameters
     bool version_requested = false;
 
     // Simulation parameters

-    unsigned log_rate = 1;
+    int log_rate = 1;

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


@@ -45,17 +49,24 @@ namespace opt {
     bool bookkeeping = false;
 
     // Application parameters
     bool bookkeeping = 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;
+    // fixme: find better defaults
+    cost_func comp_cost("1e9, 0");
+    cost_func comm_cost("1e6, 0");
+    double min_lb_iter_duration = 1.0;
+    double min_comp_iter_duration = 1.0;
+
+    // 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);
 
     // 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("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("none", "no load-balancing (for testing only)", process);
         NOL_INSERT("simple", "balance with least loaded neighbor", loba_simple);
     }


@@ -105,7 +116,7 @@ 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 = 35;
+    const int descr_width = 40;

     std::string& res = descr_str;
     res = str;
     res.resize(descr_width, '.');
     std::string& res = descr_str;
     res = str;
     res.resize(descr_width, '.');


@@ -141,18 +152,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;


@@ -170,7 +181,7 @@ bool opt::parse_args(int* argc, char* argv[])
     
     int c;
     opterr = 0;
     
     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:ehi:I:l:L:N:s:S:t:T:vV")) != -1) {

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


@@ -180,10 +191,10 @@ 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 'h':
             opt::help_requested++;


@@ -195,12 +206,10 @@ bool opt::parse_args(int* argc, char* argv[])
             opt::comm_cost = cost_func(optarg);
             break;
         case 'i':
             opt::comm_cost = cost_func(optarg);
             break;
         case 'i':

-            std::istringstream(optarg) >> opt::comp_maxiter;
+            std::istringstream(optarg) >> opt::lb_maxiter;

             break;
         case 'I':
             break;
         case 'I':

-            std::istringstream(optarg) >> opt::lb_maxiter;
-            ERROR0("option -I not implemented yet");
-            result = false;
+            std::istringstream(optarg) >> opt::comp_maxiter;

             break;
         case 'l':
             std::istringstream(optarg) >> opt::log_rate;
             break;
         case 'l':
             std::istringstream(optarg) >> opt::log_rate;


@@ -211,6 +220,15 @@ bool opt::parse_args(int* argc, char* argv[])
         case 'N':
             std::istringstream(optarg) >> opt::auto_depl::nhosts;
             break;
         case 'N':
             std::istringstream(optarg) >> opt::auto_depl::nhosts;
             break;

+        case 's':
+            std::istringstream(optarg) >> opt::min_lb_iter_duration;
+            break;
+        case 'S':
+            std::istringstream(optarg) >> opt::min_comp_iter_duration;
+            break;
+        case 't':
+            std::istringstream(optarg) >> opt::time_limit;
+            break;

         case 'T':
             opt::auto_depl::topology = optarg;
             result = opt_helper::nol_find_prefix(opt::topologies, "topology",
         case 'T':
             opt::auto_depl::topology = optarg;
             result = opt_helper::nol_find_prefix(opt::topologies, "topology",


@@ -225,7 +243,7 @@ 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;
         }


@@ -237,7 +255,7 @@ bool opt::parse_args(int* argc, char* argv[])
     if (optind < *argc) {
         opt::platform_file = argv[optind++];
     } else {
     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) {


@@ -246,7 +264,7 @@ 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;
     }
 
         result = false;
     }
 


@@ -258,31 +276,36 @@ 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 ]");
-    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) {
     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"));
+        DESCR("- initial load", "%s", h.val_or_string(auto_depl::load,
+                                                      "auto"));

     } else {
         DESCR("deployment file", "\"%s\"", deployment_file.c_str());
     }
     } 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("computation cost factors", "[%s]", comp_cost.to_string().c_str());

     DESCR("communication cost factors", "[%s]", comm_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 duration between lb. iterations", "%g",
+          min_lb_iter_duration);
+    DESCR("minimum duration between comp. iterations", "%g",
+          min_comp_iter_duration);

     DESCR("maximum number of lb. iterations", "%s",
           h.val_or_string(lb_maxiter, "infinity"));
     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("`----");
+    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"));
+    DESCR("exit on close", "%s", h.on_off(exit_on_close));
+    XBT_INFO("`----");

 
 #undef DESCR
 }
 
 #undef DESCR
 }


@@ -317,45 +340,58 @@ 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\n";
+    std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
+              << " [" << opt_helper::on_off(opt::bookkeeping) << "]\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("-e") << "exit on reception of \"close\" message\n";
+              << " [" << opt::comm_cost.to_string() << "]\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 << "\nParameters for the end of the simulation\n";

     std::clog << o("-i value")
     std::clog << o("-i value")

-              << "maximum number of comp. iterations, 0 for infinity"
-              << " (" << opt::comp_maxiter << ")\n";
-    std::clog << o("-I value")

               << "maximum number of lb. iterations, 0 for infinity"
               << "maximum number of lb. iterations, 0 for infinity"

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


@@ -369,7 +405,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"
               << "        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
 
 #undef so_list
 #undef so