0d292ca05295ef9356363e9d6dae0cca3ea47ace
[libfirm] / include / libfirm / adt / xmalloc.h
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       never failing wrappers for malloc() & friends.
23  * @author      Markus Armbruster
24  * @version     $Id$
25  * @note        The functions here never fail because they simply abort your
26  *              program in case of an error.
27  */
28 #ifndef FIRM_ADT_XMALLOC_H
29 #define FIRM_ADT_XMALLOC_H
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #include <stddef.h>
36 #include <stdlib.h>
37
38 /* xmalloc() & friends. */
39
40 void *xmalloc(size_t size);
41 void *xrealloc(void *ptr, size_t size);
42 char *xstrdup(const char *str);
43
44 #define xfree(ptr)      free(ptr)
45
46 /**
47  * Allocate n objects of a certain type
48  */
49 #define XMALLOCN(type, n) ((type*)xmalloc(sizeof(type) * (n)))
50
51 /**
52  * Allocate n objects of a certain type and zero them
53  */
54 #define XMALLOCNZ(type, n) ((type*)memset(xmalloc(sizeof(type) * (n)), 0, sizeof(type) * (n)))
55
56 /**
57  * Allocate one object of a certain type
58  */
59 #define XMALLOC(type) XMALLOCN(type, 1)
60
61 /**
62  * Allocate one object of a certain type and zero it
63  */
64 #define XMALLOCZ(type) XMALLOCNZ(type, 1)
65
66 /**
67  * Reallocate n objects of a certain type
68  */
69 #define XREALLOC(ptr, type, n) ((type*)xrealloc(ptr, sizeof(type) * (n)))
70
71 /**
72  * Allocate an object with n elements of a flexible array member
73  */
74 #define XMALLOCF(type, member, n) ((type*)xmalloc(offsetof(type, member) + sizeof(((type*)0)->member) * (n)))
75
76 /**
77  * Allocate an object with n elements of a flexible array member and zero the
78  * whole object
79  */
80 #define XMALLOCFZ(type, member, n) ((type*)memset(xmalloc(offsetof(type, member) + sizeof(((type*)0)->member) * (n)), 0, offsetof(type, member) + sizeof(((type*)0)->member) * (n)))
81
82 /**
83  * Allocate n objects of a certain type on the stack
84  */
85 #define ALLOCAN(type, n) ((type*)alloca(sizeof(type) * (n)))
86
87 /**
88  * Allocate n objects of a certain type on the stack and zero them
89  */
90 #define ALLOCANZ(type, n) ((type*)memset((type*)alloca(sizeof(type) * (n)), 0, sizeof(type) * (n)))
91
92
93 /* Includes for alloca() */
94 #if defined(__FreeBSD__)
95 #include <stdlib.h>
96 #elif defined(_WIN32)
97 #include <malloc.h>
98 #endif
99 #ifdef HAVE_ALLOCA_H
100 #include <alloca.h>
101 #endif
102
103 #ifdef __cplusplus
104 }
105 #endif
106
107 #endif