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