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