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-macros-internal.h>
35 #include <dbus/dbus-threads-internal.h>
41 ...) _DBUS_GNUC_PRINTF (1, 2);
45 ...) _DBUS_GNUC_PRINTF (1, 2);
47 void _dbus_warn_return_if_fail (const
char *function,
48 const
char *assertion,
52 DBUS_EMBEDDED_TESTS_EXPORT
53 int _dbus_get_check_failed_count (
void);
55 #if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
56 #define _DBUS_FUNCTION_NAME __func__
57 #elif defined(__GNUC__) || defined(_MSC_VER)
58 #define _DBUS_FUNCTION_NAME __FUNCTION__
60 #define _DBUS_FUNCTION_NAME "unknown function"
73 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
74 #define _DBUS_BOOLEAN_EXPR(expr) \
76 int _dbus_boolean_var_; \
78 _dbus_boolean_var_ = 1; \
80 _dbus_boolean_var_ = 0; \
83 #define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1))
84 #define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0))
86 #define _DBUS_LIKELY(expr) (expr)
87 #define _DBUS_UNLIKELY(expr) (expr)
90 #ifdef DBUS_ENABLE_VERBOSE_MODE
97 #if defined(__GNUC__) || defined(_MSC_VER)
98 #define DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
101 #ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
103 void _dbus_verbose_real (
const char *file,
const int line,
const char *
function,
104 const char *format,...) _DBUS_GNUC_PRINTF (4, 5);
105 # define _dbus_verbose(fmt,...) _dbus_verbose_real( __FILE__,__LINE__,__FUNCTION__,fmt, ## __VA_ARGS__)
108 void _dbus_verbose_real (
const char *format,
109 ...) _DBUS_GNUC_PRINTF (1, 2);
110 # define _dbus_verbose _dbus_verbose_real
113 void _dbus_verbose_reset_real (
void);
120 void _dbus_verbose_raw (
const char *s);
122 # define _dbus_verbose_reset _dbus_verbose_reset_real
123 # define _dbus_is_verbose _dbus_is_verbose_real
125 # define _dbus_verbose(...) do { } while (0)
126 # define _dbus_verbose_reset() do { } while (0)
127 # define _dbus_is_verbose() FALSE
131 void _dbus_trace_ref (
const char *obj_name,
140 const char* _dbus_strerror (
int error_number);
142 #ifdef DBUS_DISABLE_ASSERT
143 #define _dbus_assert(condition) do { } while (0)
147 const char *condition_text,
151 #define _dbus_assert(condition) \
152 _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
155 #ifdef DBUS_DISABLE_ASSERT
156 #define _dbus_assert_not_reached(explanation) do { } while (0)
161 int line) _DBUS_GNUC_NORETURN;
162 #define _dbus_assert_not_reached(explanation) \
163 _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
166 #ifdef DBUS_DISABLE_CHECKS
167 #define _dbus_return_if_fail(condition)
168 #define _dbus_return_val_if_fail(condition, val)
171 #define _dbus_return_if_fail(condition) do { \
172 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
173 if (!(condition)) { \
174 _dbus_warn_return_if_fail (_DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
178 #define _dbus_return_val_if_fail(condition, val) do { \
179 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
180 if (!(condition)) { \
181 _dbus_warn_return_if_fail (_DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
187 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
189 #define _DBUS_POINTER_TO_INT(pointer) ((intptr_t)(pointer))
190 #define _DBUS_INT_TO_POINTER(integer) ((void*)((intptr_t)(integer)))
192 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
195 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
196 (offsetof (struct_type, member))
198 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
199 ((intptr_t) ((unsigned char*) &((struct_type*) 0)->member))
202 #define _DBUS_ALIGNOF(type) \
203 (_DBUS_STRUCT_OFFSET (struct { char _1; type _2; }, _2))
205 #if defined(DBUS_DISABLE_CHECKS) || defined(DBUS_DISABLE_ASSERT)
209 #define _DBUS_ASSERT_ERROR_IS_SET(error) do { } while (0)
210 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) do { } while (0)
211 #define _DBUS_ASSERT_ERROR_XOR_BOOL(error, retval) do { } while (0)
214 _dbus_assert_error_is_set (
const DBusError *error,
220 "error is set", file, line, func);
224 _dbus_assert_error_is_clear (
const DBusError *error,
230 "error is clear", file, line, func);
234 _dbus_assert_error_xor_bool (
const DBusError *error,
241 "error is consistent with boolean result", file, line, func);
248 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert_error_is_set (error, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
254 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert_error_is_clear (error, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
262 #define _DBUS_ASSERT_ERROR_XOR_BOOL(error, retval) _dbus_assert_error_xor_bool (error, retval, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
265 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
266 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
279 #define _DBUS_ALIGN_VALUE(this, boundary) \
280 (( ((uintptr_t)(this)) + (((uintptr_t)(boundary)) -1)) & (~(((uintptr_t)(boundary))-1)))
282 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
283 ((void*)_DBUS_ALIGN_VALUE(this, boundary))
297 #define _DBUS_INT16_MIN ((dbus_int16_t) 0x8000)
298 #define _DBUS_INT16_MAX ((dbus_int16_t) 0x7fff)
299 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
300 #define _DBUS_INT32_MIN ((dbus_int32_t) 0x80000000)
301 #define _DBUS_INT32_MAX ((dbus_int32_t) 0x7fffffff)
302 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
304 #define _DBUS_INT_MIN _DBUS_INT32_MIN
305 #define _DBUS_INT_MAX _DBUS_INT32_MAX
306 #define _DBUS_UINT_MAX _DBUS_UINT32_MAX
307 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff)
308 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
309 #define _DBUS_ONE_KILOBYTE 1024
310 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
311 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
312 #define _DBUS_USEC_PER_SECOND (1000000)
315 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
318 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
321 #define ABS(a) (((a) < 0) ? -(a) : (a))
323 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
338 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
340 void _dbus_set_error_valist (
DBusError *error,
343 va_list args) _DBUS_GNUC_PRINTF (3, 0);
345 typedef dbus_bool_t (* DBusTestMemoryFunction) (
void *data,
348 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
350 void _dbus_set_fail_alloc_counter (
int until_next_fail);
351 int _dbus_get_fail_alloc_counter (
void);
352 void _dbus_set_fail_alloc_failures (
int failures_per_failure);
353 int _dbus_get_fail_alloc_failures (
void);
354 dbus_bool_t _dbus_decrement_fail_alloc_counter (
void);
357 int _dbus_get_malloc_blocks_outstanding (
void);
360 dbus_bool_t _dbus_test_oom_handling (
const char *description,
361 DBusTestMemoryFunction func,
364 #define _dbus_set_fail_alloc_counter(n)
365 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
370 #define _dbus_decrement_fail_alloc_counter() (FALSE)
371 #define _dbus_disable_mem_pools() (FALSE)
372 #define _dbus_get_malloc_blocks_outstanding() (0)
374 #define _dbus_test_oom_handling(description, func, data) ((*func) (data, TRUE))
377 typedef void (* DBusShutdownFunction) (
void *data);
381 dbus_bool_t _dbus_register_shutdown_func_unlocked (DBusShutdownFunction
function,
392 _DBUS_LOCK_connection_slots,
393 _DBUS_LOCK_pending_call_slots,
394 _DBUS_LOCK_server_slots,
395 _DBUS_LOCK_message_slots,
398 _DBUS_LOCK_bus_datas,
399 _DBUS_LOCK_shutdown_funcs,
400 _DBUS_LOCK_system_users,
401 _DBUS_LOCK_message_cache,
403 _DBUS_LOCK_shared_connections,
404 _DBUS_LOCK_machine_uuid,
410 _DBUS_WARN_UNUSED_RESULT
412 void _dbus_unlock (DBusGlobalLock lock);
414 #define _DBUS_LOCK_NAME(name) _DBUS_LOCK_##name
415 #define _DBUS_LOCK(name) _dbus_lock (_DBUS_LOCK_##name)
416 #define _DBUS_UNLOCK(name) _dbus_unlock (_DBUS_LOCK_##name)
423 const char *address_problem_type,
424 const char *address_problem_field,
425 const char *address_problem_other);
427 #define DBUS_UUID_LENGTH_BYTES 16
428 #define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4)
429 #define DBUS_UUID_LENGTH_HEX (DBUS_UUID_LENGTH_BYTES * 2)
441 DBUS_PRIVATE_EXPORT _DBUS_WARN_UNUSED_RESULT
460 #define _DBUS_PASTE2(a, b) a ## b
461 #define _DBUS_PASTE(a, b) _DBUS_PASTE2 (a, b)
462 #define _DBUS_STATIC_ASSERT(expr) \
463 typedef struct { char _assertion[(expr) ? 1 : -1]; } \
464 _DBUS_PASTE (_DBUS_STATIC_ASSERT_, __LINE__) _DBUS_GNUC_UNUSED
466 #define _DBUS_STRINGIFY(x) #x
467 #define _DBUS_FILE_LINE __FILE__ ":" _DBUS_STRINGIFY(__LINE__)
469 #ifndef __has_feature
470 # define __has_feature(x) 0
475 #if ((defined(__SANITIZE_ADDRESS__) || __has_feature(address_sanitizer)) && \
477 # include <sanitizer/lsan_interface.h>
479 # define _DBUS_ADDRESS_SANITIZER
482 # define _DBUS_BEGIN_IGNORE_LEAKS __lsan_disable ()
484 # define _DBUS_END_IGNORE_LEAKS __lsan_enable ()
486 # undef _DBUS_ADDRESS_SANITIZER
487 # define _DBUS_BEGIN_IGNORE_LEAKS do { } while (0)
488 # define _DBUS_END_IGNORE_LEAKS do { } while (0)
495 #define DBUS_IS_DIR_SEPARATOR(c) (c == '\\' || c == '/')
496 #define DBUS_DIR_SEPARATOR '\\'
497 #define DBUS_DIR_SEPARATOR_S "\\"
499 #define DBUS_IS_DIR_SEPARATOR(c) (c == '/')
500 #define DBUS_DIR_SEPARATOR '/'
501 #define DBUS_DIR_SEPARATOR_S "/"
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_address_append_escaped(DBusString *escaped, const DBusString *unescaped)
Appends an escaped version of one string to another string, using the D-Bus address escaping mechanis...
void _dbus_set_bad_address(DBusError *error, const char *address_problem_type, const char *address_problem_field, const char *address_problem_other)
Sets DBUS_ERROR_BAD_ADDRESS.
dbus_bool_t dbus_error_is_set(const DBusError *error)
Checks whether an error occurred (the error is set).
DBUS_PRIVATE_EXPORT void _dbus_real_assert_not_reached(const char *explanation, const char *file, int line) _DBUS_GNUC_NORETURN
Internals of _dbus_assert_not_reached(); it's a function rather than a macro with the inline code so ...
DBUS_PRIVATE_EXPORT _DBUS_WARN_UNUSED_RESULT dbus_bool_t _dbus_generate_uuid(DBusGUID *uuid, DBusError *error)
Generates a new UUID.
char ** _dbus_dup_string_array(const char **array)
Duplicates a string array.
DBUS_PRIVATE_EXPORT void _dbus_warn_check_failed(const char *format,...)
Prints a "critical" warning to stderr when an assertion fails; differs from _dbus_warn primarily in t...
void(* DBusForeachFunction)(void *element, void *data)
Used to iterate over each item in a collection, such as a DBusList.
dbus_bool_t _dbus_read_uuid_file(const DBusString *filename, DBusGUID *uuid, dbus_bool_t create_if_not_found, DBusError *error)
Reads (and optionally writes) a uuid to a file.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_string_array_contains(const char **array, const char *str)
Checks whether a string array contains the given string.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_get_local_machine_uuid_encoded(DBusString *uuid_str, DBusError *error)
Gets the hex-encoded UUID of the machine this function is executed on.
DBUS_PRIVATE_EXPORT void _dbus_real_assert(dbus_bool_t condition, const char *condition_text, const char *file, int line, const char *func)
Internals of _dbus_assert(); it's a function rather than a macro with the inline code so that the ass...
DBUS_PRIVATE_EXPORT char * _dbus_strdup(const char *str)
Duplicates a string.
dbus_bool_t _dbus_write_uuid_file(const DBusString *filename, const DBusGUID *uuid, DBusError *error)
Write the give UUID to a file.
void * _dbus_memdup(const void *mem, size_t n_bytes)
Duplicates a block of memory.
DBUS_PRIVATE_EXPORT void _dbus_warn(const char *format,...)
Prints a warning message to stderr.
DBUS_PRIVATE_EXPORT size_t _dbus_string_array_length(const char **array)
Returns the size of a string array.
DBUS_PRIVATE_EXPORT const char * _dbus_no_memory_message
Fixed "out of memory" error message, just to avoid making up a different string every time and wastin...
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_uuid_encode(const DBusGUID *uuid, DBusString *encoded)
Hex-encode a UUID.
#define NULL
A null pointer, defined appropriately for C or C++.
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
DBUS_PRIVATE_EXPORT void _dbus_verbose_bytes_of_string(const DBusString *str, int start, int len)
Dump the given part of the string to verbose log.
void _dbus_verbose_bytes(const unsigned char *data, int len, int offset)
If in verbose mode, print a block of binary data.
int _dbus_current_generation
_dbus_current_generation is used to track each time that dbus_shutdown() is called,...
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_register_shutdown_func(DBusShutdownFunction function, void *data)
Register a cleanup function to be called exactly once the next time dbus_shutdown() is called.
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
unsigned int dbus_uint32_t
A 32-bit unsigned integer on all platforms.
Object representing an exception.
A globally unique ID ; we have one for each DBusServer, and also one for each machine with libdbus in...
dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_WORDS]
guid as four uint32 values
char as_bytes[DBUS_UUID_LENGTH_BYTES]
guid as 16 single-byte values