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
34 #ifdef HAVE_INTTYPES_H
38 #include <dbus/dbus-errors.h>
39 #include <dbus/dbus-file.h>
40 #include <dbus/dbus-string.h>
42 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
43 * stuff straight out of string.h, so have this here for now.
48 /* AIX sys/poll.h does #define events reqevents, and other
49 * wonderousness, so must include sys/poll before declaring
57 /* Windows CE lacks some system functions (such as errno and clock).
58 We bring them in here. */
59 #include "dbus-sysdeps-wince-glue.h"
65 #define _DBUS_PATH_SEPARATOR ";"
67 #define _DBUS_PATH_SEPARATOR ":"
70 /* Forward declarations */
73 /** An opaque list type */
74 typedef struct DBusList DBusList;
76 /** Object that contains a list of credentials such as UNIX or Windows user ID */
77 typedef struct DBusCredentials DBusCredentials;
79 /** A wrapper around a pipe descriptor or handle */
80 typedef struct DBusPipe DBusPipe;
83 * @addtogroup DBusSysdeps
88 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
90 dbus_bool_t _dbus_check_setuid (void);
91 const char* _dbus_getenv (const char *varname);
92 dbus_bool_t _dbus_clearenv (void);
93 char ** _dbus_get_environment (void);
96 typedef unsigned long dbus_pid_t;
98 typedef unsigned long dbus_uid_t;
100 typedef unsigned long dbus_gid_t;
102 /** an invalid PID used to represent an uninitialized dbus_pid_t field */
103 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
104 /** an invalid UID used to represent an uninitialized dbus_uid_t field */
105 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
106 /** an invalid GID used to represent an uninitialized dbus_gid_t field */
107 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
109 /** an appropriate printf format for dbus_pid_t */
110 #define DBUS_PID_FORMAT "%lu"
111 /** an appropriate printf format for dbus_uid_t */
112 #define DBUS_UID_FORMAT "%lu"
113 /** an appropriate printf format for dbus_gid_t */
114 #define DBUS_GID_FORMAT "%lu"
120 * @todo Use for the file descriptors a struct
121 * - struct DBusSocket{ int d; }; -
122 * instead of int to get type-safety which
123 * will be checked by the compiler.
127 dbus_bool_t _dbus_close_socket (int fd,
129 int _dbus_read_socket (int fd,
132 int _dbus_write_socket (int fd,
133 const DBusString *buffer,
136 int _dbus_write_socket_two (int fd,
137 const DBusString *buffer1,
140 const DBusString *buffer2,
144 int _dbus_read_socket_with_unix_fds (int fd,
149 int _dbus_write_socket_with_unix_fds (int fd,
150 const DBusString *buffer,
155 int _dbus_write_socket_with_unix_fds_two (int fd,
156 const DBusString *buffer1,
159 const DBusString *buffer2,
165 dbus_bool_t _dbus_socket_is_invalid (int fd);
167 int _dbus_connect_tcp_socket (const char *host,
171 int _dbus_connect_tcp_socket_with_nonce (const char *host,
174 const char *noncefile,
176 int _dbus_listen_tcp_socket (const char *host,
182 int _dbus_accept (int listen_fd);
185 dbus_bool_t _dbus_read_credentials_socket (int client_fd,
186 DBusCredentials *credentials,
188 dbus_bool_t _dbus_send_credentials_socket (int server_fd,
191 dbus_bool_t _dbus_credentials_add_from_user (DBusCredentials *credentials,
192 const DBusString *username);
193 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials *credentials);
194 dbus_bool_t _dbus_append_user_from_current_process (DBusString *str);
196 dbus_bool_t _dbus_parse_unix_user_from_config (const DBusString *username,
198 dbus_bool_t _dbus_parse_unix_group_from_config (const DBusString *groupname,
200 dbus_bool_t _dbus_unix_groups_from_uid (dbus_uid_t uid,
201 dbus_gid_t **group_ids,
203 dbus_bool_t _dbus_unix_user_is_at_console (dbus_uid_t uid,
205 dbus_bool_t _dbus_unix_user_is_process_owner (dbus_uid_t uid);
206 dbus_bool_t _dbus_windows_user_is_process_owner (const char *windows_sid);
208 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString *directory,
209 DBusCredentials *credentials);
211 dbus_bool_t _dbus_daemon_is_session_bus_address_published (const char *scope);
213 dbus_bool_t _dbus_daemon_publish_session_bus_address (const char* address, const char* shm_name);
215 void _dbus_daemon_unpublish_session_bus_address (void);
217 dbus_bool_t _dbus_socket_can_pass_unix_fd(int fd);
219 /** Opaque type representing an atomically-modifiable integer
220 * that can be used from multiple threads.
222 typedef struct DBusAtomic DBusAtomic;
225 * An atomic integer safe to increment or decrement from multiple threads.
230 volatile long value; /**< Value of the atomic integer. */
232 volatile dbus_int32_t value; /**< Value of the atomic integer. */
236 /* The value we get from autofoo is in the form of a cpp expression;
237 * convert that to a conventional defined/undef switch. (We can't get
238 * the conventional defined/undef because of multiarch builds only running
239 * ./configure once, on Darwin.) */
240 #if DBUS_HAVE_ATOMIC_INT_COND
241 # define DBUS_HAVE_ATOMIC_INT 1
243 # undef DBUS_HAVE_ATOMIC_INT
246 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
247 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
248 dbus_int32_t _dbus_atomic_get (DBusAtomic *atomic);
251 /* AIX uses different values for poll */
254 /** There is data to read */
255 #define _DBUS_POLLIN 0x0001
256 /** There is urgent data to read */
257 #define _DBUS_POLLPRI 0x0004
258 /** Writing now will not block */
259 #define _DBUS_POLLOUT 0x0002
260 /** Error condition */
261 #define _DBUS_POLLERR 0x4000
263 #define _DBUS_POLLHUP 0x2000
264 /** Invalid request: fd not open */
265 #define _DBUS_POLLNVAL 0x8000
266 #elif defined(__HAIKU__)
267 /** There is data to read */
268 #define _DBUS_POLLIN 0x0001
269 /** Writing now will not block */
270 #define _DBUS_POLLOUT 0x0002
271 /** Error condition */
272 #define _DBUS_POLLERR 0x0004
273 /** There is urgent data to read */
274 #define _DBUS_POLLPRI 0x0020
276 #define _DBUS_POLLHUP 0x0080
277 /** Invalid request: fd not open */
278 #define _DBUS_POLLNVAL 0x1000
279 #elif defined(__QNX__)
280 /** Writing now will not block */
281 #define _DBUS_POLLOUT 0x0002
282 /** There is data to read */
283 #define _DBUS_POLLIN 0x0005
284 /** There is urgent data to read */
285 #define _DBUS_POLLPRI 0x0008
286 /** Error condition */
287 #define _DBUS_POLLERR 0x0020
289 #define _DBUS_POLLHUP 0x0040
290 /** Invalid request: fd not open */
291 #define _DBUS_POLLNVAL 0x1000
293 /** There is data to read */
294 #define _DBUS_POLLIN 0x0001
295 /** There is urgent data to read */
296 #define _DBUS_POLLPRI 0x0002
297 /** Writing now will not block */
298 #define _DBUS_POLLOUT 0x0004
299 /** Error condition */
300 #define _DBUS_POLLERR 0x0008
302 #define _DBUS_POLLHUP 0x0010
303 /** Invalid request: fd not open */
304 #define _DBUS_POLLNVAL 0x0020
308 * A portable struct pollfd wrapper.
312 int fd; /**< File descriptor */
313 short events; /**< Events to poll for */
314 short revents; /**< Events that occurred */
317 int _dbus_poll (DBusPollFD *fds,
319 int timeout_milliseconds);
321 void _dbus_sleep_milliseconds (int milliseconds);
323 void _dbus_get_monotonic_time (long *tv_sec,
326 void _dbus_get_real_time (long *tv_sec,
330 * directory interface
332 dbus_bool_t _dbus_create_directory (const DBusString *filename,
334 dbus_bool_t _dbus_delete_directory (const DBusString *filename,
337 dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir,
338 const DBusString *next_component);
339 dbus_bool_t _dbus_string_get_dirname (const DBusString *filename,
340 DBusString *dirname);
341 dbus_bool_t _dbus_path_is_absolute (const DBusString *filename);
343 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
344 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs);
346 dbus_bool_t _dbus_append_system_config_file (DBusString *str);
347 dbus_bool_t _dbus_append_session_config_file (DBusString *str);
349 /** Opaque type for reading a directory listing */
350 typedef struct DBusDirIter DBusDirIter;
352 DBusDirIter* _dbus_directory_open (const DBusString *filename,
354 dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter,
355 DBusString *filename,
357 void _dbus_directory_close (DBusDirIter *iter);
359 dbus_bool_t _dbus_check_dir_is_private_to_user (DBusString *dir,
362 void _dbus_fd_set_close_on_exec (intptr_t fd);
364 const char* _dbus_get_tmpdir (void);
369 void _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
371 void _dbus_generate_random_bytes_buffer (char *buffer,
373 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
375 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
378 const char* _dbus_error_from_errno (int error_number);
379 const char* _dbus_error_from_system_errno (void);
381 void _dbus_set_errno_to_zero (void);
382 dbus_bool_t _dbus_get_is_errno_nonzero (void);
383 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void);
384 dbus_bool_t _dbus_get_is_errno_enomem (void);
385 dbus_bool_t _dbus_get_is_errno_eintr (void);
386 dbus_bool_t _dbus_get_is_errno_epipe (void);
387 const char* _dbus_strerror_from_errno (void);
389 void _dbus_disable_sigpipe (void);
392 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
394 int _dbus_printf_string_upper_bound (const char *format,
399 * Portable struct with stat() results
403 unsigned long mode; /**< File mode */
404 unsigned long nlink; /**< Number of hard links */
405 dbus_uid_t uid; /**< User owning file */
406 dbus_gid_t gid; /**< Group owning file */
407 unsigned long size; /**< Size of file */
408 unsigned long atime; /**< Access time */
409 unsigned long mtime; /**< Modify time */
410 unsigned long ctime; /**< Creation time */
413 dbus_bool_t _dbus_stat (const DBusString *filename,
416 dbus_bool_t _dbus_full_duplex_pipe (int *fd1,
418 dbus_bool_t blocking,
421 void _dbus_print_backtrace (void);
423 dbus_bool_t _dbus_become_daemon (const DBusString *pidfile,
424 DBusPipe *print_pid_pipe,
426 dbus_bool_t keep_umask);
428 dbus_bool_t _dbus_verify_daemon_user (const char *user);
429 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
432 dbus_bool_t _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile,
433 DBusPipe *print_pid_pipe,
434 dbus_pid_t pid_to_write,
437 dbus_bool_t _dbus_command_for_pid (unsigned long pid,
442 /** A UNIX signal handler */
443 typedef void (* DBusSignalHandler) (int sig);
445 void _dbus_set_signal_handler (int sig,
446 DBusSignalHandler handler);
448 dbus_bool_t _dbus_user_at_console (const char *username,
451 void _dbus_init_system_log (dbus_bool_t is_daemon);
454 DBUS_SYSTEM_LOG_INFO,
455 DBUS_SYSTEM_LOG_SECURITY,
456 DBUS_SYSTEM_LOG_FATAL
457 } DBusSystemLogSeverity;
459 void _dbus_system_log (DBusSystemLogSeverity severity, const char *msg, ...) _DBUS_GNUC_PRINTF (2, 3);
460 void _dbus_system_logv (DBusSystemLogSeverity severity, const char *msg, va_list args);
462 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
463 * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
465 #if !defined (DBUS_VA_COPY)
466 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
467 # define DBUS_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
468 # elif defined (DBUS_VA_COPY_AS_ARRAY)
469 # define DBUS_VA_COPY(ap1, ap2) memcpy ((ap1), (ap2), sizeof (va_list))
470 # else /* va_list is a pointer */
471 # define DBUS_VA_COPY(ap1, ap2) ((ap1) = (ap2))
472 # endif /* va_list is a pointer */
473 #endif /* !DBUS_VA_COPY */
477 * Casts a primitive C type to a byte array and then indexes
478 * a particular byte of the array.
480 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
481 (((const char*)&(p))[(i)])
482 /** On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
483 * or b in an 80-bit register, thus failing to compare the two 64-bit
484 * doubles for bitwise equality. So this macro compares the two doubles
487 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b) \
488 (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) && \
489 _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) && \
490 _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) && \
491 _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) && \
492 _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) && \
493 _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) && \
494 _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) && \
495 _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
497 dbus_bool_t _dbus_get_autolaunch_address (const char *scope,
501 dbus_bool_t _dbus_lookup_session_address (dbus_bool_t *supported,
505 /** Type representing a universally unique ID
506 * @todo rename to UUID instead of GUID
508 typedef union DBusGUID DBusGUID;
510 dbus_bool_t _dbus_read_local_machine_uuid (DBusGUID *machine_id,
511 dbus_bool_t create_if_not_found,
515 * Initialize threads as in dbus_threads_init_default(), appropriately
517 * @returns #FALSE if no memory
519 dbus_bool_t _dbus_threads_init_platform_specific (void);
522 * Lock a static mutex used to protect _dbus_threads_init_platform_specific().
524 void _dbus_threads_lock_platform_specific (void);
527 * Undo _dbus_threads_lock_platform_specific().
529 void _dbus_threads_unlock_platform_specific (void);
531 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs,
533 DBusList **dir_list);
535 unsigned long _dbus_pid_for_log (void);
537 /* FIXME move back to dbus-sysdeps-unix.h probably -
538 * the PID file handling just needs a little more abstraction
539 * in the bus daemon first.
541 dbus_pid_t _dbus_getpid (void);
543 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
546 void _dbus_flush_caches (void);
548 void _dbus_request_file_descriptor_limit (unsigned int limit);
551 * replaces the term DBUS_PREFIX in configure_time_path by the
552 * current dbus installation directory. On unix this function is a noop
554 * @param configure_time_path
558 _dbus_replace_install_prefix (const char *configure_time_path);
566 #include "dbus-sysdeps-win.h"
569 #endif /* DBUS_SYSDEPS_H */