options.cpp

   1 #include <ctime>
   2 #include <iomanip>
   3 #include <iostream>
   4 #include <sstream>
   5 #include <stack>
   6 #include <unistd.h>             // getopt
   7 #include <xbt/log.h>
   8
   9 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
  10
  11 #include "deployment.h"
  12 #include "process.h"
  13 #include "loba_besteffort.h"
  14 #include "loba_bulk.h"
  15 #include "loba_fairstrategy.h"
  16 #include "loba_lln.h"
  17 #include "loba_makhoul.h"
  18 #include "loba_makhoul2.h"
  19 #include "loba_simple.h"
  20 #include "misc.h"
  21
  22 #include "options.h"
  23
  24 #define DATA_DESCR_WIDTH 42
  25
  26 namespace opt {
  27
  28     // Constants
  29
  30     // A sum of loads if considered null if it is less than
  31     // load_ratio_threshold percent of the sum of loads at init.
  32     const double load_ratio_threshold = 1e-4;
  33
  34     // Global options
  35     std::string program_name;
  36     int help_requested = 0;
  37     bool version_requested = false;
  38     int option_x = 0;           // hidden option, for debugging purpose
  39
  40     // Simulation parameters
  41     int log_rate = 1;
  42     volatile sig_atomic_t exit_request = 0;
  43
  44     // Platform and deployment
  45     std::string platform_file;
  46     std::string deployment_file;
  47
  48     // Automatic deployment
  49     namespace auto_depl {
  50         bool        enabled = false;
  51         std::string topology("clique");
  52         unsigned    nhosts = 0;
  53         double      load = 0.0;
  54         bool        random_distribution = false;
  55         unsigned long random_seed = 0;
  56     }
  57
  58     // Load balancing algorithm
  59     std::string loba_algo("simple");
  60     bool bookkeeping = false;
  61     double min_lb_iter_duration = 1.0;          // fixme: find better defaults
  62     double min_transfer_amount = 0.0;
  63     double max_transfer_amount = 0.0;
  64
  65     // Application parameters
  66     cost_func comp_cost("1e9, 0");              // fixme: find better defaults
  67     cost_func comm_cost("1e6, 0");              // fixme: find better defaults
  68     double min_comp_iter_duration = 1.0;        // fixme: find better defaults
  69     unsigned comp_iter_delay = 0;               // fixme: find better defaults
  70     double comp_time_delay = 0.0;               // fixme: find better defaults
  71
  72     // Parameters for the end of the simulation
  73     unsigned lb_maxiter = 0;
  74     unsigned comp_maxiter = 0;
  75     double time_limit = 0;
  76     bool exit_on_close = true;
  77
  78     // Named parameters lists
  79     loba_algorithms_type loba_algorithms;
  80     loba_algorithms_type::loba_algorithms_type()
  81     {
  82         NOL_INSERT("besteffort", "balance with best effort strategy",
  83                    loba_besteffort);
  84         NOL_INSERT("bulk", "A multi-load-units assignation rule without ordering...",
  85                    loba_bulk);
  86         NOL_INSERT("fairstrategy", "balance with fair strategy",
  87                    loba_fairstrategy);
  88         NOL_INSERT("lln", "Balance with less loaded neighbors without ordering-bulk method",
  89                    loba_lln);
  90         NOL_INSERT("makhoul", "balance with Makhoul's PhD algorithm",
  91                    loba_makhoul);
  92         NOL_INSERT("makhoul2", "balance with Makhoul's source code",
  93                    loba_makhoul2);
  94         NOL_INSERT("none", "no load-balancing (for testing only)",
  95                    process);
  96         NOL_INSERT("simple", "balance with least loaded neighbor",
  97                    loba_simple);
  98     }
  99
 100     topologies_type topologies;
 101     topologies_type::topologies_type()
 102     {
 103         NOL_INSERT("btree", "binary tree topology, initial load at root",
 104                    deployment_btree);
 105         NOL_INSERT("clique", "all connected topology", deployment_clique);
 106         NOL_INSERT("hcube", "hypercube topology", deployment_hcube);
 107         NOL_INSERT("line", "line topology, initial load at one end",
 108                    deployment_line);
 109         NOL_INSERT("ring", "ring topology", deployment_ring);
 110         NOL_INSERT("star", "star topology, initial load at center",
 111                    deployment_star);
 112         NOL_INSERT("torus", "torus topology", deployment_torus);
 113     }
 114
 115 } // namespace opt
 116
 117 namespace {
 118
 119     // local helper class
 120     class opt_helper {
 121     public:
 122         template <typename T>
 123         static bool parse_arg(char opt, const char *arg, T& val);
 124         static const char* on_off(bool b);
 125         const char* descr(const char* str);
 126         template <typename T>
 127         const char* val_or_string(const T& val, const char* str,
 128                                   const T& deflt = 0);
 129         template <typename T>
 130         static bool nol_find_prefix(const T& nol, const char* descr,
 131                                     std::string& name);
 132
 133     private:
 134         std::string descr_str;
 135         std::string val_or_string_str;
 136     };
 137
 138 } // namespace
 139
 140 template <typename T>
 141 bool opt_helper::parse_arg(char opt, const char *arg, T& val)
 142 {
 143     std::istringstream str(arg);
 144     bool result = (str >> val) && str.eof();
 145     if (!result)
 146         XBT_ERROR("invalid argument for option '-%c' -- \"%s\"", opt, arg);
 147     return result;
 148 }
 149
 150 const char* opt_helper::on_off(bool b)
 151 {
 152     return b ? "on" : "off";
 153 }
 154
 155 const char* opt_helper::descr(const char* str)
 156 {
 157     std::string& res = descr_str;
 158     res = str;
 159     res.resize(DATA_DESCR_WIDTH, '.');
 160     return res.c_str();
 161 }
 162
 163 template <typename T>
 164 const char* opt_helper::val_or_string(const T& val, const char* str,
 165                                       const T& deflt)
 166 {
 167     std::string& res = val_or_string_str;
 168     if (val != deflt) {
 169         std::ostringstream oss;
 170         oss << val;
 171         res = oss.str();
 172     } else {
 173         res = str;
 174     }
 175     return res.c_str();
 176 }
 177
 178 template <typename T>
 179 bool opt_helper::nol_find_prefix(const T& nol, const char* descr,
 180                                  std::string& name)
 181 {
 182     bool result = nol.exists(name);
 183     if (!result) {
 184         std::stack<std::string> candidates;
 185         for (typename T::iterator it = nol.begin() ; it != nol.end() ; ++it) {
 186             const std::string& fullname = nol.get_name(it);
 187             if (fullname.compare(0, name.length(), name) == 0)
 188                 candidates.push(fullname);
 189         }
 190         switch (candidates.size()) {
 191         case 0:
 192             XBT_ERROR("unknownw %s -- %s", descr, name.c_str());
 193             break;
 194         case 1:
 195             name = candidates.top();
 196             candidates.pop();
 197             result = true;
 198             XBT_DEBUG("infered %s -- %s", descr, name.c_str());
 199             break;
 200         default:
 201             XBT_ERROR("ambiguous %s -- %s", descr, name.c_str());
 202             while (!candidates.empty()) {
 203                 XBT_ERROR("  candidates are -- %s", candidates.top().c_str());
 204                 candidates.pop();
 205             }
 206             break;
 207         }
 208     }
 209     return result;
 210 }
 211
 212 bool opt::parse_args(int* argc, char* argv[])
 213 {
 214     bool result = true;
 215
 216     opt::program_name = argv[0];
 217     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));
 218
 219 #define PARSE_ARG(x) result = opt_helper::parse_arg(c, optarg, (x)) && result
 220
 221     int c;
 222     opterr = 0;
 223     while ((c = getopt(*argc, argv,
 224                        "a:bc:C:d:D:ehi:I:l:L:m:M:N:r:Rs:S:t:T:vVx:")) != -1) {
 225         switch (c) {
 226         case 'a':
 227             opt::loba_algo = optarg;
 228             result = opt_helper::nol_find_prefix(opt::loba_algorithms,
 229                                                  "load balancing algorithm",
 230                                                  opt::loba_algo)
 231                 && result;
 232             break;
 233         case 'b':
 234             opt::bookkeeping = !opt::bookkeeping;
 235             break;
 236         case 'e':
 237             opt::exit_on_close = !opt::exit_on_close;
 238             break;
 239         case 'h':
 240             opt::help_requested++;
 241             break;
 242         case 'c':
 243             try {
 244                 opt::comp_cost = cost_func(optarg);
 245             } catch (...) {
 246                 XBT_ERROR("invalid argument for option '-%c' -- \"%s\"",
 247                           c, optarg);
 248                 result = false;
 249             }
 250             break;
 251         case 'C':
 252             try {
 253                 opt::comm_cost = cost_func(optarg);
 254             } catch (...) {
 255                 XBT_ERROR("invalid argument for option '-%c' -- \"%s\"",
 256                           c, optarg);
 257                 result = false;
 258             }
 259             break;
 260         case 'd':
 261             PARSE_ARG(opt::comp_iter_delay);
 262             break;
 263         case 'D':
 264             PARSE_ARG(opt::comp_time_delay);
 265             break;
 266         case 'i':
 267             PARSE_ARG(opt::lb_maxiter);
 268             break;
 269         case 'I':
 270             PARSE_ARG(opt::comp_maxiter);
 271             break;
 272         case 'l':
 273             PARSE_ARG(opt::log_rate);
 274             break;
 275         case 'L':
 276             PARSE_ARG(opt::auto_depl::load);
 277             break;
 278         case 'm':
 279             PARSE_ARG(opt::min_transfer_amount);
 280             break;
 281         case 'M':
 282             PARSE_ARG(opt::max_transfer_amount);
 283             break;
 284         case 'N':
 285             PARSE_ARG(opt::auto_depl::nhosts);
 286             break;
 287         case 'r':
 288             PARSE_ARG(opt::auto_depl::random_seed);
 289             break;
 290         case 'R':
 291             opt::auto_depl::random_distribution =
 292                 !opt::auto_depl::random_distribution;
 293             break;
 294         case 's':
 295             PARSE_ARG(opt::min_lb_iter_duration);
 296             break;
 297         case 'S':
 298             PARSE_ARG(opt::min_comp_iter_duration);
 299             break;
 300         case 't':
 301             PARSE_ARG(opt::time_limit);
 302             break;
 303         case 'T':
 304             opt::auto_depl::topology = optarg;
 305             result = opt_helper::nol_find_prefix(opt::topologies, "topology",
 306                                                  opt::auto_depl::topology)
 307                 && result;
 308             break;
 309         case 'v':
 310             // nothing to do: this option is checked at the very
 311             // beginning of main()
 312             break;
 313         case 'V':
 314             opt::version_requested = true;
 315             break;
 316         case 'x':
 317             PARSE_ARG(opt::option_x);
 318             XBT_WARN("option_x set to %d", opt::option_x);
 319             break;
 320         case '?':
 321             XBT_ERROR("invalid option -- '%c'", optopt);
 322             result = false;
 323             break;
 324         }
 325     }
 326
 327 #undef PARSE_ARG
 328
 329     if (opt::version_requested || opt::help_requested)
 330         return 1;
 331
 332     if (optind < *argc) {
 333         opt::platform_file = argv[optind++];
 334     } else {
 335         XBT_ERROR("missing parameter -- <plaform_file>");
 336         result = false;
 337     }
 338     if (optind < *argc) {
 339         opt::deployment_file = argv[optind++];
 340     }
 341     opt::auto_depl::enabled = opt::deployment_file.empty();
 342
 343     while (optind < *argc) {
 344         XBT_ERROR("unused parameter -- \"%s\"", argv[optind++]);
 345         result = false;
 346     }
 347
 348     if (opt::max_transfer_amount &&
 349         opt::max_transfer_amount < opt::min_transfer_amount) {
 350         XBT_ERROR("max. data transfer amount < min. data transfer amount");
 351         result = false;
 352     }
 353
 354     if (!opt::auto_depl::random_seed)
 355         opt::auto_depl::random_seed = time(NULL);
 356
 357     return result;
 358 }
 359
 360 void opt::print()
 361 {
 362     opt_helper h;
 363
 364 #define DESCR(description, format, value) \
 365     XBT_INFO("| %s: " format, h.descr(description), value)
 366
 367     XBT_INFO(",----[ Simulation parameters ]");
 368     DESCR("log rate", "%s", h.val_or_string(log_rate, "disabled"));
 369     DESCR("platform file", "\"%s\"", platform_file.c_str());
 370     if (auto_depl::enabled) {
 371         XBT_INFO("| automatic deployment enabled");
 372         DESCR("- topology", "%s", auto_depl::topology.c_str());
 373         DESCR("- number of hosts", "%s", h.val_or_string(auto_depl::nhosts,
 374                                                          "auto"));
 375         DESCR("- initial load", "%s", h.val_or_string(auto_depl::load,
 376                                                       "auto"));
 377         DESCR("- random initial load distribution", "%s",
 378               h.on_off(auto_depl::random_distribution));
 379         DESCR("- random seed", "%s",
 380               h.val_or_string(auto_depl::random_seed, "time based"));
 381     } else {
 382         DESCR("deployment file", "\"%s\"", deployment_file.c_str());
 383     }
 384     DESCR("load balancing algorithm", "%s", loba_algo.c_str());
 385     DESCR("bookkeeping", "%s", h.on_off(bookkeeping));
 386     DESCR("minimum duration between lb. iterations", "%g",
 387           min_lb_iter_duration);
 388     DESCR("computation cost factors", "[%s]", comp_cost.to_string().c_str());
 389     DESCR("communication cost factors", "[%s]", comm_cost.to_string().c_str());
 390     DESCR("minimum data transfer amount", "%g", min_transfer_amount);
 391     DESCR("maximum data transfer amount", "%s",
 392           h.val_or_string(max_transfer_amount, "no limit"));
 393     DESCR("minimum duration between comp. iterations", "%g",
 394           min_comp_iter_duration);
 395     DESCR("computations start after lb. iter", "%u", comp_iter_delay);
 396     DESCR("computations start after time", "%g", comp_time_delay);
 397     DESCR("maximum number of lb. iterations", "%s",
 398           h.val_or_string(lb_maxiter, "no limit"));
 399     DESCR("maximum number of comp. iterations", "%s",
 400           h.val_or_string(comp_maxiter, "no limit"));
 401     DESCR("time limit", "%s", h.val_or_string(time_limit, "no limit"));
 402     DESCR("exit on close", "%s", h.on_off(exit_on_close));
 403     XBT_INFO("`----");
 404
 405 #undef DESCR
 406 }
 407
 408 void opt::usage()
 409 {
 410     // option(...)
 411 #define o(opt) "    " << std::setw(14) \
 412                       << std::left << (opt) << std::right << " "
 413     // sub-option(...)
 414 #define so(subopt) std::setw(18) << (subopt) << " : "
 415     // sub-option list
 416 #define so_list(name) do {                                      \
 417         name ## _type::iterator it;                             \
 418         for (it = name.begin() ; it != name.end() ; ++it)       \
 419             std::clog << so(name.get_name(it))                  \
 420                       << name.get_descr(it) << "\n";            \
 421     } while (0)
 422
 423
 424     std::clog << "Usage: " << opt::program_name
 425               << " [options] <platform_file> [<deployment_file>]\n";
 426     std::clog << "Current values for the parameters are given between square brackets.\n";
 427
 428     std::clog << "\nGlobal options:\n";
 429     std::clog << o("-h")
 430               << "print help and exit (use -hh or -hhh for extended help)\n";
 431     if (opt::help_requested < 1)
 432         return;
 433
 434     std::clog << o("--help") << "print help from SimGrid framework and exit\n";
 435     std::clog << o("-V") << "print version and exit\n";
 436
 437     std::clog << "\nSimulator output:\n";
 438     std::clog << o("-l value")
 439               << "print current load every n lb iterations, 0 to disable"
 440               << " [" << opt::log_rate << "]\n";
 441     std::clog << o("-v")
 442               << "verbose: do not override the default logging parameters\n";
 443
 444     std::clog << "\nAutomatic deployment:\n";
 445     std::clog << o("-T name")
 446               << "enable automatic deployment with selected topology"
 447               << " [" << opt::auto_depl::topology << "]\n";
 448     if (opt::help_requested > 1)
 449         so_list(opt::topologies);
 450     std::clog << o("-L value")
 451               << "total load with auto deployment, 0 for number of hosts"
 452               << " [" << opt::auto_depl::load << "]\n";
 453     std::clog << o("-N value")
 454               << "number of hosts to use with auto deployment, 0 for max."
 455               << " [" << opt::auto_depl::nhosts << "]\n";
 456     std::clog << o("-R")
 457               << "toggle random initial load distribution"
 458               << " [" << opt_helper::on_off(opt::auto_depl::random_distribution)
 459               << "]\n";
 460     std::clog << o("-r value")
 461               << "random seed, 0 for a seed based on current date"
 462               << " [" << opt::auto_depl::random_seed << "]\n";
 463
 464     std::clog << "\nLoad balancing algorithm:\n";
 465     std::clog << o("-a name") << "load balancing algorithm"
 466               << " [" << opt::loba_algo << "]\n";
 467     if (opt::help_requested > 1)
 468         so_list(opt::loba_algorithms);
 469     std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
 470               << " [" << opt_helper::on_off(opt::bookkeeping) << "]\n";
 471
 472     std::clog << "\nLb. and comp. iterations:\n";
 473     std::clog << o("-s value")
 474               << "minimum duration between lb. iterations"
 475               << " [" << opt::min_lb_iter_duration << "]\n";
 476     std::clog << o("-S value")
 477               << "minimum duration between comp. iterations"
 478               << " [" << opt::min_comp_iter_duration << "]\n";
 479     std::clog << o("-d value")
 480               << "start comp. iterations after given number of lb. iter."
 481               << " [" << opt::comp_iter_delay << "]\n";
 482     std::clog << o("-D value")
 483               << "start comp. iterations after given time"
 484               << " [" << opt::comp_time_delay << "]\n";
 485
 486     std::clog << "\nComputations and communications:\n";
 487     std::clog << o("-c [aN,...]a0")
 488               << "polynomial factors for computation cost"
 489               << " [" << opt::comp_cost.to_string() << "]\n";
 490     std::clog << o("-C [aN,...]a0")
 491               << "polynomial factors for communication cost"
 492               << " [" << opt::comm_cost.to_string() << "]\n";
 493     std::clog << o("-m value")
 494               << "minimum data transfer amount"
 495               << " [" << opt::min_transfer_amount << "]\n";
 496     std::clog << o("-M value")
 497               << "maximum data transfer amount, 0 for no limit"
 498               << " [" << opt::max_transfer_amount << "]\n";
 499
 500     std::clog << "\nEnd of the simulation:\n";
 501     std::clog << o("-i value")
 502               << "maximum number of lb. iterations, 0 for no limit"
 503               << " [" << opt::lb_maxiter << "]\n";
 504     std::clog << o("-I value")
 505               << "maximum number of comp. iterations, 0 for no limit"
 506               << " [" << opt::comp_maxiter << "]\n";
 507     std::clog << o("-t value")
 508               << "time limit (simulated time), 0 for no limit"
 509               << " [" << opt::time_limit << "]\n";
 510     std::clog << o("-e") << "toggle exit on reception of \"close\" message"
 511               << " [" << opt_helper::on_off(opt::exit_on_close) << "]\n";
 512
 513     if (opt::help_requested < 3)
 514         return;
 515
 516     std::clog << "\nLogging support:\n"
 517               << "    See SimGrid documentation on:\n"
 518               << "        http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_user\n"
 519               << "    Existing categories are:\n"
 520               << "        simu : root of following categories\n"
 521               << "        main : messages from global infrastructure\n"
 522               << "        depl : messages from auto deployment (inherited from main)\n"
 523               << "        comm : messages from asynchronous pipes\n"
 524               << "        proc : messages from base process class\n"
 525               << "        loba : messages from load-balancer\n"
 526               << "        thrd : messages from thread wrapper class\n";
 527
 528     // std::clog << "\nMiscellaneous low-level parameters\n";
 529
 530 #undef so_list
 531 #undef so
 532 #undef o
 533 }
 534
 535 // Local variables:
 536 // mode: c++
 537 // End: