D-Bus  1.10.24
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 
46 
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__
51 #else
52 #define _DBUS_FUNCTION_NAME "unknown function"
53 #endif
54 
55 /*
56  * (code from GLib)
57  *
58  * The _DBUS_LIKELY and _DBUS_UNLIKELY macros let the programmer give hints to
59  * the compiler about the expected result of an expression. Some compilers
60  * can use this information for optimizations.
61  *
62  * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
63  * putting assignments in the macro arg
64  */
65 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
66 #define _DBUS_BOOLEAN_EXPR(expr) \
67  __extension__ ({ \
68  int _dbus_boolean_var_; \
69  if (expr) \
70  _dbus_boolean_var_ = 1; \
71  else \
72  _dbus_boolean_var_ = 0; \
73  _dbus_boolean_var_; \
74 })
75 #define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1))
76 #define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0))
77 #else
78 #define _DBUS_LIKELY(expr) (expr)
79 #define _DBUS_UNLIKELY(expr) (expr)
80 #endif
81 
82 #ifdef DBUS_ENABLE_VERBOSE_MODE
83 
84 /*
85  at least gnu cc and msvc compiler are known to
86  have support for variable macro argument lists
87  add other compilers is required
88 */
89 #if defined(__GNUC__) || defined(_MSC_VER)
90 #define DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
91 #endif
92 
93 #ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
94 DBUS_PRIVATE_EXPORT
95 void _dbus_verbose_real (const char *file, const int line, const char *function,
96  const char *format,...) _DBUS_GNUC_PRINTF (4, 5);
97 # define _dbus_verbose(fmt,...) _dbus_verbose_real( __FILE__,__LINE__,__FUNCTION__,fmt, ## __VA_ARGS__)
98 #else
99 DBUS_PRIVATE_EXPORT
100 void _dbus_verbose_real (const char *format,
101  ...) _DBUS_GNUC_PRINTF (1, 2);
102 # define _dbus_verbose _dbus_verbose_real
103 #endif
104 DBUS_PRIVATE_EXPORT
105 void _dbus_verbose_reset_real (void);
106 DBUS_PRIVATE_EXPORT
107 dbus_bool_t _dbus_is_verbose_real (void);
108 DBUS_PRIVATE_EXPORT
109 dbus_bool_t _dbus_get_verbose (void);
110 DBUS_PRIVATE_EXPORT
111 void _dbus_set_verbose (dbus_bool_t state);
112 
113 # define _dbus_verbose_reset _dbus_verbose_reset_real
114 # define _dbus_is_verbose _dbus_is_verbose_real
115 #else
116 # ifdef HAVE_ISO_VARARGS
117 # define _dbus_verbose(...) do { } while (0)
118 # elif defined (HAVE_GNUC_VARARGS)
119 # define _dbus_verbose(format...) do { } while (0)
120 # else
121 static void _dbus_verbose(const char * x,...) {;}
122 # endif
123 # define _dbus_verbose_reset() do { } while (0)
124 # define _dbus_is_verbose() FALSE
125 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
126 
127 DBUS_PRIVATE_EXPORT
128 void _dbus_trace_ref (const char *obj_name,
129  void *obj,
130  int old_refcount,
131  int new_refcount,
132  const char *why,
133  const char *env_var,
134  int *enabled);
135 
136 DBUS_PRIVATE_EXPORT
137 const char* _dbus_strerror (int error_number);
138 
139 #ifdef DBUS_DISABLE_ASSERT
140 #define _dbus_assert(condition) do { } while (0)
141 #else
142 DBUS_PRIVATE_EXPORT
143 void _dbus_real_assert (dbus_bool_t condition,
144  const char *condition_text,
145  const char *file,
146  int line,
147  const char *func);
148 #define _dbus_assert(condition) \
149  _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
150 #endif /* !DBUS_DISABLE_ASSERT */
151 
152 #ifdef DBUS_DISABLE_ASSERT
153 #define _dbus_assert_not_reached(explanation) do { } while (0)
154 #else
155 DBUS_PRIVATE_EXPORT
156 void _dbus_real_assert_not_reached (const char *explanation,
157  const char *file,
158  int line) _DBUS_GNUC_NORETURN;
159 #define _dbus_assert_not_reached(explanation) \
160  _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
161 #endif /* !DBUS_DISABLE_ASSERT */
162 
163 #ifdef DBUS_DISABLE_CHECKS
164 #define _dbus_return_if_fail(condition)
165 #define _dbus_return_val_if_fail(condition, val)
166 #else
167 
168 DBUS_PRIVATE_EXPORT
169 extern const char *_dbus_return_if_fail_warning_format;
170 
171 #define _dbus_return_if_fail(condition) do { \
172  _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
173  if (!(condition)) { \
174  _dbus_warn_check_failed (_dbus_return_if_fail_warning_format, \
175  _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
176  return; \
177  } } while (0)
178 
179 #define _dbus_return_val_if_fail(condition, val) do { \
180  _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
181  if (!(condition)) { \
182  _dbus_warn_check_failed (_dbus_return_if_fail_warning_format, \
183  _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
184  return (val); \
185  } } while (0)
186 
187 #endif /* !DBUS_DISABLE_ASSERT */
188 
189 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
190 
191 #define _DBUS_POINTER_TO_INT(pointer) ((intptr_t)(pointer))
192 #define _DBUS_INT_TO_POINTER(integer) ((void*)((intptr_t)(integer)))
193 
194 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
195 
196 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
197  ((intptr_t) ((unsigned char*) &((struct_type*) 0)->member))
198 
199 #define _DBUS_ALIGNOF(type) \
200  (_DBUS_STRUCT_OFFSET (struct { char _1; type _2; }, _2))
201 
202 #ifdef DBUS_DISABLE_CHECKS
203 /* this is an assert and not an error, but in the typical --disable-checks case (you're trying
204  * to really minimize code size), disabling these assertions makes sense.
205  */
206 #define _DBUS_ASSERT_ERROR_IS_SET(error) do { } while (0)
207 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) do { } while (0)
208 #else
209 static inline void
210 _dbus_assert_error_is_set (const DBusError *error)
211 {
212  _dbus_assert (error == NULL || dbus_error_is_set (error));
213 }
214 
215 static inline void
216 _dbus_assert_error_is_clear (const DBusError *error)
217 {
218  _dbus_assert (error == NULL || !dbus_error_is_set (error));
219 }
220 
221 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert_error_is_set(error)
222 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert_error_is_clear(error)
223 #endif
224 
225 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
226 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
227 
228 /* This alignment thing is from ORBit2 */
229 /* Align a value upward to a boundary, expressed as a number of bytes.
230  * E.g. align to an 8-byte boundary with argument of 8.
231  */
232 
233 /*
234  * (this + boundary - 1)
235  * &
236  * ~(boundary - 1)
237  */
238 
239 #define _DBUS_ALIGN_VALUE(this, boundary) \
240  (( ((uintptr_t)(this)) + (((uintptr_t)(boundary)) -1)) & (~(((uintptr_t)(boundary))-1)))
241 
242 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
243  ((void*)_DBUS_ALIGN_VALUE(this, boundary))
244 
245 
246 DBUS_PRIVATE_EXPORT
247 char* _dbus_strdup (const char *str);
248 void* _dbus_memdup (const void *mem,
249  size_t n_bytes);
250 DBUS_PRIVATE_EXPORT
251 dbus_bool_t _dbus_string_array_contains (const char **array,
252  const char *str);
253 char** _dbus_dup_string_array (const char **array);
254 
255 #define _DBUS_INT16_MIN ((dbus_int16_t) 0x8000)
256 #define _DBUS_INT16_MAX ((dbus_int16_t) 0x7fff)
257 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
258 #define _DBUS_INT32_MIN ((dbus_int32_t) 0x80000000)
259 #define _DBUS_INT32_MAX ((dbus_int32_t) 0x7fffffff)
260 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
261 /* using 32-bit here is sort of bogus */
262 #define _DBUS_INT_MIN _DBUS_INT32_MIN
263 #define _DBUS_INT_MAX _DBUS_INT32_MAX
264 #define _DBUS_UINT_MAX _DBUS_UINT32_MAX
265 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff)
266 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
267 #define _DBUS_ONE_KILOBYTE 1024
268 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
269 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
270 #define _DBUS_USEC_PER_SECOND (1000000)
271 
272 #undef MAX
273 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
274 
275 #undef MIN
276 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
277 
278 #undef ABS
279 #define ABS(a) (((a) < 0) ? -(a) : (a))
280 
281 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
282 
283 typedef void (* DBusForeachFunction) (void *element,
284  void *data);
285 
286 void _dbus_verbose_bytes (const unsigned char *data,
287  int len,
288  int offset);
289 DBUS_PRIVATE_EXPORT
291  int start,
292  int len);
293 
294 DBUS_PRIVATE_EXPORT
295 extern const char *_dbus_no_memory_message;
296 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
297 DBUS_PRIVATE_EXPORT
298 void _dbus_set_error_valist (DBusError *error,
299  const char *name,
300  const char *format,
301  va_list args) _DBUS_GNUC_PRINTF (3, 0);
302 
303 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
304 /* Memory debugging */
305 void _dbus_set_fail_alloc_counter (int until_next_fail);
306 int _dbus_get_fail_alloc_counter (void);
307 void _dbus_set_fail_alloc_failures (int failures_per_failure);
308 int _dbus_get_fail_alloc_failures (void);
309 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
310 dbus_bool_t _dbus_disable_mem_pools (void);
311 DBUS_PRIVATE_EXPORT
312 int _dbus_get_malloc_blocks_outstanding (void);
313 
314 typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data);
315 DBUS_PRIVATE_EXPORT
316 dbus_bool_t _dbus_test_oom_handling (const char *description,
317  DBusTestMemoryFunction func,
318  void *data);
319 #else
320 #define _dbus_set_fail_alloc_counter(n)
321 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
322 
323 /* These are constant expressions so that blocks
324  * they protect should be optimized away
325  */
326 #define _dbus_decrement_fail_alloc_counter() (FALSE)
327 #define _dbus_disable_mem_pools() (FALSE)
328 #define _dbus_get_malloc_blocks_outstanding (0)
329 #endif /* !DBUS_ENABLE_EMBEDDED_TESTS */
330 
331 typedef void (* DBusShutdownFunction) (void *data);
332 DBUS_PRIVATE_EXPORT
333 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function,
334  void *data);
335 dbus_bool_t _dbus_register_shutdown_func_unlocked (DBusShutdownFunction function,
336  void *data);
337 
338 extern int _dbus_current_generation;
339 
340 /* The weird case convention is to avoid having to change all the callers,
341  * which would be quite a mega-patch. */
342 typedef enum
343 {
344  /* index 0-4 */
345  _DBUS_LOCK_list,
346  _DBUS_LOCK_connection_slots,
347  _DBUS_LOCK_pending_call_slots,
348  _DBUS_LOCK_server_slots,
349  _DBUS_LOCK_message_slots,
350  /* index 5-9 */
351  _DBUS_LOCK_bus,
352  _DBUS_LOCK_bus_datas,
353  _DBUS_LOCK_shutdown_funcs,
354  _DBUS_LOCK_system_users,
355  _DBUS_LOCK_message_cache,
356  /* index 10-12 */
357  _DBUS_LOCK_shared_connections,
358  _DBUS_LOCK_machine_uuid,
359  _DBUS_LOCK_sysdeps,
360 
361  _DBUS_N_GLOBAL_LOCKS
362 } DBusGlobalLock;
363 
364 dbus_bool_t _dbus_lock (DBusGlobalLock lock) _DBUS_GNUC_WARN_UNUSED_RESULT;
365 void _dbus_unlock (DBusGlobalLock lock);
366 
367 #define _DBUS_LOCK_NAME(name) _DBUS_LOCK_##name
368 #define _DBUS_LOCK(name) _dbus_lock (_DBUS_LOCK_##name)
369 #define _DBUS_UNLOCK(name) _dbus_unlock (_DBUS_LOCK_##name)
370 
371 DBUS_PRIVATE_EXPORT
372 dbus_bool_t _dbus_threads_init_debug (void);
373 
375  const DBusString *unescaped);
376 
377 void _dbus_set_bad_address (DBusError *error,
378  const char *address_problem_type,
379  const char *address_problem_field,
380  const char *address_problem_other);
381 
382 #define DBUS_UUID_LENGTH_BYTES 16
383 #define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4)
384 #define DBUS_UUID_LENGTH_HEX (DBUS_UUID_LENGTH_BYTES * 2)
385 
390 union DBusGUID
391 {
392  dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_WORDS];
393  char as_bytes[DBUS_UUID_LENGTH_BYTES];
394 };
395 
396 DBUS_PRIVATE_EXPORT _DBUS_GNUC_WARN_UNUSED_RESULT
398  DBusError *error);
399 DBUS_PRIVATE_EXPORT
401  DBusString *encoded);
403  DBusGUID *uuid,
404  dbus_bool_t create_if_not_found,
405  DBusError *error);
406 
408  const DBusGUID *uuid,
409  DBusError *error);
410 
412  DBusError *error);
413 
414 #define _DBUS_PASTE2(a, b) a ## b
415 #define _DBUS_PASTE(a, b) _DBUS_PASTE2 (a, b)
416 #define _DBUS_STATIC_ASSERT(expr) \
417  typedef struct { char _assertion[(expr) ? 1 : -1]; } \
418  _DBUS_PASTE (_DBUS_STATIC_ASSERT_, __LINE__) _DBUS_GNUC_UNUSED
419 
421 
422 #endif /* DBUS_INTERNALS_H */
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.
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_bool_t _dbus_generate_uuid(DBusGUID *uuid, DBusError *error)
Generates a new UUID.
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
const char * _dbus_return_if_fail_warning_format
String used in _dbus_return_if_fail macro.
#define _dbus_assert(condition)
Aborts with an error message if the condition is false.
char as_bytes[DBUS_UUID_LENGTH_BYTES]
guid as 16 single-byte values
void _dbus_warn_check_failed(const char *format,...)
Prints a &quot;critical&quot; 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...
void _dbus_real_assert_not_reached(const char *explanation, const char *file, int line)
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
const char * _dbus_no_memory_message
Fixed &quot;out of memory&quot; error message, just to avoid making up a different string every time and wastin...
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:65
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:781
Object representing an exception.
Definition: dbus-errors.h:48
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:104
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_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:810
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.
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.