objalloc.h 3.88 KB
Newer Older
Jason Merrill committed
1
/* objalloc.h -- routines to allocate memory for objects
2
   Copyright (C) 1997-2019 Free Software Foundation, Inc.
Jason Merrill committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16
   Written by Ian Lance Taylor, Cygnus Solutions.

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2, or (at your option) any
later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
17 18
Foundation, 51 Franklin Street - Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jason Merrill committed
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

#ifndef OBJALLOC_H
#define OBJALLOC_H

#include "ansidecl.h"

/* These routines allocate space for an object.  The assumption is
   that the object will want to allocate space as it goes along, but
   will never want to free any particular block.  There is a function
   to free a block, which also frees all more recently allocated
   blocks.  There is also a function to free all the allocated space.

   This is essentially a specialization of obstacks.  The main
   difference is that a block may not be allocated a bit at a time.
   Another difference is that these routines are always built on top
   of malloc, and always pass an malloc failure back to the caller,
   unlike more recent versions of obstacks.  */

/* This is what an objalloc structure looks like.  Callers should not
   refer to these fields, nor should they allocate these structure
   themselves.  Instead, they should only create them via
   objalloc_init, and only access them via the functions and macros
   listed below.  The structure is only defined here so that we can
   access it via macros.  */

struct objalloc
{
  char *current_ptr;
  unsigned int current_space;
48
  void *chunks;
Jason Merrill committed
49 50 51 52 53 54 55 56 57 58 59
};

/* Work out the required alignment.  */

struct objalloc_align { char x; double d; };

#if defined (__STDC__) && __STDC__
#ifndef offsetof
#include <stddef.h>
#endif
#endif
60 61 62 63
#ifndef offsetof
#define offsetof(TYPE, MEMBER) ((unsigned long) &((TYPE *)0)->MEMBER)
#endif
#define OBJALLOC_ALIGN offsetof (struct objalloc_align, d)
Jason Merrill committed
64 65 66

/* Create an objalloc structure.  Returns NULL if malloc fails.  */

67
extern struct objalloc *objalloc_create (void);
Jason Merrill committed
68 69 70 71

/* Allocate space from an objalloc structure.  Returns NULL if malloc
   fails.  */

72
extern void *_objalloc_alloc (struct objalloc *, unsigned long);
Jason Merrill committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93

/* The macro version of objalloc_alloc.  We only define this if using
   gcc, because otherwise we would have to evaluate the arguments
   multiple times, or use a temporary field as obstack.h does.  */

#if defined (__GNUC__) && defined (__STDC__) && __STDC__

/* NextStep 2.0 cc is really gcc 1.93 but it defines __GNUC__ = 2 and
   does not implement __extension__.  But that compiler doesn't define
   __GNUC_MINOR__.  */
#if __GNUC__ < 2 || (__NeXT__ && !__GNUC_MINOR__)
#define __extension__
#endif

#define objalloc_alloc(o, l)						\
  __extension__								\
  ({ struct objalloc *__o = (o);					\
     unsigned long __len = (l);						\
     if (__len == 0)							\
       __len = 1;							\
     __len = (__len + OBJALLOC_ALIGN - 1) &~ (OBJALLOC_ALIGN - 1);	\
94
     (__len != 0 && __len <= __o->current_space				\
Jason Merrill committed
95 96
      ? (__o->current_ptr += __len,					\
	 __o->current_space -= __len,					\
97
	 (void *) (__o->current_ptr - __len))				\
Jason Merrill committed
98 99 100 101 102 103 104 105 106 107
      : _objalloc_alloc (__o, __len)); })

#else /* ! __GNUC__ */

#define objalloc_alloc(o, l) _objalloc_alloc ((o), (l))

#endif /* ! __GNUC__ */

/* Free an entire objalloc structure.  */

108
extern void objalloc_free (struct objalloc *);
Jason Merrill committed
109 110 111 112

/* Free a block allocated by objalloc_alloc.  This also frees all more
   recently allocated blocks.  */

113
extern void objalloc_free_block (struct objalloc *, void *);
Jason Merrill committed
114 115

#endif /* OBJALLOC_H */