GC.h 7.52 KB
Newer Older
Simon Marlow's avatar
Simon Marlow committed
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 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
/* -----------------------------------------------------------------------------
 *
 * (c) The GHC Team, 1998-2004
 *
 * External Storage Manger Interface
 *
 * ---------------------------------------------------------------------------*/

#ifndef RTS_STORAGE_GC_H
#define RTS_STORAGE_GC_H

#include <stddef.h>
#include "rts/OSThreads.h"

/* -----------------------------------------------------------------------------
 * Generational GC
 *
 * We support an arbitrary number of generations, with an arbitrary number
 * of steps per generation.  Notes (in no particular order):
 *
 *       - all generations except the oldest should have the same
 *         number of steps.  Multiple steps gives objects a decent
 *         chance to age before being promoted, and helps ensure that
 *         we don't end up with too many thunks being updated in older
 *         generations.
 *
 *       - the oldest generation has one step.  There's no point in aging
 *         objects in the oldest generation.
 *
 *       - generation 0, step 0 (G0S0) is the allocation area.  It is given
 *         a fixed set of blocks during initialisation, and these blocks
 *         normally stay in G0S0.  In parallel execution, each
 *         Capability has its own nursery.
 *
 *       - during garbage collection, each step which is an evacuation
 *         destination (i.e. all steps except G0S0) is allocated a to-space.
 *         evacuated objects are allocated into the step's to-space until
 *         GC is finished, when the original step's contents may be freed
 *         and replaced by the to-space.
 *
 *       - the mutable-list is per-generation (not per-step).  G0 doesn't 
 *         have one (since every garbage collection collects at least G0).
 * 
 *       - block descriptors contain pointers to both the step and the
 *         generation that the block belongs to, for convenience.
 *
 *       - static objects are stored in per-generation lists.  See GC.c for
 *         details of how we collect CAFs in the generational scheme.
 *
 *       - large objects are per-step, and are promoted in the same way
 *         as small objects, except that we may allocate large objects into
 *         generation 1 initially.
 *
 * ------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
56 57 58 59
typedef struct nursery_ {
    bdescr *       blocks;
    unsigned int   n_blocks;
} nursery;
Simon Marlow's avatar
Simon Marlow committed
60

Simon Marlow's avatar
Simon Marlow committed
61 62
typedef struct generation_ {
    unsigned int   no;			// generation number
Simon Marlow's avatar
Simon Marlow committed
63

Simon Marlow's avatar
Simon Marlow committed
64 65
    bdescr *       blocks;	        // blocks in this gen
    unsigned int   n_blocks;	        // number of blocks
66
    unsigned int   n_words;             // number of used words
Simon Marlow's avatar
Simon Marlow committed
67

Simon Marlow's avatar
Simon Marlow committed
68 69
    bdescr *       large_objects;	// large objects (doubly linked)
    unsigned int   n_large_blocks;      // no. of blocks used by large objs
70 71
    unsigned long  n_new_large_words;   // words of new large objects
                                        // (for allocation stats)
Simon Marlow's avatar
Simon Marlow committed
72

Simon Marlow's avatar
Simon Marlow committed
73
    unsigned int   max_blocks;		// max blocks
74

Simon Marlow's avatar
Simon Marlow committed
75
    StgTSO *       threads;             // threads in this gen
Simon Marlow's avatar
Simon Marlow committed
76
                                        // linked via global_link
Simon Marlow's avatar
Simon Marlow committed
77 78 79 80 81 82
    struct generation_ *to;		// destination gen for live objects

    // stats information
    unsigned int collections;
    unsigned int par_collections;
    unsigned int failed_promotions;
Simon Marlow's avatar
Simon Marlow committed
83 84 85 86 87 88 89 90 91 92 93 94 95 96

    // ------------------------------------
    // Fields below are used during GC only

#if defined(THREADED_RTS)
    char pad[128];                      // make sure the following is
                                        // on a separate cache line.
    SpinLock     sync_large_objects;    // lock for large_objects
                                        //    and scavenged_large_objects
#endif

    int          mark;			// mark (not copy)? (old gen only)
    int          compact;		// compact (not sweep)? (old gen only)

Simon Marlow's avatar
Simon Marlow committed
97
    // During GC, if we are collecting this gen, blocks and n_blocks
98 99
    // are copied into the following two fields.  After GC, these blocks
    // are freed.
Simon Marlow's avatar
Simon Marlow committed
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
    bdescr *     old_blocks;	        // bdescr of first from-space block
    unsigned int n_old_blocks;		// number of blocks in from-space
    unsigned int live_estimate;         // for sweeping: estimate of live data
    
    bdescr *     part_blocks;           // partially-full scanned blocks
    unsigned int n_part_blocks;         // count of above

    bdescr *     scavenged_large_objects;  // live large objs after GC (d-link)
    unsigned int n_scavenged_large_blocks; // size (not count) of above

    bdescr *     bitmap;  		// bitmap for compacting collection

    StgTSO *     old_threads;
} generation;

extern generation * generations;
extern generation * g0;
extern generation * oldest_gen;

/* -----------------------------------------------------------------------------
   Generic allocation

122
   StgPtr allocate(Capability *cap, nat n)
Simon Marlow's avatar
Simon Marlow committed
123 124 125 126 127
                                Allocates memory from the nursery in
				the current Capability.  This can be
				done without taking a global lock,
                                unlike allocate().

128 129
   StgPtr allocatePinned(Capability *cap, nat n) 
                                Allocates a chunk of contiguous store
Simon Marlow's avatar
Simon Marlow committed
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
   				n words long, which is at a fixed
				address (won't be moved by GC).  
				Returns a pointer to the first word.
				Always succeeds.
				
				NOTE: the GC can't in general handle
				pinned objects, so allocatePinned()
				can only be used for ByteArrays at the
				moment.

				Don't forget to TICK_ALLOC_XXX(...)
				after calling allocate or
				allocatePinned, for the
				benefit of the ticky-ticky profiler.

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

147 148
StgPtr  allocate        ( Capability *cap, lnat n );
StgPtr  allocatePinned  ( Capability *cap, lnat n );
Simon Marlow's avatar
Simon Marlow committed
149 150 151 152 153

/* memory allocator for executable memory */
void * allocateExec(unsigned int len, void **exec_addr);
void   freeExec (void *p);

154
// Used by GC checks in external .cmm code:
155
extern nat large_alloc_lim;
156

Simon Marlow's avatar
Simon Marlow committed
157 158 159 160 161 162 163 164 165 166 167
/* -----------------------------------------------------------------------------
   Performing Garbage Collection
   -------------------------------------------------------------------------- */

void performGC(void);
void performMajorGC(void);

/* -----------------------------------------------------------------------------
   The CAF table - used to let us revert CAFs in GHCi
   -------------------------------------------------------------------------- */

168 169
void newCAF     (StgRegTable *reg, StgClosure *);
void newDynCAF  (StgRegTable *reg, StgClosure *);
Simon Marlow's avatar
Simon Marlow committed
170 171
void revertCAFs (void);

172 173 174
// Request that all CAFs are retained indefinitely.
void setKeepCAFs (void);

Simon Marlow's avatar
Simon Marlow committed
175 176 177 178 179 180 181
/* -----------------------------------------------------------------------------
   Stats
   -------------------------------------------------------------------------- */

// Returns the total number of bytes allocated since the start of the program.
HsInt64 getAllocations (void);

182 183 184 185 186 187 188 189 190
/* -----------------------------------------------------------------------------
   This is the write barrier for MUT_VARs, a.k.a. IORefs.  A
   MUT_VAR_CLEAN object is not on the mutable list; a MUT_VAR_DIRTY
   is.  When written to, a MUT_VAR_CLEAN turns into a MUT_VAR_DIRTY
   and is put on the mutable list.
   -------------------------------------------------------------------------- */

void dirty_MUT_VAR(StgRegTable *reg, StgClosure *p);

Simon Marlow's avatar
Simon Marlow committed
191 192 193 194
/* set to disable CAF garbage collection in GHCi. */
/* (needed when dynamic libraries are used). */
extern rtsBool keepCAFs;

Simon Marlow's avatar
Simon Marlow committed
195
INLINE_HEADER void initBdescr(bdescr *bd, generation *gen, generation *dest)
196
{
Simon Marlow's avatar
Simon Marlow committed
197 198 199
    bd->gen    = gen;
    bd->gen_no = gen->no;
    bd->dest   = dest;
200 201
}

Simon Marlow's avatar
Simon Marlow committed
202
#endif /* RTS_STORAGE_GC_H */