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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #ifndef DBUS_SYSDEPS_H
26 #define DBUS_SYSDEPS_H
30 #include <dbus/dbus-errors.h>
32 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
33 * stuff straight out of string.h, so have this here for now.
39 /* AIX sys/poll.h does #define events reqevents, and other
40 * wonderousness, so must include sys/poll before declaring
50 #define _DBUS_PATH_SEPARATOR ";"
52 #define _DBUS_PATH_SEPARATOR ":"
55 /* Forward declarations */
57 /** An opaque string type */
58 typedef struct DBusString DBusString;
60 /** An opaque list type */
61 typedef struct DBusList DBusList;
63 /** Object that contains a list of credentials such as UNIX or Windows user ID */
64 typedef struct DBusCredentials DBusCredentials;
67 * @addtogroup DBusSysdeps
72 /* The idea of this file is to encapsulate everywhere that we're
73 * relying on external libc features, for ease of security
74 * auditing. The idea is from vsftpd. This also gives us a chance to
75 * make things more convenient to use, e.g. by reading into a
76 * DBusString. Operating system headers aren't intended to be used
77 * outside of this file and a limited number of others (such as
81 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
82 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx ) \
83 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
84 #define _DBUS_GNUC_NORETURN \
85 __attribute__((__noreturn__))
87 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
88 #define _DBUS_GNUC_NORETURN
89 #endif /* !__GNUC__ */
91 /** @def _DBUS_GNUC_PRINTF
92 * used to tell gcc about printf format strings
94 /** @def _DBUS_GNUC_NORETURN
95 * used to tell gcc about functions that never return, such as _dbus_abort()
98 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
100 const char* _dbus_getenv (const char *varname);
101 dbus_bool_t _dbus_setenv (const char *varname,
103 dbus_bool_t _dbus_clearenv (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"
130 * @todo Use for the file descriptors a struct
131 * - struct DBusSocket{ int d; }; -
132 * instead of int to get type-safety which
133 * will be checked by the compiler.
137 dbus_bool_t _dbus_open_tcp_socket (int *fd,
139 dbus_bool_t _dbus_close_socket (int fd,
141 int _dbus_read_socket (int fd,
144 int _dbus_write_socket (int fd,
145 const DBusString *buffer,
148 int _dbus_write_socket_two (int fd,
149 const DBusString *buffer1,
152 const DBusString *buffer2,
155 int _dbus_connect_tcp_socket (const char *host,
159 int _dbus_listen_tcp_socket (const char *host,
165 int _dbus_accept (int listen_fd);
168 dbus_bool_t _dbus_read_credentials_socket (int client_fd,
169 DBusCredentials *credentials,
171 dbus_bool_t _dbus_send_credentials_socket (int server_fd,
174 dbus_bool_t _dbus_credentials_add_from_user (DBusCredentials *credentials,
175 const DBusString *username);
176 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials *credentials);
177 dbus_bool_t _dbus_append_user_from_current_process (DBusString *str);
179 dbus_bool_t _dbus_parse_unix_user_from_config (const DBusString *username,
181 dbus_bool_t _dbus_parse_unix_group_from_config (const DBusString *groupname,
183 dbus_bool_t _dbus_unix_groups_from_uid (dbus_uid_t uid,
184 dbus_gid_t **group_ids,
186 dbus_bool_t _dbus_unix_user_is_at_console (dbus_uid_t uid,
188 dbus_bool_t _dbus_unix_user_is_process_owner (dbus_uid_t uid);
189 dbus_bool_t _dbus_windows_user_is_process_owner (const char *windows_sid);
191 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString *directory,
192 DBusCredentials *credentials);
194 /** Opaque type representing an atomically-modifiable integer
195 * that can be used from multiple threads.
197 typedef struct DBusAtomic DBusAtomic;
200 * An atomic integer safe to increment or decrement from multiple threads.
205 volatile long value; /**< Value of the atomic integer. */
207 volatile dbus_int32_t value; /**< Value of the atomic integer. */
211 /* The value we get from autofoo is in the form of a cpp expression;
212 * convert that to a conventional defined/undef switch. (We can't get
213 * the conventional defined/undef because of multiarch builds only running
214 * ./configure once, on Darwin.) */
215 #if DBUS_HAVE_ATOMIC_INT_COND
216 # define DBUS_HAVE_ATOMIC_INT 1
218 # undef DBUS_HAVE_ATOMIC_INT
221 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
222 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
225 /* AIX uses different values for poll */
228 /** There is data to read */
229 #define _DBUS_POLLIN 0x0001
230 /** There is urgent data to read */
231 #define _DBUS_POLLPRI 0x0004
232 /** Writing now will not block */
233 #define _DBUS_POLLOUT 0x0002
234 /** Error condition */
235 #define _DBUS_POLLERR 0x4000
237 #define _DBUS_POLLHUP 0x2000
238 /** Invalid request: fd not open */
239 #define _DBUS_POLLNVAL 0x8000
241 /** There is data to read */
242 #define _DBUS_POLLIN 0x0001
243 /** There is urgent data to read */
244 #define _DBUS_POLLPRI 0x0002
245 /** Writing now will not block */
246 #define _DBUS_POLLOUT 0x0004
247 /** Error condition */
248 #define _DBUS_POLLERR 0x0008
250 #define _DBUS_POLLHUP 0x0010
251 /** Invalid request: fd not open */
252 #define _DBUS_POLLNVAL 0x0020
256 * A portable struct pollfd wrapper.
260 int fd; /**< File descriptor */
261 short events; /**< Events to poll for */
262 short revents; /**< Events that occurred */
265 int _dbus_poll (DBusPollFD *fds,
267 int timeout_milliseconds);
269 void _dbus_sleep_milliseconds (int milliseconds);
271 void _dbus_get_current_time (long *tv_sec,
275 * File/directory interface
277 dbus_bool_t _dbus_file_exists (const char *file);
278 dbus_bool_t _dbus_file_get_contents (DBusString *str,
279 const DBusString *filename,
281 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
282 const DBusString *filename,
285 dbus_bool_t _dbus_make_file_world_readable (const DBusString *filename,
288 dbus_bool_t _dbus_create_file_exclusively (const DBusString *filename,
290 dbus_bool_t _dbus_delete_file (const DBusString *filename,
292 dbus_bool_t _dbus_create_directory (const DBusString *filename,
294 dbus_bool_t _dbus_delete_directory (const DBusString *filename,
297 dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir,
298 const DBusString *next_component);
299 dbus_bool_t _dbus_string_get_dirname (const DBusString *filename,
300 DBusString *dirname);
301 dbus_bool_t _dbus_path_is_absolute (const DBusString *filename);
303 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
304 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs);
306 dbus_bool_t _dbus_append_system_config_file (DBusString *str);
307 dbus_bool_t _dbus_append_session_config_file (DBusString *str);
313 void _dbus_pipe_init (DBusPipe *pipe,
315 void _dbus_pipe_init_stdout (DBusPipe *pipe);
316 int _dbus_pipe_write (DBusPipe *pipe,
317 const DBusString *buffer,
321 int _dbus_pipe_close (DBusPipe *pipe,
323 dbus_bool_t _dbus_pipe_is_valid (DBusPipe *pipe);
324 void _dbus_pipe_invalidate (DBusPipe *pipe);
325 dbus_bool_t _dbus_pipe_is_stdout_or_stderr (DBusPipe *pipe);
328 /** Opaque type for reading a directory listing */
329 typedef struct DBusDirIter DBusDirIter;
331 DBusDirIter* _dbus_directory_open (const DBusString *filename,
333 dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter,
334 DBusString *filename,
336 void _dbus_directory_close (DBusDirIter *iter);
338 dbus_bool_t _dbus_check_dir_is_private_to_user (DBusString *dir,
341 void _dbus_fd_set_close_on_exec (int fd);
343 const char* _dbus_get_tmpdir (void);
348 void _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
350 void _dbus_generate_random_bytes_buffer (char *buffer,
352 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
354 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
357 const char* _dbus_error_from_errno (int error_number);
359 void _dbus_set_errno_to_zero (void);
360 dbus_bool_t _dbus_get_is_errno_nonzero (void);
361 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void);
362 dbus_bool_t _dbus_get_is_errno_enomem (void);
363 dbus_bool_t _dbus_get_is_errno_eintr (void);
364 const char* _dbus_strerror_from_errno (void);
366 void _dbus_disable_sigpipe (void);
369 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
371 int _dbus_printf_string_upper_bound (const char *format,
376 * Portable struct with stat() results
380 unsigned long mode; /**< File mode */
381 unsigned long nlink; /**< Number of hard links */
382 dbus_uid_t uid; /**< User owning file */
383 dbus_gid_t gid; /**< Group owning file */
384 unsigned long size; /**< Size of file */
385 unsigned long atime; /**< Access time */
386 unsigned long mtime; /**< Modify time */
387 unsigned long ctime; /**< Creation time */
390 dbus_bool_t _dbus_stat (const DBusString *filename,
393 dbus_bool_t _dbus_full_duplex_pipe (int *fd1,
395 dbus_bool_t blocking,
398 void _dbus_print_backtrace (void);
400 dbus_bool_t _dbus_become_daemon (const DBusString *pidfile,
401 DBusPipe *print_pid_pipe,
404 dbus_bool_t _dbus_verify_daemon_user (const char *user);
405 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
408 dbus_bool_t _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile,
409 DBusPipe *print_pid_pipe,
410 dbus_pid_t pid_to_write,
413 /** A UNIX signal handler */
414 typedef void (* DBusSignalHandler) (int sig);
416 void _dbus_set_signal_handler (int sig,
417 DBusSignalHandler handler);
419 dbus_bool_t _dbus_user_at_console (const char *username,
422 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
423 * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
425 #if !defined (DBUS_VA_COPY)
426 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
427 # define DBUS_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
428 # elif defined (DBUS_VA_COPY_AS_ARRAY)
429 # define DBUS_VA_COPY(ap1, ap2) memcpy ((ap1), (ap2), sizeof (va_list))
430 # else /* va_list is a pointer */
431 # define DBUS_VA_COPY(ap1, ap2) ((ap1) = (ap2))
432 # endif /* va_list is a pointer */
433 #endif /* !DBUS_VA_COPY */
437 * Casts a primitive C type to a byte array and then indexes
438 * a particular byte of the array.
440 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
441 (((const char*)&(p))[(i)])
442 /** On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
443 * or b in an 80-bit register, thus failing to compare the two 64-bit
444 * doubles for bitwise equality. So this macro compares the two doubles
447 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b) \
448 (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) && \
449 _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) && \
450 _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) && \
451 _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) && \
452 _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) && \
453 _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) && \
454 _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) && \
455 _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
457 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address,
460 /** Type representing a universally unique ID
461 * @todo rename to UUID instead of GUID
463 typedef union DBusGUID DBusGUID;
465 dbus_bool_t _dbus_read_local_machine_uuid (DBusGUID *machine_id,
466 dbus_bool_t create_if_not_found,
470 * Initialize threads as in dbus_threads_init_default(), appropriately
472 * @returns #FALSE if no memory
474 dbus_bool_t _dbus_threads_init_platform_specific (void);
476 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs,
478 DBusList **dir_list);
480 unsigned long _dbus_pid_for_log (void);
482 /* FIXME move back to dbus-sysdeps-unix.h probably -
483 * the PID file handling just needs a little more abstraction
484 * in the bus daemon first.
486 dbus_pid_t _dbus_getpid (void);
488 void _dbus_flush_caches (void);
494 #endif /* DBUS_SYSDEPS_H */