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"
111 * @def _DBUS_MAX_SUN_PATH_LENGTH
113 * Maximum length of the path to a UNIX domain socket,
114 * sockaddr_un::sun_path member. POSIX requires that all systems
115 * support at least 100 bytes here, including the nul termination.
116 * We use 99 for the max value to allow for the nul.
118 * We could probably also do sizeof (addr.sun_path)
119 * but this way we are the same on all platforms
120 * which is probably a good idea.
124 * @typedef DBusForeachFunction
126 * Used to iterate over each item in a collection, such as
131 * @def _DBUS_LOCK_NAME
133 * Expands to name of a global lock variable.
137 * @def _DBUS_DEFINE_GLOBAL_LOCK
139 * Defines a global lock variable with the given name.
140 * The lock must be added to the list to initialize
141 * in dbus_threads_init().
145 * @def _DBUS_DECLARE_GLOBAL_LOCK
147 * Expands to declaration of a global lock defined
148 * with _DBUS_DEFINE_GLOBAL_LOCK.
149 * The lock must be added to the list to initialize
150 * in dbus_threads_init().
156 * Locks a global lock
162 * Unlocks a global lock
166 * Fixed "out of memory" error message, just to avoid
167 * making up a different string every time and wasting
170 const char _dbus_no_memory_message[] = "Not enough memory";
173 * Prints a warning message to stderr.
175 * @param format printf-style format string.
178 _dbus_warn (const char *format,
181 /* FIXME not portable enough? */
184 va_start (args, format);
185 vfprintf (stderr, format, args);
190 * Prints a warning message to stderr
191 * if the user has enabled verbose mode.
192 * This is the real function implementation,
193 * use _dbus_verbose() macro in code.
195 * @param format printf-style format string.
198 _dbus_verbose_real (const char *format,
202 static dbus_bool_t verbose = TRUE;
203 static dbus_bool_t initted = FALSE;
205 /* things are written a bit oddly here so that
206 * in the non-verbose case we just have the one
207 * conditional and return immediately.
214 verbose = _dbus_getenv ("DBUS_VERBOSE") != NULL;
220 va_start (args, format);
221 vfprintf (stderr, format, args);
226 * Duplicates a string. Result must be freed with
227 * dbus_free(). Returns #NULL if memory allocation fails.
228 * If the string to be duplicated is #NULL, returns #NULL.
230 * @param str string to duplicate.
231 * @returns newly-allocated copy.
234 _dbus_strdup (const char *str)
244 copy = dbus_malloc (len + 1);
248 memcpy (copy, str, len + 1);
254 * Returns a string describing the given type.
256 * @param type the type to describe
257 * @returns a constant string describing the type
260 _dbus_type_to_string (int type)
264 case DBUS_TYPE_INVALID:
268 case DBUS_TYPE_BOOLEAN:
270 case DBUS_TYPE_INT32:
272 case DBUS_TYPE_UINT32:
274 case DBUS_TYPE_DOUBLE:
276 case DBUS_TYPE_STRING:
278 case DBUS_TYPE_BOOLEAN_ARRAY:
279 return "boolean array";
280 case DBUS_TYPE_INT32_ARRAY:
281 return "int32 array";
282 case DBUS_TYPE_UINT32_ARRAY:
283 return "uint32 array";
284 case DBUS_TYPE_DOUBLE_ARRAY:
285 return "double array";
286 case DBUS_TYPE_BYTE_ARRAY:
288 case DBUS_TYPE_STRING_ARRAY:
289 return "string array";
296 run_failing_each_malloc (int n_mallocs,
297 const char *description,
298 DBusTestMemoryFunction func,
301 n_mallocs += 10; /* fudge factor to ensure reallocs etc. are covered */
303 while (n_mallocs >= 0)
305 _dbus_set_fail_alloc_counter (n_mallocs);
307 _dbus_verbose ("\n===\n%s: (will fail malloc %d with %d failures)\n===\n",
308 description, n_mallocs,
309 _dbus_get_fail_alloc_failures ());
311 if (!(* func) (data))
317 _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
323 * Tests how well the given function responds to out-of-memory
324 * situations. Calls the function repeatedly, failing a different
325 * call to malloc() each time. If the function ever returns #FALSE,
326 * the test fails. The function should return #TRUE whenever something
327 * valid (such as returning an error, or succeeding) occurs, and #FALSE
328 * if it gets confused in some way.
330 * @param description description of the test used in verbose output
331 * @param func function to call
332 * @param data data to pass to function
333 * @returns #TRUE if the function never returns FALSE
336 _dbus_test_oom_handling (const char *description,
337 DBusTestMemoryFunction func,
342 /* Run once to see about how many mallocs are involved */
344 _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
346 if (!(* func) (data))
349 approx_mallocs = _DBUS_INT_MAX - _dbus_get_fail_alloc_counter ();
351 _dbus_verbose ("=================\n%s: about %d mallocs total\n=================\n",
352 description, approx_mallocs);
354 _dbus_set_fail_alloc_failures (1);
355 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
358 _dbus_set_fail_alloc_failures (2);
359 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
362 _dbus_set_fail_alloc_failures (3);
363 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
366 _dbus_set_fail_alloc_failures (4);
367 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
370 _dbus_verbose ("=================\n%s: all iterations passed\n=================\n",