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() */
38 #if defined(__linux__) || defined(__APPLE__)
46 * @defgroup xmalloc Memory Allocation
51 * Allocate @p size bytes on the heap.
52 * This is a wrapper for malloc which calls panic() in case of errors, so no
53 * error handling is required for code using it.
55 FIRM_API void *xmalloc(size_t size);
57 * Chane size of a previously allocated memory block to @p size bytes.
58 * This is a wrapper for realloc which calls panic() in case of errors, so no
59 * error handling is required for code using it.
61 FIRM_API void *xrealloc(void *ptr, size_t size);
63 * Allocates memory and copies string @p str into it.
64 * This is a wrapper for strdup which calls panic() in case of errors, so no
65 * error handling is required for code using it.
67 FIRM_API char *xstrdup(const char *str);
69 * Another name for the free function
72 #define xfree(ptr) free(ptr)
75 * Allocate n objects of a certain type
77 #define XMALLOCN(type, n) ((type*)xmalloc(sizeof(type) * (n)))
80 * Allocate n objects of a certain type and zero them
82 #define XMALLOCNZ(type, n) ((type*)memset(xmalloc(sizeof(type) * (n)), 0, sizeof(type) * (n)))
85 * Allocate one object of a certain type
87 #define XMALLOC(type) XMALLOCN(type, 1)
90 * Allocate one object of a certain type and zero it
92 #define XMALLOCZ(type) XMALLOCNZ(type, 1)
95 * Reallocate n objects of a certain type
97 #define XREALLOC(ptr, type, n) ((type*)xrealloc(ptr, sizeof(type) * (n)))
100 * Allocate an object with n elements of a flexible array member
102 #define XMALLOCF(type, member, n) ((type*)xmalloc(offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
105 * Allocate an object with n elements of a flexible array member and zero the
108 #define XMALLOCFZ(type, member, n) ((type*)memset(XMALLOCF(type, member, (n)), 0, offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
111 * Allocate n objects of a certain type on the stack
113 #define ALLOCAN(type, n) ((type*)alloca(sizeof(type) * (n)))
116 * Allocate n objects of a certain type on the stack and zero them
118 #define ALLOCANZ(type, n) ((type*)memset((type*)alloca(sizeof(type) * (n)), 0, sizeof(type) * (n)))
121 * Allocate n objects of a certain type on the given obstack
123 #define OALLOCN(obst, type, n) ((type*)obstack_alloc((obst), sizeof(type) * (n)))
126 * Allocate n objects of a certain type on the given obstack and zero them
128 #define OALLOCNZ(obst, type, n) ((type*)memset(OALLOCN((obst), type, (n)), 0, sizeof(type) * (n)))
131 * Allocate one object of a certain type on the given obstack
133 #define OALLOC(obst, type) OALLOCN(obst, type, 1)
136 * Allocate one object of a certain type on the given obstack and zero it
138 #define OALLOCZ(obst, type) OALLOCNZ(obst, type, 1)
141 * Allocate an object with n elements of a flexible array member on the given
144 #define OALLOCF(obst, type, member, n) ((type*)obstack_alloc((obst), offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
147 * Allocate an object with n elements of a flexible array member on the given
148 * obstack and zero the whole object
150 #define OALLOCFZ(obst, type, member, n) ((type*)memset(OALLOCF((obst), type, member, (n)), 0, offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))