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  * @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 #include <stddef.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34
  35 /* Includes for alloca() */
  36 #ifdef _WIN32
  37 #include <malloc.h>
  38 #endif
  39
  40 #include "../begin.h"
  41
  42 /* xmalloc() & friends. */
  43
  44 FIRM_API void *xmalloc(size_t size);
  45 FIRM_API void *xrealloc(void *ptr, size_t size);
  46 FIRM_API char *xstrdup(const char *str);
  47
  48 #define xfree(ptr)      free(ptr)
  49
  50 /**
  51  * Allocate n objects of a certain type
  52  */
  53 #define XMALLOCN(type, n) ((type*)xmalloc(sizeof(type) * (n)))
  54
  55 /**
  56  * Allocate n objects of a certain type and zero them
  57  */
  58 #define XMALLOCNZ(type, n) ((type*)memset(xmalloc(sizeof(type) * (n)), 0, sizeof(type) * (n)))
  59
  60 /**
  61  * Allocate one object of a certain type
  62  */
  63 #define XMALLOC(type) XMALLOCN(type, 1)
  64
  65 /**
  66  * Allocate one object of a certain type and zero it
  67  */
  68 #define XMALLOCZ(type) XMALLOCNZ(type, 1)
  69
  70 /**
  71  * Reallocate n objects of a certain type
  72  */
  73 #define XREALLOC(ptr, type, n) ((type*)xrealloc(ptr, sizeof(type) * (n)))
  74
  75 /**
  76  * Allocate an object with n elements of a flexible array member
  77  */
  78 #define XMALLOCF(type, member, n) ((type*)xmalloc(offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
  79
  80 /**
  81  * Allocate an object with n elements of a flexible array member and zero the
  82  * whole object
  83  */
  84 #define XMALLOCFZ(type, member, n) ((type*)memset(XMALLOCF(type, member, (n)), 0, offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
  85
  86 /**
  87  * Allocate n objects of a certain type on the stack
  88  */
  89 #define ALLOCAN(type, n) ((type*)alloca(sizeof(type) * (n)))
  90
  91 /**
  92  * Allocate n objects of a certain type on the stack and zero them
  93  */
  94 #define ALLOCANZ(type, n) ((type*)memset((type*)alloca(sizeof(type) * (n)), 0, sizeof(type) * (n)))
  95
  96 /**
  97  * Allocate n objects of a certain type on the given obstack
  98  */
  99 #define OALLOCN(obst, type, n) ((type*)obstack_alloc((obst), sizeof(type) * (n)))
 100
 101 /**
 102  * Allocate n objects of a certain type on the given obstack and zero them
 103  */
 104 #define OALLOCNZ(obst, type, n) ((type*)memset(OALLOCN((obst), type, (n)), 0, sizeof(type) * (n)))
 105
 106 /**
 107  * Allocate one object of a certain type on the given obstack
 108  */
 109 #define OALLOC(obst, type) OALLOCN(obst, type, 1)
 110
 111 /**
 112  * Allocate one object of a certain type on the given obstack and zero it
 113  */
 114 #define OALLOCZ(obst, type) OALLOCNZ(obst, type, 1)
 115
 116 /**
 117  * Allocate an object with n elements of a flexible array member on the given
 118  * obstck
 119  */
 120 #define OALLOCF(obst, type, member, n) ((type*)obstack_alloc((obst), offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
 121
 122 /**
 123  * Allocate an object with n elements of a flexible array member on the given
 124  * obstack and zero the whole object
 125  */
 126 #define OALLOCFZ(obst, type, member, n) ((type*)memset(OALLOCF((obst), type, member, (n)), 0, offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
 127
 128
 129 #include "../end.h"
 130
 131 #endif