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