Allow multiple C finalizers to be attached to a Weak#
[ghc.git] / rts / PrimOps.cmm
1 /* -*- tab-width: 8 -*- */
2 /* -----------------------------------------------------------------------------
3  *
4  * (c) The GHC Team, 1998-2012
5  *
6  * Out-of-line primitive operations
7  *
8  * This file contains the implementations of all the primitive
9  * operations ("primops") which are not expanded inline.  See
10  * ghc/compiler/prelude/primops.txt.pp for a list of all the primops;
11  * this file contains code for most of those with the attribute
12  * out_of_line=True.
13  *
14  * Entry convention: the entry convention for a primop is the
15  * NativeNodeCall convention, and the return convention is
16  * NativeReturn.  (see compiler/cmm/CmmCallConv.hs)
17  *
18  * This file is written in a subset of C--, extended with various
19  * features specific to GHC.  It is compiled by GHC directly.  For the
20  * syntax of .cmm files, see the parser in ghc/compiler/cmm/CmmParse.y.
21  *
22  * ---------------------------------------------------------------------------*/
23
24 #include "Cmm.h"
25
26 #ifdef __PIC__
27 import pthread_mutex_lock;
28 import pthread_mutex_unlock;
29 #endif
30 import base_ControlziExceptionziBase_nestedAtomically_closure;
31 import EnterCriticalSection;
32 import LeaveCriticalSection;
33 import ghczmprim_GHCziTypes_False_closure;
34 #if defined(USE_MINIINTERPRETER) || !defined(mingw32_HOST_OS)
35 import sm_mutex;
36 #endif
37
38 /*-----------------------------------------------------------------------------
39   Array Primitives
40
41   Basically just new*Array - the others are all inline macros.
42
43   The slow entry point is for returning from a heap check, the saved
44   size argument must be re-loaded from the stack.
45   -------------------------------------------------------------------------- */
46
47 /* for objects that are *less* than the size of a word, make sure we
48  * round up to the nearest word for the size of the array.
49  */
50
51 stg_newByteArrayzh ( W_ n )
52 {
53     W_ words, payload_words;
54     gcptr p;
55
56     MAYBE_GC_N(stg_newByteArrayzh, n);
57
58     payload_words = ROUNDUP_BYTES_TO_WDS(n);
59     words = BYTES_TO_WDS(SIZEOF_StgArrWords) + payload_words;
60     ("ptr" p) = ccall allocate(MyCapability() "ptr",words);
61     TICK_ALLOC_PRIM(SIZEOF_StgArrWords,WDS(payload_words),0);
62     SET_HDR(p, stg_ARR_WORDS_info, CCCS);
63     StgArrWords_bytes(p) = n;
64     return (p);
65 }
66
67 #define BA_ALIGN 16
68 #define BA_MASK  (BA_ALIGN-1)
69
70 stg_newPinnedByteArrayzh ( W_ n )
71 {
72     W_ words, bytes, payload_words;
73     gcptr p;
74
75     MAYBE_GC_N(stg_newPinnedByteArrayzh, n);
76
77     bytes = n;
78     /* payload_words is what we will tell the profiler we had to allocate */
79     payload_words = ROUNDUP_BYTES_TO_WDS(bytes);
80     /* When we actually allocate memory, we need to allow space for the
81        header: */
82     bytes = bytes + SIZEOF_StgArrWords;
83     /* And we want to align to BA_ALIGN bytes, so we need to allow space
84        to shift up to BA_ALIGN - 1 bytes: */
85     bytes = bytes + BA_ALIGN - 1;
86     /* Now we convert to a number of words: */
87     words = ROUNDUP_BYTES_TO_WDS(bytes);
88
89     ("ptr" p) = ccall allocatePinned(MyCapability() "ptr", words);
90     TICK_ALLOC_PRIM(SIZEOF_StgArrWords,WDS(payload_words),0);
91
92     /* Now we need to move p forward so that the payload is aligned
93        to BA_ALIGN bytes: */
94     p = p + ((-p - SIZEOF_StgArrWords) & BA_MASK);
95
96     SET_HDR(p, stg_ARR_WORDS_info, CCCS);
97     StgArrWords_bytes(p) = n;
98     return (p);
99 }
100
101 stg_newAlignedPinnedByteArrayzh ( W_ n, W_ alignment )
102 {
103     W_ words, bytes, payload_words;
104     gcptr p;
105
106     again: MAYBE_GC(again);
107
108     /* we always supply at least word-aligned memory, so there's no
109        need to allow extra space for alignment if the requirement is less
110        than a word.  This also prevents mischief with alignment == 0. */
111     if (alignment <= SIZEOF_W) { alignment = 1; }
112
113     bytes = n;
114
115     /* payload_words is what we will tell the profiler we had to allocate */
116     payload_words = ROUNDUP_BYTES_TO_WDS(bytes);
117
118     /* When we actually allocate memory, we need to allow space for the
119        header: */
120     bytes = bytes + SIZEOF_StgArrWords;
121     /* And we want to align to <alignment> bytes, so we need to allow space
122        to shift up to <alignment - 1> bytes: */
123     bytes = bytes + alignment - 1;
124     /* Now we convert to a number of words: */
125     words = ROUNDUP_BYTES_TO_WDS(bytes);
126
127     ("ptr" p) = ccall allocatePinned(MyCapability() "ptr", words);
128     TICK_ALLOC_PRIM(SIZEOF_StgArrWords,WDS(payload_words),0);
129
130     /* Now we need to move p forward so that the payload is aligned
131        to <alignment> bytes. Note that we are assuming that
132        <alignment> is a power of 2, which is technically not guaranteed */
133     p = p + ((-p - SIZEOF_StgArrWords) & (alignment - 1));
134
135     SET_HDR(p, stg_ARR_WORDS_info, CCCS);
136     StgArrWords_bytes(p) = n;
137     return (p);
138 }
139
140 stg_newArrayzh ( W_ n /* words */, gcptr init )
141 {
142     W_ words, size;
143     gcptr p, arr;
144
145     again: MAYBE_GC(again);
146
147     // the mark area contains one byte for each 2^MUT_ARR_PTRS_CARD_BITS words
148     // in the array, making sure we round up, and then rounding up to a whole
149     // number of words.
150     size = n + mutArrPtrsCardWords(n);
151     words = BYTES_TO_WDS(SIZEOF_StgMutArrPtrs) + size;
152     ("ptr" arr) = ccall allocate(MyCapability() "ptr",words);
153     TICK_ALLOC_PRIM(SIZEOF_StgMutArrPtrs, WDS(n), 0);
154
155     SET_HDR(arr, stg_MUT_ARR_PTRS_DIRTY_info, CCCS);
156     StgMutArrPtrs_ptrs(arr) = n;
157     StgMutArrPtrs_size(arr) = size;
158
159     // Initialise all elements of the the array with the value in R2
160     p = arr + SIZEOF_StgMutArrPtrs;
161   for:
162     if (p < arr + WDS(words)) {
163         W_[p] = init;
164         p = p + WDS(1);
165         goto for;
166     }
167     // Initialise the mark bits with 0
168   for2:
169     if (p < arr + WDS(size)) {
170         W_[p] = 0;
171         p = p + WDS(1);
172         goto for2;
173     }
174
175     return (arr);
176 }
177
178 stg_unsafeThawArrayzh ( gcptr arr )
179 {
180   // SUBTLETY TO DO WITH THE OLD GEN MUTABLE LIST
181   //
182   // A MUT_ARR_PTRS lives on the mutable list, but a MUT_ARR_PTRS_FROZEN
183   // normally doesn't.  However, when we freeze a MUT_ARR_PTRS, we leave
184   // it on the mutable list for the GC to remove (removing something from
185   // the mutable list is not easy).
186   //
187   // So that we can tell whether a MUT_ARR_PTRS_FROZEN is on the mutable list,
188   // when we freeze it we set the info ptr to be MUT_ARR_PTRS_FROZEN0
189   // to indicate that it is still on the mutable list.
190   //
191   // So, when we thaw a MUT_ARR_PTRS_FROZEN, we must cope with two cases:
192   // either it is on a mut_list, or it isn't.  We adopt the convention that
193   // the closure type is MUT_ARR_PTRS_FROZEN0 if it is on the mutable list,
194   // and MUT_ARR_PTRS_FROZEN otherwise.  In fact it wouldn't matter if
195   // we put it on the mutable list more than once, but it would get scavenged
196   // multiple times during GC, which would be unnecessarily slow.
197   //
198   if (StgHeader_info(arr) != stg_MUT_ARR_PTRS_FROZEN0_info) {
199         SET_INFO(arr,stg_MUT_ARR_PTRS_DIRTY_info);
200         recordMutable(arr);
201         // must be done after SET_INFO, because it ASSERTs closure_MUTABLE()
202         return (arr);
203   } else {
204         SET_INFO(arr,stg_MUT_ARR_PTRS_DIRTY_info);
205         return (arr);
206   }
207 }
208
209 stg_newArrayArrayzh ( W_ n /* words */ )
210 {
211     W_ words, size;
212     gcptr p, arr;
213
214     MAYBE_GC_N(stg_newArrayArrayzh, n);
215
216     // the mark area contains one byte for each 2^MUT_ARR_PTRS_CARD_BITS words
217     // in the array, making sure we round up, and then rounding up to a whole
218     // number of words.
219     size = n + mutArrPtrsCardWords(n);
220     words = BYTES_TO_WDS(SIZEOF_StgMutArrPtrs) + size;
221     ("ptr" arr) = ccall allocate(MyCapability() "ptr",words);
222     TICK_ALLOC_PRIM(SIZEOF_StgMutArrPtrs, WDS(n), 0);
223
224     SET_HDR(arr, stg_MUT_ARR_PTRS_DIRTY_info, W_[CCCS]);
225     StgMutArrPtrs_ptrs(arr) = n;
226     StgMutArrPtrs_size(arr) = size;
227
228     // Initialise all elements of the array with a pointer to the new array
229     p = arr + SIZEOF_StgMutArrPtrs;
230   for:
231     if (p < arr + WDS(words)) {
232         W_[p] = arr;
233         p = p + WDS(1);
234         goto for;
235     }
236     // Initialise the mark bits with 0
237   for2:
238     if (p < arr + WDS(size)) {
239         W_[p] = 0;
240         p = p + WDS(1);
241         goto for2;
242     }
243
244     return (arr);
245 }
246
247
248 /* -----------------------------------------------------------------------------
249    MutVar primitives
250    -------------------------------------------------------------------------- */
251
252 stg_newMutVarzh ( gcptr init )
253 {
254     W_ mv;
255
256     ALLOC_PRIM_P (SIZEOF_StgMutVar, stg_newMutVarzh, init);
257
258     mv = Hp - SIZEOF_StgMutVar + WDS(1);
259     SET_HDR(mv,stg_MUT_VAR_DIRTY_info,CCCS);
260     StgMutVar_var(mv) = init;
261
262     return (mv);
263 }
264
265 stg_casMutVarzh ( gcptr mv, gcptr old, gcptr new )
266  /* MutVar# s a -> a -> a -> State# s -> (# State#, Int#, a #) */
267 {
268     gcptr h;
269
270     (h) = ccall cas(mv + SIZEOF_StgHeader + OFFSET_StgMutVar_var,
271                           old, new);
272     if (h != old) {
273         return (1,h);
274     } else {
275         if (GET_INFO(mv) == stg_MUT_VAR_CLEAN_info) {
276            ccall dirty_MUT_VAR(BaseReg "ptr", mv "ptr");
277         }
278         return (0,h);
279     }
280 }
281
282 stg_atomicModifyMutVarzh ( gcptr mv, gcptr f )
283 {
284     W_ z, x, y, r, h;
285
286     /* If x is the current contents of the MutVar#, then
287        We want to make the new contents point to
288
289          (sel_0 (f x))
290
291        and the return value is
292
293          (sel_1 (f x))
294
295         obviously we can share (f x).
296
297          z = [stg_ap_2 f x]  (max (HS + 2) MIN_UPD_SIZE)
298          y = [stg_sel_0 z]   (max (HS + 1) MIN_UPD_SIZE)
299          r = [stg_sel_1 z]   (max (HS + 1) MIN_UPD_SIZE)
300     */
301
302 #if MIN_UPD_SIZE > 1
303 #define THUNK_1_SIZE (SIZEOF_StgThunkHeader + WDS(MIN_UPD_SIZE))
304 #define TICK_ALLOC_THUNK_1() TICK_ALLOC_UP_THK(WDS(1),WDS(MIN_UPD_SIZE-1))
305 #else
306 #define THUNK_1_SIZE (SIZEOF_StgThunkHeader + WDS(1))
307 #define TICK_ALLOC_THUNK_1() TICK_ALLOC_UP_THK(WDS(1),0)
308 #endif
309
310 #if MIN_UPD_SIZE > 2
311 #define THUNK_2_SIZE (SIZEOF_StgThunkHeader + WDS(MIN_UPD_SIZE))
312 #define TICK_ALLOC_THUNK_2() TICK_ALLOC_UP_THK(WDS(2),WDS(MIN_UPD_SIZE-2))
313 #else
314 #define THUNK_2_SIZE (SIZEOF_StgThunkHeader + WDS(2))
315 #define TICK_ALLOC_THUNK_2() TICK_ALLOC_UP_THK(WDS(2),0)
316 #endif
317
318 #define SIZE (THUNK_2_SIZE + THUNK_1_SIZE + THUNK_1_SIZE)
319
320    HP_CHK_GEN_TICKY(SIZE);
321
322    TICK_ALLOC_THUNK_2();
323    CCCS_ALLOC(THUNK_2_SIZE);
324    z = Hp - THUNK_2_SIZE + WDS(1);
325    SET_HDR(z, stg_ap_2_upd_info, CCCS);
326    LDV_RECORD_CREATE(z);
327    StgThunk_payload(z,0) = f;
328
329    TICK_ALLOC_THUNK_1();
330    CCCS_ALLOC(THUNK_1_SIZE);
331    y = z - THUNK_1_SIZE;
332    SET_HDR(y, stg_sel_0_upd_info, CCCS);
333    LDV_RECORD_CREATE(y);
334    StgThunk_payload(y,0) = z;
335
336    TICK_ALLOC_THUNK_1();
337    CCCS_ALLOC(THUNK_1_SIZE);
338    r = y - THUNK_1_SIZE;
339    SET_HDR(r, stg_sel_1_upd_info, CCCS);
340    LDV_RECORD_CREATE(r);
341    StgThunk_payload(r,0) = z;
342
343  retry:
344    x = StgMutVar_var(mv);
345    StgThunk_payload(z,1) = x;
346 #ifdef THREADED_RTS
347    (h) = ccall cas(mv + SIZEOF_StgHeader + OFFSET_StgMutVar_var, x, y);
348    if (h != x) { goto retry; }
349 #else
350    StgMutVar_var(mv) = y;
351 #endif
352
353    if (GET_INFO(mv) == stg_MUT_VAR_CLEAN_info) {
354      ccall dirty_MUT_VAR(BaseReg "ptr", mv "ptr");
355    }
356
357    return (r);
358 }
359
360 /* -----------------------------------------------------------------------------
361    Weak Pointer Primitives
362    -------------------------------------------------------------------------- */
363
364 STRING(stg_weak_msg,"New weak pointer at %p\n")
365
366 stg_mkWeakzh ( gcptr key,
367                gcptr value,
368                gcptr finalizer /* or stg_NO_FINALIZER_closure */ )
369 {
370   gcptr w;
371
372   ALLOC_PRIM (SIZEOF_StgWeak)
373
374   w = Hp - SIZEOF_StgWeak + WDS(1);
375   SET_HDR(w, stg_WEAK_info, CCCS);
376
377   StgWeak_key(w)         = key;
378   StgWeak_value(w)       = value;
379   StgWeak_finalizer(w)   = finalizer;
380   StgWeak_cfinalizers(w) = stg_NO_FINALIZER_closure;
381
382   ACQUIRE_LOCK(sm_mutex);
383   StgWeak_link(w)       = W_[weak_ptr_list];
384   W_[weak_ptr_list]     = w;
385   RELEASE_LOCK(sm_mutex);
386
387   IF_DEBUG(weak, ccall debugBelch(stg_weak_msg,w));
388
389   return (w);
390 }
391
392 stg_mkWeakNoFinalizzerzh ( gcptr key, gcptr value )
393 {
394   jump stg_mkWeakzh (key, value, stg_NO_FINALIZER_closure);
395 }
396
397 STRING(stg_cfinalizer_msg,"Adding a finalizer to %p\n")
398
399 stg_addCFinalizzerToWeakzh ( W_ fptr,   // finalizer
400                              W_ ptr,
401                              W_ flag,   // has environment (0 or 1)
402                              W_ eptr,
403                              gcptr w )
404 {
405   W_ c, info;
406
407   ALLOC_PRIM (SIZEOF_StgCFinalizerList)
408
409   c = Hp - SIZEOF_StgCFinalizerList + WDS(1);
410   SET_HDR(c, stg_C_FINALIZER_LIST_info, CCCS);
411
412   StgCFinalizerList_fptr(c) = fptr;
413   StgCFinalizerList_ptr(c) = ptr;
414   StgCFinalizerList_eptr(c) = eptr;
415   StgCFinalizerList_flag(c) = flag;
416
417   ("ptr" info) = ccall lockClosure(w "ptr");
418
419   if (info == stg_DEAD_WEAK_info) {
420     // Already dead.
421     unlockClosure(w, info);
422     return (0);
423   }
424
425   StgCFinalizerList_link(c) = StgWeak_cfinalizers(w);
426   StgWeak_cfinalizers(w) = c;
427
428   unlockClosure(w, info);
429
430   recordMutable(w);
431
432   IF_DEBUG(weak, ccall debugBelch(stg_cfinalizer_msg,w));
433
434   return (1);
435 }
436
437 stg_finalizzeWeakzh ( gcptr w )
438 {
439   gcptr f, list;
440   W_ info;
441
442   ("ptr" info) = ccall lockClosure(w "ptr");
443
444   // already dead?
445   if (info == stg_DEAD_WEAK_info) {
446       unlockClosure(w, info);
447       return (0,stg_NO_FINALIZER_closure);
448   }
449
450   f    = StgWeak_finalizer(w);
451   list = StgWeak_cfinalizers(w);
452
453   // kill it
454 #ifdef PROFILING
455   // @LDV profiling
456   // A weak pointer is inherently used, so we do not need to call
457   // LDV_recordDead_FILL_SLOP_DYNAMIC():
458   //    LDV_recordDead_FILL_SLOP_DYNAMIC((StgClosure *)w);
459   // or, LDV_recordDead():
460   //    LDV_recordDead((StgClosure *)w, sizeofW(StgWeak) - sizeofW(StgProfHeader));
461   // Furthermore, when PROFILING is turned on, dead weak pointers are exactly as
462   // large as weak pointers, so there is no need to fill the slop, either.
463   // See stg_DEAD_WEAK_info in StgMiscClosures.hc.
464 #endif
465
466   //
467   // Todo: maybe use SET_HDR() and remove LDV_recordCreate()?
468   //
469   unlockClosure(w, stg_DEAD_WEAK_info);
470
471   LDV_RECORD_CREATE(w);
472
473   if (list != stg_NO_FINALIZER_closure) {
474     ccall runCFinalizers(list);
475   }
476
477   /* return the finalizer */
478   if (f == stg_NO_FINALIZER_closure) {
479       return (0,stg_NO_FINALIZER_closure);
480   } else {
481       return (1,f);
482   }
483 }
484
485 stg_deRefWeakzh ( gcptr w )
486 {
487   W_ code, info;
488   gcptr val;
489
490   info = GET_INFO(w);
491
492   if (info == stg_WHITEHOLE_info) {
493     // w is locked by another thread. Now it's not immediately clear if w is
494     // alive or not. We use lockClosure to wait for the info pointer to become
495     // something other than stg_WHITEHOLE_info.
496
497     ("ptr" info) = ccall lockClosure(w "ptr");
498     unlockClosure(w, info);
499   }
500
501   if (info == stg_WEAK_info) {
502     code = 1;
503     val = StgWeak_value(w);
504   } else {
505     code = 0;
506     val = w;
507   }
508   return (code,val);
509 }
510
511 /* -----------------------------------------------------------------------------
512    Floating point operations.
513    -------------------------------------------------------------------------- */
514
515 stg_decodeFloatzuIntzh ( F_ arg )
516 {
517     W_ p;
518     W_ mp_tmp1;
519     W_ mp_tmp_w;
520
521     STK_CHK_GEN_N (WDS(2));
522
523     mp_tmp1  = Sp - WDS(1);
524     mp_tmp_w = Sp - WDS(2);
525
526     /* Perform the operation */
527     ccall __decodeFloat_Int(mp_tmp1 "ptr", mp_tmp_w "ptr", arg);
528
529     /* returns: (Int# (mantissa), Int# (exponent)) */
530     return (W_[mp_tmp1], W_[mp_tmp_w]);
531 }
532
533 stg_decodeDoublezu2Intzh ( D_ arg )
534 {
535     W_ p;
536     W_ mp_tmp1;
537     W_ mp_tmp2;
538     W_ mp_result1;
539     W_ mp_result2;
540
541     STK_CHK_GEN_N (WDS(4));
542
543     mp_tmp1    = Sp - WDS(1);
544     mp_tmp2    = Sp - WDS(2);
545     mp_result1 = Sp - WDS(3);
546     mp_result2 = Sp - WDS(4);
547
548     /* Perform the operation */
549     ccall __decodeDouble_2Int(mp_tmp1 "ptr", mp_tmp2 "ptr",
550                                     mp_result1 "ptr", mp_result2 "ptr",
551                                     arg);
552
553     /* returns:
554        (Int# (mant sign), Word# (mant high), Word# (mant low), Int# (expn)) */
555     return (W_[mp_tmp1], W_[mp_tmp2], W_[mp_result1], W_[mp_result2]);
556 }
557
558 /* -----------------------------------------------------------------------------
559  * Concurrency primitives
560  * -------------------------------------------------------------------------- */
561
562 stg_forkzh ( gcptr closure )
563 {
564   MAYBE_GC_P(stg_forkzh, closure);
565
566   gcptr threadid;
567
568   ("ptr" threadid) = ccall createIOThread( MyCapability() "ptr",
569                                 RtsFlags_GcFlags_initialStkSize(RtsFlags),
570                                 closure "ptr");
571
572   /* start blocked if the current thread is blocked */
573   StgTSO_flags(threadid) = %lobits16(
574      TO_W_(StgTSO_flags(threadid)) |
575      TO_W_(StgTSO_flags(CurrentTSO)) & (TSO_BLOCKEX | TSO_INTERRUPTIBLE));
576
577   ccall scheduleThread(MyCapability() "ptr", threadid "ptr");
578
579   // context switch soon, but not immediately: we don't want every
580   // forkIO to force a context-switch.
581   Capability_context_switch(MyCapability()) = 1 :: CInt;
582
583   return (threadid);
584 }
585
586 stg_forkOnzh ( W_ cpu, gcptr closure )
587 {
588 again: MAYBE_GC(again);
589
590   gcptr threadid;
591
592   ("ptr" threadid) = ccall createIOThread( MyCapability() "ptr",
593                                 RtsFlags_GcFlags_initialStkSize(RtsFlags),
594                                 closure "ptr");
595
596   /* start blocked if the current thread is blocked */
597   StgTSO_flags(threadid) = %lobits16(
598      TO_W_(StgTSO_flags(threadid)) |
599      TO_W_(StgTSO_flags(CurrentTSO)) & (TSO_BLOCKEX | TSO_INTERRUPTIBLE));
600
601   ccall scheduleThreadOn(MyCapability() "ptr", cpu, threadid "ptr");
602
603   // context switch soon, but not immediately: we don't want every
604   // forkIO to force a context-switch.
605   Capability_context_switch(MyCapability()) = 1 :: CInt;
606
607   return (threadid);
608 }
609
610 stg_yieldzh ()
611 {
612   // when we yield to the scheduler, we have to tell it to put the
613   // current thread to the back of the queue by setting the
614   // context_switch flag.  If we don't do this, it will run the same
615   // thread again.
616   Capability_context_switch(MyCapability()) = 1 :: CInt;
617   jump stg_yield_noregs();
618 }
619
620 stg_myThreadIdzh ()
621 {
622   return (CurrentTSO);
623 }
624
625 stg_labelThreadzh ( gcptr threadid, W_ addr )
626 {
627 #if defined(DEBUG) || defined(TRACING) || defined(DTRACE)
628   ccall labelThread(MyCapability() "ptr", threadid "ptr", addr "ptr");
629 #endif
630   return ();
631 }
632
633 stg_isCurrentThreadBoundzh (/* no args */)
634 {
635   W_ r;
636   (r) = ccall isThreadBound(CurrentTSO);
637   return (r);
638 }
639
640 stg_threadStatuszh ( gcptr tso )
641 {
642     W_ why_blocked;
643     W_ what_next;
644     W_ ret, cap, locked;
645
646     what_next   = TO_W_(StgTSO_what_next(tso));
647     why_blocked = TO_W_(StgTSO_why_blocked(tso));
648     // Note: these two reads are not atomic, so they might end up
649     // being inconsistent.  It doesn't matter, since we
650     // only return one or the other.  If we wanted to return the
651     // contents of block_info too, then we'd have to do some synchronisation.
652
653     if (what_next == ThreadComplete) {
654         ret = 16;  // NB. magic, matches up with GHC.Conc.threadStatus
655     } else {
656         if (what_next == ThreadKilled) {
657             ret = 17;
658         } else {
659             ret = why_blocked;
660         }
661     }
662
663     cap = TO_W_(Capability_no(StgTSO_cap(tso)));
664
665     if ((TO_W_(StgTSO_flags(tso)) & TSO_LOCKED) != 0) {
666         locked = 1;
667     } else {
668         locked = 0;
669     }
670
671     return (ret,cap,locked);
672 }
673
674 /* -----------------------------------------------------------------------------
675  * TVar primitives
676  * -------------------------------------------------------------------------- */
677
678 // Catch retry frame -----------------------------------------------------------
679
680 #define CATCH_RETRY_FRAME_FIELDS(w_,p_,info_ptr,        \
681                                  p1, p2,                \
682                                  running_alt_code,      \
683                                  first_code,            \
684                                  alt_code)              \
685   w_ info_ptr,                                          \
686   PROF_HDR_FIELDS(w_,p1,p2)                             \
687   w_ running_alt_code,                                  \
688   p_ first_code,                                        \
689   p_ alt_code
690
691
692 INFO_TABLE_RET(stg_catch_retry_frame, CATCH_RETRY_FRAME,
693                CATCH_RETRY_FRAME_FIELDS(W_,P_,
694                                         info_ptr, p1, p2,
695                                         running_alt_code,
696                                         first_code,
697                                         alt_code))
698     return (P_ ret)
699 {
700     W_ r;
701     gcptr trec, outer, arg;
702
703     trec = StgTSO_trec(CurrentTSO);
704     outer  = StgTRecHeader_enclosing_trec(trec);
705     (r) = ccall stmCommitNestedTransaction(MyCapability() "ptr", trec "ptr");
706     if (r != 0) {
707         // Succeeded (either first branch or second branch)
708         StgTSO_trec(CurrentTSO) = outer;
709         return (ret);
710     } else {
711         // Did not commit: re-execute
712         P_ new_trec;
713         ("ptr" new_trec) = ccall stmStartTransaction(MyCapability() "ptr",
714                                                            outer "ptr");
715         StgTSO_trec(CurrentTSO) = new_trec;
716         if (running_alt_code != 0) {
717             jump stg_ap_v_fast
718                 (CATCH_RETRY_FRAME_FIELDS(,,info_ptr, p1, p2,
719                                           running_alt_code,
720                                           first_code,
721                                           alt_code))
722                 (alt_code);
723         } else {
724             jump stg_ap_v_fast
725                 (CATCH_RETRY_FRAME_FIELDS(,,info_ptr, p1, p2,
726                                           running_alt_code,
727                                           first_code,
728                                           alt_code))
729                 (first_code);
730         }
731     }
732 }
733
734 // Atomically frame ------------------------------------------------------------
735
736 // This must match StgAtomicallyFrame in Closures.h
737 #define ATOMICALLY_FRAME_FIELDS(w_,p_,info_ptr,p1,p2,code,next,result)  \
738   w_ info_ptr,                                                          \
739   PROF_HDR_FIELDS(w_,p1,p2)                                             \
740   p_ code,                                                              \
741   p_ next,                                                              \
742   p_ result
743
744
745 INFO_TABLE_RET(stg_atomically_frame, ATOMICALLY_FRAME,
746                // layout of the frame, and bind the field names
747                ATOMICALLY_FRAME_FIELDS(W_,P_,
748                                        info_ptr, p1, p2,
749                                        code,
750                                        next_invariant,
751                                        frame_result))
752     return (P_ result) // value returned to the frame
753 {
754   W_ valid;
755   gcptr trec, outer, next_invariant, q;
756
757   trec   = StgTSO_trec(CurrentTSO);
758   outer  = StgTRecHeader_enclosing_trec(trec);
759
760   if (outer == NO_TREC) {
761     /* First time back at the atomically frame -- pick up invariants */
762     ("ptr" next_invariant) =
763         ccall stmGetInvariantsToCheck(MyCapability() "ptr", trec "ptr");
764     frame_result = result;
765
766   } else {
767     /* Second/subsequent time back at the atomically frame -- abort the
768      * tx that's checking the invariant and move on to the next one */
769     StgTSO_trec(CurrentTSO) = outer;
770     StgInvariantCheckQueue_my_execution(next_invariant) = trec;
771     ccall stmAbortTransaction(MyCapability() "ptr", trec "ptr");
772     /* Don't free trec -- it's linked from q and will be stashed in the
773      * invariant if we eventually commit. */
774     next_invariant =
775        StgInvariantCheckQueue_next_queue_entry(next_invariant);
776     trec = outer;
777   }
778
779   if (next_invariant != END_INVARIANT_CHECK_QUEUE) {
780     /* We can't commit yet: another invariant to check */
781     ("ptr" trec) = ccall stmStartTransaction(MyCapability() "ptr", trec "ptr");
782     StgTSO_trec(CurrentTSO) = trec;
783     q = StgInvariantCheckQueue_invariant(next_invariant);
784     jump stg_ap_v_fast
785         (ATOMICALLY_FRAME_FIELDS(,,info_ptr,p1,p2,
786                                  code,next_invariant,frame_result))
787         (StgAtomicInvariant_code(q));
788
789   } else {
790
791     /* We've got no more invariants to check, try to commit */
792     (valid) = ccall stmCommitTransaction(MyCapability() "ptr", trec "ptr");
793     if (valid != 0) {
794       /* Transaction was valid: commit succeeded */
795       StgTSO_trec(CurrentTSO) = NO_TREC;
796       return (frame_result);
797     } else {
798       /* Transaction was not valid: try again */
799       ("ptr" trec) = ccall stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr");
800       StgTSO_trec(CurrentTSO) = trec;
801       next_invariant = END_INVARIANT_CHECK_QUEUE;
802
803       jump stg_ap_v_fast
804           // push the StgAtomicallyFrame again: the code generator is
805           // clever enough to only assign the fields that have changed.
806           (ATOMICALLY_FRAME_FIELDS(,,info_ptr,p1,p2,
807                                    code,next_invariant,frame_result))
808           (code);
809     }
810   }
811 }
812
813
814 INFO_TABLE_RET(stg_atomically_waiting_frame, ATOMICALLY_FRAME,
815                // layout of the frame, and bind the field names
816                ATOMICALLY_FRAME_FIELDS(W_,P_,
817                                        info_ptr, p1, p2,
818                                        code,
819                                        next_invariant,
820                                        frame_result))
821     return (/* no return values */)
822 {
823   W_ trec, valid;
824
825   /* The TSO is currently waiting: should we stop waiting? */
826   (valid) = ccall stmReWait(MyCapability() "ptr", CurrentTSO "ptr");
827   if (valid != 0) {
828       /* Previous attempt is still valid: no point trying again yet */
829       jump stg_block_noregs
830           (ATOMICALLY_FRAME_FIELDS(,,info_ptr, p1, p2,
831                                    code,next_invariant,frame_result))
832           ();
833   } else {
834     /* Previous attempt is no longer valid: try again */
835     ("ptr" trec) = ccall stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr");
836     StgTSO_trec(CurrentTSO) = trec;
837
838     // change the frame header to stg_atomically_frame_info
839     jump stg_ap_v_fast
840         (ATOMICALLY_FRAME_FIELDS(,,stg_atomically_frame_info, p1, p2,
841                                  code,next_invariant,frame_result))
842         (code);
843   }
844 }
845
846 // STM catch frame -------------------------------------------------------------
847
848 /* Catch frames are very similar to update frames, but when entering
849  * one we just pop the frame off the stack and perform the correct
850  * kind of return to the activation record underneath us on the stack.
851  */
852
853 #define CATCH_STM_FRAME_FIELDS(w_,p_,info_ptr,p1,p2,code,handler) \
854   w_ info_ptr,                                                  \
855   PROF_HDR_FIELDS(w_,p1,p2)                                     \
856   p_ code,                                                      \
857   p_ handler
858
859 INFO_TABLE_RET(stg_catch_stm_frame, CATCH_STM_FRAME,
860                // layout of the frame, and bind the field names
861                CATCH_STM_FRAME_FIELDS(W_,P_,info_ptr,p1,p2,code,handler))
862     return (P_ ret)
863 {
864     W_ r, trec, outer;
865
866     trec = StgTSO_trec(CurrentTSO);
867     outer  = StgTRecHeader_enclosing_trec(trec);
868     (r) = ccall stmCommitNestedTransaction(MyCapability() "ptr", trec "ptr");
869     if (r != 0) {
870         /* Commit succeeded */
871         StgTSO_trec(CurrentTSO) = outer;
872         return (ret);
873     } else {
874         /* Commit failed */
875         W_ new_trec;
876         ("ptr" new_trec) = ccall stmStartTransaction(MyCapability() "ptr", outer "ptr");
877         StgTSO_trec(CurrentTSO) = new_trec;
878
879         jump stg_ap_v_fast
880             (CATCH_STM_FRAME_FIELDS(,,info_ptr,p1,p2,code,handler))
881             (code);
882     }
883 }
884
885
886 // Primop definition -----------------------------------------------------------
887
888 stg_atomicallyzh (P_ stm)
889 {
890   P_ old_trec;
891   P_ new_trec;
892   P_ code, next_invariant, frame_result;
893
894   // stmStartTransaction may allocate
895   MAYBE_GC_P(stg_atomicallyzh, stm);
896
897   STK_CHK_GEN();
898
899   old_trec = StgTSO_trec(CurrentTSO);
900
901   /* Nested transactions are not allowed; raise an exception */
902   if (old_trec != NO_TREC) {
903      jump stg_raisezh(base_ControlziExceptionziBase_nestedAtomically_closure);
904   }
905
906   code = stm;
907   next_invariant = END_INVARIANT_CHECK_QUEUE;
908   frame_result = NO_TREC;
909
910   /* Start the memory transcation */
911   ("ptr" new_trec) = ccall stmStartTransaction(MyCapability() "ptr", old_trec "ptr");
912   StgTSO_trec(CurrentTSO) = new_trec;
913
914   jump stg_ap_v_fast
915       (ATOMICALLY_FRAME_FIELDS(,,stg_atomically_frame_info, CCCS, 0,
916                                code,next_invariant,frame_result))
917       (stm);
918 }
919
920 // A closure representing "atomically x".  This is used when a thread
921 // inside a transaction receives an asynchronous exception; see #5866.
922 // It is somewhat similar to the stg_raise closure.
923 //
924 INFO_TABLE(stg_atomically,1,0,THUNK_1_0,"atomically","atomically")
925     (P_ thunk)
926 {
927     jump stg_atomicallyzh(StgThunk_payload(thunk,0));
928 }
929
930
931 stg_catchSTMzh (P_ code    /* :: STM a */,
932                 P_ handler /* :: Exception -> STM a */)
933 {
934     STK_CHK_GEN();
935
936     /* Start a nested transaction to run the body of the try block in */
937     W_ cur_trec;
938     W_ new_trec;
939     cur_trec = StgTSO_trec(CurrentTSO);
940     ("ptr" new_trec) = ccall stmStartTransaction(MyCapability() "ptr",
941                                                  cur_trec "ptr");
942     StgTSO_trec(CurrentTSO) = new_trec;
943
944     jump stg_ap_v_fast
945         (CATCH_STM_FRAME_FIELDS(,,stg_catch_stm_frame_info, CCCS, 0,
946                                 code, handler))
947         (code);
948 }
949
950
951 stg_catchRetryzh (P_ first_code, /* :: STM a */
952                   P_ alt_code    /* :: STM a */)
953 {
954   W_ new_trec;
955
956   // stmStartTransaction may allocate
957   MAYBE_GC_PP (stg_catchRetryzh, first_code, alt_code);
958
959   STK_CHK_GEN();
960
961   /* Start a nested transaction within which to run the first code */
962   ("ptr" new_trec) = ccall stmStartTransaction(MyCapability() "ptr",
963                                                StgTSO_trec(CurrentTSO) "ptr");
964   StgTSO_trec(CurrentTSO) = new_trec;
965
966   // push the CATCH_RETRY stack frame, and apply first_code to realWorld#
967   jump stg_ap_v_fast
968       (CATCH_RETRY_FRAME_FIELDS(,, stg_catch_retry_frame_info, CCCS, 0,
969                                 0, /* not running_alt_code */
970                                 first_code,
971                                 alt_code))
972       (first_code);
973 }
974
975
976 stg_retryzh /* no arg list: explicit stack layout */
977 {
978   W_ frame_type;
979   W_ frame;
980   W_ trec;
981   W_ outer;
982   W_ r;
983
984   // STM operations may allocate
985   MAYBE_GC_ (stg_retryzh); // NB. not MAYBE_GC(), we cannot make a
986                            // function call in an explicit-stack proc
987
988   // Find the enclosing ATOMICALLY_FRAME or CATCH_RETRY_FRAME
989 retry_pop_stack:
990   SAVE_THREAD_STATE();
991   (frame_type) = ccall findRetryFrameHelper(MyCapability(), CurrentTSO "ptr");
992   LOAD_THREAD_STATE();
993   frame = Sp;
994   trec = StgTSO_trec(CurrentTSO);
995   outer  = StgTRecHeader_enclosing_trec(trec);
996
997   if (frame_type == CATCH_RETRY_FRAME) {
998     // The retry reaches a CATCH_RETRY_FRAME before the atomic frame
999     ASSERT(outer != NO_TREC);
1000     // Abort the transaction attempting the current branch
1001     ccall stmAbortTransaction(MyCapability() "ptr", trec "ptr");
1002     ccall stmFreeAbortedTRec(MyCapability() "ptr", trec "ptr");
1003     if (!StgCatchRetryFrame_running_alt_code(frame) != 0) {
1004       // Retry in the first branch: try the alternative
1005       ("ptr" trec) = ccall stmStartTransaction(MyCapability() "ptr", outer "ptr");
1006       StgTSO_trec(CurrentTSO) = trec;
1007       StgCatchRetryFrame_running_alt_code(frame) = 1 :: CInt; // true;
1008       R1 = StgCatchRetryFrame_alt_code(frame);
1009       jump stg_ap_v_fast [R1];
1010     } else {
1011       // Retry in the alternative code: propagate the retry
1012       StgTSO_trec(CurrentTSO) = outer;
1013       Sp = Sp + SIZEOF_StgCatchRetryFrame;
1014       goto retry_pop_stack;
1015     }
1016   }
1017
1018   // We've reached the ATOMICALLY_FRAME: attempt to wait
1019   ASSERT(frame_type == ATOMICALLY_FRAME);
1020   if (outer != NO_TREC) {
1021     // We called retry while checking invariants, so abort the current
1022     // invariant check (merging its TVar accesses into the parents read
1023     // set so we'll wait on them)
1024     ccall stmAbortTransaction(MyCapability() "ptr", trec "ptr");
1025     ccall stmFreeAbortedTRec(MyCapability() "ptr", trec "ptr");
1026     trec = outer;
1027     StgTSO_trec(CurrentTSO) = trec;
1028     outer  = StgTRecHeader_enclosing_trec(trec);
1029   }
1030   ASSERT(outer == NO_TREC);
1031
1032   (r) = ccall stmWait(MyCapability() "ptr", CurrentTSO "ptr", trec "ptr");
1033   if (r != 0) {
1034     // Transaction was valid: stmWait put us on the TVars' queues, we now block
1035     StgHeader_info(frame) = stg_atomically_waiting_frame_info;
1036     Sp = frame;
1037     R3 = trec; // passing to stmWaitUnblock()
1038     jump stg_block_stmwait [R3];
1039   } else {
1040     // Transaction was not valid: retry immediately
1041     ("ptr" trec) = ccall stmStartTransaction(MyCapability() "ptr", outer "ptr");
1042     StgTSO_trec(CurrentTSO) = trec;
1043     Sp = frame;
1044     R1 = StgAtomicallyFrame_code(frame);
1045     jump stg_ap_v_fast [R1];
1046   }
1047 }
1048
1049 stg_checkzh (P_ closure /* STM a */)
1050 {
1051     W_ trec;
1052
1053     MAYBE_GC_P (stg_checkzh, closure);
1054
1055     trec = StgTSO_trec(CurrentTSO);
1056     ccall stmAddInvariantToCheck(MyCapability() "ptr",
1057                                  trec "ptr",
1058                                  closure "ptr");
1059     return ();
1060 }
1061
1062
1063 stg_newTVarzh (P_ init)
1064 {
1065     W_ tv;
1066
1067     ALLOC_PRIM_P (SIZEOF_StgTVar, stg_newTVarzh, init);
1068
1069     tv = Hp - SIZEOF_StgTVar + WDS(1);
1070     SET_HDR (tv, stg_TVAR_DIRTY_info, CCCS);
1071
1072     StgTVar_current_value(tv) = init;
1073     StgTVar_first_watch_queue_entry(tv) = stg_END_STM_WATCH_QUEUE_closure;
1074     StgTVar_num_updates(tv) = 0;
1075
1076     return (tv);
1077 }
1078
1079
1080 stg_readTVarzh (P_ tvar)
1081 {
1082   P_ trec;
1083   P_ result;
1084
1085   // Call to stmReadTVar may allocate
1086   MAYBE_GC_P (stg_readTVarzh, tvar);
1087
1088   trec = StgTSO_trec(CurrentTSO);
1089   ("ptr" result) = ccall stmReadTVar(MyCapability() "ptr", trec "ptr",
1090                                      tvar "ptr");
1091   return (result);
1092 }
1093
1094 stg_readTVarIOzh ( P_ tvar /* :: TVar a */ )
1095 {
1096     W_ result;
1097
1098 again:
1099     result = StgTVar_current_value(tvar);
1100     if (%INFO_PTR(result) == stg_TREC_HEADER_info) {
1101         goto again;
1102     }
1103     return (result);
1104 }
1105
1106 stg_writeTVarzh (P_ tvar,     /* :: TVar a */
1107                  P_ new_value /* :: a      */)
1108 {
1109     W_ trec;
1110
1111     // Call to stmWriteTVar may allocate
1112     MAYBE_GC_PP (stg_writeTVarzh, tvar, new_value);
1113
1114     trec = StgTSO_trec(CurrentTSO);
1115     ccall stmWriteTVar(MyCapability() "ptr", trec "ptr", tvar "ptr",
1116                        new_value "ptr");
1117     return ();
1118 }
1119
1120
1121 /* -----------------------------------------------------------------------------
1122  * MVar primitives
1123  *
1124  * take & putMVar work as follows.  Firstly, an important invariant:
1125  *
1126  *    If the MVar is full, then the blocking queue contains only
1127  *    threads blocked on putMVar, and if the MVar is empty then the
1128  *    blocking queue contains only threads blocked on takeMVar.
1129  *
1130  * takeMvar:
1131  *    MVar empty : then add ourselves to the blocking queue
1132  *    MVar full  : remove the value from the MVar, and
1133  *                 blocking queue empty     : return
1134  *                 blocking queue non-empty : perform the first blocked putMVar
1135  *                                            from the queue, and wake up the
1136  *                                            thread (MVar is now full again)
1137  *
1138  * putMVar is just the dual of the above algorithm.
1139  *
1140  * How do we "perform a putMVar"?  Well, we have to fiddle around with
1141  * the stack of the thread waiting to do the putMVar.  See
1142  * stg_block_putmvar and stg_block_takemvar in HeapStackCheck.c for
1143  * the stack layout, and the PerformPut and PerformTake macros below.
1144  *
1145  * It is important that a blocked take or put is woken up with the
1146  * take/put already performed, because otherwise there would be a
1147  * small window of vulnerability where the thread could receive an
1148  * exception and never perform its take or put, and we'd end up with a
1149  * deadlock.
1150  *
1151  * -------------------------------------------------------------------------- */
1152
1153 stg_isEmptyMVarzh ( P_ mvar /* :: MVar a */ )
1154 {
1155     if (StgMVar_value(mvar) == stg_END_TSO_QUEUE_closure) {
1156         return (1);
1157     } else {
1158         return (0);
1159     }
1160 }
1161
1162 stg_newMVarzh ()
1163 {
1164     W_ mvar;
1165
1166     ALLOC_PRIM_ (SIZEOF_StgMVar, stg_newMVarzh);
1167
1168     mvar = Hp - SIZEOF_StgMVar + WDS(1);
1169     SET_HDR(mvar,stg_MVAR_DIRTY_info,CCCS);
1170         // MVARs start dirty: generation 0 has no mutable list
1171     StgMVar_head(mvar)  = stg_END_TSO_QUEUE_closure;
1172     StgMVar_tail(mvar)  = stg_END_TSO_QUEUE_closure;
1173     StgMVar_value(mvar) = stg_END_TSO_QUEUE_closure;
1174     return (mvar);
1175 }
1176
1177
1178 #define PerformTake(stack, value)               \
1179     W_ sp;                                      \
1180     sp = StgStack_sp(stack);                    \
1181     W_[sp + WDS(1)] = value;                    \
1182     W_[sp + WDS(0)] = stg_ret_p_info;
1183
1184 #define PerformPut(stack,lval)                  \
1185     W_ sp;                                      \
1186     sp = StgStack_sp(stack) + WDS(3);           \
1187     StgStack_sp(stack) = sp;                    \
1188     lval = W_[sp - WDS(1)];
1189
1190
1191 stg_takeMVarzh ( P_ mvar /* :: MVar a */ )
1192 {
1193     W_ val, info, tso, q;
1194
1195 #if defined(THREADED_RTS)
1196     ("ptr" info) = ccall lockClosure(mvar "ptr");
1197 #else
1198     info = GET_INFO(mvar);
1199 #endif
1200
1201     /* If the MVar is empty, put ourselves on its blocking queue,
1202      * and wait until we're woken up.
1203      */
1204     if (StgMVar_value(mvar) == stg_END_TSO_QUEUE_closure) {
1205         if (info == stg_MVAR_CLEAN_info) {
1206             ccall dirty_MVAR(BaseReg "ptr", mvar "ptr");
1207         }
1208
1209         // We want to put the heap check down here in the slow path,
1210         // but be careful to unlock the closure before returning to
1211         // the RTS if the check fails.
1212         ALLOC_PRIM_WITH_CUSTOM_FAILURE
1213             (SIZEOF_StgMVarTSOQueue,
1214              unlockClosure(mvar, stg_MVAR_DIRTY_info);
1215              GC_PRIM_P(stg_takeMVarzh, mvar));
1216
1217         q = Hp - SIZEOF_StgMVarTSOQueue + WDS(1);
1218
1219         SET_HDR(q, stg_MVAR_TSO_QUEUE_info, CCS_SYSTEM);
1220         StgMVarTSOQueue_link(q) = END_TSO_QUEUE;
1221         StgMVarTSOQueue_tso(q)  = CurrentTSO;
1222
1223         if (StgMVar_head(mvar) == stg_END_TSO_QUEUE_closure) {
1224             StgMVar_head(mvar) = q;
1225         } else {
1226             StgMVarTSOQueue_link(StgMVar_tail(mvar)) = q;
1227             ccall recordClosureMutated(MyCapability() "ptr",
1228                                              StgMVar_tail(mvar));
1229         }
1230         StgTSO__link(CurrentTSO)       = q;
1231         StgTSO_block_info(CurrentTSO)  = mvar;
1232         StgTSO_why_blocked(CurrentTSO) = BlockedOnMVar::I16;
1233         StgMVar_tail(mvar)             = q;
1234
1235         jump stg_block_takemvar(mvar);
1236     }
1237
1238     /* we got the value... */
1239     val = StgMVar_value(mvar);
1240
1241     q = StgMVar_head(mvar);
1242 loop:
1243     if (q == stg_END_TSO_QUEUE_closure) {
1244         /* No further putMVars, MVar is now empty */
1245         StgMVar_value(mvar) = stg_END_TSO_QUEUE_closure;
1246         // If the MVar is not already dirty, then we don't need to make
1247         // it dirty, as it is empty with nothing blocking on it.
1248         unlockClosure(mvar, info);
1249         return (val);
1250     }
1251     if (StgHeader_info(q) == stg_IND_info ||
1252         StgHeader_info(q) == stg_MSG_NULL_info) {
1253         q = StgInd_indirectee(q);
1254         goto loop;
1255     }
1256
1257     // There are putMVar(s) waiting... wake up the first thread on the queue
1258
1259     if (info == stg_MVAR_CLEAN_info) {
1260         ccall dirty_MVAR(BaseReg "ptr", mvar "ptr");
1261     }
1262
1263     tso = StgMVarTSOQueue_tso(q);
1264     StgMVar_head(mvar) = StgMVarTSOQueue_link(q);
1265     if (StgMVar_head(mvar) == stg_END_TSO_QUEUE_closure) {
1266         StgMVar_tail(mvar) = stg_END_TSO_QUEUE_closure;
1267     }
1268
1269     ASSERT(StgTSO_why_blocked(tso) == BlockedOnMVar::I16);
1270     ASSERT(StgTSO_block_info(tso) == mvar);
1271
1272     // actually perform the putMVar for the thread that we just woke up
1273     W_ stack;
1274     stack = StgTSO_stackobj(tso);
1275     PerformPut(stack, StgMVar_value(mvar));
1276
1277     // indicate that the MVar operation has now completed.
1278     StgTSO__link(tso) = stg_END_TSO_QUEUE_closure;
1279
1280     // no need to mark the TSO dirty, we have only written END_TSO_QUEUE.
1281
1282     ccall tryWakeupThread(MyCapability() "ptr", tso);
1283
1284     unlockClosure(mvar, stg_MVAR_DIRTY_info);
1285     return (val);
1286 }
1287
1288 stg_tryTakeMVarzh ( P_ mvar /* :: MVar a */ )
1289 {
1290     W_ val, info, tso, q;
1291
1292 #if defined(THREADED_RTS)
1293     ("ptr" info) = ccall lockClosure(mvar "ptr");
1294 #else
1295     info = GET_INFO(mvar);
1296 #endif
1297
1298     /* If the MVar is empty, return 0. */
1299     if (StgMVar_value(mvar) == stg_END_TSO_QUEUE_closure) {
1300 #if defined(THREADED_RTS)
1301         unlockClosure(mvar, info);
1302 #endif
1303         /* HACK: we need a pointer to pass back,
1304          * so we abuse NO_FINALIZER_closure
1305          */
1306         return (0, stg_NO_FINALIZER_closure);
1307     }
1308
1309     /* we got the value... */
1310     val = StgMVar_value(mvar);
1311
1312     q = StgMVar_head(mvar);
1313 loop:
1314     if (q == stg_END_TSO_QUEUE_closure) {
1315         /* No further putMVars, MVar is now empty */
1316         StgMVar_value(mvar) = stg_END_TSO_QUEUE_closure;
1317         unlockClosure(mvar, info);
1318         return (1, val);
1319     }
1320
1321     if (StgHeader_info(q) == stg_IND_info ||
1322         StgHeader_info(q) == stg_MSG_NULL_info) {
1323         q = StgInd_indirectee(q);
1324         goto loop;
1325     }
1326
1327     // There are putMVar(s) waiting... wake up the first thread on the queue
1328
1329     if (info == stg_MVAR_CLEAN_info) {
1330         ccall dirty_MVAR(BaseReg "ptr", mvar "ptr");
1331     }
1332
1333     tso = StgMVarTSOQueue_tso(q);
1334     StgMVar_head(mvar) = StgMVarTSOQueue_link(q);
1335     if (StgMVar_head(mvar) == stg_END_TSO_QUEUE_closure) {
1336         StgMVar_tail(mvar) = stg_END_TSO_QUEUE_closure;
1337     }
1338
1339     ASSERT(StgTSO_why_blocked(tso) == BlockedOnMVar::I16);
1340     ASSERT(StgTSO_block_info(tso) == mvar);
1341
1342     // actually perform the putMVar for the thread that we just woke up
1343     W_ stack;
1344     stack = StgTSO_stackobj(tso);
1345     PerformPut(stack, StgMVar_value(mvar));
1346
1347     // indicate that the MVar operation has now completed.
1348     StgTSO__link(tso) = stg_END_TSO_QUEUE_closure;
1349
1350     // no need to mark the TSO dirty, we have only written END_TSO_QUEUE.
1351
1352     ccall tryWakeupThread(MyCapability() "ptr", tso);
1353
1354     unlockClosure(mvar, stg_MVAR_DIRTY_info);
1355     return (1,val);
1356 }
1357
1358 stg_putMVarzh ( P_ mvar, /* :: MVar a */
1359                 P_ val,  /* :: a */ )
1360 {
1361     W_ info, tso, q;
1362
1363 #if defined(THREADED_RTS)
1364     ("ptr" info) = ccall lockClosure(mvar "ptr");
1365 #else
1366     info = GET_INFO(mvar);
1367 #endif
1368
1369     if (StgMVar_value(mvar) != stg_END_TSO_QUEUE_closure) {
1370
1371         if (info == stg_MVAR_CLEAN_info) {
1372             ccall dirty_MVAR(BaseReg "ptr", mvar "ptr");
1373         }
1374
1375         // We want to put the heap check down here in the slow path,
1376         // but be careful to unlock the closure before returning to
1377         // the RTS if the check fails.
1378         ALLOC_PRIM_WITH_CUSTOM_FAILURE
1379             (SIZEOF_StgMVarTSOQueue,
1380              unlockClosure(mvar, stg_MVAR_DIRTY_info);
1381              GC_PRIM_PP(stg_putMVarzh, mvar, val));
1382
1383         q = Hp - SIZEOF_StgMVarTSOQueue + WDS(1);
1384
1385         SET_HDR(q, stg_MVAR_TSO_QUEUE_info, CCS_SYSTEM);
1386         StgMVarTSOQueue_link(q) = END_TSO_QUEUE;
1387         StgMVarTSOQueue_tso(q)  = CurrentTSO;
1388
1389         if (StgMVar_head(mvar) == stg_END_TSO_QUEUE_closure) {
1390             StgMVar_head(mvar) = q;
1391         } else {
1392             StgMVarTSOQueue_link(StgMVar_tail(mvar)) = q;
1393             ccall recordClosureMutated(MyCapability() "ptr",
1394                                              StgMVar_tail(mvar));
1395         }
1396         StgTSO__link(CurrentTSO)       = q;
1397         StgTSO_block_info(CurrentTSO)  = mvar;
1398         StgTSO_why_blocked(CurrentTSO) = BlockedOnMVar::I16;
1399         StgMVar_tail(mvar)             = q;
1400
1401         jump stg_block_putmvar(mvar,val);
1402     }
1403
1404     q = StgMVar_head(mvar);
1405 loop:
1406     if (q == stg_END_TSO_QUEUE_closure) {
1407         /* No further takes, the MVar is now full. */
1408         if (info == stg_MVAR_CLEAN_info) {
1409             ccall dirty_MVAR(BaseReg "ptr", mvar "ptr");
1410         }
1411         StgMVar_value(mvar) = val;
1412         unlockClosure(mvar, stg_MVAR_DIRTY_info);
1413         return ();
1414     }
1415     if (StgHeader_info(q) == stg_IND_info ||
1416         StgHeader_info(q) == stg_MSG_NULL_info) {
1417         q = StgInd_indirectee(q);
1418         goto loop;
1419     }
1420
1421     // There are takeMVar(s) waiting: wake up the first one
1422
1423     tso = StgMVarTSOQueue_tso(q);
1424     StgMVar_head(mvar) = StgMVarTSOQueue_link(q);
1425     if (StgMVar_head(mvar) == stg_END_TSO_QUEUE_closure) {
1426         StgMVar_tail(mvar) = stg_END_TSO_QUEUE_closure;
1427     }
1428
1429     ASSERT(StgTSO_why_blocked(tso) == BlockedOnMVar::I16);
1430     ASSERT(StgTSO_block_info(tso) == mvar);
1431
1432     // actually perform the takeMVar
1433     W_ stack;
1434     stack = StgTSO_stackobj(tso);
1435     PerformTake(stack, val);
1436
1437     // indicate that the MVar operation has now completed.
1438     StgTSO__link(tso) = stg_END_TSO_QUEUE_closure;
1439
1440     if (TO_W_(StgStack_dirty(stack)) == 0) {
1441         ccall dirty_STACK(MyCapability() "ptr", stack "ptr");
1442     }
1443
1444     ccall tryWakeupThread(MyCapability() "ptr", tso);
1445
1446     unlockClosure(mvar, info);
1447     return ();
1448 }
1449
1450
1451 stg_tryPutMVarzh ( P_ mvar, /* :: MVar a */
1452                    P_ val,  /* :: a */ )
1453 {
1454     W_ info, tso, q;
1455
1456 #if defined(THREADED_RTS)
1457     ("ptr" info) = ccall lockClosure(mvar "ptr");
1458 #else
1459     info = GET_INFO(mvar);
1460 #endif
1461
1462     if (StgMVar_value(mvar) != stg_END_TSO_QUEUE_closure) {
1463 #if defined(THREADED_RTS)
1464         unlockClosure(mvar, info);
1465 #endif
1466         return (0);
1467     }
1468
1469     q = StgMVar_head(mvar);
1470 loop:
1471     if (q == stg_END_TSO_QUEUE_closure) {
1472         /* No further takes, the MVar is now full. */
1473         if (info == stg_MVAR_CLEAN_info) {
1474             ccall dirty_MVAR(BaseReg "ptr", mvar "ptr");
1475         }
1476
1477         StgMVar_value(mvar) = val;
1478         unlockClosure(mvar, stg_MVAR_DIRTY_info);
1479         return (1);
1480     }
1481     if (StgHeader_info(q) == stg_IND_info ||
1482         StgHeader_info(q) == stg_MSG_NULL_info) {
1483         q = StgInd_indirectee(q);
1484         goto loop;
1485     }
1486
1487     // There are takeMVar(s) waiting: wake up the first one
1488
1489     tso = StgMVarTSOQueue_tso(q);
1490     StgMVar_head(mvar) = StgMVarTSOQueue_link(q);
1491     if (StgMVar_head(mvar) == stg_END_TSO_QUEUE_closure) {
1492         StgMVar_tail(mvar) = stg_END_TSO_QUEUE_closure;
1493     }
1494
1495     ASSERT(StgTSO_why_blocked(tso) == BlockedOnMVar::I16);
1496     ASSERT(StgTSO_block_info(tso) == mvar);
1497
1498     // actually perform the takeMVar
1499     W_ stack;
1500     stack = StgTSO_stackobj(tso);
1501     PerformTake(stack, val);
1502
1503     // indicate that the MVar operation has now completed.
1504     StgTSO__link(tso) = stg_END_TSO_QUEUE_closure;
1505
1506     if (TO_W_(StgStack_dirty(stack)) == 0) {
1507         ccall dirty_STACK(MyCapability() "ptr", stack "ptr");
1508     }
1509
1510     ccall tryWakeupThread(MyCapability() "ptr", tso);
1511
1512     unlockClosure(mvar, info);
1513     return (1);
1514 }
1515
1516
1517 /* -----------------------------------------------------------------------------
1518    Stable pointer primitives
1519    -------------------------------------------------------------------------  */
1520
1521 stg_makeStableNamezh ( P_ obj )
1522 {
1523     W_ index, sn_obj;
1524
1525     (index) = ccall lookupStableName(obj "ptr");
1526
1527     /* Is there already a StableName for this heap object?
1528      *  stable_name_table is a pointer to an array of snEntry structs.
1529      */
1530     if ( snEntry_sn_obj(W_[stable_name_table] + index*SIZEOF_snEntry) == NULL ) {
1531         ALLOC_PRIM (SIZEOF_StgStableName);
1532         sn_obj = Hp - SIZEOF_StgStableName + WDS(1);
1533         SET_HDR(sn_obj, stg_STABLE_NAME_info, CCCS);
1534         StgStableName_sn(sn_obj) = index;
1535         snEntry_sn_obj(W_[stable_name_table] + index*SIZEOF_snEntry) = sn_obj;
1536     } else {
1537         sn_obj = snEntry_sn_obj(W_[stable_name_table] + index*SIZEOF_snEntry);
1538     }
1539
1540     return (sn_obj);
1541 }
1542
1543 stg_makeStablePtrzh ( P_ obj )
1544 {
1545     W_ sp;
1546
1547     ("ptr" sp) = ccall getStablePtr(obj "ptr");
1548     return (sp);
1549 }
1550
1551 stg_deRefStablePtrzh ( P_ sp )
1552 {
1553     W_ r;
1554     r = spEntry_addr(W_[stable_ptr_table] + sp*SIZEOF_spEntry);
1555     return (r);
1556 }
1557
1558 /* -----------------------------------------------------------------------------
1559    Bytecode object primitives
1560    -------------------------------------------------------------------------  */
1561
1562 stg_newBCOzh ( P_ instrs,
1563                P_ literals,
1564                P_ ptrs,
1565                W_ arity,
1566                P_ bitmap_arr )
1567 {
1568     W_ bco, bytes, words;
1569
1570     words = BYTES_TO_WDS(SIZEOF_StgBCO) + BYTE_ARR_WDS(bitmap_arr);
1571     bytes = WDS(words);
1572
1573     ALLOC_PRIM (bytes);
1574
1575     bco = Hp - bytes + WDS(1);
1576     SET_HDR(bco, stg_BCO_info, CCCS);
1577
1578     StgBCO_instrs(bco)     = instrs;
1579     StgBCO_literals(bco)   = literals;
1580     StgBCO_ptrs(bco)       = ptrs;
1581     StgBCO_arity(bco)      = HALF_W_(arity);
1582     StgBCO_size(bco)       = HALF_W_(words);
1583
1584     // Copy the arity/bitmap info into the BCO
1585     W_ i;
1586     i = 0;
1587 for:
1588     if (i < BYTE_ARR_WDS(bitmap_arr)) {
1589         StgBCO_bitmap(bco,i) = StgArrWords_payload(bitmap_arr,i);
1590         i = i + 1;
1591         goto for;
1592     }
1593
1594     return (bco);
1595 }
1596
1597 stg_mkApUpd0zh ( P_ bco )
1598 {
1599     W_ ap;
1600
1601     // This function is *only* used to wrap zero-arity BCOs in an
1602     // updatable wrapper (see ByteCodeLink.lhs).  An AP thunk is always
1603     // saturated and always points directly to a FUN or BCO.
1604     ASSERT(%INFO_TYPE(%GET_STD_INFO(bco)) == HALF_W_(BCO) &&
1605            StgBCO_arity(bco) == HALF_W_(0));
1606
1607     HP_CHK_P(SIZEOF_StgAP, stg_mkApUpd0zh, bco);
1608     TICK_ALLOC_UP_THK(0, 0);
1609     CCCS_ALLOC(SIZEOF_StgAP);
1610
1611     ap = Hp - SIZEOF_StgAP + WDS(1);
1612     SET_HDR(ap, stg_AP_info, CCCS);
1613
1614     StgAP_n_args(ap) = HALF_W_(0);
1615     StgAP_fun(ap) = bco;
1616
1617     return (ap);
1618 }
1619
1620 stg_unpackClosurezh ( P_ closure )
1621 {
1622 // TODO: Consider the absence of ptrs or nonptrs as a special case ?
1623
1624     W_ info, ptrs, nptrs, p, ptrs_arr, nptrs_arr;
1625     info  = %GET_STD_INFO(UNTAG(closure));
1626
1627     // Some closures have non-standard layout, so we omit those here.
1628     W_ type;
1629     type = TO_W_(%INFO_TYPE(info));
1630     switch [0 .. N_CLOSURE_TYPES] type {
1631     case THUNK_SELECTOR : {
1632         ptrs = 1;
1633         nptrs = 0;
1634         goto out;
1635     }
1636     case THUNK, THUNK_1_0, THUNK_0_1, THUNK_2_0, THUNK_1_1,
1637          THUNK_0_2, THUNK_STATIC, AP, PAP, AP_STACK, BCO : {
1638         ptrs = 0;
1639         nptrs = 0;
1640         goto out;
1641     }
1642     default: {
1643         ptrs  = TO_W_(%INFO_PTRS(info));
1644         nptrs = TO_W_(%INFO_NPTRS(info));
1645         goto out;
1646     }}
1647 out:
1648
1649     W_ ptrs_arr_sz, ptrs_arr_cards, nptrs_arr_sz;
1650     nptrs_arr_sz = SIZEOF_StgArrWords   + WDS(nptrs);
1651     ptrs_arr_cards = mutArrPtrsCardWords(ptrs);
1652     ptrs_arr_sz  = SIZEOF_StgMutArrPtrs + WDS(ptrs) + WDS(ptrs_arr_cards);
1653
1654     ALLOC_PRIM_P (ptrs_arr_sz + nptrs_arr_sz, stg_unpackClosurezh, closure);
1655
1656     W_ clos;
1657     clos = UNTAG(closure);
1658
1659     ptrs_arr  = Hp - nptrs_arr_sz - ptrs_arr_sz + WDS(1);
1660     nptrs_arr = Hp - nptrs_arr_sz + WDS(1);
1661
1662     SET_HDR(ptrs_arr, stg_MUT_ARR_PTRS_FROZEN_info, CCCS);
1663     StgMutArrPtrs_ptrs(ptrs_arr) = ptrs;
1664     StgMutArrPtrs_size(ptrs_arr) = ptrs + ptrs_arr_cards;
1665
1666     p = 0;
1667 for:
1668     if(p < ptrs) {
1669          W_[ptrs_arr + SIZEOF_StgMutArrPtrs + WDS(p)] = StgClosure_payload(clos,p);
1670          p = p + 1;
1671          goto for;
1672     }
1673     /* We can leave the card table uninitialised, since the array is
1674        allocated in the nursery.  The GC will fill it in if/when the array
1675        is promoted. */
1676
1677     SET_HDR(nptrs_arr, stg_ARR_WORDS_info, CCCS);
1678     StgArrWords_bytes(nptrs_arr) = WDS(nptrs);
1679     p = 0;
1680 for2:
1681     if(p < nptrs) {
1682          W_[BYTE_ARR_CTS(nptrs_arr) + WDS(p)] = StgClosure_payload(clos, p+ptrs);
1683          p = p + 1;
1684          goto for2;
1685     }
1686     return (info, ptrs_arr, nptrs_arr);
1687 }
1688
1689 /* -----------------------------------------------------------------------------
1690    Thread I/O blocking primitives
1691    -------------------------------------------------------------------------- */
1692
1693 /* Add a thread to the end of the blocked queue. (C-- version of the C
1694  * macro in Schedule.h).
1695  */
1696 #define APPEND_TO_BLOCKED_QUEUE(tso)                    \
1697     ASSERT(StgTSO__link(tso) == END_TSO_QUEUE);         \
1698     if (W_[blocked_queue_hd] == END_TSO_QUEUE) {        \
1699       W_[blocked_queue_hd] = tso;                       \
1700     } else {                                            \
1701       ccall setTSOLink(MyCapability() "ptr", W_[blocked_queue_tl] "ptr", tso); \
1702     }                                                   \
1703     W_[blocked_queue_tl] = tso;
1704
1705 stg_waitReadzh ( W_ fd )
1706 {
1707 #ifdef THREADED_RTS
1708     ccall barf("waitRead# on threaded RTS") never returns;
1709 #else
1710
1711     ASSERT(StgTSO_why_blocked(CurrentTSO) == NotBlocked::I16);
1712     StgTSO_why_blocked(CurrentTSO) = BlockedOnRead::I16;
1713     StgTSO_block_info(CurrentTSO) = fd;
1714     // No locking - we're not going to use this interface in the
1715     // threaded RTS anyway.
1716     APPEND_TO_BLOCKED_QUEUE(CurrentTSO);
1717     jump stg_block_noregs();
1718 #endif
1719 }
1720
1721 stg_waitWritezh ( W_ fd )
1722 {
1723 #ifdef THREADED_RTS
1724     ccall barf("waitWrite# on threaded RTS") never returns;
1725 #else
1726
1727     ASSERT(StgTSO_why_blocked(CurrentTSO) == NotBlocked::I16);
1728     StgTSO_why_blocked(CurrentTSO) = BlockedOnWrite::I16;
1729     StgTSO_block_info(CurrentTSO) = fd;
1730     // No locking - we're not going to use this interface in the
1731     // threaded RTS anyway.
1732     APPEND_TO_BLOCKED_QUEUE(CurrentTSO);
1733     jump stg_block_noregs();
1734 #endif
1735 }
1736
1737
1738 STRING(stg_delayzh_malloc_str, "stg_delayzh")
1739 stg_delayzh ( W_ us_delay )
1740 {
1741 #ifdef mingw32_HOST_OS
1742     W_ ares;
1743     CInt reqID;
1744 #else
1745     W_ t, prev, target;
1746 #endif
1747
1748 #ifdef THREADED_RTS
1749     ccall barf("delay# on threaded RTS") never returns;
1750 #else
1751
1752     ASSERT(StgTSO_why_blocked(CurrentTSO) == NotBlocked::I16);
1753     StgTSO_why_blocked(CurrentTSO) = BlockedOnDelay::I16;
1754
1755 #ifdef mingw32_HOST_OS
1756
1757     /* could probably allocate this on the heap instead */
1758     ("ptr" ares) = ccall stgMallocBytes(SIZEOF_StgAsyncIOResult,
1759                                         stg_delayzh_malloc_str);
1760     (reqID) = ccall addDelayRequest(us_delay);
1761     StgAsyncIOResult_reqID(ares)   = reqID;
1762     StgAsyncIOResult_len(ares)     = 0;
1763     StgAsyncIOResult_errCode(ares) = 0;
1764     StgTSO_block_info(CurrentTSO)  = ares;
1765
1766     /* Having all async-blocked threads reside on the blocked_queue
1767      * simplifies matters, so change the status to OnDoProc put the
1768      * delayed thread on the blocked_queue.
1769      */
1770     StgTSO_why_blocked(CurrentTSO) = BlockedOnDoProc::I16;
1771     APPEND_TO_BLOCKED_QUEUE(CurrentTSO);
1772     jump stg_block_async_void();
1773
1774 #else
1775
1776
1777     (target) = ccall getDelayTarget(us_delay);
1778
1779     StgTSO_block_info(CurrentTSO) = target;
1780
1781     /* Insert the new thread in the sleeping queue. */
1782     prev = NULL;
1783     t = W_[sleeping_queue];
1784 while:
1785     if (t != END_TSO_QUEUE && StgTSO_block_info(t) < target) {
1786         prev = t;
1787         t = StgTSO__link(t);
1788         goto while;
1789     }
1790
1791     StgTSO__link(CurrentTSO) = t;
1792     if (prev == NULL) {
1793         W_[sleeping_queue] = CurrentTSO;
1794     } else {
1795         ccall setTSOLink(MyCapability() "ptr", prev "ptr", CurrentTSO);
1796     }
1797     jump stg_block_noregs();
1798 #endif
1799 #endif /* !THREADED_RTS */
1800 }
1801
1802
1803 #ifdef mingw32_HOST_OS
1804 STRING(stg_asyncReadzh_malloc_str, "stg_asyncReadzh")
1805 stg_asyncReadzh ( W_ fd, W_ is_sock, W_ len, W_ buf )
1806 {
1807     W_ ares;
1808     CInt reqID;
1809
1810 #ifdef THREADED_RTS
1811     ccall barf("asyncRead# on threaded RTS") never returns;
1812 #else
1813
1814     ASSERT(StgTSO_why_blocked(CurrentTSO) == NotBlocked::I16);
1815     StgTSO_why_blocked(CurrentTSO) = BlockedOnRead::I16;
1816
1817     /* could probably allocate this on the heap instead */
1818     ("ptr" ares) = ccall stgMallocBytes(SIZEOF_StgAsyncIOResult,
1819                                         stg_asyncReadzh_malloc_str);
1820     (reqID) = ccall addIORequest(fd, 0/*FALSE*/,is_sock,len,buf "ptr");
1821     StgAsyncIOResult_reqID(ares)   = reqID;
1822     StgAsyncIOResult_len(ares)     = 0;
1823     StgAsyncIOResult_errCode(ares) = 0;
1824     StgTSO_block_info(CurrentTSO)  = ares;
1825     APPEND_TO_BLOCKED_QUEUE(CurrentTSO);
1826     jump stg_block_async();
1827 #endif
1828 }
1829
1830 STRING(stg_asyncWritezh_malloc_str, "stg_asyncWritezh")
1831 stg_asyncWritezh ( W_ fd, W_ is_sock, W_ len, W_ buf )
1832 {
1833     W_ ares;
1834     CInt reqID;
1835
1836 #ifdef THREADED_RTS
1837     ccall barf("asyncWrite# on threaded RTS") never returns;
1838 #else
1839
1840     ASSERT(StgTSO_why_blocked(CurrentTSO) == NotBlocked::I16);
1841     StgTSO_why_blocked(CurrentTSO) = BlockedOnWrite::I16;
1842
1843     ("ptr" ares) = ccall stgMallocBytes(SIZEOF_StgAsyncIOResult,
1844                                         stg_asyncWritezh_malloc_str);
1845     (reqID) = ccall addIORequest(fd, 1/*TRUE*/,is_sock,len,buf "ptr");
1846
1847     StgAsyncIOResult_reqID(ares)   = reqID;
1848     StgAsyncIOResult_len(ares)     = 0;
1849     StgAsyncIOResult_errCode(ares) = 0;
1850     StgTSO_block_info(CurrentTSO)  = ares;
1851     APPEND_TO_BLOCKED_QUEUE(CurrentTSO);
1852     jump stg_block_async();
1853 #endif
1854 }
1855
1856 STRING(stg_asyncDoProczh_malloc_str, "stg_asyncDoProczh")
1857 stg_asyncDoProczh ( W_ proc, W_ param )
1858 {
1859     W_ ares;
1860     CInt reqID;
1861
1862 #ifdef THREADED_RTS
1863     ccall barf("asyncDoProc# on threaded RTS") never returns;
1864 #else
1865
1866     ASSERT(StgTSO_why_blocked(CurrentTSO) == NotBlocked::I16);
1867     StgTSO_why_blocked(CurrentTSO) = BlockedOnDoProc::I16;
1868
1869     /* could probably allocate this on the heap instead */
1870     ("ptr" ares) = ccall stgMallocBytes(SIZEOF_StgAsyncIOResult,
1871                                         stg_asyncDoProczh_malloc_str);
1872     (reqID) = ccall addDoProcRequest(proc "ptr",param "ptr");
1873     StgAsyncIOResult_reqID(ares)   = reqID;
1874     StgAsyncIOResult_len(ares)     = 0;
1875     StgAsyncIOResult_errCode(ares) = 0;
1876     StgTSO_block_info(CurrentTSO) = ares;
1877     APPEND_TO_BLOCKED_QUEUE(CurrentTSO);
1878     jump stg_block_async();
1879 #endif
1880 }
1881 #endif
1882
1883 /* -----------------------------------------------------------------------------
1884  * noDuplicate#
1885  *
1886  * noDuplicate# tries to ensure that none of the thunks under
1887  * evaluation by the current thread are also under evaluation by
1888  * another thread.  It relies on *both* threads doing noDuplicate#;
1889  * the second one will get blocked if they are duplicating some work.
1890  *
1891  * The idea is that noDuplicate# is used within unsafePerformIO to
1892  * ensure that the IO operation is performed at most once.
1893  * noDuplicate# calls threadPaused which acquires an exclusive lock on
1894  * all the thunks currently under evaluation by the current thread.
1895  *
1896  * Consider the following scenario.  There is a thunk A, whose
1897  * evaluation requires evaluating thunk B, where thunk B is an
1898  * unsafePerformIO.  Two threads, 1 and 2, bother enter A.  Thread 2
1899  * is pre-empted before it enters B, and claims A by blackholing it
1900  * (in threadPaused).  Thread 1 now enters B, and calls noDuplicate#.
1901  *
1902  *      thread 1                      thread 2
1903  *   +-----------+                 +---------------+
1904  *   |    -------+-----> A <-------+-------        |
1905  *   |  update   |   BLACKHOLE     | marked_update |
1906  *   +-----------+                 +---------------+
1907  *   |           |                 |               |
1908  *        ...                             ...
1909  *   |           |                 +---------------+
1910  *   +-----------+
1911  *   |     ------+-----> B
1912  *   |  update   |   BLACKHOLE
1913  *   +-----------+
1914  *
1915  * At this point: A is a blackhole, owned by thread 2.  noDuplicate#
1916  * calls threadPaused, which walks up the stack and
1917  *  - claims B on behalf of thread 1
1918  *  - then it reaches the update frame for A, which it sees is already
1919  *    a BLACKHOLE and is therefore owned by another thread.  Since
1920  *    thread 1 is duplicating work, the computation up to the update
1921  *    frame for A is suspended, including thunk B.
1922  *  - thunk B, which is an unsafePerformIO, has now been reverted to
1923  *    an AP_STACK which could be duplicated - BAD!
1924  *  - The solution is as follows: before calling threadPaused, we
1925  *    leave a frame on the stack (stg_noDuplicate_info) that will call
1926  *    noDuplicate# again if the current computation is suspended and
1927  *    restarted.
1928  *
1929  * See the test program in concurrent/prog003 for a way to demonstrate
1930  * this.  It needs to be run with +RTS -N3 or greater, and the bug
1931  * only manifests occasionally (once very 10 runs or so).
1932  * -------------------------------------------------------------------------- */
1933
1934 INFO_TABLE_RET(stg_noDuplicate, RET_SMALL, W_ info_ptr)
1935     return (/* no return values */)
1936 {
1937     jump stg_noDuplicatezh();
1938 }
1939
1940 stg_noDuplicatezh /* no arg list: explicit stack layout */
1941 {
1942     STK_CHK(WDS(1), stg_noDuplicatezh);
1943
1944     // leave noDuplicate frame in case the current
1945     // computation is suspended and restarted (see above).
1946     Sp_adj(-1);
1947     Sp(0) = stg_noDuplicate_info;
1948
1949     SAVE_THREAD_STATE();
1950     ASSERT(StgTSO_what_next(CurrentTSO) == ThreadRunGHC::I16);
1951     ccall threadPaused (MyCapability() "ptr", CurrentTSO "ptr");
1952
1953     if (StgTSO_what_next(CurrentTSO) == ThreadKilled::I16) {
1954         jump stg_threadFinished [];
1955     } else {
1956         LOAD_THREAD_STATE();
1957         ASSERT(StgTSO_what_next(CurrentTSO) == ThreadRunGHC::I16);
1958         // remove the stg_noDuplicate frame if it is still there.
1959         if (Sp(0) == stg_noDuplicate_info) {
1960             Sp_adj(1);
1961         }
1962         jump %ENTRY_CODE(Sp(0)) [];
1963     }
1964 }
1965
1966 /* -----------------------------------------------------------------------------
1967    Misc. primitives
1968    -------------------------------------------------------------------------- */
1969
1970 stg_getApStackValzh ( P_ ap_stack, W_ offset )
1971 {
1972    if (%INFO_PTR(ap_stack) == stg_AP_STACK_info) {
1973        return (1,StgAP_STACK_payload(ap_stack,offset));
1974    } else {
1975        return (0,ap_stack);
1976    }
1977 }
1978
1979 // Write the cost center stack of the first argument on stderr; return
1980 // the second.  Possibly only makes sense for already evaluated
1981 // things?
1982 stg_traceCcszh ( P_ obj, P_ ret )
1983 {
1984     W_ ccs;
1985
1986 #ifdef PROFILING
1987     ccs = StgHeader_ccs(UNTAG(obj));
1988     ccall fprintCCS_stderr(ccs "ptr");
1989 #endif
1990
1991     jump stg_ap_0_fast(ret);
1992 }
1993
1994 stg_getSparkzh ()
1995 {
1996    W_ spark;
1997
1998 #ifndef THREADED_RTS
1999    return (0,ghczmprim_GHCziTypes_False_closure);
2000 #else
2001    (spark) = ccall findSpark(MyCapability());
2002    if (spark != 0) {
2003       return (1,spark);
2004    } else {
2005       return (0,ghczmprim_GHCziTypes_False_closure);
2006    }
2007 #endif
2008 }
2009
2010 stg_numSparkszh ()
2011 {
2012   W_ n;
2013 #ifdef THREADED_RTS
2014   (n) = ccall dequeElements(Capability_sparks(MyCapability()));
2015 #else
2016   n = 0;
2017 #endif
2018   return (n);
2019 }
2020
2021 stg_traceEventzh ( W_ msg )
2022 {
2023 #if defined(TRACING) || defined(DEBUG)
2024
2025    ccall traceUserMsg(MyCapability() "ptr", msg "ptr");
2026
2027 #elif defined(DTRACE)
2028
2029    W_ enabled;
2030
2031    // We should go through the macro HASKELLEVENT_USER_MSG_ENABLED from
2032    // RtsProbes.h, but that header file includes unistd.h, which doesn't
2033    // work in Cmm
2034 #if !defined(solaris2_TARGET_OS)
2035    (enabled) = ccall __dtrace_isenabled$HaskellEvent$user__msg$v1();
2036 #else
2037    // Solaris' DTrace can't handle the
2038    //     __dtrace_isenabled$HaskellEvent$user__msg$v1
2039    // call above. This call is just for testing whether the user__msg
2040    // probe is enabled, and is here for just performance optimization.
2041    // Since preparation for the probe is not that complex I disable usage of
2042    // this test above for Solaris and enable the probe usage manually
2043    // here. Please note that this does not mean that the probe will be
2044    // used during the runtime! You still need to enable it by consumption
2045    // in your dtrace script as you do with any other probe.
2046    enabled = 1;
2047 #endif
2048    if (enabled != 0) {
2049      ccall dtraceUserMsgWrapper(MyCapability() "ptr", msg "ptr");
2050    }
2051
2052 #endif
2053    return ();
2054 }
2055
2056 // Same code as stg_traceEventzh above but a different kind of event
2057 // Before changing this code, read the comments in the impl above
2058 stg_traceMarkerzh ( W_ msg )
2059 {
2060 #if defined(TRACING) || defined(DEBUG)
2061
2062    ccall traceUserMarker(MyCapability() "ptr", msg "ptr");
2063
2064 #elif defined(DTRACE)
2065
2066    W_ enabled;
2067
2068 #if !defined(solaris2_TARGET_OS)
2069    (enabled) = ccall __dtrace_isenabled$HaskellEvent$user__marker$v1();
2070 #else
2071    enabled = 1;
2072 #endif
2073    if (enabled != 0) {
2074      ccall dtraceUserMarkerWrapper(MyCapability() "ptr", msg "ptr");
2075    }
2076
2077 #endif
2078    return ();
2079 }
2080