Be more precise in help message for option "-l".

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 76bc997c2c2a9b7521cd6ae49bb70b4fe246edb1..d1d136bcb31d957cad816a51d44e877bb532a5e4 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -7,6 +7,8 @@
 
 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"
 


@@ -45,9 +47,16 @@ 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 maxiter = 10;       // fixme: find better defaults
+    // fixme: find better defaults
+    cost_func comp_cost("1e9, 0");
+    cost_func comm_cost("1, 0");
+    double min_iter_duration = 1.0;
+
+    // Parameters for the end of the simulation
+    // fixme: find better defaults
+    unsigned lb_maxiter = 10;
+    unsigned comp_maxiter = 0;
+    double time_limit = 0;

     bool exit_on_close = false;
 
     // Named parameters lists
     bool exit_on_close = false;
 
     // Named parameters lists


@@ -78,63 +87,87 @@ namespace opt {
 
 namespace {
 
 
 namespace {
 

-    // some helper functions for opt::print()
+    // local helper class
+    class opt_helper {
+    public:
+        static const char* on_off(bool b);
+        const char* descr(const char* str);
+        template <typename T>
+        const char* val_or_string(const T& val, const char* str,
+                                  const T& deflt = 0);
+        template <typename T>
+        static bool nol_find_prefix(const T& nol, const char* descr,
+                                    std::string& name);
+
+    private:
+        std::string descr_str;
+        std::string val_or_string_str;
+    };

 
 

-    const char* on_off(bool b)
-    {
-        return b ? "on" : "off";
-    }
+} // namespace

 
 

-    template <typename T>
-    const char* val_or_string(const T& val, const char* str, const T& deflt = 0)
-    {
-        static std::string res;
-        if (val != deflt) {
-            std::ostringstream oss;
-            oss << val;
-            res = oss.str();
-        } else {
-            res = str;
-        }
-        return res.c_str();
-    }
+const char* opt_helper::on_off(bool b)
+{
+    return b ? "on" : "off";
+}
+
+const char* opt_helper::descr(const char* str)
+{
+    const int descr_width = 40;
+    std::string& res = descr_str;
+    res = str;
+    res.resize(descr_width, '.');
+    return res.c_str();
+}

 
 

-    // helper function for opt::parse_args()
+template <typename T>
+const char* opt_helper::val_or_string(const T& val, const char* str,
+                                      const T& deflt)
+{
+    std::string& res = val_or_string_str;
+    if (val != deflt) {
+        std::ostringstream oss;
+        oss << val;
+        res = oss.str();
+    } else {
+        res = str;
+    }
+    return res.c_str();
+}

 
 

-    template <typename T>
-    bool nol_find_prefix(const T& nol, const char* descr, std::string& name)
-    {
-        bool result = nol.exists(name);
-        if (!result) {
-            std::stack<std::string> candidates;
-            for (typename T::iterator it = nol.begin() ; it != nol.end() ; ++it) {
-                const std::string& fullname = nol.get_name(it);
-                if (fullname.compare(0, name.length(), name) == 0)
-                    candidates.push(fullname);
-            }
-            switch (candidates.size()) {
-            case 0:
-                ERROR2("unknownw %s -- %s", descr, name.c_str());
-                break;
-            case 1:
-                name = candidates.top();
+template <typename T>
+bool opt_helper::nol_find_prefix(const T& nol, const char* descr,
+                                 std::string& name)
+{
+    bool result = nol.exists(name);
+    if (!result) {
+        std::stack<std::string> candidates;
+        for (typename T::iterator it = nol.begin() ; it != nol.end() ; ++it) {
+            const std::string& fullname = nol.get_name(it);
+            if (fullname.compare(0, name.length(), name) == 0)
+                candidates.push(fullname);
+        }
+        switch (candidates.size()) {
+        case 0:
+            ERROR2("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());
+            break;
+        default:
+            ERROR2("ambiguous %s -- %s", descr, name.c_str());
+            while (!candidates.empty()) {
+                ERROR1("  candidates are -- %s", candidates.top().c_str());

                 candidates.pop();
                 candidates.pop();

-                result = true;
-                DEBUG2("infered %s -- %s", descr, name.c_str());
-                break;
-            default:
-                ERROR2("ambiguous %s -- %s", descr, name.c_str());
-                while (!candidates.empty()) {
-                    ERROR1("  candidates are -- %s", candidates.top().c_str());
-                    candidates.pop();
-                }
-                break;

             }
             }

+            break;

         }
         }

-        return result;

     }
     }

-
-} // namespace
+    return result;
+}

 
 bool opt::parse_args(int* argc, char* argv[])
 {
 
 bool opt::parse_args(int* argc, char* argv[])
 {


@@ -145,13 +178,14 @@ 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:l:L:N:T:vV")) != -1) {
+    while ((c = getopt(*argc, argv, "a:bc:C:ehi:I:l:L:N:s:t:T:vV")) != -1) {

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

-            result = nol_find_prefix(opt::loba_algorithms,
-                                     "load balancing algorithm",
-                                     opt::loba_algo);
+            result = opt_helper::nol_find_prefix(opt::loba_algorithms,
+                                                 "load balancing algorithm",
+                                                 opt::loba_algo)
+                && result;

             break;
         case 'b':
             opt::bookkeeping = true;
             break;
         case 'b':
             opt::bookkeeping = true;


@@ -169,7 +203,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::maxiter;
+            std::istringstream(optarg) >> opt::lb_maxiter;
+            break;
+        case 'I':
+            std::istringstream(optarg) >> opt::comp_maxiter;

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


@@ -180,10 +217,17 @@ 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_iter_duration;
+            break;
+        case 't':
+            std::istringstream(optarg) >> opt::time_limit;
+            break;

         case 'T':
             opt::auto_depl::topology = optarg;
         case 'T':
             opt::auto_depl::topology = optarg;

-            result = nol_find_prefix(opt::topologies, "topology",
-                                     opt::auto_depl::topology);
+            result = opt_helper::nol_find_prefix(opt::topologies, "topology",
+                                                 opt::auto_depl::topology)
+                && result;

             break;
         case 'v':
             // nothing to do: this option is checked at the very
             break;
         case 'v':
             // nothing to do: this option is checked at the very


@@ -223,28 +267,38 @@ bool opt::parse_args(int* argc, char* argv[])
 
 void opt::print()
 {
 
 void opt::print()
 {

+    opt_helper h;
+
+#define DESCR(description, format, value) \
+    INFO2("| %s: " format, h.descr(description), value)
+

     INFO0(",----[ Simulation parameters ]");
     INFO0(",----[ Simulation parameters ]");

-    INFO1("| log rate.....................: %s",
-          val_or_string(opt::log_rate, "disabled"));
-    INFO1("| platform file................: \"%s\"", opt::platform_file.c_str());
-    if (opt::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");
         INFO0("| automatic deployment enabled");

-        INFO1("| - topology...................: %s", opt::auto_depl::topology.c_str());
-        INFO1("| - number of hosts............: %s",
-              val_or_string(opt::auto_depl::nhosts, "auto"));
-        INFO1("| - initial load...............: %s",
-              val_or_string(opt::auto_depl::load, "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"));

     } else {
     } else {

-        INFO1("| deployment file..............: \"%s\"", opt::deployment_file.c_str());
+        DESCR("deployment file", "\"%s\"", deployment_file.c_str());

     }
     }

-    INFO1("| load balancing algorithm.....: %s",   opt::loba_algo.c_str());
-    INFO1("| bookkeeping..................: %s",   on_off(opt::bookkeeping));
-    INFO1("| computation cost factors.....: [%s]", opt::comp_cost.to_string().c_str());
-    INFO1("| communication cost factors...: [%s]", opt::comm_cost.to_string().c_str());
-    INFO1("| maximum number of iterations.: %s",
-          val_or_string(opt::maxiter, "infinity"));
-    INFO1("| exit on close................: %s",   on_off(opt::exit_on_close));
+    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("minimum duration between iterations", "%g", min_iter_duration);
+    DESCR("maximum number of lb. iterations", "%s",
+          h.val_or_string(lb_maxiter, "infinity"));
+    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));

     INFO0("`----");
     INFO0("`----");

+
+#undef DESCR

 }
 
 void opt::usage()
 }
 
 void opt::usage()


@@ -277,7 +331,7 @@ 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"
+              << "print current load every n-th lb iterations, 0 to disable"

               << " (" << opt::log_rate << ")\n";
     std::clog << o("-v")
               << "verbose: do not override the default logging parameters\n";
               << " (" << opt::log_rate << ")\n";
     std::clog << o("-v")
               << "verbose: do not override the default logging parameters\n";


@@ -300,7 +354,7 @@ void opt::usage()
               << " (" << opt::loba_algo << ")\n";
     if (opt::help_requested > 1)
         so_list(opt::loba_algorithms);
               << " (" << opt::loba_algo << ")\n";
     if (opt::help_requested > 1)
         so_list(opt::loba_algorithms);

-    std::clog << o("-b") << "enable bookkeeping\n";
+    std::clog << o("-b") << "enable bookkeeping (\"virtual load\")\n";

 
     std::clog << "\nApplication parameters\n";
     std::clog << o("-c [fn,...]f0")
 
     std::clog << "\nApplication parameters\n";
     std::clog << o("-c [fn,...]f0")


@@ -309,10 +363,21 @@ void opt::usage()
     std::clog << o("-C [fn,...]f0")
               << "polynomial factors for communication cost"
               << " (" << opt::comm_cost.to_string() << ")\n";
     std::clog << o("-C [fn,...]f0")
               << "polynomial factors for communication cost"
               << " (" << opt::comm_cost.to_string() << ")\n";

-    std::clog << o("-e") << "exit on reception of \"close\" message\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("-i value")
     std::clog << o("-i value")

-              << "maximum number of iterations, 0 for infinity"
-              << " (" << opt::maxiter << ")\n";
+              << "maximum number of lb. iterations, 0 for infinity"
+              << " (" << 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") << "exit on reception of \"close\" message\n";

 
     if (opt::help_requested < 3)
         return;
 
     if (opt::help_requested < 3)
         return;


@@ -328,6 +393,8 @@ void opt::usage()
               << "        proc : messages from base process class\n"
               << "        loba : messages from load-balancer\n";
 
               << "        proc : messages from base process class\n"
               << "        loba : messages from load-balancer\n";
 

+    // std::clog << "\nMiscellaneous low-level parameters\n";
+

 #undef so_list
 #undef so
 #undef o
 #undef so_list
 #undef so
 #undef o