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