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;
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 30 31
{
    W_ new_tso;
    W_ ret_off;

32 33
    SAVE_STGREGS

34
    SAVE_THREAD_STATE();
35 36
    (ret_off) = foreign "C" threadStackUnderflow(MyCapability() "ptr",
                                                 CurrentTSO);
37 38
    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
    unwind Sp = Sp + WDS(2);
51
#if defined(PROFILING)
52
    CCCS = Sp(1);
53 54
#endif
    Sp_adj(2);
55
    jump %ENTRY_CODE(Sp(0)) [*]; // NB. all registers live!
56 57
}

Simon Marlow's avatar
Simon Marlow committed
58 59 60 61 62 63 64 65 66 67

INFO_TABLE_RET (stg_restore_cccs_eval, RET_SMALL, W_ info_ptr, W_ cccs)
    return (P_ ret)
{
#if defined(PROFILING)
    CCCS = cccs;
#endif
    jump stg_ap_0_fast(ret);
}

68 69 70 71
/* ----------------------------------------------------------------------------
   Support for the bytecode interpreter.
   ------------------------------------------------------------------------- */

72 73 74 75 76 77 78 79
/* 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); }
80 81 82 83 84 85 86 87 88 89 90 91

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

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
   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.
*/

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

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

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

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

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

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

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

/*
 * 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.
 */
200
INFO_TABLE_RET( stg_apply_interp, RET_BCO )
201
    /* explicit stack */
202 203
{
    /* Just in case we end up in here... (we shouldn't) */
204
    jump stg_yield_to_interpreter [];
205 206 207 208 209 210 211
}

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

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

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

Simon Marlow's avatar
Simon Marlow committed
226 227 228 229
   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
230 231 232 233
   indirection.  We only do this for young-gen indirections.
   ------------------------------------------------------------------------- */

INFO_TABLE(stg_IND,1,0,IND,"IND","IND")
234 235 236 237 238 239 240 241 242 243 244 245 246 247
#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 */
248
{
dterei's avatar
dterei committed
249
    TICK_ENT_DYN_IND(); /* tick */
Simon Marlow's avatar
Simon Marlow committed
250
    R1 = UNTAG(StgInd_indirectee(R1));
251
    TICK_ENT_VIA_NODE();
252
    jump %GET_ENTRY(R1) [R1];
253
}
254
#endif
255

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

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

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

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

dterei's avatar
dterei committed
289
    TICK_ENT_DYN_IND(); /* tick */
290

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

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

312
        SET_HDR(msg, stg_MSG_BLACKHOLE_info, CCS_SYSTEM);
313
        MessageBlackHole_tso(msg) = CurrentTSO;
314
        MessageBlackHole_bh(msg) = node;
dterei's avatar
dterei committed
315

316
        (r) = ccall messageBlackHole(MyCapability() "ptr", msg "ptr");
317 318 319 320 321 322

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

332 333 334 335
// 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
336 337
// evaluation by another thread (a BLACKHOLE).  see Note [suspend
// duplicate work] in ThreadPaused.c
338 339
//
INFO_TABLE(stg_CAF_BLACKHOLE,1,0,BLACKHOLE,"BLACKHOLE","BLACKHOLE")
340
    (P_ node)
341
{
342
    jump ENTRY_LBL(stg_BLACKHOLE) (node);
343
}
344

345 346 347 348 349 350 351
// 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);
}

352 353
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
354

355

356 357
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
358

359

360
/* ----------------------------------------------------------------------------
361
   Whiteholes are used for the "locked" state of a closure (see lockClosure())
362 363
   ------------------------------------------------------------------------- */

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

    i = 0;
loop:
    // spin until the WHITEHOLE is updated
373
    info = StgHeader_info(node);
374 375 376 377
    if (info == stg_WHITEHOLE_info) {
        i = i + 1;
        if (i == SPIN_COUNT) {
            i = 0;
378
            ccall yieldThread();
379 380 381
        }
        goto loop;
    }
382
    jump %ENTRY_CODE(info) (node);
383
#else
384
    ccall barf("WHITEHOLE object entered!") never returns;
385 386
#endif
}
387

388 389 390 391 392 393 394
/* ----------------------------------------------------------------------------
   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")
395
{ foreign "C" barf("TSO object entered!") never returns; }
396

397 398 399
INFO_TABLE(stg_STACK, 0,0, STACK, "STACK", "STACK")
{ foreign "C" barf("STACK object entered!") never returns; }

400 401 402 403 404 405 406 407
/* ----------------------------------------------------------------------------
   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).
   ------------------------------------------------------------------------- */

408
INFO_TABLE(stg_WEAK,1,4,WEAK,"WEAK","WEAK")
409
{ foreign "C" barf("WEAK object entered!") never returns; }
410 411 412 413 414

/*
 * 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
415
 * DEAD_WEAK 5 non-pointer fields.
416
 */
417
INFO_TABLE_CONSTR(stg_DEAD_WEAK,0,5,0,CONSTR,"DEAD_WEAK","DEAD_WEAK")
418
{ foreign "C" barf("DEAD_WEAK object entered!") never returns; }
419

420 421 422 423 424 425 426 427 428
/* ----------------------------------------------------------------------------
   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; }

429 430 431 432 433 434 435
/* ----------------------------------------------------------------------------
   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
436
INFO_TABLE_CONSTR(stg_NO_FINALIZER,0,0,0,CONSTR_NOCAF,"NO_FINALIZER","NO_FINALIZER")
437
{ foreign "C" barf("NO_FINALIZER object entered!") never returns; }
438

439
CLOSURE(stg_NO_FINALIZER_closure,stg_NO_FINALIZER);
440 441 442 443 444

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

445
INFO_TABLE(stg_STABLE_NAME,0,1,PRIM,"STABLE_NAME","STABLE_NAME")
446
{ foreign "C" barf("STABLE_NAME object entered!") never returns; }
447 448 449 450 451 452 453 454

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

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

455 456
INFO_TABLE(stg_MVAR_CLEAN,3,0,MVAR_CLEAN,"MVAR","MVAR")
{ foreign "C" barf("MVAR object entered!") never returns; }
457

458 459
INFO_TABLE(stg_MVAR_DIRTY,3,0,MVAR_DIRTY,"MVAR","MVAR")
{ foreign "C" barf("MVAR object entered!") never returns; }
460

461 462 463 464
/* -----------------------------------------------------------------------------
   STM
   -------------------------------------------------------------------------- */

465 466 467 468 469
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; }
470

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

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

477
INFO_TABLE(stg_INVARIANT_CHECK_QUEUE, 3, 0, MUT_PRIM, "INVARIANT_CHECK_QUEUE", "INVARIANT_CHECK_QUEUE")
478
{ foreign "C" barf("INVARIANT_CHECK_QUEUE object entered!") never returns; }
479 480

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

483
INFO_TABLE(stg_TREC_HEADER, 3, 1, MUT_PRIM, "TREC_HEADER", "TREC_HEADER")
484
{ foreign "C" barf("TREC_HEADER object entered!") never returns; }
485

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

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

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

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

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

500
CLOSURE(stg_END_INVARIANT_CHECK_QUEUE_closure,stg_END_INVARIANT_CHECK_QUEUE);
501

502
CLOSURE(stg_END_STM_CHUNK_LIST_closure,stg_END_STM_CHUNK_LIST);
503

504
CLOSURE(stg_NO_TREC_closure,stg_NO_TREC);
505

506 507 508 509 510 511
/* ----------------------------------------------------------------------------
   Messages
   ------------------------------------------------------------------------- */

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

512 513 514
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; }

515 516 517
INFO_TABLE_CONSTR(stg_MSG_THROWTO,4,0,0,PRIM,"MSG_THROWTO","MSG_THROWTO")
{ foreign "C" barf("MSG_THROWTO object entered!") never returns; }

518 519 520
INFO_TABLE_CONSTR(stg_MSG_BLACKHOLE,3,0,0,PRIM,"MSG_BLACKHOLE","MSG_BLACKHOLE")
{ foreign "C" barf("MSG_BLACKHOLE object entered!") never returns; }

521 522 523 524
// 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; }

525 526 527 528 529 530 531
/* ----------------------------------------------------------------------------
   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
532
INFO_TABLE_CONSTR(stg_END_TSO_QUEUE,0,0,0,CONSTR_NOCAF,"END_TSO_QUEUE","END_TSO_QUEUE")
533
{ foreign "C" barf("END_TSO_QUEUE object entered!") never returns; }
534

535
CLOSURE(stg_END_TSO_QUEUE_closure,stg_END_TSO_QUEUE);
536

537 538 539 540
/* ----------------------------------------------------------------------------
   GCD_CAF
   ------------------------------------------------------------------------- */

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

Ben Gamari's avatar
Ben Gamari committed
544 545 546 547 548 549 550
/* ----------------------------------------------------------------------------
   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
551
INFO_TABLE_CONSTR(stg_STM_AWOKEN,0,0,0,CONSTR_NOCAF,"STM_AWOKEN","STM_AWOKEN")
Ben Gamari's avatar
Ben Gamari committed
552 553
{ foreign "C" barf("STM_AWOKEN object entered!") never returns; }

554
CLOSURE(stg_STM_AWOKEN_closure,stg_STM_AWOKEN);
Ben Gamari's avatar
Ben Gamari committed
555

556 557 558 559 560 561
/* ----------------------------------------------------------------------------
   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
562 563
   ___________________________
   | Info | No. of | data....
Arash Rouhani's avatar
Arash Rouhani committed
564
   |  Ptr | Words  |
dterei's avatar
dterei committed
565
   ---------------------------
566 567 568 569 570 571

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

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

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

574
INFO_TABLE(stg_MUT_ARR_PTRS_CLEAN, 0, 0, MUT_ARR_PTRS_CLEAN, "MUT_ARR_PTRS_CLEAN", "MUT_ARR_PTRS_CLEAN")
575
{ foreign "C" barf("MUT_ARR_PTRS_CLEAN object entered!") never returns; }
576 577

INFO_TABLE(stg_MUT_ARR_PTRS_DIRTY, 0, 0, MUT_ARR_PTRS_DIRTY, "MUT_ARR_PTRS_DIRTY", "MUT_ARR_PTRS_DIRTY")
578
{ foreign "C" barf("MUT_ARR_PTRS_DIRTY object entered!") never returns; }
579 580

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

583
INFO_TABLE(stg_MUT_ARR_PTRS_FROZEN0, 0, 0, MUT_ARR_PTRS_FROZEN0, "MUT_ARR_PTRS_FROZEN0", "MUT_ARR_PTRS_FROZEN0")
584
{ foreign "C" barf("MUT_ARR_PTRS_FROZEN0 object entered!") never returns; }
585

586 587 588 589 590 591 592 593 594 595 596 597
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; }

598 599 600 601
/* ----------------------------------------------------------------------------
   Mutable Variables
   ------------------------------------------------------------------------- */

602
INFO_TABLE(stg_MUT_VAR_CLEAN, 1, 0, MUT_VAR_CLEAN, "MUT_VAR_CLEAN", "MUT_VAR_CLEAN")
603
{ foreign "C" barf("MUT_VAR_CLEAN object entered!") never returns; }
604
INFO_TABLE(stg_MUT_VAR_DIRTY, 1, 0, MUT_VAR_DIRTY, "MUT_VAR_DIRTY", "MUT_VAR_DIRTY")
605
{ foreign "C" barf("MUT_VAR_DIRTY object entered!") never returns; }
606 607 608

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

610 611 612 613 614
   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
615
INFO_TABLE( stg_dummy_ret, 0, 0, CONSTR_NOCAF, "DUMMY_RET", "DUMMY_RET")
616
    ()
617
{
618
    return ();
619
}
620
CLOSURE(stg_dummy_ret_closure,stg_dummy_ret);
621

622 623 624 625 626 627 628
/* ----------------------------------------------------------------------------
   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
629 630 631
/* ----------------------------------------------------------------------------
   COMPACT_NFDATA (a blob of data in NF with no outgoing pointers)

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

638
INFO_TABLE( stg_COMPACT_NFDATA_CLEAN, 0, 5, COMPACT_NFDATA, "COMPACT_NFDATA", "COMPACT_NFDATA")
gcampax's avatar
gcampax committed
639
    ()
640 641 642 643 644
{ 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
645

646
/* ----------------------------------------------------------------------------
dterei's avatar
dterei committed
647
   CHARLIKE and INTLIKE closures.
648 649 650 651 652 653

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

654
#if defined(COMPILING_WINDOWS_DLL)
655
/*
656
 * When sticking the RTS in a Windows DLL, we delay populating the
657 658
 * 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
659 660 661
 *
 * -- this is currently broken BL 2009/11/14.
 *    we don't rewrite to static closures at all with Windows DLLs.
662
 */
663
// #warning Is this correct? _imp is a pointer!
Simon Marlow's avatar
Simon Marlow committed
664 665
#define Char_hash_con_info _imp__ghczmprim_GHCziTypes_Czh_con_info
#define Int_hash_con_info _imp__ghczmprim_GHCziTypes_Izh_con_info
666
#else
Simon Marlow's avatar
Simon Marlow committed
667 668
#define Char_hash_con_info ghczmprim_GHCziTypes_Czh_con_info
#define Int_hash_con_info ghczmprim_GHCziTypes_Izh_con_info
669 670 671
#endif


Simon Marlow's avatar
Simon Marlow committed
672 673
#define CHARLIKE_HDR(n)  CLOSURE(Char_hash_con_info, n)
#define INTLIKE_HDR(n)   CLOSURE(Int_hash_con_info, n)
674

675
#if !(defined(COMPILING_WINDOWS_DLL))
676
section "data" {
677
 stg_CHARLIKE_closure:
678 679 680 681 682 683 684 685 686 687 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
    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" {
937
 stg_INTLIKE_closure:
dterei's avatar
dterei committed
938
    INTLIKE_HDR(-16) /* MIN_INTLIKE == -16 */
939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
    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
970
    INTLIKE_HDR(16)  /* MAX_INTLIKE == 16 */
971
}
972

973
#endif