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 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., 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.
101 * @def _DBUS_INT16_MIN
103 * Minimum value of type "int16"
106 * @def _DBUS_INT16_MAX
108 * Maximum value of type "int16"
111 * @def _DBUS_UINT16_MAX
113 * Maximum value of type "uint16"
117 * @def _DBUS_INT32_MIN
119 * Minimum value of type "int32"
122 * @def _DBUS_INT32_MAX
124 * Maximum value of type "int32"
127 * @def _DBUS_UINT32_MAX
129 * Maximum value of type "uint32"
135 * Minimum value of type "int"
140 * Maximum value of type "int"
143 * @def _DBUS_UINT_MAX
145 * Maximum value of type "uint"
149 * @typedef DBusForeachFunction
151 * Used to iterate over each item in a collection, such as
156 * @def _DBUS_LOCK_NAME
158 * Expands to name of a global lock variable.
162 * @def _DBUS_DEFINE_GLOBAL_LOCK
164 * Defines a global lock variable with the given name.
165 * The lock must be added to the list to initialize
166 * in dbus_threads_init().
170 * @def _DBUS_DECLARE_GLOBAL_LOCK
172 * Expands to declaration of a global lock defined
173 * with _DBUS_DEFINE_GLOBAL_LOCK.
174 * The lock must be added to the list to initialize
175 * in dbus_threads_init().
181 * Locks a global lock
187 * Unlocks a global lock
191 * Fixed "out of memory" error message, just to avoid
192 * making up a different string every time and wasting
195 const char _dbus_no_memory_message[] = "Not enough memory";
198 * Prints a warning message to stderr.
200 * @param format printf-style format string.
203 _dbus_warn (const char *format,
206 /* FIXME not portable enough? */
209 va_start (args, format);
210 vfprintf (stderr, format, args);
214 #ifdef DBUS_ENABLE_VERBOSE_MODE
216 static dbus_bool_t verbose_initted = FALSE;
219 * Prints a warning message to stderr
220 * if the user has enabled verbose mode.
221 * This is the real function implementation,
222 * use _dbus_verbose() macro in code.
224 * @param format printf-style format string.
227 _dbus_verbose_real (const char *format,
231 static dbus_bool_t verbose = TRUE;
232 static dbus_bool_t need_pid = TRUE;
235 /* things are written a bit oddly here so that
236 * in the non-verbose case we just have the one
237 * conditional and return immediately.
242 if (!verbose_initted)
244 verbose = _dbus_getenv ("DBUS_VERBOSE") != NULL;
245 verbose_initted = TRUE;
250 /* Print out pid before the line */
252 fprintf (stderr, "%lu: ", _dbus_getpid ());
254 /* Only print pid again if the next line is a new line */
255 len = strlen (format);
256 if (format[len-1] == '\n')
261 va_start (args, format);
262 vfprintf (stderr, format, args);
269 * Reinitializes the verbose logging code, used
270 * as a hack in dbus-spawn.c so that a child
271 * process re-reads its pid
275 _dbus_verbose_reset_real (void)
277 verbose_initted = FALSE;
280 #endif /* DBUS_ENABLE_VERBOSE_MODE */
283 * Duplicates a string. Result must be freed with
284 * dbus_free(). Returns #NULL if memory allocation fails.
285 * If the string to be duplicated is #NULL, returns #NULL.
287 * @param str string to duplicate.
288 * @returns newly-allocated copy.
291 _dbus_strdup (const char *str)
301 copy = dbus_malloc (len + 1);
305 memcpy (copy, str, len + 1);
311 * Duplicates a block of memory. Returns
314 * @param mem memory to copy
315 * @param n_bytes number of bytes to copy
319 _dbus_memdup (const void *mem,
324 copy = dbus_malloc (n_bytes);
328 memcpy (copy, mem, n_bytes);
334 * Duplicates a string array. Result may be freed with
335 * dbus_free_string_array(). Returns #NULL if memory allocation fails.
336 * If the array to be duplicated is #NULL, returns #NULL.
338 * @param array array to duplicate.
339 * @returns newly-allocated copy.
342 _dbus_dup_string_array (const char **array)
351 for (len = 0; array[len] != NULL; ++len)
354 copy = dbus_new0 (char*, len + 1);
361 copy[i] = _dbus_strdup (array[i]);
364 dbus_free_string_array (copy);
375 * Checks whether a string array contains the given string.
377 * @param array array to search.
378 * @param str string to look for
379 * @returns #TRUE if array contains string
382 _dbus_string_array_contains (const char **array,
388 while (array[i] != NULL)
390 if (strcmp (array[i], str) == 0)
398 #ifdef DBUS_BUILD_TESTS
400 * Returns a string describing the given name.
402 * @param header_field the field to describe
403 * @returns a constant string describing the field
406 _dbus_header_field_to_string (int header_field)
408 switch (header_field)
410 case DBUS_HEADER_FIELD_INVALID:
412 case DBUS_HEADER_FIELD_PATH:
414 case DBUS_HEADER_FIELD_INTERFACE:
416 case DBUS_HEADER_FIELD_MEMBER:
418 case DBUS_HEADER_FIELD_ERROR_NAME:
420 case DBUS_HEADER_FIELD_REPLY_SERIAL:
421 return "reply-serial";
422 case DBUS_HEADER_FIELD_DESTINATION:
423 return "destination";
424 case DBUS_HEADER_FIELD_SENDER:
426 case DBUS_HEADER_FIELD_SIGNATURE:
432 #endif /* DBUS_BUILD_TESTS */
434 #ifndef DBUS_DISABLE_CHECKS
435 /** String used in _dbus_return_if_fail macro */
436 const char _dbus_return_if_fail_warning_format[] =
437 "%lu: arguments to %s() were incorrect, assertion \"%s\" failed in file %s line %d.\n"
438 "This is normally a bug in some application using the D-BUS library.\n";
441 #ifndef DBUS_DISABLE_ASSERT
443 * Internals of _dbus_assert(); it's a function
444 * rather than a macro with the inline code so
445 * that the assertion failure blocks don't show up
446 * in test suite coverage, and to shrink code size.
448 * @param condition TRUE if assertion succeeded
449 * @param condition_text condition as a string
450 * @param file file the assertion is in
451 * @param line line the assertion is in
452 * @param func function the assertion is in
455 _dbus_real_assert (dbus_bool_t condition,
456 const char *condition_text,
461 if (_DBUS_UNLIKELY (!condition))
463 _dbus_warn ("%lu: assertion failed \"%s\" file \"%s\" line %d function %s\n",
464 _dbus_getpid (), condition_text, file, line, func);
470 * Internals of _dbus_assert_not_reached(); it's a function
471 * rather than a macro with the inline code so
472 * that the assertion failure blocks don't show up
473 * in test suite coverage, and to shrink code size.
475 * @param explanation what was reached that shouldn't have been
476 * @param file file the assertion is in
477 * @param line line the assertion is in
480 _dbus_real_assert_not_reached (const char *explanation,
484 _dbus_warn ("File \"%s\" line %d process %lu should not have been reached: %s\n",
485 file, line, _dbus_getpid (), explanation);
488 #endif /* DBUS_DISABLE_ASSERT */
490 #ifdef DBUS_BUILD_TESTS
492 run_failing_each_malloc (int n_mallocs,
493 const char *description,
494 DBusTestMemoryFunction func,
497 n_mallocs += 10; /* fudge factor to ensure reallocs etc. are covered */
499 while (n_mallocs >= 0)
501 _dbus_set_fail_alloc_counter (n_mallocs);
503 _dbus_verbose ("\n===\n%s: (will fail malloc %d with %d failures)\n===\n",
504 description, n_mallocs,
505 _dbus_get_fail_alloc_failures ());
507 if (!(* func) (data))
513 _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
519 * Tests how well the given function responds to out-of-memory
520 * situations. Calls the function repeatedly, failing a different
521 * call to malloc() each time. If the function ever returns #FALSE,
522 * the test fails. The function should return #TRUE whenever something
523 * valid (such as returning an error, or succeeding) occurs, and #FALSE
524 * if it gets confused in some way.
526 * @param description description of the test used in verbose output
527 * @param func function to call
528 * @param data data to pass to function
529 * @returns #TRUE if the function never returns FALSE
532 _dbus_test_oom_handling (const char *description,
533 DBusTestMemoryFunction func,
538 int max_failures_to_try;
541 /* Run once to see about how many mallocs are involved */
543 _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
545 _dbus_verbose ("Running once to count mallocs\n");
547 if (!(* func) (data))
550 approx_mallocs = _DBUS_INT_MAX - _dbus_get_fail_alloc_counter ();
552 _dbus_verbose ("\n=================\n%s: about %d mallocs total\n=================\n",
553 description, approx_mallocs);
555 setting = _dbus_getenv ("DBUS_TEST_MALLOC_FAILURES");
560 _dbus_string_init_const (&str, setting);
562 if (!_dbus_string_parse_int (&str, 0, &v, NULL))
563 _dbus_warn ("couldn't parse '%s' as integer\n", setting);
564 max_failures_to_try = v;
568 max_failures_to_try = 4;
571 i = setting ? max_failures_to_try - 1 : 1;
572 while (i < max_failures_to_try)
574 _dbus_set_fail_alloc_failures (i);
575 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
580 _dbus_verbose ("\n=================\n%s: all iterations passed\n=================\n",
585 #endif /* DBUS_BUILD_TESTS */