summaryrefslogtreecommitdiff
path: root/includes/rts/SPT.h
blob: 8c5f8ab1a9fb6a767a2f5fc1097c553f60987bb7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
/* -----------------------------------------------------------------------------
 *
 * (c) The GHC Team, 2008-2009
 *
 * Initialization of the Static Pointer Table
 *
 * Do not #include this file directly: #include "Rts.h" instead.
 *
 * To understand the structure of the RTS headers, see the wiki:
 *   http://ghc.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
 *
 * -------------------------------------------------------------------------- */

#ifndef RTS_SPT_H
#define RTS_SPT_H

/** Inserts an entry in the Static Pointer Table.
 *
 * The key is a fingerprint computed from the StaticName of a static pointer
 * and the spe_closure is a pointer to the closure defining the table entry
 * (GHC.SptEntry).
 *
 * A stable pointer to the closure is made to prevent it from being garbage
 * collected while the entry exists on the table.
 *
 * This function is called from the code generated by
 * compiler/deSugar/SPT.sptInitCode
 *
 * */
void hs_spt_insert (StgWord64 key[2],void* spe_closure);

#endif /* RTS_HPC_H */