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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
#pragma once
#ifndef STORM_GC
#include "MemorySummary.h"
#include "License.h"
#include "Root.h"
namespace storm {
/**
* Example of the public interface of a GC implementation.
*
* This class is used as an implementation when the file Gc.h is included from anywhere other
* than the Gc itself in order to allow inlining of certain functions to improve performance in
* builds that do not use link-time code generation.
*/
class GcImpl {
public:
// Create.
GcImpl(size_t initialArenaSize, Nat finalizationInterval);
// Destroy. This function is always called, but may be called twice.
void destroy();
// Memory usage summary.
MemorySummary summary();
// Do a full GC now.
void collect();
// Spend approx. 'time' ms on a GC. Return 'true' if there is more work to be done.
Bool collect(Nat time);
// Type we use to store data with a thread.
typedef void *ThreadData;
// Register/deregister a thread with us. The Gc interface handles re-registering for us. It
// even makes sure that these functions are not called in parallel.
ThreadData attachThread();
void detachThread(ThreadData data);
// Allocate an object of a specific type.
void *alloc(const GcType *type);
// Allocate an object of a specific type in a non-moving pool.
void *allocStatic(const GcType *type);
// Allocate a buffer which is not moving nor protected. The memory allocated from here is
// also safe to access from threads unknown to the garbage collector.
GcArray<Byte> *allocBuffer(size_t count);
// Allocate an array of objects.
void *allocArray(const GcType *type, size_t count);
void *allocArrayRehash(const GcType *type, size_t count);
// Allocate an array of weak pointers. 'type' is always a GcType instance that is set to
// WeakArray with one pointer as elements.
void *allocWeakArray(const GcType *type, size_t count);
void *allocWeakArrayRehash(const GcType *type, size_t count);
// See if an object is live, ie. not finalized.
static Bool liveObject(RootObject *obj);
// Allocate a gc type.
GcType *allocType(GcType::Kind kind, Type *type, size_t stride, size_t entries);
// Free a gc type (GC implementations may use garbage collection for these as well).
void freeType(GcType *type);
// Get the gc type of an allocation.
static const GcType *typeOf(const void *mem);
// Change the gc type of an allocation. Can assume that the new type describes a type of the
// same size as the old type description.
static void switchType(void *mem, const GcType *to);
// Allocate a code block with 'code' bytes of machine code and 'refs' entries of reference data.
void *allocCode(size_t code, size_t refs);
// Get the size of a code allocation.
static size_t codeSize(const void *alloc);
// Get the metadata of a code allocation.
static GcCode *codeRefs(void *alloc);
// Start/end of a ramp allocation.
void startRamp();
void endRamp();
// Walk the heap.
typedef void (*WalkCb)(RootObject *inspect, void *param);
void walkObjects(WalkCb fn, void *param);
typedef GcRoot Root;
// Create a root object.
Root *createRoot(void *data, size_t count, bool ambiguous);
// Destroy a root.
static void destroyRoot(Root *root);
// Create a watch object (on a GC:d heap, no need to destroy it).
GcWatch *createWatch();
// Check memory consistency. Note: Enable checking in 'Gc.cpp' for this to work.
void checkMemory();
void checkMemory(const void *object, bool recursive);
void checkMemoryCollect();
// Debug output.
void dbg_dump();
// License.
const GcLicense *license();
};
}
#endif
|
