1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-internals.c random utility stuff (internal to D-BUS implementation)
4 * Copyright (C) 2002 Red Hat, Inc.
6 * Licensed under the Academic Free License version 1.2
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.
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.
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
23 #include "dbus-internals.h"
24 #include "dbus-protocol.h"
25 #include "dbus-test.h"
29 #include <sys/types.h>
36 * @defgroup DBusInternals D-BUS internal implementation details
37 * @brief Documentation useful when developing or debugging D-BUS itself.
42 * @defgroup DBusInternalsUtils Utilities and portability
43 * @ingroup DBusInternals
44 * @brief Utility functions (_dbus_assert(), _dbus_warn(), etc.)
51 * Aborts with an error message if the condition is false.
53 * @param condition condition which must be true.
57 * @def _dbus_assert_not_reached
59 * Aborts with an error message if called.
60 * The given explanation will be printed.
62 * @param explanation explanation of what happened if the code was reached.
66 * @def _DBUS_N_ELEMENTS
68 * Computes the number of elements in a fixed-size array using
71 * @param array the array to count elements in.
75 * @def _DBUS_POINTER_TO_INT
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.)
83 * @param pointer pointer to extract an integer from.
86 * @def _DBUS_INT_TO_POINTER
88 * Safely stuffs an integer into a pointer, to be extracted later with
89 * _DBUS_POINTER_TO_INT. Only guaranteed to preserve 32 bits.
91 * @param integer the integer to stuff into a pointer.
96 * Sets all bits in an object to zero.
98 * @param object the object to be zeroed.
103 * Minimum value of type "int"
108 * Maximum value of type "int"
111 * @def _DBUS_MAX_SUN_PATH_LENGTH
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.
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.
124 * @typedef DBusForeachFunction
126 * Used to iterate over each item in a collection, such as
131 * Prints a warning message to stderr.
133 * @param format printf-style format string.
136 _dbus_warn (const char *format,
139 /* FIXME not portable enough? */
142 va_start (args, format);
143 vfprintf (stderr, format, args);
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.
153 * @param format printf-style format string.
156 _dbus_verbose_real (const char *format,
160 static dbus_bool_t verbose = TRUE;
161 static dbus_bool_t initted = FALSE;
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.
172 verbose = _dbus_getenv ("DBUS_VERBOSE") != NULL;
178 va_start (args, format);
179 vfprintf (stderr, format, args);
184 * Converts a UNIX errno into a DBusResultCode.
186 * @todo should cover more errnos, specifically those
189 * @param error_number the errno.
190 * @returns the result code.
193 _dbus_result_from_errno (int error_number)
195 switch (error_number)
198 return DBUS_RESULT_SUCCESS;
200 #ifdef EPROTONOSUPPORT
201 case EPROTONOSUPPORT:
202 return DBUS_RESULT_NOT_SUPPORTED;
206 return DBUS_RESULT_NOT_SUPPORTED;
210 return DBUS_RESULT_LIMITS_EXCEEDED; /* kernel out of memory */
214 return DBUS_RESULT_LIMITS_EXCEEDED;
218 return DBUS_RESULT_ACCESS_DENIED;
222 return DBUS_RESULT_ACCESS_DENIED;
226 return DBUS_RESULT_NO_MEMORY;
230 return DBUS_RESULT_NO_MEMORY;
234 return DBUS_RESULT_FAILED;
238 return DBUS_RESULT_FAILED;
242 return DBUS_RESULT_FAILED;
246 return DBUS_RESULT_FAILED;
250 return DBUS_RESULT_FAILED;
254 return DBUS_RESULT_NO_SERVER;
258 return DBUS_RESULT_TIMEOUT;
262 return DBUS_RESULT_NO_NETWORK;
266 return DBUS_RESULT_ADDRESS_IN_USE;
270 return DBUS_RESULT_FILE_NOT_FOUND;
274 return DBUS_RESULT_FILE_NOT_FOUND;
278 return DBUS_RESULT_FAILED;
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.
286 * @param str string to duplicate.
287 * @returns newly-allocated copy.
290 _dbus_strdup (const char *str)
300 copy = dbus_malloc (len + 1);
304 memcpy (copy, str, len + 1);
310 * Sets a file descriptor to be nonblocking.
312 * @param fd the file descriptor.
313 * @param result address of result code.
314 * @returns #TRUE on success.
317 _dbus_set_fd_nonblocking (int fd,
318 DBusResultCode *result)
322 val = fcntl (fd, F_GETFL, 0);
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));
331 if (fcntl (fd, F_SETFL, val | O_NONBLOCK) < 0)
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));
344 * Returns a string describing the given type.
346 * @param type the type to describe
347 * @returns a constant string describing the type
350 _dbus_type_to_string (int type)
354 case DBUS_TYPE_INVALID:
358 case DBUS_TYPE_BOOLEAN:
360 case DBUS_TYPE_INT32:
362 case DBUS_TYPE_UINT32:
364 case DBUS_TYPE_DOUBLE:
366 case DBUS_TYPE_STRING:
368 case DBUS_TYPE_BOOLEAN_ARRAY:
369 return "boolean array";
370 case DBUS_TYPE_INT32_ARRAY:
371 return "int32 array";
372 case DBUS_TYPE_UINT32_ARRAY:
373 return "uint32 array";
374 case DBUS_TYPE_DOUBLE_ARRAY:
375 return "double array";
376 case DBUS_TYPE_BYTE_ARRAY:
378 case DBUS_TYPE_STRING_ARRAY:
379 return "string array";
385 #ifdef DBUS_BUILD_TESTS
386 static int fail_alloc_counter = _DBUS_INT_MAX;
388 * Sets the number of allocations until we simulate a failed
389 * allocation. If set to 0, the next allocation to run
390 * fails; if set to 1, one succeeds then the next fails; etc.
391 * Set to _DBUS_INT_MAX to not fail anything.
393 * @param until_next_fail number of successful allocs before one fails
396 _dbus_set_fail_alloc_counter (int until_next_fail)
398 fail_alloc_counter = until_next_fail;
402 * Gets the number of successful allocs until we'll simulate
405 * @returns current counter value
408 _dbus_get_fail_alloc_counter (void)
410 return fail_alloc_counter;
414 * Called when about to alloc some memory; if
415 * it returns #TRUE, then the allocation should
416 * fail. If it returns #FALSE, then the allocation
419 * @returns #TRUE if this alloc should fail
422 _dbus_decrement_fail_alloc_counter (void)
424 if (fail_alloc_counter <= 0)
426 fail_alloc_counter = _DBUS_INT_MAX;
431 fail_alloc_counter -= 1;
435 #endif /* DBUS_BUILD_TESTS */