working version on BGP
[charm.git] / src / ck-core / cklocation.C
1 /** \file cklocation.C
2  *  \addtogroup CkArrayImpl
3  *
4  *  The location manager keeps track of an indexed set of migratable objects.
5  *  It is used by the array manager to locate array elements, interact with the
6  *  load balancer, and perform migrations.
7  *
8  *  Orion Sky Lawlor, olawlor@acm.org 9/29/2001
9  */
10
11 #include "charm++.h"
12 #include "register.h"
13 #include "ck.h"
14 #include "trace.h"
15 #include "TopoManager.h"
16 #include <vector>
17 #include<sstream>
18
19 #if CMK_LBDB_ON
20 #include "LBDatabase.h"
21 #include "MetaBalancer.h"
22 #if CMK_GLOBAL_LOCATION_UPDATE
23 #include "BaseLB.h"
24 #include "init.h"
25 #endif
26 #endif // CMK_LBDB_ON
27
28 #if CMK_GRID_QUEUE_AVAILABLE
29 CpvExtern(void *, CkGridObject);
30 #endif
31
32 static const char *idx2str(const CkArrayMessage *m) {
33   return idx2str(((CkArrayMessage *)m)->array_index());
34 }
35
36 #define ARRAY_DEBUG_OUTPUT 0
37
38 #if ARRAY_DEBUG_OUTPUT 
39 #   define DEB(x) CkPrintf x  //General debug messages
40 #   define DEBI(x) CkPrintf x  //Index debug messages
41 #   define DEBC(x) CkPrintf x  //Construction debug messages
42 #   define DEBS(x) CkPrintf x  //Send/recv/broadcast debug messages
43 #   define DEBM(x) CkPrintf x  //Migration debug messages
44 #   define DEBL(x) CkPrintf x  //Load balancing debug messages
45 #   define DEBK(x) CkPrintf x  //Spring Cleaning debug messages
46 #   define DEBB(x) CkPrintf x  //Broadcast debug messages
47 #   define AA "LocMgr on %d: "
48 #   define AB ,CkMyPe()
49 #   define DEBUG(x) CkPrintf x
50 #   define DEBAD(x) CkPrintf x
51 #else
52 #   define DEB(X) /*CkPrintf x*/
53 #   define DEBI(X) /*CkPrintf x*/
54 #   define DEBC(X) /*CkPrintf x*/
55 #   define DEBS(x) /*CkPrintf x*/
56 #   define DEBM(X) /*CkPrintf x*/
57 #   define DEBL(X) /*CkPrintf x*/
58 #   define DEBK(x) /*CkPrintf x*/
59 #   define DEBB(x) /*CkPrintf x*/
60 #   define str(x) /**/
61 #   define DEBUG(x)   /**/
62 #   define DEBAD(x) /*CkPrintf x*/
63 #endif
64
65 //whether to use block mapping in the SMP node level
66 bool useNodeBlkMapping;
67
68 #if CMK_LBDB_ON
69 /*LBDB object handles are fixed-sized, and not necc.
70 the same size as ArrayIndices.
71 */
72 LDObjid idx2LDObjid(const CkArrayIndex &idx)
73 {
74   LDObjid r;
75   int i;
76   const int *data=idx.data();
77   if (OBJ_ID_SZ>=idx.nInts) {
78     for (i=0;i<idx.nInts;i++)
79       r.id[i]=data[i];
80     for (i=idx.nInts;i<OBJ_ID_SZ;i++)
81       r.id[i]=0;
82   } else {
83     //Must hash array index into LBObjid
84     int j;
85     for (j=0;j<OBJ_ID_SZ;j++)
86         r.id[j]=data[j];
87     for (i=0;i<idx.nInts;i++)
88       for (j=0;j<OBJ_ID_SZ;j++)
89         r.id[j]+=circleShift(data[i],22+11*i*(j+1))+
90           circleShift(data[i],21-9*i*(j+1));
91   }
92
93 #if CMK_GLOBAL_LOCATION_UPDATE
94   r.dimension = idx.dimension;
95   r.nInts = idx.nInts; 
96   r.isArrayElement = 1; 
97 #endif
98
99   return r;
100 }
101
102 #if CMK_GLOBAL_LOCATION_UPDATE
103 void UpdateLocation(MigrateInfo& migData) {
104
105   if (migData.obj.id.isArrayElement == 0) {
106     return;
107   }
108
109   CkArrayIndex idx; 
110   idx.dimension = migData.obj.id.dimension; 
111   idx.nInts = migData.obj.id.nInts; 
112
113   for (int i = 0; i < idx.nInts; i++) {
114     idx.data()[i] = migData.obj.id.id[i];    
115   }
116
117   CkGroupID locMgrGid;
118   locMgrGid.idx = migData.obj.id.locMgrGid;
119   CkLocMgr *localLocMgr = (CkLocMgr *) CkLocalBranch(locMgrGid);
120   localLocMgr->updateLocation(idx, migData.to_pe); 
121 }
122 #endif
123
124 #endif
125
126 /*********************** Array Messages ************************/
127 CkArrayIndex &CkArrayMessage::array_index(void)
128 {
129     return UsrToEnv((void *)this)->getsetArrayIndex();
130 }
131 unsigned short &CkArrayMessage::array_ep(void)
132 {
133         return UsrToEnv((void *)this)->getsetArrayEp();
134 }
135 unsigned short &CkArrayMessage::array_ep_bcast(void)
136 {
137         return UsrToEnv((void *)this)->getsetArrayBcastEp();
138 }
139 unsigned char &CkArrayMessage::array_hops(void)
140 {
141         return UsrToEnv((void *)this)->getsetArrayHops();
142 }
143 unsigned int CkArrayMessage::array_getSrcPe(void)
144 {
145         return UsrToEnv((void *)this)->getsetArraySrcPe();
146 }
147 unsigned int CkArrayMessage::array_ifNotThere(void)
148 {
149         return UsrToEnv((void *)this)->getArrayIfNotThere();
150 }
151 void CkArrayMessage::array_setIfNotThere(unsigned int i)
152 {
153         UsrToEnv((void *)this)->setArrayIfNotThere(i);
154 }
155
156 /*********************** Array Map ******************
157 Given an array element index, an array map tells us 
158 the index's "home" Pe.  This is the Pe the element will
159 be created on, and also where messages to this element will
160 be forwarded by default.
161 */
162
163 CkArrayMap::CkArrayMap(void) { }
164 CkArrayMap::~CkArrayMap() { }
165 int CkArrayMap::registerArray(CkArrayIndex& numElements,CkArrayID aid)
166 {return 0;}
167
168 #define CKARRAYMAP_POPULATE_INITIAL(POPULATE_CONDITION) \
169         int i; \
170         for (int i1=0; i1<numElements.data()[0]; i1++) { \
171           if (numElements.dimension == 1) { \
172             /* Make 1D indices */ \
173             i = i1; \
174             CkArrayIndex1D idx(i1); \
175             if (POPULATE_CONDITION) \
176               mgr->insertInitial(idx,CkCopyMsg(&ctorMsg)); \
177           } else { \
178             /* higher dimensionality */ \
179             for (int i2=0; i2<numElements.data()[1]; i2++) { \
180               if (numElements.dimension == 2) { \
181                 /* Make 2D indices */ \
182                 i = i1 * numElements.data()[1] + i2; \
183                 CkArrayIndex2D idx(i1, i2); \
184                 if (POPULATE_CONDITION) \
185                   mgr->insertInitial(idx,CkCopyMsg(&ctorMsg)); \
186               } else { \
187                 /* higher dimensionality */ \
188                 CkAssert(numElements.dimension == 3); \
189                 for (int i3=0; i3<numElements.data()[2]; i3++) { \
190                   /* Make 3D indices */ \
191                   i = (i1 * numElements.data()[1] + i2) * numElements.data()[2] + i3; \
192                   CkArrayIndex3D idx(i1, i2, i3 ); \
193                   if (POPULATE_CONDITION) \
194                     mgr->insertInitial(idx,CkCopyMsg(&ctorMsg)); \
195                 } \
196               } \
197             } \
198           } \
199         }
200
201 void CkArrayMap::populateInitial(int arrayHdl,CkArrayIndex& numElements,void *ctorMsg,CkArrMgr *mgr)
202 {
203         if (numElements.nInts==0) {
204           CkFreeMsg(ctorMsg);
205           return;
206         }
207         int thisPe=CkMyPe();
208         /* The CkArrayIndex is supposed to have at most 3 dimensions, which
209            means that all the fields are ints, and numElements.nInts represents
210            how many of them are used */
211         CKARRAYMAP_POPULATE_INITIAL(procNum(arrayHdl,idx)==thisPe);
212
213 #if CMK_BIGSIM_CHARM
214         BgEntrySplit("split-array-new-end");
215 #endif
216
217         mgr->doneInserting();
218         CkFreeMsg(ctorMsg);
219 }
220
221 CkGroupID _defaultArrayMapID;
222 CkGroupID _fastArrayMapID;
223
224 class RRMap : public CkArrayMap
225 {
226 public:
227   RRMap(void)
228   {
229           DEBC((AA"Creating RRMap\n"AB));
230   }
231   RRMap(CkMigrateMessage *m):CkArrayMap(m){}
232   int procNum(int /*arrayHdl*/, const CkArrayIndex &i)
233   {
234 #if 1
235     if (i.nInts==1) {
236       //Map 1D integer indices in simple round-robin fashion
237       int ans= (i.data()[0])%CkNumPes();
238       while(!CmiNodeAlive(ans) || (ans == CkMyPe() && CkpvAccess(startedEvac))){
239         ans = (ans +1 )%CkNumPes();
240       }
241       return ans;
242     }
243     else 
244 #endif
245       {
246         //Map other indices based on their hash code, mod a big prime.
247         unsigned int hash=(i.hash()+739)%1280107;
248         int ans = (hash % CkNumPes());
249         while(!CmiNodeAlive(ans)){
250                 ans = (ans +1 )%CkNumPes();
251         }
252         return ans;
253
254       }
255   }
256 };
257
258 /** 
259  * Class used to store the dimensions of the array and precalculate numChares,
260  * binSize and other values for the DefaultArrayMap -- ASB
261  */
262 class arrayMapInfo {
263 public:
264   CkArrayIndex _nelems;
265   int _binSizeFloor;            /* floor of numChares/numPes */
266   int _binSizeCeil;             /* ceiling of numChares/numPes */
267   int _numChares;               /* initial total number of chares */
268   int _remChares;               /* numChares % numPes -- equals the number of
269                                    processors in the first set */
270   int _numFirstSet;             /* _remChares X (_binSize + 1) -- number of
271                                    chares in the first set */
272
273   int _nBinSizeFloor;           /* floor of numChares/numNodes */
274   int _nRemChares;              /* numChares % numNodes -- equals the number of
275                                    nodes in the first set */
276   int _nNumFirstSet;            /* _remChares X (_binSize + 1) -- number of
277                                    chares in the first set of nodes */
278
279   /** All processors are divided into two sets. Processors in the first set
280    *  have one chare more than the processors in the second set. */
281
282   arrayMapInfo(void) { }
283
284   arrayMapInfo(CkArrayIndex& n) : _nelems(n), _numChares(0) {
285     compute_binsize();
286   }
287
288   ~arrayMapInfo() {}
289   
290   void compute_binsize()
291   {
292     int numPes = CkNumPes();
293     //Now assuming homogenous nodes where each node has the same number of PEs
294     int numNodes = CkNumNodes();
295
296     if (_nelems.nInts == 1) {
297       _numChares = _nelems.data()[0];
298     } else if (_nelems.nInts == 2) {
299       _numChares = _nelems.data()[0] * _nelems.data()[1];
300     } else if (_nelems.nInts == 3) {
301       _numChares = _nelems.data()[0] * _nelems.data()[1] * _nelems.data()[2];
302     }
303
304     _remChares = _numChares % numPes;
305     _binSizeFloor = (int)floor((double)_numChares/(double)numPes);
306     _binSizeCeil = (int)ceil((double)_numChares/(double)numPes);
307     _numFirstSet = _remChares * (_binSizeFloor + 1);
308
309     _nRemChares = _numChares % numNodes;
310     _nBinSizeFloor = _numChares/numNodes;
311     _nNumFirstSet = _nRemChares * (_nBinSizeFloor +1);
312   }
313
314   void pup(PUP::er& p){
315     p|_nelems;
316     p|_binSizeFloor;
317     p|_binSizeCeil;
318     p|_numChares;
319     p|_remChares;
320     p|_numFirstSet;
321     p|_nRemChares;
322     p|_nBinSizeFloor;
323     p|_nNumFirstSet;
324   }
325 }c;
326
327
328 /**
329  * The default map object -- This does blocked mapping in the general case and
330  * calls the round-robin procNum for the dynamic insertion case -- ASB
331  */
332 class DefaultArrayMap : public RRMap
333 {
334 public:
335   /** This array stores information about different chare arrays in a Charm
336    *  program (dimensions, binsize, numChares etc ... ) */
337   CkPupPtrVec<arrayMapInfo> amaps;
338
339 public:
340   DefaultArrayMap(void) {
341     DEBC((AA"Creating DefaultArrayMap\n"AB));
342   }
343
344   DefaultArrayMap(CkMigrateMessage *m) : RRMap(m){}
345
346   int registerArray(CkArrayIndex& numElements, CkArrayID aid)
347   {
348     int idx = amaps.size();
349     amaps.resize(idx+1);
350     amaps[idx] = new arrayMapInfo(numElements);
351     return idx;
352   }
353  
354   int procNum(int arrayHdl, const CkArrayIndex &i) {
355     int flati;
356     if (amaps[arrayHdl]->_nelems.nInts == 0) {
357       return RRMap::procNum(arrayHdl, i);
358     }
359
360     if (i.nInts == 1) {
361       flati = i.data()[0];
362     } else if (i.nInts == 2) {
363       flati = i.data()[0] * amaps[arrayHdl]->_nelems.data()[1] + i.data()[1];
364     } else if (i.nInts == 3) {
365       flati = (i.data()[0] * amaps[arrayHdl]->_nelems.data()[1] + i.data()[1]) * amaps[arrayHdl]->_nelems.data()[2] + i.data()[2];
366     }
367 #if CMK_ERROR_CHECKING
368     else {
369       CkAbort("CkArrayIndex has more than 3 integers!");
370     }
371 #endif
372
373     if(useNodeBlkMapping){
374       if(flati < amaps[arrayHdl]->_numChares){
375         int numCharesOnNode = amaps[arrayHdl]->_nBinSizeFloor;
376         int startNodeID, offsetInNode;
377         if(flati < amaps[arrayHdl]->_nNumFirstSet){
378           numCharesOnNode++;
379           startNodeID = flati/numCharesOnNode;
380           offsetInNode = flati%numCharesOnNode;
381         }else{
382           startNodeID = amaps[arrayHdl]->_nRemChares+(flati-amaps[arrayHdl]->_nNumFirstSet)/numCharesOnNode;
383           offsetInNode = (flati-amaps[arrayHdl]->_nNumFirstSet)%numCharesOnNode;
384         }
385         int nodeSize = CkMyNodeSize(); //assuming every node has same number of PEs
386         int elemsPerPE = numCharesOnNode/nodeSize;
387         int remElems = numCharesOnNode%nodeSize;
388         int firstSetPEs = remElems*(elemsPerPE+1);
389         if(offsetInNode<firstSetPEs){
390           return CkNodeFirst(startNodeID)+offsetInNode/(elemsPerPE+1);
391         }else{
392           return CkNodeFirst(startNodeID)+remElems+(offsetInNode-firstSetPEs)/elemsPerPE;
393         }
394       } else
395           return (flati % CkNumPes());
396     }
397     //regular PE-based block mapping
398     if(flati < amaps[arrayHdl]->_numFirstSet)
399       return (flati / (amaps[arrayHdl]->_binSizeFloor + 1));
400     else if (flati < amaps[arrayHdl]->_numChares)
401       return (amaps[arrayHdl]->_remChares + (flati - amaps[arrayHdl]->_numFirstSet) / (amaps[arrayHdl]->_binSizeFloor));
402     else
403       return (flati % CkNumPes());
404   }
405
406   void pup(PUP::er& p){
407     RRMap::pup(p);
408     int npes = CkNumPes();
409     p|npes;
410     p|amaps;
411     if (p.isUnpacking() && npes != CkNumPes())  {   // binSize needs update
412       for (int i=0; i<amaps.size(); i++)
413         amaps[i]->compute_binsize();
414     }
415   }
416 };
417
418 /**
419  *  A fast map for chare arrays which do static insertions and promise NOT
420  *  to do late insertions -- ASB
421  */
422 class FastArrayMap : public DefaultArrayMap
423 {
424 public:
425   FastArrayMap(void) {
426     DEBC((AA"Creating FastArrayMap\n"AB));
427   }
428
429   FastArrayMap(CkMigrateMessage *m) : DefaultArrayMap(m){}
430
431   int registerArray(CkArrayIndex& numElements, CkArrayID aid)
432   {
433     int idx;
434     idx = DefaultArrayMap::registerArray(numElements, aid);
435
436     return idx;
437   }
438
439   int procNum(int arrayHdl, const CkArrayIndex &i) {
440     int flati;
441     if (amaps[arrayHdl]->_nelems.nInts == 0) {
442       return RRMap::procNum(arrayHdl, i);
443     }
444
445     if (i.nInts == 1) {
446       flati = i.data()[0];
447     } else if (i.nInts == 2) {
448       flati = i.data()[0] * amaps[arrayHdl]->_nelems.data()[1] + i.data()[1];
449     } else if (i.nInts == 3) {
450       flati = (i.data()[0] * amaps[arrayHdl]->_nelems.data()[1] + i.data()[1]) * amaps[arrayHdl]->_nelems.data()[2] + i.data()[2];
451     }
452 #if CMK_ERROR_CHECKING
453     else {
454       CkAbort("CkArrayIndex has more than 3 integers!");
455     }
456 #endif
457
458     /** binSize used in DefaultArrayMap is the floor of numChares/numPes
459      *  but for this FastArrayMap, we need the ceiling */
460     return (flati / amaps[arrayHdl]->_binSizeCeil);
461   }
462
463   void pup(PUP::er& p){
464     DefaultArrayMap::pup(p);
465   }
466 };
467
468
469 /**
470  * This map can be used for topology aware mapping when the mapping is provided
471  * through a file -- ASB
472  */
473 class ReadFileMap : public DefaultArrayMap
474 {
475 private:
476   CkVec<int> mapping;
477
478 public:
479   ReadFileMap(void) {
480     DEBC((AA"Creating ReadFileMap\n"AB));
481   }
482
483   ReadFileMap(CkMigrateMessage *m) : DefaultArrayMap(m){}
484
485   int registerArray(CkArrayIndex& numElements, CkArrayID aid)
486   {
487     int idx;
488     idx = DefaultArrayMap::registerArray(numElements, aid);
489
490     if(mapping.size() == 0) {
491       int numChares;
492
493       if (amaps[idx]->_nelems.nInts == 1) {
494         numChares = amaps[idx]->_nelems.data()[0];
495       } else if (amaps[idx]->_nelems.nInts == 2) {
496         numChares = amaps[idx]->_nelems.data()[0] * amaps[idx]->_nelems.data()[1];
497       } else if (amaps[idx]->_nelems.nInts == 3) {
498         numChares = amaps[idx]->_nelems.data()[0] * amaps[idx]->_nelems.data()[1] * amaps[idx]->_nelems.data()[2];
499       } else {
500         CkAbort("CkArrayIndex has more than 3 integers!");
501       }
502
503       mapping.resize(numChares);
504       FILE *mapf = fopen("mapfile", "r");
505       TopoManager tmgr;
506       int x, y, z, t;
507
508       for(int i=0; i<numChares; i++) {
509         (void) fscanf(mapf, "%d %d %d %d", &x, &y, &z, &t);
510         mapping[i] = tmgr.coordinatesToRank(x, y, z, t);
511       }
512       fclose(mapf);
513     }
514
515     return idx;
516   }
517
518   int procNum(int arrayHdl, const CkArrayIndex &i) {
519     int flati;
520
521     if (i.nInts == 1) {
522       flati = i.data()[0];
523     } else if (i.nInts == 2) {
524       flati = i.data()[0] * amaps[arrayHdl]->_nelems.data()[1] + i.data()[1];
525     } else if (i.nInts == 3) {
526       flati = (i.data()[0] * amaps[arrayHdl]->_nelems.data()[1] + i.data()[1]) * amaps[arrayHdl]->_nelems.data()[2] + i.data()[2];
527     } else {
528       CkAbort("CkArrayIndex has more than 3 integers!");
529     }
530
531     return mapping[flati];
532   }
533
534   void pup(PUP::er& p){
535     DefaultArrayMap::pup(p);
536     p|mapping;
537   }
538 };
539
540 class BlockMap : public RRMap
541 {
542 public:
543   BlockMap(void){
544         DEBC((AA"Creating BlockMap\n"AB));
545   }
546   BlockMap(CkMigrateMessage *m):RRMap(m){ }
547   void populateInitial(int arrayHdl,CkArrayIndex& numElements,void *ctorMsg,CkArrMgr *mgr){
548         if (numElements.nInts==0) {
549           CkFreeMsg(ctorMsg);
550           return;
551         }
552         int thisPe=CkMyPe();
553         int numPes=CkNumPes();
554         int binSize;
555         if (numElements.nInts == 1) {
556           binSize = (int)ceil((double)numElements.data()[0]/(double)numPes);
557         } else if (numElements.nInts == 2) {
558           binSize = (int)ceil((double)(numElements.data()[0]*numElements.data()[1])/(double)numPes);
559         } else if (numElements.nInts == 3) {
560           binSize = (int)ceil((double)(numElements.data()[0]*numElements.data()[1]*numElements.data()[2])/(double)numPes);
561         } else {
562           CkAbort("CkArrayIndex has more than 3 integers!");
563         }
564         CKARRAYMAP_POPULATE_INITIAL(i/binSize==thisPe);
565
566         /*
567         CkArrayIndex idx;
568         for (idx=numElements.begin(); idx<numElements; idx.getNext(numElements)) {
569           //for (int i=0;i<numElements;i++) {
570                 int binSize = (int)ceil((double)numElements.getCombinedCount()/(double)numPes);
571                 if (i/binSize==thisPe)
572                         mgr->insertInitial(idx,CkCopyMsg(&ctorMsg));
573         }*/
574         mgr->doneInserting();
575         CkFreeMsg(ctorMsg);
576   }
577 };
578
579 /**
580  * map object-- use seed load balancer.  
581  */
582 class CldMap : public CkArrayMap
583 {
584 public:
585   CldMap(void)
586   {
587           DEBC((AA"Creating CldMap\n"AB));
588   }
589   CldMap(CkMigrateMessage *m):CkArrayMap(m){}
590   int homePe(int /*arrayHdl*/, const CkArrayIndex &i)
591   {
592     if (i.nInts==1) {
593       //Map 1D integer indices in simple round-robin fashion
594       return (i.data()[0])%CkNumPes();
595     }
596     else 
597       {
598         //Map other indices based on their hash code, mod a big prime.
599         unsigned int hash=(i.hash()+739)%1280107;
600         return (hash % CkNumPes());
601       }
602   }
603   int procNum(int arrayHdl, const CkArrayIndex &i)
604   {
605      return CLD_ANYWHERE;   // -1
606   }
607   void populateInitial(int arrayHdl,CkArrayIndex& numElements,void *ctorMsg,CkArrMgr *mgr)  {
608         if (numElements.nInts==0) {
609           CkFreeMsg(ctorMsg);
610           return;
611         }
612         int thisPe=CkMyPe();
613         int numPes=CkNumPes();
614         //CkArrayIndex idx;
615
616         CKARRAYMAP_POPULATE_INITIAL(i%numPes==thisPe);
617         /*for (idx=numElements.begin(); idx<numElements; idx.getNext(numElements)) {
618           //for (int i=0;i<numElements;i++)
619                         if((idx.getRank(numElements))%numPes==thisPe)
620                                 mgr->insertInitial(CkArrayIndex1D(i),CkCopyMsg(&ctorMsg),0);
621         }*/
622         mgr->doneInserting();
623         CkFreeMsg(ctorMsg);
624   }
625
626 };
627
628
629 /// A class responsible for parsing the command line arguments for the PE
630 /// to extract the format string passed in with +ConfigurableRRMap
631 class ConfigurableRRMapLoader {
632 public:
633   
634   int *locations;
635   int objs_per_block;
636   int PE_per_block;
637
638   /// labels for states used when parsing the ConfigurableRRMap from ARGV
639   enum ConfigurableRRMapLoadStatus{
640     not_loaded,
641     loaded_found,
642     loaded_not_found
643   };
644   
645   enum ConfigurableRRMapLoadStatus state;
646   
647   ConfigurableRRMapLoader(){
648     state = not_loaded;
649     locations = NULL;
650     objs_per_block = 0;
651     PE_per_block = 0;
652   }
653   
654   /// load configuration if possible, and return whether a valid configuration exists
655   bool haveConfiguration() {
656     if(state == not_loaded) {
657       DEBUG(("[%d] loading ConfigurableRRMap configuration\n", CkMyPe()));
658       char **argv=CkGetArgv();
659       char *configuration = NULL;
660       bool found = CmiGetArgString(argv, "+ConfigurableRRMap", &configuration);
661       if(!found){
662         DEBUG(("Couldn't find +ConfigurableRRMap command line argument\n"));
663         state = loaded_not_found;
664         return false;
665       } else {
666
667         DEBUG(("Found +ConfigurableRRMap command line argument in %p=\"%s\"\n", configuration, configuration));
668
669         std::istringstream instream(configuration);
670         CkAssert(instream.good());
671          
672         // Example line:
673         // 10 8 0 1 2 3 4 5 6 7 7 7 7
674         // Map 10 objects to 8 PEs, with each object's index among the 8 PEs.
675         
676         // extract first integer
677         instream >> objs_per_block >> PE_per_block;
678         CkAssert(instream.good());
679         CkAssert(objs_per_block > 0);
680         CkAssert(PE_per_block > 0);
681         locations = new int[objs_per_block];
682         for(int i=0;i<objs_per_block;i++){
683           locations[i] = 0;
684           CkAssert(instream.good());
685           instream >> locations[i];
686           CkAssert(locations[i] < PE_per_block);
687         }
688         state = loaded_found;
689         return true;
690       }
691
692     } else {
693       DEBUG(("[%d] ConfigurableRRMap has already been loaded\n", CkMyPe()));
694       return state == loaded_found;
695     }      
696      
697   }
698   
699 };
700
701 CkpvDeclare(ConfigurableRRMapLoader, myConfigRRMapState);
702
703 void _initConfigurableRRMap(){
704   CkpvInitialize(ConfigurableRRMapLoader, myConfigRRMapState);
705 }
706
707
708 /// Try to load the command line arguments for ConfigurableRRMap
709 bool haveConfigurableRRMap(){
710   DEBUG(("haveConfigurableRRMap()\n"));
711   ConfigurableRRMapLoader &loader =  CkpvAccess(myConfigRRMapState);
712   return loader.haveConfiguration();
713 }
714
715 class ConfigurableRRMap : public RRMap
716 {
717 public:
718   ConfigurableRRMap(void){
719         DEBC((AA"Creating ConfigurableRRMap\n"AB));
720   }
721   ConfigurableRRMap(CkMigrateMessage *m):RRMap(m){ }
722
723
724   void populateInitial(int arrayHdl,CkArrayIndex& numElements,void *ctorMsg,CkArrMgr *mgr){
725     // Try to load the configuration from command line argument
726     CkAssert(haveConfigurableRRMap());
727     ConfigurableRRMapLoader &loader =  CkpvAccess(myConfigRRMapState);
728     if (numElements.nInts==0) {
729       CkFreeMsg(ctorMsg);
730       return;
731     }
732     int thisPe=CkMyPe();
733     int maxIndex = numElements.data()[0];
734     DEBUG(("[%d] ConfigurableRRMap: index=%d,%d,%d\n", CkMyPe(),(int)numElements.data()[0], (int)numElements.data()[1], (int)numElements.data()[2]));
735
736     if (numElements.nInts != 1) {
737       CkAbort("ConfigurableRRMap only supports dimension 1!");
738     }
739         
740     for (int index=0; index<maxIndex; index++) {        
741       CkArrayIndex1D idx(index);                
742       
743       int cyclic_block = index / loader.objs_per_block;
744       int cyclic_local = index % loader.objs_per_block;
745       int l = loader.locations[ cyclic_local ];
746       int PE = (cyclic_block*loader.PE_per_block + l) % CkNumPes();
747
748       DEBUG(("[%d] ConfigurableRRMap: index=%d is located on PE %d l=%d\n", CkMyPe(), (int)index, (int)PE, l));
749
750       if(PE == thisPe)
751         mgr->insertInitial(idx,CkCopyMsg(&ctorMsg));
752
753     }
754     //        CKARRAYMAP_POPULATE_INITIAL(PE == thisPe);
755         
756     mgr->doneInserting();
757     CkFreeMsg(ctorMsg);
758   }
759 };
760
761
762 CkpvStaticDeclare(double*, rem);
763
764 class arrInfo {
765  private:
766    CkArrayIndex _nelems;
767    int *_map;
768    void distrib(int *speeds);
769  public:
770    arrInfo(void):_map(NULL){}
771    arrInfo(CkArrayIndex& n, int *speeds)
772    {
773      _nelems = n;
774      _map = new int[_nelems.getCombinedCount()];
775      distrib(speeds);
776    }
777    ~arrInfo() { delete[] _map; }
778    int getMap(const CkArrayIndex &i);
779    void pup(PUP::er& p){
780      p|_nelems;
781      int totalElements = _nelems.getCombinedCount();
782      if(p.isUnpacking()){
783        _map = new int[totalElements];
784      }
785      p(_map,totalElements);
786    }
787 };
788
789 static int cmp(const void *first, const void *second)
790 {
791   int fi = *((const int *)first);
792   int si = *((const int *)second);
793   return ((CkpvAccess(rem)[fi]==CkpvAccess(rem)[si]) ?
794           0 :
795           ((CkpvAccess(rem)[fi]<CkpvAccess(rem)[si]) ?
796           1 : (-1)));
797 }
798
799 void
800 arrInfo::distrib(int *speeds)
801 {
802   int _nelemsCount = _nelems.getCombinedCount();
803   double total = 0.0;
804   int npes = CkNumPes();
805   int i,j,k;
806   for(i=0;i<npes;i++)
807     total += (double) speeds[i];
808   double *nspeeds = new double[npes];
809   for(i=0;i<npes;i++)
810     nspeeds[i] = (double) speeds[i] / total;
811   int *cp = new int[npes];
812   for(i=0;i<npes;i++)
813     cp[i] = (int) (nspeeds[i]*_nelemsCount);
814   int nr = 0;
815   for(i=0;i<npes;i++)
816     nr += cp[i];
817   nr = _nelemsCount - nr;
818   if(nr != 0)
819   {
820     CkpvAccess(rem) = new double[npes];
821     for(i=0;i<npes;i++)
822       CkpvAccess(rem)[i] = (double)_nelemsCount*nspeeds[i] - cp[i];
823     int *pes = new int[npes];
824     for(i=0;i<npes;i++)
825       pes[i] = i;
826     qsort(pes, npes, sizeof(int), cmp);
827     for(i=0;i<nr;i++)
828       cp[pes[i]]++;
829     delete[] pes;
830     delete[] CkpvAccess(rem);
831   }
832   k = 0;
833   for(i=0;i<npes;i++)
834   {
835     for(j=0;j<cp[i];j++)
836       _map[k++] = i;
837   }
838   delete[] cp;
839   delete[] nspeeds;
840 }
841
842 int
843 arrInfo::getMap(const CkArrayIndex &i)
844 {
845   if(i.nInts==1)
846     return _map[i.data()[0]];
847   else
848     return _map[((i.hash()+739)%1280107)%_nelems.getCombinedCount()];
849 }
850
851 //Speeds maps processor number to "speed" (some sort of iterations per second counter)
852 // It is initialized by processor 0.
853 static int* speeds;
854
855 #if CMK_USE_PROP_MAP
856 typedef struct _speedmsg
857 {
858   char hdr[CmiMsgHeaderSizeBytes];
859   int node;
860   int speed;
861 } speedMsg;
862
863 static void _speedHdlr(void *m)
864 {
865   speedMsg *msg=(speedMsg *)m;
866   if (CmiMyRank()==0)
867     for (int pe=0;pe<CmiNodeSize(msg->node);pe++)
868       speeds[CmiNodeFirst(msg->node)+pe] = msg->speed;  
869   CmiFree(m);
870 }
871
872 // initnode call
873 void _propMapInit(void)
874 {
875   speeds = new int[CkNumPes()];
876   int hdlr = CkRegisterHandler((CmiHandler)_speedHdlr);
877   CmiPrintf("[%d]Measuring processor speed for prop. mapping...\n", CkMyPe());
878   int s = LDProcessorSpeed();
879   speedMsg msg;
880   CmiSetHandler(&msg, hdlr);
881   msg.node = CkMyNode();
882   msg.speed = s;
883   CmiSyncBroadcastAllAndFree(sizeof(msg), &msg);
884   for(int i=0;i<CkNumNodes();i++)
885     CmiDeliverSpecificMsg(hdlr);
886 }
887 #else
888 void _propMapInit(void)
889 {
890   speeds = new int[CkNumPes()];
891   int i;
892   for(i=0;i<CkNumPes();i++)
893     speeds[i] = 1;
894 }
895 #endif
896 /**
897  * A proportional map object-- tries to map more objects to
898  * faster processors and fewer to slower processors.  Also
899  * attempts to ensure good locality by mapping nearby elements
900  * together.
901  */
902 class PropMap : public CkArrayMap
903 {
904 private:
905   CkPupPtrVec<arrInfo> arrs;
906 public:
907   PropMap(void)
908   {
909     CkpvInitialize(double*, rem);
910     DEBC((AA"Creating PropMap\n"AB));
911   }
912   PropMap(CkMigrateMessage *m) {}
913   int registerArray(CkArrayIndex& numElements,CkArrayID aid)
914   {
915     int idx = arrs.size();
916     arrs.resize(idx+1);
917     arrs[idx] = new arrInfo(numElements, speeds);
918     return idx;
919   }
920   int procNum(int arrayHdl, const CkArrayIndex &i)
921   {
922     return arrs[arrayHdl]->getMap(i);
923   }
924   void pup(PUP::er& p){
925     p|arrs;
926   }
927 };
928
929 class CkMapsInit : public Chare
930 {
931 public:
932         CkMapsInit(CkArgMsg *msg) {
933                 _defaultArrayMapID = CProxy_DefaultArrayMap::ckNew();
934                 _fastArrayMapID = CProxy_FastArrayMap::ckNew();
935                 delete msg;
936         }
937
938         CkMapsInit(CkMigrateMessage *m) {}
939 };
940
941 // given an envelope of a Charm msg, find the recipient object pointer
942 CkMigratable * CkArrayMessageObjectPtr(envelope *env) {
943   if (env->getMsgtype()!=ForArrayEltMsg) return NULL;   // not an array msg
944
945   CkArrayID aid = env->getsetArrayMgr();
946   CkArray *mgr=(CkArray *)_localBranch(aid);
947   if (mgr) {
948     CkLocMgr *locMgr = mgr->getLocMgr();
949     if (locMgr) {
950       return locMgr->lookup(env->getsetArrayIndex(),aid);
951     }
952   }
953   return NULL;
954 }
955
956 /****************************** Out-of-Core support ********************/
957
958 #if CMK_OUT_OF_CORE
959 CooPrefetchManager CkArrayElementPrefetcher;
960 CkpvDeclare(int,CkSaveRestorePrefetch);
961
962 /**
963  * Return the out-of-core objid (from CooRegisterObject)
964  * that this Converse message will access.  If the message
965  * will not access an object, return -1.
966  */
967 int CkArrayPrefetch_msg2ObjId(void *msg) {
968   envelope *env=(envelope *)msg;
969   CkMigratable *elt = CkArrayMessageObjectPtr(env);
970   return elt?elt->prefetchObjID:-1;
971 }
972
973 /**
974  * Write this object (registered with RegisterObject)
975  * to this writable file.
976  */
977 void CkArrayPrefetch_writeToSwap(FILE *swapfile,void *objptr) {
978   CkMigratable *elt=(CkMigratable *)objptr;
979
980   //Save the element's data to disk:
981   PUP::toDisk p(swapfile);
982   elt->pup(p);
983
984   //Call the element's destructor in-place (so pointer doesn't change)
985   CkpvAccess(CkSaveRestorePrefetch)=1;
986   elt->~CkMigratable(); //< because destuctor is virtual, destroys user class too.
987   CkpvAccess(CkSaveRestorePrefetch)=0;
988 }
989         
990 /**
991  * Read this object (registered with RegisterObject)
992  * from this readable file.
993  */
994 void CkArrayPrefetch_readFromSwap(FILE *swapfile,void *objptr) {
995   CkMigratable *elt=(CkMigratable *)objptr;
996   //Call the element's migration constructor in-place
997   CkpvAccess(CkSaveRestorePrefetch)=1;
998   int ctorIdx=_chareTable[elt->thisChareType]->migCtor;
999   elt->myRec->invokeEntry(elt,(CkMigrateMessage *)0,ctorIdx,CmiTrue);
1000   CkpvAccess(CkSaveRestorePrefetch)=0;
1001   
1002   //Restore the element's data from disk:
1003   PUP::fromDisk p(swapfile);
1004   elt->pup(p);
1005 }
1006
1007 static void _CkMigratable_prefetchInit(void) 
1008 {
1009   CkpvExtern(int,CkSaveRestorePrefetch);
1010   CkpvAccess(CkSaveRestorePrefetch)=0;
1011   CkArrayElementPrefetcher.msg2ObjId=CkArrayPrefetch_msg2ObjId;
1012   CkArrayElementPrefetcher.writeToSwap=CkArrayPrefetch_writeToSwap;
1013   CkArrayElementPrefetcher.readFromSwap=CkArrayPrefetch_readFromSwap;
1014   CooRegisterManager(&CkArrayElementPrefetcher, _charmHandlerIdx);
1015 }
1016 #endif
1017
1018 /****************************** CkMigratable ***************************/
1019 /**
1020  * This tiny class is used to convey information to the 
1021  * newly created CkMigratable object when its constructor is called.
1022  */
1023 class CkMigratable_initInfo {
1024 public:
1025         CkLocRec_local *locRec;
1026         int chareType;
1027         CmiBool forPrefetch; /* If true, this creation is only a prefetch restore-from-disk.*/
1028 };
1029
1030 CkpvStaticDeclare(CkMigratable_initInfo,mig_initInfo);
1031
1032
1033 void _CkMigratable_initInfoInit(void) {
1034   CkpvInitialize(CkMigratable_initInfo,mig_initInfo);
1035 #if CMK_OUT_OF_CORE
1036   _CkMigratable_prefetchInit();
1037 #endif
1038 }
1039
1040 void CkMigratable::commonInit(void) {
1041         CkMigratable_initInfo &i=CkpvAccess(mig_initInfo);
1042 #if CMK_OUT_OF_CORE
1043         isInCore=CmiTrue;
1044         if (CkpvAccess(CkSaveRestorePrefetch))
1045                 return; /* Just restoring from disk--don't touch object */
1046         prefetchObjID=-1; //Unregistered
1047 #endif
1048         myRec=i.locRec;
1049         thisIndexMax=myRec->getIndex();
1050         thisChareType=i.chareType;
1051         usesAtSync=CmiFalse;
1052         usesAutoMeasure=CmiTrue;
1053         usesChkpAtSync = CmiFalse;
1054         barrierRegistered=CmiFalse;
1055
1056   local_state = OFF;
1057   prev_load = 0.0;
1058   can_reset = false;
1059
1060 #if CMK_LBDB_ON
1061   if (_lb_args.metaLbOn()) {
1062     atsync_iteration = myRec->getMetaBalancer()->get_iteration();
1063   }
1064 #endif
1065
1066         /*
1067         FAULT_EVAC
1068         */
1069         AsyncEvacuate(CmiTrue);
1070 }
1071
1072 CkMigratable::CkMigratable(void) {
1073         DEBC((AA"In CkMigratable constructor\n"AB));
1074         commonInit();
1075 }
1076 CkMigratable::CkMigratable(CkMigrateMessage *m): Chare(m) {
1077         commonInit();
1078 }
1079
1080 int CkMigratable::ckGetChareType(void) const {return thisChareType;}
1081
1082 void CkMigratable::pup(PUP::er &p) {
1083         DEBM((AA"In CkMigratable::pup %s\n"AB,idx2str(thisIndexMax)));
1084         Chare::pup(p);
1085         p|thisIndexMax;
1086         p(usesAtSync);
1087   p(can_reset);
1088     p(usesChkpAtSync);
1089         p(usesAutoMeasure);
1090 #if CMK_LBDB_ON 
1091         int readyMigrate;
1092         if (p.isPacking()||p.isCalChecking()) readyMigrate = myRec->isReadyMigrate();
1093         p|readyMigrate;
1094         if (p.isUnpacking()) myRec->ReadyMigrate(readyMigrate);
1095 #endif
1096         if(p.isUnpacking()) barrierRegistered=CmiFalse;
1097         /*
1098                 FAULT_EVAC
1099         */
1100         p | asyncEvacuate;
1101         if(p.isUnpacking()){myRec->AsyncEvacuate(asyncEvacuate);}
1102         
1103         if(p.isUnpacking()){
1104           atsync_chkp_iter = -1;
1105         }
1106         if(p.isUnpacking()){
1107                 resetForChkp();
1108         }
1109
1110         ckFinishConstruction();
1111 }
1112
1113 void CkMigratable::ckDestroy(void) {
1114         DEBC((AA"In CkMigratable::ckDestroy %s\n"AB,idx2str(thisIndexMax)));
1115         myRec->destroy();
1116 }
1117
1118 void CkMigratable::ckAboutToMigrate(void) { }
1119 void CkMigratable::ckJustMigrated(void) { }
1120 void CkMigratable::ckJustRestored(void) { }
1121
1122 CkMigratable::~CkMigratable() {
1123         DEBC((AA"In CkMigratable::~CkMigratable %s\n"AB,idx2str(thisIndexMax)));
1124 #if CMK_OUT_OF_CORE
1125         isInCore=CmiFalse;
1126         if (CkpvAccess(CkSaveRestorePrefetch)) 
1127                 return; /* Just saving to disk--don't deregister anything. */
1128         /* We're really leaving or dying-- unregister from the ooc system*/
1129         if (prefetchObjID!=-1) {
1130                 CooDeregisterObject(prefetchObjID);
1131                 prefetchObjID=-1;
1132         }
1133 #endif
1134         /*Might want to tell myRec about our doom here--
1135         it's difficult to avoid some kind of circular-delete, though.
1136         */
1137 #if CMK_LBDB_ON 
1138         if (barrierRegistered) {
1139           DEBL((AA"Removing barrier for element %s\n"AB,idx2str(thisIndexMax)));
1140           //CkPrintf("Removing barrier for element %s\n",idx2str(thisIndexMax));
1141           if (usesAtSync)
1142                 myRec->getLBDB()->RemoveLocalBarrierClient(ldBarrierHandle);
1143           else
1144                 myRec->getLBDB()->RemoveLocalBarrierReceiver(ldBarrierRecvHandle);
1145         }
1146 #endif
1147         //To detect use-after-delete
1148         thisIndexMax.nInts=-12345;
1149         thisIndexMax.dimension=-12345;
1150 }
1151
1152 void CkMigratable::CkAbort(const char *why) const {
1153         CkError("CkMigratable '%s' aborting:\n",_chareTable[thisChareType]->name);
1154         ::CkAbort(why);
1155 }
1156
1157 void CkMigratable::ResumeFromSync(void)
1158 {
1159 //      CkAbort("::ResumeFromSync() not defined for this array element!\n");
1160 }
1161
1162 void CkMigratable::UserSetLBLoad() {
1163         CkAbort("::UserSetLBLoad() not defined for this array element!\n");
1164 }
1165
1166 #if CMK_LBDB_ON  //For load balancing:
1167 // user can call this helper function to set obj load (for model-based lb)
1168 void CkMigratable::setObjTime(double cputime) {
1169         myRec->setObjTime(cputime);
1170 }
1171 double CkMigratable::getObjTime() {
1172         return myRec->getObjTime();
1173 }
1174
1175 void CkMigratable::clearMetaLBData() {
1176 //  if (can_reset) {
1177     local_state = OFF;
1178     atsync_iteration = -1;
1179     prev_load = 0.0;
1180     can_reset = false;
1181 //  }
1182 }
1183
1184 void CkMigratable::recvLBPeriod(void *data) {
1185   if (atsync_iteration < 0) {
1186     return;
1187   }
1188   int lb_period = *((int *) data);
1189  DEBAD(("\t[obj %s] Received the LB Period %d current iter %d state %d on PE %d\n",
1190      idx2str(thisIndexMax), lb_period, atsync_iteration, local_state, CkMyPe()));
1191
1192   bool is_tentative;
1193   if (local_state == LOAD_BALANCE) {
1194     CkAssert(lb_period == myRec->getMetaBalancer()->getPredictedLBPeriod(is_tentative));
1195     return;
1196   }
1197
1198   if (local_state == PAUSE) {
1199     if (atsync_iteration < lb_period) {
1200       local_state = DECIDED;
1201       ResumeFromSync();
1202       return;
1203     }
1204     local_state = LOAD_BALANCE;
1205
1206     can_reset = true;
1207     //myRec->getLBDB()->AtLocalBarrier(ldBarrierHandle);
1208     return;
1209   }
1210   local_state = DECIDED;
1211 }
1212
1213 void CkMigratable::metaLBCallLB() {
1214         myRec->getLBDB()->AtLocalBarrier(ldBarrierHandle);
1215 }
1216
1217 void CkMigratable::ckFinishConstruction(void)
1218 {
1219 //      if ((!usesAtSync) || barrierRegistered) return;
1220         myRec->setMeasure(usesAutoMeasure);
1221         if (barrierRegistered) return;
1222         DEBL((AA"Registering barrier client for %s\n"AB,idx2str(thisIndexMax)));
1223         //CkPrintf("Registering barrier client for %s\n",idx2str(thisIndexMax));
1224         if (usesAtSync)
1225           ldBarrierHandle = myRec->getLBDB()->AddLocalBarrierClient(
1226                 (LDBarrierFn)staticResumeFromSync,(void*)(this));
1227         else
1228           ldBarrierRecvHandle = myRec->getLBDB()->AddLocalBarrierReceiver(
1229                 (LDBarrierFn)staticResumeFromSync,(void*)(this));
1230         barrierRegistered=CmiTrue;
1231 }
1232
1233
1234 void CkMigratable::setChkpResumeClient(CkCallback & _cb)
1235 {
1236         if(CmiMyPartition()==1){
1237           //CkPrintf("[%d] setChkpResumeClient\n",CkMyPe());
1238         }
1239         chkp_cb = _cb;
1240         nextChkpIter = -1;
1241         nextChkpDecided = false;
1242         atsync_chkp_iter = -1;
1243         local_chkp_pause = false;
1244         usesChkpAtSync = CmiTrue;
1245 }
1246
1247 void CkMigratable::AtChkpSync()
1248 {
1249         if(usesChkpAtSync){
1250           if(CkMyPe()==0){
1251 //          CkPrintf("at chkp sync\n");
1252           }
1253                 if(CmiNumPartition()==1){
1254                         chkp_cb.send();
1255                         return;
1256                 }
1257                 atsync_chkp_iter++;
1258                 myRec->getChkpMgr()->recvIter(atsync_chkp_iter);
1259                 //reduction to decide the current maximum
1260                 if(nextChkpDecided){
1261                         if(atsync_chkp_iter<nextChkpIter){
1262                                 chkp_cb.send();
1263                         }else if(atsync_chkp_iter == nextChkpIter){
1264                                 resetForChkp();
1265                                 myRec->getChkpMgr()->reachChkpIter();
1266                         }else{
1267                                 CkAbort("Impossible state\n");
1268                         }
1269                 }
1270                 else if(myRec->getChkpMgr()->localDecided){
1271                         int localIter = myRec->getChkpMgr()->localMaxIter;
1272                         if(atsync_chkp_iter==localIter){
1273                                 local_chkp_pause = true;
1274                         }
1275                         else if(atsync_chkp_iter<localIter){
1276                                 chkp_cb.send();
1277                         }
1278                         else{
1279                                 CkAbort("local Impossible state\n");
1280                         }
1281                 }       
1282                 else{
1283                         chkp_cb.send();
1284                 }
1285         }
1286 }
1287
1288 void CkMigratable::resetForChkp(){
1289         nextChkpDecided = false;
1290         local_chkp_pause = false;
1291 }
1292
1293 void CkMigratable::ResumeFromChkp(){
1294         
1295         if(usesChkpAtSync&&!chkp_cb.isInvalid()){
1296                 chkp_cb.send();
1297         }
1298 }
1299
1300 void CkMigratable::recvChkpIter(void * _iter){
1301         if(usesChkpAtSync){
1302                 int iter = *(int *)_iter;
1303                 nextChkpIter = iter;
1304                 nextChkpDecided = true;
1305                 if(CkMyPe()==0){
1306                   CkPrintf("receive chkp iter %d %d\n",atsync_chkp_iter, nextChkpIter);
1307                 }
1308                 if(atsync_chkp_iter>nextChkpIter){
1309                         CkAbort("impossible state in notify\n");
1310                 }
1311                 else if(atsync_chkp_iter==nextChkpIter){
1312                         resetForChkp();
1313                         myRec->getChkpMgr()->reachChkpIter();
1314                 }
1315                 else{
1316                         if(local_chkp_pause){
1317                                 if(!chkp_cb.isInvalid())
1318                                         chkp_cb.send(); 
1319                         }
1320                 }
1321         }
1322 }
1323
1324 void CkMigratable::AtSync(int waitForMigration)
1325 {
1326         if (!usesAtSync)
1327                 CkAbort("You must set usesAtSync=CmiTrue in your array element constructor to use AtSync!\n");
1328 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1329         mlogData->toResumeOrNot=1;
1330 #endif
1331         myRec->AsyncMigrate(!waitForMigration);
1332         if (waitForMigration) ReadyMigrate(CmiTrue);
1333         ckFinishConstruction();
1334   //DEBL((AA"Element %s going to sync\n"AB,idx2str(thisIndexMax)));
1335   //if(CmiMyPartition()==1)
1336 //      CkPrintf("Element %s going to sync\n",idx2str(thisIndexMax));
1337   // model-based load balancing, ask user to provide cpu load
1338   if (usesAutoMeasure == CmiFalse) UserSetLBLoad();
1339
1340   if (!_lb_args.metaLbOn()) {
1341     myRec->getLBDB()->AtLocalBarrier(ldBarrierHandle);
1342     return;
1343   }
1344
1345   // When MetaBalancer is turned on
1346
1347   if (atsync_iteration == -1) {
1348     can_reset = false;
1349     local_state = OFF;
1350     prev_load = 0.0;
1351   }
1352
1353   atsync_iteration++;
1354   //CkPrintf("[pe %s] atsync_iter %d && predicted period %d state: %d\n",
1355   //    idx2str(thisIndexMax), atsync_iteration,
1356   //    myRec->getMetaBalancer()->getPredictedLBPeriod(), local_state);
1357   double tmp = prev_load;
1358   prev_load = myRec->getObjTime();
1359   double current_load = prev_load - tmp;
1360   if (atsync_iteration <= myRec->getMetaBalancer()->get_finished_iteration()) {
1361     CkPrintf("[%d:%s] Error!! Contributing to iter %d < current iter %d\n",
1362       CkMyPe(), idx2str(thisIndexMax), atsync_iteration,
1363       myRec->getMetaBalancer()->get_finished_iteration());
1364     CkAbort("Not contributing to the right iteration\n");
1365   }
1366
1367   if (atsync_iteration != 0) {
1368     myRec->getMetaBalancer()->AddLoad(atsync_iteration, current_load);
1369   }
1370
1371   bool is_tentative;
1372   if (atsync_iteration < myRec->getMetaBalancer()->getPredictedLBPeriod(is_tentative)) {
1373     ResumeFromSync();
1374   } else if (is_tentative) {
1375     local_state = PAUSE;
1376   } else if (local_state == DECIDED) {
1377     DEBAD(("[%d:%s] Went to load balance iter %d\n", CkMyPe(), idx2str(thisIndexMax), atsync_iteration));
1378     local_state = LOAD_BALANCE;
1379     can_reset = true;
1380     //myRec->getLBDB()->AtLocalBarrier(ldBarrierHandle);
1381   } else {
1382     DEBAD(("[%d:%s] Went to pause state iter %d\n", CkMyPe(), idx2str(thisIndexMax), atsync_iteration));
1383     local_state = PAUSE;
1384   }
1385 }
1386
1387 void CkMigratable::ReadyMigrate(CmiBool ready)
1388 {
1389         myRec->ReadyMigrate(ready);
1390 }
1391
1392 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1393     extern int globalResumeCount;
1394 #endif
1395
1396 void CkMigratable::staticResumeFromSync(void* data)
1397 {
1398         CkMigratable *el=(CkMigratable *)data;
1399 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1400     if(el->mlogData->toResumeOrNot ==0 || el->mlogData->resumeCount >= globalResumeCount){
1401         return;
1402     }
1403 #endif
1404         DEBL((AA"Element %s resuming from sync\n"AB,idx2str(el->thisIndexMax)));
1405 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1406     CpvAccess(_currentObj) = el;
1407 #endif
1408
1409   if (_lb_args.metaLbOn()) {
1410         el->clearMetaLBData();
1411         }
1412         el->ResumeFromSync();
1413 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1414     el->mlogData->resumeCount++;
1415 #endif
1416 }
1417 void CkMigratable::setMigratable(int migratable) 
1418 {
1419         myRec->setMigratable(migratable);
1420 }
1421
1422 struct CkArrayThreadListener {
1423         struct CthThreadListener base;
1424         CkMigratable *mig;
1425 };
1426
1427 extern "C"
1428 void CkArrayThreadListener_suspend(struct CthThreadListener *l)
1429 {
1430         CkArrayThreadListener *a=(CkArrayThreadListener *)l;
1431         a->mig->ckStopTiming();
1432 }
1433
1434 extern "C"
1435 void CkArrayThreadListener_resume(struct CthThreadListener *l)
1436 {
1437         CkArrayThreadListener *a=(CkArrayThreadListener *)l;
1438         a->mig->ckStartTiming();
1439 }
1440
1441 extern "C"
1442 void CkArrayThreadListener_free(struct CthThreadListener *l)
1443 {
1444         CkArrayThreadListener *a=(CkArrayThreadListener *)l;
1445         delete a;
1446 }
1447
1448 void CkMigratable::CkAddThreadListeners(CthThread tid, void *msg)
1449 {
1450         Chare::CkAddThreadListeners(tid, msg);   // for trace
1451         CthSetThreadID(tid, thisIndexMax.data()[0], thisIndexMax.data()[1], 
1452                        thisIndexMax.data()[2]);
1453         CkArrayThreadListener *a=new CkArrayThreadListener;
1454         a->base.suspend=CkArrayThreadListener_suspend;
1455         a->base.resume=CkArrayThreadListener_resume;
1456         a->base.free=CkArrayThreadListener_free;
1457         a->mig=this;
1458         CthAddListener(tid,(struct CthThreadListener *)a);
1459 }
1460 #else
1461 void CkMigratable::setObjTime(double cputime) {}
1462 double CkMigratable::getObjTime() {return 0.0;}
1463
1464 /* no load balancer: need dummy implementations to prevent link error */
1465 void CkMigratable::CkAddThreadListeners(CthThread tid, void *msg)
1466 {
1467 }
1468 #endif
1469
1470
1471 /*CkMigratableList*/
1472 CkMigratableList::CkMigratableList() {}
1473 CkMigratableList::~CkMigratableList() {}
1474
1475 void CkMigratableList::setSize(int s) {
1476         el.resize(s);
1477 }
1478
1479 void CkMigratableList::put(CkMigratable *v,int atIdx) {
1480 #if CMK_ERROR_CHECKING
1481         if (atIdx>=length())
1482                 CkAbort("Internal array manager error (CkMigrableList::put index out of bounds)");
1483 #endif
1484         el[atIdx]=v;
1485 }
1486
1487
1488 /************************** Location Records: *********************************/
1489
1490 //---------------- Base type:
1491 void CkLocRec::weAreObsolete(const CkArrayIndex &idx) {}
1492 CkLocRec::~CkLocRec() { }
1493 void CkLocRec::beenReplaced(void)
1494     {/*Default: ignore replacement*/}
1495
1496 //Return the represented array element; or NULL if there is none
1497 CkMigratable *CkLocRec::lookupElement(CkArrayID aid) {return NULL;}
1498
1499 //Return the last known processor; or -1 if none
1500 int CkLocRec::lookupProcessor(void) {return -1;}
1501
1502
1503 /*----------------- Local:
1504 Matches up the array index with the local index, an
1505 interfaces with the load balancer on behalf of the
1506 represented array elements.
1507 */
1508 CkLocRec_local::CkLocRec_local(CkLocMgr *mgr,CmiBool fromMigration,
1509   CmiBool ignoreArrival, const CkArrayIndex &idx_,int localIdx_)
1510         :CkLocRec(mgr),idx(idx_),localIdx(localIdx_),
1511          running(CmiFalse),deletedMarker(NULL)
1512 {
1513 #if CMK_LBDB_ON
1514         DEBL((AA"Registering element %s with load balancer\n"AB,idx2str(idx)));
1515         //BIGSIM_OOC DEBUGGING
1516         //CkPrintf("LocMgr on %d: Registering element %s with load balancer\n", CkMyPe(), idx2str(idx));
1517         nextPe = -1;
1518         asyncMigrate = CmiFalse;
1519         readyMigrate = CmiTrue;
1520         enable_measure = CmiTrue;
1521         bounced  = CmiFalse;
1522         the_lbdb=mgr->getLBDB();
1523         the_metalb=mgr->getMetaBalancer();
1524         the_chkp = mgr->getChkpMgr();
1525         LDObjid ldid = idx2LDObjid(idx);
1526 #if CMK_GLOBAL_LOCATION_UPDATE
1527         ldid.locMgrGid = mgr->getGroupID().idx;
1528 #endif        
1529         ldHandle=the_lbdb->RegisterObj(mgr->getOMHandle(),
1530                 ldid,(void *)this,1);
1531         if (fromMigration) {
1532                 DEBL((AA"Element %s migrated in\n"AB,idx2str(idx)));
1533                 if (!ignoreArrival)  {
1534                         the_lbdb->Migrated(ldHandle, CmiTrue);
1535                   // load balancer should ignore this objects movement
1536                 //  AsyncMigrate(CmiTrue);
1537                 }
1538         }
1539 #endif
1540         the_chkp = mgr->getChkpMgr();
1541         /*
1542                 FAULT_EVAC
1543         */
1544         asyncEvacuate = CmiTrue;
1545 }
1546 CkLocRec_local::~CkLocRec_local()
1547 {
1548         if (deletedMarker!=NULL) *deletedMarker=CmiTrue;
1549         myLocMgr->reclaim(idx,localIdx);
1550 #if CMK_LBDB_ON
1551         stopTiming();
1552         DEBL((AA"Unregistering element %s from load balancer\n"AB,idx2str(idx)));
1553         the_lbdb->UnregisterObj(ldHandle);
1554 #endif
1555 }
1556 void CkLocRec_local::migrateMe(int toPe) //Leaving this processor
1557 {
1558         //This will pack us up, send us off, and delete us
1559 //      printf("[%d] migrating migrateMe to %d \n",CkMyPe(),toPe);
1560         myLocMgr->emigrate(this,toPe);
1561 }
1562
1563 #if CMK_LBDB_ON
1564 void CkLocRec_local::informIdealLBPeriod(int lb_ideal_period) {
1565   myLocMgr->informLBPeriod(this, lb_ideal_period);
1566 }
1567
1568 void CkLocRec_local::metaLBCallLB() {
1569         myLocMgr->metaLBCallLB(this);
1570 }
1571
1572 void CkLocRec_local::startTiming(int ignore_running) {
1573         if (!ignore_running) running=CmiTrue;
1574         DEBL((AA"Start timing for %s at %.3fs {\n"AB,idx2str(idx),CkWallTimer()));
1575         if (enable_measure) the_lbdb->ObjectStart(ldHandle);
1576 }
1577 void CkLocRec_local::stopTiming(int ignore_running) {
1578         DEBL((AA"} Stop timing for %s at %.3fs\n"AB,idx2str(idx),CkWallTimer()));
1579         if ((ignore_running || running) && enable_measure) the_lbdb->ObjectStop(ldHandle);
1580         if (!ignore_running) running=CmiFalse;
1581 }
1582 void CkLocRec_local::setObjTime(double cputime) {
1583         the_lbdb->EstObjLoad(ldHandle, cputime);
1584 }
1585 double CkLocRec_local::getObjTime() {
1586         LBRealType walltime, cputime;
1587         the_lbdb->GetObjLoad(ldHandle, walltime, cputime);
1588         return walltime;
1589 }
1590 #endif
1591
1592 void CkLocRec_local::destroy(void) //User called destructor
1593 {
1594         //Our destructor does all the needed work
1595         delete this;
1596 }
1597 //Return the represented array element; or NULL if there is none
1598 CkMigratable *CkLocRec_local::lookupElement(CkArrayID aid) {
1599         return myLocMgr->lookupLocal(localIdx,aid);
1600 }
1601
1602 //Return the last known processor; or -1 if none
1603 int CkLocRec_local::lookupProcessor(void) {
1604         return CkMyPe();
1605 }
1606
1607 CkLocRec::RecType CkLocRec_local::type(void)
1608 {
1609         return local;
1610 }
1611
1612 void CkLocRec_local::addedElement(void) 
1613 {
1614         //Push everything in the half-created queue into the system--
1615         // anything not ready yet will be put back in.
1616         while (!halfCreated.isEmpty()) 
1617                 CkArrayManagerDeliver(CkMyPe(),halfCreated.deq());
1618 }
1619
1620 CmiBool CkLocRec_local::isObsolete(int nSprings,const CkArrayIndex &idx_)
1621
1622         int len=halfCreated.length();
1623         if (len!=0) {
1624                 /* This is suspicious-- the halfCreated queue should be extremely
1625                  transient.  It's possible we just looked at the wrong time, though;
1626                  so this is only a warning. 
1627                 */
1628                 CkPrintf("CkLoc WARNING> %d messages still around for uncreated element %s!\n",
1629                          len,idx2str(idx));
1630         }
1631         //A local element never expires
1632         return CmiFalse;
1633 }
1634
1635 /**********Added for cosmology (inline function handling without parameter marshalling)***********/
1636
1637 LDObjHandle CkMigratable::timingBeforeCall(int* objstopped){
1638
1639         LDObjHandle objHandle;
1640 #if CMK_LBDB_ON
1641         if (getLBDB()->RunningObject(&objHandle)) {
1642                 *objstopped = 1;
1643                 getLBDB()->ObjectStop(objHandle);
1644         }
1645         myRec->startTiming(1);
1646 #endif
1647
1648   //DEBS((AA"   Invoking entry %d on element %s\n"AB,epIdx,idx2str(idx)));
1649         //CmiBool isDeleted=CmiFalse; //Enables us to detect deletion during processing
1650         //deletedMarker=&isDeleted;
1651 /*#ifndef CMK_OPTIMIZE
1652         if (msg) {  Tracing: 
1653                 envelope *env=UsrToEnv(msg);
1654         //      CkPrintf("ckLocation.C beginExecuteDetailed %d %d \n",env->getEvent(),env->getsetArraySrcPe());
1655                 if (_entryTable[epIdx]->traceEnabled)
1656                         _TRACE_BEGIN_EXECUTE_DETAILED(env->getEvent(),
1657                                  ForChareMsg,epIdx,env->getsetArraySrcPe(), env->getTotalsize(), idx.getProjectionID(((CkGroupID)env->getsetArrayMgr())).idx);
1658         }
1659 #endif*/
1660
1661   return objHandle;
1662 }
1663
1664 void CkMigratable::timingAfterCall(LDObjHandle objHandle,int *objstopped){
1665   
1666 /*#ifndef CMK_OPTIMIZE
1667         if (msg) {  Tracing: 
1668                 if (_entryTable[epIdx]->traceEnabled)
1669                         _TRACE_END_EXECUTE();
1670         }
1671 #endif*/
1672 //#if CMK_LBDB_ON
1673 //        if (!isDeleted) checkBufferedMigration();   // check if should migrate
1674 //#endif
1675 //      if (isDeleted) return CmiFalse;//We were deleted
1676 //      deletedMarker=NULL;
1677 //      return CmiTrue;
1678         myRec->stopTiming(1);
1679 #if CMK_LBDB_ON
1680         if (*objstopped) {
1681                  getLBDB()->ObjectStart(objHandle);
1682         }
1683 #endif
1684
1685  return;
1686 }
1687 /****************************************************************************/
1688
1689
1690 CmiBool CkLocRec_local::invokeEntry(CkMigratable *obj,void *msg,
1691         int epIdx,CmiBool doFree) 
1692 {
1693
1694         DEBS((AA"   Invoking entry %d on element %s\n"AB,epIdx,idx2str(idx)));
1695         CmiBool isDeleted=CmiFalse; //Enables us to detect deletion during processing
1696         deletedMarker=&isDeleted;
1697         startTiming();
1698
1699
1700 #if CMK_TRACE_ENABLED
1701         if (msg) { /* Tracing: */
1702                 envelope *env=UsrToEnv(msg);
1703         //      CkPrintf("ckLocation.C beginExecuteDetailed %d %d \n",env->getEvent(),env->getsetArraySrcPe());
1704                 if (_entryTable[epIdx]->traceEnabled)
1705                         _TRACE_BEGIN_EXECUTE_DETAILED(env->getEvent(),
1706                                  ForChareMsg,epIdx,env->getsetArraySrcPe(), env->getTotalsize(), idx.getProjectionID((((CkGroupID)env->getsetArrayMgr())).idx));
1707         }
1708 #endif
1709
1710         if (doFree) 
1711            CkDeliverMessageFree(epIdx,msg,obj);
1712         else /* !doFree */
1713            CkDeliverMessageReadonly(epIdx,msg,obj);
1714
1715
1716 #if CMK_TRACE_ENABLED
1717         if (msg) { /* Tracing: */
1718                 if (_entryTable[epIdx]->traceEnabled)
1719                         _TRACE_END_EXECUTE();
1720         }
1721 #endif
1722 #if CMK_LBDB_ON
1723         if (!isDeleted) checkBufferedMigration();   // check if should migrate
1724 #endif
1725         if (isDeleted) return CmiFalse;//We were deleted
1726         deletedMarker=NULL;
1727         stopTiming();
1728         return CmiTrue;
1729 }
1730
1731 CmiBool CkLocRec_local::deliver(CkArrayMessage *msg,CkDeliver_t type,int opts)
1732 {
1733
1734         if (type==CkDeliver_queue) { /*Send via the message queue */
1735                 if (opts & CK_MSG_KEEP)
1736                         msg = (CkArrayMessage *)CkCopyMsg((void **)&msg);
1737                 CkArrayManagerDeliver(CkMyPe(),msg,opts);
1738                 return CmiTrue;
1739         }
1740         else
1741         {
1742                 CkMigratable *obj=myLocMgr->lookupLocal(localIdx,
1743                         UsrToEnv(msg)->getsetArrayMgr());
1744                 if (obj==NULL) {//That sibling of this object isn't created yet!
1745                         if (opts & CK_MSG_KEEP)
1746                                 msg = (CkArrayMessage *)CkCopyMsg((void **)&msg);
1747                         if (msg->array_ifNotThere()!=CkArray_IfNotThere_buffer) {
1748                                 return myLocMgr->demandCreateElement(msg,CkMyPe(),type);
1749                         }
1750                         else {
1751                                 DEBS((AA"   BUFFERING message for nonexistent element %s!\n"AB,idx2str(this->idx)));
1752                                 halfCreated.enq(msg);
1753                                 return CmiTrue;
1754                         }
1755                 }
1756                         
1757                 if (msg->array_hops()>1)
1758                         myLocMgr->multiHop(msg);
1759                 CmiBool doFree = (CmiBool)!(opts & CK_MSG_KEEP);
1760 #if CMK_LBDB_ON
1761                 // if there is a running obj being measured, stop it temporarily
1762                 LDObjHandle objHandle;
1763                 int objstopped = 0;
1764                 if (the_lbdb->RunningObject(&objHandle)) {
1765                         objstopped = 1;
1766                         the_lbdb->ObjectStop(objHandle);
1767                 }
1768 #endif
1769 #if CMK_GRID_QUEUE_AVAILABLE
1770                 // retain a pointer to the sending object (needed later)
1771                 CpvAccess(CkGridObject) = obj;
1772 #endif
1773
1774         CmiBool status = invokeEntry(obj,(void *)msg,msg->array_ep(),doFree);
1775         
1776 #if CMK_GRID_QUEUE_AVAILABLE
1777                 CpvAccess(CkGridObject) = NULL;
1778 #endif
1779 #if CMK_LBDB_ON
1780                 if (objstopped) the_lbdb->ObjectStart(objHandle);
1781 #endif
1782                 return status;
1783         }
1784
1785
1786 }
1787
1788 #if CMK_LBDB_ON
1789
1790 void CkLocRec_local::staticMetaLBResumeWaitingChares(LDObjHandle h, int lb_ideal_period) {
1791         CkLocRec_local *el=(CkLocRec_local *)LDObjUserData(h);
1792         DEBL((AA"MetaBalancer wants to resume waiting chare %s\n"AB,idx2str(el->idx)));
1793         el->metaLBResumeWaitingChares(lb_ideal_period);
1794 }
1795
1796 void CkLocRec_local::metaLBResumeWaitingChares(int lb_ideal_period) {
1797   informIdealLBPeriod(lb_ideal_period);
1798 }
1799
1800 void CkLocRec_local::staticMetaLBCallLBOnChares(LDObjHandle h) {
1801         CkLocRec_local *el=(CkLocRec_local *)LDObjUserData(h);
1802         DEBL((AA"MetaBalancer wants to call LoadBalance on chare %s\n"AB,idx2str(el->idx)));
1803         el->metaLBCallLBOnChares();
1804 }
1805
1806 void CkLocRec_local::metaLBCallLBOnChares() {
1807   metaLBCallLB();
1808 }
1809
1810 void CkLocRec_local::staticMigrate(LDObjHandle h, int dest)
1811 {
1812         CkLocRec_local *el=(CkLocRec_local *)LDObjUserData(h);
1813         DEBL((AA"Load balancer wants to migrate %s to %d\n"AB,idx2str(el->idx),dest));
1814         el->recvMigrate(dest);
1815 }
1816
1817 void CkLocRec_local::recvMigrate(int toPe)
1818 {
1819         // we are in the mode of delaying actual migration
1820         // till readyMigrate()
1821         if (readyMigrate) { migrateMe(toPe); }
1822         else nextPe = toPe;
1823 }
1824
1825 void CkLocRec_local::AsyncMigrate(CmiBool use)  
1826 {
1827         asyncMigrate = use; 
1828         the_lbdb->UseAsyncMigrate(ldHandle, use);
1829 }
1830
1831 CmiBool CkLocRec_local::checkBufferedMigration()
1832 {
1833         // we don't migrate in user's code when calling ReadyMigrate(true)
1834         // we postphone the action to here until we exit from the user code.
1835         if (readyMigrate && nextPe != -1) {
1836             int toPe = nextPe;
1837             nextPe = -1;
1838             // don't migrate inside the object call
1839             migrateMe(toPe);
1840             // don't do anything
1841             return CmiTrue;
1842         }
1843         return CmiFalse;
1844 }
1845
1846 int CkLocRec_local::MigrateToPe()
1847 {
1848         int pe = nextPe;
1849         nextPe = -1;
1850         return pe;
1851 }
1852
1853 void CkLocRec_local::setMigratable(int migratable)
1854 {
1855         if (migratable)
1856           the_lbdb->Migratable(ldHandle);
1857         else
1858           the_lbdb->NonMigratable(ldHandle);
1859 }
1860 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1861 void CkLocRec_local::Migrated(){
1862     the_lbdb->Migrated(ldHandle, CmiTrue);
1863 }
1864 #endif
1865 #endif
1866
1867 /**
1868  * Represents a deleted array element (and prevents re-use).
1869  * These are a debugging aid, usable only by uncommenting a line in
1870  * the element destruction code.
1871  */
1872 class CkLocRec_dead:public CkLocRec {
1873 public:
1874         CkLocRec_dead(CkLocMgr *Narr):CkLocRec(Narr) {}
1875   
1876         virtual RecType type(void) {return dead;}
1877   
1878         virtual CmiBool deliver(CkArrayMessage *msg,CkDeliver_t type,int opts=0) {
1879                 CkPrintf("Dead array element is %s.\n",idx2str(msg->array_index()));
1880                 CkAbort("Send to dead array element!\n");
1881                 return CmiFalse;
1882         }
1883         virtual void beenReplaced(void) 
1884                 {CkAbort("Can't re-use dead array element!\n");}
1885   
1886         //Return if this element is now obsolete (it isn't)
1887         virtual CmiBool isObsolete(int nSprings,const CkArrayIndex &idx) {return CmiFalse;}     
1888 };
1889
1890 /**
1891  * This is the abstract superclass of arrayRecs that keep track of their age,
1892  * and eventually expire. Its kids are remote and buffering.
1893  */
1894 class CkLocRec_aging:public CkLocRec {
1895 private:
1896         int lastAccess;//Age when last accessed
1897 protected:
1898         //Update our access time
1899         inline void access(void) {
1900                 lastAccess=myLocMgr->getSpringCount();
1901         }
1902         //Return if we are "stale"-- we were last accessed a while ago
1903         CmiBool isStale(void) {
1904                 if (myLocMgr->getSpringCount()-lastAccess>3) return CmiTrue;
1905                 else return CmiFalse;
1906         }
1907 public:
1908         CkLocRec_aging(CkLocMgr *Narr):CkLocRec(Narr) {
1909                 lastAccess=myLocMgr->getSpringCount();
1910         }
1911         //Return if this element is now obsolete
1912         virtual CmiBool isObsolete(int nSprings,const CkArrayIndex &idx)=0;
1913         //virtual void pup(PUP::er &p) { CkLocRec::pup(p); p(lastAccess); }
1914 };
1915
1916
1917 /**
1918  * Represents a remote array element.  This is just a PE number.
1919  */
1920 class CkLocRec_remote:public CkLocRec_aging {
1921 private:
1922         int onPe;//The last known Pe for this element
1923 public:
1924         CkLocRec_remote(CkLocMgr *Narr,int NonPe)
1925                 :CkLocRec_aging(Narr)
1926                 {
1927                         onPe=NonPe;
1928 #if CMK_ERROR_CHECKING
1929                         if (onPe==CkMyPe())
1930                                 CkAbort("ERROR!  'remote' array element on this Pe!\n");
1931 #endif
1932                 }
1933         //Return the last known processor for this element
1934         int lookupProcessor(void) {
1935                 return onPe;
1936         }  
1937         virtual RecType type(void) {return remote;}
1938   
1939         //Send a message for this element.
1940         virtual CmiBool deliver(CkArrayMessage *msg,CkDeliver_t type,int opts=0) {
1941                 /*FAULT_EVAC*/
1942                 int destPE = onPe;
1943                 if((!CmiNodeAlive(onPe) && onPe != allowMessagesOnly)){
1944 //                      printf("Delivery failed because process %d is invalid\n",onPe);
1945                         /*
1946                                 Send it to its home processor instead
1947                         */
1948                         const CkArrayIndex &idx=msg->array_index();
1949                         destPE = getNextPE(idx);
1950                 }
1951                 access();//Update our modification date
1952                 msg->array_hops()++;
1953                 DEBS((AA"   Forwarding message for element %s to %d (REMOTE)\n"AB,
1954                       idx2str(msg->array_index()),destPE));
1955                 if (opts & CK_MSG_KEEP)
1956                         msg = (CkArrayMessage *)CkCopyMsg((void **)&msg);
1957                 CkArrayManagerDeliver(destPE,msg,opts);
1958                 return CmiTrue;
1959         }
1960         //Return if this element is now obsolete
1961         virtual CmiBool isObsolete(int nSprings,const CkArrayIndex &idx) {
1962                 if (myLocMgr->isHome(idx)) 
1963                         //Home elements never become obsolete
1964                         // if they did, we couldn't deliver messages to that element.
1965                         return CmiFalse;
1966                 else if (isStale())
1967                         return CmiTrue;//We haven't been used in a long time
1968                 else
1969                         return CmiFalse;//We're fairly recent
1970         }
1971         //virtual void pup(PUP::er &p) { CkLocRec_aging::pup(p); p(onPe); }
1972 };
1973
1974
1975 /**
1976  * Buffers messages until record is replaced in the hash table, 
1977  * then delivers all messages to the replacing record.  This is 
1978  * used when a message arrives for a local element that has not
1979  * yet been created, buffering messages until the new element finally
1980  * checks in.
1981  *
1982  * It's silly to send a message to an element you won't ever create,
1983  * so this kind of record causes an abort "Stale array manager message!"
1984  * if it's left undelivered too long.
1985  */
1986 class CkLocRec_buffering:public CkLocRec_aging {
1987 private:
1988         CkQ<CkArrayMessage *> buffer;//Buffered messages.
1989 public:
1990         CkLocRec_buffering(CkLocMgr *Narr):CkLocRec_aging(Narr) {}
1991         virtual ~CkLocRec_buffering() {
1992                 if (0!=buffer.length()) {
1993                         CkPrintf("[%d] Warning: Messages abandoned in array manager buffer!\n", CkMyPe());
1994                         CkArrayMessage *m;
1995                         while (NULL!=(m=buffer.deq()))  {
1996                                 delete m;
1997                         }
1998                 }
1999         }
2000   
2001         virtual RecType type(void) {return buffering;}
2002   
2003         //Buffer a message for this element.
2004         virtual CmiBool deliver(CkArrayMessage *msg,CkDeliver_t type,int opts=0) {
2005                 DEBS((AA" Queued message for %s\n"AB,idx2str(msg->array_index())));
2006                 if (opts & CK_MSG_KEEP)
2007                         msg = (CkArrayMessage *)CkCopyMsg((void **)&msg);
2008                 buffer.enq(msg);
2009 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
2010                 envelope *env = UsrToEnv(msg);
2011                 env->sender = CpvAccess(_currentObj)->mlogData->objID;
2012 #endif
2013                 return CmiTrue;
2014         }
2015  
2016         //This is called when this ArrayRec is about to be replaced.
2017         // We dump all our buffered messages off on the next guy,
2018         // who should know what to do with them.
2019         virtual void beenReplaced(void) {
2020                 DEBS((AA" Delivering queued messages:\n"AB));
2021                 CkArrayMessage *m;
2022                 while (NULL!=(m=buffer.deq())) {
2023 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))         
2024                 DEBUG(CmiPrintf("[%d] buffered message being sent\n",CmiMyPe()));
2025                 envelope *env = UsrToEnv(m);
2026                 Chare *oldObj = CpvAccess(_currentObj);
2027                 CpvAccess(_currentObj) =(Chare *) env->sender.getObject();
2028                 env->sender.type = TypeInvalid;
2029 #endif
2030                 DEBS((AA"Sending buffered message to %s\n"AB,idx2str(m->array_index())));
2031                 myLocMgr->deliverViaQueue(m);
2032 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))         
2033                 CpvAccess(_currentObj) = oldObj;
2034 #endif
2035                 }
2036         }
2037   
2038         //Return if this element is now obsolete
2039         virtual CmiBool isObsolete(int nSprings,const CkArrayIndex &idx) {
2040                 if (isStale() && buffer.length()>0) {
2041                         /*This indicates something is seriously wrong--
2042                           buffers should be short-lived.*/
2043                         CkPrintf("[%d] WARNING: %d stale array message(s) found!\n",CkMyPe(),buffer.length());
2044                         CkArrayMessage *msg=buffer[0];
2045                         CkPrintf("Addressed to: ");
2046                         CkPrintEntryMethod(msg->array_ep());
2047                         CkPrintf(" index %s\n",idx2str(idx));
2048                         if (myLocMgr->isHome(idx)) 
2049                                 CkPrintf("is this an out-of-bounds array index, or was it never created?\n");
2050                         else //Idx is a remote-home index
2051                                 CkPrintf("why weren't they forwarded?\n");
2052                         
2053                         // CkAbort("Stale array manager message(s)!\n");
2054                 }
2055                 return CmiFalse;
2056         }
2057   
2058 /*  virtual void pup(PUP::er &p) {
2059     CkLocRec_aging::pup(p);
2060     CkArray::pupArrayMsgQ(buffer, p);
2061     }*/
2062 };
2063
2064 /*********************** Spring Cleaning *****************/
2065 /**
2066  * Used to periodically flush out unused remote element pointers.
2067  *
2068  * Cleaning often will free up memory quickly, but slow things
2069  * down because the cleaning takes time and some not-recently-referenced
2070  * remote element pointers might be valid and used some time in 
2071  * the future.
2072  *
2073  * Also used to determine if buffered messages have become stale.
2074  */
2075 inline void CkLocMgr::springCleaning(void)
2076 {
2077   nSprings++;
2078
2079   //Poke through the hash table for old ArrayRecs.
2080   void *objp;
2081   void *keyp;
2082   
2083   CkHashtableIterator *it=hash.iterator();
2084   CmiImmediateLock(hashImmLock);
2085   while (NULL!=(objp=it->next(&keyp))) {
2086     CkLocRec *rec=*(CkLocRec **)objp;
2087     CkArrayIndex &idx=*(CkArrayIndex *)keyp;
2088     if (rec->isObsolete(nSprings,idx)) {
2089       //This record is obsolete-- remove it from the table
2090       DEBK((AA"Cleaning out old record %s\n"AB,idx2str(idx)));
2091       hash.remove(*(CkArrayIndex *)&idx);
2092       delete rec;
2093       it->seek(-1);//retry this hash slot
2094     }
2095   }
2096   CmiImmediateUnlock(hashImmLock);
2097   delete it;
2098 }
2099 void CkLocMgr::staticSpringCleaning(void *forWhom,double curWallTime) {
2100         DEBK((AA"Starting spring cleaning at %.2f\n"AB,CkWallTimer()));
2101         ((CkLocMgr *)forWhom)->springCleaning();
2102 }
2103 //doesn't delete if there is extra pe
2104 void CkLocMgr::flushLocalRecs(void)
2105 {
2106   void *objp;
2107   void *keyp;
2108   CkHashtableIterator *it=hash.iterator();
2109   CmiImmediateLock(hashImmLock);
2110   while (NULL!=(objp=it->next(&keyp))) {
2111     CkLocRec *rec=*(CkLocRec **)objp;
2112     CkArrayIndex &idx=*(CkArrayIndex *)keyp;
2113     if (rec->type() == CkLocRec::local) {
2114         callMethod((CkLocRec_local*)rec, &CkMigratable::ckDestroy);
2115         it->seek(-1);//retry this hash slot
2116     }
2117   }
2118   delete it;
2119   CmiImmediateUnlock(hashImmLock);
2120 }
2121
2122 void CkLocMgr::recvChkpIter(int iter)
2123 {
2124   void *objp;
2125   void *keyp;
2126   CkHashtableIterator *it=hash.iterator();
2127   CmiImmediateLock(hashImmLock);
2128   while (NULL!=(objp=it->next(&keyp))) {
2129     CkLocRec *rec=*(CkLocRec **)objp;
2130     CkArrayIndex &idx=*(CkArrayIndex *)keyp;
2131     if (rec->type() == CkLocRec::local) {
2132         callMethod((CkLocRec_local*)rec, &CkMigratable::recvChkpIter,&iter);
2133     }
2134   }
2135   delete it;
2136   CmiImmediateUnlock(hashImmLock);
2137 }
2138
2139 void CkLocMgr::resumeFromChkp(){
2140   void *objp;
2141   void *keyp;
2142   CkHashtableIterator *it=hash.iterator();
2143   CmiImmediateLock(hashImmLock);
2144   while (NULL!=(objp=it->next(&keyp))) {
2145     CkLocRec *rec=*(CkLocRec **)objp;
2146     CkArrayIndex &idx=*(CkArrayIndex *)keyp;
2147     if (rec->type() == CkLocRec::local) {
2148         callMethod((CkLocRec_local*)rec, &CkMigratable::ResumeFromChkp);
2149     }
2150   }
2151   delete it;
2152   CmiImmediateUnlock(hashImmLock);
2153 }
2154
2155 // clean all buffer'ed messages and also free local objects
2156 void CkLocMgr::flushAllRecs(void)
2157 {
2158   void *objp;
2159   void *keyp;
2160   CkHashtableIterator *it=hash.iterator();
2161   CmiImmediateLock(hashImmLock);
2162   while (NULL!=(objp=it->next(&keyp))) {
2163     CkLocRec *rec=*(CkLocRec **)objp;
2164     CkArrayIndex &idx=*(CkArrayIndex *)keyp;
2165     if (rec->type() != CkLocRec::local) {
2166       //In the case of taking core out of memory (in BigSim's emulation)
2167       //the meta data in the location manager are not deleted so we need
2168       //this condition
2169       
2170       if(_BgOutOfCoreFlag!=1){
2171         hash.remove(*(CkArrayIndex *)&idx);
2172         delete rec;
2173         it->seek(-1);//retry this hash slot
2174       }
2175     }
2176     else {
2177         callMethod((CkLocRec_local*)rec, &CkMigratable::ckDestroy);
2178         it->seek(-1);//retry this hash slot
2179     }
2180   }
2181   delete it;
2182   CmiImmediateUnlock(hashImmLock);
2183 }
2184
2185
2186 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
2187 void CkLocMgr::callForAllRecords(CkLocFn fnPointer,CkArray *arr,void *data){
2188         void *objp;
2189         void *keyp;
2190
2191         CkHashtableIterator *it = hash.iterator();
2192         while (NULL!=(objp=it->next(&keyp))) {
2193                 CkLocRec *rec=*(CkLocRec **)objp;
2194                 CkArrayIndex &idx=*(CkArrayIndex *)keyp;
2195                 fnPointer(arr,data,rec,&idx);
2196         }
2197
2198         // releasing iterator memory
2199         delete it;
2200 }
2201 #endif
2202
2203 /*************************** LocMgr: CREATION *****************************/
2204 CkLocMgr::CkLocMgr(CkGroupID mapID_,CkGroupID lbdbID_,CkGroupID metalbID_,CkArrayIndex& numInitial)
2205         :thisProxy(thisgroup),thislocalproxy(thisgroup,CkMyPe()),
2206          hash(17,0.3)
2207 {
2208         DEBC((AA"Creating new location manager %d\n"AB,thisgroup));
2209 // moved to _CkMigratable_initInfoInit()
2210 //      CkpvInitialize(CkMigratable_initInfo,mig_initInfo);
2211
2212         managers.init();
2213         nManagers=0;
2214         firstManager=NULL;
2215         firstFree=localLen=0;
2216         duringMigration=CmiFalse;
2217         nSprings=0;
2218 #if !CMK_GLOBAL_LOCATION_UPDATE
2219         CcdCallOnConditionKeepOnPE(CcdPERIODIC_1minute,staticSpringCleaning,(void *)this, CkMyPe());
2220 #endif
2221
2222 //Register with the map object
2223         mapID=mapID_;
2224         map=(CkArrayMap *)CkLocalBranch(mapID);
2225         if (map==NULL) CkAbort("ERROR!  Local branch of array map is NULL!");
2226         mapHandle=map->registerArray(numInitial,thisgroup);
2227
2228 //Find and register with the load balancer
2229         lbdbID = lbdbID_;
2230   metalbID = metalbID_;
2231         initLB(lbdbID_, metalbID_);
2232         hashImmLock = CmiCreateImmediateLock();
2233         chkpID = ckCheckPTGroupID;
2234         the_chkp = (CkMemCheckPT *)CkLocalBranch(chkpID);
2235 }
2236
2237 CkLocMgr::CkLocMgr(CkGroupID mapID_,CkGroupID lbdbID_,CkArrayIndex& numInitial)
2238         :thisProxy(thisgroup),thislocalproxy(thisgroup,CkMyPe()),
2239          hash(17,0.3)
2240 {
2241 #if !CMK_LBDB_ON
2242         CkGroupID _metalb;
2243 #endif
2244         CkLocMgr(mapID_, lbdbID_, _metalb, numInitial);
2245 }
2246
2247
2248 CkLocMgr::CkLocMgr(CkMigrateMessage* m)
2249         :IrrGroup(m),thisProxy(thisgroup),thislocalproxy(thisgroup,CkMyPe()),hash(17,0.3)
2250 {
2251         managers.init();
2252         nManagers=0;
2253         firstManager=NULL;
2254         firstFree=localLen=0;
2255         duringMigration=CmiFalse;
2256         nSprings=0;
2257 #if !CMK_GLOBAL_LOCATION_UPDATE
2258         CcdCallOnConditionKeepOnPE(CcdPERIODIC_1minute,staticSpringCleaning,(void *)this, CkMyPe());
2259 #endif
2260         hashImmLock = CmiCreateImmediateLock();
2261 }
2262
2263 void CkLocMgr::pup(PUP::er &p){
2264         IrrGroup::pup(p);
2265         p|mapID;
2266         p|mapHandle;
2267         p|lbdbID;
2268   p|metalbID;
2269    p|chkpID;
2270         mapID = _defaultArrayMapID;
2271         if(p.isUnpacking()){
2272                 thisProxy=thisgroup;
2273                 CProxyElement_CkLocMgr newlocalproxy(thisgroup,CkMyPe());
2274                 thislocalproxy=newlocalproxy;
2275                 //Register with the map object
2276                 map=(CkArrayMap *)CkLocalBranch(mapID);
2277                 if (map==NULL) CkAbort("ERROR!  Local branch of array map is NULL!");
2278                 CkArrayIndex emptyIndex;
2279                 map->registerArray(emptyIndex,thisgroup);
2280                 // _lbdb is the fixed global groupID
2281                 initLB(lbdbID, metalbID);
2282                 the_chkp = (CkMemCheckPT *)CkLocalBranch(chkpID);
2283 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_)) ||CMK_MEM_CHECKPOINT    
2284         int count;
2285         p | count;
2286         DEBUG(CmiPrintf("[%d] Unpacking Locmgr %d has %d home elements\n",CmiMyPe(),thisgroup.idx,count));
2287 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))    
2288         homeElementCount = count;
2289 #endif
2290         for(int i=0;i<count;i++){
2291             CkArrayIndex idx;
2292             int pe;
2293             idx.pup(p);
2294             p | pe;
2295   //          CmiPrintf("[%d] idx %s is a home element exisiting on pe %d\n",CmiMyPe(),idx2str(idx),pe);
2296             inform(idx,pe);
2297             CkLocRec *rec = elementNrec(idx);
2298             CmiAssert(rec!=NULL);
2299             CmiAssert(lastKnown(idx) == pe);
2300         }
2301 #endif
2302                 // delay doneInserting when it is unpacking during restart.
2303                 // to prevent load balancing kicking in
2304                 if (!CkInRestarting()) 
2305                         doneInserting();
2306         }else{
2307  /**
2308  * pack the indexes of elements which have their homes on this processor
2309  * but dont exist on it.. needed for broadcast after a restart
2310  * indexes of local elements dont need to be packed
2311  * since they will be recreated later anyway
2312  */
2313 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))  || CMK_MEM_CHECKPOINT   
2314                 int count=0,count1=0;
2315         void *objp;
2316         void *keyp;
2317         CkVec<int> pe_list;
2318         CkVec<CkArrayIndex> idx_list;
2319         CkHashtableIterator *it = hash.iterator();
2320       while (NULL!=(objp=it->next(&keyp))) {
2321           CkLocRec *rec=*(CkLocRec **)objp;
2322           CkArrayIndex &idx=*(CkArrayIndex *)keyp;
2323             if(rec->type() != CkLocRec::local){
2324                 if(homePe(idx) == CmiMyPe()){
2325                   int pe;
2326                   CkArrayIndex max = idx;
2327                   pe = rec->lookupProcessor();
2328                   idx_list.push_back(max);
2329                   pe_list.push_back(pe);
2330                     count++;
2331                 }
2332             }
2333         }
2334         p | count;
2335
2336                 // releasing iterator memory
2337                 delete it;
2338
2339       for(int i=0;i<pe_list.length();i++){
2340         CkArrayIndex max = idx_list[i];
2341         max.pup(p);
2342         p|pe_list[i];
2343       }
2344     /*    it = hash.iterator();
2345       while (NULL!=(objp=it->next(&keyp))) {
2346       CkLocRec *rec=*(CkLocRec **)objp;
2347         CkArrayIndex &idx=*(CkArrayIndex *)keyp;
2348             CkArrayIndex max = idx;
2349             if(rec->type() != CkLocRec::local){
2350                 if(homePe(idx) == CmiMyPe()){
2351                     int pe;
2352                     max.pup(p);
2353                     pe = rec->lookupProcessor();
2354                     p | pe;
2355                     count1++;
2356                 }
2357             }
2358         }
2359       //  CmiAssert(count == count1);
2360
2361                 // releasing iterator memory
2362                 delete it;*/
2363
2364 #endif
2365
2366         }
2367 }
2368
2369 void _CkLocMgrInit(void) {
2370   /* Don't trace our deliver method--it does its own tracing */
2371   CkDisableTracing(CkIndex_CkLocMgr::deliverInline(0));
2372 }
2373
2374 /// Add a new local array manager to our list.
2375 /// Returns a new CkMigratableList for the manager to store his
2376 /// elements in.
2377 CkMigratableList *CkLocMgr::addManager(CkArrayID id,CkArrMgr *mgr)
2378 {
2379         CK_MAGICNUMBER_CHECK
2380         DEBC((AA"Adding new array manager\n"AB));
2381         //Link new manager into list
2382         ManagerRec *n=new ManagerRec;
2383         managers.find(id)=n;
2384         n->next=firstManager;
2385         n->mgr=mgr;
2386         n->elts.setSize(localLen);
2387         nManagers++;
2388         firstManager=n;
2389         return &n->elts;
2390 }
2391
2392 /// Return the next unused local element index.
2393 int CkLocMgr::nextFree(void) {
2394         if (firstFree>=localLen)
2395         {//Need more space in the local index arrays-- enlarge them
2396                 int oldLen=localLen;
2397                 localLen=localLen*2+8;
2398                 DEBC((AA"Growing the local list from %d to %d...\n"AB,oldLen,localLen));
2399                 for (ManagerRec *m=firstManager;m!=NULL;m=m->next)
2400                         m->elts.setSize(localLen);
2401                 //Update the free list
2402                 freeList.resize(localLen);
2403                 for (int i=oldLen;i<localLen;i++)
2404                         freeList[i]=i+1;
2405         }
2406         int localIdx=firstFree;
2407         if (localIdx==-1) CkAbort("CkLocMgr free list corrupted!");
2408         firstFree=freeList[localIdx];
2409         freeList[localIdx]=-1; //Mark as used
2410         return localIdx;
2411 }
2412
2413 CkLocRec_remote *CkLocMgr::insertRemote(const CkArrayIndex &idx,int nowOnPe)
2414 {
2415         DEBS((AA"Remote element %s lives on %d\n"AB,idx2str(idx),nowOnPe));
2416         CkLocRec_remote *rem=new CkLocRec_remote(this,nowOnPe);
2417         insertRec(rem,idx);
2418         return rem;
2419 }
2420
2421 //This element now lives on the given Pe
2422 void CkLocMgr::inform(const CkArrayIndex &idx,int nowOnPe)
2423 {
2424         if (nowOnPe==CkMyPe())
2425                 return; //Never insert a "remote" record pointing here
2426         CkLocRec *rec=elementNrec(idx);
2427         if (rec!=NULL && rec->type()==CkLocRec::local){
2428 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
2429         CmiPrintf("[%d]WARNING!!! Element %d:%s is local but is being told it exists on %d\n",CkMyPe(),idx.dimension,idx2str(idx), nowOnPe);
2430 #endif
2431                 return; //Never replace a local element's record!
2432         }
2433         insertRemote(idx,nowOnPe);
2434 }
2435
2436 //Tell this element's home processor it now lives "there"
2437 void CkLocMgr::informHome(const CkArrayIndex &idx,int nowOnPe)
2438 {
2439         int home=homePe(idx);
2440         if (home!=CkMyPe() && home!=nowOnPe) {
2441                 //Let this element's home Pe know it lives here now
2442                 DEBC((AA"  Telling %s's home %d that it lives on %d.\n"AB,idx2str(idx),home,nowOnPe));
2443 //#if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
2444 //#if defined(_FAULT_MLOG_)
2445 //        informLocationHome(thisgroup,idx,home,CkMyPe());
2446 //#else
2447                 thisProxy[home].updateLocation(idx,nowOnPe);
2448 //#endif
2449         }
2450 }
2451
2452 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
2453 CkLocRec_local *CkLocMgr::createLocal(const CkArrayIndex &idx,
2454         CmiBool forMigration, CmiBool ignoreArrival,
2455         CmiBool notifyHome,int dummy)
2456 {
2457     int localIdx=nextFree();
2458     DEBC((AA"Adding new record for element %s at local index %d\n"AB,idx2str(idx),localIdx));
2459     CkLocRec_local *rec=new CkLocRec_local(this,forMigration,ignoreArrival,idx,localIdx);
2460     if(!dummy){
2461         insertRec(rec,idx); //Add to global hashtable
2462     }   
2463     if (notifyHome) informHome(idx,CkMyPe());
2464     return rec; 
2465 }
2466 #else
2467 CkLocRec_local *CkLocMgr::createLocal(const CkArrayIndex &idx, 
2468                 CmiBool forMigration, CmiBool ignoreArrival,
2469                 CmiBool notifyHome)
2470 {
2471         //CkPrintf("Adding new record for element %s\n",idx2str(idx));
2472         int localIdx=nextFree();
2473         DEBC((AA"Adding new record for element %s at local index %d\n"AB,idx2str(idx),localIdx));
2474         //CkPrintf("Adding new record for element %s at local index %d\n",idx2str(idx),localIdx);
2475         CkLocRec_local *rec=new CkLocRec_local(this,forMigration,ignoreArrival,idx,localIdx);
2476         insertRec(rec,idx); //Add to global hashtable
2477         if (notifyHome) informHome(idx,CkMyPe());
2478         return rec;
2479 }
2480 #endif
2481
2482 //Add a new local array element, calling element's constructor
2483 CmiBool CkLocMgr::addElement(CkArrayID id,const CkArrayIndex &idx,
2484                 CkMigratable *elt,int ctorIdx,void *ctorMsg)
2485 {
2486         CK_MAGICNUMBER_CHECK
2487         CkLocRec *oldRec=elementNrec(idx);
2488         CkLocRec_local *rec;
2489         if (oldRec==NULL||oldRec->type()!=CkLocRec::local) 
2490         { //This is the first we've heard of that element-- add new local record
2491                 rec=createLocal(idx,CmiFalse,CmiFalse,CmiTrue);
2492 #if CMK_GLOBAL_LOCATION_UPDATE
2493                 if (homePe(idx) != CkMyPe()) {
2494                   DEBC((AA"Global location broadcast for new element idx %s "
2495                         "assigned to %d \n"AB, idx2str(idx), CkMyPe()));
2496                   thisProxy.updateLocation(idx, CkMyPe());  
2497                 }
2498 #endif
2499                 
2500         } else 
2501         { //rec is *already* local-- must not be the first insertion    
2502                 rec=((CkLocRec_local *)oldRec);
2503                 rec->addedElement();
2504         }
2505         if (!addElementToRec(rec,managers.find(id),elt,ctorIdx,ctorMsg)) return CmiFalse;
2506         elt->ckFinishConstruction();
2507         return CmiTrue;
2508 }
2509
2510 //As above, but shared with the migration code
2511 CmiBool CkLocMgr::addElementToRec(CkLocRec_local *rec,ManagerRec *m,
2512                 CkMigratable *elt,int ctorIdx,void *ctorMsg)
2513 {//Insert the new element into its manager's local list
2514         int localIdx=rec->getLocalIndex();
2515         if (m->elts.get(localIdx)!=NULL) CkAbort("Cannot insert array element twice!");
2516         m->elts.put(elt,localIdx); //Local element table
2517
2518 //Call the element's constructor
2519         DEBC((AA"Constructing element %s of array\n"AB,idx2str(rec->getIndex())));
2520         CkMigratable_initInfo &i=CkpvAccess(mig_initInfo);
2521         i.locRec=rec;
2522         i.chareType=_entryTable[ctorIdx]->chareIdx;
2523         if (!rec->invokeEntry(elt,ctorMsg,ctorIdx,CmiTrue)) return CmiFalse;
2524
2525 #if CMK_OUT_OF_CORE
2526         /* Register new element with out-of-core */
2527         PUP::sizer p_getSize; elt->pup(p_getSize);
2528         elt->prefetchObjID=CooRegisterObject(&CkArrayElementPrefetcher,p_getSize.size(),elt);
2529 #endif
2530         
2531         return CmiTrue;
2532 }
2533 void CkLocMgr::updateLocation(const CkArrayIndex &idx,int nowOnPe) {
2534   inform(idx,nowOnPe);
2535         CProxy_CkMemCheckPT checkptMgr(ckCheckPTGroupID);
2536 }
2537
2538 /*************************** LocMgr: DELETION *****************************/
2539 /// This index will no longer be used-- delete the associated elements
2540 void CkLocMgr::reclaim(const CkArrayIndex &idx,int localIdx) {
2541         CK_MAGICNUMBER_CHECK
2542         DEBC((AA"Destroying element %s (local %d)\n"AB,idx2str(idx),localIdx));
2543         //Delete, and mark as empty, each array element
2544         for (ManagerRec *m=firstManager;m!=NULL;m=m->next) {
2545                 delete m->elts.get(localIdx);
2546                 m->elts.empty(localIdx);
2547         }
2548         
2549         removeFromTable(idx);
2550         
2551         //Link local index into free list
2552         freeList[localIdx]=firstFree;
2553         firstFree=localIdx;
2554         
2555                 
2556         if (!duringMigration) 
2557         { //This is a local element dying a natural death
2558             #if CMK_BIGSIM_CHARM
2559                 //After migration, reclaimRemote will be called through 
2560                 //the CkRemoveArrayElement in the pupping routines for those 
2561                 //objects that are not on the home processors. However,
2562                 //those remote records should not be deleted since the corresponding
2563                 //objects are not actually deleted but on disk. If deleted, msgs
2564                 //that seeking where is the object will be accumulated (a circular
2565                 //msg chain) and causes the program no progress
2566                 if(_BgOutOfCoreFlag==1) return; 
2567             #endif
2568                 int home=homePe(idx);
2569                 if (home!=CkMyPe())
2570 #if CMK_MEM_CHECKPOINT
2571                 if (!CkInRestarting()) // all array elements are removed anyway
2572 #endif
2573                         thisProxy[home].reclaimRemote(idx,CkMyPe());
2574         /*      //Install a zombie to keep the living from re-using this index.
2575                 insertRecN(new CkLocRec_dead(this),idx); */
2576         }
2577 }
2578
2579 void CkLocMgr::reclaimRemote(const CkArrayIndex &idx,int deletedOnPe) {
2580         DEBC((AA"Our element %s died on PE %d\n"AB,idx2str(idx),deletedOnPe));
2581         CkLocRec *rec=elementNrec(idx);
2582         if (rec==NULL) return; //We never knew him
2583         if (rec->type()==CkLocRec::local) return; //He's already been reborn
2584         removeFromTable(idx);
2585         delete rec;
2586 }
2587 void CkLocMgr::removeFromTable(const CkArrayIndex &idx) {
2588 #if CMK_ERROR_CHECKING
2589         //Make sure it's actually in the table before we delete it
2590         if (NULL==elementNrec(idx))
2591                 CkAbort("CkLocMgr::removeFromTable called on invalid index!");
2592 #endif
2593         CmiImmediateLock(hashImmLock);
2594         hash.remove(*(CkArrayIndex *)&idx);
2595         CmiImmediateUnlock(hashImmLock);
2596 #if CMK_ERROR_CHECKING
2597         //Make sure it's really gone
2598         if (NULL!=elementNrec(idx))
2599                 CkAbort("CkLocMgr::removeFromTable called, but element still there!");
2600 #endif
2601 }
2602
2603 /************************** LocMgr: MESSAGING *************************/
2604 /// Deliver message to this element, going via the scheduler if local
2605 /// @return 0 if object local, 1 if not
2606 int CkLocMgr::deliver(CkMessage *m,CkDeliver_t type,int opts) {
2607         DEBS((AA"deliver \n"AB));
2608         CK_MAGICNUMBER_CHECK
2609         CkArrayMessage *msg=(CkArrayMessage *)m;
2610
2611
2612         const CkArrayIndex &idx=msg->array_index();
2613         DEBS((AA"deliver %s\n"AB,idx2str(idx)));
2614         if (type==CkDeliver_queue)
2615                 _TRACE_CREATION_DETAILED(UsrToEnv(m),msg->array_ep());
2616         CkLocRec *rec=elementNrec(idx);
2617         if(rec != NULL){
2618                 DEBS((AA"deliver %s of type %d \n"AB,idx2str(idx),rec->type()));
2619         }else{
2620                 DEBS((AA"deliver %s rec is null\n"AB,idx2str(idx)));
2621         }
2622 //#if (!defined(_FAULT_MLOG_) && !defined(_FAULT_CAUSAL_))
2623 //#if !defined(_FAULT_MLOG_)
2624 #if CMK_LBDB_ON
2625
2626         LDObjid ldid = idx2LDObjid(idx);
2627 #if CMK_GLOBAL_LOCATION_UPDATE
2628         ldid.locMgrGid = thisgroup.idx;
2629 #endif        
2630         if (type==CkDeliver_queue) {
2631                 if (!(opts & CK_MSG_LB_NOTRACE) && the_lbdb->CollectingCommStats()) {
2632                 if(rec!=NULL) the_lbdb->Send(myLBHandle,ldid,UsrToEnv(msg)->getTotalsize(), rec->lookupProcessor(), 1);
2633                 else /*rec==NULL*/ the_lbdb->Send(myLBHandle,ldid,UsrToEnv(msg)->getTotalsize(),homePe(msg->array_index()), 1);
2634                 }
2635         }
2636 #endif
2637 //#endif
2638 #if CMK_GRID_QUEUE_AVAILABLE
2639         int gridSrcPE;
2640         int gridSrcCluster;
2641         int gridDestPE;
2642         int gridDestCluster;
2643         CkMigratable *obj;
2644         ArrayElement *obj2;
2645         CkGroupID gid;
2646         int *data;
2647
2648         obj = (CkMigratable *) CpvAccess(CkGridObject);   // CkGridObject is a pointer to the sending object (retained earlier)
2649         if (obj != NULL) {
2650           obj2 = dynamic_cast<ArrayElement *> (obj);
2651           if (obj2 > 0) {
2652             // Get the sending object's array gid and indexes.
2653             // These are guaranteed to exist due to the succeeding dynamic cast above.
2654             gid = obj2->ckGetArrayID ();
2655             data = obj2->thisIndexMax.data ();
2656
2657             // Get the source PE and destination PE.
2658             gridSrcPE = CkMyPe ();
2659             if (rec != NULL) {
2660               gridDestPE = rec->lookupProcessor ();
2661             } else {
2662               gridDestPE = homePe (msg->array_index ());
2663             }
2664
2665             // Get the source cluster and destination cluster.
2666             gridSrcCluster = CmiGetCluster (gridSrcPE);
2667             gridDestCluster = CmiGetCluster (gridDestPE);
2668
2669             // If the Grid queue interval is greater than zero, it means that the more complicated
2670             // technique for registering border objects that exceed a specified threshold of
2671             // cross-cluster messages within a specified interval (and deregistering border objects
2672             // that do not meet this threshold) is used.  Otherwise a much simpler technique is used
2673             // where a border object is registered immediately upon sending a single cross-cluster
2674             // message (and deregistered when load balancing takes place).
2675             if (obj2->grid_queue_interval > 0) {
2676               // Increment the sending object's count of all messages.
2677               obj2->msg_count += 1;
2678
2679               // If the source cluster and destination cluster differ, this is a Grid message.
2680               // (Increment the count of all Grid messages.)
2681               if (gridSrcCluster != gridDestCluster) {
2682                 obj2->msg_count_grid += 1;
2683               }
2684
2685               // If the number of messages exceeds the interval, check to see if the object has
2686               // sent enough cross-cluster messages to qualify as a border object.
2687               if (obj2->msg_count >= obj2->grid_queue_interval) {
2688                 if (obj2->msg_count_grid >= obj2->grid_queue_threshold) {
2689                   // The object is a border object; if it is not already registered, register it.
2690                   if (!obj2->border_flag) {
2691                     CmiGridQueueRegister (gid.idx, obj2->thisIndexMax.nInts, data[0], data[1], data[2]);
2692                   }
2693                   obj2->border_flag = 1;
2694                 } else {
2695                   // The object is not a border object; if it is registered, deregister it.
2696                   if (obj2->border_flag) {
2697                     CmiGridQueueDeregister (gid.idx, obj2->thisIndexMax.nInts, data[0], data[1], data[2]);
2698                   }
2699                   obj2->border_flag = 0;
2700                 }
2701                 // Reset the counts.
2702                 obj2->msg_count = 0;
2703                 obj2->msg_count_grid = 0;
2704               }
2705             } else {
2706               if (gridSrcCluster != gridDestCluster) {
2707                 CmiGridQueueRegister (gid.idx, obj2->thisIndexMax.nInts, data[0], data[1], data[2]);
2708               }
2709             }
2710           }
2711
2712           // Reset the CkGridObject pointer.
2713           CpvAccess(CkGridObject) = NULL;
2714         }
2715 #endif
2716         /**FAULT_EVAC*/
2717         if (rec!=NULL){
2718                 CmiBool result = rec->deliver(msg,type,opts);
2719                 // if result is CmiFalse, than rec is not valid anymore, as the object
2720                 // the message was just delivered to has died or migrated out.
2721                 // Therefore rec->type() cannot be invoked!
2722                 if (result==CmiTrue && rec->type()==CkLocRec::local) return 0;
2723                 else return 1;
2724                 /*if(!result){
2725                         //DEBS((AA"deliver %s failed type %d \n"AB,idx2str(idx),rec->type()));
2726                         DEBS((AA"deliver %s failed \n"AB,idx2str(idx)));
2727                         if(rec->type() == CkLocRec::remote){
2728                                 if (opts & CK_MSG_KEEP)
2729                                         msg = (CkArrayMessage *)CkCopyMsg((void **)&msg);
2730                                 deliverUnknown(msg,type);
2731                         }
2732                 }*/
2733         }else /* rec==NULL*/ {
2734                 if (opts & CK_MSG_KEEP)
2735                         msg = (CkArrayMessage *)CkCopyMsg((void **)&msg);
2736                 deliverUnknown(msg,type,opts);
2737                 return 1;
2738         }
2739
2740 }
2741
2742 /// This index is not hashed-- somehow figure out what to do.
2743 CmiBool CkLocMgr::deliverUnknown(CkArrayMessage *msg,CkDeliver_t type,int opts)
2744 {
2745         CK_MAGICNUMBER_CHECK
2746         const CkArrayIndex &idx=msg->array_index();
2747         int onPe=homePe(idx);
2748         if (onPe!=CkMyPe()) 
2749         {// Forward the message to its home processor
2750                 DEBM((AA"Forwarding message for unknown %s to home %d \n"AB,idx2str(idx),onPe));
2751                 msg->array_hops()++;
2752                 CkArrayManagerDeliver(onPe,msg,opts);
2753                 return CmiTrue;
2754         }
2755         else
2756         { // We *are* the home processor:
2757         //Check if the element's array manager has been registered yet:
2758           CkArrMgr *mgr=managers.find(UsrToEnv((void *)msg)->getsetArrayMgr())->mgr;
2759           if (!mgr) { //No manager yet-- postpone the message (stupidly)
2760             if (CkInRestarting()) {
2761               // during restarting, this message should be ignored
2762               delete msg;
2763             }
2764             else {
2765               CkArrayManagerDeliver(CkMyPe(),msg); 
2766             }
2767           }
2768           else { // Has a manager-- must buffer the message
2769             DEBC((AA"Adding buffer for unknown element %s\n"AB,idx2str(idx)));
2770             CkLocRec *rec=new CkLocRec_buffering(this);
2771             insertRecN(rec,idx);
2772             rec->deliver(msg,type);
2773           
2774             if (msg->array_ifNotThere()!=CkArray_IfNotThere_buffer) 
2775             { //Demand-create the element:
2776               return demandCreateElement(msg,-1,type);
2777             }
2778           }
2779           return CmiTrue;
2780         }
2781 }
2782
2783 CmiBool CkLocMgr::demandCreateElement(CkArrayMessage *msg,int onPe,CkDeliver_t type)
2784 {
2785         CK_MAGICNUMBER_CHECK
2786         const CkArrayIndex &idx=msg->array_index();
2787         int chareType=_entryTable[msg->array_ep()]->chareIdx;
2788         int ctor=_chareTable[chareType]->getDefaultCtor();
2789         if (ctor==-1) CkAbort("Can't create array element to handle message--\n"
2790                               "The element has no default constructor in the .ci file!\n");
2791         if (onPe==-1) 
2792         { //Decide where element needs to live
2793                 if (msg->array_ifNotThere()==CkArray_IfNotThere_createhere) 
2794                         onPe=UsrToEnv(msg)->getsetArraySrcPe();
2795                 else //Createhome
2796                         onPe=homePe(idx);
2797         }
2798         
2799         //Find the manager and build the element
2800         DEBC((AA"Demand-creating element %s on pe %d\n"AB,idx2str(idx),onPe));
2801         CkArrMgr *mgr=managers.find(UsrToEnv((void *)msg)->getsetArrayMgr())->mgr;
2802         if (!mgr) CkAbort("Tried to demand-create for nonexistent arrMgr");
2803         return mgr->demandCreateElement(idx,onPe,ctor,type);
2804 }
2805
2806 //This message took several hops to reach us-- fix it
2807 void CkLocMgr::multiHop(CkArrayMessage *msg)
2808 {
2809
2810         CK_MAGICNUMBER_CHECK
2811         int srcPe=msg->array_getSrcPe();
2812         if (srcPe==CkMyPe())
2813                 DEB((AA"Odd routing: local element %s is %d hops away!\n"AB,idx2str(msg),msg->array_hops()));
2814         else
2815         {//Send a routing message letting original sender know new element location
2816                 DEBS((AA"Sending update back to %d for element\n"AB,srcPe,idx2str(msg)));
2817                 thisProxy[srcPe].updateLocation(msg->array_index(),CkMyPe());
2818         }
2819 }
2820
2821 /************************** LocMgr: ITERATOR *************************/
2822 CkLocation::CkLocation(CkLocMgr *mgr_, CkLocRec_local *rec_)
2823         :mgr(mgr_), rec(rec_) {}
2824         
2825 const CkArrayIndex &CkLocation::getIndex(void) const {
2826         return rec->getIndex();
2827 }
2828
2829 void CkLocation::destroyAll() {
2830         mgr->callMethod(rec, &CkMigratable::ckDestroy);
2831 }
2832
2833 void CkLocation::pup(PUP::er &p) {
2834         mgr->pupElementsFor(p,rec,CkElementCreation_migrate);
2835 }
2836
2837 CkLocIterator::~CkLocIterator() {}
2838
2839 /// Iterate over our local elements:
2840 void CkLocMgr::iterate(CkLocIterator &dest) {
2841   //Poke through the hash table for local ArrayRecs.
2842   void *objp;
2843   CkHashtableIterator *it=hash.iterator();
2844   CmiImmediateLock(hashImmLock);
2845
2846   while (NULL!=(objp=it->next())) {
2847     CkLocRec *rec=*(CkLocRec **)objp;
2848     if (rec->type()==CkLocRec::local) {
2849       CkLocation loc(this,(CkLocRec_local *)rec);
2850       dest.addLocation(loc);
2851     }
2852   }
2853   CmiImmediateUnlock(hashImmLock);
2854   delete it;
2855 }
2856
2857
2858 void CkLocMgr::iterateChkpSync(CkLocIterator &dest) {
2859   //Poke through the hash table for local ArrayRecs.
2860   void *objp;
2861   CkHashtableIterator *it=hash.iterator();
2862   CmiImmediateLock(hashImmLock);
2863
2864   while (NULL!=(objp=it->next())) {
2865     CkLocRec *rec=*(CkLocRec **)objp;
2866     if (rec->type()==CkLocRec::local) {
2867       CkLocation loc(this,(CkLocRec_local *)rec);
2868           int localIdx=((CkLocRec_local *)rec)->getLocalIndex();
2869           for (ManagerRec *m=firstManager;m!=NULL;m=m->next) {
2870                 CkMigratable *el=m->element(localIdx);
2871         if(el->getChkpSync()==CmiTrue){
2872                         dest.addLocation(loc);
2873                         break;
2874                 }
2875           }
2876     }
2877   }
2878   CmiImmediateUnlock(hashImmLock);
2879   delete it;
2880 }
2881
2882
2883 /************************** LocMgr: MIGRATION *************************/
2884 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
2885 void CkLocMgr::pupElementsFor(PUP::er &p,CkLocRec_local *rec,
2886         CkElementCreation_t type, CmiBool create, int dummy)
2887 {
2888     p.comment("-------- Array Location --------");
2889     register ManagerRec *m;
2890     int localIdx=rec->getLocalIndex();
2891     CkVec<CkMigratable *> dummyElts;
2892     for (m=firstManager;m!=NULL;m=m->next) {
2893         int elCType;
2894         if (!p.isUnpacking())
2895         { //Need to find the element's existing type
2896             CkMigratable *elt=m->element(localIdx);
2897             if (elt) elCType=elt->ckGetChareType();
2898             else elCType=-1; //Element hasn't been created
2899         }
2900         p(elCType);
2901         if (p.isUnpacking() && elCType!=-1) {
2902             CkMigratable *elt=m->mgr->allocateMigrated(elCType,rec->getIndex(),type);
2903             int migCtorIdx=_chareTable[elCType]->getMigCtor();
2904                         if(!dummy){
2905                                 if(create)
2906                                 if (!addElementToRec(rec,m,elt,migCtorIdx,NULL)) return;
2907                                 }else{
2908                     CkMigratable_initInfo &i=CkpvAccess(mig_initInfo);
2909                     i.locRec=rec;
2910                     i.chareType=_entryTable[migCtorIdx]->chareIdx;
2911                     dummyElts.push_back(elt);
2912                     if (!rec->invokeEntry(elt,NULL,migCtorIdx,CmiTrue)) return ;
2913                 }
2914         }
2915         }
2916     if(!dummy){
2917         for (m=firstManager;m!=NULL;m=m->next) {
2918             CkMigratable *elt=m->element(localIdx);
2919             if (elt!=NULL)
2920                 {
2921                        elt->pup(p);
2922                 }
2923         }
2924     }else{
2925             for(int i=0;i<dummyElts.size();i++){
2926                 CkMigratable *elt = dummyElts[i];
2927                 if (elt!=NULL){
2928             elt->pup(p);
2929                         }
2930                 delete elt;
2931             }
2932                         for (ManagerRec *m=firstManager;m!=NULL;m=m->next) {
2933                 m->elts.empty(localIdx);
2934             }
2935         freeList[localIdx]=firstFree;
2936         firstFree=localIdx;
2937     }
2938 }
2939 #else
2940 void CkLocMgr::pupElementsFor(PUP::er &p,CkLocRec_local *rec,
2941                 CkElementCreation_t type,CmiBool rebuild,CmiBool create)
2942 {
2943         p.comment("-------- Array Location --------");
2944         register ManagerRec *m;
2945         int localIdx=rec->getLocalIndex();
2946
2947         //First pup the element types
2948         // (A separate loop so ckLocal works even in element pup routines)
2949         for (m=firstManager;m!=NULL;m=m->next) {
2950                 int elCType;
2951                 if (!p.isUnpacking())
2952                 { //Need to find the element's existing type
2953                         CkMigratable *elt=m->element(localIdx);
2954                         if (elt) elCType=elt->ckGetChareType();
2955                         else elCType=-1; //Element hasn't been created
2956                 }
2957
2958                 p(elCType);
2959                 if (p.isUnpacking() && elCType!=-1) {
2960                         //Create the element
2961                         CkMigratable *elt=m->mgr->allocateMigrated(elCType,rec->getIndex(),type);
2962                         int migCtorIdx=_chareTable[elCType]->getMigCtor();
2963                         //Insert into our tables and call migration constructor
2964                         if(create)
2965                                 if (!addElementToRec(rec,m,elt,migCtorIdx,NULL)) return;
2966                 }
2967         }
2968
2969         //Next pup the element data
2970         for (m=firstManager;m!=NULL;m=m->next) {
2971                 CkMigratable *elt=m->element(localIdx);
2972                 if (elt!=NULL)
2973                 {
2974                         elt->pup(p);
2975 #if CMK_ERROR_CHECKING
2976                         if (p.isUnpacking()) elt->sanitycheck();
2977 #endif
2978                 }
2979         }
2980
2981 #if CMK_MEM_CHECKPOINT
2982         if(rebuild){
2983           ArrayElement *elt;
2984           CkVec<CkMigratable *> list;
2985           migratableList(rec, list);
2986           CmiAssert(list.length() > 0);
2987           for (int l=0; l<list.length(); l++) {
2988                 //    reset, may not needed now
2989                 // for now.
2990                 for (int i=0; i<CK_ARRAYLISTENER_MAXLEN; i++) {
2991                         ArrayElement * elt = (ArrayElement *)list[l];
2992                   contributorInfo *c=(contributorInfo *)&elt->listenerData[i];
2993                   if (c) c->redNo = 0;
2994                 }
2995           }
2996         }
2997 #endif
2998 }
2999 #endif
3000
3001 /// Call this member function on each element of this location:
3002 void CkLocMgr::callMethod(CkLocRec_local *rec,CkMigratable_voidfn_t fn)
3003 {
3004         int localIdx=rec->getLocalIndex();
3005         for (ManagerRec *m=firstManager;m!=NULL;m=m->next) {
3006                 CkMigratable *el=m->element(localIdx);
3007                 if (el) (el->* fn)();
3008         }
3009 }
3010
3011 /// Call this member function on each element of this location:
3012 void CkLocMgr::callMethod(CkLocRec_local *rec,CkMigratable_voidfn_arg_t fn,     void * data)
3013 {
3014         int localIdx=rec->getLocalIndex();
3015         for (ManagerRec *m=firstManager;m!=NULL;m=m->next) {
3016                 CkMigratable *el=m->element(localIdx);
3017                 if (el) (el->* fn)(data);
3018         }
3019 }
3020
3021 /// return a list of migratables in this local record
3022 void CkLocMgr::migratableList(CkLocRec_local *rec, CkVec<CkMigratable *> &list)
3023 {
3024         register ManagerRec *m;
3025         int localIdx=rec->getLocalIndex();
3026
3027         for (m=firstManager;m!=NULL;m=m->next) {
3028                 CkMigratable *elt=m->element(localIdx);
3029                 if (elt) list.push_back(elt);
3030         }
3031 }
3032
3033 /// Migrate this local element away to another processor.
3034 void CkLocMgr::emigrate(CkLocRec_local *rec,int toPe)
3035 {
3036         CK_MAGICNUMBER_CHECK
3037         if (toPe==CkMyPe()) return; //You're already there!
3038         /*
3039                 FAULT_EVAC
3040                 if the toProcessor is already marked as invalid, dont emigrate
3041                 Shouldn't happen but might
3042         */
3043         if(!CmiNodeAlive(toPe)){
3044                 return;
3045         }
3046         CkArrayIndex idx=rec->getIndex();
3047
3048 #if CMK_OUT_OF_CORE
3049         int localIdx=rec->getLocalIndex();
3050         /* Load in any elements that are out-of-core */
3051         for (ManagerRec *m=firstManager;m!=NULL;m=m->next) {
3052                 CkMigratable *el=m->element(localIdx);
3053                 if (el) if (!el->isInCore) CooBringIn(el->prefetchObjID);
3054         }
3055 #endif
3056
3057         //Let all the elements know we're leaving
3058         callMethod(rec,&CkMigratable::ckAboutToMigrate);
3059         /*EVAC*/
3060
3061 //First pass: find size of migration message
3062         int bufSize;
3063         {
3064                 PUP::sizer p;
3065                 p(nManagers);
3066                 pupElementsFor(p,rec,CkElementCreation_migrate);
3067                 bufSize=p.size(); 
3068         }
3069
3070 //Allocate and pack into message
3071         int doubleSize=bufSize/sizeof(double)+1;
3072         CkArrayElementMigrateMessage *msg = 
3073                 new (doubleSize, 0) CkArrayElementMigrateMessage;
3074         msg->idx=idx;
3075         msg->length=bufSize;
3076 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_)) 
3077     msg->gid = ckGetGroupID();
3078 #endif
3079 #if CMK_LBDB_ON
3080         msg->ignoreArrival = rec->isAsyncMigrate()?1:0;
3081 #endif
3082         /*
3083                 FAULT_EVAC
3084         */
3085         msg->bounced = rec->isBounced();
3086         {
3087                 PUP::toMem p(msg->packData); 
3088                 p.becomeDeleting(); 
3089                 p(nManagers);
3090                 pupElementsFor(p,rec,CkElementCreation_migrate);
3091                 if (p.size()!=bufSize) {
3092                         CkError("ERROR! Array element claimed it was %d bytes to a "
3093                                 "sizing PUP::er, but copied %d bytes into the packing PUP::er!\n",
3094                                 bufSize,p.size());
3095                         CkAbort("Array element's pup routine has a direction mismatch.\n");
3096                 }
3097         }
3098
3099         DEBM((AA"Migrated index size %s to %d \n"AB,idx2str(idx),toPe));        
3100
3101 //#if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
3102 //#if defined(_FAULT_MLOG_)
3103 //    sendMlogLocation(toPe,UsrToEnv(msg));
3104 //#else
3105         //Send off message and delete old copy
3106         thisProxy[toPe].immigrate(msg);
3107 //#endif
3108
3109         duringMigration=CmiTrue;
3110         delete rec; //Removes elements, hashtable entries, local index
3111         
3112         
3113         duringMigration=CmiFalse;
3114         //The element now lives on another processor-- tell ourselves and its home
3115         inform(idx,toPe);
3116 //#if (!defined(_FAULT_MLOG_) && !defined(_FAULT_CAUSAL_))    
3117 //#if !defined(_FAULT_MLOG_)    
3118         informHome(idx,toPe);
3119 //#endif
3120
3121 #if !CMK_LBDB_ON && CMK_GLOBAL_LOCATION_UPDATE
3122         DEBM((AA"Global location update. idx %s " 
3123               "assigned to %d \n"AB,idx2str(idx),toPe));
3124         thisProxy.updateLocation(idx, toPe);                        
3125 #endif
3126
3127         CK_MAGICNUMBER_CHECK
3128 }
3129
3130 #if CMK_LBDB_ON
3131 void CkLocMgr::informLBPeriod(CkLocRec_local *rec, int lb_ideal_period) {
3132         callMethod(rec,&CkMigratable::recvLBPeriod, (void *)&lb_ideal_period);
3133 }
3134
3135 void CkLocMgr::metaLBCallLB(CkLocRec_local *rec) {
3136         callMethod(rec, &CkMigratable::metaLBCallLB);
3137 }
3138 #endif
3139
3140 /**
3141   Migrating array element is arriving on this processor.
3142 */
3143 void CkLocMgr::immigrate(CkArrayElementMigrateMessage *msg)
3144 {
3145         const CkArrayIndex &idx=msg->idx;
3146                 
3147         PUP::fromMem p(msg->packData); 
3148         
3149         int nMsgMan;
3150         p(nMsgMan);
3151         if (nMsgMan<nManagers)
3152                 CkAbort("Array element arrived from location with fewer managers!\n");
3153         if (nMsgMan>nManagers) {
3154                 //Some array managers haven't registered yet-- throw it back
3155                 DEBM((AA"Busy-waiting for array registration on migrating %s\n"AB,idx2str(idx)));
3156                 thisProxy[CkMyPe()].immigrate(msg);
3157                 return;
3158         }
3159
3160         //Create a record for this element
3161 //#if (!defined(_FAULT_MLOG_) && !defined(_FAULT_CAUSAL_))    
3162 //#if !defined(_FAULT_MLOG_)     
3163         CkLocRec_local *rec=createLocal(idx,CmiTrue,msg->ignoreArrival,CmiFalse /* home told on departure */ );
3164 //#else
3165 //    CkLocRec_local *rec=createLocal(idx,CmiTrue,CmiTrue,CmiFalse /* home told on departure */ );
3166 //#endif
3167         
3168         //Create the new elements as we unpack the message
3169         pupElementsFor(p,rec,CkElementCreation_migrate);
3170         if (p.size()!=msg->length) {
3171                 CkError("ERROR! Array element claimed it was %d bytes to a"
3172                         "packing PUP::er, but %d bytes in the unpacking PUP::er!\n",
3173                         msg->length,p.size());
3174                 CkError("(I have %d managers; he claims %d managers)\n",
3175                         nManagers,nMsgMan);
3176                 
3177                 CkAbort("Array element's pup routine has a direction mismatch.\n");
3178         }
3179         /*
3180                 FAULT_EVAC
3181                         if this element came in as a result of being bounced off some other process,
3182                         then it needs to be resumed. It is assumed that it was bounced because load 
3183                         balancing caused it to move into a processor which later crashed
3184         */
3185         if(msg->bounced){
3186                 callMethod(rec,&CkMigratable::ResumeFromSync);
3187         }
3188         
3189         //Let all the elements know we've arrived
3190         callMethod(rec,&CkMigratable::ckJustMigrated);
3191         /*FAULT_EVAC
3192                 If this processor has started evacuating array elements on it 
3193                 dont let new immigrants in. If they arrive send them to what
3194                 would be their correct homePE.
3195                 Leave a record here mentioning the processor where it got sent
3196         */
3197         
3198         if(CkpvAccess(startedEvac)){
3199                 int newhomePE = getNextPE(idx);
3200                 DEBM((AA"Migrated into failed processor index size %s resent to %d \n"AB,idx2str(idx),newhomePE));      
3201                 CkLocMgr *mgr = rec->getLocMgr();
3202                 int targetPE=getNextPE(idx);
3203                 //set this flag so that load balancer is not informed when
3204                 //this element migrates
3205                 rec->AsyncMigrate(CmiTrue);
3206                 rec->Bounced(CmiTrue);
3207                 mgr->emigrate(rec,targetPE);
3208                 
3209         }
3210
3211         delete msg;
3212 }
3213
3214 void CkLocMgr::restore(const CkArrayIndex &idx, PUP::er &p)
3215 {
3216         //This is in broughtIntoMem during out-of-core emulation in BigSim,
3217         //informHome should not be called since such information is already
3218         //immediately updated real migration
3219 #if CMK_ERROR_CHECKING
3220         if(_BgOutOfCoreFlag!=2)
3221             CmiAbort("CkLocMgr::restore should only be used in out-of-core emulation for BigSim and be called when object is brought into memory!\n");
3222 #endif
3223         CkLocRec_local *rec=createLocal(idx,CmiFalse,CmiFalse,CmiFalse);
3224         
3225         //BIGSIM_OOC DEBUGGING
3226         //CkPrintf("Proc[%d]: Registering element %s with LDB\n", CkMyPe(), idx2str(idx));
3227
3228         //Create the new elements as we unpack the message
3229         pupElementsFor(p,rec,CkElementCreation_restore);
3230
3231         callMethod(rec,&CkMigratable::ckJustRestored);
3232 }
3233
3234
3235 /// Insert and unpack this array element from this checkpoint (e.g., from CkLocation::pup)
3236 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
3237 void CkLocMgr::resume(const CkArrayIndex &idx, PUP::er &p, CmiBool create, int dummy)
3238 {
3239         CkLocRec_local *rec;
3240         CkLocRec *recGlobal;    
3241
3242         if(create){
3243                 rec = createLocal(idx,CmiFalse,CmiFalse,CmiTrue && !dummy /* home doesn't know yet */,dummy );
3244         }else{
3245                 recGlobal = elementNrec(idx);
3246                 if(recGlobal == NULL) 
3247                         CmiAbort("Local object not found");
3248                 if(recGlobal->type() != CkLocRec::local)
3249                         CmiAbort("Local object not local, :P");
3250                 rec = (CkLocRec_local *)recGlobal;
3251         }
3252         
3253     pupElementsFor(p,rec,CkElementCreation_resume,create,dummy);
3254
3255     if(!dummy){
3256         callMethod(rec,&CkMigratable::ckJustMigrated);
3257     }
3258 }
3259 #else
3260 void CkLocMgr::resume(const CkArrayIndex &idx, PUP::er &p, CmiBool notify,CmiBool rebuild,CmiBool create)
3261 {
3262         CkLocRec_local *rec;
3263         CkLocRec *recGlobal;    
3264
3265         if(create){
3266                 //Create the new elements as we unpack the message
3267                 rec=createLocal(idx,CmiFalse,CmiFalse,notify /* home doesn't know yet */ );
3268         }else{
3269                 recGlobal = elementNrec(idx);
3270                 if(recGlobal == NULL) 
3271                         CmiAbort("Local object not found");
3272                 if(recGlobal->type() != CkLocRec::local)
3273                         CmiAbort("Local object not local, :P");
3274                 rec = (CkLocRec_local *)recGlobal;
3275         }
3276         pupElementsFor(p,rec,CkElementCreation_resume,rebuild,create);
3277         if(!p.isChecking())
3278                 callMethod(rec,&CkMigratable::ckJustMigrated);
3279 }
3280 #endif
3281
3282 /********************* LocMgr: UTILITY ****************/
3283 void CkMagicNumber_impl::badMagicNumber(
3284         int expected,const char *file,int line,void *obj) const
3285 {
3286         CkError("FAILURE on pe %d, %s:%d> Expected %p's magic number "
3287                 "to be 0x%08x; but found 0x%08x!\n", CkMyPe(),file,line,obj,
3288                 expected, magic);
3289         CkAbort("Bad magic number detected!  This implies either\n"
3290                 "the heap or a message was corrupted!\n");
3291 }
3292 CkMagicNumber_impl::CkMagicNumber_impl(int m) :magic(m) { }
3293
3294 //Look up the object with this array index, or return NULL
3295 CkMigratable *CkLocMgr::lookup(const CkArrayIndex &idx,CkArrayID aid) {
3296         CkLocRec *rec=elementNrec(idx);
3297         if (rec==NULL) return NULL;
3298         else return rec->lookupElement(aid);
3299 }
3300 //"Last-known" location (returns a processor number)
3301 int CkLocMgr::lastKnown(const CkArrayIndex &idx) {
3302         CkLocMgr *vthis=(CkLocMgr *)this;//Cast away "const"
3303         CkLocRec *rec=vthis->elementNrec(idx);
3304         int pe=-1;
3305         if (rec!=NULL) pe=rec->lookupProcessor();
3306         if (pe==-1) return homePe(idx);
3307         else{
3308                 /*
3309                         FAULT_EVAC
3310                         if the lastKnownPE is invalid return homePE and delete this record
3311                 */
3312                 if(!CmiNodeAlive(pe)){
3313                         removeFromTable(idx);
3314                         return homePe(idx);
3315                 }
3316                 return pe;
3317         }       
3318 }
3319 /// Return true if this array element lives on another processor
3320 bool CkLocMgr::isRemote(const CkArrayIndex &idx,int *onPe) const
3321 {
3322         CkLocMgr *vthis=(CkLocMgr *)this;//Cast away "const"
3323         CkLocRec *rec=vthis->elementNrec(idx);
3324         if (rec==NULL || rec->type()!=CkLocRec::remote) 
3325                 return false; /* not definitely a remote element */
3326         else /* element is indeed remote */
3327         {
3328                 *onPe=rec->lookupProcessor();
3329                 return true;
3330         }
3331 }
3332
3333 static const char *rec2str[]={
3334     "base (INVALID)",//Base class (invalid type)
3335     "local",//Array element that lives on this Pe
3336     "remote",//Array element that lives on some other Pe
3337     "buffering",//Array element that was just created
3338     "dead"//Deleted element (for debugging)
3339 };
3340
3341 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
3342 void CkLocMgr::setDuringMigration(CmiBool _duringMigration){
3343     duringMigration = _duringMigration;
3344 }
3345 #endif
3346
3347
3348 //Add given element array record at idx, replacing the existing record
3349 void CkLocMgr::insertRec(CkLocRec *rec,const CkArrayIndex &idx) {
3350         CkLocRec *old=elementNrec(idx);
3351         insertRecN(rec,idx);
3352         if (old!=NULL) {
3353                 DEBC((AA"  replaces old rec(%s) for %s\n"AB,rec2str[old->type()],idx2str(idx)));
3354                 //There was an old element at this location
3355                 if (old->type()==CkLocRec::local && rec->type()==CkLocRec::local) {
3356                     if (!CkInRestarting()) {    // ok if it is restarting
3357                         CkPrintf("ERROR! Duplicate array index: %s\n",idx2str(idx));
3358                         CkAbort("Duplicate array index used");
3359                     }
3360                 }
3361                 old->beenReplaced();
3362                 delete old;
3363         }
3364 }
3365
3366 //Add given record, when there is guarenteed to be no prior record
3367 void CkLocMgr::insertRecN(CkLocRec *rec,const CkArrayIndex &idx) {
3368         DEBC((AA"  adding new rec(%s) for %s\n"AB,rec2str[rec->type()],idx2str(idx)));
3369         CmiImmediateLock(hashImmLock);
3370         hash.put(*(CkArrayIndex *)&idx)=rec;
3371         CmiImmediateUnlock(hashImmLock);
3372 }
3373
3374 //Call this on an unrecognized array index
3375 static void abort_out_of_bounds(const CkArrayIndex &idx)
3376 {
3377   CkPrintf("ERROR! Unknown array index: %s\n",idx2str(idx));
3378   CkAbort("Array index out of bounds\n");
3379 }
3380
3381 //Look up array element in hash table.  Index out-of-bounds if not found.
3382 CkLocRec *CkLocMgr::elementRec(const CkArrayIndex &idx) {
3383 #if ! CMK_ERROR_CHECKING
3384 //Assume the element will be found
3385         return hash.getRef(*(CkArrayIndex *)&idx);
3386 #else
3387 //Include an out-of-bounds check if the element isn't found
3388         CkLocRec *rec=elementNrec(idx);
3389         if (rec==NULL) abort_out_of_bounds(idx);
3390         return rec;
3391 #endif
3392 }
3393
3394 //Look up array element in hash table.  Return NULL if not there.
3395 CkLocRec *CkLocMgr::elementNrec(const CkArrayIndex &idx) {
3396         return hash.get(*(CkArrayIndex *)&idx);
3397 }
3398
3399 struct LocalElementCounter :  public CkLocIterator
3400 {
3401     unsigned int count;
3402     LocalElementCounter() : count(0) {}
3403     void addLocation(CkLocation &loc)
3404         { ++count; }
3405 };
3406
3407 unsigned int CkLocMgr::numLocalElements()
3408 {
3409     LocalElementCounter c;
3410     iterate(c);
3411     return c.count;
3412 }
3413
3414
3415 /********************* LocMgr: LOAD BALANCE ****************/
3416
3417 #if !CMK_LBDB_ON
3418 //Empty versions of all load balancer calls
3419 void CkLocMgr::initLB(CkGroupID lbdbID_, CkGroupID metalbID_) {}
3420 void CkLocMgr::startInserting(void) {}
3421 void CkLocMgr::doneInserting(void) {}
3422 void CkLocMgr::dummyAtSync(void) {}
3423 #endif
3424
3425
3426 #if CMK_LBDB_ON
3427 void CkLocMgr::initLB(CkGroupID lbdbID_, CkGroupID metalbID_)
3428 { //Find and register with the load balancer
3429         the_lbdb = (LBDatabase *)CkLocalBranch(lbdbID_);
3430         if (the_lbdb == 0)
3431                 CkAbort("LBDatabase not yet created?\n");
3432         DEBL((AA"Connected to load balancer %p\n"AB,the_lbdb));
3433         the_metalb = (MetaBalancer *)CkLocalBranch(metalbID_);
3434         if (the_metalb == 0)
3435                 CkAbort("MetaBalancer not yet created?\n");
3436
3437         // Register myself as an object manager
3438         LDOMid myId;
3439         myId.id = thisgroup;
3440         LDCallbacks myCallbacks;
3441         myCallbacks.migrate = (LDMigrateFn)CkLocRec_local::staticMigrate;
3442         myCallbacks.setStats = NULL;
3443         myCallbacks.queryEstLoad = NULL;
3444   myCallbacks.metaLBResumeWaitingChares =
3445       (LDMetaLBResumeWaitingCharesFn)CkLocRec_local::staticMetaLBResumeWaitingChares;
3446   myCallbacks.metaLBCallLBOnChares =
3447       (LDMetaLBCallLBOnCharesFn)CkLocRec_local::staticMetaLBCallLBOnChares;
3448         myLBHandle = the_lbdb->RegisterOM(myId,this,myCallbacks);
3449
3450         // Tell the lbdb that I'm registering objects
3451         the_lbdb->RegisteringObjects(myLBHandle);
3452
3453         /*Set up the dummy barrier-- the load balancer needs
3454           us to call Registering/DoneRegistering during each AtSync,
3455           and this is the only way to do so.
3456         */
3457         the_lbdb->AddLocalBarrierReceiver(
3458                 (LDBarrierFn)staticRecvAtSync,(void*)(this));
3459         dummyBarrierHandle = the_lbdb->AddLocalBarrierClient(
3460                 (LDResumeFn)staticDummyResumeFromSync,(void*)(this));
3461         dummyAtSync();
3462 }
3463 void CkLocMgr::dummyAtSync(void)
3464 {
3465         DEBL((AA"dummyAtSync called\n"AB));
3466         the_lbdb->AtLocalBarrier(dummyBarrierHandle);
3467 }
3468
3469 void CkLocMgr::staticDummyResumeFromSync(void* data)
3470 {      ((CkLocMgr*)data)->dummyResumeFromSync(); }
3471 void CkLocMgr::dummyResumeFromSync()
3472 {
3473         DEBL((AA"DummyResumeFromSync called\n"AB));
3474         the_lbdb->DoneRegisteringObjects(myLBHandle);
3475         dummyAtSync();
3476 }
3477 void CkLocMgr::staticRecvAtSync(void* data)
3478 {      ((CkLocMgr*)data)->recvAtSync(); }
3479 void CkLocMgr::recvAtSync()
3480 {
3481         DEBL((AA"recvAtSync called\n"AB));
3482         the_lbdb->RegisteringObjects(myLBHandle);
3483 }
3484
3485 void CkLocMgr::startInserting(void)
3486 {
3487         the_lbdb->RegisteringObjects(myLBHandle);
3488 }
3489 void CkLocMgr::doneInserting(void)
3490 {
3491         the_lbdb->DoneRegisteringObjects(myLBHandle);
3492 }
3493 #endif
3494
3495 #include "CkLocation.def.h"
3496
3497