1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-sysdeps.h 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 2.1
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #ifndef DBUS_SYSDEPS_H
26 #define DBUS_SYSDEPS_H
29 #warning Please include config.h before dbus-sysdeps.h
37 #ifdef HAVE_INTTYPES_H
41 #include <dbus/dbus-errors.h>
42 #include <dbus/dbus-file.h>
43 #include <dbus/dbus-string.h>
45 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
46 * stuff straight out of string.h, so have this here for now.
51 /* AIX sys/poll.h does #define events reqevents, and other
52 * wonderousness, so must include sys/poll before declaring
60 /* Windows CE lacks some system functions (such as errno and clock).
61 We bring them in here. */
62 #include "dbus-sysdeps-wince-glue.h"
72 #define _DBUS_PATH_SEPARATOR ";"
74 #define _DBUS_PATH_SEPARATOR ":"
77 /* Forward declarations */
80 /** An opaque list type */
81 typedef struct DBusList DBusList;
83 /** Object that contains a list of credentials such as UNIX or Windows user ID */
84 typedef struct DBusCredentials DBusCredentials;
86 /** A wrapper around a pipe descriptor or handle */
87 typedef struct DBusPipe DBusPipe;
90 * @addtogroup DBusSysdeps
96 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
98 dbus_bool_t _dbus_check_setuid (void);
100 const char* _dbus_getenv (const char *varname);
102 dbus_bool_t _dbus_clearenv (void);
103 char ** _dbus_get_environment (void);
106 typedef unsigned long dbus_pid_t;
108 typedef unsigned long dbus_uid_t;
110 typedef unsigned long dbus_gid_t;
112 /** an invalid PID used to represent an uninitialized dbus_pid_t field */
113 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
114 /** an invalid UID used to represent an uninitialized dbus_uid_t field */
115 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
116 /** an invalid GID used to represent an uninitialized dbus_gid_t field */
117 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
119 /** an appropriate printf format for dbus_pid_t */
120 #define DBUS_PID_FORMAT "%lu"
121 /** an appropriate printf format for dbus_uid_t */
122 #define DBUS_UID_FORMAT "%lu"
123 /** an appropriate printf format for dbus_gid_t */
124 #define DBUS_GID_FORMAT "%lu"
131 typedef struct { SOCKET sock; } DBusSocket;
132 # define DBUS_SOCKET_FORMAT "Iu"
133 # define DBUS_SOCKET_INIT { INVALID_SOCKET }
136 _dbus_socket_printable (DBusSocket s) { return s.sock; }
138 static inline dbus_bool_t
139 _dbus_socket_is_valid (DBusSocket s) { return s.sock != INVALID_SOCKET; }
142 _dbus_socket_invalidate (DBusSocket *s) { s->sock = INVALID_SOCKET; }
145 _dbus_socket_get_int (DBusSocket s) { return (int)s.sock; }
147 #else /* not DBUS_WIN */
149 typedef struct { int fd; } DBusSocket;
150 # define DBUS_SOCKET_FORMAT "d"
151 # define DBUS_SOCKET_INIT { -1 }
154 _dbus_socket_printable (DBusSocket s) { return s.fd; }
156 static inline dbus_bool_t
157 _dbus_socket_is_valid (DBusSocket s) { return s.fd >= 0; }
160 _dbus_socket_invalidate (DBusSocket *s) { s->fd = -1; }
163 _dbus_socket_get_int (DBusSocket s) { return s.fd; }
165 #endif /* not DBUS_WIN */
167 static inline DBusSocket
168 _dbus_socket_get_invalid (void)
170 DBusSocket s = DBUS_SOCKET_INIT;
175 dbus_bool_t _dbus_set_socket_nonblocking (DBusSocket fd,
179 dbus_bool_t _dbus_close_socket (DBusSocket fd,
182 int _dbus_read_socket (DBusSocket fd,
186 int _dbus_write_socket (DBusSocket fd,
187 const DBusString *buffer,
190 int _dbus_write_socket_two (DBusSocket fd,
191 const DBusString *buffer1,
194 const DBusString *buffer2,
198 int _dbus_read_socket_with_unix_fds (DBusSocket fd,
202 unsigned int *n_fds);
204 int _dbus_write_socket_with_unix_fds (DBusSocket fd,
205 const DBusString *buffer,
210 int _dbus_write_socket_with_unix_fds_two (DBusSocket fd,
211 const DBusString *buffer1,
214 const DBusString *buffer2,
220 DBusSocket _dbus_connect_tcp_socket (const char *host,
224 DBusSocket _dbus_connect_tcp_socket_with_nonce (const char *host,
227 const char *noncefile,
229 int _dbus_listen_tcp_socket (const char *host,
235 DBusSocket _dbus_accept (DBusSocket listen_fd);
237 dbus_bool_t _dbus_read_credentials_socket (DBusSocket client_fd,
238 DBusCredentials *credentials,
240 dbus_bool_t _dbus_send_credentials_socket (DBusSocket server_fd,
243 dbus_bool_t _dbus_credentials_add_from_user (DBusCredentials *credentials,
244 const DBusString *username);
245 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials *credentials);
247 dbus_bool_t _dbus_append_user_from_current_process (DBusString *str);
249 dbus_bool_t _dbus_parse_unix_user_from_config (const DBusString *username,
251 dbus_bool_t _dbus_parse_unix_group_from_config (const DBusString *groupname,
253 dbus_bool_t _dbus_unix_groups_from_uid (dbus_uid_t uid,
254 dbus_gid_t **group_ids,
256 dbus_bool_t _dbus_unix_user_is_at_console (dbus_uid_t uid,
258 dbus_bool_t _dbus_unix_user_is_process_owner (dbus_uid_t uid);
259 dbus_bool_t _dbus_windows_user_is_process_owner (const char *windows_sid);
261 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString *directory,
262 DBusCredentials *credentials);
264 dbus_bool_t _dbus_daemon_is_session_bus_address_published (const char *scope);
266 dbus_bool_t _dbus_daemon_publish_session_bus_address (const char* address, const char* shm_name);
268 void _dbus_daemon_unpublish_session_bus_address (void);
270 dbus_bool_t _dbus_socket_can_pass_unix_fd(DBusSocket fd);
272 /** Opaque type representing an atomically-modifiable integer
273 * that can be used from multiple threads.
275 typedef struct DBusAtomic DBusAtomic;
278 * An atomic integer safe to increment or decrement from multiple threads.
283 volatile long value; /**< Value of the atomic integer. */
285 volatile dbus_int32_t value; /**< Value of the atomic integer. */
289 /* The value we get from autofoo is in the form of a cpp expression;
290 * convert that to a conventional defined/undef switch. (We can't get
291 * the conventional defined/undef because of multiarch builds only running
292 * ./configure once, on Darwin.) */
293 #if DBUS_HAVE_ATOMIC_INT_COND
294 # define DBUS_HAVE_ATOMIC_INT 1
296 # undef DBUS_HAVE_ATOMIC_INT
300 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
302 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
304 dbus_int32_t _dbus_atomic_get (DBusAtomic *atomic);
308 /* On Windows, you can only poll sockets. We emulate Unix poll() using
309 * select(), so it doesn't matter what precise type we put in DBusPollFD;
310 * use DBusSocket so that the compiler can check we are doing it right.
312 typedef DBusSocket DBusPollable;
313 # define DBUS_POLLABLE_FORMAT "Iu"
315 static inline DBusPollable
316 _dbus_socket_get_pollable (DBusSocket s) { return s; }
319 _dbus_pollable_printable (DBusPollable p) { return p.sock; }
321 static inline dbus_bool_t
322 _dbus_pollable_is_valid (DBusPollable p) { return _dbus_socket_is_valid (p); }
325 _dbus_pollable_invalidate (DBusPollable *p) { _dbus_socket_invalidate (p); }
327 static inline dbus_bool_t
328 _dbus_pollable_equals (DBusPollable a, DBusPollable b) { return a.sock == b.sock; }
330 #else /* !DBUS_WIN */
332 /* On Unix, you can poll sockets, pipes, etc., and we must put exactly
333 * "int" in DBusPollFD because we're relying on its layout exactly matching
334 * struct pollfd. (This is silly, and one day we should use a better
337 typedef int DBusPollable;
338 # define DBUS_POLLABLE_FORMAT "d"
340 static inline DBusPollable
341 _dbus_socket_get_pollable (DBusSocket s) { return s.fd; }
344 _dbus_pollable_printable (DBusPollable p) { return p; }
346 static inline dbus_bool_t
347 _dbus_pollable_is_valid (DBusPollable p) { return p >= 0; }
350 _dbus_pollable_invalidate (DBusPollable *p) { *p = -1; }
352 static inline dbus_bool_t
353 _dbus_pollable_equals (DBusPollable a, DBusPollable b) { return a == b; }
355 #endif /* !DBUS_WIN */
357 #if defined(HAVE_POLL) && !defined(BROKEN_POLL)
359 * A portable struct pollfd wrapper, or an emulation of struct pollfd
360 * on platforms where poll() is missing or broken.
362 typedef struct pollfd DBusPollFD;
364 /** There is data to read */
365 #define _DBUS_POLLIN POLLIN
366 /** There is urgent data to read */
367 #define _DBUS_POLLPRI POLLPRI
368 /** Writing now will not block */
369 #define _DBUS_POLLOUT POLLOUT
370 /** Error condition */
371 #define _DBUS_POLLERR POLLERR
373 #define _DBUS_POLLHUP POLLHUP
374 /** Invalid request: fd not open */
375 #define _DBUS_POLLNVAL POLLNVAL
377 /* Emulate poll() via select(). Because we aren't really going to call
378 * poll(), any similarly-shaped struct is acceptable, and any power of 2
379 * will do for the events/revents; these values happen to match Linux
383 DBusPollable fd; /**< File descriptor */
384 short events; /**< Events to poll for */
385 short revents; /**< Events that occurred */
388 /** There is data to read */
389 #define _DBUS_POLLIN 0x0001
390 /** There is urgent data to read */
391 #define _DBUS_POLLPRI 0x0002
392 /** Writing now will not block */
393 #define _DBUS_POLLOUT 0x0004
394 /** Error condition */
395 #define _DBUS_POLLERR 0x0008
397 #define _DBUS_POLLHUP 0x0010
398 /** Invalid request: fd not open */
399 #define _DBUS_POLLNVAL 0x0020
403 int _dbus_poll (DBusPollFD *fds,
405 int timeout_milliseconds);
408 void _dbus_sleep_milliseconds (int milliseconds);
411 void _dbus_get_monotonic_time (long *tv_sec,
415 void _dbus_get_real_time (long *tv_sec,
419 * directory interface
422 dbus_bool_t _dbus_create_directory (const DBusString *filename,
425 dbus_bool_t _dbus_delete_directory (const DBusString *filename,
429 dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir,
430 const DBusString *next_component);
431 dbus_bool_t _dbus_string_get_dirname (const DBusString *filename,
432 DBusString *dirname);
434 dbus_bool_t _dbus_path_is_absolute (const DBusString *filename);
436 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
437 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs);
439 dbus_bool_t _dbus_get_system_config_file (DBusString *str);
440 dbus_bool_t _dbus_get_session_config_file (DBusString *str);
442 /** Opaque type for reading a directory listing */
443 typedef struct DBusDirIter DBusDirIter;
445 DBusDirIter* _dbus_directory_open (const DBusString *filename,
447 dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter,
448 DBusString *filename,
450 void _dbus_directory_close (DBusDirIter *iter);
452 dbus_bool_t _dbus_check_dir_is_private_to_user (DBusString *dir,
456 const char* _dbus_get_tmpdir (void);
461 _DBUS_GNUC_WARN_UNUSED_RESULT
462 dbus_bool_t _dbus_generate_random_bytes_buffer (char *buffer,
465 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
469 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
474 const char* _dbus_error_from_errno (int error_number);
476 const char* _dbus_error_from_system_errno (void);
478 int _dbus_save_socket_errno (void);
479 void _dbus_restore_socket_errno (int saved_errno);
480 void _dbus_set_errno_to_zero (void);
481 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (int e);
482 dbus_bool_t _dbus_get_is_errno_enomem (int e);
483 dbus_bool_t _dbus_get_is_errno_eintr (int e);
484 dbus_bool_t _dbus_get_is_errno_epipe (int e);
485 dbus_bool_t _dbus_get_is_errno_etoomanyrefs (int e);
487 const char* _dbus_strerror_from_errno (void);
489 void _dbus_disable_sigpipe (void);
492 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
495 int _dbus_printf_string_upper_bound (const char *format,
498 #ifdef DBUS_ENABLE_VERBOSE_MODE
500 void _dbus_print_thread (void);
504 * Portable struct with stat() results
508 unsigned long mode; /**< File mode */
509 unsigned long nlink; /**< Number of hard links */
510 dbus_uid_t uid; /**< User owning file */
511 dbus_gid_t gid; /**< Group owning file */
512 unsigned long size; /**< Size of file */
513 unsigned long atime; /**< Access time */
514 unsigned long mtime; /**< Modify time */
515 unsigned long ctime; /**< Creation time */
518 dbus_bool_t _dbus_stat (const DBusString *filename,
522 dbus_bool_t _dbus_socketpair (DBusSocket *fd1,
524 dbus_bool_t blocking,
528 void _dbus_print_backtrace (void);
530 dbus_bool_t _dbus_become_daemon (const DBusString *pidfile,
531 DBusPipe *print_pid_pipe,
533 dbus_bool_t keep_umask);
535 dbus_bool_t _dbus_verify_daemon_user (const char *user);
536 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
539 dbus_bool_t _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile,
540 DBusPipe *print_pid_pipe,
541 dbus_pid_t pid_to_write,
544 dbus_bool_t _dbus_command_for_pid (unsigned long pid,
549 /** A UNIX signal handler */
550 typedef void (* DBusSignalHandler) (int sig);
552 void _dbus_set_signal_handler (int sig,
553 DBusSignalHandler handler);
555 dbus_bool_t _dbus_user_at_console (const char *username,
558 void _dbus_init_system_log (dbus_bool_t is_daemon);
561 DBUS_SYSTEM_LOG_INFO,
562 DBUS_SYSTEM_LOG_WARNING,
563 DBUS_SYSTEM_LOG_SECURITY,
564 DBUS_SYSTEM_LOG_FATAL
565 } DBusSystemLogSeverity;
567 void _dbus_system_log (DBusSystemLogSeverity severity, const char *msg, ...) _DBUS_GNUC_PRINTF (2, 3);
568 void _dbus_system_logv (DBusSystemLogSeverity severity, const char *msg, va_list args);
570 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
571 * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
573 #if !defined (DBUS_VA_COPY)
574 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
575 # define DBUS_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
576 # elif defined (DBUS_VA_COPY_AS_ARRAY)
577 # define DBUS_VA_COPY(ap1, ap2) memcpy ((ap1), (ap2), sizeof (va_list))
578 # else /* va_list is a pointer */
579 # define DBUS_VA_COPY(ap1, ap2) ((ap1) = (ap2))
580 # endif /* va_list is a pointer */
581 #endif /* !DBUS_VA_COPY */
585 * Casts a primitive C type to a byte array and then indexes
586 * a particular byte of the array.
588 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
589 (((const char*)&(p))[(i)])
590 /** On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
591 * or b in an 80-bit register, thus failing to compare the two 64-bit
592 * doubles for bitwise equality. So this macro compares the two doubles
595 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b) \
596 (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) && \
597 _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) && \
598 _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) && \
599 _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) && \
600 _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) && \
601 _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) && \
602 _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) && \
603 _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
605 dbus_bool_t _dbus_get_autolaunch_address (const char *scope,
609 dbus_bool_t _dbus_lookup_session_address (dbus_bool_t *supported,
613 /** Type representing a universally unique ID
614 * @todo rename to UUID instead of GUID
616 typedef union DBusGUID DBusGUID;
618 dbus_bool_t _dbus_read_local_machine_uuid (DBusGUID *machine_id,
619 dbus_bool_t create_if_not_found,
623 * Initialize threads as in dbus_threads_init_default(), appropriately
625 * @returns #FALSE if no memory
627 dbus_bool_t _dbus_threads_init_platform_specific (void);
630 * Lock a static mutex used to protect _dbus_threads_init_platform_specific().
632 void _dbus_threads_lock_platform_specific (void);
635 * Undo _dbus_threads_lock_platform_specific().
637 void _dbus_threads_unlock_platform_specific (void);
640 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs,
642 DBusList **dir_list);
644 unsigned long _dbus_pid_for_log (void);
646 /* FIXME move back to dbus-sysdeps-unix.h probably -
647 * the PID file handling just needs a little more abstraction
648 * in the bus daemon first.
651 dbus_pid_t _dbus_getpid (void);
654 dbus_uid_t _dbus_getuid (void);
656 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
660 void _dbus_flush_caches (void);
662 dbus_bool_t _dbus_replace_install_prefix (DBusString *path);
664 /* Do not set this too high: it is a denial-of-service risk.
665 * See <https://bugs.freedesktop.org/show_bug.cgi?id=82820>
667 * (This needs to be in the non-Unix-specific header so that
668 * the config-parser can use it.)
670 #define DBUS_DEFAULT_MESSAGE_UNIX_FDS 16
672 typedef struct DBusRLimit DBusRLimit;
674 DBusRLimit *_dbus_rlimit_save_fd_limit (DBusError *error);
675 dbus_bool_t _dbus_rlimit_raise_fd_limit_if_privileged (unsigned int desired,
677 dbus_bool_t _dbus_rlimit_restore_fd_limit (DBusRLimit *saved,
679 void _dbus_rlimit_free (DBusRLimit *lim);
687 #include "dbus-sysdeps-win.h"
690 #endif /* DBUS_SYSDEPS_H */