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