Merge branch 'charm' of charmgit:charm into charm
[charm.git] / src / libs / ck-libs / tcharm / tcharm.C
1 /*
2 Threaded Charm++ "Framework Framework"
3
4 Orion Sky Lawlor, olawlor@acm.org, 11/19/2001
5  */
6 #include "tcharm_impl.h"
7 #include "tcharm.h"
8 #include "ckevacuation.h"
9 #include <ctype.h>
10
11 #if 0 
12     /*Many debugging statements:*/
13 #    define DBG(x) ckout<<"["<<thisIndex<<","<<CkMyPe()<<"] TCHARM> "<<x<<endl;
14 #    define DBGX(x) ckout<<"PE("<<CkMyPe()<<") TCHARM> "<<x<<endl;
15 #else
16     /*No debugging statements*/
17 #    define DBG(x) /*empty*/
18 #    define DBGX(x) /*empty*/
19 #endif
20
21 CtvDeclare(TCharm *,_curTCharm);
22
23 static int lastNumChunks=0;
24
25 class TCharmTraceLibList {
26         enum {maxLibs=20,maxLibNameLen=15};
27         //List of libraries we want to trace:
28         int curLibs;
29         char libNames[maxLibs][maxLibNameLen];
30         int checkIfTracing(const char *lib) const
31         {
32                 for (int i=0;i<curLibs;i++) 
33                         if (0==strcmp(lib,libNames[i]))
34                                 return 1;
35                 return 0;
36         }
37 public:
38         TCharmTraceLibList() {curLibs=0;}
39         void addTracing(const char *lib) 
40         { //We want to trace this library-- add its name to the list.
41                 CkPrintf("TCHARM> Will trace calls to library %s\n",lib);
42                 int i;
43                 for (i=0;0!=*lib;i++,lib++)
44                         libNames[curLibs][i]=tolower(*lib);
45                 libNames[curLibs][i]=0;
46                 // if already tracing, skip
47                 if (checkIfTracing(libNames[curLibs])) return;
48                 curLibs++;
49         }
50         inline int isTracing(const char *lib) const {
51                 if (curLibs==0) return 0; //Common case
52                 else return checkIfTracing(lib);
53         }
54 };
55 static TCharmTraceLibList tcharm_tracelibs;
56 static int tcharm_nomig=0, tcharm_nothreads=0;
57 static int tcharm_stacksize=1*1024*1024; /*Default stack size is 1MB*/
58 static int tcharm_initted=0;
59 CkpvDeclare(int, mapCreated);
60 static CkGroupID mapID;
61 static char* mapping = NULL;
62
63 void TCharm::nodeInit(void)
64 {
65 }
66
67 void TCharm::procInit(void)
68 {
69   CtvInitialize(TCharm *,_curTCharm);
70   CtvAccess(_curTCharm)=NULL;
71   tcharm_initted=1;
72   CtgInit();
73
74   CkpvInitialize(int, mapCreated);
75   CkpvAccess(mapCreated) = 0;
76
77   // called on every pe to eat these arguments
78   char **argv=CkGetArgv();
79   tcharm_nomig=CmiGetArgFlagDesc(argv,"+tcharm_nomig","Disable migration support (debugging)");
80   tcharm_nothreads=CmiGetArgFlagDesc(argv,"+tcharm_nothread","Disable thread support (debugging)");
81   tcharm_nothreads|=CmiGetArgFlagDesc(argv,"+tcharm_nothreads",NULL);
82   char *traceLibName=NULL;
83   while (CmiGetArgStringDesc(argv,"+tcharm_trace",&traceLibName,"Print each call to this library"))
84       tcharm_tracelibs.addTracing(traceLibName);
85   // CmiGetArgIntDesc(argv,"+tcharm_stacksize",&tcharm_stacksize,"Set the thread stack size (default 1MB)");
86   char *str;
87   if (CmiGetArgStringDesc(argv,"+tcharm_stacksize",&str,"Set the thread stack size (default 1MB)"))  {
88     if (strpbrk(str,"M")) {
89       sscanf(str, "%dM", &tcharm_stacksize);
90       tcharm_stacksize *= 1024*1024;
91     }
92     else if (strpbrk(str,"K")) {
93       sscanf(str, "%dK", &tcharm_stacksize);
94       tcharm_stacksize *= 1024;
95     }
96     else {
97       sscanf(str, "%d", &tcharm_stacksize);
98     }
99     if (CkMyPe() == 0)
100       CkPrintf("TCharm> stack size is set to %d.\n", tcharm_stacksize);
101   }
102   if (CkMyPe()!=0) { //Processor 0 eats "+vp<N>" and "-vp<N>" later:
103         int ignored;
104         while (CmiGetArgIntDesc(argv,"-vp",&ignored,NULL)) {}
105         while (CmiGetArgIntDesc(argv,"+vp",&ignored,NULL)) {}
106   }
107   if (CkMyPe()==0) { // Echo various debugging options:
108     if (tcharm_nomig) CmiPrintf("TCHARM> Disabling migration support, for debugging\n");
109     if (tcharm_nothreads) CmiPrintf("TCHARM> Disabling thread support, for debugging\n");
110   }
111   if (CkpvAccess(mapCreated)==0) {
112     if (0!=CmiGetArgString(argv, "+mapping", &mapping)){
113     }
114     CkpvAccess(mapCreated)=1;
115   }
116 }
117
118 void TCHARM_Api_trace(const char *routineName,const char *libraryName)
119 {
120         if (!tcharm_tracelibs.isTracing(libraryName)) return;
121         TCharm *tc=CtvAccess(_curTCharm);
122         char where[100];
123         if (tc==NULL) sprintf(where,"[serial context on %d]",CkMyPe());
124         else sprintf(where,"[%p> vp %d, p %d]",(void *)tc,tc->getElement(),CkMyPe());
125         CmiPrintf("%s Called routine %s\n",where,routineName);
126         CmiPrintStackTrace(1);
127         CmiPrintf("\n");
128 }
129
130 // register thread start functions to get a function handler
131 // this is portable across heterogeneous platforms, or on machines with
132 // random stack/function pointer
133
134 static CkVec<TCHARM_Thread_data_start_fn> threadFnTable;
135
136 int TCHARM_Register_thread_function(TCHARM_Thread_data_start_fn fn)
137 {
138   int idx = threadFnTable.size();
139   threadFnTable.push_back(fn);
140   return idx+1;                     // make 0 invalid number
141 }
142
143 TCHARM_Thread_data_start_fn getTCharmThreadFunction(int idx)
144 {
145   CmiAssert(idx > 0);
146   return threadFnTable[idx-1];
147 }
148
149 static void startTCharmThread(TCharmInitMsg *msg)
150 {
151         DBGX("thread started");
152         TCharm::activateThread();
153        TCHARM_Thread_data_start_fn threadFn = getTCharmThreadFunction(msg->threadFn);
154         threadFn(msg->data);
155         TCharm::deactivateThread();
156         CtvAccess(_curTCharm)->done();
157 }
158
159 TCharm::TCharm(TCharmInitMsg *initMsg_)
160 {
161   initMsg=initMsg_;
162   initMsg->opts.sanityCheck();
163   timeOffset=0.0;
164   threadGlobals=CtgCreate();
165   if (tcharm_nothreads)
166   { //Don't even make a new thread-- just use main thread
167     tid=CthSelf();
168   }
169   else /*Create a thread normally*/
170   {
171     if (tcharm_nomig) { /*Nonmigratable version, for debugging*/
172       tid=CthCreate((CthVoidFn)startTCharmThread,initMsg,initMsg->opts.stackSize);
173     } else {
174       tid=CthCreateMigratable((CthVoidFn)startTCharmThread,initMsg,initMsg->opts.stackSize);
175     }
176 #if CMK_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 !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                 int nextPE = getNextPE(CkArrayIndex1D(thisIndex));
531 //              resumeAfterMigration=true;
532                 CcdCallFnAfter((CcdVoidFn)CkEmmigrateElement, (void *)myRec, 1);
533                 suspend();
534                 return;
535         }
536         return;
537
538 }
539
540 //calls atsync with async mode
541 void TCharm::async_migrate(void)
542 {
543 #if CMK_LBDB_ON
544   DBG("going to sync at async mode");
545   skipResume = true;            // we resume immediately
546   ReadyMigrate(false);
547   AtSync(0);
548   schedule();
549 //  allow_migrate();
550 #else
551   DBG("skipping sync, because there is no load balancer");
552 #endif
553 }
554
555 /*
556 Note:
557  thread can only migrate at the point when this is called
558 */
559 void TCharm::allow_migrate(void)
560 {
561 #if CMK_LBDB_ON
562 //  ReadyMigrate(true);
563   int nextPe = MigrateToPe();
564   if (nextPe != -1) {
565     migrateTo(nextPe);
566   }
567 #else
568   DBG("skipping sync, because there is no load balancer");
569 #endif
570 }
571
572 //Resume from sync: start the thread again
573 void TCharm::ResumeFromSync(void)
574 {
575   //if(isSelfDone) return;
576   //if (exitWhenDone) return; //for bigsim ooc execution
577   if (!skipResume) start();
578 }
579
580
581 /****** TcharmClient ******/
582 void TCharmClient1D::ckJustMigrated(void) {
583   ArrayElement1D::ckJustMigrated();
584   findThread();
585   tcharmClientInit();
586 }
587
588 void TCharmClient1D::pup(PUP::er &p) {
589   ArrayElement1D::pup(p);
590   p|threadProxy;
591 }
592
593 CkArrayID TCHARM_Get_threads(void) {
594         TCHARMAPI("TCHARM_Get_threads");
595         return TCharm::get()->getProxy();
596 }
597
598 /************* Startup/Shutdown Coordination Support ************/
599
600 // Useless values to reduce over:
601 int _vals[2]={0,1};
602
603 //Called when we want to go to a barrier
604 void TCharm::barrier(void) {
605         //Contribute to a synchronizing reduction
606         CkCallback cb(index_t::atBarrier(0), thisProxy[0]);
607         contribute(sizeof(_vals),&_vals,CkReduction::sum_int,cb);
608 #if CMK_BIGSIM_CHARM
609         void *curLog;           // store current log in timeline
610         _TRACE_BG_TLINE_END(&curLog);
611         TRACE_BG_AMPI_BREAK(NULL, "TCharm_Barrier_START", NULL, 0, 1);
612 #endif
613         stop();
614 #if CMK_BIGSIM_CHARM
615          _TRACE_BG_SET_INFO(NULL, "TCHARM_Barrier_END",  &curLog, 1);
616 #endif
617 }
618
619 //Called when we've reached the barrier
620 void TCharm::atBarrier(CkReductionMsg *m) {
621         DBGX("clients all at barrier");
622         delete m;
623         thisProxy.start(); //Just restart everybody
624 }
625
626 //Called when the thread is done running
627 void TCharm::done(void) {
628         //CmiPrintStackTrace(0);
629         DBG("TCharm thread "<<thisIndex<<" done")
630         if (exitWhenDone) {
631                 //Contribute to a synchronizing reduction
632                 CkCallback cb(index_t::atExit(0), thisProxy[0]);
633                 contribute(sizeof(_vals),&_vals,CkReduction::sum_int,cb);
634         }
635         isSelfDone = true;
636         stop();
637 }
638 //Called when all threads are done running
639 void TCharm::atExit(CkReductionMsg *m) {
640         DBGX("TCharm::atExit1> exiting");
641         delete m;
642         //thisProxy.unsetFlags();
643         CkExit();
644         //CkPrintf("After CkExit()!!!!!!!\n");
645 }
646
647 /************* Setup **************/
648
649 //Globals used to control setup process
650 static TCHARM_Fallback_setup_fn g_fallbackSetup=NULL;
651 void TCHARM_Set_fallback_setup(TCHARM_Fallback_setup_fn f)
652 {
653         g_fallbackSetup=f;
654 }
655 void TCHARM_Call_fallback_setup(void) {
656         if (g_fallbackSetup) 
657                 (g_fallbackSetup)();
658         else
659                 CkAbort("TCHARM: Unexpected fallback setup--missing TCHARM_User_setup routine?");
660 }
661
662 /************** User API ***************/
663 /**********************************
664 Callable from UserSetup:
665 */
666
667 // Read the command line to figure out how many threads to create:
668 CDECL int TCHARM_Get_num_chunks(void)
669 {
670         TCHARMAPI("TCHARM_Get_num_chunks");
671         if (CkMyPe()!=0) CkAbort("TCHARM_Get_num_chunks should only be called on PE 0 during setup!");
672         int nChunks=CkNumPes();
673         char **argv=CkGetArgv();
674         CmiGetArgIntDesc(argv,"-vp",&nChunks,"Set the total number of virtual processors");
675         CmiGetArgIntDesc(argv,"+vp",&nChunks,NULL);
676         lastNumChunks=nChunks;
677         return nChunks;
678 }
679 FDECL int FTN_NAME(TCHARM_GET_NUM_CHUNKS,tcharm_get_num_chunks)(void)
680 {
681         return TCHARM_Get_num_chunks();
682 }
683
684 // Fill out the default thread options:
685 TCHARM_Thread_options::TCHARM_Thread_options(int doDefault)
686 {
687         stackSize=0; /* default stacksize */
688         exitWhenDone=0; /* don't exit when done by default. */
689 }
690 void TCHARM_Thread_options::sanityCheck(void) {
691         if (stackSize<=0) stackSize=tcharm_stacksize;
692 }
693
694
695 TCHARM_Thread_options g_tcharmOptions(1);
696
697 /*Set the size of the thread stack*/
698 CDECL void TCHARM_Set_stack_size(int newStackSize)
699 {
700         TCHARMAPI("TCHARM_Set_stack_size");
701         g_tcharmOptions.stackSize=newStackSize;
702 }
703 FDECL void FTN_NAME(TCHARM_SET_STACK_SIZE,tcharm_set_stack_size)
704         (int *newSize)
705 { TCHARM_Set_stack_size(*newSize); }
706
707 CDECL void TCHARM_Set_exit(void) { g_tcharmOptions.exitWhenDone=1; }
708
709 /*Create a new array of threads, which will be bound to by subsequent libraries*/
710 CDECL void TCHARM_Create(int nThreads,
711                         int threadFn)
712 {
713         TCHARMAPI("TCHARM_Create");
714         TCHARM_Create_data(nThreads,
715                          threadFn,NULL,0);
716 }
717 FDECL void FTN_NAME(TCHARM_CREATE,tcharm_create)
718         (int *nThreads,int threadFn)
719 { TCHARM_Create(*nThreads,threadFn); }
720
721 static CProxy_TCharm TCHARM_Build_threads(TCharmInitMsg *msg);
722
723 /*As above, but pass along (arbitrary) data to threads*/
724 CDECL void TCHARM_Create_data(int nThreads,
725                   int threadFn,
726                   void *threadData,int threadDataLen)
727 {
728         TCHARMAPI("TCHARM_Create_data");
729         TCharmInitMsg *msg=new (threadDataLen,0) TCharmInitMsg(
730                 threadFn,g_tcharmOptions);
731         msg->numElements=nThreads;
732         memcpy(msg->data,threadData,threadDataLen);
733         TCHARM_Build_threads(msg);
734         
735         // Reset the thread options:
736         g_tcharmOptions=TCHARM_Thread_options(1);
737 }
738
739 FDECL void FTN_NAME(TCHARM_CREATE_DATA,tcharm_create_data)
740         (int *nThreads,
741                   int threadFn,
742                   void *threadData,int *threadDataLen)
743 { TCHARM_Create_data(*nThreads,threadFn,threadData,*threadDataLen); }
744
745 CkGroupID CkCreatePropMap(void);
746
747 static CProxy_TCharm TCHARM_Build_threads(TCharmInitMsg *msg)
748 {
749   char *tmp;
750   char **argv=CkGetArgv();
751   CkArrayOptions opts(msg->numElements);
752   CkAssert(CkpvAccess(mapCreated)==1);
753
754   if(haveConfigurableRRMap()){
755     CkPrintf("USING ConfigurableRRMap\n");
756     mapID=CProxy_ConfigurableRRMap::ckNew();
757   } else if(mapping==NULL){
758 #if CMK_BIGSIM_CHARM
759     mapID=CProxy_BlockMap::ckNew();
760 #else
761 #if __FAULT__
762         mapID=CProxy_RRMap::ckNew();
763 #else
764     mapID=CkCreatePropMap();
765 #endif
766 #endif
767   } else if(0 == strcmp(mapping,"BLOCK_MAP")) {
768     CkPrintf("USING BLOCK_MAP\n");
769     mapID = CProxy_BlockMap::ckNew();
770   } else if(0 == strcmp(mapping,"RR_MAP")) {
771     CkPrintf("USING RR_MAP\n");
772     mapID = CProxy_RRMap::ckNew();
773   } else if(0 == strcmp(mapping,"MAPFILE")) {
774     CkPrintf("Reading map from file\n");
775     mapID = CProxy_ReadFileMap::ckNew();
776   } else {  // "PROP_MAP" or anything else
777     mapID = CkCreatePropMap();
778   }
779   opts.setMap(mapID);
780   int nElem=msg->numElements; //<- save it because msg will be deleted.
781   return CProxy_TCharm::ckNew(msg,opts);
782 }
783
784 // Helper used when creating a new array bound to the TCHARM threads:
785 CkArrayOptions TCHARM_Attach_start(CkArrayID *retTCharmArray,int *retNumElts)
786 {
787         TCharm *tc=TCharm::get();
788         if (!tc)
789                 CkAbort("You must call TCHARM initialization routines from a TCHARM thread!");
790         int nElts=tc->getNumElements();
791       
792         //CmiPrintf("TCHARM Elements = %d\n", nElts);  
793       
794         if (retNumElts!=NULL) *retNumElts=nElts;
795         *retTCharmArray=tc->getProxy();
796         CkArrayOptions opts(nElts);
797         opts.bindTo(tc->getProxy());
798         return opts;
799 }
800
801 void TCHARM_Suspend(void) {
802         TCharm *tc=TCharm::get();
803         tc->suspend();
804 }
805
806 /***********************************
807 Callable from worker thread
808 */
809 CDECL int TCHARM_Element(void)
810
811         TCHARMAPI("TCHARM_Element");
812         return TCharm::get()->getElement();
813 }
814 CDECL int TCHARM_Num_elements(void)
815
816         TCHARMAPI("TCHARM_Num_elements");
817         return TCharm::get()->getNumElements();
818 }
819
820 FDECL int FTN_NAME(TCHARM_ELEMENT,tcharm_element)(void) 
821 { return TCHARM_Element();}
822 FDECL int FTN_NAME(TCHARM_NUM_ELEMENTS,tcharm_num_elements)(void) 
823 { return TCHARM_Num_elements();}
824
825 //Make sure this address will migrate with us when we move:
826 static void checkAddress(void *data)
827 {
828         if (tcharm_nomig||tcharm_nothreads) return; //Stack is not isomalloc'd
829         if (CmiThreadIs(CMI_THREAD_IS_ALIAS)||CmiThreadIs(CMI_THREAD_IS_STACKCOPY)) return; // memory alias thread
830         if (CmiIsomallocEnabled()) {
831           if (!CmiIsomallocInRange(data))
832             CkAbort("The UserData you register must be allocated on the stack!\n");
833         }
834         else {
835           if(CkMyPe() == 0)
836             CkPrintf("Warning> checkAddress failed because isomalloc not supported.\n");
837         }
838 }
839
840 /* Old "register"-based userdata: */
841 CDECL int TCHARM_Register(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 FDECL int FTN_NAME(TCHARM_REGISTER,tcharm_register)
848         (void *data,TCHARM_Pup_fn pfn)
849
850         TCHARMAPI("TCHARM_Register");
851         checkAddress(data);
852         return TCharm::get()->add(TCharm::UserData(pfn,TCharm::get()->getThread(),data));
853 }
854
855 CDECL void *TCHARM_Get_userdata(int id)
856 {
857         TCHARMAPI("TCHARM_Get_userdata");
858         return TCharm::get()->lookupUserData(id);
859 }
860 FDECL void *FTN_NAME(TCHARM_GET_USERDATA,tcharm_get_userdata)(int *id)
861 { return TCHARM_Get_userdata(*id); }
862
863 /* New hardcoded-ID userdata: */
864 CDECL void TCHARM_Set_global(int globalID,void *new_value,TCHARM_Pup_global_fn pup_or_NULL)
865 {
866         TCHARMAPI("TCHARM_Set_global");
867         TCharm *tc=TCharm::get();
868         if (tc->sud.length()<=globalID)
869         { //We don't have room for this ID yet: make room
870                 int newLen=2*globalID;
871                 tc->sud.resize(newLen);
872         }
873         tc->sud[globalID]=TCharm::UserData(pup_or_NULL,tc->getThread(),new_value);
874 }
875 CDECL void *TCHARM_Get_global(int globalID)
876 {
877         //Skip TCHARMAPI("TCHARM_Get_global") because there's no dynamic allocation here,
878         // and this routine should be as fast as possible.
879         CkVec<TCharm::UserData> &v=TCharm::get()->sud;
880         if (v.length()<=globalID) return NULL; //Uninitialized global
881         return v[globalID].getData();
882 }
883
884 CDECL void TCHARM_Migrate(void)
885 {
886         TCHARMAPI("TCHARM_Migrate");
887         if (CthMigratable() == 0) {
888           if(CkMyPe() == 0)
889             CkPrintf("Warning> thread migration is not supported!\n");
890           return;
891         }
892         TCharm::get()->migrate();
893 }
894 FORTRAN_AS_C(TCHARM_MIGRATE,TCHARM_Migrate,tcharm_migrate,(void),())
895
896 CDECL void TCHARM_Async_Migrate(void)
897 {
898         TCHARMAPI("TCHARM_Async_Migrate");
899         TCharm::get()->async_migrate();
900 }
901 FORTRAN_AS_C(TCHARM_ASYNC_MIGRATE,TCHARM_Async_Migrate,tcharm_async_migrate,(void),())
902
903 CDECL void TCHARM_Allow_Migrate(void)
904 {
905         TCHARMAPI("TCHARM_Allow_Migrate");
906         TCharm::get()->allow_migrate();
907 }
908 FORTRAN_AS_C(TCHARM_ALLOW_MIGRATE,TCHARM_Allow_Migrate,tcharm_allow_migrate,(void),())
909
910 CDECL void TCHARM_Migrate_to(int destPE)
911 {
912         TCHARMAPI("TCHARM_Migrate_to");
913         TCharm::get()->migrateTo(destPE);
914 }
915
916 CDECL void TCHARM_Evacuate()
917 {
918         TCHARMAPI("TCHARM_Migrate_to");
919         TCharm::get()->evacuate();
920 }
921
922 FORTRAN_AS_C(TCHARM_MIGRATE_TO,TCHARM_Migrate_to,tcharm_migrate_to,
923         (int *destPE),(*destPE))
924
925 CDECL void TCHARM_Yield(void)
926 {
927         TCHARMAPI("TCHARM_Yield");
928         TCharm::get()->schedule();
929 }
930 FORTRAN_AS_C(TCHARM_YIELD,TCHARM_Yield,tcharm_yield,(void),())
931
932 CDECL void TCHARM_Barrier(void)
933 {
934         TCHARMAPI("TCHARM_Barrier");
935         TCharm::get()->barrier();
936 }
937 FORTRAN_AS_C(TCHARM_BARRIER,TCHARM_Barrier,tcharm_barrier,(void),())
938
939 CDECL void TCHARM_Done(void)
940 {
941         TCHARMAPI("TCHARM_Done");
942         TCharm *c=TCharm::getNULL();
943         if (!c) CkExit();
944         else c->done();
945 }
946 FORTRAN_AS_C(TCHARM_DONE,TCHARM_Done,tcharm_done,(void),())
947
948
949 CDECL double TCHARM_Wall_timer(void)
950 {
951   TCHARMAPI("TCHARM_Wall_timer");
952   TCharm *c=TCharm::getNULL();
953   if(!c) return CkWallTimer();
954   else { //Have to apply current thread's time offset
955     return CkWallTimer()+c->getTimeOffset();
956   }
957 }
958
959 #if 1
960 /*Include Fortran-style "iargc" and "getarg" routines.
961 These are needed to get access to the command-line arguments from Fortran.
962 */
963 FDECL int FTN_NAME(TCHARM_IARGC,tcharm_iargc)(void) {
964   TCHARMAPI("tcharm_iargc");
965   return CkGetArgc()-1;
966 }
967
968 FDECL void FTN_NAME(TCHARM_GETARG,tcharm_getarg)
969         (int *i_p,char *dest,int destLen)
970 {
971   TCHARMAPI("tcharm_getarg");
972   int i=*i_p;
973   if (i<0) CkAbort("tcharm_getarg called with negative argument!");
974   if (i>=CkGetArgc()) CkAbort("tcharm_getarg called with argument > iargc!");
975   const char *src=CkGetArgv()[i];
976   strcpy(dest,src);
977   for (i=strlen(dest);i<destLen;i++) dest[i]=' ';
978 }
979
980 #endif
981
982 //These silly routines are used for serial startup:
983 extern void _initCharm(int argc, char **argv);
984 CDECL void TCHARM_Init(int *argc,char ***argv) {
985         if (!tcharm_initted) {
986           ConverseInit(*argc, *argv, (CmiStartFn) _initCharm,1,1);
987           _initCharm(*argc,*argv);
988         }
989 }
990
991 FDECL void FTN_NAME(TCHARM_INIT,tcharm_init)(void)
992 {
993         int argc=1;
994         const char *argv_sto[2]={"foo",NULL};
995         char **argv=(char **)argv_sto;
996         TCHARM_Init(&argc,&argv);
997 }
998
999 /***********************************
1000 * TCHARM Semaphores:
1001 * The idea is one side "puts", the other side "gets"; 
1002 * but the calls can come in any order--
1003 * if the "get" comes first, it blocks until the put.
1004 * This makes a convenient, race-condition-free way to do
1005 * onetime initializations.  
1006 */
1007 /// Find this semaphore, or insert if there isn't one:
1008 TCharm::TCharmSemaphore *TCharm::findSema(int id) {
1009         for (int s=0;s<sema.size();s++)
1010                 if (sema[s].id==id) 
1011                         return &sema[s];
1012         sema.push_back(TCharmSemaphore(id));
1013         return &sema[sema.size()-1];
1014 }
1015 /// Remove this semaphore from the list
1016 void TCharm::freeSema(TCharmSemaphore *doomed) {
1017         int id=doomed->id;
1018         for (int s=0;s<sema.size();s++)
1019                 if (sema[s].id==id) {
1020                         sema[s]=sema[sema.length()-1];
1021                         sema.length()--;
1022                         return;
1023                 }
1024         CkAbort("Tried to free nonexistent TCharm semaphore");
1025 }
1026
1027 /// Block until this semaphore has data:
1028 TCharm::TCharmSemaphore *TCharm::getSema(int id) {
1029         TCharmSemaphore *s=findSema(id);
1030         if (s->data==NULL) 
1031         { //Semaphore isn't filled yet: wait until it is
1032                 s->thread=CthSelf();
1033                 suspend(); //Will be woken by semaPut
1034                 // Semaphore may have moved-- find it again
1035                 s=findSema(id);
1036                 if (s->data==NULL) CkAbort("TCharm::semaGet awoken too early!");
1037         }
1038         return s;
1039 }
1040
1041 /// Store data at the semaphore "id".
1042 ///  The put can come before or after the get.
1043 void TCharm::semaPut(int id,void *data) {
1044         TCharmSemaphore *s=findSema(id);
1045         if (s->data!=NULL) CkAbort("Duplicate calls to TCharm::semaPut!");
1046         s->data=data;
1047         DBG("semaPut "<<id<<" "<<data);
1048         if (s->thread!=NULL) {//Awaken the thread
1049                 s->thread=NULL;
1050                 resume();
1051         }
1052 }
1053
1054 /// Retreive data from the semaphore "id".
1055 ///  Blocks if the data is not immediately available.
1056 ///  Consumes the data, so another put will be required for the next get.
1057 void *TCharm::semaGet(int id) {
1058         TCharmSemaphore *s=getSema(id);
1059         void *ret=s->data;
1060         DBG("semaGet "<<id<<" "<<ret);
1061         // Now remove the semaphore from the list:
1062         freeSema(s);
1063         return ret;
1064 }
1065
1066 /// Retreive data from the semaphore "id".
1067 ///  Blocks if the data is not immediately available.
1068 void *TCharm::semaGets(int id) {
1069         TCharmSemaphore *s=getSema(id);
1070         return s->data;
1071 }
1072
1073 /// Retreive data from the semaphore "id", or returns NULL.
1074 void *TCharm::semaPeek(int id) {
1075         TCharmSemaphore *s=findSema(id);
1076         return s->data;
1077 }
1078
1079 /****** System Call support ******/
1080 /*
1081 TCHARM_System exists to work around a bug where Linux ia32
1082 glibc2.2.x with pthreads crashes at the fork() site when 
1083 called from a user-levelthread. 
1084
1085 The fix is to call system from the main thread, by 
1086 passing the request out of the thread to our array element 
1087 before calling system().
1088 */
1089
1090 CDECL int 
1091 TCHARM_System(const char *shell_command)
1092 {
1093         return TCharm::get()->system(shell_command);
1094 }
1095 int TCharm::system(const char *cmd)
1096 {
1097         int ret=-1778;
1098         callSystemStruct s;
1099         s.cmd=cmd;
1100         s.ret=&ret;
1101         thisProxy[thisIndex].callSystem(s);
1102         suspend();
1103         return ret;
1104 }
1105
1106 void TCharm::callSystem(const callSystemStruct &s)
1107 {
1108         *s.ret = ::system(s.cmd);
1109         resume();
1110 }
1111
1112
1113
1114 #include "tcharm.def.h"