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