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 #define DBUS_SESSION_BUS_DEFAULT_ADDRESS "autolaunch:"
42 void _dbus_warn (const char *format,
43 ...) _DBUS_GNUC_PRINTF (1, 2);
45 #if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
46 #define _DBUS_FUNCTION_NAME __func__
47 #elif defined(__GNUC__)
48 #define _DBUS_FUNCTION_NAME __FUNCTION__
50 #define _DBUS_FUNCTION_NAME "unknown function"
56 * The _DBUS_LIKELY and _DBUS_UNLIKELY macros let the programmer give hints to
57 * the compiler about the expected result of an expression. Some compilers
58 * can use this information for optimizations.
60 * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
61 * putting assignments in the macro arg
63 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
64 #define _DBUS_BOOLEAN_EXPR(expr) \
66 int _dbus_boolean_var_; \
68 _dbus_boolean_var_ = 1; \
70 _dbus_boolean_var_ = 0; \
73 #define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1))
74 #define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0))
76 #define _DBUS_LIKELY(expr) (expr)
77 #define _DBUS_UNLIKELY(expr) (expr)
80 #ifdef DBUS_ENABLE_VERBOSE_MODE
82 void _dbus_verbose_real (const char *format,
83 ...) _DBUS_GNUC_PRINTF (1, 2);
84 void _dbus_verbose_reset_real (void);
85 dbus_bool_t _dbus_is_verbose_real (void);
87 # define _dbus_verbose _dbus_verbose_real
88 # define _dbus_verbose_reset _dbus_verbose_reset_real
89 # define _dbus_is_verbose _dbus_is_verbose_real
91 # ifdef HAVE_ISO_VARARGS
92 # define _dbus_verbose(...)
93 # elif defined (HAVE_GNUC_VARARGS)
94 # define _dbus_verbose(format...)
96 # error "This compiler does not support varargs macros and thus verbose mode can't be disabled meaningfully"
98 # define _dbus_verbose_reset()
99 # define _dbus_is_verbose() FALSE
100 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
102 const char* _dbus_strerror (int error_number);
104 #ifdef DBUS_DISABLE_ASSERT
105 #define _dbus_assert(condition)
107 void _dbus_real_assert (dbus_bool_t condition,
108 const char *condition_text,
112 #define _dbus_assert(condition) \
113 _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
114 #endif /* !DBUS_DISABLE_ASSERT */
116 #ifdef DBUS_DISABLE_ASSERT
117 #define _dbus_assert_not_reached(explanation)
119 void _dbus_real_assert_not_reached (const char *explanation,
121 int line) _DBUS_GNUC_NORETURN;
122 #define _dbus_assert_not_reached(explanation) \
123 _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
124 #endif /* !DBUS_DISABLE_ASSERT */
126 #ifdef DBUS_DISABLE_CHECKS
127 #define _dbus_return_if_fail(condition)
128 #define _dbus_return_val_if_fail(condition, val)
130 extern const char _dbus_return_if_fail_warning_format[];
132 #define _dbus_return_if_fail(condition) do { \
133 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
134 if (!(condition)) { \
135 _dbus_warn (_dbus_return_if_fail_warning_format, \
136 _dbus_getpid (), _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
140 #define _dbus_return_val_if_fail(condition, val) do { \
141 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
142 if (!(condition)) { \
143 _dbus_warn (_dbus_return_if_fail_warning_format, \
144 _dbus_getpid (), _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
148 #endif /* !DBUS_DISABLE_ASSERT */
150 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
152 #define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
153 #define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
155 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
157 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
158 ((long) ((unsigned char*) &((struct_type*) 0)->member))
160 #ifdef DBUS_DISABLE_CHECKS
161 /* this is an assert and not an error, but in the typical --disable-checks case (you're trying
162 * to really minimize code size), disabling these assertions makes sense.
164 #define _DBUS_ASSERT_ERROR_IS_SET(error)
165 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error)
167 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
168 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error)))
171 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
172 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
174 /* This alignment thing is from ORBit2 */
175 /* Align a value upward to a boundary, expressed as a number of bytes.
176 * E.g. align to an 8-byte boundary with argument of 8.
180 * (this + boundary - 1)
185 #define _DBUS_ALIGN_VALUE(this, boundary) \
186 (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1)))
188 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
189 ((void*)_DBUS_ALIGN_VALUE(this, boundary))
192 char* _dbus_strdup (const char *str);
193 void* _dbus_memdup (const void *mem,
195 dbus_bool_t _dbus_string_array_contains (const char **array,
197 char** _dbus_dup_string_array (const char **array);
199 #define _DBUS_INT16_MIN ((dbus_int16_t) 0x8000)
200 #define _DBUS_INT16_MAX ((dbus_int16_t) 0x7fff)
201 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
202 #define _DBUS_INT32_MIN ((dbus_int32_t) 0x80000000)
203 #define _DBUS_INT32_MAX ((dbus_int32_t) 0x7fffffff)
204 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
205 /* using 32-bit here is sort of bogus */
206 #define _DBUS_INT_MIN _DBUS_INT32_MIN
207 #define _DBUS_INT_MAX _DBUS_INT32_MAX
208 #define _DBUS_UINT_MAX _DBUS_UINT32_MAX
209 #ifdef DBUS_HAVE_INT64
210 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff)
211 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
213 #define _DBUS_ONE_KILOBYTE 1024
214 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
215 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
216 #define _DBUS_USEC_PER_SECOND (1000000)
219 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
222 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
225 #define ABS(a) (((a) < 0) ? -(a) : (a))
227 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
229 typedef void (* DBusForeachFunction) (void *element,
232 dbus_bool_t _dbus_set_fd_nonblocking (int fd,
235 void _dbus_verbose_bytes (const unsigned char *data,
238 void _dbus_verbose_bytes_of_string (const DBusString *str,
242 const char* _dbus_header_field_to_string (int header_field);
244 extern const char _dbus_no_memory_message[];
245 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
247 #ifdef DBUS_BUILD_TESTS
248 /* Memory debugging */
249 void _dbus_set_fail_alloc_counter (int until_next_fail);
250 int _dbus_get_fail_alloc_counter (void);
251 void _dbus_set_fail_alloc_failures (int failures_per_failure);
252 int _dbus_get_fail_alloc_failures (void);
253 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
254 dbus_bool_t _dbus_disable_mem_pools (void);
255 int _dbus_get_malloc_blocks_outstanding (void);
257 typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data);
258 dbus_bool_t _dbus_test_oom_handling (const char *description,
259 DBusTestMemoryFunction func,
262 #define _dbus_set_fail_alloc_counter(n)
263 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
265 /* These are constant expressions so that blocks
266 * they protect should be optimized away
268 #define _dbus_decrement_fail_alloc_counter() (FALSE)
269 #define _dbus_disable_mem_pools() (FALSE)
270 #define _dbus_get_malloc_blocks_outstanding (0)
271 #endif /* !DBUS_BUILD_TESTS */
273 typedef void (* DBusShutdownFunction) (void *data);
274 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function,
277 extern int _dbus_current_generation;
279 /* Thread initializers */
280 #define _DBUS_LOCK_NAME(name) _dbus_lock_##name
281 #define _DBUS_DECLARE_GLOBAL_LOCK(name) extern DBusMutex *_dbus_lock_##name
282 #define _DBUS_DEFINE_GLOBAL_LOCK(name) DBusMutex *_dbus_lock_##name
283 #define _DBUS_LOCK(name) _dbus_mutex_lock (_dbus_lock_##name)
284 #define _DBUS_UNLOCK(name) _dbus_mutex_unlock (_dbus_lock_##name)
286 _DBUS_DECLARE_GLOBAL_LOCK (list);
287 _DBUS_DECLARE_GLOBAL_LOCK (connection_slots);
288 _DBUS_DECLARE_GLOBAL_LOCK (pending_call_slots);
289 _DBUS_DECLARE_GLOBAL_LOCK (server_slots);
290 _DBUS_DECLARE_GLOBAL_LOCK (message_slots);
291 _DBUS_DECLARE_GLOBAL_LOCK (atomic);
292 _DBUS_DECLARE_GLOBAL_LOCK (bus);
293 _DBUS_DECLARE_GLOBAL_LOCK (shutdown_funcs);
294 _DBUS_DECLARE_GLOBAL_LOCK (system_users);
295 _DBUS_DECLARE_GLOBAL_LOCK (message_cache);
296 _DBUS_DECLARE_GLOBAL_LOCK (shared_connections);
297 _DBUS_DECLARE_GLOBAL_LOCK (win_fds);
298 _DBUS_DECLARE_GLOBAL_LOCK (sid_atom_cache);
299 _DBUS_DECLARE_GLOBAL_LOCK (machine_uuid);
300 #define _DBUS_N_GLOBAL_LOCKS (14)
302 dbus_bool_t _dbus_threads_init_debug (void);
304 dbus_bool_t _dbus_address_append_escaped (DBusString *escaped,
305 const DBusString *unescaped);
307 void _dbus_set_bad_address (DBusError *error,
308 const char *address_problem_type,
309 const char *address_problem_field,
310 const char *address_problem_other);
312 #define DBUS_UUID_LENGTH_BYTES 16
313 #define DBUS_UUID_LENGTH_HEX (DBUS_UUID_LENGTH_BYTES * 2)
316 * A globally unique ID ; we have one for each DBusServer, and also one for each
317 * machine with libdbus installed on it.
321 dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_BYTES / 4];
322 char as_bytes[DBUS_UUID_LENGTH_BYTES];
325 void _dbus_generate_uuid (DBusGUID *uuid);
326 dbus_bool_t _dbus_uuid_encode (const DBusGUID *uuid,
327 DBusString *encoded);
328 dbus_bool_t _dbus_read_uuid_file (const DBusString *filename,
330 dbus_bool_t create_if_not_found,
333 dbus_bool_t _dbus_get_local_machine_uuid_encoded (DBusString *uuid_str);
337 #endif /* DBUS_INTERNALS_H */