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