options.cpp

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