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