dbus-internals.h revision 615fa679e1f8339d4f57e8b6dc49e7fb5da49f2d 
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
76DBusResultCode _dbus_result_from_errno (int error_number);
77
78#ifdef DBUS_DISABLE_ASSERT
79#define _dbus_assert(condition)
80#else
81#define _dbus_assert(condition)                                         \
82do {                                                                    \
83  if (!(condition))                                                     \
84    {                                                                   \
85      _dbus_warn ("Assertion failed \"%s\" file \"%s\" line %d\n",      \
86                  #condition, __FILE__, __LINE__);                      \
87      _dbus_abort ();                                                   \
88    }                                                                   \
89} while (0)
90#endif /* !DBUS_DISABLE_ASSERT */
91
92#ifdef DBUS_DISABLE_ASSERT
93#define _dbus_assert_not_reached(explanation)
94#else
95#define _dbus_assert_not_reached(explanation)                                   \
96do {                                                                            \
97    _dbus_warn ("File \"%s\" line %d should not have been reached: %s\n",       \
98               __FILE__, __LINE__, (explanation));                              \
99    _dbus_abort ();                                                             \
100} while (0)
101#endif /* !DBUS_DISABLE_ASSERT */
102
103#define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
104
105#define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
106#define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
107
108#define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
109
110#define _DBUS_STRUCT_OFFSET(struct_type, member)	\
111    ((long) ((unsigned char*) &((struct_type*) 0)->member))
112
113#define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
114
115/* This alignment thing is from ORBit2 */
116/* Align a value upward to a boundary, expressed as a number of bytes.
117 * E.g. align to an 8-byte boundary with argument of 8.
118 */
119
120/*
121 *   (this + boundary - 1)
122 *          &
123 *    ~(boundary - 1)
124 */
125
126#define _DBUS_ALIGN_VALUE(this, boundary) \
127  (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1)))
128
129#define _DBUS_ALIGN_ADDRESS(this, boundary) \
130  ((void*)_DBUS_ALIGN_VALUE(this, boundary))
131
132char* _dbus_strdup (const char *str);
133
134#define _DBUS_INT_MIN	(-_DBUS_INT_MAX - 1)
135#define _DBUS_INT_MAX	2147483647
136#define _DBUS_UINT_MAX	0xffffffff
137#define _DBUS_MAX_SUN_PATH_LENGTH 99
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)
142
143#undef	MAX
144#define MAX(a, b)  (((a) > (b)) ? (a) : (b))
145
146#undef	MIN
147#define MIN(a, b)  (((a) < (b)) ? (a) : (b))
148
149#undef	ABS
150#define ABS(a)	   (((a) < 0) ? -(a) : (a))
151
152typedef void (* DBusForeachFunction) (void *element,
153                                      void *data);
154
155dbus_bool_t _dbus_set_fd_nonblocking (int             fd,
156                                      DBusResultCode *result);
157
158void _dbus_verbose_bytes           (const unsigned char *data,
159                                    int                  len);
160void _dbus_verbose_bytes_of_string (const DBusString    *str,
161                                    int                  start,
162                                    int                  len);
163
164
165const char* _dbus_type_to_string (int type);
166
167extern const char _dbus_no_memory_message[];
168#define _DBUS_SET_OOM(error) dbus_set_error ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
169
170#ifdef DBUS_BUILD_TESTS
171/* Memory debugging */
172void        _dbus_set_fail_alloc_counter       (int  until_next_fail);
173int         _dbus_get_fail_alloc_counter       (void);
174dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
175dbus_bool_t _dbus_disable_mem_pools            (void);
176#else
177#define _dbus_set_fail_alloc_counter(n)
178#define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
179
180/* These are constant expressions so that blocks
181 * they protect should be optimized away
182 */
183#define _dbus_decrement_fail_alloc_counter() FALSE
184#define _dbus_disable_mem_pools()            FALSE
185#endif /* !DBUS_BUILD_TESTS */
186
187/* Thread initializers */
188DBusMutex *_dbus_list_init_lock             (void);
189DBusMutex *_dbus_connection_slots_init_lock (void);
190DBusMutex *_dbus_server_slots_init_lock     (void);
191DBusMutex *_dbus_atomic_init_lock           (void);
192DBusMutex *_dbus_message_handler_init_lock  (void);
193DBusMutex *_dbus_user_info_init_lock        (void);
194DBusMutex *_dbus_bus_init_lock              (void);
195
196DBUS_END_DECLS;
197
198#endif /* DBUS_INTERNALS_H */
199