e2c14d69892d4948bcb11f757a9784455c4e3e95
[charm.git] / src / libs / ck-libs / tcharm / tcharm.C
1 /*
2 Threaded Charm++ "Framework Framework"
3
4 Orion Sky Lawlor, olawlor@acm.org, 11/19/2001
5  */
6 #include "tcharm.h"
7
8 #if 0
9     /*Many debugging statements:*/
10 #    define DBG(x) ckout<<"["<<thisIndex<<"] TCHARM> "<<x<<endl;
11 #    define DBGX(x) ckout<<"PE("<<CkMyPe()<<") TCHARM> "<<x<<endl;
12 #else
13     /*No debugging statements*/
14 #    define DBG(x) /*empty*/
15 #    define DBGX(x) /*empty*/
16 #endif
17
18 CtvDeclare(TCharm *,_curTCharm);
19 CpvDeclare(inState,_stateTCharm);
20
21 void TCharm::nodeInit(void)
22 {
23   CtvInitialize(TCharm *,_curTCharm);
24   CpvInitialize(inState,_stateTCharm);
25   TCharm::setState(inNodeSetup);
26   TCharmUserNodeSetup();
27   FTN_NAME(TCHARM_USER_NODE_SETUP,tcharm_user_node_setup)();
28   TCharm::setState(inInit);
29 }
30
31 static void startTCharmThread(TCharmInitMsg *msg)
32 {
33         TCharm::setState(inDriver);
34         typedef void (*threadFn_t)(void *);
35         ((threadFn_t)msg->threadFn)(msg->data);
36         CtvAccess(_curTCharm)->done();
37 }
38
39 TCharm::TCharm(TCharmInitMsg *initMsg_)
40 {
41   initMsg=initMsg_;
42   tid=CthCreateMigratable((CthVoidFn)startTCharmThread,initMsg,initMsg->stackSize);
43   CtvAccessOther(tid,_curTCharm)=this;
44   TCharm::setState(inInit);
45   isStopped=true;
46   threadInfo.tProxy=CProxy_TCharm(thisArrayID);
47   threadInfo.thisElement=thisIndex;
48   threadInfo.numElements=initMsg->numElements;
49   nUd=0;
50   usesAtSync=CmiTrue;
51   ready();
52 }
53
54 TCharm::TCharm(CkMigrateMessage *msg)
55         :ArrayElement1D(msg)
56 {
57   initMsg=NULL;
58   tid=NULL;
59   threadInfo.tProxy=CProxy_TCharm(thisArrayID);  
60 }
61
62 void TCharm::pup(PUP::er &p) {
63 //Pup superclass
64   ArrayElement1D::pup(p);  
65
66   p(isStopped);
67   p(threadInfo.thisElement);
68   p(threadInfo.numElements);
69
70 #ifndef CMK_OPTIMIZE
71   DBG("Packing thread");
72   if (!isStopped)
73     CkAbort("Cannot pup a running thread.  You must suspend before migrating.\n");
74 #endif
75
76 //Pup thread (EVIL & UGLY):
77   //This seekBlock allows us to reorder the packing/unpacking--
78   // This is needed because the userData depends on the thread's stack
79   // both at pack and unpack time.
80   PUP::seekBlock s(p,2);
81   if (p.isUnpacking()) 
82   {//In this case, unpack the thread before the user data
83     s.seek(1);
84     tid = CthPup((pup_er) &p, tid);
85     CtvAccessOther(tid,_curTCharm)=this;
86   }
87   
88   //Pack all user data
89   TCharm::setState(inPup);
90   s.seek(0);
91   p(nUd);
92   for(int i=0;i<nUd;i++) 
93     ud[i].pup(p);
94   TCharm::setState(inFramework);
95
96   if (!p.isUnpacking()) 
97   {//In this case, pack the thread after the user data
98     s.seek(1);
99     tid = CthPup((pup_er) &p, tid);
100   }
101   s.endBlock(); //End of seeking block
102 }
103
104 //Pup one group of user data
105 void TCharm::UserData::pup(PUP::er &p)
106 {
107   pup_er pext=(pup_er)(&p);
108   p(isC);
109   //Save address of userdata-- assumes user data is on the stack
110   p((void*)&data,sizeof(data));
111   if (isC) { //C version
112     //FIXME: function pointers may not be valid across processors
113     p((void*)&cfn, sizeof(TCpupUserDataC));
114     cfn(pext,data);
115   } 
116   else { //Fortran version
117     //FIXME: function pointers may not be valid across processors
118     p((void*)&ffn, sizeof(TCpupUserDataF));        
119     ffn(pext,data);
120   }
121 }
122
123 TCharm::~TCharm() 
124 {
125   CthFree(tid);
126   delete initMsg;
127 }
128
129 //Register user data to be packed with the thread
130 int TCharm::add(const TCharm::UserData &d)
131 {
132   if (nUd>=maxUserData)
133     CkAbort("TCharm: Registered too many user data fields!\n");
134   int nu=nUd++;
135   ud[nu]=d;
136   return nu;
137 }
138 void *TCharm::lookupUserData(int i) {
139         if (i<0 || i>=nUd)
140                 CkAbort("Bad user data index passed to TCharmGetUserdata!\n");
141         return ud[i].getData();
142 }
143
144 //Start the thread running
145 void TCharm::run(void)
146 {
147   DBG("TCharm::run()");
148   start();
149 }
150
151 //Block the thread until start()ed again.
152 void TCharm::stop(void)
153 {
154   if (isStopped) return; //Nothing to do
155 #ifndef CMK_OPTIMIZE
156   DBG("suspending thread");
157   if (tid != CthSelf())
158     CkAbort("Called TCharm::stop from outside TCharm thread!\n");
159 #endif
160   isStopped=true;
161   stopTiming();
162   TCharm::setState(inFramework);
163   CthSuspend();
164   TCharm::setState(inDriver);
165   /*We have to do the get() because "this" may have changed
166     during a migration-suspend.*/
167   TCharm::get()->startTiming();
168 }
169
170 //Resume the waiting thread
171 void TCharm::start(void)
172 {
173   if (!isStopped) return; //Already started
174   isStopped=false;
175   TCharm::setState(inDriver);
176   DBG("awakening thread");
177   CthAwaken(tid);
178 }
179
180 //Go to sync, block, possibly migrate, and then resume
181 void TCharm::migrate(void)
182 {
183 #if CMK_LBDB_ON
184   DBG("going to sync");  
185   AtSync();
186   stop();
187 #else
188   DBG("skipping sync, because there is no load balancer");
189 #endif
190 }
191
192 //Resume from sync: start the thread again
193 void TCharm::ResumeFromSync(void)
194 {
195   start();
196 }
197
198 #ifndef CMK_OPTIMIZE
199 //Make sure we're actually in driver
200 void TCharm::check(void)
201 {
202         if (getState()!=inDriver)
203                 CkAbort("TCharm> Can only use that routine from within driver!\n");
204 }
205 #endif
206
207 static int propMapCreated=0;
208 static CkGroupID propMapID;
209 CkGroupID CkCreatePropMap(void);
210
211 static void TCharmBuildThreads(TCharmInitMsg *msg,TCharmSetupCookie &cook)
212 {
213         CkArrayOptions opts(msg->numElements);
214         if (!propMapCreated) {
215                 propMapCreated=1;
216                 propMapID=CkCreatePropMap();
217         }
218         opts.setMap(propMapID);
219         CkArrayID id=CProxy_TCharm::ckNew(msg,opts);
220         cook.setThreads(id,msg->numElements);
221 }
222
223 /****** Readonlys *****/
224 CkVec<TCpupReadonlyGlobal> TCharmReadonlys::entries;
225 void TCharmReadonlys::add(TCpupReadonlyGlobal fn)
226 {
227         entries.push_back(fn);
228 }
229 //Pups all registered readonlys
230 void TCharmReadonlys::pup(PUP::er &p) {
231         if (p.isUnpacking()) {
232                 //HACK: Rather than sending this message only where its needed,
233                 // we send it everywhere and just ignore it if it's not needed.
234                 if (CkMyPe()==0) return; //Processor 0 is the source-- no unpacking needed
235                 if (CkMyRank()!=0) return; //Some other processor will do the unpacking
236         }
237         //Pup the globals for this node:
238         int i,n=entries.length();
239         p(n);
240         if (n!=entries.length())
241                 CkAbort("TCharmReadonly list length mismatch!\n");
242         for (i=0;i<n;i++)
243                 (entries[i])((pup_er)&p);
244 }
245
246 CDECL void TCharmReadonlyGlobals(TCpupReadonlyGlobal fn)
247 {
248         if (TCharm::getState()!=inNodeSetup)
249                 CkAbort("Can only call TCharmReadonlyGlobals from in TCharmUserNodeSetup!\n");
250         TCharmReadonlys::add(fn);
251 }
252 FDECL void FTN_NAME(TCHARM_READONLY_GLOBALS,tcharm_readonly_globals)
253         (TCpupReadonlyGlobal fn)
254 {
255         TCharmReadonlyGlobals(fn);
256 }
257
258 /************* Startup/Shutdown Coordination Support ************/
259
260 enum {TC_READY=23, TC_DONE=42};
261
262 //Called when a client is ready to run
263 void TCharm::ready(void) {
264         DBG("TCharm thread "<<thisIndex<<" ready")
265         int vals[2]={0,1};
266         if (thisIndex==0) vals[0]=TC_READY;
267         //Contribute to a synchronizing reduction
268         contribute(sizeof(vals),&vals,CkReduction::sum_int);
269 }
270
271 //Called when the thread is done running
272 void TCharm::done(void) {
273         DBG("TCharm thread "<<thisIndex<<" done")
274         int vals[2]={0,1};
275         if (thisIndex==0) vals[0]=TC_DONE;
276         //Contribute to a synchronizing reduction
277         contribute(sizeof(vals),&vals,CkReduction::sum_int);
278         stop();
279 }
280
281 //Called when an array reduction is complete
282 static void coordinatorReduction(void *coord_,int dataLen,void *reductionData)
283 {
284         TCharmCoordinator *coord=(TCharmCoordinator *)coord_;
285         int *vals=(int *)reductionData;
286         if (dataLen!=2*sizeof(int))
287                 CkAbort("Unexpected length in TCharm array reduction!\n");
288         DBGX("Finished coordinator reduction: "<<vals[0]<<", "<<vals[1]);
289         switch (vals[0]) {
290         case TC_READY: coord->clientReady(); break;
291         case TC_DONE: coord->clientDone(); break;
292         default:
293                 CkAbort("Unexpected value from TCharm array reduction!\n");
294         };
295 }
296
297 int TCharmCoordinator::nArrays=0; //Total number of running thread arrays
298 TCharmCoordinator *TCharmCoordinator::head=NULL; //List of coordinators
299
300
301 TCharmCoordinator::TCharmCoordinator(CkArrayID threads_,int nThreads_)
302         :threads(threads_), nThreads(nThreads_), nClients(0), nReady(0)
303 {
304         nArrays++;
305         //Link into the coordinator list
306         next=head;
307         head=this;
308
309         threads.setReductionClient(coordinatorReduction,this);
310         nClients=1; //Thread array itself is a client
311 }
312 TCharmCoordinator::~TCharmCoordinator()
313 {
314         //Coordinators never get deleted
315 }
316 void TCharmCoordinator::addClient(const CkArrayID &client)
317 {
318         nClients++;
319 }
320 void TCharmCoordinator::clientReady(void)
321 {
322         DBGX("client "<<nReady+1<<" of "<<nClients<<" ready");
323         nReady++;
324         if (nReady>=nClients) { //All client arrays are ready-- start threads
325                 DBGX("starting threads");
326                 threads.run();
327         }
328 }
329 void TCharmCoordinator::clientDone(void)
330 {
331         DBGX("clientDone");     
332         nArrays--;
333         if (nArrays<=0) { //All arrays have exited
334                 DBGX("done with computation");
335                 CkExit();
336         }
337 }
338
339 /************* Setup **************/
340
341 //Cookie used during setup
342 TCharmSetupCookie *TCharmSetupCookie::theCookie;
343
344 //Globals used to control setup process
345 static int g_numDefaultSetups=0;
346 static TCharmFallbackSetupFn g_fallbackSetup=NULL;
347 void TCharmSetFallbackSetup(TCharmFallbackSetupFn f)
348 {
349         g_fallbackSetup=f;
350 }
351 CDECL void TCharmInDefaultSetup(void) {
352         g_numDefaultSetups++;
353 }
354
355 //Tiny simple main chare
356 class TCharmMain : public Chare {
357 public:
358   TCharmMain(CkArgMsg *msg) {
359     TCharmSetupCookie cookie(msg->argv);
360     TCharmSetupCookie::theCookie=&cookie;
361     g_numDefaultSetups=0;
362     
363     /*Call user-overridable C setup*/
364     TCharmUserSetup();
365     /*Call user-overridable Fortran setup*/
366     FTN_NAME(TCHARM_USER_SETUP,tcharm_user_setup)();
367     
368     if (g_numDefaultSetups==2) 
369     { //User didn't override either setup routine
370             if (g_fallbackSetup)
371                     (g_fallbackSetup)();
372             else
373                     CmiAbort("You need to override TCharmUserSetup to start your computation, or else link in a framework module\n");
374     }       
375     
376     delete msg;
377     
378     if (0==TCharmCoordinator::getTotal())
379             CkAbort("You didn't create any TCharm arrays in TCharmUserSetup!\n");
380
381     //Send out the readonly globals:
382     TCharmReadonlys r;
383     CProxy_TCharmReadonlyGroup::ckNew(r);
384   }
385 };
386
387 #ifndef CMK_OPTIMIZE
388 /*The setup cookie, used to store global initialization state*/
389 TCharmSetupCookie &TCharmSetupCookie::check(void)
390 {
391         if (magic!=correctMagic)
392                 CkAbort("TCharm setup cookie is damaged!\n");
393         return *this;
394 }
395 #endif
396
397 void TCharmSetupCookie::setThreads(const CkArrayID &aid,int nel)
398 {
399         coord=new TCharmCoordinator(aid,nel);
400         tc=aid; numElements=nel;
401 }
402
403 TCharmSetupCookie::TCharmSetupCookie(char **argv_)
404 {
405         magic=correctMagic;
406         stackSize=0;
407         argv=argv_;
408         coord=NULL;
409 }
410
411
412 /************** User API ***************/
413
414 #define cookie (*TCharmSetupCookie::get())
415
416 /**********************************
417 Callable from UserSetup: 
418 */
419
420 /*Set the size of the thread stack*/
421 CDECL void TCharmSetStackSize(int newStackSize)
422 {
423         if (TCharm::getState()!=inInit)
424                 CkAbort("TCharm> Can only set stack size from in init!\n");
425         cookie.setStackSize(newStackSize);
426 }
427 FDECL void FTN_NAME(TCHARM_SET_STACK_SIZE,tcharm_set_stack_size)
428         (int *newSize)
429 { TCharmSetStackSize(*newSize); }
430
431
432 /*Create a new array of threads, which will be bound to by subsequent libraries*/
433 CDECL void TCharmCreate(int nThreads,
434                         TCharmThreadStartFn threadFn)
435 {
436         TCharmCreateData(nThreads,
437                          (TCharmThreadDataStartFn)threadFn,NULL,0);
438 }
439 FDECL void FTN_NAME(TCHARM_CREATE,tcharm_create)
440         (int *nThreads,TCharmThreadStartFn threadFn)
441 { TCharmCreate(*nThreads,threadFn); }
442
443
444 /*As above, but pass along (arbitrary) data to threads*/
445 CDECL void TCharmCreateData(int nThreads,
446                   TCharmThreadDataStartFn threadFn,
447                   void *threadData,int threadDataLen)
448 {
449         if (TCharm::getState()!=inInit)
450                 CkAbort("TCharm> Can only create threads from in init!\n");
451         TCharmSetupCookie &cook=cookie;
452         TCharmInitMsg *msg=new (threadDataLen,0) TCharmInitMsg(
453                 (CthVoidFn)threadFn,cook.getStackSize());
454         msg->numElements=nThreads;
455         memcpy(msg->data,threadData,threadDataLen);
456         TCharmBuildThreads(msg,cook);
457 }
458
459 FDECL void FTN_NAME(TCHARM_CREATE_DATA,tcharm_create_data)
460         (int *nThreads,
461                   TCharmThreadDataStartFn threadFn,
462                   void *threadData,int *threadDataLen)
463 { TCharmCreateData(*nThreads,threadFn,threadData,*threadDataLen); }
464
465
466 /*Get the unconsumed command-line arguments*/
467 CDECL char **TCharmArgv(void)
468 {
469         if (TCharm::getState()!=inInit)
470                 CkAbort("TCharm> Can only get arguments from in init!\n");
471         return cookie.getArgv();
472 }
473 CDECL int TCharmArgc(void)
474 {
475         if (TCharm::getState()!=inInit)
476                 CkAbort("TCharm> Can only get arguments from in init!\n");
477         return CmiGetArgc(cookie.getArgv());
478 }
479
480 CDECL int TCharmGetNumChunks(void)
481 {
482         int nChunks=CkNumPes();
483         char **argv=TCharmArgv();
484         CmiGetArgInt(argv,"-vp",&nChunks);
485         CmiGetArgInt(argv,"+vp",&nChunks);
486         return nChunks;
487 }
488 FDECL int FTN_NAME(TCHARM_GET_NUM_CHUNKS,tcharm_get_num_chunks)(void)
489 {
490         return TCharmGetNumChunks();
491 }
492
493
494 /***********************************
495 Callable from worker thread
496 */
497 CDECL int TCharmElement(void)
498 { return TCharm::get()->getElement();}
499 CDECL int TCharmNumElements(void)
500 { return TCharm::get()->getNumElements();}
501
502 FDECL int FTN_NAME(TCHARM_ELEMENT,tcharm_element)(void) 
503 { return TCharmElement();}
504 FDECL int FTN_NAME(TCHARM_NUM_ELEMENTS,tcharm_num_elements)(void) 
505 { return TCharmNumElements();}
506
507 CDECL int TCharmRegister(void *data,TCharmPupFn pfn)
508
509         if (!CmiIsomallocInRange(data))
510                 CkAbort("The UserData you register must be allocated on the stack!\n");
511         return TCharm::get()->add(TCharm::UserData(pfn,data));
512 }
513 FDECL int FTN_NAME(TCHARM_REGISTER,tcharm_register)
514         (void *data,TCpupUserDataF pfn)
515
516         if (!CmiIsomallocInRange(data))
517                 CkAbort("The UserData you register must be allocated on the stack!\n");
518         return TCharm::get()->add(TCharm::UserData(
519                 pfn,data,TCharm::UserData::isFortran()));
520 }
521
522 CDECL void *TCharmGetUserdata(int id)
523 {
524         return TCharm::get()->lookupUserData(id);
525 }
526 FDECL void *FTN_NAME(TCHARM_GET_USERDATA,tcharm_get_userdata)(int *id)
527 { return TCharmGetUserdata(*id); }
528
529 CDECL void TCharmMigrate(void)
530 {
531         TCharm::get()->migrate();
532 }
533 FDECL void FTN_NAME(TCHARM_MIGRATE,tcharm_migrate)(void)
534 {
535         TCharm::get()->migrate();
536 }
537
538 CDECL void TCharmDone(void)
539 {
540         TCharm::get()->done();
541 }
542 FDECL void FTN_NAME(TCHARM_DONE,tcharm_done)(void)
543 {
544         TCharmDone();
545 }
546
547
548
549 #include "tcharm.def.h"