c18c7c61205c61affdc67952f1e4cf3e95314651
[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(){
70         __sync_add_and_fetch(&finishFlag, 1);
71     }
72     
73         void **getRedBufs() { return redBufs; }
74         
75     void stealWork();
76 };
77
78 /* FuncNodeHelper is a nodegroup object */
79
80 typedef struct converseNotifyMsg{
81     char core[CmiMsgHeaderSizeBytes];
82     int srcRank;
83     void *ptr;
84 }ConverseNotifyMsg;
85
86 class FuncNodeHelper : public CBase_FuncNodeHelper {
87     friend class FuncSingleHelper;
88         
89 public:
90     static int MAX_CHUNKS;
91 private:
92     ConverseNotifyMsg *notifyMsgs;
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         delete [] notifyMsgs;
102     }
103
104     /* handler is only useful when converse msg is used to initiate tasks on the pseudo-thread */
105     void oneHelperCreated(int hid, FuncSingleHelper* cptr, int handler) {
106         helperPtr[hid] = cptr;
107         CmiSetHandler(&(notifyMsgs[hid]), handler);
108     }
109     
110     void parallelizeFunc(HelperFn func, /* the function that finishes a partial work on another thread */
111                         int paramNum, void * param, /* the input parameters for the above func */
112                         int msgPriority, /* the priority of the intra-node msg, and node-level msg */
113                         int numChunks, /* number of chunks to be partitioned */
114                         int lowerRange, int upperRange, /* the loop-like parallelization happens in [lowerRange, upperRange] */                        
115                         void *redResult=NULL, REDUCTION_TYPE type=NODEHELPER_NONE /* the reduction result, ONLY SUPPORT SINGLE VAR of TYPE int/float/double */
116                         );
117     void reduce(void **redBufs, void *redBuf, REDUCTION_TYPE type, int numChunks);
118 };
119
120 void SingleHelperStealWork(ConverseNotifyMsg *msg);
121
122 /* FuncSingleHelper is a chare located on every core of a node */
123 class FuncSingleHelper: public CBase_FuncSingleHelper {
124         friend class FuncNodeHelper;
125 private: 
126     int stealWorkHandler;
127     FuncNodeHelper *thisNodeHelper;
128     CurLoopInfo *curLoop; /* Points to the current loop that is being processed */
129     
130 public:
131     FuncSingleHelper(CkGroupID nid) {        
132         CProxy_FuncNodeHelper fh(nid);
133         thisNodeHelper = fh[CkMyNode()].ckLocalBranch();
134         CmiAssert(thisNodeHelper!=NULL);        
135         stealWorkHandler = CmiRegisterHandler((CmiHandler)SingleHelperStealWork);
136         curLoop = new CurLoopInfo(FuncNodeHelper::MAX_CHUNKS);
137     }
138
139     ~FuncSingleHelper() {
140         delete curLoop;
141     }
142     
143     FuncSingleHelper(CkMigrateMessage *m) {}
144                 
145     void reportCreated() {
146         //CkPrintf("Single helper %d is created on rank %d\n", CkMyPe(), CkMyRank());
147                 thisNodeHelper->oneHelperCreated(CkMyRank(), this, stealWorkHandler);
148     }    
149 };
150
151 #endif