2
* Copyright (c) 1996-1998 by Silicon Graphics. All rights reserved.
4
* THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
5
* OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
7
* Permission is hereby granted to use or copy this program
8
* for any purpose, provided the above notices are retained on all copies.
9
* Permission to modify the code and to distribute modified code is granted,
10
* provided the above notices are retained, and a notice that the code was
11
* modified is included with the above copyright notice.
15
// This is a C++ header file that is intended to replace the SGI STL
16
// alloc.h. This assumes SGI STL version < 3.0.
18
// This assumes the collector has been compiled with -DATOMIC_UNCOLLECTABLE
19
// and -DALL_INTERIOR_POINTERS. We also recommend
20
// -DREDIRECT_MALLOC=GC_uncollectable_malloc.
22
// Some of this could be faster in the explicit deallocation case. In particular,
23
// we spend too much time clearing objects on the free lists. That could be avoided.
25
// This uses template classes with static members, and hence does not work
26
// with g++ 2.7.2 and earlier.
28
// This code assumes that the collector itself has been compiled with a
29
// compiler that defines __STDC__ .
37
#define __ALLOC_H // Prevent inclusion of the default version. Ugly.
38
#define __SGI_STL_ALLOC_H
39
#define __SGI_STL_INTERNAL_ALLOC_H
42
# define __ALLOC alloc
48
// The following is just replicated from the conventional SGI alloc.h:
50
template<class T, class alloc>
54
static T *allocate(size_t n)
55
{ return 0 == n? 0 : (T*) alloc::allocate(n * sizeof (T)); }
56
static T *allocate(void)
57
{ return (T*) alloc::allocate(sizeof (T)); }
58
static void deallocate(T *p, size_t n)
59
{ if (0 != n) alloc::deallocate(p, n * sizeof (T)); }
60
static void deallocate(T *p)
61
{ alloc::deallocate(p, sizeof (T)); }
66
// The following need to match collector data structures.
67
// We can't include gc_priv.h, since that pulls in way too much stuff.
68
// This should eventually be factored out into another include file.
71
extern void ** const GC_objfreelist_ptr;
72
extern void ** const GC_aobjfreelist_ptr;
73
extern void ** const GC_uobjfreelist_ptr;
74
extern void ** const GC_auobjfreelist_ptr;
76
extern void GC_incr_words_allocd(size_t words);
77
extern void GC_incr_mem_freed(size_t words);
79
extern char * GC_generic_malloc_words_small(size_t word, int kind);
82
// Object kinds; must match PTRFREE, NORMAL, UNCOLLECTABLE, and
83
// AUNCOLLECTABLE in gc_priv.h.
85
enum { GC_PTRFREE = 0, GC_NORMAL = 1, GC_UNCOLLECTABLE = 2,
86
GC_AUNCOLLECTABLE = 3 };
88
enum { GC_max_fast_bytes = 255 };
90
enum { GC_bytes_per_word = sizeof(char *) };
92
enum { GC_byte_alignment = 8 };
94
enum { GC_word_alignment = GC_byte_alignment/GC_bytes_per_word };
96
inline void * &GC_obj_link(void * p)
97
{ return *(void **)p; }
99
// Compute a number of words >= n+1 bytes.
100
// The +1 allows for pointers one past the end.
101
inline size_t GC_round_up(size_t n)
103
return ((n + GC_byte_alignment)/GC_byte_alignment)*GC_word_alignment;
106
// The same but don't allow for extra byte.
107
inline size_t GC_round_up_uncollectable(size_t n)
109
return ((n + GC_byte_alignment - 1)/GC_byte_alignment)*GC_word_alignment;
113
class GC_aux_template {
115
// File local count of allocated words. Occasionally this is
116
// added into the global count. A separate count is necessary since the
117
// real one must be updated with a procedure call.
118
static size_t GC_words_recently_allocd;
120
// Same for uncollectable mmory. Not yet reflected in either
121
// GC_words_recently_allocd or GC_non_gc_bytes.
122
static size_t GC_uncollectable_words_recently_allocd;
124
// Similar counter for explicitly deallocated memory.
125
static size_t GC_mem_recently_freed;
127
// Again for uncollectable memory.
128
static size_t GC_uncollectable_mem_recently_freed;
130
static void * GC_out_of_line_malloc(size_t nwords, int kind);
134
size_t GC_aux_template<dummy>::GC_words_recently_allocd = 0;
137
size_t GC_aux_template<dummy>::GC_uncollectable_words_recently_allocd = 0;
140
size_t GC_aux_template<dummy>::GC_mem_recently_freed = 0;
143
size_t GC_aux_template<dummy>::GC_uncollectable_mem_recently_freed = 0;
146
void * GC_aux_template<dummy>::GC_out_of_line_malloc(size_t nwords, int kind)
148
GC_words_recently_allocd += GC_uncollectable_words_recently_allocd;
150
GC_bytes_per_word * GC_uncollectable_words_recently_allocd;
151
GC_uncollectable_words_recently_allocd = 0;
153
GC_mem_recently_freed += GC_uncollectable_mem_recently_freed;
155
GC_bytes_per_word * GC_uncollectable_mem_recently_freed;
156
GC_uncollectable_mem_recently_freed = 0;
158
GC_incr_words_allocd(GC_words_recently_allocd);
159
GC_words_recently_allocd = 0;
161
GC_incr_mem_freed(GC_mem_recently_freed);
162
GC_mem_recently_freed = 0;
164
return GC_generic_malloc_words_small(nwords, kind);
167
typedef GC_aux_template<0> GC_aux;
169
// A fast, single-threaded, garbage-collected allocator
170
// We assume the first word will be immediately overwritten.
171
// In this version, deallocation is not a noop, and explicit
172
// deallocation is likely to help performance.
174
class single_client_gc_alloc_template {
176
static void * allocate(size_t n)
178
size_t nwords = GC_round_up(n);
182
if (n > GC_max_fast_bytes) return GC_malloc(n);
183
flh = GC_objfreelist_ptr + nwords;
184
if (0 == (op = *flh)) {
185
return GC_aux::GC_out_of_line_malloc(nwords, GC_NORMAL);
187
*flh = GC_obj_link(op);
188
GC_aux::GC_words_recently_allocd += nwords;
191
static void * ptr_free_allocate(size_t n)
193
size_t nwords = GC_round_up(n);
197
if (n > GC_max_fast_bytes) return GC_malloc_atomic(n);
198
flh = GC_aobjfreelist_ptr + nwords;
199
if (0 == (op = *flh)) {
200
return GC_aux::GC_out_of_line_malloc(nwords, GC_PTRFREE);
202
*flh = GC_obj_link(op);
203
GC_aux::GC_words_recently_allocd += nwords;
206
static void deallocate(void *p, size_t n)
208
size_t nwords = GC_round_up(n);
211
if (n > GC_max_fast_bytes) {
214
flh = GC_objfreelist_ptr + nwords;
215
GC_obj_link(p) = *flh;
216
memset((char *)p + GC_bytes_per_word, 0,
217
GC_bytes_per_word * (nwords - 1));
219
GC_aux::GC_mem_recently_freed += nwords;
222
static void ptr_free_deallocate(void *p, size_t n)
224
size_t nwords = GC_round_up(n);
227
if (n > GC_max_fast_bytes) {
230
flh = GC_aobjfreelist_ptr + nwords;
231
GC_obj_link(p) = *flh;
233
GC_aux::GC_mem_recently_freed += nwords;
238
typedef single_client_gc_alloc_template<0> single_client_gc_alloc;
240
// Once more, for uncollectable objects.
242
class single_client_alloc_template {
244
static void * allocate(size_t n)
246
size_t nwords = GC_round_up_uncollectable(n);
250
if (n > GC_max_fast_bytes) return GC_malloc_uncollectable(n);
251
flh = GC_uobjfreelist_ptr + nwords;
252
if (0 == (op = *flh)) {
253
return GC_aux::GC_out_of_line_malloc(nwords, GC_UNCOLLECTABLE);
255
*flh = GC_obj_link(op);
256
GC_aux::GC_uncollectable_words_recently_allocd += nwords;
259
static void * ptr_free_allocate(size_t n)
261
size_t nwords = GC_round_up_uncollectable(n);
265
if (n > GC_max_fast_bytes) return GC_malloc_atomic_uncollectable(n);
266
flh = GC_auobjfreelist_ptr + nwords;
267
if (0 == (op = *flh)) {
268
return GC_aux::GC_out_of_line_malloc(nwords, GC_AUNCOLLECTABLE);
270
*flh = GC_obj_link(op);
271
GC_aux::GC_uncollectable_words_recently_allocd += nwords;
274
static void deallocate(void *p, size_t n)
276
size_t nwords = GC_round_up_uncollectable(n);
279
if (n > GC_max_fast_bytes) {
282
flh = GC_uobjfreelist_ptr + nwords;
283
GC_obj_link(p) = *flh;
285
GC_aux::GC_uncollectable_mem_recently_freed += nwords;
288
static void ptr_free_deallocate(void *p, size_t n)
290
size_t nwords = GC_round_up_uncollectable(n);
293
if (n > GC_max_fast_bytes) {
296
flh = GC_auobjfreelist_ptr + nwords;
297
GC_obj_link(p) = *flh;
299
GC_aux::GC_uncollectable_mem_recently_freed += nwords;
304
typedef single_client_alloc_template<0> single_client_alloc;
306
template < int dummy >
307
class gc_alloc_template {
309
static void * allocate(size_t n) { return GC_malloc(n); }
310
static void * ptr_free_allocate(size_t n)
311
{ return GC_malloc_atomic(n); }
312
static void deallocate(void *, size_t) { }
313
static void ptr_free_deallocate(void *, size_t) { }
316
typedef gc_alloc_template < 0 > gc_alloc;
318
template < int dummy >
319
class alloc_template {
321
static void * allocate(size_t n) { return GC_malloc_uncollectable(n); }
322
static void * ptr_free_allocate(size_t n)
323
{ return GC_malloc_atomic_uncollectable(n); }
324
static void deallocate(void *p, size_t) { GC_free(p); }
325
static void ptr_free_deallocate(void *p, size_t) { GC_free(p); }
328
typedef alloc_template < 0 > alloc;
332
// We want to specialize simple_alloc so that it does the right thing
333
// for all pointerfree types. At the moment there is no portable way to
334
// even approximate that. The following approximation should work for
335
// SGI compilers, and perhaps some others.
337
# define __GC_SPECIALIZE(T,alloc) \
338
class simple_alloc<T, alloc> { \
340
static T *allocate(size_t n) \
341
{ return 0 == n? 0 : \
342
(T*) alloc::ptr_free_allocate(n * sizeof (T)); } \
343
static T *allocate(void) \
344
{ return (T*) alloc::ptr_free_allocate(sizeof (T)); } \
345
static void deallocate(T *p, size_t n) \
346
{ if (0 != n) alloc::ptr_free_deallocate(p, n * sizeof (T)); } \
347
static void deallocate(T *p) \
348
{ alloc::ptr_free_deallocate(p, sizeof (T)); } \
351
__GC_SPECIALIZE(char, gc_alloc)
352
__GC_SPECIALIZE(int, gc_alloc)
353
__GC_SPECIALIZE(unsigned, gc_alloc)
354
__GC_SPECIALIZE(float, gc_alloc)
355
__GC_SPECIALIZE(double, gc_alloc)
357
__GC_SPECIALIZE(char, alloc)
358
__GC_SPECIALIZE(int, alloc)
359
__GC_SPECIALIZE(unsigned, alloc)
360
__GC_SPECIALIZE(float, alloc)
361
__GC_SPECIALIZE(double, alloc)
363
__GC_SPECIALIZE(char, single_client_gc_alloc)
364
__GC_SPECIALIZE(int, single_client_gc_alloc)
365
__GC_SPECIALIZE(unsigned, single_client_gc_alloc)
366
__GC_SPECIALIZE(float, single_client_gc_alloc)
367
__GC_SPECIALIZE(double, single_client_gc_alloc)
369
__GC_SPECIALIZE(char, single_client_alloc)
370
__GC_SPECIALIZE(int, single_client_alloc)
371
__GC_SPECIALIZE(unsigned, single_client_alloc)
372
__GC_SPECIALIZE(float, single_client_alloc)
373
__GC_SPECIALIZE(double, single_client_alloc)
375
#ifdef __STL_USE_STD_ALLOCATORS
377
???copy stuff from stl_alloc.h or remove it to a different file ???
379
#endif /* __STL_USE_STD_ALLOCATORS */
381
#endif /* _SGI_SOURCE */
383
#endif /* GC_ALLOC_H */