Improve documentation, move open questions in QUESTIONS file.

[loba.git] / options.h

diff --git a/options.h b/options.h
index 8125edbbc596c12a50a21ba1d484340a880da1ce..ed5b49865376017823d012a9803403d9d4c6e7ae 100644 (file)
--- a/options.h
+++ b/options.h
@@ -1,29 +1,69 @@
 #ifndef OPTIONS_H
 #define OPTIONS_H
 
 #ifndef OPTIONS_H
 #define OPTIONS_H
 

+#include <string>

 #include "cost_func.h"
 #include "cost_func.h"

+#include "named_object_list.h"
+
+// These classes may use include options.h, so make forward declarations
+class deployment_generator;
+class process;

 
 // Global parameters, shared by all the processes
 namespace opt {
 
 
 // Global parameters, shared by all the processes
 namespace opt {
 

-    extern const char* program_name;
-
-    extern const char* platform_file;
-    extern const char* application_file;
+    // Constants
+    extern const double load_ratio_threshold;

 
 

+    // Global options
+    extern std::string program_name;

     extern int help_requested;
     extern bool version_requested;
 
     extern int help_requested;
     extern bool version_requested;
 

-    extern unsigned log_rate;
+    // Simulation parameters
+    extern int log_rate;

 
 

-    extern unsigned maxiter;
-    extern bool exit_on_close;
+    // Platform and deployment
+    extern std::string platform_file;
+    extern std::string deployment_file;
+
+    // Automatic deployment
+    namespace auto_depl {
+        extern bool        enabled;
+        extern std::string topology;
+        extern unsigned    nhosts;
+        extern double      load;
+    }

 
 

+    // Load balancing algorithm
+    extern std::string loba_algo;

     extern bool bookkeeping;
 
     extern bool bookkeeping;
 

+    // Application parameters

     extern cost_func comp_cost;
     extern cost_func comp_cost;

+    extern cost_func comm_cost;
+    extern double min_lb_iter_duration;
+    extern double min_comp_iter_duration;
+
+    // Parameters for the end of the simulation
+    extern unsigned lb_maxiter;
+    extern unsigned comp_maxiter;
+    extern double time_limit;
+    extern bool exit_on_close;
+
+    // Named parameters lists
+    extern struct loba_algorithms_type:
+        public named_object_list2<process, int, char** > {
+            loba_algorithms_type();
+    } loba_algorithms;
+
+    extern struct topologies_type:
+        public named_object_list<deployment_generator> {
+            topologies_type();
+    } topologies;

 
 

-    int parse_args(int* argc, char* argv[]);
+    // Utility functions
+    bool parse_args(int* argc, char* argv[]);

     void print();
     void usage();
 
     void print();
     void usage();