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