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;
  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("line", "line topology, initial load at one end",
  56                    deployment_line);
  57         NOL_INSERT("ring", "ring topology", deployment_ring);
  58         NOL_INSERT("star", "star topology, initial load at center",
  59                    deployment_star);
  60         NOL_INSERT("clique", "all connected topology", deployment_clique);
  61         NOL_INSERT("btree", "binary tree topologym intiial load at root",
  62                    deployment_btree);
  63         // NOL_INSERT("torus", "torus topology", deployment_torus);
  64         NOL_INSERT("hcube", "hypercube topology", deployment_hcube);
  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     opt::auto_depl::enabled = !opt::auto_depl::topology.empty();
 142
 143     if (opt::version_requested || opt::help_requested)
 144         return 1;
 145
 146     if (optind < *argc) {
 147         opt::platform_file = argv[optind++];
 148     } else {
 149         ERROR0("missing parameter -- <plaform_file>");
 150         result = 0;
 151     }
 152     if (!opt::auto_depl::enabled) {
 153         if (optind < *argc) {
 154             opt::deployment_file = argv[optind++];
 155         } else {
 156             ERROR0("missing parameter -- <deployment_file>");
 157             result = 0;
 158         }
 159     }
 160
 161     while (optind < *argc) {
 162         ERROR1("unused parameter -- \"%s\"", argv[optind++]);
 163         result = 0;
 164     }
 165
 166     return result;
 167 }
 168
 169 void opt::print()
 170 {
 171     INFO0(",----[ Simulation parameters ]");
 172     INFO1("| log rate.....................: %u",     opt::log_rate);
 173     INFO1("| platform file................: \"%s\"", opt::platform_file.c_str());
 174     if (opt::auto_depl::enabled) {
 175         INFO0("| automatic deployment enabled");
 176         INFO1("| - topology...................: %s", opt::auto_depl::topology.c_str());
 177         INFO1("| - number of hosts............: %u", opt::auto_depl::nhosts);
 178         INFO1("| - initial load...............: %g", opt::auto_depl::load);
 179     } else {
 180         INFO1("| deployment file..............: \"%s\"", opt::deployment_file.c_str());
 181     }
 182     INFO1("| load balancing algorithm.....: %s",   opt::loba_algo.c_str());
 183     INFO1("| bookkeeping..................: %s",   on_off(opt::bookkeeping));
 184     INFO1("| computation cost factors.....: [%s]", opt::comp_cost.to_string().c_str());
 185     INFO1("| communication cost factors...: [%s]", opt::comm_cost.to_string().c_str());
 186     INFO1("| maximum number of iterations.: %u",   opt::maxiter);
 187     INFO1("| exit on close................: %s",   on_off(opt::exit_on_close));
 188     INFO0("`----");
 189 }
 190
 191 void opt::usage()
 192 {
 193     // option(...)
 194 #define o(opt) "    " << std::setw(14) \
 195                       << std::left << (opt) << std::right << " "
 196     // sub-option(...)
 197 #define so(subopt) std::setw(18) << (subopt) << " : "
 198     // sub-option list
 199 #define so_list(name) do {                                      \
 200         name ## _type::iterator it;                             \
 201         for (it = name.begin() ; it != name.end() ; ++it)       \
 202             std::clog << so(name.get_name(it))                  \
 203                       << name.get_descr(it) << "\n";            \
 204     } while (0)
 205
 206
 207     std::clog << "Usage: " << opt::program_name
 208               << " [options] <platform_file> <deployment_file>\n";
 209     std::clog << "       " << opt::program_name
 210               << " [options] -T type <platform_file>\n";
 211
 212     std::clog << "\nGlobal options\n";
 213     std::clog << o("-h")
 214               << "print help and exit (use -hh for extended help)\n";
 215     if (opt::help_requested < 1)
 216         return;
 217
 218     std::clog << o("--help") << "print help from SimGrid framework and exit\n";
 219     std::clog << o("-V") << "print version and exit\n";
 220
 221     std::clog << "\nSimulation parameters\n";
 222     std::clog << o("-l value")
 223               << "print current load every n-th iterations, 0 to disable"
 224               << " (" << opt::log_rate << ")\n";
 225
 226     std::clog << "\nAutomatic deployment options\n";
 227     std::clog << o("-T name")
 228               << "enable automatic deployment with selected topology\n";
 229     if (opt::help_requested > 1)
 230         so_list(opt::topologies);
 231     std::clog << o("-L value")
 232               << "total load with auto deployment, 0 for number of hosts"
 233               << " (" << opt::auto_depl::load << ")\n";
 234     std::clog << o("-N value")
 235               << "number of hosts to use with auto deployment,"
 236               << " 0 for max. (" << opt::auto_depl::nhosts << ")\n";
 237
 238     std::clog << "\nLoad balancing algorithm\n";
 239     std::clog << o("-a name") << "load balancing algorithm"
 240               << " (" << opt::loba_algo << ")\n";
 241     if (opt::help_requested > 1)
 242         so_list(opt::loba_algorithms);
 243     std::clog << o("-b") << "enable bookkeeping\n";
 244
 245     std::clog << "\nApplication parameters\n";
 246     std::clog << o("-c [fn,...]f0")
 247               << "polynomial factors for computation cost"
 248               << " (" << opt::comp_cost.to_string() << ")\n";
 249     std::clog << o("-C [fn,...]f0")
 250               << "polynomial factors for communication cost"
 251               << " (" << opt::comm_cost.to_string() << ")\n";
 252     std::clog << o("-e") << "exit on reception of \"close\" message\n";
 253     std::clog << o("-i value")
 254               << "maximum number of iterations, 0 for infinity"
 255               << " (" << opt::maxiter << ")\n";
 256
 257 #undef so_list
 258 #undef so
 259 #undef o
 260 }
 261
 262 // Local variables:
 263 // mode: c++
 264 // End: