1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-internals.c random utility stuff (internal to D-BUS implementation)
4 * Copyright (C) 2002, 2003 Red Hat, Inc.
6 * Licensed under the Academic Free License version 1.2
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include "dbus-internals.h"
24 #include "dbus-protocol.h"
25 #include "dbus-test.h"
29 #include <sys/types.h>
36 * @defgroup DBusInternals D-BUS internal implementation details
37 * @brief Documentation useful when developing or debugging D-BUS itself.
42 * @defgroup DBusInternalsUtils Utilities and portability
43 * @ingroup DBusInternals
44 * @brief Utility functions (_dbus_assert(), _dbus_warn(), etc.)
51 * Aborts with an error message if the condition is false.
53 * @param condition condition which must be true.
57 * @def _dbus_assert_not_reached
59 * Aborts with an error message if called.
60 * The given explanation will be printed.
62 * @param explanation explanation of what happened if the code was reached.
66 * @def _DBUS_N_ELEMENTS
68 * Computes the number of elements in a fixed-size array using
71 * @param array the array to count elements in.
75 * @def _DBUS_POINTER_TO_INT
77 * Safely casts a void* to an integer; should only be used on void*
78 * that actually contain integers, for example one created with
79 * _DBUS_INT_TO_POINTER. Only guaranteed to preserve 32 bits.
80 * (i.e. it's used to store 32-bit ints in pointers, but
81 * can't be used to store 64-bit pointers in ints.)
83 * @param pointer pointer to extract an integer from.
86 * @def _DBUS_INT_TO_POINTER
88 * Safely stuffs an integer into a pointer, to be extracted later with
89 * _DBUS_POINTER_TO_INT. Only guaranteed to preserve 32 bits.
91 * @param integer the integer to stuff into a pointer.
96 * Sets all bits in an object to zero.
98 * @param object the object to be zeroed.
103 * Minimum value of type "int"
108 * Maximum value of type "int"
112 * @typedef DBusForeachFunction
114 * Used to iterate over each item in a collection, such as
119 * @def _DBUS_LOCK_NAME
121 * Expands to name of a global lock variable.
125 * @def _DBUS_DEFINE_GLOBAL_LOCK
127 * Defines a global lock variable with the given name.
128 * The lock must be added to the list to initialize
129 * in dbus_threads_init().
133 * @def _DBUS_DECLARE_GLOBAL_LOCK
135 * Expands to declaration of a global lock defined
136 * with _DBUS_DEFINE_GLOBAL_LOCK.
137 * The lock must be added to the list to initialize
138 * in dbus_threads_init().
144 * Locks a global lock
150 * Unlocks a global lock
154 * Fixed "out of memory" error message, just to avoid
155 * making up a different string every time and wasting
158 const char _dbus_no_memory_message[] = "Not enough memory";
161 * Prints a warning message to stderr.
163 * @param format printf-style format string.
166 _dbus_warn (const char *format,
169 /* FIXME not portable enough? */
172 va_start (args, format);
173 vfprintf (stderr, format, args);
178 * Prints a warning message to stderr
179 * if the user has enabled verbose mode.
180 * This is the real function implementation,
181 * use _dbus_verbose() macro in code.
183 * @param format printf-style format string.
186 _dbus_verbose_real (const char *format,
190 static dbus_bool_t verbose = TRUE;
191 static dbus_bool_t initted = FALSE;
193 /* things are written a bit oddly here so that
194 * in the non-verbose case we just have the one
195 * conditional and return immediately.
202 verbose = _dbus_getenv ("DBUS_VERBOSE") != NULL;
208 va_start (args, format);
209 vfprintf (stderr, format, args);
214 * Duplicates a string. Result must be freed with
215 * dbus_free(). Returns #NULL if memory allocation fails.
216 * If the string to be duplicated is #NULL, returns #NULL.
218 * @param str string to duplicate.
219 * @returns newly-allocated copy.
222 _dbus_strdup (const char *str)
232 copy = dbus_malloc (len + 1);
236 memcpy (copy, str, len + 1);
242 * Duplicates a string array. Result may be freed with
243 * dbus_free_string_array(). Returns #NULL if memory allocation fails.
244 * If the array to be duplicated is #NULL, returns #NULL.
246 * @param array array to duplicate.
247 * @returns newly-allocated copy.
250 _dbus_dup_string_array (const char **array)
259 for (len = 0; array[len] != NULL; ++len)
262 copy = dbus_new0 (char*, len + 1);
269 copy[i] = _dbus_strdup (array[i]);
272 dbus_free_string_array (copy);
283 * Checks whether a string array contains the given string.
285 * @param array array to search.
286 * @param str string to look for
287 * @returns #TRUE if array contains string
290 _dbus_string_array_contains (const char **array,
296 while (array[i] != NULL)
298 if (strcmp (array[i], str) == 0)
307 * Returns a string describing the given type.
309 * @param type the type to describe
310 * @returns a constant string describing the type
313 _dbus_type_to_string (int type)
317 case DBUS_TYPE_INVALID:
321 case DBUS_TYPE_BOOLEAN:
323 case DBUS_TYPE_INT32:
325 case DBUS_TYPE_UINT32:
327 case DBUS_TYPE_DOUBLE:
329 case DBUS_TYPE_STRING:
331 case DBUS_TYPE_BOOLEAN_ARRAY:
332 return "boolean array";
333 case DBUS_TYPE_INT32_ARRAY:
334 return "int32 array";
335 case DBUS_TYPE_UINT32_ARRAY:
336 return "uint32 array";
337 case DBUS_TYPE_DOUBLE_ARRAY:
338 return "double array";
339 case DBUS_TYPE_BYTE_ARRAY:
341 case DBUS_TYPE_STRING_ARRAY:
342 return "string array";
348 #ifdef DBUS_BUILD_TESTS
350 run_failing_each_malloc (int n_mallocs,
351 const char *description,
352 DBusTestMemoryFunction func,
355 n_mallocs += 10; /* fudge factor to ensure reallocs etc. are covered */
357 while (n_mallocs >= 0)
359 _dbus_set_fail_alloc_counter (n_mallocs);
361 _dbus_verbose ("\n===\n%s: (will fail malloc %d with %d failures)\n===\n",
362 description, n_mallocs,
363 _dbus_get_fail_alloc_failures ());
365 if (!(* func) (data))
371 _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
377 * Tests how well the given function responds to out-of-memory
378 * situations. Calls the function repeatedly, failing a different
379 * call to malloc() each time. If the function ever returns #FALSE,
380 * the test fails. The function should return #TRUE whenever something
381 * valid (such as returning an error, or succeeding) occurs, and #FALSE
382 * if it gets confused in some way.
384 * @param description description of the test used in verbose output
385 * @param func function to call
386 * @param data data to pass to function
387 * @returns #TRUE if the function never returns FALSE
390 _dbus_test_oom_handling (const char *description,
391 DBusTestMemoryFunction func,
396 /* Run once to see about how many mallocs are involved */
398 _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
400 if (!(* func) (data))
403 approx_mallocs = _DBUS_INT_MAX - _dbus_get_fail_alloc_counter ();
405 _dbus_verbose ("=================\n%s: about %d mallocs total\n=================\n",
406 description, approx_mallocs);
408 _dbus_set_fail_alloc_failures (1);
409 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
412 _dbus_set_fail_alloc_failures (2);
413 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
416 _dbus_set_fail_alloc_failures (3);
417 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
420 _dbus_set_fail_alloc_failures (4);
421 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
424 _dbus_verbose ("=================\n%s: all iterations passed\n=================\n",
429 #endif /* DBUS_BUILD_TESTS */