Merge branch 'charm' of charmgit:charm into charm
[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 "ckevacuation.h"
9 #include <ctype.h>
10
11 #if 0 
12     /*Many debugging statements:*/
13 #    define DBG(x) ckout<<"["<<thisIndex<<","<<CkMyPe()<<"] TCHARM> "<<x<<endl;
14 #    define DBGX(x) ckout<<"PE("<<CkMyPe()<<") TCHARM> "<<x<<endl;
15 #else
16     /*No debugging statements*/
17 #    define DBG(x) /*empty*/
18 #    define DBGX(x) /*empty*/
19 #endif
20
21 CtvDeclare(TCharm *,_curTCharm);
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 CkpvDeclare(int, mapCreated);
60 static CkGroupID mapID;
61 static char* mapping = NULL;
62
63 void TCharm::nodeInit(void)
64 {
65 }
66
67 void TCharm::procInit(void)
68 {
69   CtvInitialize(TCharm *,_curTCharm);
70   CtvAccess(_curTCharm)=NULL;
71   tcharm_initted=1;
72   CtgInit();
73
74   CkpvInitialize(int, mapCreated);
75   CkpvAccess(mapCreated) = 0;
76
77   // called on every pe to eat these arguments
78   char **argv=CkGetArgv();
79   tcharm_nomig=CmiGetArgFlagDesc(argv,"+tcharm_nomig","Disable migration support (debugging)");
80   tcharm_nothreads=CmiGetArgFlagDesc(argv,"+tcharm_nothread","Disable thread support (debugging)");
81   tcharm_nothreads|=CmiGetArgFlagDesc(argv,"+tcharm_nothreads",NULL);
82   char *traceLibName=NULL;
83   while (CmiGetArgStringDesc(argv,"+tcharm_trace",&traceLibName,"Print each call to this library"))
84       tcharm_tracelibs.addTracing(traceLibName);
85   // CmiGetArgIntDesc(argv,"+tcharm_stacksize",&tcharm_stacksize,"Set the thread stack size (default 1MB)");
86   char *str;
87   if (CmiGetArgStringDesc(argv,"+tcharm_stacksize",&str,"Set the thread stack size (default 1MB)"))  {
88     if (strpbrk(str,"M")) {
89       sscanf(str, "%dM", &tcharm_stacksize);
90       tcharm_stacksize *= 1024*1024;
91     }
92     else if (strpbrk(str,"K")) {
93       sscanf(str, "%dK", &tcharm_stacksize);
94       tcharm_stacksize *= 1024;
95     }
96     else {
97       sscanf(str, "%d", &tcharm_stacksize);
98     }
99     if (CkMyPe() == 0)
100       CkPrintf("TCharm> stack size is set to %d.\n", tcharm_stacksize);
101   }
102   if (CkMyPe()!=0) { //Processor 0 eats "+vp<N>" and "-vp<N>" later:
103         int ignored;
104         while (CmiGetArgIntDesc(argv,"-vp",&ignored,NULL)) {}
105         while (CmiGetArgIntDesc(argv,"+vp",&ignored,NULL)) {}
106   }
107   if (CkMyPe()==0) { // Echo various debugging options:
108     if (tcharm_nomig) CmiPrintf("TCHARM> Disabling migration support, for debugging\n");
109     if (tcharm_nothreads) CmiPrintf("TCHARM> Disabling thread support, for debugging\n");
110   }
111   if (CkpvAccess(mapCreated)==0) {
112     if (0!=CmiGetArgString(argv, "+mapping", &mapping)){
113     }
114     CkpvAccess(mapCreated)=1;
115   }
116 }
117
118 void TCHARM_Api_trace(const char *routineName,const char *libraryName)
119 {
120         if (!tcharm_tracelibs.isTracing(libraryName)) return;
121         TCharm *tc=CtvAccess(_curTCharm);
122         char where[100];
123         if (tc==NULL) sprintf(where,"[serial context on %d]",CkMyPe());
124         else sprintf(where,"[%p> vp %d, p %d]",(void *)tc,tc->getElement(),CkMyPe());
125         CmiPrintf("%s Called routine %s\n",where,routineName);
126         CmiPrintStackTrace(1);
127         CmiPrintf("\n");
128 }
129
130 // register thread start functions to get a function handler
131 // this is portable across heterogeneous platforms, or on machines with
132 // random stack/function pointer
133
134 static CkVec<TCHARM_Thread_data_start_fn> threadFnTable;
135
136 int TCHARM_Register_thread_function(TCHARM_Thread_data_start_fn fn)
137 {
138   int idx = threadFnTable.size();
139   threadFnTable.push_back(fn);
140   return idx+1;                     // make 0 invalid number
141 }
142
143 TCHARM_Thread_data_start_fn getTCharmThreadFunction(int idx)
144 {
145   CmiAssert(idx > 0);
146   return threadFnTable[idx-1];
147 }
148
149 static void startTCharmThread(TCharmInitMsg *msg)
150 {
151         DBGX("thread started");
152         TCharm::activateThread();
153        TCHARM_Thread_data_start_fn threadFn = getTCharmThreadFunction(msg->threadFn);
154         threadFn(msg->data);
155         TCharm::deactivateThread();
156         CtvAccess(_curTCharm)->done();
157 }
158
159 TCharm::TCharm(TCharmInitMsg *initMsg_)
160 {
161   initMsg=initMsg_;
162   initMsg->opts.sanityCheck();
163   timeOffset=0.0;
164   threadGlobals=CtgCreate();
165   if (tcharm_nothreads)
166   { //Don't even make a new thread-- just use main thread
167     tid=CthSelf();
168   }
169   else /*Create a thread normally*/
170   {
171     if (tcharm_nomig) { /*Nonmigratable version, for debugging*/
172       tid=CthCreate((CthVoidFn)startTCharmThread,initMsg,initMsg->opts.stackSize);
173     } else {
174       tid=CthCreateMigratable((CthVoidFn)startTCharmThread,initMsg,initMsg->opts.stackSize);
175     }
176 #if CMK_BLUEGENE_CHARM
177     BgAttach(tid);
178     BgUnsetStartOutOfCore();
179 #endif
180   }
181   CtvAccessOther(tid,_curTCharm)=this;
182   isStopped=true;
183   resumeAfterMigration=false;
184         /* FAULT_EVAC*/
185         AsyncEvacuate(CmiTrue);
186   skipResume=false;
187   exitWhenDone=initMsg->opts.exitWhenDone;
188   isSelfDone = false;
189   threadInfo.tProxy=CProxy_TCharm(thisArrayID);
190   threadInfo.thisElement=thisIndex;
191   threadInfo.numElements=initMsg->numElements;
192   if (CmiMemoryIs(CMI_MEMORY_IS_ISOMALLOC))
193         heapBlocks=CmiIsomallocBlockListNew();
194   else
195         heapBlocks=0;
196   nUd=0;
197   usesAtSync=CmiTrue;
198   run();
199 }
200
201 TCharm::TCharm(CkMigrateMessage *msg)
202         :CBase_TCharm(msg)
203 {
204   initMsg=NULL;
205   tid=NULL;
206   threadGlobals=NULL;
207   threadInfo.tProxy=CProxy_TCharm(thisArrayID);
208         AsyncEvacuate(CmiTrue);
209   heapBlocks=0;
210 }
211
212 void checkPupMismatch(PUP::er &p,int expected,const char *where)
213 {
214         int v=expected;
215         p|v;
216         if (v!=expected) {
217                 CkError("FATAL ERROR> Mismatch %s pup routine\n",where);
218                 CkAbort("FATAL ERROR: Pup direction mismatch");
219         }
220 }
221
222 void TCharm::pup(PUP::er &p) {
223 //Pup superclass
224   ArrayElement1D::pup(p);
225
226   //BIGSIM_OOC DEBUGGING
227   //if(!p.isUnpacking()){
228   //  CmiPrintf("TCharm[%d] packing: ", thisIndex);
229   //  CthPrintThdStack(tid);
230   //}
231
232   checkPupMismatch(p,5134,"before TCHARM");
233 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
234     if(!isStopped){
235 //      resumeAfterMigration = true;
236     }
237     isStopped = true;
238 #endif
239   p(isStopped); p(resumeAfterMigration); p(exitWhenDone); p(isSelfDone); p(skipResume);
240   p(threadInfo.thisElement);
241   p(threadInfo.numElements);
242   
243   if (sema.size()>0){
244         CkAbort("TCharm::pup> Cannot migrate with unconsumed semaphores!\n");
245   }
246
247 #ifndef CMK_OPTIMIZE
248   DBG("Packing thread");
249   if (!isStopped && !CmiMemoryIs(CMI_MEMORY_IS_ISOMALLOC)){
250     if(_BgOutOfCoreFlag==0) //not doing out-of-core scheduling
251         CkAbort("Cannot pup a running thread.  You must suspend before migrating.\n");
252   }     
253   if (tcharm_nomig) CkAbort("Cannot migrate with the +tcharm_nomig option!\n");
254 #endif
255
256   //This seekBlock allows us to reorder the packing/unpacking--
257   // This is needed because the userData depends on the thread's stack
258   // and heap data both at pack and unpack time.
259   PUP::seekBlock s(p,2);
260   
261   if (p.isUnpacking())
262   {//In this case, unpack the thread & heap before the user data
263     s.seek(1);
264     pupThread(p);
265     //Restart our clock: set it up so packTime==CkWallTimer+timeOffset
266     double packTime;
267     p(packTime);
268     timeOffset=packTime-CkWallTimer();
269   }
270   
271 //Pack all user data
272   // Set up TCHARM context for use during user's pup routines:
273   CtvAccess(_curTCharm)=this;
274   activateThread();
275
276   s.seek(0);
277   checkPupMismatch(p,5135,"before TCHARM user data");
278   p(nUd);
279   for(int i=0;i<nUd;i++) {
280     if (p.isUnpacking()) ud[i].update(tid);
281     ud[i].pup(p);
282   }
283   checkPupMismatch(p,5137,"after TCHARM_Register user data");
284
285   if (CmiMemoryIs(CMI_MEMORY_IS_ISOMALLOC))
286     deactivateThread();
287   p|sud;           //  sud vector block can not be in isomalloc
288   checkPupMismatch(p,5138,"after TCHARM_Global user data");
289   
290   // Tear down TCHARM context after calling user pup routines
291   if (!CmiMemoryIs(CMI_MEMORY_IS_ISOMALLOC))
292     deactivateThread();
293   CtvAccess(_curTCharm)=NULL;
294   
295   if (!p.isUnpacking())
296   {//In this case, pack the thread & heap after the user data
297     s.seek(1);
298     pupThread(p);
299     //Stop our clock:
300     double packTime=CkWallTimer()+timeOffset;
301     p(packTime);
302   }
303   
304   s.endBlock(); //End of seeking block
305   checkPupMismatch(p,5140,"after TCHARM");
306   
307   //BIGSIM_OOC DEBUGGING
308   //if(p.isUnpacking()){
309   //  CmiPrintf("TCharm[%d] unpacking: ", thisIndex);
310   //  CthPrintThdStack(tid);
311   //}
312
313 }
314
315 // Pup our thread and related data
316 void TCharm::pupThread(PUP::er &pc) {
317     pup_er p=(pup_er)&pc;
318     checkPupMismatch(pc,5138,"before TCHARM thread");
319     tid = CthPup(p, tid);
320     if (pc.isUnpacking()) {
321       CtvAccessOther(tid,_curTCharm)=this;
322 #if CMK_BLUEGENE_CHARM
323       BgAttach(tid);
324 #endif
325     }
326     if (CmiMemoryIs(CMI_MEMORY_IS_ISOMALLOC))
327       CmiIsomallocBlockListPup(p,&heapBlocks);
328     threadGlobals=CtgPup(p,threadGlobals);
329     checkPupMismatch(pc,5139,"after TCHARM thread");
330 }
331
332 //Pup one group of user data
333 void TCharm::UserData::pup(PUP::er &p)
334 {
335   pup_er pext=(pup_er)(&p);
336   p(mode);
337   switch(mode) {
338   case 'c': { /* C mode: userdata is on the stack, so keep address */
339 //     p((char*)&data,sizeof(data));
340      p(pos);
341      //FIXME: function pointers may not be valid across processors
342      p((char*)&cfn, sizeof(TCHARM_Pup_fn));
343      char *data = CthPointer(t, pos);
344      if (cfn) cfn(pext,data);
345      } break;
346   case 'g': { /* Global mode: zero out userdata on arrival */
347      if (CmiMemoryIs(CMI_MEMORY_IS_ISOMALLOC))
348      {
349         // keep the pointer value if using isomalloc, no need to use pup
350        p(pos);
351      }
352      else if (p.isUnpacking())      //  zero out userdata on arrival
353        pos=0;
354
355        //FIXME: function pointers may not be valid across processors
356      p((char*)&gfn, sizeof(TCHARM_Pup_global_fn));
357      if (gfn) gfn(pext);
358      } break;
359   default:
360      break;
361   };
362 }
363
364 TCharm::~TCharm()
365 {
366   //BIGSIM_OOC DEBUGGING
367   //CmiPrintf("TCharm destructor called with heapBlocks=%p!\n", heapBlocks);
368   
369   if (heapBlocks) CmiIsomallocBlockListDelete(heapBlocks);
370   CthFree(tid);
371   CtgFree(threadGlobals);
372   delete initMsg;
373 }
374
375 void TCharm::migrateTo(int destPE) {
376         if (destPE==CkMyPe()) return;
377         if (CthMigratable() == 0) {
378             CkPrintf("Warning> thread migration is not supported!\n");
379             return;
380         }
381         // Make sure migrateMe gets called *after* we suspend:
382         thisProxy[thisIndex].migrateDelayed(destPE);
383 //      resumeAfterMigration=true;
384         suspend();
385 }
386 void TCharm::migrateDelayed(int destPE) {
387         migrateMe(destPE);
388 }
389 void TCharm::ckJustMigrated(void) {
390         ArrayElement::ckJustMigrated();
391 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
392 //  resumeAfterMigration = true;
393 #endif
394         if (resumeAfterMigration) {
395                 resumeAfterMigration=false;
396                 resume(); //Start the thread running
397         }
398 }
399
400 void TCharm::ckJustRestored(void) {
401         //CkPrintf("call just restored from TCharm[%d]\n", thisIndex);
402         ArrayElement::ckJustRestored();
403         //if (resumeAfterMigration) {
404         //      resumeAfterMigration=false;
405         //      resume(); //Start the thread running
406         //}
407 }
408
409 /*
410         FAULT_EVAC
411
412         If a Tcharm object is about to migrate it should be suspended first
413 */
414 void TCharm::ckAboutToMigrate(void){
415         ArrayElement::ckAboutToMigrate();
416         resumeAfterMigration = true;
417         isStopped = true;
418 //      suspend();
419 }
420
421 // clear the data before restarting from disk
422 void TCharm::clear()
423 {
424   if (heapBlocks) CmiIsomallocBlockListDelete(heapBlocks);
425   CthFree(tid);
426   delete initMsg;
427 }
428
429 //Register user data to be packed with the thread
430 int TCharm::add(const TCharm::UserData &d)
431 {
432   if (nUd>=maxUserData)
433     CkAbort("TCharm: Registered too many user data fields!\n");
434   int nu=nUd++;
435   ud[nu]=d;
436   return nu;
437 }
438 void *TCharm::lookupUserData(int i) {
439         if (i<0 || i>=nUd)
440                 CkAbort("Bad user data index passed to TCharmGetUserdata!\n");
441         return ud[i].getData();
442 }
443
444 //Start the thread running
445 void TCharm::run(void)
446 {
447   DBG("TCharm::run()");
448   if (tcharm_nothreads) {/*Call user routine directly*/
449           startTCharmThread(initMsg);
450   } 
451   else /* start the thread as usual */
452           start();
453 }
454
455 //Block the thread until start()ed again.
456 void TCharm::stop(void)
457 {
458 #ifndef CMK_OPTIMIZE
459   if (tid != CthSelf())
460     CkAbort("Called TCharm::stop from outside TCharm thread!\n");
461   if (tcharm_nothreads)
462     CkAbort("Cannot make blocking calls using +tcharm_nothreads!\n");
463 #endif
464   stopTiming();
465   isStopped=true;
466   DBG("thread suspended");
467
468   CthSuspend();
469 //      DBG("thread resumed");
470   /*SUBTLE: We have to do the get() because "this" may have changed
471     during a migration-suspend.  If you access *any* members
472     from this point onward, you'll cause heap corruption if
473     we're resuming from migration!  (OSL 2003/9/23)
474    */
475   TCharm *dis=TCharm::get();
476 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_)) 
477 /*  CpvAccess(_currentObj) = dis;
478  *      printf("[%d] _currentObject set to TCharm index %d %p\n",CkMyPe(),dis->thisIndex,dis);*/
479 #endif
480   dis->isStopped=false;
481   dis->startTiming();
482   //CkPrintf("[%d] Thread resumed  for tid %p\n",dis->thisIndex,dis->tid);
483 }
484
485 //Resume the waiting thread
486 void TCharm::start(void)
487 {
488   //  since this thread is scheduled, it is not a good idea to migrate 
489   isStopped=false;
490   DBG("thread resuming soon");
491   //CkPrintf("TCharm[%d]::start()\n", thisIndex);
492   //CmiPrintStackTrace(0);
493 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
494 //CthAwakenPrio(tid, CQS_QUEUEING_BFIFO, 1, &prio);
495   CthAwaken(tid);
496 #else
497   CthAwaken(tid);
498 #endif
499 }
500
501 //Block our thread, schedule, and come back:
502 void TCharm::schedule(void) {
503   DBG("thread schedule");
504   start(); // Calls CthAwaken
505   stop(); // Calls CthSuspend
506 }
507
508 //Go to sync, block, possibly migrate, and then resume
509 void TCharm::migrate(void)
510 {
511 #if CMK_LBDB_ON
512   DBG("going to sync");
513   AtSync();
514   stop();
515 #else
516   DBG("skipping sync, because there is no load balancer");
517 #endif
518 }
519
520
521
522 void TCharm::evacuate(){
523         /*
524                 FAULT_EVAC
525         */
526         //CkClearAllArrayElementsCPP();
527         if(CkpvAccess(startedEvac)){
528                 int nextPE = getNextPE(CkArrayIndex1D(thisIndex));
529 //              resumeAfterMigration=true;
530                 CcdCallFnAfter((CcdVoidFn)CkEmmigrateElement, (void *)myRec, 1);
531                 suspend();
532                 return;
533         }
534         return;
535
536 }
537
538 //calls atsync with async mode
539 void TCharm::async_migrate(void)
540 {
541 #if CMK_LBDB_ON
542   DBG("going to sync at async mode");
543   skipResume = true;            // we resume immediately
544   ReadyMigrate(false);
545   AtSync(0);
546   schedule();
547 //  allow_migrate();
548 #else
549   DBG("skipping sync, because there is no load balancer");
550 #endif
551 }
552
553 /*
554 Note:
555  thread can only migrate at the point when this is called
556 */
557 void TCharm::allow_migrate(void)
558 {
559 #if CMK_LBDB_ON
560 //  ReadyMigrate(true);
561   int nextPe = MigrateToPe();
562   if (nextPe != -1) {
563     migrateTo(nextPe);
564   }
565 #else
566   DBG("skipping sync, because there is no load balancer");
567 #endif
568 }
569
570 //Resume from sync: start the thread again
571 void TCharm::ResumeFromSync(void)
572 {
573   //if(isSelfDone) return;
574   //if (exitWhenDone) return; //for bigsim ooc execution
575   if (!skipResume) start();
576 }
577
578
579 /****** TcharmClient ******/
580 void TCharmClient1D::ckJustMigrated(void) {
581   ArrayElement1D::ckJustMigrated();
582   findThread();
583   tcharmClientInit();
584 }
585
586 void TCharmClient1D::pup(PUP::er &p) {
587   ArrayElement1D::pup(p);
588   p|threadProxy;
589 }
590
591 CkArrayID TCHARM_Get_threads(void) {
592         TCHARMAPI("TCHARM_Get_threads");
593         return TCharm::get()->getProxy();
594 }
595
596 /************* Startup/Shutdown Coordination Support ************/
597
598 // Useless values to reduce over:
599 int _vals[2]={0,1};
600
601 //Called when we want to go to a barrier
602 void TCharm::barrier(void) {
603         //Contribute to a synchronizing reduction
604         CkCallback cb(index_t::atBarrier(0), thisProxy[0]);
605         contribute(sizeof(_vals),&_vals,CkReduction::sum_int,cb);
606 #if CMK_BLUEGENE_CHARM
607         void *curLog;           // store current log in timeline
608         _TRACE_BG_TLINE_END(&curLog);
609         TRACE_BG_AMPI_BREAK(NULL, "TCharm_Barrier_START", NULL, 0, 1);
610 #endif
611         stop();
612 #if CMK_BLUEGENE_CHARM
613          _TRACE_BG_SET_INFO(NULL, "TCHARM_Barrier_END",  &curLog, 1);
614 #endif
615 }
616
617 //Called when we've reached the barrier
618 void TCharm::atBarrier(CkReductionMsg *m) {
619         DBGX("clients all at barrier");
620         delete m;
621         thisProxy.start(); //Just restart everybody
622 }
623
624 //Called when the thread is done running
625 void TCharm::done(void) {
626         //CmiPrintStackTrace(0);
627         DBG("TCharm thread "<<thisIndex<<" done")
628         if (exitWhenDone) {
629                 //Contribute to a synchronizing reduction
630                 CkCallback cb(index_t::atExit(0), thisProxy[0]);
631                 contribute(sizeof(_vals),&_vals,CkReduction::sum_int,cb);
632         }
633         isSelfDone = true;
634         stop();
635 }
636 //Called when all threads are done running
637 void TCharm::atExit(CkReductionMsg *m) {
638         DBGX("TCharm::atExit1> exiting");
639         delete m;
640         //thisProxy.unsetFlags();
641         CkExit();
642         //CkPrintf("After CkExit()!!!!!!!\n");
643 }
644
645 /************* Setup **************/
646
647 //Globals used to control setup process
648 static TCHARM_Fallback_setup_fn g_fallbackSetup=NULL;
649 void TCHARM_Set_fallback_setup(TCHARM_Fallback_setup_fn f)
650 {
651         g_fallbackSetup=f;
652 }
653 void TCHARM_Call_fallback_setup(void) {
654         if (g_fallbackSetup) 
655                 (g_fallbackSetup)();
656         else
657                 CkAbort("TCHARM: Unexpected fallback setup--missing TCHARM_User_setup routine?");
658 }
659
660 /************** User API ***************/
661 /**********************************
662 Callable from UserSetup:
663 */
664
665 // Read the command line to figure out how many threads to create:
666 CDECL int TCHARM_Get_num_chunks(void)
667 {
668         TCHARMAPI("TCHARM_Get_num_chunks");
669         if (CkMyPe()!=0) CkAbort("TCHARM_Get_num_chunks should only be called on PE 0 during setup!");
670         int nChunks=CkNumPes();
671         char **argv=CkGetArgv();
672         CmiGetArgIntDesc(argv,"-vp",&nChunks,"Set the total number of virtual processors");
673         CmiGetArgIntDesc(argv,"+vp",&nChunks,NULL);
674         lastNumChunks=nChunks;
675         return nChunks;
676 }
677 FDECL int FTN_NAME(TCHARM_GET_NUM_CHUNKS,tcharm_get_num_chunks)(void)
678 {
679         return TCHARM_Get_num_chunks();
680 }
681
682 // Fill out the default thread options:
683 TCHARM_Thread_options::TCHARM_Thread_options(int doDefault)
684 {
685         stackSize=0; /* default stacksize */
686         exitWhenDone=0; /* don't exit when done by default. */
687 }
688 void TCHARM_Thread_options::sanityCheck(void) {
689         if (stackSize<=0) stackSize=tcharm_stacksize;
690 }
691
692
693 TCHARM_Thread_options g_tcharmOptions(1);
694
695 /*Set the size of the thread stack*/
696 CDECL void TCHARM_Set_stack_size(int newStackSize)
697 {
698         TCHARMAPI("TCHARM_Set_stack_size");
699         g_tcharmOptions.stackSize=newStackSize;
700 }
701 FDECL void FTN_NAME(TCHARM_SET_STACK_SIZE,tcharm_set_stack_size)
702         (int *newSize)
703 { TCHARM_Set_stack_size(*newSize); }
704
705 CDECL void TCHARM_Set_exit(void) { g_tcharmOptions.exitWhenDone=1; }
706
707 /*Create a new array of threads, which will be bound to by subsequent libraries*/
708 CDECL void TCHARM_Create(int nThreads,
709                         int threadFn)
710 {
711         TCHARMAPI("TCHARM_Create");
712         TCHARM_Create_data(nThreads,
713                          threadFn,NULL,0);
714 }
715 FDECL void FTN_NAME(TCHARM_CREATE,tcharm_create)
716         (int *nThreads,int threadFn)
717 { TCHARM_Create(*nThreads,threadFn); }
718
719 static CProxy_TCharm TCHARM_Build_threads(TCharmInitMsg *msg);
720
721 /*As above, but pass along (arbitrary) data to threads*/
722 CDECL void TCHARM_Create_data(int nThreads,
723                   int threadFn,
724                   void *threadData,int threadDataLen)
725 {
726         TCHARMAPI("TCHARM_Create_data");
727         TCharmInitMsg *msg=new (threadDataLen,0) TCharmInitMsg(
728                 threadFn,g_tcharmOptions);
729         msg->numElements=nThreads;
730         memcpy(msg->data,threadData,threadDataLen);
731         TCHARM_Build_threads(msg);
732         
733         // Reset the thread options:
734         g_tcharmOptions=TCHARM_Thread_options(1);
735 }
736
737 FDECL void FTN_NAME(TCHARM_CREATE_DATA,tcharm_create_data)
738         (int *nThreads,
739                   int threadFn,
740                   void *threadData,int *threadDataLen)
741 { TCHARM_Create_data(*nThreads,threadFn,threadData,*threadDataLen); }
742
743 CkGroupID CkCreatePropMap(void);
744
745 static CProxy_TCharm TCHARM_Build_threads(TCharmInitMsg *msg)
746 {
747   char *tmp;
748   char **argv=CkGetArgv();
749   CkArrayOptions opts(msg->numElements);
750   CkAssert(CkpvAccess(mapCreated)==1);
751
752   if(haveConfigurableRRMap()){
753     CkPrintf("USING ConfigurableRRMap\n");
754     mapID=CProxy_ConfigurableRRMap::ckNew();
755   } else if(mapping==NULL){
756 #if CMK_BLUEGENE_CHARM
757     mapID=CProxy_BlockMap::ckNew();
758 #else
759 #if __FAULT__
760         mapID=CProxy_RRMap::ckNew();
761 #else
762     mapID=CkCreatePropMap();
763 #endif
764 #endif
765   } else if(0 == strcmp(mapping,"BLOCK_MAP")) {
766     CkPrintf("USING BLOCK_MAP\n");
767     mapID = CProxy_BlockMap::ckNew();
768   } else if(0 == strcmp(mapping,"RR_MAP")) {
769     CkPrintf("USING RR_MAP\n");
770     mapID = CProxy_RRMap::ckNew();
771   } else if(0 == strcmp(mapping,"MAPFILE")) {
772     CkPrintf("Reading map from file\n");
773     mapID = CProxy_ReadFileMap::ckNew();
774   } else {  // "PROP_MAP" or anything else
775     mapID = CkCreatePropMap();
776   }
777   opts.setMap(mapID);
778   int nElem=msg->numElements; //<- save it because msg will be deleted.
779   return CProxy_TCharm::ckNew(msg,opts);
780 }
781
782 // Helper used when creating a new array bound to the TCHARM threads:
783 CkArrayOptions TCHARM_Attach_start(CkArrayID *retTCharmArray,int *retNumElts)
784 {
785         TCharm *tc=TCharm::get();
786         if (!tc)
787                 CkAbort("You must call TCHARM initialization routines from a TCHARM thread!");
788         int nElts=tc->getNumElements();
789       
790         //CmiPrintf("TCHARM Elements = %d\n", nElts);  
791       
792         if (retNumElts!=NULL) *retNumElts=nElts;
793         *retTCharmArray=tc->getProxy();
794         CkArrayOptions opts(nElts);
795         opts.bindTo(tc->getProxy());
796         return opts;
797 }
798
799 void TCHARM_Suspend(void) {
800         TCharm *tc=TCharm::get();
801         tc->suspend();
802 }
803
804 /***********************************
805 Callable from worker thread
806 */
807 CDECL int TCHARM_Element(void)
808
809         TCHARMAPI("TCHARM_Element");
810         return TCharm::get()->getElement();
811 }
812 CDECL int TCHARM_Num_elements(void)
813
814         TCHARMAPI("TCHARM_Num_elements");
815         return TCharm::get()->getNumElements();
816 }
817
818 FDECL int FTN_NAME(TCHARM_ELEMENT,tcharm_element)(void) 
819 { return TCHARM_Element();}
820 FDECL int FTN_NAME(TCHARM_NUM_ELEMENTS,tcharm_num_elements)(void) 
821 { return TCHARM_Num_elements();}
822
823 //Make sure this address will migrate with us when we move:
824 static void checkAddress(void *data)
825 {
826         if (tcharm_nomig||tcharm_nothreads) return; //Stack is not isomalloc'd
827         if (CmiThreadIs(CMI_THREAD_IS_ALIAS)||CmiThreadIs(CMI_THREAD_IS_STACKCOPY)) return; // memory alias thread
828         if (CmiIsomallocEnabled()) {
829           if (!CmiIsomallocInRange(data))
830             CkAbort("The UserData you register must be allocated on the stack!\n");
831         }
832         else {
833           if(CkMyPe() == 0)
834             CkPrintf("Warning> checkAddress failed because isomalloc not supported.\n");
835         }
836 }
837
838 /* Old "register"-based userdata: */
839 CDECL int TCHARM_Register(void *data,TCHARM_Pup_fn pfn)
840
841         TCHARMAPI("TCHARM_Register");
842         checkAddress(data);
843         return TCharm::get()->add(TCharm::UserData(pfn,TCharm::get()->getThread(),data));
844 }
845 FDECL int FTN_NAME(TCHARM_REGISTER,tcharm_register)
846         (void *data,TCHARM_Pup_fn pfn)
847
848         TCHARMAPI("TCHARM_Register");
849         checkAddress(data);
850         return TCharm::get()->add(TCharm::UserData(pfn,TCharm::get()->getThread(),data));
851 }
852
853 CDECL void *TCHARM_Get_userdata(int id)
854 {
855         TCHARMAPI("TCHARM_Get_userdata");
856         return TCharm::get()->lookupUserData(id);
857 }
858 FDECL void *FTN_NAME(TCHARM_GET_USERDATA,tcharm_get_userdata)(int *id)
859 { return TCHARM_Get_userdata(*id); }
860
861 /* New hardcoded-ID userdata: */
862 CDECL void TCHARM_Set_global(int globalID,void *new_value,TCHARM_Pup_global_fn pup_or_NULL)
863 {
864         TCHARMAPI("TCHARM_Set_global");
865         TCharm *tc=TCharm::get();
866         if (tc->sud.length()<=globalID)
867         { //We don't have room for this ID yet: make room
868                 int newLen=2*globalID;
869                 tc->sud.resize(newLen);
870         }
871         tc->sud[globalID]=TCharm::UserData(pup_or_NULL,tc->getThread(),new_value);
872 }
873 CDECL void *TCHARM_Get_global(int globalID)
874 {
875         //Skip TCHARMAPI("TCHARM_Get_global") because there's no dynamic allocation here,
876         // and this routine should be as fast as possible.
877         CkVec<TCharm::UserData> &v=TCharm::get()->sud;
878         if (v.length()<=globalID) return NULL; //Uninitialized global
879         return v[globalID].getData();
880 }
881
882 CDECL void TCHARM_Migrate(void)
883 {
884         TCHARMAPI("TCHARM_Migrate");
885         if (CthMigratable() == 0) {
886           if(CkMyPe() == 0)
887             CkPrintf("Warning> thread migration is not supported!\n");
888           return;
889         }
890         TCharm::get()->migrate();
891 }
892 FORTRAN_AS_C(TCHARM_MIGRATE,TCHARM_Migrate,tcharm_migrate,(void),())
893
894 CDECL void TCHARM_Async_Migrate(void)
895 {
896         TCHARMAPI("TCHARM_Async_Migrate");
897         TCharm::get()->async_migrate();
898 }
899 FORTRAN_AS_C(TCHARM_ASYNC_MIGRATE,TCHARM_Async_Migrate,tcharm_async_migrate,(void),())
900
901 CDECL void TCHARM_Allow_Migrate(void)
902 {
903         TCHARMAPI("TCHARM_Allow_Migrate");
904         TCharm::get()->allow_migrate();
905 }
906 FORTRAN_AS_C(TCHARM_ALLOW_MIGRATE,TCHARM_Allow_Migrate,tcharm_allow_migrate,(void),())
907
908 CDECL void TCHARM_Migrate_to(int destPE)
909 {
910         TCHARMAPI("TCHARM_Migrate_to");
911         TCharm::get()->migrateTo(destPE);
912 }
913
914 CDECL void TCHARM_Evacuate()
915 {
916         TCHARMAPI("TCHARM_Migrate_to");
917         TCharm::get()->evacuate();
918 }
919
920 FORTRAN_AS_C(TCHARM_MIGRATE_TO,TCHARM_Migrate_to,tcharm_migrate_to,
921         (int *destPE),(*destPE))
922
923 CDECL void TCHARM_Yield(void)
924 {
925         TCHARMAPI("TCHARM_Yield");
926         TCharm::get()->schedule();
927 }
928 FORTRAN_AS_C(TCHARM_YIELD,TCHARM_Yield,tcharm_yield,(void),())
929
930 CDECL void TCHARM_Barrier(void)
931 {
932         TCHARMAPI("TCHARM_Barrier");
933         TCharm::get()->barrier();
934 }
935 FORTRAN_AS_C(TCHARM_BARRIER,TCHARM_Barrier,tcharm_barrier,(void),())
936
937 CDECL void TCHARM_Done(void)
938 {
939         TCHARMAPI("TCHARM_Done");
940         TCharm *c=TCharm::getNULL();
941         if (!c) CkExit();
942         else c->done();
943 }
944 FORTRAN_AS_C(TCHARM_DONE,TCHARM_Done,tcharm_done,(void),())
945
946
947 CDECL double TCHARM_Wall_timer(void)
948 {
949   TCHARMAPI("TCHARM_Wall_timer");
950   TCharm *c=TCharm::getNULL();
951   if(!c) return CkWallTimer();
952   else { //Have to apply current thread's time offset
953     return CkWallTimer()+c->getTimeOffset();
954   }
955 }
956
957 #if 1
958 /*Include Fortran-style "iargc" and "getarg" routines.
959 These are needed to get access to the command-line arguments from Fortran.
960 */
961 FDECL int FTN_NAME(TCHARM_IARGC,tcharm_iargc)(void) {
962   TCHARMAPI("tcharm_iargc");
963   return CkGetArgc()-1;
964 }
965
966 FDECL void FTN_NAME(TCHARM_GETARG,tcharm_getarg)
967         (int *i_p,char *dest,int destLen)
968 {
969   TCHARMAPI("tcharm_getarg");
970   int i=*i_p;
971   if (i<0) CkAbort("tcharm_getarg called with negative argument!");
972   if (i>=CkGetArgc()) CkAbort("tcharm_getarg called with argument > iargc!");
973   const char *src=CkGetArgv()[i];
974   strcpy(dest,src);
975   for (i=strlen(dest);i<destLen;i++) dest[i]=' ';
976 }
977
978 #endif
979
980 //These silly routines are used for serial startup:
981 extern void _initCharm(int argc, char **argv);
982 CDECL void TCHARM_Init(int *argc,char ***argv) {
983         if (!tcharm_initted) {
984           ConverseInit(*argc, *argv, (CmiStartFn) _initCharm,1,1);
985           _initCharm(*argc,*argv);
986         }
987 }
988
989 FDECL void FTN_NAME(TCHARM_INIT,tcharm_init)(void)
990 {
991         int argc=1;
992         const char *argv_sto[2]={"foo",NULL};
993         char **argv=(char **)argv_sto;
994         TCHARM_Init(&argc,&argv);
995 }
996
997 /***********************************
998 * TCHARM Semaphores:
999 * The idea is one side "puts", the other side "gets"; 
1000 * but the calls can come in any order--
1001 * if the "get" comes first, it blocks until the put.
1002 * This makes a convenient, race-condition-free way to do
1003 * onetime initializations.  
1004 */
1005 /// Find this semaphore, or insert if there isn't one:
1006 TCharm::TCharmSemaphore *TCharm::findSema(int id) {
1007         for (int s=0;s<sema.size();s++)
1008                 if (sema[s].id==id) 
1009                         return &sema[s];
1010         sema.push_back(TCharmSemaphore(id));
1011         return &sema[sema.size()-1];
1012 }
1013 /// Remove this semaphore from the list
1014 void TCharm::freeSema(TCharmSemaphore *doomed) {
1015         int id=doomed->id;
1016         for (int s=0;s<sema.size();s++)
1017                 if (sema[s].id==id) {
1018                         sema[s]=sema[sema.length()-1];
1019                         sema.length()--;
1020                         return;
1021                 }
1022         CkAbort("Tried to free nonexistent TCharm semaphore");
1023 }
1024
1025 /// Block until this semaphore has data:
1026 TCharm::TCharmSemaphore *TCharm::getSema(int id) {
1027         TCharmSemaphore *s=findSema(id);
1028         if (s->data==NULL) 
1029         { //Semaphore isn't filled yet: wait until it is
1030                 s->thread=CthSelf();
1031                 suspend(); //Will be woken by semaPut
1032                 // Semaphore may have moved-- find it again
1033                 s=findSema(id);
1034                 if (s->data==NULL) CkAbort("TCharm::semaGet awoken too early!");
1035         }
1036         return s;
1037 }
1038
1039 /// Store data at the semaphore "id".
1040 ///  The put can come before or after the get.
1041 void TCharm::semaPut(int id,void *data) {
1042         TCharmSemaphore *s=findSema(id);
1043         if (s->data!=NULL) CkAbort("Duplicate calls to TCharm::semaPut!");
1044         s->data=data;
1045         DBG("semaPut "<<id<<" "<<data);
1046         if (s->thread!=NULL) {//Awaken the thread
1047                 s->thread=NULL;
1048                 resume();
1049         }
1050 }
1051
1052 /// Retreive data from the semaphore "id".
1053 ///  Blocks if the data is not immediately available.
1054 ///  Consumes the data, so another put will be required for the next get.
1055 void *TCharm::semaGet(int id) {
1056         TCharmSemaphore *s=getSema(id);
1057         void *ret=s->data;
1058         DBG("semaGet "<<id<<" "<<ret);
1059         // Now remove the semaphore from the list:
1060         freeSema(s);
1061         return ret;
1062 }
1063
1064 /// Retreive data from the semaphore "id".
1065 ///  Blocks if the data is not immediately available.
1066 void *TCharm::semaGets(int id) {
1067         TCharmSemaphore *s=getSema(id);
1068         return s->data;
1069 }
1070
1071 /// Retreive data from the semaphore "id", or returns NULL.
1072 void *TCharm::semaPeek(int id) {
1073         TCharmSemaphore *s=findSema(id);
1074         return s->data;
1075 }
1076
1077 /****** System Call support ******/
1078 /*
1079 TCHARM_System exists to work around a bug where Linux ia32
1080 glibc2.2.x with pthreads crashes at the fork() site when 
1081 called from a user-levelthread. 
1082
1083 The fix is to call system from the main thread, by 
1084 passing the request out of the thread to our array element 
1085 before calling system().
1086 */
1087
1088 CDECL int 
1089 TCHARM_System(const char *shell_command)
1090 {
1091         return TCharm::get()->system(shell_command);
1092 }
1093 int TCharm::system(const char *cmd)
1094 {
1095         int ret=-1778;
1096         callSystemStruct s;
1097         s.cmd=cmd;
1098         s.ret=&ret;
1099         thisProxy[thisIndex].callSystem(s);
1100         suspend();
1101         return ret;
1102 }
1103
1104 void TCharm::callSystem(const callSystemStruct &s)
1105 {
1106         *s.ret = ::system(s.cmd);
1107         resume();
1108 }
1109
1110
1111
1112 #include "tcharm.def.h"