options.cpp

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