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.
37 /* and it would just be annoying to abstract this */
45 #define _DBUS_PATH_SEPARATOR ";"
47 #define _DBUS_PATH_SEPARATOR ":"
50 /* Forward declarations */
52 /** An opaque string type */
53 typedef struct DBusString DBusString;
55 /** An opaque list type */
56 typedef struct DBusList DBusList;
58 /** Object that contains a list of credentials such as UNIX or Windows user ID */
59 typedef struct DBusCredentials DBusCredentials;
62 * @addtogroup DBusSysdeps
67 /* The idea of this file is to encapsulate everywhere that we're
68 * relying on external libc features, for ease of security
69 * auditing. The idea is from vsftpd. This also gives us a chance to
70 * make things more convenient to use, e.g. by reading into a
71 * DBusString. Operating system headers aren't intended to be used
72 * outside of this file and a limited number of others (such as
76 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
77 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx ) \
78 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
79 #define _DBUS_GNUC_NORETURN \
80 __attribute__((__noreturn__))
82 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
83 #define _DBUS_GNUC_NORETURN
84 #endif /* !__GNUC__ */
86 /** @def _DBUS_GNUC_PRINTF
87 * used to tell gcc about printf format strings
89 /** @def _DBUS_GNUC_NORETURN
90 * used to tell gcc about functions that never return, such as _dbus_abort()
93 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
95 const char* _dbus_getenv (const char *varname);
96 dbus_bool_t _dbus_setenv (const char *varname,
100 typedef unsigned long dbus_pid_t;
102 typedef unsigned long dbus_uid_t;
104 typedef unsigned long dbus_gid_t;
106 /** an invalid PID used to represent an uninitialized dbus_pid_t field */
107 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
108 /** an invalid UID used to represent an uninitialized dbus_uid_t field */
109 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
110 /** an invalid GID used to represent an uninitialized dbus_gid_t field */
111 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
113 /** an appropriate printf format for dbus_pid_t */
114 #define DBUS_PID_FORMAT "%lu"
115 /** an appropriate printf format for dbus_uid_t */
116 #define DBUS_UID_FORMAT "%lu"
117 /** an appropriate printf format for dbus_gid_t */
118 #define DBUS_GID_FORMAT "%lu"
124 * @todo Use for the file descriptors a struct
125 * - struct DBusSocket{ int d; }; -
126 * instead of int to get type-safety which
127 * will be checked by the compiler.
131 dbus_bool_t _dbus_open_tcp_socket (int *fd,
133 dbus_bool_t _dbus_close_socket (int fd,
135 int _dbus_read_socket (int fd,
138 int _dbus_write_socket (int fd,
139 const DBusString *buffer,
142 int _dbus_write_socket_two (int fd,
143 const DBusString *buffer1,
146 const DBusString *buffer2,
149 int _dbus_connect_tcp_socket (const char *host,
152 int _dbus_listen_tcp_socket (const char *host,
155 int _dbus_accept (int listen_fd);
158 dbus_bool_t _dbus_read_credentials_socket (int client_fd,
159 DBusCredentials *credentials,
161 dbus_bool_t _dbus_send_credentials_socket (int server_fd,
164 dbus_bool_t _dbus_credentials_add_from_username (DBusCredentials *credentials,
165 const DBusString *username);
166 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials *credentials);
167 dbus_bool_t _dbus_credentials_parse_and_add_desired (DBusCredentials *credentials,
168 const DBusString *desired_identity);
170 dbus_bool_t _dbus_username_from_current_process (const DBusString **username);
171 dbus_bool_t _dbus_append_desired_identity (DBusString *str);
173 dbus_bool_t _dbus_homedir_from_current_process (const DBusString **homedir);
174 dbus_bool_t _dbus_homedir_from_username (const DBusString *username,
175 DBusString *homedir);
177 /** Opaque type representing an atomically-modifiable integer
178 * that can be used from multiple threads.
180 typedef struct DBusAtomic DBusAtomic;
183 * An atomic integer safe to increment or decrement from multiple threads.
188 volatile long value; /**< Value of the atomic integer. */
190 volatile dbus_int32_t value; /**< Value of the atomic integer. */
194 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
195 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
197 /** There is data to read */
198 #define _DBUS_POLLIN 0x0001
199 /** There is urgent data to read */
200 #define _DBUS_POLLPRI 0x0002
201 /** Writing now will not block */
202 #define _DBUS_POLLOUT 0x0004
203 /** Error condition */
204 #define _DBUS_POLLERR 0x0008
206 #define _DBUS_POLLHUP 0x0010
207 /** Invalid request: fd not open */
208 #define _DBUS_POLLNVAL 0x0020
211 * A portable struct pollfd wrapper.
215 int fd; /**< File descriptor */
216 short events; /**< Events to poll for */
217 short revents; /**< Events that occurred */
220 int _dbus_poll (DBusPollFD *fds,
222 int timeout_milliseconds);
224 void _dbus_sleep_milliseconds (int milliseconds);
226 void _dbus_get_current_time (long *tv_sec,
230 * File/directory interface
232 dbus_bool_t _dbus_file_exists (const char *file);
233 dbus_bool_t _dbus_file_get_contents (DBusString *str,
234 const DBusString *filename,
236 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
237 const DBusString *filename,
240 dbus_bool_t _dbus_make_file_world_readable (const DBusString *filename,
243 dbus_bool_t _dbus_create_file_exclusively (const DBusString *filename,
245 dbus_bool_t _dbus_delete_file (const DBusString *filename,
247 dbus_bool_t _dbus_create_directory (const DBusString *filename,
249 dbus_bool_t _dbus_delete_directory (const DBusString *filename,
252 dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir,
253 const DBusString *next_component);
254 dbus_bool_t _dbus_string_get_dirname (const DBusString *filename,
255 DBusString *dirname);
256 dbus_bool_t _dbus_path_is_absolute (const DBusString *filename);
258 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
264 void _dbus_pipe_init (DBusPipe *pipe,
266 void _dbus_pipe_init_stdout (DBusPipe *pipe);
267 int _dbus_pipe_write (DBusPipe *pipe,
268 const DBusString *buffer,
272 int _dbus_pipe_close (DBusPipe *pipe,
274 dbus_bool_t _dbus_pipe_is_valid (DBusPipe *pipe);
275 void _dbus_pipe_invalidate (DBusPipe *pipe);
276 dbus_bool_t _dbus_pipe_is_stdout_or_stderr (DBusPipe *pipe);
279 /** Opaque type for reading a directory listing */
280 typedef struct DBusDirIter DBusDirIter;
282 DBusDirIter* _dbus_directory_open (const DBusString *filename,
284 dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter,
285 DBusString *filename,
287 void _dbus_directory_close (DBusDirIter *iter);
289 dbus_bool_t _dbus_check_dir_is_private_to_user (DBusString *dir,
292 void _dbus_fd_set_close_on_exec (int fd);
294 const char* _dbus_get_tmpdir (void);
299 void _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
301 void _dbus_generate_random_bytes_buffer (char *buffer,
303 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
305 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
308 const char* _dbus_error_from_errno (int error_number);
310 void _dbus_disable_sigpipe (void);
313 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
315 int _dbus_printf_string_upper_bound (const char *format,
320 * Portable struct with stat() results
324 unsigned long mode; /**< File mode */
325 unsigned long nlink; /**< Number of hard links */
326 dbus_uid_t uid; /**< User owning file */
327 dbus_gid_t gid; /**< Group owning file */
328 unsigned long size; /**< Size of file */
329 unsigned long atime; /**< Access time */
330 unsigned long mtime; /**< Modify time */
331 unsigned long ctime; /**< Creation time */
334 dbus_bool_t _dbus_stat (const DBusString *filename,
337 dbus_bool_t _dbus_full_duplex_pipe (int *fd1,
339 dbus_bool_t blocking,
342 void _dbus_print_backtrace (void);
344 dbus_bool_t _dbus_become_daemon (const DBusString *pidfile,
345 DBusPipe *print_pid_pipe,
347 dbus_bool_t _dbus_write_pid_file (const DBusString *filename,
350 dbus_bool_t _dbus_verify_daemon_user (const char *user);
351 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
354 /** A UNIX signal handler */
355 typedef void (* DBusSignalHandler) (int sig);
357 void _dbus_set_signal_handler (int sig,
358 DBusSignalHandler handler);
360 dbus_bool_t _dbus_user_at_console (const char *username,
363 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
364 * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
366 #if !defined (DBUS_VA_COPY)
367 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
368 # define DBUS_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
369 # elif defined (DBUS_VA_COPY_AS_ARRAY)
370 # define DBUS_VA_COPY(ap1, ap2) memcpy ((ap1), (ap2), sizeof (va_list))
371 # else /* va_list is a pointer */
372 # define DBUS_VA_COPY(ap1, ap2) ((ap1) = (ap2))
373 # endif /* va_list is a pointer */
374 #endif /* !DBUS_VA_COPY */
378 * Casts a primitive C type to a byte array and then indexes
379 * a particular byte of the array.
381 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
382 (((const char*)&(p))[(i)])
383 /** On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
384 * or b in an 80-bit register, thus failing to compare the two 64-bit
385 * doubles for bitwise equality. So this macro compares the two doubles
388 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b) \
389 (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) && \
390 _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) && \
391 _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) && \
392 _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) && \
393 _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) && \
394 _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) && \
395 _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) && \
396 _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
398 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address,
401 /** Type representing a universally unique ID
402 * @todo rename to UUID instead of GUID
404 typedef union DBusGUID DBusGUID;
406 dbus_bool_t _dbus_read_local_machine_uuid (DBusGUID *machine_id,
407 dbus_bool_t create_if_not_found,
411 * Initialize threads as in dbus_threads_init_default(), appropriately
413 * @returns #FALSE if no memory
415 dbus_bool_t _dbus_threads_init_platform_specific (void);
417 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs,
419 DBusList **dir_list);
421 unsigned long _dbus_pid_for_log (void);
427 #endif /* DBUS_SYSDEPS_H */