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);
66 /* -----------------------------------------------------------------------------
68 * findSpark: find a spark on the current Capability that we can fork
71 * -------------------------------------------------------------------------- */
74 findSpark (Capability *cap)
79 pool = &(cap->r.rSparks);
80 ASSERT_SPARK_POOL_INVARIANTS(pool);
82 while (pool->hd != pool->tl) {
85 if (closure_SHOULD_SPARK(spark)) {
87 if (RtsFlags.ParFlags.ParStats.Sparks)
88 DumpRawGranEvent(CURRENT_PROC, CURRENT_PROC,
89 GR_STEALING, ((StgTSO *)NULL), spark,
90 0, 0 /* spark_queue_len(ADVISORY_POOL) */);
95 // spark pool is now empty
99 /* -----------------------------------------------------------------------------
100 * Mark all nodes pointed to by sparks in the spark queues (for GC) Does an
101 * implicit slide i.e. after marking all sparks are at the beginning of the
102 * spark pool and the spark pool only contains sparkable closures
103 * -------------------------------------------------------------------------- */
106 markSparkQueue (evac_fn evac)
108 StgClosure **sparkp, **to_sparkp;
109 nat i, n, pruned_sparks; // stats only
113 PAR_TICKY_MARK_SPARK_QUEUE_START();
117 for (i = 0; i < n_capabilities; i++) {
118 cap = &capabilities[i];
119 pool = &(cap->r.rSparks);
121 ASSERT_SPARK_POOL_INVARIANTS(pool);
123 #if defined(PARALLEL_HASKELL)
130 to_sparkp = pool->hd;
131 while (sparkp != pool->tl) {
132 ASSERT(*sparkp!=NULL);
133 ASSERT(LOOKS_LIKE_CLOSURE_PTR(((StgClosure *)*sparkp)));
134 // ToDo?: statistics gathering here (also for GUM!)
135 if (closure_SHOULD_SPARK(*sparkp)) {
137 *to_sparkp++ = *sparkp;
138 if (to_sparkp == pool->lim) {
139 to_sparkp = pool->base;
146 if (sparkp == pool->lim) {
150 pool->tl = to_sparkp;
152 PAR_TICKY_MARK_SPARK_QUEUE_END(n);
154 #if defined(PARALLEL_HASKELL)
155 debugTrace(DEBUG_sched,
156 "marked %d sparks and pruned %d sparks on [%x]",
157 n, pruned_sparks, mytid);
159 debugTrace(DEBUG_sched,
160 "marked %d sparks and pruned %d sparks",
164 debugTrace(DEBUG_sched,
165 "new spark queue len=%d; (hd=%p; tl=%p)\n",
166 sparkPoolSize(pool), pool->hd, pool->tl);
170 /* -----------------------------------------------------------------------------
172 * Turn a spark into a real thread
174 * -------------------------------------------------------------------------- */
177 createSparkThread (Capability *cap, StgClosure *p)
181 tso = createGenThread (cap, RtsFlags.GcFlags.initialStkSize, p);
182 appendToRunQueue(cap,tso);
185 /* -----------------------------------------------------------------------------
189 * -------------------------------------------------------------------------- */
194 newSpark (StgRegTable *reg, StgClosure *p)
196 StgSparkPool *pool = &(reg->rSparks);
198 ASSERT_SPARK_POOL_INVARIANTS(pool);
200 if (closure_SHOULD_SPARK(p)) {
203 new_tl = pool->tl + 1;
204 if (new_tl == pool->lim) { new_tl = pool->base; }
205 if (new_tl != pool->hd) {
208 } else if (!closure_SHOULD_SPARK(*pool->hd)) {
209 // if the old closure is not sparkable, discard it and
210 // keep the new one. Otherwise, keep the old one.
214 #else /* DISCARD OLD */
217 if (pool->tl == pool->hd) { bump_hd(pool); }
221 ASSERT_SPARK_POOL_INVARIANTS(pool);
228 newSpark (StgRegTable *reg STG_UNUSED, StgClosure *p STG_UNUSED)
234 #endif /* PARALLEL_HASKELL || THREADED_RTS */
237 /* -----------------------------------------------------------------------------
239 * GRAN & PARALLEL_HASKELL stuff beyond here.
241 * -------------------------------------------------------------------------- */
243 #if defined(PARALLEL_HASKELL) || defined(GRAN)
245 static void slide_spark_pool( StgSparkPool *pool );
248 add_to_spark_queue( StgClosure *closure, StgSparkPool *pool )
250 if (pool->tl == pool->lim)
251 slide_spark_pool(pool);
253 if (closure_SHOULD_SPARK(closure) &&
254 pool->tl < pool->lim) {
255 *(pool->tl++) = closure;
257 #if defined(PARALLEL_HASKELL)
258 // collect parallel global statistics (currently done together with GC stats)
259 if (RtsFlags.ParFlags.ParStats.Global &&
260 RtsFlags.GcFlags.giveStats > NO_GC_STATS) {
261 // debugBelch("Creating spark for %x @ %11.2f\n", closure, usertime());
262 globalParStats.tot_sparks_created++;
267 #if defined(PARALLEL_HASKELL)
268 // collect parallel global statistics (currently done together with GC stats)
269 if (RtsFlags.ParFlags.ParStats.Global &&
270 RtsFlags.GcFlags.giveStats > NO_GC_STATS) {
271 //debugBelch("Ignoring spark for %x @ %11.2f\n", closure, usertime());
272 globalParStats.tot_sparks_ignored++;
280 slide_spark_pool( StgSparkPool *pool )
282 StgClosure **sparkp, **to_sparkp;
285 to_sparkp = pool->base;
286 while (sparkp < pool->tl) {
287 ASSERT(to_sparkp<=sparkp);
288 ASSERT(*sparkp!=NULL);
289 ASSERT(LOOKS_LIKE_GHC_INFO((*sparkp)->header.info));
291 if (closure_SHOULD_SPARK(*sparkp)) {
292 *to_sparkp++ = *sparkp++;
297 pool->hd = pool->base;
298 pool->tl = to_sparkp;
305 #if !defined(THREADED_RTS)
310 pool = &(cap->rSparks);
311 ASSERT(pool->hd <= pool->tl && pool->tl <= pool->lim);
313 ASSERT(spark != (StgClosure *)NULL);
321 Search the spark queue of the proc in event for a spark that's worth
322 turning into a thread
323 (was gimme_spark in the old RTS)
326 findLocalSpark (rtsEvent *event, rtsBool *found_res, rtsSparkQ *spark_res)
328 PEs proc = event->proc, /* proc to search for work */
329 creator = event->creator; /* proc that requested work */
332 rtsSparkQ spark_of_non_local_node = NULL,
333 spark_of_non_local_node_prev = NULL,
334 low_priority_spark = NULL,
335 low_priority_spark_prev = NULL,
336 spark = NULL, prev = NULL;
338 /* Choose a spark from the local spark queue */
339 prev = (rtsSpark*)NULL;
340 spark = pending_sparks_hds[proc];
343 // ToDo: check this code & implement local sparking !! -- HWL
344 while (!found && spark != (rtsSpark*)NULL)
346 ASSERT((prev!=(rtsSpark*)NULL || spark==pending_sparks_hds[proc]) &&
347 (prev==(rtsSpark*)NULL || prev->next==spark) &&
348 (spark->prev==prev));
350 if (!closure_SHOULD_SPARK(node))
352 IF_GRAN_DEBUG(checkSparkQ,
353 debugBelch("^^ pruning spark %p (node %p) in gimme_spark",
356 if (RtsFlags.GranFlags.GranSimStats.Sparks)
357 DumpRawGranEvent(proc, (PEs)0, SP_PRUNED,(StgTSO*)NULL,
358 spark->node, spark->name, spark_queue_len(proc));
360 ASSERT(spark != (rtsSpark*)NULL);
361 ASSERT(SparksAvail>0);
364 ASSERT(prev==(rtsSpark*)NULL || prev->next==spark);
365 spark = delete_from_sparkq (spark, proc, rtsTrue);
366 if (spark != (rtsSpark*)NULL)
370 /* -- node should eventually be sparked */
371 else if (RtsFlags.GranFlags.PreferSparksOfLocalNodes &&
372 !IS_LOCAL_TO(PROCS(node),CurrentProc))
374 barf("Local sparking not yet implemented");
376 /* Remember first low priority spark */
377 if (spark_of_non_local_node==(rtsSpark*)NULL) {
378 spark_of_non_local_node_prev = prev;
379 spark_of_non_local_node = spark;
382 if (spark->next == (rtsSpark*)NULL) {
383 /* ASSERT(spark==SparkQueueTl); just for testing */
384 prev = spark_of_non_local_node_prev;
385 spark = spark_of_non_local_node;
390 # if defined(GRAN) && defined(GRAN_CHECK)
391 /* Should never happen; just for testing
392 if (spark==pending_sparks_tl) {
393 debugBelch("ReSchedule: Last spark != SparkQueueTl\n");
394 stg_exit(EXIT_FAILURE);
399 ASSERT(SparksAvail>0);
403 else if ( RtsFlags.GranFlags.DoPrioritySparking ||
404 (spark->gran_info >= RtsFlags.GranFlags.SparkPriority2) )
406 if (RtsFlags.GranFlags.DoPrioritySparking)
407 barf("Priority sparking not yet implemented");
412 else /* only used if SparkPriority2 is defined */
414 /* ToDo: fix the code below and re-integrate it */
415 /* Remember first low priority spark */
416 if (low_priority_spark==(rtsSpark*)NULL) {
417 low_priority_spark_prev = prev;
418 low_priority_spark = spark;
421 if (spark->next == (rtsSpark*)NULL) {
422 /* ASSERT(spark==spark_queue_tl); just for testing */
423 prev = low_priority_spark_prev;
424 spark = low_priority_spark;
425 found = rtsTrue; /* take low pri spark => rc is 2 */
429 /* Should never happen; just for testing
430 if (spark==pending_sparks_tl) {
431 debugBelch("ReSchedule: Last spark != SparkQueueTl\n");
432 stg_exit(EXIT_FAILURE);
439 debugBelch("++ Ignoring spark of priority %u (SparkPriority=%u); node=%p; name=%u\n",
440 spark->gran_info, RtsFlags.GranFlags.SparkPriority,
441 spark->node, spark->name);)
444 } /* while (spark!=NULL && !found) */
451 Turn the spark into a thread.
452 In GranSim this basically means scheduling a StartThread event for the
453 node pointed to by the spark at some point in the future.
454 (was munch_spark in the old RTS)
457 activateSpark (rtsEvent *event, rtsSparkQ spark)
459 PEs proc = event->proc, /* proc to search for work */
460 creator = event->creator; /* proc that requested work */
463 rtsTime spark_arrival_time;
466 We've found a node on PE proc requested by PE creator.
467 If proc==creator we can turn the spark into a thread immediately;
468 otherwise we schedule a MoveSpark event on the requesting PE
474 /* only possible if we simulate GUM style fishing */
475 ASSERT(RtsFlags.GranFlags.Fishing);
477 /* Message packing costs for sending a Fish; qeq jabbI'ID */
478 CurrentTime[proc] += RtsFlags.GranFlags.Costs.mpacktime;
480 if (RtsFlags.GranFlags.GranSimStats.Sparks)
481 DumpRawGranEvent(proc, (PEs)0, SP_EXPORTED,
482 (StgTSO*)NULL, spark->node,
483 spark->name, spark_queue_len(proc));
485 /* time of the spark arrival on the remote PE */
486 spark_arrival_time = CurrentTime[proc] + RtsFlags.GranFlags.Costs.latency;
488 new_event(creator, proc, spark_arrival_time,
490 (StgTSO*)NULL, spark->node, spark);
492 CurrentTime[proc] += RtsFlags.GranFlags.Costs.mtidytime;
494 } else { /* proc==creator i.e. turn the spark into a thread */
496 if ( RtsFlags.GranFlags.GranSimStats.Global &&
497 spark->gran_info < RtsFlags.GranFlags.SparkPriority2 ) {
499 globalGranStats.tot_low_pri_sparks++;
501 debugBelch("++ No high priority spark available; low priority (%u) spark chosen: node=%p; name=%u\n",
503 spark->node, spark->name));
506 CurrentTime[proc] += RtsFlags.GranFlags.Costs.threadcreatetime;
511 /* ToDo: fix the GC interface and move to StartThread handling-- HWL */
512 if (GARBAGE COLLECTION IS NECESSARY) {
513 /* Some kind of backoff needed here in case there's too little heap */
514 # if defined(GRAN_CHECK) && defined(GRAN)
515 if (RtsFlags.GcFlags.giveStats)
516 fprintf(RtsFlags.GcFlags.statsFile,"***** vIS Qu' chen veQ boSwI'; spark=%p, node=%p; name=%u\n",
517 /* (found==2 ? "no hi pri spark" : "hi pri spark"), */
518 spark, node, spark->name);
520 new_event(CurrentProc, CurrentProc, CurrentTime[CurrentProc]+1,
522 (StgTSO*)NULL, (StgClosure*)NULL, (rtsSpark*)NULL);
523 barf("//// activateSpark: out of heap ; ToDo: call GarbageCollect()");
524 GarbageCollect(GetRoots, rtsFalse);
525 // HWL old: ReallyPerformThreadGC(TSO_HS+TSO_CTS_SIZE,rtsFalse);
526 // HWL old: SAVE_Hp -= TSO_HS+TSO_CTS_SIZE;
528 return; /* was: continue; */ /* to the next event, eventually */
532 if (RtsFlags.GranFlags.GranSimStats.Sparks)
533 DumpRawGranEvent(CurrentProc,(PEs)0,SP_USED,(StgTSO*)NULL,
534 spark->node, spark->name,
535 spark_queue_len(CurrentProc));
537 new_event(proc, proc, CurrentTime[proc],
539 END_TSO_QUEUE, node, spark); // (rtsSpark*)NULL);
541 procStatus[proc] = Starting;
545 /* -------------------------------------------------------------------------
546 This is the main point where handling granularity information comes into
548 ------------------------------------------------------------------------- */
550 #define MAX_RAND_PRI 100
553 Granularity info transformers.
554 Applied to the GRAN_INFO field of a spark.
556 STATIC_INLINE nat ID(nat x) { return(x); };
557 STATIC_INLINE nat INV(nat x) { return(-x); };
558 STATIC_INLINE nat IGNORE(nat x) { return (0); };
559 STATIC_INLINE nat RAND(nat x) { return ((random() % MAX_RAND_PRI) + 1); }
561 /* NB: size_info and par_info are currently unused (what a shame!) -- HWL */
563 newSpark(node,name,gran_info,size_info,par_info,local)
565 nat name, gran_info, size_info, par_info, local;
570 pri = RtsFlags.GranFlags.RandomPriorities ? RAND(gran_info) :
571 RtsFlags.GranFlags.InversePriorities ? INV(gran_info) :
572 RtsFlags.GranFlags.IgnorePriorities ? IGNORE(gran_info) :
575 if ( RtsFlags.GranFlags.SparkPriority!=0 &&
576 pri<RtsFlags.GranFlags.SparkPriority ) {
578 debugBelch(",, NewSpark: Ignoring spark of priority %u (SparkPriority=%u); node=%#x; name=%u\n",
579 pri, RtsFlags.GranFlags.SparkPriority, node, name));
580 return ((rtsSpark*)NULL);
583 newspark = (rtsSpark*) stgMallocBytes(sizeof(rtsSpark), "NewSpark");
584 newspark->prev = newspark->next = (rtsSpark*)NULL;
585 newspark->node = node;
586 newspark->name = (name==1) ? CurrentTSO->gran.sparkname : name;
587 newspark->gran_info = pri;
588 newspark->global = !local; /* Check that with parAt, parAtAbs !!*/
590 if (RtsFlags.GranFlags.GranSimStats.Global) {
591 globalGranStats.tot_sparks_created++;
592 globalGranStats.sparks_created_on_PE[CurrentProc]++;
613 disposeSparkQ(spark->next);
616 if (SparksAvail < 0) {
617 debugBelch("disposeSparkQ: SparksAvail<0 after disposing sparkq @ %p\n", &spark);
626 With PrioritySparking add_to_spark_queue performs an insert sort to keep
627 the spark queue sorted. Otherwise the spark is just added to the end of
632 add_to_spark_queue(spark)
635 rtsSpark *prev = NULL, *next = NULL;
637 rtsBool found = rtsFalse;
639 if ( spark == (rtsSpark *)NULL ) {
643 if (RtsFlags.GranFlags.DoPrioritySparking && (spark->gran_info != 0) ) {
644 /* Priority sparking is enabled i.e. spark queues must be sorted */
646 for (prev = NULL, next = pending_sparks_hd, count=0;
648 !(found = (spark->gran_info >= next->gran_info));
649 prev = next, next = next->next, count++)
652 } else { /* 'utQo' */
653 /* Priority sparking is disabled */
655 found = rtsFalse; /* to add it at the end */
660 /* next points to the first spark with a gran_info smaller than that
661 of spark; therefore, add spark before next into the spark queue */
663 if ( next == NULL ) {
664 pending_sparks_tl = spark;
669 if ( prev == NULL ) {
670 pending_sparks_hd = spark;
674 } else { /* (RtsFlags.GranFlags.DoPrioritySparking && !found) || !DoPrioritySparking */
675 /* add the spark at the end of the spark queue */
677 spark->prev = pending_sparks_tl;
678 if (pending_sparks_hd == NULL)
679 pending_sparks_hd = spark;
681 pending_sparks_tl->next = spark;
682 pending_sparks_tl = spark;
686 /* add costs for search in priority sparking */
687 if (RtsFlags.GranFlags.DoPrioritySparking) {
688 CurrentTime[CurrentProc] += count * RtsFlags.GranFlags.Costs.pri_spark_overhead;
691 IF_GRAN_DEBUG(checkSparkQ,
692 debugBelch("++ Spark stats after adding spark %p (node %p) to queue on PE %d",
693 spark, spark->node, CurrentProc);
694 print_sparkq_stats());
696 # if defined(GRAN_CHECK)
697 if (RtsFlags.GranFlags.Debug.checkSparkQ) {
698 for (prev = NULL, next = pending_sparks_hd;
700 prev = next, next = next->next)
702 if ( (prev!=NULL) && (prev!=pending_sparks_tl) )
703 debugBelch("SparkQ inconsistency after adding spark %p: (PE %u) pending_sparks_tl (%p) not end of queue (%p)\n",
705 pending_sparks_tl, prev);
709 # if defined(GRAN_CHECK)
710 /* Check if the sparkq is still sorted. Just for testing, really! */
711 if ( RtsFlags.GranFlags.Debug.checkSparkQ &&
712 RtsFlags.GranFlags.Debug.pri ) {
713 rtsBool sorted = rtsTrue;
714 rtsSpark *prev, *next;
716 if (pending_sparks_hd == NULL ||
717 pending_sparks_hd->next == NULL ) {
718 /* just 1 elem => ok */
720 for (prev = pending_sparks_hd,
721 next = pending_sparks_hd->next;
723 prev = next, next = next->next) {
725 (prev->gran_info >= next->gran_info);
729 debugBelch("ghuH: SPARKQ on PE %d is not sorted:\n",
731 print_sparkq(CurrentProc);
738 spark_queue_len(proc)
741 rtsSpark *prev, *spark; /* prev only for testing !! */
744 for (len = 0, prev = NULL, spark = pending_sparks_hds[proc];
746 len++, prev = spark, spark = spark->next)
749 # if defined(GRAN_CHECK)
750 if ( RtsFlags.GranFlags.Debug.checkSparkQ )
751 if ( (prev!=NULL) && (prev!=pending_sparks_tls[proc]) )
752 debugBelch("ERROR in spark_queue_len: (PE %u) pending_sparks_tl (%p) not end of queue (%p)\n",
753 proc, pending_sparks_tls[proc], prev);
760 Take spark out of the spark queue on PE p and nuke the spark. Adjusts
761 hd and tl pointers of the spark queue. Returns a pointer to the next
765 delete_from_sparkq (spark, p, dispose_too) /* unlink and dispose spark */
773 barf("delete_from_sparkq: trying to delete NULL spark\n");
775 # if defined(GRAN_CHECK)
776 if ( RtsFlags.GranFlags.Debug.checkSparkQ ) {
777 debugBelch("## |%p:%p| (%p)<-spark=%p->(%p) <-(%p)\n",
778 pending_sparks_hd, pending_sparks_tl,
779 spark->prev, spark, spark->next,
780 (spark->next==NULL ? 0 : spark->next->prev));
784 if (spark->prev==NULL) {
785 /* spark is first spark of queue => adjust hd pointer */
786 ASSERT(pending_sparks_hds[p]==spark);
787 pending_sparks_hds[p] = spark->next;
789 spark->prev->next = spark->next;
791 if (spark->next==NULL) {
792 ASSERT(pending_sparks_tls[p]==spark);
793 /* spark is first spark of queue => adjust tl pointer */
794 pending_sparks_tls[p] = spark->prev;
796 spark->next->prev = spark->prev;
798 new_spark = spark->next;
800 # if defined(GRAN_CHECK)
801 if ( RtsFlags.GranFlags.Debug.checkSparkQ ) {
802 debugBelch("## |%p:%p| (%p)<-spark=%p->(%p) <-(%p); spark=%p will be deleted NOW \n",
803 pending_sparks_hd, pending_sparks_tl,
804 spark->prev, spark, spark->next,
805 (spark->next==NULL ? 0 : spark->next->prev), spark);
815 /* Mark all nodes pointed to by sparks in the spark queues (for GC) */
819 StgClosure *MarkRoot(StgClosure *root); // prototype
823 for (p=0; p<RtsFlags.GranFlags.proc; p++)
824 for (sp=pending_sparks_hds[p]; sp!=NULL; sp=sp->next) {
825 ASSERT(sp->node!=NULL);
826 ASSERT(LOOKS_LIKE_GHC_INFO(sp->node->header.info));
827 // ToDo?: statistics gathering here (also for GUM!)
828 sp->node = (StgClosure *)MarkRoot(sp->node);
832 debugBelch("markSparkQueue: spark statistics at start of GC:");
833 print_sparkq_stats());
843 debugBelch("Spark: NIL\n");
847 ((spark->node==NULL) ? "______" : "%#6lx"),
848 stgCast(StgPtr,spark->node));
850 debugBelch("Spark: Node %8s, Name %#6x, Global %5s, Creator %5x, Prev %6p, Next %6p\n",
852 ((spark->global)==rtsTrue?"True":"False"), spark->creator,
853 spark->prev, spark->next);
862 rtsSpark *x = pending_sparks_hds[proc];
864 debugBelch("Spark Queue of PE %d with root at %p:\n", proc, x);
865 for (; x!=(rtsSpark*)NULL; x=x->next) {
871 Print a statistics of all spark queues.
874 print_sparkq_stats(void)
878 debugBelch("SparkQs: [");
879 for (p=0; p<RtsFlags.GranFlags.proc; p++)
880 debugBelch(", PE %d: %d", p, spark_queue_len(p));