1f5aa861909cd40c850525d4df50a4a59a752b96
[charm.git] / src / ck-ldb / CentralLB.h
1 /**
2  * \addtogroup CkLdb
3 */
4 /*@{*/
5
6 #ifndef CENTRALLB_H
7 #define CENTRALLB_H
8
9 #include "BaseLB.h"
10 #include "CentralLB.decl.h"
11
12 extern CkGroupID loadbalancer;
13
14 void CreateCentralLB();
15
16 class CLBStatsMsg;
17 class LBSimulation;
18
19 /// for backward compatibility
20 typedef LBMigrateMsg  CLBMigrateMsg;
21
22 class LBInfo
23 {
24 public:
25   LBRealType *peLoads;  // total load: object + background
26   LBRealType *objLoads;         // total obj load
27   LBRealType *comLoads;         // total comm load
28   LBRealType *bgLoads;  // background load
29   int    numPes;
30   int    msgCount;      // total non-local communication
31   CmiUInt8  msgBytes;   // total non-local communication
32   LBRealType minObjLoad, maxObjLoad;
33   LBInfo(): peLoads(NULL), objLoads(NULL), comLoads(NULL), 
34             bgLoads(NULL), numPes(0), msgCount(0),
35             msgBytes(0), minObjLoad(0.0), maxObjLoad(0.0) {}
36   LBInfo(LBRealType *pl, int count): peLoads(pl), objLoads(NULL), 
37             comLoads(NULL), bgLoads(NULL), numPes(count), msgCount(0),
38             msgBytes(0), minObjLoad(0.0), maxObjLoad(0.0) {}
39   LBInfo(int count);
40   ~LBInfo();
41   void getInfo(BaseLB::LDStats* stats, int count, int considerComm);
42   void clear();
43   void print();
44   void getSummary(LBRealType &maxLoad, LBRealType &maxCpuLoad, LBRealType &totalLoad);
45 };
46
47 /** added by Abhinav
48  * class for computing the parent and children of a processor 
49  */
50 class SpanningTree
51 {
52         public:
53                 int arity;
54                 int parent;
55                 int numChildren;
56                 SpanningTree();
57                 void calcParent(int n);
58                 void calcNumChildren(int n);
59 };
60
61 class CentralLB : public BaseLB
62 {
63 private:
64   CLBStatsMsg *statsMsg;
65   int count_msgs;
66   void initLB(const CkLBOptions &);
67 public:
68   CkMarshalledCLBStatsMessage bufMsg;
69   SpanningTree st;
70   CentralLB(const CkLBOptions & opt):BaseLB(opt) { initLB(opt); 
71 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
72         lbDecisionCount= resumeCount=0;
73 #endif
74
75   CentralLB(CkMigrateMessage *m):BaseLB(m) {}
76   virtual ~CentralLB();
77
78   void pup(PUP::er &p);
79
80   void turnOn();
81   void turnOff();
82
83   static void staticAtSync(void*);
84   void AtSync(void); // Everything is at the PE barrier
85   void ProcessAtSync(void); // Receive a message from AtSync to avoid
86                             // making projections output look funny
87   void ProcessAtSyncMin(void);
88   void SendStats();
89   void SendMinStats();
90   void ReceiveCounts(CkReductionMsg *);
91   void ReceiveMinStats(CkReductionMsg *);
92   void ReceiveStats(CkMarshalledCLBStatsMessage &msg);  // Receive stats on PE 0
93   void ReceiveStatsViaTree(CkMarshalledCLBStatsMessage &msg); // Receive stats using a tree structure  
94   
95   void depositData(CLBStatsMsg *m);
96   void LoadBalance(void); 
97   void ResumeClients(int);                      // Resuming clients needs
98
99   void LoadBalanceDecision(int, int);
100   void ReceiveIterationNo(int, int); // Receives the current iter no
101
102   void ResumeClients(CkReductionMsg *); // to be resumed via message
103   void ReceiveMigration(LBMigrateMsg *);        // Receive migration data
104   void ProcessReceiveMigration(CkReductionMsg  *);
105 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
106         void ReceiveDummyMigration(int _step);
107 #endif
108   void MissMigrate(int waitForBarrier);
109
110   // manual predictor start/stop
111   static void staticPredictorOn(void* data, void* model);
112   static void staticPredictorOnWin(void* data, void* model, int wind);
113   static void staticPredictorOff(void* data);
114   static void staticChangePredictor(void* data, void* model);
115
116   // manual start load balancing
117   inline void StartLB() { thisProxy.ProcessAtSync(); }
118   static void staticStartLB(void* data);
119
120   // Migrated-element callback
121   static void staticMigrated(void* me, LDObjHandle h, int waitBarrier=1);
122   void Migrated(LDObjHandle h, int waitBarrier=1);
123
124   void MigrationDone(int balancing);  // Call when migration is complete
125   void CheckMigrationComplete();      // Call when all migration is complete
126
127   // IMPLEMENTATION FOR FUTURE PREDICTOR
128   void FuturePredictor(LDStats* stats);
129
130   struct FutureModel {
131     int n_stats;    // total number of statistics allocated
132     int cur_stats;   // number of statistics currently present
133     int start_stats; // next stat to be written
134     LDStats *collection;
135     int n_objs;     // each object has its own parameters
136     LBPredictorFunction *predictor;
137     double **parameters;
138     bool *model_valid;
139
140     FutureModel(): n_stats(0), cur_stats(0), start_stats(0), collection(NULL),
141          n_objs(0), parameters(NULL) {predictor = new DefaultFunction();}
142
143     FutureModel(int n): n_stats(n), cur_stats(0), start_stats(0), n_objs(0),
144          parameters(NULL) {
145       collection = new LDStats[n];
146       //for (int i=0;i<n;++i) collection[i].objData=NULL;
147       predictor = new DefaultFunction();
148     }
149
150     FutureModel(int n, LBPredictorFunction *myfunc): n_stats(n), cur_stats(0), start_stats(0), n_objs(0), parameters(NULL) {
151       collection = new LDStats[n];
152       //for (int i=0;i<n;++i) collection[i].objData=NULL;
153       predictor = myfunc;
154     }
155
156     ~FutureModel() {
157       delete[] collection;
158       for (int i=0;i<n_objs;++i) delete[] parameters[i];
159       delete[] parameters;
160       delete predictor;
161     }
162
163     void changePredictor(LBPredictorFunction *new_predictor) {
164       delete predictor;
165       int i;
166       // gain control of the provided predictor;
167       predictor = new_predictor;
168       for (i=0;i<n_objs;++i) delete[] parameters[i];
169       for (i=0;i<n_objs;++i) {
170         parameters[i] = new double[new_predictor->num_params];
171         model_valid = false;
172       }
173     }
174   };
175
176   // create new predictor, if one already existing, delete it first
177   // if "pred" == 0 then the default function is used
178   void predictorOn(LBPredictorFunction *pred) {
179     predictorOn(pred, _lb_predict_window);
180   }
181   void predictorOn(LBPredictorFunction *pred, int window_size) {
182     if (predicted_model) PredictorPrintf("Predictor already allocated");
183     else {
184       _lb_predict_window = window_size;
185       if (pred) predicted_model = new FutureModel(window_size, pred);
186       else predicted_model = new FutureModel(window_size);
187       _lb_predict = CmiTrue;
188     }
189     PredictorPrintf("Predictor turned on, window size %d\n",window_size);
190   }
191
192   // deallocate the predictor
193   void predictorOff() {
194     if (predicted_model) delete predicted_model;
195     predicted_model = 0;
196     _lb_predict = CmiFalse;
197     PredictorPrintf("Predictor turned off\n");
198   }
199
200   // change the function of the predictor, at runtime
201   // it will do nothing if it does not exist
202   void changePredictor(LBPredictorFunction *new_predictor) {
203     if (predicted_model) {
204       predicted_model->changePredictor(new_predictor);
205       PredictorPrintf("Predictor model changed\n");
206     }
207   }
208   // END IMPLEMENTATION FOR FUTURE PREDICTOR
209
210   LBMigrateMsg* callStrategy(LDStats* stats,int count){
211     return Strategy(stats);
212   };
213
214   int cur_ld_balancer;
215
216   void readStatsMsgs(const char* filename);
217   void writeStatsMsgs(const char* filename);
218
219   void preprocess(LDStats* stats);
220   virtual LBMigrateMsg* Strategy(LDStats* stats);
221   virtual void work(LDStats* stats);
222   virtual LBMigrateMsg * createMigrateMsg(LDStats* stats);
223   virtual LBMigrateMsg * extractMigrateMsg(LBMigrateMsg *m, int p);
224
225   // Not to be used -- maintained for legacy applications
226   virtual LBMigrateMsg* Strategy(LDStats* stats, int nprocs) {
227     return Strategy(stats);
228   }
229
230 protected:
231   virtual CmiBool QueryBalanceNow(int) { return CmiTrue; };  
232   virtual CmiBool QueryDumpData() { return CmiFalse; };  
233   virtual void LoadbalanceDone(int balancing) {}
234
235   void simulationRead();
236   void simulationWrite();
237   void findSimResults(LDStats* stats, int count, 
238                       LBMigrateMsg* msg, LBSimulation* simResults);
239   void removeNonMigratable(LDStats* statsDataList, int count);
240
241 private:  
242   CProxy_CentralLB thisProxy;
243   int myspeed;
244   int stats_msg_count;
245   CLBStatsMsg **statsMsgsList;
246   LDStats *statsData;
247   int migrates_completed;
248   int migrates_expected;
249   int future_migrates_completed;
250   int future_migrates_expected;
251   int lbdone;
252   double start_lb_time;
253   LBMigrateMsg   *storedMigrateMsg;
254   int  reduction_started;
255
256   FutureModel *predicted_model;
257
258   void BuildStatsMsg();
259   void buildStats();
260   bool generatePlan(int& period);
261   bool getLineEq(double& aslope, double& ac, double& mslope, double& mc);
262   bool getPeriodForLinear(double a, double b, double c, int& period);
263
264 public:
265   int useMem();
266 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
267     int savedBalancing;
268     void endMigrationDone(int balancing);
269     int lbDecisionCount ,resumeCount;
270 #endif
271 };
272
273 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_)) 
274     void resumeCentralLbAfterChkpt(void *lb);
275 #endif
276
277 // CLBStatsMsg is not directly sent in the entry function
278 // CkMarshalledCLBStatsMessage is used instead to use the pup defined here.
279 //class CLBStatsMsg: public CMessage_CLBStatsMsg {
280 class CLBStatsMsg {
281 public:
282   int from_pe;
283   int pe_speed;
284   LBRealType total_walltime;
285   LBRealType idletime;
286   LBRealType bg_walltime;
287 #if CMK_LB_CPUTIMER
288   LBRealType total_cputime;
289   LBRealType bg_cputime;
290 #endif
291   int n_objs;
292   LDObjData *objData;
293   int n_comm;
294   LDCommData *commData;
295
296   char * avail_vector;
297   int next_lb;
298 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
299         int step;
300 #endif
301
302 public:
303   CLBStatsMsg(int osz, int csz);
304   CLBStatsMsg(): from_pe(0), pe_speed(0), total_walltime(0.0), idletime(0.0),
305                  bg_walltime(0.0), n_objs(0), objData(NULL), n_comm(0),
306 #if CMK_LB_CPUTIMER
307                  total_cputime(0.0), bg_cputime(0.0),
308 #endif
309                  commData(NULL), avail_vector(NULL), next_lb(0) {}
310   ~CLBStatsMsg();
311   void pup(PUP::er &p);
312 }; 
313
314
315 // compute load distribution info
316 void getLoadInfo(BaseLB::LDStats* stats, int count, LBInfo &info, int considerComm);
317
318 #endif /* CENTRALLB_H */
319
320 /*@}*/
321
322