Add more documentation.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 7a65a71864400bc1bf4c976cdcc2556aad4ec62d..e4d1236ecd51205c4dd87ed536d05e5392f27dc6 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -26,7 +26,7 @@ namespace opt {
     // Automatic deployment
     namespace auto_depl {
         bool        enabled = false;
-        std::string topology;
+        std::string topology("clique");
         unsigned    nhosts = 0;
         double      load = 0.0;
     }
@@ -38,7 +38,7 @@ namespace opt {
     // 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
@@ -61,20 +61,11 @@ namespace opt {
         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 {
-
-    const char* on_off(bool b)
-    {
-        return b ? "on" : "off";
-    }
-
-}
-
 int opt::parse_args(int* argc, char* argv[])
 {
     int result = 1;
@@ -138,7 +129,6 @@ int opt::parse_args(int* argc, char* argv[])
             break;
         }
     }
-    opt::auto_depl::enabled = !opt::auto_depl::topology.empty();
 
     if (opt::version_requested || opt::help_requested)
         return 1;
@@ -149,14 +139,10 @@ int opt::parse_args(int* argc, char* argv[])
         ERROR0("missing parameter -- <plaform_file>");
         result = 0;
     }
-    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++]);
@@ -166,16 +152,44 @@ int opt::parse_args(int* argc, char* argv[])
     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()
 {
     INFO0(",----[ Simulation parameters ]");
-    INFO1("| log rate.....................: %u",     opt::log_rate);
+    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) {
         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);
+        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"));
     } else {
         INFO1("| deployment file..............: \"%s\"", opt::deployment_file.c_str());
     }
@@ -183,7 +197,8 @@ void opt::print()
     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("| maximum number of iterations.: %s",
+          val_or_string(opt::maxiter, "infinity"));
     INFO1("| exit on close................: %s",   on_off(opt::exit_on_close));
     INFO0("`----");
 }
@@ -205,13 +220,11 @@ void opt::usage()
 
 
     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")
-              << "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;
 
@@ -225,7 +238,8 @@ void opt::usage()
 
     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")
@@ -254,6 +268,20 @@ void opt::usage()
               << "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