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 assert(GC_all_interior_pointers
);
80 /** @brief Allocate memory
81 * @param n Bytes to allocate
82 * @return Pointer to allocated memory
84 * Terminates the process on error. The allocated memory is always
87 void *xmalloc(size_t n
) {
90 if(!(ptr
= do_malloc(n
)) && n
)
91 fatal(errno
, "error allocating memory");
95 /** @brief Reallocate memory
96 * @param ptr Block to reallocated
97 * @param n Bytes to allocate
98 * @return Pointer to allocated memory
100 * Terminates the process on error. It is NOT guaranteed that any
101 * additional memory allocated is 0-filled.
103 void *xrealloc(void *ptr
, size_t n
) {
104 if(!(ptr
= do_realloc(ptr
, n
)) && n
)
105 fatal(errno
, "error allocating memory");
109 /** @brief Allocate memory
110 * @param count Number of objects to allocate
111 * @param size Size of one object
112 * @return Pointer to allocated memory
114 * Terminates the process on error. The allocated memory is always
117 void *xcalloc(size_t count
, size_t size
) {
118 if(count
> SIZE_MAX
/ size
)
119 fatal(0, "excessively large calloc");
120 return xmalloc(count
* size
);
123 /** @brief Allocate memory
124 * @param n Bytes to allocate
125 * @return Pointer to allocated memory
127 * Terminates the process on error. The allocated memory is not
128 * guaranteed to be 0-filled and is not suitable for storing pointers
131 void *xmalloc_noptr(size_t n
) {
134 if(!(ptr
= do_malloc_atomic(n
)) && n
)
135 fatal(errno
, "error allocating memory");
139 /** @brief Allocate memory
140 * @param count Number of objects to allocate
141 * @param size Size of one object
142 * @return Pointer to allocated memory
144 * Terminates the process on error. IMPORTANT: the allocated memory is NOT
145 * 0-filled (unlike @c calloc()).
147 void *xcalloc_noptr(size_t count
, size_t size
) {
148 if(count
> SIZE_MAX
/ size
)
149 fatal(0, "excessively large calloc");
150 return xmalloc_noptr(count
* size
);
153 /** @brief Reallocate memory
154 * @param ptr Block to reallocated
155 * @param n Bytes to allocate
156 * @return Pointer to allocated memory
158 * Terminates the processf on error. It is NOT guaranteed that any
159 * additional memory allocated is 0-filled. The block must have been
160 * allocated with xmalloc_noptr() (or xrealloc_noptr()) initially.
162 void *xrealloc_noptr(void *ptr
, size_t n
) {
164 return xmalloc_noptr(n
);
165 if(!(ptr
= do_realloc(ptr
, n
)) && n
)
166 fatal(errno
, "error allocating memory");
170 /** @brief Duplicate a string
171 * @param s String to copy
172 * @return New copy of string
174 * This uses the equivalent of xmalloc_noptr() to allocate the new string.
176 char *xstrdup(const char *s
) {
179 if(!(t
= do_malloc_atomic(strlen(s
) + 1)))
180 fatal(errno
, "error allocating memory");
184 /** @brief Duplicate a prefix of a string
185 * @param s String to copy
186 * @param n Prefix of string to copy
187 * @return New copy of string
189 * This uses the equivalent of xmalloc_noptr() to allocate the new string.
190 * @p n must not exceed the length of the string.
192 char *xstrndup(const char *s
, size_t n
) {
195 if(!(t
= do_malloc_atomic(n
+ 1)))
196 fatal(errno
, "error allocating memory");
202 /** @brief Free memory
203 * @param ptr Block to free or 0
205 void xfree(void *ptr
) {