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

Private GIT Repository
Protect concurrent accesses to shared variables in process.
[loba.git] / options.cpp
1 #include <ctime>
2 #include <iomanip>
3 #include <iostream>
4 #include <sstream>
5 #include <stack>
6 #include <unistd.h>             // getopt
7 #include <xbt/log.h>
8
9 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
10
11 #include "deployment.h"
12 #include "process.h"
13 #include "loba_2besteffort.h"
14 #include "loba_besteffort.h"
15 #include "loba_bulk.h"
16 #include "loba_fairstrategy.h"
17 #include "loba_lln.h"
18 #include "loba_makhoul.h"
19 #include "loba_makhoul2.h"
20 #include "loba_makhoul3.h"
21 #include "loba_simple.h"
22 #include "misc.h"
23
24 #include "options.h"
25
26 #define DATA_DESCR_WIDTH 42
27
28 namespace opt {
29
30     // Constants
31
32     // A sum of loads if considered null if it is less than
33     // load_ratio_threshold percent of the sum of loads at init.
34     const double load_ratio_threshold = 1e-4;
35
36     // Global options
37     std::string program_name;
38     int help_requested = 0;
39     bool version_requested = false;
40     int option_x = 0;           // hidden option (int)
41     double option_X = 0.0;      // hidden option (double)
42
43     // Simulation parameters
44     int log_rate = 1;
45     volatile std::sig_atomic_t exit_request = 0;
46
47     // Platform and deployment
48     std::string platform_file;
49     std::string deployment_file;
50
51     // Automatic deployment
52     namespace auto_depl {
53         bool        enabled = false;
54         std::string topology("clique");
55         unsigned    nhosts = 0;
56         double      load = -1.0;
57         bool        random_distribution = false;
58         unsigned long random_seed = 0;
59     }
60
61     // Load balancing algorithm
62     std::string loba_algo("simple");
63     bool bookkeeping = false;
64     bool egocentric = false;
65     double min_lb_iter_duration = 1.0;          // fixme: find better defaults
66     double min_transfer_amount = 0.0;
67     double max_transfer_amount = 0.0;
68     bool integer_transfer = false;
69     unsigned loba_best_divisor = 1;
70
71     // Application parameters
72     cost_func comp_cost("1e9, 0");              // fixme: find better defaults
73     cost_func comm_cost("1e6, 0");              // fixme: find better defaults
74     double min_comp_iter_duration = 1.0;        // fixme: find better defaults
75     unsigned comp_iter_delay = 0;               // fixme: find better defaults
76     double comp_time_delay = 0.0;               // fixme: find better defaults
77
78     // Parameters for the end of the simulation
79     double avg_load_ratio = 0.0;
80     unsigned lb_maxiter = 0;
81     unsigned comp_maxiter = 0;
82     double time_limit = 0;
83     bool exit_on_close = true;
84
85     // Named parameters lists
86     loba_algorithms_type loba_algorithms;
87     loba_algorithms_type::loba_algorithms_type()
88     {
89         NOL_INSERT("2besteffort", "balance with best effort strategy (take #2)",
90                    loba_2besteffort);
91         NOL_INSERT("besteffort", "balance with best effort strategy",
92                    loba_besteffort);
93         NOL_INSERT("bulk", "a multi-load-units assignation rule without ordering...",
94                    loba_bulk);
95         NOL_INSERT("fairstrategy", "balance with fair strategy",
96                    loba_fairstrategy);
97         NOL_INSERT("lln", "balance with less loaded neighbors without ordering-bulk method",
98                    loba_lln);
99         NOL_INSERT("makhoul", "balance with Makhoul's PhD algorithm",
100                    loba_makhoul);
101         NOL_INSERT("makhoul2", "balance with Makhoul's source code",
102                    loba_makhoul2);
103         NOL_INSERT("makhoul3", "variation on Makhoul's algorithm",
104                    loba_makhoul3);
105         NOL_INSERT("none", "no load-balancing (for testing only)",
106                    process);
107         NOL_INSERT("simple", "balance with least loaded neighbor",
108                    loba_simple);
109     }
110
111     topologies_type topologies;
112     topologies_type::topologies_type()
113     {
114         NOL_INSERT("btree", "binary tree topology, initial load at root",
115                    deployment_btree);
116         NOL_INSERT("clique", "all connected topology", deployment_clique);
117         NOL_INSERT("hcube", "hypercube topology", deployment_hcube);
118         NOL_INSERT("line", "line topology, initial load at one end",
119                    deployment_line);
120         NOL_INSERT("ring", "ring topology", deployment_ring);
121         NOL_INSERT("star", "star topology, initial load at center",
122                    deployment_star);
123         NOL_INSERT("torus", "torus topology", deployment_torus);
124     }
125
126 } // namespace opt
127
128 namespace {
129
130     // local helper class
131     class opt_helper {
132     public:
133         template <typename T>
134         static bool parse_arg(char opt, const char *arg, T& val);
135         static const char* on_off(bool b);
136         const char* descr(const char* str);
137         template <typename T>
138         const char* val_or_string(const T& val, const char* str,
139                                   const T& deflt = 0);
140         template <typename T>
141         static bool nol_find_prefix(const T& nol, const char* descr,
142                                     std::string& name);
143
144     private:
145         std::string descr_str;
146         std::string val_or_string_str;
147     };
148
149 } // namespace
150
151 template <typename T>
152 bool opt_helper::parse_arg(char opt, const char *arg, T& val)
153 {
154     std::istringstream str(arg);
155     bool result = (str >> val) && str.eof();
156     if (!result)
157         XBT_ERROR("invalid argument for option '-%c' -- \"%s\"", opt, arg);
158     return result;
159 }
160
161 const char* opt_helper::on_off(bool b)
162 {
163     return b ? "on" : "off";
164 }
165
166 const char* opt_helper::descr(const char* str)
167 {
168     std::string& res = descr_str;
169     res = str;
170     res.resize(DATA_DESCR_WIDTH, '.');
171     return res.c_str();
172 }
173
174 template <typename T>
175 const char* opt_helper::val_or_string(const T& val, const char* str,
176                                       const T& deflt)
177 {
178     std::string& res = val_or_string_str;
179     if (val != deflt) {
180         std::ostringstream oss;
181         oss << val;
182         res = oss.str();
183     } else {
184         res = str;
185     }
186     return res.c_str();
187 }
188
189 template <typename T>
190 bool opt_helper::nol_find_prefix(const T& nol, const char* descr,
191                                  std::string& name)
192 {
193     bool result = nol.exists(name);
194     if (!result) {
195         std::stack<std::string> candidates;
196         for (typename T::iterator it = nol.begin() ; it != nol.end() ; ++it) {
197             const std::string& fullname = nol.get_name(it);
198             if (fullname.compare(0, name.length(), name) == 0)
199                 candidates.push(fullname);
200         }
201         switch (candidates.size()) {
202         case 0:
203             XBT_ERROR("unknownw %s -- %s", descr, name.c_str());
204             break;
205         case 1:
206             name = candidates.top();
207             candidates.pop();
208             result = true;
209             XBT_DEBUG("infered %s -- %s", descr, name.c_str());
210             break;
211         default:
212             XBT_ERROR("ambiguous %s -- %s", descr, name.c_str());
213             while (!candidates.empty()) {
214                 XBT_ERROR("  candidates are -- %s", candidates.top().c_str());
215                 candidates.pop();
216             }
217             break;
218         }
219     }
220     return result;
221 }
222
223 bool opt::parse_args(int* argc, char* argv[])
224 {
225     bool result = true;
226
227     opt::program_name = argv[0];
228     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));
229
230 #define PARSE_ARG(x) result = opt_helper::parse_arg(c, optarg, (x)) && result
231
232     int c;
233     opterr = 0;
234     while ((c = getopt(*argc, argv,
235                        "%:"
236                        "a:bc:C:d:D:eEhi:I:k:l:L:m:M:N:r:Rs:S:t:T:vVx:X:Z"))
237            != -1) {
238         switch (c) {
239         case '%':
240             PARSE_ARG(opt::avg_load_ratio);
241             break;
242         case 'a':
243             opt::loba_algo = optarg;
244             result = opt_helper::nol_find_prefix(opt::loba_algorithms,
245                                                  "load balancing algorithm",
246                                                  opt::loba_algo)
247                 && result;
248             break;
249         case 'b':
250             opt::bookkeeping = !opt::bookkeeping;
251             break;
252         case 'c':
253             try {
254                 opt::comp_cost = cost_func(optarg);
255             } catch (...) {
256                 XBT_ERROR("invalid argument for option '-%c' -- \"%s\"",
257                           c, optarg);
258                 result = false;
259             }
260             break;
261         case 'C':
262             try {
263                 opt::comm_cost = cost_func(optarg);
264             } catch (...) {
265                 XBT_ERROR("invalid argument for option '-%c' -- \"%s\"",
266                           c, optarg);
267                 result = false;
268             }
269             break;
270         case 'd':
271             PARSE_ARG(opt::comp_iter_delay);
272             break;
273         case 'D':
274             PARSE_ARG(opt::comp_time_delay);
275             break;
276         case 'e':
277             opt::exit_on_close = !opt::exit_on_close;
278             break;
279         case 'E':
280             opt::egocentric = !opt::egocentric;
281             break;
282         case 'h':
283             opt::help_requested++;
284             break;
285         case 'i':
286             PARSE_ARG(opt::lb_maxiter);
287             break;
288         case 'k':
289             PARSE_ARG(opt::loba_best_divisor);
290             break;
291         case 'I':
292             PARSE_ARG(opt::comp_maxiter);
293             break;
294         case 'l':
295             PARSE_ARG(opt::log_rate);
296             break;
297         case 'L':
298             PARSE_ARG(opt::auto_depl::load);
299             break;
300         case 'm':
301             PARSE_ARG(opt::min_transfer_amount);
302             break;
303         case 'M':
304             PARSE_ARG(opt::max_transfer_amount);
305             break;
306         case 'N':
307             PARSE_ARG(opt::auto_depl::nhosts);
308             break;
309         case 'r':
310             PARSE_ARG(opt::auto_depl::random_seed);
311             break;
312         case 'R':
313             opt::auto_depl::random_distribution =
314                 !opt::auto_depl::random_distribution;
315             break;
316         case 's':
317             PARSE_ARG(opt::min_lb_iter_duration);
318             break;
319         case 'S':
320             PARSE_ARG(opt::min_comp_iter_duration);
321             break;
322         case 't':
323             PARSE_ARG(opt::time_limit);
324             break;
325         case 'T':
326             opt::auto_depl::topology = optarg;
327             result = opt_helper::nol_find_prefix(opt::topologies, "topology",
328                                                  opt::auto_depl::topology)
329                 && result;
330             break;
331         case 'v':
332             // nothing to do: this option is checked at the very
333             // beginning of main()
334             break;
335         case 'V':
336             opt::version_requested = true;
337             break;
338         case 'x':
339             PARSE_ARG(opt::option_x);
340             XBT_WARN("option_x set to %d", opt::option_x);
341             break;
342         case 'X':
343             PARSE_ARG(opt::option_X);
344             XBT_WARN("option_X set to %g", opt::option_X);
345             break;
346         case 'Z':
347             opt::integer_transfer = !opt::integer_transfer;
348             break;
349         case '?':
350             XBT_ERROR("invalid option -- '%c'", optopt);
351             result = false;
352             break;
353         }
354     }
355
356 #undef PARSE_ARG
357
358     if (opt::option_x) {        // FIXME: remove this one day...
359         opt::loba_best_divisor = opt::option_x;
360         XBT_WARN("divisor for algorithms *best* set from option -x (%d => %u),"
361                  " use -k instead",
362                  opt::option_x, opt::loba_best_divisor);
363     }
364
365     if (opt::version_requested || opt::help_requested)
366         return 1;
367
368     if (optind < *argc) {
369         opt::platform_file = argv[optind++];
370     } else {
371         XBT_ERROR("missing parameter -- <plaform_file>");
372         result = false;
373     }
374     if (optind < *argc) {
375         opt::deployment_file = argv[optind++];
376     }
377     opt::auto_depl::enabled = opt::deployment_file.empty();
378
379     while (optind < *argc) {
380         XBT_ERROR("unused parameter -- \"%s\"", argv[optind++]);
381         result = false;
382     }
383
384     if (opt::max_transfer_amount &&
385         opt::max_transfer_amount < opt::min_transfer_amount) {
386         XBT_ERROR("max. data transfer amount (%g) <"
387                   " min. data transfer amount (%g)",
388                   opt::max_transfer_amount, opt::min_transfer_amount);
389         result = false;
390     }
391
392     if (opt::loba_best_divisor <= 0) {
393         XBT_ERROR("divisor for algorithms *best* (%u) should be positive",
394                   opt::loba_best_divisor);
395         result = false;
396     }
397
398     if (!opt::auto_depl::random_seed)
399         opt::auto_depl::random_seed = time(NULL);
400
401     return result;
402 }
403
404 void opt::print()
405 {
406     opt_helper h;
407
408 #define DESCR(description, format, value) \
409     XBT_INFO("| %s: " format, h.descr(description), value)
410
411     XBT_INFO(",----[ Simulation parameters ]");
412     DESCR("log rate", "%s", h.val_or_string(log_rate, "disabled"));
413     DESCR("platform file", "\"%s\"", platform_file.c_str());
414     if (auto_depl::enabled) {
415         XBT_INFO("| automatic deployment enabled");
416         DESCR("- topology", "%s", auto_depl::topology.c_str());
417         DESCR("- number of hosts", "%s", h.val_or_string(auto_depl::nhosts,
418                                                          "auto"));
419         if (auto_depl::load < 0.0)
420             DESCR("- initial load (average)", "%g", -auto_depl::load);
421         else
422             DESCR("- initial load (total)", "%g", auto_depl::load);
423         DESCR("- random initial load distribution", "%s",
424               h.on_off(auto_depl::random_distribution));
425         DESCR("- random seed", "%s", // NOTE: cannot be 0 here anymore
426               h.val_or_string(auto_depl::random_seed, "constant random", 1UL));
427     } else {
428         DESCR("deployment file", "\"%s\"", deployment_file.c_str());
429     }
430     DESCR("load balancing algorithm", "%s", loba_algo.c_str());
431     DESCR("bookkeeping", "%s", h.on_off(bookkeeping));
432     DESCR("egocentric mode", "%s", h.on_off(egocentric));
433     DESCR("computation cost factors", "[%s]", comp_cost.to_string().c_str());
434     DESCR("communication cost factors", "[%s]", comm_cost.to_string().c_str());
435     DESCR("minimum data transfer amount", "%g", min_transfer_amount);
436     DESCR("maximum data transfer amount", "%s",
437           h.val_or_string(max_transfer_amount, "no limit"));
438     DESCR("only transfer integer data shares", "%s",
439           h.on_off(integer_transfer));
440     DESCR("divisor for algorithms *best*", "%u", loba_best_divisor);
441     DESCR("minimum duration between lb. iterations", "%g",
442           min_lb_iter_duration);
443     DESCR("minimum duration between comp. iterations", "%g",
444           min_comp_iter_duration);
445     DESCR("computations start after lb. iter", "%u", comp_iter_delay);
446     DESCR("computations start after time", "%g", comp_time_delay);
447     DESCR("maximum number of lb. iterations", "%s",
448           h.val_or_string(lb_maxiter, "no limit"));
449     DESCR("maximum number of comp. iterations", "%s",
450           h.val_or_string(comp_maxiter, "no limit"));
451     DESCR("convergence is assumed within (\%)", "%g", opt::avg_load_ratio);
452     DESCR("time limit", "%s", h.val_or_string(time_limit, "no limit"));
453     DESCR("exit on close", "%s", h.on_off(exit_on_close));
454     XBT_INFO("`----");
455
456 #undef DESCR
457 }
458
459 void opt::usage()
460 {
461     // option(...)
462 #define o(opt) "    " << std::setw(14) \
463                       << std::left << (opt) << std::right << " "
464     // sub-option(...)
465 #define so(subopt) std::setw(18) << (subopt) << " : "
466     // sub-option list
467 #define so_list(name) do {                                      \
468         name ## _type::iterator it;                             \
469         for (it = name.begin() ; it != name.end() ; ++it)       \
470             std::clog << so(name.get_name(it))                  \
471                       << name.get_descr(it) << "\n";            \
472     } while (0)
473
474
475     std::clog << "Usage: " << opt::program_name
476               << " [options] <platform_file> [<deployment_file>]\n";
477     std::clog << "Current values for the parameters are given between square brackets.\n";
478
479     std::clog << "\nGlobal options:\n";
480     std::clog << o("-h")
481               << "print help and exit (use -hh or -hhh for extended help)\n";
482     if (opt::help_requested < 1)
483         return;
484
485     std::clog << o("--help") << "print help from SimGrid framework and exit\n";
486     std::clog << o("-V") << "print version and exit\n";
487
488     std::clog << "\nSimulator output:\n";
489     std::clog << o("-l value")
490               << "print current load every n lb iterations, 0 to disable"
491               << " [" << opt::log_rate << "]\n";
492     std::clog << o("-v")
493               << "verbose: do not override the default logging parameters\n";
494
495     std::clog << "\nAutomatic deployment:\n";
496     std::clog << o("-T name")
497               << "enable automatic deployment with selected topology"
498               << " [" << opt::auto_depl::topology << "]\n";
499     if (opt::help_requested > 1)
500         so_list(opt::topologies);
501     std::clog << o("-L value")
502               << "total load with auto deployment, average if negative"
503               << " [" << opt::auto_depl::load << "]\n";
504     std::clog << o("-N value")
505               << "number of hosts to use with auto deployment, 0 for max."
506               << " [" << opt::auto_depl::nhosts << "]\n";
507     std::clog << o("-R")
508               << "toggle random initial load distribution"
509               << " [" << opt_helper::on_off(opt::auto_depl::random_distribution)
510               << "]\n";
511     std::clog << o("-r value")
512               << "random seed for initial load distribution, or 0, or 1"
513               << " [" << opt::auto_depl::random_seed << "]\n";
514     if (opt::help_requested > 1)
515         std::clog << o("") << "- use 0 for a seed based on current date\n"
516                   << o("") << "- use 1 for a constant random\n";
517
518     std::clog << "\nLoad balancing algorithm:\n";
519     std::clog << o("-a name") << "load balancing algorithm"
520               << " [" << opt::loba_algo << "]\n";
521     if (opt::help_requested > 1)
522         so_list(opt::loba_algorithms);
523     std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
524               << " [" << opt_helper::on_off(opt::bookkeeping) << "]\n";
525     std::clog << o("-E") << "toggle egocentric mode when bookkeeping"
526               << " [" << opt_helper::on_off(opt::egocentric) << "]\n";
527     if (opt::help_requested > 1)
528         std::clog << o("")
529                   << "(a not so good idea introduced by git commit f5336c5)\n";
530     std::clog << o("-k value") << "divisor for algorithms *best*"
531               << " [" << opt::loba_best_divisor << "]\n";
532
533     std::clog << "\nLb. and comp. iterations:\n";
534     std::clog << o("-s value")
535               << "minimum duration between lb. iterations"
536               << " [" << opt::min_lb_iter_duration << "]\n";
537     std::clog << o("-S value")
538               << "minimum duration between comp. iterations"
539               << " [" << opt::min_comp_iter_duration << "]\n";
540     std::clog << o("-d value")
541               << "start comp. iterations after given number of lb. iter."
542               << " [" << opt::comp_iter_delay << "]\n";
543     std::clog << o("-D value")
544               << "start comp. iterations after given time"
545               << " [" << opt::comp_time_delay << "]\n";
546
547     std::clog << "\nComputations and communications:\n";
548     std::clog << o("-c [aN,...]a0")
549               << "polynomial factors for computation cost"
550               << " [" << opt::comp_cost.to_string() << "]\n";
551     std::clog << o("-C [aN,...]a0")
552               << "polynomial factors for communication cost"
553               << " [" << opt::comm_cost.to_string() << "]\n";
554     std::clog << o("-m value")
555               << "minimum data transfer amount"
556               << " [" << opt::min_transfer_amount << "]\n";
557     std::clog << o("-M value")
558               << "maximum data transfer amount, 0 for no limit"
559               << " [" << opt::max_transfer_amount << "]\n";
560     std::clog << o("-Z")
561               << "toggle transfer of integer data shares only"
562               << " [" << opt_helper::on_off(opt::integer_transfer) << "]\n";
563
564     std::clog << "\nEnd of the simulation:\n";
565     std::clog << o("-i value")
566               << "maximum number of lb. iterations, 0 for no limit"
567               << " [" << opt::lb_maxiter << "]\n";
568     std::clog << o("-I value")
569               << "maximum number of comp. iterations, 0 for no limit"
570               << " [" << opt::comp_maxiter << "]\n";
571     std::clog << o("-% value")
572               << "percent of the load average to assume the convergence"
573               << " [" << opt::avg_load_ratio << "]\n";
574     std::clog << o("-t value")
575               << "time limit (simulated time), 0 for no limit"
576               << " [" << opt::time_limit << "]\n";
577     std::clog << o("-e") << "toggle exit on reception of \"close\" message"
578               << " [" << opt_helper::on_off(opt::exit_on_close) << "]\n";
579
580     if (opt::help_requested < 3)
581         return;
582
583     std::clog << "\nHidden options:\n";
584     std::clog << o("-x value") << "value is an integer"
585               << " [" << opt::option_x << "]\n";
586     std::clog << o("-X value") << "value is a real number"
587               << " [" << opt::option_X << "]\n";
588
589     std::clog << "\nLogging support:\n"
590               << "    See SimGrid documentation on:\n"
591               << "        http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_user\n"
592               << "    Existing categories are:\n"
593               << "        simu : root of following categories\n"
594               << "        main : messages from global infrastructure\n"
595               << "        depl : messages from auto deployment (inherited from main)\n"
596               << "        comm : messages from asynchronous pipes\n"
597               << "        proc : messages from base process class\n"
598               << "        loba : messages from load-balancer\n"
599               << "        thrd : messages from thread wrapper class\n";
600
601     // std::clog << "\nMiscellaneous low-level parameters\n";
602
603 #undef so_list
604 #undef so
605 #undef o
606 }
607
608 // Local variables:
609 // mode: c++
610 // End: