update from main archive 961207
[kopensolaris-gnu/glibc.git] / malloc / obstack.c
1 /* obstack.c - subroutines used implicitly by object stack macros
2    Copyright (C) 1988,89,90,91,92,93,94,96 Free Software Foundation, Inc.
3
4    This file is part of the GNU C Library.  Its master source is NOT part of
5    the C library, however.  The master source lives in /gd/gnu/lib.
6
7    The GNU C Library is free software; you can redistribute it and/or
8    modify it under the terms of the GNU Library General Public License as
9    published by the Free Software Foundation; either version 2 of the
10    License, or (at your option) any later version.
11
12    The GNU C Library is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    Library General Public License for more details.
16
17    You should have received a copy of the GNU Library General Public
18    License along with the GNU C Library; see the file COPYING.LIB.  If not,
19    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20    Boston, MA 02111-1307, USA.  */
21
22 #include "obstack.h"
23
24 /* NOTE BEFORE MODIFYING THIS FILE: This version number must be
25    incremented whenever callers compiled using an old obstack.h can no
26    longer properly call the functions in this obstack.c.  */
27 #define OBSTACK_INTERFACE_VERSION 2
28
29 /* Comment out all this code if we are using the GNU C Library, and are not
30    actually compiling the library itself, and the installed library
31    supports the same library interface we do.  This code is part of the GNU
32    C Library, but also included in many other GNU distributions.  Compiling
33    and linking in this code is a waste when using the GNU C library
34    (especially if it is a shared library).  Rather than having every GNU
35    program understand `configure --with-gnu-libc' and omit the object
36    files, it is simpler to just do this in the source for each such file.  */
37
38 #include <stdio.h>              /* Random thing to get __GNU_LIBRARY__.  */
39 #if !defined (_LIBC) && defined (__GNU_LIBRARY__) && __GNU_LIBRARY__ > 1
40 #include <gnu-versions.h>
41 #if _GNU_OBSTACK_INTERFACE_VERSION == OBSTACK_INTERFACE_VERSION
42 #define ELIDE_CODE
43 #endif
44 #endif
45
46
47 #ifndef ELIDE_CODE
48
49
50 #if defined (__STDC__) && __STDC__
51 #define POINTER void *
52 #else
53 #define POINTER char *
54 #endif
55
56 /* Determine default alignment.  */
57 struct fooalign {char x; double d;};
58 #define DEFAULT_ALIGNMENT  \
59   ((PTR_INT_TYPE) ((char *) &((struct fooalign *) 0)->d - (char *) 0))
60 /* If malloc were really smart, it would round addresses to DEFAULT_ALIGNMENT.
61    But in fact it might be less smart and round addresses to as much as
62    DEFAULT_ROUNDING.  So we prepare for it to do that.  */
63 union fooround {long x; double d;};
64 #define DEFAULT_ROUNDING (sizeof (union fooround))
65
66 /* When we copy a long block of data, this is the unit to do it with.
67    On some machines, copying successive ints does not work;
68    in such a case, redefine COPYING_UNIT to `long' (if that works)
69    or `char' as a last resort.  */
70 #ifndef COPYING_UNIT
71 #define COPYING_UNIT int
72 #endif
73
74
75 /* The functions allocating more room by calling `obstack_chunk_alloc'
76    jump to the handler pointed to by `obstack_alloc_failed_handler'.
77    This variable by default points to the internal function
78    `print_and_abort'.  */
79 #if defined (__STDC__) && __STDC__
80 static void print_and_abort (void);
81 void (*obstack_alloc_failed_handler) (void) = print_and_abort;
82 #else
83 static void print_and_abort ();
84 void (*obstack_alloc_failed_handler) () = print_and_abort;
85 #endif
86
87 /* Exit value used when `print_and_abort' is used.  */
88 #if defined (__STDC__) && __STDC__
89 #include <stdlib.h>
90 #endif
91 #ifndef EXIT_FAILURE
92 #define EXIT_FAILURE 1
93 #endif
94 int obstack_exit_failure = EXIT_FAILURE;
95
96 /* The non-GNU-C macros copy the obstack into this global variable
97    to avoid multiple evaluation.  */
98
99 struct obstack *_obstack;
100
101 /* Define a macro that either calls functions with the traditional malloc/free
102    calling interface, or calls functions with the mmalloc/mfree interface
103    (that adds an extra first argument), based on the state of use_extra_arg.
104    For free, do not use ?:, since some compilers, like the MIPS compilers,
105    do not allow (expr) ? void : void.  */
106
107 #define CALL_CHUNKFUN(h, size) \
108   (((h) -> use_extra_arg) \
109    ? (*(h)->chunkfun) ((h)->extra_arg, (size)) \
110    : (*(struct _obstack_chunk *(*) ()) (h)->chunkfun) ((size)))
111
112 #define CALL_FREEFUN(h, old_chunk) \
113   do { \
114     if ((h) -> use_extra_arg) \
115       (*(h)->freefun) ((h)->extra_arg, (old_chunk)); \
116     else \
117       (*(void (*) ()) (h)->freefun) ((old_chunk)); \
118   } while (0)
119
120 \f
121 /* Initialize an obstack H for use.  Specify chunk size SIZE (0 means default).
122    Objects start on multiples of ALIGNMENT (0 means use default).
123    CHUNKFUN is the function to use to allocate chunks,
124    and FREEFUN the function to free them.
125
126    Return nonzero if successful, zero if out of memory.
127    To recover from an out of memory error,
128    free up some memory, then call this again.  */
129
130 int
131 _obstack_begin (h, size, alignment, chunkfun, freefun)
132      struct obstack *h;
133      int size;
134      int alignment;
135      POINTER (*chunkfun) ();
136      void (*freefun) ();
137 {
138   register struct _obstack_chunk *chunk; /* points to new chunk */
139
140   if (alignment == 0)
141     alignment = DEFAULT_ALIGNMENT;
142   if (size == 0)
143     /* Default size is what GNU malloc can fit in a 4096-byte block.  */
144     {
145       /* 12 is sizeof (mhead) and 4 is EXTRA from GNU malloc.
146          Use the values for range checking, because if range checking is off,
147          the extra bytes won't be missed terribly, but if range checking is on
148          and we used a larger request, a whole extra 4096 bytes would be
149          allocated.
150
151          These number are irrelevant to the new GNU malloc.  I suspect it is
152          less sensitive to the size of the request.  */
153       int extra = ((((12 + DEFAULT_ROUNDING - 1) & ~(DEFAULT_ROUNDING - 1))
154                     + 4 + DEFAULT_ROUNDING - 1)
155                    & ~(DEFAULT_ROUNDING - 1));
156       size = 4096 - extra;
157     }
158
159   h->chunkfun = (struct _obstack_chunk * (*)()) chunkfun;
160   h->freefun = freefun;
161   h->chunk_size = size;
162   h->alignment_mask = alignment - 1;
163   h->use_extra_arg = 0;
164
165   chunk = h->chunk = CALL_CHUNKFUN (h, h -> chunk_size);
166   if (!chunk)
167     (*obstack_alloc_failed_handler) ();
168   h->next_free = h->object_base = chunk->contents;
169   h->chunk_limit = chunk->limit
170     = (char *) chunk + h->chunk_size;
171   chunk->prev = 0;
172   /* The initial chunk now contains no empty object.  */
173   h->maybe_empty_object = 0;
174   return 1;
175 }
176
177 int
178 _obstack_begin_1 (h, size, alignment, chunkfun, freefun, arg)
179      struct obstack *h;
180      int size;
181      int alignment;
182      POINTER (*chunkfun) ();
183      void (*freefun) ();
184      POINTER arg;
185 {
186   register struct _obstack_chunk *chunk; /* points to new chunk */
187
188   if (alignment == 0)
189     alignment = DEFAULT_ALIGNMENT;
190   if (size == 0)
191     /* Default size is what GNU malloc can fit in a 4096-byte block.  */
192     {
193       /* 12 is sizeof (mhead) and 4 is EXTRA from GNU malloc.
194          Use the values for range checking, because if range checking is off,
195          the extra bytes won't be missed terribly, but if range checking is on
196          and we used a larger request, a whole extra 4096 bytes would be
197          allocated.
198
199          These number are irrelevant to the new GNU malloc.  I suspect it is
200          less sensitive to the size of the request.  */
201       int extra = ((((12 + DEFAULT_ROUNDING - 1) & ~(DEFAULT_ROUNDING - 1))
202                     + 4 + DEFAULT_ROUNDING - 1)
203                    & ~(DEFAULT_ROUNDING - 1));
204       size = 4096 - extra;
205     }
206
207   h->chunkfun = (struct _obstack_chunk * (*)()) chunkfun;
208   h->freefun = freefun;
209   h->chunk_size = size;
210   h->alignment_mask = alignment - 1;
211   h->extra_arg = arg;
212   h->use_extra_arg = 1;
213
214   chunk = h->chunk = CALL_CHUNKFUN (h, h -> chunk_size);
215   if (!chunk)
216     (*obstack_alloc_failed_handler) ();
217   h->next_free = h->object_base = chunk->contents;
218   h->chunk_limit = chunk->limit
219     = (char *) chunk + h->chunk_size;
220   chunk->prev = 0;
221   /* The initial chunk now contains no empty object.  */
222   h->maybe_empty_object = 0;
223   return 1;
224 }
225
226 /* Allocate a new current chunk for the obstack *H
227    on the assumption that LENGTH bytes need to be added
228    to the current object, or a new object of length LENGTH allocated.
229    Copies any partial object from the end of the old chunk
230    to the beginning of the new one.  */
231
232 void
233 _obstack_newchunk (h, length)
234      struct obstack *h;
235      int length;
236 {
237   register struct _obstack_chunk *old_chunk = h->chunk;
238   register struct _obstack_chunk *new_chunk;
239   register long new_size;
240   register int obj_size = h->next_free - h->object_base;
241   register int i;
242   int already;
243
244   /* Compute size for new chunk.  */
245   new_size = (obj_size + length) + (obj_size >> 3) + 100;
246   if (new_size < h->chunk_size)
247     new_size = h->chunk_size;
248
249   /* Allocate and initialize the new chunk.  */
250   new_chunk = CALL_CHUNKFUN (h, new_size);
251   if (!new_chunk)
252     (*obstack_alloc_failed_handler) ();
253   h->chunk = new_chunk;
254   new_chunk->prev = old_chunk;
255   new_chunk->limit = h->chunk_limit = (char *) new_chunk + new_size;
256
257   /* Move the existing object to the new chunk.
258      Word at a time is fast and is safe if the object
259      is sufficiently aligned.  */
260   if (h->alignment_mask + 1 >= DEFAULT_ALIGNMENT)
261     {
262       for (i = obj_size / sizeof (COPYING_UNIT) - 1;
263            i >= 0; i--)
264         ((COPYING_UNIT *)new_chunk->contents)[i]
265           = ((COPYING_UNIT *)h->object_base)[i];
266       /* We used to copy the odd few remaining bytes as one extra COPYING_UNIT,
267          but that can cross a page boundary on a machine
268          which does not do strict alignment for COPYING_UNITS.  */
269       already = obj_size / sizeof (COPYING_UNIT) * sizeof (COPYING_UNIT);
270     }
271   else
272     already = 0;
273   /* Copy remaining bytes one by one.  */
274   for (i = already; i < obj_size; i++)
275     new_chunk->contents[i] = h->object_base[i];
276
277   /* If the object just copied was the only data in OLD_CHUNK,
278      free that chunk and remove it from the chain.
279      But not if that chunk might contain an empty object.  */
280   if (h->object_base == old_chunk->contents && ! h->maybe_empty_object)
281     {
282       new_chunk->prev = old_chunk->prev;
283       CALL_FREEFUN (h, old_chunk);
284     }
285
286   h->object_base = new_chunk->contents;
287   h->next_free = h->object_base + obj_size;
288   /* The new chunk certainly contains no empty object yet.  */
289   h->maybe_empty_object = 0;
290 }
291
292 /* Return nonzero if object OBJ has been allocated from obstack H.
293    This is here for debugging.
294    If you use it in a program, you are probably losing.  */
295
296 #if defined (__STDC__) && __STDC__
297 /* Suppress -Wmissing-prototypes warning.  We don't want to declare this in
298    obstack.h because it is just for debugging.  */
299 int _obstack_allocated_p (struct obstack *h, POINTER obj);
300 #endif
301
302 int
303 _obstack_allocated_p (h, obj)
304      struct obstack *h;
305      POINTER obj;
306 {
307   register struct _obstack_chunk *lp;   /* below addr of any objects in this chunk */
308   register struct _obstack_chunk *plp;  /* point to previous chunk if any */
309
310   lp = (h)->chunk;
311   /* We use >= rather than > since the object cannot be exactly at
312      the beginning of the chunk but might be an empty object exactly
313      at the end of an adjacent chunk.  */
314   while (lp != 0 && ((POINTER) lp >= obj || (POINTER) (lp)->limit < obj))
315     {
316       plp = lp->prev;
317       lp = plp;
318     }
319   return lp != 0;
320 }
321 \f
322 /* Free objects in obstack H, including OBJ and everything allocate
323    more recently than OBJ.  If OBJ is zero, free everything in H.  */
324
325 #undef obstack_free
326
327 /* This function has two names with identical definitions.
328    This is the first one, called from non-ANSI code.  */
329
330 void
331 _obstack_free (h, obj)
332      struct obstack *h;
333      POINTER obj;
334 {
335   register struct _obstack_chunk *lp;   /* below addr of any objects in this chunk */
336   register struct _obstack_chunk *plp;  /* point to previous chunk if any */
337
338   lp = h->chunk;
339   /* We use >= because there cannot be an object at the beginning of a chunk.
340      But there can be an empty object at that address
341      at the end of another chunk.  */
342   while (lp != 0 && ((POINTER) lp >= obj || (POINTER) (lp)->limit < obj))
343     {
344       plp = lp->prev;
345       CALL_FREEFUN (h, lp);
346       lp = plp;
347       /* If we switch chunks, we can't tell whether the new current
348          chunk contains an empty object, so assume that it may.  */
349       h->maybe_empty_object = 1;
350     }
351   if (lp)
352     {
353       h->object_base = h->next_free = (char *) (obj);
354       h->chunk_limit = lp->limit;
355       h->chunk = lp;
356     }
357   else if (obj != 0)
358     /* obj is not in any of the chunks! */
359     abort ();
360 }
361
362 /* This function is used from ANSI code.  */
363
364 void
365 obstack_free (h, obj)
366      struct obstack *h;
367      POINTER obj;
368 {
369   register struct _obstack_chunk *lp;   /* below addr of any objects in this chunk */
370   register struct _obstack_chunk *plp;  /* point to previous chunk if any */
371
372   lp = h->chunk;
373   /* We use >= because there cannot be an object at the beginning of a chunk.
374      But there can be an empty object at that address
375      at the end of another chunk.  */
376   while (lp != 0 && ((POINTER) lp >= obj || (POINTER) (lp)->limit < obj))
377     {
378       plp = lp->prev;
379       CALL_FREEFUN (h, lp);
380       lp = plp;
381       /* If we switch chunks, we can't tell whether the new current
382          chunk contains an empty object, so assume that it may.  */
383       h->maybe_empty_object = 1;
384     }
385   if (lp)
386     {
387       h->object_base = h->next_free = (char *) (obj);
388       h->chunk_limit = lp->limit;
389       h->chunk = lp;
390     }
391   else if (obj != 0)
392     /* obj is not in any of the chunks! */
393     abort ();
394 }
395 \f
396 int
397 _obstack_memory_used (h)
398      struct obstack *h;
399 {
400   register struct _obstack_chunk* lp;
401   register int nbytes = 0;
402
403   for (lp = h->chunk; lp != 0; lp = lp->prev)
404     {
405       nbytes += lp->limit - (char *) lp;
406     }
407   return nbytes;
408 }
409 \f
410 /* Define the error handler.  */
411 #ifndef _
412 # ifdef HAVE_LIBINTL_H
413 #  include <libintl.h>
414 #  ifndef _
415 #   define _(Str) gettext (Str)
416 #  endif
417 # else
418 #  define _(Str) (Str)
419 # endif
420 #endif
421
422 static void
423 print_and_abort ()
424 {
425   fputs (_("memory exhausted\n"), stderr);
426   exit (obstack_exit_failure);
427 }
428 \f
429 #if 0
430 /* These are now turned off because the applications do not use it
431    and it uses bcopy via obstack_grow, which causes trouble on sysV.  */
432
433 /* Now define the functional versions of the obstack macros.
434    Define them to simply use the corresponding macros to do the job.  */
435
436 #if defined (__STDC__) && __STDC__
437 /* These function definitions do not work with non-ANSI preprocessors;
438    they won't pass through the macro names in parentheses.  */
439
440 /* The function names appear in parentheses in order to prevent
441    the macro-definitions of the names from being expanded there.  */
442
443 POINTER (obstack_base) (obstack)
444      struct obstack *obstack;
445 {
446   return obstack_base (obstack);
447 }
448
449 POINTER (obstack_next_free) (obstack)
450      struct obstack *obstack;
451 {
452   return obstack_next_free (obstack);
453 }
454
455 int (obstack_object_size) (obstack)
456      struct obstack *obstack;
457 {
458   return obstack_object_size (obstack);
459 }
460
461 int (obstack_room) (obstack)
462      struct obstack *obstack;
463 {
464   return obstack_room (obstack);
465 }
466
467 int (obstack_make_room) (obstack, length)
468      struct obstack *obstack;
469      int length;
470 {
471   return obstack_make_room (obstack, length);
472 }
473
474 void (obstack_grow) (obstack, pointer, length)
475      struct obstack *obstack;
476      POINTER pointer;
477      int length;
478 {
479   obstack_grow (obstack, pointer, length);
480 }
481
482 void (obstack_grow0) (obstack, pointer, length)
483      struct obstack *obstack;
484      POINTER pointer;
485      int length;
486 {
487   obstack_grow0 (obstack, pointer, length);
488 }
489
490 void (obstack_1grow) (obstack, character)
491      struct obstack *obstack;
492      int character;
493 {
494   obstack_1grow (obstack, character);
495 }
496
497 void (obstack_blank) (obstack, length)
498      struct obstack *obstack;
499      int length;
500 {
501   obstack_blank (obstack, length);
502 }
503
504 void (obstack_1grow_fast) (obstack, character)
505      struct obstack *obstack;
506      int character;
507 {
508   obstack_1grow_fast (obstack, character);
509 }
510
511 void (obstack_blank_fast) (obstack, length)
512      struct obstack *obstack;
513      int length;
514 {
515   obstack_blank_fast (obstack, length);
516 }
517
518 POINTER (obstack_finish) (obstack)
519      struct obstack *obstack;
520 {
521   return obstack_finish (obstack);
522 }
523
524 POINTER (obstack_alloc) (obstack, length)
525      struct obstack *obstack;
526      int length;
527 {
528   return obstack_alloc (obstack, length);
529 }
530
531 POINTER (obstack_copy) (obstack, pointer, length)
532      struct obstack *obstack;
533      POINTER pointer;
534      int length;
535 {
536   return obstack_copy (obstack, pointer, length);
537 }
538
539 POINTER (obstack_copy0) (obstack, pointer, length)
540      struct obstack *obstack;
541      POINTER pointer;
542      int length;
543 {
544   return obstack_copy0 (obstack, pointer, length);
545 }
546
547 #endif /* __STDC__ */
548
549 #endif /* 0 */
550
551 #endif  /* !ELIDE_CODE */