dbus-internals.h revision eb63ba5039c8afe61210cf2b217ec75b4a86356e
1/* -*- mode: C; c-file-style: "gnu" -*- */ 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 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); 60void _dbus_verbose_reset_real (void); 61 62#ifdef DBUS_ENABLE_VERBOSE_MODE 63# define _dbus_verbose _dbus_verbose_real 64# define _dbus_verbose_reset _dbus_verbose_reset_real 65#else 66# ifdef HAVE_ISO_VARARGS 67# define _dbus_verbose(...) 68# elif defined (HAVE_GNUC_VARARGS) 69# define _dbus_verbose(format...) 70# else 71# error "This compiler does not support varargs macros and thus verbose mode can't be disabled meaningfully" 72# endif 73# define _dbus_verbose_reset() 74#endif /* !DBUS_ENABLE_VERBOSE_MODE */ 75 76const char* _dbus_strerror (int error_number); 77 78#ifdef DBUS_DISABLE_ASSERT 79#define _dbus_assert(condition) 80#else 81void _dbus_real_assert (dbus_bool_t condition, 82 const char *condition_text, 83 const char *file, 84 int line); 85#define _dbus_assert(condition) \ 86 _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__) 87#endif /* !DBUS_DISABLE_ASSERT */ 88 89#ifdef DBUS_DISABLE_ASSERT 90#define _dbus_assert_not_reached(explanation) 91#else 92void _dbus_real_assert_not_reached (const char *explanation, 93 const char *file, 94 int line); 95#define _dbus_assert_not_reached(explanation) \ 96 _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__) 97#endif /* !DBUS_DISABLE_ASSERT */ 98 99#define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0]))) 100 101#define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer)) 102#define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer))) 103 104#define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object)))) 105 106#define _DBUS_STRUCT_OFFSET(struct_type, member) \ 107 ((long) ((unsigned char*) &((struct_type*) 0)->member)) 108 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))) 111 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. 115 */ 116 117/* 118 * (this + boundary - 1) 119 * & 120 * ~(boundary - 1) 121 */ 122 123#define _DBUS_ALIGN_VALUE(this, boundary) \ 124 (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1))) 125 126#define _DBUS_ALIGN_ADDRESS(this, boundary) \ 127 ((void*)_DBUS_ALIGN_VALUE(this, boundary)) 128 129char* _dbus_strdup (const char *str); 130dbus_bool_t _dbus_string_array_contains (const char **array, 131 const char *str); 132char** _dbus_dup_string_array (const char **array); 133 134 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) 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 DBusError *error); 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); 174void _dbus_set_fail_alloc_failures (int failures_per_failure); 175int _dbus_get_fail_alloc_failures (void); 176dbus_bool_t _dbus_decrement_fail_alloc_counter (void); 177dbus_bool_t _dbus_disable_mem_pools (void); 178int _dbus_get_malloc_blocks_outstanding (void); 179 180typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data); 181dbus_bool_t _dbus_test_oom_handling (const char *description, 182 DBusTestMemoryFunction func, 183 void *data); 184#else 185#define _dbus_set_fail_alloc_counter(n) 186#define _dbus_get_fail_alloc_counter _DBUS_INT_MAX 187 188/* These are constant expressions so that blocks 189 * they protect should be optimized away 190 */ 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 */ 195 196typedef void (* DBusShutdownFunction) (void *data); 197dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function, 198 void *data); 199 200extern int _dbus_current_generation; 201 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) 208 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) 218 219dbus_bool_t _dbus_threads_init_debug (void); 220 221DBUS_END_DECLS; 222 223#endif /* DBUS_INTERNALS_H */ 224