dbus-memory.c 10.8 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
static dbus_bool_t guards = FALSE;
80
/** value stored in guard padding for debugging buffer overrun */
81
#define GUARD_VALUE 0xdeadbeef
82
/** size of the information about the block stored in guard mode */
83
#define GUARD_INFO_SIZE 8
84
/** size of the GUARD_VALUE-filled padding after the header info  */
85
#define GUARD_START_PAD 16
86
/** size of the GUARD_VALUE-filled padding at the end of the block */
87
#define GUARD_END_PAD 16
88
/** size of stuff at start of block */
89
#define GUARD_START_OFFSET (GUARD_START_PAD + GUARD_INFO_SIZE)
90
/** total extra size over the requested allocation for guard stuff */
91
#define GUARD_EXTRA_SIZE (GUARD_START_OFFSET + GUARD_END_PAD)
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
#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"));
108 109 110

      if (_dbus_getenv ("DBUS_MALLOC_GUARDS") != NULL)
        guards = TRUE;
111 112 113 114
      
      inited = TRUE;
    }
}
115

116 117 118
/**
 * Where the block came from.
 */
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
typedef enum
{
  SOURCE_UNKNOWN,
  SOURCE_MALLOC,
  SOURCE_REALLOC,
  SOURCE_MALLOC_ZERO,
  SOURCE_REALLOC_NULL
} BlockSource;

static const char*
source_string (BlockSource source)
{
  switch (source)
    {
    case SOURCE_UNKNOWN:
      return "unknown";
    case SOURCE_MALLOC:
      return "malloc";
    case SOURCE_REALLOC:
      return "realloc";
    case SOURCE_MALLOC_ZERO:
      return "malloc0";
    case SOURCE_REALLOC_NULL:
      return "realloc(NULL)";
    }
  _dbus_assert_not_reached ("Invalid malloc block source ID");
  return "invalid!";
}

static void
check_guards (void *free_block)
{
  if (free_block != NULL)
    {
      unsigned char *block = ((unsigned char*)free_block) - GUARD_START_OFFSET;
      size_t requested_bytes = *(dbus_uint32_t*)block;
      BlockSource source = *(dbus_uint32_t*)(block + 4);
      unsigned int i;
      dbus_bool_t failed;

      failed = FALSE;

#if 0
      _dbus_verbose ("Checking %d bytes request from source %s\n",
                     requested_bytes, source_string (source));
#endif
      
      i = GUARD_INFO_SIZE;
      while (i < GUARD_START_OFFSET)
        {
          dbus_uint32_t value = *(dbus_uint32_t*) &block[i];
          if (value != GUARD_VALUE)
            {
              _dbus_warn ("Block of %u bytes from %s had start guard value 0x%x at %d expected 0x%x\n",
                          requested_bytes, source_string (source),
                          value, i, GUARD_VALUE);
              failed = TRUE;
            }
          
          i += 4;
        }

      i = GUARD_START_OFFSET + requested_bytes;
      while (i < (GUARD_START_OFFSET + requested_bytes + GUARD_END_PAD))
        {
          dbus_uint32_t value = *(dbus_uint32_t*) &block[i];
          if (value != GUARD_VALUE)
            {
              _dbus_warn ("Block of %u bytes from %s had end guard value 0x%x at %d expected 0x%x\n",
                          requested_bytes, source_string (source),
                          value, i, GUARD_VALUE);
              failed = TRUE;
            }
          
          i += 4;
        }

      if (failed)
        _dbus_assert_not_reached ("guard value corruption");
    }
}

static void*
set_guards (void       *real_block,
            size_t      requested_bytes,
            BlockSource source)
{
  unsigned char *block = real_block;
  unsigned int i;
  
  if (block == NULL)
    return NULL;

  _dbus_assert (GUARD_START_OFFSET + GUARD_END_PAD == GUARD_EXTRA_SIZE);
  
  *((dbus_uint32_t*)block) = requested_bytes;
  *((dbus_uint32_t*)(block + 4)) = source;

  i = GUARD_INFO_SIZE;
  while (i < GUARD_START_OFFSET)
    {
      (*(dbus_uint32_t*) &block[i]) = GUARD_VALUE;
      
      i += 4;
    }

  i = GUARD_START_OFFSET + requested_bytes;
  while (i < (GUARD_START_OFFSET + requested_bytes + GUARD_END_PAD))
    {
      (*(dbus_uint32_t*) &block[i]) = GUARD_VALUE;
      
      i += 4;
    }
  
  check_guards (block + GUARD_START_OFFSET);
  
  return block + GUARD_START_OFFSET;
}

238 239
#endif

240 241
/**
 * Allocates the given number of bytes, as with standard
242 243
 * malloc(). Guaranteed to return #NULL if bytes is zero
 * on all platforms. Returns #NULL if the allocation fails.
244 245 246
 * The memory must be released with dbus_free().
 *
 * @param bytes number of bytes to allocate
247
 * @return allocated memory, or #NULL if the allocation fails.
248 249 250 251
 */
void*
dbus_malloc (size_t bytes)
{
252 253 254
#ifdef DBUS_BUILD_TESTS
  initialize_malloc_debug ();
  
255
  if (_dbus_decrement_fail_alloc_counter ())
256 257 258
    {
      if (fail_counts != -1)
	_dbus_set_fail_alloc_counter (fail_counts);
259 260

      _dbus_verbose (" FAILING malloc of %d bytes\n", bytes);
261 262 263 264
      
      return NULL;
    }
#endif
265
  
266 267
  if (bytes == 0) /* some system mallocs handle this, some don't */
    return NULL;
268
#if DBUS_BUILD_TESTS
269
  else if (fail_size != 0 && bytes > fail_size)
270
    return NULL;
271 272 273 274 275 276 277
  else if (guards)
    {
      void *block;

      block = malloc (bytes + GUARD_EXTRA_SIZE);
      return set_guards (block, bytes, SOURCE_MALLOC);
    }
278
#endif
279 280 281 282 283 284 285
  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
286
 * return #NULL if bytes is zero on all platforms. Returns #NULL if the
287 288 289
 * allocation fails.  The memory must be released with dbus_free().
 *
 * @param bytes number of bytes to allocate
290
 * @return allocated memory, or #NULL if the allocation fails.
291 292 293 294
 */
void*
dbus_malloc0 (size_t bytes)
{
295 296 297
#ifdef DBUS_BUILD_TESTS
  initialize_malloc_debug ();
  
298
  if (_dbus_decrement_fail_alloc_counter ())
299 300 301
    {
      if (fail_counts != -1)
	_dbus_set_fail_alloc_counter (fail_counts);
302 303

      _dbus_verbose (" FAILING malloc0 of %d bytes\n", bytes);
304 305 306 307
      
      return NULL;
    }
#endif
308

309 310
  if (bytes == 0)
    return NULL;
311
#if DBUS_BUILD_TESTS
312
  else if (fail_size != 0 && bytes > fail_size)
313
    return NULL;
314 315 316 317 318 319 320
  else if (guards)
    {
      void *block;

      block = calloc (bytes + GUARD_EXTRA_SIZE, 1);
      return set_guards (block, bytes, SOURCE_MALLOC_ZERO);
    }
321
#endif
322 323 324 325 326 327
  else
    return calloc (bytes, 1);
}

/**
 * Resizes a block of memory previously allocated by dbus_malloc() or
328 329
 * dbus_malloc0(). Guaranteed to free the memory and return #NULL if bytes
 * is zero on all platforms. Returns #NULL if the resize fails.
330 331 332 333
 * If the resize fails, the memory is not freed.
 *
 * @param memory block to be resized
 * @param bytes new size of the memory block
334
 * @return allocated memory, or #NULL if the resize fails.
335 336 337 338 339
 */
void*
dbus_realloc (void  *memory,
              size_t bytes)
{
340 341 342
#ifdef DBUS_BUILD_TESTS
  initialize_malloc_debug ();
  
343
  if (_dbus_decrement_fail_alloc_counter ())
344 345 346
    {
      if (fail_counts != -1)
	_dbus_set_fail_alloc_counter (fail_counts);
347 348

      _dbus_verbose (" FAILING realloc of %d bytes\n", bytes);
349 350 351 352
      
      return NULL;
    }
#endif
353
  
354 355 356 357 358
  if (bytes == 0) /* guarantee this is safe */
    {
      dbus_free (memory);
      return NULL;
    }
359
#if DBUS_BUILD_TESTS
360
  else if (fail_size != 0 && bytes > fail_size)
361
    return NULL;
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
  else if (guards)
    {
      if (memory)
        {
          void *block;
          
          check_guards (memory);
          
          block = realloc (((unsigned char*)memory) - GUARD_START_OFFSET,
                           bytes + GUARD_EXTRA_SIZE);
          
          /* old guards shouldn't have moved */
          check_guards (((unsigned char*)block) + GUARD_START_OFFSET);
          
          return set_guards (block, bytes, SOURCE_REALLOC);
        }
      else
        {
          void *block;
          
          block = malloc (bytes + GUARD_EXTRA_SIZE);
          return set_guards (block, bytes, SOURCE_REALLOC_NULL);   
        }
    }
386
#endif
387 388 389 390 391 392 393 394
  else
    {
      return realloc (memory, bytes);
    }
}

/**
 * Frees a block of memory previously allocated by dbus_malloc() or
395
 * dbus_malloc0(). If passed #NULL, does nothing.
396 397 398 399 400 401
 * 
 * @param memory block to be freed
 */
void
dbus_free (void  *memory)
{
402 403 404 405 406 407 408 409 410 411
#ifdef DBUS_BUILD_TESTS
  if (guards)
    {
      check_guards (memory);
      if (memory)
        free (((unsigned char*)memory) - GUARD_START_OFFSET);
      return;
    }
#endif
    
412 413 414 415
  if (memory) /* we guarantee it's safe to free (NULL) */
    free (memory);
}

416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
/**
 * 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);
    }
}

440
/** @} */