StgMiscClosures.cmm 30.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* ----------------------------------------------------------------------------
 *
 * (c) The GHC Team, 1998-2004
 *
 * Entry code for various built-in closure types.
 *
 * 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"

15
import pthread_mutex_lock;
Simon Marlow's avatar
Simon Marlow committed
16 17
import ghczmprim_GHCziTypes_Czh_info;
import ghczmprim_GHCziTypes_Izh_info;
18 19
import EnterCriticalSection;
import LeaveCriticalSection;
20

21 22 23 24
/* ----------------------------------------------------------------------------
   Stack underflow
   ------------------------------------------------------------------------- */

25 26 27
INFO_TABLE_RET (stg_stack_underflow_frame, UNDERFLOW_FRAME,
                W_ info_ptr, P_ unused)
    /* no args => explicit stack */
28
{
29
    unwind Sp = W_[Sp + WDS(2)];
30

31 32 33
    W_ new_tso;
    W_ ret_off;

34 35
    SAVE_STGREGS

36
    SAVE_THREAD_STATE();
37 38
    (ret_off) = foreign "C" threadStackUnderflow(MyCapability() "ptr",
                                                 CurrentTSO);
39 40
    LOAD_THREAD_STATE();

41 42 43
    RESTORE_STGREGS

    jump %ENTRY_CODE(Sp(ret_off)) [*]; // NB. all registers live!
44 45
}

46 47 48 49
/* ----------------------------------------------------------------------------
   Restore a saved cost centre
   ------------------------------------------------------------------------- */

50
INFO_TABLE_RET (stg_restore_cccs, RET_SMALL, W_ info_ptr, W_ cccs)
51
{
52
    unwind Sp = Sp + WDS(2);
53
#if defined(PROFILING)
54
    CCCS = Sp(1);
55 56
#endif
    Sp_adj(2);
57
    jump %ENTRY_CODE(Sp(0)) [*]; // NB. all registers live!
58 59
}

Simon Marlow's avatar
Simon Marlow committed
60 61 62 63

INFO_TABLE_RET (stg_restore_cccs_eval, RET_SMALL, W_ info_ptr, W_ cccs)
    return (P_ ret)
{
64
    unwind Sp = Sp + WDS(2);
Simon Marlow's avatar
Simon Marlow committed
65 66 67 68 69 70
#if defined(PROFILING)
    CCCS = cccs;
#endif
    jump stg_ap_0_fast(ret);
}

71 72 73 74
/* ----------------------------------------------------------------------------
   Support for the bytecode interpreter.
   ------------------------------------------------------------------------- */

75 76 77 78 79 80 81 82
/* 7 bits of return code for constructors created by the interpreter. */
stg_interp_constr1_entry (P_ ret) { return (ret + 1); }
stg_interp_constr2_entry (P_ ret) { return (ret + 2); }
stg_interp_constr3_entry (P_ ret) { return (ret + 3); }
stg_interp_constr4_entry (P_ ret) { return (ret + 4); }
stg_interp_constr5_entry (P_ ret) { return (ret + 5); }
stg_interp_constr6_entry (P_ ret) { return (ret + 6); }
stg_interp_constr7_entry (P_ ret) { return (ret + 7); }
83 84 85 86 87 88 89 90 91 92 93 94

/* Some info tables to be used when compiled code returns a value to
   the interpreter, i.e. the interpreter pushes one of these onto the
   stack before entering a value.  What the code does is to
   impedance-match the compiled return convention (in R1p/R1n/F1/D1 etc) to
   the interpreter's convention (returned value is on top of stack),
   and then cause the scheduler to enter the interpreter.

   On entry, the stack (growing down) looks like this:

      ptr to BCO holding return continuation
      ptr to one of these info tables.
dterei's avatar
dterei committed
95

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
   The info table code, both direct and vectored, must:
      * push R1/F1/D1 on the stack, and its tag if necessary
      * push the BCO (so it's now on the stack twice)
      * Yield, ie, go to the scheduler.

   Scheduler examines the t.o.s, discovers it is a BCO, and proceeds
   directly to the bytecode interpreter.  That pops the top element
   (the BCO, containing the return continuation), and interprets it.
   Net result: return continuation gets interpreted, with the
   following stack:

      ptr to this BCO
      ptr to the info table just jumped thru
      return value

   which is just what we want -- the "standard" return layout for the
   interpreter.  Hurrah!

   Don't ask me how unboxed tuple returns are supposed to work.  We
   haven't got a good story about that yet.
*/

118
INFO_TABLE_RET( stg_ctoi_R1p, RET_BCO)
119
    /* explicit stack */
120 121 122 123
{
    Sp_adj(-2);
    Sp(1) = R1;
    Sp(0) = stg_enter_info;
124
    jump stg_yield_to_interpreter [];
125 126 127
}

/*
dterei's avatar
dterei committed
128
 * When the returned value is a pointer, but unlifted, in R1 ...
129
 */
130
INFO_TABLE_RET( stg_ctoi_R1unpt, RET_BCO )
131
    /* explicit stack */
132 133 134
{
    Sp_adj(-2);
    Sp(1) = R1;
135 136
    Sp(0) = stg_ret_p_info;
    jump stg_yield_to_interpreter [];
137 138 139 140 141
}

/*
 * When the returned value is a non-pointer in R1 ...
 */
142
INFO_TABLE_RET( stg_ctoi_R1n, RET_BCO )
143
    /* explicit stack */
144 145 146
{
    Sp_adj(-2);
    Sp(1) = R1;
147
    Sp(0) = stg_ret_n_info;
148
    jump stg_yield_to_interpreter [];
149 150 151 152 153
}

/*
 * When the returned value is in F1
 */
154
INFO_TABLE_RET( stg_ctoi_F1, RET_BCO )
155
    /* explicit stack */
156 157 158
{
    Sp_adj(-2);
    F_[Sp + WDS(1)] = F1;
159 160
    Sp(0) = stg_ret_f_info;
    jump stg_yield_to_interpreter [];
161 162 163 164 165
}

/*
 * When the returned value is in D1
 */
166
INFO_TABLE_RET( stg_ctoi_D1, RET_BCO )
167
    /* explicit stack */
168 169 170
{
    Sp_adj(-1) - SIZEOF_DOUBLE;
    D_[Sp + WDS(1)] = D1;
171 172
    Sp(0) = stg_ret_d_info;
    jump stg_yield_to_interpreter [];
173 174 175 176 177
}

/*
 * When the returned value is in L1
 */
178
INFO_TABLE_RET( stg_ctoi_L1, RET_BCO )
179
    /* explicit stack */
180 181 182
{
    Sp_adj(-1) - 8;
    L_[Sp + WDS(1)] = L1;
183 184
    Sp(0) = stg_ret_l_info;
    jump stg_yield_to_interpreter [];
185 186 187 188 189
}

/*
 * When the returned value is a void
 */
190
INFO_TABLE_RET( stg_ctoi_V, RET_BCO )
191
    /* explicit stack */
192 193
{
    Sp_adj(-1);
194 195
    Sp(0) = stg_ret_v_info;
    jump stg_yield_to_interpreter [];
196 197 198 199 200 201 202
}

/*
 * Dummy info table pushed on the top of the stack when the interpreter
 * should apply the BCO on the stack to its arguments, also on the
 * stack.
 */
203
INFO_TABLE_RET( stg_apply_interp, RET_BCO )
204
    /* explicit stack */
205 206
{
    /* Just in case we end up in here... (we shouldn't) */
207
    jump stg_yield_to_interpreter [];
208 209 210 211 212 213 214
}

/* ----------------------------------------------------------------------------
   Entry code for a BCO
   ------------------------------------------------------------------------- */

INFO_TABLE_FUN( stg_BCO, 4, 0, BCO, "BCO", "BCO", ARG_BCO )
215
    /* explicit stack */
216 217 218
{
  /* entering a BCO means "apply it", same as a function */
  Sp_adj(-2);
219 220
  // Skip the stack check; the interpreter will do one before using
  // the stack anyway.
221 222
  Sp(1) = R1;
  Sp(0) = stg_apply_interp_info;
223
  jump stg_yield_to_interpreter [];
224 225 226 227 228
}

/* ----------------------------------------------------------------------------
   Info tables for indirections.

Simon Marlow's avatar
Simon Marlow committed
229 230 231 232
   SPECIALISED INDIRECTIONS: we have a specialised indirection for direct returns,
   so that we can avoid entering
   the object when we know it points directly to a value.  The update
   code (Updates.cmm) updates objects with the appropriate kind of
233 234 235 236
   indirection.  We only do this for young-gen indirections.
   ------------------------------------------------------------------------- */

INFO_TABLE(stg_IND,1,0,IND,"IND","IND")
237 238 239 240 241 242 243 244 245 246 247 248 249 250
#if 0
/*
  This version in high-level cmm generates slightly less good code
  than the low-level version below it. (ToDo)
*/
    (P_ node)
{
    TICK_ENT_DYN_IND(); /* tick */
    node = UNTAG(StgInd_indirectee(node));
    TICK_ENT_VIA_NODE();
    jump %GET_ENTRY(node) (node);
}
#else
    /* explicit stack */
251
{
dterei's avatar
dterei committed
252
    TICK_ENT_DYN_IND(); /* tick */
Simon Marlow's avatar
Simon Marlow committed
253
    R1 = UNTAG(StgInd_indirectee(R1));
254
    TICK_ENT_VIA_NODE();
255
    jump %GET_ENTRY(R1) [R1];
256
}
257
#endif
258

Simon Marlow's avatar
Simon Marlow committed
259
INFO_TABLE(stg_IND_direct,1,0,IND,"IND","IND")
260
    (P_ node)
Simon Marlow's avatar
Simon Marlow committed
261
{
dterei's avatar
dterei committed
262
    TICK_ENT_DYN_IND(); /* tick */
263
    node = StgInd_indirectee(node);
Simon Marlow's avatar
Simon Marlow committed
264
    TICK_ENT_VIA_NODE();
265
    jump %ENTRY_CODE(Sp(0)) (node);
266 267 268
}

INFO_TABLE(stg_IND_STATIC,1,0,IND_STATIC,"IND_STATIC","IND_STATIC")
269
    /* explicit stack */
270
{
dterei's avatar
dterei committed
271
    TICK_ENT_STATIC_IND(); /* tick */
Simon Marlow's avatar
Simon Marlow committed
272
    R1 = UNTAG(StgInd_indirectee(R1));
273
    TICK_ENT_VIA_NODE();
274
    jump %GET_ENTRY(R1) [R1];
275 276 277 278 279 280 281 282 283 284 285
}

/* ----------------------------------------------------------------------------
   Black holes.

   Entering a black hole normally causes a cyclic data dependency, but
   in the concurrent world, black holes are synchronization points,
   and they are turned into blocking queues when there are threads
   waiting for the evaluation of the closure to finish.
   ------------------------------------------------------------------------- */

286
INFO_TABLE(stg_BLACKHOLE,1,0,BLACKHOLE,"BLACKHOLE","BLACKHOLE")
287
    (P_ node)
288
{
289 290
    W_ r, info, owner, bd;
    P_ p, bq, msg;
291

dterei's avatar
dterei committed
292
    TICK_ENT_DYN_IND(); /* tick */
293

294
retry:
295
    p = StgInd_indirectee(node);
296
    if (GETTAG(p) != 0) {
297
        return (p);
298 299 300 301 302 303 304 305 306 307 308 309 310 311
    }

    info = StgHeader_info(p);
    if (info == stg_IND_info) {
        // This could happen, if e.g. we got a BLOCKING_QUEUE that has
        // just been replaced with an IND by another thread in
        // wakeBlockingQueue().
        goto retry;
    }

    if (info == stg_TSO_info ||
        info == stg_BLOCKING_QUEUE_CLEAN_info ||
        info == stg_BLOCKING_QUEUE_DIRTY_info)
    {
312 313
        ("ptr" msg) = ccall allocate(MyCapability() "ptr",
                                     BYTES_TO_WDS(SIZEOF_MessageBlackHole));
dterei's avatar
dterei committed
314

315
        SET_HDR(msg, stg_MSG_BLACKHOLE_info, CCS_SYSTEM);
316
        MessageBlackHole_tso(msg) = CurrentTSO;
317
        MessageBlackHole_bh(msg) = node;
dterei's avatar
dterei committed
318

319
        (r) = ccall messageBlackHole(MyCapability() "ptr", msg "ptr");
320 321 322 323 324 325

        if (r == 0) {
            goto retry;
        } else {
            StgTSO_why_blocked(CurrentTSO) = BlockedOnBlackHole::I16;
            StgTSO_block_info(CurrentTSO) = msg;
326
            jump stg_block_blackhole(node);
327 328 329 330
        }
    }
    else
    {
331
        ENTER(p);
332
    }
333 334
}

335 336 337 338
// CAF_BLACKHOLE is allocated when entering a CAF.  The reason it is
// distinct from BLACKHOLE is so that we can tell the difference
// between an update frame on the stack that points to a CAF under
// evaluation, and one that points to a closure that is under
339 340
// evaluation by another thread (a BLACKHOLE).  see Note [suspend
// duplicate work] in ThreadPaused.c
341 342
//
INFO_TABLE(stg_CAF_BLACKHOLE,1,0,BLACKHOLE,"BLACKHOLE","BLACKHOLE")
343
    (P_ node)
344
{
345
    jump ENTRY_LBL(stg_BLACKHOLE) (node);
346
}
347

348 349 350 351 352 353 354
// EAGER_BLACKHOLE exists for the same reason as CAF_BLACKHOLE (see above).
INFO_TABLE(__stg_EAGER_BLACKHOLE,1,0,BLACKHOLE,"BLACKHOLE","BLACKHOLE")
    (P_ node)
{
    jump ENTRY_LBL(stg_BLACKHOLE) (node);
}

355 356
INFO_TABLE(stg_BLOCKING_QUEUE_CLEAN,4,0,BLOCKING_QUEUE,"BLOCKING_QUEUE","BLOCKING_QUEUE")
{ foreign "C" barf("BLOCKING_QUEUE_CLEAN object entered!") never returns; }
dterei's avatar
dterei committed
357

358

359 360
INFO_TABLE(stg_BLOCKING_QUEUE_DIRTY,4,0,BLOCKING_QUEUE,"BLOCKING_QUEUE","BLOCKING_QUEUE")
{ foreign "C" barf("BLOCKING_QUEUE_DIRTY object entered!") never returns; }
dterei's avatar
dterei committed
361

362

363
/* ----------------------------------------------------------------------------
364
   Whiteholes are used for the "locked" state of a closure (see lockClosure())
365 366
   ------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
367
INFO_TABLE(stg_WHITEHOLE, 0,0, WHITEHOLE, "WHITEHOLE", "WHITEHOLE")
368
    (P_ node)
dterei's avatar
dterei committed
369
{
370 371 372 373 374 375
#if defined(THREADED_RTS)
    W_ info, i;

    i = 0;
loop:
    // spin until the WHITEHOLE is updated
376
    info = StgHeader_info(node);
377
    if (info == stg_WHITEHOLE_info) {
378 379 380 381
#if defined(PROF_SPIN)
        W_[whitehole_lockClosure_spin] =
            W_[whitehole_lockClosure_spin] + 1;
#endif
382 383 384
        i = i + 1;
        if (i == SPIN_COUNT) {
            i = 0;
385 386 387 388
#if defined(PROF_SPIN)
            W_[whitehole_lockClosure_yield] =
                W_[whitehole_lockClosure_yield] + 1;
#endif
389
            ccall yieldThread();
390
        }
391 392
        // TODO: We should busy_wait_nop() here, but that's not currently
        // defined in CMM.
393 394
        goto loop;
    }
395
    jump %ENTRY_CODE(info) (node);
396
#else
397
    ccall barf("WHITEHOLE object entered!") never returns;
398 399
#endif
}
400

401 402 403 404 405 406 407
/* ----------------------------------------------------------------------------
   Some static info tables for things that don't get entered, and
   therefore don't need entry code (i.e. boxed but unpointed objects)
   NON_ENTERABLE_ENTRY_CODE now defined at the beginning of the file
   ------------------------------------------------------------------------- */

INFO_TABLE(stg_TSO, 0,0,TSO, "TSO", "TSO")
408
{ foreign "C" barf("TSO object entered!") never returns; }
409

410 411 412
INFO_TABLE(stg_STACK, 0,0, STACK, "STACK", "STACK")
{ foreign "C" barf("STACK object entered!") never returns; }

413 414 415 416 417 418 419 420
/* ----------------------------------------------------------------------------
   Weak pointers

   Live weak pointers have a special closure type.  Dead ones are just
   nullary constructors (although they live on the heap - we overwrite
   live weak pointers with dead ones).
   ------------------------------------------------------------------------- */

421
INFO_TABLE(stg_WEAK,1,4,WEAK,"WEAK","WEAK")
422
{ foreign "C" barf("WEAK object entered!") never returns; }
423 424 425 426 427

/*
 * It's important when turning an existing WEAK into a DEAD_WEAK
 * (which is what finalizeWeak# does) that we don't lose the link
 * field and break the linked list of weak pointers.  Hence, we give
428
 * DEAD_WEAK 5 non-pointer fields.
429
 */
430
INFO_TABLE_CONSTR(stg_DEAD_WEAK,0,5,0,CONSTR,"DEAD_WEAK","DEAD_WEAK")
431
{ foreign "C" barf("DEAD_WEAK object entered!") never returns; }
432

433 434 435 436 437 438 439 440 441
/* ----------------------------------------------------------------------------
   C finalizer lists

   Singly linked lists that chain multiple C finalizers on a weak pointer.
   ------------------------------------------------------------------------- */

INFO_TABLE_CONSTR(stg_C_FINALIZER_LIST,1,4,0,CONSTR,"C_FINALIZER_LIST","C_FINALIZER_LIST")
{ foreign "C" barf("C_FINALIZER_LIST object entered!") never returns; }

442 443 444 445 446 447 448
/* ----------------------------------------------------------------------------
   NO_FINALIZER

   This is a static nullary constructor (like []) that we use to mark an empty
   finalizer in a weak pointer object.
   ------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
449
INFO_TABLE_CONSTR(stg_NO_FINALIZER,0,0,0,CONSTR_NOCAF,"NO_FINALIZER","NO_FINALIZER")
450
{ foreign "C" barf("NO_FINALIZER object entered!") never returns; }
451

452
CLOSURE(stg_NO_FINALIZER_closure,stg_NO_FINALIZER);
453 454 455 456 457

/* ----------------------------------------------------------------------------
   Stable Names are unlifted too.
   ------------------------------------------------------------------------- */

458
INFO_TABLE(stg_STABLE_NAME,0,1,PRIM,"STABLE_NAME","STABLE_NAME")
459
{ foreign "C" barf("STABLE_NAME object entered!") never returns; }
460 461 462 463 464 465 466 467

/* ----------------------------------------------------------------------------
   MVars

   There are two kinds of these: full and empty.  We need an info table
   and entry code for each type.
   ------------------------------------------------------------------------- */

468 469
INFO_TABLE(stg_MVAR_CLEAN,3,0,MVAR_CLEAN,"MVAR","MVAR")
{ foreign "C" barf("MVAR object entered!") never returns; }
470

471 472
INFO_TABLE(stg_MVAR_DIRTY,3,0,MVAR_DIRTY,"MVAR","MVAR")
{ foreign "C" barf("MVAR object entered!") never returns; }
473

474 475 476 477
/* -----------------------------------------------------------------------------
   STM
   -------------------------------------------------------------------------- */

478 479 480 481 482
INFO_TABLE(stg_TVAR_CLEAN, 2, 1, TVAR, "TVAR", "TVAR")
{ foreign "C" barf("TVAR_CLEAN object entered!") never returns; }

INFO_TABLE(stg_TVAR_DIRTY, 2, 1, TVAR, "TVAR", "TVAR")
{ foreign "C" barf("TVAR_DIRTY object entered!") never returns; }
483

484
INFO_TABLE(stg_TVAR_WATCH_QUEUE, 3, 0, MUT_PRIM, "TVAR_WATCH_QUEUE", "TVAR_WATCH_QUEUE")
485
{ foreign "C" barf("TVAR_WATCH_QUEUE object entered!") never returns; }
tharris@microsoft.com's avatar
tharris@microsoft.com committed
486

487
INFO_TABLE(stg_ATOMIC_INVARIANT, 2, 1, MUT_PRIM, "ATOMIC_INVARIANT", "ATOMIC_INVARIANT")
488
{ foreign "C" barf("ATOMIC_INVARIANT object entered!") never returns; }
tharris@microsoft.com's avatar
tharris@microsoft.com committed
489

490
INFO_TABLE(stg_INVARIANT_CHECK_QUEUE, 3, 0, MUT_PRIM, "INVARIANT_CHECK_QUEUE", "INVARIANT_CHECK_QUEUE")
491
{ foreign "C" barf("INVARIANT_CHECK_QUEUE object entered!") never returns; }
492 493

INFO_TABLE(stg_TREC_CHUNK, 0, 0, TREC_CHUNK, "TREC_CHUNK", "TREC_CHUNK")
494
{ foreign "C" barf("TREC_CHUNK object entered!") never returns; }
495

496
INFO_TABLE(stg_TREC_HEADER, 3, 1, MUT_PRIM, "TREC_HEADER", "TREC_HEADER")
497
{ foreign "C" barf("TREC_HEADER object entered!") never returns; }
498

Simon Marlow's avatar
Simon Marlow committed
499
INFO_TABLE_CONSTR(stg_END_STM_WATCH_QUEUE,0,0,0,CONSTR_NOCAF,"END_STM_WATCH_QUEUE","END_STM_WATCH_QUEUE")
500
{ foreign "C" barf("END_STM_WATCH_QUEUE object entered!") never returns; }
tharris@microsoft.com's avatar
tharris@microsoft.com committed
501

Simon Marlow's avatar
Simon Marlow committed
502
INFO_TABLE_CONSTR(stg_END_INVARIANT_CHECK_QUEUE,0,0,0,CONSTR_NOCAF,"END_INVARIANT_CHECK_QUEUE","END_INVARIANT_CHECK_QUEUE")
503
{ foreign "C" barf("END_INVARIANT_CHECK_QUEUE object entered!") never returns; }
504

Simon Marlow's avatar
Simon Marlow committed
505
INFO_TABLE_CONSTR(stg_END_STM_CHUNK_LIST,0,0,0,CONSTR_NOCAF,"END_STM_CHUNK_LIST","END_STM_CHUNK_LIST")
506
{ foreign "C" barf("END_STM_CHUNK_LIST object entered!") never returns; }
507

Simon Marlow's avatar
Simon Marlow committed
508
INFO_TABLE_CONSTR(stg_NO_TREC,0,0,0,CONSTR_NOCAF,"NO_TREC","NO_TREC")
509
{ foreign "C" barf("NO_TREC object entered!") never returns; }
510

511
CLOSURE(stg_END_STM_WATCH_QUEUE_closure,stg_END_STM_WATCH_QUEUE);
tharris@microsoft.com's avatar
tharris@microsoft.com committed
512

513
CLOSURE(stg_END_INVARIANT_CHECK_QUEUE_closure,stg_END_INVARIANT_CHECK_QUEUE);
514

515
CLOSURE(stg_END_STM_CHUNK_LIST_closure,stg_END_STM_CHUNK_LIST);
516

517
CLOSURE(stg_NO_TREC_closure,stg_NO_TREC);
518

519 520 521 522 523 524
/* ----------------------------------------------------------------------------
   Messages
   ------------------------------------------------------------------------- */

// PRIM rather than CONSTR, because PRIM objects cannot be duplicated by the GC.

525 526 527
INFO_TABLE_CONSTR(stg_MSG_TRY_WAKEUP,2,0,0,PRIM,"MSG_TRY_WAKEUP","MSG_TRY_WAKEUP")
{ foreign "C" barf("MSG_TRY_WAKEUP object entered!") never returns; }

528 529 530
INFO_TABLE_CONSTR(stg_MSG_THROWTO,4,0,0,PRIM,"MSG_THROWTO","MSG_THROWTO")
{ foreign "C" barf("MSG_THROWTO object entered!") never returns; }

531 532 533
INFO_TABLE_CONSTR(stg_MSG_BLACKHOLE,3,0,0,PRIM,"MSG_BLACKHOLE","MSG_BLACKHOLE")
{ foreign "C" barf("MSG_BLACKHOLE object entered!") never returns; }

534 535 536 537
// used to overwrite a MSG_THROWTO when the message has been used/revoked
INFO_TABLE_CONSTR(stg_MSG_NULL,1,0,0,PRIM,"MSG_NULL","MSG_NULL")
{ foreign "C" barf("MSG_NULL object entered!") never returns; }

538 539 540 541 542 543 544
/* ----------------------------------------------------------------------------
   END_TSO_QUEUE

   This is a static nullary constructor (like []) that we use to mark the
   end of a linked TSO queue.
   ------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
545
INFO_TABLE_CONSTR(stg_END_TSO_QUEUE,0,0,0,CONSTR_NOCAF,"END_TSO_QUEUE","END_TSO_QUEUE")
546
{ foreign "C" barf("END_TSO_QUEUE object entered!") never returns; }
547

548
CLOSURE(stg_END_TSO_QUEUE_closure,stg_END_TSO_QUEUE);
549

550 551 552 553
/* ----------------------------------------------------------------------------
   GCD_CAF
   ------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
554
INFO_TABLE_CONSTR(stg_GCD_CAF,0,0,0,CONSTR_NOCAF,"GCD_CAF","GCD_CAF")
555 556
{ foreign "C" barf("Evaluated a CAF that was GC'd!") never returns; }

Ben Gamari's avatar
Ben Gamari committed
557 558 559 560 561 562 563
/* ----------------------------------------------------------------------------
   STM_AWOKEN

   This is a static nullary constructor (like []) that we use to mark a
   thread waiting on an STM wakeup
   ------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
564
INFO_TABLE_CONSTR(stg_STM_AWOKEN,0,0,0,CONSTR_NOCAF,"STM_AWOKEN","STM_AWOKEN")
Ben Gamari's avatar
Ben Gamari committed
565 566
{ foreign "C" barf("STM_AWOKEN object entered!") never returns; }

567
CLOSURE(stg_STM_AWOKEN_closure,stg_STM_AWOKEN);
Ben Gamari's avatar
Ben Gamari committed
568

569 570 571 572 573 574
/* ----------------------------------------------------------------------------
   Arrays

   These come in two basic flavours: arrays of data (StgArrWords) and arrays of
   pointers (StgArrPtrs).  They all have a similar layout:

dterei's avatar
dterei committed
575 576
   ___________________________
   | Info | No. of | data....
Arash Rouhani's avatar
Arash Rouhani committed
577
   |  Ptr | Words  |
dterei's avatar
dterei committed
578
   ---------------------------
579 580 581 582 583 584

   These are *unpointed* objects: i.e. they cannot be entered.

   ------------------------------------------------------------------------- */

INFO_TABLE(stg_ARR_WORDS, 0, 0, ARR_WORDS, "ARR_WORDS", "ARR_WORDS")
585
{ foreign "C" barf("ARR_WORDS object entered!") never returns; }
586

587
INFO_TABLE(stg_MUT_ARR_PTRS_CLEAN, 0, 0, MUT_ARR_PTRS_CLEAN, "MUT_ARR_PTRS_CLEAN", "MUT_ARR_PTRS_CLEAN")
588
{ foreign "C" barf("MUT_ARR_PTRS_CLEAN object entered!") never returns; }
589 590

INFO_TABLE(stg_MUT_ARR_PTRS_DIRTY, 0, 0, MUT_ARR_PTRS_DIRTY, "MUT_ARR_PTRS_DIRTY", "MUT_ARR_PTRS_DIRTY")
591
{ foreign "C" barf("MUT_ARR_PTRS_DIRTY object entered!") never returns; }
592 593

INFO_TABLE(stg_MUT_ARR_PTRS_FROZEN, 0, 0, MUT_ARR_PTRS_FROZEN, "MUT_ARR_PTRS_FROZEN", "MUT_ARR_PTRS_FROZEN")
594
{ foreign "C" barf("MUT_ARR_PTRS_FROZEN object entered!") never returns; }
595

596
INFO_TABLE(stg_MUT_ARR_PTRS_FROZEN0, 0, 0, MUT_ARR_PTRS_FROZEN0, "MUT_ARR_PTRS_FROZEN0", "MUT_ARR_PTRS_FROZEN0")
597
{ foreign "C" barf("MUT_ARR_PTRS_FROZEN0 object entered!") never returns; }
598

599 600 601 602 603 604 605 606 607 608 609 610
INFO_TABLE(stg_SMALL_MUT_ARR_PTRS_CLEAN, 0, 0, SMALL_MUT_ARR_PTRS_CLEAN, "SMALL_MUT_ARR_PTRS_CLEAN", "SMALL_MUT_ARR_PTRS_CLEAN")
{ foreign "C" barf("SMALL_MUT_ARR_PTRS_CLEAN object entered!") never returns; }

INFO_TABLE(stg_SMALL_MUT_ARR_PTRS_DIRTY, 0, 0, SMALL_MUT_ARR_PTRS_DIRTY, "SMALL_MUT_ARR_PTRS_DIRTY", "SMALL_MUT_ARR_PTRS_DIRTY")
{ foreign "C" barf("SMALL_MUT_ARR_PTRS_DIRTY object entered!") never returns; }

INFO_TABLE(stg_SMALL_MUT_ARR_PTRS_FROZEN, 0, 0, SMALL_MUT_ARR_PTRS_FROZEN, "SMALL_MUT_ARR_PTRS_FROZEN", "SMALL_MUT_ARR_PTRS_FROZEN")
{ foreign "C" barf("SMALL_MUT_ARR_PTRS_FROZEN object entered!") never returns; }

INFO_TABLE(stg_SMALL_MUT_ARR_PTRS_FROZEN0, 0, 0, SMALL_MUT_ARR_PTRS_FROZEN0, "SMALL_MUT_ARR_PTRS_FROZEN0", "SMALL_MUT_ARR_PTRS_FROZEN0")
{ foreign "C" barf("SMALL_MUT_ARR_PTRS_FROZEN0 object entered!") never returns; }

611 612 613 614
/* ----------------------------------------------------------------------------
   Mutable Variables
   ------------------------------------------------------------------------- */

615
INFO_TABLE(stg_MUT_VAR_CLEAN, 1, 0, MUT_VAR_CLEAN, "MUT_VAR_CLEAN", "MUT_VAR_CLEAN")
616
{ foreign "C" barf("MUT_VAR_CLEAN object entered!") never returns; }
617
INFO_TABLE(stg_MUT_VAR_DIRTY, 1, 0, MUT_VAR_DIRTY, "MUT_VAR_DIRTY", "MUT_VAR_DIRTY")
618
{ foreign "C" barf("MUT_VAR_DIRTY object entered!") never returns; }
619 620 621

/* ----------------------------------------------------------------------------
   Dummy return closure
dterei's avatar
dterei committed
622

623 624 625 626 627
   Entering this closure will just return to the address on the top of the
   stack.  Useful for getting a thread in a canonical form where we can
   just enter the top stack word to start the thread.  (see deleteThread)
 * ------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
628
INFO_TABLE( stg_dummy_ret, 0, 0, CONSTR_NOCAF, "DUMMY_RET", "DUMMY_RET")
629
    ()
630
{
631
    return ();
632
}
633
CLOSURE(stg_dummy_ret_closure,stg_dummy_ret);
634

635 636 637 638 639 640 641
/* ----------------------------------------------------------------------------
   MVAR_TSO_QUEUE
   ------------------------------------------------------------------------- */

INFO_TABLE_CONSTR(stg_MVAR_TSO_QUEUE,2,0,0,PRIM,"MVAR_TSO_QUEUE","MVAR_TSO_QUEUE")
{ foreign "C" barf("MVAR_TSO_QUEUE object entered!") never returns; }

gcampax's avatar
gcampax committed
642 643 644
/* ----------------------------------------------------------------------------
   COMPACT_NFDATA (a blob of data in NF with no outgoing pointers)

645 646 647 648
   See Note [Compact Normal Forms] in sm/CNF.c

   CLEAN/DIRTY refer to the state of the "hash" field: DIRTY means that
   compaction is in progress and the hash table needs to be scanned by the GC.
gcampax's avatar
gcampax committed
649 650
   ------------------------------------------------------------------------- */

651
INFO_TABLE( stg_COMPACT_NFDATA_CLEAN, 0, 5, COMPACT_NFDATA, "COMPACT_NFDATA", "COMPACT_NFDATA")
gcampax's avatar
gcampax committed
652
    ()
653 654 655 656 657
{ foreign "C" barf("COMPACT_NFDATA_CLEAN object entered!") never returns; }

INFO_TABLE( stg_COMPACT_NFDATA_DIRTY, 0, 5, COMPACT_NFDATA, "COMPACT_NFDATA", "COMPACT_NFDATA")
    ()
{ foreign "C" barf("COMPACT_NFDATA_DIRTY object entered!") never returns; }
gcampax's avatar
gcampax committed
658

659
/* ----------------------------------------------------------------------------
dterei's avatar
dterei committed
660
   CHARLIKE and INTLIKE closures.
661 662 663 664 665 666

   These are static representations of Chars and small Ints, so that
   we can remove dynamic Chars and Ints during garbage collection and
   replace them with references to the static objects.
   ------------------------------------------------------------------------- */

667
#if defined(COMPILING_WINDOWS_DLL)
668
/*
669
 * When sticking the RTS in a Windows DLL, we delay populating the
670 671
 * Charlike and Intlike tables until load-time, which is only
 * when we've got the real addresses to the C# and I# closures.
dterei's avatar
dterei committed
672 673 674
 *
 * -- this is currently broken BL 2009/11/14.
 *    we don't rewrite to static closures at all with Windows DLLs.
675
 */
676
// #warning Is this correct? _imp is a pointer!
Simon Marlow's avatar
Simon Marlow committed
677 678
#define Char_hash_con_info _imp__ghczmprim_GHCziTypes_Czh_con_info
#define Int_hash_con_info _imp__ghczmprim_GHCziTypes_Izh_con_info
679
#else
Simon Marlow's avatar
Simon Marlow committed
680 681
#define Char_hash_con_info ghczmprim_GHCziTypes_Czh_con_info
#define Int_hash_con_info ghczmprim_GHCziTypes_Izh_con_info
682 683 684
#endif


Simon Marlow's avatar
Simon Marlow committed
685 686
#define CHARLIKE_HDR(n)  CLOSURE(Char_hash_con_info, n)
#define INTLIKE_HDR(n)   CLOSURE(Int_hash_con_info, n)
687

688
#if !(defined(COMPILING_WINDOWS_DLL))
689
section "data" {
690
 stg_CHARLIKE_closure:
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 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 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 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 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 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 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
    CHARLIKE_HDR(0)
    CHARLIKE_HDR(1)
    CHARLIKE_HDR(2)
    CHARLIKE_HDR(3)
    CHARLIKE_HDR(4)
    CHARLIKE_HDR(5)
    CHARLIKE_HDR(6)
    CHARLIKE_HDR(7)
    CHARLIKE_HDR(8)
    CHARLIKE_HDR(9)
    CHARLIKE_HDR(10)
    CHARLIKE_HDR(11)
    CHARLIKE_HDR(12)
    CHARLIKE_HDR(13)
    CHARLIKE_HDR(14)
    CHARLIKE_HDR(15)
    CHARLIKE_HDR(16)
    CHARLIKE_HDR(17)
    CHARLIKE_HDR(18)
    CHARLIKE_HDR(19)
    CHARLIKE_HDR(20)
    CHARLIKE_HDR(21)
    CHARLIKE_HDR(22)
    CHARLIKE_HDR(23)
    CHARLIKE_HDR(24)
    CHARLIKE_HDR(25)
    CHARLIKE_HDR(26)
    CHARLIKE_HDR(27)
    CHARLIKE_HDR(28)
    CHARLIKE_HDR(29)
    CHARLIKE_HDR(30)
    CHARLIKE_HDR(31)
    CHARLIKE_HDR(32)
    CHARLIKE_HDR(33)
    CHARLIKE_HDR(34)
    CHARLIKE_HDR(35)
    CHARLIKE_HDR(36)
    CHARLIKE_HDR(37)
    CHARLIKE_HDR(38)
    CHARLIKE_HDR(39)
    CHARLIKE_HDR(40)
    CHARLIKE_HDR(41)
    CHARLIKE_HDR(42)
    CHARLIKE_HDR(43)
    CHARLIKE_HDR(44)
    CHARLIKE_HDR(45)
    CHARLIKE_HDR(46)
    CHARLIKE_HDR(47)
    CHARLIKE_HDR(48)
    CHARLIKE_HDR(49)
    CHARLIKE_HDR(50)
    CHARLIKE_HDR(51)
    CHARLIKE_HDR(52)
    CHARLIKE_HDR(53)
    CHARLIKE_HDR(54)
    CHARLIKE_HDR(55)
    CHARLIKE_HDR(56)
    CHARLIKE_HDR(57)
    CHARLIKE_HDR(58)
    CHARLIKE_HDR(59)
    CHARLIKE_HDR(60)
    CHARLIKE_HDR(61)
    CHARLIKE_HDR(62)
    CHARLIKE_HDR(63)
    CHARLIKE_HDR(64)
    CHARLIKE_HDR(65)
    CHARLIKE_HDR(66)
    CHARLIKE_HDR(67)
    CHARLIKE_HDR(68)
    CHARLIKE_HDR(69)
    CHARLIKE_HDR(70)
    CHARLIKE_HDR(71)
    CHARLIKE_HDR(72)
    CHARLIKE_HDR(73)
    CHARLIKE_HDR(74)
    CHARLIKE_HDR(75)
    CHARLIKE_HDR(76)
    CHARLIKE_HDR(77)
    CHARLIKE_HDR(78)
    CHARLIKE_HDR(79)
    CHARLIKE_HDR(80)
    CHARLIKE_HDR(81)
    CHARLIKE_HDR(82)
    CHARLIKE_HDR(83)
    CHARLIKE_HDR(84)
    CHARLIKE_HDR(85)
    CHARLIKE_HDR(86)
    CHARLIKE_HDR(87)
    CHARLIKE_HDR(88)
    CHARLIKE_HDR(89)
    CHARLIKE_HDR(90)
    CHARLIKE_HDR(91)
    CHARLIKE_HDR(92)
    CHARLIKE_HDR(93)
    CHARLIKE_HDR(94)
    CHARLIKE_HDR(95)
    CHARLIKE_HDR(96)
    CHARLIKE_HDR(97)
    CHARLIKE_HDR(98)
    CHARLIKE_HDR(99)
    CHARLIKE_HDR(100)
    CHARLIKE_HDR(101)
    CHARLIKE_HDR(102)
    CHARLIKE_HDR(103)
    CHARLIKE_HDR(104)
    CHARLIKE_HDR(105)
    CHARLIKE_HDR(106)
    CHARLIKE_HDR(107)
    CHARLIKE_HDR(108)
    CHARLIKE_HDR(109)
    CHARLIKE_HDR(110)
    CHARLIKE_HDR(111)
    CHARLIKE_HDR(112)
    CHARLIKE_HDR(113)
    CHARLIKE_HDR(114)
    CHARLIKE_HDR(115)
    CHARLIKE_HDR(116)
    CHARLIKE_HDR(117)
    CHARLIKE_HDR(118)
    CHARLIKE_HDR(119)
    CHARLIKE_HDR(120)
    CHARLIKE_HDR(121)
    CHARLIKE_HDR(122)
    CHARLIKE_HDR(123)
    CHARLIKE_HDR(124)
    CHARLIKE_HDR(125)
    CHARLIKE_HDR(126)
    CHARLIKE_HDR(127)
    CHARLIKE_HDR(128)
    CHARLIKE_HDR(129)
    CHARLIKE_HDR(130)
    CHARLIKE_HDR(131)
    CHARLIKE_HDR(132)
    CHARLIKE_HDR(133)
    CHARLIKE_HDR(134)
    CHARLIKE_HDR(135)
    CHARLIKE_HDR(136)
    CHARLIKE_HDR(137)
    CHARLIKE_HDR(138)
    CHARLIKE_HDR(139)
    CHARLIKE_HDR(140)
    CHARLIKE_HDR(141)
    CHARLIKE_HDR(142)
    CHARLIKE_HDR(143)
    CHARLIKE_HDR(144)
    CHARLIKE_HDR(145)
    CHARLIKE_HDR(146)
    CHARLIKE_HDR(147)
    CHARLIKE_HDR(148)
    CHARLIKE_HDR(149)
    CHARLIKE_HDR(150)
    CHARLIKE_HDR(151)
    CHARLIKE_HDR(152)
    CHARLIKE_HDR(153)
    CHARLIKE_HDR(154)
    CHARLIKE_HDR(155)
    CHARLIKE_HDR(156)
    CHARLIKE_HDR(157)
    CHARLIKE_HDR(158)
    CHARLIKE_HDR(159)
    CHARLIKE_HDR(160)
    CHARLIKE_HDR(161)
    CHARLIKE_HDR(162)
    CHARLIKE_HDR(163)
    CHARLIKE_HDR(164)
    CHARLIKE_HDR(165)
    CHARLIKE_HDR(166)
    CHARLIKE_HDR(167)
    CHARLIKE_HDR(168)
    CHARLIKE_HDR(169)
    CHARLIKE_HDR(170)
    CHARLIKE_HDR(171)
    CHARLIKE_HDR(172)
    CHARLIKE_HDR(173)
    CHARLIKE_HDR(174)
    CHARLIKE_HDR(175)
    CHARLIKE_HDR(176)
    CHARLIKE_HDR(177)
    CHARLIKE_HDR(178)
    CHARLIKE_HDR(179)
    CHARLIKE_HDR(180)
    CHARLIKE_HDR(181)
    CHARLIKE_HDR(182)
    CHARLIKE_HDR(183)
    CHARLIKE_HDR(184)
    CHARLIKE_HDR(185)
    CHARLIKE_HDR(186)
    CHARLIKE_HDR(187)
    CHARLIKE_HDR(188)
    CHARLIKE_HDR(189)
    CHARLIKE_HDR(190)
    CHARLIKE_HDR(191)
    CHARLIKE_HDR(192)
    CHARLIKE_HDR(193)
    CHARLIKE_HDR(194)
    CHARLIKE_HDR(195)
    CHARLIKE_HDR(196)
    CHARLIKE_HDR(197)
    CHARLIKE_HDR(198)
    CHARLIKE_HDR(199)
    CHARLIKE_HDR(200)
    CHARLIKE_HDR(201)
    CHARLIKE_HDR(202)
    CHARLIKE_HDR(203)
    CHARLIKE_HDR(204)
    CHARLIKE_HDR(205)
    CHARLIKE_HDR(206)
    CHARLIKE_HDR(207)
    CHARLIKE_HDR(208)
    CHARLIKE_HDR(209)
    CHARLIKE_HDR(210)
    CHARLIKE_HDR(211)
    CHARLIKE_HDR(212)
    CHARLIKE_HDR(213)
    CHARLIKE_HDR(214)
    CHARLIKE_HDR(215)
    CHARLIKE_HDR(216)
    CHARLIKE_HDR(217)
    CHARLIKE_HDR(218)
    CHARLIKE_HDR(219)
    CHARLIKE_HDR(220)
    CHARLIKE_HDR(221)
    CHARLIKE_HDR(222)
    CHARLIKE_HDR(223)
    CHARLIKE_HDR(224)
    CHARLIKE_HDR(225)
    CHARLIKE_HDR(226)
    CHARLIKE_HDR(227)
    CHARLIKE_HDR(228)
    CHARLIKE_HDR(229)
    CHARLIKE_HDR(230)
    CHARLIKE_HDR(231)
    CHARLIKE_HDR(232)
    CHARLIKE_HDR(233)
    CHARLIKE_HDR(234)
    CHARLIKE_HDR(235)
    CHARLIKE_HDR(236)
    CHARLIKE_HDR(237)
    CHARLIKE_HDR(238)
    CHARLIKE_HDR(239)
    CHARLIKE_HDR(240)
    CHARLIKE_HDR(241)
    CHARLIKE_HDR(242)
    CHARLIKE_HDR(243)
    CHARLIKE_HDR(244)
    CHARLIKE_HDR(245)
    CHARLIKE_HDR(246)
    CHARLIKE_HDR(247)
    CHARLIKE_HDR(248)
    CHARLIKE_HDR(249)
    CHARLIKE_HDR(250)
    CHARLIKE_HDR(251)
    CHARLIKE_HDR(252)
    CHARLIKE_HDR(253)
    CHARLIKE_HDR(254)
    CHARLIKE_HDR(255)
}

section "data" {
950
 stg_INTLIKE_closure:
dterei's avatar
dterei committed
951
    INTLIKE_HDR(-16) /* MIN_INTLIKE == -16 */
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
    INTLIKE_HDR(-15)
    INTLIKE_HDR(-14)
    INTLIKE_HDR(-13)
    INTLIKE_HDR(-12)
    INTLIKE_HDR(-11)
    INTLIKE_HDR(-10)
    INTLIKE_HDR(-9)
    INTLIKE_HDR(-8)
    INTLIKE_HDR(-7)
    INTLIKE_HDR(-6)
    INTLIKE_HDR(-5)
    INTLIKE_HDR(-4)
    INTLIKE_HDR(-3)
    INTLIKE_HDR(-2)
    INTLIKE_HDR(-1)
    INTLIKE_HDR(0)
    INTLIKE_HDR(1)
    INTLIKE_HDR(2)
    INTLIKE_HDR(3)
    INTLIKE_HDR(4)
    INTLIKE_HDR(5)
    INTLIKE_HDR(6)
    INTLIKE_HDR(7)
    INTLIKE_HDR(8)
    INTLIKE_HDR(9)
    INTLIKE_HDR(10)
    INTLIKE_HDR(11)
    INTLIKE_HDR(12)
    INTLIKE_HDR(13)
    INTLIKE_HDR(14)
    INTLIKE_HDR(15)
dterei's avatar
dterei committed
983
    INTLIKE_HDR(16)  /* MAX_INTLIKE == 16 */
984
}
985

986
#endif