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