Fix a bug in the init
[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
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         barrierRegistered=CmiFalse;
1054
1055   local_state = OFF;
1056   prev_load = 0.0;
1057   can_reset = false;
1058   if (_lb_args.metaLbOn()) {
1059     atsync_iteration = myRec->getMetaBalancer()->get_iteration();
1060   }
1061
1062         /*
1063         FAULT_EVAC
1064         */
1065         AsyncEvacuate(CmiTrue);
1066 }
1067
1068 CkMigratable::CkMigratable(void) {
1069         DEBC((AA"In CkMigratable constructor\n"AB));
1070         commonInit();
1071 }
1072 CkMigratable::CkMigratable(CkMigrateMessage *m): Chare(m) {
1073         commonInit();
1074 }
1075
1076 int CkMigratable::ckGetChareType(void) const {return thisChareType;}
1077
1078 void CkMigratable::pup(PUP::er &p) {
1079         DEBM((AA"In CkMigratable::pup %s\n"AB,idx2str(thisIndexMax)));
1080         Chare::pup(p);
1081         p|thisIndexMax;
1082         p(usesAtSync);
1083   p(can_reset);
1084         p(usesAutoMeasure);
1085 #if CMK_LBDB_ON 
1086         int readyMigrate;
1087         if (p.isPacking()) readyMigrate = myRec->isReadyMigrate();
1088         p|readyMigrate;
1089         if (p.isUnpacking()) myRec->ReadyMigrate(readyMigrate);
1090 #endif
1091         if(p.isUnpacking()) barrierRegistered=CmiFalse;
1092         /*
1093                 FAULT_EVAC
1094         */
1095         p | asyncEvacuate;
1096         if(p.isUnpacking()){myRec->AsyncEvacuate(asyncEvacuate);}
1097         
1098         ckFinishConstruction();
1099 }
1100
1101 void CkMigratable::ckDestroy(void) {
1102         DEBC((AA"In CkMigratable::ckDestroy %s\n"AB,idx2str(thisIndexMax)));
1103         myRec->destroy();
1104 }
1105
1106 void CkMigratable::ckAboutToMigrate(void) { }
1107 void CkMigratable::ckJustMigrated(void) { }
1108 void CkMigratable::ckJustRestored(void) { }
1109
1110 CkMigratable::~CkMigratable() {
1111         DEBC((AA"In CkMigratable::~CkMigratable %s\n"AB,idx2str(thisIndexMax)));
1112 #if CMK_OUT_OF_CORE
1113         isInCore=CmiFalse;
1114         if (CkpvAccess(CkSaveRestorePrefetch)) 
1115                 return; /* Just saving to disk--don't deregister anything. */
1116         /* We're really leaving or dying-- unregister from the ooc system*/
1117         if (prefetchObjID!=-1) {
1118                 CooDeregisterObject(prefetchObjID);
1119                 prefetchObjID=-1;
1120         }
1121 #endif
1122         /*Might want to tell myRec about our doom here--
1123         it's difficult to avoid some kind of circular-delete, though.
1124         */
1125 #if CMK_LBDB_ON 
1126         if (barrierRegistered) {
1127           DEBL((AA"Removing barrier for element %s\n"AB,idx2str(thisIndexMax)));
1128           if (usesAtSync)
1129                 myRec->getLBDB()->RemoveLocalBarrierClient(ldBarrierHandle);
1130           else
1131                 myRec->getLBDB()->RemoveLocalBarrierReceiver(ldBarrierRecvHandle);
1132         }
1133 #endif
1134         //To detect use-after-delete
1135         thisIndexMax.nInts=-12345;
1136         thisIndexMax.dimension=-12345;
1137 }
1138
1139 void CkMigratable::CkAbort(const char *why) const {
1140         CkError("CkMigratable '%s' aborting:\n",_chareTable[thisChareType]->name);
1141         ::CkAbort(why);
1142 }
1143
1144 void CkMigratable::ResumeFromSync(void)
1145 {
1146 //      CkAbort("::ResumeFromSync() not defined for this array element!\n");
1147 }
1148
1149 void CkMigratable::UserSetLBLoad() {
1150         CkAbort("::UserSetLBLoad() not defined for this array element!\n");
1151 }
1152
1153 #if CMK_LBDB_ON  //For load balancing:
1154 // user can call this helper function to set obj load (for model-based lb)
1155 void CkMigratable::setObjTime(double cputime) {
1156         myRec->setObjTime(cputime);
1157 }
1158 double CkMigratable::getObjTime() {
1159         return myRec->getObjTime();
1160 }
1161
1162 void CkMigratable::clearMetaLBData() {
1163 //  if (can_reset) {
1164     local_state = OFF;
1165     atsync_iteration = -1;
1166     prev_load = 0.0;
1167     can_reset = false;
1168 //  }
1169 }
1170
1171 void CkMigratable::recvLBPeriod(void *data) {
1172   if (atsync_iteration < 0) {
1173     return;
1174   }
1175   int lb_period = *((int *) data);
1176  DEBAD(("\t[obj %s] Received the LB Period %d current iter %d state %d on PE %d\n",
1177      idx2str(thisIndexMax), lb_period, atsync_iteration, local_state, CkMyPe()));
1178
1179   bool is_tentative;
1180   if (local_state == LOAD_BALANCE) {
1181     CkAssert(lb_period == myRec->getMetaBalancer()->getPredictedLBPeriod(is_tentative));
1182     return;
1183   }
1184
1185   if (local_state == PAUSE) {
1186     if (atsync_iteration < lb_period) {
1187       local_state = DECIDED;
1188       ResumeFromSync();
1189       return;
1190     }
1191     local_state = LOAD_BALANCE;
1192
1193     can_reset = true;
1194     //myRec->getLBDB()->AtLocalBarrier(ldBarrierHandle);
1195     return;
1196   }
1197   local_state = DECIDED;
1198 }
1199
1200 void CkMigratable::metaLBCallLB() {
1201         myRec->getLBDB()->AtLocalBarrier(ldBarrierHandle);
1202 }
1203
1204 void CkMigratable::ckFinishConstruction(void)
1205 {
1206 //      if ((!usesAtSync) || barrierRegistered) return;
1207         myRec->setMeasure(usesAutoMeasure);
1208         if (barrierRegistered) return;
1209         DEBL((AA"Registering barrier client for %s\n"AB,idx2str(thisIndexMax)));
1210         if (usesAtSync)
1211           ldBarrierHandle = myRec->getLBDB()->AddLocalBarrierClient(
1212                 (LDBarrierFn)staticResumeFromSync,(void*)(this));
1213         else
1214           ldBarrierRecvHandle = myRec->getLBDB()->AddLocalBarrierReceiver(
1215                 (LDBarrierFn)staticResumeFromSync,(void*)(this));
1216         barrierRegistered=CmiTrue;
1217 }
1218
1219 void CkMigratable::AtSync(int waitForMigration)
1220 {
1221         if (!usesAtSync)
1222                 CkAbort("You must set usesAtSync=CmiTrue in your array element constructor to use AtSync!\n");
1223 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1224         mlogData->toResumeOrNot=1;
1225 #endif
1226         myRec->AsyncMigrate(!waitForMigration);
1227         if (waitForMigration) ReadyMigrate(CmiTrue);
1228         ckFinishConstruction();
1229   DEBL((AA"Element %s going to sync\n"AB,idx2str(thisIndexMax)));
1230   // model-based load balancing, ask user to provide cpu load
1231   if (usesAutoMeasure == CmiFalse) UserSetLBLoad();
1232
1233   if (!_lb_args.metaLbOn()) {
1234     myRec->getLBDB()->AtLocalBarrier(ldBarrierHandle);
1235     return;
1236   }
1237
1238   // When MetaBalancer is turned on
1239
1240   if (atsync_iteration == -1) {
1241     can_reset = false;
1242     local_state = OFF;
1243     prev_load = 0.0;
1244   }
1245
1246   atsync_iteration++;
1247   //CkPrintf("[pe %s] atsync_iter %d && predicted period %d state: %d\n",
1248   //    idx2str(thisIndexMax), atsync_iteration,
1249   //    myRec->getMetaBalancer()->getPredictedLBPeriod(), local_state);
1250   double tmp = prev_load;
1251   prev_load = myRec->getObjTime();
1252   double current_load = prev_load - tmp;
1253   if (atsync_iteration <= myRec->getMetaBalancer()->get_finished_iteration()) {
1254     CkPrintf("[%d:%s] Error!! Contributing to iter %d < current iter %d\n",
1255       CkMyPe(), idx2str(thisIndexMax), atsync_iteration,
1256       myRec->getMetaBalancer()->get_finished_iteration());
1257     CkAbort("Not contributing to the right iteration\n");
1258   }
1259
1260   if (atsync_iteration != 0) {
1261     myRec->getMetaBalancer()->AddLoad(atsync_iteration, current_load);
1262   }
1263
1264   bool is_tentative;
1265   if (atsync_iteration < myRec->getMetaBalancer()->getPredictedLBPeriod(is_tentative)) {
1266     ResumeFromSync();
1267   } else if (is_tentative) {
1268     local_state = PAUSE;
1269   } else if (local_state == DECIDED) {
1270     DEBAD(("[%d:%s] Went to load balance iter %d\n", CkMyPe(), idx2str(thisIndexMax), atsync_iteration));
1271     local_state = LOAD_BALANCE;
1272     can_reset = true;
1273     //myRec->getLBDB()->AtLocalBarrier(ldBarrierHandle);
1274   } else {
1275     DEBAD(("[%d:%s] Went to pause state iter %d\n", CkMyPe(), idx2str(thisIndexMax), atsync_iteration));
1276     local_state = PAUSE;
1277   }
1278 }
1279
1280 void CkMigratable::ReadyMigrate(CmiBool ready)
1281 {
1282         myRec->ReadyMigrate(ready);
1283 }
1284
1285 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1286     extern int globalResumeCount;
1287 #endif
1288
1289 void CkMigratable::staticResumeFromSync(void* data)
1290 {
1291         CkMigratable *el=(CkMigratable *)data;
1292 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1293     if(el->mlogData->toResumeOrNot ==0 || el->mlogData->resumeCount >= globalResumeCount){
1294         return;
1295     }
1296 #endif
1297         DEBL((AA"Element %s resuming from sync\n"AB,idx2str(el->thisIndexMax)));
1298 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1299     CpvAccess(_currentObj) = el;
1300 #endif
1301
1302   if (_lb_args.metaLbOn()) {
1303         el->clearMetaLBData();
1304         }
1305         el->ResumeFromSync();
1306 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1307     el->mlogData->resumeCount++;
1308 #endif
1309 }
1310 void CkMigratable::setMigratable(int migratable) 
1311 {
1312         myRec->setMigratable(migratable);
1313 }
1314
1315 struct CkArrayThreadListener {
1316         struct CthThreadListener base;
1317         CkMigratable *mig;
1318 };
1319
1320 extern "C"
1321 void CkArrayThreadListener_suspend(struct CthThreadListener *l)
1322 {
1323         CkArrayThreadListener *a=(CkArrayThreadListener *)l;
1324         a->mig->ckStopTiming();
1325 }
1326
1327 extern "C"
1328 void CkArrayThreadListener_resume(struct CthThreadListener *l)
1329 {
1330         CkArrayThreadListener *a=(CkArrayThreadListener *)l;
1331         a->mig->ckStartTiming();
1332 }
1333
1334 extern "C"
1335 void CkArrayThreadListener_free(struct CthThreadListener *l)
1336 {
1337         CkArrayThreadListener *a=(CkArrayThreadListener *)l;
1338         delete a;
1339 }
1340
1341 void CkMigratable::CkAddThreadListeners(CthThread tid, void *msg)
1342 {
1343         Chare::CkAddThreadListeners(tid, msg);   // for trace
1344         CthSetThreadID(tid, thisIndexMax.data()[0], thisIndexMax.data()[1], 
1345                        thisIndexMax.data()[2]);
1346         CkArrayThreadListener *a=new CkArrayThreadListener;
1347         a->base.suspend=CkArrayThreadListener_suspend;
1348         a->base.resume=CkArrayThreadListener_resume;
1349         a->base.free=CkArrayThreadListener_free;
1350         a->mig=this;
1351         CthAddListener(tid,(struct CthThreadListener *)a);
1352 }
1353 #else
1354 void CkMigratable::setObjTime(double cputime) {}
1355 double CkMigratable::getObjTime() {return 0.0;}
1356
1357 /* no load balancer: need dummy implementations to prevent link error */
1358 void CkMigratable::CkAddThreadListeners(CthThread tid, void *msg)
1359 {
1360 }
1361 #endif
1362
1363
1364 /*CkMigratableList*/
1365 CkMigratableList::CkMigratableList() {}
1366 CkMigratableList::~CkMigratableList() {}
1367
1368 void CkMigratableList::setSize(int s) {
1369         el.resize(s);
1370 }
1371
1372 void CkMigratableList::put(CkMigratable *v,int atIdx) {
1373 #if CMK_ERROR_CHECKING
1374         if (atIdx>=length())
1375                 CkAbort("Internal array manager error (CkMigrableList::put index out of bounds)");
1376 #endif
1377         el[atIdx]=v;
1378 }
1379
1380
1381 /************************** Location Records: *********************************/
1382
1383 //---------------- Base type:
1384 void CkLocRec::weAreObsolete(const CkArrayIndex &idx) {}
1385 CkLocRec::~CkLocRec() { }
1386 void CkLocRec::beenReplaced(void)
1387     {/*Default: ignore replacement*/}
1388
1389 //Return the represented array element; or NULL if there is none
1390 CkMigratable *CkLocRec::lookupElement(CkArrayID aid) {return NULL;}
1391
1392 //Return the last known processor; or -1 if none
1393 int CkLocRec::lookupProcessor(void) {return -1;}
1394
1395
1396 /*----------------- Local:
1397 Matches up the array index with the local index, an
1398 interfaces with the load balancer on behalf of the
1399 represented array elements.
1400 */
1401 CkLocRec_local::CkLocRec_local(CkLocMgr *mgr,CmiBool fromMigration,
1402   CmiBool ignoreArrival, const CkArrayIndex &idx_,int localIdx_)
1403         :CkLocRec(mgr),idx(idx_),localIdx(localIdx_),
1404          running(CmiFalse),deletedMarker(NULL)
1405 {
1406 #if CMK_LBDB_ON
1407         DEBL((AA"Registering element %s with load balancer\n"AB,idx2str(idx)));
1408         //BIGSIM_OOC DEBUGGING
1409         //CkPrintf("LocMgr on %d: Registering element %s with load balancer\n", CkMyPe(), idx2str(idx));
1410         nextPe = -1;
1411         asyncMigrate = CmiFalse;
1412         readyMigrate = CmiTrue;
1413         enable_measure = CmiTrue;
1414         bounced  = CmiFalse;
1415         the_lbdb=mgr->getLBDB();
1416         the_metalb=mgr->getMetaBalancer();
1417         LDObjid ldid = idx2LDObjid(idx);
1418 #if CMK_GLOBAL_LOCATION_UPDATE
1419         ldid.locMgrGid = mgr->getGroupID().idx;
1420 #endif        
1421         ldHandle=the_lbdb->RegisterObj(mgr->getOMHandle(),
1422                 ldid,(void *)this,1);
1423         if (fromMigration) {
1424                 DEBL((AA"Element %s migrated in\n"AB,idx2str(idx)));
1425                 if (!ignoreArrival)  {
1426                         the_lbdb->Migrated(ldHandle, CmiTrue);
1427                   // load balancer should ignore this objects movement
1428                 //  AsyncMigrate(CmiTrue);
1429                 }
1430         }
1431 #endif
1432         /*
1433                 FAULT_EVAC
1434         */
1435         asyncEvacuate = CmiTrue;
1436 }
1437 CkLocRec_local::~CkLocRec_local()
1438 {
1439         if (deletedMarker!=NULL) *deletedMarker=CmiTrue;
1440         myLocMgr->reclaim(idx,localIdx);
1441 #if CMK_LBDB_ON
1442         stopTiming();
1443         DEBL((AA"Unregistering element %s from load balancer\n"AB,idx2str(idx)));
1444         the_lbdb->UnregisterObj(ldHandle);
1445 #endif
1446 }
1447 void CkLocRec_local::migrateMe(int toPe) //Leaving this processor
1448 {
1449         //This will pack us up, send us off, and delete us
1450 //      printf("[%d] migrating migrateMe to %d \n",CkMyPe(),toPe);
1451         myLocMgr->emigrate(this,toPe);
1452 }
1453
1454 void CkLocRec_local::informIdealLBPeriod(int lb_ideal_period) {
1455   myLocMgr->informLBPeriod(this, lb_ideal_period);
1456 }
1457
1458 void CkLocRec_local::metaLBCallLB() {
1459         myLocMgr->metaLBCallLB(this);
1460 }
1461
1462 #if CMK_LBDB_ON
1463 void CkLocRec_local::startTiming(int ignore_running) {
1464         if (!ignore_running) running=CmiTrue;
1465         DEBL((AA"Start timing for %s at %.3fs {\n"AB,idx2str(idx),CkWallTimer()));
1466         if (enable_measure) the_lbdb->ObjectStart(ldHandle);
1467 }
1468 void CkLocRec_local::stopTiming(int ignore_running) {
1469         DEBL((AA"} Stop timing for %s at %.3fs\n"AB,idx2str(idx),CkWallTimer()));
1470         if ((ignore_running || running) && enable_measure) the_lbdb->ObjectStop(ldHandle);
1471         if (!ignore_running) running=CmiFalse;
1472 }
1473 void CkLocRec_local::setObjTime(double cputime) {
1474         the_lbdb->EstObjLoad(ldHandle, cputime);
1475 }
1476 double CkLocRec_local::getObjTime() {
1477         LBRealType walltime, cputime;
1478         the_lbdb->GetObjLoad(ldHandle, walltime, cputime);
1479         return walltime;
1480 }
1481 #endif
1482
1483 void CkLocRec_local::destroy(void) //User called destructor
1484 {
1485         //Our destructor does all the needed work
1486         delete this;
1487 }
1488 //Return the represented array element; or NULL if there is none
1489 CkMigratable *CkLocRec_local::lookupElement(CkArrayID aid) {
1490         return myLocMgr->lookupLocal(localIdx,aid);
1491 }
1492
1493 //Return the last known processor; or -1 if none
1494 int CkLocRec_local::lookupProcessor(void) {
1495         return CkMyPe();
1496 }
1497
1498 CkLocRec::RecType CkLocRec_local::type(void)
1499 {
1500         return local;
1501 }
1502
1503 void CkLocRec_local::addedElement(void) 
1504 {
1505         //Push everything in the half-created queue into the system--
1506         // anything not ready yet will be put back in.
1507         while (!halfCreated.isEmpty()) 
1508                 CkArrayManagerDeliver(CkMyPe(),halfCreated.deq());
1509 }
1510
1511 CmiBool CkLocRec_local::isObsolete(int nSprings,const CkArrayIndex &idx_)
1512
1513         int len=halfCreated.length();
1514         if (len!=0) {
1515                 /* This is suspicious-- the halfCreated queue should be extremely
1516                  transient.  It's possible we just looked at the wrong time, though;
1517                  so this is only a warning. 
1518                 */
1519                 CkPrintf("CkLoc WARNING> %d messages still around for uncreated element %s!\n",
1520                          len,idx2str(idx));
1521         }
1522         //A local element never expires
1523         return CmiFalse;
1524 }
1525
1526 /**********Added for cosmology (inline function handling without parameter marshalling)***********/
1527
1528 LDObjHandle CkMigratable::timingBeforeCall(int* objstopped){
1529
1530         LDObjHandle objHandle;
1531 #if CMK_LBDB_ON
1532         if (getLBDB()->RunningObject(&objHandle)) {
1533                 *objstopped = 1;
1534                 getLBDB()->ObjectStop(objHandle);
1535         }
1536         myRec->startTiming(1);
1537 #endif
1538
1539   //DEBS((AA"   Invoking entry %d on element %s\n"AB,epIdx,idx2str(idx)));
1540         //CmiBool isDeleted=CmiFalse; //Enables us to detect deletion during processing
1541         //deletedMarker=&isDeleted;
1542 /*#ifndef CMK_OPTIMIZE
1543         if (msg) {  Tracing: 
1544                 envelope *env=UsrToEnv(msg);
1545         //      CkPrintf("ckLocation.C beginExecuteDetailed %d %d \n",env->getEvent(),env->getsetArraySrcPe());
1546                 if (_entryTable[epIdx]->traceEnabled)
1547                         _TRACE_BEGIN_EXECUTE_DETAILED(env->getEvent(),
1548                                  ForChareMsg,epIdx,env->getsetArraySrcPe(), env->getTotalsize(), idx.getProjectionID(((CkGroupID)env->getsetArrayMgr())).idx);
1549         }
1550 #endif*/
1551
1552   return objHandle;
1553 }
1554
1555 void CkMigratable::timingAfterCall(LDObjHandle objHandle,int *objstopped){
1556   
1557 /*#ifndef CMK_OPTIMIZE
1558         if (msg) {  Tracing: 
1559                 if (_entryTable[epIdx]->traceEnabled)
1560                         _TRACE_END_EXECUTE();
1561         }
1562 #endif*/
1563 //#if CMK_LBDB_ON
1564 //        if (!isDeleted) checkBufferedMigration();   // check if should migrate
1565 //#endif
1566 //      if (isDeleted) return CmiFalse;//We were deleted
1567 //      deletedMarker=NULL;
1568 //      return CmiTrue;
1569         myRec->stopTiming(1);
1570 #if CMK_LBDB_ON
1571         if (*objstopped) {
1572                  getLBDB()->ObjectStart(objHandle);
1573         }
1574 #endif
1575
1576  return;
1577 }
1578 /****************************************************************************/
1579
1580
1581 CmiBool CkLocRec_local::invokeEntry(CkMigratable *obj,void *msg,
1582         int epIdx,CmiBool doFree) 
1583 {
1584
1585         DEBS((AA"   Invoking entry %d on element %s\n"AB,epIdx,idx2str(idx)));
1586         CmiBool isDeleted=CmiFalse; //Enables us to detect deletion during processing
1587         deletedMarker=&isDeleted;
1588         startTiming();
1589
1590
1591 #if CMK_TRACE_ENABLED
1592         if (msg) { /* Tracing: */
1593                 envelope *env=UsrToEnv(msg);
1594         //      CkPrintf("ckLocation.C beginExecuteDetailed %d %d \n",env->getEvent(),env->getsetArraySrcPe());
1595                 if (_entryTable[epIdx]->traceEnabled)
1596                         _TRACE_BEGIN_EXECUTE_DETAILED(env->getEvent(),
1597                                  ForChareMsg,epIdx,env->getsetArraySrcPe(), env->getTotalsize(), idx.getProjectionID((((CkGroupID)env->getsetArrayMgr())).idx));
1598         }
1599 #endif
1600
1601         if (doFree) 
1602            CkDeliverMessageFree(epIdx,msg,obj);
1603         else /* !doFree */
1604            CkDeliverMessageReadonly(epIdx,msg,obj);
1605
1606
1607 #if CMK_TRACE_ENABLED
1608         if (msg) { /* Tracing: */
1609                 if (_entryTable[epIdx]->traceEnabled)
1610                         _TRACE_END_EXECUTE();
1611         }
1612 #endif
1613 #if CMK_LBDB_ON
1614         if (!isDeleted) checkBufferedMigration();   // check if should migrate
1615 #endif
1616         if (isDeleted) return CmiFalse;//We were deleted
1617         deletedMarker=NULL;
1618         stopTiming();
1619         return CmiTrue;
1620 }
1621
1622 CmiBool CkLocRec_local::deliver(CkArrayMessage *msg,CkDeliver_t type,int opts)
1623 {
1624
1625         if (type==CkDeliver_queue) { /*Send via the message queue */
1626                 if (opts & CK_MSG_KEEP)
1627                         msg = (CkArrayMessage *)CkCopyMsg((void **)&msg);
1628                 CkArrayManagerDeliver(CkMyPe(),msg,opts);
1629                 return CmiTrue;
1630         }
1631         else
1632         {
1633                 CkMigratable *obj=myLocMgr->lookupLocal(localIdx,
1634                         UsrToEnv(msg)->getsetArrayMgr());
1635                 if (obj==NULL) {//That sibling of this object isn't created yet!
1636                         if (opts & CK_MSG_KEEP)
1637                                 msg = (CkArrayMessage *)CkCopyMsg((void **)&msg);
1638                         if (msg->array_ifNotThere()!=CkArray_IfNotThere_buffer) {
1639                                 return myLocMgr->demandCreateElement(msg,CkMyPe(),type);
1640                         }
1641                         else {
1642                                 DEBS((AA"   BUFFERING message for nonexistent element %s!\n"AB,idx2str(this->idx)));
1643                                 halfCreated.enq(msg);
1644                                 return CmiTrue;
1645                         }
1646                 }
1647                         
1648                 if (msg->array_hops()>1)
1649                         myLocMgr->multiHop(msg);
1650                 CmiBool doFree = (CmiBool)!(opts & CK_MSG_KEEP);
1651 #if CMK_LBDB_ON
1652                 // if there is a running obj being measured, stop it temporarily
1653                 LDObjHandle objHandle;
1654                 int objstopped = 0;
1655                 if (the_lbdb->RunningObject(&objHandle)) {
1656                         objstopped = 1;
1657                         the_lbdb->ObjectStop(objHandle);
1658                 }
1659 #endif
1660 #if CMK_GRID_QUEUE_AVAILABLE
1661                 // retain a pointer to the sending object (needed later)
1662                 CpvAccess(CkGridObject) = obj;
1663 #endif
1664
1665         CmiBool status = invokeEntry(obj,(void *)msg,msg->array_ep(),doFree);
1666         
1667 #if CMK_GRID_QUEUE_AVAILABLE
1668                 CpvAccess(CkGridObject) = NULL;
1669 #endif
1670 #if CMK_LBDB_ON
1671                 if (objstopped) the_lbdb->ObjectStart(objHandle);
1672 #endif
1673                 return status;
1674         }
1675
1676
1677 }
1678
1679 #if CMK_LBDB_ON
1680
1681 void CkLocRec_local::staticMetaLBResumeWaitingChares(LDObjHandle h, int lb_ideal_period) {
1682         CkLocRec_local *el=(CkLocRec_local *)LDObjUserData(h);
1683         DEBL((AA"MetaBalancer wants to resume waiting chare %s\n"AB,idx2str(el->idx)));
1684         el->metaLBResumeWaitingChares(lb_ideal_period);
1685 }
1686
1687 void CkLocRec_local::metaLBResumeWaitingChares(int lb_ideal_period) {
1688   informIdealLBPeriod(lb_ideal_period);
1689 }
1690
1691 void CkLocRec_local::staticMetaLBCallLBOnChares(LDObjHandle h) {
1692         CkLocRec_local *el=(CkLocRec_local *)LDObjUserData(h);
1693         DEBL((AA"MetaBalancer wants to call LoadBalance on chare %s\n"AB,idx2str(el->idx)));
1694         el->metaLBCallLBOnChares();
1695 }
1696
1697 void CkLocRec_local::metaLBCallLBOnChares() {
1698   metaLBCallLB();
1699 }
1700
1701 void CkLocRec_local::staticMigrate(LDObjHandle h, int dest)
1702 {
1703         CkLocRec_local *el=(CkLocRec_local *)LDObjUserData(h);
1704         DEBL((AA"Load balancer wants to migrate %s to %d\n"AB,idx2str(el->idx),dest));
1705         el->recvMigrate(dest);
1706 }
1707
1708 void CkLocRec_local::recvMigrate(int toPe)
1709 {
1710         // we are in the mode of delaying actual migration
1711         // till readyMigrate()
1712         if (readyMigrate) { migrateMe(toPe); }
1713         else nextPe = toPe;
1714 }
1715
1716 void CkLocRec_local::AsyncMigrate(CmiBool use)  
1717 {
1718         asyncMigrate = use; 
1719         the_lbdb->UseAsyncMigrate(ldHandle, use);
1720 }
1721
1722 CmiBool CkLocRec_local::checkBufferedMigration()
1723 {
1724         // we don't migrate in user's code when calling ReadyMigrate(true)
1725         // we postphone the action to here until we exit from the user code.
1726         if (readyMigrate && nextPe != -1) {
1727             int toPe = nextPe;
1728             nextPe = -1;
1729             // don't migrate inside the object call
1730             migrateMe(toPe);
1731             // don't do anything
1732             return CmiTrue;
1733         }
1734         return CmiFalse;
1735 }
1736
1737 int CkLocRec_local::MigrateToPe()
1738 {
1739         int pe = nextPe;
1740         nextPe = -1;
1741         return pe;
1742 }
1743
1744 void CkLocRec_local::setMigratable(int migratable)
1745 {
1746         if (migratable)
1747           the_lbdb->Migratable(ldHandle);
1748         else
1749           the_lbdb->NonMigratable(ldHandle);
1750 }
1751 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1752 void CkLocRec_local::Migrated(){
1753     the_lbdb->Migrated(ldHandle, CmiTrue);
1754 }
1755 #endif
1756 #endif
1757
1758 /**
1759  * Represents a deleted array element (and prevents re-use).
1760  * These are a debugging aid, usable only by uncommenting a line in
1761  * the element destruction code.
1762  */
1763 class CkLocRec_dead:public CkLocRec {
1764 public:
1765         CkLocRec_dead(CkLocMgr *Narr):CkLocRec(Narr) {}
1766   
1767         virtual RecType type(void) {return dead;}
1768   
1769         virtual CmiBool deliver(CkArrayMessage *msg,CkDeliver_t type,int opts=0) {
1770                 CkPrintf("Dead array element is %s.\n",idx2str(msg->array_index()));
1771                 CkAbort("Send to dead array element!\n");
1772                 return CmiFalse;
1773         }
1774         virtual void beenReplaced(void) 
1775                 {CkAbort("Can't re-use dead array element!\n");}
1776   
1777         //Return if this element is now obsolete (it isn't)
1778         virtual CmiBool isObsolete(int nSprings,const CkArrayIndex &idx) {return CmiFalse;}     
1779 };
1780
1781 /**
1782  * This is the abstract superclass of arrayRecs that keep track of their age,
1783  * and eventually expire. Its kids are remote and buffering.
1784  */
1785 class CkLocRec_aging:public CkLocRec {
1786 private:
1787         int lastAccess;//Age when last accessed
1788 protected:
1789         //Update our access time
1790         inline void access(void) {
1791                 lastAccess=myLocMgr->getSpringCount();
1792         }
1793         //Return if we are "stale"-- we were last accessed a while ago
1794         CmiBool isStale(void) {
1795                 if (myLocMgr->getSpringCount()-lastAccess>3) return CmiTrue;
1796                 else return CmiFalse;
1797         }
1798 public:
1799         CkLocRec_aging(CkLocMgr *Narr):CkLocRec(Narr) {
1800                 lastAccess=myLocMgr->getSpringCount();
1801         }
1802         //Return if this element is now obsolete
1803         virtual CmiBool isObsolete(int nSprings,const CkArrayIndex &idx)=0;
1804         //virtual void pup(PUP::er &p) { CkLocRec::pup(p); p(lastAccess); }
1805 };
1806
1807
1808 /**
1809  * Represents a remote array element.  This is just a PE number.
1810  */
1811 class CkLocRec_remote:public CkLocRec_aging {
1812 private:
1813         int onPe;//The last known Pe for this element
1814 public:
1815         CkLocRec_remote(CkLocMgr *Narr,int NonPe)
1816                 :CkLocRec_aging(Narr)
1817                 {
1818                         onPe=NonPe;
1819 #if CMK_ERROR_CHECKING
1820                         if (onPe==CkMyPe())
1821                                 CkAbort("ERROR!  'remote' array element on this Pe!\n");
1822 #endif
1823                 }
1824         //Return the last known processor for this element
1825         int lookupProcessor(void) {
1826                 return onPe;
1827         }  
1828         virtual RecType type(void) {return remote;}
1829   
1830         //Send a message for this element.
1831         virtual CmiBool deliver(CkArrayMessage *msg,CkDeliver_t type,int opts=0) {
1832                 /*FAULT_EVAC*/
1833                 int destPE = onPe;
1834                 if((!CmiNodeAlive(onPe) && onPe != allowMessagesOnly)){
1835 //                      printf("Delivery failed because process %d is invalid\n",onPe);
1836                         /*
1837                                 Send it to its home processor instead
1838                         */
1839                         const CkArrayIndex &idx=msg->array_index();
1840                         destPE = getNextPE(idx);
1841                 }
1842                 access();//Update our modification date
1843                 msg->array_hops()++;
1844                 DEBS((AA"   Forwarding message for element %s to %d (REMOTE)\n"AB,
1845                       idx2str(msg->array_index()),destPE));
1846                 if (opts & CK_MSG_KEEP)
1847                         msg = (CkArrayMessage *)CkCopyMsg((void **)&msg);
1848                 CkArrayManagerDeliver(destPE,msg,opts);
1849                 return CmiTrue;
1850         }
1851         //Return if this element is now obsolete
1852         virtual CmiBool isObsolete(int nSprings,const CkArrayIndex &idx) {
1853                 if (myLocMgr->isHome(idx)) 
1854                         //Home elements never become obsolete
1855                         // if they did, we couldn't deliver messages to that element.
1856                         return CmiFalse;
1857                 else if (isStale())
1858                         return CmiTrue;//We haven't been used in a long time
1859                 else
1860                         return CmiFalse;//We're fairly recent
1861         }
1862         //virtual void pup(PUP::er &p) { CkLocRec_aging::pup(p); p(onPe); }
1863 };
1864
1865
1866 /**
1867  * Buffers messages until record is replaced in the hash table, 
1868  * then delivers all messages to the replacing record.  This is 
1869  * used when a message arrives for a local element that has not
1870  * yet been created, buffering messages until the new element finally
1871  * checks in.
1872  *
1873  * It's silly to send a message to an element you won't ever create,
1874  * so this kind of record causes an abort "Stale array manager message!"
1875  * if it's left undelivered too long.
1876  */
1877 class CkLocRec_buffering:public CkLocRec_aging {
1878 private:
1879         CkQ<CkArrayMessage *> buffer;//Buffered messages.
1880 public:
1881         CkLocRec_buffering(CkLocMgr *Narr):CkLocRec_aging(Narr) {}
1882         virtual ~CkLocRec_buffering() {
1883                 if (0!=buffer.length()) {
1884                         CkPrintf("[%d] Warning: Messages abandoned in array manager buffer!\n", CkMyPe());
1885                         CkArrayMessage *m;
1886                         while (NULL!=(m=buffer.deq()))  {
1887                                 delete m;
1888                         }
1889                 }
1890         }
1891   
1892         virtual RecType type(void) {return buffering;}
1893   
1894         //Buffer a message for this element.
1895         virtual CmiBool deliver(CkArrayMessage *msg,CkDeliver_t type,int opts=0) {
1896                 DEBS((AA" Queued message for %s\n"AB,idx2str(msg->array_index())));
1897                 if (opts & CK_MSG_KEEP)
1898                         msg = (CkArrayMessage *)CkCopyMsg((void **)&msg);
1899                 buffer.enq(msg);
1900 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
1901                 envelope *env = UsrToEnv(msg);
1902                 env->sender = CpvAccess(_currentObj)->mlogData->objID;
1903 #endif
1904                 return CmiTrue;
1905         }
1906  
1907         //This is called when this ArrayRec is about to be replaced.
1908         // We dump all our buffered messages off on the next guy,
1909         // who should know what to do with them.
1910         virtual void beenReplaced(void) {
1911                 DEBS((AA" Delivering queued messages:\n"AB));
1912                 CkArrayMessage *m;
1913                 while (NULL!=(m=buffer.deq())) {
1914 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))         
1915                 DEBUG(CmiPrintf("[%d] buffered message being sent\n",CmiMyPe()));
1916                 envelope *env = UsrToEnv(m);
1917                 Chare *oldObj = CpvAccess(_currentObj);
1918                 CpvAccess(_currentObj) =(Chare *) env->sender.getObject();
1919                 env->sender.type = TypeInvalid;
1920 #endif
1921                 DEBS((AA"Sending buffered message to %s\n"AB,idx2str(m->array_index())));
1922                 myLocMgr->deliverViaQueue(m);
1923 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))         
1924                 CpvAccess(_currentObj) = oldObj;
1925 #endif
1926                 }
1927         }
1928   
1929         //Return if this element is now obsolete
1930         virtual CmiBool isObsolete(int nSprings,const CkArrayIndex &idx) {
1931                 if (isStale() && buffer.length()>0) {
1932                         /*This indicates something is seriously wrong--
1933                           buffers should be short-lived.*/
1934                         CkPrintf("[%d] WARNING: %d stale array message(s) found!\n",CkMyPe(),buffer.length());
1935                         CkArrayMessage *msg=buffer[0];
1936                         CkPrintf("Addressed to: ");
1937                         CkPrintEntryMethod(msg->array_ep());
1938                         CkPrintf(" index %s\n",idx2str(idx));
1939                         if (myLocMgr->isHome(idx)) 
1940                                 CkPrintf("is this an out-of-bounds array index, or was it never created?\n");
1941                         else //Idx is a remote-home index
1942                                 CkPrintf("why weren't they forwarded?\n");
1943                         
1944                         // CkAbort("Stale array manager message(s)!\n");
1945                 }
1946                 return CmiFalse;
1947         }
1948   
1949 /*  virtual void pup(PUP::er &p) {
1950     CkLocRec_aging::pup(p);
1951     CkArray::pupArrayMsgQ(buffer, p);
1952     }*/
1953 };
1954
1955 /*********************** Spring Cleaning *****************/
1956 /**
1957  * Used to periodically flush out unused remote element pointers.
1958  *
1959  * Cleaning often will free up memory quickly, but slow things
1960  * down because the cleaning takes time and some not-recently-referenced
1961  * remote element pointers might be valid and used some time in 
1962  * the future.
1963  *
1964  * Also used to determine if buffered messages have become stale.
1965  */
1966 inline void CkLocMgr::springCleaning(void)
1967 {
1968   nSprings++;
1969
1970   //Poke through the hash table for old ArrayRecs.
1971   void *objp;
1972   void *keyp;
1973   
1974   CkHashtableIterator *it=hash.iterator();
1975   CmiImmediateLock(hashImmLock);
1976   while (NULL!=(objp=it->next(&keyp))) {
1977     CkLocRec *rec=*(CkLocRec **)objp;
1978     CkArrayIndex &idx=*(CkArrayIndex *)keyp;
1979     if (rec->isObsolete(nSprings,idx)) {
1980       //This record is obsolete-- remove it from the table
1981       DEBK((AA"Cleaning out old record %s\n"AB,idx2str(idx)));
1982       hash.remove(*(CkArrayIndex *)&idx);
1983       delete rec;
1984       it->seek(-1);//retry this hash slot
1985     }
1986   }
1987   CmiImmediateUnlock(hashImmLock);
1988   delete it;
1989 }
1990 void CkLocMgr::staticSpringCleaning(void *forWhom,double curWallTime) {
1991         DEBK((AA"Starting spring cleaning at %.2f\n"AB,CkWallTimer()));
1992         ((CkLocMgr *)forWhom)->springCleaning();
1993 }
1994
1995 // clean all buffer'ed messages and also free local objects
1996 void CkLocMgr::flushAllRecs(void)
1997 {
1998   void *objp;
1999   void *keyp;
2000     
2001   CkHashtableIterator *it=hash.iterator();
2002   CmiImmediateLock(hashImmLock);
2003   while (NULL!=(objp=it->next(&keyp))) {
2004     CkLocRec *rec=*(CkLocRec **)objp;
2005     CkArrayIndex &idx=*(CkArrayIndex *)keyp;
2006     if (rec->type() != CkLocRec::local) {
2007       //In the case of taking core out of memory (in BigSim's emulation)
2008       //the meta data in the location manager are not deleted so we need
2009       //this condition
2010       if(_BgOutOfCoreFlag!=1){
2011         hash.remove(*(CkArrayIndex *)&idx);
2012         delete rec;
2013         it->seek(-1);//retry this hash slot
2014       }
2015     }
2016     else {
2017         callMethod((CkLocRec_local*)rec, &CkMigratable::ckDestroy);
2018         it->seek(-1);//retry this hash slot
2019     }
2020   }
2021   delete it;
2022   CmiImmediateUnlock(hashImmLock);
2023 }
2024
2025 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
2026 void CkLocMgr::callForAllRecords(CkLocFn fnPointer,CkArray *arr,void *data){
2027         void *objp;
2028         void *keyp;
2029
2030         CkHashtableIterator *it = hash.iterator();
2031         while (NULL!=(objp=it->next(&keyp))) {
2032                 CkLocRec *rec=*(CkLocRec **)objp;
2033                 CkArrayIndex &idx=*(CkArrayIndex *)keyp;
2034                 fnPointer(arr,data,rec,&idx);
2035         }
2036
2037         // releasing iterator memory
2038         delete it;
2039 }
2040 #endif
2041
2042 /*************************** LocMgr: CREATION *****************************/
2043 CkLocMgr::CkLocMgr(CkGroupID mapID_,CkGroupID lbdbID_,CkGroupID metalbID_,CkArrayIndex& numInitial)
2044         :thisProxy(thisgroup),thislocalproxy(thisgroup,CkMyPe()),
2045          hash(17,0.3)
2046 {
2047         DEBC((AA"Creating new location manager %d\n"AB,thisgroup));
2048 // moved to _CkMigratable_initInfoInit()
2049 //      CkpvInitialize(CkMigratable_initInfo,mig_initInfo);
2050
2051         managers.init();
2052         nManagers=0;
2053         firstManager=NULL;
2054         firstFree=localLen=0;
2055         duringMigration=CmiFalse;
2056         nSprings=0;
2057 #if !CMK_GLOBAL_LOCATION_UPDATE
2058         CcdCallOnConditionKeepOnPE(CcdPERIODIC_1minute,staticSpringCleaning,(void *)this, CkMyPe());
2059 #endif
2060
2061 //Register with the map object
2062         mapID=mapID_;
2063         map=(CkArrayMap *)CkLocalBranch(mapID);
2064         if (map==NULL) CkAbort("ERROR!  Local branch of array map is NULL!");
2065         mapHandle=map->registerArray(numInitial,thisgroup);
2066
2067 //Find and register with the load balancer
2068         lbdbID = lbdbID_;
2069   metalbID = metalbID_;
2070         initLB(lbdbID_, metalbID_);
2071         hashImmLock = CmiCreateImmediateLock();
2072 }
2073
2074 CkLocMgr::CkLocMgr(CkGroupID mapID_,CkGroupID lbdbID_,CkArrayIndex& numInitial)
2075         :thisProxy(thisgroup),thislocalproxy(thisgroup,CkMyPe()),
2076          hash(17,0.3)
2077 {
2078 #if !CMK_LBDB_ON
2079         CkGroupID _metalb;
2080 #endif
2081         CkLocMgr(mapID_, lbdbID_, _metalb, numInitial);
2082 }
2083
2084
2085 CkLocMgr::CkLocMgr(CkMigrateMessage* m)
2086         :IrrGroup(m),thisProxy(thisgroup),thislocalproxy(thisgroup,CkMyPe()),hash(17,0.3)
2087 {
2088         managers.init();
2089         nManagers=0;
2090         firstManager=NULL;
2091         firstFree=localLen=0;
2092         duringMigration=CmiFalse;
2093         nSprings=0;
2094 #if !CMK_GLOBAL_LOCATION_UPDATE
2095         CcdCallOnConditionKeepOnPE(CcdPERIODIC_1minute,staticSpringCleaning,(void *)this, CkMyPe());
2096 #endif
2097         hashImmLock = CmiCreateImmediateLock();
2098 }
2099
2100 void CkLocMgr::pup(PUP::er &p){
2101         IrrGroup::pup(p);
2102         p|mapID;
2103         p|mapHandle;
2104         p|lbdbID;
2105   p|metalbID;
2106         mapID = _defaultArrayMapID;
2107         if(p.isUnpacking()){
2108                 thisProxy=thisgroup;
2109                 CProxyElement_CkLocMgr newlocalproxy(thisgroup,CkMyPe());
2110                 thislocalproxy=newlocalproxy;
2111                 //Register with the map object
2112                 map=(CkArrayMap *)CkLocalBranch(mapID);
2113                 if (map==NULL) CkAbort("ERROR!  Local branch of array map is NULL!");
2114                 CkArrayIndex emptyIndex;
2115                 map->registerArray(emptyIndex,thisgroup);
2116                 // _lbdb is the fixed global groupID
2117                 initLB(lbdbID, metalbID);
2118
2119 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))     
2120         int count;
2121         p | count;
2122         DEBUG(CmiPrintf("[%d] Unpacking Locmgr %d has %d home elements\n",CmiMyPe(),thisgroup.idx,count));
2123         homeElementCount = count;
2124
2125         for(int i=0;i<count;i++){
2126             CkArrayIndex idx;
2127             int pe;
2128             idx.pup(p);
2129             p | pe;
2130             DEBUG(CmiPrintf("[%d] idx %s is a home element exisiting on pe %d\n",CmiMyPe(),idx2str(idx),pe));
2131             inform(idx,pe);
2132             CkLocRec *rec = elementNrec(idx);
2133             CmiAssert(rec!=NULL);
2134             CmiAssert(lastKnown(idx) == pe);
2135         }
2136 #endif
2137                 // delay doneInserting when it is unpacking during restart.
2138                 // to prevent load balancing kicking in
2139                 if (!CkInRestarting()) 
2140                         doneInserting();
2141         }else{
2142  /**
2143  * pack the indexes of elements which have their homes on this processor
2144  * but dont exist on it.. needed for broadcast after a restart
2145  * indexes of local elements dont need to be packed
2146  * since they will be recreated later anyway
2147  */
2148 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))     
2149         int count=0,count1=0;
2150         void *objp;
2151         void *keyp;
2152         CkHashtableIterator *it = hash.iterator();
2153       while (NULL!=(objp=it->next(&keyp))) {
2154       CkLocRec *rec=*(CkLocRec **)objp;
2155         CkArrayIndex &idx=*(CkArrayIndex *)keyp;
2156             if(rec->type() != CkLocRec::local){
2157                 if(homePe(idx) == CmiMyPe()){
2158                     count++;
2159                 }
2160             }
2161         }
2162         p | count;
2163         DEBUG(CmiPrintf("[%d] Packing Locmgr %d has %d home elements\n",CmiMyPe(),thisgroup.idx,count));
2164
2165                 // releasing iterator memory
2166                 delete it;
2167
2168         it = hash.iterator();
2169       while (NULL!=(objp=it->next(&keyp))) {
2170       CkLocRec *rec=*(CkLocRec **)objp;
2171         CkArrayIndex &idx=*(CkArrayIndex *)keyp;
2172             CkArrayIndex max = idx;
2173             if(rec->type() != CkLocRec::local){
2174                 if(homePe(idx) == CmiMyPe()){
2175                     int pe;
2176                     max.pup(p);
2177                     pe = rec->lookupProcessor();
2178                     p | pe;
2179                     count1++;
2180                 }
2181             }
2182         }
2183         CmiAssert(count == count1);
2184
2185                 // releasing iterator memory
2186                 delete it;
2187
2188 #endif
2189
2190         }
2191 }
2192
2193 void _CkLocMgrInit(void) {
2194   /* Don't trace our deliver method--it does its own tracing */
2195   CkDisableTracing(CkIndex_CkLocMgr::deliverInline(0));
2196 }
2197
2198 /// Add a new local array manager to our list.
2199 /// Returns a new CkMigratableList for the manager to store his
2200 /// elements in.
2201 CkMigratableList *CkLocMgr::addManager(CkArrayID id,CkArrMgr *mgr)
2202 {
2203         CK_MAGICNUMBER_CHECK
2204         DEBC((AA"Adding new array manager\n"AB));
2205         //Link new manager into list
2206         ManagerRec *n=new ManagerRec;
2207         managers.find(id)=n;
2208         n->next=firstManager;
2209         n->mgr=mgr;
2210         n->elts.setSize(localLen);
2211         nManagers++;
2212         firstManager=n;
2213         return &n->elts;
2214 }
2215
2216 /// Return the next unused local element index.
2217 int CkLocMgr::nextFree(void) {
2218         if (firstFree>=localLen)
2219         {//Need more space in the local index arrays-- enlarge them
2220                 int oldLen=localLen;
2221                 localLen=localLen*2+8;
2222                 DEBC((AA"Growing the local list from %d to %d...\n"AB,oldLen,localLen));
2223                 for (ManagerRec *m=firstManager;m!=NULL;m=m->next)
2224                         m->elts.setSize(localLen);
2225                 //Update the free list
2226                 freeList.resize(localLen);
2227                 for (int i=oldLen;i<localLen;i++)
2228                         freeList[i]=i+1;
2229         }
2230         int localIdx=firstFree;
2231         if (localIdx==-1) CkAbort("CkLocMgr free list corrupted!");
2232         firstFree=freeList[localIdx];
2233         freeList[localIdx]=-1; //Mark as used
2234         return localIdx;
2235 }
2236
2237 CkLocRec_remote *CkLocMgr::insertRemote(const CkArrayIndex &idx,int nowOnPe)
2238 {
2239         DEBS((AA"Remote element %s lives on %d\n"AB,idx2str(idx),nowOnPe));
2240         CkLocRec_remote *rem=new CkLocRec_remote(this,nowOnPe);
2241         insertRec(rem,idx);
2242         return rem;
2243 }
2244
2245 //This element now lives on the given Pe
2246 void CkLocMgr::inform(const CkArrayIndex &idx,int nowOnPe)
2247 {
2248         if (nowOnPe==CkMyPe())
2249                 return; //Never insert a "remote" record pointing here
2250         CkLocRec *rec=elementNrec(idx);
2251         if (rec!=NULL && rec->type()==CkLocRec::local){
2252 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
2253         CmiPrintf("[%d]WARNING!!! Element %d:%s is local but is being told it exists on %d\n",CkMyPe(),idx.dimension,idx2str(idx), nowOnPe);
2254 #endif
2255                 return; //Never replace a local element's record!
2256         }
2257         insertRemote(idx,nowOnPe);
2258 }
2259
2260 //Tell this element's home processor it now lives "there"
2261 void CkLocMgr::informHome(const CkArrayIndex &idx,int nowOnPe)
2262 {
2263         int home=homePe(idx);
2264         if (home!=CkMyPe() && home!=nowOnPe) {
2265                 //Let this element's home Pe know it lives here now
2266                 DEBC((AA"  Telling %s's home %d that it lives on %d.\n"AB,idx2str(idx),home,nowOnPe));
2267 //#if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
2268 //#if defined(_FAULT_MLOG_)
2269 //        informLocationHome(thisgroup,idx,home,CkMyPe());
2270 //#else
2271                 thisProxy[home].updateLocation(idx,nowOnPe);
2272 //#endif
2273         }
2274 }
2275
2276 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
2277 CkLocRec_local *CkLocMgr::createLocal(const CkArrayIndex &idx,
2278         CmiBool forMigration, CmiBool ignoreArrival,
2279         CmiBool notifyHome,int dummy)
2280 {
2281     int localIdx=nextFree();
2282     DEBC((AA"Adding new record for element %s at local index %d\n"AB,idx2str(idx),localIdx));
2283     CkLocRec_local *rec=new CkLocRec_local(this,forMigration,ignoreArrival,idx,localIdx);
2284     if(!dummy){
2285         insertRec(rec,idx); //Add to global hashtable
2286     }   
2287     if (notifyHome) informHome(idx,CkMyPe());
2288     return rec; 
2289 }
2290 #else
2291 CkLocRec_local *CkLocMgr::createLocal(const CkArrayIndex &idx, 
2292                 CmiBool forMigration, CmiBool ignoreArrival,
2293                 CmiBool notifyHome)
2294 {
2295         int localIdx=nextFree();
2296         DEBC((AA"Adding new record for element %s at local index %d\n"AB,idx2str(idx),localIdx));
2297         CkLocRec_local *rec=new CkLocRec_local(this,forMigration,ignoreArrival,idx,localIdx);
2298         insertRec(rec,idx); //Add to global hashtable
2299
2300
2301         if (notifyHome) informHome(idx,CkMyPe());
2302         return rec;
2303 }
2304 #endif
2305
2306 //Add a new local array element, calling element's constructor
2307 CmiBool CkLocMgr::addElement(CkArrayID id,const CkArrayIndex &idx,
2308                 CkMigratable *elt,int ctorIdx,void *ctorMsg)
2309 {
2310         CK_MAGICNUMBER_CHECK
2311         CkLocRec *oldRec=elementNrec(idx);
2312         CkLocRec_local *rec;
2313         if (oldRec==NULL||oldRec->type()!=CkLocRec::local) 
2314         { //This is the first we've heard of that element-- add new local record
2315                 rec=createLocal(idx,CmiFalse,CmiFalse,CmiTrue);
2316 #if CMK_GLOBAL_LOCATION_UPDATE
2317                 if (homePe(idx) != CkMyPe()) {
2318                   DEBC((AA"Global location broadcast for new element idx %s "
2319                         "assigned to %d \n"AB, idx2str(idx), CkMyPe()));
2320                   thisProxy.updateLocation(idx, CkMyPe());  
2321                 }
2322 #endif
2323                 
2324         } else 
2325         { //rec is *already* local-- must not be the first insertion    
2326                 rec=((CkLocRec_local *)oldRec);
2327                 rec->addedElement();
2328         }
2329         if (!addElementToRec(rec,managers.find(id),elt,ctorIdx,ctorMsg)) return CmiFalse;
2330         elt->ckFinishConstruction();
2331         return CmiTrue;
2332 }
2333
2334 //As above, but shared with the migration code
2335 CmiBool CkLocMgr::addElementToRec(CkLocRec_local *rec,ManagerRec *m,
2336                 CkMigratable *elt,int ctorIdx,void *ctorMsg)
2337 {//Insert the new element into its manager's local list
2338         int localIdx=rec->getLocalIndex();
2339         if (m->elts.get(localIdx)!=NULL) CkAbort("Cannot insert array element twice!");
2340         m->elts.put(elt,localIdx); //Local element table
2341
2342 //Call the element's constructor
2343         DEBC((AA"Constructing element %s of array\n"AB,idx2str(rec->getIndex())));
2344         CkMigratable_initInfo &i=CkpvAccess(mig_initInfo);
2345         i.locRec=rec;
2346         i.chareType=_entryTable[ctorIdx]->chareIdx;
2347         if (!rec->invokeEntry(elt,ctorMsg,ctorIdx,CmiTrue)) return CmiFalse;
2348
2349 #if CMK_OUT_OF_CORE
2350         /* Register new element with out-of-core */
2351         PUP::sizer p_getSize; elt->pup(p_getSize);
2352         elt->prefetchObjID=CooRegisterObject(&CkArrayElementPrefetcher,p_getSize.size(),elt);
2353 #endif
2354         
2355         return CmiTrue;
2356 }
2357 void CkLocMgr::updateLocation(const CkArrayIndex &idx,int nowOnPe) {
2358         inform(idx,nowOnPe);
2359 }
2360
2361 /*************************** LocMgr: DELETION *****************************/
2362 /// This index will no longer be used-- delete the associated elements
2363 void CkLocMgr::reclaim(const CkArrayIndex &idx,int localIdx) {
2364         CK_MAGICNUMBER_CHECK
2365         DEBC((AA"Destroying element %s (local %d)\n"AB,idx2str(idx),localIdx));
2366         //Delete, and mark as empty, each array element
2367         for (ManagerRec *m=firstManager;m!=NULL;m=m->next) {
2368                 delete m->elts.get(localIdx);
2369                 m->elts.empty(localIdx);
2370         }
2371         
2372         removeFromTable(idx);
2373         
2374         //Link local index into free list
2375         freeList[localIdx]=firstFree;
2376         firstFree=localIdx;
2377         
2378                 
2379         if (!duringMigration) 
2380         { //This is a local element dying a natural death
2381             #if CMK_BIGSIM_CHARM
2382                 //After migration, reclaimRemote will be called through 
2383                 //the CkRemoveArrayElement in the pupping routines for those 
2384                 //objects that are not on the home processors. However,
2385                 //those remote records should not be deleted since the corresponding
2386                 //objects are not actually deleted but on disk. If deleted, msgs
2387                 //that seeking where is the object will be accumulated (a circular
2388                 //msg chain) and causes the program no progress
2389                 if(_BgOutOfCoreFlag==1) return; 
2390             #endif
2391                 int home=homePe(idx);
2392                 if (home!=CkMyPe())
2393 #if CMK_MEM_CHECKPOINT
2394                 if (!CkInRestarting()) // all array elements are removed anyway
2395 #endif
2396                         thisProxy[home].reclaimRemote(idx,CkMyPe());
2397         /*      //Install a zombie to keep the living from re-using this index.
2398                 insertRecN(new CkLocRec_dead(this),idx); */
2399         }
2400 }
2401
2402 void CkLocMgr::reclaimRemote(const CkArrayIndex &idx,int deletedOnPe) {
2403         DEBC((AA"Our element %s died on PE %d\n"AB,idx2str(idx),deletedOnPe));
2404         CkLocRec *rec=elementNrec(idx);
2405         if (rec==NULL) return; //We never knew him
2406         if (rec->type()==CkLocRec::local) return; //He's already been reborn
2407         removeFromTable(idx);
2408         delete rec;
2409 }
2410 void CkLocMgr::removeFromTable(const CkArrayIndex &idx) {
2411 #if CMK_ERROR_CHECKING
2412         //Make sure it's actually in the table before we delete it
2413         if (NULL==elementNrec(idx))
2414                 CkAbort("CkLocMgr::removeFromTable called on invalid index!");
2415 #endif
2416         CmiImmediateLock(hashImmLock);
2417         hash.remove(*(CkArrayIndex *)&idx);
2418         CmiImmediateUnlock(hashImmLock);
2419 #if CMK_ERROR_CHECKING
2420         //Make sure it's really gone
2421         if (NULL!=elementNrec(idx))
2422                 CkAbort("CkLocMgr::removeFromTable called, but element still there!");
2423 #endif
2424 }
2425
2426 /************************** LocMgr: MESSAGING *************************/
2427 /// Deliver message to this element, going via the scheduler if local
2428 /// @return 0 if object local, 1 if not
2429 int CkLocMgr::deliver(CkMessage *m,CkDeliver_t type,int opts) {
2430         DEBS((AA"deliver \n"AB));
2431         CK_MAGICNUMBER_CHECK
2432         CkArrayMessage *msg=(CkArrayMessage *)m;
2433
2434
2435         const CkArrayIndex &idx=msg->array_index();
2436         DEBS((AA"deliver %s\n"AB,idx2str(idx)));
2437         if (type==CkDeliver_queue)
2438                 _TRACE_CREATION_DETAILED(UsrToEnv(m),msg->array_ep());
2439         CkLocRec *rec=elementNrec(idx);
2440         if(rec != NULL){
2441                 DEBS((AA"deliver %s of type %d \n"AB,idx2str(idx),rec->type()));
2442         }else{
2443                 DEBS((AA"deliver %s rec is null\n"AB,idx2str(idx)));
2444         }
2445 //#if (!defined(_FAULT_MLOG_) && !defined(_FAULT_CAUSAL_))
2446 //#if !defined(_FAULT_MLOG_)
2447 #if CMK_LBDB_ON
2448
2449         LDObjid ldid = idx2LDObjid(idx);
2450 #if CMK_GLOBAL_LOCATION_UPDATE
2451         ldid.locMgrGid = thisgroup.idx;
2452 #endif        
2453         if (type==CkDeliver_queue) {
2454                 if (!(opts & CK_MSG_LB_NOTRACE) && the_lbdb->CollectingCommStats()) {
2455                 if(rec!=NULL) the_lbdb->Send(myLBHandle,ldid,UsrToEnv(msg)->getTotalsize(), rec->lookupProcessor(), 1);
2456                 else /*rec==NULL*/ the_lbdb->Send(myLBHandle,ldid,UsrToEnv(msg)->getTotalsize(),homePe(msg->array_index()), 1);
2457                 }
2458         }
2459 #endif
2460 //#endif
2461 #if CMK_GRID_QUEUE_AVAILABLE
2462         int gridSrcPE;
2463         int gridSrcCluster;
2464         int gridDestPE;
2465         int gridDestCluster;
2466         CkMigratable *obj;
2467         ArrayElement *obj2;
2468         CkGroupID gid;
2469         int *data;
2470
2471         obj = (CkMigratable *) CpvAccess(CkGridObject);   // CkGridObject is a pointer to the sending object (retained earlier)
2472         if (obj != NULL) {
2473           obj2 = dynamic_cast<ArrayElement *> (obj);
2474           if (obj2 > 0) {
2475             // Get the sending object's array gid and indexes.
2476             // These are guaranteed to exist due to the succeeding dynamic cast above.
2477             gid = obj2->ckGetArrayID ();
2478             data = obj2->thisIndexMax.data ();
2479
2480             // Get the source PE and destination PE.
2481             gridSrcPE = CkMyPe ();
2482             if (rec != NULL) {
2483               gridDestPE = rec->lookupProcessor ();
2484             } else {
2485               gridDestPE = homePe (msg->array_index ());
2486             }
2487
2488             // Get the source cluster and destination cluster.
2489             gridSrcCluster = CmiGetCluster (gridSrcPE);
2490             gridDestCluster = CmiGetCluster (gridDestPE);
2491
2492             // If the Grid queue interval is greater than zero, it means that the more complicated
2493             // technique for registering border objects that exceed a specified threshold of
2494             // cross-cluster messages within a specified interval (and deregistering border objects
2495             // that do not meet this threshold) is used.  Otherwise a much simpler technique is used
2496             // where a border object is registered immediately upon sending a single cross-cluster
2497             // message (and deregistered when load balancing takes place).
2498             if (obj2->grid_queue_interval > 0) {
2499               // Increment the sending object's count of all messages.
2500               obj2->msg_count += 1;
2501
2502               // If the source cluster and destination cluster differ, this is a Grid message.
2503               // (Increment the count of all Grid messages.)
2504               if (gridSrcCluster != gridDestCluster) {
2505                 obj2->msg_count_grid += 1;
2506               }
2507
2508               // If the number of messages exceeds the interval, check to see if the object has
2509               // sent enough cross-cluster messages to qualify as a border object.
2510               if (obj2->msg_count >= obj2->grid_queue_interval) {
2511                 if (obj2->msg_count_grid >= obj2->grid_queue_threshold) {
2512                   // The object is a border object; if it is not already registered, register it.
2513                   if (!obj2->border_flag) {
2514                     CmiGridQueueRegister (gid.idx, obj2->thisIndexMax.nInts, data[0], data[1], data[2]);
2515                   }
2516                   obj2->border_flag = 1;
2517                 } else {
2518                   // The object is not a border object; if it is registered, deregister it.
2519                   if (obj2->border_flag) {
2520                     CmiGridQueueDeregister (gid.idx, obj2->thisIndexMax.nInts, data[0], data[1], data[2]);
2521                   }
2522                   obj2->border_flag = 0;
2523                 }
2524                 // Reset the counts.
2525                 obj2->msg_count = 0;
2526                 obj2->msg_count_grid = 0;
2527               }
2528             } else {
2529               if (gridSrcCluster != gridDestCluster) {
2530                 CmiGridQueueRegister (gid.idx, obj2->thisIndexMax.nInts, data[0], data[1], data[2]);
2531               }
2532             }
2533           }
2534
2535           // Reset the CkGridObject pointer.
2536           CpvAccess(CkGridObject) = NULL;
2537         }
2538 #endif
2539         /**FAULT_EVAC*/
2540         if (rec!=NULL){
2541                 CmiBool result = rec->deliver(msg,type,opts);
2542                 // if result is CmiFalse, than rec is not valid anymore, as the object
2543                 // the message was just delivered to has died or migrated out.
2544                 // Therefore rec->type() cannot be invoked!
2545                 if (result==CmiTrue && rec->type()==CkLocRec::local) return 0;
2546                 else return 1;
2547                 /*if(!result){
2548                         //DEBS((AA"deliver %s failed type %d \n"AB,idx2str(idx),rec->type()));
2549                         DEBS((AA"deliver %s failed \n"AB,idx2str(idx)));
2550                         if(rec->type() == CkLocRec::remote){
2551                                 if (opts & CK_MSG_KEEP)
2552                                         msg = (CkArrayMessage *)CkCopyMsg((void **)&msg);
2553                                 deliverUnknown(msg,type);
2554                         }
2555                 }*/
2556         }else /* rec==NULL*/ {
2557                 if (opts & CK_MSG_KEEP)
2558                         msg = (CkArrayMessage *)CkCopyMsg((void **)&msg);
2559                 deliverUnknown(msg,type,opts);
2560                 return 1;
2561         }
2562
2563 }
2564
2565 /// This index is not hashed-- somehow figure out what to do.
2566 CmiBool CkLocMgr::deliverUnknown(CkArrayMessage *msg,CkDeliver_t type,int opts)
2567 {
2568         CK_MAGICNUMBER_CHECK
2569         const CkArrayIndex &idx=msg->array_index();
2570         int onPe=homePe(idx);
2571         if (onPe!=CkMyPe()) 
2572         {// Forward the message to its home processor
2573                 DEBM((AA"Forwarding message for unknown %s to home %d \n"AB,idx2str(idx),onPe));
2574                 msg->array_hops()++;
2575                 CkArrayManagerDeliver(onPe,msg,opts);
2576                 return CmiTrue;
2577         }
2578         else
2579         { // We *are* the home processor:
2580         //Check if the element's array manager has been registered yet:
2581           CkArrMgr *mgr=managers.find(UsrToEnv((void *)msg)->getsetArrayMgr())->mgr;
2582           if (!mgr) { //No manager yet-- postpone the message (stupidly)
2583             if (CkInRestarting()) {
2584               // during restarting, this message should be ignored
2585               delete msg;
2586             }
2587             else {
2588               CkArrayManagerDeliver(CkMyPe(),msg); 
2589             }
2590           }
2591           else { // Has a manager-- must buffer the message
2592             DEBC((AA"Adding buffer for unknown element %s\n"AB,idx2str(idx)));
2593             CkLocRec *rec=new CkLocRec_buffering(this);
2594             insertRecN(rec,idx);
2595             rec->deliver(msg,type);
2596           
2597             if (msg->array_ifNotThere()!=CkArray_IfNotThere_buffer) 
2598             { //Demand-create the element:
2599               return demandCreateElement(msg,-1,type);
2600             }
2601           }
2602           return CmiTrue;
2603         }
2604 }
2605
2606 CmiBool CkLocMgr::demandCreateElement(CkArrayMessage *msg,int onPe,CkDeliver_t type)
2607 {
2608         CK_MAGICNUMBER_CHECK
2609         const CkArrayIndex &idx=msg->array_index();
2610         int chareType=_entryTable[msg->array_ep()]->chareIdx;
2611         int ctor=_chareTable[chareType]->getDefaultCtor();
2612         if (ctor==-1) CkAbort("Can't create array element to handle message--\n"
2613                               "The element has no default constructor in the .ci file!\n");
2614         if (onPe==-1) 
2615         { //Decide where element needs to live
2616                 if (msg->array_ifNotThere()==CkArray_IfNotThere_createhere) 
2617                         onPe=UsrToEnv(msg)->getsetArraySrcPe();
2618                 else //Createhome
2619                         onPe=homePe(idx);
2620         }
2621         
2622         //Find the manager and build the element
2623         DEBC((AA"Demand-creating element %s on pe %d\n"AB,idx2str(idx),onPe));
2624         CkArrMgr *mgr=managers.find(UsrToEnv((void *)msg)->getsetArrayMgr())->mgr;
2625         if (!mgr) CkAbort("Tried to demand-create for nonexistent arrMgr");
2626         return mgr->demandCreateElement(idx,onPe,ctor,type);
2627 }
2628
2629 //This message took several hops to reach us-- fix it
2630 void CkLocMgr::multiHop(CkArrayMessage *msg)
2631 {
2632
2633         CK_MAGICNUMBER_CHECK
2634         int srcPe=msg->array_getSrcPe();
2635         if (srcPe==CkMyPe())
2636                 DEB((AA"Odd routing: local element %s is %d hops away!\n"AB,idx2str(msg),msg->array_hops()));
2637         else
2638         {//Send a routing message letting original sender know new element location
2639                 DEBS((AA"Sending update back to %d for element\n"AB,srcPe,idx2str(msg)));
2640                 thisProxy[srcPe].updateLocation(msg->array_index(),CkMyPe());
2641         }
2642 }
2643
2644 /************************** LocMgr: ITERATOR *************************/
2645 CkLocation::CkLocation(CkLocMgr *mgr_, CkLocRec_local *rec_)
2646         :mgr(mgr_), rec(rec_) {}
2647         
2648 const CkArrayIndex &CkLocation::getIndex(void) const {
2649         return rec->getIndex();
2650 }
2651
2652 void CkLocation::destroyAll() {
2653         mgr->callMethod(rec, &CkMigratable::ckDestroy);
2654 }
2655
2656 void CkLocation::pup(PUP::er &p) {
2657         mgr->pupElementsFor(p,rec,CkElementCreation_migrate);
2658 }
2659
2660 CkLocIterator::~CkLocIterator() {}
2661
2662 /// Iterate over our local elements:
2663 void CkLocMgr::iterate(CkLocIterator &dest) {
2664   //Poke through the hash table for local ArrayRecs.
2665   void *objp;
2666   CkHashtableIterator *it=hash.iterator();
2667   CmiImmediateLock(hashImmLock);
2668
2669   while (NULL!=(objp=it->next())) {
2670     CkLocRec *rec=*(CkLocRec **)objp;
2671     if (rec->type()==CkLocRec::local) {
2672       CkLocation loc(this,(CkLocRec_local *)rec);
2673       dest.addLocation(loc);
2674     }
2675   }
2676   CmiImmediateUnlock(hashImmLock);
2677   delete it;
2678 }
2679
2680
2681
2682
2683 /************************** LocMgr: MIGRATION *************************/
2684 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
2685 void CkLocMgr::pupElementsFor(PUP::er &p,CkLocRec_local *rec,
2686         CkElementCreation_t type, CmiBool create, int dummy)
2687 {
2688     p.comment("-------- Array Location --------");
2689     register ManagerRec *m;
2690     int localIdx=rec->getLocalIndex();
2691     CkVec<CkMigratable *> dummyElts;
2692
2693     for (m=firstManager;m!=NULL;m=m->next) {
2694         int elCType;
2695         if (!p.isUnpacking())
2696         { //Need to find the element's existing type
2697             CkMigratable *elt=m->element(localIdx);
2698             if (elt) elCType=elt->ckGetChareType();
2699             else elCType=-1; //Element hasn't been created
2700         }
2701         p(elCType);
2702         if (p.isUnpacking() && elCType!=-1) {
2703             CkMigratable *elt=m->mgr->allocateMigrated(elCType,rec->getIndex(),type);
2704             int migCtorIdx=_chareTable[elCType]->getMigCtor();
2705                 if(!dummy){
2706                         if(create)
2707                                 if (!addElementToRec(rec,m,elt,migCtorIdx,NULL)) return;
2708                                 }else{
2709                     CkMigratable_initInfo &i=CkpvAccess(mig_initInfo);
2710                     i.locRec=rec;
2711                     i.chareType=_entryTable[migCtorIdx]->chareIdx;
2712                     dummyElts.push_back(elt);
2713                     if (!rec->invokeEntry(elt,NULL,migCtorIdx,CmiTrue)) return ;
2714                 }
2715         }
2716     }
2717     if(!dummy){
2718         for (m=firstManager;m!=NULL;m=m->next) {
2719             CkMigratable *elt=m->element(localIdx);
2720             if (elt!=NULL)
2721                 {
2722                        elt->pup(p);
2723                 }
2724         }
2725     }else{
2726             for(int i=0;i<dummyElts.size();i++){
2727                 CkMigratable *elt = dummyElts[i];
2728                 if (elt!=NULL){
2729             elt->pup(p);
2730                         }
2731                 delete elt;
2732             }
2733                         for (ManagerRec *m=firstManager;m!=NULL;m=m->next) {
2734                 m->elts.empty(localIdx);
2735             }
2736         freeList[localIdx]=firstFree;
2737         firstFree=localIdx;
2738     }
2739 }
2740 #else
2741 void CkLocMgr::pupElementsFor(PUP::er &p,CkLocRec_local *rec,
2742                 CkElementCreation_t type)
2743 {
2744         p.comment("-------- Array Location --------");
2745         register ManagerRec *m;
2746         int localIdx=rec->getLocalIndex();
2747
2748         //First pup the element types
2749         // (A separate loop so ckLocal works even in element pup routines)
2750         for (m=firstManager;m!=NULL;m=m->next) {
2751                 int elCType;
2752                 if (!p.isUnpacking())
2753                 { //Need to find the element's existing type
2754                         CkMigratable *elt=m->element(localIdx);
2755                         if (elt) elCType=elt->ckGetChareType();
2756                         else elCType=-1; //Element hasn't been created
2757                 }
2758                 p(elCType);
2759                 if (p.isUnpacking() && elCType!=-1) {
2760                         //Create the element
2761                         CkMigratable *elt=m->mgr->allocateMigrated(elCType,rec->getIndex(),type);
2762                         int migCtorIdx=_chareTable[elCType]->getMigCtor();
2763                         //Insert into our tables and call migration constructor
2764                         if (!addElementToRec(rec,m,elt,migCtorIdx,NULL)) return;
2765                 }
2766         }
2767         //Next pup the element data
2768         for (m=firstManager;m!=NULL;m=m->next) {
2769                 CkMigratable *elt=m->element(localIdx);
2770                 if (elt!=NULL)
2771                 {
2772                         elt->pup(p);
2773 #if CMK_ERROR_CHECKING
2774                         if (p.isUnpacking()) elt->sanitycheck();
2775 #endif
2776                 }
2777         }
2778 }
2779 #endif
2780
2781 /// Call this member function on each element of this location:
2782 void CkLocMgr::callMethod(CkLocRec_local *rec,CkMigratable_voidfn_t fn)
2783 {
2784         int localIdx=rec->getLocalIndex();
2785         for (ManagerRec *m=firstManager;m!=NULL;m=m->next) {
2786                 CkMigratable *el=m->element(localIdx);
2787                 if (el) (el->* fn)();
2788         }
2789 }
2790
2791 /// Call this member function on each element of this location:
2792 void CkLocMgr::callMethod(CkLocRec_local *rec,CkMigratable_voidfn_arg_t fn,     void * data)
2793 {
2794         int localIdx=rec->getLocalIndex();
2795         for (ManagerRec *m=firstManager;m!=NULL;m=m->next) {
2796                 CkMigratable *el=m->element(localIdx);
2797                 if (el) (el->* fn)(data);
2798         }
2799 }
2800
2801 /// return a list of migratables in this local record
2802 void CkLocMgr::migratableList(CkLocRec_local *rec, CkVec<CkMigratable *> &list)
2803 {
2804         register ManagerRec *m;
2805         int localIdx=rec->getLocalIndex();
2806
2807         for (m=firstManager;m!=NULL;m=m->next) {
2808                 CkMigratable *elt=m->element(localIdx);
2809                 if (elt) list.push_back(elt);
2810         }
2811 }
2812
2813 /// Migrate this local element away to another processor.
2814 void CkLocMgr::emigrate(CkLocRec_local *rec,int toPe)
2815 {
2816         CK_MAGICNUMBER_CHECK
2817         if (toPe==CkMyPe()) return; //You're already there!
2818         /*
2819                 FAULT_EVAC
2820                 if the toProcessor is already marked as invalid, dont emigrate
2821                 Shouldn't happen but might
2822         */
2823         if(!CmiNodeAlive(toPe)){
2824                 return;
2825         }
2826         CkArrayIndex idx=rec->getIndex();
2827
2828 #if CMK_OUT_OF_CORE
2829         int localIdx=rec->getLocalIndex();
2830         /* Load in any elements that are out-of-core */
2831         for (ManagerRec *m=firstManager;m!=NULL;m=m->next) {
2832                 CkMigratable *el=m->element(localIdx);
2833                 if (el) if (!el->isInCore) CooBringIn(el->prefetchObjID);
2834         }
2835 #endif
2836
2837         //Let all the elements know we're leaving
2838         callMethod(rec,&CkMigratable::ckAboutToMigrate);
2839         /*EVAC*/
2840
2841 //First pass: find size of migration message
2842         int bufSize;
2843         {
2844                 PUP::sizer p;
2845                 p(nManagers);
2846                 pupElementsFor(p,rec,CkElementCreation_migrate);
2847                 bufSize=p.size(); 
2848         }
2849
2850 //Allocate and pack into message
2851         int doubleSize=bufSize/sizeof(double)+1;
2852         CkArrayElementMigrateMessage *msg = 
2853                 new (doubleSize, 0) CkArrayElementMigrateMessage;
2854         msg->idx=idx;
2855         msg->length=bufSize;
2856 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_)) 
2857     msg->gid = ckGetGroupID();
2858 #endif
2859 #if CMK_LBDB_ON
2860         msg->ignoreArrival = rec->isAsyncMigrate()?1:0;
2861 #endif
2862         /*
2863                 FAULT_EVAC
2864         */
2865         msg->bounced = rec->isBounced();
2866         {
2867                 PUP::toMem p(msg->packData); 
2868                 p.becomeDeleting(); 
2869                 p(nManagers);
2870                 pupElementsFor(p,rec,CkElementCreation_migrate);
2871                 if (p.size()!=bufSize) {
2872                         CkError("ERROR! Array element claimed it was %d bytes to a "
2873                                 "sizing PUP::er, but copied %d bytes into the packing PUP::er!\n",
2874                                 bufSize,p.size());
2875                         CkAbort("Array element's pup routine has a direction mismatch.\n");
2876                 }
2877         }
2878
2879         DEBM((AA"Migrated index size %s to %d \n"AB,idx2str(idx),toPe));        
2880
2881 //#if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
2882 //#if defined(_FAULT_MLOG_)
2883 //    sendMlogLocation(toPe,UsrToEnv(msg));
2884 //#else
2885         //Send off message and delete old copy
2886         thisProxy[toPe].immigrate(msg);
2887 //#endif
2888
2889         duringMigration=CmiTrue;
2890         delete rec; //Removes elements, hashtable entries, local index
2891         
2892         
2893         duringMigration=CmiFalse;
2894         //The element now lives on another processor-- tell ourselves and its home
2895         inform(idx,toPe);
2896 //#if (!defined(_FAULT_MLOG_) && !defined(_FAULT_CAUSAL_))    
2897 //#if !defined(_FAULT_MLOG_)    
2898         informHome(idx,toPe);
2899 //#endif
2900
2901 #if !CMK_LBDB_ON && CMK_GLOBAL_LOCATION_UPDATE
2902         DEBM((AA"Global location update. idx %s " 
2903               "assigned to %d \n"AB,idx2str(idx),toPe));
2904         thisProxy.updateLocation(idx, toPe);                        
2905 #endif
2906
2907         CK_MAGICNUMBER_CHECK
2908 }
2909
2910 void CkLocMgr::informLBPeriod(CkLocRec_local *rec, int lb_ideal_period) {
2911         callMethod(rec,&CkMigratable::recvLBPeriod, (void *)&lb_ideal_period);
2912 }
2913
2914 void CkLocMgr::metaLBCallLB(CkLocRec_local *rec) {
2915         callMethod(rec, &CkMigratable::metaLBCallLB);
2916 }
2917
2918 /**
2919   Migrating array element is arriving on this processor.
2920 */
2921 void CkLocMgr::immigrate(CkArrayElementMigrateMessage *msg)
2922 {
2923         const CkArrayIndex &idx=msg->idx;
2924                 
2925         PUP::fromMem p(msg->packData); 
2926         
2927         int nMsgMan;
2928         p(nMsgMan);
2929         if (nMsgMan<nManagers)
2930                 CkAbort("Array element arrived from location with fewer managers!\n");
2931         if (nMsgMan>nManagers) {
2932                 //Some array managers haven't registered yet-- throw it back
2933                 DEBM((AA"Busy-waiting for array registration on migrating %s\n"AB,idx2str(idx)));
2934                 thisProxy[CkMyPe()].immigrate(msg);
2935                 return;
2936         }
2937
2938         //Create a record for this element
2939 //#if (!defined(_FAULT_MLOG_) && !defined(_FAULT_CAUSAL_))    
2940 //#if !defined(_FAULT_MLOG_)     
2941         CkLocRec_local *rec=createLocal(idx,CmiTrue,msg->ignoreArrival,CmiFalse /* home told on departure */ );
2942 //#else
2943 //    CkLocRec_local *rec=createLocal(idx,CmiTrue,CmiTrue,CmiFalse /* home told on departure */ );
2944 //#endif
2945         
2946         //Create the new elements as we unpack the message
2947         pupElementsFor(p,rec,CkElementCreation_migrate);
2948         if (p.size()!=msg->length) {
2949                 CkError("ERROR! Array element claimed it was %d bytes to a"
2950                         "packing PUP::er, but %d bytes in the unpacking PUP::er!\n",
2951                         msg->length,p.size());
2952                 CkError("(I have %d managers; he claims %d managers)\n",
2953                         nManagers,nMsgMan);
2954                 
2955                 CkAbort("Array element's pup routine has a direction mismatch.\n");
2956         }
2957         /*
2958                 FAULT_EVAC
2959                         if this element came in as a result of being bounced off some other process,
2960                         then it needs to be resumed. It is assumed that it was bounced because load 
2961                         balancing caused it to move into a processor which later crashed
2962         */
2963         if(msg->bounced){
2964                 callMethod(rec,&CkMigratable::ResumeFromSync);
2965         }
2966         
2967         //Let all the elements know we've arrived
2968         callMethod(rec,&CkMigratable::ckJustMigrated);
2969         /*FAULT_EVAC
2970                 If this processor has started evacuating array elements on it 
2971                 dont let new immigrants in. If they arrive send them to what
2972                 would be their correct homePE.
2973                 Leave a record here mentioning the processor where it got sent
2974         */
2975         
2976         if(CkpvAccess(startedEvac)){
2977                 int newhomePE = getNextPE(idx);
2978                 DEBM((AA"Migrated into failed processor index size %s resent to %d \n"AB,idx2str(idx),newhomePE));      
2979                 CkLocMgr *mgr = rec->getLocMgr();
2980                 int targetPE=getNextPE(idx);
2981                 //set this flag so that load balancer is not informed when
2982                 //this element migrates
2983                 rec->AsyncMigrate(CmiTrue);
2984                 rec->Bounced(CmiTrue);
2985                 mgr->emigrate(rec,targetPE);
2986                 
2987         }
2988
2989         delete msg;
2990 }
2991
2992 void CkLocMgr::restore(const CkArrayIndex &idx, PUP::er &p)
2993 {
2994         //This is in broughtIntoMem during out-of-core emulation in BigSim,
2995         //informHome should not be called since such information is already
2996         //immediately updated real migration
2997 #if CMK_ERROR_CHECKING
2998         if(_BgOutOfCoreFlag!=2)
2999             CmiAbort("CkLocMgr::restore should only be used in out-of-core emulation for BigSim and be called when object is brought into memory!\n");
3000 #endif
3001         CkLocRec_local *rec=createLocal(idx,CmiFalse,CmiFalse,CmiFalse);
3002         
3003         //BIGSIM_OOC DEBUGGING
3004         //CkPrintf("Proc[%d]: Registering element %s with LDB\n", CkMyPe(), idx2str(idx));
3005
3006         //Create the new elements as we unpack the message
3007         pupElementsFor(p,rec,CkElementCreation_restore);
3008
3009         callMethod(rec,&CkMigratable::ckJustRestored);
3010 }
3011
3012
3013 /// Insert and unpack this array element from this checkpoint (e.g., from CkLocation::pup)
3014 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
3015 void CkLocMgr::resume(const CkArrayIndex &idx, PUP::er &p, CmiBool create, int dummy)
3016 {
3017         CkLocRec_local *rec;
3018         CkLocRec *recGlobal;    
3019
3020         if(create){
3021                 rec = createLocal(idx,CmiFalse,CmiFalse,CmiTrue && !dummy /* home doesn't know yet */,dummy );
3022         }else{
3023                 recGlobal = elementNrec(idx);
3024                 if(recGlobal == NULL) 
3025                         CmiAbort("Local object not found");
3026                 if(recGlobal->type() != CkLocRec::local)
3027                         CmiAbort("Local object not local, :P");
3028                 rec = (CkLocRec_local *)recGlobal;
3029         }
3030         
3031     pupElementsFor(p,rec,CkElementCreation_resume,create,dummy);
3032
3033     if(!dummy){
3034         callMethod(rec,&CkMigratable::ckJustMigrated);
3035     }
3036 }
3037 #else
3038 void CkLocMgr::resume(const CkArrayIndex &idx, PUP::er &p, CmiBool notify)
3039 {
3040         CkLocRec_local *rec=createLocal(idx,CmiFalse,CmiFalse,notify /* home doesn't know yet */ );
3041
3042         //Create the new elements as we unpack the message
3043         pupElementsFor(p,rec,CkElementCreation_resume);
3044
3045         callMethod(rec,&CkMigratable::ckJustMigrated);
3046 }
3047 #endif
3048
3049 /********************* LocMgr: UTILITY ****************/
3050 void CkMagicNumber_impl::badMagicNumber(
3051         int expected,const char *file,int line,void *obj) const
3052 {
3053         CkError("FAILURE on pe %d, %s:%d> Expected %p's magic number "
3054                 "to be 0x%08x; but found 0x%08x!\n", CkMyPe(),file,line,obj,
3055                 expected, magic);
3056         CkAbort("Bad magic number detected!  This implies either\n"
3057                 "the heap or a message was corrupted!\n");
3058 }
3059 CkMagicNumber_impl::CkMagicNumber_impl(int m) :magic(m) { }
3060
3061 //Look up the object with this array index, or return NULL
3062 CkMigratable *CkLocMgr::lookup(const CkArrayIndex &idx,CkArrayID aid) {
3063         CkLocRec *rec=elementNrec(idx);
3064         if (rec==NULL) return NULL;
3065         else return rec->lookupElement(aid);
3066 }
3067 //"Last-known" location (returns a processor number)
3068 int CkLocMgr::lastKnown(const CkArrayIndex &idx) {
3069         CkLocMgr *vthis=(CkLocMgr *)this;//Cast away "const"
3070         CkLocRec *rec=vthis->elementNrec(idx);
3071         int pe=-1;
3072         if (rec!=NULL) pe=rec->lookupProcessor();
3073         if (pe==-1) return homePe(idx);
3074         else{
3075                 /*
3076                         FAULT_EVAC
3077                         if the lastKnownPE is invalid return homePE and delete this record
3078                 */
3079                 if(!CmiNodeAlive(pe)){
3080                         removeFromTable(idx);
3081                         return homePe(idx);
3082                 }
3083                 return pe;
3084         }       
3085 }
3086 /// Return true if this array element lives on another processor
3087 bool CkLocMgr::isRemote(const CkArrayIndex &idx,int *onPe) const
3088 {
3089         CkLocMgr *vthis=(CkLocMgr *)this;//Cast away "const"
3090         CkLocRec *rec=vthis->elementNrec(idx);
3091         if (rec==NULL || rec->type()!=CkLocRec::remote) 
3092                 return false; /* not definitely a remote element */
3093         else /* element is indeed remote */
3094         {
3095                 *onPe=rec->lookupProcessor();
3096                 return true;
3097         }
3098 }
3099
3100 static const char *rec2str[]={
3101     "base (INVALID)",//Base class (invalid type)
3102     "local",//Array element that lives on this Pe
3103     "remote",//Array element that lives on some other Pe
3104     "buffering",//Array element that was just created
3105     "dead"//Deleted element (for debugging)
3106 };
3107
3108 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
3109 void CkLocMgr::setDuringMigration(CmiBool _duringMigration){
3110     duringMigration = _duringMigration;
3111 }
3112 #endif
3113
3114
3115 //Add given element array record at idx, replacing the existing record
3116 void CkLocMgr::insertRec(CkLocRec *rec,const CkArrayIndex &idx) {
3117         CkLocRec *old=elementNrec(idx);
3118         insertRecN(rec,idx);
3119         if (old!=NULL) {
3120                 DEBC((AA"  replaces old rec(%s) for %s\n"AB,rec2str[old->type()],idx2str(idx)));
3121                 //There was an old element at this location
3122                 if (old->type()==CkLocRec::local && rec->type()==CkLocRec::local) {
3123                     if (!CkInRestarting()) {    // ok if it is restarting
3124                         CkPrintf("ERROR! Duplicate array index: %s\n",idx2str(idx));
3125                         CkAbort("Duplicate array index used");
3126                     }
3127                 }
3128                 old->beenReplaced();
3129                 delete old;
3130         }
3131 }
3132
3133 //Add given record, when there is guarenteed to be no prior record
3134 void CkLocMgr::insertRecN(CkLocRec *rec,const CkArrayIndex &idx) {
3135         DEBC((AA"  adding new rec(%s) for %s\n"AB,rec2str[rec->type()],idx2str(idx)));
3136         CmiImmediateLock(hashImmLock);
3137         hash.put(*(CkArrayIndex *)&idx)=rec;
3138         CmiImmediateUnlock(hashImmLock);
3139 }
3140
3141 //Call this on an unrecognized array index
3142 static void abort_out_of_bounds(const CkArrayIndex &idx)
3143 {
3144   CkPrintf("ERROR! Unknown array index: %s\n",idx2str(idx));
3145   CkAbort("Array index out of bounds\n");
3146 }
3147
3148 //Look up array element in hash table.  Index out-of-bounds if not found.
3149 CkLocRec *CkLocMgr::elementRec(const CkArrayIndex &idx) {
3150 #if ! CMK_ERROR_CHECKING
3151 //Assume the element will be found
3152         return hash.getRef(*(CkArrayIndex *)&idx);
3153 #else
3154 //Include an out-of-bounds check if the element isn't found
3155         CkLocRec *rec=elementNrec(idx);
3156         if (rec==NULL) abort_out_of_bounds(idx);
3157         return rec;
3158 #endif
3159 }
3160
3161 //Look up array element in hash table.  Return NULL if not there.
3162 CkLocRec *CkLocMgr::elementNrec(const CkArrayIndex &idx) {
3163         return hash.get(*(CkArrayIndex *)&idx);
3164 }
3165
3166 struct LocalElementCounter :  public CkLocIterator
3167 {
3168     unsigned int count;
3169     LocalElementCounter() : count(0) {}
3170     void addLocation(CkLocation &loc)
3171         { ++count; }
3172 };
3173
3174 unsigned int CkLocMgr::numLocalElements()
3175 {
3176     LocalElementCounter c;
3177     iterate(c);
3178     return c.count;
3179 }
3180
3181
3182 /********************* LocMgr: LOAD BALANCE ****************/
3183
3184 #if !CMK_LBDB_ON
3185 //Empty versions of all load balancer calls
3186 void CkLocMgr::initLB(CkGroupID lbdbID_, CkGroupID metalbID_) {}
3187 void CkLocMgr::startInserting(void) {}
3188 void CkLocMgr::doneInserting(void) {}
3189 void CkLocMgr::dummyAtSync(void) {}
3190 #endif
3191
3192
3193 #if CMK_LBDB_ON
3194 void CkLocMgr::initLB(CkGroupID lbdbID_, CkGroupID metalbID_)
3195 { //Find and register with the load balancer
3196         the_lbdb = (LBDatabase *)CkLocalBranch(lbdbID_);
3197         if (the_lbdb == 0)
3198                 CkAbort("LBDatabase not yet created?\n");
3199         DEBL((AA"Connected to load balancer %p\n"AB,the_lbdb));
3200         the_metalb = (MetaBalancer *)CkLocalBranch(metalbID_);
3201         if (the_metalb == 0)
3202                 CkAbort("MetaBalancer not yet created?\n");
3203
3204         // Register myself as an object manager
3205         LDOMid myId;
3206         myId.id = thisgroup;
3207         LDCallbacks myCallbacks;
3208         myCallbacks.migrate = (LDMigrateFn)CkLocRec_local::staticMigrate;
3209         myCallbacks.setStats = NULL;
3210         myCallbacks.queryEstLoad = NULL;
3211   myCallbacks.metaLBResumeWaitingChares =
3212       (LDMetaLBResumeWaitingCharesFn)CkLocRec_local::staticMetaLBResumeWaitingChares;
3213   myCallbacks.metaLBCallLBOnChares =
3214       (LDMetaLBCallLBOnCharesFn)CkLocRec_local::staticMetaLBCallLBOnChares;
3215         myLBHandle = the_lbdb->RegisterOM(myId,this,myCallbacks);
3216
3217         // Tell the lbdb that I'm registering objects
3218         the_lbdb->RegisteringObjects(myLBHandle);
3219
3220         /*Set up the dummy barrier-- the load balancer needs
3221           us to call Registering/DoneRegistering during each AtSync,
3222           and this is the only way to do so.
3223         */
3224         the_lbdb->AddLocalBarrierReceiver(
3225                 (LDBarrierFn)staticRecvAtSync,(void*)(this));
3226         dummyBarrierHandle = the_lbdb->AddLocalBarrierClient(
3227                 (LDResumeFn)staticDummyResumeFromSync,(void*)(this));
3228         dummyAtSync();
3229 }
3230 void CkLocMgr::dummyAtSync(void)
3231 {
3232         DEBL((AA"dummyAtSync called\n"AB));
3233         the_lbdb->AtLocalBarrier(dummyBarrierHandle);
3234 }
3235
3236 void CkLocMgr::staticDummyResumeFromSync(void* data)
3237 {      ((CkLocMgr*)data)->dummyResumeFromSync(); }
3238 void CkLocMgr::dummyResumeFromSync()
3239 {
3240         DEBL((AA"DummyResumeFromSync called\n"AB));
3241         the_lbdb->DoneRegisteringObjects(myLBHandle);
3242         dummyAtSync();
3243 }
3244 void CkLocMgr::staticRecvAtSync(void* data)
3245 {      ((CkLocMgr*)data)->recvAtSync(); }
3246 void CkLocMgr::recvAtSync()
3247 {
3248         DEBL((AA"recvAtSync called\n"AB));
3249         the_lbdb->RegisteringObjects(myLBHandle);
3250 }
3251
3252 void CkLocMgr::startInserting(void)
3253 {
3254         the_lbdb->RegisteringObjects(myLBHandle);
3255 }
3256 void CkLocMgr::doneInserting(void)
3257 {
3258         the_lbdb->DoneRegisteringObjects(myLBHandle);
3259 }
3260 #endif
3261
3262 #include "CkLocation.def.h"
3263
3264