1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-sysdeps.c Wrappers around system/libc features (internal to D-BUS implementation)
4 * Copyright (C) 2002, 2003 Red Hat, Inc.
5 * Copyright (C) 2003 CodeFactory AB
7 * Licensed under the Academic Free License version 1.2
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "dbus-internals.h"
26 #include "dbus-sysdeps.h"
27 #include "dbus-threads.h"
28 #include "dbus-test.h"
29 #include <sys/types.h>
37 #include <sys/socket.h>
46 #include <netinet/in.h>
66 /* This system is not POSIX.1g. */
67 #define SUN_LEN(ptr) ((size_t) (((struct sockaddr_un *) 0)->sun_path) \
68 + strlen ((ptr)->sun_path))
72 * @addtogroup DBusInternalsUtils
76 * Aborts the program with SIGABRT (dumping core).
82 _exit (1); /* in case someone manages to ignore SIGABRT */
86 * Wrapper for setenv(). If the value is #NULL, unsets
87 * the environment variable.
89 * @todo if someone can verify it's safe, we could avoid the
90 * memleak when doing an unset.
92 * @param varname name of environment variable
93 * @param value value of environment variable
94 * @returns #TRUE on success.
97 _dbus_setenv (const char *varname,
100 _dbus_assert (varname != NULL);
111 len = strlen (varname);
113 /* Use system malloc to avoid memleaks that dbus_malloc
114 * will get upset about.
117 putenv_value = malloc (len + 1);
118 if (putenv_value == NULL)
121 strcpy (putenv_value, varname);
123 return (putenv (putenv_value) == 0);
129 return (setenv (varname, value, TRUE) == 0);
136 varname_len = strlen (varname);
137 value_len = strlen (value);
139 len = varname_len + value_len + 1 /* '=' */ ;
141 /* Use system malloc to avoid memleaks that dbus_malloc
142 * will get upset about.
145 putenv_value = malloc (len + 1);
146 if (putenv_value == NULL)
149 strcpy (putenv_value, varname);
150 strcpy (putenv_value + varname_len, "=");
151 strcpy (putenv_value + varname_len + 1, value);
153 return (putenv (putenv_value) == 0);
159 * Wrapper for getenv().
161 * @param varname name of environment variable
162 * @returns value of environment variable or #NULL if unset
165 _dbus_getenv (const char *varname)
167 return getenv (varname);
171 * Thin wrapper around the read() system call that appends
172 * the data it reads to the DBusString buffer. It appends
173 * up to the given count, and returns the same value
174 * and same errno as read(). The only exception is that
175 * _dbus_read() handles EINTR for you. _dbus_read() can
176 * return ENOMEM, even though regular UNIX read doesn't.
178 * @param fd the file descriptor to read from
179 * @param buffer the buffer to append data to
180 * @param count the amount of data to read
181 * @returns the number of bytes read or -1
192 _dbus_assert (count >= 0);
194 start = _dbus_string_get_length (buffer);
196 if (!_dbus_string_lengthen (buffer, count))
202 data = _dbus_string_get_data_len (buffer, start, count);
206 bytes_read = read (fd, data, count);
214 /* put length back (note that this doesn't actually realloc anything) */
215 _dbus_string_set_length (buffer, start);
221 /* put length back (doesn't actually realloc) */
222 _dbus_string_set_length (buffer, start + bytes_read);
226 _dbus_verbose_bytes_of_string (buffer, start, bytes_read);
234 * Thin wrapper around the write() system call that writes a part of a
235 * DBusString and handles EINTR for you.
237 * @param fd the file descriptor to write
238 * @param buffer the buffer to write data from
239 * @param start the first byte in the buffer to write
240 * @param len the number of bytes to try to write
241 * @returns the number of bytes written or -1 on error
245 const DBusString *buffer,
252 data = _dbus_string_get_const_data_len (buffer, start, len);
256 bytes_written = write (fd, data, len);
258 if (bytes_written < 0 && errno == EINTR)
262 if (bytes_written > 0)
263 _dbus_verbose_bytes_of_string (buffer, start, bytes_written);
266 return bytes_written;
270 * Like _dbus_write() but will use writev() if possible
271 * to write both buffers in sequence. The return value
272 * is the number of bytes written in the first buffer,
273 * plus the number written in the second. If the first
274 * buffer is written successfully and an error occurs
275 * writing the second, the number of bytes in the first
276 * is returned (i.e. the error is ignored), on systems that
277 * don't have writev. Handles EINTR for you.
278 * The second buffer may be #NULL.
280 * @param fd the file descriptor
281 * @param buffer1 first buffer
282 * @param start1 first byte to write in first buffer
283 * @param len1 number of bytes to write from first buffer
284 * @param buffer2 second buffer, or #NULL
285 * @param start2 first byte to write in second buffer
286 * @param len2 number of bytes to write in second buffer
287 * @returns total bytes written from both buffers, or -1 on error
290 _dbus_write_two (int fd,
291 const DBusString *buffer1,
294 const DBusString *buffer2,
298 _dbus_assert (buffer1 != NULL);
299 _dbus_assert (start1 >= 0);
300 _dbus_assert (start2 >= 0);
301 _dbus_assert (len1 >= 0);
302 _dbus_assert (len2 >= 0);
306 struct iovec vectors[2];
311 data1 = _dbus_string_get_const_data_len (buffer1, start1, len1);
314 data2 = _dbus_string_get_const_data_len (buffer2, start2, len2);
322 vectors[0].iov_base = (char*) data1;
323 vectors[0].iov_len = len1;
324 vectors[1].iov_base = (char*) data2;
325 vectors[1].iov_len = len2;
329 bytes_written = writev (fd,
333 if (bytes_written < 0 && errno == EINTR)
336 return bytes_written;
338 #else /* HAVE_WRITEV */
342 ret1 = _dbus_write (fd, buffer1, start1, len1);
343 if (ret1 == len1 && buffer2 != NULL)
345 ret2 = _dbus_write (fd, buffer2, start2, len2);
347 ret2 = 0; /* we can't report an error as the first write was OK */
354 #endif /* !HAVE_WRITEV */
357 #define _DBUS_MAX_SUN_PATH_LENGTH 99
360 * @def _DBUS_MAX_SUN_PATH_LENGTH
362 * Maximum length of the path to a UNIX domain socket,
363 * sockaddr_un::sun_path member. POSIX requires that all systems
364 * support at least 100 bytes here, including the nul termination.
365 * We use 99 for the max value to allow for the nul.
367 * We could probably also do sizeof (addr.sun_path)
368 * but this way we are the same on all platforms
369 * which is probably a good idea.
373 * Creates a socket and connects it to the UNIX domain socket at the
374 * given path. The connection fd is returned, and is set up as
377 * Uses abstract sockets instead of filesystem-linked sockets if
378 * requested (it's possible only on Linux; see "man 7 unix" on Linux).
379 * On non-Linux abstract socket usage always fails.
381 * @param path the path to UNIX domain socket
382 * @param abstract #TRUE to use abstract namespace
383 * @param error return location for error code
384 * @returns connection file descriptor or -1 on error
387 _dbus_connect_unix_socket (const char *path,
388 dbus_bool_t abstract,
392 struct sockaddr_un addr;
394 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
396 fd = socket (PF_UNIX, SOCK_STREAM, 0);
400 dbus_set_error (error,
401 _dbus_error_from_errno (errno),
402 "Failed to create socket: %s",
403 _dbus_strerror (errno));
409 addr.sun_family = AF_UNIX;
413 #ifdef HAVE_ABSTRACT_SOCKETS
414 addr.sun_path[0] = '\0'; /* this is what says "use abstract" */
415 strncpy (&addr.sun_path[1], path, _DBUS_MAX_SUN_PATH_LENGTH - 2);
416 #else /* HAVE_ABSTRACT_SOCKETS */
417 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED,
418 "Operating system does not support abstract socket namespace\n");
421 #endif /* ! HAVE_ABSTRACT_SOCKETS */
425 strncpy (addr.sun_path, path, _DBUS_MAX_SUN_PATH_LENGTH - 1);
428 if (connect (fd, (struct sockaddr*) &addr, sizeof (addr)) < 0)
430 dbus_set_error (error,
431 _dbus_error_from_errno (errno),
432 "Failed to connect to socket %s: %s",
433 path, _dbus_strerror (errno));
441 if (!_dbus_set_fd_nonblocking (fd, error))
443 _DBUS_ASSERT_ERROR_IS_SET (error);
455 * Creates a socket and binds it to the given path,
456 * then listens on the socket. The socket is
457 * set to be nonblocking.
459 * Uses abstract sockets instead of filesystem-linked
460 * sockets if requested (it's possible only on Linux;
461 * see "man 7 unix" on Linux).
462 * On non-Linux abstract socket usage always fails.
464 * @param path the socket name
465 * @param abstract #TRUE to use abstract namespace
466 * @param error return location for errors
467 * @returns the listening file descriptor or -1 on error
470 _dbus_listen_unix_socket (const char *path,
471 dbus_bool_t abstract,
475 struct sockaddr_un addr;
477 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
479 listen_fd = socket (PF_UNIX, SOCK_STREAM, 0);
483 dbus_set_error (error, _dbus_error_from_errno (errno),
484 "Failed to create socket \"%s\": %s",
485 path, _dbus_strerror (errno));
490 addr.sun_family = AF_UNIX;
494 #ifdef HAVE_ABSTRACT_SOCKETS
495 addr.sun_path[0] = '\0'; /* this is what says "use abstract" */
496 strncpy (&addr.sun_path[1], path, _DBUS_MAX_SUN_PATH_LENGTH - 2);
497 #else /* HAVE_ABSTRACT_SOCKETS */
498 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED,
499 "Operating system does not support abstract socket namespace\n");
502 #endif /* ! HAVE_ABSTRACT_SOCKETS */
506 /* FIXME discussed security implications of this with Nalin,
507 * and we couldn't think of where it would kick our ass, but
508 * it still seems a bit sucky. It also has non-security suckage;
509 * really we'd prefer to exit if the socket is already in use.
510 * But there doesn't seem to be a good way to do this.
512 * Just to be extra careful, I threw in the stat() - clearly
513 * the stat() can't *fix* any security issue, but it at least
514 * avoids inadvertent/accidental data loss.
519 if (stat (path, &sb) == 0 &&
520 S_ISSOCK (sb.st_mode))
524 strncpy (addr.sun_path, path, _DBUS_MAX_SUN_PATH_LENGTH - 1);
527 if (bind (listen_fd, (struct sockaddr*) &addr, SUN_LEN (&addr)) < 0)
529 dbus_set_error (error, _dbus_error_from_errno (errno),
530 "Failed to bind socket \"%s\": %s",
531 path, _dbus_strerror (errno));
536 if (listen (listen_fd, 30 /* backlog */) < 0)
538 dbus_set_error (error, _dbus_error_from_errno (errno),
539 "Failed to listen on socket \"%s\": %s",
540 path, _dbus_strerror (errno));
545 if (!_dbus_set_fd_nonblocking (listen_fd, error))
547 _DBUS_ASSERT_ERROR_IS_SET (error);
552 /* Try opening up the permissions, but if we can't, just go ahead
553 * and continue, maybe it will be good enough.
555 if (!abstract && chmod (path, 0777) < 0)
556 _dbus_warn ("Could not set mode 0777 on socket %s\n",
563 * Creates a socket and connects to a socket at the given host
564 * and port. The connection fd is returned, and is set up as
567 * @param host the host name to connect to
568 * @param port the prot to connect to
569 * @param error return location for error code
570 * @returns connection file descriptor or -1 on error
573 _dbus_connect_tcp_socket (const char *host,
578 struct sockaddr_in addr;
580 struct in_addr *haddr;
582 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
584 fd = socket (AF_INET, SOCK_STREAM, 0);
588 dbus_set_error (error,
589 _dbus_error_from_errno (errno),
590 "Failed to create socket: %s",
591 _dbus_strerror (errno));
599 he = gethostbyname (host);
602 dbus_set_error (error,
603 _dbus_error_from_errno (errno),
604 "Failed to lookup hostname: %s",
609 haddr = ((struct in_addr *) (he->h_addr_list)[0]);
612 memcpy (&addr.sin_addr, haddr, sizeof(struct in_addr));
613 addr.sin_family = AF_INET;
614 addr.sin_port = htons (port);
616 if (connect (fd, (struct sockaddr*) &addr, sizeof (addr)) < 0)
618 dbus_set_error (error,
619 _dbus_error_from_errno (errno),
620 "Failed to connect to socket %s: %s:%d",
621 host, _dbus_strerror (errno), port);
629 if (!_dbus_set_fd_nonblocking (fd, error))
641 * Creates a socket and binds it to the given path,
642 * then listens on the socket. The socket is
643 * set to be nonblocking.
645 * @param host the host name to listen on
646 * @param port the prot to listen on
647 * @param error return location for errors
648 * @returns the listening file descriptor or -1 on error
651 _dbus_listen_tcp_socket (const char *host,
656 struct sockaddr_in addr;
658 struct in_addr *haddr;
660 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
662 listen_fd = socket (AF_INET, SOCK_STREAM, 0);
666 dbus_set_error (error, _dbus_error_from_errno (errno),
667 "Failed to create socket \"%s:%d\": %s",
668 host, port, _dbus_strerror (errno));
675 he = gethostbyname (host);
678 dbus_set_error (error,
679 _dbus_error_from_errno (errno),
680 "Failed to lookup hostname: %s",
685 haddr = ((struct in_addr *) (he->h_addr_list)[0]);
688 memcpy (&addr.sin_addr, haddr, sizeof (struct in_addr));
689 addr.sin_family = AF_INET;
690 addr.sin_port = htons (port);
692 if (bind (listen_fd, (struct sockaddr*) &addr, sizeof (struct sockaddr)))
694 dbus_set_error (error, _dbus_error_from_errno (errno),
695 "Failed to bind socket \"%s:%d\": %s",
696 host, port, _dbus_strerror (errno));
701 if (listen (listen_fd, 30 /* backlog */) < 0)
703 dbus_set_error (error, _dbus_error_from_errno (errno),
704 "Failed to listen on socket \"%s:%d\": %s",
705 host, port, _dbus_strerror (errno));
710 if (!_dbus_set_fd_nonblocking (listen_fd, error))
720 write_credentials_byte (int server_fd,
724 char buf[1] = { '\0' };
726 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
730 bytes_written = write (server_fd, buf, 1);
732 if (bytes_written < 0 && errno == EINTR)
735 if (bytes_written < 0)
737 dbus_set_error (error, _dbus_error_from_errno (errno),
738 "Failed to write credentials byte: %s",
739 _dbus_strerror (errno));
742 else if (bytes_written == 0)
744 dbus_set_error (error, DBUS_ERROR_IO_ERROR,
745 "wrote zero bytes writing credentials byte");
750 _dbus_assert (bytes_written == 1);
751 _dbus_verbose ("wrote credentials byte\n");
757 * Reads a single byte which must be nul (an error occurs otherwise),
758 * and reads unix credentials if available. Fills in pid/uid/gid with
759 * -1 if no credentials are available. Return value indicates whether
760 * a byte was read, not whether we got valid credentials. On some
761 * systems, such as Linux, reading/writing the byte isn't actually
762 * required, but we do it anyway just to avoid multiple codepaths.
764 * Fails if no byte is available, so you must select() first.
766 * The point of the byte is that on some systems we have to
767 * use sendmsg()/recvmsg() to transmit credentials.
769 * @param client_fd the client file descriptor
770 * @param credentials struct to fill with credentials of client
771 * @param error location to store error code
772 * @returns #TRUE on success
775 _dbus_read_credentials_unix_socket (int client_fd,
776 DBusCredentials *credentials,
784 char cmsgmem[CMSG_SPACE (sizeof (struct cmsgcred))];
785 struct cmsghdr *cmsg = (struct cmsghdr *) cmsgmem;
788 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
790 /* The POSIX spec certainly doesn't promise this, but
791 * we need these assertions to fail as soon as we're wrong about
792 * it so we can do the porting fixups
794 _dbus_assert (sizeof (pid_t) <= sizeof (credentials->pid));
795 _dbus_assert (sizeof (uid_t) <= sizeof (credentials->uid));
796 _dbus_assert (sizeof (gid_t) <= sizeof (credentials->gid));
798 _dbus_credentials_clear (credentials);
800 #if defined(LOCAL_CREDS) && defined(HAVE_CMSGCRED)
801 /* Set the socket to receive credentials on the next message */
804 if (setsockopt (client_fd, 0, LOCAL_CREDS, &on, sizeof (on)) < 0)
806 _dbus_verbose ("Unable to set LOCAL_CREDS socket option\n");
815 memset (&msg, 0, sizeof (msg));
820 memset (cmsgmem, 0, sizeof (cmsgmem));
821 msg.msg_control = cmsgmem;
822 msg.msg_controllen = sizeof (cmsgmem);
826 if (recvmsg (client_fd, &msg, 0) < 0)
831 dbus_set_error (error, _dbus_error_from_errno (errno),
832 "Failed to read credentials byte: %s",
833 _dbus_strerror (errno));
839 dbus_set_error (error, DBUS_ERROR_FAILED,
840 "Credentials byte was not nul");
845 if (cmsg->cmsg_len < sizeof (cmsgmem) || cmsg->cmsg_type != SCM_CREDS)
847 dbus_set_error (error, DBUS_ERROR_FAILED);
848 _dbus_verbose ("Message from recvmsg() was not SCM_CREDS\n");
853 _dbus_verbose ("read credentials byte\n");
858 int cr_len = sizeof (cr);
860 if (getsockopt (client_fd, SOL_SOCKET, SO_PEERCRED, &cr, &cr_len) == 0 &&
861 cr_len == sizeof (cr))
863 credentials->pid = cr.pid;
864 credentials->uid = cr.uid;
865 credentials->gid = cr.gid;
869 _dbus_verbose ("Failed to getsockopt() credentials, returned len %d/%d: %s\n",
870 cr_len, (int) sizeof (cr), _dbus_strerror (errno));
872 #elif defined(HAVE_CMSGCRED)
873 struct cmsgcred *cred;
875 cred = (struct cmsgcred *) CMSG_DATA (cmsg);
877 credentials->pid = cred->cmcred_pid;
878 credentials->uid = cred->cmcred_euid;
879 credentials->gid = cred->cmcred_groups[0];
880 #else /* !SO_PEERCRED && !HAVE_CMSGCRED */
881 _dbus_verbose ("Socket credentials not supported on this OS\n");
885 _dbus_verbose ("Credentials:"
886 " pid "DBUS_PID_FORMAT
887 " uid "DBUS_UID_FORMAT
888 " gid "DBUS_GID_FORMAT"\n",
897 * Sends a single nul byte with our UNIX credentials as ancillary
898 * data. Returns #TRUE if the data was successfully written. On
899 * systems that don't support sending credentials, just writes a byte,
900 * doesn't send any credentials. On some systems, such as Linux,
901 * reading/writing the byte isn't actually required, but we do it
902 * anyway just to avoid multiple codepaths.
904 * Fails if no byte can be written, so you must select() first.
906 * The point of the byte is that on some systems we have to
907 * use sendmsg()/recvmsg() to transmit credentials.
909 * @param server_fd file descriptor for connection to server
910 * @param error return location for error code
911 * @returns #TRUE if the byte was sent
914 _dbus_send_credentials_unix_socket (int server_fd,
917 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
919 if (write_credentials_byte (server_fd, error))
926 * Accepts a connection on a listening socket.
927 * Handles EINTR for you.
929 * @param listen_fd the listen file descriptor
930 * @returns the connection fd of the client, or -1 on error
933 _dbus_accept (int listen_fd)
936 struct sockaddr addr;
939 addrlen = sizeof (addr);
942 client_fd = accept (listen_fd, &addr, &addrlen);
956 * @addtogroup DBusString
961 * Appends an integer to a DBusString.
963 * @param str the string
964 * @param value the integer value
965 * @returns #FALSE if not enough memory or other failure.
968 _dbus_string_append_int (DBusString *str,
971 /* this calculation is from comp.lang.c faq */
972 #define MAX_LONG_LEN ((sizeof (long) * 8 + 2) / 3 + 1) /* +1 for '-' */
977 orig_len = _dbus_string_get_length (str);
979 if (!_dbus_string_lengthen (str, MAX_LONG_LEN))
982 buf = _dbus_string_get_data_len (str, orig_len, MAX_LONG_LEN);
984 snprintf (buf, MAX_LONG_LEN, "%ld", value);
993 _dbus_string_shorten (str, MAX_LONG_LEN - i);
999 * Appends an unsigned integer to a DBusString.
1001 * @param str the string
1002 * @param value the integer value
1003 * @returns #FALSE if not enough memory or other failure.
1006 _dbus_string_append_uint (DBusString *str,
1007 unsigned long value)
1009 /* this is wrong, but definitely on the high side. */
1010 #define MAX_ULONG_LEN (MAX_LONG_LEN * 2)
1015 orig_len = _dbus_string_get_length (str);
1017 if (!_dbus_string_lengthen (str, MAX_ULONG_LEN))
1020 buf = _dbus_string_get_data_len (str, orig_len, MAX_ULONG_LEN);
1022 snprintf (buf, MAX_ULONG_LEN, "%lu", value);
1031 _dbus_string_shorten (str, MAX_ULONG_LEN - i);
1037 * Appends a double to a DBusString.
1039 * @param str the string
1040 * @param value the floating point value
1041 * @returns #FALSE if not enough memory or other failure.
1044 _dbus_string_append_double (DBusString *str,
1047 #define MAX_DOUBLE_LEN 64 /* this is completely made up :-/ */
1052 orig_len = _dbus_string_get_length (str);
1054 if (!_dbus_string_lengthen (str, MAX_DOUBLE_LEN))
1057 buf = _dbus_string_get_data_len (str, orig_len, MAX_DOUBLE_LEN);
1059 snprintf (buf, MAX_LONG_LEN, "%g", value);
1068 _dbus_string_shorten (str, MAX_DOUBLE_LEN - i);
1074 * Parses an integer contained in a DBusString. Either return parameter
1075 * may be #NULL if you aren't interested in it. The integer is parsed
1076 * and stored in value_return. Return parameters are not initialized
1077 * if the function returns #FALSE.
1079 * @param str the string
1080 * @param start the byte index of the start of the integer
1081 * @param value_return return location of the integer value or #NULL
1082 * @param end_return return location of the end of the integer, or #NULL
1083 * @returns #TRUE on success
1086 _dbus_string_parse_int (const DBusString *str,
1095 p = _dbus_string_get_const_data_len (str, start,
1096 _dbus_string_get_length (str) - start);
1100 v = strtol (p, &end, 0);
1101 if (end == NULL || end == p || errno != 0)
1107 *end_return = start + (end - p);
1112 #ifdef DBUS_BUILD_TESTS
1113 /* Not currently used, so only built when tests are enabled */
1115 * Parses an unsigned integer contained in a DBusString. Either return
1116 * parameter may be #NULL if you aren't interested in it. The integer
1117 * is parsed and stored in value_return. Return parameters are not
1118 * initialized if the function returns #FALSE.
1120 * @param str the string
1121 * @param start the byte index of the start of the integer
1122 * @param value_return return location of the integer value or #NULL
1123 * @param end_return return location of the end of the integer, or #NULL
1124 * @returns #TRUE on success
1127 _dbus_string_parse_uint (const DBusString *str,
1129 unsigned long *value_return,
1136 p = _dbus_string_get_const_data_len (str, start,
1137 _dbus_string_get_length (str) - start);
1141 v = strtoul (p, &end, 0);
1142 if (end == NULL || end == p || errno != 0)
1148 *end_return = start + (end - p);
1152 #endif /* DBUS_BUILD_TESTS */
1155 ascii_isspace (char c)
1166 ascii_isdigit (char c)
1168 return c >= '0' && c <= '9';
1172 ascii_isxdigit (char c)
1174 return (ascii_isdigit (c) ||
1175 (c >= 'a' && c <= 'f') ||
1176 (c >= 'A' && c <= 'F'));
1180 /* Calls strtod in a locale-independent fashion, by looking at
1181 * the locale data and patching the decimal comma to a point.
1183 * Relicensed from glib.
1186 ascii_strtod (const char *nptr,
1191 struct lconv *locale_data;
1192 const char *decimal_point;
1193 int decimal_point_len;
1194 const char *p, *decimal_point_pos;
1195 const char *end = NULL; /* Silence gcc */
1199 locale_data = localeconv ();
1200 decimal_point = locale_data->decimal_point;
1201 decimal_point_len = strlen (decimal_point);
1203 _dbus_assert (decimal_point_len != 0);
1205 decimal_point_pos = NULL;
1206 if (decimal_point[0] != '.' ||
1207 decimal_point[1] != 0)
1210 /* Skip leading space */
1211 while (ascii_isspace (*p))
1214 /* Skip leading optional sign */
1215 if (*p == '+' || *p == '-')
1219 (p[1] == 'x' || p[1] == 'X'))
1222 /* HEX - find the (optional) decimal point */
1224 while (ascii_isxdigit (*p))
1229 decimal_point_pos = p++;
1231 while (ascii_isxdigit (*p))
1234 if (*p == 'p' || *p == 'P')
1236 if (*p == '+' || *p == '-')
1238 while (ascii_isdigit (*p))
1245 while (ascii_isdigit (*p))
1250 decimal_point_pos = p++;
1252 while (ascii_isdigit (*p))
1255 if (*p == 'e' || *p == 'E')
1257 if (*p == '+' || *p == '-')
1259 while (ascii_isdigit (*p))
1264 /* For the other cases, we need not convert the decimal point */
1267 /* Set errno to zero, so that we can distinguish zero results
1271 if (decimal_point_pos)
1275 /* We need to convert the '.' to the locale specific decimal point */
1276 copy = dbus_malloc (end - nptr + 1 + decimal_point_len);
1279 memcpy (c, nptr, decimal_point_pos - nptr);
1280 c += decimal_point_pos - nptr;
1281 memcpy (c, decimal_point, decimal_point_len);
1282 c += decimal_point_len;
1283 memcpy (c, decimal_point_pos + 1, end - (decimal_point_pos + 1));
1284 c += end - (decimal_point_pos + 1);
1287 val = strtod (copy, &fail_pos);
1291 if (fail_pos > decimal_point_pos)
1292 fail_pos = (char *)nptr + (fail_pos - copy) - (decimal_point_len - 1);
1294 fail_pos = (char *)nptr + (fail_pos - copy);
1301 val = strtod (nptr, &fail_pos);
1311 * Parses a floating point number contained in a DBusString. Either
1312 * return parameter may be #NULL if you aren't interested in it. The
1313 * integer is parsed and stored in value_return. Return parameters are
1314 * not initialized if the function returns #FALSE.
1316 * @param str the string
1317 * @param start the byte index of the start of the float
1318 * @param value_return return location of the float value or #NULL
1319 * @param end_return return location of the end of the float, or #NULL
1320 * @returns #TRUE on success
1323 _dbus_string_parse_double (const DBusString *str,
1325 double *value_return,
1332 p = _dbus_string_get_const_data_len (str, start,
1333 _dbus_string_get_length (str) - start);
1337 v = ascii_strtod (p, &end);
1338 if (end == NULL || end == p || errno != 0)
1344 *end_return = start + (end - p);
1349 /** @} */ /* DBusString group */
1352 * @addtogroup DBusInternalsUtils
1356 fill_user_info_from_passwd (struct passwd *p,
1360 _dbus_assert (p->pw_name != NULL);
1361 _dbus_assert (p->pw_dir != NULL);
1363 info->uid = p->pw_uid;
1364 info->primary_gid = p->pw_gid;
1365 info->username = _dbus_strdup (p->pw_name);
1366 info->homedir = _dbus_strdup (p->pw_dir);
1368 if (info->username == NULL ||
1369 info->homedir == NULL)
1371 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1379 fill_user_info (DBusUserInfo *info,
1381 const DBusString *username,
1384 const char *username_c;
1386 /* exactly one of username/uid provided */
1387 _dbus_assert (username != NULL || uid != DBUS_UID_UNSET);
1388 _dbus_assert (username == NULL || uid == DBUS_UID_UNSET);
1390 info->uid = DBUS_UID_UNSET;
1391 info->primary_gid = DBUS_GID_UNSET;
1392 info->group_ids = NULL;
1393 info->n_group_ids = 0;
1394 info->username = NULL;
1395 info->homedir = NULL;
1397 if (username != NULL)
1398 username_c = _dbus_string_get_const_data (username);
1402 /* For now assuming that the getpwnam() and getpwuid() flavors
1403 * are always symmetrical, if not we have to add more configure
1407 #if defined (HAVE_POSIX_GETPWNAME_R) || defined (HAVE_NONPOSIX_GETPWNAME_R)
1412 struct passwd p_str;
1415 #ifdef HAVE_POSIX_GETPWNAME_R
1417 result = getpwuid_r (uid, &p_str, buf, sizeof (buf),
1420 result = getpwnam_r (username_c, &p_str, buf, sizeof (buf),
1423 if (uid != DBUS_UID_UNSET)
1424 p = getpwuid_r (uid, &p_str, buf, sizeof (buf));
1426 p = getpwnam_r (username_c, &p_str, buf, sizeof (buf));
1428 #endif /* !HAVE_POSIX_GETPWNAME_R */
1429 if (result == 0 && p == &p_str)
1431 if (!fill_user_info_from_passwd (p, info, error))
1436 dbus_set_error (error, _dbus_error_from_errno (errno),
1437 "User \"%s\" unknown or no memory to allocate password entry\n",
1438 username_c ? username_c : "???");
1439 _dbus_verbose ("User %s unknown\n", username_c ? username_c : "???");
1443 #else /* ! HAVE_GETPWNAM_R */
1445 /* I guess we're screwed on thread safety here */
1448 if (uid != DBUS_UID_UNSET)
1451 p = getpwnam (username_c);
1455 if (!fill_user_info_from_passwd (p, info, error))
1460 dbus_set_error (error, _dbus_error_from_errno (errno),
1461 "User \"%s\" unknown or no memory to allocate password entry\n",
1462 username_c ? username_c : "???");
1463 _dbus_verbose ("User %s unknown\n", username_c ? username_c : "???");
1467 #endif /* ! HAVE_GETPWNAM_R */
1469 /* Fill this in so we can use it to get groups */
1470 username_c = info->username;
1472 #ifdef HAVE_GETGROUPLIST
1479 buf = dbus_new (gid_t, buf_count);
1482 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1486 if (getgrouplist (username_c,
1488 buf, &buf_count) < 0)
1490 gid_t *new = dbus_realloc (buf, buf_count * sizeof (buf[0]));
1493 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1501 if (getgrouplist (username_c, info->primary_gid, buf, &buf_count) < 0)
1503 dbus_set_error (error,
1504 _dbus_error_from_errno (errno),
1505 "Failed to get groups for username \"%s\" primary GID "
1506 DBUS_GID_FORMAT ": %s\n",
1507 username_c, info->primary_gid,
1508 _dbus_strerror (errno));
1514 info->group_ids = dbus_new (dbus_gid_t, buf_count);
1515 if (info->group_ids == NULL)
1517 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1522 for (i = 0; i < buf_count; ++i)
1523 info->group_ids[i] = buf[i];
1525 info->n_group_ids = buf_count;
1529 #else /* HAVE_GETGROUPLIST */
1531 /* We just get the one group ID */
1532 info->group_ids = dbus_new (dbus_gid_t, 1);
1533 if (info->group_ids == NULL)
1535 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1539 info->n_group_ids = 1;
1541 (info->group_ids)[0] = info->primary_gid;
1543 #endif /* HAVE_GETGROUPLIST */
1545 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1550 _DBUS_ASSERT_ERROR_IS_SET (error);
1551 _dbus_user_info_free (info);
1556 * Gets user info for the given username.
1558 * @param info user info object to initialize
1559 * @param username the username
1560 * @param error error return
1561 * @returns #TRUE on success
1564 _dbus_user_info_fill (DBusUserInfo *info,
1565 const DBusString *username,
1568 return fill_user_info (info, DBUS_UID_UNSET,
1573 * Gets user info for the given user ID.
1575 * @param info user info object to initialize
1576 * @param uid the user ID
1577 * @param error error return
1578 * @returns #TRUE on success
1581 _dbus_user_info_fill_uid (DBusUserInfo *info,
1585 return fill_user_info (info, uid,
1590 * Frees the members of info
1591 * (but not info itself)
1592 * @param info the user info struct
1595 _dbus_user_info_free (DBusUserInfo *info)
1597 dbus_free (info->group_ids);
1598 dbus_free (info->username);
1599 dbus_free (info->homedir);
1603 fill_user_info_from_group (struct group *g,
1604 DBusGroupInfo *info,
1607 _dbus_assert (g->gr_name != NULL);
1609 info->gid = g->gr_gid;
1610 info->groupname = _dbus_strdup (g->gr_name);
1612 /* info->members = dbus_strdupv (g->gr_mem) */
1614 if (info->groupname == NULL)
1616 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1624 fill_group_info (DBusGroupInfo *info,
1626 const DBusString *groupname,
1629 const char *group_c_str;
1631 _dbus_assert (groupname != NULL || gid != DBUS_GID_UNSET);
1632 _dbus_assert (groupname == NULL || gid == DBUS_GID_UNSET);
1635 group_c_str = _dbus_string_get_const_data (groupname);
1639 /* For now assuming that the getgrnam() and getgrgid() flavors
1640 * always correspond to the pwnam flavors, if not we have
1641 * to add more configure checks.
1644 #if defined (HAVE_POSIX_GETPWNAME_R) || defined (HAVE_NONPOSIX_GETPWNAME_R)
1652 #ifdef HAVE_POSIX_GETPWNAME_R
1655 result = getgrnam_r (group_c_str, &g_str, buf, sizeof (buf),
1658 result = getgrgid_r (gid, &g_str, buf, sizeof (buf),
1661 p = getgrnam_r (group_c_str, &g_str, buf, sizeof (buf));
1663 #endif /* !HAVE_POSIX_GETPWNAME_R */
1664 if (result == 0 && g == &g_str)
1666 return fill_user_info_from_group (g, info, error);
1670 dbus_set_error (error, _dbus_error_from_errno (errno),
1671 "Group %s unknown or failed to look it up\n",
1672 group_c_str ? group_c_str : "???");
1676 #else /* ! HAVE_GETPWNAM_R */
1678 /* I guess we're screwed on thread safety here */
1681 g = getgrnam (group_c_str);
1685 return fill_user_info_from_group (g, info, error);
1689 dbus_set_error (error, _dbus_error_from_errno (errno),
1690 "Group %s unknown or failed to look it up\n",
1691 group_c_str ? group_c_str : "???");
1695 #endif /* ! HAVE_GETPWNAM_R */
1699 * Initializes the given DBusGroupInfo struct
1700 * with information about the given group name.
1702 * @param info the group info struct
1703 * @param groupname name of group
1704 * @param error the error return
1705 * @returns #FALSE if error is set
1708 _dbus_group_info_fill (DBusGroupInfo *info,
1709 const DBusString *groupname,
1712 return fill_group_info (info, DBUS_GID_UNSET,
1718 * Initializes the given DBusGroupInfo struct
1719 * with information about the given group ID.
1721 * @param info the group info struct
1722 * @param gid group ID
1723 * @param error the error return
1724 * @returns #FALSE if error is set
1727 _dbus_group_info_fill_gid (DBusGroupInfo *info,
1731 return fill_group_info (info, gid, NULL, error);
1735 * Frees the members of info (but not info itself).
1737 * @param info the group info
1740 _dbus_group_info_free (DBusGroupInfo *info)
1742 dbus_free (info->groupname);
1746 * Sets fields in DBusCredentials to DBUS_PID_UNSET,
1747 * DBUS_UID_UNSET, DBUS_GID_UNSET.
1749 * @param credentials the credentials object to fill in
1752 _dbus_credentials_clear (DBusCredentials *credentials)
1754 credentials->pid = DBUS_PID_UNSET;
1755 credentials->uid = DBUS_UID_UNSET;
1756 credentials->gid = DBUS_GID_UNSET;
1760 * Gets the credentials of the current process.
1762 * @param credentials credentials to fill in.
1765 _dbus_credentials_from_current_process (DBusCredentials *credentials)
1767 /* The POSIX spec certainly doesn't promise this, but
1768 * we need these assertions to fail as soon as we're wrong about
1769 * it so we can do the porting fixups
1771 _dbus_assert (sizeof (pid_t) <= sizeof (credentials->pid));
1772 _dbus_assert (sizeof (uid_t) <= sizeof (credentials->uid));
1773 _dbus_assert (sizeof (gid_t) <= sizeof (credentials->gid));
1775 credentials->pid = getpid ();
1776 credentials->uid = getuid ();
1777 credentials->gid = getgid ();
1781 * Checks whether the provided_credentials are allowed to log in
1782 * as the expected_credentials.
1784 * @param expected_credentials credentials we're trying to log in as
1785 * @param provided_credentials credentials we have
1786 * @returns #TRUE if we can log in
1789 _dbus_credentials_match (const DBusCredentials *expected_credentials,
1790 const DBusCredentials *provided_credentials)
1792 if (provided_credentials->uid == DBUS_UID_UNSET)
1794 else if (expected_credentials->uid == DBUS_UID_UNSET)
1796 else if (provided_credentials->uid == 0)
1798 else if (provided_credentials->uid == expected_credentials->uid)
1805 * Gets our process ID
1806 * @returns process ID
1815 * @returns process UID
1824 * @returns process GID
1832 _DBUS_DEFINE_GLOBAL_LOCK (atomic);
1834 #ifdef DBUS_USE_ATOMIC_INT_486
1835 /* Taken from CVS version 1.7 of glibc's sysdeps/i386/i486/atomicity.h */
1836 /* Since the asm stuff here is gcc-specific we go ahead and use "inline" also */
1837 static inline dbus_int32_t
1838 atomic_exchange_and_add (DBusAtomic *atomic,
1839 volatile dbus_int32_t val)
1841 register dbus_int32_t result;
1843 __asm__ __volatile__ ("lock; xaddl %0,%1"
1844 : "=r" (result), "=m" (atomic->value)
1845 : "0" (val), "m" (atomic->value));
1851 * Atomically increments an integer
1853 * @param atomic pointer to the integer to increment
1854 * @returns the value before incrementing
1856 * @todo implement arch-specific faster atomic ops
1859 _dbus_atomic_inc (DBusAtomic *atomic)
1861 #ifdef DBUS_USE_ATOMIC_INT_486
1862 return atomic_exchange_and_add (atomic, 1);
1865 _DBUS_LOCK (atomic);
1866 res = atomic->value;
1868 _DBUS_UNLOCK (atomic);
1874 * Atomically decrement an integer
1876 * @param atomic pointer to the integer to decrement
1877 * @returns the value before decrementing
1879 * @todo implement arch-specific faster atomic ops
1882 _dbus_atomic_dec (DBusAtomic *atomic)
1884 #ifdef DBUS_USE_ATOMIC_INT_486
1885 return atomic_exchange_and_add (atomic, -1);
1889 _DBUS_LOCK (atomic);
1890 res = atomic->value;
1892 _DBUS_UNLOCK (atomic);
1898 * Wrapper for poll().
1900 * @todo need a fallback implementation using select()
1902 * @param fds the file descriptors to poll
1903 * @param n_fds number of descriptors in the array
1904 * @param timeout_milliseconds timeout or -1 for infinite
1905 * @returns numbers of fds with revents, or <0 on error
1908 _dbus_poll (DBusPollFD *fds,
1910 int timeout_milliseconds)
1913 /* This big thing is a constant expression and should get optimized
1914 * out of existence. So it's more robust than a configure check at
1917 if (_DBUS_POLLIN == POLLIN &&
1918 _DBUS_POLLPRI == POLLPRI &&
1919 _DBUS_POLLOUT == POLLOUT &&
1920 _DBUS_POLLERR == POLLERR &&
1921 _DBUS_POLLHUP == POLLHUP &&
1922 _DBUS_POLLNVAL == POLLNVAL &&
1923 sizeof (DBusPollFD) == sizeof (struct pollfd) &&
1924 _DBUS_STRUCT_OFFSET (DBusPollFD, fd) ==
1925 _DBUS_STRUCT_OFFSET (struct pollfd, fd) &&
1926 _DBUS_STRUCT_OFFSET (DBusPollFD, events) ==
1927 _DBUS_STRUCT_OFFSET (struct pollfd, events) &&
1928 _DBUS_STRUCT_OFFSET (DBusPollFD, revents) ==
1929 _DBUS_STRUCT_OFFSET (struct pollfd, revents))
1931 return poll ((struct pollfd*) fds,
1933 timeout_milliseconds);
1937 /* We have to convert the DBusPollFD to an array of
1938 * struct pollfd, poll, and convert back.
1940 _dbus_warn ("didn't implement poll() properly for this system yet\n");
1943 #else /* ! HAVE_POLL */
1945 fd_set read_set, write_set, err_set;
1951 FD_ZERO (&read_set);
1952 FD_ZERO (&write_set);
1955 for (i = 0; i < n_fds; i++)
1957 DBusPollFD f = fds[i];
1959 if (f.events & _DBUS_POLLIN)
1960 FD_SET (f.fd, &read_set);
1962 if (f.events & _DBUS_POLLOUT)
1963 FD_SET (f.fd, &write_set);
1965 FD_SET (f.fd, &err_set);
1967 max_fd = MAX (max_fd, f.fd);
1970 tv.tv_sec = timeout_milliseconds / 1000;
1971 tv.tv_usec = (timeout_milliseconds % 1000) * 1000;
1973 ready = select (max_fd + 1, &read_set, &write_set, &err_set, &tv);
1977 for (i = 0; i < n_fds; i++)
1979 DBusPollFD f = fds[i];
1983 if (FD_ISSET (f.fd, &read_set))
1984 f.revents |= _DBUS_POLLIN;
1986 if (FD_ISSET (f.fd, &write_set))
1987 f.revents |= _DBUS_POLLOUT;
1989 if (FD_ISSET (f.fd, &err_set))
1990 f.revents |= _DBUS_POLLERR;
1998 /** nanoseconds in a second */
1999 #define NANOSECONDS_PER_SECOND 1000000000
2000 /** microseconds in a second */
2001 #define MICROSECONDS_PER_SECOND 1000000
2002 /** milliseconds in a second */
2003 #define MILLISECONDS_PER_SECOND 1000
2004 /** nanoseconds in a millisecond */
2005 #define NANOSECONDS_PER_MILLISECOND 1000000
2006 /** microseconds in a millisecond */
2007 #define MICROSECONDS_PER_MILLISECOND 1000
2010 * Sleeps the given number of milliseconds.
2011 * @param milliseconds number of milliseconds
2014 _dbus_sleep_milliseconds (int milliseconds)
2016 #ifdef HAVE_NANOSLEEP
2017 struct timespec req;
2018 struct timespec rem;
2020 req.tv_sec = milliseconds / MILLISECONDS_PER_SECOND;
2021 req.tv_nsec = (milliseconds % MILLISECONDS_PER_SECOND) * NANOSECONDS_PER_MILLISECOND;
2025 while (nanosleep (&req, &rem) < 0 && errno == EINTR)
2027 #elif defined (HAVE_USLEEP)
2028 usleep (milliseconds * MICROSECONDS_PER_MILLISECOND);
2029 #else /* ! HAVE_USLEEP */
2030 sleep (MAX (milliseconds / 1000, 1));
2035 * Get current time, as in gettimeofday().
2037 * @param tv_sec return location for number of seconds
2038 * @param tv_usec return location for number of microseconds (thousandths)
2041 _dbus_get_current_time (long *tv_sec,
2046 gettimeofday (&t, NULL);
2051 *tv_usec = t.tv_usec;
2055 * Appends the contents of the given file to the string,
2056 * returning error code. At the moment, won't open a file
2057 * more than a megabyte in size.
2059 * @param str the string to append to
2060 * @param filename filename to load
2061 * @param error place to set an error
2062 * @returns #FALSE if error was set
2065 _dbus_file_get_contents (DBusString *str,
2066 const DBusString *filename,
2073 const char *filename_c;
2075 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2077 filename_c = _dbus_string_get_const_data (filename);
2079 /* O_BINARY useful on Cygwin */
2080 fd = open (filename_c, O_RDONLY | O_BINARY);
2083 dbus_set_error (error, _dbus_error_from_errno (errno),
2084 "Failed to open \"%s\": %s",
2086 _dbus_strerror (errno));
2090 if (fstat (fd, &sb) < 0)
2092 dbus_set_error (error, _dbus_error_from_errno (errno),
2093 "Failed to stat \"%s\": %s",
2095 _dbus_strerror (errno));
2097 _dbus_verbose ("fstat() failed: %s",
2098 _dbus_strerror (errno));
2105 if (sb.st_size > _DBUS_ONE_MEGABYTE)
2107 dbus_set_error (error, DBUS_ERROR_FAILED,
2108 "File size %lu of \"%s\" is too large.",
2109 filename_c, (unsigned long) sb.st_size);
2115 orig_len = _dbus_string_get_length (str);
2116 if (sb.st_size > 0 && S_ISREG (sb.st_mode))
2120 while (total < (int) sb.st_size)
2122 bytes_read = _dbus_read (fd, str,
2123 sb.st_size - total);
2124 if (bytes_read <= 0)
2126 dbus_set_error (error, _dbus_error_from_errno (errno),
2127 "Error reading \"%s\": %s",
2129 _dbus_strerror (errno));
2131 _dbus_verbose ("read() failed: %s",
2132 _dbus_strerror (errno));
2135 _dbus_string_set_length (str, orig_len);
2139 total += bytes_read;
2145 else if (sb.st_size != 0)
2147 _dbus_verbose ("Can only open regular files at the moment.\n");
2148 dbus_set_error (error, DBUS_ERROR_FAILED,
2149 "\"%s\" is not a regular file",
2162 * Writes a string out to a file. If the file exists,
2163 * it will be atomically overwritten by the new data.
2165 * @param str the string to write out
2166 * @param filename the file to save string to
2167 * @param error error to be filled in on failure
2168 * @returns #FALSE on failure
2171 _dbus_string_save_to_file (const DBusString *str,
2172 const DBusString *filename,
2177 const char *filename_c;
2178 DBusString tmp_filename;
2179 const char *tmp_filename_c;
2181 dbus_bool_t need_unlink;
2184 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2188 need_unlink = FALSE;
2190 if (!_dbus_string_init (&tmp_filename))
2192 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2196 if (!_dbus_string_copy (filename, 0, &tmp_filename, 0))
2198 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2199 _dbus_string_free (&tmp_filename);
2203 if (!_dbus_string_append (&tmp_filename, "."))
2205 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2206 _dbus_string_free (&tmp_filename);
2210 #define N_TMP_FILENAME_RANDOM_BYTES 8
2211 if (!_dbus_generate_random_ascii (&tmp_filename, N_TMP_FILENAME_RANDOM_BYTES))
2213 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2214 _dbus_string_free (&tmp_filename);
2218 filename_c = _dbus_string_get_const_data (filename);
2219 tmp_filename_c = _dbus_string_get_const_data (&tmp_filename);
2221 fd = open (tmp_filename_c, O_WRONLY | O_BINARY | O_EXCL | O_CREAT,
2225 dbus_set_error (error, _dbus_error_from_errno (errno),
2226 "Could not create %s: %s", tmp_filename_c,
2227 _dbus_strerror (errno));
2234 bytes_to_write = _dbus_string_get_length (str);
2236 while (total < bytes_to_write)
2240 bytes_written = _dbus_write (fd, str, total,
2241 bytes_to_write - total);
2243 if (bytes_written <= 0)
2245 dbus_set_error (error, _dbus_error_from_errno (errno),
2246 "Could not write to %s: %s", tmp_filename_c,
2247 _dbus_strerror (errno));
2252 total += bytes_written;
2257 dbus_set_error (error, _dbus_error_from_errno (errno),
2258 "Could not close file %s: %s",
2259 tmp_filename_c, _dbus_strerror (errno));
2266 if (rename (tmp_filename_c, filename_c) < 0)
2268 dbus_set_error (error, _dbus_error_from_errno (errno),
2269 "Could not rename %s to %s: %s",
2270 tmp_filename_c, filename_c,
2271 _dbus_strerror (errno));
2276 need_unlink = FALSE;
2281 /* close first, then unlink, to prevent ".nfs34234235" garbage
2288 if (need_unlink && unlink (tmp_filename_c) < 0)
2289 _dbus_verbose ("Failed to unlink temp file %s: %s\n",
2290 tmp_filename_c, _dbus_strerror (errno));
2292 _dbus_string_free (&tmp_filename);
2295 _DBUS_ASSERT_ERROR_IS_SET (error);
2300 /** Creates the given file, failing if the file already exists.
2302 * @param filename the filename
2303 * @param error error location
2304 * @returns #TRUE if we created the file and it didn't exist
2307 _dbus_create_file_exclusively (const DBusString *filename,
2311 const char *filename_c;
2313 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2315 filename_c = _dbus_string_get_const_data (filename);
2317 fd = open (filename_c, O_WRONLY | O_BINARY | O_EXCL | O_CREAT,
2321 dbus_set_error (error,
2323 "Could not create file %s: %s\n",
2325 _dbus_strerror (errno));
2331 dbus_set_error (error,
2333 "Could not close file %s: %s\n",
2335 _dbus_strerror (errno));
2343 * Deletes the given file.
2345 * @param filename the filename
2346 * @param error error location
2348 * @returns #TRUE if unlink() succeeded
2351 _dbus_delete_file (const DBusString *filename,
2354 const char *filename_c;
2356 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2358 filename_c = _dbus_string_get_const_data (filename);
2360 if (unlink (filename_c) < 0)
2362 dbus_set_error (error, DBUS_ERROR_FAILED,
2363 "Failed to delete file %s: %s\n",
2364 filename_c, _dbus_strerror (errno));
2372 * Creates a directory; succeeds if the directory
2373 * is created or already existed.
2375 * @param filename directory filename
2376 * @param error initialized error object
2377 * @returns #TRUE on success
2380 _dbus_create_directory (const DBusString *filename,
2383 const char *filename_c;
2385 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2387 filename_c = _dbus_string_get_const_data (filename);
2389 if (mkdir (filename_c, 0700) < 0)
2391 if (errno == EEXIST)
2394 dbus_set_error (error, DBUS_ERROR_FAILED,
2395 "Failed to create directory %s: %s\n",
2396 filename_c, _dbus_strerror (errno));
2404 * Appends the given filename to the given directory.
2406 * @todo it might be cute to collapse multiple '/' such as "foo//"
2409 * @param dir the directory name
2410 * @param next_component the filename
2411 * @returns #TRUE on success
2414 _dbus_concat_dir_and_file (DBusString *dir,
2415 const DBusString *next_component)
2417 dbus_bool_t dir_ends_in_slash;
2418 dbus_bool_t file_starts_with_slash;
2420 if (_dbus_string_get_length (dir) == 0 ||
2421 _dbus_string_get_length (next_component) == 0)
2424 dir_ends_in_slash = '/' == _dbus_string_get_byte (dir,
2425 _dbus_string_get_length (dir) - 1);
2427 file_starts_with_slash = '/' == _dbus_string_get_byte (next_component, 0);
2429 if (dir_ends_in_slash && file_starts_with_slash)
2431 _dbus_string_shorten (dir, 1);
2433 else if (!(dir_ends_in_slash || file_starts_with_slash))
2435 if (!_dbus_string_append_byte (dir, '/'))
2439 return _dbus_string_copy (next_component, 0, dir,
2440 _dbus_string_get_length (dir));
2444 * Get the directory name from a complete filename
2445 * @param filename the filename
2446 * @param dirname string to append directory name to
2447 * @returns #FALSE if no memory
2450 _dbus_string_get_dirname (const DBusString *filename,
2451 DBusString *dirname)
2455 _dbus_assert (filename != dirname);
2456 _dbus_assert (filename != NULL);
2457 _dbus_assert (dirname != NULL);
2459 /* Ignore any separators on the end */
2460 sep = _dbus_string_get_length (filename);
2462 return _dbus_string_append (dirname, "."); /* empty string passed in */
2464 while (sep > 0 && _dbus_string_get_byte (filename, sep - 1) == '/')
2467 _dbus_assert (sep >= 0);
2470 return _dbus_string_append (dirname, "/");
2472 /* Now find the previous separator */
2473 _dbus_string_find_byte_backward (filename, sep, '/', &sep);
2475 return _dbus_string_append (dirname, ".");
2477 /* skip multiple separators */
2478 while (sep > 0 && _dbus_string_get_byte (filename, sep - 1) == '/')
2481 _dbus_assert (sep >= 0);
2484 _dbus_string_get_byte (filename, 0) == '/')
2485 return _dbus_string_append (dirname, "/");
2487 return _dbus_string_copy_len (filename, 0, sep - 0,
2488 dirname, _dbus_string_get_length (dirname));
2492 * Checks whether the filename is an absolute path
2494 * @param filename the filename
2495 * @returns #TRUE if an absolute path
2498 _dbus_path_is_absolute (const DBusString *filename)
2500 if (_dbus_string_get_length (filename) > 0)
2501 return _dbus_string_get_byte (filename, 0) == '/';
2513 * Open a directory to iterate over.
2515 * @param filename the directory name
2516 * @param error exception return object or #NULL
2517 * @returns new iterator, or #NULL on error
2520 _dbus_directory_open (const DBusString *filename,
2525 const char *filename_c;
2527 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2529 filename_c = _dbus_string_get_const_data (filename);
2531 d = opendir (filename_c);
2534 dbus_set_error (error, _dbus_error_from_errno (errno),
2535 "Failed to read directory \"%s\": %s",
2537 _dbus_strerror (errno));
2540 iter = dbus_new0 (DBusDirIter, 1);
2544 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
2545 "Could not allocate memory for directory iterator");
2555 * Get next file in the directory. Will not return "." or ".." on
2556 * UNIX. If an error occurs, the contents of "filename" are
2557 * undefined. The error is never set if the function succeeds.
2559 * @todo for thread safety, I think we have to use
2560 * readdir_r(). (GLib has the same issue, should file a bug.)
2562 * @param iter the iterator
2563 * @param filename string to be set to the next file in the dir
2564 * @param error return location for error
2565 * @returns #TRUE if filename was filled in with a new filename
2568 _dbus_directory_get_next_file (DBusDirIter *iter,
2569 DBusString *filename,
2574 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2578 ent = readdir (iter->d);
2582 dbus_set_error (error,
2583 _dbus_error_from_errno (errno),
2584 "%s", _dbus_strerror (errno));
2587 else if (ent->d_name[0] == '.' &&
2588 (ent->d_name[1] == '\0' ||
2589 (ent->d_name[1] == '.' && ent->d_name[2] == '\0')))
2593 _dbus_string_set_length (filename, 0);
2594 if (!_dbus_string_append (filename, ent->d_name))
2596 dbus_set_error (error, DBUS_ERROR_NO_MEMORY,
2597 "No memory to read directory entry");
2606 * Closes a directory iteration.
2609 _dbus_directory_close (DBusDirIter *iter)
2616 pseudorandom_generate_random_bytes (DBusString *str,
2620 unsigned long tv_usec;
2623 old_len = _dbus_string_get_length (str);
2625 /* fall back to pseudorandom */
2626 _dbus_verbose ("Falling back to pseudorandom for %d bytes\n",
2629 _dbus_get_current_time (NULL, &tv_usec);
2639 b = (r / (double) RAND_MAX) * 255.0;
2641 if (!_dbus_string_append_byte (str, b))
2650 _dbus_string_set_length (str, old_len);
2655 * Generates the given number of random bytes,
2656 * using the best mechanism we can come up with.
2658 * @param str the string
2659 * @param n_bytes the number of random bytes to append to string
2660 * @returns #TRUE on success, #FALSE if no memory
2663 _dbus_generate_random_bytes (DBusString *str,
2669 /* FALSE return means "no memory", if it could
2670 * mean something else then we'd need to return
2671 * a DBusError. So we always fall back to pseudorandom
2675 old_len = _dbus_string_get_length (str);
2678 /* note, urandom on linux will fall back to pseudorandom */
2679 fd = open ("/dev/urandom", O_RDONLY);
2681 return pseudorandom_generate_random_bytes (str, n_bytes);
2683 if (_dbus_read (fd, str, n_bytes) != n_bytes)
2686 _dbus_string_set_length (str, old_len);
2687 return pseudorandom_generate_random_bytes (str, n_bytes);
2690 _dbus_verbose ("Read %d bytes from /dev/urandom\n",
2699 * Generates the given number of random bytes, where the bytes are
2700 * chosen from the alphanumeric ASCII subset.
2702 * @param str the string
2703 * @param n_bytes the number of random ASCII bytes to append to string
2704 * @returns #TRUE on success, #FALSE if no memory or other failure
2707 _dbus_generate_random_ascii (DBusString *str,
2710 static const char letters[] =
2711 "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyz";
2715 if (!_dbus_generate_random_bytes (str, n_bytes))
2718 len = _dbus_string_get_length (str);
2722 _dbus_string_set_byte (str, i,
2723 letters[_dbus_string_get_byte (str, i) %
2724 (sizeof (letters) - 1)]);
2729 _dbus_assert (_dbus_string_validate_ascii (str, len - n_bytes,
2736 * A wrapper around strerror() because some platforms
2737 * may be lame and not have strerror().
2739 * @param error_number errno.
2740 * @returns error description.
2743 _dbus_strerror (int error_number)
2747 msg = strerror (error_number);
2755 * signal (SIGPIPE, SIG_IGN);
2758 _dbus_disable_sigpipe (void)
2760 signal (SIGPIPE, SIG_IGN);
2764 * Sets the file descriptor to be close
2765 * on exec. Should be called for all file
2766 * descriptors in D-BUS code.
2768 * @param fd the file descriptor
2771 _dbus_fd_set_close_on_exec (int fd)
2775 val = fcntl (fd, F_GETFD, 0);
2782 fcntl (fd, F_SETFD, val);
2786 * Converts a UNIX errno into a #DBusError name.
2788 * @todo should cover more errnos, specifically those
2791 * @param error_number the errno.
2792 * @returns an error name
2795 _dbus_error_from_errno (int error_number)
2797 switch (error_number)
2800 return DBUS_ERROR_FAILED;
2802 #ifdef EPROTONOSUPPORT
2803 case EPROTONOSUPPORT:
2804 return DBUS_ERROR_NOT_SUPPORTED;
2808 return DBUS_ERROR_NOT_SUPPORTED;
2812 return DBUS_ERROR_LIMITS_EXCEEDED; /* kernel out of memory */
2816 return DBUS_ERROR_LIMITS_EXCEEDED;
2820 return DBUS_ERROR_ACCESS_DENIED;
2824 return DBUS_ERROR_ACCESS_DENIED;
2828 return DBUS_ERROR_NO_MEMORY;
2832 return DBUS_ERROR_NO_MEMORY;
2836 return DBUS_ERROR_FAILED;
2840 return DBUS_ERROR_FAILED;
2844 return DBUS_ERROR_FAILED;
2848 return DBUS_ERROR_FAILED;
2852 return DBUS_ERROR_FAILED;
2856 return DBUS_ERROR_NO_SERVER;
2860 return DBUS_ERROR_TIMEOUT;
2864 return DBUS_ERROR_NO_NETWORK;
2868 return DBUS_ERROR_ADDRESS_IN_USE;
2872 return DBUS_ERROR_FILE_NOT_FOUND;
2876 return DBUS_ERROR_FILE_NOT_FOUND;
2880 return DBUS_ERROR_FAILED;
2884 * Exit the process, returning the given value.
2886 * @param code the exit code
2889 _dbus_exit (int code)
2897 * @param filename the filename to stat
2898 * @param statbuf the stat info to fill in
2899 * @param error return location for error
2900 * @returns #FALSE if error was set
2903 _dbus_stat (const DBusString *filename,
2907 const char *filename_c;
2910 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2912 filename_c = _dbus_string_get_const_data (filename);
2914 if (stat (filename_c, &sb) < 0)
2916 dbus_set_error (error, _dbus_error_from_errno (errno),
2917 "%s", _dbus_strerror (errno));
2921 statbuf->mode = sb.st_mode;
2922 statbuf->nlink = sb.st_nlink;
2923 statbuf->uid = sb.st_uid;
2924 statbuf->gid = sb.st_gid;
2925 statbuf->size = sb.st_size;
2926 statbuf->atime = sb.st_atime;
2927 statbuf->mtime = sb.st_mtime;
2928 statbuf->ctime = sb.st_ctime;
2934 * Creates a full-duplex pipe (as in socketpair()).
2935 * Sets both ends of the pipe nonblocking.
2937 * @param fd1 return location for one end
2938 * @param fd2 return location for the other end
2939 * @param blocking #TRUE if pipe should be blocking
2940 * @param error error return
2941 * @returns #FALSE on failure (if error is set)
2944 _dbus_full_duplex_pipe (int *fd1,
2946 dbus_bool_t blocking,
2949 #ifdef HAVE_SOCKETPAIR
2952 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
2954 if (socketpair (AF_UNIX, SOCK_STREAM, 0, fds) < 0)
2956 dbus_set_error (error, _dbus_error_from_errno (errno),
2957 "Could not create full-duplex pipe");
2962 (!_dbus_set_fd_nonblocking (fds[0], NULL) ||
2963 !_dbus_set_fd_nonblocking (fds[1], NULL)))
2965 dbus_set_error (error, _dbus_error_from_errno (errno),
2966 "Could not set full-duplex pipe nonblocking");
2979 _dbus_warn ("_dbus_full_duplex_pipe() not implemented on this OS\n");
2980 dbus_set_error (error, DBUS_ERROR_FAILED,
2981 "_dbus_full_duplex_pipe() not implemented on this OS");
2987 * Closes a file descriptor.
2989 * @param fd the file descriptor
2990 * @param error error object
2991 * @returns #FALSE if error set
2994 _dbus_close (int fd,
2997 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3005 dbus_set_error (error, _dbus_error_from_errno (errno),
3006 "Could not close fd %d", fd);
3014 * Sets a file descriptor to be nonblocking.
3016 * @param fd the file descriptor.
3017 * @param error address of error location.
3018 * @returns #TRUE on success.
3021 _dbus_set_fd_nonblocking (int fd,
3026 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
3028 val = fcntl (fd, F_GETFL, 0);
3031 dbus_set_error (error, _dbus_error_from_errno (errno),
3032 "Failed to get flags from file descriptor %d: %s",
3033 fd, _dbus_strerror (errno));
3034 _dbus_verbose ("Failed to get flags for fd %d: %s\n", fd,
3035 _dbus_strerror (errno));
3039 if (fcntl (fd, F_SETFL, val | O_NONBLOCK) < 0)
3041 dbus_set_error (error, _dbus_error_from_errno (errno),
3042 "Failed to set nonblocking flag of file descriptor %d: %s",
3043 fd, _dbus_strerror (errno));
3044 _dbus_verbose ("Failed to set fd %d nonblocking: %s\n",
3045 fd, _dbus_strerror (errno));
3054 * On GNU libc systems, print a crude backtrace to the verbose log.
3055 * On other systems, print "no backtrace support"
3059 _dbus_print_backtrace (void)
3061 #if defined (HAVE_BACKTRACE) && defined (DBUS_ENABLE_VERBOSE_MODE)
3067 bt_size = backtrace (bt, 500);
3069 syms = backtrace_symbols (bt, bt_size);
3074 _dbus_verbose (" %s\n", syms[i]);
3080 _dbus_verbose (" D-BUS not compiled with backtrace support\n");
3085 * Does the chdir, fork, setsid, etc. to become a daemon process.
3087 * @param pidfile #NULL, or pidfile to create
3088 * @param error return location for errors
3089 * @returns #FALSE on failure
3092 _dbus_become_daemon (const DBusString *pidfile,
3098 if (chdir ("/") < 0)
3100 dbus_set_error (error, DBUS_ERROR_FAILED,
3101 "Could not chdir() to root directory");
3105 switch ((child_pid = fork ()))
3108 dbus_set_error (error, _dbus_error_from_errno (errno),
3109 "Failed to fork daemon: %s", _dbus_strerror (errno));
3116 s = _dbus_getenv ("DBUS_DEBUG_DAEMONIZE");
3118 kill (_dbus_getpid (), SIGSTOP);
3120 s = _dbus_getenv ("DBUS_DEBUG_OUTPUT");
3121 if (s == NULL || *s == '\0')
3125 /* silently ignore failures here, if someone
3126 * doesn't have /dev/null we may as well try
3127 * to continue anyhow
3130 dev_null_fd = open ("/dev/null", O_RDWR);
3131 if (dev_null_fd >= 0)
3133 dup2 (dev_null_fd, 0);
3134 dup2 (dev_null_fd, 1);
3135 dup2 (dev_null_fd, 2);
3139 /* Get a predictable umask */
3146 if (!_dbus_write_pid_file (pidfile,
3150 kill (child_pid, SIGTERM);
3158 if (setsid () == -1)
3159 _dbus_assert_not_reached ("setsid() failed");
3165 * Creates a file containing the process ID.
3167 * @param filename the filename to write to
3168 * @param pid our process ID
3169 * @param error return location for errors
3170 * @returns #FALSE on failure
3173 _dbus_write_pid_file (const DBusString *filename,
3177 const char *cfilename;
3181 cfilename = _dbus_string_get_const_data (filename);
3183 fd = open (cfilename, O_WRONLY|O_CREAT|O_EXCL|O_BINARY, 0644);
3187 dbus_set_error (error, _dbus_error_from_errno (errno),
3188 "Failed to open \"%s\": %s", cfilename,
3189 _dbus_strerror (errno));
3193 if ((f = fdopen (fd, "w")) == NULL)
3195 dbus_set_error (error, _dbus_error_from_errno (errno),
3196 "Failed to fdopen fd %d: %s", fd, _dbus_strerror (errno));
3201 if (fprintf (f, "%lu\n", pid) < 0)
3203 dbus_set_error (error, _dbus_error_from_errno (errno),
3204 "Failed to write to \"%s\": %s", cfilename,
3205 _dbus_strerror (errno));
3209 if (fclose (f) == EOF)
3211 dbus_set_error (error, _dbus_error_from_errno (errno),
3212 "Failed to close \"%s\": %s", cfilename,
3213 _dbus_strerror (errno));
3221 * Changes the user and group the bus is running as.
3223 * @param uid the new user ID
3224 * @param gid the new group ID
3225 * @param error return location for errors
3226 * @returns #FALSE on failure
3229 _dbus_change_identity (dbus_uid_t uid,
3233 /* Set GID first, or the setuid may remove our permission
3236 if (setgid (gid) < 0)
3238 dbus_set_error (error, _dbus_error_from_errno (errno),
3239 "Failed to set GID to %lu: %s", gid,
3240 _dbus_strerror (errno));
3244 if (setuid (uid) < 0)
3246 dbus_set_error (error, _dbus_error_from_errno (errno),
3247 "Failed to set UID to %lu: %s", uid,
3248 _dbus_strerror (errno));
3255 /** Installs a UNIX signal handler
3257 * @param sig the signal to handle
3258 * @param handler the handler
3261 _dbus_set_signal_handler (int sig,
3262 DBusSignalHandler handler)
3264 struct sigaction act;
3265 sigset_t empty_mask;
3267 sigemptyset (&empty_mask);
3268 act.sa_handler = handler;
3269 act.sa_mask = empty_mask;
3271 sigaction (sig, &act, 0);
3275 #ifdef DBUS_BUILD_TESTS
3278 check_dirname (const char *filename,
3279 const char *dirname)
3283 _dbus_string_init_const (&f, filename);
3285 if (!_dbus_string_init (&d))
3286 _dbus_assert_not_reached ("no memory");
3288 if (!_dbus_string_get_dirname (&f, &d))
3289 _dbus_assert_not_reached ("no memory");
3291 if (!_dbus_string_equal_c_str (&d, dirname))
3293 _dbus_warn ("For filename \"%s\" got dirname \"%s\" and expected \"%s\"\n",
3295 _dbus_string_get_const_data (&d),
3300 _dbus_string_free (&d);
3304 check_path_absolute (const char *path,
3305 dbus_bool_t expected)
3309 _dbus_string_init_const (&p, path);
3311 if (_dbus_path_is_absolute (&p) != expected)
3313 _dbus_warn ("For path \"%s\" expected absolute = %d got %d\n",
3314 path, expected, _dbus_path_is_absolute (&p));
3320 * Unit test for dbus-sysdeps.c.
3322 * @returns #TRUE on success.
3325 _dbus_sysdeps_test (void)
3331 check_dirname ("foo", ".");
3332 check_dirname ("foo/bar", "foo");
3333 check_dirname ("foo//bar", "foo");
3334 check_dirname ("foo///bar", "foo");
3335 check_dirname ("foo/bar/", "foo");
3336 check_dirname ("foo//bar/", "foo");
3337 check_dirname ("foo///bar/", "foo");
3338 check_dirname ("foo/bar//", "foo");
3339 check_dirname ("foo//bar////", "foo");
3340 check_dirname ("foo///bar///////", "foo");
3341 check_dirname ("/foo", "/");
3342 check_dirname ("////foo", "/");
3343 check_dirname ("/foo/bar", "/foo");
3344 check_dirname ("/foo//bar", "/foo");
3345 check_dirname ("/foo///bar", "/foo");
3346 check_dirname ("/", "/");
3347 check_dirname ("///", "/");
3348 check_dirname ("", ".");
3351 _dbus_string_init_const (&str, "3.5");
3352 if (!_dbus_string_parse_double (&str,
3355 _dbus_warn ("Failed to parse double");
3360 _dbus_warn ("Failed to parse 3.5 correctly, got: %f", val);
3365 _dbus_warn ("_dbus_string_parse_double of \"3.5\" returned wrong position %d", pos);
3369 check_path_absolute ("/", TRUE);
3370 check_path_absolute ("/foo", TRUE);
3371 check_path_absolute ("", FALSE);
3372 check_path_absolute ("foo", FALSE);
3373 check_path_absolute ("foo/bar", FALSE);
3377 #endif /* DBUS_BUILD_TESTS */
3379 /** @} end of sysdeps */