Added the initial support of using pthreads for parallelization (a special SMP mode...
[charm.git] / NodeHelper.h
1 #ifndef _NODEHELPER_H
2 #define _NODEHELPER_H
3 #include <assert.h>
4
5 #include "charm++.h"
6 #include "NodeHelperAPI.h"
7
8 #define USE_TREE_BROADCAST_THRESHOLD 8
9 #define TREE_BCAST_BRANCH (4)
10 #define CACHE_LINE_SIZE 64
11
12 class FuncSingleHelper;
13
14 class CurLoopInfo{
15     friend class FuncSingleHelper;
16     
17 private:
18     volatile int curChunkIdx;
19     int numChunks;
20     HelperFn fnPtr;
21     int lowerIndex;
22     int upperIndex;
23     int paramNum;
24     void *param;
25     //limitation: only allow single variable reduction of size numChunks!!!
26     void **redBufs;
27         char *bufSpace;
28
29     volatile int finishFlag;
30     
31     //a tag to indicate whether the task for this new loop has been inited
32     //this tag is needed to prevent other helpers to run the old task
33     int inited;
34     
35 public:    
36     CurLoopInfo(int maxChunks):numChunks(0),fnPtr(NULL), lowerIndex(-1), upperIndex(0), 
37     paramNum(0), param(NULL), curChunkIdx(-1), finishFlag(0), redBufs(NULL), bufSpace(NULL), inited(0) 
38         {
39                 redBufs = new void *[maxChunks];
40                 bufSpace = new char[maxChunks * CACHE_LINE_SIZE];
41         for(int i=0; i<maxChunks; i++) redBufs[i] = (void *)(bufSpace+i*CACHE_LINE_SIZE);
42         }
43     
44     ~CurLoopInfo() { 
45                 delete [] redBufs; 
46                 delete [] bufSpace;
47         }
48     
49     void set(int nc, HelperFn f, int lIdx, int uIdx, int numParams, void *p){        /*
50       * WARNING: there's a rare data-racing case here. The current loop is
51       * about to finish (just before setting inited to 0; A helper (say B) 
52       * just enters the stealWork and passes the inited check. The helper 
53       * (say A) is very fast, and starts the next loop, and happens enter
54       * into the middle of this function. Then helper B will face corrupted
55       * task info as it is trying to execute the old loop task!
56       * In reality for user cases, this case happens very rarely!! -Chao Mei
57       */
58         numChunks = nc;
59         fnPtr = f;
60         lowerIndex = lIdx;
61         upperIndex = uIdx;
62         paramNum = numParams;
63         param = p;
64         curChunkIdx = -1;
65         finishFlag = 0;
66         //needs to be set last
67         inited = 1;
68     }
69       
70     void waitLoopDone(int sync){
71         //while(!__sync_bool_compare_and_swap(&finishFlag, numChunks, 0));
72         if(sync) while(finishFlag!=numChunks);
73         //finishFlag = 0;
74         inited = 0;
75     }
76     int getNextChunkIdx(){
77         return __sync_add_and_fetch(&curChunkIdx, 1);
78     }
79     void reportFinished(int counter){
80         if(counter==0) return;
81         __sync_add_and_fetch(&finishFlag, counter);
82     }
83     
84     int isFree() { return finishFlag == numChunks; }
85     
86         void **getRedBufs() { return redBufs; }
87         
88     void stealWork();
89 };
90
91 /* FuncNodeHelper is a nodegroup object */
92
93 typedef struct converseNotifyMsg{
94     char core[CmiMsgHeaderSizeBytes];
95     int srcRank;
96     void *ptr;
97 }ConverseNotifyMsg;
98
99 class FuncNodeHelper : public CBase_FuncNodeHelper {
100     friend class FuncSingleHelper;
101         
102 public:
103     static int MAX_CHUNKS;
104 private:
105     int mode;
106         
107     int numHelpers; //in pthread mode, the counter includes itself    
108     FuncSingleHelper **helperPtr; /* ptrs to the FuncSingleHelpers it manages */
109         int useTreeBcast;
110     
111 public:
112         FuncNodeHelper(int mode_, int numThreads_);
113     ~FuncNodeHelper() {
114         delete [] helperPtr;
115     }
116         
117         void createPThreads();
118         void exit();
119         
120         int getNumHelpers() { return numHelpers; }
121         int needTreeBcast() { return useTreeBcast; }
122     
123     void parallelizeFunc(HelperFn func, /* the function that finishes a partial work on another thread */
124                         int paramNum, void * param, /* the input parameters for the above func */
125                         int numChunks, /* number of chunks to be partitioned */
126                         int lowerRange, int upperRange, /* the loop-like parallelization happens in [lowerRange, upperRange] */                        
127                         int sync=1, /* whether the flow will continue until all chunks have finished */
128                         void *redResult=NULL, REDUCTION_TYPE type=NODEHELPER_NONE /* the reduction result, ONLY SUPPORT SINGLE VAR of TYPE int/float/double */
129                         );
130     void reduce(void **redBufs, void *redBuf, REDUCTION_TYPE type, int numChunks);
131 };
132
133 void SingleHelperStealWork(ConverseNotifyMsg *msg);
134
135 /* FuncSingleHelper is a chare located on every core of a node */
136 //allowing arbitrary combination of sync and unsync parallelizd loops
137 #define MSG_BUFFER_SIZE (3)
138 class FuncSingleHelper: public CBase_FuncSingleHelper {
139         friend class FuncNodeHelper;
140 private: 
141     FuncNodeHelper *thisNodeHelper;
142     ConverseNotifyMsg *notifyMsg;
143     int nextFreeNotifyMsg;
144     //CurLoopInfo *curLoop; /* Points to the current loop that is being processed */
145     
146 public:
147     FuncSingleHelper(size_t ndhPtr);
148
149     ~FuncSingleHelper() {
150         for(int i=0; i<MSG_BUFFER_SIZE; i++){
151             ConverseNotifyMsg *tmp = notifyMsg+i;
152             CurLoopInfo *loop = (CurLoopInfo *)(tmp->ptr);
153             delete loop;
154         }
155         free(notifyMsg);
156     }
157     
158     ConverseNotifyMsg *getNotifyMsg(){
159         while(1){
160             ConverseNotifyMsg *cur = notifyMsg+nextFreeNotifyMsg;
161             CurLoopInfo *loop = (CurLoopInfo *)(cur->ptr);
162             nextFreeNotifyMsg = (nextFreeNotifyMsg+1)%MSG_BUFFER_SIZE;
163             if(loop->isFree()) return cur;
164         }
165         return NULL;
166     }
167     
168     FuncSingleHelper(CkMigrateMessage *m) {}            
169 };
170
171 #endif