1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-memory.c D-Bus memory handling
4 * Copyright (C) 2002, 2003 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
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.
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.
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
25 #include "dbus-memory.h"
26 #include "dbus-internals.h"
27 #include "dbus-sysdeps.h"
28 #include "dbus-list.h"
29 #include "dbus-threads.h"
33 * @defgroup DBusMemory Memory Allocation
35 * @brief dbus_malloc(), dbus_free(), etc.
37 * Functions and macros related to allocating and releasing
43 * @defgroup DBusMemoryInternals Memory allocation implementation details
44 * @ingroup DBusInternals
45 * @brief internals of dbus_malloc() etc.
47 * Implementation details related to allocating and releasing blocks
52 * @addtogroup DBusMemory
60 * Safe macro for using dbus_malloc(). Accepts the type
61 * to allocate and the number of type instances to
62 * allocate as arguments, and returns a memory block
63 * cast to the desired type, instead of as a void*.
65 * @param type type name to allocate
66 * @param count number of instances in the allocated array
67 * @returns the new memory block or #NULL on failure
73 * Safe macro for using dbus_malloc0(). Accepts the type
74 * to allocate and the number of type instances to
75 * allocate as arguments, and returns a memory block
76 * cast to the desired type, instead of as a void*.
77 * The allocated array is initialized to all-bits-zero.
79 * @param type type name to allocate
80 * @param count number of instances in the allocated array
81 * @returns the new memory block or #NULL on failure
85 * @typedef DBusFreeFunction
87 * The type of a function which frees a block of memory.
89 * @param memory the memory to free
92 /** @} */ /* end of public API docs */
95 * @addtogroup DBusMemoryInternals
100 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
101 static dbus_bool_t debug_initialized = FALSE;
102 static int fail_nth = -1;
103 static size_t fail_size = 0;
104 static int fail_alloc_counter = _DBUS_INT_MAX;
105 static int n_failures_per_failure = 1;
106 static int n_failures_this_failure = 0;
107 static dbus_bool_t guards = FALSE;
108 static dbus_bool_t disable_mem_pools = FALSE;
109 static dbus_bool_t backtrace_on_fail_alloc = FALSE;
110 static dbus_bool_t malloc_cannot_fail = FALSE;
111 static DBusAtomic n_blocks_outstanding = {0};
113 /** value stored in guard padding for debugging buffer overrun */
114 #define GUARD_VALUE 0xdeadbeef
115 /** size of the information about the block stored in guard mode */
116 #define GUARD_INFO_SIZE 8
117 /** size of the GUARD_VALUE-filled padding after the header info */
118 #define GUARD_START_PAD 16
119 /** size of the GUARD_VALUE-filled padding at the end of the block */
120 #define GUARD_END_PAD 16
121 /** size of stuff at start of block */
122 #define GUARD_START_OFFSET (GUARD_START_PAD + GUARD_INFO_SIZE)
123 /** total extra size over the requested allocation for guard stuff */
124 #define GUARD_EXTRA_SIZE (GUARD_START_OFFSET + GUARD_END_PAD)
127 _dbus_initialize_malloc_debug (void)
129 if (!debug_initialized)
131 debug_initialized = TRUE;
133 if (_dbus_getenv ("DBUS_MALLOC_FAIL_NTH") != NULL)
135 fail_nth = atoi (_dbus_getenv ("DBUS_MALLOC_FAIL_NTH"));
136 fail_alloc_counter = fail_nth;
137 _dbus_verbose ("Will fail dbus_malloc every %d times\n", fail_nth);
140 if (_dbus_getenv ("DBUS_MALLOC_FAIL_GREATER_THAN") != NULL)
142 fail_size = atoi (_dbus_getenv ("DBUS_MALLOC_FAIL_GREATER_THAN"));
143 _dbus_verbose ("Will fail mallocs over %ld bytes\n",
147 if (_dbus_getenv ("DBUS_MALLOC_GUARDS") != NULL)
150 _dbus_verbose ("Will use dbus_malloc guards\n");
153 if (_dbus_getenv ("DBUS_DISABLE_MEM_POOLS") != NULL)
155 disable_mem_pools = TRUE;
156 _dbus_verbose ("Will disable memory pools\n");
159 if (_dbus_getenv ("DBUS_MALLOC_BACKTRACES") != NULL)
161 backtrace_on_fail_alloc = TRUE;
162 _dbus_verbose ("Will backtrace on failing a dbus_malloc\n");
165 if (_dbus_getenv ("DBUS_MALLOC_CANNOT_FAIL") != NULL)
167 malloc_cannot_fail = TRUE;
168 _dbus_verbose ("Will abort if system malloc() and friends fail\n");
174 * Whether to turn off mem pools, useful for leak checking.
176 * @returns #TRUE if mempools should not be used.
179 _dbus_disable_mem_pools (void)
181 _dbus_initialize_malloc_debug ();
182 return disable_mem_pools;
186 * Sets the number of allocations until we simulate a failed
187 * allocation. If set to 0, the next allocation to run
188 * fails; if set to 1, one succeeds then the next fails; etc.
189 * Set to _DBUS_INT_MAX to not fail anything.
191 * @param until_next_fail number of successful allocs before one fails
194 _dbus_set_fail_alloc_counter (int until_next_fail)
196 _dbus_initialize_malloc_debug ();
198 fail_alloc_counter = until_next_fail;
201 _dbus_verbose ("Set fail alloc counter = %d\n", fail_alloc_counter);
206 * Gets the number of successful allocs until we'll simulate
209 * @returns current counter value
212 _dbus_get_fail_alloc_counter (void)
214 _dbus_initialize_malloc_debug ();
216 return fail_alloc_counter;
220 * Sets how many mallocs to fail when the fail alloc counter reaches
223 * @param failures_per_failure number to fail
226 _dbus_set_fail_alloc_failures (int failures_per_failure)
228 n_failures_per_failure = failures_per_failure;
232 * Gets the number of failures we'll have when the fail malloc
235 * @returns number of failures planned
238 _dbus_get_fail_alloc_failures (void)
240 return n_failures_per_failure;
243 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
245 * Called when about to alloc some memory; if
246 * it returns #TRUE, then the allocation should
247 * fail. If it returns #FALSE, then the allocation
250 * @returns #TRUE if this alloc should fail
253 _dbus_decrement_fail_alloc_counter (void)
255 _dbus_initialize_malloc_debug ();
256 #ifdef DBUS_WIN_FIXME
258 static dbus_bool_t called = 0;
262 _dbus_verbose("TODO: memory allocation testing errors disabled for now\n");
269 if (fail_alloc_counter <= 0)
271 if (backtrace_on_fail_alloc)
272 _dbus_print_backtrace ();
274 _dbus_verbose ("failure %d\n", n_failures_this_failure);
276 n_failures_this_failure += 1;
277 if (n_failures_this_failure >= n_failures_per_failure)
280 fail_alloc_counter = fail_nth;
282 fail_alloc_counter = _DBUS_INT_MAX;
284 n_failures_this_failure = 0;
286 _dbus_verbose ("reset fail alloc counter to %d\n", fail_alloc_counter);
293 fail_alloc_counter -= 1;
297 #endif /* DBUS_ENABLE_EMBEDDED_TESTS */
300 * Get the number of outstanding malloc()'d blocks.
302 * @returns number of blocks
305 _dbus_get_malloc_blocks_outstanding (void)
307 return _dbus_atomic_get (&n_blocks_outstanding);
311 * Where the block came from.
323 source_string (BlockSource source)
333 case SOURCE_MALLOC_ZERO:
335 case SOURCE_REALLOC_NULL:
336 return "realloc(NULL)";
338 _dbus_assert_not_reached ("Invalid malloc block source ID");
343 check_guards (void *free_block,
344 dbus_bool_t overwrite)
346 if (free_block != NULL)
348 unsigned char *block = ((unsigned char*)free_block) - GUARD_START_OFFSET;
349 size_t requested_bytes = *(dbus_uint32_t*)block;
350 BlockSource source = *(dbus_uint32_t*)(block + 4);
357 _dbus_verbose ("Checking %d bytes request from source %s\n",
358 requested_bytes, source_string (source));
362 while (i < GUARD_START_OFFSET)
364 dbus_uint32_t value = *(dbus_uint32_t*) &block[i];
365 if (value != GUARD_VALUE)
367 _dbus_warn ("Block of %lu bytes from %s had start guard value 0x%ux at %d expected 0x%x\n",
368 (long) requested_bytes, source_string (source),
369 value, i, GUARD_VALUE);
376 i = GUARD_START_OFFSET + requested_bytes;
377 while (i < (GUARD_START_OFFSET + requested_bytes + GUARD_END_PAD))
379 dbus_uint32_t value = *(dbus_uint32_t*) &block[i];
380 if (value != GUARD_VALUE)
382 _dbus_warn ("Block of %lu bytes from %s had end guard value 0x%ux at %d expected 0x%x\n",
383 (long) requested_bytes, source_string (source),
384 value, i, GUARD_VALUE);
391 /* set memory to anything but nul bytes */
393 memset (free_block, 'g', requested_bytes);
396 _dbus_assert_not_reached ("guard value corruption");
401 set_guards (void *real_block,
402 size_t requested_bytes,
405 unsigned char *block = real_block;
411 _dbus_assert (GUARD_START_OFFSET + GUARD_END_PAD == GUARD_EXTRA_SIZE);
413 *((dbus_uint32_t*)block) = requested_bytes;
414 *((dbus_uint32_t*)(block + 4)) = source;
417 while (i < GUARD_START_OFFSET)
419 (*(dbus_uint32_t*) &block[i]) = GUARD_VALUE;
424 i = GUARD_START_OFFSET + requested_bytes;
425 while (i < (GUARD_START_OFFSET + requested_bytes + GUARD_END_PAD))
427 (*(dbus_uint32_t*) &block[i]) = GUARD_VALUE;
432 check_guards (block + GUARD_START_OFFSET, FALSE);
434 return block + GUARD_START_OFFSET;
439 /** @} */ /* End of internals docs */
443 * @addtogroup DBusMemory
449 * Allocates the given number of bytes, as with standard
450 * malloc(). Guaranteed to return #NULL if bytes is zero
451 * on all platforms. Returns #NULL if the allocation fails.
452 * The memory must be released with dbus_free().
454 * dbus_malloc() memory is NOT safe to free with regular free() from
455 * the C library. Free it with dbus_free() only.
457 * @param bytes number of bytes to allocate
458 * @return allocated memory, or #NULL if the allocation fails.
461 dbus_malloc (size_t bytes)
463 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
464 _dbus_initialize_malloc_debug ();
466 if (_dbus_decrement_fail_alloc_counter ())
468 _dbus_verbose (" FAILING malloc of %ld bytes\n", (long) bytes);
473 if (bytes == 0) /* some system mallocs handle this, some don't */
475 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
476 else if (fail_size != 0 && bytes > fail_size)
482 block = malloc (bytes + GUARD_EXTRA_SIZE);
485 _dbus_atomic_inc (&n_blocks_outstanding);
487 else if (malloc_cannot_fail)
489 _dbus_warn ("out of memory: malloc (%ld + %ld)\n",
490 (long) bytes, (long) GUARD_EXTRA_SIZE);
494 return set_guards (block, bytes, SOURCE_MALLOC);
500 mem = malloc (bytes);
502 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
505 _dbus_atomic_inc (&n_blocks_outstanding);
507 else if (malloc_cannot_fail)
509 _dbus_warn ("out of memory: malloc (%ld)\n", (long) bytes);
519 * Allocates the given number of bytes, as with standard malloc(), but
520 * all bytes are initialized to zero as with calloc(). Guaranteed to
521 * return #NULL if bytes is zero on all platforms. Returns #NULL if the
522 * allocation fails. The memory must be released with dbus_free().
524 * dbus_malloc0() memory is NOT safe to free with regular free() from
525 * the C library. Free it with dbus_free() only.
527 * @param bytes number of bytes to allocate
528 * @return allocated memory, or #NULL if the allocation fails.
531 dbus_malloc0 (size_t bytes)
533 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
534 _dbus_initialize_malloc_debug ();
536 if (_dbus_decrement_fail_alloc_counter ())
538 _dbus_verbose (" FAILING malloc0 of %ld bytes\n", (long) bytes);
546 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
547 else if (fail_size != 0 && bytes > fail_size)
553 block = calloc (bytes + GUARD_EXTRA_SIZE, 1);
557 _dbus_atomic_inc (&n_blocks_outstanding);
559 else if (malloc_cannot_fail)
561 _dbus_warn ("out of memory: calloc (%ld + %ld, 1)\n",
562 (long) bytes, (long) GUARD_EXTRA_SIZE);
566 return set_guards (block, bytes, SOURCE_MALLOC_ZERO);
572 mem = calloc (bytes, 1);
574 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
577 _dbus_atomic_inc (&n_blocks_outstanding);
579 else if (malloc_cannot_fail)
581 _dbus_warn ("out of memory: calloc (%ld)\n", (long) bytes);
591 * Resizes a block of memory previously allocated by dbus_malloc() or
592 * dbus_malloc0(). Guaranteed to free the memory and return #NULL if bytes
593 * is zero on all platforms. Returns #NULL if the resize fails.
594 * If the resize fails, the memory is not freed.
596 * @param memory block to be resized
597 * @param bytes new size of the memory block
598 * @return allocated memory, or #NULL if the resize fails.
601 dbus_realloc (void *memory,
604 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
605 _dbus_initialize_malloc_debug ();
607 if (_dbus_decrement_fail_alloc_counter ())
609 _dbus_verbose (" FAILING realloc of %ld bytes\n", (long) bytes);
615 if (bytes == 0) /* guarantee this is safe */
620 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
621 else if (fail_size != 0 && bytes > fail_size)
630 check_guards (memory, FALSE);
632 block = realloc (((unsigned char*)memory) - GUARD_START_OFFSET,
633 bytes + GUARD_EXTRA_SIZE);
637 if (malloc_cannot_fail)
639 _dbus_warn ("out of memory: realloc (%p, %ld + %ld)\n",
640 memory, (long) bytes, (long) GUARD_EXTRA_SIZE);
647 old_bytes = *(dbus_uint32_t*)block;
648 if (bytes >= old_bytes)
649 /* old guards shouldn't have moved */
650 check_guards (((unsigned char*)block) + GUARD_START_OFFSET, FALSE);
652 return set_guards (block, bytes, SOURCE_REALLOC);
658 block = malloc (bytes + GUARD_EXTRA_SIZE);
662 _dbus_atomic_inc (&n_blocks_outstanding);
664 else if (malloc_cannot_fail)
666 _dbus_warn ("out of memory: malloc (%ld + %ld)\n",
667 (long) bytes, (long) GUARD_EXTRA_SIZE);
671 return set_guards (block, bytes, SOURCE_REALLOC_NULL);
678 mem = realloc (memory, bytes);
680 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
681 if (mem == NULL && malloc_cannot_fail)
683 _dbus_warn ("out of memory: malloc (%ld)\n", (long) bytes);
687 if (memory == NULL && mem != NULL)
688 _dbus_atomic_inc (&n_blocks_outstanding);
695 * Frees a block of memory previously allocated by dbus_malloc() or
696 * dbus_malloc0(). If passed #NULL, does nothing.
698 * @param memory block to be freed
701 dbus_free (void *memory)
703 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
706 check_guards (memory, TRUE);
709 #ifdef DBUS_DISABLE_ASSERT
710 _dbus_atomic_dec (&n_blocks_outstanding);
712 dbus_int32_t old_value;
714 old_value = _dbus_atomic_dec (&n_blocks_outstanding);
715 _dbus_assert (old_value >= 1);
718 free (((unsigned char*)memory) - GUARD_START_OFFSET);
725 if (memory) /* we guarantee it's safe to free (NULL) */
727 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
728 #ifdef DBUS_DISABLE_ASSERT
729 _dbus_atomic_dec (&n_blocks_outstanding);
731 dbus_int32_t old_value;
733 old_value = _dbus_atomic_dec (&n_blocks_outstanding);
734 _dbus_assert (old_value >= 1);
743 * Frees a #NULL-terminated array of strings.
744 * If passed #NULL, does nothing.
746 * @param str_array the array to be freed
749 dbus_free_string_array (char **str_array)
758 dbus_free (str_array[i]);
762 dbus_free (str_array);
766 /** @} */ /* End of public API docs block */
770 * @addtogroup DBusMemoryInternals
776 * _dbus_current_generation is used to track each
777 * time that dbus_shutdown() is called, so we can
778 * reinit things after it's been called. It is simply
779 * incremented each time we shut down.
781 int _dbus_current_generation = 1;
784 * Represents a function to be called on shutdown.
786 typedef struct ShutdownClosure ShutdownClosure;
789 * This struct represents a function to be called on shutdown.
791 struct ShutdownClosure
793 ShutdownClosure *next; /**< Next ShutdownClosure */
794 DBusShutdownFunction func; /**< Function to call */
795 void *data; /**< Data for function */
798 /* Protected by _DBUS_LOCK (shutdown_funcs) */
799 static ShutdownClosure *registered_globals = NULL;
802 * Register a cleanup function to be called exactly once
803 * the next time dbus_shutdown() is called.
805 * @param func the function
806 * @param data data to pass to the function
807 * @returns #FALSE on not enough memory
810 _dbus_register_shutdown_func (DBusShutdownFunction func,
815 if (!_DBUS_LOCK (shutdown_funcs))
818 ok = _dbus_register_shutdown_func_unlocked (func, data);
819 _DBUS_UNLOCK (shutdown_funcs);
824 _dbus_register_shutdown_func_unlocked (DBusShutdownFunction func,
829 c = dbus_new (ShutdownClosure, 1);
837 c->next = registered_globals;
838 registered_globals = c;
843 /** @} */ /* End of private API docs block */
847 * @addtogroup DBusMemory
853 * Frees all memory allocated internally by libdbus and
854 * reverses the effects of dbus_threads_init(). libdbus keeps internal
855 * global variables, for example caches and thread locks, and it
856 * can be useful to free these internal data structures.
858 * dbus_shutdown() does NOT free memory that was returned
859 * to the application. It only returns libdbus-internal
862 * You MUST free all memory and release all reference counts
863 * returned to you by libdbus prior to calling dbus_shutdown().
865 * You can't continue to use any D-Bus objects, such as connections,
866 * that were allocated prior to dbus_shutdown(). You can, however,
867 * start over; call dbus_threads_init() again, create new connections,
870 * WARNING: dbus_shutdown() is NOT thread safe, it must be called
871 * while NO other threads are using D-Bus. (Remember, you have to free
872 * all D-Bus objects and memory before you call dbus_shutdown(), so no
873 * thread can be using libdbus.)
875 * The purpose of dbus_shutdown() is to allow applications to get
876 * clean output from memory leak checkers. dbus_shutdown() may also be
877 * useful if you want to dlopen() libdbus instead of linking to it,
878 * and want to be able to unload the library again.
880 * There is absolutely no requirement to call dbus_shutdown() - in fact,
881 * most applications won't bother and should not feel guilty.
883 * You have to know that nobody is using libdbus in your application's
884 * process before you can call dbus_shutdown(). One implication of this
885 * is that calling dbus_shutdown() from a library is almost certainly
886 * wrong, since you don't know what the rest of the app is up to.
892 while (registered_globals != NULL)
896 c = registered_globals;
897 registered_globals = c->next;
899 (* c->func) (c->data);
904 /* We wrap this in the thread-initialization lock because
905 * dbus_threads_init() uses the current generation to tell whether
906 * we're initialized, so we need to make sure that un-initializing
907 * propagates into all threads. */
908 _dbus_threads_lock_platform_specific ();
909 _dbus_current_generation += 1;
910 _dbus_threads_unlock_platform_specific ();
913 /** @} */ /** End of public API docs block */
915 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
916 #include "dbus-test.h"
919 * @ingroup DBusMemoryInternals
920 * Unit test for DBusMemory
921 * @returns #TRUE on success.
924 _dbus_memory_test (void)
926 dbus_bool_t old_guards;
934 _dbus_assert_not_reached ("no memory");
935 for (size = 4; size < 256; size += 4)
937 p = dbus_realloc (p, size);
939 _dbus_assert_not_reached ("no memory");
941 for (size = 256; size != 0; size -= 4)
943 p = dbus_realloc (p, size);
945 _dbus_assert_not_reached ("no memory");