dbus/dbus-internals.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   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 2.1
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  *
  22  */
  23
  24 #include <config.h>
  25 #include "dbus-internals.h"
  26 #include "dbus-protocol.h"
  27 #include "dbus-marshal-basic.h"
  28 #include "dbus-test.h"
  29 #include "dbus-valgrind-internal.h"
  30 #include <stdio.h>
  31 #include <stdarg.h>
  32 #include <string.h>
  33 #include <stdlib.h>
  34 #ifdef DBUS_USE_OUTPUT_DEBUG_STRING
  35 #include <windows.h>
  36 #include <mbstring.h>
  37 #endif
  38
  39 /**
  40  * @defgroup DBusInternals D-Bus secret internal implementation details
  41  * @brief Documentation useful when developing or debugging D-Bus itself.
  42  *
  43  */
  44
  45 /**
  46  * @defgroup DBusInternalsUtils Utilities and portability
  47  * @ingroup DBusInternals
  48  * @brief Utility functions (_dbus_assert(), _dbus_warn(), etc.)
  49  * @{
  50  */
  51
  52 /**
  53  * @def _dbus_assert
  54  *
  55  * Aborts with an error message if the condition is false.
  56  *
  57  * @param condition condition which must be true.
  58  */
  59
  60 /**
  61  * @def _dbus_assert_not_reached
  62  *
  63  * Aborts with an error message if called.
  64  * The given explanation will be printed.
  65  *
  66  * @param explanation explanation of what happened if the code was reached.
  67  */
  68
  69 /**
  70  * @def _DBUS_N_ELEMENTS
  71  *
  72  * Computes the number of elements in a fixed-size array using
  73  * sizeof().
  74  *
  75  * @param array the array to count elements in.
  76  */
  77
  78 /**
  79  * @def _DBUS_POINTER_TO_INT
  80  *
  81  * Safely casts a void* to an integer; should only be used on void*
  82  * that actually contain integers, for example one created with
  83  * _DBUS_INT_TO_POINTER.  Only guaranteed to preserve 32 bits.
  84  * (i.e. it's used to store 32-bit ints in pointers, but
  85  * can't be used to store 64-bit pointers in ints.)
  86  *
  87  * @param pointer pointer to extract an integer from.
  88  */
  89 /**
  90  * @def _DBUS_INT_TO_POINTER
  91  *
  92  * Safely stuffs an integer into a pointer, to be extracted later with
  93  * _DBUS_POINTER_TO_INT. Only guaranteed to preserve 32 bits.
  94  *
  95  * @param integer the integer to stuff into a pointer.
  96  */
  97 /**
  98  * @def _DBUS_ZERO
  99  *
 100  * Sets all bits in an object to zero.
 101  *
 102  * @param object the object to be zeroed.
 103  */
 104 /**
 105  * @def _DBUS_INT16_MIN
 106  *
 107  * Minimum value of type "int16"
 108  */
 109 /**
 110  * @def _DBUS_INT16_MAX
 111  *
 112  * Maximum value of type "int16"
 113  */
 114 /**
 115  * @def _DBUS_UINT16_MAX
 116  *
 117  * Maximum value of type "uint16"
 118  */
 119
 120 /**
 121  * @def _DBUS_INT32_MIN
 122  *
 123  * Minimum value of type "int32"
 124  */
 125 /**
 126  * @def _DBUS_INT32_MAX
 127  *
 128  * Maximum value of type "int32"
 129  */
 130 /**
 131  * @def _DBUS_UINT32_MAX
 132  *
 133  * Maximum value of type "uint32"
 134  */
 135
 136 /**
 137  * @def _DBUS_INT_MIN
 138  *
 139  * Minimum value of type "int"
 140  */
 141 /**
 142  * @def _DBUS_INT_MAX
 143  *
 144  * Maximum value of type "int"
 145  */
 146 /**
 147  * @def _DBUS_UINT_MAX
 148  *
 149  * Maximum value of type "uint"
 150  */
 151
 152 /**
 153  * @typedef DBusForeachFunction
 154  *
 155  * Used to iterate over each item in a collection, such as
 156  * a DBusList.
 157  */
 158
 159 /**
 160  * @def _DBUS_LOCK_NAME
 161  *
 162  * Expands to name of a global lock variable.
 163  */
 164
 165 /**
 166  * @def _DBUS_DEFINE_GLOBAL_LOCK
 167  *
 168  * Defines a global lock variable with the given name.
 169  * The lock must be added to the list to initialize
 170  * in dbus_threads_init().
 171  */
 172
 173 /**
 174  * @def _DBUS_DECLARE_GLOBAL_LOCK
 175  *
 176  * Expands to declaration of a global lock defined
 177  * with _DBUS_DEFINE_GLOBAL_LOCK.
 178  * The lock must be added to the list to initialize
 179  * in dbus_threads_init().
 180  */
 181
 182 /**
 183  * @def _DBUS_LOCK
 184  *
 185  * Locks a global lock
 186  */
 187
 188 /**
 189  * @def _DBUS_UNLOCK
 190  *
 191  * Unlocks a global lock
 192  */
 193
 194 /**
 195  * Fixed "out of memory" error message, just to avoid
 196  * making up a different string every time and wasting
 197  * space.
 198  */
 199 const char *_dbus_no_memory_message = "Not enough memory";
 200
 201 static dbus_bool_t warn_initted = FALSE;
 202 static dbus_bool_t fatal_warnings = FALSE;
 203 static dbus_bool_t fatal_warnings_on_check_failed = TRUE;
 204
 205 static void
 206 init_warnings(void)
 207 {
 208   if (!warn_initted)
 209     {
 210       const char *s;
 211       s = _dbus_getenv ("DBUS_FATAL_WARNINGS");
 212       if (s && *s)
 213         {
 214           if (*s == '0')
 215             {
 216               fatal_warnings = FALSE;
 217               fatal_warnings_on_check_failed = FALSE;
 218             }
 219           else if (*s == '1')
 220             {
 221               fatal_warnings = TRUE;
 222               fatal_warnings_on_check_failed = TRUE;
 223             }
 224           else
 225             {
 226               fprintf(stderr, "DBUS_FATAL_WARNINGS should be set to 0 or 1 if set, not '%s'",
 227                       s);
 228             }
 229         }
 230
 231       warn_initted = TRUE;
 232     }
 233 }
 234
 235 /**
 236  * Prints a warning message to stderr. Can optionally be made to exit
 237  * fatally by setting DBUS_FATAL_WARNINGS, but this is rarely
 238  * used. This function should be considered pretty much equivalent to
 239  * fprintf(stderr). _dbus_warn_check_failed() on the other hand is
 240  * suitable for use when a programming mistake has been made.
 241  *
 242  * @param format printf-style format string.
 243  */
 244 void
 245 _dbus_warn (const char *format,
 246             ...)
 247 {
 248   va_list args;
 249
 250   if (!warn_initted)
 251     init_warnings ();
 252
 253   va_start (args, format);
 254   vfprintf (stderr, format, args);
 255   va_end (args);
 256
 257   if (fatal_warnings)
 258     {
 259       fflush (stderr);
 260       _dbus_abort ();
 261     }
 262 }
 263
 264 /**
 265  * Prints a "critical" warning to stderr when an assertion fails;
 266  * differs from _dbus_warn primarily in that it prefixes the pid and
 267  * defaults to fatal. This should be used only when a programming
 268  * error has been detected. (NOT for unavoidable errors that an app
 269  * might handle - those should be returned as DBusError.) Calling this
 270  * means "there is a bug"
 271  */
 272 void
 273 _dbus_warn_check_failed(const char *format,
 274                         ...)
 275 {
 276   va_list args;
 277
 278   if (!warn_initted)
 279     init_warnings ();
 280
 281   fprintf (stderr, "process %lu: ", _dbus_pid_for_log ());
 282
 283   va_start (args, format);
 284   vfprintf (stderr, format, args);
 285   va_end (args);
 286
 287   if (fatal_warnings_on_check_failed)
 288     {
 289       fflush (stderr);
 290       _dbus_abort ();
 291     }
 292 }
 293
 294 #ifdef DBUS_ENABLE_VERBOSE_MODE
 295
 296 static dbus_bool_t verbose_initted = FALSE;
 297 static dbus_bool_t verbose = TRUE;
 298
 299 /** Whether to show the current thread in verbose messages */
 300 #define PTHREAD_IN_VERBOSE 0
 301 #if PTHREAD_IN_VERBOSE
 302 #include <pthread.h>
 303 #endif
 304
 305 #ifdef DBUS_USE_OUTPUT_DEBUG_STRING
 306 static char module_name[1024];
 307 #endif
 308
 309 static inline void
 310 _dbus_verbose_init (void)
 311 {
 312   if (!verbose_initted)
 313     {
 314       const char *p = _dbus_getenv ("DBUS_VERBOSE");
 315       verbose = p != NULL && *p == '1';
 316       verbose_initted = TRUE;
 317 #ifdef DBUS_USE_OUTPUT_DEBUG_STRING
 318       {
 319         char *last_period, *last_slash;
 320         GetModuleFileName(0,module_name,sizeof(module_name)-1);
 321         last_period = _mbsrchr(module_name,'.');
 322         if (last_period)
 323           *last_period ='\0';
 324         last_slash = _mbsrchr(module_name,'\\');
 325         if (last_slash)
 326           strcpy(module_name,last_slash+1);
 327         strcat(module_name,": ");
 328       }
 329 #endif
 330     }
 331 }
 332
 333 /** @def DBUS_IS_DIR_SEPARATOR(c)
 334  * macro for checking if character c is a patch separator
 335  *
 336  * @todo move to a header file so that others can use this too
 337  */
 338 #ifdef DBUS_WIN
 339 #define DBUS_IS_DIR_SEPARATOR(c) (c == '\\' || c == '/')
 340 #else
 341 #define DBUS_IS_DIR_SEPARATOR(c) (c == '/')
 342 #endif
 343
 344 /**
 345  remove source root from file path
 346  the source root is determined by
 347 */
 348 static char *_dbus_file_path_extract_elements_from_tail(const char *file,int level)
 349 {
 350   static int prefix = -1;
 351
 352   if (prefix == -1)
 353     {
 354       char *p = (char *)file + strlen(file);
 355       int i = 0;
 356       prefix = 0;
 357       for (;p >= file;p--)
 358         {
 359           if (DBUS_IS_DIR_SEPARATOR(*p))
 360             {
 361               if (++i >= level)
 362                 {
 363                   prefix = p-file+1;
 364                   break;
 365                 }
 366            }
 367         }
 368     }
 369   return (char *)file+prefix;
 370 }
 371
 372 /**
 373  * Implementation of dbus_is_verbose() macro if built with verbose logging
 374  * enabled.
 375  * @returns whether verbose logging is active.
 376  */
 377 dbus_bool_t
 378 _dbus_is_verbose_real (void)
 379 {
 380   _dbus_verbose_init ();
 381   return verbose;
 382 }
 383
 384 /**
 385  * Prints a warning message to stderr
 386  * if the user has enabled verbose mode.
 387  * This is the real function implementation,
 388  * use _dbus_verbose() macro in code.
 389  *
 390  * @param format printf-style format string.
 391  */
 392 void
 393 _dbus_verbose_real (
 394 #ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
 395                     const char *file,
 396                     const int line,
 397                     const char *function,
 398 #endif
 399                     const char *format,
 400                     ...)
 401 {
 402   va_list args;
 403   static dbus_bool_t need_pid = TRUE;
 404   int len;
 405
 406   /* things are written a bit oddly here so that
 407    * in the non-verbose case we just have the one
 408    * conditional and return immediately.
 409    */
 410   if (!_dbus_is_verbose_real())
 411     return;
 412
 413 #ifndef DBUS_USE_OUTPUT_DEBUG_STRING
 414   /* Print out pid before the line */
 415   if (need_pid)
 416     {
 417 #if PTHREAD_IN_VERBOSE
 418       fprintf (stderr, "%lu: 0x%lx: ", _dbus_pid_for_log (), pthread_self ());
 419 #else
 420       fprintf (stderr, "%lu: ", _dbus_pid_for_log ());
 421 #endif
 422     }
 423 #endif
 424
 425   /* Only print pid again if the next line is a new line */
 426   len = strlen (format);
 427   if (format[len-1] == '\n')
 428     need_pid = TRUE;
 429   else
 430     need_pid = FALSE;
 431
 432   va_start (args, format);
 433 #ifdef DBUS_USE_OUTPUT_DEBUG_STRING
 434   {
 435   char buf[1024];
 436   strcpy(buf,module_name);
 437 #ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
 438   sprintf (buf+strlen(buf), "[%s(%d):%s] ",_dbus_file_path_extract_elements_from_tail(file,2),line,function);
 439 #endif
 440   vsprintf (buf+strlen(buf),format, args);
 441   va_end (args);
 442   OutputDebugStringA(buf);
 443   }
 444 #else
 445 #ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
 446   fprintf (stderr, "[%s(%d):%s] ",_dbus_file_path_extract_elements_from_tail(file,2),line,function);
 447 #endif
 448
 449   vfprintf (stderr, format, args);
 450   va_end (args);
 451
 452   fflush (stderr);
 453 #endif
 454 }
 455
 456 /**
 457  * Reinitializes the verbose logging code, used
 458  * as a hack in dbus-spawn.c so that a child
 459  * process re-reads its pid
 460  *
 461  */
 462 void
 463 _dbus_verbose_reset_real (void)
 464 {
 465   verbose_initted = FALSE;
 466 }
 467
 468 void
 469 _dbus_trace_ref (const char *obj_name,
 470                  void       *obj,
 471                  int         old_refcount,
 472                  int         new_refcount,
 473                  const char *why,
 474                  const char *env_var,
 475                  int        *enabled)
 476 {
 477   _dbus_assert (obj_name != NULL);
 478   _dbus_assert (obj != NULL);
 479   _dbus_assert (old_refcount >= -1);
 480   _dbus_assert (new_refcount >= -1);
 481
 482   if (old_refcount == -1)
 483     {
 484       _dbus_assert (new_refcount == -1);
 485     }
 486   else
 487     {
 488       _dbus_assert (new_refcount >= 0);
 489       _dbus_assert (old_refcount >= 0);
 490       _dbus_assert (old_refcount > 0 || new_refcount > 0);
 491     }
 492
 493   _dbus_assert (why != NULL);
 494   _dbus_assert (env_var != NULL);
 495   _dbus_assert (enabled != NULL);
 496
 497   if (*enabled < 0)
 498     {
 499       const char *s = _dbus_getenv (env_var);
 500
 501       *enabled = FALSE;
 502
 503       if (s && *s)
 504         {
 505           if (*s == '0')
 506             *enabled = FALSE;
 507           else if (*s == '1')
 508             *enabled = TRUE;
 509           else
 510             _dbus_warn ("%s should be 0 or 1 if set, not '%s'", env_var, s);
 511         }
 512     }
 513
 514   if (*enabled)
 515     {
 516       if (old_refcount == -1)
 517         {
 518           VALGRIND_PRINTF_BACKTRACE ("%s %p ref stolen (%s)",
 519                                      obj_name, obj, why);
 520           _dbus_verbose ("%s %p ref stolen (%s)",
 521                          obj_name, obj, why);
 522         }
 523       else
 524         {
 525           VALGRIND_PRINTF_BACKTRACE ("%s %p %d -> %d refs (%s)",
 526                                      obj_name, obj,
 527                                      old_refcount, new_refcount, why);
 528           _dbus_verbose ("%s %p %d -> %d refs (%s)",
 529                          obj_name, obj, old_refcount, new_refcount, why);
 530         }
 531     }
 532 }
 533
 534 #endif /* DBUS_ENABLE_VERBOSE_MODE */
 535
 536 /**
 537  * Duplicates a string. Result must be freed with
 538  * dbus_free(). Returns #NULL if memory allocation fails.
 539  * If the string to be duplicated is #NULL, returns #NULL.
 540  *
 541  * @param str string to duplicate.
 542  * @returns newly-allocated copy.
 543  */
 544 char*
 545 _dbus_strdup (const char *str)
 546 {
 547   size_t len;
 548   char *copy;
 549
 550   if (str == NULL)
 551     return NULL;
 552
 553   len = strlen (str);
 554
 555   copy = dbus_malloc (len + 1);
 556   if (copy == NULL)
 557     return NULL;
 558
 559   memcpy (copy, str, len + 1);
 560
 561   return copy;
 562 }
 563
 564 /**
 565  * Duplicates a block of memory. Returns
 566  * #NULL on failure.
 567  *
 568  * @param mem memory to copy
 569  * @param n_bytes number of bytes to copy
 570  * @returns the copy
 571  */
 572 void*
 573 _dbus_memdup (const void  *mem,
 574               size_t       n_bytes)
 575 {
 576   void *copy;
 577
 578   copy = dbus_malloc (n_bytes);
 579   if (copy == NULL)
 580     return NULL;
 581
 582   memcpy (copy, mem, n_bytes);
 583
 584   return copy;
 585 }
 586
 587 /**
 588  * Duplicates a string array. Result may be freed with
 589  * dbus_free_string_array(). Returns #NULL if memory allocation fails.
 590  * If the array to be duplicated is #NULL, returns #NULL.
 591  *
 592  * @param array array to duplicate.
 593  * @returns newly-allocated copy.
 594  */
 595 char**
 596 _dbus_dup_string_array (const char **array)
 597 {
 598   int len;
 599   int i;
 600   char **copy;
 601
 602   if (array == NULL)
 603     return NULL;
 604
 605   for (len = 0; array[len] != NULL; ++len)
 606     ;
 607
 608   copy = dbus_new0 (char*, len + 1);
 609   if (copy == NULL)
 610     return NULL;
 611
 612   i = 0;
 613   while (i < len)
 614     {
 615       copy[i] = _dbus_strdup (array[i]);
 616       if (copy[i] == NULL)
 617         {
 618           dbus_free_string_array (copy);
 619           return NULL;
 620         }
 621
 622       ++i;
 623     }
 624
 625   return copy;
 626 }
 627
 628 /**
 629  * Checks whether a string array contains the given string.
 630  *
 631  * @param array array to search.
 632  * @param str string to look for
 633  * @returns #TRUE if array contains string
 634  */
 635 dbus_bool_t
 636 _dbus_string_array_contains (const char **array,
 637                              const char  *str)
 638 {
 639   int i;
 640
 641   i = 0;
 642   while (array[i] != NULL)
 643     {
 644       if (strcmp (array[i], str) == 0)
 645         return TRUE;
 646       ++i;
 647     }
 648
 649   return FALSE;
 650 }
 651
 652 /**
 653  * Generates a new UUID. If you change how this is done,
 654  * there's some text about it in the spec that should also change.
 655  *
 656  * @param uuid the uuid to initialize
 657  */
 658 void
 659 _dbus_generate_uuid (DBusGUID *uuid)
 660 {
 661   long now;
 662
 663   _dbus_get_current_time (&now, NULL);
 664
 665   uuid->as_uint32s[DBUS_UUID_LENGTH_WORDS - 1] = DBUS_UINT32_TO_BE (now);
 666
 667   _dbus_generate_random_bytes_buffer (uuid->as_bytes, DBUS_UUID_LENGTH_BYTES - 4);
 668 }
 669
 670 /**
 671  * Hex-encode a UUID.
 672  *
 673  * @param uuid the uuid
 674  * @param encoded string to append hex uuid to
 675  * @returns #FALSE if no memory
 676  */
 677 dbus_bool_t
 678 _dbus_uuid_encode (const DBusGUID *uuid,
 679                    DBusString     *encoded)
 680 {
 681   DBusString binary;
 682   _dbus_string_init_const_len (&binary, uuid->as_bytes, DBUS_UUID_LENGTH_BYTES);
 683   return _dbus_string_hex_encode (&binary, 0, encoded, _dbus_string_get_length (encoded));
 684 }
 685
 686 static dbus_bool_t
 687 _dbus_read_uuid_file_without_creating (const DBusString *filename,
 688                                        DBusGUID         *uuid,
 689                                        DBusError        *error)
 690 {
 691   DBusString contents;
 692   DBusString decoded;
 693   int end;
 694
 695   if (!_dbus_string_init (&contents))
 696     {
 697       _DBUS_SET_OOM (error);
 698       return FALSE;
 699     }
 700
 701   if (!_dbus_string_init (&decoded))
 702     {
 703       _dbus_string_free (&contents);
 704       _DBUS_SET_OOM (error);
 705       return FALSE;
 706     }
 707
 708   if (!_dbus_file_get_contents (&contents, filename, error))
 709     goto error;
 710
 711   _dbus_string_chop_white (&contents);
 712
 713   if (_dbus_string_get_length (&contents) != DBUS_UUID_LENGTH_HEX)
 714     {
 715       dbus_set_error (error, DBUS_ERROR_INVALID_FILE_CONTENT,
 716                       "UUID file '%s' should contain a hex string of length %d, not length %d, with no other text",
 717                       _dbus_string_get_const_data (filename),
 718                       DBUS_UUID_LENGTH_HEX,
 719                       _dbus_string_get_length (&contents));
 720       goto error;
 721     }
 722
 723   if (!_dbus_string_hex_decode (&contents, 0, &end, &decoded, 0))
 724     {
 725       _DBUS_SET_OOM (error);
 726       goto error;
 727     }
 728
 729   if (end == 0)
 730     {
 731       dbus_set_error (error, DBUS_ERROR_INVALID_FILE_CONTENT,
 732                       "UUID file '%s' contains invalid hex data",
 733                       _dbus_string_get_const_data (filename));
 734       goto error;
 735     }
 736
 737   if (_dbus_string_get_length (&decoded) != DBUS_UUID_LENGTH_BYTES)
 738     {
 739       dbus_set_error (error, DBUS_ERROR_INVALID_FILE_CONTENT,
 740                       "UUID file '%s' contains %d bytes of hex-encoded data instead of %d",
 741                       _dbus_string_get_const_data (filename),
 742                       _dbus_string_get_length (&decoded),
 743                       DBUS_UUID_LENGTH_BYTES);
 744       goto error;
 745     }
 746
 747   _dbus_string_copy_to_buffer (&decoded, uuid->as_bytes, DBUS_UUID_LENGTH_BYTES);
 748
 749   _dbus_string_free (&decoded);
 750   _dbus_string_free (&contents);
 751
 752   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 753
 754   return TRUE;
 755
 756  error:
 757   _DBUS_ASSERT_ERROR_IS_SET (error);
 758   _dbus_string_free (&contents);
 759   _dbus_string_free (&decoded);
 760   return FALSE;
 761 }
 762
 763 static dbus_bool_t
 764 _dbus_create_uuid_file_exclusively (const DBusString *filename,
 765                                     DBusGUID         *uuid,
 766                                     DBusError        *error)
 767 {
 768   DBusString encoded;
 769
 770   if (!_dbus_string_init (&encoded))
 771     {
 772       _DBUS_SET_OOM (error);
 773       return FALSE;
 774     }
 775
 776   _dbus_generate_uuid (uuid);
 777
 778   if (!_dbus_uuid_encode (uuid, &encoded))
 779     {
 780       _DBUS_SET_OOM (error);
 781       goto error;
 782     }
 783
 784   if (!_dbus_string_append_byte (&encoded, '\n'))
 785     {
 786       _DBUS_SET_OOM (error);
 787       goto error;
 788     }
 789
 790   if (!_dbus_string_save_to_file (&encoded, filename, TRUE, error))
 791     goto error;
 792
 793   _dbus_string_free (&encoded);
 794
 795   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 796   return TRUE;
 797
 798  error:
 799   _DBUS_ASSERT_ERROR_IS_SET (error);
 800   _dbus_string_free (&encoded);
 801   return FALSE;
 802 }
 803
 804 /**
 805  * Reads (and optionally writes) a uuid to a file. Initializes the uuid
 806  * unless an error is returned.
 807  *
 808  * @param filename the name of the file
 809  * @param uuid uuid to be initialized with the loaded uuid
 810  * @param create_if_not_found #TRUE to create a new uuid and save it if the file doesn't exist
 811  * @param error the error return
 812  * @returns #FALSE if the error is set
 813  */
 814 dbus_bool_t
 815 _dbus_read_uuid_file (const DBusString *filename,
 816                       DBusGUID         *uuid,
 817                       dbus_bool_t       create_if_not_found,
 818                       DBusError        *error)
 819 {
 820   DBusError read_error = DBUS_ERROR_INIT;
 821
 822   if (_dbus_read_uuid_file_without_creating (filename, uuid, &read_error))
 823     return TRUE;
 824
 825   if (!create_if_not_found)
 826     {
 827       dbus_move_error (&read_error, error);
 828       return FALSE;
 829     }
 830
 831   /* If the file exists and contains junk, we want to keep that error
 832    * message instead of overwriting it with a "file exists" error
 833    * message when we try to write
 834    */
 835   if (dbus_error_has_name (&read_error, DBUS_ERROR_INVALID_FILE_CONTENT))
 836     {
 837       dbus_move_error (&read_error, error);
 838       return FALSE;
 839     }
 840   else
 841     {
 842       dbus_error_free (&read_error);
 843       return _dbus_create_uuid_file_exclusively (filename, uuid, error);
 844     }
 845 }
 846
 847 _DBUS_DEFINE_GLOBAL_LOCK (machine_uuid);
 848 static int machine_uuid_initialized_generation = 0;
 849 static DBusGUID machine_uuid;
 850
 851 /**
 852  * Gets the hex-encoded UUID of the machine this function is
 853  * executed on. This UUID is guaranteed to be the same for a given
 854  * machine at least until it next reboots, though it also
 855  * makes some effort to be the same forever, it may change if the
 856  * machine is reconfigured or its hardware is modified.
 857  *
 858  * @param uuid_str string to append hex-encoded machine uuid to
 859  * @returns #FALSE if no memory
 860  */
 861 dbus_bool_t
 862 _dbus_get_local_machine_uuid_encoded (DBusString *uuid_str)
 863 {
 864   dbus_bool_t ok;
 865
 866   _DBUS_LOCK (machine_uuid);
 867   if (machine_uuid_initialized_generation != _dbus_current_generation)
 868     {
 869       DBusError error = DBUS_ERROR_INIT;
 870
 871       if (!_dbus_read_local_machine_uuid (&machine_uuid, FALSE,
 872                                           &error))
 873         {
 874 #ifndef DBUS_BUILD_TESTS
 875           /* For the test suite, we may not be installed so just continue silently
 876            * here. But in a production build, we want to be nice and loud about
 877            * this.
 878            */
 879           _dbus_warn_check_failed ("D-Bus library appears to be incorrectly set up; failed to read machine uuid: %s\n"
 880                                    "See the manual page for dbus-uuidgen to correct this issue.\n",
 881                                    error.message);
 882 #endif
 883
 884           dbus_error_free (&error);
 885
 886           _dbus_generate_uuid (&machine_uuid);
 887         }
 888     }
 889
 890   ok = _dbus_uuid_encode (&machine_uuid, uuid_str);
 891
 892   _DBUS_UNLOCK (machine_uuid);
 893
 894   return ok;
 895 }
 896
 897 #ifndef DBUS_DISABLE_CHECKS
 898 /** String used in _dbus_return_if_fail macro */
 899 const char *_dbus_return_if_fail_warning_format =
 900 "arguments to %s() were incorrect, assertion \"%s\" failed in file %s line %d.\n"
 901 "This is normally a bug in some application using the D-Bus library.\n";
 902 #endif
 903
 904 #ifndef DBUS_DISABLE_ASSERT
 905 /**
 906  * Internals of _dbus_assert(); it's a function
 907  * rather than a macro with the inline code so
 908  * that the assertion failure blocks don't show up
 909  * in test suite coverage, and to shrink code size.
 910  *
 911  * @param condition TRUE if assertion succeeded
 912  * @param condition_text condition as a string
 913  * @param file file the assertion is in
 914  * @param line line the assertion is in
 915  * @param func function the assertion is in
 916  */
 917 void
 918 _dbus_real_assert (dbus_bool_t  condition,
 919                    const char  *condition_text,
 920                    const char  *file,
 921                    int          line,
 922                    const char  *func)
 923 {
 924   if (_DBUS_UNLIKELY (!condition))
 925     {
 926       _dbus_warn ("%lu: assertion failed \"%s\" file \"%s\" line %d function %s\n",
 927                   _dbus_pid_for_log (), condition_text, file, line, func);
 928       _dbus_abort ();
 929     }
 930 }
 931
 932 /**
 933  * Internals of _dbus_assert_not_reached(); it's a function
 934  * rather than a macro with the inline code so
 935  * that the assertion failure blocks don't show up
 936  * in test suite coverage, and to shrink code size.
 937  *
 938  * @param explanation what was reached that shouldn't have been
 939  * @param file file the assertion is in
 940  * @param line line the assertion is in
 941  */
 942 void
 943 _dbus_real_assert_not_reached (const char *explanation,
 944                                const char *file,
 945                                int         line)
 946 {
 947   _dbus_warn ("File \"%s\" line %d process %lu should not have been reached: %s\n",
 948               file, line, _dbus_pid_for_log (), explanation);
 949   _dbus_abort ();
 950 }
 951 #endif /* DBUS_DISABLE_ASSERT */
 952
 953 #ifdef DBUS_BUILD_TESTS
 954 static dbus_bool_t
 955 run_failing_each_malloc (int                    n_mallocs,
 956                          const char            *description,
 957                          DBusTestMemoryFunction func,
 958                          void                  *data)
 959 {
 960   n_mallocs += 10; /* fudge factor to ensure reallocs etc. are covered */
 961
 962   while (n_mallocs >= 0)
 963     {
 964       _dbus_set_fail_alloc_counter (n_mallocs);
 965
 966       _dbus_verbose ("\n===\n%s: (will fail malloc %d with %d failures)\n===\n",
 967                      description, n_mallocs,
 968                      _dbus_get_fail_alloc_failures ());
 969
 970       if (!(* func) (data))
 971         return FALSE;
 972
 973       n_mallocs -= 1;
 974     }
 975
 976   _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
 977
 978   return TRUE;
 979 }
 980
 981 /**
 982  * Tests how well the given function responds to out-of-memory
 983  * situations. Calls the function repeatedly, failing a different
 984  * call to malloc() each time. If the function ever returns #FALSE,
 985  * the test fails. The function should return #TRUE whenever something
 986  * valid (such as returning an error, or succeeding) occurs, and #FALSE
 987  * if it gets confused in some way.
 988  *
 989  * @param description description of the test used in verbose output
 990  * @param func function to call
 991  * @param data data to pass to function
 992  * @returns #TRUE if the function never returns FALSE
 993  */
 994 dbus_bool_t
 995 _dbus_test_oom_handling (const char             *description,
 996                          DBusTestMemoryFunction  func,
 997                          void                   *data)
 998 {
 999   int approx_mallocs;
1000   const char *setting;
1001   int max_failures_to_try;
1002   int i;
1003
1004   /* Run once to see about how many mallocs are involved */
1005
1006   _dbus_set_fail_alloc_counter (_DBUS_INT_MAX);
1007
1008   _dbus_verbose ("Running once to count mallocs\n");
1009
1010   if (!(* func) (data))
1011     return FALSE;
1012
1013   approx_mallocs = _DBUS_INT_MAX - _dbus_get_fail_alloc_counter ();
1014
1015   _dbus_verbose ("\n=================\n%s: about %d mallocs total\n=================\n",
1016                  description, approx_mallocs);
1017
1018   setting = _dbus_getenv ("DBUS_TEST_MALLOC_FAILURES");
1019   if (setting != NULL)
1020     {
1021       DBusString str;
1022       long v;
1023       _dbus_string_init_const (&str, setting);
1024       v = 4;
1025       if (!_dbus_string_parse_int (&str, 0, &v, NULL))
1026         _dbus_warn ("couldn't parse '%s' as integer\n", setting);
1027       max_failures_to_try = v;
1028     }
1029   else
1030     {
1031       max_failures_to_try = 4;
1032     }
1033
1034   i = setting ? max_failures_to_try - 1 : 1;
1035   while (i < max_failures_to_try)
1036     {
1037       _dbus_set_fail_alloc_failures (i);
1038       if (!run_failing_each_malloc (approx_mallocs, description, func, data))
1039         return FALSE;
1040       ++i;
1041     }
1042
1043   _dbus_verbose ("\n=================\n%s: all iterations passed\n=================\n",
1044                  description);
1045
1046   return TRUE;
1047 }
1048 #endif /* DBUS_BUILD_TESTS */
1049
1050 /** @} */