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