dbus/dbus-internals.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-internals.c  random utility stuff (internal to D-BUS implementation)
   3  *
   4  * Copyright (C) 2002, 2003  Red Hat, Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   7  *
   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.
  12  *
  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.
  17  *
  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
  21  *
  22  */
  23 #include "dbus-internals.h"
  24 #include "dbus-protocol.h"
  25 #include "dbus-test.h"
  26 #include <stdio.h>
  27 #include <stdarg.h>
  28 #include <string.h>
  29 #include <sys/types.h>
  30 #include <errno.h>
  31 #include <unistd.h>
  32 #include <fcntl.h>
  33 #include <stdlib.h>
  34
  35 /**
  36  * @defgroup DBusInternals D-BUS internal implementation details
  37  * @brief Documentation useful when developing or debugging D-BUS itself.
  38  *
  39  */
  40
  41 /**
  42  * @defgroup DBusInternalsUtils Utilities and portability
  43  * @ingroup DBusInternals
  44  * @brief Utility functions (_dbus_assert(), _dbus_warn(), etc.)
  45  * @{
  46  */
  47
  48 /**
  49  * @def _dbus_assert
  50  *
  51  * Aborts with an error message if the condition is false.
  52  *
  53  * @param condition condition which must be true.
  54  */
  55
  56 /**
  57  * @def _dbus_assert_not_reached
  58  *
  59  * Aborts with an error message if called.
  60  * The given explanation will be printed.
  61  *
  62  * @param explanation explanation of what happened if the code was reached.
  63  */
  64
  65 /**
  66  * @def _DBUS_N_ELEMENTS
  67  *
  68  * Computes the number of elements in a fixed-size array using
  69  * sizeof().
  70  *
  71  * @param array the array to count elements in.
  72  */
  73
  74 /**
  75  * @def _DBUS_POINTER_TO_INT
  76  *
  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.)
  82  *
  83  * @param pointer pointer to extract an integer from.
  84  */
  85 /**
  86  * @def _DBUS_INT_TO_POINTER
  87  *
  88  * Safely stuffs an integer into a pointer, to be extracted later with
  89  * _DBUS_POINTER_TO_INT. Only guaranteed to preserve 32 bits.
  90  *
  91  * @param integer the integer to stuff into a pointer.
  92  */
  93 /**
  94  * @def _DBUS_ZERO
  95  *
  96  * Sets all bits in an object to zero.
  97  *
  98  * @param object the object to be zeroed.
  99  */
 100 /**
 101  * @def _DBUS_INT_MIN
 102  *
 103  * Minimum value of type "int"
 104  */
 105 /**
 106  * @def _DBUS_INT_MAX
 107  *
 108  * Maximum value of type "int"
 109  */
 110
 111 /**
 112  * @typedef DBusForeachFunction
 113  *
 114  * Used to iterate over each item in a collection, such as
 115  * a DBusList.
 116  */
 117
 118 /**
 119  * @def _DBUS_LOCK_NAME
 120  *
 121  * Expands to name of a global lock variable.
 122  */
 123
 124 /**
 125  * @def _DBUS_DEFINE_GLOBAL_LOCK
 126  *
 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().
 130  */
 131
 132 /**
 133  * @def _DBUS_DECLARE_GLOBAL_LOCK
 134  *
 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().
 139  */
 140
 141 /**
 142  * @def _DBUS_LOCK
 143  *
 144  * Locks a global lock
 145  */
 146
 147 /**
 148  * @def _DBUS_UNLOCK
 149  *
 150  * Unlocks a global lock
 151  */
 152
 153 /**
 154  * Fixed "out of memory" error message, just to avoid
 155  * making up a different string every time and wasting
 156  * space.
 157  */
 158 const char _dbus_no_memory_message[] = "Not enough memory";
 159
 160 /**
 161  * Prints a warning message to stderr.
 162  *
 163  * @param format printf-style format string.
 164  */
 165 void
 166 _dbus_warn (const char *format,
 167             ...)
 168 {
 169   /* FIXME not portable enough? */
 170   va_list args;
 171
 172   va_start (args, format);
 173   vfprintf (stderr, format, args);
 174   va_end (args);
 175 }
 176
 177 static dbus_bool_t verbose_initted = FALSE;
 178
 179 /**
 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.
 184  *
 185  * @param format printf-style format string.
 186  */
 187 void
 188 _dbus_verbose_real (const char *format,
 189                     ...)
 190 {
 191   va_list args;
 192   static dbus_bool_t verbose = TRUE;
 193   static unsigned long pid;
 194
 195   /* things are written a bit oddly here so that
 196    * in the non-verbose case we just have the one
 197    * conditional and return immediately.
 198    */
 199   if (!verbose)
 200     return;
 201
 202   if (!verbose_initted)
 203     {
 204       verbose = _dbus_getenv ("DBUS_VERBOSE") != NULL;
 205       pid = _dbus_getpid ();
 206       verbose_initted = TRUE;
 207       if (!verbose)
 208         return;
 209     }
 210
 211   fprintf (stderr, "%lu: ", pid);
 212
 213   va_start (args, format);
 214   vfprintf (stderr, format, args);
 215   va_end (args);
 216 }
 217
 218 /**
 219  * Reinitializes the verbose logging code, used
 220  * as a hack in dbus-spawn.c so that a child
 221  * process re-reads its pid
 222  *
 223  */
 224 void
 225 _dbus_verbose_reset_real (void)
 226 {
 227   verbose_initted = FALSE;
 228 }
 229
 230 /**
 231  * Duplicates a string. Result must be freed with
 232  * dbus_free(). Returns #NULL if memory allocation fails.
 233  * If the string to be duplicated is #NULL, returns #NULL.
 234  *
 235  * @param str string to duplicate.
 236  * @returns newly-allocated copy.
 237  */
 238 char*
 239 _dbus_strdup (const char *str)
 240 {
 241   int len;
 242   char *copy;
 243
 244   if (str == NULL)
 245     return NULL;
 246
 247   len = strlen (str);
 248
 249   copy = dbus_malloc (len + 1);
 250   if (copy == NULL)
 251     return NULL;
 252
 253   memcpy (copy, str, len + 1);
 254
 255   return copy;
 256 }
 257
 258 /**
 259  * Duplicates a string array. Result may be freed with
 260  * dbus_free_string_array(). Returns #NULL if memory allocation fails.
 261  * If the array to be duplicated is #NULL, returns #NULL.
 262  *
 263  * @param array array to duplicate.
 264  * @returns newly-allocated copy.
 265  */
 266 char**
 267 _dbus_dup_string_array (const char **array)
 268 {
 269   int len;
 270   int i;
 271   char **copy;
 272
 273   if (array == NULL)
 274     return NULL;
 275
 276   for (len = 0; array[len] != NULL; ++len)
 277     ;
 278
 279   copy = dbus_new0 (char*, len + 1);
 280   if (copy == NULL)
 281     return NULL;
 282
 283   i = 0;
 284   while (i < len)
 285     {
 286       copy[i] = _dbus_strdup (array[i]);
 287       if (copy[i] == NULL)
 288         {
 289           dbus_free_string_array (copy);
 290           return NULL;
 291         }
 292
 293       ++i;
 294     }
 295
 296   return copy;
 297 }
 298
 299 /**
 300  * Checks whether a string array contains the given string.
 301  *
 302  * @param array array to search.
 303  * @param str string to look for
 304  * @returns #TRUE if array contains string
 305  */
 306 dbus_bool_t
 307 _dbus_string_array_contains (const char **array,
 308                              const char  *str)
 309 {
 310   int i;
 311
 312   i = 0;
 313   while (array[i] != NULL)
 314     {
 315       if (strcmp (array[i], str) == 0)
 316         return TRUE;
 317       ++i;
 318     }
 319
 320   return FALSE;
 321 }
 322
 323 /**
 324  * Returns a string describing the given type.
 325  *
 326  * @param type the type to describe
 327  * @returns a constant string describing the type
 328  */
 329 const char *
 330 _dbus_type_to_string (int type)
 331 {
 332   switch (type)
 333     {
 334     case DBUS_TYPE_INVALID:
 335       return "invalid";
 336     case DBUS_TYPE_NIL:
 337       return "nil";
 338     case DBUS_TYPE_BOOLEAN:
 339       return "boolean";
 340     case DBUS_TYPE_INT32:
 341       return "int32";
 342     case DBUS_TYPE_UINT32:
 343       return "uint32";
 344     case DBUS_TYPE_DOUBLE:
 345       return "double";
 346     case DBUS_TYPE_STRING:
 347       return "string";
 348     case DBUS_TYPE_NAMED:
 349       return "named";
 350     case DBUS_TYPE_ARRAY:
 351       return "array";
 352     case DBUS_TYPE_DICT:
 353       return "dict";
 354     default:
 355       return "unknown";
 356     }
 357 }
 358
 359 #ifndef DBUS_DISABLE_CHECKS
 360 const char _dbus_return_if_fail_warning_format[] =
 361 "Arguments to %s were incorrect, assertion \"%s\" failed in file %s line %d.\n"
 362 "This is normally a bug in some application using the D-BUS library.\n";
 363 #endif
 364
 365 #ifndef DBUS_DISABLE_ASSERT
 366 /**
 367  * Internals of _dbus_assert(); it's a function
 368  * rather than a macro with the inline code so
 369  * that the assertion failure blocks don't show up
 370  * in test suite coverage, and to shrink code size.
 371  *
 372  * @param condition TRUE if assertion succeeded
 373  * @param condition_text condition as a string
 374  * @param file file the assertion is in
 375  * @param line line the assertion is in
 376  */
 377 void
 378 _dbus_real_assert (dbus_bool_t  condition,
 379                    const char  *condition_text,
 380                    const char  *file,
 381                    int          line)
 382 {
 383   if (!condition)
 384     {
 385       _dbus_warn ("Assertion failed \"%s\" file \"%s\" line %d process %lu\n",
 386                   condition_text, file, line, _dbus_getpid ());
 387       _dbus_abort ();
 388     }
 389 }
 390
 391 /**
 392  * Internals of _dbus_assert_not_reached(); it's a function
 393  * rather than a macro with the inline code so
 394  * that the assertion failure blocks don't show up
 395  * in test suite coverage, and to shrink code size.
 396  *
 397  * @param explanation what was reached that shouldn't have been
 398  * @param file file the assertion is in
 399  * @param line line the assertion is in
 400  */
 401 void
 402 _dbus_real_assert_not_reached (const char *explanation,
 403                                const char *file,
 404                                int         line)
 405 {
 406   _dbus_warn ("File \"%s\" line %d process %lu should not have been reached: %s\n",
 407               file, line, _dbus_getpid (), explanation);
 408   _dbus_abort ();
 409 }
 410 #endif /* DBUS_DISABLE_ASSERT */
 411
 412 #ifdef DBUS_BUILD_TESTS
 413 static dbus_bool_t
 414 run_failing_each_malloc (int                    n_mallocs,
 415                          const char            *description,
 416                          DBusTestMemoryFunction func,
 417                          void                  *data)
 418 {
 419   n_mallocs += 10; /* fudge factor to ensure reallocs etc. are covered */
 420
 421   while (n_mallocs >= 0)
 422     {
 423       _dbus_set_fail_alloc_counter (n_mallocs);
 424
 425       _dbus_verbose ("\n===\n%s: (will fail malloc %d with %d failures)\n===\n",
 426                      description, n_mallocs,
 427                      _dbus_get_fail_alloc_failures ());
 428
 429       if (!(* func) (data))
 430         return FALSE;
 431
 432       n_mallocs -= 1;
 433     }
 434
 435   _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
 436
 437   return TRUE;
 438 }
 439
 440 /**
 441  * Tests how well the given function responds to out-of-memory
 442  * situations. Calls the function repeatedly, failing a different
 443  * call to malloc() each time. If the function ever returns #FALSE,
 444  * the test fails. The function should return #TRUE whenever something
 445  * valid (such as returning an error, or succeeding) occurs, and #FALSE
 446  * if it gets confused in some way.
 447  *
 448  * @param description description of the test used in verbose output
 449  * @param func function to call
 450  * @param data data to pass to function
 451  * @returns #TRUE if the function never returns FALSE
 452  */
 453 dbus_bool_t
 454 _dbus_test_oom_handling (const char             *description,
 455                          DBusTestMemoryFunction  func,
 456                          void                   *data)
 457 {
 458   int approx_mallocs;
 459
 460   /* Run once to see about how many mallocs are involved */
 461
 462   _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
 463
 464   _dbus_verbose ("Running once to count mallocs\n");
 465
 466   if (!(* func) (data))
 467     return FALSE;
 468
 469   approx_mallocs = _DBUS_INT_MAX - _dbus_get_fail_alloc_counter ();
 470
 471   _dbus_verbose ("\n=================\n%s: about %d mallocs total\n=================\n",
 472                  description, approx_mallocs);
 473
 474   _dbus_set_fail_alloc_failures (1);
 475   if (!run_failing_each_malloc (approx_mallocs, description, func, data))
 476     return FALSE;
 477
 478   _dbus_set_fail_alloc_failures (2);
 479   if (!run_failing_each_malloc (approx_mallocs, description, func, data))
 480     return FALSE;
 481
 482   _dbus_set_fail_alloc_failures (3);
 483   if (!run_failing_each_malloc (approx_mallocs, description, func, data))
 484     return FALSE;
 485
 486   _dbus_set_fail_alloc_failures (4);
 487   if (!run_failing_each_malloc (approx_mallocs, description, func, data))
 488     return FALSE;
 489
 490   _dbus_verbose ("\n=================\n%s: all iterations passed\n=================\n",
 491                  description);
 492
 493   return TRUE;
 494 }
 495 #endif /* DBUS_BUILD_TESTS */
 496
 497 /** @} */