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