options.cpp

   1 #include <iomanip>
   2 #include <iostream>
   3 #include <sstream>
   4 #include <stack>
   5 #include <unistd.h>             // getopt
   6 #include <xbt/log.h>
   7
   8 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
   9
  10 #include "loba_simple.h"
  11 #include "loba_fairstrategy.h"
  12
  13 #include "options.h"
  14
  15 namespace opt {
  16
  17     // Constants
  18
  19     // A sum of loads if considered null if it is less than
  20     // load_ratio_threshold percent of the sum of loads at init.
  21     const double load_ratio_threshold = 1e-4;
  22
  23     // Global options
  24     std::string program_name;
  25     int help_requested = 0;
  26     bool version_requested = false;
  27
  28     // Simulation parameters
  29     unsigned log_rate = 1;
  30
  31     // Platform and deployment
  32     std::string platform_file;
  33     std::string deployment_file;
  34
  35     // Automatic deployment
  36     namespace auto_depl {
  37         bool        enabled = false;
  38         std::string topology("clique");
  39         unsigned    nhosts = 0;
  40         double      load = 0.0;
  41     }
  42
  43     // Load balancing algorithm
  44     std::string loba_algo("simple");
  45     bool bookkeeping = false;
  46
  47     // Application parameters
  48     cost_func comp_cost("1e9, 0"); // fixme: find better defaults
  49     cost_func comm_cost("1, 0"); // fixme: find better defaults
  50     unsigned comp_maxiter = 10;  // fixme: find better defaults
  51     unsigned lb_maxiter = comp_maxiter; // fixme: find better defaults
  52     bool exit_on_close = false;
  53
  54     // Named parameters lists
  55     loba_algorithms_type loba_algorithms;
  56     loba_algorithms_type::loba_algorithms_type()
  57     {
  58         NOL_INSERT("fairstrategy", "balance with fair strategy", loba_fairstrategy);
  59         NOL_INSERT("none", "no load-balancing (for testing only)", process);
  60         NOL_INSERT("simple", "balance with least loaded neighbor", loba_simple);
  61     }
  62
  63     topologies_type topologies;
  64     topologies_type::topologies_type()
  65     {
  66         NOL_INSERT("btree", "binary tree topology, initial load at root",
  67                    deployment_btree);
  68         NOL_INSERT("clique", "all connected topology", deployment_clique);
  69         NOL_INSERT("hcube", "hypercube topology", deployment_hcube);
  70         NOL_INSERT("line", "line topology, initial load at one end",
  71                    deployment_line);
  72         NOL_INSERT("ring", "ring topology", deployment_ring);
  73         NOL_INSERT("star", "star topology, initial load at center",
  74                    deployment_star);
  75         NOL_INSERT("torus", "torus topology", deployment_torus);
  76     }
  77
  78 } // namespace opt
  79
  80 namespace {
  81
  82     // some helper functions for opt::print()
  83
  84     std::string* descr_str;
  85     std::string* val_or_string_str;
  86
  87     void print_helper_init()
  88     {
  89         descr_str = new std::string;
  90         val_or_string_str = new std::string;
  91     }
  92
  93     void print_helper_destroy()
  94     {
  95         delete val_or_string_str;
  96         delete descr_str;
  97     }
  98
  99     const char* descr(const char* str)
 100     {
 101         const int descr_width = 35;
 102         std::string* res = descr_str;
 103         *res = str;
 104         res->resize(descr_width, '.');
 105         return res->c_str();
 106     }
 107
 108     const char* on_off(bool b)
 109     {
 110         return b ? "on" : "off";
 111     }
 112
 113     template <typename T>
 114     const char* val_or_string(const T& val, const char* str, const T& deflt = 0)
 115     {
 116         std::string* res = val_or_string_str;
 117         if (val != deflt) {
 118             std::ostringstream oss;
 119             oss << val;
 120             *res = oss.str();
 121         } else {
 122             *res = str;
 123         }
 124         return res->c_str();
 125     }
 126
 127     // helper function for opt::parse_args()
 128
 129     template <typename T>
 130     bool nol_find_prefix(const T& nol, const char* descr, std::string& name)
 131     {
 132         bool result = nol.exists(name);
 133         if (!result) {
 134             std::stack<std::string> candidates;
 135             for (typename T::iterator it = nol.begin() ; it != nol.end() ; ++it) {
 136                 const std::string& fullname = nol.get_name(it);
 137                 if (fullname.compare(0, name.length(), name) == 0)
 138                     candidates.push(fullname);
 139             }
 140             switch (candidates.size()) {
 141             case 0:
 142                 ERROR2("unknownw %s -- %s", descr, name.c_str());
 143                 break;
 144             case 1:
 145                 name = candidates.top();
 146                 candidates.pop();
 147                 result = true;
 148                 DEBUG2("infered %s -- %s", descr, name.c_str());
 149                 break;
 150             default:
 151                 ERROR2("ambiguous %s -- %s", descr, name.c_str());
 152                 while (!candidates.empty()) {
 153                     ERROR1("  candidates are -- %s", candidates.top().c_str());
 154                     candidates.pop();
 155                 }
 156                 break;
 157             }
 158         }
 159         return result;
 160     }
 161
 162 } // namespace
 163
 164 bool opt::parse_args(int* argc, char* argv[])
 165 {
 166     bool result = true;
 167
 168     opt::program_name = argv[0];
 169     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));
 170
 171     int c;
 172     opterr = 0;
 173     while ((c = getopt(*argc, argv, "a:bc:C:ehi:I:l:L:N:T:vV")) != -1) {
 174         switch (c) {
 175         case 'a':
 176             opt::loba_algo = optarg;
 177             result = nol_find_prefix(opt::loba_algorithms,
 178                                      "load balancing algorithm",
 179                                      opt::loba_algo);
 180             break;
 181         case 'b':
 182             opt::bookkeeping = true;
 183             break;
 184         case 'e':
 185             opt::exit_on_close = true;
 186             break;
 187         case 'h':
 188             opt::help_requested++;
 189             break;
 190         case 'c':
 191             opt::comp_cost = cost_func(optarg);
 192             break;
 193         case 'C':
 194             opt::comm_cost = cost_func(optarg);
 195             break;
 196         case 'i':
 197             std::istringstream(optarg) >> opt::comp_maxiter;
 198             break;
 199         case 'I':
 200             std::istringstream(optarg) >> opt::lb_maxiter;
 201             ERROR0("option -I not implemented yet");
 202             result = false;
 203             break;
 204         case 'l':
 205             std::istringstream(optarg) >> opt::log_rate;
 206             break;
 207         case 'L':
 208             std::istringstream(optarg) >> opt::auto_depl::load;
 209             break;
 210         case 'N':
 211             std::istringstream(optarg) >> opt::auto_depl::nhosts;
 212             break;
 213         case 'T':
 214             opt::auto_depl::topology = optarg;
 215             result = nol_find_prefix(opt::topologies, "topology",
 216                                      opt::auto_depl::topology);
 217             break;
 218         case 'v':
 219             // nothing to do: this option is checked at the very
 220             // beginning of main()
 221             break;
 222         case 'V':
 223             opt::version_requested = true;
 224             break;
 225         case '?':
 226             ERROR1("invalid option -- '%c'", optopt);
 227             result = false;
 228             break;
 229         }
 230     }
 231
 232     if (opt::version_requested || opt::help_requested)
 233         return 1;
 234
 235     if (optind < *argc) {
 236         opt::platform_file = argv[optind++];
 237     } else {
 238         ERROR0("missing parameter -- <plaform_file>");
 239         result = false;
 240     }
 241     if (optind < *argc) {
 242         opt::deployment_file = argv[optind++];
 243     }
 244     opt::auto_depl::enabled = opt::deployment_file.empty();
 245
 246     while (optind < *argc) {
 247         ERROR1("unused parameter -- \"%s\"", argv[optind++]);
 248         result = false;
 249     }
 250
 251     return result;
 252 }
 253
 254 void opt::print()
 255 {
 256     print_helper_init();
 257 #define DESCR(description, format, value) \
 258     INFO2("| %s: " format, descr(description), value)
 259     INFO0(",----[ Simulation parameters ]");
 260     DESCR("log rate", "%s",          val_or_string(log_rate, "disabled"));
 261     DESCR("platform file", "\"%s\"", platform_file.c_str());
 262     if (auto_depl::enabled) {
 263         INFO0("| automatic deployment enabled");
 264         DESCR("- topology", "%s",          auto_depl::topology.c_str());
 265         DESCR("- number of hosts", "%s",   val_or_string(auto_depl::nhosts,
 266                                                          "auto"));
 267         DESCR("- initial load", "%s",      val_or_string(auto_depl::load,
 268                                                          "auto"));
 269     } else {
 270         DESCR("deployment file", "\"%s\"", deployment_file.c_str());
 271     }
 272     DESCR("load balancing algorithm", "%s",     loba_algo.c_str());
 273     DESCR("bookkeeping", "%s",                  on_off(bookkeeping));
 274     DESCR("computation cost factors", "[%s]",   comp_cost.to_string().c_str());
 275     DESCR("communication cost factors", "[%s]", comm_cost.to_string().c_str());
 276     DESCR("maximum number of comp. iterations", "%s",
 277           val_or_string(comp_maxiter, "infinity"));
 278     DESCR("maximum number of lb. iterations", "%s",
 279           val_or_string(lb_maxiter, "infinity"));
 280     DESCR("exit on close", "%s",                on_off(exit_on_close));
 281     INFO0("`----");
 282 #undef DESCR
 283     print_helper_destroy();
 284 }
 285
 286 void opt::usage()
 287 {
 288     // option(...)
 289 #define o(opt) "    " << std::setw(14) \
 290                       << std::left << (opt) << std::right << " "
 291     // sub-option(...)
 292 #define so(subopt) std::setw(18) << (subopt) << " : "
 293     // sub-option list
 294 #define so_list(name) do {                                      \
 295         name ## _type::iterator it;                             \
 296         for (it = name.begin() ; it != name.end() ; ++it)       \
 297             std::clog << so(name.get_name(it))                  \
 298                       << name.get_descr(it) << "\n";            \
 299     } while (0)
 300
 301
 302     std::clog << "Usage: " << opt::program_name
 303               << " [options] <platform_file> [<deployment_file>]\n";
 304
 305     std::clog << "\nGlobal options\n";
 306     std::clog << o("-h")
 307               << "print help and exit (use -hh or -hhh for extended help)\n";
 308     if (opt::help_requested < 1)
 309         return;
 310
 311     std::clog << o("--help") << "print help from SimGrid framework and exit\n";
 312     std::clog << o("-V") << "print version and exit\n";
 313
 314     std::clog << "\nSimulation parameters\n";
 315     std::clog << o("-l value")
 316               << "print current load every n-th iterations, 0 to disable"
 317               << " (" << opt::log_rate << ")\n";
 318     std::clog << o("-v")
 319               << "verbose: do not override the default logging parameters\n";
 320
 321     std::clog << "\nAutomatic deployment options\n";
 322     std::clog << o("-T name")
 323               << "enable automatic deployment with selected topology"
 324               << " (" << opt::auto_depl::topology << ")\n";
 325     if (opt::help_requested > 1)
 326         so_list(opt::topologies);
 327     std::clog << o("-L value")
 328               << "total load with auto deployment, 0 for number of hosts"
 329               << " (" << opt::auto_depl::load << ")\n";
 330     std::clog << o("-N value")
 331               << "number of hosts to use with auto deployment,"
 332               << " 0 for max. (" << opt::auto_depl::nhosts << ")\n";
 333
 334     std::clog << "\nLoad balancing algorithm\n";
 335     std::clog << o("-a name") << "load balancing algorithm"
 336               << " (" << opt::loba_algo << ")\n";
 337     if (opt::help_requested > 1)
 338         so_list(opt::loba_algorithms);
 339     std::clog << o("-b") << "enable bookkeeping\n";
 340
 341     std::clog << "\nApplication parameters\n";
 342     std::clog << o("-c [fn,...]f0")
 343               << "polynomial factors for computation cost"
 344               << " (" << opt::comp_cost.to_string() << ")\n";
 345     std::clog << o("-C [fn,...]f0")
 346               << "polynomial factors for communication cost"
 347               << " (" << opt::comm_cost.to_string() << ")\n";
 348     std::clog << o("-e") << "exit on reception of \"close\" message\n";
 349     std::clog << o("-i value")
 350               << "maximum number of comp. iterations, 0 for infinity"
 351               << " (" << opt::comp_maxiter << ")\n";
 352     std::clog << o("-I value")
 353               << "maximum number of lb. iterations, 0 for infinity"
 354               << " (" << opt::lb_maxiter << ")\n";
 355
 356     if (opt::help_requested < 3)
 357         return;
 358
 359     std::clog << "\nLogging support\n"
 360               << "    See SimGrid documentation on:\n"
 361               << "        http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_user\n"
 362               << "    Existing categories are:\n"
 363               << "        simu : root of following categories\n"
 364               << "        main : messages from global infrastructure\n"
 365               << "        depl : messages from auto deployment (inherited from main)\n"
 366               << "        comm : messages from asynchronous pipes\n"
 367               << "        proc : messages from base process class\n"
 368               << "        loba : messages from load-balancer\n";
 369
 370 #undef so_list
 371 #undef so
 372 #undef o
 373 }
 374
 375 // Local variables:
 376 // mode: c++
 377 // End: