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
36 DBUS_BEGIN_DECLS
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 # ifdef HAVE_ISO_VARARGS
121 # define _dbus_verbose(...) do { } while (0)
122 # elif defined (HAVE_GNUC_VARARGS)
123 # define _dbus_verbose(format...) do { } while (0)
124 # else
_dbus_verbose(const char * x,...)125 static void _dbus_verbose(const char * x,...) {;}
126 # endif
127 # define _dbus_verbose_reset() do { } while (0)
128 # define _dbus_is_verbose() FALSE
129 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
130
131 DBUS_PRIVATE_EXPORT
132 void _dbus_trace_ref (const char *obj_name,
133 void *obj,
134 int old_refcount,
135 int new_refcount,
136 const char *why,
137 const char *env_var,
138 int *enabled);
139
140 DBUS_PRIVATE_EXPORT
141 const char* _dbus_strerror (int error_number);
142
143 #ifdef DBUS_DISABLE_ASSERT
144 #define _dbus_assert(condition) do { } while (0)
145 #else
146 DBUS_PRIVATE_EXPORT
147 void _dbus_real_assert (dbus_bool_t condition,
148 const char *condition_text,
149 const char *file,
150 int line,
151 const char *func);
152 #define _dbus_assert(condition) \
153 _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME)
154 #endif /* !DBUS_DISABLE_ASSERT */
155
156 #ifdef DBUS_DISABLE_ASSERT
157 #define _dbus_assert_not_reached(explanation) do { } while (0)
158 #else
159 DBUS_PRIVATE_EXPORT
160 void _dbus_real_assert_not_reached (const char *explanation,
161 const char *file,
162 int line) _DBUS_GNUC_NORETURN;
163 #define _dbus_assert_not_reached(explanation) \
164 _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
165 #endif /* !DBUS_DISABLE_ASSERT */
166
167 #ifdef DBUS_DISABLE_CHECKS
168 #define _dbus_return_if_fail(condition)
169 #define _dbus_return_val_if_fail(condition, val)
170 #else
171
172 #define _dbus_return_if_fail(condition) do { \
173 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \
174 if (!(condition)) { \
175 _dbus_warn_return_if_fail (_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_return_if_fail (_DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \
183 return (val); \
184 } } while (0)
185
186 #endif /* !DBUS_DISABLE_ASSERT */
187
188 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
189
190 #define _DBUS_POINTER_TO_INT(pointer) ((intptr_t)(pointer))
191 #define _DBUS_INT_TO_POINTER(integer) ((void*)((intptr_t)(integer)))
192
193 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
194
195 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
196 ((intptr_t) ((unsigned char*) &((struct_type*) 0)->member))
197
198 #define _DBUS_ALIGNOF(type) \
199 (_DBUS_STRUCT_OFFSET (struct { char _1; type _2; }, _2))
200
201 #ifdef DBUS_DISABLE_CHECKS
202 /* this is an assert and not an error, but in the typical --disable-checks case (you're trying
203 * to really minimize code size), disabling these assertions makes sense.
204 */
205 #define _DBUS_ASSERT_ERROR_IS_SET(error) do { } while (0)
206 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) do { } while (0)
207 #else
208 static inline void
_dbus_assert_error_is_set(const DBusError * error)209 _dbus_assert_error_is_set (const DBusError *error)
210 {
211 _dbus_assert (error == NULL || dbus_error_is_set (error));
212 }
213
214 static inline void
_dbus_assert_error_is_clear(const DBusError * error)215 _dbus_assert_error_is_clear (const DBusError *error)
216 {
217 _dbus_assert (error == NULL || !dbus_error_is_set (error));
218 }
219
220 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert_error_is_set(error)
221 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert_error_is_clear(error)
222 #endif
223
224 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
225 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
226
227 /* This alignment thing is from ORBit2 */
228 /* Align a value upward to a boundary, expressed as a number of bytes.
229 * E.g. align to an 8-byte boundary with argument of 8.
230 */
231
232 /*
233 * (this + boundary - 1)
234 * &
235 * ~(boundary - 1)
236 */
237
238 #define _DBUS_ALIGN_VALUE(this, boundary) \
239 (( ((uintptr_t)(this)) + (((uintptr_t)(boundary)) -1)) & (~(((uintptr_t)(boundary))-1)))
240
241 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
242 ((void*)_DBUS_ALIGN_VALUE(this, boundary))
243
244
245 DBUS_PRIVATE_EXPORT
246 char* _dbus_strdup (const char *str);
247 void* _dbus_memdup (const void *mem,
248 size_t n_bytes);
249 DBUS_PRIVATE_EXPORT
250 dbus_bool_t _dbus_string_array_contains (const char **array,
251 const char *str);
252 DBUS_PRIVATE_EXPORT
253 size_t _dbus_string_array_length (const char **array);
254 char** _dbus_dup_string_array (const char **array);
255
256 #define _DBUS_INT16_MIN ((dbus_int16_t) 0x8000)
257 #define _DBUS_INT16_MAX ((dbus_int16_t) 0x7fff)
258 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff)
259 #define _DBUS_INT32_MIN ((dbus_int32_t) 0x80000000)
260 #define _DBUS_INT32_MAX ((dbus_int32_t) 0x7fffffff)
261 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff)
262 /* using 32-bit here is sort of bogus */
263 #define _DBUS_INT_MIN _DBUS_INT32_MIN
264 #define _DBUS_INT_MAX _DBUS_INT32_MAX
265 #define _DBUS_UINT_MAX _DBUS_UINT32_MAX
266 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff)
267 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
268 #define _DBUS_ONE_KILOBYTE 1024
269 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
270 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
271 #define _DBUS_USEC_PER_SECOND (1000000)
272
273 #undef MAX
274 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
275
276 #undef MIN
277 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
278
279 #undef ABS
280 #define ABS(a) (((a) < 0) ? -(a) : (a))
281
282 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0))
283
284 typedef void (* DBusForeachFunction) (void *element,
285 void *data);
286
287 void _dbus_verbose_bytes (const unsigned char *data,
288 int len,
289 int offset);
290 DBUS_PRIVATE_EXPORT
291 void _dbus_verbose_bytes_of_string (const DBusString *str,
292 int start,
293 int len);
294
295 DBUS_PRIVATE_EXPORT
296 extern const char *_dbus_no_memory_message;
297 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
298 DBUS_PRIVATE_EXPORT
299 void _dbus_set_error_valist (DBusError *error,
300 const char *name,
301 const char *format,
302 va_list args) _DBUS_GNUC_PRINTF (3, 0);
303
304 typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data);
305
306 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
307 /* Memory debugging */
308 void _dbus_set_fail_alloc_counter (int until_next_fail);
309 int _dbus_get_fail_alloc_counter (void);
310 void _dbus_set_fail_alloc_failures (int failures_per_failure);
311 int _dbus_get_fail_alloc_failures (void);
312 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
313 dbus_bool_t _dbus_disable_mem_pools (void);
314 DBUS_PRIVATE_EXPORT
315 int _dbus_get_malloc_blocks_outstanding (void);
316
317 DBUS_PRIVATE_EXPORT
318 dbus_bool_t _dbus_test_oom_handling (const char *description,
319 DBusTestMemoryFunction func,
320 void *data);
321 #else
322 #define _dbus_set_fail_alloc_counter(n)
323 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
324
325 /* These are constant expressions so that blocks
326 * they protect should be optimized away
327 */
328 #define _dbus_decrement_fail_alloc_counter() (FALSE)
329 #define _dbus_disable_mem_pools() (FALSE)
330 #define _dbus_get_malloc_blocks_outstanding() (0)
331
332 #define _dbus_test_oom_handling(description, func, data) ((*func) (data))
333 #endif /* !DBUS_ENABLE_EMBEDDED_TESTS */
334
335 typedef void (* DBusShutdownFunction) (void *data);
336 DBUS_PRIVATE_EXPORT
337 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function,
338 void *data);
339 dbus_bool_t _dbus_register_shutdown_func_unlocked (DBusShutdownFunction function,
340 void *data);
341
342 extern int _dbus_current_generation;
343
344 /* The weird case convention is to avoid having to change all the callers,
345 * which would be quite a mega-patch. */
346 typedef enum
347 {
348 /* index 0-4 */
349 _DBUS_LOCK_list,
350 _DBUS_LOCK_connection_slots,
351 _DBUS_LOCK_pending_call_slots,
352 _DBUS_LOCK_server_slots,
353 _DBUS_LOCK_message_slots,
354 /* index 5-9 */
355 _DBUS_LOCK_bus,
356 _DBUS_LOCK_bus_datas,
357 _DBUS_LOCK_shutdown_funcs,
358 _DBUS_LOCK_system_users,
359 _DBUS_LOCK_message_cache,
360 /* index 10-12 */
361 _DBUS_LOCK_shared_connections,
362 _DBUS_LOCK_machine_uuid,
363 _DBUS_LOCK_sysdeps,
364
365 _DBUS_N_GLOBAL_LOCKS
366 } DBusGlobalLock;
367
368 dbus_bool_t _dbus_lock (DBusGlobalLock lock) _DBUS_GNUC_WARN_UNUSED_RESULT;
369 void _dbus_unlock (DBusGlobalLock lock);
370
371 #define _DBUS_LOCK_NAME(name) _DBUS_LOCK_##name
372 #define _DBUS_LOCK(name) _dbus_lock (_DBUS_LOCK_##name)
373 #define _DBUS_UNLOCK(name) _dbus_unlock (_DBUS_LOCK_##name)
374
375 DBUS_PRIVATE_EXPORT
376 dbus_bool_t _dbus_threads_init_debug (void);
377
378 dbus_bool_t _dbus_address_append_escaped (DBusString *escaped,
379 const DBusString *unescaped);
380
381 void _dbus_set_bad_address (DBusError *error,
382 const char *address_problem_type,
383 const char *address_problem_field,
384 const char *address_problem_other);
385
386 #define DBUS_UUID_LENGTH_BYTES 16
387 #define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4)
388 #define DBUS_UUID_LENGTH_HEX (DBUS_UUID_LENGTH_BYTES * 2)
389
390 /**
391 * A globally unique ID ; we have one for each DBusServer, and also one for each
392 * machine with libdbus installed on it.
393 */
394 union DBusGUID
395 {
396 dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_WORDS]; /**< guid as four uint32 values */
397 char as_bytes[DBUS_UUID_LENGTH_BYTES]; /**< guid as 16 single-byte values */
398 };
399
400 DBUS_PRIVATE_EXPORT _DBUS_GNUC_WARN_UNUSED_RESULT
401 dbus_bool_t _dbus_generate_uuid (DBusGUID *uuid,
402 DBusError *error);
403 DBUS_PRIVATE_EXPORT
404 dbus_bool_t _dbus_uuid_encode (const DBusGUID *uuid,
405 DBusString *encoded);
406 dbus_bool_t _dbus_read_uuid_file (const DBusString *filename,
407 DBusGUID *uuid,
408 dbus_bool_t create_if_not_found,
409 DBusError *error);
410
411 dbus_bool_t _dbus_write_uuid_file (const DBusString *filename,
412 const DBusGUID *uuid,
413 DBusError *error);
414
415 DBUS_PRIVATE_EXPORT
416 dbus_bool_t _dbus_get_local_machine_uuid_encoded (DBusString *uuid_str,
417 DBusError *error);
418
419 #define _DBUS_PASTE2(a, b) a ## b
420 #define _DBUS_PASTE(a, b) _DBUS_PASTE2 (a, b)
421 #define _DBUS_STATIC_ASSERT(expr) \
422 typedef struct { char _assertion[(expr) ? 1 : -1]; } \
423 _DBUS_PASTE (_DBUS_STATIC_ASSERT_, __LINE__) _DBUS_GNUC_UNUSED
424
425 DBUS_END_DECLS
426
427 #endif /* DBUS_INTERNALS_H */
428