StgMiscClosures.cmm 29.9 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;
16
import ghczmprim_GHCziTypes_Czh_static_info;
17
import ghczmprim_GHCziTypes_Izh_static_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 30 31
{
    W_ new_tso;
    W_ ret_off;

32 33
    SAVE_STGREGS

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

39 40 41
    RESTORE_STGREGS

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

44 45 46 47
/* ----------------------------------------------------------------------------
   Restore a saved cost centre
   ------------------------------------------------------------------------- */

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

57 58 59 60 61
/* ----------------------------------------------------------------------------
   Support for the bytecode interpreter.
   ------------------------------------------------------------------------- */

/* 9 bits of return code for constructors created by the interpreter. */
62
stg_interp_constr_entry (P_ ret)
dterei's avatar
dterei committed
63
{
64
    return (ret);
65 66 67 68 69 70 71 72 73 74 75 76 77
}

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

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
   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.
*/

101
INFO_TABLE_RET( stg_ctoi_R1p, RET_BCO)
102
    /* explicit stack */
103 104 105 106
{
    Sp_adj(-2);
    Sp(1) = R1;
    Sp(0) = stg_enter_info;
107
    jump stg_yield_to_interpreter [];
108 109 110
}

/*
dterei's avatar
dterei committed
111
 * When the returned value is a pointer, but unlifted, in R1 ...
112
 */
113
INFO_TABLE_RET( stg_ctoi_R1unpt, RET_BCO )
114
    /* explicit stack */
115 116 117
{
    Sp_adj(-2);
    Sp(1) = R1;
118 119
    Sp(0) = stg_ret_p_info;
    jump stg_yield_to_interpreter [];
120 121 122 123 124
}

/*
 * When the returned value is a non-pointer in R1 ...
 */
125
INFO_TABLE_RET( stg_ctoi_R1n, RET_BCO )
126
    /* explicit stack */
127 128 129
{
    Sp_adj(-2);
    Sp(1) = R1;
130
    Sp(0) = stg_ret_n_info;
131
    jump stg_yield_to_interpreter [];
132 133 134 135 136
}

/*
 * When the returned value is in F1
 */
137
INFO_TABLE_RET( stg_ctoi_F1, RET_BCO )
138
    /* explicit stack */
139 140 141
{
    Sp_adj(-2);
    F_[Sp + WDS(1)] = F1;
142 143
    Sp(0) = stg_ret_f_info;
    jump stg_yield_to_interpreter [];
144 145 146 147 148
}

/*
 * When the returned value is in D1
 */
149
INFO_TABLE_RET( stg_ctoi_D1, RET_BCO )
150
    /* explicit stack */
151 152 153
{
    Sp_adj(-1) - SIZEOF_DOUBLE;
    D_[Sp + WDS(1)] = D1;
154 155
    Sp(0) = stg_ret_d_info;
    jump stg_yield_to_interpreter [];
156 157 158 159 160
}

/*
 * When the returned value is in L1
 */
161
INFO_TABLE_RET( stg_ctoi_L1, RET_BCO )
162
    /* explicit stack */
163 164 165
{
    Sp_adj(-1) - 8;
    L_[Sp + WDS(1)] = L1;
166 167
    Sp(0) = stg_ret_l_info;
    jump stg_yield_to_interpreter [];
168 169 170 171 172
}

/*
 * When the returned value is a void
 */
173
INFO_TABLE_RET( stg_ctoi_V, RET_BCO )
174
    /* explicit stack */
175 176
{
    Sp_adj(-1);
177 178
    Sp(0) = stg_ret_v_info;
    jump stg_yield_to_interpreter [];
179 180 181 182 183 184 185
}

/*
 * 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.
 */
186
INFO_TABLE_RET( stg_apply_interp, RET_BCO )
187
    /* explicit stack */
188 189
{
    /* Just in case we end up in here... (we shouldn't) */
190
    jump stg_yield_to_interpreter [];
191 192 193 194 195 196 197
}

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

INFO_TABLE_FUN( stg_BCO, 4, 0, BCO, "BCO", "BCO", ARG_BCO )
198
    /* explicit stack */
199 200 201
{
  /* entering a BCO means "apply it", same as a function */
  Sp_adj(-2);
202 203
  // Skip the stack check; the interpreter will do one before using
  // the stack anyway.
204 205
  Sp(1) = R1;
  Sp(0) = stg_apply_interp_info;
206
  jump stg_yield_to_interpreter [];
207 208 209 210 211
}

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

Simon Marlow's avatar
Simon Marlow committed
212 213 214 215
   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
216 217 218 219
   indirection.  We only do this for young-gen indirections.
   ------------------------------------------------------------------------- */

INFO_TABLE(stg_IND,1,0,IND,"IND","IND")
220 221 222 223 224 225 226 227 228 229 230 231 232 233
#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 */
234
{
dterei's avatar
dterei committed
235
    TICK_ENT_DYN_IND(); /* tick */
Simon Marlow's avatar
Simon Marlow committed
236
    R1 = UNTAG(StgInd_indirectee(R1));
237
    TICK_ENT_VIA_NODE();
238
    jump %GET_ENTRY(R1) [R1];
239
}
240
#endif
241

Simon Marlow's avatar
Simon Marlow committed
242
INFO_TABLE(stg_IND_direct,1,0,IND,"IND","IND")
243
    (P_ node)
Simon Marlow's avatar
Simon Marlow committed
244
{
dterei's avatar
dterei committed
245
    TICK_ENT_DYN_IND(); /* tick */
246
    node = StgInd_indirectee(node);
Simon Marlow's avatar
Simon Marlow committed
247
    TICK_ENT_VIA_NODE();
248
    jump %ENTRY_CODE(Sp(0)) (node);
249 250 251
}

INFO_TABLE(stg_IND_STATIC,1,0,IND_STATIC,"IND_STATIC","IND_STATIC")
252
    /* explicit stack */
253
{
dterei's avatar
dterei committed
254
    TICK_ENT_STATIC_IND(); /* tick */
Simon Marlow's avatar
Simon Marlow committed
255
    R1 = UNTAG(StgInd_indirectee(R1));
256
    TICK_ENT_VIA_NODE();
257
    jump %GET_ENTRY(R1) [R1];
258 259
}

260
INFO_TABLE(stg_IND_PERM,1,0,IND_PERM,"IND_PERM","IND_PERM")
261
    /* explicit stack */
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
{
    /* Don't add INDs to granularity cost */

    /* Don't: TICK_ENT_STATIC_IND(Node); for ticky-ticky; this ind is
       here only to help profiling */

#if defined(TICKY_TICKY) && !defined(PROFILING)
    /* TICKY_TICKY && !PROFILING means PERM_IND *replaces* an IND, rather than
       being extra  */
    TICK_ENT_PERM_IND();
#endif

    LDV_ENTER(R1);

    /* For ticky-ticky, change the perm_ind to a normal ind on first
     * entry, so the number of ent_perm_inds is the number of *thunks*
     * entered again, not the number of subsequent entries.
     *
     * Since this screws up cost centres, we die if profiling and
     * ticky_ticky are on at the same time.  KSW 1999-01.
     */
#ifdef TICKY_TICKY
#  ifdef PROFILING
#    error Profiling and ticky-ticky do not mix at present!
#  endif  /* PROFILING */
    StgHeader_info(R1) = stg_IND_info;
#endif /* TICKY_TICKY */

Simon Marlow's avatar
Simon Marlow committed
290
    R1 = UNTAG(StgInd_indirectee(R1));
291 292 293 294 295

#if defined(TICKY_TICKY) && !defined(PROFILING)
    TICK_ENT_VIA_NODE();
#endif

296
    jump %GET_ENTRY(R1) [R1];
dterei's avatar
dterei committed
297
}
298 299 300 301 302 303 304 305 306 307

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

308
INFO_TABLE(stg_BLACKHOLE,1,0,BLACKHOLE,"BLACKHOLE","BLACKHOLE")
309
    (P_ node)
310
{
311 312
    W_ r, info, owner, bd;
    P_ p, bq, msg;
313

dterei's avatar
dterei committed
314
    TICK_ENT_DYN_IND(); /* tick */
315

316
retry:
317
    p = StgInd_indirectee(node);
318
    if (GETTAG(p) != 0) {
319
        return (p);
320 321 322 323 324 325 326 327 328 329 330 331 332 333
    }

    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)
    {
334 335
        ("ptr" msg) = ccall allocate(MyCapability() "ptr",
                                     BYTES_TO_WDS(SIZEOF_MessageBlackHole));
dterei's avatar
dterei committed
336

337
        SET_HDR(msg, stg_MSG_BLACKHOLE_info, CCS_SYSTEM);
338
        MessageBlackHole_tso(msg) = CurrentTSO;
339
        MessageBlackHole_bh(msg) = node;
dterei's avatar
dterei committed
340

341
        (r) = ccall messageBlackHole(MyCapability() "ptr", msg "ptr");
342 343 344 345 346 347

        if (r == 0) {
            goto retry;
        } else {
            StgTSO_why_blocked(CurrentTSO) = BlockedOnBlackHole::I16;
            StgTSO_block_info(CurrentTSO) = msg;
348
            jump stg_block_blackhole(node);
349 350 351 352
        }
    }
    else
    {
353
        ENTER(p);
354
    }
355 356
}

357
INFO_TABLE(__stg_EAGER_BLACKHOLE,1,0,BLACKHOLE,"BLACKHOLE","BLACKHOLE")
358
    (P_ node)
359
{
360
    jump ENTRY_LBL(stg_BLACKHOLE) (node);
361 362
}

363 364 365 366 367 368 369
// 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
// evaluation by another thread (a BLACKHOLE).  See threadPaused().
//
INFO_TABLE(stg_CAF_BLACKHOLE,1,0,BLACKHOLE,"BLACKHOLE","BLACKHOLE")
370
    (P_ node)
371
{
372
    jump ENTRY_LBL(stg_BLACKHOLE) (node);
373
}
374

375 376
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
377

378

379 380
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
381

382

383
/* ----------------------------------------------------------------------------
384
   Whiteholes are used for the "locked" state of a closure (see lockClosure())
385 386
   ------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
387
INFO_TABLE(stg_WHITEHOLE, 0,0, WHITEHOLE, "WHITEHOLE", "WHITEHOLE")
388
    (P_ node)
dterei's avatar
dterei committed
389
{
390 391 392 393 394 395
#if defined(THREADED_RTS)
    W_ info, i;

    i = 0;
loop:
    // spin until the WHITEHOLE is updated
396
    info = StgHeader_info(node);
397 398 399 400
    if (info == stg_WHITEHOLE_info) {
        i = i + 1;
        if (i == SPIN_COUNT) {
            i = 0;
401
            ccall yieldThread();
402 403 404
        }
        goto loop;
    }
405
    jump %ENTRY_CODE(info) (node);
406
#else
407
    ccall barf("WHITEHOLE object entered!") never returns;
408 409
#endif
}
410

411 412 413 414 415 416 417
/* ----------------------------------------------------------------------------
   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")
418
{ foreign "C" barf("TSO object entered!") never returns; }
419

420 421 422
INFO_TABLE(stg_STACK, 0,0, STACK, "STACK", "STACK")
{ foreign "C" barf("STACK object entered!") never returns; }

423 424 425 426 427 428 429 430
/* ----------------------------------------------------------------------------
   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).
   ------------------------------------------------------------------------- */

431
INFO_TABLE(stg_WEAK,1,4,WEAK,"WEAK","WEAK")
432
{ foreign "C" barf("WEAK object entered!") never returns; }
433 434 435 436 437

/*
 * 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
438
 * DEAD_WEAK 5 non-pointer fields.
439
 */
440
INFO_TABLE_CONSTR(stg_DEAD_WEAK,0,5,0,CONSTR,"DEAD_WEAK","DEAD_WEAK")
441
{ foreign "C" barf("DEAD_WEAK object entered!") never returns; }
442

443 444 445 446 447 448 449 450 451
/* ----------------------------------------------------------------------------
   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; }

452 453 454 455 456 457 458 459
/* ----------------------------------------------------------------------------
   NO_FINALIZER

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

INFO_TABLE_CONSTR(stg_NO_FINALIZER,0,0,0,CONSTR_NOCAF_STATIC,"NO_FINALIZER","NO_FINALIZER")
460
{ foreign "C" barf("NO_FINALIZER object entered!") never returns; }
461

462
CLOSURE(stg_NO_FINALIZER_closure,stg_NO_FINALIZER);
463 464 465 466 467

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

468
INFO_TABLE(stg_STABLE_NAME,0,1,PRIM,"STABLE_NAME","STABLE_NAME")
469
{ foreign "C" barf("STABLE_NAME object entered!") never returns; }
470 471 472 473 474 475 476 477

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

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

478 479
INFO_TABLE(stg_MVAR_CLEAN,3,0,MVAR_CLEAN,"MVAR","MVAR")
{ foreign "C" barf("MVAR object entered!") never returns; }
480

481 482
INFO_TABLE(stg_MVAR_DIRTY,3,0,MVAR_DIRTY,"MVAR","MVAR")
{ foreign "C" barf("MVAR object entered!") never returns; }
483

484 485 486 487
/* -----------------------------------------------------------------------------
   STM
   -------------------------------------------------------------------------- */

488 489 490 491 492
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; }
493

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

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

500
INFO_TABLE(stg_INVARIANT_CHECK_QUEUE, 3, 0, MUT_PRIM, "INVARIANT_CHECK_QUEUE", "INVARIANT_CHECK_QUEUE")
501
{ foreign "C" barf("INVARIANT_CHECK_QUEUE object entered!") never returns; }
502 503

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

506
INFO_TABLE(stg_TREC_HEADER, 3, 1, MUT_PRIM, "TREC_HEADER", "TREC_HEADER")
507
{ foreign "C" barf("TREC_HEADER object entered!") never returns; }
508

tharris@microsoft.com's avatar
tharris@microsoft.com committed
509
INFO_TABLE_CONSTR(stg_END_STM_WATCH_QUEUE,0,0,0,CONSTR_NOCAF_STATIC,"END_STM_WATCH_QUEUE","END_STM_WATCH_QUEUE")
510
{ foreign "C" barf("END_STM_WATCH_QUEUE object entered!") never returns; }
tharris@microsoft.com's avatar
tharris@microsoft.com committed
511 512

INFO_TABLE_CONSTR(stg_END_INVARIANT_CHECK_QUEUE,0,0,0,CONSTR_NOCAF_STATIC,"END_INVARIANT_CHECK_QUEUE","END_INVARIANT_CHECK_QUEUE")
513
{ foreign "C" barf("END_INVARIANT_CHECK_QUEUE object entered!") never returns; }
514 515

INFO_TABLE_CONSTR(stg_END_STM_CHUNK_LIST,0,0,0,CONSTR_NOCAF_STATIC,"END_STM_CHUNK_LIST","END_STM_CHUNK_LIST")
516
{ foreign "C" barf("END_STM_CHUNK_LIST object entered!") never returns; }
517 518

INFO_TABLE_CONSTR(stg_NO_TREC,0,0,0,CONSTR_NOCAF_STATIC,"NO_TREC","NO_TREC")
519
{ foreign "C" barf("NO_TREC object entered!") never returns; }
520

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

523
CLOSURE(stg_END_INVARIANT_CHECK_QUEUE_closure,stg_END_INVARIANT_CHECK_QUEUE);
524

525
CLOSURE(stg_END_STM_CHUNK_LIST_closure,stg_END_STM_CHUNK_LIST);
526

527
CLOSURE(stg_NO_TREC_closure,stg_NO_TREC);
528

529 530 531 532 533 534
/* ----------------------------------------------------------------------------
   Messages
   ------------------------------------------------------------------------- */

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

535 536 537
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; }

538 539 540
INFO_TABLE_CONSTR(stg_MSG_THROWTO,4,0,0,PRIM,"MSG_THROWTO","MSG_THROWTO")
{ foreign "C" barf("MSG_THROWTO object entered!") never returns; }

541 542 543
INFO_TABLE_CONSTR(stg_MSG_BLACKHOLE,3,0,0,PRIM,"MSG_BLACKHOLE","MSG_BLACKHOLE")
{ foreign "C" barf("MSG_BLACKHOLE object entered!") never returns; }

544 545 546 547
// 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; }

548 549 550 551 552 553 554 555
/* ----------------------------------------------------------------------------
   END_TSO_QUEUE

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

INFO_TABLE_CONSTR(stg_END_TSO_QUEUE,0,0,0,CONSTR_NOCAF_STATIC,"END_TSO_QUEUE","END_TSO_QUEUE")
556
{ foreign "C" barf("END_TSO_QUEUE object entered!") never returns; }
557

558
CLOSURE(stg_END_TSO_QUEUE_closure,stg_END_TSO_QUEUE);
559

560 561 562 563 564 565 566
/* ----------------------------------------------------------------------------
   GCD_CAF
   ------------------------------------------------------------------------- */

INFO_TABLE_CONSTR(stg_GCD_CAF,0,0,0,CONSTR_NOCAF_STATIC,"GCD_CAF","GCD_CAF")
{ foreign "C" barf("Evaluated a CAF that was GC'd!") never returns; }

Ben Gamari's avatar
Ben Gamari committed
567 568 569 570 571 572 573 574 575 576
/* ----------------------------------------------------------------------------
   STM_AWOKEN

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

INFO_TABLE_CONSTR(stg_STM_AWOKEN,0,0,0,CONSTR_NOCAF_STATIC,"STM_AWOKEN","STM_AWOKEN")
{ foreign "C" barf("STM_AWOKEN object entered!") never returns; }

577
CLOSURE(stg_STM_AWOKEN_closure,stg_STM_AWOKEN);
Ben Gamari's avatar
Ben Gamari committed
578

579 580 581 582 583 584
/* ----------------------------------------------------------------------------
   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
585 586
   ___________________________
   | Info | No. of | data....
Arash Rouhani's avatar
Arash Rouhani committed
587
   |  Ptr | Words  |
dterei's avatar
dterei committed
588
   ---------------------------
589 590 591 592 593 594

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

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

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

597
INFO_TABLE(stg_MUT_ARR_PTRS_CLEAN, 0, 0, MUT_ARR_PTRS_CLEAN, "MUT_ARR_PTRS_CLEAN", "MUT_ARR_PTRS_CLEAN")
598
{ foreign "C" barf("MUT_ARR_PTRS_CLEAN object entered!") never returns; }
599 600

INFO_TABLE(stg_MUT_ARR_PTRS_DIRTY, 0, 0, MUT_ARR_PTRS_DIRTY, "MUT_ARR_PTRS_DIRTY", "MUT_ARR_PTRS_DIRTY")
601
{ foreign "C" barf("MUT_ARR_PTRS_DIRTY object entered!") never returns; }
602 603

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

606
INFO_TABLE(stg_MUT_ARR_PTRS_FROZEN0, 0, 0, MUT_ARR_PTRS_FROZEN0, "MUT_ARR_PTRS_FROZEN0", "MUT_ARR_PTRS_FROZEN0")
607
{ foreign "C" barf("MUT_ARR_PTRS_FROZEN0 object entered!") never returns; }
608

609 610 611 612 613 614 615 616 617 618 619 620
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; }

621 622 623 624
/* ----------------------------------------------------------------------------
   Mutable Variables
   ------------------------------------------------------------------------- */

625
INFO_TABLE(stg_MUT_VAR_CLEAN, 1, 0, MUT_VAR_CLEAN, "MUT_VAR_CLEAN", "MUT_VAR_CLEAN")
626
{ foreign "C" barf("MUT_VAR_CLEAN object entered!") never returns; }
627
INFO_TABLE(stg_MUT_VAR_DIRTY, 1, 0, MUT_VAR_DIRTY, "MUT_VAR_DIRTY", "MUT_VAR_DIRTY")
628
{ foreign "C" barf("MUT_VAR_DIRTY object entered!") never returns; }
629 630 631

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

633 634 635 636 637 638
   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)
 * ------------------------------------------------------------------------- */

INFO_TABLE( stg_dummy_ret, 0, 0, CONSTR_NOCAF_STATIC, "DUMMY_RET", "DUMMY_RET")
639
    ()
640
{
641
    return ();
642
}
643
CLOSURE(stg_dummy_ret_closure,stg_dummy_ret);
644

645 646 647 648 649 650 651
/* ----------------------------------------------------------------------------
   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; }

652
/* ----------------------------------------------------------------------------
dterei's avatar
dterei committed
653
   CHARLIKE and INTLIKE closures.
654 655 656 657 658 659

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

660
#if defined(COMPILING_WINDOWS_DLL)
661
/*
662
 * When sticking the RTS in a Windows DLL, we delay populating the
663 664
 * 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
665 666 667
 *
 * -- this is currently broken BL 2009/11/14.
 *    we don't rewrite to static closures at all with Windows DLLs.
668
 */
669
// #warning Is this correct? _imp is a pointer!
670
#define Char_hash_static_info _imp__ghczmprim_GHCziTypes_Czh_static_info
671
#define Int_hash_static_info _imp__ghczmprim_GHCziTypes_Izh_static_info
672
#else
673
#define Char_hash_static_info ghczmprim_GHCziTypes_Czh_static_info
674
#define Int_hash_static_info ghczmprim_GHCziTypes_Izh_static_info
675 676 677
#endif


678 679
#define CHARLIKE_HDR(n)  CLOSURE(Char_hash_static_info, n)
#define INTLIKE_HDR(n)   CLOSURE(Int_hash_static_info, n)
680 681 682 683 684

/* put these in the *data* section, since the garbage collector relies
 * on the fact that static closures live in the data section.
 */

685
#if !(defined(COMPILING_WINDOWS_DLL))
686
section "data" {
687
 stg_CHARLIKE_closure:
688 689 690 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
    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" {
947
 stg_INTLIKE_closure:
dterei's avatar
dterei committed
948
    INTLIKE_HDR(-16) /* MIN_INTLIKE == -16 */
949 950 951 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
    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
980
    INTLIKE_HDR(16)  /* MAX_INTLIKE == 16 */
981
}
982

983
#endif