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