0c1248ce65ad71b2c8570150f0fd9dd67e24d9b8
[charm.git] / src / libs / ck-libs / multiphaseSharedArrays / msa-DistPageMgr.h
1 // emacs mode line -*- mode: c++; tab-width: 4 -*-
2
3 #ifndef MSA_DISTPAGEMGR_H
4 #define MSA_DISTPAGEMGR_H
5
6 #include <charm++.h>
7 #include <string.h>
8 #include <list>
9 #include <stack>
10 #include <map>
11 #include <set>
12 #include <vector>
13 #include "msa-common.h"
14
15 // forward decl needed in msa-DistPageMgr.ci, i.e. in msa.decl.h
16
17 /// Stores a list of indices to be written out.
18 struct MSA_WriteSpan_t {
19     int start,end;
20     inline void pup(PUP::er &p) {
21         p|start; p|end;
22     }
23 };
24
25 template <class ENTRY, class MERGER,
26           unsigned int ENTRIES_PER_PAGE>
27          class MSA_PageT;
28 #include "msa.decl.h"
29
30 //=======================================================
31 // Utility Classes
32
33 /// Listens for some event on a page or set of pages.
34 class MSA_Listener {
35 public:
36         MSA_Listener() {}
37         virtual ~MSA_Listener();
38         /// Getting added to a lister list.
39         virtual void add(void) =0;
40         /// Event waiting for has occurred.
41         virtual void signal(unsigned int pageNo) =0;
42 };
43
44 /// Keeps a list of MSA_Listeners
45 class MSA_Listeners {
46         CkVec<MSA_Listener *> listeners;
47 public:
48         MSA_Listeners();
49         ~MSA_Listeners();
50         
51         /// Add this listener to your set.  Calls l->add().
52         void add(MSA_Listener *l);
53         
54         /// Return the number of listeners in our set.
55         unsigned int size(void) const {return listeners.size();}
56         
57         /// Signal all added listeners and remove them from the set.
58         void signal(unsigned int pageNo);
59 };
60
61
62 /** Resumes a thread once all needed pages have arrived */
63 class MSA_Thread_Listener : public MSA_Listener {
64         CthThread thread;    // the suspended thread of execution (0 if not suspended)
65         int count;  // number of pages we're still waiting for
66 public:
67         MSA_Thread_Listener() :thread(0), count(0) {}
68         
69         /// Wait for one more page.
70         void add(void);
71         
72         /// If we're waiting for any pages, suspend our thread.
73         void suspend(void);
74         
75         /// Another page arrived.
76         void signal(unsigned int pageNo);
77 };
78
79
80 /// Stores all housekeeping information about a cached copy of a page: 
81 ///   everything but the actual page data.
82 /// This is the non-templated superclass, which doesn't depend on the 
83 ///   page size or datatype.
84 class MSA_Page_State {
85 public:
86         /// e.g., Read_Fault for a read-only page.
87         MSA_Page_Fault_t state;
88         
89         /// If true, this page is locked in memory.
90         ///   Pages get locked so people can safely use the non-checking version of "get".
91         bool locked;
92         
93         /// Threads waiting for this page to be paged in from the network.
94         MSA_Listeners readRequests;
95         /// Threads waiting for this page to be paged out to the network.
96         MSA_Listeners writeRequests;
97         
98         /// Return true if this page can be safely written back.
99         bool canPageOut(void) const {
100                 return (!locked) && canDelete();
101         }
102         
103         /// Return true if this page can be safely purged from memory.
104         bool canDelete(void) const {
105                 return (readRequests.size()==0) && (writeRequests.size()==0);
106         }
107         
108         MSA_Page_State() :state(Uninit_State), locked(false) {}
109 };
110
111 /// Fast, fixed-size bitvector class.
112 // TODO: Replace with std::bitset
113 template <unsigned int NUM_BITS>
114 class fixedlength_bitvector {
115 public:
116         /// Data type used to store actual bits in the vector.
117         typedef unsigned long store_t;
118         enum { store_bits=8*sizeof(store_t) };
119         
120         /// Number of store_t's in our vector.
121         enum { len=(NUM_BITS+(store_bits-1))/store_bits };
122         store_t store[len];
123         
124         fixedlength_bitvector() {reset();}
125
126         /// Fill the entire vector with this value.
127         void fill(store_t s) {
128                 for (int i=0;i<len;i++) store[i]=s;
129         }
130
131         void reset(void) {fill(0);}
132         
133         /// Set-to-1 bit i of the vector.
134         void set(unsigned int i) { store[i/store_bits] |= (1lu<<(i%store_bits)); }
135
136         /// Clear-to-0 bit i of the vector.
137         void reset(unsigned int i) { store[i/store_bits] &= ~(1lu<<(i%store_bits)); }
138         
139         /// Return the i'th bit of the vector.
140         bool test(unsigned int i) { return (store[i/store_bits] & (1lu<<(i%store_bits))); }
141 };
142
143 /// Templated page housekeeping class.  
144 template <class ENTRY, unsigned int ENTRIES_PER_PAGE>
145 class MSA_Page_StateT : public MSA_Page_State {
146         /** Write tracking:
147            Somehow, we have to identify the entries in a page 
148          that have been written to.  Our method for doing this is
149          a bitvector: 0's indicate the entry hasn't been written; 
150          1's indicate the entry has been written.
151         */
152         typedef fixedlength_bitvector<ENTRIES_PER_PAGE> writes_t;
153         writes_t writes;
154         typedef typename writes_t::store_t writes_store_t;
155         enum {writes_bits=writes_t::store_bits};
156         
157         /// Tracking writes to our writes: a smaller vector, used to 
158         ///  avoid the large number of 0's in the writes vector.
159         ///  Bit i of writes2 indicates that store_t i of writes has 1's.
160         typedef fixedlength_bitvector<writes_t::len> writes2_t;
161         writes2_t writes2;
162         typedef typename writes2_t::store_t writes2_store_t;
163         enum {writes2_bits=writes2_t::store_bits*writes_t::store_bits};
164
165 public:
166         /// Write entry i of this page.
167         void write(unsigned int i) {
168                 writes.set(i);
169                 writes2.set(i/writes_t::store_bits);
170         }
171         
172         /// Clear the write list for this page.
173         void writeClear(void) {
174                 for (int i2=0;i2<writes2_t::len;i2++)
175                   if (writes2.store[i2]) { /* some bits set: clear them all */
176                         int o=i2*writes2_t::store_bits;
177                         for (int i=0;i<writes_t::len;i++) 
178                           writes.store[o+i]=0;
179                         writes2.store[i2]=0;
180                   }
181         }
182         
183         /// Return the nearest multiple of m >= v.
184         inline int roundUp(int v,int m) {
185                 return (v+m-1)/m*m;
186         }
187         
188         /// Get a list of our written output values as this list of spans.
189         ///   Returns the total number of spans written to "span".
190         int writeSpans(MSA_WriteSpan_t *span) {
191                 int nSpans=0;
192                 
193                 int cur=0; // entry we're looking at
194                 while (true) {
195                         /* skip over unwritten space */
196                         while (true) { 
197                                 if (writes2.store[cur/writes2_bits]==(writes2_store_t)0) 
198                                         cur=roundUp(cur+1,writes2_bits);
199                                 else if (writes.store[cur/writes_bits]==(writes_store_t)0)
200                                         cur=roundUp(cur+1,writes_bits); 
201                                 else if (writes.test(cur)==false)
202                                         cur++;
203                                 else /* writes.test(cur)==true */
204                                         break;
205                                 if (cur>=ENTRIES_PER_PAGE) return nSpans;
206                         }
207                         /* now writes.test(cur)==true */
208                         span[nSpans].start=cur;
209                         /* skip over written space */
210                         while (true) { 
211                                 /* // 0-1 symmetry doesn't hold here, since writes2 may have 1's, but writes may still have some 0's...
212                                 if (writes2.store[cur/writes2_bits]==~(writes2_store_t)0) 
213                                         cur=roundUp(cur+1,writes2_bits);
214                                 else */
215                                 if (writes.store[cur/writes_bits]==~(writes_store_t)0)
216                                         cur=roundUp(cur+1,writes_bits); 
217                                 else if (writes.test(cur)==true)
218                                         cur++;
219                                 else /* writes.test(cur)==false */
220                                         break;
221                                 if (cur>=ENTRIES_PER_PAGE) {
222                                         span[nSpans++].end=ENTRIES_PER_PAGE; /* finish the last span */
223                                         return nSpans;
224                                 }
225                         }
226                         /* now writes.test(cur)==false */
227                         span[nSpans++].end=cur;
228                 }
229         }
230 };
231
232
233 //=======================================================
234 // Page-out policy
235
236 /**
237   class vmLRUPageReplacementPolicy
238   This class provides the functionality of least recently used page replacement policy.
239   It needs to be notified when a page is accessed using the pageAccessed() function and
240   a page can be selected for replacement using the selectPage() function.
241  
242   WARNING: a list is absolutely the wrong data structure for this class, 
243      because it makes *both* updating as well as searching for a page O(n),
244      where n is the number of pages.  A heap would be a better choice,
245      as both operations would then become O(lg(n))
246  */
247 template <class ENTRY_TYPE, unsigned int ENTRIES_PER_PAGE>
248 class vmLRUReplacementPolicy
249 {
250 protected:
251     unsigned int nPages;            // number of pages
252   const std::vector<ENTRY_TYPE *> &pageTable; // actual data for pages (NULL means page is gone)
253   typedef MSA_Page_StateT<ENTRY_TYPE, ENTRIES_PER_PAGE> pageState_t;
254   const std::vector<pageState_t *> &pageState;  // state of each page
255     std::list<unsigned int> stackOfPages;
256     unsigned int lastPageAccessed;
257
258 public:
259   inline vmLRUReplacementPolicy(unsigned int nPages_, const std::vector<ENTRY_TYPE *> &pageTable_, const std::vector<pageState_t *> &pageState_)
260     : nPages(nPages_), pageTable(pageTable_), pageState(pageState_), lastPageAccessed(MSA_INVALID_PAGE_NO) {}
261
262     inline void pageAccessed(unsigned int page)
263     {
264         if(page != lastPageAccessed)
265         {
266             lastPageAccessed = page;
267
268             // delete this page from the stack and push it at the top
269                         std::list<unsigned int>::iterator i;
270             for(i = stackOfPages.begin(); i != stackOfPages.end(); i++)
271                 if(*i == page)
272                     i = stackOfPages.erase(i);
273
274             stackOfPages.push_back(page);
275         }
276     }
277
278     inline unsigned int selectPage()
279     {
280         if(stackOfPages.size() == 0)
281             return MSA_INVALID_PAGE_NO;
282
283         // find a non-empty unlocked page to swap, delete all empty pages from the stack
284                 std::list<unsigned int>::iterator i = stackOfPages.begin();
285         while(i != stackOfPages.end())
286         {
287             if(pageTable[*i] == NULL) i = stackOfPages.erase(i);
288             else if(!pageState[*i]->canPageOut()) i++;
289             else break;
290         }
291
292         if(i != stackOfPages.end())
293             return *i;
294         else
295             return MSA_INVALID_PAGE_NO;
296     }
297 };
298
299 /**
300   class vmNRUPageReplacementPolicy
301   This class provides the functionality of not-recently-used page replacement policy.
302   It needs to be notified when a page is accessed using the pageAccessed() function and
303   a page can be selected for replacement using the selectPage() function.
304   
305   "not-recently-used" could replace any page that has not been used in the 
306   last K accesses; that is, it's a memory-limited version of LRU.
307   
308   pageAccessed is O(1).
309   selectPage best-case is O(K) (if we immediately find a doomed page); 
310              worst-case is O(K n) (if there are no doomed pages).
311  */
312 template <class ENTRY_TYPE, unsigned int ENTRIES_PER_PAGE>
313 class vmNRUReplacementPolicy
314 {
315 protected:
316     unsigned int nPages;            // number of pages
317   const std::vector<ENTRY_TYPE *> &pageTable; // actual pages (NULL means page is gone)
318   typedef MSA_Page_StateT<ENTRY_TYPE, ENTRIES_PER_PAGE> pageState_t;
319   const std::vector<pageState_t *> &pageState;  // state of each page
320     enum {K=5}; // Number of distinct pages to remember
321     unsigned int last[K]; // pages that have been used recently
322     unsigned int Klast; // index into last array.
323     
324     unsigned int victim; // next page to throw out.
325     
326     bool recentlyUsed(unsigned int page) {
327         for (int k=0;k<K;k++) if (page==last[k]) return true;
328         return false;
329     }
330
331 public:
332   inline vmNRUReplacementPolicy(unsigned int nPages_, const std::vector<ENTRY_TYPE *> &pageTable_, const std::vector<pageState_t *> &pageState_)
333     : nPages(nPages_), pageTable(pageTable_), pageState(pageState_), Klast(0), victim(0)
334     {
335         for (int k=0;k<K;k++) last[k]=MSA_INVALID_PAGE_NO;
336     }
337
338     inline void pageAccessed(unsigned int page)
339     {
340         if (page!=last[Klast]) {
341             Klast++; if (Klast>=K) Klast=0;
342             last[Klast]=page;
343         }
344     }
345
346     inline unsigned int selectPage() {
347         unsigned int last_victim=victim;
348         do {
349             victim++; if (victim>=nPages) victim=0;
350             if (pageTable[victim]
351                 &&pageState[victim]->canPageOut()
352                 &&!recentlyUsed(victim)) {
353                 /* victim is an allocated, unlocked, non-recently-used page: page him out. */
354                 return victim;
355             }
356         } while (victim!=last_victim);
357         return MSA_INVALID_PAGE_NO;  /* nobody is pageable */
358     }
359 };
360
361 //================================================================
362
363 /**
364   UNUSED
365
366   Holds the untyped data for one MSA page.
367   This is the interface MSA_CacheGroup uses to access a cached page.
368   MSA_CacheGroup asks the templated code to create a MSA_Page
369   for each new page, then talks to the page directly.
370 */
371 class MSA_Page {
372 public:
373         virtual ~MSA_Page();
374
375         /**
376           Pack or unpack the data in this page.
377           Used to send and receive pages from the network
378           (or even disk, if somebody needs it.)
379         */
380         virtual void pup(PUP::er &p) =0;
381
382         /**
383           Merge this page's data into our own.
384           Only parts of this page may have been set.
385         */
386         virtual void merge(MSA_Page &otherPage) =0;
387 };
388
389 /**
390   Holds the typed data for one MSA page.
391   Implementation of puppedPage used by the templated code.
392 */
393 template <
394         class ENTRY, 
395         class MERGER=DefaultEntry<ENTRY>,
396         unsigned int ENTRIES_PER_PAGE=MSA_DEFAULT_ENTRIES_PER_PAGE
397 >
398 class MSA_PageT {
399     unsigned int n; // number of entries on this page.  Used to send page updates.
400         /** The contents of this page: array of ENTRIES_PER_PAGE items */
401         ENTRY *data;
402         /** Merger object */
403         MERGER m;
404   bool duplicate;
405
406 public:
407         MSA_PageT():duplicate(false), n(ENTRIES_PER_PAGE) {
408                 data=new ENTRY[ENTRIES_PER_PAGE];
409                 for (int i=0;i<ENTRIES_PER_PAGE;i++){
410                         data[i]=m.getIdentity();
411                 }
412                 //shouldn't n be set to ENTRIES_PER_PAGE
413                 n = ENTRIES_PER_PAGE;
414         }
415     // This constructor is used in PageArray to quickly convert an
416     // array of ENTRY into an MSA_PageT.  So we just make a copy of
417     // the pointer.  When it comes time to destruct the object, we
418     // need to ensure we do NOT delete the data but just discard the
419     // pointer.
420         MSA_PageT(ENTRY *d):data(d), duplicate(true), n(ENTRIES_PER_PAGE) {
421     }
422         MSA_PageT(ENTRY *d, unsigned int n_):data(d), duplicate(true), n(n_) {
423     }
424         virtual ~MSA_PageT() {
425                 if (!duplicate) {
426             delete [] data;
427         }
428         }
429
430         virtual void pup(PUP::er &p) {
431     p | n;
432                 /*this pup routine was broken, It didnt consider the case
433                         in which n > 0 and data = NULL. This is possible when  
434                         sending empty pages. It also doesnt seem to do any allocation
435                         for the data variable while unpacking which seems to be wrong
436                 */
437                 bool nulldata;
438                 if(!p.isUnpacking()){
439                                 nulldata = (data == NULL);
440                 }
441                 p | nulldata;
442                 if(nulldata){
443                                 data = NULL;
444                                 return;
445                 }
446                 if(p.isUnpacking()){
447                                 data = new ENTRY[n];
448                 }
449                 for (int i=0;i<n;i++){
450                         p|data[i];
451                 }       
452         }
453
454         virtual void merge(MSA_PageT<ENTRY, MERGER, ENTRIES_PER_PAGE> &otherPage) {
455                 for (int i=0;i<ENTRIES_PER_PAGE;i++)
456                         m.accumulate(data[i],otherPage.data[i]);
457         }
458
459         // These accessors might be used by the templated code.
460         inline ENTRY &operator[](int i) {return data[i];}
461         inline const ENTRY &operator[](int i) const {return data[i];}
462     inline ENTRY *getData() { return data; }
463 };
464
465 //=============================== Cache Manager =================================
466
467 template <class ENTRY_TYPE, class ENTRY_OPS_CLASS,unsigned int ENTRIES_PER_PAGE>
468 class MSA_CacheGroup : public Group
469 {
470     typedef MSA_PageT<ENTRY_TYPE, ENTRY_OPS_CLASS, ENTRIES_PER_PAGE> page_t;
471
472 protected:
473     ENTRY_OPS_CLASS *entryOpsObject;
474     unsigned int numberOfWorkerThreads;      // number of worker threads across all processors for this shared array
475     // @@ migration?
476     unsigned int numberLocalWorkerThreads;   // number of worker threads on THIS processor for this shared array
477     unsigned int enrollDoneq;                 // has enroll() been done on this processor?
478     MSA_Listeners enrollWaiters;
479     MSA_Listeners syncWaiters;
480     std::set<int> enrolledPEs;                          // which PEs are involved?
481
482     unsigned int nPages;            ///< number of pages
483   std::vector<ENTRY_TYPE*> pageTable;          ///< the page table for this PE: stores actual data.
484     typedef MSA_Page_StateT<ENTRY_TYPE,ENTRIES_PER_PAGE> pageState_t;
485   std::vector<pageState_t *> pageStateStorage; ///< Housekeeping information for each allocated page.
486     
487     /// Return the state for this page, returning NULL if no state available.
488     inline pageState_t *stateN(unsigned int pageNo) {
489         return pageStateStorage[pageNo];
490     }
491     
492     /// Return the state for this page, allocating if needed.
493     pageState_t *state(unsigned int pageNo) {
494         pageState_t *ret=pageStateStorage[pageNo];
495         if (ret==NULL) {
496             ret=new pageState_t;
497             pageStateStorage[pageNo]=ret;
498         }
499         return ret;
500     }
501
502     typedef CProxy_MSA_PageArray<ENTRY_TYPE, ENTRY_OPS_CLASS, ENTRIES_PER_PAGE> CProxy_PageArray_t;
503     CProxy_PageArray_t pageArray;     // a proxy to the page array
504     typedef CProxy_MSA_CacheGroup<ENTRY_TYPE, ENTRY_OPS_CLASS, ENTRIES_PER_PAGE> CProxy_CacheGroup_t;
505     CProxy_CacheGroup_t thisProxy; // a proxy to myself.
506
507     std::map<CthThread, MSA_Thread_Listener *> threadList;
508     /// Look up or create the listener for the current thread.
509     MSA_Thread_Listener *getListener(void) {
510         CthThread t=CthSelf();
511         MSA_Thread_Listener *l=threadList[t];
512                         if (l==NULL) {
513                 l=new MSA_Thread_Listener;
514                 threadList[t]=l;
515                         }
516                         return l;
517     }
518     /// Add our thread to this list and suspend
519     void addAndSuspend(MSA_Listeners &dest) {
520         MSA_Thread_Listener *l=getListener();
521                         dest.add(l);
522                         l->suspend();
523     }
524
525     std::stack<ENTRY_TYPE*> pagePool;     // a pool of unused pages
526     
527   typedef vmNRUReplacementPolicy<ENTRY_TYPE, ENTRIES_PER_PAGE> vmPageReplacementPolicy;
528     vmPageReplacementPolicy* replacementPolicy;
529
530     // structure for the bounds of a single write
531     typedef struct { unsigned int begin; unsigned int end; } writebounds_t;
532
533     // a list of write bounds associated with a given page
534     typedef std::list<writebounds_t> writelist_t;
535
536     writelist_t** writes;           // the write lists for each page
537
538     unsigned int resident_pages;             // pages currently allocated
539     unsigned int max_resident_pages;         // max allowable pages to allocate
540     unsigned int nEntries;          // number of entries for this array
541     unsigned int syncAckCount;      // number of sync ack's we received
542     int outOfBufferInPrefetch;      // flag to indicate if the last prefetch ran out of buffers
543
544     int syncThreadCount;            // number of local threads that have issued Sync
545     
546     
547     // used during output
548     MSA_WriteSpan_t writeSpans[ENTRIES_PER_PAGE];
549     ENTRY_TYPE writeEntries[ENTRIES_PER_PAGE];
550
551     /*********************************************************************************/
552     /** these routines deal with managing the page queue **/
553
554     // increment the number of pages the thread is waiting on.
555     // also add thread to the page queue; then thread is woken when the page arrives.
556     inline void IncrementPagesWaiting(unsigned int page)
557     {
558         state(page)->readRequests.add(getListener());
559     }
560
561     inline void IncrementChangesWaiting(unsigned int page)
562     {
563         state(page)->writeRequests.add(getListener());
564     }
565
566 /************************* Page allocation and management **************************/
567     
568     /// Allocate a new page, removing old pages if we're over the limit.
569     /// Returns NULL if no buffer space is available
570     inline ENTRY_TYPE* tryBuffer(int async=0) // @@@
571     {
572         ENTRY_TYPE* nu = NULL;
573
574         // first try the page pool
575         if(!pagePool.empty())
576         {
577             nu = pagePool.top();
578             pagePool.pop();
579         }
580
581         // else try to allocate the buffer
582         if(nu == NULL && resident_pages < max_resident_pages)
583         {
584             nu = new ENTRY_TYPE[ENTRIES_PER_PAGE];
585             resident_pages++;
586         }
587
588         // else swap out one of the pages
589         if(nu == NULL)
590         {
591             int pageToSwap = replacementPolicy->selectPage();
592             if(pageToSwap != MSA_INVALID_PAGE_NO)
593             {
594                 CkAssert(pageTable[pageToSwap] != NULL);
595                 CkAssert(state(pageToSwap)->canPageOut() == true);
596                 
597                 relocatePage(pageToSwap, async);
598                 nu = pageTable[pageToSwap];
599                 pageTable[pageToSwap] = 0;
600                 delete pageStateStorage[pageToSwap];
601                 pageStateStorage[pageToSwap]=0;
602             }
603         }
604
605         // otherwise return NULL
606
607         return nu;
608     }
609     
610     /// Allocate storage for this page, if none has been allocated already.
611     ///  Update pageTable, and return the storage for the page.
612     inline ENTRY_TYPE* makePage(unsigned int page) // @@@
613     {
614         ENTRY_TYPE* nu=pageTable[page];
615         if (nu==0) {
616             nu=tryBuffer();
617             if (nu==0) CkAbort("MSA: No available space to create pages.\n");
618             pageTable[page]=nu;
619         }
620         return nu;
621     }
622     
623     /// Throw away this allocated page.
624     ///  Returns the page itself, for deletion or recycling.
625     ENTRY_TYPE* destroyPage(unsigned int page)
626     {
627         ENTRY_TYPE* nu=pageTable[page];
628         pageTable[page] = 0;
629         if (pageStateStorage[page]->canDelete()) {
630                 delete pageStateStorage[page];
631                 pageStateStorage[page]=0;
632         }
633         resident_pages--;
634         return nu;
635     }
636     
637     //MSA_CacheGroup::
638     void pageFault(unsigned int page, MSA_Page_Fault_t why)
639     {
640         // Write the page to the page table
641         state(page)->state = why;
642         if(why == Read_Fault)
643         { // Issue a remote request to fetch the new page
644             // If the page has not been requested already, then request it.
645             if (stateN(page)->readRequests.size()==0) {
646                 pageArray[page].GetPage(CkMyPe());
647                 //ckout << "Requesting page first time"<< endl;
648             } else {
649                 ;//ckout << "Requesting page next time.  Skipping request."<< endl;
650             }
651             MSA_Thread_Listener *l=getListener();
652             stateN(page)->readRequests.add(l);
653             l->suspend(); // Suspend until page arrives.
654         }
655         else {
656             // Build an empty buffer into which to create the new page
657             ENTRY_TYPE* nu = makePage(page);
658             writeIdentity(nu);
659         }
660     }
661     
662     /// Make sure this page is accessible, faulting the page in if needed.
663     // MSA_CacheGroup::
664     inline void accessPage(unsigned int page,MSA_Page_Fault_t access)
665     {
666         if (pageTable[page] == 0) {
667 //             ckout << "p" << CkMyPe() << ": Calling pageFault" << endl;
668             pageFault(page, access);
669         }
670 #ifndef CMK_OPTIMIZE
671         if (stateN(page)->state!=access) {
672             CkPrintf("page=%d mode=%d pagestate=%d", page, access, stateN(page)->state);
673             CkAbort("MSA Runtime error: Attempting to access a page that is still in another mode.");
674         }
675 #endif
676         replacementPolicy->pageAccessed(page);
677     }
678
679     // MSA_CacheGroup::
680     // Fill this page with identity values, to prepare for writes or 
681     //  accumulates.
682     void writeIdentity(ENTRY_TYPE* pagePtr)
683     {
684         for(unsigned int i = 0; i < ENTRIES_PER_PAGE; i++)
685             pagePtr[i] = entryOpsObject->getIdentity();
686     }
687     
688 /************* Page Flush and Writeback *********************/
689     bool shouldWriteback(unsigned int page) {
690         if (!pageTable[page]) return false;
691         return (stateN(page)->state == Write_Fault || stateN(page)->state == Accumulate_Fault);
692     }
693     
694     inline void relocatePage(unsigned int page, int async)
695     {
696         //CkAssert(pageTable[page]);
697         if(shouldWriteback(page))
698         {
699             // the page to be swapped is a writeable page. So inform any
700             // changes this node has made to the page manager
701             sendChangesToPageArray(page, async);
702         }
703     }
704
705     inline void sendChangesToPageArray(const unsigned int page, const int async)
706     {
707         sendRLEChangesToPageArray(page);
708         
709         MSA_Thread_Listener *l=getListener();
710         state(page)->writeRequests.add(l);
711         if (!async)
712             l->suspend(); // Suspend until page is really gone.
713         // TODO: Are write acknowledgements really necessary ?
714     }
715
716     // Send the page data as a contiguous block.
717     //   Note that this is INCORRECT when writes to pages overlap!
718     inline void sendNonRLEChangesToPageArray(const unsigned int page) // @@@
719     {
720         pageArray[page].PAReceivePage(pageTable[page], ENTRIES_PER_PAGE, CkMyPe(), stateN(page)->state);
721     }
722     
723     // Send the page data as an RLE block.
724     // this function assumes that there are no overlapping writes in the list
725     inline void sendRLEChangesToPageArray(const unsigned int page)
726     {
727         ENTRY_TYPE *writePage=pageTable[page];
728         int nSpans=stateN(page)->writeSpans(writeSpans);
729         if (nSpans==1) 
730         { /* common case: can make very fast */
731             int nEntries=writeSpans[0].end-writeSpans[0].start;
732             if (entryOpsObject->pupEveryElement()) {
733                 pageArray[page].PAReceiveRLEPageWithPup(writeSpans,nSpans,
734                     page_t(&writePage[writeSpans[0].start],nEntries),nEntries,
735                     CkMyPe(),stateN(page)->state);
736             } else {
737                 pageArray[page].PAReceiveRLEPage(writeSpans,nSpans,
738                     &writePage[writeSpans[0].start], nEntries,
739                     CkMyPe(),stateN(page)->state);
740             }
741         } 
742         else /* nSpans>1 */ 
743         { /* must copy separate spans into a single output buffer (luckily rare) */
744             int nEntries=0;
745             for (int s=0;s<nSpans;s++) {
746                 for (int i=writeSpans[s].start;i<writeSpans[s].end;i++)
747                     writeEntries[nEntries++]=writePage[i]; // calls assign
748             }
749             if (entryOpsObject->pupEveryElement()) {
750                 pageArray[page].PAReceiveRLEPageWithPup(writeSpans,nSpans,
751                                                         page_t(writeEntries,nEntries),nEntries,
752                                                         CkMyPe(),stateN(page)->state);
753             } else {
754                 pageArray[page].PAReceiveRLEPage(writeSpans,nSpans,
755                                                writeEntries,nEntries,
756                                                CkMyPe(),stateN(page)->state);
757             }
758         }
759     }
760
761 /*********************** Public Interface **********************/
762 public:
763     // 
764     //
765     // MSA_CacheGroup::
766   inline MSA_CacheGroup(unsigned int nPages_, CkArrayID pageArrayID,
767                                                 unsigned int max_bytes_, unsigned int nEntries_, 
768                                                 unsigned int numberOfWorkerThreads_)
769         : numberOfWorkerThreads(numberOfWorkerThreads_),
770           nPages(nPages_),
771           nEntries(nEntries_), 
772           pageTable(nPages, NULL),
773           pageStateStorage(nPages, NULL),
774           pageArray(pageArrayID),
775           thisProxy(thisgroup),
776           max_resident_pages(max_bytes_/(sizeof(ENTRY_TYPE)*ENTRIES_PER_PAGE)),
777           entryOpsObject(new ENTRY_OPS_CLASS),
778           replacementPolicy(new vmPageReplacementPolicy(nPages, pageTable, pageStateStorage)),
779           outOfBufferInPrefetch(0), syncAckCount(0),syncThreadCount(0),
780           resident_pages(0),numberLocalWorkerThreads(0), enrollDoneq(0)
781   {
782         MSADEBPRINT(printf("MSA_CacheGroup nEntries %d \n",nEntries););
783   }
784
785     // MSA_CacheGroup::
786     inline ~MSA_CacheGroup()
787     {
788         FreeMem();
789     }
790
791     /* To change the accumulate function TBD @@ race conditions */
792     inline void changeEntryOpsObject(ENTRY_OPS_CLASS *e) {
793         entryOpsObject = e;
794         pageArray.changeEntryOpsObject(e);
795     }
796
797     // MSA_CacheGroup::
798     inline const ENTRY_TYPE* readablePage(unsigned int page)
799     {
800         accessPage(page,Read_Fault);
801         
802         return pageTable[page];
803     }
804
805     // MSA_CacheGroup::
806     //
807     // known local page
808     inline const void* readablePage2(unsigned int page)
809     {
810         return pageTable[page];
811     }
812
813     // MSA_CacheGroup::
814     // Obtains a writable copy of the page.
815     inline ENTRY_TYPE* writeablePage(unsigned int page, unsigned int offset)
816     {
817         accessPage(page,Write_Fault);
818
819         // NOTE: Since we assume write once semantics, i.e. between two calls to sync,
820         // either there can be no write to a location or a single write to a location,
821         // a readable page will suffice as a writeable page too, because no one else
822         // is going to write to this location. In reality, two locations on the *same*
823         // page can be written by two different threads, in which case we will need
824         // to keep track of which parts of the page have been written, hence:
825         stateN(page)->write(offset);
826 //     ckout << "write:" << page*ENTRIES_PER_PAGE+offset << endl;
827         
828         return pageTable[page];
829     }
830
831     // MSA_CacheGroup::
832     inline ENTRY_TYPE &accumulate(unsigned int page, unsigned int offset)
833     {
834         accessPage(page,Accumulate_Fault);
835         stateN(page)->write(offset);
836         return pageTable[page][offset];
837     }
838
839     /// A requested page has arrived from the network.
840     ///  nEntriesInPage_ = num entries being sent (0 for empty page, num entries otherwise)
841     inline void ReceivePageWithPUP(unsigned int page, page_t &pageData, int size)
842     {
843         ReceivePage(page, pageData.getData(), size);
844     }
845
846     inline void ReceivePage(unsigned int page, ENTRY_TYPE* pageData, int size)
847     {
848         CkAssert(0==size || ENTRIES_PER_PAGE == size);
849         // the page we requested has been received
850         ENTRY_TYPE *nu=makePage(page);
851         if(size!=0)
852         {
853             for(unsigned int i = 0; i < size; i++)
854                 nu[i] = pageData[i]; // @@@, calls assignment operator
855         }
856         else /* isEmpty */
857         {
858             // the page we requested for is empty, so we can just initialize it.
859             writeIdentity(nu);
860         }
861         
862         state(page)->readRequests.signal(page);
863     }
864
865     // This EP is invoked during sync to acknowledge that a dirty page
866     // has been received and written back to the page owner.  We keep track
867     // of the number of ack's yet to arrive in nChangesWaiting.  Once
868     // all the dirty pages have been ack'd, we awaken the thread that
869     // flushed the page.
870     //
871     // It's not clear this is useful very often...
872     //
873     // MSA_CacheGroup::
874     inline void AckPage(unsigned int page)
875     {
876         state(page)->writeRequests.signal(page);
877     }
878
879     // MSA_CacheGroup::
880     // synchronize all the pages and also clear up the cache
881     inline void SyncReq(int single)
882     {
883           MSADEBPRINT(printf("SyncReq single %d\n",single););
884           if(single)
885         {
886             /*ask all the caches to send their updates to the page array, but we don't need to empty the caches on the other PEs*/
887             SingleSync();
888             EmptyCache();
889
890             getListener()->suspend();
891         }
892         else{
893             Sync();
894                                 }
895     }
896
897     // MSA_CacheGroup::
898     inline void FlushCache()
899     {
900         // flush the local cache
901         // for each writeable page, send that page to the array element
902         for(unsigned int i = 0; i < nPages; i++)
903         {
904             if(shouldWriteback(i)) {
905                 //ckout << "p" << CkMyPe() << "FlushCache: sending page " << i << endl;
906                 sendChangesToPageArray(i, 1);
907             }
908         }
909     }
910
911     // MSA_CacheGroup::
912     void EmptyCache()
913     {
914         /* just makes all the pages empty, assuming that the data in those pages has been flushed to the owners */
915         for(unsigned int i = 0; i < nPages; i++)
916         {
917             if(pageTable[i]) pagePool.push(destroyPage(i));
918         }
919     }
920
921 /************************ Enroll ********************/
922     /// Enroll phase 1: called by users.
923     // MSA_CacheGroup::
924     inline void enroll(unsigned int num_workers)
925     {
926         CkAssert(num_workers == numberOfWorkerThreads); // just to verify
927         CkAssert(enrollDoneq == 0);
928         numberLocalWorkerThreads++;
929         // @@ how to ensure that enroll is called only once?
930
931         //ckout << "[" << CkMyPe() << "] sending sync ack to PE 0" << endl;
932         thisProxy[0].enrollAck(CkMyPe());
933         //ckout << "[" << CkMyPe() << "] suspening thread in Sync() " << endl;
934         addAndSuspend(enrollWaiters);
935         //ckout << "[" << CkMyPe() << "] rsuming thread in Sync()" << endl;
936
937         CkAssert(enrollDoneq == 1);
938         return;
939     }
940
941     /// Enroll phase 2: called on PE 0 from everywhere
942     inline void enrollAck(int originator)
943     {
944         CkAssert(CkMyPe() == 0);  // enrollAck is only called on PE 0
945         CkAssert(enrollDoneq == 0);  // prevent multiple enroll operations
946         
947         syncAckCount++;
948         enrolledPEs.insert(originator);
949         //ckout << "[" << CkMyPe() << "] SyncAckcount = " << syncAckCount << endl;
950         if(syncAckCount == numberOfWorkerThreads) {
951 //             ckout << "[" << CkMyPe() << "]" << "Enroll operation is almost done" << endl;
952             syncAckCount = 0;
953             enrollDoneq = 1;
954             // What if fewer worker threads than pe's ?  Handled in
955             // enrollDone.
956             thisProxy.enrollDone();
957         }
958     }
959
960     /// Enroll phase 3: called everywhere by PE 0
961     inline void enrollDone()
962     {
963 //         ckout << "[" << CkMyPe() << "] enrollDone.  Waking threads."
964 //               <<  " numberOfWorkerThreads=" << numberOfWorkerThreads
965 //               <<  " local=" << numberLocalWorkerThreads << endl;
966         enrollDoneq = 1;
967         enrollWaiters.signal(0);
968     }
969
970 /******************************** Sync & writeback ***********************/
971     // MSA_CacheGroup::
972     inline void SingleSync()
973     {
974         /* a single thread issued a sync call with all = 1. The first thing to do is to flush the local cache */
975         FlushCache();
976     }
977
978     // MSA_CacheGroup::
979     inline void Sync()
980     {
981         syncThreadCount++;
982         //ckout << "[" << CkMyPe() << "] syncThreadCount = " << syncThreadCount << " " << numberLocalWorkerThreads << endl;
983         //ckout << "[" << CkMyPe() << "] syncThreadCount = " << syncThreadCount << ", registered threads = " << getNumRegisteredThreads()
984                 //  << ", number of suspended threads = " << getNumSuspendedThreads() << endl;
985
986         // First, all threads on this processor need to reach the sync
987         // call; only then can we proceed with merging the data.  Only
988         // the last thread on this processor needs to do the FlushCache,
989         // etc.  Others just suspend until the sync is over.
990                                 MSADEBPRINT(printf("Sync syncThreadCount %d \n",syncThreadCount););
991         if(syncThreadCount < numberLocalWorkerThreads)
992         {
993                   MSADEBPRINT(printf("Sync addAndSuspend \n"););
994             addAndSuspend(syncWaiters);
995             return;
996         }
997                 
998         //ckout << "[" << CkMyPe() << "] Sync started" << endl;
999
1000         // flush the cache asynchronously and also empty it
1001         FlushCache();
1002         // idea: instead of invalidating the pages, switch it to read
1003         // mode. That will not work, since the page may have also been
1004         // modified by another thread.
1005         EmptyCache();
1006
1007         // Now, we suspend too (if we had at least one dirty page).
1008         // We will be awoken when all our dirty pages have been
1009         // written and acknowledged.
1010                 MSADEBPRINT(printf("Sync calling suspend on getListener\n"););
1011         getListener()->suspend();
1012                 MSADEBPRINT(printf("Sync awakening after suspend\n"););
1013
1014         // So far, the sync has been asynchronous, i.e. PE0 might be ahead
1015         // of PE1.  Next we basically do a barrier to ensure that all PE's
1016         // are synchronized.
1017
1018         // at this point, the sync's across the group should
1019         // synchronize among themselves by each one sending
1020         // a sync acknowledge message to PE 0. (this is like
1021         // a reduction over a group)
1022         if(CkMyPe() != 0)
1023         {
1024             thisProxy[0].SyncAck();
1025         }
1026         else /* I *am* PE 0 */
1027         {
1028             SyncAck();
1029         }
1030                                 MSADEBPRINT(printf("Sync all local threads done, going to addAndSuspend\n"););
1031         /* Wait until sync is reflected from PE 0 */
1032         addAndSuspend(syncWaiters);
1033                                 
1034                 MSADEBPRINT(printf("Sync all local threads done waking up after addAndSuspend\n"););
1035                 //ckout << "[" << CkMyPe() << "] Sync finished" << endl;        
1036     }
1037
1038     inline unsigned int getNumEntries() { return nEntries; }
1039     inline CProxy_PageArray_t getArray() { return pageArray; }
1040
1041     // TODO: Can this SyncAck and other simple Acks be made efficient?
1042     inline void SyncAck()
1043     {
1044         CkAssert(CkMyPe() == 0);  // SyncAck is only called on PE 0
1045         syncAckCount++;
1046         // DONE @@ what if fewer worker threads than pe's ?
1047         // @@ what if fewer worker threads than pe's and >1 threads on 1 pe?
1048         //if(syncAckCount == min(numberOfWorkerThreads, CkNumPes())){
1049                 if (syncAckCount == enrolledPEs.size()) {
1050                         MSADEBPRINT(printf("SyncAck starting reduction on pageArray of size %d number of pages %d\n",nEntries,nPages););
1051                         pageArray.Sync();
1052                 }               
1053     }
1054
1055     inline void SyncDone()
1056     {
1057         //ckout << "[" << CkMyPe() << "] Sync Done indication" << endl;
1058         //ckout << "[" << CkMyPe() << "] Sync Done indication" << endl;
1059         /* Reset for next sync */
1060         syncThreadCount = 0;
1061         syncAckCount = 0;
1062                                 MSADEBPRINT(printf("SyncDone syncWaiters signal to be called\n"););
1063         syncWaiters.signal(0);
1064     }
1065
1066     inline void FreeMem()
1067     {
1068         for(unsigned int i = 0; i < nPages; i++)
1069         {
1070             if(pageTable[i]) delete [] destroyPage(i);
1071         }
1072
1073         while(!pagePool.empty())
1074         {
1075             delete [] pagePool.top();  // @@@
1076             pagePool.pop();
1077         }
1078         
1079         resident_pages=0;
1080     }
1081
1082                 /** 
1083                         Deregister a client. Decremenet the number of local threads. If total number of local threads 
1084                         hits 0 FreeMem()
1085                 */
1086                 inline void unroll(){
1087         numberLocalWorkerThreads--;
1088                                 if(numberLocalWorkerThreads == 0){
1089                                         FreeMem();
1090                                 }
1091                 }
1092
1093     /**
1094      * Issue a prefetch request for the given range of pages. These pages will
1095      * be locked into the cache, so that they will not be swapped out.
1096      */
1097     inline void Prefetch(unsigned int pageStart, unsigned int pageEnd)
1098     {
1099         /* prefetching is feasible only if we we did not encounter an out
1100          * of buffer condition in the previous prefetch call
1101          */
1102         if(!outOfBufferInPrefetch)
1103         {
1104             //ckout << "prefetching pages " << pageStart << " through " << pageEnd << endl;
1105             for(unsigned int p = pageStart; p <= pageEnd; p++)
1106             {
1107                 if(NULL == pageTable[p])
1108                 {
1109
1110                     /* relocate the buffer asynchronously */
1111                     ENTRY_TYPE* nu = tryBuffer(1);
1112                     if(NULL == nu)
1113                     {
1114                         /* signal that sufficient buffer space is not available */
1115                         outOfBufferInPrefetch = 1;
1116                         break;
1117                     }
1118
1119                     pageTable[p] = nu;
1120                     state(p)->state = Read_Fault;
1121
1122                     pageArray[p].GetPage(CkMyPe());
1123                     IncrementPagesWaiting(p);
1124                     //ckout << "Prefetch page" << p << ", pages waiting = " << nPagesWaiting << endl;
1125                     /* don't suspend the thread */
1126                 }
1127
1128                 /* mark the page as being locked */
1129                 state(p)->locked = true;
1130             }
1131         }
1132     }
1133
1134     /**
1135      * Wait for all the prefetch pages to be fetched into the cache.
1136      * Returns: 0 if prefetch successful, 1 if not
1137      */
1138     inline int WaitAll(void)
1139     {
1140         if(outOfBufferInPrefetch)
1141         {
1142             // we encountered out of buffer in the previous prefetch call, return error
1143             outOfBufferInPrefetch = 0;
1144             getListener()->suspend();
1145             UnlockPages();
1146             return 1;
1147         }
1148         else
1149         {
1150             // prefetch requests have been successfully issued already, so suspend the
1151             // thread and wait for completion
1152             outOfBufferInPrefetch = 0;
1153             getListener()->suspend();
1154             return 0;
1155         }
1156     }
1157     
1158     inline void UnlockPage(unsigned int page) {
1159         pageState_t *s=stateN(page);
1160         if(s && s->locked) {
1161             replacementPolicy->pageAccessed(page);
1162             s->locked = false;
1163         }
1164     }
1165
1166     /**
1167      * Unlock all the pages locked in the cache
1168      */
1169     inline void UnlockPages()
1170     {
1171         // add all the locked pages to page replacement policy
1172         for(unsigned int page = 0; page < nPages; page++)
1173             UnlockPage(page);
1174     }
1175
1176     /**
1177      * Unlock the given pages: [startPage ... endPage]
1178      *  Note that the range is inclusive.
1179      */
1180     inline void UnlockPages(unsigned int startPage, unsigned int endPage)
1181     {
1182         for(unsigned int page = startPage; page <= endPage; page++)
1183             UnlockPage(page);
1184     }
1185
1186     /// Debugging routine
1187     inline void emitBufferValue(int ID, unsigned int pageNum, unsigned int offset)
1188     {
1189         CkAssert( pageNum < nPages );
1190         CkAssert( offset < ENTRIES_PER_PAGE );
1191
1192         //ckout << "p" << CkMyPe() << "ID" << ID;
1193 //         if (pageTable[pageNum] == 0)
1194 //             ckout << "emitBufferValue: page " << pageNum << " not available in local cache." << endl;
1195 //         else
1196 //             ckout << "emitBufferValue: [" << pageNum << "," << offset << "] = " << pageTable[pageNum][offset] << endl;
1197     }
1198 };
1199
1200 // each element of this array is responsible for managing
1201 // the information about a single page. It is in effect the
1202 // "owner" as well as the "manager" for that page.
1203 //
1204 template<class ENTRY_TYPE, class ENTRY_OPS_CLASS,unsigned int ENTRIES_PER_PAGE> 
1205 class MSA_PageArray : public ArrayElement1D
1206 {
1207     typedef CProxy_MSA_CacheGroup<ENTRY_TYPE, ENTRY_OPS_CLASS, ENTRIES_PER_PAGE> CProxy_CacheGroup_t;
1208     typedef MSA_PageT<ENTRY_TYPE, ENTRY_OPS_CLASS, ENTRIES_PER_PAGE> page_t;
1209     
1210 protected:
1211     ENTRY_TYPE *epage;
1212     ENTRY_OPS_CLASS entryOpsObject;
1213     CProxy_CacheGroup_t cache;
1214
1215     unsigned int pageNo() { return thisIndex; }
1216
1217     inline void allocatePage(MSA_Page_Fault_t access) // @@@
1218     {
1219         if(epage == NULL)
1220         {
1221             epage = new ENTRY_TYPE[ENTRIES_PER_PAGE];
1222             if (access==Accumulate_Fault)
1223                writeIdentity();
1224         }
1225     }
1226
1227     // begin and end are indexes into the page.
1228     inline void set(const ENTRY_TYPE* buffer, unsigned int begin, unsigned int end)
1229     {
1230         //ckout << "set: " << begin << "," << end << endl;
1231         for(unsigned int i = 0; i < (end - begin); i++) {
1232             epage[begin + i] = buffer[i]; // @@@, calls assignment operator
1233             //ckout << "set val[" << begin+i << "]=" << buffer[i] << endl;
1234         }
1235     }
1236
1237     // MSA_PageArray::
1238     inline void combine(const ENTRY_TYPE* buffer, unsigned int begin, unsigned int end)
1239     {
1240         ENTRY_TYPE* pagePtr = epage + begin;
1241         for(unsigned int i = 0; i < (end - begin); i++)
1242             entryOpsObject.accumulate(pagePtr[i], buffer[i]);
1243     }
1244
1245     // MSA_PageArray::
1246     inline void writeIdentity()
1247     {
1248         for(unsigned int i = 0; i < ENTRIES_PER_PAGE; i++)
1249             epage[i] = entryOpsObject.getIdentity();
1250     }
1251
1252 public:
1253     inline MSA_PageArray() : epage(NULL) { }
1254     inline MSA_PageArray(CkMigrateMessage* m) { delete m; }
1255     
1256     void setCacheProxy(CProxy_CacheGroup_t &cache_)
1257     {
1258        cache=cache_;
1259     }
1260     
1261     virtual void pup(PUP::er& p)
1262     {
1263         ArrayElement1D::pup(p);
1264         int epage_present=(epage!=0);
1265         p|epage_present;
1266         if (epage_present) {
1267           if(p.isUnpacking())
1268             allocatePage(Write_Fault);
1269           for (int i=0;i<ENTRIES_PER_PAGE;i++)
1270             p|epage[i];
1271         }
1272     }
1273     
1274     inline ~MSA_PageArray()
1275     {
1276         if(epage) delete [] epage;
1277     }
1278
1279     /// Request our page.
1280     ///   pe = to which to send page
1281     inline void GetPage(int pe)
1282     {
1283         if(epage == NULL) {
1284             // send empty page
1285             if (entryOpsObject.pupEveryElement())
1286                 cache[pe].ReceivePageWithPUP(pageNo(), page_t((ENTRY_TYPE*)NULL), 0);
1287             else
1288                 cache[pe].ReceivePage(pageNo(), (ENTRY_TYPE*)NULL, 0);
1289         } else {
1290             // send page with data
1291             if (entryOpsObject.pupEveryElement())
1292                 cache[pe].ReceivePageWithPUP(pageNo(), page_t(epage), ENTRIES_PER_PAGE);
1293             else
1294                 cache[pe].ReceivePage(pageNo(), epage, ENTRIES_PER_PAGE);  // send page with data                
1295         }
1296     }
1297
1298     /// Receive a non-runlength encoded page from the network:
1299     // @@ TBD: ERROR: This does not work for  varsize pages.
1300     inline void PAReceivePage(ENTRY_TYPE *pageData,
1301                             int pe, MSA_Page_Fault_t pageState)
1302     {
1303         allocatePage(pageState);
1304
1305         if(pageState == Write_Fault)
1306             set(pageData, 0, ENTRIES_PER_PAGE);
1307         else
1308             combine(pageData, 0, ENTRIES_PER_PAGE);
1309         
1310         // send the acknowledgement to the sender that we received the page
1311         //ckout << "Sending Ack to PE " << pe << endl;
1312         cache[pe].AckPage(thisIndex);
1313     }
1314
1315     /// Receive a runlength encoded page from the network:
1316     inline void PAReceiveRLEPageWithPup(
1317         const MSA_WriteSpan_t *spans, unsigned int nSpans, 
1318         MSA_PageT<ENTRY_TYPE, ENTRY_OPS_CLASS, ENTRIES_PER_PAGE> &entries, unsigned int nEntries, 
1319         int pe, MSA_Page_Fault_t pageState)
1320     {
1321         PAReceiveRLEPage(spans, nSpans, entries.getData(), nEntries, pe, pageState);
1322     }
1323
1324
1325     inline void PAReceiveRLEPage(
1326         const MSA_WriteSpan_t *spans, unsigned int nSpans, 
1327         const ENTRY_TYPE *entries, unsigned int nEntries, 
1328         int pe, MSA_Page_Fault_t pageState)
1329     {
1330         allocatePage(pageState);
1331         
1332         //ckout << "p" << CkMyPe() << "ReceiveRLEPage nSpans=" << nSpans << " nEntries=" << nEntries << endl;
1333         int e=0; /* consumed entries */
1334         for (int s=0;s<nSpans;s++) {
1335             if(pageState == Write_Fault)
1336                 set(&entries[e], spans[s].start,spans[s].end);
1337             else /* Accumulate_Fault */
1338                 combine(&entries[e], spans[s].start,spans[s].end);
1339             e+=spans[s].end-spans[s].start;
1340         } 
1341
1342         // send the acknowledgement to the sender that we received the page
1343         //ckout << "Sending AckRLE to PE " << pe << endl;
1344         cache[pe].AckPage(thisIndex);
1345     }
1346
1347     // MSA_PageArray::
1348     inline void Sync()
1349     {
1350                                 MSADEBPRINT(printf("MSA_PageArray::Sync about to call contribute \n");); 
1351         contribute(0, NULL, CkReduction::concat);
1352     }
1353
1354     inline void emit(int ID, int index)
1355     {
1356           //ckout << "p" << CkMyPe() << "ID" << ID;
1357 //         if(epage == NULL)
1358 //             ckout << "emit: epage is NULL" << endl;
1359 //         else
1360 //             ckout << "emit: " << epage[index] << endl;
1361     }
1362 };
1363
1364 #define CK_TEMPLATES_ONLY
1365 #include "msa.def.h"
1366 #undef CK_TEMPLATES_ONLY
1367
1368 #endif