dbus-internals.h revision 2f3fbd451d2bed1737052c672974e3dc31ad015f
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 79void _dbus_real_assert (dbus_bool_t condition, 80 const char *condition_text, 81 const char *file, 82 int line); 83#define _dbus_assert(condition) \ 84 _dbus_real_assert ((condition), #condition, __FILE__, __LINE__) 85#endif /* !DBUS_DISABLE_ASSERT */ 86 87#ifdef DBUS_DISABLE_ASSERT 88#define _dbus_assert_not_reached(explanation) 89#else 90void _dbus_real_assert_not_reached (const char *explanation, 91 const char *file, 92 int line); 93#define _dbus_assert_not_reached(explanation) \ 94 _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__) 95#endif /* !DBUS_DISABLE_ASSERT */ 96 97#define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0]))) 98 99#define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer)) 100#define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer))) 101 102#define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object)))) 103 104#define _DBUS_STRUCT_OFFSET(struct_type, member) \ 105 ((long) ((unsigned char*) &((struct_type*) 0)->member)) 106 107#define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error))) 108#define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error))) 109 110/* This alignment thing is from ORBit2 */ 111/* Align a value upward to a boundary, expressed as a number of bytes. 112 * E.g. align to an 8-byte boundary with argument of 8. 113 */ 114 115/* 116 * (this + boundary - 1) 117 * & 118 * ~(boundary - 1) 119 */ 120 121#define _DBUS_ALIGN_VALUE(this, boundary) \ 122 (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1))) 123 124#define _DBUS_ALIGN_ADDRESS(this, boundary) \ 125 ((void*)_DBUS_ALIGN_VALUE(this, boundary)) 126 127char* _dbus_strdup (const char *str); 128dbus_bool_t _dbus_string_array_contains (const char **array, 129 const char *str); 130char** _dbus_dup_string_array (const char **array); 131 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_ONE_KILOBYTE 1024 137#define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE 138#define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60) 139#define _DBUS_USEC_PER_SECOND (1000000) 140 141#undef MAX 142#define MAX(a, b) (((a) > (b)) ? (a) : (b)) 143 144#undef MIN 145#define MIN(a, b) (((a) < (b)) ? (a) : (b)) 146 147#undef ABS 148#define ABS(a) (((a) < 0) ? -(a) : (a)) 149 150typedef void (* DBusForeachFunction) (void *element, 151 void *data); 152 153dbus_bool_t _dbus_set_fd_nonblocking (int fd, 154 DBusError *error); 155 156void _dbus_verbose_bytes (const unsigned char *data, 157 int len); 158void _dbus_verbose_bytes_of_string (const DBusString *str, 159 int start, 160 int len); 161 162 163const char* _dbus_type_to_string (int type); 164 165extern const char _dbus_no_memory_message[]; 166#define _DBUS_SET_OOM(error) dbus_set_error ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message) 167 168#ifdef DBUS_BUILD_TESTS 169/* Memory debugging */ 170void _dbus_set_fail_alloc_counter (int until_next_fail); 171int _dbus_get_fail_alloc_counter (void); 172void _dbus_set_fail_alloc_failures (int failures_per_failure); 173int _dbus_get_fail_alloc_failures (void); 174dbus_bool_t _dbus_decrement_fail_alloc_counter (void); 175dbus_bool_t _dbus_disable_mem_pools (void); 176int _dbus_get_malloc_blocks_outstanding (void); 177 178typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data); 179dbus_bool_t _dbus_test_oom_handling (const char *description, 180 DBusTestMemoryFunction func, 181 void *data); 182#else 183#define _dbus_set_fail_alloc_counter(n) 184#define _dbus_get_fail_alloc_counter _DBUS_INT_MAX 185 186/* These are constant expressions so that blocks 187 * they protect should be optimized away 188 */ 189#define _dbus_decrement_fail_alloc_counter() (FALSE) 190#define _dbus_disable_mem_pools() (FALSE) 191#define _dbus_get_malloc_blocks_outstanding (0) 192#endif /* !DBUS_BUILD_TESTS */ 193 194typedef void (* DBusShutdownFunction) (void *data); 195dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function, 196 void *data); 197 198extern int _dbus_current_generation; 199 200/* Thread initializers */ 201#define _DBUS_LOCK_NAME(name) _dbus_lock_##name 202#define _DBUS_DECLARE_GLOBAL_LOCK(name) extern DBusMutex *_dbus_lock_##name 203#define _DBUS_DEFINE_GLOBAL_LOCK(name) DBusMutex *_dbus_lock_##name 204#define _DBUS_LOCK(name) dbus_mutex_lock (_dbus_lock_##name) 205#define _DBUS_UNLOCK(name) dbus_mutex_unlock (_dbus_lock_##name) 206 207_DBUS_DECLARE_GLOBAL_LOCK (list); 208_DBUS_DECLARE_GLOBAL_LOCK (connection_slots); 209_DBUS_DECLARE_GLOBAL_LOCK (server_slots); 210_DBUS_DECLARE_GLOBAL_LOCK (atomic); 211_DBUS_DECLARE_GLOBAL_LOCK (message_handler); 212_DBUS_DECLARE_GLOBAL_LOCK (user_info); 213_DBUS_DECLARE_GLOBAL_LOCK (bus); 214_DBUS_DECLARE_GLOBAL_LOCK (shutdown_funcs); 215#define _DBUS_N_GLOBAL_LOCKS (8) 216 217DBUS_END_DECLS; 218 219#endif /* DBUS_INTERNALS_H */ 220