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