Make opt::print() more friendly to update.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index f881ad338e34d0990b365de58d2882087c775797..86cec694b295ff958cffb5a12735fce664f1ba0f 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -1,16 +1,25 @@
-#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 "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;


@@ -26,7 +35,7 @@ namespace opt {
     // Automatic deployment
     namespace auto_depl {
         bool        enabled = false;
     // Automatic deployment
     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;
     }


@@ -38,61 +47,135 @@ namespace opt {
     // Application parameters
     cost_func comp_cost("1e9, 0"); // fixme: find better defaults
     cost_func comm_cost("1, 0"); // fixme: find better defaults
     // 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
+    unsigned maxiter = 10;       // fixme: find better defaults

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

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

+    // some helper functions for opt::print()
+
+    std::string* descr_str;
+    std::string* val_or_string_str;
+
+    void print_helper_init()
+    {
+        descr_str = new std::string;
+        val_or_string_str = new std::string;
+    }
+
+    void print_helper_destroy()
+    {
+        delete val_or_string_str;
+        delete descr_str;
+    }
+
+    const char* descr(const char* str)
+    {
+        const int descr_width = 35;
+        std::string* res = descr_str;
+        *res = str;
+        res->resize(descr_width, '.');
+        return res->c_str();
+    }
+

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

-}
+    template <typename T>
+    const char* val_or_string(const T& val, const char* str, const T& deflt = 0)
+    {
+        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();
+    }
+
+    // helper function for opt::parse_args()
+
+    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();
+                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;
+    }
+
+} // namespace

 
 

-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:l:L:N: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 = nol_find_prefix(opt::loba_algorithms,
+                                     "load balancing algorithm",
+                                     opt::loba_algo);

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


@@ -122,23 +205,23 @@ int opt::parse_args(int* argc, char* argv[])
             std::istringstream(optarg) >> opt::auto_depl::nhosts;
             break;
         case 'T':
             std::istringstream(optarg) >> opt::auto_depl::nhosts;
             break;
         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 = nol_find_prefix(opt::topologies, "topology",
+                                     opt::auto_depl::topology);
+            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;


@@ -147,20 +230,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;


@@ -168,24 +247,32 @@ int opt::parse_args(int* argc, char* argv[])
 
 void opt::print()
 {
 
 void opt::print()
 {

+    print_helper_init();
+#define DESCR(description, format, value) \
+    INFO2("| %s: " format, 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",          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",   val_or_string(auto_depl::nhosts,
+                                                         "auto"));
+        DESCR("- initial load", "%s",      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",                  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("maximum number of iterations", "%s",
+          val_or_string(maxiter, "infinity"));
+    DESCR("exit on close", "%s",                on_off(exit_on_close));

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

+#undef DESCR
+    print_helper_destroy();

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


@@ -205,13 +292,11 @@ void opt::usage()
 
 
     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;
 


@@ -222,10 +307,13 @@ 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")

-              << "enable automatic deployment with selected topology\n";
+              << "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")
     if (opt::help_requested > 1)
         so_list(opt::topologies);
     std::clog << o("-L value")


@@ -254,6 +342,20 @@ void opt::usage()
               << "maximum number of iterations, 0 for infinity"
               << " (" << opt::maxiter << ")\n";
 
               << "maximum number of iterations, 0 for infinity"
               << " (" << opt::maxiter << ")\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";
+

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