dbus/dbus-internals.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-internals.c  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 #include "dbus-internals.h"
  24 #include "dbus-protocol.h"
  25 #include "dbus-test.h"
  26 #include <stdio.h>
  27 #include <stdarg.h>
  28 #include <string.h>
  29 #include <sys/types.h>
  30 #include <errno.h>
  31 #include <unistd.h>
  32 #include <fcntl.h>
  33 #include <stdlib.h>
  34
  35 /**
  36  * @defgroup DBusInternals D-BUS internal implementation details
  37  * @brief Documentation useful when developing or debugging D-BUS itself.
  38  *
  39  */
  40
  41 /**
  42  * @defgroup DBusInternalsUtils Utilities and portability
  43  * @ingroup DBusInternals
  44  * @brief Utility functions (_dbus_assert(), _dbus_warn(), etc.)
  45  * @{
  46  */
  47
  48 /**
  49  * @def _dbus_assert
  50  *
  51  * Aborts with an error message if the condition is false.
  52  *
  53  * @param condition condition which must be true.
  54  */
  55
  56 /**
  57  * @def _dbus_assert_not_reached
  58  *
  59  * Aborts with an error message if called.
  60  * The given explanation will be printed.
  61  *
  62  * @param explanation explanation of what happened if the code was reached.
  63  */
  64
  65 /**
  66  * @def _DBUS_N_ELEMENTS
  67  *
  68  * Computes the number of elements in a fixed-size array using
  69  * sizeof().
  70  *
  71  * @param array the array to count elements in.
  72  */
  73
  74 /**
  75  * @def _DBUS_POINTER_TO_INT
  76  *
  77  * Safely casts a void* to an integer; should only be used on void*
  78  * that actually contain integers, for example one created with
  79  * _DBUS_INT_TO_POINTER.  Only guaranteed to preserve 32 bits.
  80  * (i.e. it's used to store 32-bit ints in pointers, but
  81  * can't be used to store 64-bit pointers in ints.)
  82  *
  83  * @param pointer pointer to extract an integer from.
  84  */
  85 /**
  86  * @def _DBUS_INT_TO_POINTER
  87  *
  88  * Safely stuffs an integer into a pointer, to be extracted later with
  89  * _DBUS_POINTER_TO_INT. Only guaranteed to preserve 32 bits.
  90  *
  91  * @param integer the integer to stuff into a pointer.
  92  */
  93 /**
  94  * @def _DBUS_ZERO
  95  *
  96  * Sets all bits in an object to zero.
  97  *
  98  * @param object the object to be zeroed.
  99  */
 100 /**
 101  * @def _DBUS_INT_MIN
 102  *
 103  * Minimum value of type "int"
 104  */
 105 /**
 106  * @def _DBUS_INT_MAX
 107  *
 108  * Maximum value of type "int"
 109  */
 110 /**
 111  * @def _DBUS_MAX_SUN_PATH_LENGTH
 112  *
 113  * Maximum length of the path to a UNIX domain socket,
 114  * sockaddr_un::sun_path member. POSIX requires that all systems
 115  * support at least 100 bytes here, including the nul termination.
 116  * We use 99 for the max value to allow for the nul.
 117  *
 118  * We could probably also do sizeof (addr.sun_path)
 119  * but this way we are the same on all platforms
 120  * which is probably a good idea.
 121  */
 122
 123 /**
 124  * @typedef DBusForeachFunction
 125  *
 126  * Used to iterate over each item in a collection, such as
 127  * a DBusList.
 128  */
 129
 130 /**
 131  * Prints a warning message to stderr.
 132  *
 133  * @param format printf-style format string.
 134  */
 135 void
 136 _dbus_warn (const char *format,
 137             ...)
 138 {
 139   /* FIXME not portable enough? */
 140   va_list args;
 141
 142   va_start (args, format);
 143   vfprintf (stderr, format, args);
 144   va_end (args);
 145 }
 146
 147 /**
 148  * Prints a warning message to stderr
 149  * if the user has enabled verbose mode.
 150  * This is the real function implementation,
 151  * use _dbus_verbose() macro in code.
 152  *
 153  * @param format printf-style format string.
 154  */
 155 void
 156 _dbus_verbose_real (const char *format,
 157                     ...)
 158 {
 159   va_list args;
 160   static dbus_bool_t verbose = TRUE;
 161   static dbus_bool_t initted = FALSE;
 162
 163   /* things are written a bit oddly here so that
 164    * in the non-verbose case we just have the one
 165    * conditional and return immediately.
 166    */
 167   if (!verbose)
 168     return;
 169
 170   if (!initted)
 171     {
 172       verbose = _dbus_getenv ("DBUS_VERBOSE") != NULL;
 173       initted = TRUE;
 174       if (!verbose)
 175         return;
 176     }
 177
 178   va_start (args, format);
 179   vfprintf (stderr, format, args);
 180   va_end (args);
 181 }
 182
 183 /**
 184  * A wrapper around strerror() because some platforms
 185  * may be lame and not have strerror().
 186  *
 187  * @param error_number errno.
 188  * @returns error description.
 189  */
 190 const char*
 191 _dbus_strerror (int error_number)
 192 {
 193   return strerror (error_number);
 194 }
 195
 196 /**
 197  * Converts a UNIX errno into a DBusResultCode.
 198  *
 199  * @param error_number the errno.
 200  * @returns the result code.
 201  */
 202 DBusResultCode
 203 _dbus_result_from_errno (int error_number)
 204 {
 205   switch (error_number)
 206     {
 207     case 0:
 208       return DBUS_RESULT_SUCCESS;
 209
 210 #ifdef EPROTONOSUPPORT
 211     case EPROTONOSUPPORT:
 212       return DBUS_RESULT_NOT_SUPPORTED;
 213 #endif
 214 #ifdef EAFNOSUPPORT
 215     case EAFNOSUPPORT:
 216       return DBUS_RESULT_NOT_SUPPORTED;
 217 #endif
 218 #ifdef ENFILE
 219     case ENFILE:
 220       return DBUS_RESULT_LIMITS_EXCEEDED; /* kernel out of memory */
 221 #endif
 222 #ifdef EMFILE
 223     case EMFILE:
 224       return DBUS_RESULT_LIMITS_EXCEEDED;
 225 #endif
 226 #ifdef EACCES
 227     case EACCES:
 228       return DBUS_RESULT_ACCESS_DENIED;
 229 #endif
 230 #ifdef EPERM
 231     case EPERM:
 232       return DBUS_RESULT_ACCESS_DENIED;
 233 #endif
 234 #ifdef ENOBUFS
 235     case ENOBUFS:
 236       return DBUS_RESULT_NO_MEMORY;
 237 #endif
 238 #ifdef ENOMEM
 239     case ENOMEM:
 240       return DBUS_RESULT_NO_MEMORY;
 241 #endif
 242 #ifdef EINVAL
 243     case EINVAL:
 244       return DBUS_RESULT_FAILED;
 245 #endif
 246 #ifdef EBADF
 247     case EBADF:
 248       return DBUS_RESULT_FAILED;
 249 #endif
 250 #ifdef EFAULT
 251     case EFAULT:
 252       return DBUS_RESULT_FAILED;
 253 #endif
 254 #ifdef ENOTSOCK
 255     case ENOTSOCK:
 256       return DBUS_RESULT_FAILED;
 257 #endif
 258 #ifdef EISCONN
 259     case EISCONN:
 260       return DBUS_RESULT_FAILED;
 261 #endif
 262 #ifdef ECONNREFUSED
 263     case ECONNREFUSED:
 264       return DBUS_RESULT_NO_SERVER;
 265 #endif
 266 #ifdef ETIMEDOUT
 267     case ETIMEDOUT:
 268       return DBUS_RESULT_TIMEOUT;
 269 #endif
 270 #ifdef ENETUNREACH
 271     case ENETUNREACH:
 272       return DBUS_RESULT_NO_NETWORK;
 273 #endif
 274 #ifdef EADDRINUSE
 275     case EADDRINUSE:
 276       return DBUS_RESULT_ADDRESS_IN_USE;
 277 #endif
 278     }
 279
 280   return DBUS_RESULT_FAILED;
 281 }
 282
 283 /**
 284  * Duplicates a string. Result must be freed with
 285  * dbus_free(). Returns #NULL if memory allocation fails.
 286  * If the string to be duplicated is #NULL, returns #NULL.
 287  *
 288  * @param str string to duplicate.
 289  * @returns newly-allocated copy.
 290  */
 291 char*
 292 _dbus_strdup (const char *str)
 293 {
 294   int len;
 295   char *copy;
 296
 297   if (str == NULL)
 298     return NULL;
 299
 300   len = strlen (str);
 301
 302   copy = dbus_malloc (len + 1);
 303   if (copy == NULL)
 304     return NULL;
 305
 306   memcpy (copy, str, len + 1);
 307
 308   return copy;
 309 }
 310
 311 /**
 312  * Sets a file descriptor to be nonblocking.
 313  *
 314  * @param fd the file descriptor.
 315  * @param result address of result code.
 316  * @returns #TRUE on success.
 317  */
 318 dbus_bool_t
 319 _dbus_set_fd_nonblocking (int             fd,
 320                           DBusResultCode *result)
 321 {
 322   int val;
 323
 324   val = fcntl (fd, F_GETFL, 0);
 325   if (val < 0)
 326     {
 327       dbus_set_result (result, _dbus_result_from_errno (errno));
 328       _dbus_verbose ("Failed to get flags for fd %d: %s\n", fd,
 329                      _dbus_strerror (errno));
 330       return FALSE;
 331     }
 332
 333   if (fcntl (fd, F_SETFL, val | O_NONBLOCK) < 0)
 334     {
 335       dbus_set_result (result, _dbus_result_from_errno (errno));
 336       _dbus_verbose ("Failed to set fd %d nonblocking: %s\n",
 337                      fd, _dbus_strerror (errno));
 338
 339       return FALSE;
 340     }
 341
 342   return TRUE;
 343 }
 344
 345 /**
 346  * Returns a string describing the given type.
 347  *
 348  * @param type the type to describe
 349  * @returns a constant string describing the type
 350  */
 351 const char *
 352 _dbus_type_to_string (int type)
 353 {
 354   switch (type)
 355     {
 356     case DBUS_TYPE_INVALID:
 357       return "invalid";
 358     case DBUS_TYPE_INT32:
 359       return "int32";
 360     case DBUS_TYPE_UINT32:
 361       return "uint32";
 362     case DBUS_TYPE_DOUBLE:
 363       return "double";
 364     case DBUS_TYPE_STRING:
 365       return "string";
 366     case DBUS_TYPE_BYTE_ARRAY:
 367       return "byte array";
 368     default:
 369       return "unknown";
 370     }
 371 }
 372
 373 /** @} */