dbus-memory.c 17.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
#include "dbus-sysdeps.h"
27
#include "dbus-list.h"
28 29 30
#include <stdlib.h>

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

/**
 * @defgroup DBusMemoryInternals Memory allocation implementation details
 * @ingroup  DBusInternals
 * @brief internals of dbus_malloc() etc.
 *
 * Implementation details related to allocating and releasing blocks
 * of memory.
 */

/**
 * @addtogroup DBusMemory
 *
52 53 54 55 56 57 58 59 60 61 62 63 64
 * @{
 */

/**
 * @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
65
 * @returns the new memory block or #NULL on failure
66 67 68 69 70 71 72 73 74 75 76 77 78
 */

/**
 * @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
79
 * @returns the new memory block or #NULL on failure
80 81
 */

82 83 84 85 86 87 88 89
/**
 * @typedef DBusFreeFunction
 *
 * The type of a function which frees a block of memory.
 *
 * @param memory the memory to free
 */

90 91 92 93 94 95 96 97
/** @} */ /* end of public API docs */

/**
 * @addtogroup DBusMemoryInternals
 *
 * @{
 */

98
#ifdef DBUS_BUILD_TESTS
99
static dbus_bool_t debug_initialized = FALSE;
100
static int fail_nth = -1;
101
static size_t fail_size = 0;
102
static int fail_alloc_counter = _DBUS_INT_MAX;
103 104
static int n_failures_per_failure = 1;
static int n_failures_this_failure = 0;
105
static dbus_bool_t guards = FALSE;
106
static dbus_bool_t disable_mem_pools = FALSE;
107
static dbus_bool_t backtrace_on_fail_alloc = FALSE;
108
static int n_blocks_outstanding = 0;
109

110
/** value stored in guard padding for debugging buffer overrun */
111
#define GUARD_VALUE 0xdeadbeef
112
/** size of the information about the block stored in guard mode */
113
#define GUARD_INFO_SIZE 8
114
/** size of the GUARD_VALUE-filled padding after the header info  */
115
#define GUARD_START_PAD 16
116
/** size of the GUARD_VALUE-filled padding at the end of the block */
117
#define GUARD_END_PAD 16
118
/** size of stuff at start of block */
119
#define GUARD_START_OFFSET (GUARD_START_PAD + GUARD_INFO_SIZE)
120
/** total extra size over the requested allocation for guard stuff */
121
#define GUARD_EXTRA_SIZE (GUARD_START_OFFSET + GUARD_END_PAD)
122 123

static void
124
_dbus_initialize_malloc_debug (void)
125
{
126
  if (!debug_initialized)
127
    {
128 129
      debug_initialized = TRUE;
      
130 131
      if (_dbus_getenv ("DBUS_MALLOC_FAIL_NTH") != NULL)
	{
132 133 134
	  fail_nth = atoi (_dbus_getenv ("DBUS_MALLOC_FAIL_NTH"));
          fail_alloc_counter = fail_nth;
          _dbus_verbose ("Will fail malloc every %d times\n", fail_nth);
135 136 137
	}
      
      if (_dbus_getenv ("DBUS_MALLOC_FAIL_GREATER_THAN") != NULL)
138 139 140 141 142
        {
          fail_size = atoi (_dbus_getenv ("DBUS_MALLOC_FAIL_GREATER_THAN"));
          _dbus_verbose ("Will fail mallocs over %d bytes\n",
                         fail_size);
        }
143 144

      if (_dbus_getenv ("DBUS_MALLOC_GUARDS") != NULL)
145 146 147 148 149 150 151 152 153 154
        {
          guards = TRUE;
          _dbus_verbose ("Will use malloc guards\n");
        }

      if (_dbus_getenv ("DBUS_DISABLE_MEM_POOLS") != NULL)
        {
          disable_mem_pools = TRUE;
          _dbus_verbose ("Will disable memory pools\n");
        }
155 156 157 158 159 160

      if (_dbus_getenv ("DBUS_MALLOC_BACKTRACES") != NULL)
        {
          backtrace_on_fail_alloc = TRUE;
          _dbus_verbose ("Will backtrace on failing a malloc\n");
        }
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
    }
}

/**
 * Whether to turn off mem pools, useful for leak checking.
 *
 * @returns #TRUE if mempools should not be used.
 */
dbus_bool_t
_dbus_disable_mem_pools (void)
{
  _dbus_initialize_malloc_debug ();
  return disable_mem_pools;
}

/**
 * Sets the number of allocations until we simulate a failed
 * allocation. If set to 0, the next allocation to run
 * fails; if set to 1, one succeeds then the next fails; etc.
 * Set to _DBUS_INT_MAX to not fail anything. 
 *
 * @param until_next_fail number of successful allocs before one fails
 */
void
_dbus_set_fail_alloc_counter (int until_next_fail)
{
  _dbus_initialize_malloc_debug ();

  fail_alloc_counter = until_next_fail;

191
#if 0
192
  _dbus_verbose ("Set fail alloc counter = %d\n", fail_alloc_counter);
193
#endif
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
}

/**
 * Gets the number of successful allocs until we'll simulate
 * a failed alloc.
 *
 * @returns current counter value
 */
int
_dbus_get_fail_alloc_counter (void)
{
  _dbus_initialize_malloc_debug ();

  return fail_alloc_counter;
}

210 211 212 213
/**
 * Sets how many mallocs to fail when the fail alloc counter reaches
 * 0.
 *
214
 * @param failures_per_failure number to fail
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
 */
void
_dbus_set_fail_alloc_failures (int failures_per_failure)
{
  n_failures_per_failure = failures_per_failure;
}

/**
 * Gets the number of failures we'll have when the fail malloc
 * counter reaches 0.
 *
 * @returns number of failures planned
 */
int
_dbus_get_fail_alloc_failures (void)
{
  return n_failures_per_failure;
}

234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
/**
 * Called when about to alloc some memory; if
 * it returns #TRUE, then the allocation should
 * fail. If it returns #FALSE, then the allocation
 * should not fail.
 *
 * @returns #TRUE if this alloc should fail
 */
dbus_bool_t
_dbus_decrement_fail_alloc_counter (void)
{
  _dbus_initialize_malloc_debug ();
  
  if (fail_alloc_counter <= 0)
    {
249 250
      if (backtrace_on_fail_alloc)
        _dbus_print_backtrace ();
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265

      _dbus_verbose ("failure %d\n", n_failures_this_failure);
      
      n_failures_this_failure += 1;
      if (n_failures_this_failure >= n_failures_per_failure)
        {
          if (fail_nth >= 0)
            fail_alloc_counter = fail_nth;
          else
            fail_alloc_counter = _DBUS_INT_MAX;

          n_failures_this_failure = 0;

          _dbus_verbose ("reset fail alloc counter to %d\n", fail_alloc_counter);
        }
266
      
267 268 269 270 271 272
      return TRUE;
    }
  else
    {
      fail_alloc_counter -= 1;
      return FALSE;
273 274
    }
}
275

276 277 278 279 280 281 282 283 284 285 286
/**
 * Get the number of outstanding malloc()'d blocks.
 *
 * @returns number of blocks
 */
int
_dbus_get_malloc_blocks_outstanding (void)
{
  return n_blocks_outstanding;
}

287 288 289
/**
 * Where the block came from.
 */
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
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;
}

409 410
#endif

411 412 413 414 415 416 417 418 419
/** @} */ /* End of internals docs */


/**
 * @addtogroup DBusMemory
 *
 * @{
 */

420 421
/**
 * Allocates the given number of bytes, as with standard
422 423
 * malloc(). Guaranteed to return #NULL if bytes is zero
 * on all platforms. Returns #NULL if the allocation fails.
424 425 426
 * The memory must be released with dbus_free().
 *
 * @param bytes number of bytes to allocate
427
 * @return allocated memory, or #NULL if the allocation fails.
428 429 430 431
 */
void*
dbus_malloc (size_t bytes)
{
432
#ifdef DBUS_BUILD_TESTS
433
  _dbus_initialize_malloc_debug ();
434
  
435
  if (_dbus_decrement_fail_alloc_counter ())
436
    {
437
      _dbus_verbose (" FAILING malloc of %d bytes\n", bytes);
438 439 440 441
      
      return NULL;
    }
#endif
442
  
443 444
  if (bytes == 0) /* some system mallocs handle this, some don't */
    return NULL;
445
#if DBUS_BUILD_TESTS
446
  else if (fail_size != 0 && bytes > fail_size)
447
    return NULL;
448 449 450 451 452
  else if (guards)
    {
      void *block;

      block = malloc (bytes + GUARD_EXTRA_SIZE);
453 454 455
      if (block)
        n_blocks_outstanding += 1;
      
456 457
      return set_guards (block, bytes, SOURCE_MALLOC);
    }
458
#endif
459
  else
460 461 462 463 464 465 466 467 468
    {
      void *mem;
      mem = malloc (bytes);
#ifdef DBUS_BUILD_TESTS
      if (mem)
        n_blocks_outstanding += 1;
#endif
      return mem;
    }
469 470 471 472 473
}

/**
 * Allocates the given number of bytes, as with standard malloc(), but
 * all bytes are initialized to zero as with calloc(). Guaranteed to
474
 * return #NULL if bytes is zero on all platforms. Returns #NULL if the
475 476 477
 * allocation fails.  The memory must be released with dbus_free().
 *
 * @param bytes number of bytes to allocate
478
 * @return allocated memory, or #NULL if the allocation fails.
479 480 481 482
 */
void*
dbus_malloc0 (size_t bytes)
{
483
#ifdef DBUS_BUILD_TESTS
484
  _dbus_initialize_malloc_debug ();
485
  
486
  if (_dbus_decrement_fail_alloc_counter ())
487
    {
488
      _dbus_verbose (" FAILING malloc0 of %d bytes\n", bytes);
489 490 491 492
      
      return NULL;
    }
#endif
493

494 495
  if (bytes == 0)
    return NULL;
496
#if DBUS_BUILD_TESTS
497
  else if (fail_size != 0 && bytes > fail_size)
498
    return NULL;
499 500 501 502 503
  else if (guards)
    {
      void *block;

      block = calloc (bytes + GUARD_EXTRA_SIZE, 1);
504 505
      if (block)
        n_blocks_outstanding += 1;
506 507
      return set_guards (block, bytes, SOURCE_MALLOC_ZERO);
    }
508
#endif
509
  else
510 511 512 513 514 515 516 517 518
    {
      void *mem;
      mem = calloc (bytes, 1);
#ifdef DBUS_BUILD_TESTS
      if (mem)
        n_blocks_outstanding += 1;
#endif
      return mem;
    }
519 520 521 522
}

/**
 * Resizes a block of memory previously allocated by dbus_malloc() or
523 524
 * dbus_malloc0(). Guaranteed to free the memory and return #NULL if bytes
 * is zero on all platforms. Returns #NULL if the resize fails.
525 526 527 528
 * If the resize fails, the memory is not freed.
 *
 * @param memory block to be resized
 * @param bytes new size of the memory block
529
 * @return allocated memory, or #NULL if the resize fails.
530 531 532 533 534
 */
void*
dbus_realloc (void  *memory,
              size_t bytes)
{
535
#ifdef DBUS_BUILD_TESTS
536
  _dbus_initialize_malloc_debug ();
537
  
538
  if (_dbus_decrement_fail_alloc_counter ())
539
    {
540
      _dbus_verbose (" FAILING realloc of %d bytes\n", bytes);
541 542 543 544
      
      return NULL;
    }
#endif
545
  
546 547 548 549 550
  if (bytes == 0) /* guarantee this is safe */
    {
      dbus_free (memory);
      return NULL;
    }
551
#if DBUS_BUILD_TESTS
552
  else if (fail_size != 0 && bytes > fail_size)
553
    return NULL;
554 555 556 557 558 559 560 561 562 563
  else if (guards)
    {
      if (memory)
        {
          void *block;
          
          check_guards (memory);
          
          block = realloc (((unsigned char*)memory) - GUARD_START_OFFSET,
                           bytes + GUARD_EXTRA_SIZE);
564 565 566 567

          if (block)
            /* old guards shouldn't have moved */
            check_guards (((unsigned char*)block) + GUARD_START_OFFSET);
568 569 570 571 572 573 574 575
          
          return set_guards (block, bytes, SOURCE_REALLOC);
        }
      else
        {
          void *block;
          
          block = malloc (bytes + GUARD_EXTRA_SIZE);
576 577 578 579

          if (block)
            n_blocks_outstanding += 1;
          
580 581 582
          return set_guards (block, bytes, SOURCE_REALLOC_NULL);   
        }
    }
583
#endif
584 585
  else
    {
586 587 588 589 590 591 592
      void *mem;
      mem = realloc (memory, bytes);
#ifdef DBUS_BUILD_TESTS
      if (memory == NULL && mem != NULL)
        n_blocks_outstanding += 1;
#endif
      return mem;
593 594 595 596 597
    }
}

/**
 * Frees a block of memory previously allocated by dbus_malloc() or
598
 * dbus_malloc0(). If passed #NULL, does nothing.
599 600 601 602 603 604
 * 
 * @param memory block to be freed
 */
void
dbus_free (void  *memory)
{
605 606 607 608 609
#ifdef DBUS_BUILD_TESTS
  if (guards)
    {
      check_guards (memory);
      if (memory)
610 611 612 613 614 615 616 617
        {
          n_blocks_outstanding -= 1;
          
          _dbus_assert (n_blocks_outstanding >= 0);
          
          free (((unsigned char*)memory) - GUARD_START_OFFSET);
        }
      
618 619 620 621
      return;
    }
#endif
    
622
  if (memory) /* we guarantee it's safe to free (NULL) */
623 624 625 626 627 628 629 630 631
    {
#ifdef DBUS_BUILD_TESTS
      n_blocks_outstanding -= 1;
      
      _dbus_assert (n_blocks_outstanding >= 0);
#endif

      free (memory);
    }
632 633
}

634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
/**
 * 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);
    }
}

658 659 660 661 662 663 664 665 666
/** @} */ /* End of public API docs block */


/**
 * @addtogroup DBusMemoryInternals
 *
 * @{
 */

667 668 669 670 671 672 673 674
/**
 * _dbus_current_generation is used to track each
 * time that dbus_shutdown() is called, so we can
 * reinit things after it's been called. It is simply
 * incremented each time we shut down.
 */
int _dbus_current_generation = 1;

675 676 677
/**
 * Represents a function to be called on shutdown.
 */
678
typedef struct ShutdownClosure ShutdownClosure;
679

680 681 682
/**
 * This struct represents a function to be called on shutdown.
 */
683
struct ShutdownClosure
684
{
685 686 687
  ShutdownClosure *next;     /**< Next ShutdownClosure */
  DBusShutdownFunction func; /**< Function to call */
  void *data;                /**< Data for function */
688 689 690 691
};

_DBUS_DEFINE_GLOBAL_LOCK (shutdown_funcs);
static ShutdownClosure *registered_globals = NULL;
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710

/**
 * Register a cleanup function to be called exactly once
 * the next time dbus_shutdown() is called.
 *
 * @param func the function
 * @param data data to pass to the function
 * @returns #FALSE on not enough memory
 */
dbus_bool_t
_dbus_register_shutdown_func (DBusShutdownFunction  func,
                              void                 *data)
{
  ShutdownClosure *c;

  c = dbus_new (ShutdownClosure, 1);

  if (c == NULL)
    return FALSE;
711

712 713 714
  c->func = func;
  c->data = data;

715 716 717 718
  _DBUS_LOCK (shutdown_funcs);
  
  c->next = registered_globals;
  registered_globals = c;
719

720 721
  _DBUS_UNLOCK (shutdown_funcs);
  
722 723 724
  return TRUE;
}

725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
/** @} */ /* End of private API docs block */


/**
 * @addtogroup DBusMemory
 *
 * @{
 */

/**
 * The D-BUS library keeps some internal global variables, for example
 * to cache the username of the current process.  This function is
 * used to free these global variables.  It is really useful only for
 * leak-checking cleanliness and the like. WARNING: this function is
 * NOT thread safe, it must be called while NO other threads are using
 * D-BUS. You cannot continue using D-BUS after calling this function,
 * as it does things like free global mutexes created by
 * dbus_threads_init(). To use a D-BUS function after calling
 * dbus_shutdown(), you have to start over from scratch, e.g. calling
 * dbus_threads_init() again.
 */
void
dbus_shutdown (void)
{
  while (registered_globals != NULL)
    {
      ShutdownClosure *c;

      c = registered_globals;
      registered_globals = c->next;
      
      (* c->func) (c->data);
      
      dbus_free (c);
    }

  _dbus_current_generation += 1;
}

/** @} */ /** End of public API docs block */