PrimOps.cmm 60.6 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 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
/* -----------------------------------------------------------------------------
 *
 * (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"

/*-----------------------------------------------------------------------------
  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;
52
    "ptr" p = foreign "C" allocateLocal(MyCapability() "ptr",words) [];
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
    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;
    }

76
    "ptr" p = foreign "C" allocatePinned(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);

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

103
    SET_HDR(arr, stg_MUT_ARR_PTRS_DIRTY_info, W_[CCCS]);
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
    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).
  // 
128
  // So that we can tell whether a MUT_ARR_PTRS_FROZEN is on the mutable list,
129 130 131
  // 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.
  //
132 133
  // 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
134
  // the closure type is MUT_ARR_PTRS_FROZEN0 if it is on the mutable list,
135 136 137
  // 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.
138
  //
139
  if (StgHeader_info(R1) != stg_MUT_ARR_PTRS_FROZEN0_info) {
140
	SET_INFO(R1,stg_MUT_ARR_PTRS_DIRTY_info);
141
	recordMutable(R1, R1);
142 143 144
	// must be done after SET_INFO, because it ASSERTs closure_MUTABLE()
	RET_P(R1);
  } else {
145
	SET_INFO(R1,stg_MUT_ARR_PTRS_DIRTY_info);
146
	RET_P(R1);
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
  }
}

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

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

    ALLOC_PRIM( SIZEOF_StgMutVar, R1_PTR, newMutVarzh_fast);

    mv = Hp - SIZEOF_StgMutVar + WDS(1);
162
    SET_HDR(mv,stg_MUT_VAR_DIRTY_info,W_[CCCS]);
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
    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
190
#define THUNK_1_SIZE (SIZEOF_StgThunkHeader + WDS(MIN_UPD_SIZE))
191 192
#define TICK_ALLOC_THUNK_1() TICK_ALLOC_UP_THK(WDS(1),WDS(MIN_UPD_SIZE-1))
#else
193
#define THUNK_1_SIZE (SIZEOF_StgThunkHeader + WDS(1))
194 195 196 197
#define TICK_ALLOC_THUNK_1() TICK_ALLOC_UP_THK(WDS(1),0)
#endif

#if MIN_UPD_SIZE > 2
198
#define THUNK_2_SIZE (SIZEOF_StgThunkHeader + WDS(MIN_UPD_SIZE))
199 200
#define TICK_ALLOC_THUNK_2() TICK_ALLOC_UP_THK(WDS(2),WDS(MIN_UPD_SIZE-2))
#else
201
#define THUNK_2_SIZE (SIZEOF_StgThunkHeader + WDS(2))
202 203 204 205 206 207 208
#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);

209
#if defined(THREADED_RTS)
210
    foreign "C" ACQUIRE_LOCK(atomic_modify_mutvar_mutex "ptr") [R1,R2];
211 212
#endif

213 214 215 216 217 218 219
   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);
220 221
   StgThunk_payload(z,0) = R2;
   StgThunk_payload(z,1) = x;
222 223 224 225 226 227

   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);
228
   StgThunk_payload(y,0) = z;
229 230

   StgMutVar_var(R1) = y;
231
   foreign "C" dirty_MUT_VAR(BaseReg "ptr", R1 "ptr") [R1];
232 233 234 235 236 237

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

240
#if defined(THREADED_RTS)
241
    foreign "C" RELEASE_LOCK(atomic_modify_mutvar_mutex "ptr") [];
242
#endif
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276

   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;

277
  IF_DEBUG(weak, foreign "C" debugBelch(stg_weak_msg,w) []);
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315

  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);
316
  StgDeadWeak_link(w) = StgWeak_link(w);
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 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

  /* 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;
421
   W_ hi, lo, s, neg, words_needed, p;
422 423 424 425

   val = L1;
   neg = 0;

426 427 428 429
   hi = TO_W_(val >> 32);
   lo = TO_W_(val);

   if ( hi != 0 && hi != 0xFFFFFFFF )  { 
430 431 432 433 434 435 436 437 438 439 440 441 442
       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;

443
   if ( %lt(hi,0) ) {
444
     neg = 1;
445 446 447 448 449 450
     lo = -lo;
     if(lo == 0) {
       hi = -hi;
     } else {
       hi = -hi - 1;
     }
451 452 453 454
   }

   if ( words_needed == 2 )  { 
      s = 2;
455
      Hp(-1) = lo;
456 457
      Hp(0) = hi;
   } else { 
458
       if ( lo != 0 ) {
459
	   s = 1;
460
	   Hp(0) = lo;
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
       } 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;
479
   W_ hi, lo, s, words_needed, p;
480 481

   val = L1;
482 483 484 485
   hi = TO_W_(val >> 32);
   lo = TO_W_(val);

   if ( hi != 0 ) {
486 487 488 489 490 491 492 493 494 495 496 497
      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;

498
   if ( hi != 0 ) { 
499
     s = 2;
500
     Hp(-1) = lo;
501 502
     Hp(0)  = hi;
   } else {
503
      if ( lo != 0 ) {
504
        s = 1;
505
        Hp(0) = lo;
506 507 508 509 510 511 512 513 514 515 516 517
     } else /* val==0 */  {
      s = 0;
     }
  }

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


518

519 520 521 522
#endif /* SUPPORT_LONG_LONGS */

/* ToDo: this is shockingly inefficient */

523
#ifndef THREADED_RTS
524 525 526 527 528 529 530 531 532 533 534
section "bss" {
  mp_tmp1:
    bits8 [SIZEOF_MP_INT];
}

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

section "bss" {
535
  mp_result1:
536 537 538 539
    bits8 [SIZEOF_MP_INT];
}

section "bss" {
540
  mp_result2:
541 542
    bits8 [SIZEOF_MP_INT];
}
543 544
#endif

545
#ifdef THREADED_RTS
546 547 548 549 550 551
#define FETCH_MP_TEMP(X) \
W_ X; \
X = BaseReg + (OFFSET_StgRegTable_r ## X);
#else
#define FETCH_MP_TEMP(X) /* Nothing */
#endif
552

553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
#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);                         \
                                                                        \
578
  foreign "C" __gmpz_init(mp_result1 "ptr") [];                            \
579 580
                                                                        \
  /* Perform the operation */                                           \
581
  foreign "C" mp_fun(mp_result1 "ptr",mp_tmp1  "ptr",mp_tmp2  "ptr") []; \
582 583 584
                                                                        \
  RET_NP(TO_W_(MP_INT__mp_size(mp_result1)),                            \
         MP_INT__mp_d(mp_result1) - SIZEOF_StgArrWords);                \
585 586
}

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

614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
#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);                                     \
                                                                                        \
639 640
  foreign "C" __gmpz_init(mp_result1 "ptr") [];                                               \
  foreign "C" __gmpz_init(mp_result2 "ptr") [];                                               \
641 642
                                                                                        \
  /* Perform the operation */                                                           \
643
  foreign "C" mp_fun(mp_result1 "ptr",mp_result2 "ptr",mp_tmp1 "ptr",mp_tmp2 "ptr") [];    \
644 645 646 647 648
                                                                                        \
  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);                              \
649 650
}

651 652 653 654 655 656 657 658 659 660 661 662 663 664
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)
665

666
#ifndef THREADED_RTS
667
section "bss" {
668
  mp_tmp_w:  W_; // NB. mp_tmp_w is really an here mp_limb_t
669
}
670
#endif
671 672 673 674 675

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

678
    W_[mp_tmp_w] = R1;
679
    r = foreign "C" __gmpn_gcd_1(mp_tmp_w "ptr", 1, R2) [];
680 681 682 683 684 685 686 687 688 689

    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 */
690
    R1 = foreign "C" __gmpn_gcd_1( BYTE_ARR_CTS(R2) "ptr", R1, R3) [];
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
    
    /* 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;

706
    // paraphrased from __gmpz_cmp_si() in the GMP sources
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
    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;

748
    // paraphrased from __gmpz_cmp() in the GMP sources
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
    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);

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

773
    if (cmp == 0 :: CInt) {
774 775 776 777
	R1 = 0; 
	jump %ENTRY_CODE(Sp(0));
    }

778
    if (%lt(cmp,0 :: CInt) == %lt(usize,0)) {
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
	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;
829 830
    FETCH_MP_TEMP(mp_tmp1);
    FETCH_MP_TEMP(mp_tmp_w);
831 832 833 834 835 836 837 838 839 840 841 842 843 844
    
    /* 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 */
845
    foreign "C" __decodeFloat(mp_tmp1 "ptr",mp_tmp_w "ptr" ,arg) [];
846 847
    
    /* returns: (Int# (expn), Int#, ByteArray#) */
848
    RET_NNP(W_[mp_tmp_w], TO_W_(MP_INT__mp_size(mp_tmp1)), p);
849 850 851 852 853 854 855 856 857
}

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

decodeDoublezh_fast
{ 
    D_ arg;
    W_ p;
858 859
    FETCH_MP_TEMP(mp_tmp1);
    FETCH_MP_TEMP(mp_tmp_w);
860 861 862 863 864 865 866 867 868 869 870 871 872 873

    /* 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 */
874
    foreign "C" __decodeDouble(mp_tmp1 "ptr", mp_tmp_w "ptr",arg) [];
875 876
    
    /* returns: (Int# (expn), Int#, ByteArray#) */
877
    RET_NNP(W_[mp_tmp_w], TO_W_(MP_INT__mp_size(mp_tmp1)), p);
878 879 880 881 882 883 884 885 886
}

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

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

888 889
  MAYBE_GC(R1_PTR, forkzh_fast);

890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
  W_ closure;
  W_ threadid;
  closure = R1;

  "ptr" threadid = foreign "C" createIOThread( MyCapability() "ptr", 
				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;

  "ptr" threadid = foreign "C" createIOThread( MyCapability() "ptr", 
918
				RtsFlags_GcFlags_initialStkSize(RtsFlags), 
919 920
				closure "ptr") [];
  foreign "C" scheduleThreadOn(MyCapability() "ptr", cpu, threadid "ptr") [];
921 922

  // switch at the earliest opportunity
923
  CInt[context_switch] = 1 :: CInt;
924
  
925
  RET_P(threadid);
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
}

yieldzh_fast
{
  jump stg_yield_noregs;
}

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

labelThreadzh_fast
{
  /* args: 
	R1 = ThreadId#
	R2 = Addr# */
#ifdef DEBUG
945
  foreign "C" labelThread(R1 "ptr", R2 "ptr") [];
946 947 948 949 950 951 952 953
#endif
  jump %ENTRY_CODE(Sp(0));
}

isCurrentThreadBoundzh_fast
{
  /* no args */
  W_ r;
954
  r = foreign "C" isThreadBound(CurrentTSO) [];
955 956 957
  RET_N(r);
}

958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974

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

#if defined(PROFILING)
#define CATCH_RETRY_FRAME_BITMAP 7
tharris@microsoft.com's avatar
tharris@microsoft.com committed
975
#define CATCH_RETRY_FRAME_WORDS  5
976 977
#else
#define CATCH_RETRY_FRAME_BITMAP 1
tharris@microsoft.com's avatar
tharris@microsoft.com committed
978
#define CATCH_RETRY_FRAME_WORDS  3
979 980 981 982
#endif

INFO_TABLE_RET(stg_catch_retry_frame,
	       CATCH_RETRY_FRAME_WORDS, CATCH_RETRY_FRAME_BITMAP,
Simon Marlow's avatar
Simon Marlow committed
983
	       CATCH_RETRY_FRAME)
984 985 986 987 988 989
{
   W_ r, frame, trec, outer;
   IF_NOT_REG_R1(W_ rval;  rval = Sp(0);  Sp_adj(1); )

   frame = Sp;
   trec = StgTSO_trec(CurrentTSO);
990
   "ptr" outer = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
991
   r = foreign "C" stmCommitNestedTransaction(MyCapability() "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
992
   if (r != 0) {
993 994 995 996 997 998
     /* 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
999
     /* Did not commit: re-execute */
1000
     W_ new_trec;
1001
     "ptr" new_trec = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
1002
     StgTSO_trec(CurrentTSO) = new_trec;
Simon Marlow's avatar
Simon Marlow committed
1003
     if (StgCatchRetryFrame_running_alt_code(frame) != 0::I32) {
1004 1005 1006 1007
       R1 = StgCatchRetryFrame_alt_code(frame);
     } else {
       R1 = StgCatchRetryFrame_first_code(frame);
     }
1008
     jump stg_ap_v_fast;
1009 1010
   }
}
1011 1012


Simon Marlow's avatar
Simon Marlow committed
1013
// Atomically frame ------------------------------------------------------------
1014 1015

#if defined(PROFILING)
1016
#define ATOMICALLY_FRAME_BITMAP 3
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1017
#define ATOMICALLY_FRAME_WORDS  4
1018
#else
1019
#define ATOMICALLY_FRAME_BITMAP 0
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1020
#define ATOMICALLY_FRAME_WORDS  2
1021 1022 1023 1024
#endif

INFO_TABLE_RET(stg_atomically_frame,
	       ATOMICALLY_FRAME_WORDS, ATOMICALLY_FRAME_BITMAP,
Simon Marlow's avatar
Simon Marlow committed
1025
	       ATOMICALLY_FRAME)
1026
{
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1027
  W_ frame, trec, valid, next_invariant, q, outer;
1028
  IF_NOT_REG_R1(W_ rval;  rval = Sp(0);  Sp_adj(1); )
1029

1030 1031
  frame = Sp;
  trec = StgTSO_trec(CurrentTSO);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1032 1033 1034 1035 1036 1037
  "ptr" outer = foreign "C" stmGetEnclosingTRec(trec "ptr") [];

  if (outer == NO_TREC) {
    /* First time back at the atomically frame -- pick up invariants */
    "ptr" q = foreign "C" stmGetInvariantsToCheck(MyCapability() "ptr", trec "ptr") [];
    StgAtomicallyFrame_next_invariant_to_check(frame) = q;
1038 1039

  } else {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
    /* 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 */
    "ptr" trec = foreign "C" stmStartTransaction(MyCapability() "ptr", trec "ptr") [];
1058
    StgTSO_trec(CurrentTSO) = trec;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1059 1060 1061

    next_invariant = StgInvariantCheckQueue_invariant(q);
    R1 = StgAtomicInvariant_code(next_invariant);
1062
    jump stg_ap_v_fast;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081

  } else {

    /* We've got no more invariants to check, try to commit */
    valid = foreign "C" stmCommitTransaction(MyCapability() "ptr", trec "ptr") [];
    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 */
      "ptr" trec = foreign "C" stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr") [];
      StgTSO_trec(CurrentTSO) = trec;
      StgAtomicallyFrame_next_invariant_to_check(frame) = END_INVARIANT_CHECK_QUEUE;
      R1 = StgAtomicallyFrame_code(frame);
      jump stg_ap_v_fast;
    }
1082 1083 1084 1085 1086
  }
}

INFO_TABLE_RET(stg_atomically_waiting_frame,
	       ATOMICALLY_FRAME_WORDS, ATOMICALLY_FRAME_BITMAP,
Simon Marlow's avatar
Simon Marlow committed
1087
	       ATOMICALLY_FRAME)
1088 1089 1090 1091 1092 1093 1094
{
  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? */
1095
  valid = foreign "C" stmReWait(MyCapability() "ptr", CurrentTSO "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1096
  if (valid != 0) {
1097
    /* Previous attempt is still valid: no point trying again yet */
1098 1099 1100
	  IF_NOT_REG_R1(Sp_adj(-2);
			Sp(1) = stg_NO_FINALIZER_closure;
		  	Sp(0) = stg_ut_1_0_unreg_info;)
1101 1102 1103
    jump stg_block_noregs;
  } else {
    /* Previous attempt is no longer valid: try again */
1104
    "ptr" trec = foreign "C" stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr") [];
1105 1106 1107
    StgTSO_trec(CurrentTSO) = trec;
    StgHeader_info(frame) = stg_atomically_frame_info;
    R1 = StgAtomicallyFrame_code(frame);
1108
    jump stg_ap_v_fast;
1109
  }
1110
}
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121

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

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

#if defined(PROFILING)
#define CATCH_STM_FRAME_BITMAP 3
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1122
#define CATCH_STM_FRAME_WORDS  4
1123 1124
#else
#define CATCH_STM_FRAME_BITMAP 0
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1125
#define CATCH_STM_FRAME_WORDS  2
1126 1127 1128 1129 1130 1131 1132 1133 1134
#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.
 */

INFO_TABLE_RET(stg_catch_stm_frame,
	       CATCH_STM_FRAME_WORDS, CATCH_STM_FRAME_BITMAP,
Simon Marlow's avatar
Simon Marlow committed
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
	       CATCH_STM_FRAME)
   {
      IF_NOT_REG_R1(W_ rval;  rval = Sp(0);  Sp_adj(1); )
      W_ r, frame, trec, outer;
      frame = Sp;
      trec = StgTSO_trec(CurrentTSO);
      "ptr" outer = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
      r = foreign "C" stmCommitNestedTransaction(MyCapability() "ptr", trec "ptr") [];
      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;
        "ptr" new_trec = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
        StgTSO_trec(CurrentTSO) = new_trec;
        R1 = StgCatchSTMFrame_code(frame);
        jump stg_ap_v_fast;
      }
   }
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167


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

atomicallyzh_fast
{
  W_ frame;
  W_ old_trec;
  W_ new_trec;
  
1168 1169 1170
  // stmStartTransaction may allocate
  MAYBE_GC (R1_PTR, atomicallyzh_fast); 

1171 1172 1173
  /* Args: R1 = m :: STM a */
  STK_CHK_GEN(SIZEOF_StgAtomicallyFrame + WDS(1), R1_PTR, atomicallyzh_fast);

1174 1175 1176 1177
  old_trec = StgTSO_trec(CurrentTSO);

  /* Nested transactions are not allowed; raise an exception */
  if (old_trec != NO_TREC) {
1178
     R1 = base_GHCziIOBase_NestedAtomically_closure;
1179 1180 1181
     jump raisezh_fast;
  }

1182 1183 1184 1185
  /* Set up the atomically frame */
  Sp = Sp - SIZEOF_StgAtomicallyFrame;
  frame = Sp;

1186
  SET_HDR(frame,stg_atomically_frame_info, W_[CCCS]);
1187
  StgAtomicallyFrame_code(frame) = R1;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1188
  StgAtomicallyFrame_next_invariant_to_check(frame) = END_INVARIANT_CHECK_QUEUE;
1189 1190

  /* Start the memory transcation */
1191
  "ptr" new_trec = foreign "C" stmStartTransaction(MyCapability() "ptr", old_trec "ptr") [R1];
1192 1193 1194
  StgTSO_trec(CurrentTSO) = new_trec;

  /* Apply R1 to the realworld token */
1195
  jump stg_ap_v_fast;
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
}


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;

1211
  SET_HDR(frame, stg_catch_stm_frame_info, W_[CCCS]);
1212
  StgCatchSTMFrame_handler(frame) = R2;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1213 1214 1215 1216 1217 1218 1219 1220
  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);
  "ptr" new_trec = foreign "C" stmStartTransaction(MyCapability() "ptr", cur_trec "ptr");
  StgTSO_trec(CurrentTSO) = new_trec;
1221 1222

  /* Apply R1 to the realworld token */
1223
  jump stg_ap_v_fast;
1224 1225 1226 1227 1228 1229 1230 1231 1232
}


catchRetryzh_fast
{
  W_ frame;
  W_ new_trec;
  W_ trec;

1233 1234 1235
  // stmStartTransaction may allocate
  MAYBE_GC (R1_PTR & R2_PTR, catchRetryzh_fast); 

1236 1237 1238 1239 1240 1241
  /* 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);
1242
  "ptr" new_trec = foreign "C" stmStartTransaction(MyCapability() "ptr", trec "ptr") [R1,R2];
1243 1244 1245 1246 1247 1248
  StgTSO_trec(CurrentTSO) = new_trec;

  /* Set up the catch-retry frame */
  Sp = Sp - SIZEOF_StgCatchRetryFrame;
  frame = Sp;
  
1249
  SET_HDR(frame, stg_catch_retry_frame_info, W_[CCCS]);
1250
  StgCatchRetryFrame_running_alt_code(frame) = 0 :: CInt; // false;
1251 1252 1253 1254
  StgCatchRetryFrame_first_code(frame) = R1;
  StgCatchRetryFrame_alt_code(frame) = R2;

  /* Apply R1 to the realworld token */
1255
  jump stg_ap_v_fast;
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
}


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

1267
  MAYBE_GC (NO_PTRS, retryzh_fast); // STM operations may allocate
1268 1269 1270 1271

  // Find the enclosing ATOMICALLY_FRAME or CATCH_RETRY_FRAME
retry_pop_stack:
  StgTSO_sp(CurrentTSO) = Sp;
1272
  frame_type = foreign "C" findRetryFrameHelper(CurrentTSO "ptr") [];
1273 1274
  Sp = StgTSO_sp(CurrentTSO);
  frame = Sp;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1275 1276
  trec = StgTSO_trec(CurrentTSO);
  "ptr" outer = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
1277 1278 1279 1280

  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
1281 1282 1283
    // 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
1284
    if (!StgCatchRetryFrame_running_alt_code(frame) != 0::I32) {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1285
      // Retry in the first branch: try the alternative
1286
      "ptr" trec = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
1287
      StgTSO_trec(CurrentTSO) = trec;
1288
      StgCatchRetryFrame_running_alt_code(frame) = 1 :: CInt; // true;
1289
      R1 = StgCatchRetryFrame_alt_code(frame);
1290
      jump stg_ap_v_fast;
1291
    } else {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1292 1293 1294 1295
      // Retry in the alternative code: propagate the retry
      StgTSO_trec(CurrentTSO) = outer;
      Sp = Sp + SIZEOF_StgCatchRetryFrame;
      goto retry_pop_stack;
1296 1297 1298 1299 1300
    }
  }

  // We've reached the ATOMICALLY_FRAME: attempt to wait 
  ASSERT(frame_type == ATOMICALLY_FRAME);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
  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;
     StgTSO_trec(CurrentTSO) = trec;
    "ptr" outer = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
  }
1311
  ASSERT(outer == NO_TREC);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1312

1313
  r = foreign "C" stmWait(MyCapability() "ptr", CurrentTSO "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1314
  if (r != 0) {
1315
    // Transaction was valid: stmWait put us on the TVars' queues, we now block
1316
    StgHeader_info(frame) = stg_atomically_waiting_frame_info;
1317
    Sp = frame;
1318 1319 1320 1321
    // 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;)
1322 1323
    R3 = trec; // passing to stmWaitUnblock()
    jump stg_block_stmwait;
1324 1325
  } else {
    // Transaction was not valid: retry immediately
1326
    "ptr" trec = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
1327 1328 1329
    StgTSO_trec(CurrentTSO) = trec;
    R1 = StgAtomicallyFrame_code(frame);
    Sp = frame;
1330
    jump stg_ap_v_fast;
1331 1332 1333 1334
  }
}


tharris@microsoft.com's avatar
tharris@microsoft.com committed
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
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));
}


1352 1353 1354
newTVarzh_fast
{
  W_ tv;
1355
  W_ new_value;
1356 1357 1358

  /* Args: R1 = initialisation value */

1359 1360
  MAYBE_GC (R1_PTR, newTVarzh_fast); 
  new_value = R1;
1361
  "ptr" tv = foreign "C" stmNewTVar(MyCapability() "ptr", new_value "ptr") [];
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
  RET_P(tv);
}


readTVarzh_fast
{
  W_ trec;
  W_ tvar;
  W_ result;

  /* Args: R1 = TVar closure */

  MAYBE_GC (R1_PTR, readTVarzh_fast); // Call to stmReadTVar may allocate
  trec = StgTSO_trec(CurrentTSO);
  tvar = R1;
1377
  "ptr" result = foreign "C" stmReadTVar(MyCapability() "ptr", trec "ptr", tvar "ptr") [];
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395

  RET_P(result);
}


writeTVarzh_fast
{
  W_ trec;
  W_ tvar;
  W_ new_value;
  
  /* Args: R1 = TVar closure */
  /*       R2 = New value    */

  MAYBE_GC (R1_PTR & R2_PTR, writeTVarzh_fast); // Call to stmWriteTVar may allocate
  trec = StgTSO_trec(CurrentTSO);
  tvar = R1;
  new_value = R2;
1396
  foreign "C" stmWriteTVar(MyCapability() "ptr", trec "ptr", tvar "ptr", new_value "ptr") [];
1397 1398 1399 1400 1401

  jump %ENTRY_CODE(Sp(0));
}


1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
/* -----------------------------------------------------------------------------
 * MVar primitives
 *
 * take & putMVar work as follows.  Firstly, an important invariant:
 *
 *    If the MVar is full, then the blocking queue contains only
 *    threads blocked on putMVar, and if the MVar is empty then the
 *    blocking queue contains only threads blocked on takeMVar.
 *
 * takeMvar:
 *    MVar empty : then add ourselves to the blocking queue
 *    MVar full  : remove the value from the MVar, and
 *                 blocking queue empty     : return
 *                 blocking queue non-empty : perform the first blocked putMVar
 *                                            from the queue, and wake up the
 *                                            thread (MVar is now full again)
 *
 * putMVar is just the dual of the above algorithm.
 *
 * How do we "perform a putMVar"?  Well, we have to fiddle around with
 * the stack of the thread waiting to do the putMVar.  See
 * stg_block_putmvar and stg_block_takemvar in HeapStackCheck.c for
 * the stack layout, and the PerformPut and PerformTake macros below.
 *
 * It is important that a blocked take or put is woken up with the
 * take/put already performed, because otherwise there would be a
 * small window of vulnerability where the thread could receive an
 * exception and never perform its take or put, and we'd end up with a
 * deadlock.
 *
 * -------------------------------------------------------------------------- */

isEmptyMVarzh_fast
{
    /* args: R1 = MVar closure */

    if (GET_INFO(R1) == stg_EMPTY_MVAR_info) {
	RET_N(1);
1440 1441
    } else {
	RET_N(0);
1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
    }
}

newMVarzh_fast
{
    /* args: none */
    W_ mvar;

    ALLOC_PRIM ( SIZEOF_StgMVar, NO_PTRS, newMVarzh_fast );
  
    mvar = Hp - SIZEOF_StgMVar + WDS(1);
    SET_HDR(mvar,stg_EMPTY_MVAR_info,W_[CCCS]);
    StgMVar_head(mvar)  = stg_END_TSO_QUEUE_closure;
    StgMVar_tail(mvar)  = stg_END_TSO_QUEUE_closure;
    StgMVar_value(mvar) = stg_END_TSO_QUEUE_closure;
    RET_P(mvar);
}


/* If R1 isn't available, pass it on the stack */
#ifdef REG_R1
#define PerformTake(tso, value)				\
    W_[StgTSO_sp(tso) + WDS(1)] = value;		\
    W_[StgTSO_sp(tso) + WDS(0)] = stg_gc_unpt_r1_info;
#else
#define PerformTake(tso, value)					\
    W_[StgTSO_sp(tso) + WDS(1)] = value;			\
    W_[StgTSO_sp(tso) + WDS(0)] = stg_ut_1_0_unreg_info;
#endif

#define PerformPut(tso,lval)			\
    StgTSO_sp(tso) = StgTSO_sp(tso) + WDS(3);	\
    lval = W_[StgTSO_sp(tso) - WDS(1)];

takeMVarzh_fast
{
    W_ mvar, val, info, tso;

    /* args: R1 = MVar closure */
    mvar = R1;

1483
#if defined(THREADED_RTS)
1484
    "ptr" info = foreign "C" lockClosure(mvar "ptr") [];
1485
#else
1486
    info = GET_INFO(mvar);
1487
#endif
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518

    /* If the MVar is empty, put ourselves on its blocking queue,
     * and wait until we're woken up.
     */
    if (info == stg_EMPTY_MVAR_info) {
	if (StgMVar_head(mvar) == stg_END_TSO_QUEUE_closure) {
	    StgMVar_head(mvar) = CurrentTSO;
	} else {
	    StgTSO_link(StgMVar_tail(mvar)) = CurrentTSO;
	}
	StgTSO_link(CurrentTSO)        = stg_END_TSO_QUEUE_closure;
	StgTSO_why_blocked(CurrentTSO) = BlockedOnMVar::I16;
	StgTSO_block_info(CurrentTSO)  = mvar;
	StgMVar_tail(mvar) = CurrentTSO;
	
	jump stg_block_takemvar;
  }

  /* we got the value... */
  val = StgMVar_value(mvar);

  if (StgMVar_head(mvar) != stg_END_TSO_QUEUE_closure)
  {
      /* There are putMVar(s) waiting... 
       * wake up the first thread on the queue
       */
      ASSERT(StgTSO_why_blocked(StgMVar_head(mvar)) == BlockedOnMVar::I16);

      /* actually perform the putMVar for the thread that we just woke up */
      tso = StgMVar_head(mvar);
      PerformPut(tso,StgMVar_value(mvar));
1519
      dirtyTSO(tso);
1520 1521 1522

#if defined(GRAN) || defined(PAR)
      /* ToDo: check 2nd arg (mvar) is right */
1523
      "ptr" tso = foreign "C" unblockOne(StgMVar_head(mvar),mvar) [];
1524 1525
      StgMVar_head(mvar) = tso;
#else
1526 1527
      "ptr" tso = foreign "C" unblockOne(MyCapability() "ptr", 
				         StgMVar_head(mvar) "ptr") [];
1528 1529
      StgMVar_head(mvar) = tso;
#endif
1530

1531 1532 1533
      if (StgMVar_head(mvar) == stg_END_TSO_QUEUE_closure) {
	  StgMVar_tail(mvar) = stg_END_TSO_QUEUE_closure;
      }
1534

1535
#if defined(THREADED_RTS)
1536
      unlockClosure(mvar, stg_FULL_MVAR_info);
1537
#endif
1538 1539 1540 1541 1542 1543
      RET_P(val);
  } 
  else
  {
      /* No further putMVars, MVar is now empty */
      StgMVar_value(mvar) = stg_END_TSO_QUEUE_closure;
1544
 
1545
#if defined(THREADED_RTS)
1546
      unlockClosure(mvar, stg_EMPTY_MVAR_info);
1547
#else
1548
      SET_INFO(mvar,stg_EMPTY_MVAR_info);
1549
#endif
1550

1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
      RET_P(val);
  }
}


tryTakeMVarzh_fast
{
    W_ mvar, val, info, tso;

    /* args: R1 = MVar closure */

    mvar = R1;

1564
#if defined(THREADED_RTS)
1565
    "ptr" info = foreign "C" lockClosure(mvar "ptr") [];
1566
#else
1567
    info = GET_INFO(mvar);
1568
#endif
1569 1570

    if (info == stg_EMPTY_MVAR_info) {
1571
#if defined(THREADED_RTS)
1572
        unlockClosure(mvar, stg_EMPTY_MVAR_info);
1573
#endif
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583
	/* HACK: we need a pointer to pass back, 
	 * so we abuse NO_FINALIZER_closure
	 */
	RET_NP(0, stg_NO_FINALIZER_closure);
    }

    /* we got the value... */
    val = StgMVar_value(mvar);

    if (StgMVar_head(mvar) != stg_END_TSO_QUEUE_closure) {
1584

1585 1586 1587 1588 1589 1590 1591 1592
	/* There are putMVar(s) waiting... 
	 * wake up the first thread on the queue
	 */
	ASSERT(StgTSO_why_blocked(StgMVar_head(mvar)) == BlockedOnMVar::I16);

	/* actually perform the putMVar for the thread that we just woke up */
	tso = StgMVar_head(mvar);
	PerformPut(tso,StgMVar_value(mvar));
1593
        dirtyTSO(tso);
1594 1595 1596

#if defined(GRAN) || defined(PAR)
	/* ToDo: check 2nd arg (mvar) is right */
1597
	"ptr" tso = foreign "C" unblockOne(StgMVar_head(mvar) "ptr", mvar "ptr") [];
1598 1599
	StgMVar_head(mvar) = tso;
#else
1600 1601
	"ptr" tso = foreign "C" unblockOne(MyCapability() "ptr",
					   StgMVar_head(mvar) "ptr") [];
1602 1603 1604 1605 1606 1607
	StgMVar_head(mvar) = tso;
#endif

	if (StgMVar_head(mvar) == stg_END_TSO_QUEUE_closure) {
	    StgMVar_tail(mvar) = stg_END_TSO_QUEUE_closure;
	}
1608
#if defined(THREADED_RTS)
1609
        unlockClosure(mvar, stg_FULL_MVAR_info);
1610
#endif
1611 1612 1613 1614 1615
    }
    else 
    {
	/* No further putMVars, MVar is now empty */
	StgMVar_value(mvar) = stg_END_TSO_QUEUE_closure;
1616
#if defined(THREADED_RTS)
1617
    	unlockClosure(mvar, stg_EMPTY_MVAR_info);