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