dbus/dbus-memory.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-memory.c  D-Bus memory handling
   3  *
   4  * Copyright (C) 2002, 2003  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  *
  22  */
  23
  24 #include <config.h>
  25 #include "dbus-memory.h"
  26 #include "dbus-internals.h"
  27 #include "dbus-sysdeps.h"
  28 #include "dbus-list.h"
  29 #include <stdlib.h>
  30
  31 /**
  32  * @defgroup DBusMemory Memory Allocation
  33  * @ingroup  DBus
  34  * @brief dbus_malloc(), dbus_free(), etc.
  35  *
  36  * Functions and macros related to allocating and releasing
  37  * blocks of memory.
  38  *
  39  */
  40
  41 /**
  42  * @defgroup DBusMemoryInternals Memory allocation implementation details
  43  * @ingroup  DBusInternals
  44  * @brief internals of dbus_malloc() etc.
  45  *
  46  * Implementation details related to allocating and releasing blocks
  47  * of memory.
  48  */
  49
  50 /**
  51  * @addtogroup DBusMemory
  52  *
  53  * @{
  54  */
  55
  56 /**
  57  * @def dbus_new
  58  *
  59  * Safe macro for using dbus_malloc(). Accepts the type
  60  * to allocate and the number of type instances to
  61  * allocate as arguments, and returns a memory block
  62  * cast to the desired type, instead of as a void*.
  63  *
  64  * @param type type name to allocate
  65  * @param count number of instances in the allocated array
  66  * @returns the new memory block or #NULL on failure
  67  */
  68
  69 /**
  70  * @def dbus_new0
  71  *
  72  * Safe macro for using dbus_malloc0(). Accepts the type
  73  * to allocate and the number of type instances to
  74  * allocate as arguments, and returns a memory block
  75  * cast to the desired type, instead of as a void*.
  76  * The allocated array is initialized to all-bits-zero.
  77  *
  78  * @param type type name to allocate
  79  * @param count number of instances in the allocated array
  80  * @returns the new memory block or #NULL on failure
  81  */
  82
  83 /**
  84  * @typedef DBusFreeFunction
  85  *
  86  * The type of a function which frees a block of memory.
  87  *
  88  * @param memory the memory to free
  89  */
  90
  91 /** @} */ /* end of public API docs */
  92
  93 /**
  94  * @addtogroup DBusMemoryInternals
  95  *
  96  * @{
  97  */
  98
  99 #ifdef DBUS_BUILD_TESTS
 100 static dbus_bool_t debug_initialized = FALSE;
 101 static int fail_nth = -1;
 102 static size_t fail_size = 0;
 103 static int fail_alloc_counter = _DBUS_INT_MAX;
 104 static int n_failures_per_failure = 1;
 105 static int n_failures_this_failure = 0;
 106 static dbus_bool_t guards = FALSE;
 107 static dbus_bool_t disable_mem_pools = FALSE;
 108 static dbus_bool_t backtrace_on_fail_alloc = FALSE;
 109 static DBusAtomic n_blocks_outstanding = {0};
 110
 111 /** value stored in guard padding for debugging buffer overrun */
 112 #define GUARD_VALUE 0xdeadbeef
 113 /** size of the information about the block stored in guard mode */
 114 #define GUARD_INFO_SIZE 8
 115 /** size of the GUARD_VALUE-filled padding after the header info  */
 116 #define GUARD_START_PAD 16
 117 /** size of the GUARD_VALUE-filled padding at the end of the block */
 118 #define GUARD_END_PAD 16
 119 /** size of stuff at start of block */
 120 #define GUARD_START_OFFSET (GUARD_START_PAD + GUARD_INFO_SIZE)
 121 /** total extra size over the requested allocation for guard stuff */
 122 #define GUARD_EXTRA_SIZE (GUARD_START_OFFSET + GUARD_END_PAD)
 123
 124 static void
 125 _dbus_initialize_malloc_debug (void)
 126 {
 127   if (!debug_initialized)
 128     {
 129       debug_initialized = TRUE;
 130
 131       if (_dbus_getenv ("DBUS_MALLOC_FAIL_NTH") != NULL)
 132         {
 133           fail_nth = atoi (_dbus_getenv ("DBUS_MALLOC_FAIL_NTH"));
 134           fail_alloc_counter = fail_nth;
 135           _dbus_verbose ("Will fail malloc every %d times\n", fail_nth);
 136         }
 137
 138       if (_dbus_getenv ("DBUS_MALLOC_FAIL_GREATER_THAN") != NULL)
 139         {
 140           fail_size = atoi (_dbus_getenv ("DBUS_MALLOC_FAIL_GREATER_THAN"));
 141           _dbus_verbose ("Will fail mallocs over %ld bytes\n",
 142                          (long) fail_size);
 143         }
 144
 145       if (_dbus_getenv ("DBUS_MALLOC_GUARDS") != NULL)
 146         {
 147           guards = TRUE;
 148           _dbus_verbose ("Will use malloc guards\n");
 149         }
 150
 151       if (_dbus_getenv ("DBUS_DISABLE_MEM_POOLS") != NULL)
 152         {
 153           disable_mem_pools = TRUE;
 154           _dbus_verbose ("Will disable memory pools\n");
 155         }
 156
 157       if (_dbus_getenv ("DBUS_MALLOC_BACKTRACES") != NULL)
 158         {
 159           backtrace_on_fail_alloc = TRUE;
 160           _dbus_verbose ("Will backtrace on failing a malloc\n");
 161         }
 162     }
 163 }
 164
 165 /**
 166  * Whether to turn off mem pools, useful for leak checking.
 167  *
 168  * @returns #TRUE if mempools should not be used.
 169  */
 170 dbus_bool_t
 171 _dbus_disable_mem_pools (void)
 172 {
 173   _dbus_initialize_malloc_debug ();
 174   return disable_mem_pools;
 175 }
 176
 177 /**
 178  * Sets the number of allocations until we simulate a failed
 179  * allocation. If set to 0, the next allocation to run
 180  * fails; if set to 1, one succeeds then the next fails; etc.
 181  * Set to _DBUS_INT_MAX to not fail anything.
 182  *
 183  * @param until_next_fail number of successful allocs before one fails
 184  */
 185 void
 186 _dbus_set_fail_alloc_counter (int until_next_fail)
 187 {
 188   _dbus_initialize_malloc_debug ();
 189
 190   fail_alloc_counter = until_next_fail;
 191
 192 #if 0
 193   _dbus_verbose ("Set fail alloc counter = %d\n", fail_alloc_counter);
 194 #endif
 195 }
 196
 197 /**
 198  * Gets the number of successful allocs until we'll simulate
 199  * a failed alloc.
 200  *
 201  * @returns current counter value
 202  */
 203 int
 204 _dbus_get_fail_alloc_counter (void)
 205 {
 206   _dbus_initialize_malloc_debug ();
 207
 208   return fail_alloc_counter;
 209 }
 210
 211 /**
 212  * Sets how many mallocs to fail when the fail alloc counter reaches
 213  * 0.
 214  *
 215  * @param failures_per_failure number to fail
 216  */
 217 void
 218 _dbus_set_fail_alloc_failures (int failures_per_failure)
 219 {
 220   n_failures_per_failure = failures_per_failure;
 221 }
 222
 223 /**
 224  * Gets the number of failures we'll have when the fail malloc
 225  * counter reaches 0.
 226  *
 227  * @returns number of failures planned
 228  */
 229 int
 230 _dbus_get_fail_alloc_failures (void)
 231 {
 232   return n_failures_per_failure;
 233 }
 234
 235 #ifdef DBUS_BUILD_TESTS
 236 /**
 237  * Called when about to alloc some memory; if
 238  * it returns #TRUE, then the allocation should
 239  * fail. If it returns #FALSE, then the allocation
 240  * should not fail.
 241  *
 242  * @returns #TRUE if this alloc should fail
 243  */
 244 dbus_bool_t
 245 _dbus_decrement_fail_alloc_counter (void)
 246 {
 247   _dbus_initialize_malloc_debug ();
 248 #ifdef DBUS_WIN_FIXME
 249   _dbus_warn("disabled memory allocation errors for now, it makes testing much more complicated");
 250   return FALSE;
 251 #endif
 252
 253   if (fail_alloc_counter <= 0)
 254     {
 255       if (backtrace_on_fail_alloc)
 256         _dbus_print_backtrace ();
 257
 258       _dbus_verbose ("failure %d\n", n_failures_this_failure);
 259
 260       n_failures_this_failure += 1;
 261       if (n_failures_this_failure >= n_failures_per_failure)
 262         {
 263           if (fail_nth >= 0)
 264             fail_alloc_counter = fail_nth;
 265           else
 266             fail_alloc_counter = _DBUS_INT_MAX;
 267
 268           n_failures_this_failure = 0;
 269
 270           _dbus_verbose ("reset fail alloc counter to %d\n", fail_alloc_counter);
 271         }
 272
 273       return TRUE;
 274     }
 275   else
 276     {
 277       fail_alloc_counter -= 1;
 278       return FALSE;
 279     }
 280 }
 281 #endif /* DBUS_BUILD_TESTS */
 282
 283 /**
 284  * Get the number of outstanding malloc()'d blocks.
 285  *
 286  * @returns number of blocks
 287  */
 288 int
 289 _dbus_get_malloc_blocks_outstanding (void)
 290 {
 291   return n_blocks_outstanding.value;
 292 }
 293
 294 /**
 295  * Where the block came from.
 296  */
 297 typedef enum
 298 {
 299   SOURCE_UNKNOWN,
 300   SOURCE_MALLOC,
 301   SOURCE_REALLOC,
 302   SOURCE_MALLOC_ZERO,
 303   SOURCE_REALLOC_NULL
 304 } BlockSource;
 305
 306 static const char*
 307 source_string (BlockSource source)
 308 {
 309   switch (source)
 310     {
 311     case SOURCE_UNKNOWN:
 312       return "unknown";
 313     case SOURCE_MALLOC:
 314       return "malloc";
 315     case SOURCE_REALLOC:
 316       return "realloc";
 317     case SOURCE_MALLOC_ZERO:
 318       return "malloc0";
 319     case SOURCE_REALLOC_NULL:
 320       return "realloc(NULL)";
 321     }
 322   _dbus_assert_not_reached ("Invalid malloc block source ID");
 323   return "invalid!";
 324 }
 325
 326 static void
 327 check_guards (void       *free_block,
 328               dbus_bool_t overwrite)
 329 {
 330   if (free_block != NULL)
 331     {
 332       unsigned char *block = ((unsigned char*)free_block) - GUARD_START_OFFSET;
 333       size_t requested_bytes = *(dbus_uint32_t*)block;
 334       BlockSource source = *(dbus_uint32_t*)(block + 4);
 335       unsigned int i;
 336       dbus_bool_t failed;
 337
 338       failed = FALSE;
 339
 340 #if 0
 341       _dbus_verbose ("Checking %d bytes request from source %s\n",
 342                      requested_bytes, source_string (source));
 343 #endif
 344
 345       i = GUARD_INFO_SIZE;
 346       while (i < GUARD_START_OFFSET)
 347         {
 348           dbus_uint32_t value = *(dbus_uint32_t*) &block[i];
 349           if (value != GUARD_VALUE)
 350             {
 351               _dbus_warn ("Block of %lu bytes from %s had start guard value 0x%ux at %d expected 0x%x\n",
 352                           (long) requested_bytes, source_string (source),
 353                           value, i, GUARD_VALUE);
 354               failed = TRUE;
 355             }
 356
 357           i += 4;
 358         }
 359
 360       i = GUARD_START_OFFSET + requested_bytes;
 361       while (i < (GUARD_START_OFFSET + requested_bytes + GUARD_END_PAD))
 362         {
 363           dbus_uint32_t value = *(dbus_uint32_t*) &block[i];
 364           if (value != GUARD_VALUE)
 365             {
 366               _dbus_warn ("Block of %lu bytes from %s had end guard value 0x%ux at %d expected 0x%x\n",
 367                           (long) requested_bytes, source_string (source),
 368                           value, i, GUARD_VALUE);
 369               failed = TRUE;
 370             }
 371
 372           i += 4;
 373         }
 374
 375       /* set memory to anything but nul bytes */
 376       if (overwrite)
 377         memset (free_block, 'g', requested_bytes);
 378
 379       if (failed)
 380         _dbus_assert_not_reached ("guard value corruption");
 381     }
 382 }
 383
 384 static void*
 385 set_guards (void       *real_block,
 386             size_t      requested_bytes,
 387             BlockSource source)
 388 {
 389   unsigned char *block = real_block;
 390   unsigned int i;
 391
 392   if (block == NULL)
 393     return NULL;
 394
 395   _dbus_assert (GUARD_START_OFFSET + GUARD_END_PAD == GUARD_EXTRA_SIZE);
 396
 397   *((dbus_uint32_t*)block) = requested_bytes;
 398   *((dbus_uint32_t*)(block + 4)) = source;
 399
 400   i = GUARD_INFO_SIZE;
 401   while (i < GUARD_START_OFFSET)
 402     {
 403       (*(dbus_uint32_t*) &block[i]) = GUARD_VALUE;
 404
 405       i += 4;
 406     }
 407
 408   i = GUARD_START_OFFSET + requested_bytes;
 409   while (i < (GUARD_START_OFFSET + requested_bytes + GUARD_END_PAD))
 410     {
 411       (*(dbus_uint32_t*) &block[i]) = GUARD_VALUE;
 412
 413       i += 4;
 414     }
 415
 416   check_guards (block + GUARD_START_OFFSET, FALSE);
 417
 418   return block + GUARD_START_OFFSET;
 419 }
 420
 421 #endif
 422
 423 /** @} */ /* End of internals docs */
 424
 425
 426 /**
 427  * @addtogroup DBusMemory
 428  *
 429  * @{
 430  */
 431
 432 /**
 433  * Allocates the given number of bytes, as with standard
 434  * malloc(). Guaranteed to return #NULL if bytes is zero
 435  * on all platforms. Returns #NULL if the allocation fails.
 436  * The memory must be released with dbus_free().
 437  *
 438  * dbus_malloc() memory is NOT safe to free with regular free() from
 439  * the C library. Free it with dbus_free() only.
 440  *
 441  * @param bytes number of bytes to allocate
 442  * @return allocated memory, or #NULL if the allocation fails.
 443  */
 444 void*
 445 dbus_malloc (size_t bytes)
 446 {
 447 #ifdef DBUS_BUILD_TESTS
 448   _dbus_initialize_malloc_debug ();
 449
 450   if (_dbus_decrement_fail_alloc_counter ())
 451     {
 452       _dbus_verbose (" FAILING malloc of %ld bytes\n", (long) bytes);
 453       return NULL;
 454     }
 455 #endif
 456
 457   if (bytes == 0) /* some system mallocs handle this, some don't */
 458     return NULL;
 459 #ifdef DBUS_BUILD_TESTS
 460   else if (fail_size != 0 && bytes > fail_size)
 461     return NULL;
 462   else if (guards)
 463     {
 464       void *block;
 465
 466       block = malloc (bytes + GUARD_EXTRA_SIZE);
 467       if (block)
 468         _dbus_atomic_inc (&n_blocks_outstanding);
 469
 470       return set_guards (block, bytes, SOURCE_MALLOC);
 471     }
 472 #endif
 473   else
 474     {
 475       void *mem;
 476       mem = malloc (bytes);
 477 #ifdef DBUS_BUILD_TESTS
 478       if (mem)
 479         _dbus_atomic_inc (&n_blocks_outstanding);
 480 #endif
 481       return mem;
 482     }
 483 }
 484
 485 /**
 486  * Allocates the given number of bytes, as with standard malloc(), but
 487  * all bytes are initialized to zero as with calloc(). Guaranteed to
 488  * return #NULL if bytes is zero on all platforms. Returns #NULL if the
 489  * allocation fails.  The memory must be released with dbus_free().
 490  *
 491  * dbus_malloc0() memory is NOT safe to free with regular free() from
 492  * the C library. Free it with dbus_free() only.
 493  *
 494  * @param bytes number of bytes to allocate
 495  * @return allocated memory, or #NULL if the allocation fails.
 496  */
 497 void*
 498 dbus_malloc0 (size_t bytes)
 499 {
 500 #ifdef DBUS_BUILD_TESTS
 501   _dbus_initialize_malloc_debug ();
 502
 503   if (_dbus_decrement_fail_alloc_counter ())
 504     {
 505       _dbus_verbose (" FAILING malloc0 of %ld bytes\n", (long) bytes);
 506
 507       return NULL;
 508     }
 509 #endif
 510
 511   if (bytes == 0)
 512     return NULL;
 513 #ifdef DBUS_BUILD_TESTS
 514   else if (fail_size != 0 && bytes > fail_size)
 515     return NULL;
 516   else if (guards)
 517     {
 518       void *block;
 519
 520       block = calloc (bytes + GUARD_EXTRA_SIZE, 1);
 521       if (block)
 522         _dbus_atomic_inc (&n_blocks_outstanding);
 523       return set_guards (block, bytes, SOURCE_MALLOC_ZERO);
 524     }
 525 #endif
 526   else
 527     {
 528       void *mem;
 529       mem = calloc (bytes, 1);
 530 #ifdef DBUS_BUILD_TESTS
 531       if (mem)
 532         _dbus_atomic_inc (&n_blocks_outstanding);
 533 #endif
 534       return mem;
 535     }
 536 }
 537
 538 /**
 539  * Resizes a block of memory previously allocated by dbus_malloc() or
 540  * dbus_malloc0(). Guaranteed to free the memory and return #NULL if bytes
 541  * is zero on all platforms. Returns #NULL if the resize fails.
 542  * If the resize fails, the memory is not freed.
 543  *
 544  * @param memory block to be resized
 545  * @param bytes new size of the memory block
 546  * @return allocated memory, or #NULL if the resize fails.
 547  */
 548 void*
 549 dbus_realloc (void  *memory,
 550               size_t bytes)
 551 {
 552 #ifdef DBUS_BUILD_TESTS
 553   _dbus_initialize_malloc_debug ();
 554
 555   if (_dbus_decrement_fail_alloc_counter ())
 556     {
 557       _dbus_verbose (" FAILING realloc of %ld bytes\n", (long) bytes);
 558
 559       return NULL;
 560     }
 561 #endif
 562
 563   if (bytes == 0) /* guarantee this is safe */
 564     {
 565       dbus_free (memory);
 566       return NULL;
 567     }
 568 #ifdef DBUS_BUILD_TESTS
 569   else if (fail_size != 0 && bytes > fail_size)
 570     return NULL;
 571   else if (guards)
 572     {
 573       if (memory)
 574         {
 575           size_t old_bytes;
 576           void *block;
 577
 578           check_guards (memory, FALSE);
 579
 580           block = realloc (((unsigned char*)memory) - GUARD_START_OFFSET,
 581                            bytes + GUARD_EXTRA_SIZE);
 582
 583           old_bytes = *(dbus_uint32_t*)block;
 584           if (block && bytes >= old_bytes)
 585             /* old guards shouldn't have moved */
 586             check_guards (((unsigned char*)block) + GUARD_START_OFFSET, FALSE);
 587
 588           return set_guards (block, bytes, SOURCE_REALLOC);
 589         }
 590       else
 591         {
 592           void *block;
 593
 594           block = malloc (bytes + GUARD_EXTRA_SIZE);
 595
 596           if (block)
 597             _dbus_atomic_inc (&n_blocks_outstanding);
 598
 599           return set_guards (block, bytes, SOURCE_REALLOC_NULL);
 600         }
 601     }
 602 #endif
 603   else
 604     {
 605       void *mem;
 606       mem = realloc (memory, bytes);
 607 #ifdef DBUS_BUILD_TESTS
 608       if (memory == NULL && mem != NULL)
 609             _dbus_atomic_inc (&n_blocks_outstanding);
 610 #endif
 611       return mem;
 612     }
 613 }
 614
 615 /**
 616  * Frees a block of memory previously allocated by dbus_malloc() or
 617  * dbus_malloc0(). If passed #NULL, does nothing.
 618  *
 619  * @param memory block to be freed
 620  */
 621 void
 622 dbus_free (void  *memory)
 623 {
 624 #ifdef DBUS_BUILD_TESTS
 625   if (guards)
 626     {
 627       check_guards (memory, TRUE);
 628       if (memory)
 629         {
 630           _dbus_atomic_dec (&n_blocks_outstanding);
 631
 632           _dbus_assert (n_blocks_outstanding.value >= 0);
 633
 634           free (((unsigned char*)memory) - GUARD_START_OFFSET);
 635         }
 636
 637       return;
 638     }
 639 #endif
 640
 641   if (memory) /* we guarantee it's safe to free (NULL) */
 642     {
 643 #ifdef DBUS_BUILD_TESTS
 644       _dbus_atomic_dec (&n_blocks_outstanding);
 645
 646       _dbus_assert (n_blocks_outstanding.value >= 0);
 647 #endif
 648
 649       free (memory);
 650     }
 651 }
 652
 653 /**
 654  * Frees a #NULL-terminated array of strings.
 655  * If passed #NULL, does nothing.
 656  *
 657  * @param str_array the array to be freed
 658  */
 659 void
 660 dbus_free_string_array (char **str_array)
 661 {
 662   if (str_array)
 663     {
 664       int i;
 665
 666       i = 0;
 667       while (str_array[i])
 668         {
 669           dbus_free (str_array[i]);
 670           i++;
 671         }
 672
 673       dbus_free (str_array);
 674     }
 675 }
 676
 677 /** @} */ /* End of public API docs block */
 678
 679
 680 /**
 681  * @addtogroup DBusMemoryInternals
 682  *
 683  * @{
 684  */
 685
 686 /**
 687  * _dbus_current_generation is used to track each
 688  * time that dbus_shutdown() is called, so we can
 689  * reinit things after it's been called. It is simply
 690  * incremented each time we shut down.
 691  */
 692 int _dbus_current_generation = 1;
 693
 694 /**
 695  * Represents a function to be called on shutdown.
 696  */
 697 typedef struct ShutdownClosure ShutdownClosure;
 698
 699 /**
 700  * This struct represents a function to be called on shutdown.
 701  */
 702 struct ShutdownClosure
 703 {
 704   ShutdownClosure *next;     /**< Next ShutdownClosure */
 705   DBusShutdownFunction func; /**< Function to call */
 706   void *data;                /**< Data for function */
 707 };
 708
 709 _DBUS_DEFINE_GLOBAL_LOCK (shutdown_funcs);
 710 static ShutdownClosure *registered_globals = NULL;
 711
 712 /**
 713  * Register a cleanup function to be called exactly once
 714  * the next time dbus_shutdown() is called.
 715  *
 716  * @param func the function
 717  * @param data data to pass to the function
 718  * @returns #FALSE on not enough memory
 719  */
 720 dbus_bool_t
 721 _dbus_register_shutdown_func (DBusShutdownFunction  func,
 722                               void                 *data)
 723 {
 724   ShutdownClosure *c;
 725
 726   c = dbus_new (ShutdownClosure, 1);
 727
 728   if (c == NULL)
 729     return FALSE;
 730
 731   c->func = func;
 732   c->data = data;
 733
 734   _DBUS_LOCK (shutdown_funcs);
 735
 736   c->next = registered_globals;
 737   registered_globals = c;
 738
 739   _DBUS_UNLOCK (shutdown_funcs);
 740
 741   return TRUE;
 742 }
 743
 744 /** @} */ /* End of private API docs block */
 745
 746
 747 /**
 748  * @addtogroup DBusMemory
 749  *
 750  * @{
 751  */
 752
 753 /**
 754  * Frees all memory allocated internally by libdbus and
 755  * reverses the effects of dbus_threads_init(). libdbus keeps internal
 756  * global variables, for example caches and thread locks, and it
 757  * can be useful to free these internal data structures.
 758  *
 759  * dbus_shutdown() does NOT free memory that was returned
 760  * to the application. It only returns libdbus-internal
 761  * data structures.
 762  *
 763  * You MUST free all memory and release all reference counts
 764  * returned to you by libdbus prior to calling dbus_shutdown().
 765  *
 766  * You can't continue to use any D-Bus objects, such as connections,
 767  * that were allocated prior to dbus_shutdown(). You can, however,
 768  * start over; call dbus_threads_init() again, create new connections,
 769  * and so forth.
 770  *
 771  * WARNING: dbus_shutdown() is NOT thread safe, it must be called
 772  * while NO other threads are using D-Bus. (Remember, you have to free
 773  * all D-Bus objects and memory before you call dbus_shutdown(), so no
 774  * thread can be using libdbus.)
 775  *
 776  * The purpose of dbus_shutdown() is to allow applications to get
 777  * clean output from memory leak checkers. dbus_shutdown() may also be
 778  * useful if you want to dlopen() libdbus instead of linking to it,
 779  * and want to be able to unload the library again.
 780  *
 781  * There is absolutely no requirement to call dbus_shutdown() - in fact,
 782  * most applications won't bother and should not feel guilty.
 783  *
 784  * You have to know that nobody is using libdbus in your application's
 785  * process before you can call dbus_shutdown(). One implication of this
 786  * is that calling dbus_shutdown() from a library is almost certainly
 787  * wrong, since you don't know what the rest of the app is up to.
 788  *
 789  */
 790 void
 791 dbus_shutdown (void)
 792 {
 793   while (registered_globals != NULL)
 794     {
 795       ShutdownClosure *c;
 796
 797       c = registered_globals;
 798       registered_globals = c->next;
 799
 800       (* c->func) (c->data);
 801
 802       dbus_free (c);
 803     }
 804
 805   _dbus_current_generation += 1;
 806 }
 807
 808 /** @} */ /** End of public API docs block */
 809
 810 #ifdef DBUS_BUILD_TESTS
 811 #include "dbus-test.h"
 812
 813 /**
 814  * @ingroup DBusMemoryInternals
 815  * Unit test for DBusMemory
 816  * @returns #TRUE on success.
 817  */
 818 dbus_bool_t
 819 _dbus_memory_test (void)
 820 {
 821   dbus_bool_t old_guards;
 822   void *p;
 823   size_t size;
 824
 825   old_guards = guards;
 826   guards = TRUE;
 827   p = dbus_malloc (4);
 828   if (p == NULL)
 829     _dbus_assert_not_reached ("no memory");
 830   for (size = 4; size < 256; size += 4)
 831     {
 832       p = dbus_realloc (p, size);
 833       if (p == NULL)
 834         _dbus_assert_not_reached ("no memory");
 835     }
 836   for (size = 256; size != 0; size -= 4)
 837     {
 838       p = dbus_realloc (p, size);
 839       if (p == NULL)
 840         _dbus_assert_not_reached ("no memory");
 841     }
 842   dbus_free (p);
 843   guards = old_guards;
 844   return TRUE;
 845 }
 846
 847 #endif