Fix error reporting in opt::parse_args.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index cf9d7b70bcfdbc6cd14bf08559981fb9d86768d3..56049ed98fd641a14a7ff5e13d9c12806d20e269 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -1,6 +1,7 @@
 #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>
 


@@ -13,6 +14,12 @@ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
 
 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;


@@ -40,7 +47,8 @@ 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 = 10;       // 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;
 
     // Named parameters lists
     bool exit_on_close = false;
 
     // Named parameters lists


@@ -69,24 +77,107 @@ namespace opt {
 
 } // namespace opt
 
 
 } // namespace opt
 

-int opt::parse_args(int* argc, char* argv[])
+namespace {
+
+    // 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 = 35;
+    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)

 {
 {

-    int result = 1;
+    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;
+}
+
+bool opt::parse_args(int* argc, char* argv[])
+{
+    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:vV")) != -1) {
+    while ((c = getopt(*argc, argv, "a:bc:C:ehi:I: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 = 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;


@@ -104,7 +195,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;


@@ -116,12 +212,10 @@ 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 = 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


@@ -132,7 +226,7 @@ int opt::parse_args(int* argc, char* argv[])
             break;
         case '?':
             ERROR1("invalid option -- '%c'", optopt);
             break;
         case '?':
             ERROR1("invalid option -- '%c'", optopt);

-            result = 0;
+            result = false;

             break;
         }
     }
             break;
         }
     }


@@ -144,7 +238,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++];


@@ -153,61 +247,44 @@ 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;
 }
 

-namespace {
-
-    // some helper functions for opt::print()
-
-    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)
-    {
-        static std::string res;
-        if (val != deflt) {
-            std::ostringstream oss;
-            oss << val;
-            res = oss.str();
-        } else {
-            res = str;
-        }
-        return res.c_str();
-    }
-
-} // namespace
-

 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("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("exit on close", "%s",                h.on_off(exit_on_close));

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

+
+#undef DESCR

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


@@ -274,8 +351,11 @@ void opt::usage()
               << " (" << opt::comm_cost.to_string() << ")\n";
     std::clog << o("-e") << "exit on reception of \"close\" message\n";
     std::clog << o("-i value")
               << " (" << opt::comm_cost.to_string() << ")\n";
     std::clog << o("-e") << "exit on reception of \"close\" message\n";
     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";

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