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 = 4;       // fixme
  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 namespace {
  70
  71     const char* on_off(bool b)
  72     {
  73         return b ? "on" : "off";
  74     }
  75
  76 }
  77
  78 int opt::parse_args(int* argc, char* argv[])
  79 {
  80     int result = 1;
  81
  82     opt::program_name = argv[0];
  83     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));
  84
  85     int c;
  86     opterr = 0;
  87     while ((c = getopt(*argc, argv, "a:bc:C:ehi:l:L:N:T:V")) != -1) {
  88         switch (c) {
  89         case 'a':
  90             opt::loba_algo = optarg;
  91             if (!opt::loba_algorithms.exists(opt::loba_algo)) {
  92                 ERROR1("unknownw load balancing algorithm -- %s",
  93                        opt::loba_algo.c_str());
  94                 result = 0;
  95             }
  96             break;
  97         case 'b':
  98             opt::bookkeeping = true;
  99             break;
 100         case 'e':
 101             opt::exit_on_close = true;
 102             break;
 103         case 'h':
 104             opt::help_requested++;
 105             break;
 106         case 'c':
 107             opt::comp_cost = cost_func(optarg);
 108             break;
 109         case 'C':
 110             opt::comm_cost = cost_func(optarg);
 111             break;
 112         case 'i':
 113             std::istringstream(optarg) >> opt::maxiter;
 114             break;
 115         case 'l':
 116             std::istringstream(optarg) >> opt::log_rate;
 117             break;
 118         case 'L':
 119             std::istringstream(optarg) >> opt::auto_depl::load;
 120             break;
 121         case 'N':
 122             std::istringstream(optarg) >> opt::auto_depl::nhosts;
 123             break;
 124         case 'T':
 125             opt::auto_depl::topology = optarg;
 126             if (!opt::topologies.exists(opt::auto_depl::topology)) {
 127                 ERROR1("unknownw topology -- %s",
 128                        opt::auto_depl::topology.c_str());
 129                 result = 0;
 130             }
 131             break;
 132         case 'V':
 133             opt::version_requested = true;
 134             break;
 135         case '?':
 136             ERROR1("invalid option -- '%c'", optopt);
 137             result = 0;
 138             break;
 139         }
 140     }
 141
 142     if (opt::version_requested || opt::help_requested)
 143         return 1;
 144
 145     if (optind < *argc) {
 146         opt::platform_file = argv[optind++];
 147     } else {
 148         ERROR0("missing parameter -- <plaform_file>");
 149         result = 0;
 150     }
 151     if (optind < *argc) {
 152         opt::deployment_file = argv[optind++];
 153     }
 154     opt::auto_depl::enabled = opt::deployment_file.empty();
 155
 156     while (optind < *argc) {
 157         ERROR1("unused parameter -- \"%s\"", argv[optind++]);
 158         result = 0;
 159     }
 160
 161     return result;
 162 }
 163
 164 void opt::print()
 165 {
 166     INFO0(",----[ Simulation parameters ]");
 167     INFO1("| log rate.....................: %u",     opt::log_rate);
 168     INFO1("| platform file................: \"%s\"", opt::platform_file.c_str());
 169     if (opt::auto_depl::enabled) {
 170         INFO0("| automatic deployment enabled");
 171         INFO1("| - topology...................: %s", opt::auto_depl::topology.c_str());
 172         INFO1("| - number of hosts............: %u", opt::auto_depl::nhosts);
 173         INFO1("| - initial load...............: %g", opt::auto_depl::load);
 174     } else {
 175         INFO1("| deployment file..............: \"%s\"", opt::deployment_file.c_str());
 176     }
 177     INFO1("| load balancing algorithm.....: %s",   opt::loba_algo.c_str());
 178     INFO1("| bookkeeping..................: %s",   on_off(opt::bookkeeping));
 179     INFO1("| computation cost factors.....: [%s]", opt::comp_cost.to_string().c_str());
 180     INFO1("| communication cost factors...: [%s]", opt::comm_cost.to_string().c_str());
 181     INFO1("| maximum number of iterations.: %u",   opt::maxiter);
 182     INFO1("| exit on close................: %s",   on_off(opt::exit_on_close));
 183     INFO0("`----");
 184 }
 185
 186 void opt::usage()
 187 {
 188     // option(...)
 189 #define o(opt) "    " << std::setw(14) \
 190                       << std::left << (opt) << std::right << " "
 191     // sub-option(...)
 192 #define so(subopt) std::setw(18) << (subopt) << " : "
 193     // sub-option list
 194 #define so_list(name) do {                                      \
 195         name ## _type::iterator it;                             \
 196         for (it = name.begin() ; it != name.end() ; ++it)       \
 197             std::clog << so(name.get_name(it))                  \
 198                       << name.get_descr(it) << "\n";            \
 199     } while (0)
 200
 201
 202     std::clog << "Usage: " << opt::program_name
 203               << " [options] <platform_file> [<deployment_file>]\n";
 204
 205     std::clog << "\nGlobal options\n";
 206     std::clog << o("-h")
 207               << "print help and exit (use -hh or -hhh for extended help)\n";
 208     if (opt::help_requested < 1)
 209         return;
 210
 211     std::clog << o("--help") << "print help from SimGrid framework and exit\n";
 212     std::clog << o("-V") << "print version and exit\n";
 213
 214     std::clog << "\nSimulation parameters\n";
 215     std::clog << o("-l value")
 216               << "print current load every n-th iterations, 0 to disable"
 217               << " (" << opt::log_rate << ")\n";
 218
 219     std::clog << "\nAutomatic deployment options\n";
 220     std::clog << o("-T name")
 221               << "enable automatic deployment with selected topology"
 222               << " (" << opt::auto_depl::topology << ")\n";
 223     if (opt::help_requested > 1)
 224         so_list(opt::topologies);
 225     std::clog << o("-L value")
 226               << "total load with auto deployment, 0 for number of hosts"
 227               << " (" << opt::auto_depl::load << ")\n";
 228     std::clog << o("-N value")
 229               << "number of hosts to use with auto deployment,"
 230               << " 0 for max. (" << opt::auto_depl::nhosts << ")\n";
 231
 232     std::clog << "\nLoad balancing algorithm\n";
 233     std::clog << o("-a name") << "load balancing algorithm"
 234               << " (" << opt::loba_algo << ")\n";
 235     if (opt::help_requested > 1)
 236         so_list(opt::loba_algorithms);
 237     std::clog << o("-b") << "enable bookkeeping\n";
 238
 239     std::clog << "\nApplication parameters\n";
 240     std::clog << o("-c [fn,...]f0")
 241               << "polynomial factors for computation cost"
 242               << " (" << opt::comp_cost.to_string() << ")\n";
 243     std::clog << o("-C [fn,...]f0")
 244               << "polynomial factors for communication cost"
 245               << " (" << opt::comm_cost.to_string() << ")\n";
 246     std::clog << o("-e") << "exit on reception of \"close\" message\n";
 247     std::clog << o("-i value")
 248               << "maximum number of iterations, 0 for infinity"
 249               << " (" << opt::maxiter << ")\n";
 250
 251     if (opt::help_requested < 3)
 252         return;
 253
 254     std::clog << "\nLogging support\n"
 255               << "    See SimGrid documentation on:\n"
 256               << "        http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_user\n"
 257               << "    Existing categories are:\n"
 258               << "        simu : root of following categories\n"
 259               << "        main : messages from global infrastructure\n"
 260               << "        depl : messages from auto deployment (inherited from main)\n"
 261               << "        comm : messages from asynchronous pipes\n"
 262               << "        proc : messages from base process class\n"
 263               << "        loba : messages from load-balancer\n";
 264
 265 #undef so_list
 266 #undef so
 267 #undef o
 268 }
 269
 270 // Local variables:
 271 // mode: c++
 272 // End: