Make boolean option togglable.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 243ad59be73126b016e7b2ced37aaa3d1287e515..89f8b18eb3287b5afd0d95ddf5c226b44de4d685 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -1,68 +1,197 @@
-#include "options.h"
-

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

+#include <stack>

 #include <unistd.h>             // getopt
 #include <xbt/log.h>
 #include <unistd.h>             // getopt
 #include <xbt/log.h>

-#include "misc.h"

 
 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 "options.h"
+

 namespace opt {
 
 namespace opt {
 

-    std::string program_name;
+    // Constants

 
 

-    std::string platform_file;
-    std::string deployment_file;
+    // A sum of loads if considered null if it is less than
+    // load_ratio_threshold percent of the sum of loads at init.
+    const double load_ratio_threshold = 1e-4;

 
 

+    // Global options
+    std::string program_name;

     int help_requested = 0;
     bool version_requested = false;
 
     int help_requested = 0;
     bool version_requested = false;
 

+    // Simulation parameters

     unsigned log_rate = 1;
 
     unsigned log_rate = 1;
 

+    // Platform and deployment
+    std::string platform_file;
+    std::string deployment_file;
+
+    // Automatic deployment

     namespace auto_depl {
         bool        enabled = false;
     namespace auto_depl {
         bool        enabled = false;

-        std::string topology;
+        std::string topology("clique");

         unsigned    nhosts = 0;
         double      load = 0.0;
     }
 
         unsigned    nhosts = 0;
         double      load = 0.0;
     }
 

-    unsigned maxiter = 4;       // fixme
+    // Load balancing algorithm
+    std::string loba_algo("simple");
+    bool bookkeeping = false;
+
+    // Application parameters
+    // 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;
 
     bool exit_on_close = false;
 

-    bool bookkeeping = false;
+    // 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);
+    }

 
 

-    cost_func comp_cost("1e9, 0"); // fixme: find better defaults
-    cost_func comm_cost("1, 0"); // fixme: find better defaults
+    topologies_type topologies;
+    topologies_type::topologies_type()
+    {
+        NOL_INSERT("btree", "binary tree topology, initial load at root",
+                   deployment_btree);
+        NOL_INSERT("clique", "all connected topology", deployment_clique);
+        NOL_INSERT("hcube", "hypercube topology", deployment_hcube);
+        NOL_INSERT("line", "line topology, initial load at one end",
+                   deployment_line);
+        NOL_INSERT("ring", "ring topology", deployment_ring);
+        NOL_INSERT("star", "star topology, initial load at center",
+                   deployment_star);
+        NOL_INSERT("torus", "torus topology", deployment_torus);
+    }

 
 } // namespace opt
 
 namespace {
 
 
 } // namespace opt
 
 namespace {
 

-    const char* on_off(bool b)
-    {
-        return b ? "on" : "off";
+    // 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;
+    };
+
+} // namespace
+
+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();
+}
+
+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 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();
+            }
+            break;
+        }
+    }
+    return result;

 }
 
 }
 

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

 {
 {

-    int result = 1;
+    bool result = true;

 
     opt::program_name = argv[0];
     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));
     
     int c;
     opterr = 0;
 
     opt::program_name = argv[0];
     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));
     
     int c;
     opterr = 0;

-    while ((c = getopt(*argc, argv, "bc:C:ehi:l:L:N:T:V")) != -1) {
+    while ((c = getopt(*argc, argv, "a:bc:C:ehi:I:l:L:N:s:t:T:vV")) != -1) {

         switch (c) {
         switch (c) {

+        case 'a':
+            opt::loba_algo = optarg;
+            result = opt_helper::nol_find_prefix(opt::loba_algorithms,
+                                                 "load balancing algorithm",
+                                                 opt::loba_algo)
+                && result;
+            break;

         case 'b':
         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++;


@@ -74,7 +203,10 @@ int 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;


@@ -85,19 +217,31 @@ int 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 = 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
+            // beginning of main()

             break;
         case 'V':
             opt::version_requested = true;
             break;
         case '?':
             ERROR1("invalid option -- '%c'", optopt);
             break;
         case 'V':
             opt::version_requested = true;
             break;
         case '?':
             ERROR1("invalid option -- '%c'", optopt);

-            result = 0;
+            result = false;

             break;
         }
     }
             break;
         }
     }

-    opt::auto_depl::enabled = !opt::auto_depl::topology.empty();

 
     if (opt::version_requested || opt::help_requested)
         return 1;
 
     if (opt::version_requested || opt::help_requested)
         return 1;


@@ -106,20 +250,16 @@ int opt::parse_args(int* argc, char* argv[])
         opt::platform_file = argv[optind++];
     } else {
         ERROR0("missing parameter -- <plaform_file>");
         opt::platform_file = argv[optind++];
     } else {
         ERROR0("missing parameter -- <plaform_file>");

-        result = 0;
+        result = false;

     }
     }

-    if (!opt::auto_depl::enabled) {
-        if (optind < *argc) {
-            opt::deployment_file = argv[optind++];
-        } else {
-            ERROR0("missing parameter -- <deployment_file>");
-            result = 0;
-        }
+    if (optind < *argc) {
+        opt::deployment_file = argv[optind++];

     }
     }

+    opt::auto_depl::enabled = opt::deployment_file.empty();

 
     while (optind < *argc) {
         ERROR1("unused parameter -- \"%s\"", argv[optind++]);
 
     while (optind < *argc) {
         ERROR1("unused parameter -- \"%s\"", argv[optind++]);

-        result = 0;
+        result = false;

     }
 
     return result;
     }
 
     return result;


@@ -127,39 +267,62 @@ int 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("| platform file.......: \"%s\"", opt::platform_file.c_str());
-    if (opt::auto_depl::enabled) {
-        INFO0("| automatic deployment enabled with:");
-        INFO1("|     topology........: %s", opt::auto_depl::topology.c_str());
-        INFO1("|     number of hosts.: %u", opt::auto_depl::nhosts);
-        INFO1("|     initial load....: %g", opt::auto_depl::load);
+    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"));

     } else {
     } else {

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

     }
     }

-    INFO1("| log rate............: %u",     opt::log_rate);
-    INFO1("| maxiter.............: %u",     opt::maxiter);
-    INFO1("| exit on close.......: %s",     on_off(opt::exit_on_close));
-    INFO1("| bookkeeping.........: %s",     on_off(opt::bookkeeping));
-    INFO1("| comp. cost factors..: [%s]",   opt::comp_cost.to_string().c_str());
-    INFO1("| comm. cost factors..: [%s]",   opt::comm_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("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()
 {

+    // option(...)

 #define o(opt) "    " << std::setw(14) \
                       << std::left << (opt) << std::right << " "
 #define o(opt) "    " << std::setw(14) \
                       << std::left << (opt) << std::right << " "

-#define so(subopt) std::setw(10) << (subopt) << ": "
+    // sub-option(...)
+#define so(subopt) std::setw(18) << (subopt) << " : "
+    // sub-option list
+#define so_list(name) do {                                      \
+        name ## _type::iterator it;                             \
+        for (it = name.begin() ; it != name.end() ; ++it)       \
+            std::clog << so(name.get_name(it))                  \
+                      << name.get_descr(it) << "\n";            \
+    } while (0)
+

 
     std::clog << "Usage: " << opt::program_name
 
     std::clog << "Usage: " << opt::program_name

-              << " [options] <platform_file> <deployment_file>\n";
-    std::clog << "       " << opt::program_name
-              << " [options] -T type <platform_file>\n";
+              << " [options] <platform_file> [<deployment_file>]\n";

 
     std::clog << "\nGlobal options\n";
     std::clog << o("-h")
 
     std::clog << "\nGlobal options\n";
     std::clog << o("-h")

-              << "print help and exit (use -hh for extended help)\n";
+              << "print help and exit (use -hh or -hhh for extended help)\n";

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


@@ -168,38 +331,73 @@ 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"
+              << " [" << 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";
+    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("-a name") << "load balancing algorithm"
+              << " [" << opt::loba_algo << "]\n";
+    if (opt::help_requested > 1)
+        so_list(opt::loba_algorithms);
+    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")
               << "polynomial factors for computation cost"
 
     std::clog << "\nApplication parameters\n";
     std::clog << o("-c [fn,...]f0")
               << "polynomial factors for computation cost"

-              << " (" << opt::comp_cost.to_string() << ")\n";
+              << " [" << opt::comp_cost.to_string() << "]\n";

     std::clog << o("-C [fn,...]f0")
               << "polynomial factors for communication cost"
     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";
+              << " [" << 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("-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") << "toggle exit on reception of \"close\" message"
+              << " [" << opt_helper::on_off(opt::exit_on_close) << "]\n";
+
+    if (opt::help_requested < 3)
+        return;

 
 

-    std::clog << "\nLoad balancing algorithm\n";
-    std::clog << o("-b") << "enable bookkeeping\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"
+              << "        simu : root of following categories\n"
+              << "        main : messages from global infrastructure\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";

 
 

-    std::clog << "\nAutomatic deployment options\n";
-    std::clog << o("-T type")
-              << "enable automatic deployment with selected topology\n";
-    if (opt::help_requested > 1) {
-        std::clog << so(1) << "pipo\n";
-        std::clog << so(42) << "atchoum\n";
-    }
-    std::clog << o("-L value")
-              << "total load with auto deployment, 0 for number of hosts"
-              << " (" << 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";
+    // std::clog << "\nMiscellaneous low-level parameters\n";

 
 

+#undef so_list

 #undef so
 #undef o
 }
 #undef so
 #undef o
 }