1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 void _dbus_warn_check_failed (const char *format,
46 ...) _DBUS_GNUC_PRINTF (1, 2);
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__
54 #define _DBUS_FUNCTION_NAME "unknown function"
60 * The _DBUS_LIKELY and _DBUS_UNLIKELY macros let the programmer give hints to
61 * the compiler about the expected result of an expression. Some compilers
62 * can use this information for optimizations.
64 * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
65 * putting assignments in the macro arg
67 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
68 #define _DBUS_BOOLEAN_EXPR(expr) \
70 int _dbus_boolean_var_; \
72 _dbus_boolean_var_ = 1; \
74 _dbus_boolean_var_ = 0; \
77 #define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1))
78 #define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0))
80 #define _DBUS_LIKELY(expr) (expr)
81 #define _DBUS_UNLIKELY(expr) (expr)
84 #ifdef DBUS_ENABLE_VERBOSE_MODE
87 at least gnu cc and msvc compiler are known to
88 have support for variable macro argument lists
89 add other compilers is required
91 #if defined(__GNUC__) || defined(_MSC_VER)
92 #define DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
95 #ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
96 void _dbus_verbose_real (const char *file, const int line, const char *function,
97 const char *format,...) _DBUS_GNUC_PRINTF (4, 5);
98 # define _dbus_verbose(fmt,...) _dbus_verbose_real( __FILE__,__LINE__,__FUNCTION__,fmt, ## __VA_ARGS__)
100 void _dbus_verbose_real (const char *format,
101 ...) _DBUS_GNUC_PRINTF (1, 2);
102 # define _dbus_verbose _dbus_verbose_real
104 void _dbus_verbose_reset_real (void);
105 dbus_bool_t _dbus_is_verbose_real (void);
107 # define _dbus_verbose_reset _dbus_verbose_reset_real
108 # define _dbus_is_verbose _dbus_is_verbose_real
110 # ifdef HAVE_ISO_VARARGS
111 # define _dbus_verbose(...)
112 # elif defined (HAVE_GNUC_VARARGS)
113 # define _dbus_verbose(format...)
115 static void _dbus_verbose(const char * x,...) {;}
117 # define _dbus_verbose_reset()
118 # define _dbus_is_verbose() FALSE
119 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
121 const char* _dbus_strerror (int error_number);
123 #ifdef DBUS_DISABLE_ASSERT
124 #define _dbus_assert(condition)
126 void _dbus_real_assert (dbus_bool_t condition,
127 const char *condition_text,
131 #define _dbus_assert(condition) \
132 _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
133 #endif /* !DBUS_DISABLE_ASSERT */
135 #ifdef DBUS_DISABLE_ASSERT
136 #define _dbus_assert_not_reached(explanation)
138 void _dbus_real_assert_not_reached (const char *explanation,
140 int line) _DBUS_GNUC_NORETURN;
141 #define _dbus_assert_not_reached(explanation) \
142 _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
143 #endif /* !DBUS_DISABLE_ASSERT */
145 #ifdef DBUS_DISABLE_CHECKS
146 #define _dbus_return_if_fail(condition)
147 #define _dbus_return_val_if_fail(condition, val)
149 extern const char *_dbus_return_if_fail_warning_format;
151 #define _dbus_return_if_fail(condition) do { \
152 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
153 if (!(condition)) { \
154 _dbus_warn_check_failed (_dbus_return_if_fail_warning_format, \
155 _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
159 #define _dbus_return_val_if_fail(condition, val) do { \
160 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
161 if (!(condition)) { \
162 _dbus_warn_check_failed (_dbus_return_if_fail_warning_format, \
163 _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
167 #endif /* !DBUS_DISABLE_ASSERT */
169 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
171 #define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
172 #define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
174 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
176 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
177 ((long) ((unsigned char*) &((struct_type*) 0)->member))
179 #ifdef DBUS_DISABLE_CHECKS
180 /* this is an assert and not an error, but in the typical --disable-checks case (you're trying
181 * to really minimize code size), disabling these assertions makes sense.
183 #define _DBUS_ASSERT_ERROR_IS_SET(error)
184 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error)
186 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
187 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error)))
190 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
191 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
193 /* This alignment thing is from ORBit2 */
194 /* Align a value upward to a boundary, expressed as a number of bytes.
195 * E.g. align to an 8-byte boundary with argument of 8.
199 * (this + boundary - 1)
204 #define _DBUS_ALIGN_VALUE(this, boundary) \
205 (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1)))
207 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
208 ((void*)_DBUS_ALIGN_VALUE(this, boundary))
211 char* _dbus_strdup (const char *str);
212 void* _dbus_memdup (const void *mem,
214 dbus_bool_t _dbus_string_array_contains (const char **array,
216 char** _dbus_dup_string_array (const char **array);
218 #define _DBUS_INT16_MIN ((dbus_int16_t) 0x8000)
219 #define _DBUS_INT16_MAX ((dbus_int16_t) 0x7fff)
220 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
221 #define _DBUS_INT32_MIN ((dbus_int32_t) 0x80000000)
222 #define _DBUS_INT32_MAX ((dbus_int32_t) 0x7fffffff)
223 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
224 /* using 32-bit here is sort of bogus */
225 #define _DBUS_INT_MIN _DBUS_INT32_MIN
226 #define _DBUS_INT_MAX _DBUS_INT32_MAX
227 #define _DBUS_UINT_MAX _DBUS_UINT32_MAX
228 #ifdef DBUS_HAVE_INT64
229 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff)
230 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
232 #define _DBUS_ONE_KILOBYTE 1024
233 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
234 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
235 #define _DBUS_USEC_PER_SECOND (1000000)
238 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
241 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
244 #define ABS(a) (((a) < 0) ? -(a) : (a))
246 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
248 typedef void (* DBusForeachFunction) (void *element,
251 dbus_bool_t _dbus_set_fd_nonblocking (int fd,
254 void _dbus_verbose_bytes (const unsigned char *data,
257 void _dbus_verbose_bytes_of_string (const DBusString *str,
261 const char* _dbus_header_field_to_string (int header_field);
263 extern const char *_dbus_no_memory_message;
264 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
266 #ifdef DBUS_BUILD_TESTS
267 /* Memory debugging */
268 void _dbus_set_fail_alloc_counter (int until_next_fail);
269 int _dbus_get_fail_alloc_counter (void);
270 void _dbus_set_fail_alloc_failures (int failures_per_failure);
271 int _dbus_get_fail_alloc_failures (void);
272 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
273 dbus_bool_t _dbus_disable_mem_pools (void);
274 int _dbus_get_malloc_blocks_outstanding (void);
276 typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data);
277 dbus_bool_t _dbus_test_oom_handling (const char *description,
278 DBusTestMemoryFunction func,
281 #define _dbus_set_fail_alloc_counter(n)
282 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
284 /* These are constant expressions so that blocks
285 * they protect should be optimized away
287 #define _dbus_decrement_fail_alloc_counter() (FALSE)
288 #define _dbus_disable_mem_pools() (FALSE)
289 #define _dbus_get_malloc_blocks_outstanding (0)
290 #endif /* !DBUS_BUILD_TESTS */
292 typedef void (* DBusShutdownFunction) (void *data);
293 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function,
296 extern int _dbus_current_generation;
298 /* Thread initializers */
299 #define _DBUS_LOCK_NAME(name) _dbus_lock_##name
300 #define _DBUS_DECLARE_GLOBAL_LOCK(name) extern DBusMutex *_dbus_lock_##name
301 #define _DBUS_DEFINE_GLOBAL_LOCK(name) DBusMutex *_dbus_lock_##name
302 #define _DBUS_LOCK(name) _dbus_mutex_lock (_dbus_lock_##name)
303 #define _DBUS_UNLOCK(name) _dbus_mutex_unlock (_dbus_lock_##name)
306 _DBUS_DECLARE_GLOBAL_LOCK (list);
307 _DBUS_DECLARE_GLOBAL_LOCK (connection_slots);
308 _DBUS_DECLARE_GLOBAL_LOCK (pending_call_slots);
309 _DBUS_DECLARE_GLOBAL_LOCK (server_slots);
310 _DBUS_DECLARE_GLOBAL_LOCK (message_slots);
312 _DBUS_DECLARE_GLOBAL_LOCK (bus);
313 _DBUS_DECLARE_GLOBAL_LOCK (bus_datas);
314 _DBUS_DECLARE_GLOBAL_LOCK (shutdown_funcs);
315 _DBUS_DECLARE_GLOBAL_LOCK (system_users);
316 _DBUS_DECLARE_GLOBAL_LOCK (message_cache);
318 _DBUS_DECLARE_GLOBAL_LOCK (shared_connections);
319 _DBUS_DECLARE_GLOBAL_LOCK (win_fds);
320 _DBUS_DECLARE_GLOBAL_LOCK (sid_atom_cache);
321 _DBUS_DECLARE_GLOBAL_LOCK (machine_uuid);
324 _DBUS_DECLARE_GLOBAL_LOCK (atomic);
325 #define _DBUS_N_GLOBAL_LOCKS (15)
327 #define _DBUS_N_GLOBAL_LOCKS (14)
330 dbus_bool_t _dbus_threads_init_debug (void);
332 dbus_bool_t _dbus_address_append_escaped (DBusString *escaped,
333 const DBusString *unescaped);
335 void _dbus_set_bad_address (DBusError *error,
336 const char *address_problem_type,
337 const char *address_problem_field,
338 const char *address_problem_other);
340 #define DBUS_UUID_LENGTH_BYTES 16
341 #define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4)
342 #define DBUS_UUID_LENGTH_HEX (DBUS_UUID_LENGTH_BYTES * 2)
345 * A globally unique ID ; we have one for each DBusServer, and also one for each
346 * machine with libdbus installed on it.
350 dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_WORDS]; /**< guid as four uint32 values */
351 char as_bytes[DBUS_UUID_LENGTH_BYTES]; /**< guid as 16 single-byte values */
354 void _dbus_generate_uuid (DBusGUID *uuid);
355 dbus_bool_t _dbus_uuid_encode (const DBusGUID *uuid,
356 DBusString *encoded);
357 dbus_bool_t _dbus_read_uuid_file (const DBusString *filename,
359 dbus_bool_t create_if_not_found,
362 dbus_bool_t _dbus_get_local_machine_uuid_encoded (DBusString *uuid_str);
366 #endif /* DBUS_INTERNALS_H */