2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief never failing wrappers for malloc() & friends.
23 * @author Markus Armbruster
24 * @note The functions here never fail because they simply abort your
25 * program in case of an error.
27 #ifndef FIRM_ADT_XMALLOC_H
28 #define FIRM_ADT_XMALLOC_H
34 /* Includes for alloca() */
43 * @defgroup xmalloc Memory Allocation
48 * Allocate @p size bytes on the heap.
49 * This is a wrapper for malloc which calls panic() in case of errors, so no
50 * error handling is required for code using it.
52 FIRM_API void *xmalloc(size_t size);
54 * Chane size of a previously allocated memory block to @p size bytes.
55 * This is a wrapper for realloc which calls panic() in case of errors, so no
56 * error handling is required for code using it.
58 FIRM_API void *xrealloc(void *ptr, size_t size);
60 * Allocates memory and copies string @p str into it.
61 * This is a wrapper for strdup which calls panic() in case of errors, so no
62 * error handling is required for code using it.
64 FIRM_API char *xstrdup(const char *str);
66 * Another name for the free function
69 #define xfree(ptr) free(ptr)
72 * Allocate n objects of a certain type
74 #define XMALLOCN(type, n) ((type*)xmalloc(sizeof(type) * (n)))
77 * Allocate n objects of a certain type and zero them
79 #define XMALLOCNZ(type, n) ((type*)memset(xmalloc(sizeof(type) * (n)), 0, sizeof(type) * (n)))
82 * Allocate one object of a certain type
84 #define XMALLOC(type) XMALLOCN(type, 1)
87 * Allocate one object of a certain type and zero it
89 #define XMALLOCZ(type) XMALLOCNZ(type, 1)
92 * Reallocate n objects of a certain type
94 #define XREALLOC(ptr, type, n) ((type*)xrealloc(ptr, sizeof(type) * (n)))
97 * Allocate an object with n elements of a flexible array member
99 #define XMALLOCF(type, member, n) ((type*)xmalloc(offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
102 * Allocate an object with n elements of a flexible array member and zero the
105 #define XMALLOCFZ(type, member, n) ((type*)memset(XMALLOCF(type, member, (n)), 0, offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
108 * Allocate n objects of a certain type on the stack
110 #define ALLOCAN(type, n) ((type*)alloca(sizeof(type) * (n)))
113 * Allocate n objects of a certain type on the stack and zero them
115 #define ALLOCANZ(type, n) ((type*)memset((type*)alloca(sizeof(type) * (n)), 0, sizeof(type) * (n)))
118 * Allocate n objects of a certain type on the given obstack
120 #define OALLOCN(obst, type, n) ((type*)obstack_alloc((obst), sizeof(type) * (n)))
123 * Allocate n objects of a certain type on the given obstack and zero them
125 #define OALLOCNZ(obst, type, n) ((type*)memset(OALLOCN((obst), type, (n)), 0, sizeof(type) * (n)))
128 * Allocate one object of a certain type on the given obstack
130 #define OALLOC(obst, type) OALLOCN(obst, type, 1)
133 * Allocate one object of a certain type on the given obstack and zero it
135 #define OALLOCZ(obst, type) OALLOCNZ(obst, type, 1)
138 * Allocate an object with n elements of a flexible array member on the given
141 #define OALLOCF(obst, type, member, n) ((type*)obstack_alloc((obst), offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
144 * Allocate an object with n elements of a flexible array member on the given
145 * obstack and zero the whole object
147 #define OALLOCFZ(obst, type, member, n) ((type*)memset(OALLOCF((obst), type, member, (n)), 0, offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))