WvStreams
|
00001 /* -*- mode: C; c-file-style: "gnu" -*- */ 00002 /* dbus-internals.h random utility stuff (internal to D-BUS implementation) 00003 * 00004 * Copyright (C) 2002, 2003 Red Hat, Inc. 00005 * 00006 * Licensed under the Academic Free License version 2.1 00007 * 00008 * This program is free software; you can redistribute it and/or modify 00009 * it under the terms of the GNU General Public License as published by 00010 * the Free Software Foundation; either version 2 of the License, or 00011 * (at your option) any later version. 00012 * 00013 * This program is distributed in the hope that it will be useful, 00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00016 * GNU General Public License for more details. 00017 * 00018 * You should have received a copy of the GNU General Public License 00019 * along with this program; if not, write to the Free Software 00020 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 00021 * 00022 */ 00023 #ifdef DBUS_INSIDE_DBUS_H 00024 #error "You can't include dbus-internals.h in the public header dbus.h" 00025 #endif 00026 00027 #ifndef DBUS_INTERNALS_H 00028 #define DBUS_INTERNALS_H 00029 00030 #include "config.h" 00031 00032 #include <dbus/dbus-memory.h> 00033 #include <dbus/dbus-types.h> 00034 #include <dbus/dbus-errors.h> 00035 #include <dbus/dbus-sysdeps.h> 00036 #include <dbus/dbus-threads-internal.h> 00037 00038 DBUS_BEGIN_DECLS 00039 00040 void _dbus_warn (const char *format, 00041 ...) _DBUS_GNUC_PRINTF (1, 2); 00042 00043 #if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) 00044 #define _DBUS_FUNCTION_NAME __func__ 00045 #elif defined(__GNUC__) 00046 #define _DBUS_FUNCTION_NAME __FUNCTION__ 00047 #else 00048 #define _DBUS_FUNCTION_NAME "unknown function" 00049 #endif 00050 00051 /* 00052 * (code from GLib) 00053 * 00054 * The _DBUS_LIKELY and _DBUS_UNLIKELY macros let the programmer give hints to 00055 * the compiler about the expected result of an expression. Some compilers 00056 * can use this information for optimizations. 00057 * 00058 * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when 00059 * putting assignments in the macro arg 00060 */ 00061 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__) 00062 #define _DBUS_BOOLEAN_EXPR(expr) \ 00063 __extension__ ({ \ 00064 int _dbus_boolean_var_; \ 00065 if (expr) \ 00066 _dbus_boolean_var_ = 1; \ 00067 else \ 00068 _dbus_boolean_var_ = 0; \ 00069 _dbus_boolean_var_; \ 00070 }) 00071 #define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1)) 00072 #define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0)) 00073 #else 00074 #define _DBUS_LIKELY(expr) (expr) 00075 #define _DBUS_UNLIKELY(expr) (expr) 00076 #endif 00077 00078 #ifdef DBUS_ENABLE_VERBOSE_MODE 00079 00080 void _dbus_verbose_real (const char *format, 00081 ...) _DBUS_GNUC_PRINTF (1, 2); 00082 void _dbus_verbose_reset_real (void); 00083 00084 # define _dbus_verbose _dbus_verbose_real 00085 # define _dbus_verbose_reset _dbus_verbose_reset_real 00086 #else 00087 # ifdef HAVE_ISO_VARARGS 00088 # define _dbus_verbose(...) 00089 # elif defined (HAVE_GNUC_VARARGS) 00090 # define _dbus_verbose(format...) 00091 # else 00092 # error "This compiler does not support varargs macros and thus verbose mode can't be disabled meaningfully" 00093 # endif 00094 # define _dbus_verbose_reset() 00095 #endif /* !DBUS_ENABLE_VERBOSE_MODE */ 00096 00097 const char* _dbus_strerror (int error_number); 00098 00099 #ifdef DBUS_DISABLE_ASSERT 00100 #define _dbus_assert(condition) 00101 #else 00102 void _dbus_real_assert (dbus_bool_t condition, 00103 const char *condition_text, 00104 const char *file, 00105 int line, 00106 const char *func); 00107 #define _dbus_assert(condition) \ 00108 _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME) 00109 #endif /* !DBUS_DISABLE_ASSERT */ 00110 00111 #ifdef DBUS_DISABLE_ASSERT 00112 #define _dbus_assert_not_reached(explanation) 00113 #else 00114 void _dbus_real_assert_not_reached (const char *explanation, 00115 const char *file, 00116 int line) _DBUS_GNUC_NORETURN; 00117 #define _dbus_assert_not_reached(explanation) \ 00118 _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__) 00119 #endif /* !DBUS_DISABLE_ASSERT */ 00120 00121 #ifdef DBUS_DISABLE_CHECKS 00122 #define _dbus_return_if_fail(condition) 00123 #define _dbus_return_val_if_fail(condition, val) 00124 #else 00125 extern const char _dbus_return_if_fail_warning_format[]; 00126 00127 #define _dbus_return_if_fail(condition) do { \ 00128 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \ 00129 if (!(condition)) { \ 00130 _dbus_warn (_dbus_return_if_fail_warning_format, \ 00131 _dbus_getpid (), _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \ 00132 return; \ 00133 } } while (0) 00134 00135 #define _dbus_return_val_if_fail(condition, val) do { \ 00136 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \ 00137 if (!(condition)) { \ 00138 _dbus_warn (_dbus_return_if_fail_warning_format, \ 00139 _dbus_getpid (), _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \ 00140 return (val); \ 00141 } } while (0) 00142 00143 #endif /* !DBUS_DISABLE_ASSERT */ 00144 00145 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0]))) 00146 00147 #define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer)) 00148 #define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer))) 00149 00150 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object)))) 00151 00152 #define _DBUS_STRUCT_OFFSET(struct_type, member) \ 00153 ((long) ((unsigned char*) &((struct_type*) 0)->member)) 00154 00155 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error))) 00156 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error))) 00157 00158 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error))) 00159 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val)) 00160 00161 /* This alignment thing is from ORBit2 */ 00162 /* Align a value upward to a boundary, expressed as a number of bytes. 00163 * E.g. align to an 8-byte boundary with argument of 8. 00164 */ 00165 00166 /* 00167 * (this + boundary - 1) 00168 * & 00169 * ~(boundary - 1) 00170 */ 00171 00172 #define _DBUS_ALIGN_VALUE(this, boundary) \ 00173 (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1))) 00174 00175 #define _DBUS_ALIGN_ADDRESS(this, boundary) \ 00176 ((void*)_DBUS_ALIGN_VALUE(this, boundary)) 00177 00178 00179 char* _dbus_strdup (const char *str); 00180 void* _dbus_memdup (const void *mem, 00181 size_t n_bytes); 00182 dbus_bool_t _dbus_string_array_contains (const char **array, 00183 const char *str); 00184 char** _dbus_dup_string_array (const char **array); 00185 00186 #define _DBUS_INT16_MIN ((dbus_int16_t) 0x8000) 00187 #define _DBUS_INT16_MAX ((dbus_int16_t) 0x7fff) 00188 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff) 00189 #define _DBUS_INT32_MIN ((dbus_int32_t) 0x80000000) 00190 #define _DBUS_INT32_MAX ((dbus_int32_t) 0x7fffffff) 00191 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff) 00192 /* using 32-bit here is sort of bogus */ 00193 #define _DBUS_INT_MIN _DBUS_INT32_MIN 00194 #define _DBUS_INT_MAX _DBUS_INT32_MAX 00195 #define _DBUS_UINT_MAX _DBUS_UINT32_MAX 00196 #ifdef DBUS_HAVE_INT64 00197 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff) 00198 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff) 00199 #endif 00200 #define _DBUS_ONE_KILOBYTE 1024 00201 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE 00202 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60) 00203 #define _DBUS_USEC_PER_SECOND (1000000) 00204 00205 #undef MAX 00206 #define MAX(a, b) (((a) > (b)) ? (a) : (b)) 00207 00208 #undef MIN 00209 #define MIN(a, b) (((a) < (b)) ? (a) : (b)) 00210 00211 #undef ABS 00212 #define ABS(a) (((a) < 0) ? -(a) : (a)) 00213 00214 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0)) 00215 00216 typedef void (* DBusForeachFunction) (void *element, 00217 void *data); 00218 00219 dbus_bool_t _dbus_set_fd_nonblocking (int fd, 00220 DBusError *error); 00221 00222 void _dbus_verbose_bytes (const unsigned char *data, 00223 int len, 00224 int offset); 00225 void _dbus_verbose_bytes_of_string (const DBusString *str, 00226 int start, 00227 int len); 00228 00229 const char* _dbus_header_field_to_string (int header_field); 00230 00231 extern const char _dbus_no_memory_message[]; 00232 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message) 00233 00234 #ifdef DBUS_BUILD_TESTS 00235 /* Memory debugging */ 00236 void _dbus_set_fail_alloc_counter (int until_next_fail); 00237 int _dbus_get_fail_alloc_counter (void); 00238 void _dbus_set_fail_alloc_failures (int failures_per_failure); 00239 int _dbus_get_fail_alloc_failures (void); 00240 dbus_bool_t _dbus_decrement_fail_alloc_counter (void); 00241 dbus_bool_t _dbus_disable_mem_pools (void); 00242 int _dbus_get_malloc_blocks_outstanding (void); 00243 00244 typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data); 00245 dbus_bool_t _dbus_test_oom_handling (const char *description, 00246 DBusTestMemoryFunction func, 00247 void *data); 00248 #else 00249 #define _dbus_set_fail_alloc_counter(n) 00250 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX 00251 00252 /* These are constant expressions so that blocks 00253 * they protect should be optimized away 00254 */ 00255 #define _dbus_decrement_fail_alloc_counter() (FALSE) 00256 #define _dbus_disable_mem_pools() (FALSE) 00257 #define _dbus_get_malloc_blocks_outstanding (0) 00258 #endif /* !DBUS_BUILD_TESTS */ 00259 00260 typedef void (* DBusShutdownFunction) (void *data); 00261 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function, 00262 void *data); 00263 00264 extern int _dbus_current_generation; 00265 00266 /* Thread initializers */ 00267 #define _DBUS_LOCK_NAME(name) _dbus_lock_##name 00268 #define _DBUS_DECLARE_GLOBAL_LOCK(name) extern DBusMutex *_dbus_lock_##name 00269 #define _DBUS_DEFINE_GLOBAL_LOCK(name) DBusMutex *_dbus_lock_##name 00270 #if WV_USE_LOCKS 00271 #define _DBUS_LOCK(name) _dbus_mutex_lock (_dbus_lock_##name) 00272 #define _DBUS_UNLOCK(name) _dbus_mutex_unlock (_dbus_lock_##name) 00273 #else 00274 #define _DBUS_LOCK(name) 1 00275 #define _DBUS_UNLOCK(name) 0 00276 #endif 00277 00278 _DBUS_DECLARE_GLOBAL_LOCK (list); 00279 _DBUS_DECLARE_GLOBAL_LOCK (connection_slots); 00280 _DBUS_DECLARE_GLOBAL_LOCK (pending_call_slots); 00281 _DBUS_DECLARE_GLOBAL_LOCK (server_slots); 00282 _DBUS_DECLARE_GLOBAL_LOCK (message_slots); 00283 _DBUS_DECLARE_GLOBAL_LOCK (atomic); 00284 _DBUS_DECLARE_GLOBAL_LOCK (bus); 00285 _DBUS_DECLARE_GLOBAL_LOCK (shutdown_funcs); 00286 _DBUS_DECLARE_GLOBAL_LOCK (system_users); 00287 _DBUS_DECLARE_GLOBAL_LOCK (message_cache); 00288 _DBUS_DECLARE_GLOBAL_LOCK (shared_connections); 00289 #define _DBUS_N_GLOBAL_LOCKS (11) 00290 00291 dbus_bool_t _dbus_threads_init_debug (void); 00292 00293 dbus_bool_t _dbus_address_append_escaped (DBusString *escaped, 00294 const DBusString *unescaped); 00295 00296 DBUS_END_DECLS 00297 00298 #endif /* DBUS_INTERNALS_H */