dbus-internals.h 15.7 KB
Newer Older
1
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
John Palmieri's avatar
John Palmieri committed
2
/* dbus-internals.h  random utility stuff (internal to D-Bus implementation)
Havoc Pennington's avatar
Havoc Pennington committed
3
 *
4
 * Copyright (C) 2002, 2003  Red Hat, Inc.
Havoc Pennington's avatar
Havoc Pennington committed
5
 *
6
 * Licensed under the Academic Free License version 2.1
Havoc Pennington's avatar
Havoc Pennington committed
7 8 9 10 11 12 13 14 15 16 17 18 19
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
Havoc Pennington's avatar
Havoc Pennington committed
21 22
 *
 */
23 24 25
#ifdef DBUS_INSIDE_DBUS_H
#error "You can't include dbus-internals.h in the public header dbus.h"
#endif
Havoc Pennington's avatar
Havoc Pennington committed
26 27 28 29 30 31

#ifndef DBUS_INTERNALS_H
#define DBUS_INTERNALS_H

#include <dbus/dbus-memory.h>
#include <dbus/dbus-types.h>
32
#include <dbus/dbus-errors.h>
33
#include <dbus/dbus-sysdeps.h>
34
#include <dbus/dbus-threads-internal.h>
Havoc Pennington's avatar
Havoc Pennington committed
35

36
DBUS_BEGIN_DECLS
Havoc Pennington's avatar
Havoc Pennington committed
37

38
DBUS_PRIVATE_EXPORT
39 40
void _dbus_warn               (const char *format,
                               ...) _DBUS_GNUC_PRINTF (1, 2);
41

42
DBUS_PRIVATE_EXPORT
43 44 45 46
void _dbus_warn_check_failed  (const char *format,
                               ...) _DBUS_GNUC_PRINTF (1, 2);


47 48
#if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
#define _DBUS_FUNCTION_NAME __func__
49
#elif defined(__GNUC__) || defined(_MSC_VER)
50 51 52 53 54
#define _DBUS_FUNCTION_NAME __FUNCTION__
#else
#define _DBUS_FUNCTION_NAME "unknown function"
#endif

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
/*
 * (code from GLib)
 * 
 * The _DBUS_LIKELY and _DBUS_UNLIKELY macros let the programmer give hints to 
 * the compiler about the expected result of an expression. Some compilers
 * can use this information for optimizations.
 *
 * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
 * putting assignments in the macro arg
 */
#if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
#define _DBUS_BOOLEAN_EXPR(expr)                \
 __extension__ ({                               \
   int _dbus_boolean_var_;                      \
   if (expr)                                    \
      _dbus_boolean_var_ = 1;                   \
   else                                         \
      _dbus_boolean_var_ = 0;                   \
   _dbus_boolean_var_;                          \
})
#define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1))
#define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0))
#else
#define _DBUS_LIKELY(expr) (expr)
#define _DBUS_UNLIKELY(expr) (expr)
#endif

82
#ifdef DBUS_ENABLE_VERBOSE_MODE
83

84 85 86 87 88 89 90 91 92 93
/*
 at least gnu cc and msvc compiler are known to 
 have support for variable macro argument lists
 add other compilers is required
*/
#if defined(__GNUC__) || defined(_MSC_VER) 
#define DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
#endif

#ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
94
DBUS_PRIVATE_EXPORT
95 96 97 98
void _dbus_verbose_real       (const char *file, const int line, const char *function, 
                               const char *format,...) _DBUS_GNUC_PRINTF (4, 5);
#  define _dbus_verbose(fmt,...) _dbus_verbose_real( __FILE__,__LINE__,__FUNCTION__,fmt, ## __VA_ARGS__)
#else
99
DBUS_PRIVATE_EXPORT
100 101
void _dbus_verbose_real       (const char *format,
                               ...) _DBUS_GNUC_PRINTF (1, 2);
102 103
#  define _dbus_verbose _dbus_verbose_real
#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 116
#else
#  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 128 129 130 131 132 133 134
void _dbus_trace_ref (const char *obj_name,
                      void       *obj,
                      int         old_refcount,
                      int         new_refcount,
                      const char *why,
                      const char *env_var,
                      int        *enabled);

135
DBUS_PRIVATE_EXPORT
136 137
const char* _dbus_strerror (int error_number);

138
#ifdef DBUS_DISABLE_ASSERT
139
#define _dbus_assert(condition) do { } while (0)
140
#else
141
DBUS_PRIVATE_EXPORT
142 143 144
void _dbus_real_assert (dbus_bool_t  condition,
                        const char  *condition_text,
                        const char  *file,
145 146
                        int          line,
                        const char  *func);
Havoc Pennington's avatar
Havoc Pennington committed
147
#define _dbus_assert(condition)                                         \
148
  _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
149
#endif /* !DBUS_DISABLE_ASSERT */
Havoc Pennington's avatar
Havoc Pennington committed
150

151
#ifdef DBUS_DISABLE_ASSERT
152
#define _dbus_assert_not_reached(explanation) do { } while (0)
153
#else
154
DBUS_PRIVATE_EXPORT
155 156
void _dbus_real_assert_not_reached (const char *explanation,
                                    const char *file,
157
                                    int         line) _DBUS_GNUC_NORETURN;
Havoc Pennington's avatar
Havoc Pennington committed
158
#define _dbus_assert_not_reached(explanation)                                   \
159
  _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
160
#endif /* !DBUS_DISABLE_ASSERT */
Havoc Pennington's avatar
Havoc Pennington committed
161

162 163 164 165
#ifdef DBUS_DISABLE_CHECKS
#define _dbus_return_if_fail(condition)
#define _dbus_return_val_if_fail(condition, val)
#else
166

167
DBUS_PRIVATE_EXPORT
168
extern const char *_dbus_return_if_fail_warning_format;
169

170 171 172 173 174 175
#define _dbus_return_if_fail(condition) do {                                       \
   _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_');                      \
  if (!(condition)) {                                                              \
    _dbus_warn_check_failed (_dbus_return_if_fail_warning_format,                  \
                             _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
    return;                                                                        \
176 177
  } } while (0)

178
#define _dbus_return_val_if_fail(condition, val) do {                                   \
179
   _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_');                           \
180
  if (!(condition)) {                                                                   \
181 182
    _dbus_warn_check_failed (_dbus_return_if_fail_warning_format,                       \
                             _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__);      \
183
    return (val);                                                                       \
184 185 186 187
  } } while (0)

#endif /* !DBUS_DISABLE_ASSERT */

188
#define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
Havoc Pennington's avatar
Havoc Pennington committed
189

190 191
#define _DBUS_POINTER_TO_INT(pointer) ((intptr_t)(pointer))
#define _DBUS_INT_TO_POINTER(integer) ((void*)((intptr_t)(integer)))
Havoc Pennington's avatar
Havoc Pennington committed
192

193 194
#define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))

195
#define _DBUS_STRUCT_OFFSET(struct_type, member)	\
196
    ((intptr_t) ((unsigned char*) &((struct_type*) 0)->member))
197

198 199 200 201
#ifdef DBUS_DISABLE_CHECKS
/* this is an assert and not an error, but in the typical --disable-checks case (you're trying
 * to really minimize code size), disabling these assertions makes sense.
 */
202 203
#define _DBUS_ASSERT_ERROR_IS_SET(error) do { } while (0)
#define _DBUS_ASSERT_ERROR_IS_CLEAR(error) do { } while (0)
204
#else
205 206 207 208 209 210 211 212 213 214 215 216 217 218
static inline void
_dbus_assert_error_is_set (const DBusError *error)
{
    _dbus_assert (error == NULL || dbus_error_is_set (error));
}

static inline void
_dbus_assert_error_is_clear (const DBusError *error)
{
    _dbus_assert (error == NULL || !dbus_error_is_set (error));
}

#define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert_error_is_set(error)
#define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert_error_is_clear(error)
219
#endif
220

221 222 223
#define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
#define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))

224 225 226 227 228 229 230 231 232 233 234 235
/* This alignment thing is from ORBit2 */
/* Align a value upward to a boundary, expressed as a number of bytes.
 * E.g. align to an 8-byte boundary with argument of 8.
 */

/*
 *   (this + boundary - 1)
 *          &
 *    ~(boundary - 1)
 */

#define _DBUS_ALIGN_VALUE(this, boundary) \
236
  (( ((uintptr_t)(this)) + (((uintptr_t)(boundary)) -1)) & (~(((uintptr_t)(boundary))-1)))
237 238 239 240

#define _DBUS_ALIGN_ADDRESS(this, boundary) \
  ((void*)_DBUS_ALIGN_VALUE(this, boundary))

241

242
DBUS_PRIVATE_EXPORT
243
char*       _dbus_strdup                (const char  *str);
244 245
void*       _dbus_memdup                (const void  *mem,
                                         size_t       n_bytes);
246
DBUS_PRIVATE_EXPORT
247 248 249 250
dbus_bool_t _dbus_string_array_contains (const char **array,
                                         const char  *str);
char**      _dbus_dup_string_array      (const char **array);

251 252 253 254 255 256 257 258 259 260 261
#define _DBUS_INT16_MIN	 ((dbus_int16_t) 0x8000)
#define _DBUS_INT16_MAX	 ((dbus_int16_t) 0x7fff)
#define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
#define _DBUS_INT32_MIN	 ((dbus_int32_t) 0x80000000)
#define _DBUS_INT32_MAX	 ((dbus_int32_t) 0x7fffffff)
#define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
/* using 32-bit here is sort of bogus */
#define _DBUS_INT_MIN	 _DBUS_INT32_MIN
#define _DBUS_INT_MAX	 _DBUS_INT32_MAX
#define _DBUS_UINT_MAX	 _DBUS_UINT32_MAX
#define _DBUS_INT64_MAX	 DBUS_INT64_CONSTANT  (0x7fffffffffffffff)
262
#define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
263 264
#define _DBUS_ONE_KILOBYTE 1024
#define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
265 266
#define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
#define _DBUS_USEC_PER_SECOND          (1000000)
267

268 269 270 271 272 273 274 275 276
#undef	MAX
#define MAX(a, b)  (((a) > (b)) ? (a) : (b))

#undef	MIN
#define MIN(a, b)  (((a) < (b)) ? (a) : (b))

#undef	ABS
#define ABS(a)	   (((a) < 0) ? -(a) : (a))

277 278
#define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))

279 280 281
typedef void (* DBusForeachFunction) (void *element,
                                      void *data);

282
void _dbus_verbose_bytes           (const unsigned char *data,
283 284
                                    int                  len,
                                    int                  offset);
285
DBUS_PRIVATE_EXPORT
286 287 288 289
void _dbus_verbose_bytes_of_string (const DBusString    *str,
                                    int                  start,
                                    int                  len);

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
Simon McVittie's avatar
Simon McVittie committed
294 295 296 297
void _dbus_set_error_valist (DBusError  *error,
                             const char *name,
                             const char *format,
                             va_list     args) _DBUS_GNUC_PRINTF (3, 0);
298

299
#ifdef DBUS_ENABLE_EMBEDDED_TESTS
300
/* Memory debugging */
301 302
void        _dbus_set_fail_alloc_counter        (int  until_next_fail);
int         _dbus_get_fail_alloc_counter        (void);
303 304
void        _dbus_set_fail_alloc_failures       (int  failures_per_failure);
int         _dbus_get_fail_alloc_failures       (void);
305 306
dbus_bool_t _dbus_decrement_fail_alloc_counter  (void);
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 313 314
dbus_bool_t _dbus_test_oom_handling (const char             *description,
                                     DBusTestMemoryFunction  func,
                                     void                   *data);
315 316 317
#else
#define _dbus_set_fail_alloc_counter(n)
#define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
318 319 320 321

/* These are constant expressions so that blocks
 * they protect should be optimized away
 */
322 323 324
#define _dbus_decrement_fail_alloc_counter() (FALSE)
#define _dbus_disable_mem_pools()            (FALSE)
#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 330 331 332
dbus_bool_t _dbus_register_shutdown_func          (DBusShutdownFunction  function,
                                                   void                 *data);
dbus_bool_t _dbus_register_shutdown_func_unlocked (DBusShutdownFunction  function,
                                                   void                 *data);
333 334 335

extern int _dbus_current_generation;

336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
/* The weird case convention is to avoid having to change all the callers,
 * which would be quite a mega-patch. */
typedef enum
{
  /* index 0-4 */
  _DBUS_LOCK_list,
  _DBUS_LOCK_connection_slots,
  _DBUS_LOCK_pending_call_slots,
  _DBUS_LOCK_server_slots,
  _DBUS_LOCK_message_slots,
  /* index 5-9 */
  _DBUS_LOCK_bus,
  _DBUS_LOCK_bus_datas,
  _DBUS_LOCK_shutdown_funcs,
  _DBUS_LOCK_system_users,
  _DBUS_LOCK_message_cache,
352
  /* index 10-12 */
353 354
  _DBUS_LOCK_shared_connections,
  _DBUS_LOCK_machine_uuid,
355
  _DBUS_LOCK_sysdeps,
356 357 358 359

  _DBUS_N_GLOBAL_LOCKS
} DBusGlobalLock;

360 361
dbus_bool_t _dbus_lock   (DBusGlobalLock lock) _DBUS_GNUC_WARN_UNUSED_RESULT;
void        _dbus_unlock (DBusGlobalLock lock);
362 363 364 365

#define _DBUS_LOCK_NAME(name)           _DBUS_LOCK_##name
#define _DBUS_LOCK(name)                _dbus_lock   (_DBUS_LOCK_##name)
#define _DBUS_UNLOCK(name)              _dbus_unlock (_DBUS_LOCK_##name)
366

367
DBUS_PRIVATE_EXPORT
368 369
dbus_bool_t _dbus_threads_init_debug (void);

370 371 372
dbus_bool_t   _dbus_address_append_escaped (DBusString       *escaped,
                                            const DBusString *unescaped);

373 374 375 376 377
void          _dbus_set_bad_address        (DBusError         *error,
                                            const char        *address_problem_type,
                                            const char        *address_problem_field,
                                            const char        *address_problem_other);

378
#define DBUS_UUID_LENGTH_BYTES 16
379 380
#define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4)
#define DBUS_UUID_LENGTH_HEX   (DBUS_UUID_LENGTH_BYTES * 2)
381 382 383 384 385 386 387

/**
 * A globally unique ID ; we have one for each DBusServer, and also one for each
 * machine with libdbus installed on it.
 */
union DBusGUID
{
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
};

Simon McVittie's avatar
Simon McVittie committed
392 393 394
DBUS_PRIVATE_EXPORT _DBUS_GNUC_WARN_UNUSED_RESULT
dbus_bool_t _dbus_generate_uuid  (DBusGUID         *uuid,
                                  DBusError        *error);
395
DBUS_PRIVATE_EXPORT
396 397 398 399 400 401 402
dbus_bool_t _dbus_uuid_encode    (const DBusGUID   *uuid,
                                  DBusString       *encoded);
dbus_bool_t _dbus_read_uuid_file (const DBusString *filename,
                                  DBusGUID         *uuid,
                                  dbus_bool_t       create_if_not_found,
                                  DBusError        *error);

403 404 405 406
dbus_bool_t _dbus_write_uuid_file (const DBusString *filename,
                                   const DBusGUID   *uuid,
                                   DBusError        *error);

Simon McVittie's avatar
Simon McVittie committed
407 408
dbus_bool_t _dbus_get_local_machine_uuid_encoded (DBusString *uuid_str,
                                                  DBusError  *error);
409

410 411 412 413
#define _DBUS_PASTE2(a, b) a ## b
#define _DBUS_PASTE(a, b) _DBUS_PASTE2 (a, b)
#define _DBUS_STATIC_ASSERT(expr) \
  typedef struct { char _assertion[(expr) ? 1 : -1]; } \
414
  _DBUS_PASTE (_DBUS_STATIC_ASSERT_, __LINE__) _DBUS_GNUC_UNUSED
415

416
DBUS_END_DECLS
Havoc Pennington's avatar
Havoc Pennington committed
417 418

#endif /* DBUS_INTERNALS_H */