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