Removed old checkpoint/restart mechanism
[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 CpvDeclare(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                 curLibs++;
47         }
48         inline int isTracing(const char *lib) const {
49                 if (curLibs==0) return 0; //Common case
50                 else return checkIfTracing(lib);
51         }
52 };
53 static TCharmTraceLibList tcharm_tracelibs;
54 static int tcharm_nomig=0, tcharm_nothreads=0;
55 static int tcharm_stacksize=1*1024*1024; /*Default stack size is 1MB*/
56
57 void TCharm::nodeInit(void)
58 {
59   CtvInitialize(TCharm *,_curTCharm);
60   CtvAccess(_curTCharm)=NULL;
61   CpvInitialize(inState,_stateTCharm);
62   CmiArgGroup("Library","TCharm");
63   char **argv=CkGetArgv();
64   tcharm_nomig=CmiGetArgFlagDesc(argv,"+tcharm_nomig","Disable migration support (debugging)");
65   tcharm_nothreads=CmiGetArgFlagDesc(argv,"+tcharm_nothread","Disable thread support (debugging)");
66   tcharm_nothreads|=CmiGetArgFlagDesc(argv,"+tcharm_nothreads",NULL);
67   char *traceLibName=NULL;
68   while (CmiGetArgStringDesc(argv,"+tcharm_trace",&traceLibName,"Print each call to this library"))
69       tcharm_tracelibs.addTracing(traceLibName);
70   CmiGetArgIntDesc(argv,"+tcharm_stacksize",&tcharm_stacksize,"Set the thread stack size (default 1MB)");
71   if (CkMyPe()!=0) { //Processor 0 eats "+vp<N>" and "-vp<N>" later:
72         int ignored;
73         while (CmiGetArgIntDesc(argv,"-vp",&ignored,NULL)) {}
74         while (CmiGetArgIntDesc(argv,"+vp",&ignored,NULL)) {}
75   }
76
77   TCharm::setState(inNodeSetup);
78   TCHARM_User_node_setup();
79   FTN_NAME(TCHARM_USER_NODE_SETUP,tcharm_user_node_setup)();
80   TCharm::setState(inInit);
81 }
82
83 void TCHARM_Api_trace(const char *routineName,const char *libraryName)
84 {
85         if (!tcharm_tracelibs.isTracing(libraryName)) return;
86         TCharm *tc=CtvAccess(_curTCharm);
87         char where[100];
88         if (tc==NULL) sprintf(where,"[serial context on %d]",CkMyPe());
89         else sprintf(where,"[%p> vp %d, p %d]",(void *)tc,tc->getElement(),CkMyPe());
90         CmiPrintf("%s Called routine %s\n",where,routineName);
91         CmiPrintStackTrace(1);
92         CmiPrintf("\n");
93 }
94
95 static void startTCharmThread(TCharmInitMsg *msg)
96 {
97         TCharm::setState(inDriver);
98         CtvAccess(_curTCharm)->activateHeap();
99         typedef void (*threadFn_t)(void *);
100         ((threadFn_t)msg->threadFn)(msg->data);
101         CmiIsomallocBlockListActivate(NULL); //Turn off migratable memory
102         CtvAccess(_curTCharm)->done();
103 }
104
105 TCharm::TCharm(TCharmInitMsg *initMsg_)
106 {
107   initMsg=initMsg_;
108   timeOffset=0.0;
109   if (tcharm_nothreads)
110   { //Don't even make a new thread-- just use main thread
111     tid=CthSelf();
112   }
113   else /*Create a thread normally*/
114   {
115     if (tcharm_nomig) { /*Nonmigratable version, for debugging*/
116       tid=CthCreate((CthVoidFn)startTCharmThread,initMsg,initMsg->stackSize);
117     } else {
118       tid=CthCreateMigratable((CthVoidFn)startTCharmThread,initMsg,initMsg->stackSize);
119     }
120   }
121   CtvAccessOther(tid,_curTCharm)=this;
122   TCharm::setState(inInit);
123   isStopped=true;
124   threadInfo.tProxy=CProxy_TCharm(thisArrayID);
125   threadInfo.thisElement=thisIndex;
126   threadInfo.numElements=initMsg->numElements;
127   heapBlocks=CmiIsomallocBlockListNew();
128   nUd=0;
129   usesAtSync=CmiTrue;
130   ready();
131 }
132
133 TCharm::TCharm(CkMigrateMessage *msg)
134         :ArrayElement1D(msg)
135 {
136   initMsg=NULL;
137   tid=NULL;
138   threadInfo.tProxy=CProxy_TCharm(thisArrayID);
139 }
140
141 void TCharm::pup(PUP::er &p) {
142 //Pup superclass
143   ArrayElement1D::pup(p);
144
145   p(isStopped);
146   p(threadInfo.thisElement);
147   p(threadInfo.numElements);
148
149 #ifndef CMK_OPTIMIZE
150   DBG("Packing thread");
151   if (!isStopped)
152     CkAbort("Cannot pup a running thread.  You must suspend before migrating.\n");
153   if (tcharm_nomig) CkAbort("Cannot migrate with the +tcharm_nomig option!\n");
154 #endif
155
156 //Pup thread (EVIL & UGLY):
157   //This seekBlock allows us to reorder the packing/unpacking--
158   // This is needed because the userData depends on the thread's stack
159   // and heap data both at pack and unpack time.
160   PUP::seekBlock s(p,2);
161   if (p.isUnpacking())
162   {//In this case, unpack the thread & heap before the user data
163     s.seek(1);
164     tid = CthPup((pup_er) &p, tid);
165     CtvAccessOther(tid,_curTCharm)=this;
166     CmiIsomallocBlockListPup((pup_er) &p,&heapBlocks);
167     //Restart our clock: set it up so packTime==CkWallTimer+timeOffset
168     double packTime;
169     p(packTime);
170     timeOffset=packTime-CkWallTimer();
171   }
172
173   //Pack all user data
174   TCharm::setState(inPup);
175   s.seek(0);
176   p(nUd);
177   for(int i=0;i<nUd;i++)
178     ud[i].pup(p);
179   p|sud;
180   TCharm::setState(inFramework);
181
182   if (!p.isUnpacking())
183   {//In this case, pack the thread & heap after the user data
184     s.seek(1);
185     tid = CthPup((pup_er) &p, tid);
186     CmiIsomallocBlockListPup((pup_er) &p,&heapBlocks);
187     //Stop our clock:
188     double packTime=CkWallTimer()+timeOffset;
189     p(packTime);
190   }
191   s.endBlock(); //End of seeking block
192 }
193
194 //Pup one group of user data
195 void TCharm::UserData::pup(PUP::er &p)
196 {
197   pup_er pext=(pup_er)(&p);
198   p(isC);
199   //Save address of userdata-- assumes user data is on the stack
200   p((void*)&data,sizeof(data));
201   if (isC) { //C version
202     //FIXME: function pointers may not be valid across processors
203     p((void*)&cfn, sizeof(TCpupUserDataC));
204     if (cfn) cfn(pext,data);
205   }
206   else { //Fortran version
207     //FIXME: function pointers may not be valid across processors
208     p((void*)&ffn, sizeof(TCpupUserDataF));
209     if (ffn) ffn(pext,data);
210   }
211 }
212
213 TCharm::~TCharm()
214 {
215   CmiIsomallocBlockListDelete(heapBlocks);
216   CthFree(tid);
217   delete initMsg;
218 }
219
220 // clear the data before restarting from disk
221 void TCharm::clear()
222 {
223   CmiIsomallocBlockListDelete(heapBlocks);
224   CthFree(tid);
225   delete initMsg;
226 }
227
228 //Register user data to be packed with the thread
229 int TCharm::add(const TCharm::UserData &d)
230 {
231   if (nUd>=maxUserData)
232     CkAbort("TCharm: Registered too many user data fields!\n");
233   int nu=nUd++;
234   ud[nu]=d;
235   return nu;
236 }
237 void *TCharm::lookupUserData(int i) {
238         if (i<0 || i>=nUd)
239                 CkAbort("Bad user data index passed to TCharmGetUserdata!\n");
240         return ud[i].getData();
241 }
242
243 //Start the thread running
244 void TCharm::run(void)
245 {
246   DBG("TCharm::run()");
247   start();
248 }
249
250 //Block the thread until start()ed again.
251 void TCharm::stop(void)
252 {
253   if (isStopped) return; //Nothing to do
254 #ifndef CMK_OPTIMIZE
255   DBG("suspending thread");
256   if (tid != CthSelf())
257     CkAbort("Called TCharm::stop from outside TCharm thread!\n");
258   if (tcharm_nothreads)
259     CkAbort("Cannot make blocking calls using +tcharm_nothreads!\n");
260 #endif
261   isStopped=true;
262   stopTiming();
263   TCharm::setState(inFramework);
264   CthSuspend();
265   TCharm::setState(inDriver);
266   /*We have to do the get() because "this" may have changed
267     during a migration-suspend.*/
268   TCharm::get()->startTiming();
269 }
270
271 //Resume the waiting thread
272 void TCharm::start(void)
273 {
274   if (!isStopped) return; //Already started
275   isStopped=false;
276   TCharm::setState(inDriver);
277   DBG("awakening thread");
278   if (tcharm_nothreads) /*Call user routine directly*/
279           startTCharmThread(initMsg);
280   else /*Jump to thread normally*/
281           CthAwaken(tid);
282 }
283
284 //Go to sync, block, possibly migrate, and then resume
285 void TCharm::migrate(void)
286 {
287 #if CMK_LBDB_ON
288   DBG("going to sync");
289   AtSync();
290   stop();
291 #else
292   DBG("skipping sync, because there is no load balancer");
293 #endif
294 }
295
296 //Resume from sync: start the thread again
297 void TCharm::ResumeFromSync(void)
298 {
299   start();
300 }
301
302 #ifndef CMK_OPTIMIZE
303 //Make sure we're actually in driver
304 void TCharm::check(void)
305 {
306         if (getState()!=inDriver)
307                 ::CkAbort("TCharm> Can only use that routine from within driver!\n");
308 }
309 #endif
310
311 static int propMapCreated=0;
312 static CkGroupID propMapID;
313 CkGroupID CkCreatePropMap(void);
314
315 static void TCHARM_Build_threads(TCharmInitMsg *msg,TCharmSetupCookie &cook)
316 {
317         CkArrayOptions opts(msg->numElements);
318         if (!propMapCreated) {
319                 propMapCreated=1;
320                 propMapID=CkCreatePropMap();
321         }
322         opts.setMap(propMapID);
323         int nElem=msg->numElements; //<- save it because msg will be deleted.
324         CkArrayID id=CProxy_TCharm::ckNew(msg,opts);
325         cook.setThreads(id,nElem);
326 }
327
328 /****** TcharmClient ******/
329 void TCharmClient1D::ckJustMigrated(void) {
330   ArrayElement1D::ckJustMigrated();
331   tcharmClientInit();
332 }
333
334 void TCharmClient1D::pup(PUP::er &p) {
335   ArrayElement1D::pup(p);
336   p|threadProxy;
337 }
338
339
340 /****** Readonlys *****/
341 CkVec<TCpupReadonlyGlobal> TCharmReadonlys::entries;
342 void TCharmReadonlys::add(TCpupReadonlyGlobal fn)
343 {
344         entries.push_back(fn);
345 }
346
347 //Pups all registered readonlys
348 void TCharmReadonlys::pupAllReadonlys(PUP::er &p) {
349         //Pup the globals for this node:
350         int i,n=entries.length();
351         p.comment("TCharm Readonly global variables:");
352         p(n);
353         if (n!=entries.length())
354                 CkAbort("TCharmReadonly list length mismatch!\n");
355         for (i=0;i<n;i++)
356                 (entries[i])((pup_er)&p);
357 }
358
359 void TCharmReadonlys::pup(PUP::er &p) {
360         if (p.isUnpacking()) {
361                 //HACK: Rather than sending this message only where its needed,
362                 // we send it everywhere and just ignore it if it's not needed.
363                 if (CkMyPe()==0) return; //Processor 0 is the source-- no unpacking needed
364                 if (CkMyRank()!=0) return; //Some other processor will do the unpacking
365         }
366         pupAllReadonlys(p);
367 }
368
369 CDECL void TCHARM_Readonly_globals(TCpupReadonlyGlobal fn)
370 {
371         TCHARMAPI("TCHARM_Readonly_globals");
372         if (TCharm::getState()!=inNodeSetup)
373                 CkAbort("Can only call TCHARM_ReadonlyGlobals from in TCHARM_UserNodeSetup!\n");
374         TCharmReadonlys::add(fn);
375 }
376 FDECL void FTN_NAME(TCHARM_READONLY_GLOBALS,tcharm_readonly_globals)
377         (TCpupReadonlyGlobal fn)
378 {
379         TCHARM_Readonly_globals(fn);
380 }
381
382 /************* Startup/Shutdown Coordination Support ************/
383
384 enum {TC_READY=23, TC_BARRIER=87, TC_DONE=42};
385
386 //Called when a client is ready to run
387 void TCharm::ready(void) {
388         DBG("TCharm thread "<<thisIndex<<" ready")
389         int vals[2]={0,1};
390         if (thisIndex==0) vals[0]=TC_READY;
391         //Contribute to a synchronizing reduction
392         contribute(sizeof(vals),&vals,CkReduction::sum_int);
393 }
394
395 //Called when we want to go to a barrier
396 void TCharm::barrier(void) {
397         int vals[2]={0,1};
398         if (thisIndex==0) vals[0]=TC_BARRIER;
399         //Contribute to a synchronizing reduction
400         contribute(sizeof(vals),&vals,CkReduction::sum_int);
401         stop();
402 }
403
404 //Called when the thread is done running
405 void TCharm::done(void) {
406         DBG("TCharm thread "<<thisIndex<<" done")
407         int vals[2]={0,1};
408         if (thisIndex==0) vals[0]=TC_DONE;
409         //Contribute to a synchronizing reduction
410         contribute(sizeof(vals),&vals,CkReduction::sum_int);
411         stop();
412 }
413
414 //Called when an array reduction is complete
415 static void coordinatorReduction(void *coord_,int dataLen,void *reductionData)
416 {
417         TCharmCoordinator *coord=(TCharmCoordinator *)coord_;
418         int *vals=(int *)reductionData;
419         if (dataLen!=2*sizeof(int))
420                 CkAbort("Unexpected length in TCharm array reduction!\n");
421         DBGX("Finished coordinator reduction: "<<vals[0]<<", "<<vals[1]);
422         switch (vals[0]) {
423         case TC_READY: coord->clientReady(); break;
424         case TC_BARRIER: coord->clientBarrier(); break;
425         case TC_DONE: coord->clientDone(); break;
426         default:
427                 CkAbort("Unexpected value from TCharm array reduction!\n");
428         };
429 }
430
431 int TCharmCoordinator::nArrays=0; //Total number of running thread arrays
432 TCharmCoordinator *TCharmCoordinator::head=NULL; //List of coordinators
433
434
435 TCharmCoordinator::TCharmCoordinator(CkArrayID threads_,int nThreads_)
436         :threads(threads_), nThreads(nThreads_), nClients(0), nReady(0)
437 {
438         nArrays++;
439         //Link into the coordinator list
440         next=head;
441         head=this;
442
443         threads.setReductionClient(coordinatorReduction,this);
444         nClients=1; //Thread array itself is a client
445 }
446 TCharmCoordinator::~TCharmCoordinator()
447 {
448         //Coordinators never get deleted
449 }
450 void TCharmCoordinator::addClient(const CkArrayID &client)
451 {
452         nClients++;
453 }
454 void TCharmCoordinator::clientReady(void)
455 {
456         DBGX("client "<<nReady+1<<" of "<<nClients<<" ready");
457         nReady++;
458         if (nReady>=nClients) { //All client arrays are ready-- start threads
459                 DBGX("starting threads");
460                 threads.run();
461         }
462 }
463 void TCharmCoordinator::clientBarrier(void)
464 {
465         DBGX("clients all at barrier");
466         threads.run();
467 }
468 void TCharmCoordinator::clientDone(void)
469 {
470         DBGX("clientDone");     
471         nArrays--;
472         if (nArrays<=0) { //All arrays have exited
473                 DBGX("done with computation");
474                 CkExit();
475         }
476 }
477
478 /************* Setup **************/
479
480 //Cookie used during setup
481 TCharmSetupCookie *TCharmSetupCookie::theCookie;
482
483 //Globals used to control setup process
484 static int g_numDefaultSetups=0;
485 static TCHARM_Fallback_setup_fn g_fallbackSetup=NULL;
486 void TCHARM_Set_fallback_setup(TCHARM_Fallback_setup_fn f)
487 {
488         g_fallbackSetup=f;
489 }
490 CDECL void TCharmInDefaultSetup(void) {
491         g_numDefaultSetups++;
492 }
493
494 //Tiny simple main chare
495 class TCharmMain : public Chare {
496 public:
497   TCharmMain(CkArgMsg *msg) {
498     if (0!=tcharm_nomig)
499         CmiPrintf("TCHARM> Disabling migration support, for debugging\n");
500     if (0!=tcharm_nothreads)
501        CmiPrintf("TCHARM> Disabling thread support, for debugging\n");
502
503     TCharmSetupCookie cookie(msg->argv);
504     TCharmSetupCookie::theCookie=&cookie;
505     g_numDefaultSetups=0;
506     
507     /*Call user-overridable C setup*/
508     TCHARM_User_setup();
509     /*Call user-overridable Fortran setup*/
510     FTN_NAME(TCHARM_USER_SETUP,tcharm_user_setup)();
511     
512     if (g_numDefaultSetups==2) 
513     { //User didn't override either setup routine
514             if (g_fallbackSetup)
515                     (g_fallbackSetup)();
516             else
517                     CmiAbort("You need to override TCharmUserSetup to start your computation, or else link in a framework module\n");
518     }       
519     
520     delete msg;
521     
522     if (0==TCharmCoordinator::getTotal())
523             CkAbort("You didn't create any TCharm arrays in TCharmUserSetup!\n");
524
525     //Send out the readonly globals:
526     TCharmReadonlys r;
527     CProxy_TCharmReadonlyGroup::ckNew(r);
528   }
529 };
530
531 #ifndef CMK_OPTIMIZE
532 /*The setup cookie, used to store global initialization state*/
533 TCharmSetupCookie &TCharmSetupCookie::check(void)
534 {
535         if (magic!=correctMagic)
536                 CkAbort("TCharm setup cookie is damaged!\n");
537         return *this;
538 }
539 #endif
540
541 void TCharmSetupCookie::setThreads(const CkArrayID &aid,int nel)
542 {
543         coord=new TCharmCoordinator(aid,nel);
544         tc=aid; numElements=nel;
545 }
546
547 TCharmSetupCookie::TCharmSetupCookie(char **argv_)
548 {
549         magic=correctMagic;
550         argv=argv_;
551         coord=NULL;
552         stackSize=tcharm_stacksize;
553 }
554
555 CkArrayOptions TCHARM_Attach_start(CkArrayID *retTCharmArray,int *retNumElts)
556 {
557         TCharmSetupCookie *tc=TCharmSetupCookie::get();
558         if (!tc->hasThreads())
559                 CkAbort("You must create a thread array with TCharmCreate before calling Attach!\n");
560         int nElts=tc->getNumElements();
561         if (retNumElts!=NULL) *retNumElts=nElts;
562         *retTCharmArray=tc->getThreads();
563         CkArrayOptions opts(nElts);
564         opts.bindTo(tc->getThreads());
565         return opts;
566 }
567 void TCHARM_Attach_finish(const CkArrayID &libraryArray)
568 {
569         TCharmSetupCookie *tc=TCharmSetupCookie::get();
570         tc->addClient(libraryArray);
571 }
572
573
574 /************** User API ***************/
575
576 #define cookie (*TCharmSetupCookie::get())
577
578 /**********************************
579 Callable from UserSetup:
580 */
581
582 /*Set the size of the thread stack*/
583 CDECL void TCHARM_Set_stack_size(int newStackSize)
584 {
585         TCHARMAPI("TCHARM_Set_stack_size");
586         if (TCharm::getState()!=inInit)
587                 CkAbort("TCharm> Can only set stack size from in init!\n");
588         cookie.setStackSize(newStackSize);
589 }
590 FDECL void FTN_NAME(TCHARM_SET_STACK_SIZE,tcharm_set_stack_size)
591         (int *newSize)
592 { TCHARM_Set_stack_size(*newSize); }
593
594
595 /*Create a new array of threads, which will be bound to by subsequent libraries*/
596 CDECL void TCHARM_Create(int nThreads,
597                         TCHARM_Thread_start_fn threadFn)
598 {
599         TCHARMAPI("TCHARM_Create");
600         TCHARM_Create_data(nThreads,
601                          (TCHARM_Thread_data_start_fn)threadFn,NULL,0);
602 }
603 FDECL void FTN_NAME(TCHARM_CREATE,tcharm_create)
604         (int *nThreads,TCHARM_Thread_start_fn threadFn)
605 { TCHARM_Create(*nThreads,threadFn); }
606
607
608 /*As above, but pass along (arbitrary) data to threads*/
609 CDECL void TCHARM_Create_data(int nThreads,
610                   TCHARM_Thread_data_start_fn threadFn,
611                   void *threadData,int threadDataLen)
612 {
613         TCHARMAPI("TCHARM_Create_data");
614         if (TCharm::getState()!=inInit)
615                 CkAbort("TCharm> Can only create threads from in init!\n");
616         TCharmSetupCookie &cook=cookie;
617         TCharmInitMsg *msg=new (threadDataLen,0) TCharmInitMsg(
618                 (CthVoidFn)threadFn,cook.getStackSize());
619         msg->numElements=nThreads;
620         memcpy(msg->data,threadData,threadDataLen);
621         TCHARM_Build_threads(msg,cook);
622 }
623
624 FDECL void FTN_NAME(TCHARM_CREATE_DATA,tcharm_create_data)
625         (int *nThreads,
626                   TCHARM_Thread_data_start_fn threadFn,
627                   void *threadData,int *threadDataLen)
628 { TCHARM_Create_data(*nThreads,threadFn,threadData,*threadDataLen); }
629
630
631 CDECL int TCHARM_Get_num_chunks(void)
632 {
633         TCHARMAPI("TCHARM_Get_num_chunks");
634         if (CkMyPe()!=0) CkAbort("TCHARM_Get_num_chunks should only be called on PE 0 during setup!");
635         int nChunks=CkNumPes();
636         char **argv=CkGetArgv();
637         CmiGetArgIntDesc(argv,"-vp",&nChunks,"Set the total number of virtual processors");
638         CmiGetArgIntDesc(argv,"+vp",&nChunks,NULL);
639         lastNumChunks=nChunks;
640         return nChunks;
641 }
642 FDECL int FTN_NAME(TCHARM_GET_NUM_CHUNKS,tcharm_get_num_chunks)(void)
643 {
644         return TCHARM_Get_num_chunks();
645 }
646
647
648 /***********************************
649 Callable from worker thread
650 */
651 CDECL int TCHARM_Element(void)
652
653         TCHARMAPI("TCHARM_Element");
654         return TCharm::get()->getElement();
655 }
656 CDECL int TCHARM_Num_elements(void)
657
658         TCHARMAPI("TCHARM_Num_elements");
659         if (TCharm::getState()==inDriver)
660                 return TCharm::get()->getNumElements();
661         else
662                 return lastNumChunks;
663 }
664
665 FDECL int FTN_NAME(TCHARM_ELEMENT,tcharm_element)(void) 
666 { return TCHARM_Element();}
667 FDECL int FTN_NAME(TCHARM_NUM_ELEMENTS,tcharm_num_elements)(void) 
668 { return TCHARM_Num_elements();}
669
670 //Make sure this address will migrate with us when we move:
671 static void checkAddress(void *data)
672 {
673         if (tcharm_nomig||tcharm_nothreads) return; //Stack is not isomalloc'd
674         if (!CmiIsomallocInRange(data))
675             CkAbort("The UserData you register must be allocated on the stack!\n");
676 }
677
678 /* Old "register"-based userdata: */
679 CDECL int TCHARM_Register(void *data,TCHARM_Pup_fn pfn)
680
681         TCHARMAPI("TCHARM_Register");
682         checkAddress(data);
683         return TCharm::get()->add(TCharm::UserData(pfn,data));
684 }
685 FDECL int FTN_NAME(TCHARM_REGISTER,tcharm_register)
686         (void *data,TCpupUserDataF pfn)
687
688         TCHARMAPI("TCHARM_Register");
689         checkAddress(data);
690         return TCharm::get()->add(TCharm::UserData(
691                 pfn,data,TCharm::UserData::isFortran()));
692 }
693
694 CDECL void *TCHARM_Get_userdata(int id)
695 {
696         TCHARMAPI("TCHARM_Get_userdata");
697         return TCharm::get()->lookupUserData(id);
698 }
699 FDECL void *FTN_NAME(TCHARM_GET_USERDATA,tcharm_get_userdata)(int *id)
700 { return TCHARM_Get_userdata(*id); }
701
702 /* New hardcoded-ID userdata: */
703 CDECL void TCHARM_Set_global(int globalID,void *new_value,TCHARM_Pup_global_fn pup_or_NULL)
704 {
705         TCHARMAPI("TCHARM_Set_global");
706         TCharm *tc=TCharm::get();
707         if (tc->sud.length()<=globalID)
708         { //We don't have room for this ID yet: make room
709                 int newLen=2*globalID;
710                 tc->sud.setSize(newLen);
711                 tc->sud.length()=newLen;
712         }
713         tc->sud[globalID]=TCharm::UserData((TCHARM_Pup_fn) pup_or_NULL,new_value);
714 }
715 CDECL void *TCHARM_Get_global(int globalID)
716 {
717         //Skip TCHARMAPI("TCHARM_Get_global") because there's no dynamic allocation here,
718         // and this routine should be as fast as possible.
719         CkVec<TCharm::UserData> &v=TCharm::get()->sud;
720         if (v.length()<=globalID) return NULL; //Uninitialized global
721         return v[globalID].getData();
722 }
723
724 CDECL void TCHARM_Migrate(void)
725 {
726         TCHARMAPI("TCHARM_Migrate");
727         TCharm::get()->migrate();
728 }
729 FDECL void FTN_NAME(TCHARM_MIGRATE,tcharm_migrate)(void)
730 {
731         TCHARMAPI("TCHARM_Migrate");
732         TCharm::get()->migrate();
733 }
734
735 CDECL void TCHARM_Yield(void)
736 {
737         TCHARMAPI("TCHARM_Yield");
738         TCharm::get()->schedule();
739 }
740 FDECL void FTN_NAME(TCHARM_YIELD,tcharm_yield)(void)
741 {
742         TCHARM_Yield();
743 }
744
745 CDECL void TCHARM_Barrier(void)
746 {
747         TCHARMAPI("TCHARM_Barrier");
748         TCharm::get()->barrier();
749 }
750 FDECL void FTN_NAME(TCHARM_BARRIER,tcharm_barrier)(void)
751 {
752         TCHARM_Barrier();
753 }
754
755 CDECL void TCHARM_Done(void)
756 {
757         TCHARMAPI("TCHARM_Done");
758         if (TCharm::getState()!=inDriver) CkExit();
759         else TCharm::get()->done();
760 }
761 FDECL void FTN_NAME(TCHARM_DONE,tcharm_done)(void)
762 {
763         TCHARM_Done();
764 }
765
766 CDECL double TCHARM_Wall_timer(void)
767 {
768   TCHARMAPI("TCHARM_Wall_timer");
769   if(TCharm::getState()!=inDriver) return CkWallTimer();
770   else { //Have to apply current thread's time offset
771     return CkWallTimer()+TCharm::get()->getTimeOffset();
772   }
773 }
774
775 #if 1
776 /*Include Fortran-style "iargc" and "getarg" routines.
777 These are needed to get access to the command-line arguments from Fortran.
778 */
779 FDECL int FTN_NAME(TCHARM_IARGC,tcharm_iargc)(void) {
780   TCHARMAPI("tcharm_iargc");
781   return CkGetArgc()-1;
782 }
783
784 FDECL void FTN_NAME(TCHARM_GETARG,tcharm_getarg)
785         (int *i_p,char *dest,int destLen)
786 {
787   TCHARMAPI("tcharm_getarg");
788   int i=*i_p;
789   if (i<0) CkAbort("tcharm_getarg called with negative argument!");
790   if (i>=CkGetArgc()) CkAbort("tcharm_getarg called with argument > iargc!");
791   const char *src=CkGetArgv()[i];
792   strcpy(dest,src);
793   for (i=strlen(dest);i<destLen;i++) dest[i]=' ';
794 }
795
796 #endif
797
798 //These silly routines are used for serial startup:
799 extern void _initCharm(int argc, char **argv);
800 CDECL void TCHARM_Init(int *argc,char ***argv) {
801         ConverseInit(*argc, *argv, (CmiStartFn) _initCharm,1,1);
802         _initCharm(*argc,*argv);
803 }
804
805 FDECL void FTN_NAME(TCHARM_INIT,tcharm_init)(void)
806 {
807         int argc=1;
808         char *argv[2]={"foo",NULL};
809         ConverseInit(argc,argv, (CmiStartFn) _initCharm,1,1);
810         _initCharm(argc,argv);
811 }
812
813 #include "tcharm.def.h"