1 /* ---------------------------------------------------------------------------
3 * (c) The GHC Team, 2000-2006
5 * Sparking support for PARALLEL_HASKELL and THREADED_RTS versions of the RTS.
7 * -------------------------------------------------------------------------*/
9 #include "PosixSource.h"
17 # if defined(PARALLEL_HASKELL)
18 # include "ParallelRts.h"
19 # include "GranSimRts.h" // for GR_...
21 # include "GranSimRts.h"
26 #if defined(THREADED_RTS) || defined(PARALLEL_HASKELL)
28 static INLINE_ME void bump_hd (StgSparkPool *p)
29 { p->hd++; if (p->hd == p->lim) p->hd = p->base; }
31 static INLINE_ME void bump_tl (StgSparkPool *p)
32 { p->tl++; if (p->tl == p->lim) p->tl = p->base; }
34 /* -----------------------------------------------------------------------------
36 * Initialising spark pools.
38 * -------------------------------------------------------------------------- */
41 initSparkPool(StgSparkPool *pool)
43 pool->base = stgMallocBytes(RtsFlags.ParFlags.maxLocalSparks
44 * sizeof(StgClosure *),
46 pool->lim = pool->base + RtsFlags.ParFlags.maxLocalSparks;
47 pool->hd = pool->base;
48 pool->tl = pool->base;
52 initSparkPools( void )
55 /* walk over the capabilities, allocating a spark pool for each one */
57 for (i = 0; i < n_capabilities; i++) {
58 initSparkPool(&capabilities[i].r.rSparks);
61 /* allocate a single spark pool */
62 initSparkPool(&MainCapability.r.rSparks);
67 freeSparkPool(StgSparkPool *pool) {
71 /* -----------------------------------------------------------------------------
73 * findSpark: find a spark on the current Capability that we can fork
76 * -------------------------------------------------------------------------- */
79 findSpark (Capability *cap)
84 pool = &(cap->r.rSparks);
85 ASSERT_SPARK_POOL_INVARIANTS(pool);
87 while (pool->hd != pool->tl) {
90 if (closure_SHOULD_SPARK(spark)) {
92 if (RtsFlags.ParFlags.ParStats.Sparks)
93 DumpRawGranEvent(CURRENT_PROC, CURRENT_PROC,
94 GR_STEALING, ((StgTSO *)NULL), spark,
95 0, 0 /* spark_queue_len(ADVISORY_POOL) */);
100 // spark pool is now empty
104 /* -----------------------------------------------------------------------------
106 * Turn a spark into a real thread
108 * -------------------------------------------------------------------------- */
111 createSparkThread (Capability *cap, StgClosure *p)
115 tso = createGenThread (cap, RtsFlags.GcFlags.initialStkSize, p);
116 appendToRunQueue(cap,tso);
119 /* -----------------------------------------------------------------------------
123 * -------------------------------------------------------------------------- */
128 newSpark (StgRegTable *reg, StgClosure *p)
130 StgSparkPool *pool = &(reg->rSparks);
132 /* I am not sure whether this is the right thing to do.
133 * Maybe it is better to exploit the tag information
134 * instead of throwing it away?
136 p = UNTAG_CLOSURE(p);
138 ASSERT_SPARK_POOL_INVARIANTS(pool);
140 if (closure_SHOULD_SPARK(p)) {
143 new_tl = pool->tl + 1;
144 if (new_tl == pool->lim) { new_tl = pool->base; }
145 if (new_tl != pool->hd) {
148 } else if (!closure_SHOULD_SPARK(*pool->hd)) {
149 // if the old closure is not sparkable, discard it and
150 // keep the new one. Otherwise, keep the old one.
154 #else /* DISCARD OLD */
157 if (pool->tl == pool->hd) { bump_hd(pool); }
161 ASSERT_SPARK_POOL_INVARIANTS(pool);
165 /* -----------------------------------------------------------------------------
166 * Mark all nodes pointed to by sparks in the spark queues (for GC) Does an
167 * implicit slide i.e. after marking all sparks are at the beginning of the
168 * spark pool and the spark pool only contains sparkable closures
169 * -------------------------------------------------------------------------- */
172 updateSparkQueue (Capability *cap)
174 StgClosure *spark, **sparkp, **to_sparkp;
175 nat n, pruned_sparks; // stats only
178 PAR_TICKY_MARK_SPARK_QUEUE_START();
183 pool = &(cap->r.rSparks);
185 ASSERT_SPARK_POOL_INVARIANTS(pool);
188 to_sparkp = pool->hd;
189 while (sparkp != pool->tl) {
190 ASSERT(*sparkp!=NULL);
191 ASSERT(LOOKS_LIKE_CLOSURE_PTR(((StgClosure *)*sparkp)));
192 // ToDo?: statistics gathering here (also for GUM!)
193 spark = isAlive(*sparkp);
194 if (spark != NULL && closure_SHOULD_SPARK(spark)) {
195 *to_sparkp++ = spark;
196 if (to_sparkp == pool->lim) {
197 to_sparkp = pool->base;
204 if (sparkp == pool->lim) {
208 pool->tl = to_sparkp;
210 PAR_TICKY_MARK_SPARK_QUEUE_END(n);
212 debugTrace(DEBUG_sched,
213 "updated %d sparks and pruned %d sparks",
216 debugTrace(DEBUG_sched,
217 "new spark queue len=%d; (hd=%p; tl=%p)\n",
218 sparkPoolSize(pool), pool->hd, pool->tl);
222 traverseSparkQueue (evac_fn evac, void *user, Capability *cap)
227 pool = &(cap->r.rSparks);
229 while (sparkp != pool->tl) {
232 if (sparkp == pool->lim) {
241 newSpark (StgRegTable *reg STG_UNUSED, StgClosure *p STG_UNUSED)
248 #endif /* PARALLEL_HASKELL || THREADED_RTS */
251 /* -----------------------------------------------------------------------------
253 * GRAN & PARALLEL_HASKELL stuff beyond here.
255 * -------------------------------------------------------------------------- */
257 #if defined(PARALLEL_HASKELL) || defined(GRAN)
259 static void slide_spark_pool( StgSparkPool *pool );
262 add_to_spark_queue( StgClosure *closure, StgSparkPool *pool )
264 if (pool->tl == pool->lim)
265 slide_spark_pool(pool);
267 if (closure_SHOULD_SPARK(closure) &&
268 pool->tl < pool->lim) {
269 *(pool->tl++) = closure;
271 #if defined(PARALLEL_HASKELL)
272 // collect parallel global statistics (currently done together with GC stats)
273 if (RtsFlags.ParFlags.ParStats.Global &&
274 RtsFlags.GcFlags.giveStats > NO_GC_STATS) {
275 // debugBelch("Creating spark for %x @ %11.2f\n", closure, usertime());
276 globalParStats.tot_sparks_created++;
281 #if defined(PARALLEL_HASKELL)
282 // collect parallel global statistics (currently done together with GC stats)
283 if (RtsFlags.ParFlags.ParStats.Global &&
284 RtsFlags.GcFlags.giveStats > NO_GC_STATS) {
285 //debugBelch("Ignoring spark for %x @ %11.2f\n", closure, usertime());
286 globalParStats.tot_sparks_ignored++;
294 slide_spark_pool( StgSparkPool *pool )
296 StgClosure **sparkp, **to_sparkp;
299 to_sparkp = pool->base;
300 while (sparkp < pool->tl) {
301 ASSERT(to_sparkp<=sparkp);
302 ASSERT(*sparkp!=NULL);
303 ASSERT(LOOKS_LIKE_GHC_INFO((*sparkp)->header.info));
305 if (closure_SHOULD_SPARK(*sparkp)) {
306 *to_sparkp++ = *sparkp++;
311 pool->hd = pool->base;
312 pool->tl = to_sparkp;
319 #if !defined(THREADED_RTS)
324 pool = &(cap->rSparks);
325 ASSERT(pool->hd <= pool->tl && pool->tl <= pool->lim);
327 ASSERT(spark != (StgClosure *)NULL);
335 Search the spark queue of the proc in event for a spark that's worth
336 turning into a thread
337 (was gimme_spark in the old RTS)
340 findLocalSpark (rtsEvent *event, rtsBool *found_res, rtsSparkQ *spark_res)
342 PEs proc = event->proc, /* proc to search for work */
343 creator = event->creator; /* proc that requested work */
346 rtsSparkQ spark_of_non_local_node = NULL,
347 spark_of_non_local_node_prev = NULL,
348 low_priority_spark = NULL,
349 low_priority_spark_prev = NULL,
350 spark = NULL, prev = NULL;
352 /* Choose a spark from the local spark queue */
353 prev = (rtsSpark*)NULL;
354 spark = pending_sparks_hds[proc];
357 // ToDo: check this code & implement local sparking !! -- HWL
358 while (!found && spark != (rtsSpark*)NULL)
360 ASSERT((prev!=(rtsSpark*)NULL || spark==pending_sparks_hds[proc]) &&
361 (prev==(rtsSpark*)NULL || prev->next==spark) &&
362 (spark->prev==prev));
364 if (!closure_SHOULD_SPARK(node))
366 IF_GRAN_DEBUG(checkSparkQ,
367 debugBelch("^^ pruning spark %p (node %p) in gimme_spark",
370 if (RtsFlags.GranFlags.GranSimStats.Sparks)
371 DumpRawGranEvent(proc, (PEs)0, SP_PRUNED,(StgTSO*)NULL,
372 spark->node, spark->name, spark_queue_len(proc));
374 ASSERT(spark != (rtsSpark*)NULL);
375 ASSERT(SparksAvail>0);
378 ASSERT(prev==(rtsSpark*)NULL || prev->next==spark);
379 spark = delete_from_sparkq (spark, proc, rtsTrue);
380 if (spark != (rtsSpark*)NULL)
384 /* -- node should eventually be sparked */
385 else if (RtsFlags.GranFlags.PreferSparksOfLocalNodes &&
386 !IS_LOCAL_TO(PROCS(node),CurrentProc))
388 barf("Local sparking not yet implemented");
390 /* Remember first low priority spark */
391 if (spark_of_non_local_node==(rtsSpark*)NULL) {
392 spark_of_non_local_node_prev = prev;
393 spark_of_non_local_node = spark;
396 if (spark->next == (rtsSpark*)NULL) {
397 /* ASSERT(spark==SparkQueueTl); just for testing */
398 prev = spark_of_non_local_node_prev;
399 spark = spark_of_non_local_node;
404 # if defined(GRAN) && defined(GRAN_CHECK)
405 /* Should never happen; just for testing
406 if (spark==pending_sparks_tl) {
407 debugBelch("ReSchedule: Last spark != SparkQueueTl\n");
408 stg_exit(EXIT_FAILURE);
413 ASSERT(SparksAvail>0);
417 else if ( RtsFlags.GranFlags.DoPrioritySparking ||
418 (spark->gran_info >= RtsFlags.GranFlags.SparkPriority2) )
420 if (RtsFlags.GranFlags.DoPrioritySparking)
421 barf("Priority sparking not yet implemented");
426 else /* only used if SparkPriority2 is defined */
428 /* ToDo: fix the code below and re-integrate it */
429 /* Remember first low priority spark */
430 if (low_priority_spark==(rtsSpark*)NULL) {
431 low_priority_spark_prev = prev;
432 low_priority_spark = spark;
435 if (spark->next == (rtsSpark*)NULL) {
436 /* ASSERT(spark==spark_queue_tl); just for testing */
437 prev = low_priority_spark_prev;
438 spark = low_priority_spark;
439 found = rtsTrue; /* take low pri spark => rc is 2 */
443 /* Should never happen; just for testing
444 if (spark==pending_sparks_tl) {
445 debugBelch("ReSchedule: Last spark != SparkQueueTl\n");
446 stg_exit(EXIT_FAILURE);
453 debugBelch("++ Ignoring spark of priority %u (SparkPriority=%u); node=%p; name=%u\n",
454 spark->gran_info, RtsFlags.GranFlags.SparkPriority,
455 spark->node, spark->name);)
458 } /* while (spark!=NULL && !found) */
465 Turn the spark into a thread.
466 In GranSim this basically means scheduling a StartThread event for the
467 node pointed to by the spark at some point in the future.
468 (was munch_spark in the old RTS)
471 activateSpark (rtsEvent *event, rtsSparkQ spark)
473 PEs proc = event->proc, /* proc to search for work */
474 creator = event->creator; /* proc that requested work */
477 rtsTime spark_arrival_time;
480 We've found a node on PE proc requested by PE creator.
481 If proc==creator we can turn the spark into a thread immediately;
482 otherwise we schedule a MoveSpark event on the requesting PE
488 /* only possible if we simulate GUM style fishing */
489 ASSERT(RtsFlags.GranFlags.Fishing);
491 /* Message packing costs for sending a Fish; qeq jabbI'ID */
492 CurrentTime[proc] += RtsFlags.GranFlags.Costs.mpacktime;
494 if (RtsFlags.GranFlags.GranSimStats.Sparks)
495 DumpRawGranEvent(proc, (PEs)0, SP_EXPORTED,
496 (StgTSO*)NULL, spark->node,
497 spark->name, spark_queue_len(proc));
499 /* time of the spark arrival on the remote PE */
500 spark_arrival_time = CurrentTime[proc] + RtsFlags.GranFlags.Costs.latency;
502 new_event(creator, proc, spark_arrival_time,
504 (StgTSO*)NULL, spark->node, spark);
506 CurrentTime[proc] += RtsFlags.GranFlags.Costs.mtidytime;
508 } else { /* proc==creator i.e. turn the spark into a thread */
510 if ( RtsFlags.GranFlags.GranSimStats.Global &&
511 spark->gran_info < RtsFlags.GranFlags.SparkPriority2 ) {
513 globalGranStats.tot_low_pri_sparks++;
515 debugBelch("++ No high priority spark available; low priority (%u) spark chosen: node=%p; name=%u\n",
517 spark->node, spark->name));
520 CurrentTime[proc] += RtsFlags.GranFlags.Costs.threadcreatetime;
525 /* ToDo: fix the GC interface and move to StartThread handling-- HWL */
526 if (GARBAGE COLLECTION IS NECESSARY) {
527 /* Some kind of backoff needed here in case there's too little heap */
528 # if defined(GRAN_CHECK) && defined(GRAN)
529 if (RtsFlags.GcFlags.giveStats)
530 fprintf(RtsFlags.GcFlags.statsFile,"***** vIS Qu' chen veQ boSwI'; spark=%p, node=%p; name=%u\n",
531 /* (found==2 ? "no hi pri spark" : "hi pri spark"), */
532 spark, node, spark->name);
534 new_event(CurrentProc, CurrentProc, CurrentTime[CurrentProc]+1,
536 (StgTSO*)NULL, (StgClosure*)NULL, (rtsSpark*)NULL);
537 barf("//// activateSpark: out of heap ; ToDo: call GarbageCollect()");
538 GarbageCollect(GetRoots, rtsFalse);
539 // HWL old: ReallyPerformThreadGC(TSO_HS+TSO_CTS_SIZE,rtsFalse);
540 // HWL old: SAVE_Hp -= TSO_HS+TSO_CTS_SIZE;
542 return; /* was: continue; */ /* to the next event, eventually */
546 if (RtsFlags.GranFlags.GranSimStats.Sparks)
547 DumpRawGranEvent(CurrentProc,(PEs)0,SP_USED,(StgTSO*)NULL,
548 spark->node, spark->name,
549 spark_queue_len(CurrentProc));
551 new_event(proc, proc, CurrentTime[proc],
553 END_TSO_QUEUE, node, spark); // (rtsSpark*)NULL);
555 procStatus[proc] = Starting;
559 /* -------------------------------------------------------------------------
560 This is the main point where handling granularity information comes into
562 ------------------------------------------------------------------------- */
564 #define MAX_RAND_PRI 100
567 Granularity info transformers.
568 Applied to the GRAN_INFO field of a spark.
570 STATIC_INLINE nat ID(nat x) { return(x); };
571 STATIC_INLINE nat INV(nat x) { return(-x); };
572 STATIC_INLINE nat IGNORE(nat x) { return (0); };
573 STATIC_INLINE nat RAND(nat x) { return ((random() % MAX_RAND_PRI) + 1); }
575 /* NB: size_info and par_info are currently unused (what a shame!) -- HWL */
577 newSpark(node,name,gran_info,size_info,par_info,local)
579 nat name, gran_info, size_info, par_info, local;
584 pri = RtsFlags.GranFlags.RandomPriorities ? RAND(gran_info) :
585 RtsFlags.GranFlags.InversePriorities ? INV(gran_info) :
586 RtsFlags.GranFlags.IgnorePriorities ? IGNORE(gran_info) :
589 if ( RtsFlags.GranFlags.SparkPriority!=0 &&
590 pri<RtsFlags.GranFlags.SparkPriority ) {
592 debugBelch(",, NewSpark: Ignoring spark of priority %u (SparkPriority=%u); node=%#x; name=%u\n",
593 pri, RtsFlags.GranFlags.SparkPriority, node, name));
594 return ((rtsSpark*)NULL);
597 newspark = (rtsSpark*) stgMallocBytes(sizeof(rtsSpark), "NewSpark");
598 newspark->prev = newspark->next = (rtsSpark*)NULL;
599 newspark->node = node;
600 newspark->name = (name==1) ? CurrentTSO->gran.sparkname : name;
601 newspark->gran_info = pri;
602 newspark->global = !local; /* Check that with parAt, parAtAbs !!*/
604 if (RtsFlags.GranFlags.GranSimStats.Global) {
605 globalGranStats.tot_sparks_created++;
606 globalGranStats.sparks_created_on_PE[CurrentProc]++;
627 disposeSparkQ(spark->next);
630 if (SparksAvail < 0) {
631 debugBelch("disposeSparkQ: SparksAvail<0 after disposing sparkq @ %p\n", &spark);
640 With PrioritySparking add_to_spark_queue performs an insert sort to keep
641 the spark queue sorted. Otherwise the spark is just added to the end of
646 add_to_spark_queue(spark)
649 rtsSpark *prev = NULL, *next = NULL;
651 rtsBool found = rtsFalse;
653 if ( spark == (rtsSpark *)NULL ) {
657 if (RtsFlags.GranFlags.DoPrioritySparking && (spark->gran_info != 0) ) {
658 /* Priority sparking is enabled i.e. spark queues must be sorted */
660 for (prev = NULL, next = pending_sparks_hd, count=0;
662 !(found = (spark->gran_info >= next->gran_info));
663 prev = next, next = next->next, count++)
666 } else { /* 'utQo' */
667 /* Priority sparking is disabled */
669 found = rtsFalse; /* to add it at the end */
674 /* next points to the first spark with a gran_info smaller than that
675 of spark; therefore, add spark before next into the spark queue */
677 if ( next == NULL ) {
678 pending_sparks_tl = spark;
683 if ( prev == NULL ) {
684 pending_sparks_hd = spark;
688 } else { /* (RtsFlags.GranFlags.DoPrioritySparking && !found) || !DoPrioritySparking */
689 /* add the spark at the end of the spark queue */
691 spark->prev = pending_sparks_tl;
692 if (pending_sparks_hd == NULL)
693 pending_sparks_hd = spark;
695 pending_sparks_tl->next = spark;
696 pending_sparks_tl = spark;
700 /* add costs for search in priority sparking */
701 if (RtsFlags.GranFlags.DoPrioritySparking) {
702 CurrentTime[CurrentProc] += count * RtsFlags.GranFlags.Costs.pri_spark_overhead;
705 IF_GRAN_DEBUG(checkSparkQ,
706 debugBelch("++ Spark stats after adding spark %p (node %p) to queue on PE %d",
707 spark, spark->node, CurrentProc);
708 print_sparkq_stats());
710 # if defined(GRAN_CHECK)
711 if (RtsFlags.GranFlags.Debug.checkSparkQ) {
712 for (prev = NULL, next = pending_sparks_hd;
714 prev = next, next = next->next)
716 if ( (prev!=NULL) && (prev!=pending_sparks_tl) )
717 debugBelch("SparkQ inconsistency after adding spark %p: (PE %u) pending_sparks_tl (%p) not end of queue (%p)\n",
719 pending_sparks_tl, prev);
723 # if defined(GRAN_CHECK)
724 /* Check if the sparkq is still sorted. Just for testing, really! */
725 if ( RtsFlags.GranFlags.Debug.checkSparkQ &&
726 RtsFlags.GranFlags.Debug.pri ) {
727 rtsBool sorted = rtsTrue;
728 rtsSpark *prev, *next;
730 if (pending_sparks_hd == NULL ||
731 pending_sparks_hd->next == NULL ) {
732 /* just 1 elem => ok */
734 for (prev = pending_sparks_hd,
735 next = pending_sparks_hd->next;
737 prev = next, next = next->next) {
739 (prev->gran_info >= next->gran_info);
743 debugBelch("ghuH: SPARKQ on PE %d is not sorted:\n",
745 print_sparkq(CurrentProc);
752 spark_queue_len(proc)
755 rtsSpark *prev, *spark; /* prev only for testing !! */
758 for (len = 0, prev = NULL, spark = pending_sparks_hds[proc];
760 len++, prev = spark, spark = spark->next)
763 # if defined(GRAN_CHECK)
764 if ( RtsFlags.GranFlags.Debug.checkSparkQ )
765 if ( (prev!=NULL) && (prev!=pending_sparks_tls[proc]) )
766 debugBelch("ERROR in spark_queue_len: (PE %u) pending_sparks_tl (%p) not end of queue (%p)\n",
767 proc, pending_sparks_tls[proc], prev);
774 Take spark out of the spark queue on PE p and nuke the spark. Adjusts
775 hd and tl pointers of the spark queue. Returns a pointer to the next
779 delete_from_sparkq (spark, p, dispose_too) /* unlink and dispose spark */
787 barf("delete_from_sparkq: trying to delete NULL spark\n");
789 # if defined(GRAN_CHECK)
790 if ( RtsFlags.GranFlags.Debug.checkSparkQ ) {
791 debugBelch("## |%p:%p| (%p)<-spark=%p->(%p) <-(%p)\n",
792 pending_sparks_hd, pending_sparks_tl,
793 spark->prev, spark, spark->next,
794 (spark->next==NULL ? 0 : spark->next->prev));
798 if (spark->prev==NULL) {
799 /* spark is first spark of queue => adjust hd pointer */
800 ASSERT(pending_sparks_hds[p]==spark);
801 pending_sparks_hds[p] = spark->next;
803 spark->prev->next = spark->next;
805 if (spark->next==NULL) {
806 ASSERT(pending_sparks_tls[p]==spark);
807 /* spark is first spark of queue => adjust tl pointer */
808 pending_sparks_tls[p] = spark->prev;
810 spark->next->prev = spark->prev;
812 new_spark = spark->next;
814 # if defined(GRAN_CHECK)
815 if ( RtsFlags.GranFlags.Debug.checkSparkQ ) {
816 debugBelch("## |%p:%p| (%p)<-spark=%p->(%p) <-(%p); spark=%p will be deleted NOW \n",
817 pending_sparks_hd, pending_sparks_tl,
818 spark->prev, spark, spark->next,
819 (spark->next==NULL ? 0 : spark->next->prev), spark);
829 /* Mark all nodes pointed to by sparks in the spark queues (for GC) */
833 StgClosure *MarkRoot(StgClosure *root); // prototype
837 for (p=0; p<RtsFlags.GranFlags.proc; p++)
838 for (sp=pending_sparks_hds[p]; sp!=NULL; sp=sp->next) {
839 ASSERT(sp->node!=NULL);
840 ASSERT(LOOKS_LIKE_GHC_INFO(sp->node->header.info));
841 // ToDo?: statistics gathering here (also for GUM!)
842 sp->node = (StgClosure *)MarkRoot(sp->node);
846 debugBelch("markSparkQueue: spark statistics at start of GC:");
847 print_sparkq_stats());
857 debugBelch("Spark: NIL\n");
861 ((spark->node==NULL) ? "______" : "%#6lx"),
862 stgCast(StgPtr,spark->node));
864 debugBelch("Spark: Node %8s, Name %#6x, Global %5s, Creator %5x, Prev %6p, Next %6p\n",
866 ((spark->global)==rtsTrue?"True":"False"), spark->creator,
867 spark->prev, spark->next);
876 rtsSpark *x = pending_sparks_hds[proc];
878 debugBelch("Spark Queue of PE %d with root at %p:\n", proc, x);
879 for (; x!=(rtsSpark*)NULL; x=x->next) {
885 Print a statistics of all spark queues.
888 print_sparkq_stats(void)
892 debugBelch("SparkQs: [");
893 for (p=0; p<RtsFlags.GranFlags.proc; p++)
894 debugBelch(", PE %d: %d", p, spark_queue_len(p));