chiark / gitweb /
examples/disorder.init.in: Read settings from `/etc/default/disorder'.
[disorder] / lib / mem.c
CommitLineData
460b9539 1/*
2 * This file is part of DisOrder.
8e93ddd1 3 * Copyright (C) 2004, 2005, 2006, 2007, 2009 Richard Kettlewell
460b9539 4 *
e7eb3a27 5 * This program is free software: you can redistribute it and/or modify
460b9539 6 * it under the terms of the GNU General Public License as published by
e7eb3a27 7 * the Free Software Foundation, either version 3 of the License, or
460b9539 8 * (at your option) any later version.
e7eb3a27
RK
9 *
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.
14 *
460b9539 15 * You should have received a copy of the GNU General Public License
e7eb3a27 16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
460b9539 17 */
b5bafc5c
RK
18/** @file lib/mem.c
19 * @brief Memory management
20 */
460b9539 21
05b75f8d 22#include "common.h"
460b9539 23
320598d4 24#if GC
460b9539 25#include <gc.h>
320598d4 26#endif
460b9539 27#include <errno.h>
460b9539 28
29#include "mem.h"
30#include "log.h"
31#include "printf.h"
32
33#include "disorder.h"
34
b5bafc5c
RK
35/** @brief Allocate and zero out
36 * @param n Number of bytes to allocate
37 * @return Pointer to allocated memory, or 0
38 */
460b9539 39static void *malloc_and_zero(size_t n) {
40 void *ptr = malloc(n);
41
42 if(ptr) memset(ptr, 0, n);
43 return ptr;
44}
45
320598d4
RK
46#if GC
47static void *(*do_malloc)(size_t) = GC_malloc;
48static void *(*do_realloc)(void *, size_t) = GC_realloc;
49static void *(*do_malloc_atomic)(size_t) = GC_malloc_atomic;
50static void (*do_free)(void *) = GC_free;
51#else
52static void *(*do_malloc)(size_t) = malloc_and_zero;
53static void *(*do_realloc)(void *, size_t) = realloc;
54static void *(*do_malloc_atomic)(size_t) = malloc;
55static void (*do_free)(void *) = free;
56#endif
57
b5bafc5c
RK
58/** @brief Initialize memory management
59 *
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).
63 */
320598d4
RK
64void mem_init(void) {
65#if GC
460b9539 66 const char *e;
67
320598d4 68 if(((e = getenv("DISORDER_GC")) && !strcmp(e, "no"))) {
460b9539 69 do_malloc = malloc_and_zero;
70 do_malloc_atomic = malloc;
71 do_realloc = realloc;
72 do_free = free;
433e561f 73 } else {
460b9539 74 GC_init();
4265131b 75#ifdef HAVE_GC_GET_ALL_INTERIOR_POINTERS
fe0268e1 76 assert(GC_get_all_interior_pointers());
4265131b
MW
77#else
78 assert(GC_all_interior_pointers);
79#endif
433e561f 80 }
320598d4 81#endif
460b9539 82}
83
b5bafc5c
RK
84/** @brief Allocate memory
85 * @param n Bytes to allocate
86 * @return Pointer to allocated memory
87 *
88 * Terminates the process on error. The allocated memory is always
89 * 0-filled.
90 */
460b9539 91void *xmalloc(size_t n) {
92 void *ptr;
93
94 if(!(ptr = do_malloc(n)) && n)
2e9ba080 95 disorder_fatal(errno, "error allocating memory");
460b9539 96 return ptr;
97}
98
b5bafc5c
RK
99/** @brief Reallocate memory
100 * @param ptr Block to reallocated
101 * @param n Bytes to allocate
102 * @return Pointer to allocated memory
103 *
104 * Terminates the process on error. It is NOT guaranteed that any
105 * additional memory allocated is 0-filled.
106 */
460b9539 107void *xrealloc(void *ptr, size_t n) {
108 if(!(ptr = do_realloc(ptr, n)) && n)
2e9ba080 109 disorder_fatal(errno, "error allocating memory");
460b9539 110 return ptr;
111}
112
b5bafc5c
RK
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
117 *
118 * Terminates the process on error. The allocated memory is always
119 * 0-filled.
120 */
460b9539 121void *xcalloc(size_t count, size_t size) {
122 if(count > SIZE_MAX / size)
2e9ba080 123 disorder_fatal(0, "excessively large calloc");
460b9539 124 return xmalloc(count * size);
125}
126
b5bafc5c
RK
127/** @brief Allocate memory
128 * @param n Bytes to allocate
129 * @return Pointer to allocated memory
130 *
131 * Terminates the process on error. The allocated memory is not
132 * guaranteed to be 0-filled and is not suitable for storing pointers
133 * in.
134 */
460b9539 135void *xmalloc_noptr(size_t n) {
136 void *ptr;
137
138 if(!(ptr = do_malloc_atomic(n)) && n)
2e9ba080 139 disorder_fatal(errno, "error allocating memory");
460b9539 140 return ptr;
141}
142
8e93ddd1
RK
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
147 *
148 * Terminates the process on error. IMPORTANT: the allocated memory is NOT
149 * 0-filled (unlike @c calloc()).
150 */
151void *xcalloc_noptr(size_t count, size_t size) {
152 if(count > SIZE_MAX / size)
2e9ba080 153 disorder_fatal(0, "excessively large calloc");
8e93ddd1
RK
154 return xmalloc_noptr(count * size);
155}
156
b5bafc5c
RK
157/** @brief Reallocate memory
158 * @param ptr Block to reallocated
159 * @param n Bytes to allocate
160 * @return Pointer to allocated memory
161 *
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.
165 */
460b9539 166void *xrealloc_noptr(void *ptr, size_t n) {
167 if(ptr == 0)
168 return xmalloc_noptr(n);
169 if(!(ptr = do_realloc(ptr, n)) && n)
2e9ba080 170 disorder_fatal(errno, "error allocating memory");
460b9539 171 return ptr;
172}
173
b5bafc5c
RK
174/** @brief Duplicate a string
175 * @param s String to copy
176 * @return New copy of string
177 *
178 * This uses the equivalent of xmalloc_noptr() to allocate the new string.
179 */
460b9539 180char *xstrdup(const char *s) {
181 char *t;
182
183 if(!(t = do_malloc_atomic(strlen(s) + 1)))
2e9ba080 184 disorder_fatal(errno, "error allocating memory");
460b9539 185 return strcpy(t, s);
186}
187
b5bafc5c
RK
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
192 *
193 * This uses the equivalent of xmalloc_noptr() to allocate the new string.
194 * @p n must not exceed the length of the string.
195 */
460b9539 196char *xstrndup(const char *s, size_t n) {
197 char *t;
198
199 if(!(t = do_malloc_atomic(n + 1)))
2e9ba080 200 disorder_fatal(errno, "error allocating memory");
460b9539 201 memcpy(t, s, n);
202 t[n] = 0;
203 return t;
204}
205
b5bafc5c
RK
206/** @brief Free memory
207 * @param ptr Block to free or 0
208 */
460b9539 209void xfree(void *ptr) {
210 do_free(ptr);
211}
212
213/*
214Local Variables:
215c-basic-offset:2
216comment-column:40
8e93ddd1
RK
217fill-column:79
218indent-tabs-mode:nil
460b9539 219End:
220*/