D-Bus  1.8.16
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 void _dbus_warn (const char *format,
39  ...) _DBUS_GNUC_PRINTF (1, 2);
40 
41 void _dbus_warn_check_failed (const char *format,
42  ...) _DBUS_GNUC_PRINTF (1, 2);
43 
44 
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__
49 #else
50 #define _DBUS_FUNCTION_NAME "unknown function"
51 #endif
52 
53 /*
54  * (code from GLib)
55  *
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.
59  *
60  * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
61  * putting assignments in the macro arg
62  */
63 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
64 #define _DBUS_BOOLEAN_EXPR(expr) \
65  __extension__ ({ \
66  int _dbus_boolean_var_; \
67  if (expr) \
68  _dbus_boolean_var_ = 1; \
69  else \
70  _dbus_boolean_var_ = 0; \
71  _dbus_boolean_var_; \
72 })
73 #define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1))
74 #define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0))
75 #else
76 #define _DBUS_LIKELY(expr) (expr)
77 #define _DBUS_UNLIKELY(expr) (expr)
78 #endif
79 
80 #ifdef DBUS_ENABLE_VERBOSE_MODE
81 
82 /*
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
86 */
87 #if defined(__GNUC__) || defined(_MSC_VER)
88 #define DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
89 #endif
90 
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__)
95 #else
96 void _dbus_verbose_real (const char *format,
97  ...) _DBUS_GNUC_PRINTF (1, 2);
98 # define _dbus_verbose _dbus_verbose_real
99 #endif
100 void _dbus_verbose_reset_real (void);
101 dbus_bool_t _dbus_is_verbose_real (void);
102 
103 # define _dbus_verbose_reset _dbus_verbose_reset_real
104 # define _dbus_is_verbose _dbus_is_verbose_real
105 #else
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)
110 # else
111 static void _dbus_verbose(const char * x,...) {;}
112 # endif
113 # define _dbus_verbose_reset() do { } while (0)
114 # define _dbus_is_verbose() FALSE
115 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
116 
117 void _dbus_trace_ref (const char *obj_name,
118  void *obj,
119  int old_refcount,
120  int new_refcount,
121  const char *why,
122  const char *env_var,
123  int *enabled);
124 
125 const char* _dbus_strerror (int error_number);
126 
127 #ifdef DBUS_DISABLE_ASSERT
128 #define _dbus_assert(condition) do { } while (0)
129 #else
130 void _dbus_real_assert (dbus_bool_t condition,
131  const char *condition_text,
132  const char *file,
133  int line,
134  const char *func);
135 #define _dbus_assert(condition) \
136  _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
137 #endif /* !DBUS_DISABLE_ASSERT */
138 
139 #ifdef DBUS_DISABLE_ASSERT
140 #define _dbus_assert_not_reached(explanation) do { } while (0)
141 #else
142 void _dbus_real_assert_not_reached (const char *explanation,
143  const char *file,
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 */
148 
149 #ifdef DBUS_DISABLE_CHECKS
150 #define _dbus_return_if_fail(condition)
151 #define _dbus_return_val_if_fail(condition, val)
152 #else
153 
154 extern const char *_dbus_return_if_fail_warning_format;
155 
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__); \
161  return; \
162  } } while (0)
163 
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__); \
169  return (val); \
170  } } while (0)
171 
172 #endif /* !DBUS_DISABLE_ASSERT */
173 
174 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
175 
176 #define _DBUS_POINTER_TO_INT(pointer) ((intptr_t)(pointer))
177 #define _DBUS_INT_TO_POINTER(integer) ((void*)((intptr_t)(integer)))
178 
179 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
180 
181 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
182  ((intptr_t) ((unsigned char*) &((struct_type*) 0)->member))
183 
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.
187  */
188 #define _DBUS_ASSERT_ERROR_IS_SET(error) do { } while (0)
189 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) do { } while (0)
190 #else
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)))
193 #endif
194 
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))
197 
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.
201  */
202 
203 /*
204  * (this + boundary - 1)
205  * &
206  * ~(boundary - 1)
207  */
208 
209 #define _DBUS_ALIGN_VALUE(this, boundary) \
210  (( ((uintptr_t)(this)) + (((uintptr_t)(boundary)) -1)) & (~(((uintptr_t)(boundary))-1)))
211 
212 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
213  ((void*)_DBUS_ALIGN_VALUE(this, boundary))
214 
215 
216 char* _dbus_strdup (const char *str);
217 void* _dbus_memdup (const void *mem,
218  size_t n_bytes);
219 dbus_bool_t _dbus_string_array_contains (const char **array,
220  const char *str);
221 char** _dbus_dup_string_array (const char **array);
222 
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 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff)
234 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
235 #define _DBUS_ONE_KILOBYTE 1024
236 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
237 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
238 #define _DBUS_USEC_PER_SECOND (1000000)
239 
240 #undef MAX
241 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
242 
243 #undef MIN
244 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
245 
246 #undef ABS
247 #define ABS(a) (((a) < 0) ? -(a) : (a))
248 
249 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
250 
251 typedef void (* DBusForeachFunction) (void *element,
252  void *data);
253 
254 dbus_bool_t _dbus_set_fd_nonblocking (int fd,
255  DBusError *error);
256 
257 void _dbus_verbose_bytes (const unsigned char *data,
258  int len,
259  int offset);
261  int start,
262  int len);
263 
264 extern const char *_dbus_no_memory_message;
265 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
266 
267 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
268 /* Memory debugging */
269 void _dbus_set_fail_alloc_counter (int until_next_fail);
270 int _dbus_get_fail_alloc_counter (void);
271 void _dbus_set_fail_alloc_failures (int failures_per_failure);
272 int _dbus_get_fail_alloc_failures (void);
273 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
274 dbus_bool_t _dbus_disable_mem_pools (void);
275 int _dbus_get_malloc_blocks_outstanding (void);
276 
277 typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data);
278 dbus_bool_t _dbus_test_oom_handling (const char *description,
279  DBusTestMemoryFunction func,
280  void *data);
281 #else
282 #define _dbus_set_fail_alloc_counter(n)
283 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
284 
285 /* These are constant expressions so that blocks
286  * they protect should be optimized away
287  */
288 #define _dbus_decrement_fail_alloc_counter() (FALSE)
289 #define _dbus_disable_mem_pools() (FALSE)
290 #define _dbus_get_malloc_blocks_outstanding (0)
291 #endif /* !DBUS_ENABLE_EMBEDDED_TESTS */
292 
293 typedef void (* DBusShutdownFunction) (void *data);
294 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function,
295  void *data);
296 dbus_bool_t _dbus_register_shutdown_func_unlocked (DBusShutdownFunction function,
297  void *data);
298 
299 extern int _dbus_current_generation;
300 
301 /* The weird case convention is to avoid having to change all the callers,
302  * which would be quite a mega-patch. */
303 typedef enum
304 {
305  /* index 0-4 */
306  _DBUS_LOCK_list,
307  _DBUS_LOCK_connection_slots,
308  _DBUS_LOCK_pending_call_slots,
309  _DBUS_LOCK_server_slots,
310  _DBUS_LOCK_message_slots,
311  /* index 5-9 */
312  _DBUS_LOCK_bus,
313  _DBUS_LOCK_bus_datas,
314  _DBUS_LOCK_shutdown_funcs,
315  _DBUS_LOCK_system_users,
316  _DBUS_LOCK_message_cache,
317  /* index 10-12 */
318  _DBUS_LOCK_shared_connections,
319  _DBUS_LOCK_machine_uuid,
320  _DBUS_LOCK_sysdeps,
321 
322  _DBUS_N_GLOBAL_LOCKS
323 } DBusGlobalLock;
324 
325 dbus_bool_t _dbus_lock (DBusGlobalLock lock) _DBUS_GNUC_WARN_UNUSED_RESULT;
326 void _dbus_unlock (DBusGlobalLock lock);
327 
328 #define _DBUS_LOCK_NAME(name) _DBUS_LOCK_##name
329 #define _DBUS_LOCK(name) _dbus_lock (_DBUS_LOCK_##name)
330 #define _DBUS_UNLOCK(name) _dbus_unlock (_DBUS_LOCK_##name)
331 
332 dbus_bool_t _dbus_threads_init_debug (void);
333 
335  const DBusString *unescaped);
336 
337 void _dbus_set_bad_address (DBusError *error,
338  const char *address_problem_type,
339  const char *address_problem_field,
340  const char *address_problem_other);
341 
342 #define DBUS_UUID_LENGTH_BYTES 16
343 #define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4)
344 #define DBUS_UUID_LENGTH_HEX (DBUS_UUID_LENGTH_BYTES * 2)
345 
350 union DBusGUID
351 {
352  dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_WORDS];
353  char as_bytes[DBUS_UUID_LENGTH_BYTES];
354 };
355 
356 void _dbus_generate_uuid (DBusGUID *uuid);
358  DBusString *encoded);
360  DBusGUID *uuid,
361  dbus_bool_t create_if_not_found,
362  DBusError *error);
363 
365  const DBusGUID *uuid,
366  DBusError *error);
367 
369 
370 #define _DBUS_PASTE2(a, b) a ## b
371 #define _DBUS_PASTE(a, b) _DBUS_PASTE2 (a, b)
372 #define _DBUS_STATIC_ASSERT(expr) \
373  typedef struct { char _assertion[(expr) ? 1 : -1]; } \
374  _DBUS_PASTE (_DBUS_STATIC_ASSERT_, __LINE__) _DBUS_GNUC_UNUSED
375 
377 
378 #endif /* DBUS_INTERNALS_H */
unsigned int dbus_uint32_t
A 32-bit unsigned integer on all platforms.
dbus_bool_t _dbus_uuid_encode(const DBusGUID *uuid, DBusString *encoded)
Hex-encode a UUID.
#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's a function rather than a macro with the inline code so that the ass...
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.
char as_bytes[DBUS_UUID_LENGTH_BYTES]
guid as 16 single-byte values
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_bool_t _dbus_get_local_machine_uuid_encoded(DBusString *uuid_str)
Gets the hex-encoded UUID of the machine this function is executed on.
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_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 "out of memory" 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'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.
void _dbus_generate_uuid(DBusGUID *uuid)
Generates a new UUID.
dbus_bool_t _dbus_write_uuid_file(const DBusString *filename, const DBusGUID *uuid, DBusError *error)
Write the give UUID to a file.
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
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.
#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.