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 /**
 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.
 182  *
 183  * @param format printf-style format string.
 184  */
 185 void
 186 _dbus_verbose_real (const char *format,
 187                     ...)
 188 {
 189   va_list args;
 190   static dbus_bool_t verbose = TRUE;
 191   static dbus_bool_t initted = FALSE;
 192
 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.
 196    */
 197   if (!verbose)
 198     return;
 199
 200   if (!initted)
 201     {
 202       verbose = _dbus_getenv ("DBUS_VERBOSE") != NULL;
 203       initted = TRUE;
 204       if (!verbose)
 205         return;
 206     }
 207
 208   va_start (args, format);
 209   vfprintf (stderr, format, args);
 210   va_end (args);
 211 }
 212
 213 /**
 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.
 217  *
 218  * @param str string to duplicate.
 219  * @returns newly-allocated copy.
 220  */
 221 char*
 222 _dbus_strdup (const char *str)
 223 {
 224   int len;
 225   char *copy;
 226
 227   if (str == NULL)
 228     return NULL;
 229
 230   len = strlen (str);
 231
 232   copy = dbus_malloc (len + 1);
 233   if (copy == NULL)
 234     return NULL;
 235
 236   memcpy (copy, str, len + 1);
 237
 238   return copy;
 239 }
 240
 241 /**
 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.
 245  *
 246  * @param array array to duplicate.
 247  * @returns newly-allocated copy.
 248  */
 249 char**
 250 _dbus_dup_string_array (const char **array)
 251 {
 252   int len;
 253   int i;
 254   char **copy;
 255
 256   if (array == NULL)
 257     return NULL;
 258
 259   for (len = 0; array[len] != NULL; ++len)
 260     ;
 261
 262   copy = dbus_new0 (char*, len + 1);
 263   if (copy == NULL)
 264     return NULL;
 265
 266   i = 0;
 267   while (i < len)
 268     {
 269       copy[i] = _dbus_strdup (array[i]);
 270       if (copy[i] == NULL)
 271         {
 272           dbus_free_string_array (copy);
 273           return NULL;
 274         }
 275
 276       ++i;
 277     }
 278
 279   return copy;
 280 }
 281
 282 /**
 283  * Checks whether a string array contains the given string.
 284  *
 285  * @param array array to search.
 286  * @param str string to look for
 287  * @returns #TRUE if array contains string
 288  */
 289 dbus_bool_t
 290 _dbus_string_array_contains (const char **array,
 291                              const char  *str)
 292 {
 293   int i;
 294
 295   i = 0;
 296   while (array[i] != NULL)
 297     {
 298       if (strcmp (array[i], str) == 0)
 299         return TRUE;
 300       ++i;
 301     }
 302
 303   return FALSE;
 304 }
 305
 306 /**
 307  * Returns a string describing the given type.
 308  *
 309  * @param type the type to describe
 310  * @returns a constant string describing the type
 311  */
 312 const char *
 313 _dbus_type_to_string (int type)
 314 {
 315   switch (type)
 316     {
 317     case DBUS_TYPE_INVALID:
 318       return "invalid";
 319     case DBUS_TYPE_NIL:
 320       return "nil";
 321     case DBUS_TYPE_BOOLEAN:
 322       return "boolean";
 323     case DBUS_TYPE_INT32:
 324       return "int32";
 325     case DBUS_TYPE_UINT32:
 326       return "uint32";
 327     case DBUS_TYPE_DOUBLE:
 328       return "double";
 329     case DBUS_TYPE_STRING:
 330       return "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:
 340       return "byte array";
 341     case DBUS_TYPE_STRING_ARRAY:
 342       return "string array";
 343     default:
 344       return "unknown";
 345     }
 346 }
 347
 348 #ifndef DBUS_DISABLE_ASSERT
 349 /**
 350  * Internals of _dbus_assert(); it's a function
 351  * rather than a macro with the inline code so
 352  * that the assertion failure blocks don't show up
 353  * in test suite coverage, and to shrink code size.
 354  *
 355  * @param condition TRUE if assertion succeeded
 356  * @param condition_text condition as a string
 357  * @param file file the assertion is in
 358  * @param line line the assertion is in
 359  */
 360 void
 361 _dbus_real_assert (dbus_bool_t  condition,
 362                    const char  *condition_text,
 363                    const char  *file,
 364                    int          line)
 365 {
 366   if (!condition)
 367     {
 368       _dbus_warn ("Assertion failed \"%s\" file \"%s\" line %d\n",
 369                   condition_text, file, line);
 370       _dbus_abort ();
 371     }
 372 }
 373
 374 /**
 375  * Internals of _dbus_assert_not_reached(); it's a function
 376  * rather than a macro with the inline code so
 377  * that the assertion failure blocks don't show up
 378  * in test suite coverage, and to shrink code size.
 379  *
 380  * @param explanation what was reached that shouldn't have been
 381  * @param file file the assertion is in
 382  * @param line line the assertion is in
 383  */
 384 void
 385 _dbus_real_assert_not_reached (const char *explanation,
 386                                const char *file,
 387                                int         line)
 388 {
 389   _dbus_warn ("File \"%s\" line %d should not have been reached: %s\n",
 390               file, line, explanation);
 391   _dbus_abort ();
 392 }
 393 #endif /* DBUS_DISABLE_ASSERT */
 394
 395 #ifdef DBUS_BUILD_TESTS
 396 static dbus_bool_t
 397 run_failing_each_malloc (int                    n_mallocs,
 398                          const char            *description,
 399                          DBusTestMemoryFunction func,
 400                          void                  *data)
 401 {
 402   n_mallocs += 10; /* fudge factor to ensure reallocs etc. are covered */
 403
 404   while (n_mallocs >= 0)
 405     {
 406       _dbus_set_fail_alloc_counter (n_mallocs);
 407
 408       _dbus_verbose ("\n===\n%s: (will fail malloc %d with %d failures)\n===\n",
 409                      description, n_mallocs,
 410                      _dbus_get_fail_alloc_failures ());
 411
 412       if (!(* func) (data))
 413         return FALSE;
 414
 415       n_mallocs -= 1;
 416     }
 417
 418   _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
 419
 420   return TRUE;
 421 }
 422
 423 /**
 424  * Tests how well the given function responds to out-of-memory
 425  * situations. Calls the function repeatedly, failing a different
 426  * call to malloc() each time. If the function ever returns #FALSE,
 427  * the test fails. The function should return #TRUE whenever something
 428  * valid (such as returning an error, or succeeding) occurs, and #FALSE
 429  * if it gets confused in some way.
 430  *
 431  * @param description description of the test used in verbose output
 432  * @param func function to call
 433  * @param data data to pass to function
 434  * @returns #TRUE if the function never returns FALSE
 435  */
 436 dbus_bool_t
 437 _dbus_test_oom_handling (const char             *description,
 438                          DBusTestMemoryFunction  func,
 439                          void                   *data)
 440 {
 441   int approx_mallocs;
 442
 443   /* Run once to see about how many mallocs are involved */
 444
 445   _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
 446
 447   if (!(* func) (data))
 448     return FALSE;
 449
 450   approx_mallocs = _DBUS_INT_MAX - _dbus_get_fail_alloc_counter ();
 451
 452   _dbus_verbose ("=================\n%s: about %d mallocs total\n=================\n",
 453                  description, approx_mallocs);
 454
 455   _dbus_set_fail_alloc_failures (1);
 456   if (!run_failing_each_malloc (approx_mallocs, description, func, data))
 457     return FALSE;
 458
 459   _dbus_set_fail_alloc_failures (2);
 460   if (!run_failing_each_malloc (approx_mallocs, description, func, data))
 461     return FALSE;
 462
 463   _dbus_set_fail_alloc_failures (3);
 464   if (!run_failing_each_malloc (approx_mallocs, description, func, data))
 465     return FALSE;
 466
 467   _dbus_set_fail_alloc_failures (4);
 468   if (!run_failing_each_malloc (approx_mallocs, description, func, data))
 469     return FALSE;
 470
 471   _dbus_verbose ("=================\n%s: all iterations passed\n=================\n",
 472                  description);
 473
 474   return TRUE;
 475 }
 476 #endif /* DBUS_BUILD_TESTS */
 477
 478 /** @} */