src/libpspp/pool.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18    02110-1301, USA. */
  19
  20 #if !pool_h
  21 #define pool_h 1
  22
  23 #include <stdio.h>
  24
  25 /* Maximum size of a suballocated block.  Larger blocks are allocated
  26    directly with malloc() to avoid memory wastage at the end of a
  27    suballocation block. */
  28 #ifndef MAX_SUBALLOC
  29 #define MAX_SUBALLOC 64
  30 #endif
  31
  32
  33 /* Records the state of a pool for later restoration. */
  34 struct pool_mark
  35   {
  36     /* Current block and offset into it. */
  37     struct pool_block *block;
  38     size_t ofs;
  39
  40     /* Current serial number to allow freeing of gizmos. */
  41     long serial;
  42   };
  43
  44 /* General routines. */
  45 struct pool *pool_create (void);
  46 void pool_destroy (struct pool *);
  47 void pool_clear (struct pool *);
  48
  49 /* Creates a pool, allocates an instance of the given STRUCT
  50    within it, sets the struct's MEMBER to the pool's address, and
  51    returns the allocated structure. */
  52 #define pool_create_container(STRUCT, MEMBER)                           \
  53         ((STRUCT *) pool_create_at_offset (sizeof (STRUCT),             \
  54                                            offsetof (STRUCT, MEMBER)))
  55 void *pool_create_at_offset (size_t struct_size, size_t pool_member_offset);
  56
  57 /* Suballocation routines. */
  58 void *pool_alloc (struct pool *, size_t) MALLOC_LIKE;
  59 void *pool_nalloc (struct pool *, size_t n, size_t s) MALLOC_LIKE;
  60 void *pool_clone (struct pool *, const void *, size_t) MALLOC_LIKE;
  61
  62 void *pool_alloc_unaligned (struct pool *, size_t) MALLOC_LIKE;
  63 void *pool_clone_unaligned (struct pool *, const void *, size_t) MALLOC_LIKE;
  64 char *pool_strdup (struct pool *, const char *) MALLOC_LIKE;
  65 char *pool_strcat (struct pool *, const char *, ...) MALLOC_LIKE;
  66
  67 /* Standard allocation routines. */
  68 void *pool_malloc (struct pool *, size_t) MALLOC_LIKE;
  69 void *pool_nmalloc (struct pool *, size_t n, size_t s) MALLOC_LIKE;
  70 void *pool_realloc (struct pool *, void *, size_t);
  71 void *pool_nrealloc (struct pool *, void *, size_t n, size_t s);
  72 void *pool_2nrealloc (struct pool *, void *, size_t *pn, size_t s);
  73 void pool_free (struct pool *, void *);
  74
  75 /* Subpools. */
  76 struct pool *pool_create_subpool (struct pool *);
  77 void pool_add_subpool (struct pool *, struct pool *subpool);
  78
  79 /* Files. */
  80 FILE *pool_fopen (struct pool *, const char *, const char *);
  81 int pool_fclose (struct pool *, FILE *);
  82 FILE *pool_tmpfile (struct pool *);
  83 void pool_attach_file (struct pool *, FILE *);
  84 void pool_detach_file (struct pool *, FILE *);
  85
  86 /* Custom allocations. */
  87 void pool_register (struct pool *, void (*free) (void *), void *p);
  88 int pool_unregister (struct pool *, void *);
  89
  90 /* Partial freeing. */
  91 void pool_mark (struct pool *, struct pool_mark *);
  92 void pool_release (struct pool *, const struct pool_mark *);
  93
  94 #if GLOBAL_DEBUGGING
  95 void pool_dump (const struct pool *, const char *title);
  96 #endif
  97
  98 #endif /* pool.h */