checking for div by 0
[charm.git] / src / ck-ldb / LBDatabase.C
1 /**
2  * \addtogroup CkLdb
3 */
4 /*@{*/
5
6 #include "converse.h"
7
8 /*
9  * This C++ file contains the Charm stub functions
10  */
11
12 #include "LBDatabase.h"
13 #include "LBSimulation.h"
14 #include "topology.h"
15
16 #include "limits.h"
17
18 #include "NullLB.h"
19
20 struct AdaptiveData {
21   int iteration;
22   double max_load;
23   double avg_load;
24   double max_idle_time;
25   double idle_time;
26 };
27
28 struct AdaptiveLBDatabase {
29   std::vector<AdaptiveData> history_data;
30 } adaptive_lbdb;
31
32 struct AdaptiveLBStructure {
33   int lb_ideal_period;
34   int lb_calculated_period;
35   int lb_no_iterations;
36   int global_max_iter_no;
37   int global_recv_iter_counter;
38   bool in_progress;
39   double prev_load;
40   double lb_strategy_cost;
41   double lb_migration_cost;
42   bool lb_period_informed;
43   bool isCommLB;
44   int lb_msg_send_no;
45   int lb_msg_recv_no;
46   int total_syncs_called;
47 } adaptive_struct;
48
49
50 CkReductionMsg* lbDataCollection(int nMsg, CkReductionMsg** msgs) {
51   double lb_data[6];
52   lb_data[2] = 0.0;
53   lb_data[3] = 0.0;
54   lb_data[4] = 0.0;
55   lb_data[5] = 0.0;
56   for (int i = 0; i < nMsg; i++) {
57     CkAssert(msgs[i]->getSize() == 4*sizeof(double));
58     double* m = (double *)msgs[i]->getData();
59     // Total count
60     lb_data[1] += m[1];
61     // Avg load
62     lb_data[2] += m[2];
63     // Max load
64     lb_data[3] = ((m[3] > lb_data[3])? m[3] : lb_data[3]);
65     // Avg idle
66     lb_data[4] += m[4];
67     // Max idle
68     lb_data[5] = ((m[5] > lb_data[5]) ? m[5] : lb_data[5]);
69     if (i == 0) {
70       // Iteration no
71       lb_data[0] = m[0];
72     }
73     if (m[0] != lb_data[0]) {
74       CkPrintf("Error!!! Reduction is intermingled between iteration %lf and\
75       %lf\n", lb_data[0], m[0]);
76     }
77   }
78   return CkReductionMsg::buildNew(6*sizeof(double), lb_data);
79 }
80
81 /*global*/ CkReduction::reducerType lbDataCollectionType;
82 /*initcall*/ void registerLBDataCollection(void) {
83   lbDataCollectionType = CkReduction::addReducer(lbDataCollection);
84 }
85
86 CkGroupID _lbdb;
87
88 CkpvDeclare(int, numLoadBalancers);  /**< num of lb created */
89 CkpvDeclare(int, hasNullLB);         /**< true if NullLB is created */
90 CkpvDeclare(int, lbdatabaseInited);  /**< true if lbdatabase is inited */
91
92 // command line options
93 CkLBArgs _lb_args;
94 int _lb_predict=0;
95 int _lb_predict_delay=10;
96 int _lb_predict_window=20;
97
98 // registry class stores all load balancers linked and created at runtime
99 class LBDBRegistry {
100 friend class LBDBInit;
101 friend class LBDatabase;
102 private:
103   // table for all available LBs linked in
104   struct LBDBEntry {
105     const char *name;
106     LBCreateFn  cfn;
107     LBAllocFn   afn;
108     const char *help;
109     int         shown;          // if 0, donot show in help page
110     LBDBEntry(): name(0), cfn(0), afn(0), help(0), shown(1) {}
111     LBDBEntry(int) {}
112     LBDBEntry(const char *n, LBCreateFn cf, LBAllocFn af, 
113               const char *h, int show=1):
114       name(n), cfn(cf), afn(af), help(h), shown(show) {};
115   };
116   CkVec<LBDBEntry> lbtables;            // a list of available LBs linked
117   CkVec<const char *>   compile_lbs;    // load balancers at compile time
118   CkVec<const char *>   runtime_lbs;    // load balancers at run time
119 public:
120   LBDBRegistry() {}
121   void displayLBs()
122   {
123     CmiPrintf("\nAvailable load balancers:\n");
124     for (int i=0; i<lbtables.length(); i++) {
125       LBDBEntry &entry = lbtables[i];
126       if (entry.shown) CmiPrintf("* %s: %s\n", entry.name, entry.help);
127     }
128     CmiPrintf("\n");
129   }
130   void addEntry(const char *name, LBCreateFn fn, LBAllocFn afn, const char *help, int shown) {
131     lbtables.push_back(LBDBEntry(name, fn, afn, help, shown));
132   }
133   void addCompiletimeBalancer(const char *name) {
134     compile_lbs.push_back(name); 
135   }
136   void addRuntimeBalancer(const char *name) {
137     runtime_lbs.push_back(name); 
138   }
139   LBCreateFn search(const char *name) {
140     char *ptr = strpbrk((char *)name, ":,");
141     int slen = ptr!=NULL?ptr-name:strlen(name);
142     for (int i=0; i<lbtables.length(); i++)
143       if (0==strncmp(name, lbtables[i].name, slen)) return lbtables[i].cfn;
144     return NULL;
145   }
146   LBAllocFn getLBAllocFn(const char *name) {
147     char *ptr = strpbrk((char *)name, ":,");
148     int slen = ptr-name;
149     for (int i=0; i<lbtables.length(); i++)
150       if (0==strncmp(name, lbtables[i].name, slen)) return lbtables[i].afn;
151     return NULL;
152   }
153 };
154
155 static LBDBRegistry lbRegistry;
156
157 void LBDefaultCreate(const char *lbname)
158 {
159   lbRegistry.addCompiletimeBalancer(lbname);
160 }
161
162 // default is to show the helper
163 void LBRegisterBalancer(const char *name, LBCreateFn fn, LBAllocFn afn, const char *help, int shown)
164 {
165   lbRegistry.addEntry(name, fn, afn, help, shown);
166 }
167
168 LBAllocFn getLBAllocFn(char *lbname) {
169     return lbRegistry.getLBAllocFn(lbname);
170 }
171
172 LBCreateFn getLBCreateFn(const char *lbname) {
173     return lbRegistry.search(lbname);
174 }
175 // create a load balancer group using the strategy name
176 static void createLoadBalancer(const char *lbname)
177 {
178     LBCreateFn fn = lbRegistry.search(lbname);
179     if (!fn) {    // invalid lb name
180       CmiPrintf("Abort: Unknown load balancer: '%s'!\n", lbname);
181       lbRegistry.displayLBs();    // display help page
182       CkAbort("Abort");
183     }
184     // invoke function to create load balancer 
185     fn();
186 }
187
188 // mainchare
189 LBDBInit::LBDBInit(CkArgMsg *m)
190 {
191 #if CMK_LBDB_ON
192   _lbdb = CProxy_LBDatabase::ckNew();
193
194   // runtime specified load balancer
195   if (lbRegistry.runtime_lbs.size() > 0) {
196     for (int i=0; i<lbRegistry.runtime_lbs.size(); i++) {
197       const char *balancer = lbRegistry.runtime_lbs[i];
198       createLoadBalancer(balancer);
199     }
200   }
201   else if (lbRegistry.compile_lbs.size() > 0) {
202     for (int i=0; i<lbRegistry.compile_lbs.size(); i++) {
203       const char* balancer = lbRegistry.compile_lbs[i];
204       createLoadBalancer(balancer);
205     }
206   }
207   else {
208     // NullLB is the default when none of above lb created
209     // note user may create his own load balancer in his code manually like
210     // in NAMD, but never mind NullLB can disable itself if there is 
211     // a non NULL LB.
212     createLoadBalancer("NullLB");
213   }
214
215   // simulation mode
216   if (LBSimulation::doSimulation) {
217     CmiPrintf("Charm++> Entering Load Balancer Simulation Mode ... \n");
218     CProxy_LBDatabase(_lbdb).ckLocalBranch()->StartLB();
219   }
220 #endif
221   delete m;
222 }
223
224 // called from init.C
225 void _loadbalancerInit()
226 {
227   CkpvInitialize(int, lbdatabaseInited);
228   CkpvAccess(lbdatabaseInited) = 0;
229   CkpvInitialize(int, numLoadBalancers);
230   CkpvAccess(numLoadBalancers) = 0;
231   CkpvInitialize(int, hasNullLB);
232   CkpvAccess(hasNullLB) = 0;
233
234   char **argv = CkGetArgv();
235   char *balancer = NULL;
236   CmiArgGroup("Charm++","Load Balancer");
237   while (CmiGetArgStringDesc(argv, "+balancer", &balancer, "Use this load balancer")) {
238     if (CkMyRank() == 0)                
239       lbRegistry.addRuntimeBalancer(balancer);   /* lbRegistry is a static */
240   }
241
242   // set up init value for LBPeriod time in seconds
243   // it can also be set by calling LDSetLBPeriod()
244   CmiGetArgDoubleDesc(argv,"+LBPeriod", &_lb_args.lbperiod(),"the minimum time period in seconds allowed for two consecutive automatic load balancing");
245   _lb_args.loop() = CmiGetArgFlagDesc(argv, "+LBLoop", "Use multiple load balancing strategies in loop");
246
247   // now called in cldb.c: CldModuleGeneralInit()
248   // registerLBTopos();
249   CmiGetArgStringDesc(argv, "+LBTopo", &_lbtopo, "define load balancing topology");
250   //Read the K parameter for RefineKLB
251   CmiGetArgIntDesc(argv, "+LBNumMoves", &_lb_args.percentMovesAllowed() , "Percentage of chares to be moved (used by RefineKLB) [0-100]");
252
253   /**************** FUTURE PREDICTOR ****************/
254   _lb_predict = CmiGetArgFlagDesc(argv, "+LBPredictor", "Turn on LB future predictor");
255   CmiGetArgIntDesc(argv, "+LBPredictorDelay", &_lb_predict_delay, "Number of balance steps before learning a model");
256   CmiGetArgIntDesc(argv, "+LBPredictorWindow", &_lb_predict_window, "Number of steps to use to learn a model");
257   if (_lb_predict_window < _lb_predict_delay) {
258     CmiPrintf("LB> [%d] Argument LBPredictorWindow (%d) less than LBPredictorDelay (%d) , fixing\n", CkMyPe(), _lb_predict_window, _lb_predict_delay);
259     _lb_predict_delay = _lb_predict_window;
260   }
261
262   /******************* SIMULATION *******************/
263   // get the step number at which to dump the LB database
264   CmiGetArgIntDesc(argv, "+LBVersion", &_lb_args.lbversion(), "LB database file version number");
265   CmiGetArgIntDesc(argv, "+LBCentPE", &_lb_args.central_pe(), "CentralLB processor");
266   int _lb_dump_activated = 0;
267   if (CmiGetArgIntDesc(argv, "+LBDump", &LBSimulation::dumpStep, "Dump the LB state from this step"))
268     _lb_dump_activated = 1;
269   if (_lb_dump_activated && LBSimulation::dumpStep < 0) {
270     CmiPrintf("LB> Argument LBDump (%d) negative, setting to 0\n",LBSimulation::dumpStep);
271     LBSimulation::dumpStep = 0;
272   }
273   CmiGetArgIntDesc(argv, "+LBDumpSteps", &LBSimulation::dumpStepSize, "Dump the LB state for this amount of steps");
274   if (LBSimulation::dumpStepSize <= 0) {
275     CmiPrintf("LB> Argument LBDumpSteps (%d) too small, setting to 1\n",LBSimulation::dumpStepSize);
276     LBSimulation::dumpStepSize = 1;
277   }
278   CmiGetArgStringDesc(argv, "+LBDumpFile", &LBSimulation::dumpFile, "Set the LB state file name");
279   // get the simulation flag and number. Now the flag can also be avoided by the presence of the number
280   LBSimulation::doSimulation = CmiGetArgIntDesc(argv, "+LBSim", &LBSimulation::simStep, "Read LB state from LBDumpFile since this step");
281   // check for stupid LBSim parameter
282   if (LBSimulation::doSimulation && LBSimulation::simStep < 0) {
283     CmiPrintf("LB> Argument LBSim (%d) invalid, should be >= 0\n");
284     CkExit();
285     return;
286   }
287   CmiGetArgIntDesc(argv, "+LBSimSteps", &LBSimulation::simStepSize, "Read LB state for this number of steps");
288   if (LBSimulation::simStepSize <= 0) {
289     CmiPrintf("LB> Argument LBSimSteps (%d) too small, setting to 1\n",LBSimulation::simStepSize);
290     LBSimulation::simStepSize = 1;
291   }
292
293
294   LBSimulation::simProcs = 0;
295   CmiGetArgIntDesc(argv, "+LBSimProcs", &LBSimulation::simProcs, "Number of target processors.");
296
297   LBSimulation::showDecisionsOnly = 
298     CmiGetArgFlagDesc(argv, "+LBShowDecisions",
299                       "Write to File: Load Balancing Object to Processor Map decisions during LB Simulation");
300
301   // force a global barrier after migration done
302   _lb_args.syncResume() = CmiGetArgFlagDesc(argv, "+LBSyncResume", 
303                   "LB performs a barrier after migration is finished");
304
305   // both +LBDebug and +LBDebug level should work
306   if (!CmiGetArgIntDesc(argv, "+LBDebug", &_lb_args.debug(), 
307                                           "Turn on LB debugging printouts"))
308     _lb_args.debug() = CmiGetArgFlagDesc(argv, "+LBDebug", 
309                                              "Turn on LB debugging printouts");
310
311   // getting the size of the team with +teamSize
312   if (!CmiGetArgIntDesc(argv, "+teamSize", &_lb_args.teamSize(), 
313                                           "Team size"))
314     _lb_args.teamSize() = 1;
315
316   // ask to print summary/quality of load balancer
317   _lb_args.printSummary() = CmiGetArgFlagDesc(argv, "+LBPrintSummary",
318                 "Print load balancing result summary");
319
320   // to ignore baclground load
321   _lb_args.ignoreBgLoad() = CmiGetArgFlagDesc(argv, "+LBNoBackground", 
322                       "Load balancer ignores the background load.");
323 #ifdef __BIGSIM__
324   _lb_args.ignoreBgLoad() = 1;
325 #endif
326   _lb_args.migObjOnly() = CmiGetArgFlagDesc(argv, "+LBObjOnly", 
327                       "Only load balancing migratable objects, ignoring all others.");
328   if (_lb_args.migObjOnly()) _lb_args.ignoreBgLoad() = 1;
329
330   // assume all CPUs are identical
331   _lb_args.testPeSpeed() = CmiGetArgFlagDesc(argv, "+LBTestPESpeed", 
332                       "Load balancer test all CPUs speed.");
333   _lb_args.samePeSpeed() = CmiGetArgFlagDesc(argv, "+LBSameCpus", 
334                       "Load balancer assumes all CPUs are of same speed.");
335   if (!_lb_args.testPeSpeed()) _lb_args.samePeSpeed() = 1;
336
337   _lb_args.useCpuTime() = CmiGetArgFlagDesc(argv, "+LBUseCpuTime", 
338                       "Load balancer uses CPU time instead of wallclock time.");
339
340   // turn instrumentation off at startup
341   _lb_args.statsOn() = !CmiGetArgFlagDesc(argv, "+LBOff",
342                         "Turn load balancer instrumentation off");
343
344   // turn instrumentation of communicatin off at startup
345   _lb_args.traceComm() = !CmiGetArgFlagDesc(argv, "+LBCommOff",
346                 "Turn load balancer instrumentation of communication off");
347
348   // set alpha and beeta
349   _lb_args.alpha() = PER_MESSAGE_SEND_OVERHEAD_DEFAULT;
350   _lb_args.beeta() = PER_BYTE_SEND_OVERHEAD_DEFAULT;
351   CmiGetArgDoubleDesc(argv,"+LBAlpha", &_lb_args.alpha(),
352                            "per message send overhead");
353   CmiGetArgDoubleDesc(argv,"+LBBeta", &_lb_args.beeta(),
354                            "per byte send overhead");
355
356   if (CkMyPe() == 0) {
357     if (_lb_args.debug()) {
358       CmiPrintf("CharmLB> Verbose level %d, load balancing period: %g seconds\n", _lb_args.debug(), _lb_args.lbperiod());
359     }
360     if (_lb_args.debug() > 1) {
361       CmiPrintf("CharmLB> Topology %s alpha: %es beta: %es.\n", _lbtopo, _lb_args.alpha(), _lb_args.beeta());
362     }
363     if (_lb_args.printSummary())
364       CmiPrintf("CharmLB> Load balancer print summary of load balancing result.\n");
365     if (_lb_args.ignoreBgLoad())
366       CmiPrintf("CharmLB> Load balancer ignores processor background load.\n");
367     if (_lb_args.samePeSpeed())
368       CmiPrintf("CharmLB> Load balancer assumes all CPUs are same.\n");
369     if (_lb_args.useCpuTime())
370       CmiPrintf("CharmLB> Load balancer uses CPU time instead of wallclock time.\n");
371     if (LBSimulation::doSimulation)
372       CmiPrintf("CharmLB> Load balancer running in simulation mode on file '%s' version %d.\n", LBSimulation::dumpFile, _lb_args.lbversion());
373     if (_lb_args.statsOn()==0)
374       CkPrintf("CharmLB> Load balancing instrumentation is off.\n");
375     if (_lb_args.traceComm()==0)
376       CkPrintf("CharmLB> Load balancing instrumentation for communication is off.\n");
377     if (_lb_args.migObjOnly())
378       CkPrintf("LB> Load balancing strategy ignores non-migratable objects.\n");
379   }
380 }
381
382 int LBDatabase::manualOn = 0;
383 char *LBDatabase::avail_vector = NULL;
384 CmiNodeLock avail_vector_lock;
385
386 static LBRealType * _expectedLoad = NULL;
387
388 void LBDatabase::initnodeFn()
389 {
390   int proc;
391   int num_proc = CkNumPes();
392   avail_vector= new char[num_proc];
393   for(proc = 0; proc < num_proc; proc++)
394       avail_vector[proc] = 1;
395   avail_vector_lock = CmiCreateLock();
396
397   _expectedLoad = new LBRealType[num_proc];
398   for (proc=0; proc<num_proc; proc++) _expectedLoad[proc]=0.0;
399 }
400
401 // called my constructor
402 void LBDatabase::init(void) 
403 {
404   //thisProxy = CProxy_LBDatabase(thisgroup);
405   myLDHandle = LDCreate();
406   mystep = 0;
407   nloadbalancers = 0;
408   new_ld_balancer = 0;
409
410   CkpvAccess(lbdatabaseInited) = 1;
411 #if CMK_LBDB_ON
412   if (manualOn) TurnManualLBOn();
413 #endif
414   
415   max_load_vec.resize(100, 0.0);
416   total_load_vec.resize(100, 0.0);
417   total_contrib_vec.resize(100, 0.0);
418   max_iteration = -1;
419
420   // If metabalancer enabled, initialize the variables
421   adaptive_struct.lb_ideal_period =  INT_MAX;
422   adaptive_struct.lb_calculated_period = INT_MAX;
423   adaptive_struct.lb_no_iterations = -1;
424   adaptive_struct.global_max_iter_no = 0;
425   adaptive_struct.global_recv_iter_counter = 0;
426   adaptive_struct.in_progress = false;
427   adaptive_struct.prev_load = 0.0;
428   adaptive_struct.lb_strategy_cost = 0.0;
429   adaptive_struct.lb_migration_cost = 0.0;
430   adaptive_struct.lb_msg_send_no = 0;
431   adaptive_struct.lb_msg_recv_no = 0;
432   adaptive_struct.total_syncs_called = 0;
433
434   is_prev_lb_refine = -1;
435 }
436
437 LBDatabase::LastLBInfo::LastLBInfo()
438 {
439   expectedLoad = _expectedLoad;
440 }
441
442 void LBDatabase::get_avail_vector(char * bitmap) {
443     CmiAssert(bitmap && avail_vector);
444     const int num_proc = CkNumPes();
445     for(int proc = 0; proc < num_proc; proc++){
446       bitmap[proc] = avail_vector[proc];
447     }
448 }
449
450 // new_ld == -1(default) : calcualte a new ld
451 //           -2 : ignore new ld
452 //           >=0: given a new ld
453 void LBDatabase::set_avail_vector(char * bitmap, int new_ld){
454     int assigned = 0;
455     const int num_proc = CkNumPes();
456     if (new_ld == -2) assigned = 1;
457     else if (new_ld >= 0) {
458       CmiAssert(new_ld < num_proc);
459       new_ld_balancer = new_ld;
460       assigned = 1;
461     }
462     CmiAssert(bitmap && avail_vector);
463     for(int count = 0; count < num_proc; count++){
464         avail_vector[count] = bitmap[count];
465         if((bitmap[count] == 1) && !assigned){
466             new_ld_balancer = count;
467             assigned = 1;
468         }
469     }
470 }
471
472 // called in CreateFooLB() when multiple load balancers are created
473 // on PE0, BaseLB of each load balancer applies a ticket number
474 // and broadcast the ticket number to all processors
475 int LBDatabase::getLoadbalancerTicket()  { 
476   int seq = nloadbalancers;
477   nloadbalancers ++;
478   loadbalancers.resize(nloadbalancers); 
479   loadbalancers[seq] = NULL;
480   return seq; 
481 }
482
483 void LBDatabase::addLoadbalancer(BaseLB *lb, int seq) {
484 //  CmiPrintf("[%d] addLoadbalancer for seq %d\n", CkMyPe(), seq);
485   if (seq == -1) return;
486   if (CkMyPe() == 0) {
487     CmiAssert(seq < nloadbalancers);
488     if (loadbalancers[seq]) {
489       CmiPrintf("Duplicate load balancer created at %d\n", seq);
490       CmiAbort("LBDatabase");
491     }
492   }
493   else
494     nloadbalancers ++;
495   loadbalancers.resize(seq+1);
496   loadbalancers[seq] = lb;
497 }
498
499 // switch strategy in order
500 void LBDatabase::nextLoadbalancer(int seq) {
501   if (seq == -1) return;                // -1 means this is the only LB
502   int next = seq+1;
503   if (_lb_args.loop()) {
504     if (next == nloadbalancers) next = 0;
505   }
506   else {
507     if (next == nloadbalancers) next --;  // keep using the last one
508   }
509   if (seq != next) {
510     loadbalancers[seq]->turnOff();
511     CmiAssert(loadbalancers[next]);
512     loadbalancers[next]->turnOn();
513   }
514 }
515
516 // return the seq-th load balancer string name of
517 // it can be specified in either compile time or runtime
518 // runtime has higher priority
519 const char *LBDatabase::loadbalancer(int seq) {
520   if (lbRegistry.runtime_lbs.length()) {
521     CmiAssert(seq < lbRegistry.runtime_lbs.length());
522     return lbRegistry.runtime_lbs[seq];
523   }
524   else {
525     CmiAssert(seq < lbRegistry.compile_lbs.length());
526     return lbRegistry.compile_lbs[seq];
527   }
528 }
529
530 void LBDatabase::pup(PUP::er& p)
531
532         IrrGroup::pup(p); 
533         // the memory should be already allocated
534         int np;
535         if (!p.isUnpacking()) np = CkNumPes();
536         p|np;
537         CmiAssert(avail_vector);
538         // in case number of processors changes
539         if (p.isUnpacking() && np > CkNumPes()) {
540                 CmiLock(avail_vector_lock);
541                 delete [] avail_vector;
542                 avail_vector = new char[np];
543                 for (int i=0; i<np; i++) avail_vector[i] = 1;
544                 CmiUnlock(avail_vector_lock);
545         }
546         p(avail_vector, np);
547         p|mystep;
548         if(p.isUnpacking()) nloadbalancers = 0;
549 }
550
551
552 void LBDatabase::EstObjLoad(const LDObjHandle &_h, double cputime)
553 {
554 #if CMK_LBDB_ON
555   LBDB *const db = (LBDB*)(_h.omhandle.ldb.handle);
556   LBObj *const obj = db->LbObj(_h);
557
558   CmiAssert(obj != NULL);
559   obj->setTiming(cputime);
560 #endif
561 }
562
563 void LBDatabase::ResumeClients() {
564   // If metabalancer enabled, initialize the variables
565   adaptive_lbdb.history_data.clear();
566
567   adaptive_struct.lb_ideal_period =  INT_MAX;
568   adaptive_struct.lb_calculated_period = INT_MAX;
569   adaptive_struct.lb_no_iterations = -1;
570   adaptive_struct.global_max_iter_no = 0;
571   adaptive_struct.global_recv_iter_counter = 0;
572   adaptive_struct.in_progress = false;
573   adaptive_struct.prev_load = 0.0;
574   adaptive_struct.lb_strategy_cost = 0.0;
575   adaptive_struct.lb_migration_cost = 0.0;
576   adaptive_struct.lb_msg_send_no = 0;
577   adaptive_struct.lb_msg_recv_no = 0;
578   adaptive_struct.total_syncs_called = 0;
579   
580   max_load_vec.clear();
581   total_load_vec.clear();
582   total_contrib_vec.clear();
583
584   max_load_vec.resize(100, 0.0);
585   total_load_vec.resize(100, 0.0);
586   total_contrib_vec.resize(100, 0.0);
587
588   LDResumeClients(myLDHandle);
589 }
590
591 bool LBDatabase::AddLoad(int iteration, double load) {
592   total_contrib_vec[iteration]++;
593   adaptive_struct.total_syncs_called++;
594   //CkPrintf("At PE %d Total contribution for iteration %d is %lf total objs %d\n", CkMyPe(), iteration,
595   //total_contrib_vec[iteration], getLBDB()->ObjDataCount());
596
597   if (iteration > adaptive_struct.lb_no_iterations) {
598     adaptive_struct.lb_no_iterations = iteration;
599   }
600   total_load_vec[iteration] += load;
601  // if (max_load_vec[iteration] < load) {
602  //   max_load_vec[iteration] = load;
603  // }
604   if (total_contrib_vec[iteration] == getLBDB()->ObjDataCount()) {
605     double idle_time;
606     double tmp;
607     GetTime(&tmp, &tmp, &idle_time, &tmp, &tmp);
608     idle_time = idle_time * iteration * getLBDB()->ObjDataCount() /
609       adaptive_struct.total_syncs_called;
610
611     double lb_data[6];
612     lb_data[0] = iteration;
613     lb_data[1] = 1;
614     lb_data[2] = total_load_vec[iteration];
615     //lb_data[2] = max_load_vec[iteration];
616     lb_data[3] = total_load_vec[iteration];
617     //lb_data[3] = getLBDB()->ObjDataCount();
618     lb_data[4] = idle_time;
619     if (total_load_vec[iteration] == 0.0) {
620       lb_data[5] = idle_time;
621     } else {
622       lb_data[5] = idle_time/total_load_vec[iteration];
623     }
624
625     CkPrintf("[%d] sends total load %lf idle time %lf ratio of idle/load %lf at iter %d\n", CkMyPe(),
626         total_load_vec[iteration], idle_time,
627         idle_time/total_load_vec[iteration], adaptive_struct.lb_no_iterations);
628
629     CkCallback cb(CkIndex_LBDatabase::ReceiveMinStats((CkReductionMsg*)NULL), thisProxy[0]);
630     contribute(6*sizeof(double), lb_data, lbDataCollectionType, cb);
631   }
632   return true;
633 }
634
635 void LBDatabase::ReceiveMinStats(CkReductionMsg *msg) {
636   double* load = (double *) msg->getData();
637   double avg = load[2]/load[1];
638   double max = load[3];
639   double avg_idle = load[4]/load[1];
640   double max_idle = load[5];
641   int iteration_n = load[0];
642   CkPrintf("** [%d] Iteration Avg load: %lf Max load: %lf Avg Idle : %lf Max Idle : %lf for %lf procs\n",iteration_n, avg, max, avg_idle, max_idle, load[1]);
643   delete msg;
644  
645   // Store the data for this iteration
646   adaptive_struct.lb_no_iterations = iteration_n;
647   AdaptiveData data;
648   data.iteration = adaptive_struct.lb_no_iterations;
649   data.max_load = max;
650   data.avg_load = avg;
651   data.max_idle_time = max_idle;
652   data.idle_time = avg_idle;
653   adaptive_lbdb.history_data.push_back(data);
654
655   // If lb period inform is in progress, dont inform again
656   if (adaptive_struct.in_progress) {
657     return;
658   }
659
660 //  if (adaptive_struct.lb_period_informed) {
661 //    return;
662 //  }
663
664   // If the max/avg ratio is greater than the threshold and also this is not the
665   // step immediately after load balancing, carry out load balancing
666   //if (max/avg >= 1.1 && adaptive_lbdb.history_data.size() > 4) {
667   if ((max_idle >= 0.1 || max/avg >= 1.5) && adaptive_lbdb.history_data.size() > 4) {
668     CkPrintf("Carry out load balancing step at iter max/avg(%lf) and max_idle ratio (%lf)\n", max/avg, max_idle);
669 //    if (!adaptive_struct.lb_period_informed) {
670 //      // Just for testing
671 //      adaptive_struct.lb_calculated_period = 40;
672 //      adaptive_struct.lb_period_informed = true;
673 //      thisProxy.LoadBalanceDecision(adaptive_struct.lb_calculated_period);
674 //      return;
675 //    }
676
677
678     // If the new lb period is less than current set lb period
679     if (adaptive_struct.lb_calculated_period > iteration_n + 1) {
680       if (max/avg < 1.5) {
681         adaptive_struct.isCommLB = true;
682         CkPrintf("No load imbalance but idle time\n");
683       } else {
684         adaptive_struct.isCommLB = false;
685         CkPrintf("load imbalance \n");
686       }
687       adaptive_struct.lb_calculated_period = iteration_n + 1;
688       adaptive_struct.lb_period_informed = true;
689       adaptive_struct.in_progress = true;
690       CkPrintf("Informing everyone the lb period is %d\n",
691           adaptive_struct.lb_calculated_period);
692       thisProxy.LoadBalanceDecision(adaptive_struct.lb_msg_send_no++, adaptive_struct.lb_calculated_period);
693     }
694     return;
695   }
696
697   // Generate the plan for the adaptive strategy
698   int period;
699   if (generatePlan(period)) {
700     //CkPrintf("Carry out load balancing step at iter\n");
701
702     // If the new lb period is less than current set lb period
703     if (adaptive_struct.lb_calculated_period > period) {
704       adaptive_struct.isCommLB = false;
705       adaptive_struct.lb_calculated_period = period;
706       adaptive_struct.in_progress = true;
707       adaptive_struct.lb_period_informed = true;
708       CkPrintf("Informing everyone the lb period is %d\n",
709           adaptive_struct.lb_calculated_period);
710       thisProxy.LoadBalanceDecision(adaptive_struct.lb_msg_send_no++, adaptive_struct.lb_calculated_period);
711     }
712   }
713 }
714
715 bool LBDatabase::generatePlan(int& period) {
716   if (adaptive_lbdb.history_data.size() <= 8) {
717     return false;
718   }
719
720   // Some heuristics for lbperiod
721   // If constant load or almost constant,
722   // then max * new_lb_period > avg * new_lb_period + lb_cost
723   double max = 0.0;
724   double avg = 0.0;
725   AdaptiveData data;
726   for (int i = 0; i < adaptive_lbdb.history_data.size(); i++) {
727     data = adaptive_lbdb.history_data[i];
728     max += data.max_load;
729     avg += data.avg_load;
730     CkPrintf("max (%d, %lf) avg (%d, %lf)\n", i, data.max_load, i, data.avg_load);
731   }
732 //  max /= (adaptive_struct.lb_no_iterations - adaptive_lbdb.history_data[0].iteration);
733 //  avg /= (adaptive_struct.lb_no_iterations - adaptive_lbdb.history_data[0].iteration);
734 //
735 //  adaptive_struct.lb_ideal_period = (adaptive_struct.lb_strategy_cost +
736 //  adaptive_struct.lb_migration_cost) / (max - avg);
737 //  CkPrintf("max : %lf, avg: %lf, strat cost: %lf, migration_cost: %lf, idealperiod : %d \n",
738 //      max, avg, adaptive_struct.lb_strategy_cost, adaptive_struct.lb_migration_cost, adaptive_struct.lb_ideal_period);
739 //
740
741   // If linearly varying load, then find lb_period
742   // area between the max and avg curve 
743   // If we can attain perfect balance, then the new load is close to the
744   // average. Hence we pass 1, else pass in some other value which would be the
745   // new max_load after load balancing.
746
747
748   return getPeriodForStrategy(1, 1, period);
749
750 //  int refine_period, scratch_period;
751 //  bool obtained_refine, obtained_scratch;
752 //  obtained_refine = getPeriodForStrategy(1, 1, refine_period);
753 //  obtained_scratch = getPeriodForStrategy(1, 1, scratch_period);
754 //
755 //  if (obtained_refine) {
756 //    if (!obtained_scratch) {
757 //      period = refine_period;
758 //      adaptive_struct.isRefine = true;
759 //      return true;
760 //    }
761 //    if (scratch_period < 1.1*refine_period) {
762 //      adaptive_struct.isRefine = false;
763 //      period = scratch_period;
764 //      return true;
765 //    }
766 //    period = refine_period;
767 //    adaptive_struct.isRefine = true;
768 //    return true;
769 //  }
770 //
771 //  if (obtained_scratch) {
772 //    period = scratch_period;
773 //    adaptive_struct.isRefine = false;
774 //    return true;
775 //  }
776 //  return false;
777 }
778
779 bool LBDatabase::getPeriodForStrategy(double new_load_percent, double overhead_percent, int& period) {
780   double mslope, aslope, mc, ac;
781   getLineEq(new_load_percent, aslope, ac, mslope, mc);
782   CkPrintf("\n max: %fx + %f; avg: %fx + %f\n", mslope, mc, aslope, ac);
783   double a = (mslope - aslope)/2;
784   double b = (mc - ac);
785   double c = -(adaptive_struct.lb_strategy_cost +
786       adaptive_struct.lb_migration_cost) * overhead_percent;
787   //c = -2.5;
788   bool got_period = getPeriodForLinear(a, b, c, period);
789   if (!got_period) {
790     return false;
791   }
792   
793   if (mslope < 0) {
794     if (period > (-mc/mslope)) {
795       CkPrintf("Max < 0 Period set when max load is -ve\n");
796       return false;
797     }
798   }
799
800   if (aslope < 0) {
801     if (period > (-ac/aslope)) {
802       CkPrintf("Avg < 0 Period set when avg load is -ve\n");
803       return false;
804     }
805   }
806
807   int intersection_t = (mc-ac) / (aslope - mslope);
808   if (intersection_t > 0 && period > intersection_t) {
809     CkPrintf("Avg | Max Period set when curves intersect\n");
810     return false;
811   }
812   return true;
813 }
814
815 bool LBDatabase::getPeriodForLinear(double a, double b, double c, int& period) {
816   CkPrintf("Quadratic Equation %lf X^2 + %lf X + %lf\n", a, b, c);
817   if (a == 0.0) {
818     period = (-c / b);
819     CkPrintf("Ideal period for linear load %d\n", period);
820     return true;
821   }
822   int x;
823   double t = (b * b) - (4*a*c);
824   if (t < 0) {
825     CkPrintf("(b * b) - (4*a*c) is -ve sqrt : %lf\n", sqrt(t));
826     return false;
827   }
828   t = (-b + sqrt(t)) / (2*a);
829   x = t;
830   if (x < 0) {
831     CkPrintf("boo!!! x (%d) < 0\n", x);
832     x = 0;
833     return false;
834   }
835   period = x;
836   CkPrintf("Ideal period for linear load %d\n", period);
837   return true;
838 }
839
840 bool LBDatabase::getLineEq(double new_load_percent, double& aslope, double& ac, double& mslope, double& mc) {
841   int total = adaptive_lbdb.history_data.size();
842   int iterations = 1 + adaptive_lbdb.history_data[total - 1].iteration -
843       adaptive_lbdb.history_data[0].iteration;
844   double a1 = 0;
845   double m1 = 0;
846   double a2 = 0;
847   double m2 = 0;
848   AdaptiveData data;
849   int i = 0;
850   for (i = 0; i < total/2; i++) {
851     data = adaptive_lbdb.history_data[i];
852     m1 += data.max_load;
853     a1 += data.avg_load;
854   }
855   m1 /= i;
856   a1 = (a1 * new_load_percent) / i;
857
858   for (i = total/2; i < total; i++) {
859     data = adaptive_lbdb.history_data[i];
860     m2 += data.max_load;
861     a2 += data.avg_load;
862   }
863   m2 /= (i - total/2);
864   a2 = (a2 * new_load_percent) / (i - total/2);
865
866   aslope = 2 * (a2 - a1) / iterations;
867   mslope = 2 * (m2 - m1) / iterations;
868   ac = adaptive_lbdb.history_data[0].avg_load * new_load_percent;
869   mc = adaptive_lbdb.history_data[0].max_load;
870   return true;
871 }
872
873 void LBDatabase::LoadBalanceDecision(int req_no, int period) {
874   if (req_no < adaptive_struct.lb_msg_recv_no) {
875     CkPrintf("Error!!! Received a request which was already sent or old\n");
876     return;
877   }
878   //CkPrintf("[%d] Load balance decision made cur iteration: %d period:%d state: %d\n",CkMyPe(), adaptive_struct.lb_no_iterations, period, local_state);
879   adaptive_struct.lb_ideal_period = period;
880   //local_state = ON;
881   adaptive_struct.lb_msg_recv_no = req_no;
882   thisProxy[0].ReceiveIterationNo(req_no, adaptive_struct.lb_no_iterations);
883 }
884
885 void LBDatabase::LoadBalanceDecisionFinal(int req_no, int period) {
886   if (req_no < adaptive_struct.lb_msg_recv_no) {
887     return;
888   }
889 //  CkPrintf("[%d] Final Load balance decision made cur iteration: %d period:%d \n",CkMyPe(), adaptive_struct.lb_no_iterations, period);
890   adaptive_struct.lb_ideal_period = period;
891   LDOMAdaptResumeSync(myLDHandle, period);
892
893 //  if (local_state == ON) {
894 //    local_state = DECIDED;
895 //    return;
896 //  }
897
898   // If the state is PAUSE, then its waiting for the final decision from central
899   // processor. If the decision is that the ideal period is in the future,
900   // resume. If the ideal period is now, then carry out load balancing.
901 //  if (local_state == PAUSE) {
902 //    if (adaptive_struct.lb_no_iterations < adaptive_struct.lb_ideal_period) {
903 //      local_state = DECIDED;
904 //      //SendMinStats();
905 //      //FIX ME!!! ResumeClients(0);
906 //    } else {
907 //      local_state = LOAD_BALANCE;
908 //      //FIX ME!!! ProcessAtSync();
909 //    }
910 //    return;
911 //  }
912 //  CkPrintf("Error!!! Final decision received but the state is invalid %d\n", local_state);
913 }
914
915
916 void LBDatabase::ReceiveIterationNo(int req_no, int local_iter_no) {
917   CmiAssert(CkMyPe() == 0);
918
919   adaptive_struct.global_recv_iter_counter++;
920   if (local_iter_no > adaptive_struct.global_max_iter_no) {
921     adaptive_struct.global_max_iter_no = local_iter_no;
922   }
923   if (CkNumPes() == adaptive_struct.global_recv_iter_counter) {
924     adaptive_struct.lb_ideal_period = (adaptive_struct.lb_ideal_period > adaptive_struct.global_max_iter_no) ? adaptive_struct.lb_ideal_period : adaptive_struct.global_max_iter_no + 1;
925     thisProxy.LoadBalanceDecisionFinal(req_no, adaptive_struct.lb_ideal_period);
926     CkPrintf("Final lb_period %d\n", adaptive_struct.lb_ideal_period);
927     adaptive_struct.in_progress = false;
928     adaptive_struct.global_max_iter_no = 0;
929     adaptive_struct.global_recv_iter_counter = 0;
930   }
931 }
932
933 int LBDatabase::getPredictedLBPeriod() {
934   return adaptive_struct.lb_ideal_period;
935 }
936
937 bool LBDatabase::isStrategyComm() {
938   return adaptive_struct.isCommLB;
939 }
940
941 /*
942   callable from user's code
943 */
944 void TurnManualLBOn()
945 {
946 #if CMK_LBDB_ON
947    LBDatabase * myLbdb = LBDatabase::Object();
948    if (myLbdb) {
949      myLbdb->TurnManualLBOn();
950    }
951    else {
952      LBDatabase::manualOn = 1;
953    }
954 #endif
955 }
956
957 void TurnManualLBOff()
958 {
959 #if CMK_LBDB_ON
960    LBDatabase * myLbdb = LBDatabase::Object();
961    if (myLbdb) {
962      myLbdb->TurnManualLBOff();
963    }
964    else {
965      LBDatabase::manualOn = 0;
966    }
967 #endif
968 }
969
970 extern "C" void LBTurnInstrumentOn() { 
971 #if CMK_LBDB_ON
972   if (CkpvAccess(lbdatabaseInited))
973     LBDatabase::Object()->CollectStatsOn(); 
974   else
975     _lb_args.statsOn() = 1;
976 #endif
977 }
978
979 extern "C" void LBTurnInstrumentOff() { 
980 #if CMK_LBDB_ON
981   if (CkpvAccess(lbdatabaseInited))
982     LBDatabase::Object()->CollectStatsOff(); 
983   else
984     _lb_args.statsOn() = 0;
985 #endif
986 }
987 void LBClearLoads() {
988 #if CMK_LBDB_ON
989   LBDatabase::Object()->ClearLoads(); 
990 #endif
991 }
992
993 void LBTurnPredictorOn(LBPredictorFunction *model) {
994 #if CMK_LBDB_ON
995   LBDatabase::Object()->PredictorOn(model);
996 #endif
997 }
998
999 void LBTurnPredictorOn(LBPredictorFunction *model, int wind) {
1000 #if CMK_LBDB_ON
1001   LBDatabase::Object()->PredictorOn(model, wind);
1002 #endif
1003 }
1004
1005 void LBTurnPredictorOff() {
1006 #if CMK_LBDB_ON
1007   LBDatabase::Object()->PredictorOff();
1008 #endif
1009 }
1010
1011 void LBChangePredictor(LBPredictorFunction *model) {
1012 #if CMK_LBDB_ON
1013   LBDatabase::Object()->ChangePredictor(model);
1014 #endif
1015 }
1016
1017 void LBSetPeriod(double second) {
1018 #if CMK_LBDB_ON
1019   if (CkpvAccess(lbdatabaseInited))
1020     LBDatabase::Object()->SetLBPeriod(second); 
1021   else
1022     _lb_args.lbperiod() = second;
1023 #endif
1024 }
1025
1026 #include "LBDatabase.def.h"
1027
1028 /*@}*/