dbus/dbus-internals.h

   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
  38 DBUS_BEGIN_DECLS;
  39
  40 void _dbus_warn         (const char *format,
  41                          ...);
  42 void _dbus_verbose_real (const char *format,
  43                          ...);
  44
  45
  46 #ifdef DBUS_ENABLE_VERBOSE_MODE
  47 #  define _dbus_verbose _dbus_verbose_real
  48 #else
  49 #  ifdef HAVE_ISO_VARARGS
  50 #    define _dbus_verbose(...)
  51 #  elif defined (HAVE_GNUC_VARARGS)
  52 #    define _dbus_verbose(format...)
  53 #  else
  54 #    error "This compiler does not support varargs macros and thus verbose mode can't be disabled meaningfully"
  55 #  endif
  56 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
  57
  58 const char* _dbus_strerror (int error_number);
  59
  60 DBusResultCode _dbus_result_from_errno (int error_number);
  61
  62 #ifdef DBUS_DISABLE_ASSERT
  63 #define _dbus_assert(condition)
  64 #else
  65 #define _dbus_assert(condition)                                         \
  66 do {                                                                    \
  67   if (!(condition))                                                     \
  68     {                                                                   \
  69       _dbus_warn ("Assertion failed \"%s\" file \"%s\" line %d\n",      \
  70                   #condition, __FILE__, __LINE__);                      \
  71       _dbus_abort ();                                                   \
  72     }                                                                   \
  73 } while (0)
  74 #endif /* !DBUS_DISABLE_ASSERT */
  75
  76 #ifdef DBUS_DISABLE_ASSERT
  77 #define _dbus_assert_not_reached(explanation)
  78 #else
  79 #define _dbus_assert_not_reached(explanation)                                   \
  80 do {                                                                            \
  81     _dbus_warn ("File \"%s\" line %d should not have been reached: %s\n",       \
  82                __FILE__, __LINE__, (explanation));                              \
  83     _dbus_abort ();                                                             \
  84 } while (0)
  85 #endif /* !DBUS_DISABLE_ASSERT */
  86
  87 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
  88
  89 #define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
  90 #define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
  91
  92 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
  93
  94 #define _DBUS_STRUCT_OFFSET(struct_type, member)        \
  95     ((long) ((unsigned char*) &((struct_type*) 0)->member))
  96
  97 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
  98
  99 /* This alignment thing is from ORBit2 */
 100 /* Align a value upward to a boundary, expressed as a number of bytes.
 101  * E.g. align to an 8-byte boundary with argument of 8.
 102  */
 103
 104 /*
 105  *   (this + boundary - 1)
 106  *          &
 107  *    ~(boundary - 1)
 108  */
 109
 110 #define _DBUS_ALIGN_VALUE(this, boundary) \
 111   (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1)))
 112
 113 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
 114   ((void*)_DBUS_ALIGN_VALUE(this, boundary))
 115
 116 char* _dbus_strdup (const char *str);
 117
 118 #define _DBUS_INT_MIN   (-_DBUS_INT_MAX - 1)
 119 #define _DBUS_INT_MAX   2147483647
 120 #define _DBUS_UINT_MAX  0xffffffff
 121 #define _DBUS_MAX_SUN_PATH_LENGTH 99
 122 #define _DBUS_ONE_KILOBYTE 1024
 123 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
 124 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
 125 #define _DBUS_USEC_PER_SECOND          (1000000)
 126
 127 #undef  MAX
 128 #define MAX(a, b)  (((a) > (b)) ? (a) : (b))
 129
 130 #undef  MIN
 131 #define MIN(a, b)  (((a) < (b)) ? (a) : (b))
 132
 133 #undef  ABS
 134 #define ABS(a)     (((a) < 0) ? -(a) : (a))
 135
 136 typedef void (* DBusForeachFunction) (void *element,
 137                                       void *data);
 138
 139 dbus_bool_t _dbus_set_fd_nonblocking (int             fd,
 140                                       DBusResultCode *result);
 141
 142 void _dbus_verbose_bytes           (const unsigned char *data,
 143                                     int                  len);
 144 void _dbus_verbose_bytes_of_string (const DBusString    *str,
 145                                     int                  start,
 146                                     int                  len);
 147
 148
 149 const char* _dbus_type_to_string (int type);
 150
 151 extern const char _dbus_no_memory_message[];
 152 #define _DBUS_SET_OOM(error) dbus_set_error ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
 153
 154 #ifdef DBUS_BUILD_TESTS
 155 /* Memory debugging */
 156 void        _dbus_set_fail_alloc_counter       (int  until_next_fail);
 157 int         _dbus_get_fail_alloc_counter       (void);
 158 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
 159 #else
 160 #define _dbus_set_fail_alloc_counter(n)
 161 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
 162 #define _dbus_decrement_fail_alloc_counter() FALSE
 163 #endif /* !DBUS_BUILD_TESTS */
 164
 165 /* Thread initializers */
 166 DBusMutex *_dbus_list_init_lock             (void);
 167 DBusMutex *_dbus_connection_slots_init_lock (void);
 168 DBusMutex *_dbus_server_slots_init_lock     (void);
 169 DBusMutex *_dbus_atomic_init_lock           (void);
 170 DBusMutex *_dbus_message_handler_init_lock  (void);
 171 DBusMutex *_dbus_user_info_init_lock        (void);
 172
 173 DBUS_END_DECLS;
 174
 175 #endif /* DBUS_INTERNALS_H */