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