Don't depend on order of global variable initialization;
[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_impl.h"
7 #include "tcharm.h"
8 #include <ctype.h>
9
10 #if 0
11     /*Many debugging statements:*/
12 #    define DBG(x) ckout<<"["<<thisIndex<<"] TCHARM> "<<x<<endl;
13 #    define DBGX(x) ckout<<"PE("<<CkMyPe()<<") TCHARM> "<<x<<endl;
14 #else
15     /*No debugging statements*/
16 #    define DBG(x) /*empty*/
17 #    define DBGX(x) /*empty*/
18 #endif
19
20 CtvDeclare(TCharm *,_curTCharm);
21 CkpvDeclare(inState,_stateTCharm);
22
23 static int lastNumChunks=0;
24
25 class TCharmTraceLibList {
26         enum {maxLibs=20,maxLibNameLen=15};
27         //List of libraries we want to trace:
28         int curLibs;
29         char libNames[maxLibs][maxLibNameLen];
30         int checkIfTracing(const char *lib) const
31         {
32                 for (int i=0;i<curLibs;i++) 
33                         if (0==strcmp(lib,libNames[i]))
34                                 return 1;
35                 return 0;
36         }
37 public:
38         TCharmTraceLibList() {curLibs=0;}
39         void addTracing(const char *lib) 
40         { //We want to trace this library-- add its name to the list.
41                 CkPrintf("TCHARM> Will trace calls to library %s\n",lib);
42                 int i;
43                 for (i=0;0!=*lib;i++,lib++)
44                         libNames[curLibs][i]=tolower(*lib);
45                 libNames[curLibs][i]=0;
46                 // if already tracing, skip
47                 if (checkIfTracing(libNames[curLibs])) return;
48                 curLibs++;
49         }
50         inline int isTracing(const char *lib) const {
51                 if (curLibs==0) return 0; //Common case
52                 else return checkIfTracing(lib);
53         }
54 };
55 static TCharmTraceLibList tcharm_tracelibs;
56 static int tcharm_nomig=0, tcharm_nothreads=0;
57 static int tcharm_stacksize=1*1024*1024; /*Default stack size is 1MB*/
58 static int tcharm_initted=0;
59
60 void TCharm::nodeInit(void)
61 {
62   CtvInitialize(TCharm *,_curTCharm);
63   CtvAccess(_curTCharm)=NULL;
64   CkpvInitialize(inState,_stateTCharm);
65   TCharm::setState(inInit);
66
67   tcharm_initted=1;
68 }
69
70 void TCharm::procInit(void)
71 {
72   // called on every pe to eat these arguments
73   char **argv=CkGetArgv();
74   tcharm_nomig=CmiGetArgFlagDesc(argv,"+tcharm_nomig","Disable migration support (debugging)");
75   tcharm_nothreads=CmiGetArgFlagDesc(argv,"+tcharm_nothread","Disable thread support (debugging)");
76   tcharm_nothreads|=CmiGetArgFlagDesc(argv,"+tcharm_nothreads",NULL);
77   char *traceLibName=NULL;
78   while (CmiGetArgStringDesc(argv,"+tcharm_trace",&traceLibName,"Print each call to this library"))
79       tcharm_tracelibs.addTracing(traceLibName);
80   CmiGetArgIntDesc(argv,"+tcharm_stacksize",&tcharm_stacksize,"Set the thread stack size (default 1MB)");
81   if (CkMyPe()!=0) { //Processor 0 eats "+vp<N>" and "-vp<N>" later:
82         int ignored;
83         while (CmiGetArgIntDesc(argv,"-vp",&ignored,NULL)) {}
84         while (CmiGetArgIntDesc(argv,"+vp",&ignored,NULL)) {}
85   }
86   if (CkMyPe()==0) { // Echo various debugging options:
87     if (tcharm_nomig) CmiPrintf("TCHARM> Disabling migration support, for debugging\n");
88     if (tcharm_nothreads) CmiPrintf("TCHARM> Disabling thread support, for debugging\n");
89   }
90 }
91
92 void TCHARM_Api_trace(const char *routineName,const char *libraryName)
93 {
94         if (!tcharm_tracelibs.isTracing(libraryName)) return;
95         TCharm *tc=CtvAccess(_curTCharm);
96         char where[100];
97         if (tc==NULL) sprintf(where,"[serial context on %d]",CkMyPe());
98         else sprintf(where,"[%p> vp %d, p %d]",(void *)tc,tc->getElement(),CkMyPe());
99         CmiPrintf("%s Called routine %s\n",where,routineName);
100         CmiPrintStackTrace(1);
101         CmiPrintf("\n");
102 }
103
104 static void startTCharmThread(TCharmInitMsg *msg)
105 {
106         TCharm::setState(inDriver);
107         CtvAccess(_curTCharm)->activateHeap();
108         typedef void (*threadFn_t)(void *);
109         ((threadFn_t)msg->threadFn)(msg->data);
110         CmiIsomallocBlockListActivate(NULL); //Turn off migratable memory
111         CtvAccess(_curTCharm)->done();
112 }
113
114 TCharm::TCharm(TCharmInitMsg *initMsg_)
115 {
116   initMsg=initMsg_;
117   timeOffset=0.0;
118   if (tcharm_nothreads)
119   { //Don't even make a new thread-- just use main thread
120     tid=CthSelf();
121   }
122   else /*Create a thread normally*/
123   {
124     if (tcharm_nomig) { /*Nonmigratable version, for debugging*/
125       tid=CthCreate((CthVoidFn)startTCharmThread,initMsg,initMsg->opts.stackSize);
126     } else {
127       tid=CthCreateMigratable((CthVoidFn)startTCharmThread,initMsg,initMsg->opts.stackSize);
128     }
129 #if CMK_BLUEGENE_CHARM
130     BgAttach(tid);
131 #endif
132   }
133   CtvAccessOther(tid,_curTCharm)=this;
134   TCharm::setState(inInit);
135   isStopped=true;
136   resumeAfterMigration=false;
137   exitWhenDone=initMsg->opts.exitWhenDone;
138   threadInfo.tProxy=CProxy_TCharm(thisArrayID);
139   threadInfo.thisElement=thisIndex;
140   threadInfo.numElements=initMsg->numElements;
141   heapBlocks=CmiIsomallocBlockListNew();
142   nUd=0;
143   usesAtSync=CmiTrue;
144   run();
145 }
146
147 TCharm::TCharm(CkMigrateMessage *msg)
148         :CBase_TCharm(msg)
149 {
150   initMsg=NULL;
151   tid=NULL;
152   threadInfo.tProxy=CProxy_TCharm(thisArrayID);
153 }
154
155 void TCharm::pup(PUP::er &p) {
156 //Pup superclass
157   ArrayElement1D::pup(p);
158
159   p(isStopped); p(resumeAfterMigration); p(exitWhenDone);
160   p(threadInfo.thisElement);
161   p(threadInfo.numElements);
162   
163   if (sema.size()>0) 
164         CkAbort("TCharm::pup> Cannot migrate with unconsumed semaphores!\n");
165
166 #ifndef CMK_OPTIMIZE
167   DBG("Packing thread");
168   if (!isStopped)
169     CkAbort("Cannot pup a running thread.  You must suspend before migrating.\n");
170   if (tcharm_nomig) CkAbort("Cannot migrate with the +tcharm_nomig option!\n");
171 #endif
172
173 //Pup thread (EVIL & UGLY):
174   //This seekBlock allows us to reorder the packing/unpacking--
175   // This is needed because the userData depends on the thread's stack
176   // and heap data both at pack and unpack time.
177   PUP::seekBlock s(p,2);
178   if (p.isUnpacking())
179   {//In this case, unpack the thread & heap before the user data
180     s.seek(1);
181     tid = CthPup((pup_er) &p, tid);
182     CtvAccessOther(tid,_curTCharm)=this;
183     CmiIsomallocBlockListPup((pup_er) &p,&heapBlocks);
184     //Restart our clock: set it up so packTime==CkWallTimer+timeOffset
185     double packTime;
186     p(packTime);
187     timeOffset=packTime-CkWallTimer();
188   }
189
190   //Pack all user data
191   TCharm::setState(inPup);
192   s.seek(0);
193   p(nUd);
194   for(int i=0;i<nUd;i++)
195     ud[i].pup(p);
196   p|sud;
197   TCharm::setState(inFramework);
198
199   if (!p.isUnpacking())
200   {//In this case, pack the thread & heap after the user data
201     s.seek(1);
202     tid = CthPup((pup_er) &p, tid);
203     CmiIsomallocBlockListPup((pup_er) &p,&heapBlocks);
204     //Stop our clock:
205     double packTime=CkWallTimer()+timeOffset;
206     p(packTime);
207   }
208   s.endBlock(); //End of seeking block
209 }
210
211 //Pup one group of user data
212 void TCharm::UserData::pup(PUP::er &p)
213 {
214   pup_er pext=(pup_er)(&p);
215   p(isC);
216   //Save address of userdata-- assumes user data is on the stack
217   p((void*)&data,sizeof(data));
218   if (isC) { //C version
219     //FIXME: function pointers may not be valid across processors
220     p((void*)&cfn, sizeof(TCpupUserDataC));
221     if (cfn) cfn(pext,data);
222   }
223   else { //Fortran version
224     //FIXME: function pointers may not be valid across processors
225     p((void*)&ffn, sizeof(TCpupUserDataF));
226     if (ffn) ffn(pext,data);
227   }
228 }
229
230 TCharm::~TCharm()
231 {
232   CmiIsomallocBlockListDelete(heapBlocks);
233   CthFree(tid);
234   delete initMsg;
235 }
236
237 void TCharm::migrateTo(int destPE) {
238         if (destPE==CkMyPe()) return;
239         // Make sure migrateMe gets called *after* we suspend:
240         thisProxy[thisIndex].migrateDelayed(destPE);
241         resumeAfterMigration=true;
242         suspend();
243 }
244 void TCharm::migrateDelayed(int destPE) {
245         migrateMe(destPE);
246 }
247 void TCharm::ckJustMigrated(void) {
248         ArrayElement::ckJustMigrated();
249         if (resumeAfterMigration) {
250                 resumeAfterMigration=false;
251                 resume(); //Start the thread running
252         }
253 }
254
255 // clear the data before restarting from disk
256 void TCharm::clear()
257 {
258   CmiIsomallocBlockListDelete(heapBlocks);
259   CthFree(tid);
260   delete initMsg;
261 }
262
263 //Register user data to be packed with the thread
264 int TCharm::add(const TCharm::UserData &d)
265 {
266   if (nUd>=maxUserData)
267     CkAbort("TCharm: Registered too many user data fields!\n");
268   int nu=nUd++;
269   ud[nu]=d;
270   return nu;
271 }
272 void *TCharm::lookupUserData(int i) {
273         if (i<0 || i>=nUd)
274                 CkAbort("Bad user data index passed to TCharmGetUserdata!\n");
275         return ud[i].getData();
276 }
277
278 //Start the thread running
279 void TCharm::run(void)
280 {
281   DBG("TCharm::run()");
282   start();
283 }
284
285 //Block the thread until start()ed again.
286 void TCharm::stop(void)
287 {
288   if (isStopped) return; //Nothing to do
289 #ifndef CMK_OPTIMIZE
290   DBG("suspending thread");
291   if (tid != CthSelf())
292     CkAbort("Called TCharm::stop from outside TCharm thread!\n");
293   if (tcharm_nothreads)
294     CkAbort("Cannot make blocking calls using +tcharm_nothreads!\n");
295 #endif
296   isStopped=true;
297   stopTiming();
298   TCharm::setState(inFramework);
299   CthSuspend();
300   TCharm::setState(inDriver);
301   /*We have to do the get() because "this" may have changed
302     during a migration-suspend.*/
303   TCharm::get()->startTiming();
304 }
305
306 //Resume the waiting thread
307 void TCharm::start(void)
308 {
309   if (!isStopped) return; //Already started
310   isStopped=false;
311   TCharm::setState(inDriver);
312   DBG("awakening thread");
313   if (tcharm_nothreads) /*Call user routine directly*/
314           startTCharmThread(initMsg);
315   else /*Jump to thread normally*/
316           CthAwaken(tid);
317 }
318
319 //Go to sync, block, possibly migrate, and then resume
320 void TCharm::migrate(void)
321 {
322 #if CMK_LBDB_ON
323   DBG("going to sync");
324   AtSync();
325   stop();
326 #else
327   DBG("skipping sync, because there is no load balancer");
328 #endif
329 }
330
331 //Resume from sync: start the thread again
332 void TCharm::ResumeFromSync(void)
333 {
334   start();
335 }
336
337 #ifndef CMK_OPTIMIZE
338 //Make sure we're actually in driver
339 void TCharm::check(void)
340 {
341         if (getState()!=inDriver)
342                 ::CkAbort("TCharm> Can only use that routine from within driver!\n");
343 }
344 #endif
345
346
347 /****** TcharmClient ******/
348 void TCharmClient1D::ckJustMigrated(void) {
349   ArrayElement1D::ckJustMigrated();
350   findThread();
351   tcharmClientInit();
352 }
353
354 void TCharmClient1D::pup(PUP::er &p) {
355   ArrayElement1D::pup(p);
356   p|threadProxy;
357 }
358
359 CkArrayID TCHARM_Get_threads(void) {
360         TCHARMAPI("TCHARM_Get_threads");
361         if (TCharm::getState()!=inDriver)
362                 CkAbort("Can only call TCHARM_Get_threads from driver!\n");
363         return TCharm::get()->getProxy();
364 }
365
366 /****** Readonlys *****/
367 static int tcharm_readonlygroup_created=0;
368 static TCharmReadonlys *initial_readonlies=NULL;
369 TCharmReadonlys &getInitialReadonlies(void) {
370         if (!initial_readonlies) initial_readonlies=new TCharmReadonlys;
371         return *initial_readonlies;
372 }
373 CProxy_TCharmReadonlyGroup tcharm_readonlygroup;
374
375 class TCharmReadonlyGroup : public CBase_TCharmReadonlyGroup {
376 public:
377         TCharmReadonlys all;
378         
379         TCharmReadonlyGroup(TCharmReadonlys &r,int len,const char *data)
380         {
381                 add(r,len,data);
382         }
383         
384         void add(TCharmReadonlys &r,int len,const char *data) {
385                 // Unpack these readonlies:
386                 PUP::fromMem p(data);
387                 r.pupData(p);
388                 // Add to our list:
389                 all.add(r);
390         }
391         
392         void pup(PUP::er &p) {
393                 all.pup(p);
394                 all.pupData(p);
395         }
396 };
397
398 // Send out this set of readonlies to the readonly group:
399 static void send_readonlies(TCharmReadonlys &r) {
400         int len; {PUP::sizer p; r.pupData(p); len=p.size();}
401         char *data=new char[len];
402         {PUP::toMem p(data); r.pupData(p);}
403         tcharm_readonlygroup.add(r,len,data);
404         delete[] data;
405 }
406
407 class TCharmReadonlyMain : public CBase_TCharmReadonlyMain {
408 public:
409     TCharmReadonlyMain(void) {
410         TCharmReadonlys &r=getInitialReadonlies();
411         int len; {PUP::sizer p; r.pupData(p); len=p.size();}
412         char *data=new char[len];
413         {PUP::toMem p(data); r.pupData(p);}
414         tcharm_readonlygroup=CProxy_TCharmReadonlyGroup::ckNew(r,len,data);
415         delete[] data;
416         tcharm_readonlygroup_created=1;
417     }
418 };
419
420 void TCharmReadonlys::add(TCpupReadonlyGlobal fn)
421 {
422         entries.push_back(fn);
423 }
424 void TCharmReadonlys::add(const TCharmReadonlys &r) {
425         for (unsigned int i=0;i<r.entries.size();i++)
426                 entries.push_back(r.entries[i]);
427 }
428
429 //Pup the readonly *functions* (for shipping)
430 void TCharmReadonlys::pup(PUP::er &p) {
431         p|entries;
432 }
433
434 //Pups the readonly *data*
435 void TCharmReadonlys::pupData(PUP::er &p) {
436         for (unsigned int i=0;i<entries.size();i++)
437                 (entries[i])((pup_er)&p);
438 }
439
440 //Pups all readonly data registered so far.
441 void TCharmReadonlys::pupAll(PUP::er &p) {
442         if (!tcharm_readonlygroup_created)
443                 CkAbort("TCharmReadonlys::pupAll can only be called after the TCHARM main");
444         TCharmReadonlys &all=tcharm_readonlygroup.ckLocalBranch()->all;
445         int n=all.size();
446         p|n;
447         if (n!=all.size())
448                 CkAbort("TCharmReadonly list length mismatch!\n");
449         all.pupData(p);
450 }
451
452 CDECL void TCHARM_Readonly_globals(TCpupReadonlyGlobal fn)
453 {
454         if (!tcharm_readonlygroup_created) 
455         { // Readonly message hasn't gone out yet: just add to list.
456           // Because this routine can be called from nodesetup,
457           //  TCHARMAPI isn't safe yet.
458                 getInitialReadonlies().add(fn);
459         } 
460         else /* tcharm_readonlygroup_created */
461         { // Late addition: Broadcast our copy of the readonly data:
462                 TCHARMAPI("TCHARM_Readonly_globals");
463                 TCharmReadonlys r; r.add(fn);
464                 send_readonlies(r);
465         }
466 }
467 FDECL void FTN_NAME(TCHARM_READONLY_GLOBALS,tcharm_readonly_globals)
468         (TCpupReadonlyGlobal fn)
469 {
470         TCHARM_Readonly_globals(fn);
471 }
472
473
474 /************* Startup/Shutdown Coordination Support ************/
475
476 // Useless values to reduce over:
477 int vals[2]={0,1};
478
479 //Called when we want to go to a barrier
480 void TCharm::barrier(void) {
481         //Contribute to a synchronizing reduction
482         CkCallback cb(index_t::atBarrier(0), thisProxy[0]);
483         contribute(sizeof(vals),&vals,CkReduction::sum_int,cb);
484         stop();
485 }
486
487 //Called when we've reached the barrier
488 void TCharm::atBarrier(CkReductionMsg *m) {
489         DBGX("clients all at barrier");
490         delete m;
491         thisProxy.run(); //Just restart everybody
492 }
493
494 //Called when the thread is done running
495 void TCharm::done(void) {
496         DBG("TCharm thread "<<thisIndex<<" done")
497         if (exitWhenDone) {
498                 //Contribute to a synchronizing reduction
499                 CkCallback cb(index_t::atExit(0), thisProxy[0]);
500                 contribute(sizeof(vals),&vals,CkReduction::sum_int,cb);
501         }
502         stop();
503 }
504 //Called when all threads are done running
505 void TCharm::atExit(CkReductionMsg *m) {
506         DBGX("TCharm::atExit> exiting");
507         delete m;
508         CkExit();
509 }
510
511
512 /************* Setup **************/
513
514 //Globals used to control setup process
515 static TCHARM_Fallback_setup_fn g_fallbackSetup=NULL;
516 void TCHARM_Set_fallback_setup(TCHARM_Fallback_setup_fn f)
517 {
518         g_fallbackSetup=f;
519 }
520 void TCHARM_Call_fallback_setup(void) {
521         if (g_fallbackSetup) 
522                 (g_fallbackSetup)();
523         else
524                 CkAbort("TCHARM: Unexpected fallback setup--missing TCHARM_User_setup routine?");
525 }
526
527 /************** User API ***************/
528 /**********************************
529 Callable from UserSetup:
530 */
531
532 // Read the command line to figure out how many threads to create:
533 CDECL int TCHARM_Get_num_chunks(void)
534 {
535         TCHARMAPI("TCHARM_Get_num_chunks");
536         if (CkMyPe()!=0) CkAbort("TCHARM_Get_num_chunks should only be called on PE 0 during setup!");
537         int nChunks=CkNumPes();
538         char **argv=CkGetArgv();
539         CmiGetArgIntDesc(argv,"-vp",&nChunks,"Set the total number of virtual processors");
540         CmiGetArgIntDesc(argv,"+vp",&nChunks,NULL);
541         lastNumChunks=nChunks;
542         return nChunks;
543 }
544 FDECL int FTN_NAME(TCHARM_GET_NUM_CHUNKS,tcharm_get_num_chunks)(void)
545 {
546         return TCHARM_Get_num_chunks();
547 }
548
549 // Fill out the default thread options:
550 TCHARM_Thread_options::TCHARM_Thread_options(int doDefault)
551 {
552         stackSize=tcharm_stacksize; /* default stacksize */
553         exitWhenDone=0; /* don't exit when done by default. */
554 }
555
556 TCHARM_Thread_options g_tcharmOptions(1);
557
558 /*Set the size of the thread stack*/
559 CDECL void TCHARM_Set_stack_size(int newStackSize)
560 {
561         TCHARMAPI("TCHARM_Set_stack_size");
562         g_tcharmOptions.stackSize=newStackSize;
563 }
564 FDECL void FTN_NAME(TCHARM_SET_STACK_SIZE,tcharm_set_stack_size)
565         (int *newSize)
566 { TCHARM_Set_stack_size(*newSize); }
567
568 CDECL void TCHARM_Set_exit(void) { g_tcharmOptions.exitWhenDone=1; }
569
570 /*Create a new array of threads, which will be bound to by subsequent libraries*/
571 CDECL void TCHARM_Create(int nThreads,
572                         TCHARM_Thread_start_fn threadFn)
573 {
574         TCHARMAPI("TCHARM_Create");
575         TCHARM_Create_data(nThreads,
576                          (TCHARM_Thread_data_start_fn)threadFn,NULL,0);
577 }
578 FDECL void FTN_NAME(TCHARM_CREATE,tcharm_create)
579         (int *nThreads,TCHARM_Thread_start_fn threadFn)
580 { TCHARM_Create(*nThreads,threadFn); }
581
582 static CProxy_TCharm TCHARM_Build_threads(TCharmInitMsg *msg);
583
584 /*As above, but pass along (arbitrary) data to threads*/
585 CDECL void TCHARM_Create_data(int nThreads,
586                   TCHARM_Thread_data_start_fn threadFn,
587                   void *threadData,int threadDataLen)
588 {
589         TCHARMAPI("TCHARM_Create_data");
590         if (TCharm::getState()!=inInit)
591                 CkAbort("TCharm> Can only create threads from in init!\n");
592         TCharmInitMsg *msg=new (threadDataLen,0) TCharmInitMsg(
593                 (CthVoidFn)threadFn,g_tcharmOptions);
594         msg->numElements=nThreads;
595         memcpy(msg->data,threadData,threadDataLen);
596         TCHARM_Build_threads(msg);
597         
598         // Reset the thread options:
599         g_tcharmOptions=TCHARM_Thread_options(1);
600 }
601
602 FDECL void FTN_NAME(TCHARM_CREATE_DATA,tcharm_create_data)
603         (int *nThreads,
604                   TCHARM_Thread_data_start_fn threadFn,
605                   void *threadData,int *threadDataLen)
606 { TCHARM_Create_data(*nThreads,threadFn,threadData,*threadDataLen); }
607
608 static int propMapCreated=0;
609 static CkGroupID propMapID;
610 CkGroupID CkCreatePropMap(void);
611
612 static CProxy_TCharm TCHARM_Build_threads(TCharmInitMsg *msg)
613 {
614         CkArrayOptions opts(msg->numElements);
615         if (!propMapCreated) {
616                 propMapCreated=1;
617                 propMapID=CkCreatePropMap();
618         }
619         opts.setMap(propMapID);
620         int nElem=msg->numElements; //<- save it because msg will be deleted.
621         return CProxy_TCharm::ckNew(msg,opts);
622 }
623
624 // Helper used when creating a new array bound to the TCHARM threads:
625 CkArrayOptions TCHARM_Attach_start(CkArrayID *retTCharmArray,int *retNumElts)
626 {
627         TCharm *tc=TCharm::get();
628         if (!tc)
629                 CkAbort("You must call TCHARM initialization routines from a TCHARM thread!");
630         int nElts=tc->getNumElements();
631         if (retNumElts!=NULL) *retNumElts=nElts;
632         *retTCharmArray=tc->getProxy();
633         CkArrayOptions opts(nElts);
634         opts.bindTo(tc->getProxy());
635         return opts;
636 }
637
638 void TCHARM_Suspend(void) {
639         TCharm *tc=TCharm::get();
640         tc->suspend();
641 }
642
643 /***********************************
644 Callable from worker thread
645 */
646 CDECL int TCHARM_Element(void)
647
648         TCHARMAPI("TCHARM_Element");
649         return TCharm::get()->getElement();
650 }
651 CDECL int TCHARM_Num_elements(void)
652
653         TCHARMAPI("TCHARM_Num_elements");
654         if (TCharm::getState()==inDriver)
655                 return TCharm::get()->getNumElements();
656         else
657                 return lastNumChunks;
658 }
659
660 FDECL int FTN_NAME(TCHARM_ELEMENT,tcharm_element)(void) 
661 { return TCHARM_Element();}
662 FDECL int FTN_NAME(TCHARM_NUM_ELEMENTS,tcharm_num_elements)(void) 
663 { return TCHARM_Num_elements();}
664
665 //Make sure this address will migrate with us when we move:
666 static void checkAddress(void *data)
667 {
668         if (tcharm_nomig||tcharm_nothreads) return; //Stack is not isomalloc'd
669         if (!CmiIsomallocInRange(data))
670             CkAbort("The UserData you register must be allocated on the stack!\n");
671 }
672
673 /* Old "register"-based userdata: */
674 CDECL int TCHARM_Register(void *data,TCHARM_Pup_fn pfn)
675
676         TCHARMAPI("TCHARM_Register");
677         checkAddress(data);
678         return TCharm::get()->add(TCharm::UserData(pfn,data));
679 }
680 FDECL int FTN_NAME(TCHARM_REGISTER,tcharm_register)
681         (void *data,TCpupUserDataF pfn)
682
683         TCHARMAPI("TCHARM_Register");
684         checkAddress(data);
685         return TCharm::get()->add(TCharm::UserData(
686                 pfn,data,TCharm::UserData::isFortran()));
687 }
688
689 CDECL void *TCHARM_Get_userdata(int id)
690 {
691         TCHARMAPI("TCHARM_Get_userdata");
692         return TCharm::get()->lookupUserData(id);
693 }
694 FDECL void *FTN_NAME(TCHARM_GET_USERDATA,tcharm_get_userdata)(int *id)
695 { return TCHARM_Get_userdata(*id); }
696
697 /* New hardcoded-ID userdata: */
698 CDECL void TCHARM_Set_global(int globalID,void *new_value,TCHARM_Pup_global_fn pup_or_NULL)
699 {
700         TCHARMAPI("TCHARM_Set_global");
701         TCharm *tc=TCharm::get();
702         if (tc->sud.length()<=globalID)
703         { //We don't have room for this ID yet: make room
704                 int newLen=2*globalID;
705                 tc->sud.setSize(newLen);
706                 tc->sud.length()=newLen;
707         }
708         tc->sud[globalID]=TCharm::UserData((TCHARM_Pup_fn) pup_or_NULL,new_value);
709 }
710 CDECL void *TCHARM_Get_global(int globalID)
711 {
712         //Skip TCHARMAPI("TCHARM_Get_global") because there's no dynamic allocation here,
713         // and this routine should be as fast as possible.
714         CkVec<TCharm::UserData> &v=TCharm::get()->sud;
715         if (v.length()<=globalID) return NULL; //Uninitialized global
716         return v[globalID].getData();
717 }
718
719 CDECL void TCHARM_Migrate(void)
720 {
721         TCHARMAPI("TCHARM_Migrate");
722         TCharm::get()->migrate();
723 }
724 FORTRAN_AS_C(TCHARM_MIGRATE,TCHARM_Migrate,tcharm_migrate,(void),())
725
726 CDECL void TCHARM_Migrate_to(int destPE)
727 {
728         TCHARMAPI("TCHARM_Migrate_to");
729         TCharm::get()->migrateTo(destPE);
730 }
731 FORTRAN_AS_C(TCHARM_MIGRATE_TO,TCHARM_Migrate_to,tcharm_migrate_to,
732         (int *destPE),(*destPE))
733
734 CDECL void TCHARM_Yield(void)
735 {
736         TCHARMAPI("TCHARM_Yield");
737         TCharm::get()->schedule();
738 }
739 FORTRAN_AS_C(TCHARM_YIELD,TCHARM_Yield,tcharm_yield,(void),())
740
741 CDECL void TCHARM_Barrier(void)
742 {
743         TCHARMAPI("TCHARM_Barrier");
744         TCharm::get()->barrier();
745 }
746 FORTRAN_AS_C(TCHARM_BARRIER,TCHARM_Barrier,tcharm_barrier,(void),())
747
748 CDECL void TCHARM_Done(void)
749 {
750         TCHARMAPI("TCHARM_Done");
751         if (TCharm::getState()!=inDriver) CkExit();
752         else TCharm::get()->done();
753 }
754 FORTRAN_AS_C(TCHARM_DONE,TCHARM_Done,tcharm_done,(void),())
755
756
757 CDECL double TCHARM_Wall_timer(void)
758 {
759   TCHARMAPI("TCHARM_Wall_timer");
760   if(TCharm::getState()!=inDriver) return CkWallTimer();
761   else { //Have to apply current thread's time offset
762     return CkWallTimer()+TCharm::get()->getTimeOffset();
763   }
764 }
765
766 #if 1
767 /*Include Fortran-style "iargc" and "getarg" routines.
768 These are needed to get access to the command-line arguments from Fortran.
769 */
770 FDECL int FTN_NAME(TCHARM_IARGC,tcharm_iargc)(void) {
771   TCHARMAPI("tcharm_iargc");
772   return CkGetArgc()-1;
773 }
774
775 FDECL void FTN_NAME(TCHARM_GETARG,tcharm_getarg)
776         (int *i_p,char *dest,int destLen)
777 {
778   TCHARMAPI("tcharm_getarg");
779   int i=*i_p;
780   if (i<0) CkAbort("tcharm_getarg called with negative argument!");
781   if (i>=CkGetArgc()) CkAbort("tcharm_getarg called with argument > iargc!");
782   const char *src=CkGetArgv()[i];
783   strcpy(dest,src);
784   for (i=strlen(dest);i<destLen;i++) dest[i]=' ';
785 }
786
787 #endif
788
789 //These silly routines are used for serial startup:
790 extern void _initCharm(int argc, char **argv);
791 CDECL void TCHARM_Init(int *argc,char ***argv) {
792         if (!tcharm_initted) {
793           ConverseInit(*argc, *argv, (CmiStartFn) _initCharm,1,1);
794           _initCharm(*argc,*argv);
795         }
796 }
797
798 FDECL void FTN_NAME(TCHARM_INIT,tcharm_init)(void)
799 {
800         int argc=1;
801         char *argv_sto[2]={"foo",NULL};
802         char **argv=argv_sto;
803         TCHARM_Init(&argc,&argv);
804 }
805
806 /***********************************
807 * TCHARM Semaphores:
808 * The idea is one side "puts", the other side "gets"; 
809 * but the calls can come in any order--
810 * if the "get" comes first, it blocks until the put.
811 * This makes a convenient, race-condition-free way to do
812 * onetime initializations.  
813 */
814 /// Find this semaphore, or insert if there isn't one:
815 TCharm::TCharmSemaphore *TCharm::findSema(int id) {
816         for (int s=0;s<sema.size();s++)
817                 if (sema[s].id==id) 
818                         return &sema[s];
819         sema.push_back(TCharmSemaphore(id));
820         return &sema[sema.size()-1];
821 }
822 /// Remove this semaphore from the list
823 void TCharm::freeSema(TCharmSemaphore *doomed) {
824         int id=doomed->id;
825         for (int s=0;s<sema.size();s++)
826                 if (sema[s].id==id) {
827                         sema[s]=sema[sema.length()-1];
828                         sema.length()--;
829                         return;
830                 }
831         CkAbort("Tried to free nonexistent TCharm semaphore");
832 }
833
834 /// Block until this semaphore has data:
835 TCharm::TCharmSemaphore *TCharm::getSema(int id) {
836         TCharmSemaphore *s=findSema(id);
837         if (s->data==NULL) 
838         { //Semaphore isn't filled yet: wait until it is
839                 s->thread=CthSelf();
840                 suspend(); //Will be woken by semaPut
841                 // Semaphore may have moved-- find it again
842                 s=findSema(id);
843                 if (s->data==NULL) CkAbort("TCharm::semaGet awoken too early!");
844         }
845         return s;
846 }
847
848 /// Store data at the semaphore "id".
849 ///  The put can come before or after the get.
850 void TCharm::semaPut(int id,void *data) {
851         TCharmSemaphore *s=findSema(id);
852         if (s->data!=NULL) CkAbort("Duplicate calls to TCharm::semaPut!");
853         s->data=data;
854         if (s->thread!=NULL) {//Awaken the thread
855                 s->thread=NULL;
856                 resume();
857         }
858 }
859
860 /// Retreive data from the semaphore "id".
861 ///  Blocks if the data is not immediately available.
862 ///  Consumes the data, so another put will be required for the next get.
863 void *TCharm::semaGet(int id) {
864         TCharmSemaphore *s=getSema(id);
865         void *ret=s->data;
866         // Now remove the semaphore from the list:
867         freeSema(s);
868         return ret;
869 }
870
871 /// Retreive data from the semaphore "id".
872 ///  Blocks if the data is not immediately available.
873 void *TCharm::semaGets(int id) {
874         TCharmSemaphore *s=getSema(id);
875         return s->data;
876 }
877
878 /// Retreive data from the semaphore "id", or returns NULL.
879 void *TCharm::semaPeek(int id) {
880         TCharmSemaphore *s=findSema(id);
881         return s->data;
882 }
883
884 #include "tcharm.def.h"