Define process::lb_load(), and use it.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 54fd53d19000426dbf487e7491d3675e32b99173..dc29495c236ee34f7ec47924fd966e5cc6c08fe5 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -1,16 +1,27 @@
-#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 "loba_simple.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 {
 

+    // Constants
+
+    // 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;
     // Global options
     std::string program_name;
     int help_requested = 0;


@@ -36,23 +47,31 @@ 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 = 4;       // fixme
+    // 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 comp_maxiter = 10;
+    unsigned lb_maxiter = comp_maxiter;
+    double time_limit = 0;

     bool exit_on_close = false;
 
     // Named parameters lists
     loba_algorithms_type loba_algorithms;
     loba_algorithms_type::loba_algorithms_type()
     {
     bool exit_on_close = false;
 
     // Named parameters lists
     loba_algorithms_type loba_algorithms;
     loba_algorithms_type::loba_algorithms_type()
     {

-        NOL_INSERT("none", "no load-balancing (for testing)", process);
+        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);
     }
 
     topologies_type topologies;
     topologies_type::topologies_type()
     {
         NOL_INSERT("simple", "balance with least loaded neighbor", loba_simple);
     }
 
     topologies_type topologies;
     topologies_type::topologies_type()
     {

-        NOL_INSERT("btree", "binary tree topologym intiial load at root", 
+        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);
                    deployment_btree);
         NOL_INSERT("clique", "all connected topology", deployment_clique);
         NOL_INSERT("hcube", "hypercube topology", deployment_hcube);


@@ -61,38 +80,112 @@ namespace opt {
         NOL_INSERT("ring", "ring topology", deployment_ring);
         NOL_INSERT("star", "star topology, initial load at center",
                    deployment_star);
         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);
+        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, "a: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) {
         case 'a':
             opt::loba_algo = optarg;
         switch (c) {
         case 'a':
             opt::loba_algo = optarg;

-            if (!opt::loba_algorithms.exists(opt::loba_algo)) {
-                ERROR1("unknownw load balancing algorithm -- %s",
-                       opt::loba_algo.c_str());
-                result = 0;
-            }
+            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;


@@ -110,7 +203,12 @@ 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::comp_maxiter;
+            break;
+        case 'I':
+            std::istringstream(optarg) >> opt::lb_maxiter;
+            ERROR0("option -I not implemented yet");
+            result = false;

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


@@ -121,20 +219,28 @@ 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':
         case 'T':

-            opt::auto_depl::topology = optarg; 
-            if (!opt::topologies.exists(opt::auto_depl::topology)) {
-                ERROR1("unknownw topology -- %s",
-                       opt::auto_depl::topology.c_str());
-                result = 0;
-            }
+            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;
         }
     }


@@ -146,7 +252,7 @@ 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 (optind < *argc) {
         opt::deployment_file = argv[optind++];
     }
     if (optind < *argc) {
         opt::deployment_file = argv[optind++];


@@ -155,7 +261,7 @@ int opt::parse_args(int* argc, char* argv[])
 
     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;


@@ -163,24 +269,38 @@ 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("| log rate.....................: %u",     opt::log_rate);
-    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............: %u", opt::auto_depl::nhosts);
-        INFO1("| - initial load...............: %g", opt::auto_depl::load);
+        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.: %u",   opt::maxiter);
-    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 comp. iterations", "%s",
+          h.val_or_string(comp_maxiter, "infinity"));
+    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"));
+    DESCR("exit on close", "%s", h.on_off(exit_on_close));

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

+
+#undef DESCR

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


@@ -204,7 +324,7 @@ void opt::usage()
 
     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;
 


@@ -215,6 +335,8 @@ void opt::usage()
     std::clog << o("-l value")
               << "print current load every n-th iterations, 0 to disable"
               << " (" << opt::log_rate << ")\n";
     std::clog << o("-l value")
               << "print current load every n-th 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")
 
     std::clog << "\nAutomatic deployment options\n";
     std::clog << o("-T name")


@@ -234,7 +356,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")


@@ -243,10 +365,37 @@ 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 comp. iterations, 0 for infinity"
+              << " (" << opt::comp_maxiter << ")\n";
+    std::clog << o("-I value")
+              << "maximum number of lb. iterations, 0 for infinity"
+              << " (" << opt::lb_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;
+
+    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 << "\nMiscellaneous low-level parameters\n";

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