Deadlock fix, and other changes.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 18d4613dd77ade3686e7b09bae8c031e67803c25..2c8e61d672b7c82adfadbbf233805f06f193c225 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -1,53 +1,99 @@
-#include <cstring>              // strrchr

 #include <iomanip>
 #include <iostream>
 #include <sstream>
 #include <unistd.h>             // getopt
 #include <xbt/log.h>
 #include <iomanip>
 #include <iostream>
 #include <sstream>
 #include <unistd.h>             // getopt
 #include <xbt/log.h>

-#include "options.h"
-#include "misc.h"

 
 

-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simu);
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
+
+#include "loba_simple.h"
+#include "loba_fairstrategy.h"
+
+#include "options.h"

 
 namespace opt {
 
 
 namespace opt {
 

-    const char* program_name;
+    // Constants

 
 

-    const char* platform_file;
-    const char* application_file;
+    // 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;
     bool version_requested = false;
 
     int help_requested = 0;
     bool version_requested = false;
 

-    unsigned maxiter = 4;
-    bool exit_on_close = false;
+    // Simulation parameters
+    unsigned log_rate = 1;
+
+    // Platform and deployment
+    std::string platform_file;
+    std::string deployment_file;

 
 

+    // Automatic deployment
+    namespace auto_depl {
+        bool        enabled = false;
+        std::string topology("clique");
+        unsigned    nhosts = 0;
+        double      load = 0.0;
+    }
+
+    // Load balancing algorithm
+    std::string loba_algo("simple");

     bool bookkeeping = false;
 
     bool bookkeeping = false;
 

+    // Application parameters

     cost_func comp_cost("1e9, 0"); // fixme: find better defaults
     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
+    bool exit_on_close = false;

 
 

-} // namespace opt
-
-namespace {
+    // Named parameters lists
+    loba_algorithms_type loba_algorithms;
+    loba_algorithms_type::loba_algorithms_type()
+    {
+        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);
+    }

 
 

-    const char* on_off(bool b)
+    topologies_type topologies;
+    topologies_type::topologies_type()

     {
     {

-        return b ? "on" : "off";
+        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("torus", "torus topology", deployment_torus);

     }
 
     }
 

-}
+} // namespace opt

 
 int opt::parse_args(int* argc, char* argv[])
 {
     int result = 1;
 
 
 int opt::parse_args(int* argc, char* argv[])
 {
     int result = 1;
 

-    char* tmp = strrchr(argv[0], '/');
-    opt::program_name = (tmp ? tmp + 1 : argv[0]);
-
+    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:ehi:V")) != -1) {
+    while ((c = getopt(*argc, argv, "a:bc:C:ehi:l:L:N:T:vV")) != -1) {

         switch (c) {
         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;
+            }
+            break;

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


@@ -60,9 +106,33 @@ int opt::parse_args(int* argc, char* argv[])
         case 'c':
             opt::comp_cost = cost_func(optarg);
             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 '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; 
+            if (!opt::topologies.exists(opt::auto_depl::topology)) {
+                ERROR1("unknownw topology -- %s",
+                       opt::auto_depl::topology.c_str());
+                result = 0;
+            }
+            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 'V':
             opt::version_requested = true;
             break;


@@ -72,74 +142,164 @@ int opt::parse_args(int* argc, char* argv[])
             break;
         }
     }
             break;
         }
     }

+

     if (opt::version_requested || opt::help_requested)
         return 1;
 
     if (opt::version_requested || opt::help_requested)
         return 1;
 

-    int rem_args = *argc - optind;
-    switch (rem_args) {
-    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>");

         result = 0;
         result = 0;

-        break;
+    }
+    if (optind < *argc) {
+        opt::deployment_file = argv[optind++];
+    }
+    opt::auto_depl::enabled = opt::deployment_file.empty();

 
 

-    default:
-        opt::platform_file = argv[optind];
-        opt::application_file = argv[optind + 1];
-        if (rem_args == 2)
-            break;
-        for (int i = optind + 2 ; i < *argc ; ++i)
-            ERROR1("unused parameter -- \"%s\"", argv[i]);
+    while (optind < *argc) {
+        ERROR1("unused parameter -- \"%s\"", argv[optind++]);

         result = 0;
         result = 0;

-        break;

     }
 
     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()
 {
     INFO0(",----[ Simulation parameters ]");
 void opt::print()
 {
     INFO0(",----[ Simulation parameters ]");

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

     INFO0("`----");
 }
 
 void opt::usage()
 {
     INFO0("`----");
 }
 
 void opt::usage()
 {

-    const int indent1 = 6;
-    const int indent2 = 12;
+    // option(...)
+#define o(opt) "    " << std::setw(14) \
+                      << std::left << (opt) << std::right << " "
+    // sub-option(...)
+#define so(subopt) std::setw(18) << (subopt) << " : "
+    // sub-option list
+#define so_list(name) do {                                      \
+        name ## _type::iterator it;                             \
+        for (it = name.begin() ; it != name.end() ; ++it)       \
+            std::clog << so(name.get_name(it))                  \
+                      << name.get_descr(it) << "\n";            \
+    } while (0)

 
 

-#define oo(opt, arg) std::setw(indent1) << (opt) << " "               \
-    << std::setw(indent2) << std::left << (arg) << std::right
-#define o(opt) oo(opt, "")

 
     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 << "\nGlobal options\n";

     std::clog << o("-h")
               << "print help and exit (use -hh or -hhh for extended help)\n";
     if (opt::help_requested < 1)
         return;
 
     std::clog << o("-h")
               << "print help and exit (use -hh or -hhh for extended help)\n";
     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 << o("-e") << "exit on close reception\n";
-    std::clog << oo("-i", "value")
-              << "maximum number of iterations, 0 for infinity ("
-              << opt::maxiter << ")\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 << o("-v")
+              << "verbose: do not override the default logging parameters\n";
+
+    std::clog << "\nAutomatic deployment options\n";
+    std::clog << o("-T name")
+              << "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")
+              << "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";
+
+    std::clog << "\nLoad balancing algorithm\n";
+    std::clog << o("-a name") << "load balancing algorithm"
+              << " (" << opt::loba_algo << ")\n";
+    if (opt::help_requested > 1)
+        so_list(opt::loba_algorithms);
+    std::clog << o("-b") << "enable bookkeeping\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";
+
+    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 o

-#undef oo

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