dbus/dbus-internals.h

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-internals.h  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 #ifdef DBUS_INSIDE_DBUS_H
  24 #error "You can't include dbus-internals.h in the public header dbus.h"
  25 #endif
  26
  27 #ifndef DBUS_INTERNALS_H
  28 #define DBUS_INTERNALS_H
  29
  30 #include <dbus/dbus-memory.h>
  31 #include <dbus/dbus-types.h>
  32 #include <dbus/dbus-errors.h>
  33 #include <dbus/dbus-sysdeps.h>
  34 #include <dbus/dbus-threads-internal.h>
  35
  36 DBUS_BEGIN_DECLS
  37
  38 DBUS_PRIVATE_EXPORT
  39 void _dbus_warn               (const char *format,
  40                                ...) _DBUS_GNUC_PRINTF (1, 2);
  41
  42 DBUS_PRIVATE_EXPORT
  43 void _dbus_warn_check_failed  (const char *format,
  44                                ...) _DBUS_GNUC_PRINTF (1, 2);
  45
  46
  47 #if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
  48 #define _DBUS_FUNCTION_NAME __func__
  49 #elif defined(__GNUC__) || defined(_MSC_VER)
  50 #define _DBUS_FUNCTION_NAME __FUNCTION__
  51 #else
  52 #define _DBUS_FUNCTION_NAME "unknown function"
  53 #endif
  54
  55 /*
  56  * (code from GLib)
  57  *
  58  * The _DBUS_LIKELY and _DBUS_UNLIKELY macros let the programmer give hints to
  59  * the compiler about the expected result of an expression. Some compilers
  60  * can use this information for optimizations.
  61  *
  62  * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
  63  * putting assignments in the macro arg
  64  */
  65 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
  66 #define _DBUS_BOOLEAN_EXPR(expr)                \
  67  __extension__ ({                               \
  68    int _dbus_boolean_var_;                      \
  69    if (expr)                                    \
  70       _dbus_boolean_var_ = 1;                   \
  71    else                                         \
  72       _dbus_boolean_var_ = 0;                   \
  73    _dbus_boolean_var_;                          \
  74 })
  75 #define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1))
  76 #define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0))
  77 #else
  78 #define _DBUS_LIKELY(expr) (expr)
  79 #define _DBUS_UNLIKELY(expr) (expr)
  80 #endif
  81
  82 #ifdef DBUS_ENABLE_VERBOSE_MODE
  83
  84 /*
  85  at least gnu cc and msvc compiler are known to
  86  have support for variable macro argument lists
  87  add other compilers is required
  88 */
  89 #if defined(__GNUC__) || defined(_MSC_VER)
  90 #define DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
  91 #endif
  92
  93 #ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
  94 DBUS_PRIVATE_EXPORT
  95 void _dbus_verbose_real       (const char *file, const int line, const char *function,
  96                                const char *format,...) _DBUS_GNUC_PRINTF (4, 5);
  97 #  define _dbus_verbose(fmt,...) _dbus_verbose_real( __FILE__,__LINE__,__FUNCTION__,fmt, ## __VA_ARGS__)
  98 #else
  99 DBUS_PRIVATE_EXPORT
 100 void _dbus_verbose_real       (const char *format,
 101                                ...) _DBUS_GNUC_PRINTF (1, 2);
 102 #  define _dbus_verbose _dbus_verbose_real
 103 #endif
 104 DBUS_PRIVATE_EXPORT
 105 void _dbus_verbose_reset_real (void);
 106 DBUS_PRIVATE_EXPORT
 107 dbus_bool_t _dbus_is_verbose_real (void);
 108 DBUS_PRIVATE_EXPORT
 109 dbus_bool_t _dbus_get_verbose (void);
 110 DBUS_PRIVATE_EXPORT
 111 void _dbus_set_verbose (dbus_bool_t state);
 112
 113 #  define _dbus_verbose_reset _dbus_verbose_reset_real
 114 #  define _dbus_is_verbose _dbus_is_verbose_real
 115 #else
 116 #  ifdef HAVE_ISO_VARARGS
 117 #    define _dbus_verbose(...) do { } while (0)
 118 #  elif defined (HAVE_GNUC_VARARGS)
 119 #    define _dbus_verbose(format...) do { } while (0)
 120 #  else
 121 static void _dbus_verbose(const char * x,...) {;}
 122 #  endif
 123 #  define _dbus_verbose_reset() do { } while (0)
 124 #  define _dbus_is_verbose() FALSE
 125 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
 126
 127 DBUS_PRIVATE_EXPORT
 128 void _dbus_trace_ref (const char *obj_name,
 129                       void       *obj,
 130                       int         old_refcount,
 131                       int         new_refcount,
 132                       const char *why,
 133                       const char *env_var,
 134                       int        *enabled);
 135
 136 DBUS_PRIVATE_EXPORT
 137 const char* _dbus_strerror (int error_number);
 138
 139 #ifdef DBUS_DISABLE_ASSERT
 140 #define _dbus_assert(condition) do { } while (0)
 141 #else
 142 DBUS_PRIVATE_EXPORT
 143 void _dbus_real_assert (dbus_bool_t  condition,
 144                         const char  *condition_text,
 145                         const char  *file,
 146                         int          line,
 147                         const char  *func);
 148 #define _dbus_assert(condition)                                         \
 149   _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
 150 #endif /* !DBUS_DISABLE_ASSERT */
 151
 152 #ifdef DBUS_DISABLE_ASSERT
 153 #define _dbus_assert_not_reached(explanation) do { } while (0)
 154 #else
 155 DBUS_PRIVATE_EXPORT
 156 void _dbus_real_assert_not_reached (const char *explanation,
 157                                     const char *file,
 158                                     int         line) _DBUS_GNUC_NORETURN;
 159 #define _dbus_assert_not_reached(explanation)                                   \
 160   _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
 161 #endif /* !DBUS_DISABLE_ASSERT */
 162
 163 #ifdef DBUS_DISABLE_CHECKS
 164 #define _dbus_return_if_fail(condition)
 165 #define _dbus_return_val_if_fail(condition, val)
 166 #else
 167
 168 DBUS_PRIVATE_EXPORT
 169 extern const char *_dbus_return_if_fail_warning_format;
 170
 171 #define _dbus_return_if_fail(condition) do {                                       \
 172    _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_');                      \
 173   if (!(condition)) {                                                              \
 174     _dbus_warn_check_failed (_dbus_return_if_fail_warning_format,                  \
 175                              _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
 176     return;                                                                        \
 177   } } while (0)
 178
 179 #define _dbus_return_val_if_fail(condition, val) do {                                   \
 180    _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_');                           \
 181   if (!(condition)) {                                                                   \
 182     _dbus_warn_check_failed (_dbus_return_if_fail_warning_format,                       \
 183                              _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__);      \
 184     return (val);                                                                       \
 185   } } while (0)
 186
 187 #endif /* !DBUS_DISABLE_ASSERT */
 188
 189 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
 190
 191 #define _DBUS_POINTER_TO_INT(pointer) ((intptr_t)(pointer))
 192 #define _DBUS_INT_TO_POINTER(integer) ((void*)((intptr_t)(integer)))
 193
 194 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
 195
 196 #define _DBUS_STRUCT_OFFSET(struct_type, member)        \
 197     ((intptr_t) ((unsigned char*) &((struct_type*) 0)->member))
 198
 199 #define _DBUS_ALIGNOF(type) \
 200     (_DBUS_STRUCT_OFFSET (struct { char _1; type _2; }, _2))
 201
 202 #ifdef DBUS_DISABLE_CHECKS
 203 /* this is an assert and not an error, but in the typical --disable-checks case (you're trying
 204  * to really minimize code size), disabling these assertions makes sense.
 205  */
 206 #define _DBUS_ASSERT_ERROR_IS_SET(error) do { } while (0)
 207 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) do { } while (0)
 208 #else
 209 static inline void
 210 _dbus_assert_error_is_set (const DBusError *error)
 211 {
 212     _dbus_assert (error == NULL || dbus_error_is_set (error));
 213 }
 214
 215 static inline void
 216 _dbus_assert_error_is_clear (const DBusError *error)
 217 {
 218     _dbus_assert (error == NULL || !dbus_error_is_set (error));
 219 }
 220
 221 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert_error_is_set(error)
 222 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert_error_is_clear(error)
 223 #endif
 224
 225 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
 226 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
 227
 228 /* This alignment thing is from ORBit2 */
 229 /* Align a value upward to a boundary, expressed as a number of bytes.
 230  * E.g. align to an 8-byte boundary with argument of 8.
 231  */
 232
 233 /*
 234  *   (this + boundary - 1)
 235  *          &
 236  *    ~(boundary - 1)
 237  */
 238
 239 #define _DBUS_ALIGN_VALUE(this, boundary) \
 240   (( ((uintptr_t)(this)) + (((uintptr_t)(boundary)) -1)) & (~(((uintptr_t)(boundary))-1)))
 241
 242 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
 243   ((void*)_DBUS_ALIGN_VALUE(this, boundary))
 244
 245
 246 DBUS_PRIVATE_EXPORT
 247 char*       _dbus_strdup                (const char  *str);
 248 void*       _dbus_memdup                (const void  *mem,
 249                                          size_t       n_bytes);
 250 DBUS_PRIVATE_EXPORT
 251 dbus_bool_t _dbus_string_array_contains (const char **array,
 252                                          const char  *str);
 253 DBUS_PRIVATE_EXPORT
 254 size_t      _dbus_string_array_length   (const char **array);
 255 char**      _dbus_dup_string_array      (const char **array);
 256
 257 #define _DBUS_INT16_MIN  ((dbus_int16_t) 0x8000)
 258 #define _DBUS_INT16_MAX  ((dbus_int16_t) 0x7fff)
 259 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
 260 #define _DBUS_INT32_MIN  ((dbus_int32_t) 0x80000000)
 261 #define _DBUS_INT32_MAX  ((dbus_int32_t) 0x7fffffff)
 262 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
 263 /* using 32-bit here is sort of bogus */
 264 #define _DBUS_INT_MIN    _DBUS_INT32_MIN
 265 #define _DBUS_INT_MAX    _DBUS_INT32_MAX
 266 #define _DBUS_UINT_MAX   _DBUS_UINT32_MAX
 267 #define _DBUS_INT64_MAX  DBUS_INT64_CONSTANT  (0x7fffffffffffffff)
 268 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
 269 #define _DBUS_ONE_KILOBYTE 1024
 270 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
 271 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
 272 #define _DBUS_USEC_PER_SECOND          (1000000)
 273
 274 #undef  MAX
 275 #define MAX(a, b)  (((a) > (b)) ? (a) : (b))
 276
 277 #undef  MIN
 278 #define MIN(a, b)  (((a) < (b)) ? (a) : (b))
 279
 280 #undef  ABS
 281 #define ABS(a)     (((a) < 0) ? -(a) : (a))
 282
 283 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
 284
 285 typedef void (* DBusForeachFunction) (void *element,
 286                                       void *data);
 287
 288 void _dbus_verbose_bytes           (const unsigned char *data,
 289                                     int                  len,
 290                                     int                  offset);
 291 DBUS_PRIVATE_EXPORT
 292 void _dbus_verbose_bytes_of_string (const DBusString    *str,
 293                                     int                  start,
 294                                     int                  len);
 295
 296 DBUS_PRIVATE_EXPORT
 297 extern const char *_dbus_no_memory_message;
 298 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
 299 DBUS_PRIVATE_EXPORT
 300 void _dbus_set_error_valist (DBusError  *error,
 301                              const char *name,
 302                              const char *format,
 303                              va_list     args) _DBUS_GNUC_PRINTF (3, 0);
 304
 305 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
 306 /* Memory debugging */
 307 void        _dbus_set_fail_alloc_counter        (int  until_next_fail);
 308 int         _dbus_get_fail_alloc_counter        (void);
 309 void        _dbus_set_fail_alloc_failures       (int  failures_per_failure);
 310 int         _dbus_get_fail_alloc_failures       (void);
 311 dbus_bool_t _dbus_decrement_fail_alloc_counter  (void);
 312 dbus_bool_t _dbus_disable_mem_pools             (void);
 313 DBUS_PRIVATE_EXPORT
 314 int         _dbus_get_malloc_blocks_outstanding (void);
 315
 316 typedef dbus_bool_t (* DBusTestMemoryFunction)  (void *data);
 317 DBUS_PRIVATE_EXPORT
 318 dbus_bool_t _dbus_test_oom_handling (const char             *description,
 319                                      DBusTestMemoryFunction  func,
 320                                      void                   *data);
 321 #else
 322 #define _dbus_set_fail_alloc_counter(n)
 323 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
 324
 325 /* These are constant expressions so that blocks
 326  * they protect should be optimized away
 327  */
 328 #define _dbus_decrement_fail_alloc_counter() (FALSE)
 329 #define _dbus_disable_mem_pools()            (FALSE)
 330 #define _dbus_get_malloc_blocks_outstanding  (0)
 331 #endif /* !DBUS_ENABLE_EMBEDDED_TESTS */
 332
 333 typedef void (* DBusShutdownFunction) (void *data);
 334 DBUS_PRIVATE_EXPORT
 335 dbus_bool_t _dbus_register_shutdown_func          (DBusShutdownFunction  function,
 336                                                    void                 *data);
 337 dbus_bool_t _dbus_register_shutdown_func_unlocked (DBusShutdownFunction  function,
 338                                                    void                 *data);
 339
 340 extern int _dbus_current_generation;
 341
 342 /* The weird case convention is to avoid having to change all the callers,
 343  * which would be quite a mega-patch. */
 344 typedef enum
 345 {
 346   /* index 0-4 */
 347   _DBUS_LOCK_list,
 348   _DBUS_LOCK_connection_slots,
 349   _DBUS_LOCK_pending_call_slots,
 350   _DBUS_LOCK_server_slots,
 351   _DBUS_LOCK_message_slots,
 352   /* index 5-9 */
 353   _DBUS_LOCK_bus,
 354   _DBUS_LOCK_bus_datas,
 355   _DBUS_LOCK_shutdown_funcs,
 356   _DBUS_LOCK_system_users,
 357   _DBUS_LOCK_message_cache,
 358   /* index 10-12 */
 359   _DBUS_LOCK_shared_connections,
 360   _DBUS_LOCK_machine_uuid,
 361   _DBUS_LOCK_sysdeps,
 362
 363   _DBUS_N_GLOBAL_LOCKS
 364 } DBusGlobalLock;
 365
 366 dbus_bool_t _dbus_lock   (DBusGlobalLock lock) _DBUS_GNUC_WARN_UNUSED_RESULT;
 367 void        _dbus_unlock (DBusGlobalLock lock);
 368
 369 #define _DBUS_LOCK_NAME(name)           _DBUS_LOCK_##name
 370 #define _DBUS_LOCK(name)                _dbus_lock   (_DBUS_LOCK_##name)
 371 #define _DBUS_UNLOCK(name)              _dbus_unlock (_DBUS_LOCK_##name)
 372
 373 DBUS_PRIVATE_EXPORT
 374 dbus_bool_t _dbus_threads_init_debug (void);
 375
 376 dbus_bool_t   _dbus_address_append_escaped (DBusString       *escaped,
 377                                             const DBusString *unescaped);
 378
 379 void          _dbus_set_bad_address        (DBusError         *error,
 380                                             const char        *address_problem_type,
 381                                             const char        *address_problem_field,
 382                                             const char        *address_problem_other);
 383
 384 #define DBUS_UUID_LENGTH_BYTES 16
 385 #define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4)
 386 #define DBUS_UUID_LENGTH_HEX   (DBUS_UUID_LENGTH_BYTES * 2)
 387
 388 /**
 389  * A globally unique ID ; we have one for each DBusServer, and also one for each
 390  * machine with libdbus installed on it.
 391  */
 392 union DBusGUID
 393 {
 394   dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_WORDS];     /**< guid as four uint32 values */
 395   char as_bytes[DBUS_UUID_LENGTH_BYTES];                /**< guid as 16 single-byte values */
 396 };
 397
 398 DBUS_PRIVATE_EXPORT _DBUS_GNUC_WARN_UNUSED_RESULT
 399 dbus_bool_t _dbus_generate_uuid  (DBusGUID         *uuid,
 400                                   DBusError        *error);
 401 DBUS_PRIVATE_EXPORT
 402 dbus_bool_t _dbus_uuid_encode    (const DBusGUID   *uuid,
 403                                   DBusString       *encoded);
 404 dbus_bool_t _dbus_read_uuid_file (const DBusString *filename,
 405                                   DBusGUID         *uuid,
 406                                   dbus_bool_t       create_if_not_found,
 407                                   DBusError        *error);
 408
 409 dbus_bool_t _dbus_write_uuid_file (const DBusString *filename,
 410                                    const DBusGUID   *uuid,
 411                                    DBusError        *error);
 412
 413 dbus_bool_t _dbus_get_local_machine_uuid_encoded (DBusString *uuid_str,
 414                                                   DBusError  *error);
 415
 416 #define _DBUS_PASTE2(a, b) a ## b
 417 #define _DBUS_PASTE(a, b) _DBUS_PASTE2 (a, b)
 418 #define _DBUS_STATIC_ASSERT(expr) \
 419   typedef struct { char _assertion[(expr) ? 1 : -1]; } \
 420   _DBUS_PASTE (_DBUS_STATIC_ASSERT_, __LINE__) _DBUS_GNUC_UNUSED
 421
 422 DBUS_END_DECLS
 423
 424 #endif /* DBUS_INTERNALS_H */