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