options.cpp

   1 #include <iomanip>
   2 #include <iostream>
   3 #include <sstream>
   4 #include <unistd.h>             // getopt
   5 #include <xbt/log.h>
   6
   7 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
   8
   9 #include "loba_simple.h"
  10 #include "loba_fairstrategy.h"
  11
  12 #include "options.h"
  13
  14 namespace opt {
  15
  16     // Global options
  17     std::string program_name;
  18     int help_requested = 0;
  19     bool version_requested = false;
  20
  21     // Simulation parameters
  22     unsigned log_rate = 1;
  23
  24     // Platform and deployment
  25     std::string platform_file;
  26     std::string deployment_file;
  27
  28     // Automatic deployment
  29     namespace auto_depl {
  30         bool        enabled = false;
  31         std::string topology("clique");
  32         unsigned    nhosts = 0;
  33         double      load = 0.0;
  34     }
  35
  36     // Load balancing algorithm
  37     std::string loba_algo("simple");
  38     bool bookkeeping = false;
  39
  40     // Application parameters
  41     cost_func comp_cost("1e9, 0"); // fixme: find better defaults
  42     cost_func comm_cost("1, 0"); // fixme: find better defaults
  43     unsigned maxiter = 10;       // fixme: find better defaults
  44     bool exit_on_close = false;
  45
  46     // Named parameters lists
  47     loba_algorithms_type loba_algorithms;
  48     loba_algorithms_type::loba_algorithms_type()
  49     {
  50         NOL_INSERT("fairstrategy", "balance with fair strategy", loba_fairstrategy);
  51         NOL_INSERT("none", "no load-balancing (for testing only)", process);
  52         NOL_INSERT("simple", "balance with least loaded neighbor", loba_simple);
  53     }
  54
  55     topologies_type topologies;
  56     topologies_type::topologies_type()
  57     {
  58         NOL_INSERT("btree", "binary tree topology, initial load at root",
  59                    deployment_btree);
  60         NOL_INSERT("clique", "all connected topology", deployment_clique);
  61         NOL_INSERT("hcube", "hypercube topology", deployment_hcube);
  62         NOL_INSERT("line", "line topology, initial load at one end",
  63                    deployment_line);
  64         NOL_INSERT("ring", "ring topology", deployment_ring);
  65         NOL_INSERT("star", "star topology, initial load at center",
  66                    deployment_star);
  67         NOL_INSERT("torus", "torus topology", deployment_torus);
  68     }
  69
  70 } // namespace opt
  71
  72 int opt::parse_args(int* argc, char* argv[])
  73 {
  74     int result = 1;
  75
  76     opt::program_name = argv[0];
  77     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));
  78
  79     int c;
  80     opterr = 0;
  81     while ((c = getopt(*argc, argv, "a:bc:C:ehi:l:L:N:T:vV")) != -1) {
  82         switch (c) {
  83         case 'a':
  84             opt::loba_algo = optarg;
  85             if (!opt::loba_algorithms.exists(opt::loba_algo)) {
  86                 ERROR1("unknownw load balancing algorithm -- %s",
  87                        opt::loba_algo.c_str());
  88                 result = 0;
  89             }
  90             break;
  91         case 'b':
  92             opt::bookkeeping = true;
  93             break;
  94         case 'e':
  95             opt::exit_on_close = true;
  96             break;
  97         case 'h':
  98             opt::help_requested++;
  99             break;
 100         case 'c':
 101             opt::comp_cost = cost_func(optarg);
 102             break;
 103         case 'C':
 104             opt::comm_cost = cost_func(optarg);
 105             break;
 106         case 'i':
 107             std::istringstream(optarg) >> opt::maxiter;
 108             break;
 109         case 'l':
 110             std::istringstream(optarg) >> opt::log_rate;
 111             break;
 112         case 'L':
 113             std::istringstream(optarg) >> opt::auto_depl::load;
 114             break;
 115         case 'N':
 116             std::istringstream(optarg) >> opt::auto_depl::nhosts;
 117             break;
 118         case 'T':
 119             opt::auto_depl::topology = optarg;
 120             if (!opt::topologies.exists(opt::auto_depl::topology)) {
 121                 ERROR1("unknownw topology -- %s",
 122                        opt::auto_depl::topology.c_str());
 123                 result = 0;
 124             }
 125             break;
 126         case 'v':
 127             // nothing to do: this option is checked at the very
 128             // beginning of main()
 129             break;
 130         case 'V':
 131             opt::version_requested = true;
 132             break;
 133         case '?':
 134             ERROR1("invalid option -- '%c'", optopt);
 135             result = 0;
 136             break;
 137         }
 138     }
 139
 140     if (opt::version_requested || opt::help_requested)
 141         return 1;
 142
 143     if (optind < *argc) {
 144         opt::platform_file = argv[optind++];
 145     } else {
 146         ERROR0("missing parameter -- <plaform_file>");
 147         result = 0;
 148     }
 149     if (optind < *argc) {
 150         opt::deployment_file = argv[optind++];
 151     }
 152     opt::auto_depl::enabled = opt::deployment_file.empty();
 153
 154     while (optind < *argc) {
 155         ERROR1("unused parameter -- \"%s\"", argv[optind++]);
 156         result = 0;
 157     }
 158
 159     return result;
 160 }
 161
 162 namespace {
 163
 164     // some helper functions for opt::print()
 165
 166     const char* on_off(bool b)
 167     {
 168         return b ? "on" : "off";
 169     }
 170
 171     template <typename T>
 172     const char* val_or_string(const T& val, const char* str, const T& deflt = 0)
 173     {
 174         static std::string res;
 175         if (val != deflt) {
 176             std::ostringstream oss;
 177             oss << val;
 178             res = oss.str();
 179         } else {
 180             res = str;
 181         }
 182         return res.c_str();
 183     }
 184
 185 } // namespace
 186
 187 void opt::print()
 188 {
 189     INFO0(",----[ Simulation parameters ]");
 190     INFO1("| log rate.....................: %s",
 191           val_or_string(opt::log_rate, "disabled"));
 192     INFO1("| platform file................: \"%s\"", opt::platform_file.c_str());
 193     if (opt::auto_depl::enabled) {
 194         INFO0("| automatic deployment enabled");
 195         INFO1("| - topology...................: %s", opt::auto_depl::topology.c_str());
 196         INFO1("| - number of hosts............: %s",
 197               val_or_string(opt::auto_depl::nhosts, "auto"));
 198         INFO1("| - initial load...............: %s",
 199               val_or_string(opt::auto_depl::load, "auto"));
 200     } else {
 201         INFO1("| deployment file..............: \"%s\"", opt::deployment_file.c_str());
 202     }
 203     INFO1("| load balancing algorithm.....: %s",   opt::loba_algo.c_str());
 204     INFO1("| bookkeeping..................: %s",   on_off(opt::bookkeeping));
 205     INFO1("| computation cost factors.....: [%s]", opt::comp_cost.to_string().c_str());
 206     INFO1("| communication cost factors...: [%s]", opt::comm_cost.to_string().c_str());
 207     INFO1("| maximum number of iterations.: %s",
 208           val_or_string(opt::maxiter, "infinity"));
 209     INFO1("| exit on close................: %s",   on_off(opt::exit_on_close));
 210     INFO0("`----");
 211 }
 212
 213 void opt::usage()
 214 {
 215     // option(...)
 216 #define o(opt) "    " << std::setw(14) \
 217                       << std::left << (opt) << std::right << " "
 218     // sub-option(...)
 219 #define so(subopt) std::setw(18) << (subopt) << " : "
 220     // sub-option list
 221 #define so_list(name) do {                                      \
 222         name ## _type::iterator it;                             \
 223         for (it = name.begin() ; it != name.end() ; ++it)       \
 224             std::clog << so(name.get_name(it))                  \
 225                       << name.get_descr(it) << "\n";            \
 226     } while (0)
 227
 228
 229     std::clog << "Usage: " << opt::program_name
 230               << " [options] <platform_file> [<deployment_file>]\n";
 231
 232     std::clog << "\nGlobal options\n";
 233     std::clog << o("-h")
 234               << "print help and exit (use -hh or -hhh for extended help)\n";
 235     if (opt::help_requested < 1)
 236         return;
 237
 238     std::clog << o("--help") << "print help from SimGrid framework and exit\n";
 239     std::clog << o("-V") << "print version and exit\n";
 240
 241     std::clog << "\nSimulation parameters\n";
 242     std::clog << o("-l value")
 243               << "print current load every n-th iterations, 0 to disable"
 244               << " (" << opt::log_rate << ")\n";
 245     std::clog << o("-v")
 246               << "verbose: do not override the default logging parameters\n";
 247
 248     std::clog << "\nAutomatic deployment options\n";
 249     std::clog << o("-T name")
 250               << "enable automatic deployment with selected topology"
 251               << " (" << opt::auto_depl::topology << ")\n";
 252     if (opt::help_requested > 1)
 253         so_list(opt::topologies);
 254     std::clog << o("-L value")
 255               << "total load with auto deployment, 0 for number of hosts"
 256               << " (" << opt::auto_depl::load << ")\n";
 257     std::clog << o("-N value")
 258               << "number of hosts to use with auto deployment,"
 259               << " 0 for max. (" << opt::auto_depl::nhosts << ")\n";
 260
 261     std::clog << "\nLoad balancing algorithm\n";
 262     std::clog << o("-a name") << "load balancing algorithm"
 263               << " (" << opt::loba_algo << ")\n";
 264     if (opt::help_requested > 1)
 265         so_list(opt::loba_algorithms);
 266     std::clog << o("-b") << "enable bookkeeping\n";
 267
 268     std::clog << "\nApplication parameters\n";
 269     std::clog << o("-c [fn,...]f0")
 270               << "polynomial factors for computation cost"
 271               << " (" << opt::comp_cost.to_string() << ")\n";
 272     std::clog << o("-C [fn,...]f0")
 273               << "polynomial factors for communication cost"
 274               << " (" << opt::comm_cost.to_string() << ")\n";
 275     std::clog << o("-e") << "exit on reception of \"close\" message\n";
 276     std::clog << o("-i value")
 277               << "maximum number of iterations, 0 for infinity"
 278               << " (" << opt::maxiter << ")\n";
 279
 280     if (opt::help_requested < 3)
 281         return;
 282
 283     std::clog << "\nLogging support\n"
 284               << "    See SimGrid documentation on:\n"
 285               << "        http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_user\n"
 286               << "    Existing categories are:\n"
 287               << "        simu : root of following categories\n"
 288               << "        main : messages from global infrastructure\n"
 289               << "        depl : messages from auto deployment (inherited from main)\n"
 290               << "        comm : messages from asynchronous pipes\n"
 291               << "        proc : messages from base process class\n"
 292               << "        loba : messages from load-balancer\n";
 293
 294 #undef so_list
 295 #undef so
 296 #undef o
 297 }
 298
 299 // Local variables:
 300 // mode: c++
 301 // End: