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

#include "Cmm.h"

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

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

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

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

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

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

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

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

89 90 91 92 93 94 95 96
newPinnedByteArrayzh_fast
{
    W_ words, payload_words, n, p;

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

Simon Marlow's avatar
Simon Marlow committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
    words = payload_words + ((SIZEOF_StgArrWords + BA_MASK) & ~BA_MASK);

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

    // This bumps p forwards so that the payload falls on an R2-byte boundary.
    p = p + ((-p - SIZEOF_StgArrWords) & BA_MASK);

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

newAlignedPinnedByteArrayzh_fast
{
    W_ words, payload_words, n, p, mask;

    MAYBE_GC(NO_PTRS,newAlignedPinnedByteArrayzh_fast);
    n = R1;

    if (R2 > SIZEOF_W) {
        mask = R2 - 1;
    } else {
        mask = 0;
    }

    payload_words = ROUNDUP_BYTES_TO_WDS(n);

    // We want an <align>-byte aligned array.  allocatePinned() gives us
126 127 128
    // 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.
Simon Marlow's avatar
Simon Marlow committed
129
    words = payload_words + ((SIZEOF_StgArrWords + mask) & ~mask);
130

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

Simon Marlow's avatar
Simon Marlow committed
134 135
    // This bumps p forwards so that the payload falls on an R2-byte boundary.
    p = p + ((-p - SIZEOF_StgArrWords) & mask);
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150

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

154
    SET_HDR(arr, stg_MUT_ARR_PTRS_DIRTY_info, W_[CCCS]);
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
    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).
  // 
179
  // So that we can tell whether a MUT_ARR_PTRS_FROZEN is on the mutable list,
180 181 182
  // 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.
  //
183 184
  // 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
185
  // the closure type is MUT_ARR_PTRS_FROZEN0 if it is on the mutable list,
186 187 188
  // 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.
189
  //
190
  if (StgHeader_info(R1) != stg_MUT_ARR_PTRS_FROZEN0_info) {
191
	SET_INFO(R1,stg_MUT_ARR_PTRS_DIRTY_info);
192
	recordMutable(R1, R1);
193 194 195
	// must be done after SET_INFO, because it ASSERTs closure_MUTABLE()
	RET_P(R1);
  } else {
196
	SET_INFO(R1,stg_MUT_ARR_PTRS_DIRTY_info);
197
	RET_P(R1);
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
  }
}

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

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

    ALLOC_PRIM( SIZEOF_StgMutVar, R1_PTR, newMutVarzh_fast);

    mv = Hp - SIZEOF_StgMutVar + WDS(1);
213
    SET_HDR(mv,stg_MUT_VAR_DIRTY_info,W_[CCCS]);
214 215 216 217 218 219 220
    StgMutVar_var(mv) = R1;
    
    RET_P(mv);
}

atomicModifyMutVarzh_fast
{
221
    W_ mv, f, z, x, y, r, h;
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
    /* 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
241
#define THUNK_1_SIZE (SIZEOF_StgThunkHeader + WDS(MIN_UPD_SIZE))
242 243
#define TICK_ALLOC_THUNK_1() TICK_ALLOC_UP_THK(WDS(1),WDS(MIN_UPD_SIZE-1))
#else
244
#define THUNK_1_SIZE (SIZEOF_StgThunkHeader + WDS(1))
245 246 247 248
#define TICK_ALLOC_THUNK_1() TICK_ALLOC_UP_THK(WDS(1),0)
#endif

#if MIN_UPD_SIZE > 2
249
#define THUNK_2_SIZE (SIZEOF_StgThunkHeader + WDS(MIN_UPD_SIZE))
250 251
#define TICK_ALLOC_THUNK_2() TICK_ALLOC_UP_THK(WDS(2),WDS(MIN_UPD_SIZE-2))
#else
252
#define THUNK_2_SIZE (SIZEOF_StgThunkHeader + WDS(2))
253 254 255 256 257 258 259
#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);

260 261
   mv = R1;
   f = R2;
262 263 264 265 266 267

   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);
268
   StgThunk_payload(z,0) = f;
269 270 271 272 273 274

   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);
275
   StgThunk_payload(y,0) = z;
276 277 278 279 280 281

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

284 285 286 287 288 289 290 291
 retry:
   x = StgMutVar_var(mv);
   StgThunk_payload(z,1) = x;
#ifdef THREADED_RTS
   (h) = foreign "C" cas(mv + SIZEOF_StgHeader + OFFSET_StgMutVar_var, x, y) [];
   if (h != x) { goto retry; }
#else
   StgMutVar_var(mv) = y;
292
#endif
293

294 295 296 297
   if (GET_INFO(mv) == stg_MUT_VAR_CLEAN_info) {
     foreign "C" dirty_MUT_VAR(BaseReg "ptr", mv "ptr") [];
   }

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
   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]);

324 325 326 327 328 329 330 331
  // We don't care about cfinalizer here.
  // Should StgWeak_cfinalizer(w) be stg_NO_FINALIZER_closure or
  // something else?

  StgWeak_key(w)        = R1;
  StgWeak_value(w)      = R2;
  StgWeak_finalizer(w)  = R3;
  StgWeak_cfinalizer(w) = stg_NO_FINALIZER_closure;
332 333 334 335

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

336
  IF_DEBUG(weak, foreign "C" debugBelch(stg_weak_msg,w) []);
337 338 339 340

  RET_P(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
mkWeakForeignEnvzh_fast
{
  /* R1 = key
     R2 = value
     R3 = finalizer
     R4 = pointer
     R5 = has environment (0 or 1)
     R6 = environment
  */
  W_ w, payload_words, words, p;

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

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

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

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

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

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

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

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

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

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

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

  RET_P(w);
}
394 395 396 397 398

finalizzeWeakzh_fast
{
  /* R1 = weak ptr
   */
399
  W_ w, f, arr;
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

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

427 428 429
  f   = StgWeak_finalizer(w);
  arr = StgWeak_cfinalizer(w);

430
  StgDeadWeak_link(w) = StgWeak_link(w);
431

432 433 434 435 436 437 438
  if (arr != stg_NO_FINALIZER_closure) {
    foreign "C" runCFinalizer(StgArrWords_payload(arr,0),
                              StgArrWords_payload(arr,1),
                              StgArrWords_payload(arr,2),
                              StgArrWords_payload(arr,3)) [];
  }

439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
  /* 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;
542
   W_ hi, lo, s, neg, words_needed, p;
543 544 545 546

   val = L1;
   neg = 0;

547 548 549
   hi = TO_W_(val >> 32);
   lo = TO_W_(val);

550
   if ( hi == 0 || (hi == 0xFFFFFFFF && lo != 0) )  {
551 552
       // minimum is one word
       words_needed = 1;
553 554
   } else { 
       words_needed = 2;
555 556 557 558 559 560 561 562 563
   }

   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;

564
   if ( %lt(hi,0) ) {
565
     neg = 1;
566 567 568 569 570 571
     lo = -lo;
     if(lo == 0) {
       hi = -hi;
     } else {
       hi = -hi - 1;
     }
572 573 574 575
   }

   if ( words_needed == 2 )  { 
      s = 2;
576
      Hp(-1) = lo;
577 578
      Hp(0) = hi;
   } else { 
579
       if ( lo != 0 ) {
580
	   s = 1;
581
	   Hp(0) = lo;
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
       } 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;
600
   W_ hi, lo, s, words_needed, p;
601 602

   val = L1;
603 604 605 606
   hi = TO_W_(val >> 32);
   lo = TO_W_(val);

   if ( hi != 0 ) {
607 608 609 610 611 612 613 614 615 616 617 618
      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;

619
   if ( hi != 0 ) { 
620
     s = 2;
621
     Hp(-1) = lo;
622 623
     Hp(0)  = hi;
   } else {
624
      if ( lo != 0 ) {
625
        s = 1;
626
        Hp(0) = lo;
627 628 629 630 631 632 633 634 635 636 637 638
     } else /* val==0 */  {
      s = 0;
     }
  }

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


639

640 641 642 643
#endif /* SUPPORT_LONG_LONGS */

/* ToDo: this is shockingly inefficient */

644
#ifndef THREADED_RTS
645 646 647 648 649 650 651 652 653 654 655
section "bss" {
  mp_tmp1:
    bits8 [SIZEOF_MP_INT];
}

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

section "bss" {
656
  mp_result1:
657 658 659 660
    bits8 [SIZEOF_MP_INT];
}

section "bss" {
661
  mp_result2:
662 663
    bits8 [SIZEOF_MP_INT];
}
664 665
#endif

666
#ifdef THREADED_RTS
667 668 669 670 671 672
#define FETCH_MP_TEMP(X) \
W_ X; \
X = BaseReg + (OFFSET_StgRegTable_r ## X);
#else
#define FETCH_MP_TEMP(X) /* Nothing */
#endif
673

674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
#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);                         \
                                                                        \
699
  foreign "C" __gmpz_init(mp_result1 "ptr") [];                            \
700 701
                                                                        \
  /* Perform the operation */                                           \
702
  foreign "C" mp_fun(mp_result1 "ptr",mp_tmp1  "ptr",mp_tmp2  "ptr") []; \
703 704 705
                                                                        \
  RET_NP(TO_W_(MP_INT__mp_size(mp_result1)),                            \
         MP_INT__mp_d(mp_result1) - SIZEOF_StgArrWords);                \
706 707
}

708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
#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);                     \
                                                                        \
726
  foreign "C" __gmpz_init(mp_result1 "ptr") [];                            \
727 728
                                                                        \
  /* Perform the operation */                                           \
729
  foreign "C" mp_fun(mp_result1 "ptr",mp_tmp1 "ptr") [];                \
730 731 732
                                                                        \
  RET_NP(TO_W_(MP_INT__mp_size(mp_result1)),                            \
         MP_INT__mp_d(mp_result1) - SIZEOF_StgArrWords);                \
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
#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);                                     \
                                                                                        \
760 761
  foreign "C" __gmpz_init(mp_result1 "ptr") [];                                               \
  foreign "C" __gmpz_init(mp_result2 "ptr") [];                                               \
762 763
                                                                                        \
  /* Perform the operation */                                                           \
764
  foreign "C" mp_fun(mp_result1 "ptr",mp_result2 "ptr",mp_tmp1 "ptr",mp_tmp2 "ptr") [];    \
765 766 767 768 769
                                                                                        \
  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);                              \
770 771
}

772 773 774 775 776 777 778 779 780 781 782 783 784 785
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)
786

787
#ifndef THREADED_RTS
788
section "bss" {
789
  mp_tmp_w:  W_; // NB. mp_tmp_w is really an here mp_limb_t
790
}
791
#endif
792 793 794 795 796

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

799
    W_[mp_tmp_w] = R1;
800
    (r) = foreign "C" __gmpn_gcd_1(mp_tmp_w "ptr", 1, R2) [];
801 802 803 804 805 806 807 808 809 810

    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 */
811 812 813
    W_ s1;
    (s1) = foreign "C" __gmpn_gcd_1( BYTE_ARR_CTS(R2) "ptr", R1, R3) [];
    R1 = s1;
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
    
    /* 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;

829
    // paraphrased from __gmpz_cmp_si() in the GMP sources
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 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
    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;

871
    // paraphrased from __gmpz_cmp() in the GMP sources
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
    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);

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

896
    if (cmp == 0 :: CInt) {
897 898 899 900
	R1 = 0; 
	jump %ENTRY_CODE(Sp(0));
    }

901
    if (%lt(cmp,0 :: CInt) == %lt(usize,0)) {
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
	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;
952 953
    FETCH_MP_TEMP(mp_tmp1);
    FETCH_MP_TEMP(mp_tmp_w);
954 955 956 957 958 959 960 961 962 963 964 965 966 967
    
    /* 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 */
968
    foreign "C" __decodeFloat(mp_tmp1 "ptr",mp_tmp_w "ptr" ,arg) [];
969 970
    
    /* returns: (Int# (expn), Int#, ByteArray#) */
971
    RET_NNP(W_[mp_tmp_w], TO_W_(MP_INT__mp_size(mp_tmp1)), p);
972 973
}

974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990
decodeFloatzuIntzh_fast
{ 
    W_ p;
    F_ arg;
    FETCH_MP_TEMP(mp_tmp1);
    FETCH_MP_TEMP(mp_tmp_w);
    
    /* arguments: F1 = Float# */
    arg = F1;
    
    /* Perform the operation */
    foreign "C" __decodeFloat_Int(mp_tmp1 "ptr", mp_tmp_w "ptr", arg) [];
    
    /* returns: (Int# (mantissa), Int# (exponent)) */
    RET_NN(W_[mp_tmp1], W_[mp_tmp_w]);
}

991 992 993 994 995 996 997
#define DOUBLE_MANTISSA_SIZE SIZEOF_DOUBLE
#define ARR_SIZE (SIZEOF_StgArrWords + DOUBLE_MANTISSA_SIZE)

decodeDoublezh_fast
{ 
    D_ arg;
    W_ p;
998 999
    FETCH_MP_TEMP(mp_tmp1);
    FETCH_MP_TEMP(mp_tmp_w);
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013

    /* 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 */
1014
    foreign "C" __decodeDouble(mp_tmp1 "ptr", mp_tmp_w "ptr",arg) [];
1015 1016
    
    /* returns: (Int# (expn), Int#, ByteArray#) */
1017
    RET_NNP(W_[mp_tmp_w], TO_W_(MP_INT__mp_size(mp_tmp1)), p);
1018 1019
}

1020 1021 1022 1023 1024 1025
decodeDoublezu2Intzh_fast
{ 
    D_ arg;
    W_ p;
    FETCH_MP_TEMP(mp_tmp1);
    FETCH_MP_TEMP(mp_tmp2);
1026 1027
    FETCH_MP_TEMP(mp_result1);
    FETCH_MP_TEMP(mp_result2);
1028 1029 1030 1031 1032

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

    /* Perform the operation */
1033 1034 1035 1036 1037 1038 1039
    foreign "C" __decodeDouble_2Int(mp_tmp1 "ptr", mp_tmp2 "ptr",
                                    mp_result1 "ptr", mp_result2 "ptr",
                                    arg) [];

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

1042 1043 1044 1045 1046 1047 1048
/* -----------------------------------------------------------------------------
 * Concurrency primitives
 * -------------------------------------------------------------------------- */

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

1050 1051
  MAYBE_GC(R1_PTR, forkzh_fast);

1052 1053 1054 1055
  W_ closure;
  W_ threadid;
  closure = R1;

1056
  ("ptr" threadid) = foreign "C" createIOThread( MyCapability() "ptr", 
1057 1058
				RtsFlags_GcFlags_initialStkSize(RtsFlags), 
				closure "ptr") [];
1059 1060 1061 1062 1063 1064

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

1065 1066 1067
  foreign "C" scheduleThread(MyCapability() "ptr", threadid "ptr") [];

  // switch at the earliest opportunity
1068
  Capability_context_switch(MyCapability()) = 1 :: CInt;
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
  
  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;

1085
  ("ptr" threadid) = foreign "C" createIOThread( MyCapability() "ptr", 
1086
				RtsFlags_GcFlags_initialStkSize(RtsFlags), 
1087
				closure "ptr") [];
1088 1089 1090 1091 1092 1093

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

1094
  foreign "C" scheduleThreadOn(MyCapability() "ptr", cpu, threadid "ptr") [];
1095 1096

  // switch at the earliest opportunity
1097
  Capability_context_switch(MyCapability()) = 1 :: CInt;
1098
  
1099
  RET_P(threadid);
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
}

yieldzh_fast
{
  jump stg_yield_noregs;
}

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

labelThreadzh_fast
{
  /* args: 
	R1 = ThreadId#
	R2 = Addr# */
#ifdef DEBUG
1119
  foreign "C" labelThread(R1 "ptr", R2 "ptr") [];
1120 1121 1122 1123 1124 1125 1126 1127
#endif
  jump %ENTRY_CODE(Sp(0));
}

isCurrentThreadBoundzh_fast
{
  /* no args */
  W_ r;
1128
  (r) = foreign "C" isThreadBound(CurrentTSO) [];
1129 1130 1131
  RET_N(r);
}

1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
threadStatuszh_fast
{
    /* args: R1 :: ThreadId# */
    W_ tso;
    W_ why_blocked;
    W_ what_next;
    W_ ret;

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

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

    if (what_next == ThreadComplete) {
        ret = 16;  // NB. magic, matches up with GHC.Conc.threadStatus
    } else {
        if (what_next == ThreadKilled) {
            ret = 17;
        } else {
            ret = why_blocked;
        }
    }
    RET_N(ret);
}
1165 1166 1167 1168 1169 1170 1171 1172 1173

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

#define SP_OFF 0

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

1174
INFO_TABLE_RET(stg_catch_retry_frame, CATCH_RETRY_FRAME,
1175
#if defined(PROFILING)
1176
  W_ unused1, W_ unused2,
1177
#endif
1178
  W_ unused3, P_ unused4, P_ unused5)
1179 1180 1181 1182 1183
{
   W_ r, frame, trec, outer;

   frame = Sp;
   trec = StgTSO_trec(CurrentTSO);
1184 1185
   ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
   (r) = foreign "C" stmCommitNestedTransaction(MyCapability() "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1186
   if (r != 0) {
1187 1188 1189 1190 1191
     /* Succeeded (either first branch or second branch) */
     StgTSO_trec(CurrentTSO) = outer;
     Sp = Sp + SIZEOF_StgCatchRetryFrame;
     jump %ENTRY_CODE(Sp(SP_OFF));
   } else {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1192
     /* Did not commit: re-execute */
1193
     W_ new_trec;
1194
     ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
1195
     StgTSO_trec(CurrentTSO) = new_trec;
Simon Marlow's avatar
Simon Marlow committed
1196
     if (StgCatchRetryFrame_running_alt_code(frame) != 0::I32) {
1197 1198 1199 1200
       R1 = StgCatchRetryFrame_alt_code(frame);
     } else {
       R1 = StgCatchRetryFrame_first_code(frame);
     }
1201
     jump stg_ap_v_fast;
1202 1203
   }
}
1204 1205


Simon Marlow's avatar
Simon Marlow committed
1206
// Atomically frame ------------------------------------------------------------
1207

1208
INFO_TABLE_RET(stg_atomically_frame, ATOMICALLY_FRAME,
1209
#if defined(PROFILING)
1210
  W_ unused1, W_ unused2,
1211
#endif
1212
  P_ unused3, P_ unused4)
1213
{
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1214
  W_ frame, trec, valid, next_invariant, q, outer;
1215

1216 1217
  frame = Sp;
  trec = StgTSO_trec(CurrentTSO);
1218
  ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1219 1220 1221

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

  } else {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
    /* 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 */
1243
    ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", trec "ptr") [];
1244
    StgTSO_trec(CurrentTSO) = trec;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1245 1246 1247

    next_invariant = StgInvariantCheckQueue_invariant(q);
    R1 = StgAtomicInvariant_code(next_invariant);
1248
    jump stg_ap_v_fast;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1249 1250 1251 1252

  } else {

    /* We've got no more invariants to check, try to commit */
1253
    (valid) = foreign "C" stmCommitTransaction(MyCapability() "ptr", trec "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1254 1255 1256 1257 1258 1259 1260
    if (valid != 0) {
      /* Transaction was valid: commit succeeded */
      StgTSO_trec(CurrentTSO) = NO_TREC;
      Sp = Sp + SIZEOF_StgAtomicallyFrame;
      jump %ENTRY_CODE(Sp(SP_OFF));
    } else {
      /* Transaction was not valid: try again */
1261
      ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1262 1263 1264 1265 1266
      StgTSO_trec(CurrentTSO) = trec;
      StgAtomicallyFrame_next_invariant_to_check(frame) = END_INVARIANT_CHECK_QUEUE;
      R1 = StgAtomicallyFrame_code(frame);
      jump stg_ap_v_fast;
    }
1267 1268 1269
  }
}

1270 1271 1272 1273
INFO_TABLE_RET(stg_atomically_waiting_frame, ATOMICALLY_FRAME,
#if defined(PROFILING)
  W_ unused1, W_ unused2,
#endif
1274
  P_ unused3, P_ unused4)
1275 1276 1277 1278 1279 1280
{
  W_ frame, trec, valid;

  frame = Sp;

  /* The TSO is currently waiting: should we stop waiting? */
1281
  (valid) = foreign "C" stmReWait(MyCapability() "ptr", CurrentTSO "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1282
  if (valid != 0) {
1283 1284 1285 1286
    /* Previous attempt is still valid: no point trying again yet */
    jump stg_block_noregs;
  } else {
    /* Previous attempt is no longer valid: try again */
1287
    ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr") [];
1288 1289 1290
    StgTSO_trec(CurrentTSO) = trec;
    StgHeader_info(frame) = stg_atomically_frame_info;
    R1 = StgAtomicallyFrame_code(frame);
1291
    jump stg_ap_v_fast;
1292
  }
1293
}
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303

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

#define SP_OFF 0

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

1304 1305 1306 1307
INFO_TABLE_RET(stg_catch_stm_frame, CATCH_STM_FRAME,
#if defined(PROFILING)
  W_ unused1, W_ unused2,
#endif
1308
  P_ unused3, P_ unused4)
Simon Marlow's avatar
Simon Marlow committed
1309 1310 1311 1312
   {
      W_ r, frame, trec, outer;
      frame = Sp;
      trec = StgTSO_trec(CurrentTSO);
1313 1314
      ("ptr" outer) = foreign "C" stmGetEnclosingTRec(trec "ptr") [];
      (r) = foreign "C" stmCommitNestedTransaction(MyCapability() "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1315 1316 1317 1318 1319 1320 1321 1322
      if (r != 0) {
        /* Commit succeeded */
        StgTSO_trec(CurrentTSO) = outer;
        Sp = Sp + SIZEOF_StgCatchSTMFrame;
        jump Sp(SP_OFF);
      } else {
        /* Commit failed */
        W_ new_trec;
1323
        ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
1324 1325 1326 1327 1328
        StgTSO_trec(CurrentTSO) = new_trec;
        R1 = StgCatchSTMFrame_code(frame);
        jump stg_ap_v_fast;
      }
   }
1329 1330 1331 1332 1333 1334 1335 1336 1337 1338


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

atomicallyzh_fast
{
  W_ frame;
  W_ old_trec;
  W_ new_trec;
  
1339 1340 1341
  // stmStartTransaction may allocate
  MAYBE_GC (R1_PTR, atomicallyzh_fast); 

1342 1343 1344
  /* Args: R1 = m :: STM a */
  STK_CHK_GEN(SIZEOF_StgAtomicallyFrame + WDS(1), R1_PTR, atomicallyzh_fast);

1345 1346 1347 1348
  old_trec = StgTSO_trec(CurrentTSO);

  /* Nested transactions are not allowed; raise an exception */
  if (old_trec != NO_TREC) {
1349
     R1 = base_ControlziExceptionziBase_nestedAtomically_closure;
1350 1351 1352
     jump raisezh_fast;
  }

1353 1354 1355 1356
  /* Set up the atomically frame */
  Sp = Sp - SIZEOF_StgAtomicallyFrame;
  frame = Sp;

1357
  SET_HDR(frame,stg_atomically_frame_info, W_[CCCS]);
1358
  StgAtomicallyFrame_code(frame) = R1;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1359
  StgAtomicallyFrame_next_invariant_to_check(frame) = END_INVARIANT_CHECK_QUEUE;
1360 1361

  /* Start the memory transcation */
1362
  ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", old_trec "ptr") [R1];
1363 1364 1365
  StgTSO_trec(CurrentTSO) = new_trec;

  /* Apply R1 to the realworld token */
1366
  jump stg_ap_v_fast;
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381
}


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;

1382
  SET_HDR(frame, stg_catch_stm_frame_info, W_[CCCS]);
1383
  StgCatchSTMFrame_handler(frame) = R2;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1384 1385 1386 1387 1388 1389
  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);
1390
  ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", cur_trec "ptr");
tharris@microsoft.com's avatar
tharris@microsoft.com committed
1391
  StgTSO_trec(CurrentTSO) = new_trec;
1392 1393

  /* Apply R1 to the realworld token */
1394
  jump stg_ap_v_fast;
1395 1396 1397 1398 1399 1400 1401 1402 1403
}


catchRetryzh_fast
{
  W_ frame;
  W_ new_trec;
  W_ trec;

1404 1405 1406
  // stmStartTransaction may allocate
  MAYBE_GC (R1_PTR & R2_PTR, catchRetryzh_fast); 

1407 1408 1409 1410 1411