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