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  *
 151  * @param format printf-style format string.
 152  */
 153 void
 154 _dbus_verbose (const char *format,
 155                ...)
 156 {
 157   va_list args;
 158   static dbus_bool_t verbose = TRUE;
 159   static dbus_bool_t initted = FALSE;
 160
 161   /* things are written a bit oddly here so that
 162    * in the non-verbose case we just have the one
 163    * conditional and return immediately.
 164    */
 165   if (!verbose)
 166     return;
 167
 168   if (!initted)
 169     {
 170       verbose = _dbus_getenv ("DBUS_VERBOSE") != NULL;
 171       initted = TRUE;
 172       if (!verbose)
 173         return;
 174     }
 175
 176   va_start (args, format);
 177   vfprintf (stderr, format, args);
 178   va_end (args);
 179 }
 180
 181 /**
 182  * A wrapper around strerror() because some platforms
 183  * may be lame and not have strerror().
 184  *
 185  * @param error_number errno.
 186  * @returns error description.
 187  */
 188 const char*
 189 _dbus_strerror (int error_number)
 190 {
 191   return strerror (error_number);
 192 }
 193
 194 /**
 195  * Converts a UNIX errno into a DBusResultCode.
 196  *
 197  * @param error_number the errno.
 198  * @returns the result code.
 199  */
 200 DBusResultCode
 201 _dbus_result_from_errno (int error_number)
 202 {
 203   switch (error_number)
 204     {
 205     case 0:
 206       return DBUS_RESULT_SUCCESS;
 207
 208 #ifdef EPROTONOSUPPORT
 209     case EPROTONOSUPPORT:
 210       return DBUS_RESULT_NOT_SUPPORTED;
 211 #endif
 212 #ifdef EAFNOSUPPORT
 213     case EAFNOSUPPORT:
 214       return DBUS_RESULT_NOT_SUPPORTED;
 215 #endif
 216 #ifdef ENFILE
 217     case ENFILE:
 218       return DBUS_RESULT_LIMITS_EXCEEDED; /* kernel out of memory */
 219 #endif
 220 #ifdef EMFILE
 221     case EMFILE:
 222       return DBUS_RESULT_LIMITS_EXCEEDED;
 223 #endif
 224 #ifdef EACCES
 225     case EACCES:
 226       return DBUS_RESULT_ACCESS_DENIED;
 227 #endif
 228 #ifdef EPERM
 229     case EPERM:
 230       return DBUS_RESULT_ACCESS_DENIED;
 231 #endif
 232 #ifdef ENOBUFS
 233     case ENOBUFS:
 234       return DBUS_RESULT_NO_MEMORY;
 235 #endif
 236 #ifdef ENOMEM
 237     case ENOMEM:
 238       return DBUS_RESULT_NO_MEMORY;
 239 #endif
 240 #ifdef EINVAL
 241     case EINVAL:
 242       return DBUS_RESULT_FAILED;
 243 #endif
 244 #ifdef EBADF
 245     case EBADF:
 246       return DBUS_RESULT_FAILED;
 247 #endif
 248 #ifdef EFAULT
 249     case EFAULT:
 250       return DBUS_RESULT_FAILED;
 251 #endif
 252 #ifdef ENOTSOCK
 253     case ENOTSOCK:
 254       return DBUS_RESULT_FAILED;
 255 #endif
 256 #ifdef EISCONN
 257     case EISCONN:
 258       return DBUS_RESULT_FAILED;
 259 #endif
 260 #ifdef ECONNREFUSED
 261     case ECONNREFUSED:
 262       return DBUS_RESULT_NO_SERVER;
 263 #endif
 264 #ifdef ETIMEDOUT
 265     case ETIMEDOUT:
 266       return DBUS_RESULT_TIMEOUT;
 267 #endif
 268 #ifdef ENETUNREACH
 269     case ENETUNREACH:
 270       return DBUS_RESULT_NO_NETWORK;
 271 #endif
 272 #ifdef EADDRINUSE
 273     case EADDRINUSE:
 274       return DBUS_RESULT_ADDRESS_IN_USE;
 275 #endif
 276     }
 277
 278   return DBUS_RESULT_FAILED;
 279 }
 280
 281 /**
 282  * Duplicates a string. Result must be freed with
 283  * dbus_free(). Returns #NULL if memory allocation fails.
 284  * If the string to be duplicated is #NULL, returns #NULL.
 285  *
 286  * @param str string to duplicate.
 287  * @returns newly-allocated copy.
 288  */
 289 char*
 290 _dbus_strdup (const char *str)
 291 {
 292   int len;
 293   char *copy;
 294
 295   if (str == NULL)
 296     return NULL;
 297
 298   len = strlen (str);
 299
 300   copy = dbus_malloc (len + 1);
 301   if (copy == NULL)
 302     return NULL;
 303
 304   memcpy (copy, str, len + 1);
 305
 306   return copy;
 307 }
 308
 309 /**
 310  * Sets a file descriptor to be nonblocking.
 311  *
 312  * @param fd the file descriptor.
 313  * @param result address of result code.
 314  * @returns #TRUE on success.
 315  */
 316 dbus_bool_t
 317 _dbus_set_fd_nonblocking (int             fd,
 318                           DBusResultCode *result)
 319 {
 320   int val;
 321
 322   val = fcntl (fd, F_GETFL, 0);
 323   if (val < 0)
 324     {
 325       dbus_set_result (result, _dbus_result_from_errno (errno));
 326       _dbus_verbose ("Failed to get flags for fd %d: %s\n", fd,
 327                      _dbus_strerror (errno));
 328       return FALSE;
 329     }
 330
 331   if (fcntl (fd, F_SETFL, val | O_NONBLOCK) < 0)
 332     {
 333       dbus_set_result (result, _dbus_result_from_errno (errno));
 334       _dbus_verbose ("Failed to set fd %d nonblocking: %s\n",
 335                      fd, _dbus_strerror (errno));
 336
 337       return FALSE;
 338     }
 339
 340   return TRUE;
 341 }
 342
 343 /**
 344  * Returns a string describing the given type.
 345  *
 346  * @param type the type to describe
 347  * @returns a constant string describing the type
 348  */
 349 const char *
 350 _dbus_type_to_string (int type)
 351 {
 352   switch (type)
 353     {
 354     case DBUS_TYPE_INVALID:
 355       return "invalid";
 356     case DBUS_TYPE_INT32:
 357       return "int32";
 358     case DBUS_TYPE_UINT32:
 359       return "uint32";
 360     case DBUS_TYPE_DOUBLE:
 361       return "double";
 362     case DBUS_TYPE_STRING:
 363       return "string";
 364     case DBUS_TYPE_BYTE_ARRAY:
 365       return "byte array";
 366     default:
 367       return "unknown";
 368     }
 369 }
 370
 371 /** @} */