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 /* -----------------------------------------------------------------------------
105 * Mark all nodes pointed to by sparks in the spark queues (for GC) Does an
106 * implicit slide i.e. after marking all sparks are at the beginning of the
107 * spark pool and the spark pool only contains sparkable closures
108 * -------------------------------------------------------------------------- */
111 markSparkQueue (evac_fn evac)
113 StgClosure **sparkp, **to_sparkp;
114 nat i, n, pruned_sparks; // stats only
118 PAR_TICKY_MARK_SPARK_QUEUE_START();
122 for (i = 0; i < n_capabilities; i++) {
123 cap = &capabilities[i];
124 pool = &(cap->r.rSparks);
126 ASSERT_SPARK_POOL_INVARIANTS(pool);
128 #if defined(PARALLEL_HASKELL)
135 to_sparkp = pool->hd;
136 while (sparkp != pool->tl) {
137 ASSERT(*sparkp!=NULL);
138 ASSERT(LOOKS_LIKE_CLOSURE_PTR(((StgClosure *)*sparkp)));
139 // ToDo?: statistics gathering here (also for GUM!)
140 if (closure_SHOULD_SPARK(*sparkp)) {
142 *to_sparkp++ = *sparkp;
143 if (to_sparkp == pool->lim) {
144 to_sparkp = pool->base;
151 if (sparkp == pool->lim) {
155 pool->tl = to_sparkp;
157 PAR_TICKY_MARK_SPARK_QUEUE_END(n);
159 #if defined(PARALLEL_HASKELL)
160 debugTrace(DEBUG_sched,
161 "marked %d sparks and pruned %d sparks on [%x]",
162 n, pruned_sparks, mytid);
164 debugTrace(DEBUG_sched,
165 "marked %d sparks and pruned %d sparks",
169 debugTrace(DEBUG_sched,
170 "new spark queue len=%d; (hd=%p; tl=%p)\n",
171 sparkPoolSize(pool), pool->hd, pool->tl);
175 /* -----------------------------------------------------------------------------
177 * Turn a spark into a real thread
179 * -------------------------------------------------------------------------- */
182 createSparkThread (Capability *cap, StgClosure *p)
186 tso = createGenThread (cap, RtsFlags.GcFlags.initialStkSize, p);
187 appendToRunQueue(cap,tso);
190 /* -----------------------------------------------------------------------------
194 * -------------------------------------------------------------------------- */
199 newSpark (StgRegTable *reg, StgClosure *p)
201 StgSparkPool *pool = &(reg->rSparks);
203 ASSERT_SPARK_POOL_INVARIANTS(pool);
205 if (closure_SHOULD_SPARK(p)) {
208 new_tl = pool->tl + 1;
209 if (new_tl == pool->lim) { new_tl = pool->base; }
210 if (new_tl != pool->hd) {
213 } else if (!closure_SHOULD_SPARK(*pool->hd)) {
214 // if the old closure is not sparkable, discard it and
215 // keep the new one. Otherwise, keep the old one.
219 #else /* DISCARD OLD */
222 if (pool->tl == pool->hd) { bump_hd(pool); }
226 ASSERT_SPARK_POOL_INVARIANTS(pool);
233 newSpark (StgRegTable *reg STG_UNUSED, StgClosure *p STG_UNUSED)
239 #endif /* PARALLEL_HASKELL || THREADED_RTS */
242 /* -----------------------------------------------------------------------------
244 * GRAN & PARALLEL_HASKELL stuff beyond here.
246 * -------------------------------------------------------------------------- */
248 #if defined(PARALLEL_HASKELL) || defined(GRAN)
250 static void slide_spark_pool( StgSparkPool *pool );
253 add_to_spark_queue( StgClosure *closure, StgSparkPool *pool )
255 if (pool->tl == pool->lim)
256 slide_spark_pool(pool);
258 if (closure_SHOULD_SPARK(closure) &&
259 pool->tl < pool->lim) {
260 *(pool->tl++) = closure;
262 #if defined(PARALLEL_HASKELL)
263 // collect parallel global statistics (currently done together with GC stats)
264 if (RtsFlags.ParFlags.ParStats.Global &&
265 RtsFlags.GcFlags.giveStats > NO_GC_STATS) {
266 // debugBelch("Creating spark for %x @ %11.2f\n", closure, usertime());
267 globalParStats.tot_sparks_created++;
272 #if defined(PARALLEL_HASKELL)
273 // collect parallel global statistics (currently done together with GC stats)
274 if (RtsFlags.ParFlags.ParStats.Global &&
275 RtsFlags.GcFlags.giveStats > NO_GC_STATS) {
276 //debugBelch("Ignoring spark for %x @ %11.2f\n", closure, usertime());
277 globalParStats.tot_sparks_ignored++;
285 slide_spark_pool( StgSparkPool *pool )
287 StgClosure **sparkp, **to_sparkp;
290 to_sparkp = pool->base;
291 while (sparkp < pool->tl) {
292 ASSERT(to_sparkp<=sparkp);
293 ASSERT(*sparkp!=NULL);
294 ASSERT(LOOKS_LIKE_GHC_INFO((*sparkp)->header.info));
296 if (closure_SHOULD_SPARK(*sparkp)) {
297 *to_sparkp++ = *sparkp++;
302 pool->hd = pool->base;
303 pool->tl = to_sparkp;
310 #if !defined(THREADED_RTS)
315 pool = &(cap->rSparks);
316 ASSERT(pool->hd <= pool->tl && pool->tl <= pool->lim);
318 ASSERT(spark != (StgClosure *)NULL);
326 Search the spark queue of the proc in event for a spark that's worth
327 turning into a thread
328 (was gimme_spark in the old RTS)
331 findLocalSpark (rtsEvent *event, rtsBool *found_res, rtsSparkQ *spark_res)
333 PEs proc = event->proc, /* proc to search for work */
334 creator = event->creator; /* proc that requested work */
337 rtsSparkQ spark_of_non_local_node = NULL,
338 spark_of_non_local_node_prev = NULL,
339 low_priority_spark = NULL,
340 low_priority_spark_prev = NULL,
341 spark = NULL, prev = NULL;
343 /* Choose a spark from the local spark queue */
344 prev = (rtsSpark*)NULL;
345 spark = pending_sparks_hds[proc];
348 // ToDo: check this code & implement local sparking !! -- HWL
349 while (!found && spark != (rtsSpark*)NULL)
351 ASSERT((prev!=(rtsSpark*)NULL || spark==pending_sparks_hds[proc]) &&
352 (prev==(rtsSpark*)NULL || prev->next==spark) &&
353 (spark->prev==prev));
355 if (!closure_SHOULD_SPARK(node))
357 IF_GRAN_DEBUG(checkSparkQ,
358 debugBelch("^^ pruning spark %p (node %p) in gimme_spark",
361 if (RtsFlags.GranFlags.GranSimStats.Sparks)
362 DumpRawGranEvent(proc, (PEs)0, SP_PRUNED,(StgTSO*)NULL,
363 spark->node, spark->name, spark_queue_len(proc));
365 ASSERT(spark != (rtsSpark*)NULL);
366 ASSERT(SparksAvail>0);
369 ASSERT(prev==(rtsSpark*)NULL || prev->next==spark);
370 spark = delete_from_sparkq (spark, proc, rtsTrue);
371 if (spark != (rtsSpark*)NULL)
375 /* -- node should eventually be sparked */
376 else if (RtsFlags.GranFlags.PreferSparksOfLocalNodes &&
377 !IS_LOCAL_TO(PROCS(node),CurrentProc))
379 barf("Local sparking not yet implemented");
381 /* Remember first low priority spark */
382 if (spark_of_non_local_node==(rtsSpark*)NULL) {
383 spark_of_non_local_node_prev = prev;
384 spark_of_non_local_node = spark;
387 if (spark->next == (rtsSpark*)NULL) {
388 /* ASSERT(spark==SparkQueueTl); just for testing */
389 prev = spark_of_non_local_node_prev;
390 spark = spark_of_non_local_node;
395 # if defined(GRAN) && defined(GRAN_CHECK)
396 /* Should never happen; just for testing
397 if (spark==pending_sparks_tl) {
398 debugBelch("ReSchedule: Last spark != SparkQueueTl\n");
399 stg_exit(EXIT_FAILURE);
404 ASSERT(SparksAvail>0);
408 else if ( RtsFlags.GranFlags.DoPrioritySparking ||
409 (spark->gran_info >= RtsFlags.GranFlags.SparkPriority2) )
411 if (RtsFlags.GranFlags.DoPrioritySparking)
412 barf("Priority sparking not yet implemented");
417 else /* only used if SparkPriority2 is defined */
419 /* ToDo: fix the code below and re-integrate it */
420 /* Remember first low priority spark */
421 if (low_priority_spark==(rtsSpark*)NULL) {
422 low_priority_spark_prev = prev;
423 low_priority_spark = spark;
426 if (spark->next == (rtsSpark*)NULL) {
427 /* ASSERT(spark==spark_queue_tl); just for testing */
428 prev = low_priority_spark_prev;
429 spark = low_priority_spark;
430 found = rtsTrue; /* take low pri spark => rc is 2 */
434 /* Should never happen; just for testing
435 if (spark==pending_sparks_tl) {
436 debugBelch("ReSchedule: Last spark != SparkQueueTl\n");
437 stg_exit(EXIT_FAILURE);
444 debugBelch("++ Ignoring spark of priority %u (SparkPriority=%u); node=%p; name=%u\n",
445 spark->gran_info, RtsFlags.GranFlags.SparkPriority,
446 spark->node, spark->name);)
449 } /* while (spark!=NULL && !found) */
456 Turn the spark into a thread.
457 In GranSim this basically means scheduling a StartThread event for the
458 node pointed to by the spark at some point in the future.
459 (was munch_spark in the old RTS)
462 activateSpark (rtsEvent *event, rtsSparkQ spark)
464 PEs proc = event->proc, /* proc to search for work */
465 creator = event->creator; /* proc that requested work */
468 rtsTime spark_arrival_time;
471 We've found a node on PE proc requested by PE creator.
472 If proc==creator we can turn the spark into a thread immediately;
473 otherwise we schedule a MoveSpark event on the requesting PE
479 /* only possible if we simulate GUM style fishing */
480 ASSERT(RtsFlags.GranFlags.Fishing);
482 /* Message packing costs for sending a Fish; qeq jabbI'ID */
483 CurrentTime[proc] += RtsFlags.GranFlags.Costs.mpacktime;
485 if (RtsFlags.GranFlags.GranSimStats.Sparks)
486 DumpRawGranEvent(proc, (PEs)0, SP_EXPORTED,
487 (StgTSO*)NULL, spark->node,
488 spark->name, spark_queue_len(proc));
490 /* time of the spark arrival on the remote PE */
491 spark_arrival_time = CurrentTime[proc] + RtsFlags.GranFlags.Costs.latency;
493 new_event(creator, proc, spark_arrival_time,
495 (StgTSO*)NULL, spark->node, spark);
497 CurrentTime[proc] += RtsFlags.GranFlags.Costs.mtidytime;
499 } else { /* proc==creator i.e. turn the spark into a thread */
501 if ( RtsFlags.GranFlags.GranSimStats.Global &&
502 spark->gran_info < RtsFlags.GranFlags.SparkPriority2 ) {
504 globalGranStats.tot_low_pri_sparks++;
506 debugBelch("++ No high priority spark available; low priority (%u) spark chosen: node=%p; name=%u\n",
508 spark->node, spark->name));
511 CurrentTime[proc] += RtsFlags.GranFlags.Costs.threadcreatetime;
516 /* ToDo: fix the GC interface and move to StartThread handling-- HWL */
517 if (GARBAGE COLLECTION IS NECESSARY) {
518 /* Some kind of backoff needed here in case there's too little heap */
519 # if defined(GRAN_CHECK) && defined(GRAN)
520 if (RtsFlags.GcFlags.giveStats)
521 fprintf(RtsFlags.GcFlags.statsFile,"***** vIS Qu' chen veQ boSwI'; spark=%p, node=%p; name=%u\n",
522 /* (found==2 ? "no hi pri spark" : "hi pri spark"), */
523 spark, node, spark->name);
525 new_event(CurrentProc, CurrentProc, CurrentTime[CurrentProc]+1,
527 (StgTSO*)NULL, (StgClosure*)NULL, (rtsSpark*)NULL);
528 barf("//// activateSpark: out of heap ; ToDo: call GarbageCollect()");
529 GarbageCollect(GetRoots, rtsFalse);
530 // HWL old: ReallyPerformThreadGC(TSO_HS+TSO_CTS_SIZE,rtsFalse);
531 // HWL old: SAVE_Hp -= TSO_HS+TSO_CTS_SIZE;
533 return; /* was: continue; */ /* to the next event, eventually */
537 if (RtsFlags.GranFlags.GranSimStats.Sparks)
538 DumpRawGranEvent(CurrentProc,(PEs)0,SP_USED,(StgTSO*)NULL,
539 spark->node, spark->name,
540 spark_queue_len(CurrentProc));
542 new_event(proc, proc, CurrentTime[proc],
544 END_TSO_QUEUE, node, spark); // (rtsSpark*)NULL);
546 procStatus[proc] = Starting;
550 /* -------------------------------------------------------------------------
551 This is the main point where handling granularity information comes into
553 ------------------------------------------------------------------------- */
555 #define MAX_RAND_PRI 100
558 Granularity info transformers.
559 Applied to the GRAN_INFO field of a spark.
561 STATIC_INLINE nat ID(nat x) { return(x); };
562 STATIC_INLINE nat INV(nat x) { return(-x); };
563 STATIC_INLINE nat IGNORE(nat x) { return (0); };
564 STATIC_INLINE nat RAND(nat x) { return ((random() % MAX_RAND_PRI) + 1); }
566 /* NB: size_info and par_info are currently unused (what a shame!) -- HWL */
568 newSpark(node,name,gran_info,size_info,par_info,local)
570 nat name, gran_info, size_info, par_info, local;
575 pri = RtsFlags.GranFlags.RandomPriorities ? RAND(gran_info) :
576 RtsFlags.GranFlags.InversePriorities ? INV(gran_info) :
577 RtsFlags.GranFlags.IgnorePriorities ? IGNORE(gran_info) :
580 if ( RtsFlags.GranFlags.SparkPriority!=0 &&
581 pri<RtsFlags.GranFlags.SparkPriority ) {
583 debugBelch(",, NewSpark: Ignoring spark of priority %u (SparkPriority=%u); node=%#x; name=%u\n",
584 pri, RtsFlags.GranFlags.SparkPriority, node, name));
585 return ((rtsSpark*)NULL);
588 newspark = (rtsSpark*) stgMallocBytes(sizeof(rtsSpark), "NewSpark");
589 newspark->prev = newspark->next = (rtsSpark*)NULL;
590 newspark->node = node;
591 newspark->name = (name==1) ? CurrentTSO->gran.sparkname : name;
592 newspark->gran_info = pri;
593 newspark->global = !local; /* Check that with parAt, parAtAbs !!*/
595 if (RtsFlags.GranFlags.GranSimStats.Global) {
596 globalGranStats.tot_sparks_created++;
597 globalGranStats.sparks_created_on_PE[CurrentProc]++;
618 disposeSparkQ(spark->next);
621 if (SparksAvail < 0) {
622 debugBelch("disposeSparkQ: SparksAvail<0 after disposing sparkq @ %p\n", &spark);
631 With PrioritySparking add_to_spark_queue performs an insert sort to keep
632 the spark queue sorted. Otherwise the spark is just added to the end of
637 add_to_spark_queue(spark)
640 rtsSpark *prev = NULL, *next = NULL;
642 rtsBool found = rtsFalse;
644 if ( spark == (rtsSpark *)NULL ) {
648 if (RtsFlags.GranFlags.DoPrioritySparking && (spark->gran_info != 0) ) {
649 /* Priority sparking is enabled i.e. spark queues must be sorted */
651 for (prev = NULL, next = pending_sparks_hd, count=0;
653 !(found = (spark->gran_info >= next->gran_info));
654 prev = next, next = next->next, count++)
657 } else { /* 'utQo' */
658 /* Priority sparking is disabled */
660 found = rtsFalse; /* to add it at the end */
665 /* next points to the first spark with a gran_info smaller than that
666 of spark; therefore, add spark before next into the spark queue */
668 if ( next == NULL ) {
669 pending_sparks_tl = spark;
674 if ( prev == NULL ) {
675 pending_sparks_hd = spark;
679 } else { /* (RtsFlags.GranFlags.DoPrioritySparking && !found) || !DoPrioritySparking */
680 /* add the spark at the end of the spark queue */
682 spark->prev = pending_sparks_tl;
683 if (pending_sparks_hd == NULL)
684 pending_sparks_hd = spark;
686 pending_sparks_tl->next = spark;
687 pending_sparks_tl = spark;
691 /* add costs for search in priority sparking */
692 if (RtsFlags.GranFlags.DoPrioritySparking) {
693 CurrentTime[CurrentProc] += count * RtsFlags.GranFlags.Costs.pri_spark_overhead;
696 IF_GRAN_DEBUG(checkSparkQ,
697 debugBelch("++ Spark stats after adding spark %p (node %p) to queue on PE %d",
698 spark, spark->node, CurrentProc);
699 print_sparkq_stats());
701 # if defined(GRAN_CHECK)
702 if (RtsFlags.GranFlags.Debug.checkSparkQ) {
703 for (prev = NULL, next = pending_sparks_hd;
705 prev = next, next = next->next)
707 if ( (prev!=NULL) && (prev!=pending_sparks_tl) )
708 debugBelch("SparkQ inconsistency after adding spark %p: (PE %u) pending_sparks_tl (%p) not end of queue (%p)\n",
710 pending_sparks_tl, prev);
714 # if defined(GRAN_CHECK)
715 /* Check if the sparkq is still sorted. Just for testing, really! */
716 if ( RtsFlags.GranFlags.Debug.checkSparkQ &&
717 RtsFlags.GranFlags.Debug.pri ) {
718 rtsBool sorted = rtsTrue;
719 rtsSpark *prev, *next;
721 if (pending_sparks_hd == NULL ||
722 pending_sparks_hd->next == NULL ) {
723 /* just 1 elem => ok */
725 for (prev = pending_sparks_hd,
726 next = pending_sparks_hd->next;
728 prev = next, next = next->next) {
730 (prev->gran_info >= next->gran_info);
734 debugBelch("ghuH: SPARKQ on PE %d is not sorted:\n",
736 print_sparkq(CurrentProc);
743 spark_queue_len(proc)
746 rtsSpark *prev, *spark; /* prev only for testing !! */
749 for (len = 0, prev = NULL, spark = pending_sparks_hds[proc];
751 len++, prev = spark, spark = spark->next)
754 # if defined(GRAN_CHECK)
755 if ( RtsFlags.GranFlags.Debug.checkSparkQ )
756 if ( (prev!=NULL) && (prev!=pending_sparks_tls[proc]) )
757 debugBelch("ERROR in spark_queue_len: (PE %u) pending_sparks_tl (%p) not end of queue (%p)\n",
758 proc, pending_sparks_tls[proc], prev);
765 Take spark out of the spark queue on PE p and nuke the spark. Adjusts
766 hd and tl pointers of the spark queue. Returns a pointer to the next
770 delete_from_sparkq (spark, p, dispose_too) /* unlink and dispose spark */
778 barf("delete_from_sparkq: trying to delete NULL spark\n");
780 # if defined(GRAN_CHECK)
781 if ( RtsFlags.GranFlags.Debug.checkSparkQ ) {
782 debugBelch("## |%p:%p| (%p)<-spark=%p->(%p) <-(%p)\n",
783 pending_sparks_hd, pending_sparks_tl,
784 spark->prev, spark, spark->next,
785 (spark->next==NULL ? 0 : spark->next->prev));
789 if (spark->prev==NULL) {
790 /* spark is first spark of queue => adjust hd pointer */
791 ASSERT(pending_sparks_hds[p]==spark);
792 pending_sparks_hds[p] = spark->next;
794 spark->prev->next = spark->next;
796 if (spark->next==NULL) {
797 ASSERT(pending_sparks_tls[p]==spark);
798 /* spark is first spark of queue => adjust tl pointer */
799 pending_sparks_tls[p] = spark->prev;
801 spark->next->prev = spark->prev;
803 new_spark = spark->next;
805 # if defined(GRAN_CHECK)
806 if ( RtsFlags.GranFlags.Debug.checkSparkQ ) {
807 debugBelch("## |%p:%p| (%p)<-spark=%p->(%p) <-(%p); spark=%p will be deleted NOW \n",
808 pending_sparks_hd, pending_sparks_tl,
809 spark->prev, spark, spark->next,
810 (spark->next==NULL ? 0 : spark->next->prev), spark);
820 /* Mark all nodes pointed to by sparks in the spark queues (for GC) */
824 StgClosure *MarkRoot(StgClosure *root); // prototype
828 for (p=0; p<RtsFlags.GranFlags.proc; p++)
829 for (sp=pending_sparks_hds[p]; sp!=NULL; sp=sp->next) {
830 ASSERT(sp->node!=NULL);
831 ASSERT(LOOKS_LIKE_GHC_INFO(sp->node->header.info));
832 // ToDo?: statistics gathering here (also for GUM!)
833 sp->node = (StgClosure *)MarkRoot(sp->node);
837 debugBelch("markSparkQueue: spark statistics at start of GC:");
838 print_sparkq_stats());
848 debugBelch("Spark: NIL\n");
852 ((spark->node==NULL) ? "______" : "%#6lx"),
853 stgCast(StgPtr,spark->node));
855 debugBelch("Spark: Node %8s, Name %#6x, Global %5s, Creator %5x, Prev %6p, Next %6p\n",
857 ((spark->global)==rtsTrue?"True":"False"), spark->creator,
858 spark->prev, spark->next);
867 rtsSpark *x = pending_sparks_hds[proc];
869 debugBelch("Spark Queue of PE %d with root at %p:\n", proc, x);
870 for (; x!=(rtsSpark*)NULL; x=x->next) {
876 Print a statistics of all spark queues.
879 print_sparkq_stats(void)
883 debugBelch("SparkQs: [");
884 for (p=0; p<RtsFlags.GranFlags.proc; p++)
885 debugBelch(", PE %d: %d", p, spark_queue_len(p));