1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ 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 2.1 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 <dbus/dbus-memory.h> 31 #include <dbus/dbus-types.h> 32 #include <dbus/dbus-errors.h> 33 #include <dbus/dbus-sysdeps.h> 34 #include <dbus/dbus-threads-internal.h> 35 36 DBUS_BEGIN_DECLS 37 38 #ifndef DBUS_SESSION_BUS_DEFAULT_ADDRESS 39 #define DBUS_SESSION_BUS_DEFAULT_ADDRESS "autolaunch:" 40 #endif 41 42 void _dbus_warn (const char *format, 43 ...) _DBUS_GNUC_PRINTF (1, 2); 44 45 void _dbus_warn_check_failed (const char *format, 46 ...) _DBUS_GNUC_PRINTF (1, 2); 47 48 49 #if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) 50 #define _DBUS_FUNCTION_NAME __func__ 51 #elif defined(__GNUC__) || defined(_MSC_VER) 52 #define _DBUS_FUNCTION_NAME __FUNCTION__ 53 #else 54 #define _DBUS_FUNCTION_NAME "unknown function" 55 #endif 56 57 /* 58 * (code from GLib) 59 * 60 * The _DBUS_LIKELY and _DBUS_UNLIKELY macros let the programmer give hints to 61 * the compiler about the expected result of an expression. Some compilers 62 * can use this information for optimizations. 63 * 64 * The _DBUS_BOOLEAN_EXPR macro is intended to trigger a gcc warning when 65 * putting assignments in the macro arg 66 */ 67 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__) 68 #define _DBUS_BOOLEAN_EXPR(expr) \ 69 __extension__ ({ \ 70 int _dbus_boolean_var_; \ 71 if (expr) \ 72 _dbus_boolean_var_ = 1; \ 73 else \ 74 _dbus_boolean_var_ = 0; \ 75 _dbus_boolean_var_; \ 76 }) 77 #define _DBUS_LIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 1)) 78 #define _DBUS_UNLIKELY(expr) (__builtin_expect (_DBUS_BOOLEAN_EXPR(expr), 0)) 79 #else 80 #define _DBUS_LIKELY(expr) (expr) 81 #define _DBUS_UNLIKELY(expr) (expr) 82 #endif 83 84 #ifdef DBUS_ENABLE_VERBOSE_MODE 85 86 /* 87 at least gnu cc and msvc compiler are known to 88 have support for variable macro argument lists 89 add other compilers is required 90 */ 91 #if defined(__GNUC__) || defined(_MSC_VER) 92 #define DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS 93 #endif 94 95 #ifdef DBUS_CPP_SUPPORTS_VARIABLE_MACRO_ARGUMENTS 96 void _dbus_verbose_real (const char *file, const int line, const char *function, 97 const char *format,...) _DBUS_GNUC_PRINTF (4, 5); 98 # define _dbus_verbose(fmt,...) _dbus_verbose_real( __FILE__,__LINE__,__FUNCTION__,fmt, ## __VA_ARGS__) 99 #else 100 void _dbus_verbose_real (const char *format, 101 ...) _DBUS_GNUC_PRINTF (1, 2); 102 # define _dbus_verbose _dbus_verbose_real 103 #endif 104 void _dbus_verbose_reset_real (void); 105 dbus_bool_t _dbus_is_verbose_real (void); 106 107 # define _dbus_verbose_reset _dbus_verbose_reset_real 108 # define _dbus_is_verbose _dbus_is_verbose_real 109 #else 110 # ifdef HAVE_ISO_VARARGS 111 # define _dbus_verbose(...) do { } while (0) 112 # elif defined (HAVE_GNUC_VARARGS) 113 # define _dbus_verbose(format...) do { } while (0) 114 # else 115 static void _dbus_verbose(const char * x,...) {;} 116 # endif 117 # define _dbus_verbose_reset() do { } while (0) 118 # define _dbus_is_verbose() FALSE 119 #endif /* !DBUS_ENABLE_VERBOSE_MODE */ 120 121 void _dbus_trace_ref (const char *obj_name, 122 void *obj, 123 int old_refcount, 124 int new_refcount, 125 const char *why, 126 const char *env_var, 127 int *enabled); 128 129 const char* _dbus_strerror (int error_number); 130 131 #ifdef DBUS_DISABLE_ASSERT 132 #define _dbus_assert(condition) do { } while (0) 133 #else 134 void _dbus_real_assert (dbus_bool_t condition, 135 const char *condition_text, 136 const char *file, 137 int line, 138 const char *func); 139 #define _dbus_assert(condition) \ 140 _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__, _DBUS_FUNCTION_NAME) 141 #endif /* !DBUS_DISABLE_ASSERT */ 142 143 #ifdef DBUS_DISABLE_ASSERT 144 #define _dbus_assert_not_reached(explanation) do { } while (0) 145 #else 146 void _dbus_real_assert_not_reached (const char *explanation, 147 const char *file, 148 int line) _DBUS_GNUC_NORETURN; 149 #define _dbus_assert_not_reached(explanation) \ 150 _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__) 151 #endif /* !DBUS_DISABLE_ASSERT */ 152 153 #ifdef DBUS_DISABLE_CHECKS 154 #define _dbus_return_if_fail(condition) 155 #define _dbus_return_val_if_fail(condition, val) 156 #else 157 158 extern const char *_dbus_return_if_fail_warning_format; 159 160 #define _dbus_return_if_fail(condition) do { \ 161 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \ 162 if (!(condition)) { \ 163 _dbus_warn_check_failed (_dbus_return_if_fail_warning_format, \ 164 _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \ 165 return; \ 166 } } while (0) 167 168 #define _dbus_return_val_if_fail(condition, val) do { \ 169 _dbus_assert ((*(const char*)_DBUS_FUNCTION_NAME) != '_'); \ 170 if (!(condition)) { \ 171 _dbus_warn_check_failed (_dbus_return_if_fail_warning_format, \ 172 _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__); \ 173 return (val); \ 174 } } while (0) 175 176 #endif /* !DBUS_DISABLE_ASSERT */ 177 178 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0]))) 179 180 #define _DBUS_POINTER_TO_INT(pointer) ((intptr_t)(pointer)) 181 #define _DBUS_INT_TO_POINTER(integer) ((void*)((intptr_t)(integer))) 182 183 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object)))) 184 185 #define _DBUS_STRUCT_OFFSET(struct_type, member) \ 186 ((intptr_t) ((unsigned char*) &((struct_type*) 0)->member)) 187 188 #ifdef DBUS_DISABLE_CHECKS 189 /* this is an assert and not an error, but in the typical --disable-checks case (you're trying 190 * to really minimize code size), disabling these assertions makes sense. 191 */ 192 #define _DBUS_ASSERT_ERROR_IS_SET(error) do { } while (0) 193 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) do { } while (0) 194 #else 195 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error))) 196 #define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error))) 197 #endif 198 199 #define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error))) 200 #define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val)) 201 202 /* This alignment thing is from ORBit2 */ 203 /* Align a value upward to a boundary, expressed as a number of bytes. 204 * E.g. align to an 8-byte boundary with argument of 8. 205 */ 206 207 /* 208 * (this + boundary - 1) 209 * & 210 * ~(boundary - 1) 211 */ 212 213 #define _DBUS_ALIGN_VALUE(this, boundary) \ 214 (( ((uintptr_t)(this)) + (((uintptr_t)(boundary)) -1)) & (~(((uintptr_t)(boundary))-1))) 215 216 #define _DBUS_ALIGN_ADDRESS(this, boundary) \ 217 ((void*)_DBUS_ALIGN_VALUE(this, boundary)) 218 219 220 char* _dbus_strdup (const char *str); 221 void* _dbus_memdup (const void *mem, 222 size_t n_bytes); 223 dbus_bool_t _dbus_string_array_contains (const char **array, 224 const char *str); 225 char** _dbus_dup_string_array (const char **array); 226 227 #define _DBUS_INT16_MIN ((dbus_int16_t) 0x8000) 228 #define _DBUS_INT16_MAX ((dbus_int16_t) 0x7fff) 229 #define _DBUS_UINT16_MAX ((dbus_uint16_t)0xffff) 230 #define _DBUS_INT32_MIN ((dbus_int32_t) 0x80000000) 231 #define _DBUS_INT32_MAX ((dbus_int32_t) 0x7fffffff) 232 #define _DBUS_UINT32_MAX ((dbus_uint32_t)0xffffffff) 233 /* using 32-bit here is sort of bogus */ 234 #define _DBUS_INT_MIN _DBUS_INT32_MIN 235 #define _DBUS_INT_MAX _DBUS_INT32_MAX 236 #define _DBUS_UINT_MAX _DBUS_UINT32_MAX 237 #ifdef DBUS_HAVE_INT64 238 #define _DBUS_INT64_MAX DBUS_INT64_CONSTANT (0x7fffffffffffffff) 239 #define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff) 240 #endif 241 #define _DBUS_ONE_KILOBYTE 1024 242 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE 243 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60) 244 #define _DBUS_USEC_PER_SECOND (1000000) 245 246 #undef MAX 247 #define MAX(a, b) (((a) > (b)) ? (a) : (b)) 248 249 #undef MIN 250 #define MIN(a, b) (((a) < (b)) ? (a) : (b)) 251 252 #undef ABS 253 #define ABS(a) (((a) < 0) ? -(a) : (a)) 254 255 #define _DBUS_ISASCII(c) ((c) != '\0' && (((c) & ~0x7f) == 0)) 256 257 typedef void (* DBusForeachFunction) (void *element, 258 void *data); 259 260 dbus_bool_t _dbus_set_fd_nonblocking (int fd, 261 DBusError *error); 262 263 void _dbus_verbose_bytes (const unsigned char *data, 264 int len, 265 int offset); 266 void _dbus_verbose_bytes_of_string (const DBusString *str, 267 int start, 268 int len); 269 270 extern const char *_dbus_no_memory_message; 271 #define _DBUS_SET_OOM(error) dbus_set_error_const ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message) 272 273 #ifdef DBUS_BUILD_TESTS 274 /* Memory debugging */ 275 void _dbus_set_fail_alloc_counter (int until_next_fail); 276 int _dbus_get_fail_alloc_counter (void); 277 void _dbus_set_fail_alloc_failures (int failures_per_failure); 278 int _dbus_get_fail_alloc_failures (void); 279 dbus_bool_t _dbus_decrement_fail_alloc_counter (void); 280 dbus_bool_t _dbus_disable_mem_pools (void); 281 int _dbus_get_malloc_blocks_outstanding (void); 282 283 typedef dbus_bool_t (* DBusTestMemoryFunction) (void *data); 284 dbus_bool_t _dbus_test_oom_handling (const char *description, 285 DBusTestMemoryFunction func, 286 void *data); 287 #else 288 #define _dbus_set_fail_alloc_counter(n) 289 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX 290 291 /* These are constant expressions so that blocks 292 * they protect should be optimized away 293 */ 294 #define _dbus_decrement_fail_alloc_counter() (FALSE) 295 #define _dbus_disable_mem_pools() (FALSE) 296 #define _dbus_get_malloc_blocks_outstanding (0) 297 #endif /* !DBUS_BUILD_TESTS */ 298 299 typedef void (* DBusShutdownFunction) (void *data); 300 dbus_bool_t _dbus_register_shutdown_func (DBusShutdownFunction function, 301 void *data); 302 303 extern int _dbus_current_generation; 304 305 /* Thread initializers */ 306 #define _DBUS_LOCK_NAME(name) _dbus_lock_##name 307 #define _DBUS_DECLARE_GLOBAL_LOCK(name) extern DBusRMutex *_dbus_lock_##name 308 #define _DBUS_DEFINE_GLOBAL_LOCK(name) DBusRMutex *_dbus_lock_##name 309 #define _DBUS_LOCK(name) _dbus_rmutex_lock (_dbus_lock_##name) 310 #define _DBUS_UNLOCK(name) _dbus_rmutex_unlock (_dbus_lock_##name) 311 312 /* 1-5 */ 313 _DBUS_DECLARE_GLOBAL_LOCK (list); 314 _DBUS_DECLARE_GLOBAL_LOCK (connection_slots); 315 _DBUS_DECLARE_GLOBAL_LOCK (pending_call_slots); 316 _DBUS_DECLARE_GLOBAL_LOCK (server_slots); 317 _DBUS_DECLARE_GLOBAL_LOCK (message_slots); 318 /* 5-10 */ 319 _DBUS_DECLARE_GLOBAL_LOCK (bus); 320 _DBUS_DECLARE_GLOBAL_LOCK (bus_datas); 321 _DBUS_DECLARE_GLOBAL_LOCK (shutdown_funcs); 322 _DBUS_DECLARE_GLOBAL_LOCK (system_users); 323 _DBUS_DECLARE_GLOBAL_LOCK (message_cache); 324 /* 10-14 */ 325 _DBUS_DECLARE_GLOBAL_LOCK (shared_connections); 326 _DBUS_DECLARE_GLOBAL_LOCK (win_fds); 327 _DBUS_DECLARE_GLOBAL_LOCK (sid_atom_cache); 328 _DBUS_DECLARE_GLOBAL_LOCK (machine_uuid); 329 330 #if !DBUS_USE_SYNC 331 _DBUS_DECLARE_GLOBAL_LOCK (atomic); 332 #define _DBUS_N_GLOBAL_LOCKS (15) 333 #else 334 #define _DBUS_N_GLOBAL_LOCKS (14) 335 #endif 336 337 dbus_bool_t _dbus_threads_init_debug (void); 338 339 dbus_bool_t _dbus_address_append_escaped (DBusString *escaped, 340 const DBusString *unescaped); 341 342 void _dbus_set_bad_address (DBusError *error, 343 const char *address_problem_type, 344 const char *address_problem_field, 345 const char *address_problem_other); 346 347 #define DBUS_UUID_LENGTH_BYTES 16 348 #define DBUS_UUID_LENGTH_WORDS (DBUS_UUID_LENGTH_BYTES / 4) 349 #define DBUS_UUID_LENGTH_HEX (DBUS_UUID_LENGTH_BYTES * 2) 350 351 /** 352 * A globally unique ID ; we have one for each DBusServer, and also one for each 353 * machine with libdbus installed on it. 354 */ 355 union DBusGUID 356 { 357 dbus_uint32_t as_uint32s[DBUS_UUID_LENGTH_WORDS]; /**< guid as four uint32 values */ 358 char as_bytes[DBUS_UUID_LENGTH_BYTES]; /**< guid as 16 single-byte values */ 359 }; 360 361 void _dbus_generate_uuid (DBusGUID *uuid); 362 dbus_bool_t _dbus_uuid_encode (const DBusGUID *uuid, 363 DBusString *encoded); 364 dbus_bool_t _dbus_read_uuid_file (const DBusString *filename, 365 DBusGUID *uuid, 366 dbus_bool_t create_if_not_found, 367 DBusError *error); 368 369 dbus_bool_t _dbus_get_local_machine_uuid_encoded (DBusString *uuid_str); 370 371 #define _DBUS_PASTE2(a, b) a ## b 372 #define _DBUS_PASTE(a, b) _DBUS_PASTE2 (a, b) 373 #define _DBUS_STATIC_ASSERT(expr) \ 374 typedef struct { char _assertion[(expr) ? 1 : -1]; } \ 375 _DBUS_PASTE (_DBUS_STATIC_ASSERT_, __LINE__) 376 377 DBUS_END_DECLS 378 379 #endif /* DBUS_INTERNALS_H */ 380
