1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-internals.h random utility stuff (internal to D-Bus implementation)
4 * Copyright (C) 2002, 2003 Red Hat, Inc.
6 * Licensed under the Academic Free License version 2.1
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.
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.
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
23 #ifdef DBUS_INSIDE_DBUS_H
24 #error "You can't include dbus-internals.h in the public header dbus.h"
27 #ifndef DBUS_INTERNALS_H
28 #define DBUS_INTERNALS_H
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>
40 void _dbus_warn (const char *format,
41 ...) _DBUS_GNUC_PRINTF (1, 2);
43 #if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
44 #define _DBUS_FUNCTION_NAME __func__
45 #elif defined(__GNUC__)
46 #define _DBUS_FUNCTION_NAME __FUNCTION__
48 #define _DBUS_FUNCTION_NAME "unknown function"
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.
58 * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
59 * putting assignments in the macro arg
61 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
62 #define _DBUS_BOOLEAN_EXPR(expr) \
64 int _dbus_boolean_var_; \
66 _dbus_boolean_var_ = 1; \
68 _dbus_boolean_var_ = 0; \
71 #define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1))
72 #define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0))
74 #define _DBUS_LIKELY(expr) (expr)
75 #define _DBUS_UNLIKELY(expr) (expr)
78 #ifdef DBUS_ENABLE_VERBOSE_MODE
80 void _dbus_verbose_real (const char *format,
81 ...) _DBUS_GNUC_PRINTF (1, 2);
82 void _dbus_verbose_reset_real (void);
83 dbus_bool_t _dbus_is_verbose_real (void);
85 # define _dbus_verbose _dbus_verbose_real
86 # define _dbus_verbose_reset _dbus_verbose_reset_real
87 # define _dbus_is_verbose _dbus_is_verbose_real
89 # ifdef HAVE_ISO_VARARGS
90 # define _dbus_verbose(...)
91 # elif defined (HAVE_GNUC_VARARGS)
92 # define _dbus_verbose(format...)
94 # error "This compiler does not support varargs macros and thus verbose mode can't be disabled meaningfully"
96 # define _dbus_verbose_reset()
97 # define _dbus_is_verbose() FALSE
98 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
100 const char* _dbus_strerror (int error_number);
102 #ifdef DBUS_DISABLE_ASSERT
103 #define _dbus_assert(condition)
105 void _dbus_real_assert (dbus_bool_t condition,
106 const char *condition_text,
110 #define _dbus_assert(condition) \
111 _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
112 #endif /* !DBUS_DISABLE_ASSERT */
114 #ifdef DBUS_DISABLE_ASSERT
115 #define _dbus_assert_not_reached(explanation)
117 void _dbus_real_assert_not_reached (const char *explanation,
119 int line) _DBUS_GNUC_NORETURN;
120 #define _dbus_assert_not_reached(explanation) \
121 _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
122 #endif /* !DBUS_DISABLE_ASSERT */
124 #ifdef DBUS_DISABLE_CHECKS
125 #define _dbus_return_if_fail(condition)
126 #define _dbus_return_val_if_fail(condition, val)
128 extern const char _dbus_return_if_fail_warning_format[];
130 #define _dbus_return_if_fail(condition) do { \
131 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
132 if (!(condition)) { \
133 _dbus_warn (_dbus_return_if_fail_warning_format, \
134 _dbus_getpid (), _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
138 #define _dbus_return_val_if_fail(condition, val) do { \
139 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
140 if (!(condition)) { \
141 _dbus_warn (_dbus_return_if_fail_warning_format, \
142 _dbus_getpid (), _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
146 #endif /* !DBUS_DISABLE_ASSERT */
148 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
150 #define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
151 #define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
153 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
155 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
156 ((long) ((unsigned char*) &((struct_type*) 0)->member))
158 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
159 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error)))
161 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
162 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
164 /* This alignment thing is from ORBit2 */
165 /* Align a value upward to a boundary, expressed as a number of bytes.
166 * E.g. align to an 8-byte boundary with argument of 8.
170 * (this + boundary - 1)
175 #define _DBUS_ALIGN_VALUE(this, boundary) \
176 (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1)))
178 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
179 ((void*)_DBUS_ALIGN_VALUE(this, boundary))
182 char* _dbus_strdup (const char *str);
183 void* _dbus_memdup (const void *mem,
185 dbus_bool_t _dbus_string_array_contains (const char **array,
187 char** _dbus_dup_string_array (const char **array);
189 #define _DBUS_INT16_MIN ((dbus_int16_t) 0x8000)
190 #define _DBUS_INT16_MAX ((dbus_int16_t) 0x7fff)
191 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
192 #define _DBUS_INT32_MIN ((dbus_int32_t) 0x80000000)
193 #define _DBUS_INT32_MAX ((dbus_int32_t) 0x7fffffff)
194 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
195 /* using 32-bit here is sort of bogus */
196 #define _DBUS_INT_MIN _DBUS_INT32_MIN
197 #define _DBUS_INT_MAX _DBUS_INT32_MAX
198 #define _DBUS_UINT_MAX _DBUS_UINT32_MAX
199 #ifdef DBUS_HAVE_INT64
200 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff)
201 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
203 #define _DBUS_ONE_KILOBYTE 1024
204 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
205 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
206 #define _DBUS_USEC_PER_SECOND (1000000)
209 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
212 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
215 #define ABS(a) (((a) < 0) ? -(a) : (a))
217 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
219 typedef void (* DBusForeachFunction) (void *element,
222 dbus_bool_t _dbus_set_fd_nonblocking (int fd,
225 void _dbus_verbose_bytes (const unsigned char *data,
228 void _dbus_verbose_bytes_of_string (const DBusString *str,
232 const char* _dbus_header_field_to_string (int header_field);
234 extern const char _dbus_no_memory_message[];
235 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
237 #ifdef DBUS_BUILD_TESTS
238 /* Memory debugging */
239 void _dbus_set_fail_alloc_counter (int until_next_fail);
240 int _dbus_get_fail_alloc_counter (void);
241 void _dbus_set_fail_alloc_failures (int failures_per_failure);
242 int _dbus_get_fail_alloc_failures (void);
243 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
244 dbus_bool_t _dbus_disable_mem_pools (void);
245 int _dbus_get_malloc_blocks_outstanding (void);
247 typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data);
248 dbus_bool_t _dbus_test_oom_handling (const char *description,
249 DBusTestMemoryFunction func,
252 #define _dbus_set_fail_alloc_counter(n)
253 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
255 /* These are constant expressions so that blocks
256 * they protect should be optimized away
258 #define _dbus_decrement_fail_alloc_counter() (FALSE)
259 #define _dbus_disable_mem_pools() (FALSE)
260 #define _dbus_get_malloc_blocks_outstanding (0)
261 #endif /* !DBUS_BUILD_TESTS */
263 typedef void (* DBusShutdownFunction) (void *data);
264 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function,
267 extern int _dbus_current_generation;
269 /* Thread initializers */
270 #define _DBUS_LOCK_NAME(name) _dbus_lock_##name
271 #define _DBUS_DECLARE_GLOBAL_LOCK(name) extern DBusMutex *_dbus_lock_##name
272 #define _DBUS_DEFINE_GLOBAL_LOCK(name) DBusMutex *_dbus_lock_##name
273 #define _DBUS_LOCK(name) _dbus_mutex_lock (_dbus_lock_##name)
274 #define _DBUS_UNLOCK(name) _dbus_mutex_unlock (_dbus_lock_##name)
276 _DBUS_DECLARE_GLOBAL_LOCK (list);
277 _DBUS_DECLARE_GLOBAL_LOCK (connection_slots);
278 _DBUS_DECLARE_GLOBAL_LOCK (pending_call_slots);
279 _DBUS_DECLARE_GLOBAL_LOCK (server_slots);
280 _DBUS_DECLARE_GLOBAL_LOCK (message_slots);
281 _DBUS_DECLARE_GLOBAL_LOCK (atomic);
282 _DBUS_DECLARE_GLOBAL_LOCK (bus);
283 _DBUS_DECLARE_GLOBAL_LOCK (shutdown_funcs);
284 _DBUS_DECLARE_GLOBAL_LOCK (system_users);
285 _DBUS_DECLARE_GLOBAL_LOCK (message_cache);
286 _DBUS_DECLARE_GLOBAL_LOCK (shared_connections);
287 _DBUS_DECLARE_GLOBAL_LOCK (win_fds);
288 _DBUS_DECLARE_GLOBAL_LOCK (sid_atom_cache);
289 #define _DBUS_N_GLOBAL_LOCKS (13)
291 dbus_bool_t _dbus_threads_init_debug (void);
293 dbus_bool_t _dbus_address_append_escaped (DBusString *escaped,
294 const DBusString *unescaped);
298 #endif /* DBUS_INTERNALS_H */