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