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
30 #include <dbus/dbus-memory.h>
31 #include <dbus/dbus-types.h>
32 #include <dbus/dbus-errors.h>
33 #include <dbus/dbus-sysdeps.h>
34 #include <dbus/dbus-threads-internal.h>
38 void _dbus_warn (const char *format,
39 ...) _DBUS_GNUC_PRINTF (1, 2);
41 void _dbus_warn_check_failed (const char *format,
42 ...) _DBUS_GNUC_PRINTF (1, 2);
45 #if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
46 #define _DBUS_FUNCTION_NAME __func__
47 #elif defined(__GNUC__) || defined(_MSC_VER)
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
83 at least gnu cc and msvc compiler are known to
84 have support for variable macro argument lists
85 add other compilers is required
87 #if defined(__GNUC__) || defined(_MSC_VER)
88 #define DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
91 #ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
92 void _dbus_verbose_real (const char *file, const int line, const char *function,
93 const char *format,...) _DBUS_GNUC_PRINTF (4, 5);
94 # define _dbus_verbose(fmt,...) _dbus_verbose_real( __FILE__,__LINE__,__FUNCTION__,fmt, ## __VA_ARGS__)
96 void _dbus_verbose_real (const char *format,
97 ...) _DBUS_GNUC_PRINTF (1, 2);
98 # define _dbus_verbose _dbus_verbose_real
100 void _dbus_verbose_reset_real (void);
101 dbus_bool_t _dbus_is_verbose_real (void);
103 # define _dbus_verbose_reset _dbus_verbose_reset_real
104 # define _dbus_is_verbose _dbus_is_verbose_real
106 # ifdef HAVE_ISO_VARARGS
107 # define _dbus_verbose(...) do { } while (0)
108 # elif defined (HAVE_GNUC_VARARGS)
109 # define _dbus_verbose(format...) do { } while (0)
111 static void _dbus_verbose(const char * x,...) {;}
113 # define _dbus_verbose_reset() do { } while (0)
114 # define _dbus_is_verbose() FALSE
115 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
117 void _dbus_trace_ref (const char *obj_name,
125 const char* _dbus_strerror (int error_number);
127 #ifdef DBUS_DISABLE_ASSERT
128 #define _dbus_assert(condition) do { } while (0)
130 void _dbus_real_assert (dbus_bool_t condition,
131 const char *condition_text,
135 #define _dbus_assert(condition) \
136 _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
137 #endif /* !DBUS_DISABLE_ASSERT */
139 #ifdef DBUS_DISABLE_ASSERT
140 #define _dbus_assert_not_reached(explanation) do { } while (0)
142 void _dbus_real_assert_not_reached (const char *explanation,
144 int line) _DBUS_GNUC_NORETURN;
145 #define _dbus_assert_not_reached(explanation) \
146 _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
147 #endif /* !DBUS_DISABLE_ASSERT */
149 #ifdef DBUS_DISABLE_CHECKS
150 #define _dbus_return_if_fail(condition)
151 #define _dbus_return_val_if_fail(condition, val)
154 extern const char *_dbus_return_if_fail_warning_format;
156 #define _dbus_return_if_fail(condition) do { \
157 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
158 if (!(condition)) { \
159 _dbus_warn_check_failed (_dbus_return_if_fail_warning_format, \
160 _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
164 #define _dbus_return_val_if_fail(condition, val) do { \
165 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
166 if (!(condition)) { \
167 _dbus_warn_check_failed (_dbus_return_if_fail_warning_format, \
168 _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
172 #endif /* !DBUS_DISABLE_ASSERT */
174 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
176 #define _DBUS_POINTER_TO_INT(pointer) ((intptr_t)(pointer))
177 #define _DBUS_INT_TO_POINTER(integer) ((void*)((intptr_t)(integer)))
179 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
181 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
182 ((intptr_t) ((unsigned char*) &((struct_type*) 0)->member))
184 #ifdef DBUS_DISABLE_CHECKS
185 /* this is an assert and not an error, but in the typical --disable-checks case (you're trying
186 * to really minimize code size), disabling these assertions makes sense.
188 #define _DBUS_ASSERT_ERROR_IS_SET(error) do { } while (0)
189 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) do { } while (0)
191 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
192 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error)))
195 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
196 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
198 /* This alignment thing is from ORBit2 */
199 /* Align a value upward to a boundary, expressed as a number of bytes.
200 * E.g. align to an 8-byte boundary with argument of 8.
204 * (this + boundary - 1)
209 #define _DBUS_ALIGN_VALUE(this, boundary) \
210 (( ((uintptr_t)(this)) + (((uintptr_t)(boundary)) -1)) & (~(((uintptr_t)(boundary))-1)))
212 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
213 ((void*)_DBUS_ALIGN_VALUE(this, boundary))
216 char* _dbus_strdup (const char *str);
217 void* _dbus_memdup (const void *mem,
219 dbus_bool_t _dbus_string_array_contains (const char **array,
221 char** _dbus_dup_string_array (const char **array);
223 #define _DBUS_INT16_MIN ((dbus_int16_t) 0x8000)
224 #define _DBUS_INT16_MAX ((dbus_int16_t) 0x7fff)
225 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
226 #define _DBUS_INT32_MIN ((dbus_int32_t) 0x80000000)
227 #define _DBUS_INT32_MAX ((dbus_int32_t) 0x7fffffff)
228 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
229 /* using 32-bit here is sort of bogus */
230 #define _DBUS_INT_MIN _DBUS_INT32_MIN
231 #define _DBUS_INT_MAX _DBUS_INT32_MAX
232 #define _DBUS_UINT_MAX _DBUS_UINT32_MAX
233 #ifdef DBUS_HAVE_INT64
234 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff)
235 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
237 #define _DBUS_ONE_KILOBYTE 1024
238 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
239 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
240 #define _DBUS_USEC_PER_SECOND (1000000)
243 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
246 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
249 #define ABS(a) (((a) < 0) ? -(a) : (a))
251 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
253 typedef void (* DBusForeachFunction) (void *element,
256 dbus_bool_t _dbus_set_fd_nonblocking (int fd,
259 void _dbus_verbose_bytes (const unsigned char *data,
262 void _dbus_verbose_bytes_of_string (const DBusString *str,
266 extern const char *_dbus_no_memory_message;
267 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
269 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
270 /* Memory debugging */
271 void _dbus_set_fail_alloc_counter (int until_next_fail);
272 int _dbus_get_fail_alloc_counter (void);
273 void _dbus_set_fail_alloc_failures (int failures_per_failure);
274 int _dbus_get_fail_alloc_failures (void);
275 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
276 dbus_bool_t _dbus_disable_mem_pools (void);
277 int _dbus_get_malloc_blocks_outstanding (void);
279 typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data);
280 dbus_bool_t _dbus_test_oom_handling (const char *description,
281 DBusTestMemoryFunction func,
284 #define _dbus_set_fail_alloc_counter(n)
285 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
287 /* These are constant expressions so that blocks
288 * they protect should be optimized away
290 #define _dbus_decrement_fail_alloc_counter() (FALSE)
291 #define _dbus_disable_mem_pools() (FALSE)
292 #define _dbus_get_malloc_blocks_outstanding (0)
293 #endif /* !DBUS_ENABLE_EMBEDDED_TESTS */
295 typedef void (* DBusShutdownFunction) (void *data);
296 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function,
298 dbus_bool_t _dbus_register_shutdown_func_unlocked (DBusShutdownFunction function,
301 extern int _dbus_current_generation;
303 /* The weird case convention is to avoid having to change all the callers,
304 * which would be quite a mega-patch. */
309 _DBUS_LOCK_connection_slots,
310 _DBUS_LOCK_pending_call_slots,
311 _DBUS_LOCK_server_slots,
312 _DBUS_LOCK_message_slots,
315 _DBUS_LOCK_bus_datas,
316 _DBUS_LOCK_shutdown_funcs,
317 _DBUS_LOCK_system_users,
318 _DBUS_LOCK_message_cache,
320 _DBUS_LOCK_shared_connections,
321 _DBUS_LOCK_machine_uuid,
327 dbus_bool_t _dbus_lock (DBusGlobalLock lock) _DBUS_GNUC_WARN_UNUSED_RESULT;
328 void _dbus_unlock (DBusGlobalLock lock);
330 #define _DBUS_LOCK_NAME(name) _DBUS_LOCK_##name
331 #define _DBUS_LOCK(name) _dbus_lock (_DBUS_LOCK_##name)
332 #define _DBUS_UNLOCK(name) _dbus_unlock (_DBUS_LOCK_##name)
334 dbus_bool_t _dbus_threads_init_debug (void);
336 dbus_bool_t _dbus_address_append_escaped (DBusString *escaped,
337 const DBusString *unescaped);
339 void _dbus_set_bad_address (DBusError *error,
340 const char *address_problem_type,
341 const char *address_problem_field,
342 const char *address_problem_other);
344 #define DBUS_UUID_LENGTH_BYTES 16
345 #define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4)
346 #define DBUS_UUID_LENGTH_HEX (DBUS_UUID_LENGTH_BYTES * 2)
349 * A globally unique ID ; we have one for each DBusServer, and also one for each
350 * machine with libdbus installed on it.
354 dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_WORDS]; /**< guid as four uint32 values */
355 char as_bytes[DBUS_UUID_LENGTH_BYTES]; /**< guid as 16 single-byte values */
358 void _dbus_generate_uuid (DBusGUID *uuid);
359 dbus_bool_t _dbus_uuid_encode (const DBusGUID *uuid,
360 DBusString *encoded);
361 dbus_bool_t _dbus_read_uuid_file (const DBusString *filename,
363 dbus_bool_t create_if_not_found,
366 dbus_bool_t _dbus_get_local_machine_uuid_encoded (DBusString *uuid_str);
368 #define _DBUS_PASTE2(a, b) a ## b
369 #define _DBUS_PASTE(a, b) _DBUS_PASTE2 (a, b)
370 #define _DBUS_STATIC_ASSERT(expr) \
371 typedef struct { char _assertion[(expr) ? 1 : -1]; } \
372 _DBUS_PASTE (_DBUS_STATIC_ASSERT_, __LINE__)
376 #endif /* DBUS_INTERNALS_H */