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 #define DBUS_SESSION_BUS_DEFAULT_ADDRESS "autolaunch:"
40 void _dbus_warn (const char *format,
41 ...) _DBUS_GNUC_PRINTF (1, 2);
43 void _dbus_warn_check_failed (const char *format,
44 ...) _DBUS_GNUC_PRINTF (1, 2);
47 #if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
48 #define _DBUS_FUNCTION_NAME __func__
49 #elif defined(__GNUC__) || defined(_MSC_VER)
50 #define _DBUS_FUNCTION_NAME __FUNCTION__
52 #define _DBUS_FUNCTION_NAME "unknown function"
56 * This is necessary to access global variables outside the DLL with MSVC,
57 * just exporting them in the .def file still leads to linker errors
58 * note: dbus_1_EXPORTS is set automatically by CMake when the DLL is built
61 # if defined(dbus_1_EXPORTS)
62 # define DBUS_EXTERN __declspec(dllexport)
64 # define DBUS_EXTERN __declspec(dllimport)
67 #define DBUS_EXTERN extern
73 * The _DBUS_LIKELY and _DBUS_UNLIKELY macros let the programmer give hints to
74 * the compiler about the expected result of an expression. Some compilers
75 * can use this information for optimizations.
77 * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
78 * putting assignments in the macro arg
80 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
81 #define _DBUS_BOOLEAN_EXPR(expr) \
83 int _dbus_boolean_var_; \
85 _dbus_boolean_var_ = 1; \
87 _dbus_boolean_var_ = 0; \
90 #define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1))
91 #define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0))
93 #define _DBUS_LIKELY(expr) (expr)
94 #define _DBUS_UNLIKELY(expr) (expr)
97 #ifdef DBUS_ENABLE_VERBOSE_MODE
100 at least gnu cc and msvc compiler are known to
101 have support for variable macro argument lists
102 add other compilers is required
104 #if defined(__GNUC__) || defined(_MSC_VER)
105 #define DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
108 #ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
109 void _dbus_verbose_real (const char *file, const int line, const char *function,
110 const char *format,...) _DBUS_GNUC_PRINTF (4, 5);
111 # define _dbus_verbose(fmt,...) _dbus_verbose_real( __FILE__,__LINE__,__FUNCTION__,fmt, ## __VA_ARGS__)
113 void _dbus_verbose_real (const char *format,
114 ...) _DBUS_GNUC_PRINTF (1, 2);
115 # define _dbus_verbose _dbus_verbose_real
117 void _dbus_verbose_reset_real (void);
118 dbus_bool_t _dbus_is_verbose_real (void);
120 # define _dbus_verbose_reset _dbus_verbose_reset_real
121 # define _dbus_is_verbose _dbus_is_verbose_real
123 # ifdef HAVE_ISO_VARARGS
124 # define _dbus_verbose(...)
125 # elif defined (HAVE_GNUC_VARARGS)
126 # define _dbus_verbose(format...)
128 static void _dbus_verbose(const char * x,...) {;}
130 # define _dbus_verbose_reset()
131 # define _dbus_is_verbose() FALSE
132 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
134 const char* _dbus_strerror (int error_number);
136 #ifdef DBUS_DISABLE_ASSERT
137 #define _dbus_assert(condition)
139 void _dbus_real_assert (dbus_bool_t condition,
140 const char *condition_text,
144 #define _dbus_assert(condition) \
145 _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
146 #endif /* !DBUS_DISABLE_ASSERT */
148 #ifdef DBUS_DISABLE_ASSERT
149 #define _dbus_assert_not_reached(explanation)
151 void _dbus_real_assert_not_reached (const char *explanation,
153 int line) _DBUS_GNUC_NORETURN;
154 #define _dbus_assert_not_reached(explanation) \
155 _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
156 #endif /* !DBUS_DISABLE_ASSERT */
158 #ifdef DBUS_DISABLE_CHECKS
159 #define _dbus_return_if_fail(condition)
160 #define _dbus_return_val_if_fail(condition, val)
163 DBUS_EXTERN const char *_dbus_return_if_fail_warning_format;
165 #define _dbus_return_if_fail(condition) do { \
166 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
167 if (!(condition)) { \
168 _dbus_warn_check_failed (_dbus_return_if_fail_warning_format, \
169 _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
173 #define _dbus_return_val_if_fail(condition, val) do { \
174 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
175 if (!(condition)) { \
176 _dbus_warn_check_failed (_dbus_return_if_fail_warning_format, \
177 _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
181 #endif /* !DBUS_DISABLE_ASSERT */
183 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
185 #define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
186 #define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
188 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
190 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
191 ((long) ((unsigned char*) &((struct_type*) 0)->member))
193 #ifdef DBUS_DISABLE_CHECKS
194 /* this is an assert and not an error, but in the typical --disable-checks case (you're trying
195 * to really minimize code size), disabling these assertions makes sense.
197 #define _DBUS_ASSERT_ERROR_IS_SET(error)
198 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error)
200 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
201 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error)))
204 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
205 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
207 /* This alignment thing is from ORBit2 */
208 /* Align a value upward to a boundary, expressed as a number of bytes.
209 * E.g. align to an 8-byte boundary with argument of 8.
213 * (this + boundary - 1)
218 #define _DBUS_ALIGN_VALUE(this, boundary) \
219 (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1)))
221 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
222 ((void*)_DBUS_ALIGN_VALUE(this, boundary))
225 char* _dbus_strdup (const char *str);
226 void* _dbus_memdup (const void *mem,
228 dbus_bool_t _dbus_string_array_contains (const char **array,
230 char** _dbus_dup_string_array (const char **array);
232 #define _DBUS_INT16_MIN ((dbus_int16_t) 0x8000)
233 #define _DBUS_INT16_MAX ((dbus_int16_t) 0x7fff)
234 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
235 #define _DBUS_INT32_MIN ((dbus_int32_t) 0x80000000)
236 #define _DBUS_INT32_MAX ((dbus_int32_t) 0x7fffffff)
237 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
238 /* using 32-bit here is sort of bogus */
239 #define _DBUS_INT_MIN _DBUS_INT32_MIN
240 #define _DBUS_INT_MAX _DBUS_INT32_MAX
241 #define _DBUS_UINT_MAX _DBUS_UINT32_MAX
242 #ifdef DBUS_HAVE_INT64
243 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff)
244 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
246 #define _DBUS_ONE_KILOBYTE 1024
247 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
248 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
249 #define _DBUS_USEC_PER_SECOND (1000000)
252 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
255 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
258 #define ABS(a) (((a) < 0) ? -(a) : (a))
260 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
262 typedef void (* DBusForeachFunction) (void *element,
265 dbus_bool_t _dbus_set_fd_nonblocking (int fd,
268 void _dbus_verbose_bytes (const unsigned char *data,
271 void _dbus_verbose_bytes_of_string (const DBusString *str,
275 const char* _dbus_header_field_to_string (int header_field);
277 DBUS_EXTERN const char *_dbus_no_memory_message;
278 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
280 #ifdef DBUS_BUILD_TESTS
281 /* Memory debugging */
282 void _dbus_set_fail_alloc_counter (int until_next_fail);
283 int _dbus_get_fail_alloc_counter (void);
284 void _dbus_set_fail_alloc_failures (int failures_per_failure);
285 int _dbus_get_fail_alloc_failures (void);
286 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
287 dbus_bool_t _dbus_disable_mem_pools (void);
288 int _dbus_get_malloc_blocks_outstanding (void);
290 typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data);
291 dbus_bool_t _dbus_test_oom_handling (const char *description,
292 DBusTestMemoryFunction func,
295 #define _dbus_set_fail_alloc_counter(n)
296 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
298 /* These are constant expressions so that blocks
299 * they protect should be optimized away
301 #define _dbus_decrement_fail_alloc_counter() (FALSE)
302 #define _dbus_disable_mem_pools() (FALSE)
303 #define _dbus_get_malloc_blocks_outstanding (0)
304 #endif /* !DBUS_BUILD_TESTS */
306 typedef void (* DBusShutdownFunction) (void *data);
307 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function,
310 extern int _dbus_current_generation;
312 /* Thread initializers */
313 #define _DBUS_LOCK_NAME(name) _dbus_lock_##name
314 #define _DBUS_DECLARE_GLOBAL_LOCK(name) extern DBusMutex *_dbus_lock_##name
315 #define _DBUS_DEFINE_GLOBAL_LOCK(name) DBusMutex *_dbus_lock_##name
316 #define _DBUS_LOCK(name) _dbus_mutex_lock (_dbus_lock_##name)
317 #define _DBUS_UNLOCK(name) _dbus_mutex_unlock (_dbus_lock_##name)
320 _DBUS_DECLARE_GLOBAL_LOCK (list);
321 _DBUS_DECLARE_GLOBAL_LOCK (connection_slots);
322 _DBUS_DECLARE_GLOBAL_LOCK (pending_call_slots);
323 _DBUS_DECLARE_GLOBAL_LOCK (server_slots);
324 _DBUS_DECLARE_GLOBAL_LOCK (message_slots);
326 _DBUS_DECLARE_GLOBAL_LOCK (bus);
327 _DBUS_DECLARE_GLOBAL_LOCK (bus_datas);
328 _DBUS_DECLARE_GLOBAL_LOCK (shutdown_funcs);
329 _DBUS_DECLARE_GLOBAL_LOCK (system_users);
330 _DBUS_DECLARE_GLOBAL_LOCK (message_cache);
332 _DBUS_DECLARE_GLOBAL_LOCK (shared_connections);
333 _DBUS_DECLARE_GLOBAL_LOCK (win_fds);
334 _DBUS_DECLARE_GLOBAL_LOCK (sid_atom_cache);
335 _DBUS_DECLARE_GLOBAL_LOCK (machine_uuid);
338 _DBUS_DECLARE_GLOBAL_LOCK (atomic);
339 #define _DBUS_N_GLOBAL_LOCKS (15)
341 #define _DBUS_N_GLOBAL_LOCKS (14)
344 dbus_bool_t _dbus_threads_init_debug (void);
346 dbus_bool_t _dbus_address_append_escaped (DBusString *escaped,
347 const DBusString *unescaped);
349 void _dbus_set_bad_address (DBusError *error,
350 const char *address_problem_type,
351 const char *address_problem_field,
352 const char *address_problem_other);
354 #define DBUS_UUID_LENGTH_BYTES 16
355 #define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4)
356 #define DBUS_UUID_LENGTH_HEX (DBUS_UUID_LENGTH_BYTES * 2)
359 * A globally unique ID ; we have one for each DBusServer, and also one for each
360 * machine with libdbus installed on it.
364 dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_WORDS]; /**< guid as four uint32 values */
365 char as_bytes[DBUS_UUID_LENGTH_BYTES]; /**< guid as 16 single-byte values */
368 void _dbus_generate_uuid (DBusGUID *uuid);
369 dbus_bool_t _dbus_uuid_encode (const DBusGUID *uuid,
370 DBusString *encoded);
371 dbus_bool_t _dbus_read_uuid_file (const DBusString *filename,
373 dbus_bool_t create_if_not_found,
376 dbus_bool_t _dbus_get_local_machine_uuid_encoded (DBusString *uuid_str);
380 #endif /* DBUS_INTERNALS_H */