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