D-Bus  1.4.10
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 #ifndef DBUS_SESSION_BUS_DEFAULT_ADDRESS
39 #define DBUS_SESSION_BUS_DEFAULT_ADDRESS "autolaunch:"
40 #endif
41 
42 void _dbus_warn (const char *format,
43  ...) _DBUS_GNUC_PRINTF (1, 2);
44 
45 void _dbus_warn_check_failed (const char *format,
46  ...) _DBUS_GNUC_PRINTF (1, 2);
47 
48 
49 #if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
50 #define _DBUS_FUNCTION_NAME __func__
51 #elif defined(__GNUC__) || defined(_MSC_VER)
52 #define _DBUS_FUNCTION_NAME __FUNCTION__
53 #else
54 #define _DBUS_FUNCTION_NAME "unknown function"
55 #endif
56 
57 /*
58  * (code from GLib)
59  *
60  * The _DBUS_LIKELY and _DBUS_UNLIKELY macros let the programmer give hints to
61  * the compiler about the expected result of an expression. Some compilers
62  * can use this information for optimizations.
63  *
64  * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
65  * putting assignments in the macro arg
66  */
67 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
68 #define _DBUS_BOOLEAN_EXPR(expr) \
69  __extension__ ({ \
70  int _dbus_boolean_var_; \
71  if (expr) \
72  _dbus_boolean_var_ = 1; \
73  else \
74  _dbus_boolean_var_ = 0; \
75  _dbus_boolean_var_; \
76 })
77 #define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1))
78 #define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0))
79 #else
80 #define _DBUS_LIKELY(expr) (expr)
81 #define _DBUS_UNLIKELY(expr) (expr)
82 #endif
83 
84 #ifdef DBUS_ENABLE_VERBOSE_MODE
85 
86 /*
87  at least gnu cc and msvc compiler are known to
88  have support for variable macro argument lists
89  add other compilers is required
90 */
91 #if defined(__GNUC__) || defined(_MSC_VER)
92 #define DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
93 #endif
94 
95 #ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS
96 void _dbus_verbose_real (const char *file, const int line, const char *function,
97  const char *format,...) _DBUS_GNUC_PRINTF (4, 5);
98 # define _dbus_verbose(fmt,...) _dbus_verbose_real( __FILE__,__LINE__,__FUNCTION__,fmt, ## __VA_ARGS__)
99 #else
100 void _dbus_verbose_real (const char *format,
101  ...) _DBUS_GNUC_PRINTF (1, 2);
102 # define _dbus_verbose _dbus_verbose_real
103 #endif
104 void _dbus_verbose_reset_real (void);
105 dbus_bool_t _dbus_is_verbose_real (void);
106 
107 # define _dbus_verbose_reset _dbus_verbose_reset_real
108 # define _dbus_is_verbose _dbus_is_verbose_real
109 #else
110 # ifdef HAVE_ISO_VARARGS
111 # define _dbus_verbose(...)
112 # elif defined (HAVE_GNUC_VARARGS)
113 # define _dbus_verbose(format...)
114 # else
115 static void _dbus_verbose(const char * x,...) {;}
116 # endif
117 # define _dbus_verbose_reset()
118 # define _dbus_is_verbose() FALSE
119 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
120 
121 const char* _dbus_strerror (int error_number);
122 
123 #ifdef DBUS_DISABLE_ASSERT
124 #define _dbus_assert(condition)
125 #else
126 void _dbus_real_assert (dbus_bool_t condition,
127  const char *condition_text,
128  const char *file,
129  int line,
130  const char *func);
131 #define _dbus_assert(condition) \
132  _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
133 #endif /* !DBUS_DISABLE_ASSERT */
134 
135 #ifdef DBUS_DISABLE_ASSERT
136 #define _dbus_assert_not_reached(explanation)
137 #else
138 void _dbus_real_assert_not_reached (const char *explanation,
139  const char *file,
140  int line) _DBUS_GNUC_NORETURN;
141 #define _dbus_assert_not_reached(explanation) \
142  _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
143 #endif /* !DBUS_DISABLE_ASSERT */
144 
145 #ifdef DBUS_DISABLE_CHECKS
146 #define _dbus_return_if_fail(condition)
147 #define _dbus_return_val_if_fail(condition, val)
148 #else
149 
150 extern const char *_dbus_return_if_fail_warning_format;
151 
152 #define _dbus_return_if_fail(condition) do { \
153  _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
154  if (!(condition)) { \
155  _dbus_warn_check_failed (_dbus_return_if_fail_warning_format, \
156  _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
157  return; \
158  } } while (0)
159 
160 #define _dbus_return_val_if_fail(condition, val) do { \
161  _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
162  if (!(condition)) { \
163  _dbus_warn_check_failed (_dbus_return_if_fail_warning_format, \
164  _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
165  return (val); \
166  } } while (0)
167 
168 #endif /* !DBUS_DISABLE_ASSERT */
169 
170 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
171 
172 #define _DBUS_POINTER_TO_INT(pointer) ((intptr_t)(pointer))
173 #define _DBUS_INT_TO_POINTER(integer) ((void*)((intptr_t)(integer)))
174 
175 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
176 
177 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
178  ((intptr_t) ((unsigned char*) &((struct_type*) 0)->member))
179 
180 #ifdef DBUS_DISABLE_CHECKS
181 /* this is an assert and not an error, but in the typical --disable-checks case (you're trying
182  * to really minimize code size), disabling these assertions makes sense.
183  */
184 #define _DBUS_ASSERT_ERROR_IS_SET(error)
185 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error)
186 #else
187 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
188 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error)))
189 #endif
190 
191 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
192 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
193 
194 /* This alignment thing is from ORBit2 */
195 /* Align a value upward to a boundary, expressed as a number of bytes.
196  * E.g. align to an 8-byte boundary with argument of 8.
197  */
198 
199 /*
200  * (this + boundary - 1)
201  * &
202  * ~(boundary - 1)
203  */
204 
205 #define _DBUS_ALIGN_VALUE(this, boundary) \
206  (( ((uintptr_t)(this)) + (((uintptr_t)(boundary)) -1)) & (~(((uintptr_t)(boundary))-1)))
207 
208 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
209  ((void*)_DBUS_ALIGN_VALUE(this, boundary))
210 
211 
212 char* _dbus_strdup (const char *str);
213 void* _dbus_memdup (const void *mem,
214  size_t n_bytes);
215 dbus_bool_t _dbus_string_array_contains (const char **array,
216  const char *str);
217 char** _dbus_dup_string_array (const char **array);
218 
219 #define _DBUS_INT16_MIN ((dbus_int16_t) 0x8000)
220 #define _DBUS_INT16_MAX ((dbus_int16_t) 0x7fff)
221 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
222 #define _DBUS_INT32_MIN ((dbus_int32_t) 0x80000000)
223 #define _DBUS_INT32_MAX ((dbus_int32_t) 0x7fffffff)
224 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
225 /* using 32-bit here is sort of bogus */
226 #define _DBUS_INT_MIN _DBUS_INT32_MIN
227 #define _DBUS_INT_MAX _DBUS_INT32_MAX
228 #define _DBUS_UINT_MAX _DBUS_UINT32_MAX
229 #ifdef DBUS_HAVE_INT64
230 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff)
231 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
232 #endif
233 #define _DBUS_ONE_KILOBYTE 1024
234 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
235 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
236 #define _DBUS_USEC_PER_SECOND (1000000)
237 
238 #undef MAX
239 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
240 
241 #undef MIN
242 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
243 
244 #undef ABS
245 #define ABS(a) (((a) < 0) ? -(a) : (a))
246 
247 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
248 
249 typedef void (* DBusForeachFunction) (void *element,
250  void *data);
251 
252 dbus_bool_t _dbus_set_fd_nonblocking (int fd,
253  DBusError *error);
254 
255 void _dbus_verbose_bytes (const unsigned char *data,
256  int len,
257  int offset);
259  int start,
260  int len);
261 
262 const char* _dbus_header_field_to_string (int header_field);
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_BUILD_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_BUILD_TESTS */
292 
293 typedef void (* DBusShutdownFunction) (void *data);
294 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function,
295  void *data);
296 
297 extern int _dbus_current_generation;
298 
299 /* Thread initializers */
300 #define _DBUS_LOCK_NAME(name) _dbus_lock_##name
301 #define _DBUS_DECLARE_GLOBAL_LOCK(name) extern DBusMutex *_dbus_lock_##name
302 #define _DBUS_DEFINE_GLOBAL_LOCK(name) DBusMutex *_dbus_lock_##name
303 #define _DBUS_LOCK(name) _dbus_mutex_lock (_dbus_lock_##name)
304 #define _DBUS_UNLOCK(name) _dbus_mutex_unlock (_dbus_lock_##name)
305 
306 /* 1-5 */
308 _DBUS_DECLARE_GLOBAL_LOCK (connection_slots);
309 _DBUS_DECLARE_GLOBAL_LOCK (pending_call_slots);
310 _DBUS_DECLARE_GLOBAL_LOCK (server_slots);
311 _DBUS_DECLARE_GLOBAL_LOCK (message_slots);
312 /* 5-10 */
314 _DBUS_DECLARE_GLOBAL_LOCK (bus_datas);
315 _DBUS_DECLARE_GLOBAL_LOCK (shutdown_funcs);
316 _DBUS_DECLARE_GLOBAL_LOCK (system_users);
317 _DBUS_DECLARE_GLOBAL_LOCK (message_cache);
318 /* 10-14 */
319 _DBUS_DECLARE_GLOBAL_LOCK (shared_connections);
320 _DBUS_DECLARE_GLOBAL_LOCK (win_fds);
321 _DBUS_DECLARE_GLOBAL_LOCK (sid_atom_cache);
322 _DBUS_DECLARE_GLOBAL_LOCK (machine_uuid);
323 
324 #if !DBUS_USE_SYNC
326 #define _DBUS_N_GLOBAL_LOCKS (15)
327 #else
328 #define _DBUS_N_GLOBAL_LOCKS (14)
329 #endif
330 
331 dbus_bool_t _dbus_threads_init_debug (void);
332 
334  const DBusString *unescaped);
335 
336 void _dbus_set_bad_address (DBusError *error,
337  const char *address_problem_type,
338  const char *address_problem_field,
339  const char *address_problem_other);
340 
341 #define DBUS_UUID_LENGTH_BYTES 16
342 #define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4)
343 #define DBUS_UUID_LENGTH_HEX (DBUS_UUID_LENGTH_BYTES * 2)
344 
349 union DBusGUID
350 {
351  dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_WORDS];
352  char as_bytes[DBUS_UUID_LENGTH_BYTES];
353 };
354 
355 void _dbus_generate_uuid (DBusGUID *uuid);
357  DBusString *encoded);
359  DBusGUID *uuid,
360  dbus_bool_t create_if_not_found,
361  DBusError *error);
362 
364 
366 
367 #endif /* DBUS_INTERNALS_H */