Some tweaks
[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[5] += m[5];
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     lb_data[5] = idle_time/total_load_vec[iteration];
620
621     CkPrintf("[%d] sends total load %lf idle time %lf at iter %d\n", CkMyPe(),
622         total_load_vec[iteration], idle_time, adaptive_struct.lb_no_iterations);
623
624     CkCallback cb(CkIndex_LBDatabase::ReceiveMinStats((CkReductionMsg*)NULL), thisProxy[0]);
625     contribute(6*sizeof(double), lb_data, lbDataCollectionType, cb);
626   }
627   return true;
628 }
629
630 void LBDatabase::ReceiveMinStats(CkReductionMsg *msg) {
631   double* load = (double *) msg->getData();
632   double avg = load[2]/load[1];
633   double max = load[3];
634   double avg_idle = load[4]/load[1];
635   double max_idle = load[5];
636   int iteration_n = load[0];
637   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[3]);
638   delete msg;
639  
640   // Store the data for this iteration
641   adaptive_struct.lb_no_iterations = iteration_n;
642   AdaptiveData data;
643   data.iteration = adaptive_struct.lb_no_iterations;
644   data.max_load = max;
645   data.avg_load = avg;
646   data.max_idle_time = max_idle;
647   data.idle_time = avg_idle;
648   adaptive_lbdb.history_data.push_back(data);
649
650   // If lb period inform is in progress, dont inform again
651   if (adaptive_struct.in_progress) {
652     return;
653   }
654
655 //  if (adaptive_struct.lb_period_informed) {
656 //    return;
657 //  }
658
659   // If the max/avg ratio is greater than the threshold and also this is not the
660   // step immediately after load balancing, carry out load balancing
661   //if (max/avg >= 1.1 && adaptive_lbdb.history_data.size() > 4) {
662   if ((max_idle >= 0.1 || max/avg >= 1.5) && adaptive_lbdb.history_data.size() > 4) {
663     CkPrintf("Carry out load balancing step at iter max/avg(%lf) and max_idle ratio (%lf)\n", max/avg, max_idle);
664 //    if (!adaptive_struct.lb_period_informed) {
665 //      // Just for testing
666 //      adaptive_struct.lb_calculated_period = 40;
667 //      adaptive_struct.lb_period_informed = true;
668 //      thisProxy.LoadBalanceDecision(adaptive_struct.lb_calculated_period);
669 //      return;
670 //    }
671
672     adaptive_struct.isCommLB = false;
673
674     // If the new lb period is less than current set lb period
675     if (adaptive_struct.lb_calculated_period > iteration_n + 1) {
676       if (max/avg < 1.5) {
677         adaptive_struct.isCommLB = true;
678         CkPrintf("No load imbalance but idle time\n");
679       }
680       adaptive_struct.lb_calculated_period = iteration_n + 1;
681       adaptive_struct.lb_period_informed = true;
682       adaptive_struct.in_progress = true;
683       CkPrintf("Informing everyone the lb period is %d\n",
684           adaptive_struct.lb_calculated_period);
685       thisProxy.LoadBalanceDecision(adaptive_struct.lb_msg_send_no++, adaptive_struct.lb_calculated_period);
686     }
687     return;
688   }
689
690   // Generate the plan for the adaptive strategy
691   int period;
692   if (generatePlan(period)) {
693     //CkPrintf("Carry out load balancing step at iter\n");
694
695     // If the new lb period is less than current set lb period
696     if (adaptive_struct.lb_calculated_period > period) {
697       adaptive_struct.lb_calculated_period = period;
698       adaptive_struct.in_progress = true;
699       adaptive_struct.lb_period_informed = true;
700       CkPrintf("Informing everyone the lb period is %d\n",
701           adaptive_struct.lb_calculated_period);
702       thisProxy.LoadBalanceDecision(adaptive_struct.lb_msg_send_no++, adaptive_struct.lb_calculated_period);
703     }
704   }
705 }
706
707 bool LBDatabase::generatePlan(int& period) {
708   if (adaptive_lbdb.history_data.size() <= 8) {
709     return false;
710   }
711
712   // Some heuristics for lbperiod
713   // If constant load or almost constant,
714   // then max * new_lb_period > avg * new_lb_period + lb_cost
715   double max = 0.0;
716   double avg = 0.0;
717   AdaptiveData data;
718   for (int i = 0; i < adaptive_lbdb.history_data.size(); i++) {
719     data = adaptive_lbdb.history_data[i];
720     max += data.max_load;
721     avg += data.avg_load;
722     CkPrintf("max (%d, %lf) avg (%d, %lf)\n", i, data.max_load, i, data.avg_load);
723   }
724 //  max /= (adaptive_struct.lb_no_iterations - adaptive_lbdb.history_data[0].iteration);
725 //  avg /= (adaptive_struct.lb_no_iterations - adaptive_lbdb.history_data[0].iteration);
726 //
727 //  adaptive_struct.lb_ideal_period = (adaptive_struct.lb_strategy_cost +
728 //  adaptive_struct.lb_migration_cost) / (max - avg);
729 //  CkPrintf("max : %lf, avg: %lf, strat cost: %lf, migration_cost: %lf, idealperiod : %d \n",
730 //      max, avg, adaptive_struct.lb_strategy_cost, adaptive_struct.lb_migration_cost, adaptive_struct.lb_ideal_period);
731 //
732
733   // If linearly varying load, then find lb_period
734   // area between the max and avg curve 
735   // If we can attain perfect balance, then the new load is close to the
736   // average. Hence we pass 1, else pass in some other value which would be the
737   // new max_load after load balancing.
738
739
740   return getPeriodForStrategy(1, 1, period);
741
742 //  int refine_period, scratch_period;
743 //  bool obtained_refine, obtained_scratch;
744 //  obtained_refine = getPeriodForStrategy(1, 1, refine_period);
745 //  obtained_scratch = getPeriodForStrategy(1, 1, scratch_period);
746 //
747 //  if (obtained_refine) {
748 //    if (!obtained_scratch) {
749 //      period = refine_period;
750 //      adaptive_struct.isRefine = true;
751 //      return true;
752 //    }
753 //    if (scratch_period < 1.1*refine_period) {
754 //      adaptive_struct.isRefine = false;
755 //      period = scratch_period;
756 //      return true;
757 //    }
758 //    period = refine_period;
759 //    adaptive_struct.isRefine = true;
760 //    return true;
761 //  }
762 //
763 //  if (obtained_scratch) {
764 //    period = scratch_period;
765 //    adaptive_struct.isRefine = false;
766 //    return true;
767 //  }
768 //  return false;
769 }
770
771 bool LBDatabase::getPeriodForStrategy(double new_load_percent, double overhead_percent, int& period) {
772   double mslope, aslope, mc, ac;
773   getLineEq(new_load_percent, aslope, ac, mslope, mc);
774   CkPrintf("\n max: %fx + %f; avg: %fx + %f\n", mslope, mc, aslope, ac);
775   double a = (mslope - aslope)/2;
776   double b = (mc - ac);
777   double c = -(adaptive_struct.lb_strategy_cost +
778       adaptive_struct.lb_migration_cost) * overhead_percent;
779   //c = -2.5;
780   bool got_period = getPeriodForLinear(a, b, c, period);
781   if (!got_period) {
782     return false;
783   }
784   
785   if (mslope < 0) {
786     if (period > (-mc/mslope)) {
787       CkPrintf("Max < 0 Period set when max load is -ve\n");
788       return false;
789     }
790   }
791
792   if (aslope < 0) {
793     if (period > (-ac/aslope)) {
794       CkPrintf("Avg < 0 Period set when avg load is -ve\n");
795       return false;
796     }
797   }
798
799   int intersection_t = (mc-ac) / (aslope - mslope);
800   if (intersection_t > 0 && period > intersection_t) {
801     CkPrintf("Avg | Max Period set when curves intersect\n");
802     return false;
803   }
804   return true;
805 }
806
807 bool LBDatabase::getPeriodForLinear(double a, double b, double c, int& period) {
808   CkPrintf("Quadratic Equation %lf X^2 + %lf X + %lf\n", a, b, c);
809   if (a == 0.0) {
810     period = (-c / b);
811     CkPrintf("Ideal period for linear load %d\n", period);
812     return true;
813   }
814   int x;
815   double t = (b * b) - (4*a*c);
816   if (t < 0) {
817     CkPrintf("(b * b) - (4*a*c) is -ve sqrt : %lf\n", sqrt(t));
818     return false;
819   }
820   t = (-b + sqrt(t)) / (2*a);
821   x = t;
822   if (x < 0) {
823     CkPrintf("boo!!! x (%d) < 0\n", x);
824     x = 0;
825     return false;
826   }
827   period = x;
828   CkPrintf("Ideal period for linear load %d\n", period);
829   return true;
830 }
831
832 bool LBDatabase::getLineEq(double new_load_percent, double& aslope, double& ac, double& mslope, double& mc) {
833   int total = adaptive_lbdb.history_data.size();
834   int iterations = 1 + adaptive_lbdb.history_data[total - 1].iteration -
835       adaptive_lbdb.history_data[0].iteration;
836   double a1 = 0;
837   double m1 = 0;
838   double a2 = 0;
839   double m2 = 0;
840   AdaptiveData data;
841   int i = 0;
842   for (i = 0; i < total/2; i++) {
843     data = adaptive_lbdb.history_data[i];
844     m1 += data.max_load;
845     a1 += data.avg_load;
846   }
847   m1 /= i;
848   a1 = (a1 * new_load_percent) / i;
849
850   for (i = total/2; i < total; i++) {
851     data = adaptive_lbdb.history_data[i];
852     m2 += data.max_load;
853     a2 += data.avg_load;
854   }
855   m2 /= (i - total/2);
856   a2 = (a2 * new_load_percent) / (i - total/2);
857
858   aslope = 2 * (a2 - a1) / iterations;
859   mslope = 2 * (m2 - m1) / iterations;
860   ac = adaptive_lbdb.history_data[0].avg_load * new_load_percent;
861   mc = adaptive_lbdb.history_data[0].max_load;
862   return true;
863 }
864
865 void LBDatabase::LoadBalanceDecision(int req_no, int period) {
866   if (req_no < adaptive_struct.lb_msg_recv_no) {
867     CkPrintf("Error!!! Received a request which was already sent or old\n");
868     return;
869   }
870   //CkPrintf("[%d] Load balance decision made cur iteration: %d period:%d state: %d\n",CkMyPe(), adaptive_struct.lb_no_iterations, period, local_state);
871   adaptive_struct.lb_ideal_period = period;
872   //local_state = ON;
873   adaptive_struct.lb_msg_recv_no = req_no;
874   thisProxy[0].ReceiveIterationNo(req_no, adaptive_struct.lb_no_iterations);
875 }
876
877 void LBDatabase::LoadBalanceDecisionFinal(int req_no, int period) {
878   if (req_no < adaptive_struct.lb_msg_recv_no) {
879     return;
880   }
881 //  CkPrintf("[%d] Final Load balance decision made cur iteration: %d period:%d \n",CkMyPe(), adaptive_struct.lb_no_iterations, period);
882   adaptive_struct.lb_ideal_period = period;
883   LDOMAdaptResumeSync(myLDHandle, period);
884
885 //  if (local_state == ON) {
886 //    local_state = DECIDED;
887 //    return;
888 //  }
889
890   // If the state is PAUSE, then its waiting for the final decision from central
891   // processor. If the decision is that the ideal period is in the future,
892   // resume. If the ideal period is now, then carry out load balancing.
893 //  if (local_state == PAUSE) {
894 //    if (adaptive_struct.lb_no_iterations < adaptive_struct.lb_ideal_period) {
895 //      local_state = DECIDED;
896 //      //SendMinStats();
897 //      //FIX ME!!! ResumeClients(0);
898 //    } else {
899 //      local_state = LOAD_BALANCE;
900 //      //FIX ME!!! ProcessAtSync();
901 //    }
902 //    return;
903 //  }
904 //  CkPrintf("Error!!! Final decision received but the state is invalid %d\n", local_state);
905 }
906
907
908 void LBDatabase::ReceiveIterationNo(int req_no, int local_iter_no) {
909   CmiAssert(CkMyPe() == 0);
910
911   adaptive_struct.global_recv_iter_counter++;
912   if (local_iter_no > adaptive_struct.global_max_iter_no) {
913     adaptive_struct.global_max_iter_no = local_iter_no;
914   }
915   if (CkNumPes() == adaptive_struct.global_recv_iter_counter) {
916     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;
917     thisProxy.LoadBalanceDecisionFinal(req_no, adaptive_struct.lb_ideal_period);
918     CkPrintf("Final lb_period %d\n", adaptive_struct.lb_ideal_period);
919     adaptive_struct.in_progress = false;
920     adaptive_struct.global_max_iter_no = 0;
921     adaptive_struct.global_recv_iter_counter = 0;
922   }
923 }
924
925 int LBDatabase::getPredictedLBPeriod() {
926   return adaptive_struct.lb_ideal_period;
927 }
928
929 bool LBDatabase::isStrategyComm() {
930   return adaptive_struct.isCommLB;
931 }
932
933 /*
934   callable from user's code
935 */
936 void TurnManualLBOn()
937 {
938 #if CMK_LBDB_ON
939    LBDatabase * myLbdb = LBDatabase::Object();
940    if (myLbdb) {
941      myLbdb->TurnManualLBOn();
942    }
943    else {
944      LBDatabase::manualOn = 1;
945    }
946 #endif
947 }
948
949 void TurnManualLBOff()
950 {
951 #if CMK_LBDB_ON
952    LBDatabase * myLbdb = LBDatabase::Object();
953    if (myLbdb) {
954      myLbdb->TurnManualLBOff();
955    }
956    else {
957      LBDatabase::manualOn = 0;
958    }
959 #endif
960 }
961
962 extern "C" void LBTurnInstrumentOn() { 
963 #if CMK_LBDB_ON
964   if (CkpvAccess(lbdatabaseInited))
965     LBDatabase::Object()->CollectStatsOn(); 
966   else
967     _lb_args.statsOn() = 1;
968 #endif
969 }
970
971 extern "C" void LBTurnInstrumentOff() { 
972 #if CMK_LBDB_ON
973   if (CkpvAccess(lbdatabaseInited))
974     LBDatabase::Object()->CollectStatsOff(); 
975   else
976     _lb_args.statsOn() = 0;
977 #endif
978 }
979 void LBClearLoads() {
980 #if CMK_LBDB_ON
981   LBDatabase::Object()->ClearLoads(); 
982 #endif
983 }
984
985 void LBTurnPredictorOn(LBPredictorFunction *model) {
986 #if CMK_LBDB_ON
987   LBDatabase::Object()->PredictorOn(model);
988 #endif
989 }
990
991 void LBTurnPredictorOn(LBPredictorFunction *model, int wind) {
992 #if CMK_LBDB_ON
993   LBDatabase::Object()->PredictorOn(model, wind);
994 #endif
995 }
996
997 void LBTurnPredictorOff() {
998 #if CMK_LBDB_ON
999   LBDatabase::Object()->PredictorOff();
1000 #endif
1001 }
1002
1003 void LBChangePredictor(LBPredictorFunction *model) {
1004 #if CMK_LBDB_ON
1005   LBDatabase::Object()->ChangePredictor(model);
1006 #endif
1007 }
1008
1009 void LBSetPeriod(double second) {
1010 #if CMK_LBDB_ON
1011   if (CkpvAccess(lbdatabaseInited))
1012     LBDatabase::Object()->SetLBPeriod(second); 
1013   else
1014     _lb_args.lbperiod() = second;
1015 #endif
1016 }
1017
1018 #include "LBDatabase.def.h"
1019
1020 /*@}*/