Fix typos.

[loba.git] / process.h

diff --git a/process.h b/process.h
index c148683bca8764e145344c98d8900563f80dac1f..68dcd9b71fecc45abc4dbc9f27c51b5e07348c34 100644 (file)
--- a/process.h
+++ b/process.h
@@ -13,49 +13,86 @@
 #  define MAP_TEMPLATE std::map
 #endif
 #include <msg/msg.h>
 #  define MAP_TEMPLATE std::map
 #endif
 #include <msg/msg.h>

+#include <xbt/log.h>

 #include "communicator.h"
 #include "neighbor.h"
 
 class process {
 public:
 #include "communicator.h"
 #include "neighbor.h"
 
 class process {
 public:

+    static double get_total_load_init() { return total_load_init; }
+    static double get_total_load_exit() { return total_load_exit; }
+

     process(int argc, char* argv[]);
     process(int argc, char* argv[]);

-    ~process();
+    virtual ~process();
+

     int run();
 
 protected:
     typedef std::vector<neighbor> neigh_type;
     typedef std::vector<neighbor*> pneigh_type;
 
     int run();
 
 protected:
     typedef std::vector<neighbor> neigh_type;
     typedef std::vector<neighbor*> pneigh_type;
 

-    neigh_type neigh;
-    pneigh_type pneigh;
+    pneigh_type pneigh;         // list of pointers to neighbors that
+                                // we are free to reorder
+
+    // Returns the sum of "to_send" for all neighbors.
+    double sum_of_to_send() const;
+
+    // Calls neighbor::print(verbose, logp, cat) for each member of neigh.
+    void print_loads(bool verbose = false,
+                     e_xbt_log_priority_t logp = xbt_log_priority_info,
+                     xbt_log_category_t cat = _XBT_LOGV(default)) const;
+
+    // Calls neighbor::print(verbose, logp, cat) for each member of pneigh.
+    void print_loads_p(bool verbose = false,
+                       e_xbt_log_priority_t logp = xbt_log_priority_info,
+                       xbt_log_category_t cat = _XBT_LOGV(default)) const;

 
 private:
 
 private:

-    typedef MAP_TEMPLATE<m_host_t, neighbor*> rev_neigh_type;
+    static double total_load_init; // sum of neighbor loads at init
+    static double total_load_exit; // sum of neighbor loads at exit

 
 

-    rev_neigh_type rev_neigh;
+    typedef MAP_TEMPLATE<m_host_t, neighbor*> rev_neigh_type;
+    neigh_type neigh;           // list of neighbors (do not alter
+                                // after construction!)
+    rev_neigh_type rev_neigh;   // map m_host_t -> neighbor

 
 

-    communicator comm;
-    int ctrl_close_pending;
-    int data_close_pending;
+    communicator comm;          // communicator for this process
+    int ctrl_close_pending;     // number of "close" messages to wait
+                                // on ctrl channel
+    int data_close_pending;     // number of "close" messages to wait
+                                // on data channel

 
 

-    unsigned iter;
+    unsigned iter;              // counter of iterations

 
 

-    double load;
-    double expected_load;
+    double prev_load_broadcast; // used to ensure that we do not send
+                                // a same information messages
+    double load;                // current load
+    double expected_load;       // expected load in bookkeeping mode

 
 

-    double sum_of_to_send() const;
+    // The load balancing algorithm comes here...
+    // Parameter "my_load" is the load to take into account for myself
+    // (may be load or expected load).
+    // Returns the total load sent to neighbors.

     virtual double load_balance(double my_load);
 
     virtual double load_balance(double my_load);
 

+    // Virtually do some computation

     void compute();
     void compute();

+
+    // Send procedures, with helpers for bookkeeping mode or not

     void send1_no_bookkeeping(neighbor& nb);
     void send1_bookkeeping(neighbor& nb);
     void send();
     void send1_no_bookkeeping(neighbor& nb);
     void send1_bookkeeping(neighbor& nb);
     void send();

-    bool receive(bool wait_for_close);
+
+    // Receive procedure: wait (or not) for a message to come.
+    // Returns false if some "close" message was received, returns true
+    // otherwise.
+    enum recv_wait_mode { NO_WAIT = 0, WAIT, WAIT_FOR_CLOSE };
+    bool receive(recv_wait_mode wait);
+
+    // Finalize sends a "close" message to each neighbor and wait for
+    // all of them to answer.

     void finalize1(neighbor& nb);
     void finalize();
     void finalize1(neighbor& nb);
     void finalize();

-    void print_loads(e_xbt_log_priority_t logp = xbt_log_priority_info);
-
-    void insert_neighbor_in_map(neighbor& nb);

 };
 
 #endif // !PROCESS_H
 };
 
 #endif // !PROCESS_H