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

#include "Cmm.h"

30
#ifdef __PIC__
31 32
import pthread_mutex_lock;
import pthread_mutex_unlock;
33
#endif
34
import base_ControlziExceptionziBase_nestedAtomically_closure;
35 36
import EnterCriticalSection;
import LeaveCriticalSection;
37
import ghczmprim_GHCziBool_False_closure;
38
import sm_mutex;
39

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
/*-----------------------------------------------------------------------------
  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.
 */

55
stg_newByteArrayzh
56 57
{
    W_ words, payload_words, n, p;
58
    MAYBE_GC(NO_PTRS,stg_newByteArrayzh);
59 60 61
    n = R1;
    payload_words = ROUNDUP_BYTES_TO_WDS(n);
    words = BYTES_TO_WDS(SIZEOF_StgArrWords) + payload_words;
62
    ("ptr" p) = foreign "C" allocate(MyCapability() "ptr",words) [];
63 64 65 66 67 68
    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
69 70 71
#define BA_ALIGN 16
#define BA_MASK  (BA_ALIGN-1)

72
stg_newPinnedByteArrayzh
73
{
74
    W_ words, bytes, payload_words, p;
75

76
    MAYBE_GC(NO_PTRS,stg_newPinnedByteArrayzh);
77 78 79 80 81 82 83 84 85 86 87
    bytes = R1;
    /* payload_words is what we will tell the profiler we had to allocate */
    payload_words = ROUNDUP_BYTES_TO_WDS(bytes);
    /* When we actually allocate memory, we need to allow space for the
       header: */
    bytes = bytes + SIZEOF_StgArrWords;
    /* And we want to align to BA_ALIGN bytes, so we need to allow space
       to shift up to BA_ALIGN - 1 bytes: */
    bytes = bytes + BA_ALIGN - 1;
    /* Now we convert to a number of words: */
    words = ROUNDUP_BYTES_TO_WDS(bytes);
Simon Marlow's avatar
Simon Marlow committed
88

89
    ("ptr" p) = foreign "C" allocatePinned(MyCapability() "ptr", words) [];
Simon Marlow's avatar
Simon Marlow committed
90 91
    TICK_ALLOC_PRIM(SIZEOF_StgArrWords,WDS(payload_words),0);

92 93
    /* Now we need to move p forward so that the payload is aligned
       to BA_ALIGN bytes: */
Simon Marlow's avatar
Simon Marlow committed
94 95 96 97 98 99 100
    p = p + ((-p - SIZEOF_StgArrWords) & BA_MASK);

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

101
stg_newAlignedPinnedByteArrayzh
Simon Marlow's avatar
Simon Marlow committed
102
{
103
    W_ words, bytes, payload_words, p, alignment;
Simon Marlow's avatar
Simon Marlow committed
104

105
    MAYBE_GC(NO_PTRS,stg_newAlignedPinnedByteArrayzh);
106 107
    bytes = R1;
    alignment = R2;
Simon Marlow's avatar
Simon Marlow committed
108

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

112 113 114 115 116 117 118 119
    /* When we actually allocate memory, we need to allow space for the
       header: */
    bytes = bytes + SIZEOF_StgArrWords;
    /* And we want to align to <alignment> bytes, so we need to allow space
       to shift up to <alignment - 1> bytes: */
    bytes = bytes + alignment - 1;
    /* Now we convert to a number of words: */
    words = ROUNDUP_BYTES_TO_WDS(bytes);
120

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

124 125 126 127
    /* Now we need to move p forward so that the payload is aligned
       to <alignment> bytes. Note that we are assuming that
       <alignment> is a power of 2, which is technically not guaranteed */
    p = p + ((-p - SIZEOF_StgArrWords) & (alignment - 1));
128 129 130 131 132 133

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

134
stg_newArrayzh
135
{
136
    W_ words, n, init, arr, p, size;
137 138 139
    /* Args: R1 = words, R2 = initialisation value */

    n = R1;
140
    MAYBE_GC(R2_PTR,stg_newArrayzh);
141

142 143 144 145 146
    // the mark area contains one byte for each 2^MUT_ARR_PTRS_CARD_BITS words
    // in the array, making sure we round up, and then rounding up to a whole
    // number of words.
    size = n + mutArrPtrsCardWords(n);
    words = BYTES_TO_WDS(SIZEOF_StgMutArrPtrs) + size;
147
    ("ptr" arr) = foreign "C" allocate(MyCapability() "ptr",words) [R2];
148 149
    TICK_ALLOC_PRIM(SIZEOF_StgMutArrPtrs, WDS(n), 0);

150
    SET_HDR(arr, stg_MUT_ARR_PTRS_DIRTY_info, W_[CCCS]);
151
    StgMutArrPtrs_ptrs(arr) = n;
152
    StgMutArrPtrs_size(arr) = size;
153 154 155 156 157 158 159 160 161 162

    // 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;
    }
163 164 165 166 167 168 169
    // Initialise the mark bits with 0
  for2:
    if (p < arr + WDS(size)) {
	W_[p] = 0;
	p = p + WDS(1);
	goto for2;
    }
170 171 172 173

    RET_P(arr);
}

174
stg_unsafeThawArrayzh
175 176 177 178 179 180
{
  // 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
181
  // the mutable list is not easy).
182
  // 
183
  // So that we can tell whether a MUT_ARR_PTRS_FROZEN is on the mutable list,
184 185 186
  // 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.
  //
187 188
  // 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
189
  // the closure type is MUT_ARR_PTRS_FROZEN0 if it is on the mutable list,
190 191 192
  // 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.
193
  //
194
  if (StgHeader_info(R1) != stg_MUT_ARR_PTRS_FROZEN0_info) {
195
	SET_INFO(R1,stg_MUT_ARR_PTRS_DIRTY_info);
196
	recordMutable(R1, R1);
197 198 199
	// must be done after SET_INFO, because it ASSERTs closure_MUTABLE()
	RET_P(R1);
  } else {
200
	SET_INFO(R1,stg_MUT_ARR_PTRS_DIRTY_info);
201
	RET_P(R1);
202 203 204 205 206 207 208
  }
}

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

209
stg_newMutVarzh
210 211 212 213
{
    W_ mv;
    /* Args: R1 = initialisation value */

214
    ALLOC_PRIM( SIZEOF_StgMutVar, R1_PTR, stg_newMutVarzh);
215 216

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

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

#if MIN_UPD_SIZE > 2
253
#define THUNK_2_SIZE (SIZEOF_StgThunkHeader + WDS(MIN_UPD_SIZE))
254 255
#define TICK_ALLOC_THUNK_2() TICK_ALLOC_UP_THK(WDS(2),WDS(MIN_UPD_SIZE-2))
#else
256
#define THUNK_2_SIZE (SIZEOF_StgThunkHeader + WDS(2))
257 258 259 260 261
#define TICK_ALLOC_THUNK_2() TICK_ALLOC_UP_THK(WDS(2),0)
#endif

#define SIZE (THUNK_2_SIZE + THUNK_1_SIZE + THUNK_1_SIZE)

262
   HP_CHK_GEN_TICKY(SIZE, R1_PTR & R2_PTR, stg_atomicModifyMutVarzh);
263

264 265
   mv = R1;
   f = R2;
266 267 268 269 270 271

   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);
272
   StgThunk_payload(z,0) = f;
273 274 275 276 277 278

   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);
279
   StgThunk_payload(y,0) = z;
280 281 282 283 284 285

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

288 289 290 291 292 293 294 295
 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;
296
#endif
297

298 299 300 301
   if (GET_INFO(mv) == stg_MUT_VAR_CLEAN_info) {
     foreign "C" dirty_MUT_VAR(BaseReg "ptr", mv "ptr") [];
   }

302 303 304 305 306 307 308 309 310
   RET_P(r);
}

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

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

311
stg_mkWeakzh
312 313 314 315 316 317 318 319 320 321 322
{
  /* R1 = key
     R2 = value
     R3 = finalizer (or NULL)
  */
  W_ w;

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

323
  ALLOC_PRIM( SIZEOF_StgWeak, R1_PTR & R2_PTR & R3_PTR, stg_mkWeakzh );
324 325 326 327

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

328 329 330 331 332 333 334 335
  // 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;
336

337
  ACQUIRE_LOCK(sm_mutex);
338 339
  StgWeak_link(w)	= W_[weak_ptr_list];
  W_[weak_ptr_list] 	= w;
340
  RELEASE_LOCK(sm_mutex);
341

342
  IF_DEBUG(weak, foreign "C" debugBelch(stg_weak_msg,w) []);
343 344 345 346

  RET_P(w);
}

347
stg_mkWeakForeignEnvzh
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
{
  /* 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;

367
  ALLOC_PRIM( SIZEOF_StgWeak, R1_PTR & R2_PTR, stg_mkWeakForeignEnvzh );
368 369 370 371 372 373

  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;
374
  ("ptr" p)     = foreign "C" allocate(MyCapability() "ptr", words) [];
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392

  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;

393
  ACQUIRE_LOCK(sm_mutex);
394 395
  StgWeak_link(w)   = W_[weak_ptr_list];
  W_[weak_ptr_list] = w;
396
  RELEASE_LOCK(sm_mutex);
397 398 399 400 401

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

  RET_P(w);
}
402

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

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

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

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

440 441 442 443 444 445 446
  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)) [];
  }

447 448 449 450 451 452 453 454
  /* return the finalizer */
  if (f == stg_NO_FINALIZER_closure) {
      RET_NP(0,stg_NO_FINALIZER_closure);
  } else {
      RET_NP(1,f);
  }
}

455
stg_deRefWeakzh
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
{
  /* 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);
}

/* -----------------------------------------------------------------------------
472
   Floating point operations.
473 474
   -------------------------------------------------------------------------- */

475
stg_decodeFloatzuIntzh
476 477 478
{ 
    W_ p;
    F_ arg;
479 480 481
    W_ mp_tmp1;
    W_ mp_tmp_w;

482
    STK_CHK_GEN( WDS(2), NO_PTRS, stg_decodeFloatzuIntzh );
483 484 485

    mp_tmp1  = Sp - WDS(1);
    mp_tmp_w = Sp - WDS(2);
486 487 488 489 490 491 492 493 494 495 496
    
    /* 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]);
}

497
stg_decodeDoublezu2Intzh
498 499 500
{ 
    D_ arg;
    W_ p;
501 502 503 504 505
    W_ mp_tmp1;
    W_ mp_tmp2;
    W_ mp_result1;
    W_ mp_result2;

506
    STK_CHK_GEN( WDS(4), NO_PTRS, stg_decodeDoublezu2Intzh );
507 508 509 510 511

    mp_tmp1    = Sp - WDS(1);
    mp_tmp2    = Sp - WDS(2);
    mp_result1 = Sp - WDS(3);
    mp_result2 = Sp - WDS(4);
512 513 514 515 516

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

    /* Perform the operation */
517 518 519 520 521 522 523
    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]);
524 525
}

526 527 528 529
/* -----------------------------------------------------------------------------
 * Concurrency primitives
 * -------------------------------------------------------------------------- */

530
stg_forkzh
531 532
{
  /* args: R1 = closure to spark */
533

534
  MAYBE_GC(R1_PTR, stg_forkzh);
535

536 537 538 539
  W_ closure;
  W_ threadid;
  closure = R1;

540
  ("ptr" threadid) = foreign "C" createIOThread( MyCapability() "ptr", 
541 542
				RtsFlags_GcFlags_initialStkSize(RtsFlags), 
				closure "ptr") [];
543 544 545 546 547 548

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

549 550
  foreign "C" scheduleThread(MyCapability() "ptr", threadid "ptr") [];

551 552
  // context switch soon, but not immediately: we don't want every
  // forkIO to force a context-switch.
553
  Capability_context_switch(MyCapability()) = 1 :: CInt;
554 555 556 557
  
  RET_P(threadid);
}

558
stg_forkOnzh
559 560 561
{
  /* args: R1 = cpu, R2 = closure to spark */

562
  MAYBE_GC(R2_PTR, stg_forkOnzh);
563 564 565 566 567 568 569

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

570
  ("ptr" threadid) = foreign "C" createIOThread( MyCapability() "ptr", 
571
				RtsFlags_GcFlags_initialStkSize(RtsFlags), 
572
				closure "ptr") [];
573 574 575 576 577 578

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

579
  foreign "C" scheduleThreadOn(MyCapability() "ptr", cpu, threadid "ptr") [];
580

581 582
  // context switch soon, but not immediately: we don't want every
  // forkIO to force a context-switch.
583
  Capability_context_switch(MyCapability()) = 1 :: CInt;
584
  
585
  RET_P(threadid);
586 587
}

588
stg_yieldzh
589 590 591 592
{
  jump stg_yield_noregs;
}

593
stg_myThreadIdzh
594 595 596 597 598
{
  /* no args. */
  RET_P(CurrentTSO);
}

599
stg_labelThreadzh
600 601 602 603 604
{
  /* args: 
	R1 = ThreadId#
	R2 = Addr# */
#ifdef DEBUG
605
  foreign "C" labelThread(R1 "ptr", R2 "ptr") [];
606 607 608 609
#endif
  jump %ENTRY_CODE(Sp(0));
}

610
stg_isCurrentThreadBoundzh
611 612 613
{
  /* no args */
  W_ r;
614
  (r) = foreign "C" isThreadBound(CurrentTSO) [];
615 616 617
  RET_N(r);
}

618
stg_threadStatuszh
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
{
    /* 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);
}
651 652 653 654 655 656 657 658 659

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

#define SP_OFF 0

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

660
INFO_TABLE_RET(stg_catch_retry_frame, CATCH_RETRY_FRAME,
661
#if defined(PROFILING)
662
  W_ unused1, W_ unused2,
663
#endif
664
  W_ unused3, P_ unused4, P_ unused5)
665 666 667 668 669
{
   W_ r, frame, trec, outer;

   frame = Sp;
   trec = StgTSO_trec(CurrentTSO);
670
   outer  = StgTRecHeader_enclosing_trec(trec);
671
   (r) = foreign "C" stmCommitNestedTransaction(MyCapability() "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
672
   if (r != 0) {
673 674 675 676 677
     /* 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
678
     /* Did not commit: re-execute */
679
     W_ new_trec;
680
     ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
681
     StgTSO_trec(CurrentTSO) = new_trec;
Simon Marlow's avatar
Simon Marlow committed
682
     if (StgCatchRetryFrame_running_alt_code(frame) != 0::I32) {
683 684 685 686
       R1 = StgCatchRetryFrame_alt_code(frame);
     } else {
       R1 = StgCatchRetryFrame_first_code(frame);
     }
687
     jump stg_ap_v_fast;
688 689
   }
}
690 691


Simon Marlow's avatar
Simon Marlow committed
692
// Atomically frame ------------------------------------------------------------
693

694
INFO_TABLE_RET(stg_atomically_frame, ATOMICALLY_FRAME,
695
#if defined(PROFILING)
696
  W_ unused1, W_ unused2,
697
#endif
698
  P_ code, P_ next_invariant_to_check, P_ result)
699
{
tharris@microsoft.com's avatar
tharris@microsoft.com committed
700
  W_ frame, trec, valid, next_invariant, q, outer;
701

702 703 704
  frame  = Sp;
  trec   = StgTSO_trec(CurrentTSO);
  result = R1;
705
  outer  = StgTRecHeader_enclosing_trec(trec);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
706 707 708

  if (outer == NO_TREC) {
    /* First time back at the atomically frame -- pick up invariants */
709
    ("ptr" q) = foreign "C" stmGetInvariantsToCheck(MyCapability() "ptr", trec "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
710
    StgAtomicallyFrame_next_invariant_to_check(frame) = q;
711
    StgAtomicallyFrame_result(frame) = result;
712 713

  } else {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
    /* 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 */
731
    ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", trec "ptr") [];
732
    StgTSO_trec(CurrentTSO) = trec;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
733 734 735

    next_invariant = StgInvariantCheckQueue_invariant(q);
    R1 = StgAtomicInvariant_code(next_invariant);
736
    jump stg_ap_v_fast;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
737 738 739 740

  } else {

    /* We've got no more invariants to check, try to commit */
741
    (valid) = foreign "C" stmCommitTransaction(MyCapability() "ptr", trec "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
742 743 744
    if (valid != 0) {
      /* Transaction was valid: commit succeeded */
      StgTSO_trec(CurrentTSO) = NO_TREC;
745
      R1 = StgAtomicallyFrame_result(frame);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
746 747 748 749
      Sp = Sp + SIZEOF_StgAtomicallyFrame;
      jump %ENTRY_CODE(Sp(SP_OFF));
    } else {
      /* Transaction was not valid: try again */
750
      ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr") [];
tharris@microsoft.com's avatar
tharris@microsoft.com committed
751 752 753 754 755
      StgTSO_trec(CurrentTSO) = trec;
      StgAtomicallyFrame_next_invariant_to_check(frame) = END_INVARIANT_CHECK_QUEUE;
      R1 = StgAtomicallyFrame_code(frame);
      jump stg_ap_v_fast;
    }
756 757 758
  }
}

759 760 761 762
INFO_TABLE_RET(stg_atomically_waiting_frame, ATOMICALLY_FRAME,
#if defined(PROFILING)
  W_ unused1, W_ unused2,
#endif
763
  P_ code, P_ next_invariant_to_check, P_ result)
764 765 766 767 768 769
{
  W_ frame, trec, valid;

  frame = Sp;

  /* The TSO is currently waiting: should we stop waiting? */
770
  (valid) = foreign "C" stmReWait(MyCapability() "ptr", CurrentTSO "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
771
  if (valid != 0) {
772 773 774 775
    /* Previous attempt is still valid: no point trying again yet */
    jump stg_block_noregs;
  } else {
    /* Previous attempt is no longer valid: try again */
776
    ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", NO_TREC "ptr") [];
777 778 779
    StgTSO_trec(CurrentTSO) = trec;
    StgHeader_info(frame) = stg_atomically_frame_info;
    R1 = StgAtomicallyFrame_code(frame);
780
    jump stg_ap_v_fast;
781
  }
782
}
783 784 785 786 787 788 789 790 791 792

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

793 794 795 796
INFO_TABLE_RET(stg_catch_stm_frame, CATCH_STM_FRAME,
#if defined(PROFILING)
  W_ unused1, W_ unused2,
#endif
797
  P_ unused3, P_ unused4)
Simon Marlow's avatar
Simon Marlow committed
798 799 800 801
   {
      W_ r, frame, trec, outer;
      frame = Sp;
      trec = StgTSO_trec(CurrentTSO);
802
      outer  = StgTRecHeader_enclosing_trec(trec);
803
      (r) = foreign "C" stmCommitNestedTransaction(MyCapability() "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
804 805 806 807 808 809 810 811
      if (r != 0) {
        /* Commit succeeded */
        StgTSO_trec(CurrentTSO) = outer;
        Sp = Sp + SIZEOF_StgCatchSTMFrame;
        jump Sp(SP_OFF);
      } else {
        /* Commit failed */
        W_ new_trec;
812
        ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
813 814 815 816 817
        StgTSO_trec(CurrentTSO) = new_trec;
        R1 = StgCatchSTMFrame_code(frame);
        jump stg_ap_v_fast;
      }
   }
818 819 820 821


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

822
stg_atomicallyzh
823 824 825 826 827
{
  W_ frame;
  W_ old_trec;
  W_ new_trec;
  
828
  // stmStartTransaction may allocate
829
  MAYBE_GC (R1_PTR, stg_atomicallyzh); 
830

831
  /* Args: R1 = m :: STM a */
832
  STK_CHK_GEN(SIZEOF_StgAtomicallyFrame + WDS(1), R1_PTR, stg_atomicallyzh);
833

834 835 836 837
  old_trec = StgTSO_trec(CurrentTSO);

  /* Nested transactions are not allowed; raise an exception */
  if (old_trec != NO_TREC) {
838
     R1 = base_ControlziExceptionziBase_nestedAtomically_closure;
839
     jump stg_raisezh;
840 841
  }

842 843 844 845
  /* Set up the atomically frame */
  Sp = Sp - SIZEOF_StgAtomicallyFrame;
  frame = Sp;

846
  SET_HDR(frame,stg_atomically_frame_info, W_[CCCS]);
847
  StgAtomicallyFrame_code(frame) = R1;
848
  StgAtomicallyFrame_result(frame) = NO_TREC;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
849
  StgAtomicallyFrame_next_invariant_to_check(frame) = END_INVARIANT_CHECK_QUEUE;
850 851

  /* Start the memory transcation */
852
  ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", old_trec "ptr") [R1];
853 854 855
  StgTSO_trec(CurrentTSO) = new_trec;

  /* Apply R1 to the realworld token */
856
  jump stg_ap_v_fast;
857 858 859
}


860
stg_catchSTMzh
861 862 863 864 865
{
  W_ frame;
  
  /* Args: R1 :: STM a */
  /* Args: R2 :: Exception -> STM a */
866
  STK_CHK_GEN(SIZEOF_StgCatchSTMFrame + WDS(1), R1_PTR & R2_PTR, stg_catchSTMzh);
867 868 869 870 871

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

872
  SET_HDR(frame, stg_catch_stm_frame_info, W_[CCCS]);
873
  StgCatchSTMFrame_handler(frame) = R2;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
874 875 876 877 878 879
  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);
880
  ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", cur_trec "ptr");
tharris@microsoft.com's avatar
tharris@microsoft.com committed
881
  StgTSO_trec(CurrentTSO) = new_trec;
882 883

  /* Apply R1 to the realworld token */
884
  jump stg_ap_v_fast;
885 886 887
}


888
stg_catchRetryzh
889 890 891 892 893
{
  W_ frame;
  W_ new_trec;
  W_ trec;

894
  // stmStartTransaction may allocate
895
  MAYBE_GC (R1_PTR & R2_PTR, stg_catchRetryzh); 
896

897 898
  /* Args: R1 :: STM a */
  /* Args: R2 :: STM a */
899
  STK_CHK_GEN(SIZEOF_StgCatchRetryFrame + WDS(1), R1_PTR & R2_PTR, stg_catchRetryzh);
900 901 902

  /* Start a nested transaction within which to run the first code */
  trec = StgTSO_trec(CurrentTSO);
903
  ("ptr" new_trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", trec "ptr") [R1,R2];
904 905 906 907 908 909
  StgTSO_trec(CurrentTSO) = new_trec;

  /* Set up the catch-retry frame */
  Sp = Sp - SIZEOF_StgCatchRetryFrame;
  frame = Sp;
  
910
  SET_HDR(frame, stg_catch_retry_frame_info, W_[CCCS]);
911
  StgCatchRetryFrame_running_alt_code(frame) = 0 :: CInt; // false;
912 913 914 915
  StgCatchRetryFrame_first_code(frame) = R1;
  StgCatchRetryFrame_alt_code(frame) = R2;

  /* Apply R1 to the realworld token */
916
  jump stg_ap_v_fast;
917 918 919
}


920
stg_retryzh
921 922 923 924 925 926 927
{
  W_ frame_type;
  W_ frame;
  W_ trec;
  W_ outer;
  W_ r;

928
  MAYBE_GC (NO_PTRS, stg_retryzh); // STM operations may allocate
929 930 931 932

  // Find the enclosing ATOMICALLY_FRAME or CATCH_RETRY_FRAME
retry_pop_stack:
  StgTSO_sp(CurrentTSO) = Sp;
933
  (frame_type) = foreign "C" findRetryFrameHelper(CurrentTSO "ptr") [];
934 935
  Sp = StgTSO_sp(CurrentTSO);
  frame = Sp;
tharris@microsoft.com's avatar
tharris@microsoft.com committed
936
  trec = StgTSO_trec(CurrentTSO);
937
  outer  = StgTRecHeader_enclosing_trec(trec);
938 939 940 941

  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
942 943 944
    // 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
945
    if (!StgCatchRetryFrame_running_alt_code(frame) != 0::I32) {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
946
      // Retry in the first branch: try the alternative
947
      ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
948
      StgTSO_trec(CurrentTSO) = trec;
949
      StgCatchRetryFrame_running_alt_code(frame) = 1 :: CInt; // true;
950
      R1 = StgCatchRetryFrame_alt_code(frame);
951
      jump stg_ap_v_fast;
952
    } else {
tharris@microsoft.com's avatar
tharris@microsoft.com committed
953 954 955 956
      // Retry in the alternative code: propagate the retry
      StgTSO_trec(CurrentTSO) = outer;
      Sp = Sp + SIZEOF_StgCatchRetryFrame;
      goto retry_pop_stack;
957 958 959 960 961
    }
  }

  // We've reached the ATOMICALLY_FRAME: attempt to wait 
  ASSERT(frame_type == ATOMICALLY_FRAME);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
962 963 964 965 966 967 968
  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;
969
    StgTSO_trec(CurrentTSO) = trec;
970
    outer  = StgTRecHeader_enclosing_trec(trec);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
971
  }
972
  ASSERT(outer == NO_TREC);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
973

974
  (r) = foreign "C" stmWait(MyCapability() "ptr", CurrentTSO "ptr", trec "ptr") [];
Simon Marlow's avatar
Simon Marlow committed
975
  if (r != 0) {
976
    // Transaction was valid: stmWait put us on the TVars' queues, we now block
977
    StgHeader_info(frame) = stg_atomically_waiting_frame_info;
978
    Sp = frame;
979
    // Fix up the stack in the unregisterised case: the return convention is different.
980 981
    R3 = trec; // passing to stmWaitUnblock()
    jump stg_block_stmwait;
982 983
  } else {
    // Transaction was not valid: retry immediately
984
    ("ptr" trec) = foreign "C" stmStartTransaction(MyCapability() "ptr", outer "ptr") [];
985 986 987
    StgTSO_trec(CurrentTSO) = trec;
    R1 = StgAtomicallyFrame_code(frame);
    Sp = frame;
988
    jump stg_ap_v_fast;
989 990 991 992
  }
}


993
stg_checkzh
tharris@microsoft.com's avatar
tharris@microsoft.com committed
994 995 996 997
{
  W_ trec, closure;

  /* Args: R1 = invariant closure */
998
  MAYBE_GC (R1_PTR, stg_checkzh); 
tharris@microsoft.com's avatar
tharris@microsoft.com committed
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009

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

  jump %ENTRY_CODE(Sp(0));
}


1010
stg_newTVarzh
1011 1012
{
  W_ tv;
1013
  W_ new_value;
1014 1015 1016

  /* Args: R1 = initialisation value */

1017
  MAYBE_GC (R1_PTR, stg_newTVarzh); 
1018
  new_value = R1;
1019
  ("ptr" tv) = foreign "C" stmNewTVar(MyCapability() "ptr", new_value "ptr") [];
1020 1021 1022 1023
  RET_P(tv);
}


1024
stg_readTVarzh
1025 1026 1027 1028 1029 1030 1031
{
  W_ trec;
  W_ tvar;
  W_ result;

  /* Args: R1 = TVar closure */

1032
  MAYBE_GC (R1_PTR, stg_readTVarzh); // Call to stmReadTVar may allocate
1033 1034
  trec = StgTSO_trec(CurrentTSO);
  tvar = R1;
1035
  ("ptr" result) = foreign "C" stmReadTVar(MyCapability() "ptr", trec "ptr", tvar "ptr") [];
1036 1037 1038 1039

  RET_P(result);
}

1040
stg_readTVarIOzh
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
{
    W_ result;

again:
    result = StgTVar_current_value(R1);
    if (%INFO_PTR(result) == stg_TREC_HEADER_info) {
        goto again;
    }
    RET_P(result);
}
1051

1052
stg_writeTVarzh
1053 1054 1055 1056 1057 1058 1059 1060
{
  W_ trec;
  W_ tvar;
  W_ new_value;
  
  /* Args: R1 = TVar closure */
  /*       R2 = New value    */

1061
  MAYBE_GC (R1_PTR & R2_PTR, stg_writeTVarzh); // Call to stmWriteTVar may allocate
1062 1063 1064
  trec = StgTSO_trec(CurrentTSO);
  tvar = R1;
  new_value = R2;
1065
  foreign "C" stmWriteTVar(MyCapability() "ptr", trec "ptr", tvar "ptr", new_value "ptr") [];
1066 1067 1068 1069 1070

  jump %ENTRY_CODE(Sp(0));
}


1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101