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 void _dbus_trace_ref (const char *obj_name,
 128                       void       *obj,
 129                       int         old_refcount,
 130                       int         new_refcount,
 131                       const char *why,
 132                       const char *env_var,
 133                       int        *enabled);
 134
 135 DBUS_PRIVATE_EXPORT
 136 const char* _dbus_strerror (int error_number);
 137
 138 #ifdef DBUS_DISABLE_ASSERT
 139 #define _dbus_assert(condition) do { } while (0)
 140 #else
 141 DBUS_PRIVATE_EXPORT
 142 void _dbus_real_assert (dbus_bool_t  condition,
 143                         const char  *condition_text,
 144                         const char  *file,
 145                         int          line,
 146                         const char  *func);
 147 #define _dbus_assert(condition)                                         \
 148   _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
 149 #endif /* !DBUS_DISABLE_ASSERT */
 150
 151 #ifdef DBUS_DISABLE_ASSERT
 152 #define _dbus_assert_not_reached(explanation) do { } while (0)
 153 #else
 154 DBUS_PRIVATE_EXPORT
 155 void _dbus_real_assert_not_reached (const char *explanation,
 156                                     const char *file,
 157                                     int         line) _DBUS_GNUC_NORETURN;
 158 #define _dbus_assert_not_reached(explanation)                                   \
 159   _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
 160 #endif /* !DBUS_DISABLE_ASSERT */
 161
 162 #ifdef DBUS_DISABLE_CHECKS
 163 #define _dbus_return_if_fail(condition)
 164 #define _dbus_return_val_if_fail(condition, val)
 165 #else
 166
 167 DBUS_PRIVATE_EXPORT
 168 extern const char *_dbus_return_if_fail_warning_format;
 169
 170 #define _dbus_return_if_fail(condition) do {                                       \
 171    _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_');                      \
 172   if (!(condition)) {                                                              \
 173     _dbus_warn_check_failed (_dbus_return_if_fail_warning_format,                  \
 174                              _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
 175     return;                                                                        \
 176   } } while (0)
 177
 178 #define _dbus_return_val_if_fail(condition, val) do {                                   \
 179    _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_');                           \
 180   if (!(condition)) {                                                                   \
 181     _dbus_warn_check_failed (_dbus_return_if_fail_warning_format,                       \
 182                              _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__);      \
 183     return (val);                                                                       \
 184   } } while (0)
 185
 186 #endif /* !DBUS_DISABLE_ASSERT */
 187
 188 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
 189
 190 #define _DBUS_POINTER_TO_INT(pointer) ((intptr_t)(pointer))
 191 #define _DBUS_INT_TO_POINTER(integer) ((void*)((intptr_t)(integer)))
 192
 193 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
 194
 195 #define _DBUS_STRUCT_OFFSET(struct_type, member)        \
 196     ((intptr_t) ((unsigned char*) &((struct_type*) 0)->member))
 197
 198 #ifdef DBUS_DISABLE_CHECKS
 199 /* this is an assert and not an error, but in the typical --disable-checks case (you're trying
 200  * to really minimize code size), disabling these assertions makes sense.
 201  */
 202 #define _DBUS_ASSERT_ERROR_IS_SET(error) do { } while (0)
 203 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) do { } while (0)
 204 #else
 205 static inline void
 206 _dbus_assert_error_is_set (const DBusError *error)
 207 {
 208     _dbus_assert (error == NULL || dbus_error_is_set (error));
 209 }
 210
 211 static inline void
 212 _dbus_assert_error_is_clear (const DBusError *error)
 213 {
 214     _dbus_assert (error == NULL || !dbus_error_is_set (error));
 215 }
 216
 217 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert_error_is_set(error)
 218 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert_error_is_clear(error)
 219 #endif
 220
 221 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
 222 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
 223
 224 /* This alignment thing is from ORBit2 */
 225 /* Align a value upward to a boundary, expressed as a number of bytes.
 226  * E.g. align to an 8-byte boundary with argument of 8.
 227  */
 228
 229 /*
 230  *   (this + boundary - 1)
 231  *          &
 232  *    ~(boundary - 1)
 233  */
 234
 235 #define _DBUS_ALIGN_VALUE(this, boundary) \
 236   (( ((uintptr_t)(this)) + (((uintptr_t)(boundary)) -1)) & (~(((uintptr_t)(boundary))-1)))
 237
 238 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
 239   ((void*)_DBUS_ALIGN_VALUE(this, boundary))
 240
 241
 242 DBUS_PRIVATE_EXPORT
 243 char*       _dbus_strdup                (const char  *str);
 244 void*       _dbus_memdup                (const void  *mem,
 245                                          size_t       n_bytes);
 246 DBUS_PRIVATE_EXPORT
 247 dbus_bool_t _dbus_string_array_contains (const char **array,
 248                                          const char  *str);
 249 char**      _dbus_dup_string_array      (const char **array);
 250
 251 #define _DBUS_INT16_MIN  ((dbus_int16_t) 0x8000)
 252 #define _DBUS_INT16_MAX  ((dbus_int16_t) 0x7fff)
 253 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
 254 #define _DBUS_INT32_MIN  ((dbus_int32_t) 0x80000000)
 255 #define _DBUS_INT32_MAX  ((dbus_int32_t) 0x7fffffff)
 256 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
 257 /* using 32-bit here is sort of bogus */
 258 #define _DBUS_INT_MIN    _DBUS_INT32_MIN
 259 #define _DBUS_INT_MAX    _DBUS_INT32_MAX
 260 #define _DBUS_UINT_MAX   _DBUS_UINT32_MAX
 261 #define _DBUS_INT64_MAX  DBUS_INT64_CONSTANT  (0x7fffffffffffffff)
 262 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
 263 #define _DBUS_ONE_KILOBYTE 1024
 264 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
 265 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
 266 #define _DBUS_USEC_PER_SECOND          (1000000)
 267
 268 #undef  MAX
 269 #define MAX(a, b)  (((a) > (b)) ? (a) : (b))
 270
 271 #undef  MIN
 272 #define MIN(a, b)  (((a) < (b)) ? (a) : (b))
 273
 274 #undef  ABS
 275 #define ABS(a)     (((a) < 0) ? -(a) : (a))
 276
 277 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
 278
 279 typedef void (* DBusForeachFunction) (void *element,
 280                                       void *data);
 281
 282 void _dbus_verbose_bytes           (const unsigned char *data,
 283                                     int                  len,
 284                                     int                  offset);
 285 DBUS_PRIVATE_EXPORT
 286 void _dbus_verbose_bytes_of_string (const DBusString    *str,
 287                                     int                  start,
 288                                     int                  len);
 289
 290 DBUS_PRIVATE_EXPORT
 291 extern const char *_dbus_no_memory_message;
 292 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
 293 DBUS_PRIVATE_EXPORT
 294 void _dbus_set_error_valist (DBusError  *error,
 295                              const char *name,
 296                              const char *format,
 297                              va_list     args) _DBUS_GNUC_PRINTF (3, 0);
 298
 299 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
 300 /* Memory debugging */
 301 void        _dbus_set_fail_alloc_counter        (int  until_next_fail);
 302 int         _dbus_get_fail_alloc_counter        (void);
 303 void        _dbus_set_fail_alloc_failures       (int  failures_per_failure);
 304 int         _dbus_get_fail_alloc_failures       (void);
 305 dbus_bool_t _dbus_decrement_fail_alloc_counter  (void);
 306 dbus_bool_t _dbus_disable_mem_pools             (void);
 307 DBUS_PRIVATE_EXPORT
 308 int         _dbus_get_malloc_blocks_outstanding (void);
 309
 310 typedef dbus_bool_t (* DBusTestMemoryFunction)  (void *data);
 311 DBUS_PRIVATE_EXPORT
 312 dbus_bool_t _dbus_test_oom_handling (const char             *description,
 313                                      DBusTestMemoryFunction  func,
 314                                      void                   *data);
 315 #else
 316 #define _dbus_set_fail_alloc_counter(n)
 317 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
 318
 319 /* These are constant expressions so that blocks
 320  * they protect should be optimized away
 321  */
 322 #define _dbus_decrement_fail_alloc_counter() (FALSE)
 323 #define _dbus_disable_mem_pools()            (FALSE)
 324 #define _dbus_get_malloc_blocks_outstanding  (0)
 325 #endif /* !DBUS_ENABLE_EMBEDDED_TESTS */
 326
 327 typedef void (* DBusShutdownFunction) (void *data);
 328 DBUS_PRIVATE_EXPORT
 329 dbus_bool_t _dbus_register_shutdown_func          (DBusShutdownFunction  function,
 330                                                    void                 *data);
 331 dbus_bool_t _dbus_register_shutdown_func_unlocked (DBusShutdownFunction  function,
 332                                                    void                 *data);
 333
 334 extern int _dbus_current_generation;
 335
 336 /* The weird case convention is to avoid having to change all the callers,
 337  * which would be quite a mega-patch. */
 338 typedef enum
 339 {
 340   /* index 0-4 */
 341   _DBUS_LOCK_list,
 342   _DBUS_LOCK_connection_slots,
 343   _DBUS_LOCK_pending_call_slots,
 344   _DBUS_LOCK_server_slots,
 345   _DBUS_LOCK_message_slots,
 346   /* index 5-9 */
 347   _DBUS_LOCK_bus,
 348   _DBUS_LOCK_bus_datas,
 349   _DBUS_LOCK_shutdown_funcs,
 350   _DBUS_LOCK_system_users,
 351   _DBUS_LOCK_message_cache,
 352   /* index 10-12 */
 353   _DBUS_LOCK_shared_connections,
 354   _DBUS_LOCK_machine_uuid,
 355   _DBUS_LOCK_sysdeps,
 356
 357   _DBUS_N_GLOBAL_LOCKS
 358 } DBusGlobalLock;
 359
 360 dbus_bool_t _dbus_lock   (DBusGlobalLock lock) _DBUS_GNUC_WARN_UNUSED_RESULT;
 361 void        _dbus_unlock (DBusGlobalLock lock);
 362
 363 #define _DBUS_LOCK_NAME(name)           _DBUS_LOCK_##name
 364 #define _DBUS_LOCK(name)                _dbus_lock   (_DBUS_LOCK_##name)
 365 #define _DBUS_UNLOCK(name)              _dbus_unlock (_DBUS_LOCK_##name)
 366
 367 DBUS_PRIVATE_EXPORT
 368 dbus_bool_t _dbus_threads_init_debug (void);
 369
 370 dbus_bool_t   _dbus_address_append_escaped (DBusString       *escaped,
 371                                             const DBusString *unescaped);
 372
 373 void          _dbus_set_bad_address        (DBusError         *error,
 374                                             const char        *address_problem_type,
 375                                             const char        *address_problem_field,
 376                                             const char        *address_problem_other);
 377
 378 #define DBUS_UUID_LENGTH_BYTES 16
 379 #define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4)
 380 #define DBUS_UUID_LENGTH_HEX   (DBUS_UUID_LENGTH_BYTES * 2)
 381
 382 /**
 383  * A globally unique ID ; we have one for each DBusServer, and also one for each
 384  * machine with libdbus installed on it.
 385  */
 386 union DBusGUID
 387 {
 388   dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_WORDS];     /**< guid as four uint32 values */
 389   char as_bytes[DBUS_UUID_LENGTH_BYTES];                /**< guid as 16 single-byte values */
 390 };
 391
 392 DBUS_PRIVATE_EXPORT _DBUS_GNUC_WARN_UNUSED_RESULT
 393 dbus_bool_t _dbus_generate_uuid  (DBusGUID         *uuid,
 394                                   DBusError        *error);
 395 DBUS_PRIVATE_EXPORT
 396 dbus_bool_t _dbus_uuid_encode    (const DBusGUID   *uuid,
 397                                   DBusString       *encoded);
 398 dbus_bool_t _dbus_read_uuid_file (const DBusString *filename,
 399                                   DBusGUID         *uuid,
 400                                   dbus_bool_t       create_if_not_found,
 401                                   DBusError        *error);
 402
 403 dbus_bool_t _dbus_write_uuid_file (const DBusString *filename,
 404                                    const DBusGUID   *uuid,
 405                                    DBusError        *error);
 406
 407 dbus_bool_t _dbus_get_local_machine_uuid_encoded (DBusString *uuid_str,
 408                                                   DBusError  *error);
 409
 410 #define _DBUS_PASTE2(a, b) a ## b
 411 #define _DBUS_PASTE(a, b) _DBUS_PASTE2 (a, b)
 412 #define _DBUS_STATIC_ASSERT(expr) \
 413   typedef struct { char _assertion[(expr) ? 1 : -1]; } \
 414   _DBUS_PASTE (_DBUS_STATIC_ASSERT_, __LINE__) _DBUS_GNUC_UNUSED
 415
 416 DBUS_END_DECLS
 417
 418 #endif /* DBUS_INTERNALS_H */