PrimOps.cmm 61 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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
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;
import base_GHCziIOBase_NestedAtomically_closure;
import pthread_mutex_lock;
import pthread_mutex_unlock;
50 51
import EnterCriticalSection
import LeaveCriticalSection
52
#endif
53

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
/*-----------------------------------------------------------------------------
  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;
76
    ("ptr" p) = foreign "C" allocateLocal(MyCapability() "ptr",words) [];
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
    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);
}

newPinnedByteArrayzh_fast
{
    W_ words, payload_words, n, p;

    MAYBE_GC(NO_PTRS,newPinnedByteArrayzh_fast);
    n = R1;
    payload_words = ROUNDUP_BYTES_TO_WDS(n);

    // We want an 8-byte aligned array.  allocatePinned() gives us
    // 8-byte aligned memory by default, but we want to align the
    // *goods* inside the ArrWords object, so we have to check the
    // size of the ArrWords header and adjust our size accordingly.
    words = BYTES_TO_WDS(SIZEOF_StgArrWords) + payload_words;
    if ((SIZEOF_StgArrWords & 7) != 0) {
	words = words + 1;
    }

100
    ("ptr" p) = foreign "C" allocatePinned(words) [];
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
    TICK_ALLOC_PRIM(SIZEOF_StgArrWords,WDS(payload_words),0);

    // Again, if the ArrWords header isn't a multiple of 8 bytes, we
    // have to push the object forward one word so that the goods
    // fall on an 8-byte boundary.
    if ((SIZEOF_StgArrWords & 7) != 0) {
	p = p + WDS(1);
    }

    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;
124
    ("ptr" arr) = foreign "C" allocateLocal(MyCapability() "ptr",words) [R2];
125 126
    TICK_ALLOC_PRIM(SIZEOF_StgMutArrPtrs, WDS(n), 0);

127
    SET_HDR(arr, stg_MUT_ARR_PTRS_DIRTY_info, W_[CCCS]);
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
    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).
  // 
152
  // So that we can tell whether a MUT_ARR_PTRS_FROZEN is on the mutable list,
153 154 155
  // 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.
  //
156 157
  // 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
158
  // the closure type is MUT_ARR_PTRS_FROZEN0 if it is on the mutable list,
159 160 161
  // 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.
162
  //
163
  if (StgHeader_info(R1) != stg_MUT_ARR_PTRS_FROZEN0_info) {
164
	SET_INFO(R1,stg_MUT_ARR_PTRS_DIRTY_info);
165
	recordMutable(R1, R1);
166 167 168
	// must be done after SET_INFO, because it ASSERTs closure_MUTABLE()
	RET_P(R1);
  } else {
169
	SET_INFO(R1,stg_MUT_ARR_PTRS_DIRTY_info);
170
	RET_P(R1);
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
  }
}

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

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

    ALLOC_PRIM( SIZEOF_StgMutVar, R1_PTR, newMutVarzh_fast);

    mv = Hp - SIZEOF_StgMutVar + WDS(1);
186
    SET_HDR(mv,stg_MUT_VAR_DIRTY_info,W_[CCCS]);
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
    StgMutVar_var(mv) = R1;
    
    RET_P(mv);
}

atomicModifyMutVarzh_fast
{
    W_ mv, z, x, y, r;
    /* 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
214
#define THUNK_1_SIZE (SIZEOF_StgThunkHeader + WDS(MIN_UPD_SIZE))
215 216
#define TICK_ALLOC_THUNK_1() TICK_ALLOC_UP_THK(WDS(1),WDS(MIN_UPD_SIZE-1))
#else
217
#define THUNK_1_SIZE (SIZEOF_StgThunkHeader + WDS(1))
218 219 220 221
#define TICK_ALLOC_THUNK_1() TICK_ALLOC_UP_THK(WDS(1),0)
#endif

#if MIN_UPD_SIZE > 2
222
#define THUNK_2_SIZE (SIZEOF_StgThunkHeader + WDS(MIN_UPD_SIZE))
223 224
#define TICK_ALLOC_THUNK_2() TICK_ALLOC_UP_THK(WDS(2),WDS(MIN_UPD_SIZE-2))
#else
225
#define THUNK_2_SIZE (SIZEOF_StgThunkHeader + WDS(2))
226 227 228 229 230 231 232
#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);

233
#if defined(THREADED_RTS)
234
    ACQUIRE_LOCK(atomic_modify_mutvar_mutex "ptr") [R1,R2];
235 236
#endif

237 238 239 240 241 242 243
   x = StgMutVar_var(R1);

   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);
244 245
   StgThunk_payload(z,0) = R2;
   StgThunk_payload(z,1) = x;
246 247 248 249 250 251

   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);
252
   StgThunk_payload(y,0) = z;
253 254

   StgMutVar_var(R1) = y;
255
   foreign "C" dirty_MUT_VAR(BaseReg "ptr", R1 "ptr") [R1];
256 257 258 259 260 261

   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);
262 263
   StgThunk_payload(r,0) = z;

264
#if defined(THREADED_RTS)
265
    RELEASE_LOCK(atomic_modify_mutvar_mutex "ptr") [];
266
#endif
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300

   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]);

  StgWeak_key(w)       = R1;
  StgWeak_value(w)     = R2;
  StgWeak_finalizer(w) = R3;

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

301
  IF_DEBUG(weak, foreign "C" debugBelch(stg_weak_msg,w) []);
302 303 304 305 306 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 333 334 335 336 337 338 339

  RET_P(w);
}


finalizzeWeakzh_fast
{
  /* R1 = weak ptr
   */
  W_ w, f;

  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);

  f = StgWeak_finalizer(w);
340
  StgDeadWeak_link(w) = StgWeak_link(w);
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 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 403 404 405 406 407 408 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 436 437 438 439 440 441 442 443 444

  /* 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;
445
   W_ hi, lo, s, neg, words_needed, p;
446 447 448 449

   val = L1;
   neg = 0;

450 451 452 453
   hi = TO_W_(val >> 32);
   lo = TO_W_(val);

   if ( hi != 0 && hi != 0xFFFFFFFF )  { 
454 455 456 457 458 459 460 461 462 463 464 465 466
       words_needed = 2;
   } else { 
       // minimum is one word
       words_needed = 1;
   }

   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;

467
   if ( %lt(hi,0) ) {
468
     neg = 1;
469 470 471 472 473 474
     lo = -lo;
     if(lo == 0) {
       hi = -hi;
     } else {
       hi = -hi - 1;
     }
475 476 477 478
   }

   if ( words_needed == 2 )  { 
      s = 2;
479
      Hp(-1) = lo;
480 481
      Hp(0) = hi;
   } else { 
482
       if ( lo != 0 ) {
483
	   s = 1;
484
	   Hp(0) = lo;
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
       } 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;
503
   W_ hi, lo, s, words_needed, p;
504 505

   val = L1;
506 507 508 509
   hi = TO_W_(val >> 32);
   lo = TO_W_(val);

   if ( hi != 0 ) {
510 511 512 513 514 515 516 517 518 519 520 521
      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;

522
   if ( hi != 0 ) { 
523
     s = 2;
524
     Hp(-1) = lo;
525 526
     Hp(0)  = hi;
   } else {
527
      if ( lo != 0 ) {
528
        s = 1;
529
        Hp(0) = lo;
530 531 532 533 534 535 536 537 538 539 540 541
     } else /* val==0 */  {
      s = 0;
     }
  }

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


542

543 544 545 546
#endif /* SUPPORT_LONG_LONGS */

/* ToDo: this is shockingly inefficient */

547
#ifndef THREADED_RTS
548 549 550 551 552 553 554 555 556 557 558
section "bss" {
  mp_tmp1:
    bits8 [SIZEOF_MP_INT];
}

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

section "bss" {
559
  mp_result1:
560 561 562 563
    bits8 [SIZEOF_MP_INT];
}

section "bss" {
564
  mp_result2:
565 566
    bits8 [SIZEOF_MP_INT];
}
567 568
#endif

569
#ifdef THREADED_RTS
570 571 572 573 574 575
#define FETCH_MP_TEMP(X) \
W_ X; \
X = BaseReg + (OFFSET_StgRegTable_r ## X);
#else
#define FETCH_MP_TEMP(X) /* Nothing */
#endif
576

577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
#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);                         \
                                                                        \
602
  foreign "C" __gmpz_init(mp_result1 "ptr") [];                            \
603 604
                                                                        \
  /* Perform the operation */                                           \
605
  foreign "C" mp_fun(mp_result1 "ptr",mp_tmp1  "ptr",mp_tmp2  "ptr") []; \
606 607 608
                                                                        \
  RET_NP(TO_W_(MP_INT__mp_size(mp_result1)),                            \
         MP_INT__mp_d(mp_result1) - SIZEOF_StgArrWords);                \
609 610
}

611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
#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);                     \
                                                                        \
629
  foreign "C" __gmpz_init(mp_result1 "ptr") [];                            \
630 631
                                                                        \
  /* Perform the operation */                                           \
632
  foreign "C" mp_fun(mp_result1 "ptr",mp_tmp1 "ptr") [];                \
633 634 635
                                                                        \
  RET_NP(TO_W_(MP_INT__mp_size(mp_result1)),                            \
         MP_INT__mp_d(mp_result1) - SIZEOF_StgArrWords);                \
636 637
}

638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
#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);                                     \
                                                                                        \
663 664
  foreign "C" __gmpz_init(mp_result1 "ptr") [];                                               \
  foreign "C" __gmpz_init(mp_result2 "ptr") [];                                               \
665 666
                                                                                        \
  /* Perform the operation */                                                           \
667
  foreign "C" mp_fun(mp_result1 "ptr",mp_result2 "ptr",mp_tmp1 "ptr",mp_tmp2 "ptr") [];    \
668 669 670 671 672
                                                                                        \
  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);                              \
673 674
}

675 676 677 678 679 680 681 682 683 684 685 686 687 688
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)
689

690
#ifndef THREADED_RTS
691
section "bss" {
692
  mp_tmp_w:  W_; // NB. mp_tmp_w is really an here mp_limb_t
693
}
694
#endif
695 696 697 698 699

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

702
    W_[mp_tmp_w] = R1;
703
    (r) = foreign "C" __gmpn_gcd_1(mp_tmp_w "ptr", 1, R2) [];
704 705 706 707 708 709 710 711 712 713

    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 */
714 715 716
    W_ s1;
    (s1) = foreign "C" __gmpn_gcd_1( BYTE_ARR_CTS(R2) "ptr", R1, R3) [];
    R1 = s1;
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
    
    /* 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;

732
    // paraphrased from __gmpz_cmp_si() in the GMP sources
733 734 735 736 737 738 739 740 741 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 769 770 771 772 773
    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;

774
    // paraphrased from __gmpz_cmp() in the GMP sources
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
    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);

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

799
    if (cmp == 0 :: CInt) {
800 801 802 803
	R1 = 0; 
	jump %ENTRY_CODE(Sp(0));
    }

804
    if (%lt(cmp,0 :: CInt) == %lt(usize,0)) {
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
	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));
}

decodeFloatzh_fast
{ 
    W_ p;
    F_ arg;
855 856
    FETCH_MP_TEMP(mp_tmp1);
    FETCH_MP_TEMP(mp_tmp_w);
857 858 859 860 861 862 863 864 865 866 867 868 869 870
    
    /* arguments: F1 = Float# */
    arg = F1;
    
    ALLOC_PRIM( SIZEOF_StgArrWords + WDS(1), NO_PTRS, decodeFloatzh_fast );
    
    /* Be prepared to tell Lennart-coded __decodeFloat
       where mantissa._mp_d can be put (it does not care about the rest) */
    p = Hp - SIZEOF_StgArrWords;
    SET_HDR(p,stg_ARR_WORDS_info,W_[CCCS]);
    StgArrWords_words(p) = 1;
    MP_INT__mp_d(mp_tmp1) = BYTE_ARR_CTS(p);
    
    /* Perform the operation */
871
    foreign "C" __decodeFloat(mp_tmp1 "ptr",mp_tmp_w "ptr" ,arg) [];
872 873
    
    /* returns: (Int# (expn), Int#, ByteArray#) */
874
    RET_NNP(W_[mp_tmp_w], TO_W_(MP_INT__mp_size(mp_tmp1)), p);
875 876 877 878 879 880 881 882 883
}

#define DOUBLE_MANTISSA_SIZE SIZEOF_DOUBLE
#define ARR_SIZE (SIZEOF_StgArrWords + DOUBLE_MANTISSA_SIZE)

decodeDoublezh_fast
{ 
    D_ arg;
    W_ p;
884 885
    FETCH_MP_TEMP(mp_tmp1);
    FETCH_MP_TEMP(mp_tmp_w);
886 887 888 889 890 891 892 893 894 895 896 897 898 899

    /* 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 */
900
    foreign "C" __decodeDouble(mp_tmp1 "ptr", mp_tmp_w "ptr",arg) [];
901 902
    
    /* returns: (Int# (expn), Int#, ByteArray#) */
903
    RET_NNP(W_[mp_tmp_w], TO_W_(MP_INT__mp_size(mp_tmp1)), p);
904 905 906 907 908 909 910 911 912
}

/* -----------------------------------------------------------------------------
 * Concurrency primitives
 * -------------------------------------------------------------------------- */

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

914 915
  MAYBE_GC(R1_PTR, forkzh_fast);

916 917 918 919
  W_ closure;
  W_ threadid;
  closure = R1;

920
  ("ptr" threadid) = foreign "C" createIOThread( MyCapability() "ptr", 
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
				RtsFlags_GcFlags_initialStkSize(RtsFlags), 
				closure "ptr") [];
  foreign "C" scheduleThread(MyCapability() "ptr", threadid "ptr") [];

  // switch at the earliest opportunity
  CInt[context_switch] = 1 :: CInt;
  
  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;

943
  ("ptr" threadid) = foreign "C" createIOThread( MyCapability() "ptr", 
944
				RtsFlags_GcFlags_initialStkSize(RtsFlags), 
945 946
				closure "ptr") [];
  foreign "C" scheduleThreadOn(MyCapability() "ptr", cpu, threadid "ptr") [];
947 948

  // switch at the earliest opportunity
949
  CInt[context_switch] = 1 :: CInt;
950
  
951
  RET_P(threadid);
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
}

yieldzh_fast
{
  jump stg_yield_noregs;
}

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

labelThreadzh_fast
{
  /* args: 
	R1 = ThreadId#
	R2 = Addr# */
#ifdef DEBUG
971
  foreign "C" labelThread(R1 "ptr", R2 "ptr") [];
972 973 974 975 976 977 978 979
#endif
  jump %ENTRY_CODE(Sp(0));
}

isCurrentThreadBoundzh_fast
{
  /* no args */
  W_ r;
980
  (r) = foreign "C" isThreadBound(CurrentTSO) [];
981 982 983
  RET_N(r);
}

984 985 986 987 988 989 990 991 992 993 994 995 996 997 998

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

#ifdef REG_R1
#define SP_OFF 0
#define IF_NOT_REG_R1(x) 
#else
#define SP_OFF 1
#define IF_NOT_REG_R1(x) x
#endif

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

999
INFO_TABLE_RET(stg_catch_retry_frame, CATCH_RETRY_FRAME,
1000
#if defined(PROFILING)
1001
  W_ unused1, W_ unused2,
1002
#endif
1003
  W_ unused3, "ptr" W_ unused4, "ptr" W_ unused5)
1004 1005 1006 1007 1008 1009
{
   W_ r, frame, trec, outer;
   IF_NOT_REG_R1(W_ rval;  rval = Sp(0);  Sp_adj(1); )

   frame = Sp;
   trec = StgTSO_trec(CurrentTSO);
1010 1011
   ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
   (r) = foreign "C" stmCommitNestedTransaction(MyCapability() "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1012
   if (r != 0) {
1013 1014 1015 1016 1017 1018
     /* Succeeded (either first branch or second branch) */
     StgTSO_trec(CurrentTSO) = outer;
     Sp = Sp + SIZEOF_StgCatchRetryFrame;
     IF_NOT_REG_R1(Sp_adj(-1); Sp(0) = rval;)
     jump %ENTRY_CODE(Sp(SP_OFF));
   } else {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1019
     /* Did not commit: re-execute */
1020
     W_ new_trec;
1021
     ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
1022
     StgTSO_trec(CurrentTSO) = new_trec;
Simon Marlow's avatar
Simon Marlow committed
1023
     if (StgCatchRetryFrame_running_alt_code(frame) != 0::I32) {
1024 1025 1026 1027
       R1 = StgCatchRetryFrame_alt_code(frame);
     } else {
       R1 = StgCatchRetryFrame_first_code(frame);
     }
1028
     jump stg_ap_v_fast;
1029 1030
   }
}
1031 1032


Simon Marlow's avatar
Simon Marlow committed
1033
// Atomically frame ------------------------------------------------------------
1034

1035
INFO_TABLE_RET(stg_atomically_frame, ATOMICALLY_FRAME,
1036
#if defined(PROFILING)
1037
  W_ unused1, W_ unused2,
1038
#endif
1039
  "ptr" W_ unused3, "ptr" W_ unused4)
1040
{
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1041
  W_ frame, trec, valid, next_invariant, q, outer;
1042
  IF_NOT_REG_R1(W_ rval;  rval = Sp(0);  Sp_adj(1); )
1043

1044 1045
  frame = Sp;
  trec = StgTSO_trec(CurrentTSO);
1046
  ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1047 1048 1049

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

  } else {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
    /* 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 */
1071
    ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", trec "ptr") [];
1072
    StgTSO_trec(CurrentTSO) = trec;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1073 1074 1075

    next_invariant = StgInvariantCheckQueue_invariant(q);
    R1 = StgAtomicInvariant_code(next_invariant);
1076
    jump stg_ap_v_fast;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1077 1078 1079 1080

  } else {

    /* We've got no more invariants to check, try to commit */
1081
    (valid) = foreign "C" stmCommitTransaction(MyCapability() "ptr", trec "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1082 1083 1084 1085 1086 1087 1088 1089
    if (valid != 0) {
      /* Transaction was valid: commit succeeded */
      StgTSO_trec(CurrentTSO) = NO_TREC;
      Sp = Sp + SIZEOF_StgAtomicallyFrame;
      IF_NOT_REG_R1(Sp_adj(-1); Sp(0) = rval;)
      jump %ENTRY_CODE(Sp(SP_OFF));
    } else {
      /* Transaction was not valid: try again */
1090
      ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1091 1092 1093 1094 1095
      StgTSO_trec(CurrentTSO) = trec;
      StgAtomicallyFrame_next_invariant_to_check(frame) = END_INVARIANT_CHECK_QUEUE;
      R1 = StgAtomicallyFrame_code(frame);
      jump stg_ap_v_fast;
    }
1096 1097 1098
  }
}

1099 1100 1101 1102 1103
INFO_TABLE_RET(stg_atomically_waiting_frame, ATOMICALLY_FRAME,
#if defined(PROFILING)
  W_ unused1, W_ unused2,
#endif
  "ptr" W_ unused3, "ptr" W_ unused4)
1104 1105 1106 1107 1108 1109 1110
{
  W_ frame, trec, valid;
  IF_NOT_REG_R1(W_ rval;  rval = Sp(0);  Sp_adj(1); )

  frame = Sp;

  /* The TSO is currently waiting: should we stop waiting? */
1111
  (valid) = foreign "C" stmReWait(MyCapability() "ptr", CurrentTSO "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1112
  if (valid != 0) {
1113
    /* Previous attempt is still valid: no point trying again yet */
1114 1115 1116
	  IF_NOT_REG_R1(Sp_adj(-2);
			Sp(1) = stg_NO_FINALIZER_closure;
		  	Sp(0) = stg_ut_1_0_unreg_info;)
1117 1118 1119
    jump stg_block_noregs;
  } else {
    /* Previous attempt is no longer valid: try again */
1120
    ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr") [];
1121 1122 1123
    StgTSO_trec(CurrentTSO) = trec;
    StgHeader_info(frame) = stg_atomically_frame_info;
    R1 = StgAtomicallyFrame_code(frame);
1124
    jump stg_ap_v_fast;
1125
  }
1126
}
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140

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

#ifdef REG_R1
#define SP_OFF 0
#else
#define SP_OFF 1
#endif

/* 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.
 */

1141 1142 1143 1144 1145
INFO_TABLE_RET(stg_catch_stm_frame, CATCH_STM_FRAME,
#if defined(PROFILING)
  W_ unused1, W_ unused2,
#endif
  "ptr" W_ unused3, "ptr" W_ unused4)
Simon Marlow's avatar
Simon Marlow committed
1146 1147 1148 1149 1150
   {
      IF_NOT_REG_R1(W_ rval;  rval = Sp(0);  Sp_adj(1); )
      W_ r, frame, trec, outer;
      frame = Sp;
      trec = StgTSO_trec(CurrentTSO);
1151 1152
      ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
      (r) = foreign "C" stmCommitNestedTransaction(MyCapability() "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1153 1154 1155 1156 1157 1158 1159 1160 1161
      if (r != 0) {
        /* Commit succeeded */
        StgTSO_trec(CurrentTSO) = outer;
        Sp = Sp + SIZEOF_StgCatchSTMFrame;
        IF_NOT_REG_R1(Sp_adj(-1); Sp(0) = rval;)
        jump Sp(SP_OFF);
      } else {
        /* Commit failed */
        W_ new_trec;
1162
        ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1163 1164 1165 1166 1167
        StgTSO_trec(CurrentTSO) = new_trec;
        R1 = StgCatchSTMFrame_code(frame);
        jump stg_ap_v_fast;
      }
   }
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177


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

atomicallyzh_fast
{
  W_ frame;
  W_ old_trec;
  W_ new_trec;
  
1178 1179 1180
  // stmStartTransaction may allocate
  MAYBE_GC (R1_PTR, atomicallyzh_fast); 

1181 1182 1183
  /* Args: R1 = m :: STM a */
  STK_CHK_GEN(SIZEOF_StgAtomicallyFrame + WDS(1), R1_PTR, atomicallyzh_fast);

1184 1185 1186 1187
  old_trec = StgTSO_trec(CurrentTSO);

  /* Nested transactions are not allowed; raise an exception */
  if (old_trec != NO_TREC) {
1188
     R1 = base_GHCziIOBase_NestedAtomically_closure;
1189 1190 1191
     jump raisezh_fast;
  }

1192 1193 1194 1195
  /* Set up the atomically frame */
  Sp = Sp - SIZEOF_StgAtomicallyFrame;
  frame = Sp;

1196
  SET_HDR(frame,stg_atomically_frame_info, W_[CCCS]);
1197
  StgAtomicallyFrame_code(frame) = R1;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1198
  StgAtomicallyFrame_next_invariant_to_check(frame) = END_INVARIANT_CHECK_QUEUE;
1199 1200

  /* Start the memory transcation */
1201
  ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", old_trec "ptr") [R1];
1202 1203 1204
  StgTSO_trec(CurrentTSO) = new_trec;

  /* Apply R1 to the realworld token */
1205
  jump stg_ap_v_fast;
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
}


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;

1221
  SET_HDR(frame, stg_catch_stm_frame_info, W_[CCCS]);
1222
  StgCatchSTMFrame_handler(frame) = R2;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1223 1224 1225 1226 1227 1228
  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);
1229
  ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", cur_trec "ptr");
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1230
  StgTSO_trec(CurrentTSO) = new_trec;
1231 1232

  /* Apply R1 to the realworld token */
1233
  jump stg_ap_v_fast;
1234 1235 1236 1237 1238 1239 1240 1241 1242
}


catchRetryzh_fast
{
  W_ frame;
  W_ new_trec;
  W_ trec;

1243 1244 1245
  // stmStartTransaction may allocate
  MAYBE_GC (R1_PTR & R2_PTR, catchRetryzh_fast); 

1246 1247 1248 1249 1250 1251
  /* 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);
1252
  ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", trec "ptr") [R1,R2];
1253 1254 1255 1256 1257 1258
  StgTSO_trec(CurrentTSO) = new_trec;

  /* Set up the catch-retry frame */
  Sp = Sp - SIZEOF_StgCatchRetryFrame;
  frame = Sp;
  
1259
  SET_HDR(frame, stg_catch_retry_frame_info, W_[CCCS]);
1260
  StgCatchRetryFrame_running_alt_code(frame) = 0 :: CInt; // false;
1261 1262 1263 1264
  StgCatchRetryFrame_first_code(frame) = R1;
  StgCatchRetryFrame_alt_code(frame) = R2;

  /* Apply R1 to the realworld token */
1265
  jump stg_ap_v_fast;
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
}


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

1277
  MAYBE_GC (NO_PTRS, retryzh_fast); // STM operations may allocate
1278 1279 1280 1281

  // Find the enclosing ATOMICALLY_FRAME or CATCH_RETRY_FRAME
retry_pop_stack:
  StgTSO_sp(CurrentTSO) = Sp;
1282
  (frame_type) = foreign "C" findRetryFrameHelper(CurrentTSO "ptr") [];
1283 1284
  Sp = StgTSO_sp(CurrentTSO);
  frame = Sp;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1285
  trec = StgTSO_trec(CurrentTSO);
1286
  ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
1287 1288 1289 1290

  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
1291 1292 1293
    // 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
1294
    if (!StgCatchRetryFrame_running_alt_code(frame) != 0::I32) {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1295
      // Retry in the first branch: try the alternative
1296
      ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
1297
      StgTSO_trec(CurrentTSO) = trec;
1298
      StgCatchRetryFrame_running_alt_code(frame) = 1 :: CInt; // true;
1299
      R1 = StgCatchRetryFrame_alt_code(frame);
1300
      jump stg_ap_v_fast;
1301
    } else {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1302 1303 1304 1305
      // Retry in the alternative code: propagate the retry
      StgTSO_trec(CurrentTSO) = outer;
      Sp = Sp + SIZEOF_StgCatchRetryFrame;
      goto retry_pop_stack;
1306 1307 1308 1309 1310
    }
  }

  // We've reached the ATOMICALLY_FRAME: attempt to wait 
  ASSERT(frame_type == ATOMICALLY_FRAME);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1311 1312 1313 1314 1315 1316 1317
  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;
1318 1319
    StgTSO_trec(CurrentTSO) = trec;
    ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1320
  }
1321
  ASSERT(outer == NO_TREC);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1322

1323
  (r) = foreign "C" stmWait(MyCapability() "ptr", CurrentTSO "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1324
  if (r != 0) {
1325
    // Transaction was valid: stmWait put us on the TVars' queues, we now block
1326
    StgHeader_info(frame) = stg_atomically_waiting_frame_info;
1327
    Sp = frame;
1328 1329 1330 1331
    // Fix up the stack in the unregisterised case: the return convention is different.
    IF_NOT_REG_R1(Sp_adj(-2); 
		  Sp(1) = stg_NO_FINALIZER_closure;
		  Sp(0) = stg_ut_1_0_unreg_info;)
1332 1333
    R3 = trec; // passing to stmWaitUnblock()
    jump stg_block_stmwait;
1334 1335
  } else {
    // Transaction was not valid: retry immediately
1336
    ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
1337 1338 1339
    StgTSO_trec(CurrentTSO) = trec;
    R1 = StgAtomicallyFrame_code(frame);
    Sp = frame;
1340
    jump stg_ap_v_fast;
1341 1342 1343 1344
  }
}


tharris@microsoft.com's avatar
tharris@microsoft.com committed
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
checkzh_fast
{
  W_ trec, closure;

  /* Args: R1 = invariant closure */
  MAYBE_GC (R1_PTR, checkzh_fast); 

  trec = StgTSO_trec(CurrentTSO);
  closure = R1;
  foreign "C" stmAddInvariantToCheck(MyCapability() "ptr", 
                                     trec "ptr",
                                     closure "ptr") [];

  jump %ENTRY_CODE(Sp(0));
}


1362 1363 1364
newTVarzh_fast
{
  W_ tv;
1365
  W_ new_value;
1366 1367 1368

  /* Args: R1 = initialisation value */

1369 1370
  MAYBE_GC (R1_PTR, newTVarzh_fast); 
  new_value = R1;