1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-internals.h random utility stuff (internal to D-BUS implementation)
4 * Copyright (C) 2002, 2003 Red Hat, Inc.
6 * Licensed under the Academic Free License version 1.2
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #ifdef DBUS_INSIDE_DBUS_H
24 #error "You can't include dbus-internals.h in the public header dbus.h"
27 #ifndef DBUS_INTERNALS_H
28 #define DBUS_INTERNALS_H
32 #include <dbus/dbus-memory.h>
33 #include <dbus/dbus-types.h>
34 #include <dbus/dbus-errors.h>
35 #include <dbus/dbus-sysdeps.h>
36 #include <dbus/dbus-threads.h>
40 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
41 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx ) \
42 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
43 #define _DBUS_GNUC_SCANF( format_idx, arg_idx ) \
44 __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
45 #define _DBUS_GNUC_FORMAT( arg_idx ) \
46 __attribute__((__format_arg__ (arg_idx)))
47 #define _DBUS_GNUC_NORETURN \
48 __attribute__((__noreturn__))
50 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
51 #define _DBUS_GNUC_SCANF( format_idx, arg_idx )
52 #define _DBUS_GNUC_FORMAT( arg_idx )
53 #define _DBUS_GNUC_NORETURN
54 #endif /* !__GNUC__ */
56 void _dbus_warn (const char *format,
57 ...) _DBUS_GNUC_PRINTF (1, 2);
58 void _dbus_verbose_real (const char *format,
59 ...) _DBUS_GNUC_PRINTF (1, 2);
60 void _dbus_verbose_reset_real (void);
62 #ifdef DBUS_ENABLE_VERBOSE_MODE
63 # define _dbus_verbose _dbus_verbose_real
64 # define _dbus_verbose_reset _dbus_verbose_reset_real
66 # ifdef HAVE_ISO_VARARGS
67 # define _dbus_verbose(...)
68 # elif defined (HAVE_GNUC_VARARGS)
69 # define _dbus_verbose(format...)
71 # error "This compiler does not support varargs macros and thus verbose mode can't be disabled meaningfully"
73 # define _dbus_verbose_reset()
74 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
76 const char* _dbus_strerror (int error_number);
78 #ifdef DBUS_DISABLE_ASSERT
79 #define _dbus_assert(condition)
81 void _dbus_real_assert (dbus_bool_t condition,
82 const char *condition_text,
85 #define _dbus_assert(condition) \
86 _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__)
87 #endif /* !DBUS_DISABLE_ASSERT */
89 #ifdef DBUS_DISABLE_ASSERT
90 #define _dbus_assert_not_reached(explanation)
92 void _dbus_real_assert_not_reached (const char *explanation,
95 #define _dbus_assert_not_reached(explanation) \
96 _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
97 #endif /* !DBUS_DISABLE_ASSERT */
99 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
101 #define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
102 #define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
104 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
106 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
107 ((long) ((unsigned char*) &((struct_type*) 0)->member))
109 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
110 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error)))
112 /* This alignment thing is from ORBit2 */
113 /* Align a value upward to a boundary, expressed as a number of bytes.
114 * E.g. align to an 8-byte boundary with argument of 8.
118 * (this + boundary - 1)
123 #define _DBUS_ALIGN_VALUE(this, boundary) \
124 (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1)))
126 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
127 ((void*)_DBUS_ALIGN_VALUE(this, boundary))
129 char* _dbus_strdup (const char *str);
130 dbus_bool_t _dbus_string_array_contains (const char **array,
132 char** _dbus_dup_string_array (const char **array);
135 #define _DBUS_INT_MIN (-_DBUS_INT_MAX - 1)
136 #define _DBUS_INT_MAX 2147483647
137 #define _DBUS_UINT_MAX 0xffffffff
138 #define _DBUS_ONE_KILOBYTE 1024
139 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
140 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
141 #define _DBUS_USEC_PER_SECOND (1000000)
144 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
147 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
150 #define ABS(a) (((a) < 0) ? -(a) : (a))
152 typedef void (* DBusForeachFunction) (void *element,
155 dbus_bool_t _dbus_set_fd_nonblocking (int fd,
158 void _dbus_verbose_bytes (const unsigned char *data,
160 void _dbus_verbose_bytes_of_string (const DBusString *str,
165 const char* _dbus_type_to_string (int type);
167 extern const char _dbus_no_memory_message[];
168 #define _DBUS_SET_OOM(error) dbus_set_error ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
170 #ifdef DBUS_BUILD_TESTS
171 /* Memory debugging */
172 void _dbus_set_fail_alloc_counter (int until_next_fail);
173 int _dbus_get_fail_alloc_counter (void);
174 void _dbus_set_fail_alloc_failures (int failures_per_failure);
175 int _dbus_get_fail_alloc_failures (void);
176 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
177 dbus_bool_t _dbus_disable_mem_pools (void);
178 int _dbus_get_malloc_blocks_outstanding (void);
180 typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data);
181 dbus_bool_t _dbus_test_oom_handling (const char *description,
182 DBusTestMemoryFunction func,
185 #define _dbus_set_fail_alloc_counter(n)
186 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
188 /* These are constant expressions so that blocks
189 * they protect should be optimized away
191 #define _dbus_decrement_fail_alloc_counter() (FALSE)
192 #define _dbus_disable_mem_pools() (FALSE)
193 #define _dbus_get_malloc_blocks_outstanding (0)
194 #endif /* !DBUS_BUILD_TESTS */
196 typedef void (* DBusShutdownFunction) (void *data);
197 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function,
200 extern int _dbus_current_generation;
202 /* Thread initializers */
203 #define _DBUS_LOCK_NAME(name) _dbus_lock_##name
204 #define _DBUS_DECLARE_GLOBAL_LOCK(name) extern DBusMutex *_dbus_lock_##name
205 #define _DBUS_DEFINE_GLOBAL_LOCK(name) DBusMutex *_dbus_lock_##name
206 #define _DBUS_LOCK(name) dbus_mutex_lock (_dbus_lock_##name)
207 #define _DBUS_UNLOCK(name) dbus_mutex_unlock (_dbus_lock_##name)
209 _DBUS_DECLARE_GLOBAL_LOCK (list);
210 _DBUS_DECLARE_GLOBAL_LOCK (connection_slots);
211 _DBUS_DECLARE_GLOBAL_LOCK (server_slots);
212 _DBUS_DECLARE_GLOBAL_LOCK (atomic);
213 _DBUS_DECLARE_GLOBAL_LOCK (message_handler);
214 _DBUS_DECLARE_GLOBAL_LOCK (user_info);
215 _DBUS_DECLARE_GLOBAL_LOCK (bus);
216 _DBUS_DECLARE_GLOBAL_LOCK (shutdown_funcs);
217 #define _DBUS_N_GLOBAL_LOCKS (8)
219 dbus_bool_t _dbus_threads_init_debug (void);
223 #endif /* DBUS_INTERNALS_H */