Improve documentation, move open questions in QUESTIONS file.

[loba.git] / process.h

diff --git a/process.h b/process.h
index 4e6ab240f8d73b6f3b15c9fe404568bb82bdc7e2..dbf9b05a34c53cee4e2f95c96f4ce72c0a49e781 100644 (file)
--- a/process.h
+++ b/process.h
@@ -4,7 +4,8 @@
 #define USE_UNORDERED_MAP 1
 //#undef USE_UNORDERED_MAP
 
 #define USE_UNORDERED_MAP 1
 //#undef USE_UNORDERED_MAP
 

-#include <vector>
+#include <algorithm>
+#include <tr1/functional>

 #ifdef USE_UNORDERED_MAP
 #  include <tr1/unordered_map>
 #  define MAP_TEMPLATE std::tr1::unordered_map
 #ifdef USE_UNORDERED_MAP
 #  include <tr1/unordered_map>
 #  define MAP_TEMPLATE std::tr1::unordered_map


@@ -12,10 +13,14 @@
 #  include <map>
 #  define MAP_TEMPLATE std::map
 #endif
 #  include <map>
 #  define MAP_TEMPLATE std::map
 #endif

+#include <vector>

 #include <msg/msg.h>
 #include <xbt/log.h>
 #include "communicator.h"
 #include <msg/msg.h>
 #include <xbt/log.h>
 #include "communicator.h"

+#include "misc.h"
+#include "msg_thread.h"

 #include "neighbor.h"
 #include "neighbor.h"

+#include "options.h"

 
 class process {
 public:
 
 class process {
 public:


@@ -26,6 +31,9 @@ public:
     process(int argc, char* argv[]);
     virtual ~process();
 
     process(int argc, char* argv[]);
     virtual ~process();
 

+    double get_comp() const                { return comp; }
+    double get_real_load() const           { return real_load; }
+

     int run();
 
 protected:
     int run();
 
 protected:


@@ -35,8 +43,21 @@ protected:
     pneigh_type pneigh;         // list of pointers to neighbors that
                                 // we are free to reorder
 
     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;
+    // Get and set current load, which may be real load, or expected
+    // load if opt::bookkeeping is true.
+    double get_load() const;
+    void set_load(double load);
+
+    // The load balancing algorithm comes here...
+    virtual void load_balance();
+
+    // Register some amount of load to send to given neighbor.
+    void send(neighbor& nb, double amount);
+    void send(neighbor* nb, double amount) { send(*nb, amount); }
+
+    // Sort pneigh by applying comp to their loads
+    template <typename Compare>
+    void pneigh_sort_by_load(const Compare& comp);

 
     // Calls neighbor::print(verbose, logp, cat) for each member of neigh.
     void print_loads(bool verbose = false,
 
     // Calls neighbor::print(verbose, logp, cat) for each member of neigh.
     void print_loads(bool verbose = false,


@@ -50,7 +71,7 @@ protected:
 
 private:
     static double total_load_init; // sum of process loads at init
 
 private:
     static double total_load_init; // sum of process loads at init

-    static double total_load_running; // summ of loads while running
+    static double total_load_running; // sum of loads while running

     static double total_load_exit; // sum of process loads at exit
 
     typedef MAP_TEMPLATE<m_host_t, neighbor*> rev_neigh_type;
     static double total_load_exit; // sum of process loads at exit
 
     typedef MAP_TEMPLATE<m_host_t, neighbor*> rev_neigh_type;


@@ -64,40 +85,71 @@ private:
     int data_close_pending;     // number of "close" messages to wait
                                 // on data channel
     bool close_received;        // true if we received a "close" message
     int data_close_pending;     // number of "close" messages to wait
                                 // on data channel
     bool close_received;        // true if we received a "close" message

-    bool may_receive;           // true if there remains neighbors to listen for

     bool finalizing;            // true when finalize() is running
 
     bool finalizing;            // true when finalize() is running
 

-    unsigned iter;              // counter of iterations
+    unsigned lb_iter;           // counter of load-balancing iterations
+    unsigned comp_iter;         // counter of computation iterations
+
+    double comp;                // total computing done so far (flops)

 
     double prev_load_broadcast; // used to ensure that we do not send
                                 // a same information messages
 
     double prev_load_broadcast; // used to ensure that we do not send
                                 // a same information messages

-    double load;                // current load
+    double real_load;           // current load

     double expected_load;       // expected load in bookkeeping mode
 
     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();
-
-    // 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.
-    enum recv_wait_mode { NO_WAIT = 0, WAIT, WAIT_FOR_CLOSE };
-    void 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();
+    // Load-balancing loop
+    void load_balance_loop();
+
+    // Simulate computation loop
+    msg_thread* compute_thread;
+    void compute_loop();
+
+    bool still_running();
+
+    // Send procedures
+    void ctrl_send(neighbor& nb);
+    void data_send(neighbor& nb);
+    void ctrl_close(neighbor& nb);
+    void data_close(neighbor& nb);
+
+    // Receive procedure
+    // Parameter "timeout" may be 0 for non-blocking operation, -1 for
+    // infinite waiting, or any positive timeout.
+    void ctrl_receive(double timeout);
+    void data_receive(double timeout);
+    void handle_message(message* msg, m_host_t from);

 };
 
 };
 

+inline
+double process::get_load() const
+{
+    if (opt::bookkeeping)
+        return expected_load;
+    else
+        return real_load;
+}
+
+inline
+void process::set_load(double load)
+{
+    if (opt::bookkeeping)
+        expected_load = load;
+    else
+        real_load = load;
+}
+
+template <typename Compare>
+void process::pneigh_sort_by_load(const Compare& comp)
+{
+    using std::tr1::bind;
+    using std::tr1::placeholders::_1;
+    using std::tr1::placeholders::_2;
+    std::sort(pneigh.begin(), pneigh.end(),
+              bind(comp,
+                   bind(&neighbor::get_load, _1),
+                   bind(&neighbor::get_load, _2)));
+}
+

 #endif // !PROCESS_H
 
 // Local variables:
 #endif // !PROCESS_H
 
 // Local variables: