Use bool for return type of parse_args().

[loba.git] / options.cpp

diff --git a/options.cpp b/options.cpp
index 668aed3e044ae27c3b5df48beb392d76dd9de462..142056600f93c83bfe2ec94e1c16cefe496191f0 100644 (file)
--- a/options.cpp
+++ b/options.cpp
@@ -1,16 +1,24 @@
-#include "options.h"
-

 #include <iomanip>
 #include <iostream>
 #include <sstream>
 #include <unistd.h>             // getopt
 #include <xbt/log.h>
 #include <iomanip>
 #include <iostream>
 #include <sstream>
 #include <unistd.h>             // getopt
 #include <xbt/log.h>

-#include "loba_simple.h"

 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
 
 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(main);
 

+#include "loba_simple.h"
+#include "loba_fairstrategy.h"
+
+#include "options.h"
+

 namespace opt {
 
 namespace opt {
 

+    // Constants
+
+    // A sum of loads if considered null if it is less than
+    // load_ratio_threshold percent of the sum of loads at init.
+    const double load_ratio_threshold = 1e-4;
+

     // Global options
     std::string program_name;
     int help_requested = 0;
     // Global options
     std::string program_name;
     int help_requested = 0;


@@ -38,21 +46,22 @@ namespace opt {
     // Application parameters
     cost_func comp_cost("1e9, 0"); // fixme: find better defaults
     cost_func comm_cost("1, 0"); // fixme: find better defaults
     // Application parameters
     cost_func comp_cost("1e9, 0"); // fixme: find better defaults
     cost_func comm_cost("1, 0"); // fixme: find better defaults

-    unsigned maxiter = 4;       // fixme
+    unsigned maxiter = 10;       // fixme: find better defaults

     bool exit_on_close = false;
 
     // Named parameters lists
     loba_algorithms_type loba_algorithms;
     loba_algorithms_type::loba_algorithms_type()
     {
     bool exit_on_close = false;
 
     // Named parameters lists
     loba_algorithms_type loba_algorithms;
     loba_algorithms_type::loba_algorithms_type()
     {

-        NOL_INSERT("none", "no load-balancing (for testing)", process);
+        NOL_INSERT("fairstrategy", "balance with fair strategy", loba_fairstrategy);
+        NOL_INSERT("none", "no load-balancing (for testing only)", process);

         NOL_INSERT("simple", "balance with least loaded neighbor", loba_simple);
     }
 
     topologies_type topologies;
     topologies_type::topologies_type()
     {
         NOL_INSERT("simple", "balance with least loaded neighbor", loba_simple);
     }
 
     topologies_type topologies;
     topologies_type::topologies_type()
     {

-        NOL_INSERT("btree", "binary tree topologym intiial load at root", 
+        NOL_INSERT("btree", "binary tree topology, initial load at root",

                    deployment_btree);
         NOL_INSERT("clique", "all connected topology", deployment_clique);
         NOL_INSERT("hcube", "hypercube topology", deployment_hcube);
                    deployment_btree);
         NOL_INSERT("clique", "all connected topology", deployment_clique);
         NOL_INSERT("hcube", "hypercube topology", deployment_hcube);


@@ -66,32 +75,23 @@ namespace opt {
 
 } // namespace opt
 
 
 } // namespace opt
 

-namespace {
-
-    const char* on_off(bool b)
-    {
-        return b ? "on" : "off";
-    }
-
-}
-
-int opt::parse_args(int* argc, char* argv[])
+bool opt::parse_args(int* argc, char* argv[])

 {
 {

-    int result = 1;
+    bool result = true;

 
     opt::program_name = argv[0];
     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));
     
     int c;
     opterr = 0;
 
     opt::program_name = argv[0];
     opt::program_name.erase(0, 1 + opt::program_name.find_last_of('/'));
     
     int c;
     opterr = 0;

-    while ((c = getopt(*argc, argv, "a:bc:C:ehi:l:L:N:T:V")) != -1) {
+    while ((c = getopt(*argc, argv, "a:bc:C:ehi:l:L:N:T:vV")) != -1) {

         switch (c) {
         case 'a':
             opt::loba_algo = optarg;
             if (!opt::loba_algorithms.exists(opt::loba_algo)) {
                 ERROR1("unknownw load balancing algorithm -- %s",
                        opt::loba_algo.c_str());
         switch (c) {
         case 'a':
             opt::loba_algo = optarg;
             if (!opt::loba_algorithms.exists(opt::loba_algo)) {
                 ERROR1("unknownw load balancing algorithm -- %s",
                        opt::loba_algo.c_str());

-                result = 0;
+                result = false;

             }
             break;
         case 'b':
             }
             break;
         case 'b':


@@ -126,15 +126,19 @@ int opt::parse_args(int* argc, char* argv[])
             if (!opt::topologies.exists(opt::auto_depl::topology)) {
                 ERROR1("unknownw topology -- %s",
                        opt::auto_depl::topology.c_str());
             if (!opt::topologies.exists(opt::auto_depl::topology)) {
                 ERROR1("unknownw topology -- %s",
                        opt::auto_depl::topology.c_str());

-                result = 0;
+                result = false;

             }
             break;
             }
             break;

+        case 'v':
+            // nothing to do: this option is checked at the very
+            // beginning of main()
+            break;

         case 'V':
             opt::version_requested = true;
             break;
         case '?':
             ERROR1("invalid option -- '%c'", optopt);
         case 'V':
             opt::version_requested = true;
             break;
         case '?':
             ERROR1("invalid option -- '%c'", optopt);

-            result = 0;
+            result = false;

             break;
         }
     }
             break;
         }
     }


@@ -146,7 +150,7 @@ int opt::parse_args(int* argc, char* argv[])
         opt::platform_file = argv[optind++];
     } else {
         ERROR0("missing parameter -- <plaform_file>");
         opt::platform_file = argv[optind++];
     } else {
         ERROR0("missing parameter -- <plaform_file>");

-        result = 0;
+        result = false;

     }
     if (optind < *argc) {
         opt::deployment_file = argv[optind++];
     }
     if (optind < *argc) {
         opt::deployment_file = argv[optind++];


@@ -155,22 +159,50 @@ int opt::parse_args(int* argc, char* argv[])
 
     while (optind < *argc) {
         ERROR1("unused parameter -- \"%s\"", argv[optind++]);
 
     while (optind < *argc) {
         ERROR1("unused parameter -- \"%s\"", argv[optind++]);

-        result = 0;
+        result = false;

     }
 
     return result;
 }
 
     }
 
     return result;
 }
 

+namespace {
+
+    // some helper functions for opt::print()
+
+    const char* on_off(bool b)
+    {
+        return b ? "on" : "off";
+    }
+
+    template <typename T>
+    const char* val_or_string(const T& val, const char* str, const T& deflt = 0)
+    {
+        static std::string res;
+        if (val != deflt) {
+            std::ostringstream oss;
+            oss << val;
+            res = oss.str();
+        } else {
+            res = str;
+        }
+        return res.c_str();
+    }
+
+} // namespace
+

 void opt::print()
 {
     INFO0(",----[ Simulation parameters ]");
 void opt::print()
 {
     INFO0(",----[ Simulation parameters ]");

-    INFO1("| log rate.....................: %u",     opt::log_rate);
+    INFO1("| log rate.....................: %s",
+          val_or_string(opt::log_rate, "disabled"));

     INFO1("| platform file................: \"%s\"", opt::platform_file.c_str());
     if (opt::auto_depl::enabled) {
         INFO0("| automatic deployment enabled");
         INFO1("| - topology...................: %s", opt::auto_depl::topology.c_str());
     INFO1("| platform file................: \"%s\"", opt::platform_file.c_str());
     if (opt::auto_depl::enabled) {
         INFO0("| automatic deployment enabled");
         INFO1("| - topology...................: %s", opt::auto_depl::topology.c_str());

-        INFO1("| - number of hosts............: %u", opt::auto_depl::nhosts);
-        INFO1("| - initial load...............: %g", opt::auto_depl::load);
+        INFO1("| - number of hosts............: %s",
+              val_or_string(opt::auto_depl::nhosts, "auto"));
+        INFO1("| - initial load...............: %s",
+              val_or_string(opt::auto_depl::load, "auto"));

     } else {
         INFO1("| deployment file..............: \"%s\"", opt::deployment_file.c_str());
     }
     } else {
         INFO1("| deployment file..............: \"%s\"", opt::deployment_file.c_str());
     }


@@ -178,7 +210,8 @@ void opt::print()
     INFO1("| bookkeeping..................: %s",   on_off(opt::bookkeeping));
     INFO1("| computation cost factors.....: [%s]", opt::comp_cost.to_string().c_str());
     INFO1("| communication cost factors...: [%s]", opt::comm_cost.to_string().c_str());
     INFO1("| bookkeeping..................: %s",   on_off(opt::bookkeeping));
     INFO1("| computation cost factors.....: [%s]", opt::comp_cost.to_string().c_str());
     INFO1("| communication cost factors...: [%s]", opt::comm_cost.to_string().c_str());

-    INFO1("| maximum number of iterations.: %u",   opt::maxiter);
+    INFO1("| maximum number of iterations.: %s",
+          val_or_string(opt::maxiter, "infinity"));

     INFO1("| exit on close................: %s",   on_off(opt::exit_on_close));
     INFO0("`----");
 }
     INFO1("| exit on close................: %s",   on_off(opt::exit_on_close));
     INFO0("`----");
 }


@@ -215,6 +248,8 @@ void opt::usage()
     std::clog << o("-l value")
               << "print current load every n-th iterations, 0 to disable"
               << " (" << opt::log_rate << ")\n";
     std::clog << o("-l value")
               << "print current load every n-th 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 << o("-T name")
 
     std::clog << "\nAutomatic deployment options\n";
     std::clog << o("-T name")