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