Add more documentation.

[loba.git] / process.h

diff --git a/process.h b/process.h
index aa1e032122e18545ce45d3d20ef4735ada3583a0..268fac9a2902641225f3145bf9cd3f30283f1aaa 100644 (file)
--- a/process.h
+++ b/process.h
@@ -1,24 +1,83 @@
 #ifndef PROCESS_H
 #define PROCESS_H
 
 #ifndef PROCESS_H
 #define PROCESS_H
 

+#define USE_UNORDERED_MAP 1
+//#undef USE_UNORDERED_MAP
+

 #include <vector>
 #include <vector>

-#include <xbt/log.h>
+#ifdef USE_UNORDERED_MAP
+#  include <tr1/unordered_map>
+#  define MAP_TEMPLATE std::tr1::unordered_map
+#else
+#  include <map>
+#  define MAP_TEMPLATE std::map
+#endif
+#include <msg/msg.h>

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

-    process(int argc, char *argv[]);
-    ~process() { };
+    process(int argc, char* argv[]);
+    ~process();

     int run();
 
     int run();
 

+protected:
+    typedef std::vector<neighbor> neigh_type;
+    typedef std::vector<neighbor*> pneigh_type;
+
+    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;
+

 private:
 private:

-    communicator comm;
-    std::vector<neighbor> neigh;
-    double load;
+    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;          // 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;              // counter of iterations

 
 

-    void receive();
+    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
+
+    // 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);
+
+    // 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();
+
+    // 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();
+
+    // Print with given priority what we know about our neighbors' loads

     void print_loads(e_xbt_log_priority_t logp = xbt_log_priority_info);
 };
 
     void print_loads(e_xbt_log_priority_t logp = xbt_log_priority_info);
 };