dbus-memory.c 5.83 KB
Newer Older
1 2 3
/* -*- mode: C; c-file-style: "gnu" -*- */
/* dbus-memory.c  D-BUS memory handling
 *
4
 * Copyright (C) 2002, 2003  Red Hat Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * Licensed under the Academic Free License version 1.2
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#include "dbus-memory.h"
25
#include "dbus-internals.h"
26 27
#include <stdlib.h>

28

29
/**
30
 * @defgroup DBusMemory Memory Allocation
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
 * @ingroup  DBus
 * @brief dbus_malloc(), dbus_free(), etc.
 *
 * Functions and macros related to allocating and releasing
 * blocks of memory.
 *
 * @{
 */

/**
 * @def dbus_new
 *
 * Safe macro for using dbus_malloc(). Accepts the type
 * to allocate and the number of type instances to
 * allocate as arguments, and returns a memory block
 * cast to the desired type, instead of as a void*.
 *
 * @param type type name to allocate
 * @param count number of instances in the allocated array
50
 * @returns the new memory block or #NULL on failure
51 52 53 54 55 56 57 58 59 60 61 62 63
 */

/**
 * @def dbus_new0
 *
 * Safe macro for using dbus_malloc0(). Accepts the type
 * to allocate and the number of type instances to
 * allocate as arguments, and returns a memory block
 * cast to the desired type, instead of as a void*.
 * The allocated array is initialized to all-bits-zero.
 *
 * @param type type name to allocate
 * @param count number of instances in the allocated array
64
 * @returns the new memory block or #NULL on failure
65 66
 */

67 68 69 70 71 72 73 74
/**
 * @typedef DBusFreeFunction
 *
 * The type of a function which frees a block of memory.
 *
 * @param memory the memory to free
 */

75 76 77
#ifdef DBUS_BUILD_TESTS
static dbus_bool_t inited = FALSE;
static int fail_counts = -1;
78
static size_t fail_size = 0;
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
#endif

#ifdef DBUS_BUILD_TESTS
static void
initialize_malloc_debug (void)
{
  if (!inited)
    {
      if (_dbus_getenv ("DBUS_MALLOC_FAIL_NTH") != NULL)
	{
	  fail_counts = atoi (_dbus_getenv ("DBUS_MALLOC_FAIL_NTH"));
	  _dbus_set_fail_alloc_counter (fail_counts);
	}
      
      if (_dbus_getenv ("DBUS_MALLOC_FAIL_GREATER_THAN") != NULL)
	fail_size = atoi (_dbus_getenv ("DBUS_MALLOC_FAIL_GREATER_THAN"));
      
      inited = TRUE;
    }
}
#endif

101 102
/**
 * Allocates the given number of bytes, as with standard
103 104
 * malloc(). Guaranteed to return #NULL if bytes is zero
 * on all platforms. Returns #NULL if the allocation fails.
105 106 107
 * The memory must be released with dbus_free().
 *
 * @param bytes number of bytes to allocate
108
 * @return allocated memory, or #NULL if the allocation fails.
109 110 111 112
 */
void*
dbus_malloc (size_t bytes)
{
113 114 115
#ifdef DBUS_BUILD_TESTS
  initialize_malloc_debug ();
  
116
  if (_dbus_decrement_fail_alloc_counter ())
117 118 119 120 121 122 123
    {
      if (fail_counts != -1)
	_dbus_set_fail_alloc_counter (fail_counts);
      
      return NULL;
    }
#endif
124
  
125 126
  if (bytes == 0) /* some system mallocs handle this, some don't */
    return NULL;
127
#if DBUS_BUILD_TESTS
128
  else if (fail_size != 0 && bytes > fail_size)
129 130
    return NULL;
#endif
131 132 133 134 135 136 137
  else
    return malloc (bytes);
}

/**
 * Allocates the given number of bytes, as with standard malloc(), but
 * all bytes are initialized to zero as with calloc(). Guaranteed to
138
 * return #NULL if bytes is zero on all platforms. Returns #NULL if the
139 140 141
 * allocation fails.  The memory must be released with dbus_free().
 *
 * @param bytes number of bytes to allocate
142
 * @return allocated memory, or #NULL if the allocation fails.
143 144 145 146
 */
void*
dbus_malloc0 (size_t bytes)
{
147 148 149
#ifdef DBUS_BUILD_TESTS
  initialize_malloc_debug ();
  
150
  if (_dbus_decrement_fail_alloc_counter ())
151 152 153 154 155 156 157
    {
      if (fail_counts != -1)
	_dbus_set_fail_alloc_counter (fail_counts);
      
      return NULL;
    }
#endif
158

159 160
  if (bytes == 0)
    return NULL;
161
#if DBUS_BUILD_TESTS
162
  else if (fail_size != 0 && bytes > fail_size)
163 164
    return NULL;
#endif
165 166 167 168 169 170
  else
    return calloc (bytes, 1);
}

/**
 * Resizes a block of memory previously allocated by dbus_malloc() or
171 172
 * dbus_malloc0(). Guaranteed to free the memory and return #NULL if bytes
 * is zero on all platforms. Returns #NULL if the resize fails.
173 174 175 176
 * If the resize fails, the memory is not freed.
 *
 * @param memory block to be resized
 * @param bytes new size of the memory block
177
 * @return allocated memory, or #NULL if the resize fails.
178 179 180 181 182
 */
void*
dbus_realloc (void  *memory,
              size_t bytes)
{
183 184 185
#ifdef DBUS_BUILD_TESTS
  initialize_malloc_debug ();
  
186
  if (_dbus_decrement_fail_alloc_counter ())
187 188 189 190 191 192 193
    {
      if (fail_counts != -1)
	_dbus_set_fail_alloc_counter (fail_counts);
      
      return NULL;
    }
#endif
194
  
195 196 197 198 199
  if (bytes == 0) /* guarantee this is safe */
    {
      dbus_free (memory);
      return NULL;
    }
200
#if DBUS_BUILD_TESTS
201
  else if (fail_size != 0 && bytes > fail_size)
202 203
    return NULL;
#endif
204 205 206 207 208 209 210 211
  else
    {
      return realloc (memory, bytes);
    }
}

/**
 * Frees a block of memory previously allocated by dbus_malloc() or
212
 * dbus_malloc0(). If passed #NULL, does nothing.
213 214 215 216 217 218 219 220 221 222
 * 
 * @param memory block to be freed
 */
void
dbus_free (void  *memory)
{
  if (memory) /* we guarantee it's safe to free (NULL) */
    free (memory);
}

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
/**
 * Frees a #NULL-terminated array of strings.
 * If passed #NULL, does nothing.
 *
 * @param str_array the array to be freed
 */
void
dbus_free_string_array (char **str_array)
{
  if (str_array)
    {
      int i;

      i = 0;
      while (str_array[i])
	{
	  dbus_free (str_array[i]);
	  i++;
	}

      dbus_free (str_array);
    }
}

247
/** @} */