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