nsz Git - libfirm/blob - 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  * @note        The functions here never fail because they simply abort your
  25  *              program in case of an error.
  26  */
  27 #ifndef FIRM_ADT_XMALLOC_H
  28 #define FIRM_ADT_XMALLOC_H
  29
  30 #include <stddef.h>
  31 #include <stdlib.h>
  32 #include <string.h>
  33
  34 /* Includes for alloca() */
  35 #ifdef _WIN32
  36 #include <malloc.h>
  37 #endif
  38
  39 #include "../begin.h"
  40
  41 /**
  42  * @ingroup adt
  43  * @defgroup xmalloc Memory Allocation
  44  * @{
  45  */
  46
  47 /**
  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.
  51  */
  52 FIRM_API void *xmalloc(size_t size);
  53 /**
  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.
  57  */
  58 FIRM_API void *xrealloc(void *ptr, size_t size);
  59 /**
  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.
  63  */
  64 FIRM_API char *xstrdup(const char *str);
  65 /**
  66  * Another name for the free function
  67  * @deprecated
  68  */
  69 #define xfree(ptr)      free(ptr)
  70
  71 /**
  72  * Allocate n objects of a certain type
  73  */
  74 #define XMALLOCN(type, n) ((type*)xmalloc(sizeof(type) * (n)))
  75
  76 /**
  77  * Allocate n objects of a certain type and zero them
  78  */
  79 #define XMALLOCNZ(type, n) ((type*)memset(xmalloc(sizeof(type) * (n)), 0, sizeof(type) * (n)))
  80
  81 /**
  82  * Allocate one object of a certain type
  83  */
  84 #define XMALLOC(type) XMALLOCN(type, 1)
  85
  86 /**
  87  * Allocate one object of a certain type and zero it
  88  */
  89 #define XMALLOCZ(type) XMALLOCNZ(type, 1)
  90
  91 /**
  92  * Reallocate n objects of a certain type
  93  */
  94 #define XREALLOC(ptr, type, n) ((type*)xrealloc(ptr, sizeof(type) * (n)))
  95
  96 /**
  97  * Allocate an object with n elements of a flexible array member
  98  */
  99 #define XMALLOCF(type, member, n) ((type*)xmalloc(offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
 100
 101 /**
 102  * Allocate an object with n elements of a flexible array member and zero the
 103  * whole object
 104  */
 105 #define XMALLOCFZ(type, member, n) ((type*)memset(XMALLOCF(type, member, (n)), 0, offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
 106
 107 /**
 108  * Allocate n objects of a certain type on the stack
 109  */
 110 #define ALLOCAN(type, n) ((type*)alloca(sizeof(type) * (n)))
 111
 112 /**
 113  * Allocate n objects of a certain type on the stack and zero them
 114  */
 115 #define ALLOCANZ(type, n) ((type*)memset((type*)alloca(sizeof(type) * (n)), 0, sizeof(type) * (n)))
 116
 117 /**
 118  * Allocate n objects of a certain type on the given obstack
 119  */
 120 #define OALLOCN(obst, type, n) ((type*)obstack_alloc((obst), sizeof(type) * (n)))
 121
 122 /**
 123  * Allocate n objects of a certain type on the given obstack and zero them
 124  */
 125 #define OALLOCNZ(obst, type, n) ((type*)memset(OALLOCN((obst), type, (n)), 0, sizeof(type) * (n)))
 126
 127 /**
 128  * Allocate one object of a certain type on the given obstack
 129  */
 130 #define OALLOC(obst, type) OALLOCN(obst, type, 1)
 131
 132 /**
 133  * Allocate one object of a certain type on the given obstack and zero it
 134  */
 135 #define OALLOCZ(obst, type) OALLOCNZ(obst, type, 1)
 136
 137 /**
 138  * Allocate an object with n elements of a flexible array member on the given
 139  * obstck
 140  */
 141 #define OALLOCF(obst, type, member, n) ((type*)obstack_alloc((obst), offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
 142
 143 /**
 144  * Allocate an object with n elements of a flexible array member on the given
 145  * obstack and zero the whole object
 146  */
 147 #define OALLOCFZ(obst, type, member, n) ((type*)memset(OALLOCF((obst), type, member, (n)), 0, offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
 148
 149 /** @} */
 150
 151 #include "../end.h"
 152
 153 #endif