08d18d36459219618ae3d5dcca253bc2d7d6de63
[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         numChunks = nc;
51         fnPtr = f;
52         lowerIndex = lIdx;
53         upperIndex = uIdx;
54         paramNum = numParams;
55         param = p;
56         curChunkIdx = -1;
57         finishFlag = 0;
58         //needs to be set last
59         inited = 1;
60     }
61       
62     void waitLoopDone(){
63         //while(!__sync_bool_compare_and_swap(&finishFlag, numChunks, 0));
64         while(finishFlag!=numChunks);
65         finishFlag = 0;
66         inited = 0;
67     }
68     int getNextChunkIdx(){
69         return __sync_add_and_fetch(&curChunkIdx, 1);
70     }
71     void reportFinished(int counter){
72         if(counter==0) return;
73         __sync_add_and_fetch(&finishFlag, counter);
74     }
75     
76         void **getRedBufs() { return redBufs; }
77         
78     void stealWork();
79 };
80
81 /* FuncNodeHelper is a nodegroup object */
82
83 typedef struct converseNotifyMsg{
84     char core[CmiMsgHeaderSizeBytes];
85     int srcRank;
86     void *ptr;
87 }ConverseNotifyMsg;
88
89 class FuncNodeHelper : public CBase_FuncNodeHelper {
90     friend class FuncSingleHelper;
91         
92 public:
93     static int MAX_CHUNKS;
94 private:    
95     int numHelpers;    
96     FuncSingleHelper **helperPtr; /* ptrs to the FuncSingleHelpers it manages */
97         int useTreeBcast;
98     
99 public:
100         FuncNodeHelper();
101     ~FuncNodeHelper() {
102         delete [] helperPtr;
103     }
104     
105     void parallelizeFunc(HelperFn func, /* the function that finishes a partial work on another thread */
106                         int paramNum, void * param, /* the input parameters for the above func */
107                         int msgPriority, /* the priority of the intra-node msg, and node-level msg */
108                         int numChunks, /* number of chunks to be partitioned */
109                         int lowerRange, int upperRange, /* the loop-like parallelization happens in [lowerRange, upperRange] */                        
110                         void *redResult=NULL, REDUCTION_TYPE type=NODEHELPER_NONE /* the reduction result, ONLY SUPPORT SINGLE VAR of TYPE int/float/double */
111                         );
112     void reduce(void **redBufs, void *redBuf, REDUCTION_TYPE type, int numChunks);
113 };
114
115 void SingleHelperStealWork(ConverseNotifyMsg *msg);
116
117 /* FuncSingleHelper is a chare located on every core of a node */
118 class FuncSingleHelper: public CBase_FuncSingleHelper {
119         friend class FuncNodeHelper;
120 private: 
121     FuncNodeHelper *thisNodeHelper;
122     ConverseNotifyMsg *notifyMsg;
123     CurLoopInfo *curLoop; /* Points to the current loop that is being processed */
124     
125 public:
126     FuncSingleHelper(size_t ndhPtr) {
127         thisNodeHelper = (FuncNodeHelper *)ndhPtr;
128         CmiAssert(thisNodeHelper!=NULL);        
129         int stealWorkHandler = CmiRegisterHandler((CmiHandler)SingleHelperStealWork);
130         curLoop = new CurLoopInfo(FuncNodeHelper::MAX_CHUNKS);
131         
132         notifyMsg = (ConverseNotifyMsg *)malloc(sizeof(ConverseNotifyMsg));
133         if(thisNodeHelper->useTreeBcast){
134             notifyMsg->srcRank = CmiMyRank();
135         }else{
136             notifyMsg->srcRank = -1;
137         }
138         notifyMsg->ptr = (void *)curLoop;
139         CmiSetHandler(notifyMsg, stealWorkHandler);
140         thisNodeHelper->helperPtr[CkMyRank()] = this;
141     }
142
143     ~FuncSingleHelper() {
144         delete curLoop;
145         delete notifyMsg;
146     }
147     
148     FuncSingleHelper(CkMigrateMessage *m) {}            
149 };
150
151 #endif