2 * This file is part of DisOrder.
3 * Copyright (C) 2004, 2005, 2006, 2007, 2009 Richard Kettlewell
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 * @brief Memory management
35 /** @brief Allocate and zero out
36 * @param n Number of bytes to allocate
37 * @return Pointer to allocated memory, or 0
39 static void *malloc_and_zero(size_t n
) {
40 void *ptr
= malloc(n
);
42 if(ptr
) memset(ptr
, 0, n
);
47 static void *(*do_malloc
)(size_t) = GC_malloc
;
48 static void *(*do_realloc
)(void *, size_t) = GC_realloc
;
49 static void *(*do_malloc_atomic
)(size_t) = GC_malloc_atomic
;
50 static void (*do_free
)(void *) = GC_free
;
52 static void *(*do_malloc
)(size_t) = malloc_and_zero
;
53 static void *(*do_realloc
)(void *, size_t) = realloc
;
54 static void *(*do_malloc_atomic
)(size_t) = malloc
;
55 static void (*do_free
)(void *) = free
;
58 /** @brief Initialize memory management
60 * Must be called by all programs that use garbage collection. Define
61 * @c ${DISORDER_GC} to @c no to suppress use of the collector
62 * (e.g. for debugging purposes).
68 if(((e
= getenv("DISORDER_GC")) && !strcmp(e
, "no"))) {
69 do_malloc
= malloc_and_zero
;
70 do_malloc_atomic
= malloc
;
75 #ifdef HAVE_GC_GET_ALL_INTERIOR_POINTERS
76 assert(GC_get_all_interior_pointers());
78 assert(GC_all_interior_pointers
);
84 /** @brief Allocate memory
85 * @param n Bytes to allocate
86 * @return Pointer to allocated memory
88 * Terminates the process on error. The allocated memory is always
91 void *xmalloc(size_t n
) {
94 if(!(ptr
= do_malloc(n
)) && n
)
95 disorder_fatal(errno
, "error allocating memory");
99 /** @brief Reallocate memory
100 * @param ptr Block to reallocated
101 * @param n Bytes to allocate
102 * @return Pointer to allocated memory
104 * Terminates the process on error. It is NOT guaranteed that any
105 * additional memory allocated is 0-filled.
107 void *xrealloc(void *ptr
, size_t n
) {
108 if(!(ptr
= do_realloc(ptr
, n
)) && n
)
109 disorder_fatal(errno
, "error allocating memory");
113 /** @brief Allocate memory
114 * @param count Number of objects to allocate
115 * @param size Size of one object
116 * @return Pointer to allocated memory
118 * Terminates the process on error. The allocated memory is always
121 void *xcalloc(size_t count
, size_t size
) {
122 if(count
> SIZE_MAX
/ size
)
123 disorder_fatal(0, "excessively large calloc");
124 return xmalloc(count
* size
);
127 /** @brief Allocate memory
128 * @param n Bytes to allocate
129 * @return Pointer to allocated memory
131 * Terminates the process on error. The allocated memory is not
132 * guaranteed to be 0-filled and is not suitable for storing pointers
135 void *xmalloc_noptr(size_t n
) {
138 if(!(ptr
= do_malloc_atomic(n
)) && n
)
139 disorder_fatal(errno
, "error allocating memory");
143 /** @brief Allocate memory
144 * @param count Number of objects to allocate
145 * @param size Size of one object
146 * @return Pointer to allocated memory
148 * Terminates the process on error. IMPORTANT: the allocated memory is NOT
149 * 0-filled (unlike @c calloc()).
151 void *xcalloc_noptr(size_t count
, size_t size
) {
152 if(count
> SIZE_MAX
/ size
)
153 disorder_fatal(0, "excessively large calloc");
154 return xmalloc_noptr(count
* size
);
157 /** @brief Reallocate memory
158 * @param ptr Block to reallocated
159 * @param n Bytes to allocate
160 * @return Pointer to allocated memory
162 * Terminates the processf on error. It is NOT guaranteed that any
163 * additional memory allocated is 0-filled. The block must have been
164 * allocated with xmalloc_noptr() (or xrealloc_noptr()) initially.
166 void *xrealloc_noptr(void *ptr
, size_t n
) {
168 return xmalloc_noptr(n
);
169 if(!(ptr
= do_realloc(ptr
, n
)) && n
)
170 disorder_fatal(errno
, "error allocating memory");
174 /** @brief Duplicate a string
175 * @param s String to copy
176 * @return New copy of string
178 * This uses the equivalent of xmalloc_noptr() to allocate the new string.
180 char *xstrdup(const char *s
) {
183 if(!(t
= do_malloc_atomic(strlen(s
) + 1)))
184 disorder_fatal(errno
, "error allocating memory");
188 /** @brief Duplicate a prefix of a string
189 * @param s String to copy
190 * @param n Prefix of string to copy
191 * @return New copy of string
193 * This uses the equivalent of xmalloc_noptr() to allocate the new string.
194 * @p n must not exceed the length of the string.
196 char *xstrndup(const char *s
, size_t n
) {
199 if(!(t
= do_malloc_atomic(n
+ 1)))
200 disorder_fatal(errno
, "error allocating memory");
206 /** @brief Free memory
207 * @param ptr Block to free or 0
209 void xfree(void *ptr
) {