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