dbus-internals.h revision bf99381351b802fb3348a24037898222aae631e2 
1/* -*- mode: C; c-file-style: "gnu" -*- */
2/* dbus-internals.h  random utility stuff (internal to D-BUS implementation)
3 *
4 * Copyright (C) 2002  Red Hat, Inc.
5 *
6 * Licensed under the Academic Free License version 1.2
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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 <config.h>
31
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>
37
38DBUS_BEGIN_DECLS;
39
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__))
49#else   /* !__GNUC__ */
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__ */
55
56void _dbus_warn         (const char *format,
57                         ...) _DBUS_GNUC_PRINTF (1, 2);
58void _dbus_verbose_real (const char *format,
59                         ...) _DBUS_GNUC_PRINTF (1, 2);
60
61
62#ifdef DBUS_ENABLE_VERBOSE_MODE
63#  define _dbus_verbose _dbus_verbose_real
64#else
65#  ifdef HAVE_ISO_VARARGS
66#    define _dbus_verbose(...)
67#  elif defined (HAVE_GNUC_VARARGS)
68#    define _dbus_verbose(format...)
69#  else
70#    error "This compiler does not support varargs macros and thus verbose mode can't be disabled meaningfully"
71#  endif
72#endif /* !DBUS_ENABLE_VERBOSE_MODE */
73
74const char* _dbus_strerror (int error_number);
75
76#ifdef DBUS_DISABLE_ASSERT
77#define _dbus_assert(condition)
78#else
79#define _dbus_assert(condition)                                         \
80do {                                                                    \
81  if (!(condition))                                                     \
82    {                                                                   \
83      _dbus_warn ("Assertion failed \"%s\" file \"%s\" line %d\n",      \
84                  #condition, __FILE__, __LINE__);                      \
85      _dbus_abort ();                                                   \
86    }                                                                   \
87} while (0)
88#endif /* !DBUS_DISABLE_ASSERT */
89
90#ifdef DBUS_DISABLE_ASSERT
91#define _dbus_assert_not_reached(explanation)
92#else
93#define _dbus_assert_not_reached(explanation)                                   \
94do {                                                                            \
95    _dbus_warn ("File \"%s\" line %d should not have been reached: %s\n",       \
96               __FILE__, __LINE__, (explanation));                              \
97    _dbus_abort ();                                                             \
98} while (0)
99#endif /* !DBUS_DISABLE_ASSERT */
100
101#define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
102
103#define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
104#define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
105
106#define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
107
108#define _DBUS_STRUCT_OFFSET(struct_type, member)	\
109    ((long) ((unsigned char*) &((struct_type*) 0)->member))
110
111#define _DBUS_ASSERT_ERROR_IS_SET(error)   _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
112#define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error)))
113
114/* This alignment thing is from ORBit2 */
115/* Align a value upward to a boundary, expressed as a number of bytes.
116 * E.g. align to an 8-byte boundary with argument of 8.
117 */
118
119/*
120 *   (this + boundary - 1)
121 *          &
122 *    ~(boundary - 1)
123 */
124
125#define _DBUS_ALIGN_VALUE(this, boundary) \
126  (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1)))
127
128#define _DBUS_ALIGN_ADDRESS(this, boundary) \
129  ((void*)_DBUS_ALIGN_VALUE(this, boundary))
130
131char* _dbus_strdup (const char *str);
132
133#define _DBUS_INT_MIN	(-_DBUS_INT_MAX - 1)
134#define _DBUS_INT_MAX	2147483647
135#define _DBUS_UINT_MAX	0xffffffff
136#define _DBUS_MAX_SUN_PATH_LENGTH 99
137#define _DBUS_ONE_KILOBYTE 1024
138#define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
139#define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
140#define _DBUS_USEC_PER_SECOND          (1000000)
141
142#undef	MAX
143#define MAX(a, b)  (((a) > (b)) ? (a) : (b))
144
145#undef	MIN
146#define MIN(a, b)  (((a) < (b)) ? (a) : (b))
147
148#undef	ABS
149#define ABS(a)	   (((a) < 0) ? -(a) : (a))
150
151typedef void (* DBusForeachFunction) (void *element,
152                                      void *data);
153
154dbus_bool_t _dbus_set_fd_nonblocking (int             fd,
155                                      DBusError      *error);
156
157void _dbus_verbose_bytes           (const unsigned char *data,
158                                    int                  len);
159void _dbus_verbose_bytes_of_string (const DBusString    *str,
160                                    int                  start,
161                                    int                  len);
162
163
164const char* _dbus_type_to_string (int type);
165
166extern const char _dbus_no_memory_message[];
167#define _DBUS_SET_OOM(error) dbus_set_error ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
168
169#ifdef DBUS_BUILD_TESTS
170/* Memory debugging */
171void        _dbus_set_fail_alloc_counter        (int  until_next_fail);
172int         _dbus_get_fail_alloc_counter        (void);
173void        _dbus_set_fail_alloc_failures       (int  failures_per_failure);
174int         _dbus_get_fail_alloc_failures       (void);
175dbus_bool_t _dbus_decrement_fail_alloc_counter  (void);
176dbus_bool_t _dbus_disable_mem_pools             (void);
177int         _dbus_get_malloc_blocks_outstanding (void);
178
179typedef dbus_bool_t (* DBusTestMemoryFunction)  (void *data);
180dbus_bool_t _dbus_test_oom_handling (const char             *description,
181                                     DBusTestMemoryFunction  func,
182                                     void                   *data);
183#else
184#define _dbus_set_fail_alloc_counter(n)
185#define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
186
187/* These are constant expressions so that blocks
188 * they protect should be optimized away
189 */
190#define _dbus_decrement_fail_alloc_counter() (FALSE)
191#define _dbus_disable_mem_pools()            (FALSE)
192#define _dbus_get_malloc_blocks_outstanding  (0)
193#endif /* !DBUS_BUILD_TESTS */
194
195typedef void (* DBusShutdownFunction) (void *data);
196dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction  function,
197                                          void                 *data);
198
199extern int _dbus_current_generation;
200
201/* Thread initializers */
202#define _DBUS_LOCK_NAME(name)           _dbus_lock_##name
203#define _DBUS_DECLARE_GLOBAL_LOCK(name) extern DBusMutex  *_dbus_lock_##name
204#define _DBUS_DEFINE_GLOBAL_LOCK(name)  DBusMutex         *_dbus_lock_##name
205#define _DBUS_LOCK(name)                dbus_mutex_lock   (_dbus_lock_##name)
206#define _DBUS_UNLOCK(name)              dbus_mutex_unlock (_dbus_lock_##name)
207
208_DBUS_DECLARE_GLOBAL_LOCK (list);
209_DBUS_DECLARE_GLOBAL_LOCK (connection_slots);
210_DBUS_DECLARE_GLOBAL_LOCK (server_slots);
211_DBUS_DECLARE_GLOBAL_LOCK (atomic);
212_DBUS_DECLARE_GLOBAL_LOCK (message_handler);
213_DBUS_DECLARE_GLOBAL_LOCK (user_info);
214_DBUS_DECLARE_GLOBAL_LOCK (bus);
215#define _DBUS_N_GLOBAL_LOCKS (7)
216
217DBUS_END_DECLS;
218
219#endif /* DBUS_INTERNALS_H */
220