Fixing a bug
[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     CthThread savedtid = tid;
319     checkPupMismatch(pc,5138,"before TCHARM thread");
320     tid = CthPup(p, tid);
321     if (pc.isUnpacking()) {
322       CtvAccessOther(tid,_curTCharm)=this;
323 #if CMK_BIGSIM_CHARM
324       BgAttach(tid);
325 #endif
326     }
327     if (1 || CmiMemoryIs(CMI_MEMORY_IS_ISOMALLOC))
328       CmiIsomallocBlockListPup(p,&heapBlocks,savedtid);
329     threadGlobals=CtgPup(p,threadGlobals);
330     checkPupMismatch(pc,5139,"after TCHARM thread");
331 }
332
333 //Pup one group of user data
334 void TCharm::UserData::pup(PUP::er &p)
335 {
336   pup_er pext=(pup_er)(&p);
337   p(mode);
338   switch(mode) {
339   case 'c': { /* C mode: userdata is on the stack, so keep address */
340 //     p((char*)&data,sizeof(data));
341      p(pos);
342      //FIXME: function pointers may not be valid across processors
343      p((char*)&cfn, sizeof(TCHARM_Pup_fn));
344      char *data = CthPointer(t, pos);
345      if (cfn) cfn(pext,data);
346      } break;
347   case 'g': { /* Global mode: zero out userdata on arrival */
348      if (CmiMemoryIs(CMI_MEMORY_IS_ISOMALLOC))
349      {
350         // keep the pointer value if using isomalloc, no need to use pup
351        p(pos);
352      }
353      else if (p.isUnpacking())      //  zero out userdata on arrival
354        pos=0;
355
356        //FIXME: function pointers may not be valid across processors
357      p((char*)&gfn, sizeof(TCHARM_Pup_global_fn));
358      if (gfn) gfn(pext);
359      } break;
360   default:
361      break;
362   };
363 }
364
365 TCharm::~TCharm()
366 {
367   //BIGSIM_OOC DEBUGGING
368   //CmiPrintf("TCharm destructor called with heapBlocks=%p!\n", heapBlocks);
369   
370   if (heapBlocks) CmiIsomallocBlockListDelete(heapBlocks);
371   CthFree(tid);
372   CtgFree(threadGlobals);
373   delete initMsg;
374 }
375
376 void TCharm::migrateTo(int destPE) {
377         if (destPE==CkMyPe()) return;
378         if (CthMigratable() == 0) {
379             CkPrintf("Warning> thread migration is not supported!\n");
380             return;
381         }
382         // Make sure migrateMe gets called *after* we suspend:
383         thisProxy[thisIndex].migrateDelayed(destPE);
384 //      resumeAfterMigration=true;
385         suspend();
386 }
387 void TCharm::migrateDelayed(int destPE) {
388         migrateMe(destPE);
389 }
390 void TCharm::ckJustMigrated(void) {
391         ArrayElement::ckJustMigrated();
392 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
393 //  resumeAfterMigration = true;
394 #endif
395         if (resumeAfterMigration) {
396                 resumeAfterMigration=false;
397                 resume(); //Start the thread running
398         }
399 }
400
401 void TCharm::ckJustRestored(void) {
402         //CkPrintf("call just restored from TCharm[%d]\n", thisIndex);
403         ArrayElement::ckJustRestored();
404         //if (resumeAfterMigration) {
405         //      resumeAfterMigration=false;
406         //      resume(); //Start the thread running
407         //}
408 }
409
410 /*
411         FAULT_EVAC
412
413         If a Tcharm object is about to migrate it should be suspended first
414 */
415 void TCharm::ckAboutToMigrate(void){
416         ArrayElement::ckAboutToMigrate();
417         resumeAfterMigration = true;
418         isStopped = true;
419 //      suspend();
420 }
421
422 // clear the data before restarting from disk
423 void TCharm::clear()
424 {
425   if (heapBlocks) CmiIsomallocBlockListDelete(heapBlocks);
426   CthFree(tid);
427   delete initMsg;
428 }
429
430 //Register user data to be packed with the thread
431 int TCharm::add(const TCharm::UserData &d)
432 {
433   if (nUd>=maxUserData)
434     CkAbort("TCharm: Registered too many user data fields!\n");
435   int nu=nUd++;
436   ud[nu]=d;
437   return nu;
438 }
439 void *TCharm::lookupUserData(int i) {
440         if (i<0 || i>=nUd)
441                 CkAbort("Bad user data index passed to TCharmGetUserdata!\n");
442         return ud[i].getData();
443 }
444
445 //Start the thread running
446 void TCharm::run(void)
447 {
448   DBG("TCharm::run()");
449   if (tcharm_nothreads) {/*Call user routine directly*/
450           startTCharmThread(initMsg);
451   } 
452   else /* start the thread as usual */
453           start();
454 }
455
456 //Block the thread until start()ed again.
457 void TCharm::stop(void)
458 {
459 #ifndef CMK_OPTIMIZE
460   if (tid != CthSelf())
461     CkAbort("Called TCharm::stop from outside TCharm thread!\n");
462   if (tcharm_nothreads)
463     CkAbort("Cannot make blocking calls using +tcharm_nothreads!\n");
464 #endif
465   stopTiming();
466   isStopped=true;
467   DBG("thread suspended");
468
469   CthSuspend();
470 //      DBG("thread resumed");
471   /*SUBTLE: We have to do the get() because "this" may have changed
472     during a migration-suspend.  If you access *any* members
473     from this point onward, you'll cause heap corruption if
474     we're resuming from migration!  (OSL 2003/9/23)
475    */
476   TCharm *dis=TCharm::get();
477 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_)) 
478 /*  CpvAccess(_currentObj) = dis;
479  *      printf("[%d] _currentObject set to TCharm index %d %p\n",CkMyPe(),dis->thisIndex,dis);*/
480 #endif
481   dis->isStopped=false;
482   dis->startTiming();
483   //CkPrintf("[%d] Thread resumed  for tid %p\n",dis->thisIndex,dis->tid);
484 }
485
486 //Resume the waiting thread
487 void TCharm::start(void)
488 {
489   //  since this thread is scheduled, it is not a good idea to migrate 
490   isStopped=false;
491   DBG("thread resuming soon");
492   //CkPrintf("TCharm[%d]::start()\n", thisIndex);
493   //CmiPrintStackTrace(0);
494 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
495 //CthAwakenPrio(tid, CQS_QUEUEING_BFIFO, 1, &prio);
496   CthAwaken(tid);
497 #else
498   CthAwaken(tid);
499 #endif
500 }
501
502 //Block our thread, schedule, and come back:
503 void TCharm::schedule(void) {
504   DBG("thread schedule");
505   start(); // Calls CthAwaken
506   stop(); // Calls CthSuspend
507 }
508
509 //Go to sync, block, possibly migrate, and then resume
510 void TCharm::migrate(void)
511 {
512 #if CMK_LBDB_ON
513   DBG("going to sync");
514   AtSync();
515   stop();
516 #else
517   DBG("skipping sync, because there is no load balancer");
518 #endif
519 }
520
521
522
523 void TCharm::evacuate(){
524         /*
525                 FAULT_EVAC
526         */
527         //CkClearAllArrayElementsCPP();
528         if(CkpvAccess(startedEvac)){
529                 int nextPE = getNextPE(CkArrayIndex1D(thisIndex));
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   char *tmp;
749   char **argv=CkGetArgv();
750   CkArrayOptions opts(msg->numElements);
751   CkAssert(CkpvAccess(mapCreated)==1);
752
753   if(haveConfigurableRRMap()){
754     CkPrintf("USING ConfigurableRRMap\n");
755     mapID=CProxy_ConfigurableRRMap::ckNew();
756   } else if(mapping==NULL){
757 #if CMK_BIGSIM_CHARM
758     mapID=CProxy_BlockMap::ckNew();
759 #else
760 #if __FAULT__
761         mapID=CProxy_RRMap::ckNew();
762 #else
763     mapID=CkCreatePropMap();
764 #endif
765 #endif
766   } else if(0 == strcmp(mapping,"BLOCK_MAP")) {
767     CkPrintf("USING BLOCK_MAP\n");
768     mapID = CProxy_BlockMap::ckNew();
769   } else if(0 == strcmp(mapping,"RR_MAP")) {
770     CkPrintf("USING RR_MAP\n");
771     mapID = CProxy_RRMap::ckNew();
772   } else if(0 == strcmp(mapping,"MAPFILE")) {
773     CkPrintf("Reading map from file\n");
774     mapID = CProxy_ReadFileMap::ckNew();
775   } else {  // "PROP_MAP" or anything else
776     mapID = CkCreatePropMap();
777   }
778   opts.setMap(mapID);
779   int nElem=msg->numElements; //<- save it because msg will be deleted.
780   return CProxy_TCharm::ckNew(msg,opts);
781 }
782
783 // Helper used when creating a new array bound to the TCHARM threads:
784 CkArrayOptions TCHARM_Attach_start(CkArrayID *retTCharmArray,int *retNumElts)
785 {
786         TCharm *tc=TCharm::get();
787         if (!tc)
788                 CkAbort("You must call TCHARM initialization routines from a TCHARM thread!");
789         int nElts=tc->getNumElements();
790       
791         //CmiPrintf("TCHARM Elements = %d\n", nElts);  
792       
793         if (retNumElts!=NULL) *retNumElts=nElts;
794         *retTCharmArray=tc->getProxy();
795         CkArrayOptions opts(nElts);
796         opts.bindTo(tc->getProxy());
797         return opts;
798 }
799
800 void TCHARM_Suspend(void) {
801         TCharm *tc=TCharm::get();
802         tc->suspend();
803 }
804
805 /***********************************
806 Callable from worker thread
807 */
808 CDECL int TCHARM_Element(void)
809
810         TCHARMAPI("TCHARM_Element");
811         return TCharm::get()->getElement();
812 }
813 CDECL int TCHARM_Num_elements(void)
814
815         TCHARMAPI("TCHARM_Num_elements");
816         return TCharm::get()->getNumElements();
817 }
818
819 FDECL int FTN_NAME(TCHARM_ELEMENT,tcharm_element)(void) 
820 { return TCHARM_Element();}
821 FDECL int FTN_NAME(TCHARM_NUM_ELEMENTS,tcharm_num_elements)(void) 
822 { return TCHARM_Num_elements();}
823
824 //Make sure this address will migrate with us when we move:
825 static void checkAddress(void *data)
826 {
827         if (tcharm_nomig||tcharm_nothreads) return; //Stack is not isomalloc'd
828         if (CmiThreadIs(CMI_THREAD_IS_ALIAS)||CmiThreadIs(CMI_THREAD_IS_STACKCOPY)) return; // memory alias thread
829         if (CmiIsomallocEnabled()) {
830           if (!CmiIsomallocInRange(data))
831             CkAbort("The UserData you register must be allocated on the stack!\n");
832         }
833         else {
834           if(CkMyPe() == 0)
835             CkPrintf("Warning> checkAddress failed because isomalloc not supported.\n");
836         }
837 }
838
839 /* Old "register"-based userdata: */
840 CDECL int TCHARM_Register(void *data,TCHARM_Pup_fn pfn)
841
842         TCHARMAPI("TCHARM_Register");
843         checkAddress(data);
844         return TCharm::get()->add(TCharm::UserData(pfn,TCharm::get()->getThread(),data));
845 }
846 FDECL int FTN_NAME(TCHARM_REGISTER,tcharm_register)
847         (void *data,TCHARM_Pup_fn pfn)
848
849         TCHARMAPI("TCHARM_Register");
850         checkAddress(data);
851         return TCharm::get()->add(TCharm::UserData(pfn,TCharm::get()->getThread(),data));
852 }
853
854 CDECL void *TCHARM_Get_userdata(int id)
855 {
856         TCHARMAPI("TCHARM_Get_userdata");
857         return TCharm::get()->lookupUserData(id);
858 }
859 FDECL void *FTN_NAME(TCHARM_GET_USERDATA,tcharm_get_userdata)(int *id)
860 { return TCHARM_Get_userdata(*id); }
861
862 /* New hardcoded-ID userdata: */
863 CDECL void TCHARM_Set_global(int globalID,void *new_value,TCHARM_Pup_global_fn pup_or_NULL)
864 {
865         TCHARMAPI("TCHARM_Set_global");
866         TCharm *tc=TCharm::get();
867         if (tc->sud.length()<=globalID)
868         { //We don't have room for this ID yet: make room
869                 int newLen=2*globalID;
870                 tc->sud.resize(newLen);
871         }
872         tc->sud[globalID]=TCharm::UserData(pup_or_NULL,tc->getThread(),new_value);
873 }
874 CDECL void *TCHARM_Get_global(int globalID)
875 {
876         //Skip TCHARMAPI("TCHARM_Get_global") because there's no dynamic allocation here,
877         // and this routine should be as fast as possible.
878         CkVec<TCharm::UserData> &v=TCharm::get()->sud;
879         if (v.length()<=globalID) return NULL; //Uninitialized global
880         return v[globalID].getData();
881 }
882
883 CDECL void TCHARM_Migrate(void)
884 {
885         TCHARMAPI("TCHARM_Migrate");
886         if (CthMigratable() == 0) {
887           if(CkMyPe() == 0)
888             CkPrintf("Warning> thread migration is not supported!\n");
889           return;
890         }
891         TCharm::get()->migrate();
892 }
893 FORTRAN_AS_C(TCHARM_MIGRATE,TCHARM_Migrate,tcharm_migrate,(void),())
894
895 CDECL void TCHARM_Async_Migrate(void)
896 {
897         TCHARMAPI("TCHARM_Async_Migrate");
898         TCharm::get()->async_migrate();
899 }
900 FORTRAN_AS_C(TCHARM_ASYNC_MIGRATE,TCHARM_Async_Migrate,tcharm_async_migrate,(void),())
901
902 CDECL void TCHARM_Allow_Migrate(void)
903 {
904         TCHARMAPI("TCHARM_Allow_Migrate");
905         TCharm::get()->allow_migrate();
906 }
907 FORTRAN_AS_C(TCHARM_ALLOW_MIGRATE,TCHARM_Allow_Migrate,tcharm_allow_migrate,(void),())
908
909 CDECL void TCHARM_Migrate_to(int destPE)
910 {
911         TCHARMAPI("TCHARM_Migrate_to");
912         TCharm::get()->migrateTo(destPE);
913 }
914
915 CDECL void TCHARM_Evacuate()
916 {
917         TCHARMAPI("TCHARM_Migrate_to");
918         TCharm::get()->evacuate();
919 }
920
921 FORTRAN_AS_C(TCHARM_MIGRATE_TO,TCHARM_Migrate_to,tcharm_migrate_to,
922         (int *destPE),(*destPE))
923
924 CDECL void TCHARM_Yield(void)
925 {
926         TCHARMAPI("TCHARM_Yield");
927         TCharm::get()->schedule();
928 }
929 FORTRAN_AS_C(TCHARM_YIELD,TCHARM_Yield,tcharm_yield,(void),())
930
931 CDECL void TCHARM_Barrier(void)
932 {
933         TCHARMAPI("TCHARM_Barrier");
934         TCharm::get()->barrier();
935 }
936 FORTRAN_AS_C(TCHARM_BARRIER,TCHARM_Barrier,tcharm_barrier,(void),())
937
938 CDECL void TCHARM_Done(void)
939 {
940         TCHARMAPI("TCHARM_Done");
941         TCharm *c=TCharm::getNULL();
942         if (!c) CkExit();
943         else c->done();
944 }
945 FORTRAN_AS_C(TCHARM_DONE,TCHARM_Done,tcharm_done,(void),())
946
947
948 CDECL double TCHARM_Wall_timer(void)
949 {
950   TCHARMAPI("TCHARM_Wall_timer");
951   TCharm *c=TCharm::getNULL();
952   if(!c) return CkWallTimer();
953   else { //Have to apply current thread's time offset
954     return CkWallTimer()+c->getTimeOffset();
955   }
956 }
957
958 #if 1
959 /*Include Fortran-style "iargc" and "getarg" routines.
960 These are needed to get access to the command-line arguments from Fortran.
961 */
962 FDECL int FTN_NAME(TCHARM_IARGC,tcharm_iargc)(void) {
963   TCHARMAPI("tcharm_iargc");
964   return CkGetArgc()-1;
965 }
966
967 FDECL void FTN_NAME(TCHARM_GETARG,tcharm_getarg)
968         (int *i_p,char *dest,int destLen)
969 {
970   TCHARMAPI("tcharm_getarg");
971   int i=*i_p;
972   if (i<0) CkAbort("tcharm_getarg called with negative argument!");
973   if (i>=CkGetArgc()) CkAbort("tcharm_getarg called with argument > iargc!");
974   const char *src=CkGetArgv()[i];
975   strcpy(dest,src);
976   for (i=strlen(dest);i<destLen;i++) dest[i]=' ';
977 }
978
979 #endif
980
981 //These silly routines are used for serial startup:
982 extern void _initCharm(int argc, char **argv);
983 CDECL void TCHARM_Init(int *argc,char ***argv) {
984         if (!tcharm_initted) {
985           ConverseInit(*argc, *argv, (CmiStartFn) _initCharm,1,1);
986           _initCharm(*argc,*argv);
987         }
988 }
989
990 FDECL void FTN_NAME(TCHARM_INIT,tcharm_init)(void)
991 {
992         int argc=1;
993         const char *argv_sto[2]={"foo",NULL};
994         char **argv=(char **)argv_sto;
995         TCHARM_Init(&argc,&argv);
996 }
997
998 /***********************************
999 * TCHARM Semaphores:
1000 * The idea is one side "puts", the other side "gets"; 
1001 * but the calls can come in any order--
1002 * if the "get" comes first, it blocks until the put.
1003 * This makes a convenient, race-condition-free way to do
1004 * onetime initializations.  
1005 */
1006 /// Find this semaphore, or insert if there isn't one:
1007 TCharm::TCharmSemaphore *TCharm::findSema(int id) {
1008         for (int s=0;s<sema.size();s++)
1009                 if (sema[s].id==id) 
1010                         return &sema[s];
1011         sema.push_back(TCharmSemaphore(id));
1012         return &sema[sema.size()-1];
1013 }
1014 /// Remove this semaphore from the list
1015 void TCharm::freeSema(TCharmSemaphore *doomed) {
1016         int id=doomed->id;
1017         for (int s=0;s<sema.size();s++)
1018                 if (sema[s].id==id) {
1019                         sema[s]=sema[sema.length()-1];
1020                         sema.length()--;
1021                         return;
1022                 }
1023         CkAbort("Tried to free nonexistent TCharm semaphore");
1024 }
1025
1026 /// Block until this semaphore has data:
1027 TCharm::TCharmSemaphore *TCharm::getSema(int id) {
1028         TCharmSemaphore *s=findSema(id);
1029         if (s->data==NULL) 
1030         { //Semaphore isn't filled yet: wait until it is
1031                 s->thread=CthSelf();
1032                 suspend(); //Will be woken by semaPut
1033                 // Semaphore may have moved-- find it again
1034                 s=findSema(id);
1035                 if (s->data==NULL) CkAbort("TCharm::semaGet awoken too early!");
1036         }
1037         return s;
1038 }
1039
1040 /// Store data at the semaphore "id".
1041 ///  The put can come before or after the get.
1042 void TCharm::semaPut(int id,void *data) {
1043         TCharmSemaphore *s=findSema(id);
1044         if (s->data!=NULL) CkAbort("Duplicate calls to TCharm::semaPut!");
1045         s->data=data;
1046         DBG("semaPut "<<id<<" "<<data);
1047         if (s->thread!=NULL) {//Awaken the thread
1048                 s->thread=NULL;
1049                 resume();
1050         }
1051 }
1052
1053 /// Retreive data from the semaphore "id".
1054 ///  Blocks if the data is not immediately available.
1055 ///  Consumes the data, so another put will be required for the next get.
1056 void *TCharm::semaGet(int id) {
1057         TCharmSemaphore *s=getSema(id);
1058         void *ret=s->data;
1059         DBG("semaGet "<<id<<" "<<ret);
1060         // Now remove the semaphore from the list:
1061         freeSema(s);
1062         return ret;
1063 }
1064
1065 /// Retreive data from the semaphore "id".
1066 ///  Blocks if the data is not immediately available.
1067 void *TCharm::semaGets(int id) {
1068         TCharmSemaphore *s=getSema(id);
1069         return s->data;
1070 }
1071
1072 /// Retreive data from the semaphore "id", or returns NULL.
1073 void *TCharm::semaPeek(int id) {
1074         TCharmSemaphore *s=findSema(id);
1075         return s->data;
1076 }
1077
1078 /****** System Call support ******/
1079 /*
1080 TCHARM_System exists to work around a bug where Linux ia32
1081 glibc2.2.x with pthreads crashes at the fork() site when 
1082 called from a user-levelthread. 
1083
1084 The fix is to call system from the main thread, by 
1085 passing the request out of the thread to our array element 
1086 before calling system().
1087 */
1088
1089 CDECL int 
1090 TCHARM_System(const char *shell_command)
1091 {
1092         return TCharm::get()->system(shell_command);
1093 }
1094 int TCharm::system(const char *cmd)
1095 {
1096         int ret=-1778;
1097         callSystemStruct s;
1098         s.cmd=cmd;
1099         s.ret=&ret;
1100         thisProxy[thisIndex].callSystem(s);
1101         suspend();
1102         return ret;
1103 }
1104
1105 void TCharm::callSystem(const callSystemStruct &s)
1106 {
1107         *s.ret = ::system(s.cmd);
1108         resume();
1109 }
1110
1111
1112
1113 #include "tcharm.def.h"