D-Bus  1.13.7
dbus-internals.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-internals.h random utility stuff (internal to D-Bus implementation)
3  *
4  * Copyright (C) 2002, 2003 Red Hat, Inc.
5  *
6  * Licensed under the Academic Free License version 2.1
7  *
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.
12  *
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.
17  *
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
21  *
22  */
23 #ifdef DBUS_INSIDE_DBUS_H
24 #error "You can't include dbus-internals.h in the public header dbus.h"
25 #endif
26 
27 #ifndef DBUS_INTERNALS_H
28 #define DBUS_INTERNALS_H
29 
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>
35 
37 
38 DBUS_PRIVATE_EXPORT
39 void _dbus_warn (const char *format,
40  ...) _DBUS_GNUC_PRINTF (1, 2);
41 
42 DBUS_PRIVATE_EXPORT
43 void _dbus_warn_check_failed (const char *format,
44  ...) _DBUS_GNUC_PRINTF (1, 2);
45 DBUS_PRIVATE_EXPORT
46 void _dbus_warn_return_if_fail (const char *function,
47  const char *assertion,
48  const char *file,
49  int line);
50 
51 #if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
52 #define _DBUS_FUNCTION_NAME __func__
53 #elif defined(__GNUC__) || defined(_MSC_VER)
54 #define _DBUS_FUNCTION_NAME __FUNCTION__
55 #else
56 #define _DBUS_FUNCTION_NAME "unknown function"
57 #endif
58 
59 /*
60  * (code from GLib)
61  *
62  * The _DBUS_LIKELY and _DBUS_UNLIKELY macros let the programmer give hints to
63  * the compiler about the expected result of an expression. Some compilers
64  * can use this information for optimizations.
65  *
66  * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
67  * putting assignments in the macro arg
68  */
69 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
70 #define _DBUS_BOOLEAN_EXPR(expr) \
71  __extension__ ({ \
72  int _dbus_boolean_var_; \
73  if (expr) \
74  _dbus_boolean_var_ = 1; \
75  else \
76  _dbus_boolean_var_ = 0; \
77  _dbus_boolean_var_; \
78 })
79 #define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1))
80 #define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0))
81 #else
82 #define _DBUS_LIKELY(expr) (expr)
83 #define _DBUS_UNLIKELY(expr) (expr)
84 #endif
85 
86 #ifdef DBUS_ENABLE_VERBOSE_MODE
87 
88 /*
89  at least gnu cc and msvc compiler are known to
90  have support for variable macro argument lists
91  add other compilers is required
92 */
93 #if defined(__GNUC__) || defined(_MSC_VER)
94 #define DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
95 #endif
96 
97 #ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
98 DBUS_PRIVATE_EXPORT
99 void _dbus_verbose_real (const char *file, const int line, const char *function,
100  const char *format,...) _DBUS_GNUC_PRINTF (4, 5);
101 # define _dbus_verbose(fmt,...) _dbus_verbose_real( __FILE__,__LINE__,__FUNCTION__,fmt, ## __VA_ARGS__)
102 #else
103 DBUS_PRIVATE_EXPORT
104 void _dbus_verbose_real (const char *format,
105  ...) _DBUS_GNUC_PRINTF (1, 2);
106 # define _dbus_verbose _dbus_verbose_real
107 #endif
108 DBUS_PRIVATE_EXPORT
109 void _dbus_verbose_reset_real (void);
110 DBUS_PRIVATE_EXPORT
111 dbus_bool_t _dbus_is_verbose_real (void);
112 DBUS_PRIVATE_EXPORT
113 dbus_bool_t _dbus_get_verbose (void);
114 DBUS_PRIVATE_EXPORT
115 void _dbus_set_verbose (dbus_bool_t state);
116 
117 # define _dbus_verbose_reset _dbus_verbose_reset_real
118 # define _dbus_is_verbose _dbus_is_verbose_real
119 #else
120 # define _dbus_verbose(...) do { } while (0)
121 # define _dbus_verbose_reset() do { } while (0)
122 # define _dbus_is_verbose() FALSE
123 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
124 
125 DBUS_PRIVATE_EXPORT
126 void _dbus_trace_ref (const char *obj_name,
127  void *obj,
128  int old_refcount,
129  int new_refcount,
130  const char *why,
131  const char *env_var,
132  int *enabled);
133 
134 DBUS_PRIVATE_EXPORT
135 const char* _dbus_strerror (int error_number);
136 
137 #ifdef DBUS_DISABLE_ASSERT
138 #define _dbus_assert(condition) do { } while (0)
139 #else
140 DBUS_PRIVATE_EXPORT
141 void _dbus_real_assert (dbus_bool_t condition,
142  const char *condition_text,
143  const char *file,
144  int line,
145  const char *func);
146 #define _dbus_assert(condition) \
147  _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
148 #endif /* !DBUS_DISABLE_ASSERT */
149 
150 #ifdef DBUS_DISABLE_ASSERT
151 #define _dbus_assert_not_reached(explanation) do { } while (0)
152 #else
153 DBUS_PRIVATE_EXPORT
154 void _dbus_real_assert_not_reached (const char *explanation,
155  const char *file,
156  int line) _DBUS_GNUC_NORETURN;
157 #define _dbus_assert_not_reached(explanation) \
158  _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
159 #endif /* !DBUS_DISABLE_ASSERT */
160 
161 #ifdef DBUS_DISABLE_CHECKS
162 #define _dbus_return_if_fail(condition)
163 #define _dbus_return_val_if_fail(condition, val)
164 #else
165 
166 #define _dbus_return_if_fail(condition) do { \
167  _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
168  if (!(condition)) { \
169  _dbus_warn_return_if_fail (_DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
170  return; \
171  } } while (0)
172 
173 #define _dbus_return_val_if_fail(condition, val) do { \
174  _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
175  if (!(condition)) { \
176  _dbus_warn_return_if_fail (_DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
177  return (val); \
178  } } while (0)
179 
180 #endif /* !DBUS_DISABLE_ASSERT */
181 
182 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
183 
184 #define _DBUS_POINTER_TO_INT(pointer) ((intptr_t)(pointer))
185 #define _DBUS_INT_TO_POINTER(integer) ((void*)((intptr_t)(integer)))
186 
187 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
188 
189 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
190  ((intptr_t) ((unsigned char*) &((struct_type*) 0)->member))
191 
192 #define _DBUS_ALIGNOF(type) \
193  (_DBUS_STRUCT_OFFSET (struct { char _1; type _2; }, _2))
194 
195 #if defined(DBUS_DISABLE_CHECKS) || defined(DBUS_DISABLE_ASSERT)
196 /* this is an assert and not an error, but in the typical --disable-checks case (you're trying
197  * to really minimize code size), disabling these assertions makes sense.
198  */
199 #define _DBUS_ASSERT_ERROR_IS_SET(error) do { } while (0)
200 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) do { } while (0)
201 #define _DBUS_ASSERT_ERROR_XOR_BOOL(error, retval) do { } while (0)
202 #else
203 static inline void
204 _dbus_assert_error_is_set (const DBusError *error,
205  const char *file,
206  int line,
207  const char *func)
208 {
209  _dbus_real_assert (error == NULL || dbus_error_is_set (error),
210  "error is set", file, line, func);
211 }
212 
213 static inline void
214 _dbus_assert_error_is_clear (const DBusError *error,
215  const char *file,
216  int line,
217  const char *func)
218 {
219  _dbus_real_assert (error == NULL || !dbus_error_is_set (error),
220  "error is clear", file, line, func);
221 }
222 
223 static inline void
224 _dbus_assert_error_xor_bool (const DBusError *error,
225  dbus_bool_t retval,
226  const char *file,
227  int line,
228  const char *func)
229 {
230  _dbus_real_assert (error == NULL || dbus_error_is_set (error) == !retval,
231  "error is consistent with boolean result", file, line, func);
232 }
233 
238 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert_error_is_set (error, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
239 
244 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert_error_is_clear (error, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
245 
252 #define _DBUS_ASSERT_ERROR_XOR_BOOL(error, retval) _dbus_assert_error_xor_bool (error, retval, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
253 #endif
254 
255 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
256 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
257 
258 /* This alignment thing is from ORBit2 */
259 /* Align a value upward to a boundary, expressed as a number of bytes.
260  * E.g. align to an 8-byte boundary with argument of 8.
261  */
262 
263 /*
264  * (this + boundary - 1)
265  * &
266  * ~(boundary - 1)
267  */
268 
269 #define _DBUS_ALIGN_VALUE(this, boundary) \
270  (( ((uintptr_t)(this)) + (((uintptr_t)(boundary)) -1)) & (~(((uintptr_t)(boundary))-1)))
271 
272 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
273  ((void*)_DBUS_ALIGN_VALUE(this, boundary))
274 
275 
276 DBUS_PRIVATE_EXPORT
277 char* _dbus_strdup (const char *str);
278 void* _dbus_memdup (const void *mem,
279  size_t n_bytes);
280 DBUS_PRIVATE_EXPORT
281 dbus_bool_t _dbus_string_array_contains (const char **array,
282  const char *str);
283 DBUS_PRIVATE_EXPORT
284 size_t _dbus_string_array_length (const char **array);
285 char** _dbus_dup_string_array (const char **array);
286 
287 #define _DBUS_INT16_MIN ((dbus_int16_t) 0x8000)
288 #define _DBUS_INT16_MAX ((dbus_int16_t) 0x7fff)
289 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
290 #define _DBUS_INT32_MIN ((dbus_int32_t) 0x80000000)
291 #define _DBUS_INT32_MAX ((dbus_int32_t) 0x7fffffff)
292 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
293 /* using 32-bit here is sort of bogus */
294 #define _DBUS_INT_MIN _DBUS_INT32_MIN
295 #define _DBUS_INT_MAX _DBUS_INT32_MAX
296 #define _DBUS_UINT_MAX _DBUS_UINT32_MAX
297 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff)
298 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
299 #define _DBUS_ONE_KILOBYTE 1024
300 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
301 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
302 #define _DBUS_USEC_PER_SECOND (1000000)
303 
304 #undef MAX
305 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
306 
307 #undef MIN
308 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
309 
310 #undef ABS
311 #define ABS(a) (((a) < 0) ? -(a) : (a))
312 
313 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
314 
315 typedef void (* DBusForeachFunction) (void *element,
316  void *data);
317 
318 void _dbus_verbose_bytes (const unsigned char *data,
319  int len,
320  int offset);
321 DBUS_PRIVATE_EXPORT
323  int start,
324  int len);
325 
326 DBUS_PRIVATE_EXPORT
327 extern const char *_dbus_no_memory_message;
328 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
329 DBUS_PRIVATE_EXPORT
330 void _dbus_set_error_valist (DBusError *error,
331  const char *name,
332  const char *format,
333  va_list args) _DBUS_GNUC_PRINTF (3, 0);
334 
335 typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data,
336  dbus_bool_t have_memory);
337 
338 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
339 /* Memory debugging */
340 void _dbus_set_fail_alloc_counter (int until_next_fail);
341 int _dbus_get_fail_alloc_counter (void);
342 void _dbus_set_fail_alloc_failures (int failures_per_failure);
343 int _dbus_get_fail_alloc_failures (void);
344 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
345 dbus_bool_t _dbus_disable_mem_pools (void);
346 DBUS_PRIVATE_EXPORT
347 int _dbus_get_malloc_blocks_outstanding (void);
348 
349 DBUS_PRIVATE_EXPORT
350 dbus_bool_t _dbus_test_oom_handling (const char *description,
351  DBusTestMemoryFunction func,
352  void *data);
353 #else
354 #define _dbus_set_fail_alloc_counter(n)
355 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
356 
357 /* These are constant expressions so that blocks
358  * they protect should be optimized away
359  */
360 #define _dbus_decrement_fail_alloc_counter() (FALSE)
361 #define _dbus_disable_mem_pools() (FALSE)
362 #define _dbus_get_malloc_blocks_outstanding() (0)
363 
364 #define _dbus_test_oom_handling(description, func, data) ((*func) (data, TRUE))
365 #endif /* !DBUS_ENABLE_EMBEDDED_TESTS */
366 
367 typedef void (* DBusShutdownFunction) (void *data);
368 DBUS_PRIVATE_EXPORT
369 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function,
370  void *data);
371 dbus_bool_t _dbus_register_shutdown_func_unlocked (DBusShutdownFunction function,
372  void *data);
373 
374 extern int _dbus_current_generation;
375 
376 /* The weird case convention is to avoid having to change all the callers,
377  * which would be quite a mega-patch. */
378 typedef enum
379 {
380  /* index 0-4 */
381  _DBUS_LOCK_list,
382  _DBUS_LOCK_connection_slots,
383  _DBUS_LOCK_pending_call_slots,
384  _DBUS_LOCK_server_slots,
385  _DBUS_LOCK_message_slots,
386  /* index 5-9 */
387  _DBUS_LOCK_bus,
388  _DBUS_LOCK_bus_datas,
389  _DBUS_LOCK_shutdown_funcs,
390  _DBUS_LOCK_system_users,
391  _DBUS_LOCK_message_cache,
392  /* index 10-12 */
393  _DBUS_LOCK_shared_connections,
394  _DBUS_LOCK_machine_uuid,
395  _DBUS_LOCK_sysdeps,
396 
397  _DBUS_N_GLOBAL_LOCKS
398 } DBusGlobalLock;
399 
400 _DBUS_WARN_UNUSED_RESULT
401 dbus_bool_t _dbus_lock (DBusGlobalLock lock);
402 void _dbus_unlock (DBusGlobalLock lock);
403 
404 #define _DBUS_LOCK_NAME(name) _DBUS_LOCK_##name
405 #define _DBUS_LOCK(name) _dbus_lock (_DBUS_LOCK_##name)
406 #define _DBUS_UNLOCK(name) _dbus_unlock (_DBUS_LOCK_##name)
407 
408 DBUS_PRIVATE_EXPORT
409 dbus_bool_t _dbus_threads_init_debug (void);
410 
411 DBUS_PRIVATE_EXPORT
413  const DBusString *unescaped);
414 
415 void _dbus_set_bad_address (DBusError *error,
416  const char *address_problem_type,
417  const char *address_problem_field,
418  const char *address_problem_other);
419 
420 #define DBUS_UUID_LENGTH_BYTES 16
421 #define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4)
422 #define DBUS_UUID_LENGTH_HEX (DBUS_UUID_LENGTH_BYTES * 2)
423 
428 union DBusGUID
429 {
430  dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_WORDS];
431  char as_bytes[DBUS_UUID_LENGTH_BYTES];
432 };
433 
434 DBUS_PRIVATE_EXPORT _DBUS_WARN_UNUSED_RESULT
436  DBusError *error);
437 DBUS_PRIVATE_EXPORT
439  DBusString *encoded);
441  DBusGUID *uuid,
442  dbus_bool_t create_if_not_found,
443  DBusError *error);
444 
446  const DBusGUID *uuid,
447  DBusError *error);
448 
449 DBUS_PRIVATE_EXPORT
451  DBusError *error);
452 
453 #define _DBUS_PASTE2(a, b) a ## b
454 #define _DBUS_PASTE(a, b) _DBUS_PASTE2 (a, b)
455 #define _DBUS_STATIC_ASSERT(expr) \
456  typedef struct { char _assertion[(expr) ? 1 : -1]; } \
457  _DBUS_PASTE (_DBUS_STATIC_ASSERT_, __LINE__) _DBUS_GNUC_UNUSED
458 
460 
461 #endif /* DBUS_INTERNALS_H */
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.
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&#39;s a function rather than a macro with the inline code so that the ass...
DBUS_PRIVATE_EXPORT _DBUS_WARN_UNUSED_RESULT dbus_bool_t _dbus_generate_uuid(DBusGUID *uuid, DBusError *error)
Generates a new UUID.
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_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
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...
A globally unique ID ; we have one for each DBusServer, and also one for each machine with libdbus in...
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&#39;s a function rather than a macro with the inline code so ...
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
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 void _dbus_warn(const char *format,...)
Prints a warning message to stderr.
void * _dbus_memdup(const void *mem, size_t n_bytes)
Duplicates a block of memory.
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.
Definition: dbus-address.c:66
int _dbus_current_generation
_dbus_current_generation is used to track each time that dbus_shutdown() is called, so we can reinit things after it&#39;s been called.
Definition: dbus-memory.c:783
Object representing an exception.
Definition: dbus-errors.h:48
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...
Definition: dbus-address.c:105
DBUS_PRIVATE_EXPORT size_t _dbus_string_array_length(const char **array)
Returns the size of a string array.
char ** _dbus_dup_string_array(const char **array)
Duplicates a string array.
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.
void(* DBusForeachFunction)(void *element, void *data)
Used to iterate over each item in a collection, such as a DBusList.
dbus_bool_t _dbus_write_uuid_file(const DBusString *filename, const DBusGUID *uuid, DBusError *error)
Write the give UUID to a file.
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...
Definition: dbus-memory.c:812
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.
DBUS_PRIVATE_EXPORT char * _dbus_strdup(const char *str)
Duplicates a string.
dbus_bool_t dbus_error_is_set(const DBusError *error)
Checks whether an error occurred (the error is set).
Definition: dbus-errors.c:329
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
void _dbus_verbose_bytes(const unsigned char *data, int len, int offset)
If in verbose mode, print a block of binary data.