Import gnulib version.
[kopensolaris-gnu/glibc.git] / malloc / obstack.c
1 /* obstack.c - subroutines used implicitly by object stack macros
2    Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1996, 1997,
3    1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
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 Lesser General Public
9    License as published by the Free Software Foundation; either
10    version 2.1 of the 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    Lesser General Public License for more details.
16
17    You should have received a copy of the GNU Lesser General Public
18    License along with the GNU C Library; if not, write to the Free
19    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
20    02111-1307 USA.  */
21
22 #ifdef HAVE_CONFIG_H
23 # include <config.h>
24 #endif
25
26 #ifdef _LIBC
27 # include <obstack.h>
28 #else
29 # include "obstack.h"
30 #endif
31
32 /* NOTE BEFORE MODIFYING THIS FILE: This version number must be
33    incremented whenever callers compiled using an old obstack.h can no
34    longer properly call the functions in this obstack.c.  */
35 #define OBSTACK_INTERFACE_VERSION 1
36
37 /* Comment out all this code if we are using the GNU C Library, and are not
38    actually compiling the library itself, and the installed library
39    supports the same library interface we do.  This code is part of the GNU
40    C Library, but also included in many other GNU distributions.  Compiling
41    and linking in this code is a waste when using the GNU C library
42    (especially if it is a shared library).  Rather than having every GNU
43    program understand `configure --with-gnu-libc' and omit the object
44    files, it is simpler to just do this in the source for each such file.  */
45
46 #include <stdio.h>              /* Random thing to get __GNU_LIBRARY__.  */
47 #if !defined _LIBC && defined __GNU_LIBRARY__ && __GNU_LIBRARY__ > 1
48 # include <gnu-versions.h>
49 # if _GNU_OBSTACK_INTERFACE_VERSION == OBSTACK_INTERFACE_VERSION
50 #  define ELIDE_CODE
51 # endif
52 #endif
53
54 #if defined _LIBC && defined USE_IN_LIBIO
55 # include <wchar.h>
56 #endif
57
58 #ifndef ELIDE_CODE
59
60
61 /* Determine default alignment.  */
62 struct fooalign {char x; double d;};
63 # define DEFAULT_ALIGNMENT  \
64   ((PTR_INT_TYPE) ((char *) &((struct fooalign *) 0)->d - (char *) 0))
65 /* If malloc were really smart, it would round addresses to DEFAULT_ALIGNMENT.
66    But in fact it might be less smart and round addresses to as much as
67    DEFAULT_ROUNDING.  So we prepare for it to do that.  */
68 union fooround {long x; double d;};
69 # define DEFAULT_ROUNDING (sizeof (union fooround))
70
71 /* When we copy a long block of data, this is the unit to do it with.
72    On some machines, copying successive ints does not work;
73    in such a case, redefine COPYING_UNIT to `long' (if that works)
74    or `char' as a last resort.  */
75 # ifndef COPYING_UNIT
76 #  define COPYING_UNIT int
77 # endif
78
79
80 /* The functions allocating more room by calling `obstack_chunk_alloc'
81    jump to the handler pointed to by `obstack_alloc_failed_handler'.
82    This can be set to a user defined function which should either
83    abort gracefully or use longjump - but shouldn't return.  This
84    variable by default points to the internal function
85    `print_and_abort'.  */
86 static void print_and_abort (void);
87 void (*obstack_alloc_failed_handler) (void) = print_and_abort;
88
89 /* Exit value used when `print_and_abort' is used.  */
90 # include <stdlib.h>
91 # ifdef _LIBC
92 int obstack_exit_failure = EXIT_FAILURE;
93 # else
94 #  include "exitfail.h"
95 #  define obstack_exit_failure exit_failure
96 # endif
97
98 /* The non-GNU-C macros copy the obstack into this global variable
99    to avoid multiple evaluation.  */
100
101 struct obstack *_obstack;
102
103 /* Define a macro that either calls functions with the traditional malloc/free
104    calling interface, or calls functions with the mmalloc/mfree interface
105    (that adds an extra first argument), based on the state of use_extra_arg.
106    For free, do not use ?:, since some compilers, like the MIPS compilers,
107    do not allow (expr) ? void : void.  */
108
109 # define CALL_CHUNKFUN(h, size) \
110   (((h) -> use_extra_arg) \
111    ? (*(h)->chunkfun) ((h)->extra_arg, (size)) \
112    : (*(struct _obstack_chunk *(*) (long)) (h)->chunkfun) ((size)))
113
114 # define CALL_FREEFUN(h, old_chunk) \
115   do { \
116     if ((h) -> use_extra_arg) \
117       (*(h)->freefun) ((h)->extra_arg, (old_chunk)); \
118     else \
119       (*(void (*) (void *)) (h)->freefun) ((old_chunk)); \
120   } while (0)
121
122 \f
123 /* Initialize an obstack H for use.  Specify chunk size SIZE (0 means default).
124    Objects start on multiples of ALIGNMENT (0 means use default).
125    CHUNKFUN is the function to use to allocate chunks,
126    and FREEFUN the function to free them.
127
128    Return nonzero if successful, calls obstack_alloc_failed_handler if
129    allocation fails.  */
130
131 int
132 _obstack_begin (struct obstack *h,
133                 int size, int alignment,
134                 void *(*chunkfun) (long),
135                 void (*freefun) (void *))
136 {
137   register struct _obstack_chunk *chunk; /* points to new chunk */
138
139   if (alignment == 0)
140     alignment = (int) DEFAULT_ALIGNMENT;
141   if (size == 0)
142     /* Default size is what GNU malloc can fit in a 4096-byte block.  */
143     {
144       /* 12 is sizeof (mhead) and 4 is EXTRA from GNU malloc.
145          Use the values for range checking, because if range checking is off,
146          the extra bytes won't be missed terribly, but if range checking is on
147          and we used a larger request, a whole extra 4096 bytes would be
148          allocated.
149
150          These number are irrelevant to the new GNU malloc.  I suspect it is
151          less sensitive to the size of the request.  */
152       int extra = ((((12 + DEFAULT_ROUNDING - 1) & ~(DEFAULT_ROUNDING - 1))
153                     + 4 + DEFAULT_ROUNDING - 1)
154                    & ~(DEFAULT_ROUNDING - 1));
155       size = 4096 - extra;
156     }
157
158   h->chunkfun = (struct _obstack_chunk * (*)(void *, long)) chunkfun;
159   h->freefun = (void (*) (void *, struct _obstack_chunk *)) freefun;
160   h->chunk_size = size;
161   h->alignment_mask = alignment - 1;
162   h->use_extra_arg = 0;
163
164   chunk = h->chunk = CALL_CHUNKFUN (h, h -> chunk_size);
165   if (!chunk)
166     (*obstack_alloc_failed_handler) ();
167   h->next_free = h->object_base = chunk->contents;
168   h->chunk_limit = chunk->limit
169     = (char *) chunk + h->chunk_size;
170   chunk->prev = 0;
171   /* The initial chunk now contains no empty object.  */
172   h->maybe_empty_object = 0;
173   h->alloc_failed = 0;
174   return 1;
175 }
176
177 int
178 _obstack_begin_1 (struct obstack *h, int size, int alignment,
179                   void *(*chunkfun) (void *, long),
180                   void (*freefun) (void *, void *),
181                   void *arg)
182 {
183   register struct _obstack_chunk *chunk; /* points to new chunk */
184
185   if (alignment == 0)
186     alignment = (int) DEFAULT_ALIGNMENT;
187   if (size == 0)
188     /* Default size is what GNU malloc can fit in a 4096-byte block.  */
189     {
190       /* 12 is sizeof (mhead) and 4 is EXTRA from GNU malloc.
191          Use the values for range checking, because if range checking is off,
192          the extra bytes won't be missed terribly, but if range checking is on
193          and we used a larger request, a whole extra 4096 bytes would be
194          allocated.
195
196          These number are irrelevant to the new GNU malloc.  I suspect it is
197          less sensitive to the size of the request.  */
198       int extra = ((((12 + DEFAULT_ROUNDING - 1) & ~(DEFAULT_ROUNDING - 1))
199                     + 4 + DEFAULT_ROUNDING - 1)
200                    & ~(DEFAULT_ROUNDING - 1));
201       size = 4096 - extra;
202     }
203
204   h->chunkfun = (struct _obstack_chunk * (*)(void *,long)) chunkfun;
205   h->freefun = (void (*) (void *, struct _obstack_chunk *)) freefun;
206   h->chunk_size = size;
207   h->alignment_mask = alignment - 1;
208   h->extra_arg = arg;
209   h->use_extra_arg = 1;
210
211   chunk = h->chunk = CALL_CHUNKFUN (h, h -> chunk_size);
212   if (!chunk)
213     (*obstack_alloc_failed_handler) ();
214   h->next_free = h->object_base = chunk->contents;
215   h->chunk_limit = chunk->limit
216     = (char *) chunk + h->chunk_size;
217   chunk->prev = 0;
218   /* The initial chunk now contains no empty object.  */
219   h->maybe_empty_object = 0;
220   h->alloc_failed = 0;
221   return 1;
222 }
223
224 /* Allocate a new current chunk for the obstack *H
225    on the assumption that LENGTH bytes need to be added
226    to the current object, or a new object of length LENGTH allocated.
227    Copies any partial object from the end of the old chunk
228    to the beginning of the new one.  */
229
230 void
231 _obstack_newchunk (struct obstack *h, int length)
232 {
233   register struct _obstack_chunk *old_chunk = h->chunk;
234   register struct _obstack_chunk *new_chunk;
235   register long new_size;
236   register long obj_size = h->next_free - h->object_base;
237   register long i;
238   long already;
239   char *object_base;
240
241   /* Compute size for new chunk.  */
242   new_size = (obj_size + length) + (obj_size >> 3) + h->alignment_mask + 100;
243   if (new_size < h->chunk_size)
244     new_size = h->chunk_size;
245
246   /* Allocate and initialize the new chunk.  */
247   new_chunk = CALL_CHUNKFUN (h, new_size);
248   if (!new_chunk)
249     (*obstack_alloc_failed_handler) ();
250   h->chunk = new_chunk;
251   new_chunk->prev = old_chunk;
252   new_chunk->limit = h->chunk_limit = (char *) new_chunk + new_size;
253
254   /* Compute an aligned object_base in the new chunk */
255   object_base =
256     __INT_TO_PTR ((__PTR_TO_INT (new_chunk->contents) + h->alignment_mask)
257                   & ~ (h->alignment_mask));
258
259   /* Move the existing object to the new chunk.
260      Word at a time is fast and is safe if the object
261      is sufficiently aligned.  */
262   if (h->alignment_mask + 1 >= DEFAULT_ALIGNMENT)
263     {
264       for (i = obj_size / sizeof (COPYING_UNIT) - 1;
265            i >= 0; i--)
266         ((COPYING_UNIT *)object_base)[i]
267           = ((COPYING_UNIT *)h->object_base)[i];
268       /* We used to copy the odd few remaining bytes as one extra COPYING_UNIT,
269          but that can cross a page boundary on a machine
270          which does not do strict alignment for COPYING_UNITS.  */
271       already = obj_size / sizeof (COPYING_UNIT) * sizeof (COPYING_UNIT);
272     }
273   else
274     already = 0;
275   /* Copy remaining bytes one by one.  */
276   for (i = already; i < obj_size; i++)
277     object_base[i] = h->object_base[i];
278
279   /* If the object just copied was the only data in OLD_CHUNK,
280      free that chunk and remove it from the chain.
281      But not if that chunk might contain an empty object.  */
282   if (h->object_base == old_chunk->contents && ! h->maybe_empty_object)
283     {
284       new_chunk->prev = old_chunk->prev;
285       CALL_FREEFUN (h, old_chunk);
286     }
287
288   h->object_base = object_base;
289   h->next_free = h->object_base + obj_size;
290   /* The new chunk certainly contains no empty object yet.  */
291   h->maybe_empty_object = 0;
292 }
293 # ifdef _LIBC
294 libc_hidden_def (_obstack_newchunk)
295 # endif
296
297 /* Return nonzero if object OBJ has been allocated from obstack H.
298    This is here for debugging.
299    If you use it in a program, you are probably losing.  */
300
301 /* Suppress -Wmissing-prototypes warning.  We don't want to declare this in
302    obstack.h because it is just for debugging.  */
303 int _obstack_allocated_p (struct obstack *h, void *obj);
304
305 int
306 _obstack_allocated_p (struct obstack *h, void *obj)
307 {
308   register struct _obstack_chunk *lp;   /* below addr of any objects in this chunk */
309   register struct _obstack_chunk *plp;  /* point to previous chunk if any */
310
311   lp = (h)->chunk;
312   /* We use >= rather than > since the object cannot be exactly at
313      the beginning of the chunk but might be an empty object exactly
314      at the end of an adjacent chunk.  */
315   while (lp != 0 && ((void *) lp >= obj || (void *) (lp)->limit < obj))
316     {
317       plp = lp->prev;
318       lp = plp;
319     }
320   return lp != 0;
321 }
322 \f
323 /* Free objects in obstack H, including OBJ and everything allocate
324    more recently than OBJ.  If OBJ is zero, free everything in H.  */
325
326 # undef obstack_free
327
328 void
329 obstack_free (struct obstack *h, void *obj)
330 {
331   register struct _obstack_chunk *lp;   /* below addr of any objects in this chunk */
332   register struct _obstack_chunk *plp;  /* point to previous chunk if any */
333
334   lp = h->chunk;
335   /* We use >= because there cannot be an object at the beginning of a chunk.
336      But there can be an empty object at that address
337      at the end of another chunk.  */
338   while (lp != 0 && ((void *) lp >= obj || (void *) (lp)->limit < obj))
339     {
340       plp = lp->prev;
341       CALL_FREEFUN (h, lp);
342       lp = plp;
343       /* If we switch chunks, we can't tell whether the new current
344          chunk contains an empty object, so assume that it may.  */
345       h->maybe_empty_object = 1;
346     }
347   if (lp)
348     {
349       h->object_base = h->next_free = (char *) (obj);
350       h->chunk_limit = lp->limit;
351       h->chunk = lp;
352     }
353   else if (obj != 0)
354     /* obj is not in any of the chunks! */
355     abort ();
356 }
357
358 # ifdef _LIBC
359 /* Older versions of libc used a function _obstack_free intended to be
360    called by non-GCC compilers.  */
361 strong_alias (obstack_free, _obstack_free)
362 # endif
363 \f
364 int
365 _obstack_memory_used (struct obstack *h)
366 {
367   register struct _obstack_chunk* lp;
368   register int nbytes = 0;
369
370   for (lp = h->chunk; lp != 0; lp = lp->prev)
371     {
372       nbytes += lp->limit - (char *) lp;
373     }
374   return nbytes;
375 }
376 \f
377 /* Define the error handler.  */
378 # ifdef _LIBC
379 #  include <libintl.h>
380 # else
381 #  include "gettext.h"
382 # endif
383 # ifndef _
384 #  define _(msgid) gettext (msgid)
385 # endif
386
387 # ifdef _LIBC
388 #  include <libio/iolibio.h>
389 # endif
390
391 # ifndef __attribute__
392 /* This feature is available in gcc versions 2.5 and later.  */
393 #  if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5)
394 #   define __attribute__(Spec) /* empty */
395 #  endif
396 # endif
397
398 static void
399 __attribute__ ((noreturn))
400 print_and_abort (void)
401 {
402   /* Don't change any of these strings.  Yes, it would be possible to add
403      the newline to the string and use fputs or so.  But this must not
404      happen because the "memory exhausted" message appears in other places
405      like this and the translation should be reused instead of creating
406      a very similar string which requires a separate translation.  */
407 # if defined _LIBC && defined USE_IN_LIBIO
408   if (_IO_fwide (stderr, 0) > 0)
409     __fwprintf (stderr, L"%s\n", _("memory exhausted"));
410   else
411 # endif
412     fprintf (stderr, "%s\n", _("memory exhausted"));
413   exit (obstack_exit_failure);
414 }
415
416 #endif  /* !ELIDE_CODE */