1 /* obstack.h - object stack macros
2 Copyright (C) 1988,89,90,91,92,93,94,96,97,98,99 Free Software Foundation, Inc.
3 This file is part of the GNU C Library. Its master source is NOT part of
4 the C library, however. The master source lives in /gd/gnu/lib.
6 The GNU C Library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Lesser General Public
8 License as published by the Free Software Foundation; either
9 version 2.1 of the License, or (at your option) any later version.
11 The GNU C Library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public
17 License along with the GNU C Library; if not, write to the Free
18 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
23 All the apparent functions defined here are macros. The idea
24 is that you would use these pre-tested macros to solve a
25 very specific set of problems, and they would run fast.
26 Caution: no side-effects in arguments please!! They may be
27 evaluated MANY times!!
29 These macros operate a stack of objects. Each object starts life
30 small, and may grow to maturity. (Consider building a word syllable
31 by syllable.) An object can move while it is growing. Once it has
32 been "finished" it never changes address again. So the "top of the
33 stack" is typically an immature growing object, while the rest of the
34 stack is of mature, fixed size and fixed address objects.
36 These routines grab large chunks of memory, using a function you
37 supply, called `obstack_chunk_alloc'. On occasion, they free chunks,
38 by calling `obstack_chunk_free'. You must define them and declare
39 them before using any obstack macros.
41 Each independent stack is represented by a `struct obstack'.
42 Each of the obstack macros expects a pointer to such a structure
43 as the first argument.
45 One motivation for this package is the problem of growing char strings
46 in symbol tables. Unless you are "fascist pig with a read-only mind"
47 --Gosper's immortal quote from HAKMEM item 154, out of context--you
48 would not like to put any arbitrary upper limit on the length of your
51 In practice this often means you will build many short symbols and a
52 few long symbols. At the time you are reading a symbol you don't know
53 how long it is. One traditional method is to read a symbol into a
54 buffer, realloc()ating the buffer every time you try to read a symbol
55 that is longer than the buffer. This is beaut, but you still will
56 want to copy the symbol from the buffer to a more permanent
57 symbol-table entry say about half the time.
59 With obstacks, you can work differently. Use one obstack for all symbol
60 names. As you read a symbol, grow the name in the obstack gradually.
61 When the name is complete, finalize it. Then, if the symbol exists already,
62 free the newly read name.
64 The way we do this is to take a large chunk, allocating memory from
65 low addresses. When you want to build a symbol in the chunk you just
66 add chars above the current "high water mark" in the chunk. When you
67 have finished adding chars, because you got to the end of the symbol,
68 you know how long the chars are, and you can create a new object.
69 Mostly the chars will not burst over the highest address of the chunk,
70 because you would typically expect a chunk to be (say) 100 times as
71 long as an average object.
73 In case that isn't clear, when we have enough chars to make up
74 the object, THEY ARE ALREADY CONTIGUOUS IN THE CHUNK (guaranteed)
75 so we just point to it where it lies. No moving of chars is
76 needed and this is the second win: potentially long strings need
77 never be explicitly shuffled. Once an object is formed, it does not
78 change its address during its lifetime.
80 When the chars burst over a chunk boundary, we allocate a larger
81 chunk, and then copy the partly formed object from the end of the old
82 chunk to the beginning of the new larger chunk. We then carry on
83 accreting characters to the end of the object as we normally would.
85 A special macro is provided to add a single char at a time to a
86 growing object. This allows the use of register variables, which
87 break the ordinary 'growth' macro.
90 We allocate large chunks.
91 We carve out one object at a time from the current chunk.
92 Once carved, an object never moves.
93 We are free to append data of any size to the currently
95 Exactly one object is growing in an obstack at any one time.
96 You can run one obstack per control block.
97 You may have as many control blocks as you dare.
98 Because of the way we do it, you can `unwind' an obstack
99 back to a previous state. (You may remove objects much
100 as you would with a stack.)
104 /* Don't do the contents of this file more than once. */
113 /* We use subtraction of (char *) 0 instead of casting to int
114 because on word-addressable machines a simple cast to int
115 may ignore the byte-within-word field of the pointer. */
118 # define __PTR_TO_INT(P) ((P) - (char *) 0)
122 #if defined __STDC__ && __STDC__
123 # define __INT_TO_PTR(P) ((void *) ((P) + (char *) 0))
125 # define __INT_TO_PTR(P) ((P) + (char *) 0)
129 /* We need the type of the resulting object. If __PTRDIFF_TYPE__ is
130 defined, as with GNU C, use that; that way we don't pollute the
131 namespace with <stddef.h>'s symbols. Otherwise, if <stddef.h> is
132 available, include it and use ptrdiff_t. In traditional C, long is
133 the best that we can do. */
135 #ifdef __PTRDIFF_TYPE__
136 # define PTR_INT_TYPE __PTRDIFF_TYPE__
138 # ifdef HAVE_STDDEF_H
140 # define PTR_INT_TYPE ptrdiff_t
142 # define PTR_INT_TYPE long
146 #if defined _LIBC || defined HAVE_STRING_H
148 # define _obstack_memcpy(To, From, N) memcpy ((To), (From), (N))
151 # define _obstack_memcpy(To, From, N) memcpy ((To), (From), (N))
153 # define _obstack_memcpy(To, From, N) bcopy ((From), (To), (N))
157 struct _obstack_chunk
/* Lives at front of each chunk. */
159 char *limit
; /* 1 past end of this chunk */
160 struct _obstack_chunk
*prev
; /* address of prior chunk or NULL */
161 char contents
[4]; /* objects begin here */
164 struct obstack
/* control current object in current chunk */
166 long chunk_size
; /* preferred size to allocate chunks in */
167 struct _obstack_chunk
*chunk
; /* address of current struct obstack_chunk */
168 char *object_base
; /* address of object we are building */
169 char *next_free
; /* where to add next char to current object */
170 char *chunk_limit
; /* address of char after current chunk */
171 PTR_INT_TYPE temp
; /* Temporary for some macros. */
172 int alignment_mask
; /* Mask of alignment for each object. */
173 #if defined __STDC__ && __STDC__
174 /* These prototypes vary based on `use_extra_arg', and we use
175 casts to the prototypeless function type in all assignments,
176 but having prototypes here quiets -Wstrict-prototypes. */
177 struct _obstack_chunk
*(*chunkfun
) (void *, long);
178 void (*freefun
) (void *, struct _obstack_chunk
*);
179 void *extra_arg
; /* first arg for chunk alloc/dealloc funcs */
181 struct _obstack_chunk
*(*chunkfun
) (); /* User's fcn to allocate a chunk. */
182 void (*freefun
) (); /* User's function to free a chunk. */
183 char *extra_arg
; /* first arg for chunk alloc/dealloc funcs */
185 unsigned use_extra_arg
:1; /* chunk alloc/dealloc funcs take extra arg */
186 unsigned maybe_empty_object
:1;/* There is a possibility that the current
187 chunk contains a zero-length object. This
188 prevents freeing the chunk if we allocate
189 a bigger chunk to replace it. */
190 unsigned alloc_failed
:1; /* No longer used, as we now call the failed
191 handler on error, but retained for binary
195 /* Declare the external functions we use; they are in obstack.c. */
197 #if defined __STDC__ && __STDC__
198 extern void _obstack_newchunk (struct obstack
*, int);
199 extern void _obstack_free (struct obstack
*, void *);
200 extern int _obstack_begin (struct obstack
*, int, int,
201 void *(*) (long), void (*) (void *));
202 extern int _obstack_begin_1 (struct obstack
*, int, int,
203 void *(*) (void *, long),
204 void (*) (void *, void *), void *);
205 extern int _obstack_memory_used (struct obstack
*);
207 extern void _obstack_newchunk ();
208 extern void _obstack_free ();
209 extern int _obstack_begin ();
210 extern int _obstack_begin_1 ();
211 extern int _obstack_memory_used ();
214 #if defined __STDC__ && __STDC__
216 /* Do the function-declarations after the structs
217 but before defining the macros. */
219 void obstack_init (struct obstack
*obstack
);
221 void * obstack_alloc (struct obstack
*obstack
, int size
);
223 void * obstack_copy (struct obstack
*obstack
, const void *address
, int size
);
224 void * obstack_copy0 (struct obstack
*obstack
, const void *address
, int size
);
226 void obstack_free (struct obstack
*obstack
, void *block
);
228 void obstack_blank (struct obstack
*obstack
, int size
);
230 void obstack_grow (struct obstack
*obstack
, const void *data
, int size
);
231 void obstack_grow0 (struct obstack
*obstack
, const void *data
, int size
);
233 void obstack_1grow (struct obstack
*obstack
, int data_char
);
234 void obstack_ptr_grow (struct obstack
*obstack
, const void *data
);
235 void obstack_int_grow (struct obstack
*obstack
, int data
);
237 void * obstack_finish (struct obstack
*obstack
);
239 int obstack_object_size (struct obstack
*obstack
);
241 int obstack_room (struct obstack
*obstack
);
242 void obstack_make_room (struct obstack
*obstack
, int size
);
243 void obstack_1grow_fast (struct obstack
*obstack
, int data_char
);
244 void obstack_ptr_grow_fast (struct obstack
*obstack
, const void *data
);
245 void obstack_int_grow_fast (struct obstack
*obstack
, int data
);
246 void obstack_blank_fast (struct obstack
*obstack
, int size
);
248 void * obstack_base (struct obstack
*obstack
);
249 void * obstack_next_free (struct obstack
*obstack
);
250 int obstack_alignment_mask (struct obstack
*obstack
);
251 int obstack_chunk_size (struct obstack
*obstack
);
252 int obstack_memory_used (struct obstack
*obstack
);
254 #endif /* __STDC__ */
256 /* Non-ANSI C cannot really support alternative functions for these macros,
257 so we do not declare them. */
259 /* Error handler called when `obstack_chunk_alloc' failed to allocate
260 more memory. This can be set to a user defined function which
261 should either abort gracefully or use longjump - but shouldn't
262 return. The default action is to print a message and abort. */
263 #if defined __STDC__ && __STDC__
264 extern void (*obstack_alloc_failed_handler
) (void);
266 extern void (*obstack_alloc_failed_handler
) ();
269 /* Exit value used when `print_and_abort' is used. */
270 extern int obstack_exit_failure
;
272 /* Pointer to beginning of object being allocated or to be allocated next.
273 Note that this might not be the final address of the object
274 because a new chunk might be needed to hold the final size. */
276 #define obstack_base(h) ((h)->object_base)
278 /* Size for allocating ordinary chunks. */
280 #define obstack_chunk_size(h) ((h)->chunk_size)
282 /* Pointer to next byte not yet allocated in current chunk. */
284 #define obstack_next_free(h) ((h)->next_free)
286 /* Mask specifying low bits that should be clear in address of an object. */
288 #define obstack_alignment_mask(h) ((h)->alignment_mask)
290 /* To prevent prototype warnings provide complete argument list in
291 standard C version. */
292 #if defined __STDC__ && __STDC__
294 # define obstack_init(h) \
295 _obstack_begin ((h), 0, 0, \
296 (void *(*) (long)) obstack_chunk_alloc, \
297 (void (*) (void *)) obstack_chunk_free)
299 # define obstack_begin(h, size) \
300 _obstack_begin ((h), (size), 0, \
301 (void *(*) (long)) obstack_chunk_alloc, \
302 (void (*) (void *)) obstack_chunk_free)
304 # define obstack_specify_allocation(h, size, alignment, chunkfun, freefun) \
305 _obstack_begin ((h), (size), (alignment), \
306 (void *(*) (long)) (chunkfun), \
307 (void (*) (void *)) (freefun))
309 # define obstack_specify_allocation_with_arg(h, size, alignment, chunkfun, freefun, arg) \
310 _obstack_begin_1 ((h), (size), (alignment), \
311 (void *(*) (void *, long)) (chunkfun), \
312 (void (*) (void *, void *)) (freefun), (arg))
314 # define obstack_chunkfun(h, newchunkfun) \
315 ((h) -> chunkfun = (struct _obstack_chunk *(*)(void *, long)) (newchunkfun))
317 # define obstack_freefun(h, newfreefun) \
318 ((h) -> freefun = (void (*)(void *, struct _obstack_chunk *)) (newfreefun))
322 # define obstack_init(h) \
323 _obstack_begin ((h), 0, 0, \
324 (void *(*) ()) obstack_chunk_alloc, \
325 (void (*) ()) obstack_chunk_free)
327 # define obstack_begin(h, size) \
328 _obstack_begin ((h), (size), 0, \
329 (void *(*) ()) obstack_chunk_alloc, \
330 (void (*) ()) obstack_chunk_free)
332 # define obstack_specify_allocation(h, size, alignment, chunkfun, freefun) \
333 _obstack_begin ((h), (size), (alignment), \
334 (void *(*) ()) (chunkfun), \
335 (void (*) ()) (freefun))
337 # define obstack_specify_allocation_with_arg(h, size, alignment, chunkfun, freefun, arg) \
338 _obstack_begin_1 ((h), (size), (alignment), \
339 (void *(*) ()) (chunkfun), \
340 (void (*) ()) (freefun), (arg))
342 # define obstack_chunkfun(h, newchunkfun) \
343 ((h) -> chunkfun = (struct _obstack_chunk *(*)()) (newchunkfun))
345 # define obstack_freefun(h, newfreefun) \
346 ((h) -> freefun = (void (*)()) (newfreefun))
350 #define obstack_1grow_fast(h,achar) (*((h)->next_free)++ = achar)
352 #define obstack_blank_fast(h,n) ((h)->next_free += (n))
354 #define obstack_memory_used(h) _obstack_memory_used (h)
356 #if defined __GNUC__ && defined __STDC__ && __STDC__
357 /* NextStep 2.0 cc is really gcc 1.93 but it defines __GNUC__ = 2 and
358 does not implement __extension__. But that compiler doesn't define
360 # if __GNUC__ < 2 || (__NeXT__ && !__GNUC_MINOR__)
361 # define __extension__
364 /* For GNU C, if not -traditional,
365 we can define these macros to compute all args only once
366 without using a global variable.
367 Also, we can avoid using the `temp' slot, to make faster code. */
369 # define obstack_object_size(OBSTACK) \
371 ({ struct obstack *__o = (OBSTACK); \
372 (unsigned) (__o->next_free - __o->object_base); })
374 # define obstack_room(OBSTACK) \
376 ({ struct obstack *__o = (OBSTACK); \
377 (unsigned) (__o->chunk_limit - __o->next_free); })
379 # define obstack_make_room(OBSTACK,length) \
381 ({ struct obstack *__o = (OBSTACK); \
382 int __len = (length); \
383 if (__o->chunk_limit - __o->next_free < __len) \
384 _obstack_newchunk (__o, __len); \
387 # define obstack_empty_p(OBSTACK) \
389 ({ struct obstack *__o = (OBSTACK); \
390 (__o->chunk->prev == 0 && __o->next_free - __o->chunk->contents == 0); })
392 # define obstack_grow(OBSTACK,where,length) \
394 ({ struct obstack *__o = (OBSTACK); \
395 int __len = (length); \
396 if (__o->next_free + __len > __o->chunk_limit) \
397 _obstack_newchunk (__o, __len); \
398 _obstack_memcpy (__o->next_free, (where), __len); \
399 __o->next_free += __len; \
402 # define obstack_grow0(OBSTACK,where,length) \
404 ({ struct obstack *__o = (OBSTACK); \
405 int __len = (length); \
406 if (__o->next_free + __len + 1 > __o->chunk_limit) \
407 _obstack_newchunk (__o, __len + 1); \
408 _obstack_memcpy (__o->next_free, (where), __len); \
409 __o->next_free += __len; \
410 *(__o->next_free)++ = 0; \
413 # define obstack_1grow(OBSTACK,datum) \
415 ({ struct obstack *__o = (OBSTACK); \
416 if (__o->next_free + 1 > __o->chunk_limit) \
417 _obstack_newchunk (__o, 1); \
418 *(__o->next_free)++ = (datum); \
421 /* These assume that the obstack alignment is good enough for pointers
422 or ints, and that the data added so far to the current object
423 shares that much alignment. */
425 # define obstack_ptr_grow(OBSTACK,datum) \
427 ({ struct obstack *__o = (OBSTACK); \
428 if (__o->next_free + sizeof (void *) > __o->chunk_limit) \
429 _obstack_newchunk (__o, sizeof (void *)); \
430 *((void **)__o->next_free)++ = (datum); \
433 # define obstack_int_grow(OBSTACK,datum) \
435 ({ struct obstack *__o = (OBSTACK); \
436 if (__o->next_free + sizeof (int) > __o->chunk_limit) \
437 _obstack_newchunk (__o, sizeof (int)); \
438 *((int *)__o->next_free)++ = (datum); \
441 # define obstack_ptr_grow_fast(h,aptr) \
442 (*((void **) (h)->next_free)++ = (aptr))
444 # define obstack_int_grow_fast(h,aint) \
445 (*((int *) (h)->next_free)++ = (aint))
447 # define obstack_blank(OBSTACK,length) \
449 ({ struct obstack *__o = (OBSTACK); \
450 int __len = (length); \
451 if (__o->chunk_limit - __o->next_free < __len) \
452 _obstack_newchunk (__o, __len); \
453 __o->next_free += __len; \
456 # define obstack_alloc(OBSTACK,length) \
458 ({ struct obstack *__h = (OBSTACK); \
459 obstack_blank (__h, (length)); \
460 obstack_finish (__h); })
462 # define obstack_copy(OBSTACK,where,length) \
464 ({ struct obstack *__h = (OBSTACK); \
465 obstack_grow (__h, (where), (length)); \
466 obstack_finish (__h); })
468 # define obstack_copy0(OBSTACK,where,length) \
470 ({ struct obstack *__h = (OBSTACK); \
471 obstack_grow0 (__h, (where), (length)); \
472 obstack_finish (__h); })
474 /* The local variable is named __o1 to avoid a name conflict
475 when obstack_blank is called. */
476 # define obstack_finish(OBSTACK) \
478 ({ struct obstack *__o1 = (OBSTACK); \
480 value = (void *) __o1->object_base; \
481 if (__o1->next_free == value) \
482 __o1->maybe_empty_object = 1; \
484 = __INT_TO_PTR ((__PTR_TO_INT (__o1->next_free)+__o1->alignment_mask)\
485 & ~ (__o1->alignment_mask)); \
486 if (__o1->next_free - (char *)__o1->chunk \
487 > __o1->chunk_limit - (char *)__o1->chunk) \
488 __o1->next_free = __o1->chunk_limit; \
489 __o1->object_base = __o1->next_free; \
492 # define obstack_free(OBSTACK, OBJ) \
494 ({ struct obstack *__o = (OBSTACK); \
495 void *__obj = (OBJ); \
496 if (__obj > (void *)__o->chunk && __obj < (void *)__o->chunk_limit) \
497 __o->next_free = __o->object_base = (char *)__obj; \
498 else (obstack_free) (__o, __obj); })
500 #else /* not __GNUC__ or not __STDC__ */
502 # define obstack_object_size(h) \
503 (unsigned) ((h)->next_free - (h)->object_base)
505 # define obstack_room(h) \
506 (unsigned) ((h)->chunk_limit - (h)->next_free)
508 # define obstack_empty_p(h) \
509 ((h)->chunk->prev == 0 && (h)->next_free - (h)->chunk->contents == 0)
511 /* Note that the call to _obstack_newchunk is enclosed in (..., 0)
512 so that we can avoid having void expressions
513 in the arms of the conditional expression.
514 Casting the third operand to void was tried before,
515 but some compilers won't accept it. */
517 # define obstack_make_room(h,length) \
518 ( (h)->temp = (length), \
519 (((h)->next_free + (h)->temp > (h)->chunk_limit) \
520 ? (_obstack_newchunk ((h), (h)->temp), 0) : 0))
522 # define obstack_grow(h,where,length) \
523 ( (h)->temp = (length), \
524 (((h)->next_free + (h)->temp > (h)->chunk_limit) \
525 ? (_obstack_newchunk ((h), (h)->temp), 0) : 0), \
526 _obstack_memcpy ((h)->next_free, (where), (h)->temp), \
527 (h)->next_free += (h)->temp)
529 # define obstack_grow0(h,where,length) \
530 ( (h)->temp = (length), \
531 (((h)->next_free + (h)->temp + 1 > (h)->chunk_limit) \
532 ? (_obstack_newchunk ((h), (h)->temp + 1), 0) : 0), \
533 _obstack_memcpy ((h)->next_free, (where), (h)->temp), \
534 (h)->next_free += (h)->temp, \
535 *((h)->next_free)++ = 0)
537 # define obstack_1grow(h,datum) \
538 ( (((h)->next_free + 1 > (h)->chunk_limit) \
539 ? (_obstack_newchunk ((h), 1), 0) : 0), \
540 (*((h)->next_free)++ = (datum)))
542 # define obstack_ptr_grow(h,datum) \
543 ( (((h)->next_free + sizeof (char *) > (h)->chunk_limit) \
544 ? (_obstack_newchunk ((h), sizeof (char *)), 0) : 0), \
545 (*((const char **) (((h)->next_free+=sizeof(char *))-sizeof(char *))) = (datum)))
547 # define obstack_int_grow(h,datum) \
548 ( (((h)->next_free + sizeof (int) > (h)->chunk_limit) \
549 ? (_obstack_newchunk ((h), sizeof (int)), 0) : 0), \
550 (*((int *) (((h)->next_free+=sizeof(int))-sizeof(int))) = (datum)))
552 # define obstack_ptr_grow_fast(h,aptr) \
553 (*((const char **) (h)->next_free)++ = (aptr))
555 # define obstack_int_grow_fast(h,aint) \
556 (*((int *) (h)->next_free)++ = (aint))
558 # define obstack_blank(h,length) \
559 ( (h)->temp = (length), \
560 (((h)->chunk_limit - (h)->next_free < (h)->temp) \
561 ? (_obstack_newchunk ((h), (h)->temp), 0) : 0), \
562 ((h)->next_free += (h)->temp))
564 # define obstack_alloc(h,length) \
565 (obstack_blank ((h), (length)), obstack_finish ((h)))
567 # define obstack_copy(h,where,length) \
568 (obstack_grow ((h), (where), (length)), obstack_finish ((h)))
570 # define obstack_copy0(h,where,length) \
571 (obstack_grow0 ((h), (where), (length)), obstack_finish ((h)))
573 # define obstack_finish(h) \
574 ( ((h)->next_free == (h)->object_base \
575 ? (((h)->maybe_empty_object = 1), 0) \
577 (h)->temp = __PTR_TO_INT ((h)->object_base), \
579 = __INT_TO_PTR ((__PTR_TO_INT ((h)->next_free)+(h)->alignment_mask) \
580 & ~ ((h)->alignment_mask)), \
581 (((h)->next_free - (char *) (h)->chunk \
582 > (h)->chunk_limit - (char *) (h)->chunk) \
583 ? ((h)->next_free = (h)->chunk_limit) : 0), \
584 (h)->object_base = (h)->next_free, \
585 __INT_TO_PTR ((h)->temp))
587 # if defined __STDC__ && __STDC__
588 # define obstack_free(h,obj) \
589 ( (h)->temp = (char *) (obj) - (char *) (h)->chunk, \
590 (((h)->temp > 0 && (h)->temp < (h)->chunk_limit - (char *) (h)->chunk)\
591 ? (int) ((h)->next_free = (h)->object_base \
592 = (h)->temp + (char *) (h)->chunk) \
593 : (((obstack_free) ((h), (h)->temp + (char *) (h)->chunk), 0), 0)))
595 # define obstack_free(h,obj) \
596 ( (h)->temp = (char *) (obj) - (char *) (h)->chunk, \
597 (((h)->temp > 0 && (h)->temp < (h)->chunk_limit - (char *) (h)->chunk)\
598 ? (int) ((h)->next_free = (h)->object_base \
599 = (h)->temp + (char *) (h)->chunk) \
600 : (_obstack_free ((h), (h)->temp + (char *) (h)->chunk), 0)))
603 #endif /* not __GNUC__ or not __STDC__ */
609 #endif /* obstack.h */