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