Update BUGS.

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index c0becfde198f7347b31ff3593c95447697975077..3602fbffdccd562df03a7ff8d89337382dadb62e 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -1,3 +1,4 @@
+#include <ctime>

 #include <iomanip>
 #include <iostream>
 #include <sstream>
 #include <iomanip>
 #include <iostream>
 #include <sstream>


@@ -32,9 +33,11 @@ namespace opt {
     std::string program_name;
     int help_requested = 0;
     bool version_requested = false;
     std::string program_name;
     int help_requested = 0;
     bool version_requested = false;

+    int option_x = 0;           // hidden option, for debugging purpose

 
     // Simulation parameters
     int log_rate = 1;
 
     // Simulation parameters
     int log_rate = 1;

+    bool exit_request = false;

 
     // Platform and deployment
     std::string platform_file;
 
     // Platform and deployment
     std::string platform_file;


@@ -46,6 +49,8 @@ namespace opt {
         std::string topology("clique");
         unsigned    nhosts = 0;
         double      load = 0.0;
         std::string topology("clique");
         unsigned    nhosts = 0;
         double      load = 0.0;

+        bool        random_distribution = false;
+        unsigned long random_seed = 0;

     }
 
     // Load balancing algorithm
     }
 
     // Load balancing algorithm


@@ -206,11 +211,11 @@ bool opt::parse_args(int* argc, char* argv[])
     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));
 
 #define PARSE_ARG(x) result = opt_helper::parse_arg(c, optarg, (x)) && result
     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));
 
 #define PARSE_ARG(x) result = opt_helper::parse_arg(c, optarg, (x)) && result

-    
+

     int c;
     opterr = 0;
     while ((c = getopt(*argc, argv,
     int c;
     opterr = 0;
     while ((c = getopt(*argc, argv,

-                       "a:bc:C:d:D:ehi:I:l:L:m:M:N:s:S:t:T:vV")) != -1) {
+                       "a:bc:C:d:D:ehi:I:l:L:m:M:N:r:Rs:S:t:T:vVx:")) != -1) {

         switch (c) {
         case 'a':
             opt::loba_algo = optarg;
         switch (c) {
         case 'a':
             opt::loba_algo = optarg;


@@ -273,6 +278,13 @@ bool opt::parse_args(int* argc, char* argv[])
         case 'N':
             PARSE_ARG(opt::auto_depl::nhosts);
             break;
         case 'N':
             PARSE_ARG(opt::auto_depl::nhosts);
             break;

+        case 'r':
+            PARSE_ARG(opt::auto_depl::random_seed);
+            break;
+        case 'R':
+            opt::auto_depl::random_distribution =
+                !opt::auto_depl::random_distribution;
+            break;

         case 's':
             PARSE_ARG(opt::min_lb_iter_duration);
             break;
         case 's':
             PARSE_ARG(opt::min_lb_iter_duration);
             break;


@@ -295,6 +307,10 @@ bool opt::parse_args(int* argc, char* argv[])
         case 'V':
             opt::version_requested = true;
             break;
         case 'V':
             opt::version_requested = true;
             break;

+        case 'x':
+            PARSE_ARG(opt::option_x);
+            XBT_WARN("option_x set to %d", opt::option_x);
+            break;

         case '?':
             XBT_ERROR("invalid option -- '%c'", optopt);
             result = false;
         case '?':
             XBT_ERROR("invalid option -- '%c'", optopt);
             result = false;


@@ -329,6 +345,9 @@ bool opt::parse_args(int* argc, char* argv[])
         result = false;
     }
 
         result = false;
     }
 

+    if (!opt::auto_depl::random_seed)
+        opt::auto_depl::random_seed = time(NULL);
+

     return result;
 }
 
     return result;
 }
 


@@ -349,6 +368,10 @@ void opt::print()
                                                          "auto"));
         DESCR("- initial load", "%s", h.val_or_string(auto_depl::load,
                                                       "auto"));
                                                          "auto"));
         DESCR("- initial load", "%s", h.val_or_string(auto_depl::load,
                                                       "auto"));

+        DESCR("- random initial load distribution", "%s",
+              h.on_off(auto_depl::random_distribution));
+        DESCR("- random seed", "%s",
+              h.val_or_string(auto_depl::random_seed, "time based"));

     } else {
         DESCR("deployment file", "\"%s\"", deployment_file.c_str());
     }
     } else {
         DESCR("deployment file", "\"%s\"", deployment_file.c_str());
     }


@@ -394,8 +417,9 @@ void opt::usage()
 
     std::clog << "Usage: " << opt::program_name
               << " [options] <platform_file> [<deployment_file>]\n";
 
     std::clog << "Usage: " << opt::program_name
               << " [options] <platform_file> [<deployment_file>]\n";

+    std::clog << "Current values for the parameters are given between square brackets.\n";

 
 

-    std::clog << "\nGlobal options\n";
+    std::clog << "\nGlobal options:\n";

     std::clog << o("-h")
               << "print help and exit (use -hh or -hhh for extended help)\n";
     if (opt::help_requested < 1)
     std::clog << o("-h")
               << "print help and exit (use -hh or -hhh for extended help)\n";
     if (opt::help_requested < 1)


@@ -404,14 +428,14 @@ void opt::usage()
     std::clog << o("--help") << "print help from SimGrid framework and exit\n";
     std::clog << o("-V") << "print version and exit\n";
 
     std::clog << o("--help") << "print help from SimGrid framework and exit\n";
     std::clog << o("-V") << "print version and exit\n";
 

-    std::clog << "\nSimulation parameters\n";
+    std::clog << "\nSimulator output:\n";

     std::clog << o("-l value")
               << "print current load every n lb iterations, 0 to disable"
               << " [" << opt::log_rate << "]\n";
     std::clog << o("-v")
               << "verbose: do not override the default logging parameters\n";
 
     std::clog << o("-l value")
               << "print current load every n lb iterations, 0 to disable"
               << " [" << opt::log_rate << "]\n";
     std::clog << o("-v")
               << "verbose: do not override the default logging parameters\n";
 

-    std::clog << "\nAutomatic deployment options\n";
+    std::clog << "\nAutomatic deployment:\n";

     std::clog << o("-T name")
               << "enable automatic deployment with selected topology"
               << " [" << opt::auto_depl::topology << "]\n";
     std::clog << o("-T name")
               << "enable automatic deployment with selected topology"
               << " [" << opt::auto_depl::topology << "]\n";


@@ -423,19 +447,37 @@ void opt::usage()
     std::clog << o("-N value")
               << "number of hosts to use with auto deployment, 0 for max."
               << " [" << opt::auto_depl::nhosts << "]\n";
     std::clog << o("-N value")
               << "number of hosts to use with auto deployment, 0 for max."
               << " [" << opt::auto_depl::nhosts << "]\n";

-
-    std::clog << "\nLoad balancing algorithm\n";
+    std::clog << o("-R")
+              << "toggle random initial load distribution"
+              << " [" << opt_helper::on_off(opt::auto_depl::random_distribution)
+              << "]\n";
+    std::clog << o("-r value")
+              << "random seed, 0 for a seed based on current date"
+              << " [" << opt::auto_depl::random_seed << "]\n";
+
+    std::clog << "\nLoad balancing algorithm:\n";

     std::clog << o("-a name") << "load balancing algorithm"
               << " [" << opt::loba_algo << "]\n";
     if (opt::help_requested > 1)
         so_list(opt::loba_algorithms);
     std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
               << " [" << opt_helper::on_off(opt::bookkeeping) << "]\n";
     std::clog << o("-a name") << "load balancing algorithm"
               << " [" << opt::loba_algo << "]\n";
     if (opt::help_requested > 1)
         so_list(opt::loba_algorithms);
     std::clog << o("-b") << "toggle bookkeeping (\"virtual load\")"
               << " [" << opt_helper::on_off(opt::bookkeeping) << "]\n";

+
+    std::clog << "\nLb. and comp. iterations:\n";

     std::clog << o("-s value")
               << "minimum duration between lb. iterations"
               << " [" << opt::min_lb_iter_duration << "]\n";
     std::clog << o("-s value")
               << "minimum duration between lb. iterations"
               << " [" << opt::min_lb_iter_duration << "]\n";

+    std::clog << o("-S value")
+              << "minimum duration between comp. iterations"
+              << " [" << opt::min_comp_iter_duration << "]\n";
+    std::clog << o("-d value")
+              << "start comp. iterations after given number of lb. iter."
+              << " [" << opt::comp_iter_delay << "]\n";
+    std::clog << o("-D value")
+              << "start comp. iterations after given time"
+              << " [" << opt::comp_time_delay << "]\n";

 
 

-    std::clog << "\nApplication parameters\n";
+    std::clog << "\nComputations and communications:\n";

     std::clog << o("-c [aN,...]a0")
               << "polynomial factors for computation cost"
               << " [" << opt::comp_cost.to_string() << "]\n";
     std::clog << o("-c [aN,...]a0")
               << "polynomial factors for computation cost"
               << " [" << opt::comp_cost.to_string() << "]\n";


@@ -448,17 +490,8 @@ void opt::usage()
     std::clog << o("-M value")
               << "maximum data transfer amount, 0 for no limit"
               << " [" << opt::max_transfer_amount << "]\n";
     std::clog << o("-M value")
               << "maximum data transfer amount, 0 for no limit"
               << " [" << opt::max_transfer_amount << "]\n";

-    std::clog << o("-S value")
-              << "minimum duration between comp. iterations"
-              << " [" << opt::min_comp_iter_duration << "]\n";
-    std::clog << o("-d value")
-              << "start computations after given number of lb iterations"
-              << " [" << opt::comp_iter_delay << "]\n";
-    std::clog << o("-D value")
-              << "start computations after given time"
-              << " [" << opt::comp_time_delay << "]\n";

 
 

-    std::clog << "\nParameters for the end of the simulation\n";
+    std::clog << "\nEnd of the simulation:\n";

     std::clog << o("-i value")
               << "maximum number of lb. iterations, 0 for no limit"
               << " [" << opt::lb_maxiter << "]\n";
     std::clog << o("-i value")
               << "maximum number of lb. iterations, 0 for no limit"
               << " [" << opt::lb_maxiter << "]\n";


@@ -474,7 +507,7 @@ void opt::usage()
     if (opt::help_requested < 3)
         return;
 
     if (opt::help_requested < 3)
         return;
 

-    std::clog << "\nLogging support\n"
+    std::clog << "\nLogging support:\n"

               << "    See SimGrid documentation on:\n"
               << "        http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_user\n"
               << "    Existing categories are:\n"
               << "    See SimGrid documentation on:\n"
               << "        http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_user\n"
               << "    Existing categories are:\n"