PrimOps.cmm 67.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
/* -----------------------------------------------------------------------------
 *
 * (c) The GHC Team, 1998-2004
 *
 * Out-of-line primitive operations
 *
 * This file contains the implementations of all the primitive
 * operations ("primops") which are not expanded inline.  See
 * ghc/compiler/prelude/primops.txt.pp for a list of all the primops;
 * this file contains code for most of those with the attribute
 * out_of_line=True.
 *
 * Entry convention: the entry convention for a primop is that all the
 * args are in Stg registers (R1, R2, etc.).  This is to make writing
 * the primops easier.  (see compiler/codeGen/CgCallConv.hs).
 *
 * Return convention: results from a primop are generally returned
 * using the ordinary unboxed tuple return convention.  The C-- parser
 * implements the RET_xxxx() macros to perform unboxed-tuple returns
 * based on the prevailing return convention.
 *
 * This file is written in a subset of C--, extended with various
 * features specific to GHC.  It is compiled by GHC directly.  For the
 * syntax of .cmm files, see the parser in ghc/compiler/cmm/CmmParse.y.
 *
 * ---------------------------------------------------------------------------*/

#include "Cmm.h"

30
#ifdef __PIC__
31
#ifndef mingw32_HOST_OS
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
import __gmpz_init;
import __gmpz_add;
import __gmpz_sub;
import __gmpz_mul;
import __gmpz_gcd;
import __gmpn_gcd_1;
import __gmpn_cmp;
import __gmpz_tdiv_q;
import __gmpz_tdiv_r;
import __gmpz_tdiv_qr;
import __gmpz_fdiv_qr;
import __gmpz_divexact;
import __gmpz_and;
import __gmpz_xor;
import __gmpz_ior;
import __gmpz_com;
48
#endif
49
50
import pthread_mutex_lock;
import pthread_mutex_unlock;
51
#endif
52
import base_ControlziExceptionziBase_nestedAtomically_closure;
53
54
import EnterCriticalSection;
import LeaveCriticalSection;
55
import ghczmprim_GHCziBool_False_closure;
56

57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*-----------------------------------------------------------------------------
  Array Primitives

  Basically just new*Array - the others are all inline macros.

  The size arg is always passed in R1, and the result returned in R1.

  The slow entry point is for returning from a heap check, the saved
  size argument must be re-loaded from the stack.
  -------------------------------------------------------------------------- */

/* for objects that are *less* than the size of a word, make sure we
 * round up to the nearest word for the size of the array.
 */

newByteArrayzh_fast
{
    W_ words, payload_words, n, p;
    MAYBE_GC(NO_PTRS,newByteArrayzh_fast);
    n = R1;
    payload_words = ROUNDUP_BYTES_TO_WDS(n);
    words = BYTES_TO_WDS(SIZEOF_StgArrWords) + payload_words;
79
    ("ptr" p) = foreign "C" allocateLocal(MyCapability() "ptr",words) [];
80
81
82
83
84
85
    TICK_ALLOC_PRIM(SIZEOF_StgArrWords,WDS(payload_words),0);
    SET_HDR(p, stg_ARR_WORDS_info, W_[CCCS]);
    StgArrWords_words(p) = payload_words;
    RET_P(p);
}

Simon Marlow's avatar
Simon Marlow committed
86
87
88
#define BA_ALIGN 16
#define BA_MASK  (BA_ALIGN-1)

89
90
newPinnedByteArrayzh_fast
{
91
    W_ words, bytes, payload_words, p;
92
93

    MAYBE_GC(NO_PTRS,newPinnedByteArrayzh_fast);
94
95
96
97
98
99
100
101
102
103
104
    bytes = R1;
    /* payload_words is what we will tell the profiler we had to allocate */
    payload_words = ROUNDUP_BYTES_TO_WDS(bytes);
    /* When we actually allocate memory, we need to allow space for the
       header: */
    bytes = bytes + SIZEOF_StgArrWords;
    /* And we want to align to BA_ALIGN bytes, so we need to allow space
       to shift up to BA_ALIGN - 1 bytes: */
    bytes = bytes + BA_ALIGN - 1;
    /* Now we convert to a number of words: */
    words = ROUNDUP_BYTES_TO_WDS(bytes);
Simon Marlow's avatar
Simon Marlow committed
105
106
107
108

    ("ptr" p) = foreign "C" allocatePinned(words) [];
    TICK_ALLOC_PRIM(SIZEOF_StgArrWords,WDS(payload_words),0);

109
110
    /* Now we need to move p forward so that the payload is aligned
       to BA_ALIGN bytes: */
Simon Marlow's avatar
Simon Marlow committed
111
112
113
114
115
116
117
118
119
    p = p + ((-p - SIZEOF_StgArrWords) & BA_MASK);

    SET_HDR(p, stg_ARR_WORDS_info, W_[CCCS]);
    StgArrWords_words(p) = payload_words;
    RET_P(p);
}

newAlignedPinnedByteArrayzh_fast
{
120
    W_ words, bytes, payload_words, p, alignment;
Simon Marlow's avatar
Simon Marlow committed
121
122

    MAYBE_GC(NO_PTRS,newAlignedPinnedByteArrayzh_fast);
123
124
    bytes = R1;
    alignment = R2;
Simon Marlow's avatar
Simon Marlow committed
125

126
127
    /* payload_words is what we will tell the profiler we had to allocate */
    payload_words = ROUNDUP_BYTES_TO_WDS(bytes);
Simon Marlow's avatar
Simon Marlow committed
128

129
130
131
132
133
134
135
136
    /* When we actually allocate memory, we need to allow space for the
       header: */
    bytes = bytes + SIZEOF_StgArrWords;
    /* And we want to align to <alignment> bytes, so we need to allow space
       to shift up to <alignment - 1> bytes: */
    bytes = bytes + alignment - 1;
    /* Now we convert to a number of words: */
    words = ROUNDUP_BYTES_TO_WDS(bytes);
137

138
    ("ptr" p) = foreign "C" allocatePinned(words) [];
139
140
    TICK_ALLOC_PRIM(SIZEOF_StgArrWords,WDS(payload_words),0);

141
142
143
144
    /* Now we need to move p forward so that the payload is aligned
       to <alignment> bytes. Note that we are assuming that
       <alignment> is a power of 2, which is technically not guaranteed */
    p = p + ((-p - SIZEOF_StgArrWords) & (alignment - 1));
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

    SET_HDR(p, stg_ARR_WORDS_info, W_[CCCS]);
    StgArrWords_words(p) = payload_words;
    RET_P(p);
}

newArrayzh_fast
{
    W_ words, n, init, arr, p;
    /* Args: R1 = words, R2 = initialisation value */

    n = R1;
    MAYBE_GC(R2_PTR,newArrayzh_fast);

    words = BYTES_TO_WDS(SIZEOF_StgMutArrPtrs) + n;
160
    ("ptr" arr) = foreign "C" allocateLocal(MyCapability() "ptr",words) [R2];
161
162
    TICK_ALLOC_PRIM(SIZEOF_StgMutArrPtrs, WDS(n), 0);

163
    SET_HDR(arr, stg_MUT_ARR_PTRS_DIRTY_info, W_[CCCS]);
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
    StgMutArrPtrs_ptrs(arr) = n;

    // Initialise all elements of the the array with the value in R2
    init = R2;
    p = arr + SIZEOF_StgMutArrPtrs;
  for:
    if (p < arr + WDS(words)) {
	W_[p] = init;
	p = p + WDS(1);
	goto for;
    }

    RET_P(arr);
}

unsafeThawArrayzh_fast
{
  // SUBTLETY TO DO WITH THE OLD GEN MUTABLE LIST
  //
  // A MUT_ARR_PTRS lives on the mutable list, but a MUT_ARR_PTRS_FROZEN 
  // normally doesn't.  However, when we freeze a MUT_ARR_PTRS, we leave
  // it on the mutable list for the GC to remove (removing something from
  // the mutable list is not easy, because the mut_list is only singly-linked).
  // 
188
  // So that we can tell whether a MUT_ARR_PTRS_FROZEN is on the mutable list,
189
190
191
  // when we freeze it we set the info ptr to be MUT_ARR_PTRS_FROZEN0
  // to indicate that it is still on the mutable list.
  //
192
193
  // So, when we thaw a MUT_ARR_PTRS_FROZEN, we must cope with two cases:
  // either it is on a mut_list, or it isn't.  We adopt the convention that
194
  // the closure type is MUT_ARR_PTRS_FROZEN0 if it is on the mutable list,
195
196
197
  // and MUT_ARR_PTRS_FROZEN otherwise.  In fact it wouldn't matter if
  // we put it on the mutable list more than once, but it would get scavenged
  // multiple times during GC, which would be unnecessarily slow.
198
  //
199
  if (StgHeader_info(R1) != stg_MUT_ARR_PTRS_FROZEN0_info) {
200
	SET_INFO(R1,stg_MUT_ARR_PTRS_DIRTY_info);
201
	recordMutable(R1, R1);
202
203
204
	// must be done after SET_INFO, because it ASSERTs closure_MUTABLE()
	RET_P(R1);
  } else {
205
	SET_INFO(R1,stg_MUT_ARR_PTRS_DIRTY_info);
206
	RET_P(R1);
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
  }
}

/* -----------------------------------------------------------------------------
   MutVar primitives
   -------------------------------------------------------------------------- */

newMutVarzh_fast
{
    W_ mv;
    /* Args: R1 = initialisation value */

    ALLOC_PRIM( SIZEOF_StgMutVar, R1_PTR, newMutVarzh_fast);

    mv = Hp - SIZEOF_StgMutVar + WDS(1);
222
    SET_HDR(mv,stg_MUT_VAR_DIRTY_info,W_[CCCS]);
223
224
225
226
227
228
229
    StgMutVar_var(mv) = R1;
    
    RET_P(mv);
}

atomicModifyMutVarzh_fast
{
230
    W_ mv, f, z, x, y, r, h;
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
    /* Args: R1 :: MutVar#,  R2 :: a -> (a,b) */

    /* If x is the current contents of the MutVar#, then 
       We want to make the new contents point to

         (sel_0 (f x))
 
       and the return value is
	 
	 (sel_1 (f x))

        obviously we can share (f x).

         z = [stg_ap_2 f x]  (max (HS + 2) MIN_UPD_SIZE)
	 y = [stg_sel_0 z]   (max (HS + 1) MIN_UPD_SIZE)
         r = [stg_sel_1 z]   (max (HS + 1) MIN_UPD_SIZE)
    */

#if MIN_UPD_SIZE > 1
250
#define THUNK_1_SIZE (SIZEOF_StgThunkHeader + WDS(MIN_UPD_SIZE))
251
252
#define TICK_ALLOC_THUNK_1() TICK_ALLOC_UP_THK(WDS(1),WDS(MIN_UPD_SIZE-1))
#else
253
#define THUNK_1_SIZE (SIZEOF_StgThunkHeader + WDS(1))
254
255
256
257
#define TICK_ALLOC_THUNK_1() TICK_ALLOC_UP_THK(WDS(1),0)
#endif

#if MIN_UPD_SIZE > 2
258
#define THUNK_2_SIZE (SIZEOF_StgThunkHeader + WDS(MIN_UPD_SIZE))
259
260
#define TICK_ALLOC_THUNK_2() TICK_ALLOC_UP_THK(WDS(2),WDS(MIN_UPD_SIZE-2))
#else
261
#define THUNK_2_SIZE (SIZEOF_StgThunkHeader + WDS(2))
262
263
264
265
266
267
268
#define TICK_ALLOC_THUNK_2() TICK_ALLOC_UP_THK(WDS(2),0)
#endif

#define SIZE (THUNK_2_SIZE + THUNK_1_SIZE + THUNK_1_SIZE)

   HP_CHK_GEN_TICKY(SIZE, R1_PTR & R2_PTR, atomicModifyMutVarzh_fast);

269
270
   mv = R1;
   f = R2;
271
272
273
274
275
276

   TICK_ALLOC_THUNK_2();
   CCCS_ALLOC(THUNK_2_SIZE);
   z = Hp - THUNK_2_SIZE + WDS(1);
   SET_HDR(z, stg_ap_2_upd_info, W_[CCCS]);
   LDV_RECORD_CREATE(z);
277
   StgThunk_payload(z,0) = f;
278
279
280
281
282
283

   TICK_ALLOC_THUNK_1();
   CCCS_ALLOC(THUNK_1_SIZE);
   y = z - THUNK_1_SIZE;
   SET_HDR(y, stg_sel_0_upd_info, W_[CCCS]);
   LDV_RECORD_CREATE(y);
284
   StgThunk_payload(y,0) = z;
285
286
287
288
289
290

   TICK_ALLOC_THUNK_1();
   CCCS_ALLOC(THUNK_1_SIZE);
   r = y - THUNK_1_SIZE;
   SET_HDR(r, stg_sel_1_upd_info, W_[CCCS]);
   LDV_RECORD_CREATE(r);
291
292
   StgThunk_payload(r,0) = z;

293
294
295
296
297
298
299
300
 retry:
   x = StgMutVar_var(mv);
   StgThunk_payload(z,1) = x;
#ifdef THREADED_RTS
   (h) = foreign "C" cas(mv + SIZEOF_StgHeader + OFFSET_StgMutVar_var, x, y) [];
   if (h != x) { goto retry; }
#else
   StgMutVar_var(mv) = y;
301
#endif
302

303
304
305
306
   if (GET_INFO(mv) == stg_MUT_VAR_CLEAN_info) {
     foreign "C" dirty_MUT_VAR(BaseReg "ptr", mv "ptr") [];
   }

307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
   RET_P(r);
}

/* -----------------------------------------------------------------------------
   Weak Pointer Primitives
   -------------------------------------------------------------------------- */

STRING(stg_weak_msg,"New weak pointer at %p\n")

mkWeakzh_fast
{
  /* R1 = key
     R2 = value
     R3 = finalizer (or NULL)
  */
  W_ w;

  if (R3 == NULL) {
    R3 = stg_NO_FINALIZER_closure;
  }

  ALLOC_PRIM( SIZEOF_StgWeak, R1_PTR & R2_PTR & R3_PTR, mkWeakzh_fast );

  w = Hp - SIZEOF_StgWeak + WDS(1);
  SET_HDR(w, stg_WEAK_info, W_[CCCS]);

333
334
335
336
337
338
339
340
  // We don't care about cfinalizer here.
  // Should StgWeak_cfinalizer(w) be stg_NO_FINALIZER_closure or
  // something else?

  StgWeak_key(w)        = R1;
  StgWeak_value(w)      = R2;
  StgWeak_finalizer(w)  = R3;
  StgWeak_cfinalizer(w) = stg_NO_FINALIZER_closure;
341
342
343
344

  StgWeak_link(w)	= W_[weak_ptr_list];
  W_[weak_ptr_list] 	= w;

345
  IF_DEBUG(weak, foreign "C" debugBelch(stg_weak_msg,w) []);
346
347
348
349

  RET_P(w);
}

350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
mkWeakForeignEnvzh_fast
{
  /* R1 = key
     R2 = value
     R3 = finalizer
     R4 = pointer
     R5 = has environment (0 or 1)
     R6 = environment
  */
  W_ w, payload_words, words, p;

  W_ key, val, fptr, ptr, flag, eptr;

  key  = R1;
  val  = R2;
  fptr = R3;
  ptr  = R4;
  flag = R5;
  eptr = R6;

370
  ALLOC_PRIM( SIZEOF_StgWeak, R1_PTR & R2_PTR, mkWeakForeignEnvzh_fast );
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402

  w = Hp - SIZEOF_StgWeak + WDS(1);
  SET_HDR(w, stg_WEAK_info, W_[CCCS]);

  payload_words = 4;
  words         = BYTES_TO_WDS(SIZEOF_StgArrWords) + payload_words;
  ("ptr" p)     = foreign "C" allocateLocal(MyCapability() "ptr", words) [];

  TICK_ALLOC_PRIM(SIZEOF_StgArrWords,WDS(payload_words),0);
  SET_HDR(p, stg_ARR_WORDS_info, W_[CCCS]);

  StgArrWords_words(p)     = payload_words;
  StgArrWords_payload(p,0) = fptr;
  StgArrWords_payload(p,1) = ptr;
  StgArrWords_payload(p,2) = eptr;
  StgArrWords_payload(p,3) = flag;

  // We don't care about the value here.
  // Should StgWeak_value(w) be stg_NO_FINALIZER_closure or something else?

  StgWeak_key(w)        = key;
  StgWeak_value(w)      = val;
  StgWeak_finalizer(w)  = stg_NO_FINALIZER_closure;
  StgWeak_cfinalizer(w) = p;

  StgWeak_link(w)   = W_[weak_ptr_list];
  W_[weak_ptr_list] = w;

  IF_DEBUG(weak, foreign "C" debugBelch(stg_weak_msg,w) []);

  RET_P(w);
}
403
404
405
406
407

finalizzeWeakzh_fast
{
  /* R1 = weak ptr
   */
408
  W_ w, f, arr;
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435

  w = R1;

  // already dead?
  if (GET_INFO(w) == stg_DEAD_WEAK_info) {
      RET_NP(0,stg_NO_FINALIZER_closure);
  }

  // kill it
#ifdef PROFILING
  // @LDV profiling
  // A weak pointer is inherently used, so we do not need to call
  // LDV_recordDead_FILL_SLOP_DYNAMIC():
  //    LDV_recordDead_FILL_SLOP_DYNAMIC((StgClosure *)w);
  // or, LDV_recordDead():
  //    LDV_recordDead((StgClosure *)w, sizeofW(StgWeak) - sizeofW(StgProfHeader));
  // Furthermore, when PROFILING is turned on, dead weak pointers are exactly as 
  // large as weak pointers, so there is no need to fill the slop, either.
  // See stg_DEAD_WEAK_info in StgMiscClosures.hc.
#endif

  //
  // Todo: maybe use SET_HDR() and remove LDV_recordCreate()?
  //
  SET_INFO(w,stg_DEAD_WEAK_info);
  LDV_RECORD_CREATE(w);

436
437
438
  f   = StgWeak_finalizer(w);
  arr = StgWeak_cfinalizer(w);

439
  StgDeadWeak_link(w) = StgWeak_link(w);
440

441
442
443
444
445
446
447
  if (arr != stg_NO_FINALIZER_closure) {
    foreign "C" runCFinalizer(StgArrWords_payload(arr,0),
                              StgArrWords_payload(arr,1),
                              StgArrWords_payload(arr,2),
                              StgArrWords_payload(arr,3)) [];
  }

448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
  /* return the finalizer */
  if (f == stg_NO_FINALIZER_closure) {
      RET_NP(0,stg_NO_FINALIZER_closure);
  } else {
      RET_NP(1,f);
  }
}

deRefWeakzh_fast
{
  /* R1 = weak ptr */
  W_ w, code, val;

  w = R1;
  if (GET_INFO(w) == stg_WEAK_info) {
    code = 1;
    val = StgWeak_value(w);
  } else {
    code = 0;
    val = w;
  }
  RET_NP(code,val);
}

/* -----------------------------------------------------------------------------
   Arbitrary-precision Integer operations.

   There are some assumptions in this code that mp_limb_t == W_.  This is
   the case for all the platforms that GHC supports, currently.
   -------------------------------------------------------------------------- */

int2Integerzh_fast
{
   /* arguments: R1 = Int# */

   W_ val, s, p;	/* to avoid aliasing */

   val = R1;
   ALLOC_PRIM( SIZEOF_StgArrWords + WDS(1), NO_PTRS, int2Integerzh_fast );

   p = Hp - SIZEOF_StgArrWords;
   SET_HDR(p, stg_ARR_WORDS_info, W_[CCCS]);
   StgArrWords_words(p) = 1;

   /* mpz_set_si is inlined here, makes things simpler */
   if (%lt(val,0)) { 
	s  = -1;
	Hp(0) = -val;
   } else { 
     if (%gt(val,0)) {
	s = 1;
	Hp(0) = val;
     } else {
	s = 0;
     }
  }

   /* returns (# size  :: Int#, 
		 data  :: ByteArray# 
	       #)
   */
   RET_NP(s,p);
}

word2Integerzh_fast
{
   /* arguments: R1 = Word# */

   W_ val, s, p;	/* to avoid aliasing */

   val = R1;

   ALLOC_PRIM( SIZEOF_StgArrWords + WDS(1), NO_PTRS, word2Integerzh_fast);

   p = Hp - SIZEOF_StgArrWords;
   SET_HDR(p, stg_ARR_WORDS_info, W_[CCCS]);
   StgArrWords_words(p) = 1;

   if (val != 0) {
	s = 1;
	W_[Hp] = val;
   } else {
	s = 0;
   }

   /* returns (# size  :: Int#, 
		 data  :: ByteArray# #)
   */
   RET_NP(s,p);
}


/*
 * 'long long' primops for converting to/from Integers.
 */

#ifdef SUPPORT_LONG_LONGS

int64ToIntegerzh_fast
{
   /* arguments: L1 = Int64# */

   L_ val;
551
   W_ hi, lo, s, neg, words_needed, p;
552
553
554
555

   val = L1;
   neg = 0;

556
557
558
   hi = TO_W_(val >> 32);
   lo = TO_W_(val);

559
   if ( hi == 0 || (hi == 0xFFFFFFFF && lo != 0) )  {
560
561
       // minimum is one word
       words_needed = 1;
562
563
   } else { 
       words_needed = 2;
564
565
566
567
568
569
570
571
572
   }

   ALLOC_PRIM( SIZEOF_StgArrWords + WDS(words_needed),
	       NO_PTRS, int64ToIntegerzh_fast );

   p = Hp - SIZEOF_StgArrWords - WDS(words_needed) + WDS(1);
   SET_HDR(p, stg_ARR_WORDS_info, W_[CCCS]);
   StgArrWords_words(p) = words_needed;

573
   if ( %lt(hi,0) ) {
574
     neg = 1;
575
576
577
578
579
580
     lo = -lo;
     if(lo == 0) {
       hi = -hi;
     } else {
       hi = -hi - 1;
     }
581
582
583
584
   }

   if ( words_needed == 2 )  { 
      s = 2;
585
      Hp(-1) = lo;
586
587
      Hp(0) = hi;
   } else { 
588
       if ( lo != 0 ) {
589
	   s = 1;
590
	   Hp(0) = lo;
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
       } else /* val==0 */  {
	   s = 0;
       }
   }
   if ( neg != 0 ) {
	s = -s;
   }

   /* returns (# size  :: Int#, 
		 data  :: ByteArray# #)
   */
   RET_NP(s,p);
}
word64ToIntegerzh_fast
{
   /* arguments: L1 = Word64# */

   L_ val;
609
   W_ hi, lo, s, words_needed, p;
610
611

   val = L1;
612
613
614
615
   hi = TO_W_(val >> 32);
   lo = TO_W_(val);

   if ( hi != 0 ) {
616
617
618
619
620
621
622
623
624
625
626
627
      words_needed = 2;
   } else {
      words_needed = 1;
   }

   ALLOC_PRIM( SIZEOF_StgArrWords + WDS(words_needed),
	       NO_PTRS, word64ToIntegerzh_fast );

   p = Hp - SIZEOF_StgArrWords - WDS(words_needed) + WDS(1);
   SET_HDR(p, stg_ARR_WORDS_info, W_[CCCS]);
   StgArrWords_words(p) = words_needed;

628
   if ( hi != 0 ) { 
629
     s = 2;
630
     Hp(-1) = lo;
631
632
     Hp(0)  = hi;
   } else {
633
      if ( lo != 0 ) {
634
        s = 1;
635
        Hp(0) = lo;
636
637
638
639
640
641
642
643
644
645
646
647
     } else /* val==0 */  {
      s = 0;
     }
  }

   /* returns (# size  :: Int#, 
		 data  :: ByteArray# #)
   */
   RET_NP(s,p);
}


648

649
650
651
652
#endif /* SUPPORT_LONG_LONGS */

/* ToDo: this is shockingly inefficient */

653
#ifndef THREADED_RTS
654
655
656
657
658
659
660
661
662
663
664
section "bss" {
  mp_tmp1:
    bits8 [SIZEOF_MP_INT];
}

section "bss" {
  mp_tmp2:
    bits8 [SIZEOF_MP_INT];
}

section "bss" {
665
  mp_result1:
666
667
668
669
    bits8 [SIZEOF_MP_INT];
}

section "bss" {
670
  mp_result2:
671
672
    bits8 [SIZEOF_MP_INT];
}
673
674
#endif

675
#ifdef THREADED_RTS
676
677
678
679
680
681
#define FETCH_MP_TEMP(X) \
W_ X; \
X = BaseReg + (OFFSET_StgRegTable_r ## X);
#else
#define FETCH_MP_TEMP(X) /* Nothing */
#endif
682

683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
#define GMP_TAKE2_RET1(name,mp_fun)                                     \
name                                                                    \
{                                                                       \
  CInt s1, s2;                                                          \
  W_ d1, d2;                                                            \
  FETCH_MP_TEMP(mp_tmp1);                                               \
  FETCH_MP_TEMP(mp_tmp2);                                               \
  FETCH_MP_TEMP(mp_result1)                                             \
  FETCH_MP_TEMP(mp_result2);                                            \
                                                                        \
  /* call doYouWantToGC() */                                            \
  MAYBE_GC(R2_PTR & R4_PTR, name);                                      \
                                                                        \
  s1 = W_TO_INT(R1);                                                    \
  d1 = R2;                                                              \
  s2 = W_TO_INT(R3);                                                    \
  d2 = R4;                                                              \
                                                                        \
  MP_INT__mp_alloc(mp_tmp1) = W_TO_INT(StgArrWords_words(d1));          \
  MP_INT__mp_size(mp_tmp1)  = (s1);                                     \
  MP_INT__mp_d(mp_tmp1)	    = BYTE_ARR_CTS(d1);                         \
  MP_INT__mp_alloc(mp_tmp2) = W_TO_INT(StgArrWords_words(d2));          \
  MP_INT__mp_size(mp_tmp2)  = (s2);                                     \
  MP_INT__mp_d(mp_tmp2)	    = BYTE_ARR_CTS(d2);                         \
                                                                        \
708
  foreign "C" __gmpz_init(mp_result1 "ptr") [];                            \
709
710
                                                                        \
  /* Perform the operation */                                           \
711
  foreign "C" mp_fun(mp_result1 "ptr",mp_tmp1  "ptr",mp_tmp2  "ptr") []; \
712
713
714
                                                                        \
  RET_NP(TO_W_(MP_INT__mp_size(mp_result1)),                            \
         MP_INT__mp_d(mp_result1) - SIZEOF_StgArrWords);                \
715
716
}

717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
#define GMP_TAKE1_RET1(name,mp_fun)                                     \
name                                                                    \
{                                                                       \
  CInt s1;                                                              \
  W_ d1;                                                                \
  FETCH_MP_TEMP(mp_tmp1);                                               \
  FETCH_MP_TEMP(mp_result1)                                             \
                                                                        \
  /* call doYouWantToGC() */                                            \
  MAYBE_GC(R2_PTR, name);                                               \
                                                                        \
  d1 = R2;                                                              \
  s1 = W_TO_INT(R1);                                                    \
                                                                        \
  MP_INT__mp_alloc(mp_tmp1)	= W_TO_INT(StgArrWords_words(d1));      \
  MP_INT__mp_size(mp_tmp1)	= (s1);                                 \
  MP_INT__mp_d(mp_tmp1)		= BYTE_ARR_CTS(d1);                     \
                                                                        \
735
  foreign "C" __gmpz_init(mp_result1 "ptr") [];                            \
736
737
                                                                        \
  /* Perform the operation */                                           \
738
  foreign "C" mp_fun(mp_result1 "ptr",mp_tmp1 "ptr") [];                \
739
740
741
                                                                        \
  RET_NP(TO_W_(MP_INT__mp_size(mp_result1)),                            \
         MP_INT__mp_d(mp_result1) - SIZEOF_StgArrWords);                \
742
743
}

744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
#define GMP_TAKE2_RET2(name,mp_fun)                                                     \
name                                                                                    \
{                                                                                       \
  CInt s1, s2;                                                                          \
  W_ d1, d2;                                                                            \
  FETCH_MP_TEMP(mp_tmp1);                                                               \
  FETCH_MP_TEMP(mp_tmp2);                                                               \
  FETCH_MP_TEMP(mp_result1)                                                             \
  FETCH_MP_TEMP(mp_result2)                                                             \
                                                                                        \
  /* call doYouWantToGC() */                                                            \
  MAYBE_GC(R2_PTR & R4_PTR, name);                                                      \
                                                                                        \
  s1 = W_TO_INT(R1);                                                                    \
  d1 = R2;                                                                              \
  s2 = W_TO_INT(R3);                                                                    \
  d2 = R4;                                                                              \
                                                                                        \
  MP_INT__mp_alloc(mp_tmp1)	= W_TO_INT(StgArrWords_words(d1));                      \
  MP_INT__mp_size(mp_tmp1)	= (s1);                                                 \
  MP_INT__mp_d(mp_tmp1)		= BYTE_ARR_CTS(d1);                                     \
  MP_INT__mp_alloc(mp_tmp2)	= W_TO_INT(StgArrWords_words(d2));                      \
  MP_INT__mp_size(mp_tmp2)	= (s2);                                                 \
  MP_INT__mp_d(mp_tmp2)		= BYTE_ARR_CTS(d2);                                     \
                                                                                        \
769
770
  foreign "C" __gmpz_init(mp_result1 "ptr") [];                                               \
  foreign "C" __gmpz_init(mp_result2 "ptr") [];                                               \
771
772
                                                                                        \
  /* Perform the operation */                                                           \
773
  foreign "C" mp_fun(mp_result1 "ptr",mp_result2 "ptr",mp_tmp1 "ptr",mp_tmp2 "ptr") [];    \
774
775
776
777
778
                                                                                        \
  RET_NPNP(TO_W_(MP_INT__mp_size(mp_result1)),                                          \
           MP_INT__mp_d(mp_result1) - SIZEOF_StgArrWords,                               \
	   TO_W_(MP_INT__mp_size(mp_result2)),                                          \
           MP_INT__mp_d(mp_result2) - SIZEOF_StgArrWords);                              \
779
780
}

781
782
783
784
785
786
787
788
789
790
791
792
793
794
GMP_TAKE2_RET1(plusIntegerzh_fast,     __gmpz_add)
GMP_TAKE2_RET1(minusIntegerzh_fast,    __gmpz_sub)
GMP_TAKE2_RET1(timesIntegerzh_fast,    __gmpz_mul)
GMP_TAKE2_RET1(gcdIntegerzh_fast,      __gmpz_gcd)
GMP_TAKE2_RET1(quotIntegerzh_fast,     __gmpz_tdiv_q)
GMP_TAKE2_RET1(remIntegerzh_fast,      __gmpz_tdiv_r)
GMP_TAKE2_RET1(divExactIntegerzh_fast, __gmpz_divexact)
GMP_TAKE2_RET1(andIntegerzh_fast,      __gmpz_and)
GMP_TAKE2_RET1(orIntegerzh_fast,       __gmpz_ior)
GMP_TAKE2_RET1(xorIntegerzh_fast,      __gmpz_xor)
GMP_TAKE1_RET1(complementIntegerzh_fast, __gmpz_com)

GMP_TAKE2_RET2(quotRemIntegerzh_fast, __gmpz_tdiv_qr)
GMP_TAKE2_RET2(divModIntegerzh_fast,  __gmpz_fdiv_qr)
795

796
#ifndef THREADED_RTS
797
section "bss" {
798
  mp_tmp_w:  W_; // NB. mp_tmp_w is really an here mp_limb_t
799
}
800
#endif
801
802
803
804
805

gcdIntzh_fast
{
    /* R1 = the first Int#; R2 = the second Int# */
    W_ r; 
806
    FETCH_MP_TEMP(mp_tmp_w);
807

808
    W_[mp_tmp_w] = R1;
809
    (r) = foreign "C" __gmpn_gcd_1(mp_tmp_w "ptr", 1, R2) [];
810
811
812
813
814
815
816
817
818
819

    R1 = r;
    /* Result parked in R1, return via info-pointer at TOS */
    jump %ENTRY_CODE(Sp(0));
}


gcdIntegerIntzh_fast
{
    /* R1 = s1; R2 = d1; R3 = the int */
820
821
822
    W_ s1;
    (s1) = foreign "C" __gmpn_gcd_1( BYTE_ARR_CTS(R2) "ptr", R1, R3) [];
    R1 = s1;
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
    
    /* Result parked in R1, return via info-pointer at TOS */
    jump %ENTRY_CODE(Sp(0));
}


cmpIntegerIntzh_fast
{
    /* R1 = s1; R2 = d1; R3 = the int */
    W_ usize, vsize, v_digit, u_digit;

    usize = R1;
    vsize = 0;
    v_digit = R3;

838
    // paraphrased from __gmpz_cmp_si() in the GMP sources
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
    if (%gt(v_digit,0)) {
	vsize = 1;
    } else { 
	if (%lt(v_digit,0)) {
	    vsize = -1;
	    v_digit = -v_digit;
	}
    }

    if (usize != vsize) {
	R1 = usize - vsize; 
	jump %ENTRY_CODE(Sp(0));
    }

    if (usize == 0) {
	R1 = 0; 
	jump %ENTRY_CODE(Sp(0));
    }

    u_digit = W_[BYTE_ARR_CTS(R2)];

    if (u_digit == v_digit) {
	R1 = 0; 
	jump %ENTRY_CODE(Sp(0));
    }

    if (%gtu(u_digit,v_digit)) { // NB. unsigned: these are mp_limb_t's
	R1 = usize; 
    } else {
	R1 = -usize; 
    }

    jump %ENTRY_CODE(Sp(0));
}

cmpIntegerzh_fast
{
    /* R1 = s1; R2 = d1; R3 = s2; R4 = d2 */
    W_ usize, vsize, size, up, vp;
    CInt cmp;

880
    // paraphrased from __gmpz_cmp() in the GMP sources
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
    usize = R1;
    vsize = R3;

    if (usize != vsize) {
	R1 = usize - vsize; 
	jump %ENTRY_CODE(Sp(0));
    }

    if (usize == 0) {
	R1 = 0; 
	jump %ENTRY_CODE(Sp(0));
    }

    if (%lt(usize,0)) { // NB. not <, which is unsigned
	size = -usize;
    } else {
	size = usize;
    }

    up = BYTE_ARR_CTS(R2);
    vp = BYTE_ARR_CTS(R4);

903
    (cmp) = foreign "C" __gmpn_cmp(up "ptr", vp "ptr", size) [];
904

905
    if (cmp == 0 :: CInt) {
906
907
908
909
	R1 = 0; 
	jump %ENTRY_CODE(Sp(0));
    }

910
    if (%lt(cmp,0 :: CInt) == %lt(usize,0)) {
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
	R1 = 1;
    } else {
	R1 = (-1); 
    }
    /* Result parked in R1, return via info-pointer at TOS */
    jump %ENTRY_CODE(Sp(0));
}

integer2Intzh_fast
{
    /* R1 = s; R2 = d */
    W_ r, s;

    s = R1;
    if (s == 0) {
	r = 0;
    } else {
	r = W_[R2 + SIZEOF_StgArrWords];
	if (%lt(s,0)) {
	    r = -r;
	}
    }
    /* Result parked in R1, return via info-pointer at TOS */
    R1 = r;
    jump %ENTRY_CODE(Sp(0));
}

integer2Wordzh_fast
{
  /* R1 = s; R2 = d */
  W_ r, s;

  s = R1;
  if (s == 0) {
    r = 0;
  } else {
    r = W_[R2 + SIZEOF_StgArrWords];
    if (%lt(s,0)) {
	r = -r;
    }
  }
  /* Result parked in R1, return via info-pointer at TOS */
  R1 = r;
  jump %ENTRY_CODE(Sp(0));
}

957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
decodeFloatzuIntzh_fast
{ 
    W_ p;
    F_ arg;
    FETCH_MP_TEMP(mp_tmp1);
    FETCH_MP_TEMP(mp_tmp_w);
    
    /* arguments: F1 = Float# */
    arg = F1;
    
    /* Perform the operation */
    foreign "C" __decodeFloat_Int(mp_tmp1 "ptr", mp_tmp_w "ptr", arg) [];
    
    /* returns: (Int# (mantissa), Int# (exponent)) */
    RET_NN(W_[mp_tmp1], W_[mp_tmp_w]);
}

974
975
976
977
978
979
980
#define DOUBLE_MANTISSA_SIZE SIZEOF_DOUBLE
#define ARR_SIZE (SIZEOF_StgArrWords + DOUBLE_MANTISSA_SIZE)

decodeDoublezh_fast
{ 
    D_ arg;
    W_ p;
981
982
    FETCH_MP_TEMP(mp_tmp1);
    FETCH_MP_TEMP(mp_tmp_w);
983
984
985
986
987
988
989
990
991
992
993
994
995
996

    /* arguments: D1 = Double# */
    arg = D1;

    ALLOC_PRIM( ARR_SIZE, NO_PTRS, decodeDoublezh_fast );
    
    /* Be prepared to tell Lennart-coded __decodeDouble
       where mantissa.d can be put (it does not care about the rest) */
    p = Hp - ARR_SIZE + WDS(1);
    SET_HDR(p, stg_ARR_WORDS_info, W_[CCCS]);
    StgArrWords_words(p) = BYTES_TO_WDS(DOUBLE_MANTISSA_SIZE);
    MP_INT__mp_d(mp_tmp1) = BYTE_ARR_CTS(p);

    /* Perform the operation */
997
    foreign "C" __decodeDouble(mp_tmp1 "ptr", mp_tmp_w "ptr",arg) [];
998
999
    
    /* returns: (Int# (expn), Int#, ByteArray#) */
1000
    RET_NNP(W_[mp_tmp_w], TO_W_(MP_INT__mp_size(mp_tmp1)), p);
1001
1002
}

1003
1004
1005
1006
1007
1008
decodeDoublezu2Intzh_fast
{ 
    D_ arg;
    W_ p;
    FETCH_MP_TEMP(mp_tmp1);
    FETCH_MP_TEMP(mp_tmp2);
1009
1010
    FETCH_MP_TEMP(mp_result1);
    FETCH_MP_TEMP(mp_result2);
1011
1012
1013
1014
1015

    /* arguments: D1 = Double# */
    arg = D1;

    /* Perform the operation */
1016
1017
1018
1019
1020
1021
1022
    foreign "C" __decodeDouble_2Int(mp_tmp1 "ptr", mp_tmp2 "ptr",
                                    mp_result1 "ptr", mp_result2 "ptr",
                                    arg) [];

    /* returns:
       (Int# (mant sign), Word# (mant high), Word# (mant low), Int# (expn)) */
    RET_NNNN(W_[mp_tmp1], W_[mp_tmp2], W_[mp_result1], W_[mp_result2]);
1023
1024
}

1025
1026
1027
1028
1029
1030
1031
/* -----------------------------------------------------------------------------
 * Concurrency primitives
 * -------------------------------------------------------------------------- */

forkzh_fast
{
  /* args: R1 = closure to spark */
1032

1033
1034
  MAYBE_GC(R1_PTR, forkzh_fast);

1035
1036
1037
1038
  W_ closure;
  W_ threadid;
  closure = R1;

1039
  ("ptr" threadid) = foreign "C" createIOThread( MyCapability() "ptr", 
1040
1041
				RtsFlags_GcFlags_initialStkSize(RtsFlags), 
				closure "ptr") [];
1042
1043
1044
1045
1046
1047

  /* start blocked if the current thread is blocked */
  StgTSO_flags(threadid) = 
     StgTSO_flags(threadid) |  (StgTSO_flags(CurrentTSO) & 
                                (TSO_BLOCKEX::I32 | TSO_INTERRUPTIBLE::I32));

1048
1049
  foreign "C" scheduleThread(MyCapability() "ptr", threadid "ptr") [];

1050
1051
  // context switch soon, but not immediately: we don't want every
  // forkIO to force a context-switch.
1052
  Capability_context_switch(MyCapability()) = 1 :: CInt;
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
  
  RET_P(threadid);
}

forkOnzh_fast
{
  /* args: R1 = cpu, R2 = closure to spark */

  MAYBE_GC(R2_PTR, forkOnzh_fast);

  W_ cpu;
  W_ closure;
  W_ threadid;
  cpu = R1;
  closure = R2;

1069
  ("ptr" threadid) = foreign "C" createIOThread( MyCapability() "ptr", 
1070
				RtsFlags_GcFlags_initialStkSize(RtsFlags), 
1071
				closure "ptr") [];
1072
1073
1074
1075
1076
1077

  /* start blocked if the current thread is blocked */
  StgTSO_flags(threadid) = 
     StgTSO_flags(threadid) |  (StgTSO_flags(CurrentTSO) & 
                                (TSO_BLOCKEX::I32 | TSO_INTERRUPTIBLE::I32));

1078
  foreign "C" scheduleThreadOn(MyCapability() "ptr", cpu, threadid "ptr") [];
1079

1080
1081
  // context switch soon, but not immediately: we don't want every
  // forkIO to force a context-switch.
1082
  Capability_context_switch(MyCapability()) = 1 :: CInt;
1083
  
1084
  RET_P(threadid);
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
}

yieldzh_fast
{
  jump stg_yield_noregs;
}

myThreadIdzh_fast
{
  /* no args. */
  RET_P(CurrentTSO);
}

labelThreadzh_fast
{
  /* args: 
	R1 = ThreadId#
	R2 = Addr# */
#ifdef DEBUG
1104
  foreign "C" labelThread(R1 "ptr", R2 "ptr") [];
1105
1106
1107
1108
1109
1110
1111
1112
#endif
  jump %ENTRY_CODE(Sp(0));
}

isCurrentThreadBoundzh_fast
{
  /* no args */
  W_ r;
1113
  (r) = foreign "C" isThreadBound(CurrentTSO) [];
1114
1115
1116
  RET_N(r);
}

1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
threadStatuszh_fast
{
    /* args: R1 :: ThreadId# */
    W_ tso;
    W_ why_blocked;
    W_ what_next;
    W_ ret;

    tso = R1;
    loop:
      if (TO_W_(StgTSO_what_next(tso)) == ThreadRelocated) {
          tso = StgTSO__link(tso);
          goto loop;
      }

    what_next   = TO_W_(StgTSO_what_next(tso));
    why_blocked = TO_W_(StgTSO_why_blocked(tso));
    // Note: these two reads are not atomic, so they might end up
    // being inconsistent.  It doesn't matter, since we
    // only return one or the other.  If we wanted to return the
    // contents of block_info too, then we'd have to do some synchronisation.

    if (what_next == ThreadComplete) {
        ret = 16;  // NB. magic, matches up with GHC.Conc.threadStatus
    } else {
        if (what_next == ThreadKilled) {
            ret = 17;
        } else {
            ret = why_blocked;
        }
    }
    RET_N(ret);
}
1150
1151
1152
1153
1154
1155
1156
1157
1158

/* -----------------------------------------------------------------------------
 * TVar primitives
 * -------------------------------------------------------------------------- */

#define SP_OFF 0

// Catch retry frame ------------------------------------------------------------

1159
INFO_TABLE_RET(stg_catch_retry_frame, CATCH_RETRY_FRAME,
1160
#if defined(PROFILING)
1161
  W_ unused1, W_ unused2,
1162
#endif
1163
  W_ unused3, P_ unused4, P_ unused5)
1164
1165
1166
1167
1168
{
   W_ r, frame, trec, outer;

   frame = Sp;
   trec = StgTSO_trec(CurrentTSO);
1169
1170
   ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
   (r) = foreign "C" stmCommitNestedTransaction(MyCapability() "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1171
   if (r != 0) {
1172
1173
1174
1175
1176
     /* Succeeded (either first branch or second branch) */
     StgTSO_trec(CurrentTSO) = outer;
     Sp = Sp + SIZEOF_StgCatchRetryFrame;
     jump %ENTRY_CODE(Sp(SP_OFF));
   } else {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1177
     /* Did not commit: re-execute */
1178
     W_ new_trec;
1179
     ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
1180
     StgTSO_trec(CurrentTSO) = new_trec;
Simon Marlow's avatar
Simon Marlow committed
1181
     if (StgCatchRetryFrame_running_alt_code(frame) != 0::I32) {
1182
1183
1184
1185
       R1 = StgCatchRetryFrame_alt_code(frame);
     } else {
       R1 = StgCatchRetryFrame_first_code(frame);
     }
1186
     jump stg_ap_v_fast;
1187
1188
   }
}
1189
1190


Simon Marlow's avatar
Simon Marlow committed
1191
// Atomically frame ------------------------------------------------------------
1192

1193
INFO_TABLE_RET(stg_atomically_frame, ATOMICALLY_FRAME,
1194
#if defined(PROFILING)
1195
  W_ unused1, W_ unused2,
1196
#endif
1197
  P_ unused3, P_ unused4)
1198
{
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1199
  W_ frame, trec, valid, next_invariant, q, outer;
1200

1201
1202
  frame = Sp;
  trec = StgTSO_trec(CurrentTSO);
1203
  ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1204
1205
1206

  if (outer == NO_TREC) {
    /* First time back at the atomically frame -- pick up invariants */
1207
    ("ptr" q) = foreign "C" stmGetInvariantsToCheck(MyCapability() "ptr", trec "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1208
    StgAtomicallyFrame_next_invariant_to_check(frame) = q;
1209
1210

  } else {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
    /* Second/subsequent time back at the atomically frame -- abort the
     * tx that's checking the invariant and move on to the next one */
    StgTSO_trec(CurrentTSO) = outer;
    q = StgAtomicallyFrame_next_invariant_to_check(frame);
    StgInvariantCheckQueue_my_execution(q) = trec;
    foreign "C" stmAbortTransaction(MyCapability() "ptr", trec "ptr") [];
    /* Don't free trec -- it's linked from q and will be stashed in the
     * invariant if we eventually commit. */
    q = StgInvariantCheckQueue_next_queue_entry(q);
    StgAtomicallyFrame_next_invariant_to_check(frame) = q;
    trec = outer;
  }

  q = StgAtomicallyFrame_next_invariant_to_check(frame);

  if (q != END_INVARIANT_CHECK_QUEUE) {
    /* We can't commit yet: another invariant to check */
1228
    ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", trec "ptr") [];
1229
    StgTSO_trec(CurrentTSO) = trec;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1230
1231
1232

    next_invariant = StgInvariantCheckQueue_invariant(q);
    R1 = StgAtomicInvariant_code(next_invariant);
1233
    jump stg_ap_v_fast;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1234
1235
1236
1237

  } else {

    /* We've got no more invariants to check, try to commit */
1238
    (valid) = foreign "C" stmCommitTransaction(MyCapability() "ptr", trec "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1239
1240
1241
1242
1243
1244
1245
    if (valid != 0) {
      /* Transaction was valid: commit succeeded */
      StgTSO_trec(CurrentTSO) = NO_TREC;
      Sp = Sp + SIZEOF_StgAtomicallyFrame;
      jump %ENTRY_CODE(Sp(SP_OFF));
    } else {
      /* Transaction was not valid: try again */
1246
      ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1247
1248
1249
1250
1251
      StgTSO_trec(CurrentTSO) = trec;
      StgAtomicallyFrame_next_invariant_to_check(frame) = END_INVARIANT_CHECK_QUEUE;
      R1 = StgAtomicallyFrame_code(frame);
      jump stg_ap_v_fast;
    }
1252
1253
1254
  }
}

1255
1256
1257
1258
INFO_TABLE_RET(stg_atomically_waiting_frame, ATOMICALLY_FRAME,
#if defined(PROFILING)
  W_ unused1, W_ unused2,
#endif
1259
  P_ unused3, P_ unused4)
1260
1261
1262
1263
1264
1265
{
  W_ frame, trec, valid;

  frame = Sp;

  /* The TSO is currently waiting: should we stop waiting? */
1266
  (valid) = foreign "C" stmReWait(MyCapability() "ptr", CurrentTSO "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1267
  if (valid != 0) {
1268
1269
1270
1271
    /* Previous attempt is still valid: no point trying again yet */
    jump stg_block_noregs;
  } else {
    /* Previous attempt is no longer valid: try again */
1272
    ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr") [];
1273
1274
1275
    StgTSO_trec(CurrentTSO) = trec;
    StgHeader_info(frame) = stg_atomically_frame_info;
    R1 = StgAtomicallyFrame_code(frame);
1276
    jump stg_ap_v_fast;
1277
  }
1278
}
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288

// STM catch frame --------------------------------------------------------------

#define SP_OFF 0

/* Catch frames are very similar to update frames, but when entering
 * one we just pop the frame off the stack and perform the correct
 * kind of return to the activation record underneath us on the stack.
 */

1289
1290
1291
1292
INFO_TABLE_RET(stg_catch_stm_frame, CATCH_STM_FRAME,
#if defined(PROFILING)
  W_ unused1, W_ unused2,
#endif
1293
  P_ unused3, P_ unused4)
Simon Marlow's avatar
Simon Marlow committed
1294
1295
1296
1297
   {
      W_ r, frame, trec, outer;
      frame = Sp;
      trec = StgTSO_trec(CurrentTSO);
1298
1299
      ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
      (r) = foreign "C" stmCommitNestedTransaction(MyCapability() "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1300
1301
1302
1303
1304
1305
1306
1307
      if (r != 0) {
        /* Commit succeeded */
        StgTSO_trec(CurrentTSO) = outer;
        Sp = Sp + SIZEOF_StgCatchSTMFrame;
        jump Sp(SP_OFF);
      } else {
        /* Commit failed */
        W_ new_trec;
1308
        ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1309
1310
1311
1312
1313
        StgTSO_trec(CurrentTSO) = new_trec;
        R1 = StgCatchSTMFrame_code(frame);
        jump stg_ap_v_fast;
      }
   }
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323


// Primop definition ------------------------------------------------------------

atomicallyzh_fast
{
  W_ frame;
  W_ old_trec;
  W_ new_trec;
  
1324
1325
1326
  // stmStartTransaction may allocate
  MAYBE_GC (R1_PTR, atomicallyzh_fast); 

1327
1328
1329
  /* Args: R1 = m :: STM a */
  STK_CHK_GEN(SIZEOF_StgAtomicallyFrame + WDS(1), R1_PTR, atomicallyzh_fast);

1330
1331
1332
1333
  old_trec = StgTSO_trec(CurrentTSO);

  /* Nested transactions are not allowed; raise an exception */
  if (old_trec != NO_TREC) {
1334
     R1 = base_ControlziExceptionziBase_nestedAtomically_closure;
1335
1336
1337
     jump raisezh_fast;
  }

1338
1339
1340
1341
  /* Set up the atomically frame */
  Sp = Sp - SIZEOF_StgAtomicallyFrame;
  frame = Sp;

1342
  SET_HDR(frame,stg_atomically_frame_info, W_[CCCS]);
1343
  StgAtomicallyFrame_code(frame) = R1;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1344
  StgAtomicallyFrame_next_invariant_to_check(frame) = END_INVARIANT_CHECK_QUEUE;
1345
1346

  /* Start the memory transcation */
1347
  ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", old_trec "ptr") [R1];
1348
1349
1350
  StgTSO_trec(CurrentTSO) = new_trec;

  /* Apply R1 to the realworld token */
1351
  jump stg_ap_v_fast;
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
}


catchSTMzh_fast
{
  W_ frame;
  
  /* Args: R1 :: STM a */
  /* Args: R2 :: Exception -> STM a */
  STK_CHK_GEN(SIZEOF_StgCatchSTMFrame + WDS(1), R1_PTR & R2_PTR, catchSTMzh_fast);

  /* Set up the catch frame */
  Sp = Sp - SIZEOF_StgCatchSTMFrame;
  frame = Sp;

1367
  SET_HDR(frame, stg_catch_stm_frame_info, W_[CCCS]);
1368
  StgCatchSTMFrame_handler(frame) = R2;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1369
1370
1371
1372
1373
1374
  StgCatchSTMFrame_code(frame) = R1;

  /* Start a nested transaction to run the body of the try block in */
  W_ cur_trec;  
  W_ new_trec;
  cur_trec = StgTSO_trec(CurrentTSO);
1375
  ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", cur_trec "ptr");
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1376
  StgTSO_trec(CurrentTSO) = new_trec;
1377
1378

  /* Apply R1 to the realworld token */
1379
  jump stg_ap_v_fast;
1380
1381
1382
1383
1384
1385
1386
1387
1388
}


catchRetryzh_fast
{
  W_ frame;
  W_ new_trec;
  W_ trec;

1389
1390
1391
  // stmStartTransaction may allocate
  MAYBE_GC (R1_PTR & R2_PTR, catchRetryzh_fast); 

1392
1393
1394
1395
1396
1397
  /* Args: R1 :: STM a */
  /* Args: R2 :: STM a */
  STK_CHK_GEN(SIZEOF_StgCatchRetryFrame + WDS(1), R1_PTR & R2_PTR, catchRetryzh_fast);

  /* Start a nested transaction within which to run the first code */
  trec = StgTSO_trec(CurrentTSO);
1398
  ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", trec "ptr") [R1,R2];
1399
1400
1401
1402
1403
1404
  StgTSO_trec(CurrentTSO) = new_trec;

  /* Set up the catch-retry frame */
  Sp = Sp - SIZEOF_StgCatchRetryFrame;
  frame = Sp;
  
1405
  SET_HDR(frame, stg_catch_retry_frame_info, W_[CCCS]);
1406
  StgCatchRetryFrame_running_alt_code(frame) = 0 :: CInt; // false;
1407
1408
1409
1410
  StgCatchRetryFrame_first_code(frame) = R1;
  StgCatchRetryFrame_alt_code(frame) = R2;

  /* Apply R1 to the realworld token */
1411
  jump stg_ap_v_fast;
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
}


retryzh_fast
{
  W_ frame_type;
  W_ frame;
  W_ trec;
  W_ outer;
  W_ r;

1423
  MAYBE_GC (NO_PTRS, retryzh_fast); // STM operations may allocate
1424
1425
1426
1427

  // Find the enclosing ATOMICALLY_FRAME or CATCH_RETRY_FRAME
retry_pop_stack:
  StgTSO_sp(CurrentTSO) = Sp;
1428
  (frame_type) = foreign "C" findRetryFrameHelper(CurrentTSO "ptr") [];
1429
1430
  Sp = StgTSO_sp(CurrentTSO);
  frame = Sp;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1431
  trec = StgTSO_trec(CurrentTSO);
1432
  ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
1433
1434
1435
1436

  if (frame_type == CATCH_RETRY_FRAME) {
    // The retry reaches a CATCH_RETRY_FRAME before the atomic frame
    ASSERT(outer != NO_TREC);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1437
1438
1439
    // Abort the transaction attempting the current branch
    foreign "C" stmAbortTransaction(MyCapability() "ptr", trec "ptr") [];
    foreign "C" stmFreeAbortedTRec(MyCapability() "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1440
    if (!StgCatchRetryFrame_running_alt_code(frame) != 0::I32) {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1441
      // Retry in the first branch: try the alternative
1442
      ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
1443
      StgTSO_trec(CurrentTSO) = trec;
1444
      StgCatchRetryFrame_running_alt_code(frame) = 1 :: CInt; // true;
1445
      R1 = StgCatchRetryFrame_alt_code(frame);
1446
      jump stg_ap_v_fast;
1447
    } else {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1448
1449
1450
1451
      // Retry in the alternative code: propagate the retry
      StgTSO_trec(CurrentTSO) = outer;
      Sp = Sp + SIZEOF_StgCatchRetryFrame;
      goto retry_pop_stack;
1452
1453
1454
1455
1456
    }
  }

  // We've reached the ATOMICALLY_FRAME: attempt to wait 
  ASSERT(frame_type == ATOMICALLY_FRAME);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1457
1458
1459
1460
1461
1462
1463
  if (outer != NO_TREC) {
    // We called retry while checking invariants, so abort the current
    // invariant check (merging its TVar accesses into the parents read
    // set so we'll wait on them)
    foreign "C" stmAbortTransaction(MyCapability() "ptr", trec "ptr") [];
    foreign "C" stmFreeAbortedTRec(MyCapability() "ptr", trec "ptr") [];
    trec = outer;
1464
1465
    StgTSO_trec(CurrentTSO) = trec;
    ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1466
  }
1467
  ASSERT(outer == NO_TREC);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1468

1469
  (r) = foreign "C" stmWait(MyCapability() "ptr", CurrentTSO "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1470
  if (r != 0) {
1471
    // Transaction was valid: stmWait put us on the TVars' queues, we now block
1472
    StgHeader_info(frame) = stg_atomically_waiting_frame_info;
1473
    Sp = frame;
1474
    // Fix up the stack in the unregisterised case: the return convention is different.
1475
1476
    R3 = trec; // passing to stmWaitUnblock()
    jump stg_block_stmwait;
1477
1478
  } else {
    // Transaction was not valid: retry immediately
1479