summaryrefslogtreecommitdiff
path: root/lib/allocator.h
blob: 4ac863b224cac91a35fe1f7ad1525c2ebf6515cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
48
49
50
51
52
53
/* Memory allocators such as malloc+free.

   Copyright (C) 2011 Free Software Foundation, Inc.

   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 3 of the License, 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, see <http://www.gnu.org/licenses/>.  */

/* Written by Paul Eggert.  */

#ifndef _GL_ALLOCATOR_H

#include <stddef.h>

/* An object describing a memory allocator family.  */

struct allocator
{
  /* Do not use GCC attributes such as __attribute__ ((malloc)) with
     the function types pointed at by these members, because these
     attributes do not work with pointers to functions.  See
     <http://lists.gnu.org/archive/html/bug-gnulib/2011-04/msg00007.html>.  */

  /* Call MALLOC to allocate memory, like 'malloc'.  On failure MALLOC
     should return NULL, though not necessarily set errno.  When given
     a zero size it may return NULL even if successful.  */
  void *(*malloc) (size_t);

  /* If nonnull, call REALLOC to reallocate memory, like 'realloc'.
     On failure REALLOC should return NULL, though not necessarily set
     errno.  When given a zero size it may return NULL even if
     successful.  */
  void *(*realloc) (void *, size_t);

  /* Call FREE to free memory, like 'free'.  */
  void (*free) (void *);

  /* If nonnull, call DIE if MALLOC or REALLOC fails.  DIE should not
     return.  DIE can be used by code that detects memory overflow
     while calculating sizes to be passed to MALLOC or REALLOC.  */
  void (*die) (void);
};

#endif