]> AND Private Git Repository - loba.git/blob - options.cpp
Logo AND Algorithmique Numérique Distribuée

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