Add BUGS and review TODO.

[loba.git] / process.h

diff --git a/process.h b/process.h
index 268fac9a2902641225f3145bf9cd3f30283f1aaa..78fc507f963b58491477fc9e2a064efc7685bddf 100644 (file)
--- a/process.h
+++ b/process.h
@@ -13,13 +13,23 @@
 #  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"
 #include "communicator.h"
 #include "neighbor.h"

+#include "options.h"

 
 class process {
 public:
 
 class process {
 public:

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

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

-    ~process();
+    virtual ~process();
+
+    double get_comp() const                { return comp; }
+    double get_real_load() const           { return real_load; }
+

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


@@ -29,12 +39,31 @@ 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);
+
+    // 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); }
+
+    // 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 process loads at init
+    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;

     neigh_type neigh;           // list of neighbors (do not alter
                                 // after construction!)
     rev_neigh_type rev_neigh;   // map m_host_t -> neighbor
     neigh_type neigh;           // list of neighbors (do not alter
                                 // after construction!)
     rev_neigh_type rev_neigh;   // map m_host_t -> neighbor


@@ -44,19 +73,21 @@ private:
                                 // on ctrl channel
     int data_close_pending;     // number of "close" messages to wait
                                 // on data channel
                                 // on ctrl channel
     int data_close_pending;     // number of "close" messages to wait
                                 // on data channel

+    bool close_received;        // true if we received a "close" message
+    bool finalizing;            // true when finalize() is running
+
+    unsigned lb_iter;           // counter of load-balancing iterations
+    unsigned comp_iter;         // counter of computation iterations

 
 

-    unsigned iter;              // counter of 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
 
     // The load balancing algorithm comes here...
     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);
+    virtual void load_balance();

 
     // Virtually do some computation
     void compute();
 
     // Virtually do some computation
     void compute();


@@ -64,23 +95,40 @@ private:
     // Send procedures, with helpers for bookkeeping mode or not
     void send1_no_bookkeeping(neighbor& nb);
     void send1_bookkeeping(neighbor& nb);
     // Send procedures, with helpers for bookkeeping mode or not
     void send1_no_bookkeeping(neighbor& nb);
     void send1_bookkeeping(neighbor& nb);

-    void send();
+    void send_all();

 
 

-    // 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);
+    // Returns true if there remains neighbors to listen for
+    bool may_receive() { return ctrl_close_pending || data_close_pending; }
+
+    // Receive procedure
+    // Parameter "timeout" may be 0 for non-blocking operation, -1 for
+    // infinite waiting, or any positive timeout.
+    void receive(double timeout);

 
     // Finalize sends a "close" message to each neighbor and wait for
     // all of them to answer.
     void finalize1(neighbor& nb);
     void finalize();
 
     // 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);

 };
 
 };
 

+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;
+}
+

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