Improve help message.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 4dd53150f784f3f5f680d19b46e7082c80bb8a32..243ad59be73126b016e7b2ced37aaa3d1287e515 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -1,25 +1,40 @@
-#include <cstring>
+#include "options.h"
+
+#include <iomanip>

 #include <iostream>
 #include <iostream>

-#include <unistd.h>
+#include <sstream>
+#include <unistd.h>             // getopt

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

-#include "options.h"

 #include "misc.h"
 
 #include "misc.h"
 

-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simu);
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);

 
 namespace opt {
 
 
 namespace opt {
 

-    const char* program_name;
+    std::string program_name;

 
 

-    const char* platform_file;
-    const char* application_file;
+    std::string platform_file;
+    std::string deployment_file;

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

+    unsigned log_rate = 1;
+
+    namespace auto_depl {
+        bool        enabled = false;
+        std::string topology;
+        unsigned    nhosts = 0;
+        double      load = 0.0;
+    }
+
+    unsigned maxiter = 4;       // fixme
+    bool exit_on_close = false;
+

     bool bookkeeping = false;
 
     cost_func comp_cost("1e9, 0"); // fixme: find better defaults
     bool bookkeeping = false;
 
     cost_func comp_cost("1e9, 0"); // fixme: find better defaults

+    cost_func comm_cost("1, 0"); // fixme: find better defaults

 
 } // namespace opt
 
 
 } // namespace opt
 


@@ -34,86 +49,159 @@ namespace {
 
 int opt::parse_args(int* argc, char* argv[])
 {
 
 int opt::parse_args(int* argc, char* argv[])
 {

-    char* tmp = strrchr(argv[0], '/');
-    opt::program_name = (tmp ? tmp + 1 : argv[0]);
+    int result = 1;

 
 

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

     int c;
     opterr = 0;
     int c;
     opterr = 0;

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

         switch (c) {
         case 'b':
             opt::bookkeeping = true;
             break;
         switch (c) {
         case 'b':
             opt::bookkeeping = true;
             break;

+        case 'e':
+            opt::exit_on_close = true;
+            break;

         case 'h':
             opt::help_requested++;
             break;
         case 'c':
             opt::comp_cost = cost_func(optarg);
             break;
         case 'h':
             opt::help_requested++;
             break;
         case 'c':
             opt::comp_cost = cost_func(optarg);
             break;

+        case 'C':
+            opt::comm_cost = cost_func(optarg);
+            break;
+        case 'i':
+            std::istringstream(optarg) >> opt::maxiter;
+            break;
+        case 'l':
+            std::istringstream(optarg) >> opt::log_rate;
+            break;
+        case 'L':
+            std::istringstream(optarg) >> opt::auto_depl::load;
+            break;
+        case 'N':
+            std::istringstream(optarg) >> opt::auto_depl::nhosts;
+            break;
+        case 'T':
+            opt::auto_depl::topology = optarg;
+            break;

         case 'V':
             opt::version_requested = true;
             break;
         case '?':
         case 'V':
             opt::version_requested = true;
             break;
         case '?':

-            WARN1("invalid option -- '%c'", optopt);
+            ERROR1("invalid option -- '%c'", optopt);
+            result = 0;

             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;
 

-    switch (*argc - optind) {
-    case 0:
+    if (optind < *argc) {
+        opt::platform_file = argv[optind++];
+    } else {

         ERROR0("missing parameter -- <plaform_file>");
         ERROR0("missing parameter -- <plaform_file>");

-    case 1:
-        ERROR0("missing parameter -- <application_file>");
-        return 0;
-
-    default:
-        opt::platform_file = argv[optind];
-        opt::application_file = argv[optind + 1];
-        for (int i = optind + 2 ; i < *argc ; ++i)
-            WARN1("unused parameter -- \"%s\"", argv[i]);
-        break;
+        result = 0;
+    }
+    if (!opt::auto_depl::enabled) {
+        if (optind < *argc) {
+            opt::deployment_file = argv[optind++];
+        } else {
+            ERROR0("missing parameter -- <deployment_file>");
+            result = 0;
+        }
+    }
+
+    while (optind < *argc) {
+        ERROR1("unused parameter -- \"%s\"", argv[optind++]);
+        result = 0;

     }
 
     }
 

-    return 1;
+    return result;

 }
 
 void opt::print()
 {
     INFO0(",----[ Simulation parameters ]");
 }
 
 void opt::print()
 {
     INFO0(",----[ Simulation parameters ]");

-    INFO1("| platform_file.......: \"%s\"", opt::platform_file);
-    INFO1("| application_file....: \"%s\"", opt::application_file);
+    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);
+    } else {
+        INFO1("| deployment file.....: \"%s\"", opt::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("| 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());

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

-#include <iomanip>

 void opt::usage()
 {
 void opt::usage()
 {

-    const int indent1 = 6;
-    const int indent2 = 12;
-
-#define oo(opt, arg) std::setw(indent1) << (opt) << " "               \
-    << std::setw(indent2) << std::left << (arg) << std::right
-#define o(opt) oo(opt, "")
+#define o(opt) "    " << std::setw(14) \
+                      << std::left << (opt) << std::right << " "
+#define so(subopt) std::setw(10) << (subopt) << ": "

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

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

 
 

+    std::clog << "\nGlobal options\n";

     std::clog << o("-h")
     std::clog << o("-h")

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

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

+
+    std::clog << o("--help") << "print help from SimGrid framework and exit\n";

     std::clog << o("-V") << "print version and exit\n";
     std::clog << o("-V") << "print version and exit\n";

-    std::clog << o("-b") << "activate bookkeeping\n";
-    std::clog << oo("-c", "[fn,...]f0")
-              << "polynomial factors for computation cost ("
-              << opt::comp_cost.to_string() << ")\n";

 
 

+    std::clog << "\nSimulation parameters\n";
+    std::clog << o("-l value")
+              << "print current load every n-th iterations, 0 to disable"
+              << " (" << opt::log_rate << ")\n";
+
+    std::clog << "\nApplication parameters\n";
+    std::clog << o("-c [fn,...]f0")
+              << "polynomial factors for computation cost"
+              << " (" << opt::comp_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("-i value")
+              << "maximum number of iterations, 0 for infinity"
+              << " (" << opt::maxiter << ")\n";
+
+    std::clog << "\nLoad balancing algorithm\n";
+    std::clog << o("-b") << "enable bookkeeping\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";
+
+#undef so

 #undef o
 #undef o

-#undef oo

 }
 
 // Local variables:
 }
 
 // Local variables: