acc4588a7a3483f2f3b7f21cd221e7104145af5f
[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_BIGSIM_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 (1 || CmiMemoryIs(CMI_MEMORY_IS_ISOMALLOC)) {
193         heapBlocks=CmiIsomallocBlockListNew(tid);
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     if (1 || CmiMemoryIs(CMI_MEMORY_IS_ISOMALLOC))
320       CmiIsomallocBlockListPup(p,&heapBlocks,tid);
321     tid = CthPup(p, tid);
322     if (pc.isUnpacking()) {
323       CtvAccessOther(tid,_curTCharm)=this;
324 #if CMK_BIGSIM_CHARM
325       BgAttach(tid);
326 #endif
327     }
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 !CMK_USE_MEMPOOL_ISOMALLOC
370   if (heapBlocks) CmiIsomallocBlockListDelete(heapBlocks);
371 #endif
372   CthFree(tid);
373   CtgFree(threadGlobals);
374   delete initMsg;
375 }
376
377 void TCharm::migrateTo(int destPE) {
378         if (destPE==CkMyPe()) return;
379         if (CthMigratable() == 0) {
380             CkPrintf("Warning> thread migration is not supported!\n");
381             return;
382         }
383         // Make sure migrateMe gets called *after* we suspend:
384         thisProxy[thisIndex].migrateDelayed(destPE);
385 //      resumeAfterMigration=true;
386         suspend();
387 }
388 void TCharm::migrateDelayed(int destPE) {
389         migrateMe(destPE);
390 }
391 void TCharm::ckJustMigrated(void) {
392         ArrayElement::ckJustMigrated();
393 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
394 //  resumeAfterMigration = true;
395 #endif
396         if (resumeAfterMigration) {
397                 resumeAfterMigration=false;
398                 resume(); //Start the thread running
399         }
400 }
401
402 void TCharm::ckJustRestored(void) {
403         //CkPrintf("call just restored from TCharm[%d]\n", thisIndex);
404         ArrayElement::ckJustRestored();
405         //if (resumeAfterMigration) {
406         //      resumeAfterMigration=false;
407         //      resume(); //Start the thread running
408         //}
409 }
410
411 /*
412         FAULT_EVAC
413
414         If a Tcharm object is about to migrate it should be suspended first
415 */
416 void TCharm::ckAboutToMigrate(void){
417         ArrayElement::ckAboutToMigrate();
418         resumeAfterMigration = true;
419         isStopped = true;
420 //      suspend();
421 }
422
423 // clear the data before restarting from disk
424 void TCharm::clear()
425 {
426   if (heapBlocks) CmiIsomallocBlockListDelete(heapBlocks);
427   CthFree(tid);
428   delete initMsg;
429 }
430
431 //Register user data to be packed with the thread
432 int TCharm::add(const TCharm::UserData &d)
433 {
434   if (nUd>=maxUserData)
435     CkAbort("TCharm: Registered too many user data fields!\n");
436   int nu=nUd++;
437   ud[nu]=d;
438   return nu;
439 }
440 void *TCharm::lookupUserData(int i) {
441         if (i<0 || i>=nUd)
442                 CkAbort("Bad user data index passed to TCharmGetUserdata!\n");
443         return ud[i].getData();
444 }
445
446 //Start the thread running
447 void TCharm::run(void)
448 {
449   DBG("TCharm::run()");
450   if (tcharm_nothreads) {/*Call user routine directly*/
451           startTCharmThread(initMsg);
452   } 
453   else /* start the thread as usual */
454           start();
455 }
456
457 //Block the thread until start()ed again.
458 void TCharm::stop(void)
459 {
460 #ifndef CMK_OPTIMIZE
461   if (tid != CthSelf())
462     CkAbort("Called TCharm::stop from outside TCharm thread!\n");
463   if (tcharm_nothreads)
464     CkAbort("Cannot make blocking calls using +tcharm_nothreads!\n");
465 #endif
466   stopTiming();
467   isStopped=true;
468   DBG("thread suspended");
469
470   CthSuspend();
471 //      DBG("thread resumed");
472   /*SUBTLE: We have to do the get() because "this" may have changed
473     during a migration-suspend.  If you access *any* members
474     from this point onward, you'll cause heap corruption if
475     we're resuming from migration!  (OSL 2003/9/23)
476    */
477   TCharm *dis=TCharm::get();
478 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_)) 
479 /*  CpvAccess(_currentObj) = dis;
480  *      printf("[%d] _currentObject set to TCharm index %d %p\n",CkMyPe(),dis->thisIndex,dis);*/
481 #endif
482   dis->isStopped=false;
483   dis->startTiming();
484   //CkPrintf("[%d] Thread resumed  for tid %p\n",dis->thisIndex,dis->tid);
485 }
486
487 //Resume the waiting thread
488 void TCharm::start(void)
489 {
490   //  since this thread is scheduled, it is not a good idea to migrate 
491   isStopped=false;
492   DBG("thread resuming soon");
493   //CkPrintf("TCharm[%d]::start()\n", thisIndex);
494   //CmiPrintStackTrace(0);
495 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
496 //CthAwakenPrio(tid, CQS_QUEUEING_BFIFO, 1, &prio);
497   CthAwaken(tid);
498 #else
499   CthAwaken(tid);
500 #endif
501 }
502
503 //Block our thread, schedule, and come back:
504 void TCharm::schedule(void) {
505   DBG("thread schedule");
506   start(); // Calls CthAwaken
507   stop(); // Calls CthSuspend
508 }
509
510 //Go to sync, block, possibly migrate, and then resume
511 void TCharm::migrate(void)
512 {
513 #if CMK_LBDB_ON
514   DBG("going to sync");
515   AtSync();
516   stop();
517 #else
518   DBG("skipping sync, because there is no load balancer");
519 #endif
520 }
521
522
523
524 void TCharm::evacuate(){
525         /*
526                 FAULT_EVAC
527         */
528         //CkClearAllArrayElementsCPP();
529         if(CkpvAccess(startedEvac)){
530 //              resumeAfterMigration=true;
531                 CcdCallFnAfter((CcdVoidFn)CkEmmigrateElement, (void *)myRec, 1);
532                 suspend();
533                 return;
534         }
535         return;
536
537 }
538
539 //calls atsync with async mode
540 void TCharm::async_migrate(void)
541 {
542 #if CMK_LBDB_ON
543   DBG("going to sync at async mode");
544   skipResume = true;            // we resume immediately
545   ReadyMigrate(false);
546   AtSync(0);
547   schedule();
548 //  allow_migrate();
549 #else
550   DBG("skipping sync, because there is no load balancer");
551 #endif
552 }
553
554 /*
555 Note:
556  thread can only migrate at the point when this is called
557 */
558 void TCharm::allow_migrate(void)
559 {
560 #if CMK_LBDB_ON
561 //  ReadyMigrate(true);
562   int nextPe = MigrateToPe();
563   if (nextPe != -1) {
564     migrateTo(nextPe);
565   }
566 #else
567   DBG("skipping sync, because there is no load balancer");
568 #endif
569 }
570
571 //Resume from sync: start the thread again
572 void TCharm::ResumeFromSync(void)
573 {
574   //if(isSelfDone) return;
575   //if (exitWhenDone) return; //for bigsim ooc execution
576   if (!skipResume) start();
577 }
578
579
580 /****** TcharmClient ******/
581 void TCharmClient1D::ckJustMigrated(void) {
582   ArrayElement1D::ckJustMigrated();
583   findThread();
584   tcharmClientInit();
585 }
586
587 void TCharmClient1D::pup(PUP::er &p) {
588   ArrayElement1D::pup(p);
589   p|threadProxy;
590 }
591
592 CkArrayID TCHARM_Get_threads(void) {
593         TCHARMAPI("TCHARM_Get_threads");
594         return TCharm::get()->getProxy();
595 }
596
597 /************* Startup/Shutdown Coordination Support ************/
598
599 // Useless values to reduce over:
600 int _vals[2]={0,1};
601
602 //Called when we want to go to a barrier
603 void TCharm::barrier(void) {
604         //Contribute to a synchronizing reduction
605         CkCallback cb(index_t::atBarrier(0), thisProxy[0]);
606         contribute(sizeof(_vals),&_vals,CkReduction::sum_int,cb);
607 #if CMK_BIGSIM_CHARM
608         void *curLog;           // store current log in timeline
609         _TRACE_BG_TLINE_END(&curLog);
610         TRACE_BG_AMPI_BREAK(NULL, "TCharm_Barrier_START", NULL, 0, 1);
611 #endif
612         stop();
613 #if CMK_BIGSIM_CHARM
614          _TRACE_BG_SET_INFO(NULL, "TCHARM_Barrier_END",  &curLog, 1);
615 #endif
616 }
617
618 //Called when we've reached the barrier
619 void TCharm::atBarrier(CkReductionMsg *m) {
620         DBGX("clients all at barrier");
621         delete m;
622         thisProxy.start(); //Just restart everybody
623 }
624
625 //Called when the thread is done running
626 void TCharm::done(void) {
627         //CmiPrintStackTrace(0);
628         DBG("TCharm thread "<<thisIndex<<" done")
629         if (exitWhenDone) {
630                 //Contribute to a synchronizing reduction
631                 CkCallback cb(index_t::atExit(0), thisProxy[0]);
632                 contribute(sizeof(_vals),&_vals,CkReduction::sum_int,cb);
633         }
634         isSelfDone = true;
635         stop();
636 }
637 //Called when all threads are done running
638 void TCharm::atExit(CkReductionMsg *m) {
639         DBGX("TCharm::atExit1> exiting");
640         delete m;
641         //thisProxy.unsetFlags();
642         CkExit();
643         //CkPrintf("After CkExit()!!!!!!!\n");
644 }
645
646 /************* Setup **************/
647
648 //Globals used to control setup process
649 static TCHARM_Fallback_setup_fn g_fallbackSetup=NULL;
650 void TCHARM_Set_fallback_setup(TCHARM_Fallback_setup_fn f)
651 {
652         g_fallbackSetup=f;
653 }
654 void TCHARM_Call_fallback_setup(void) {
655         if (g_fallbackSetup) 
656                 (g_fallbackSetup)();
657         else
658                 CkAbort("TCHARM: Unexpected fallback setup--missing TCHARM_User_setup routine?");
659 }
660
661 /************** User API ***************/
662 /**********************************
663 Callable from UserSetup:
664 */
665
666 // Read the command line to figure out how many threads to create:
667 CDECL int TCHARM_Get_num_chunks(void)
668 {
669         TCHARMAPI("TCHARM_Get_num_chunks");
670         if (CkMyPe()!=0) CkAbort("TCHARM_Get_num_chunks should only be called on PE 0 during setup!");
671         int nChunks=CkNumPes();
672         char **argv=CkGetArgv();
673         CmiGetArgIntDesc(argv,"-vp",&nChunks,"Set the total number of virtual processors");
674         CmiGetArgIntDesc(argv,"+vp",&nChunks,NULL);
675         lastNumChunks=nChunks;
676         return nChunks;
677 }
678 FDECL int FTN_NAME(TCHARM_GET_NUM_CHUNKS,tcharm_get_num_chunks)(void)
679 {
680         return TCHARM_Get_num_chunks();
681 }
682
683 // Fill out the default thread options:
684 TCHARM_Thread_options::TCHARM_Thread_options(int doDefault)
685 {
686         stackSize=0; /* default stacksize */
687         exitWhenDone=0; /* don't exit when done by default. */
688 }
689 void TCHARM_Thread_options::sanityCheck(void) {
690         if (stackSize<=0) stackSize=tcharm_stacksize;
691 }
692
693
694 TCHARM_Thread_options g_tcharmOptions(1);
695
696 /*Set the size of the thread stack*/
697 CDECL void TCHARM_Set_stack_size(int newStackSize)
698 {
699         TCHARMAPI("TCHARM_Set_stack_size");
700         g_tcharmOptions.stackSize=newStackSize;
701 }
702 FDECL void FTN_NAME(TCHARM_SET_STACK_SIZE,tcharm_set_stack_size)
703         (int *newSize)
704 { TCHARM_Set_stack_size(*newSize); }
705
706 CDECL void TCHARM_Set_exit(void) { g_tcharmOptions.exitWhenDone=1; }
707
708 /*Create a new array of threads, which will be bound to by subsequent libraries*/
709 CDECL void TCHARM_Create(int nThreads,
710                         int threadFn)
711 {
712         TCHARMAPI("TCHARM_Create");
713         TCHARM_Create_data(nThreads,
714                          threadFn,NULL,0);
715 }
716 FDECL void FTN_NAME(TCHARM_CREATE,tcharm_create)
717         (int *nThreads,int threadFn)
718 { TCHARM_Create(*nThreads,threadFn); }
719
720 static CProxy_TCharm TCHARM_Build_threads(TCharmInitMsg *msg);
721
722 /*As above, but pass along (arbitrary) data to threads*/
723 CDECL void TCHARM_Create_data(int nThreads,
724                   int threadFn,
725                   void *threadData,int threadDataLen)
726 {
727         TCHARMAPI("TCHARM_Create_data");
728         TCharmInitMsg *msg=new (threadDataLen,0) TCharmInitMsg(
729                 threadFn,g_tcharmOptions);
730         msg->numElements=nThreads;
731         memcpy(msg->data,threadData,threadDataLen);
732         TCHARM_Build_threads(msg);
733         
734         // Reset the thread options:
735         g_tcharmOptions=TCHARM_Thread_options(1);
736 }
737
738 FDECL void FTN_NAME(TCHARM_CREATE_DATA,tcharm_create_data)
739         (int *nThreads,
740                   int threadFn,
741                   void *threadData,int *threadDataLen)
742 { TCHARM_Create_data(*nThreads,threadFn,threadData,*threadDataLen); }
743
744 CkGroupID CkCreatePropMap(void);
745
746 static CProxy_TCharm TCHARM_Build_threads(TCharmInitMsg *msg)
747 {
748   CkArrayOptions opts(msg->numElements);
749   CkAssert(CkpvAccess(mapCreated)==1);
750
751   if(haveConfigurableRRMap()){
752     CkPrintf("USING ConfigurableRRMap\n");
753     mapID=CProxy_ConfigurableRRMap::ckNew();
754   } else if(mapping==NULL){
755 #if CMK_BIGSIM_CHARM
756     mapID=CProxy_BlockMap::ckNew();
757 #else
758 #if __FAULT__
759         mapID=CProxy_RRMap::ckNew();
760 #else
761     mapID=CkCreatePropMap();
762 #endif
763 #endif
764   } else if(0 == strcmp(mapping,"BLOCK_MAP")) {
765     CkPrintf("USING BLOCK_MAP\n");
766     mapID = CProxy_BlockMap::ckNew();
767   } else if(0 == strcmp(mapping,"RR_MAP")) {
768     CkPrintf("USING RR_MAP\n");
769     mapID = CProxy_RRMap::ckNew();
770   } else if(0 == strcmp(mapping,"MAPFILE")) {
771     CkPrintf("Reading map from file\n");
772     mapID = CProxy_ReadFileMap::ckNew();
773   } else {  // "PROP_MAP" or anything else
774     mapID = CkCreatePropMap();
775   }
776   opts.setMap(mapID);
777   return CProxy_TCharm::ckNew(msg,opts);
778 }
779
780 // Helper used when creating a new array bound to the TCHARM threads:
781 CkArrayOptions TCHARM_Attach_start(CkArrayID *retTCharmArray,int *retNumElts)
782 {
783         TCharm *tc=TCharm::get();
784         if (!tc)
785                 CkAbort("You must call TCHARM initialization routines from a TCHARM thread!");
786         int nElts=tc->getNumElements();
787       
788         //CmiPrintf("TCHARM Elements = %d\n", nElts);  
789       
790         if (retNumElts!=NULL) *retNumElts=nElts;
791         *retTCharmArray=tc->getProxy();
792         CkArrayOptions opts(nElts);
793         opts.bindTo(tc->getProxy());
794         return opts;
795 }
796
797 void TCHARM_Suspend(void) {
798         TCharm *tc=TCharm::get();
799         tc->suspend();
800 }
801
802 /***********************************
803 Callable from worker thread
804 */
805 CDECL int TCHARM_Element(void)
806
807         TCHARMAPI("TCHARM_Element");
808         return TCharm::get()->getElement();
809 }
810 CDECL int TCHARM_Num_elements(void)
811
812         TCHARMAPI("TCHARM_Num_elements");
813         return TCharm::get()->getNumElements();
814 }
815
816 FDECL int FTN_NAME(TCHARM_ELEMENT,tcharm_element)(void) 
817 { return TCHARM_Element();}
818 FDECL int FTN_NAME(TCHARM_NUM_ELEMENTS,tcharm_num_elements)(void) 
819 { return TCHARM_Num_elements();}
820
821 //Make sure this address will migrate with us when we move:
822 static void checkAddress(void *data)
823 {
824         if (tcharm_nomig||tcharm_nothreads) return; //Stack is not isomalloc'd
825         if (CmiThreadIs(CMI_THREAD_IS_ALIAS)||CmiThreadIs(CMI_THREAD_IS_STACKCOPY)) return; // memory alias thread
826         if (CmiIsomallocEnabled()) {
827           if (!CmiIsomallocInRange(data))
828             CkAbort("The UserData you register must be allocated on the stack!\n");
829         }
830         else {
831           if(CkMyPe() == 0)
832             CkPrintf("Warning> checkAddress failed because isomalloc not supported.\n");
833         }
834 }
835
836 /* Old "register"-based userdata: */
837 CDECL int TCHARM_Register(void *data,TCHARM_Pup_fn pfn)
838
839         TCHARMAPI("TCHARM_Register");
840         checkAddress(data);
841         return TCharm::get()->add(TCharm::UserData(pfn,TCharm::get()->getThread(),data));
842 }
843 FDECL int FTN_NAME(TCHARM_REGISTER,tcharm_register)
844         (void *data,TCHARM_Pup_fn pfn)
845
846         TCHARMAPI("TCHARM_Register");
847         checkAddress(data);
848         return TCharm::get()->add(TCharm::UserData(pfn,TCharm::get()->getThread(),data));
849 }
850
851 CDECL void *TCHARM_Get_userdata(int id)
852 {
853         TCHARMAPI("TCHARM_Get_userdata");
854         return TCharm::get()->lookupUserData(id);
855 }
856 FDECL void *FTN_NAME(TCHARM_GET_USERDATA,tcharm_get_userdata)(int *id)
857 { return TCHARM_Get_userdata(*id); }
858
859 /* New hardcoded-ID userdata: */
860 CDECL void TCHARM_Set_global(int globalID,void *new_value,TCHARM_Pup_global_fn pup_or_NULL)
861 {
862         TCHARMAPI("TCHARM_Set_global");
863         TCharm *tc=TCharm::get();
864         if (tc->sud.length()<=globalID)
865         { //We don't have room for this ID yet: make room
866                 int newLen=2*globalID;
867                 tc->sud.resize(newLen);
868         }
869         tc->sud[globalID]=TCharm::UserData(pup_or_NULL,tc->getThread(),new_value);
870 }
871 CDECL void *TCHARM_Get_global(int globalID)
872 {
873         //Skip TCHARMAPI("TCHARM_Get_global") because there's no dynamic allocation here,
874         // and this routine should be as fast as possible.
875         CkVec<TCharm::UserData> &v=TCharm::get()->sud;
876         if (v.length()<=globalID) return NULL; //Uninitialized global
877         return v[globalID].getData();
878 }
879
880 CDECL void TCHARM_Migrate(void)
881 {
882         TCHARMAPI("TCHARM_Migrate");
883         if (CthMigratable() == 0) {
884           if(CkMyPe() == 0)
885             CkPrintf("Warning> thread migration is not supported!\n");
886           return;
887         }
888         TCharm::get()->migrate();
889 }
890 FORTRAN_AS_C(TCHARM_MIGRATE,TCHARM_Migrate,tcharm_migrate,(void),())
891
892 CDECL void TCHARM_Async_Migrate(void)
893 {
894         TCHARMAPI("TCHARM_Async_Migrate");
895         TCharm::get()->async_migrate();
896 }
897 FORTRAN_AS_C(TCHARM_ASYNC_MIGRATE,TCHARM_Async_Migrate,tcharm_async_migrate,(void),())
898
899 CDECL void TCHARM_Allow_Migrate(void)
900 {
901         TCHARMAPI("TCHARM_Allow_Migrate");
902         TCharm::get()->allow_migrate();
903 }
904 FORTRAN_AS_C(TCHARM_ALLOW_MIGRATE,TCHARM_Allow_Migrate,tcharm_allow_migrate,(void),())
905
906 CDECL void TCHARM_Migrate_to(int destPE)
907 {
908         TCHARMAPI("TCHARM_Migrate_to");
909         TCharm::get()->migrateTo(destPE);
910 }
911
912 CDECL void TCHARM_Evacuate()
913 {
914         TCHARMAPI("TCHARM_Migrate_to");
915         TCharm::get()->evacuate();
916 }
917
918 FORTRAN_AS_C(TCHARM_MIGRATE_TO,TCHARM_Migrate_to,tcharm_migrate_to,
919         (int *destPE),(*destPE))
920
921 CDECL void TCHARM_Yield(void)
922 {
923         TCHARMAPI("TCHARM_Yield");
924         TCharm::get()->schedule();
925 }
926 FORTRAN_AS_C(TCHARM_YIELD,TCHARM_Yield,tcharm_yield,(void),())
927
928 CDECL void TCHARM_Barrier(void)
929 {
930         TCHARMAPI("TCHARM_Barrier");
931         TCharm::get()->barrier();
932 }
933 FORTRAN_AS_C(TCHARM_BARRIER,TCHARM_Barrier,tcharm_barrier,(void),())
934
935 CDECL void TCHARM_Done(void)
936 {
937         TCHARMAPI("TCHARM_Done");
938         TCharm *c=TCharm::getNULL();
939         if (!c) CkExit();
940         else c->done();
941 }
942 FORTRAN_AS_C(TCHARM_DONE,TCHARM_Done,tcharm_done,(void),())
943
944
945 CDECL double TCHARM_Wall_timer(void)
946 {
947   TCHARMAPI("TCHARM_Wall_timer");
948   TCharm *c=TCharm::getNULL();
949   if(!c) return CkWallTimer();
950   else { //Have to apply current thread's time offset
951     return CkWallTimer()+c->getTimeOffset();
952   }
953 }
954
955 #if 1
956 /*Include Fortran-style "iargc" and "getarg" routines.
957 These are needed to get access to the command-line arguments from Fortran.
958 */
959 FDECL int FTN_NAME(TCHARM_IARGC,tcharm_iargc)(void) {
960   TCHARMAPI("tcharm_iargc");
961   return CkGetArgc()-1;
962 }
963
964 FDECL void FTN_NAME(TCHARM_GETARG,tcharm_getarg)
965         (int *i_p,char *dest,int destLen)
966 {
967   TCHARMAPI("tcharm_getarg");
968   int i=*i_p;
969   if (i<0) CkAbort("tcharm_getarg called with negative argument!");
970   if (i>=CkGetArgc()) CkAbort("tcharm_getarg called with argument > iargc!");
971   const char *src=CkGetArgv()[i];
972   strcpy(dest,src);
973   for (i=strlen(dest);i<destLen;i++) dest[i]=' ';
974 }
975
976 #endif
977
978 //These silly routines are used for serial startup:
979 extern void _initCharm(int argc, char **argv);
980 CDECL void TCHARM_Init(int *argc,char ***argv) {
981         if (!tcharm_initted) {
982           ConverseInit(*argc, *argv, (CmiStartFn) _initCharm,1,1);
983           _initCharm(*argc,*argv);
984         }
985 }
986
987 FDECL void FTN_NAME(TCHARM_INIT,tcharm_init)(void)
988 {
989         int argc=1;
990         const char *argv_sto[2]={"foo",NULL};
991         char **argv=(char **)argv_sto;
992         TCHARM_Init(&argc,&argv);
993 }
994
995 /***********************************
996 * TCHARM Semaphores:
997 * The idea is one side "puts", the other side "gets"; 
998 * but the calls can come in any order--
999 * if the "get" comes first, it blocks until the put.
1000 * This makes a convenient, race-condition-free way to do
1001 * onetime initializations.  
1002 */
1003 /// Find this semaphore, or insert if there isn't one:
1004 TCharm::TCharmSemaphore *TCharm::findSema(int id) {
1005         for (int s=0;s<sema.size();s++)
1006                 if (sema[s].id==id) 
1007                         return &sema[s];
1008         sema.push_back(TCharmSemaphore(id));
1009         return &sema[sema.size()-1];
1010 }
1011 /// Remove this semaphore from the list
1012 void TCharm::freeSema(TCharmSemaphore *doomed) {
1013         int id=doomed->id;
1014         for (int s=0;s<sema.size();s++)
1015                 if (sema[s].id==id) {
1016                         sema[s]=sema[sema.length()-1];
1017                         sema.length()--;
1018                         return;
1019                 }
1020         CkAbort("Tried to free nonexistent TCharm semaphore");
1021 }
1022
1023 /// Block until this semaphore has data:
1024 TCharm::TCharmSemaphore *TCharm::getSema(int id) {
1025         TCharmSemaphore *s=findSema(id);
1026         if (s->data==NULL) 
1027         { //Semaphore isn't filled yet: wait until it is
1028                 s->thread=CthSelf();
1029                 suspend(); //Will be woken by semaPut
1030                 // Semaphore may have moved-- find it again
1031                 s=findSema(id);
1032                 if (s->data==NULL) CkAbort("TCharm::semaGet awoken too early!");
1033         }
1034         return s;
1035 }
1036
1037 /// Store data at the semaphore "id".
1038 ///  The put can come before or after the get.
1039 void TCharm::semaPut(int id,void *data) {
1040         TCharmSemaphore *s=findSema(id);
1041         if (s->data!=NULL) CkAbort("Duplicate calls to TCharm::semaPut!");
1042         s->data=data;
1043         DBG("semaPut "<<id<<" "<<data);
1044         if (s->thread!=NULL) {//Awaken the thread
1045                 s->thread=NULL;
1046                 resume();
1047         }
1048 }
1049
1050 /// Retreive data from the semaphore "id".
1051 ///  Blocks if the data is not immediately available.
1052 ///  Consumes the data, so another put will be required for the next get.
1053 void *TCharm::semaGet(int id) {
1054         TCharmSemaphore *s=getSema(id);
1055         void *ret=s->data;
1056         DBG("semaGet "<<id<<" "<<ret);
1057         // Now remove the semaphore from the list:
1058         freeSema(s);
1059         return ret;
1060 }
1061
1062 /// Retreive data from the semaphore "id".
1063 ///  Blocks if the data is not immediately available.
1064 void *TCharm::semaGets(int id) {
1065         TCharmSemaphore *s=getSema(id);
1066         return s->data;
1067 }
1068
1069 /// Retreive data from the semaphore "id", or returns NULL.
1070 void *TCharm::semaPeek(int id) {
1071         TCharmSemaphore *s=findSema(id);
1072         return s->data;
1073 }
1074
1075 /****** System Call support ******/
1076 /*
1077 TCHARM_System exists to work around a bug where Linux ia32
1078 glibc2.2.x with pthreads crashes at the fork() site when 
1079 called from a user-levelthread. 
1080
1081 The fix is to call system from the main thread, by 
1082 passing the request out of the thread to our array element 
1083 before calling system().
1084 */
1085
1086 CDECL int 
1087 TCHARM_System(const char *shell_command)
1088 {
1089         return TCharm::get()->system(shell_command);
1090 }
1091 int TCharm::system(const char *cmd)
1092 {
1093         int ret=-1778;
1094         callSystemStruct s;
1095         s.cmd=cmd;
1096         s.ret=&ret;
1097         thisProxy[thisIndex].callSystem(s);
1098         suspend();
1099         return ret;
1100 }
1101
1102 void TCharm::callSystem(const callSystemStruct &s)
1103 {
1104         *s.ret = ::system(s.cmd);
1105         resume();
1106 }
1107
1108
1109
1110 #include "tcharm.def.h"