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.
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);
177 static dbus_bool_t verbose_initted = FALSE;
180 * Prints a warning message to stderr
181 * if the user has enabled verbose mode.
182 * This is the real function implementation,
183 * use _dbus_verbose() macro in code.
185 * @param format printf-style format string.
188 _dbus_verbose_real (const char *format,
192 static dbus_bool_t verbose = TRUE;
193 static dbus_bool_t need_pid = TRUE;
196 /* things are written a bit oddly here so that
197 * in the non-verbose case we just have the one
198 * conditional and return immediately.
203 if (!verbose_initted)
205 verbose = _dbus_getenv ("DBUS_VERBOSE") != NULL;
206 verbose_initted = TRUE;
211 /* Print out pid before the line */
213 fprintf (stderr, "%lu: ", _dbus_getpid ());
215 /* Only print pid again if the next line is a new line */
216 len = strlen (format);
217 if (format[len-1] == '\n')
222 va_start (args, format);
223 vfprintf (stderr, format, args);
230 * Reinitializes the verbose logging code, used
231 * as a hack in dbus-spawn.c so that a child
232 * process re-reads its pid
236 _dbus_verbose_reset_real (void)
238 verbose_initted = FALSE;
242 * Duplicates a string. Result must be freed with
243 * dbus_free(). Returns #NULL if memory allocation fails.
244 * If the string to be duplicated is #NULL, returns #NULL.
246 * @param str string to duplicate.
247 * @returns newly-allocated copy.
250 _dbus_strdup (const char *str)
260 copy = dbus_malloc (len + 1);
264 memcpy (copy, str, len + 1);
270 * Duplicates a block of memory. Returns
273 * @param mem memory to copy
274 * @param n_bytes number of bytes to copy
278 _dbus_memdup (const void *mem,
283 copy = dbus_malloc (n_bytes);
287 memcpy (copy, mem, n_bytes);
293 * Duplicates a string array. Result may be freed with
294 * dbus_free_string_array(). Returns #NULL if memory allocation fails.
295 * If the array to be duplicated is #NULL, returns #NULL.
297 * @param array array to duplicate.
298 * @returns newly-allocated copy.
301 _dbus_dup_string_array (const char **array)
310 for (len = 0; array[len] != NULL; ++len)
313 copy = dbus_new0 (char*, len + 1);
320 copy[i] = _dbus_strdup (array[i]);
323 dbus_free_string_array (copy);
334 * Checks whether a string array contains the given string.
336 * @param array array to search.
337 * @param str string to look for
338 * @returns #TRUE if array contains string
341 _dbus_string_array_contains (const char **array,
347 while (array[i] != NULL)
349 if (strcmp (array[i], str) == 0)
358 * Returns a string describing the given type.
360 * @param type the type to describe
361 * @returns a constant string describing the type
364 _dbus_type_to_string (int type)
368 case DBUS_TYPE_INVALID:
372 case DBUS_TYPE_BOOLEAN:
374 case DBUS_TYPE_INT32:
376 case DBUS_TYPE_UINT32:
378 case DBUS_TYPE_DOUBLE:
380 case DBUS_TYPE_STRING:
382 case DBUS_TYPE_CUSTOM:
384 case DBUS_TYPE_ARRAY:
394 * Returns a string describing the given name.
396 * @param header_field the field to describe
397 * @returns a constant string describing the field
400 _dbus_header_field_to_string (int header_field)
402 switch (header_field)
404 case DBUS_HEADER_FIELD_INVALID:
406 case DBUS_HEADER_FIELD_PATH:
408 case DBUS_HEADER_FIELD_INTERFACE:
410 case DBUS_HEADER_FIELD_MEMBER:
412 case DBUS_HEADER_FIELD_ERROR_NAME:
414 case DBUS_HEADER_FIELD_REPLY_SERIAL:
415 return "reply-serial";
416 case DBUS_HEADER_FIELD_DESTINATION:
417 return "destination";
418 case DBUS_HEADER_FIELD_SENDER:
420 case DBUS_HEADER_FIELD_SIGNATURE:
427 #ifndef DBUS_DISABLE_CHECKS
428 /** String used in _dbus_return_if_fail macro */
429 const char _dbus_return_if_fail_warning_format[] =
430 "%lu: arguments to %s() were incorrect, assertion \"%s\" failed in file %s line %d.\n"
431 "This is normally a bug in some application using the D-BUS library.\n";
434 #ifndef DBUS_DISABLE_ASSERT
436 * Internals of _dbus_assert(); it's a function
437 * rather than a macro with the inline code so
438 * that the assertion failure blocks don't show up
439 * in test suite coverage, and to shrink code size.
441 * @param condition TRUE if assertion succeeded
442 * @param condition_text condition as a string
443 * @param file file the assertion is in
444 * @param line line the assertion is in
447 _dbus_real_assert (dbus_bool_t condition,
448 const char *condition_text,
452 if (_DBUS_UNLIKELY (!condition))
454 _dbus_warn ("%lu: assertion failed \"%s\" file \"%s\" line %d\n",
455 _dbus_getpid (), condition_text, file, line);
461 * Internals of _dbus_assert_not_reached(); it's a function
462 * rather than a macro with the inline code so
463 * that the assertion failure blocks don't show up
464 * in test suite coverage, and to shrink code size.
466 * @param explanation what was reached that shouldn't have been
467 * @param file file the assertion is in
468 * @param line line the assertion is in
471 _dbus_real_assert_not_reached (const char *explanation,
475 _dbus_warn ("File \"%s\" line %d process %lu should not have been reached: %s\n",
476 file, line, _dbus_getpid (), explanation);
479 #endif /* DBUS_DISABLE_ASSERT */
481 #ifdef DBUS_BUILD_TESTS
483 run_failing_each_malloc (int n_mallocs,
484 const char *description,
485 DBusTestMemoryFunction func,
488 n_mallocs += 10; /* fudge factor to ensure reallocs etc. are covered */
490 while (n_mallocs >= 0)
492 _dbus_set_fail_alloc_counter (n_mallocs);
494 _dbus_verbose ("\n===\n%s: (will fail malloc %d with %d failures)\n===\n",
495 description, n_mallocs,
496 _dbus_get_fail_alloc_failures ());
498 if (!(* func) (data))
504 _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
510 * Tests how well the given function responds to out-of-memory
511 * situations. Calls the function repeatedly, failing a different
512 * call to malloc() each time. If the function ever returns #FALSE,
513 * the test fails. The function should return #TRUE whenever something
514 * valid (such as returning an error, or succeeding) occurs, and #FALSE
515 * if it gets confused in some way.
517 * @param description description of the test used in verbose output
518 * @param func function to call
519 * @param data data to pass to function
520 * @returns #TRUE if the function never returns FALSE
523 _dbus_test_oom_handling (const char *description,
524 DBusTestMemoryFunction func,
529 /* Run once to see about how many mallocs are involved */
531 _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
533 _dbus_verbose ("Running once to count mallocs\n");
535 if (!(* func) (data))
538 approx_mallocs = _DBUS_INT_MAX - _dbus_get_fail_alloc_counter ();
540 _dbus_verbose ("\n=================\n%s: about %d mallocs total\n=================\n",
541 description, approx_mallocs);
543 _dbus_set_fail_alloc_failures (1);
544 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
547 _dbus_set_fail_alloc_failures (2);
548 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
551 _dbus_set_fail_alloc_failures (3);
552 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
555 _dbus_set_fail_alloc_failures (4);
556 if (!run_failing_each_malloc (approx_mallocs, description, func, data))
559 _dbus_verbose ("\n=================\n%s: all iterations passed\n=================\n",
564 #endif /* DBUS_BUILD_TESTS */