dbus-internals.h revision aa4f823781185fb18187714798795d7e4b0c9b65 
1/* -*- mode: C; c-file-style: "gnu" -*- */
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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.h>
37
38DBUS_BEGIN_DECLS
39
40void _dbus_warn               (const char *format,
41                               ...) _DBUS_GNUC_PRINTF (1, 2);
42
43#if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
44#define _DBUS_FUNCTION_NAME __func__
45#elif defined(__GNUC__)
46#define _DBUS_FUNCTION_NAME __FUNCTION__
47#else
48#define _DBUS_FUNCTION_NAME "unknown function"
49#endif
50
51/*
52 * (code from GLib)
53 *
54 * The _DBUS_LIKELY and _DBUS_UNLIKELY macros let the programmer give hints to
55 * the compiler about the expected result of an expression. Some compilers
56 * can use this information for optimizations.
57 *
58 * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
59 * putting assignments in the macro arg
60 */
61#if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
62#define _DBUS_BOOLEAN_EXPR(expr)                \
63 __extension__ ({                               \
64   int _dbus_boolean_var_;                      \
65   if (expr)                                    \
66      _dbus_boolean_var_ = 1;                   \
67   else                                         \
68      _dbus_boolean_var_ = 0;                   \
69   _dbus_boolean_var_;                          \
70})
71#define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1))
72#define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0))
73#else
74#define _DBUS_LIKELY(expr) (expr)
75#define _DBUS_UNLIKELY(expr) (expr)
76#endif
77
78#ifdef DBUS_ENABLE_VERBOSE_MODE
79
80void _dbus_verbose_real       (const char *format,
81                               ...) _DBUS_GNUC_PRINTF (1, 2);
82void _dbus_verbose_reset_real (void);
83
84#  define _dbus_verbose _dbus_verbose_real
85#  define _dbus_verbose_reset _dbus_verbose_reset_real
86#else
87#  ifdef HAVE_ISO_VARARGS
88#    define _dbus_verbose(...)
89#  elif defined (HAVE_GNUC_VARARGS)
90#    define _dbus_verbose(format...)
91#  else
92#    error "This compiler does not support varargs macros and thus verbose mode can't be disabled meaningfully"
93#  endif
94#  define _dbus_verbose_reset()
95#endif /* !DBUS_ENABLE_VERBOSE_MODE */
96
97const char* _dbus_strerror (int error_number);
98
99#ifdef DBUS_DISABLE_ASSERT
100#define _dbus_assert(condition)
101#else
102void _dbus_real_assert (dbus_bool_t  condition,
103                        const char  *condition_text,
104                        const char  *file,
105                        int          line,
106                        const char  *func);
107#define _dbus_assert(condition)                                         \
108  _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
109#endif /* !DBUS_DISABLE_ASSERT */
110
111#ifdef DBUS_DISABLE_ASSERT
112#define _dbus_assert_not_reached(explanation)
113#else
114void _dbus_real_assert_not_reached (const char *explanation,
115                                    const char *file,
116                                    int         line) _DBUS_GNUC_NORETURN;
117#define _dbus_assert_not_reached(explanation)                                   \
118  _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
119#endif /* !DBUS_DISABLE_ASSERT */
120
121#ifdef DBUS_DISABLE_CHECKS
122#define _dbus_return_if_fail(condition)
123#define _dbus_return_val_if_fail(condition, val)
124#else
125extern const char _dbus_return_if_fail_warning_format[];
126
127#define _dbus_return_if_fail(condition) do {                                            \
128   _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_');                           \
129  if (!(condition)) {                                                                   \
130    _dbus_warn (_dbus_return_if_fail_warning_format,                                    \
131                _dbus_getpid (), _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__);  \
132    return;                                                                             \
133  } } while (0)
134
135#define _dbus_return_val_if_fail(condition, val) do {                                   \
136   _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_');                           \
137  if (!(condition)) {                                                                   \
138    _dbus_warn (_dbus_return_if_fail_warning_format,                                    \
139                _dbus_getpid (), _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__);  \
140    return (val);                                                                       \
141  } } while (0)
142
143#endif /* !DBUS_DISABLE_ASSERT */
144
145#define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
146
147#define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
148#define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
149
150#define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
151
152#define _DBUS_STRUCT_OFFSET(struct_type, member)	\
153    ((long) ((unsigned char*) &((struct_type*) 0)->member))
154
155#define _DBUS_ASSERT_ERROR_IS_SET(error)   _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
156#define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error)))
157
158#define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
159#define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
160
161/* This alignment thing is from ORBit2 */
162/* Align a value upward to a boundary, expressed as a number of bytes.
163 * E.g. align to an 8-byte boundary with argument of 8.
164 */
165
166/*
167 *   (this + boundary - 1)
168 *          &
169 *    ~(boundary - 1)
170 */
171
172#define _DBUS_ALIGN_VALUE(this, boundary) \
173  (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1)))
174
175#define _DBUS_ALIGN_ADDRESS(this, boundary) \
176  ((void*)_DBUS_ALIGN_VALUE(this, boundary))
177
178
179char*       _dbus_strdup                (const char  *str);
180void*       _dbus_memdup                (const void  *mem,
181                                         size_t       n_bytes);
182dbus_bool_t _dbus_string_array_contains (const char **array,
183                                         const char  *str);
184char**      _dbus_dup_string_array      (const char **array);
185
186#define _DBUS_INT16_MIN	 ((dbus_int16_t) 0x8000)
187#define _DBUS_INT16_MAX	 ((dbus_int16_t) 0x7fff)
188#define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
189#define _DBUS_INT32_MIN	 ((dbus_int32_t) 0x80000000)
190#define _DBUS_INT32_MAX	 ((dbus_int32_t) 0x7fffffff)
191#define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
192/* using 32-bit here is sort of bogus */
193#define _DBUS_INT_MIN	 _DBUS_INT32_MIN
194#define _DBUS_INT_MAX	 _DBUS_INT32_MAX
195#define _DBUS_UINT_MAX	 _DBUS_UINT32_MAX
196#ifdef DBUS_HAVE_INT64
197#define _DBUS_INT64_MAX	 DBUS_INT64_CONSTANT  (0x7fffffffffffffff)
198#define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
199#endif
200#define _DBUS_ONE_KILOBYTE 1024
201#define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
202#define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
203#define _DBUS_USEC_PER_SECOND          (1000000)
204
205#undef	MAX
206#define MAX(a, b)  (((a) > (b)) ? (a) : (b))
207
208#undef	MIN
209#define MIN(a, b)  (((a) < (b)) ? (a) : (b))
210
211#undef	ABS
212#define ABS(a)	   (((a) < 0) ? -(a) : (a))
213
214#define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
215
216typedef void (* DBusForeachFunction) (void *element,
217                                      void *data);
218
219dbus_bool_t _dbus_set_fd_nonblocking (int             fd,
220                                      DBusError      *error);
221
222void _dbus_verbose_bytes           (const unsigned char *data,
223                                    int                  len,
224                                    int                  offset);
225void _dbus_verbose_bytes_of_string (const DBusString    *str,
226                                    int                  start,
227                                    int                  len);
228
229const char* _dbus_header_field_to_string (int header_field);
230
231extern const char _dbus_no_memory_message[];
232#define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
233
234#ifdef DBUS_BUILD_TESTS
235/* Memory debugging */
236void        _dbus_set_fail_alloc_counter        (int  until_next_fail);
237int         _dbus_get_fail_alloc_counter        (void);
238void        _dbus_set_fail_alloc_failures       (int  failures_per_failure);
239int         _dbus_get_fail_alloc_failures       (void);
240dbus_bool_t _dbus_decrement_fail_alloc_counter  (void);
241dbus_bool_t _dbus_disable_mem_pools             (void);
242int         _dbus_get_malloc_blocks_outstanding (void);
243
244typedef dbus_bool_t (* DBusTestMemoryFunction)  (void *data);
245dbus_bool_t _dbus_test_oom_handling (const char             *description,
246                                     DBusTestMemoryFunction  func,
247                                     void                   *data);
248#else
249#define _dbus_set_fail_alloc_counter(n)
250#define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
251
252/* These are constant expressions so that blocks
253 * they protect should be optimized away
254 */
255#define _dbus_decrement_fail_alloc_counter() (FALSE)
256#define _dbus_disable_mem_pools()            (FALSE)
257#define _dbus_get_malloc_blocks_outstanding  (0)
258#endif /* !DBUS_BUILD_TESTS */
259
260typedef void (* DBusShutdownFunction) (void *data);
261dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction  function,
262                                          void                 *data);
263
264extern int _dbus_current_generation;
265
266/* Thread initializers */
267#define _DBUS_LOCK_NAME(name)           _dbus_lock_##name
268#define _DBUS_DECLARE_GLOBAL_LOCK(name) extern DBusMutex  *_dbus_lock_##name
269#define _DBUS_DEFINE_GLOBAL_LOCK(name)  DBusMutex         *_dbus_lock_##name
270#define _DBUS_LOCK(name)                dbus_mutex_lock   (_dbus_lock_##name)
271#define _DBUS_UNLOCK(name)              dbus_mutex_unlock (_dbus_lock_##name)
272
273_DBUS_DECLARE_GLOBAL_LOCK (list);
274_DBUS_DECLARE_GLOBAL_LOCK (connection_slots);
275_DBUS_DECLARE_GLOBAL_LOCK (pending_call_slots);
276_DBUS_DECLARE_GLOBAL_LOCK (server_slots);
277_DBUS_DECLARE_GLOBAL_LOCK (message_slots);
278_DBUS_DECLARE_GLOBAL_LOCK (atomic);
279_DBUS_DECLARE_GLOBAL_LOCK (bus);
280_DBUS_DECLARE_GLOBAL_LOCK (shutdown_funcs);
281_DBUS_DECLARE_GLOBAL_LOCK (system_users);
282_DBUS_DECLARE_GLOBAL_LOCK (message_cache);
283#define _DBUS_N_GLOBAL_LOCKS (10)
284
285dbus_bool_t _dbus_threads_init_debug (void);
286
287dbus_bool_t   _dbus_address_append_escaped (DBusString       *escaped,
288                                            const DBusString *unescaped);
289
290DBUS_END_DECLS
291
292#endif /* DBUS_INTERNALS_H */
293