1 /* -*- mode: C; c-file-style: "gnu" -*- */
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.
41 #define _DBUS_PATH_SEPARATOR ";"
43 #define _DBUS_PATH_SEPARATOR ":"
46 /* Forward declarations */
48 /** An opaque string type */
49 typedef struct DBusString DBusString;
51 /** An opaque list type */
52 typedef struct DBusList DBusList;
54 /** Object that contains a list of credentials such as UNIX or Windows user ID */
55 typedef struct DBusCredentials DBusCredentials;
58 * @addtogroup DBusSysdeps
63 /* The idea of this file is to encapsulate everywhere that we're
64 * relying on external libc features, for ease of security
65 * auditing. The idea is from vsftpd. This also gives us a chance to
66 * make things more convenient to use, e.g. by reading into a
67 * DBusString. Operating system headers aren't intended to be used
68 * outside of this file and a limited number of others (such as
72 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
73 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx ) \
74 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
75 #define _DBUS_GNUC_NORETURN \
76 __attribute__((__noreturn__))
78 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
79 #define _DBUS_GNUC_NORETURN
80 #endif /* !__GNUC__ */
82 /** @def _DBUS_GNUC_PRINTF
83 * used to tell gcc about printf format strings
85 /** @def _DBUS_GNUC_NORETURN
86 * used to tell gcc about functions that never return, such as _dbus_abort()
89 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
91 const char* _dbus_getenv (const char *varname);
92 dbus_bool_t _dbus_setenv (const char *varname,
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_open_tcp_socket (int *fd,
129 dbus_bool_t _dbus_close_socket (int fd,
131 int _dbus_read_socket (int fd,
134 int _dbus_write_socket (int fd,
135 const DBusString *buffer,
138 int _dbus_write_socket_two (int fd,
139 const DBusString *buffer1,
142 const DBusString *buffer2,
145 int _dbus_connect_tcp_socket (const char *host,
148 int _dbus_listen_tcp_socket (const char *host,
150 dbus_bool_t inaddr_any,
152 int _dbus_accept (int listen_fd);
155 dbus_bool_t _dbus_read_credentials_socket (int client_fd,
156 DBusCredentials *credentials,
158 dbus_bool_t _dbus_send_credentials_socket (int server_fd,
161 dbus_bool_t _dbus_credentials_add_from_user (DBusCredentials *credentials,
162 const DBusString *username);
163 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials *credentials);
164 dbus_bool_t _dbus_append_user_from_current_process (DBusString *str);
166 dbus_bool_t _dbus_parse_unix_user_from_config (const DBusString *username,
168 dbus_bool_t _dbus_parse_unix_group_from_config (const DBusString *groupname,
170 dbus_bool_t _dbus_unix_groups_from_uid (dbus_uid_t uid,
171 dbus_gid_t **group_ids,
173 dbus_bool_t _dbus_unix_user_is_at_console (dbus_uid_t uid,
175 dbus_bool_t _dbus_unix_user_is_process_owner (dbus_uid_t uid);
176 dbus_bool_t _dbus_windows_user_is_process_owner (const char *windows_sid);
178 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString *directory,
179 DBusCredentials *credentials);
181 /** Opaque type representing an atomically-modifiable integer
182 * that can be used from multiple threads.
184 typedef struct DBusAtomic DBusAtomic;
187 * An atomic integer safe to increment or decrement from multiple threads.
192 volatile long value; /**< Value of the atomic integer. */
194 volatile dbus_int32_t value; /**< Value of the atomic integer. */
198 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
199 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
201 /** There is data to read */
202 #define _DBUS_POLLIN 0x0001
203 /** There is urgent data to read */
204 #define _DBUS_POLLPRI 0x0002
205 /** Writing now will not block */
206 #define _DBUS_POLLOUT 0x0004
207 /** Error condition */
208 #define _DBUS_POLLERR 0x0008
210 #define _DBUS_POLLHUP 0x0010
211 /** Invalid request: fd not open */
212 #define _DBUS_POLLNVAL 0x0020
215 * A portable struct pollfd wrapper.
219 int fd; /**< File descriptor */
220 short events; /**< Events to poll for */
221 short revents; /**< Events that occurred */
224 int _dbus_poll (DBusPollFD *fds,
226 int timeout_milliseconds);
228 void _dbus_sleep_milliseconds (int milliseconds);
230 void _dbus_get_current_time (long *tv_sec,
234 * File/directory interface
236 dbus_bool_t _dbus_file_exists (const char *file);
237 dbus_bool_t _dbus_file_get_contents (DBusString *str,
238 const DBusString *filename,
240 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
241 const DBusString *filename,
244 dbus_bool_t _dbus_make_file_world_readable (const DBusString *filename,
247 dbus_bool_t _dbus_create_file_exclusively (const DBusString *filename,
249 dbus_bool_t _dbus_delete_file (const DBusString *filename,
251 dbus_bool_t _dbus_create_directory (const DBusString *filename,
253 dbus_bool_t _dbus_delete_directory (const DBusString *filename,
256 dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir,
257 const DBusString *next_component);
258 dbus_bool_t _dbus_string_get_dirname (const DBusString *filename,
259 DBusString *dirname);
260 dbus_bool_t _dbus_path_is_absolute (const DBusString *filename);
262 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
264 dbus_bool_t _dbus_append_system_config_file (DBusString *str);
265 dbus_bool_t _dbus_append_session_config_file (DBusString *str);
271 void _dbus_pipe_init (DBusPipe *pipe,
273 void _dbus_pipe_init_stdout (DBusPipe *pipe);
274 int _dbus_pipe_write (DBusPipe *pipe,
275 const DBusString *buffer,
279 int _dbus_pipe_close (DBusPipe *pipe,
281 dbus_bool_t _dbus_pipe_is_valid (DBusPipe *pipe);
282 void _dbus_pipe_invalidate (DBusPipe *pipe);
283 dbus_bool_t _dbus_pipe_is_stdout_or_stderr (DBusPipe *pipe);
286 /** Opaque type for reading a directory listing */
287 typedef struct DBusDirIter DBusDirIter;
289 DBusDirIter* _dbus_directory_open (const DBusString *filename,
291 dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter,
292 DBusString *filename,
294 void _dbus_directory_close (DBusDirIter *iter);
296 dbus_bool_t _dbus_check_dir_is_private_to_user (DBusString *dir,
299 void _dbus_fd_set_close_on_exec (int fd);
301 const char* _dbus_get_tmpdir (void);
306 void _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
308 void _dbus_generate_random_bytes_buffer (char *buffer,
310 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
312 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
315 const char* _dbus_error_from_errno (int error_number);
317 void _dbus_set_errno_to_zero (void);
318 dbus_bool_t _dbus_get_is_errno_nonzero (void);
319 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void);
320 dbus_bool_t _dbus_get_is_errno_enomem (void);
321 dbus_bool_t _dbus_get_is_errno_eintr (void);
322 const char* _dbus_strerror_from_errno (void);
324 void _dbus_disable_sigpipe (void);
327 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
329 int _dbus_printf_string_upper_bound (const char *format,
334 * Portable struct with stat() results
338 unsigned long mode; /**< File mode */
339 unsigned long nlink; /**< Number of hard links */
340 dbus_uid_t uid; /**< User owning file */
341 dbus_gid_t gid; /**< Group owning file */
342 unsigned long size; /**< Size of file */
343 unsigned long atime; /**< Access time */
344 unsigned long mtime; /**< Modify time */
345 unsigned long ctime; /**< Creation time */
348 dbus_bool_t _dbus_stat (const DBusString *filename,
351 dbus_bool_t _dbus_full_duplex_pipe (int *fd1,
353 dbus_bool_t blocking,
356 void _dbus_print_backtrace (void);
358 dbus_bool_t _dbus_become_daemon (const DBusString *pidfile,
359 DBusPipe *print_pid_pipe,
361 dbus_bool_t _dbus_write_pid_file (const DBusString *filename,
364 dbus_bool_t _dbus_verify_daemon_user (const char *user);
365 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
368 /** A UNIX signal handler */
369 typedef void (* DBusSignalHandler) (int sig);
371 void _dbus_set_signal_handler (int sig,
372 DBusSignalHandler handler);
374 dbus_bool_t _dbus_user_at_console (const char *username,
377 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
378 * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
380 #if !defined (DBUS_VA_COPY)
381 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
382 # define DBUS_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
383 # elif defined (DBUS_VA_COPY_AS_ARRAY)
384 # define DBUS_VA_COPY(ap1, ap2) memcpy ((ap1), (ap2), sizeof (va_list))
385 # else /* va_list is a pointer */
386 # define DBUS_VA_COPY(ap1, ap2) ((ap1) = (ap2))
387 # endif /* va_list is a pointer */
388 #endif /* !DBUS_VA_COPY */
392 * Casts a primitive C type to a byte array and then indexes
393 * a particular byte of the array.
395 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
396 (((const char*)&(p))[(i)])
397 /** On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
398 * or b in an 80-bit register, thus failing to compare the two 64-bit
399 * doubles for bitwise equality. So this macro compares the two doubles
402 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b) \
403 (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) && \
404 _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) && \
405 _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) && \
406 _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) && \
407 _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) && \
408 _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) && \
409 _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) && \
410 _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
412 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address,
415 /** Type representing a universally unique ID
416 * @todo rename to UUID instead of GUID
418 typedef union DBusGUID DBusGUID;
420 dbus_bool_t _dbus_read_local_machine_uuid (DBusGUID *machine_id,
421 dbus_bool_t create_if_not_found,
425 * Initialize threads as in dbus_threads_init_default(), appropriately
427 * @returns #FALSE if no memory
429 dbus_bool_t _dbus_threads_init_platform_specific (void);
431 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs,
433 DBusList **dir_list);
435 unsigned long _dbus_pid_for_log (void);
437 /* FIXME move back to dbus-sysdeps-unix.h probably -
438 * the PID file handling just needs a little more abstraction
439 * in the bus daemon first.
441 dbus_pid_t _dbus_getpid (void);
443 void _dbus_flush_caches (void);
449 #endif /* DBUS_SYSDEPS_H */