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 */
44 /* The idea of this file is to encapsulate everywhere that we're
45 * relying on external libc features, for ease of security
46 * auditing. The idea is from vsftpd. This also gives us a chance to
47 * make things more convenient to use, e.g. by reading into a
48 * DBusString. Operating system headers aren't intended to be used
49 * outside of this file and a limited number of others (such as
53 typedef struct DBusString DBusString;
55 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
56 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx ) \
57 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
58 #define _DBUS_GNUC_SCANF( format_idx, arg_idx ) \
59 __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
60 #define _DBUS_GNUC_FORMAT( arg_idx ) \
61 __attribute__((__format_arg__ (arg_idx)))
62 #define _DBUS_GNUC_NORETURN \
63 __attribute__((__noreturn__))
65 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
66 #define _DBUS_GNUC_SCANF( format_idx, arg_idx )
67 #define _DBUS_GNUC_FORMAT( arg_idx )
68 #define _DBUS_GNUC_NORETURN
69 #endif /* !__GNUC__ */
71 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
73 const char* _dbus_getenv (const char *varname);
74 dbus_bool_t _dbus_setenv (const char *varname,
78 typedef unsigned long dbus_pid_t;
79 typedef unsigned long dbus_uid_t;
80 typedef unsigned long dbus_gid_t;
82 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
83 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
84 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
86 #define DBUS_PID_FORMAT "%lu"
87 #define DBUS_UID_FORMAT "%lu"
88 #define DBUS_GID_FORMAT "%lu"
94 * @todo Use for the file descriptors a struct
95 * - struct DBusSocket{ int d; }; -
96 * instead of int to get type-safety which
97 * will be checked by the compiler.
101 dbus_bool_t _dbus_open_tcp_socket (int *fd,
103 dbus_bool_t _dbus_close_socket (int fd,
105 int _dbus_read_socket (int fd,
108 int _dbus_write_socket (int fd,
109 const DBusString *buffer,
112 int _dbus_write_socket_two (int fd,
113 const DBusString *buffer1,
116 const DBusString *buffer2,
119 int _dbus_connect_tcp_socket (const char *host,
122 int _dbus_listen_tcp_socket (const char *host,
125 int _dbus_accept (int listen_fd);
128 * Struct representing socket credentials
132 dbus_pid_t pid; /**< process ID or DBUS_PID_UNSET */
133 dbus_uid_t uid; /**< user ID or DBUS_UID_UNSET */
134 dbus_gid_t gid; /**< group ID or DBUS_GID_UNSET */
137 /* FIXME these read/send credentials should get moved to sysdeps-unix.h,
138 * or renamed to reflect what they mean cross-platform
140 dbus_bool_t _dbus_read_credentials_unix_socket (int client_fd,
141 DBusCredentials *credentials,
143 dbus_bool_t _dbus_send_credentials_unix_socket (int server_fd,
147 void _dbus_credentials_clear (DBusCredentials *credentials);
148 void _dbus_credentials_from_current_process (DBusCredentials *credentials);
149 dbus_bool_t _dbus_credentials_match (const DBusCredentials *expected_credentials,
150 const DBusCredentials *provided_credentials);
153 typedef struct DBusUserInfo DBusUserInfo;
154 typedef struct DBusGroupInfo DBusGroupInfo;
157 * Information about a UNIX user
161 dbus_uid_t uid; /**< UID */
162 dbus_gid_t primary_gid; /**< GID */
163 dbus_gid_t *group_ids; /**< Groups IDs, *including* above primary group */
164 int n_group_ids; /**< Size of group IDs array */
165 char *username; /**< Username */
166 char *homedir; /**< Home directory */
170 * Information about a UNIX group
174 dbus_gid_t gid; /**< GID */
175 char *groupname; /**< Group name */
178 dbus_bool_t _dbus_user_info_fill (DBusUserInfo *info,
179 const DBusString *username,
181 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo *info,
184 void _dbus_user_info_free (DBusUserInfo *info);
186 dbus_bool_t _dbus_group_info_fill (DBusGroupInfo *info,
187 const DBusString *groupname,
189 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo *info,
192 void _dbus_group_info_free (DBusGroupInfo *info);
195 unsigned long _dbus_getpid (void);
196 dbus_uid_t _dbus_getuid (void);
197 dbus_gid_t _dbus_getgid (void);
199 typedef struct DBusAtomic DBusAtomic;
206 volatile dbus_int32_t value; /**< Value of the atomic integer. */
209 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
210 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
212 #define _DBUS_POLLIN 0x0001 /* There is data to read */
213 #define _DBUS_POLLPRI 0x0002 /* There is urgent data to read */
214 #define _DBUS_POLLOUT 0x0004 /* Writing now will not block */
215 #define _DBUS_POLLERR 0x0008 /* Error condition */
216 #define _DBUS_POLLHUP 0x0010 /* Hung up */
217 #define _DBUS_POLLNVAL 0x0020 /* Invalid request: fd not open */
220 * A portable struct pollfd wrapper.
224 int fd; /**< File descriptor */
225 short events; /**< Events to poll for */
226 short revents; /**< Events that occurred */
229 int _dbus_poll (DBusPollFD *fds,
231 int timeout_milliseconds);
233 void _dbus_sleep_milliseconds (int milliseconds);
235 void _dbus_get_current_time (long *tv_sec,
239 * File/directory interface
241 dbus_bool_t _dbus_file_exists (const char *file);
242 dbus_bool_t _dbus_file_get_contents (DBusString *str,
243 const DBusString *filename,
245 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
246 const DBusString *filename,
249 dbus_bool_t _dbus_create_file_exclusively (const DBusString *filename,
251 dbus_bool_t _dbus_delete_file (const DBusString *filename,
253 dbus_bool_t _dbus_create_directory (const DBusString *filename,
255 dbus_bool_t _dbus_delete_directory (const DBusString *filename,
258 dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir,
259 const DBusString *next_component);
260 dbus_bool_t _dbus_string_get_dirname (const DBusString *filename,
261 DBusString *dirname);
262 dbus_bool_t _dbus_path_is_absolute (const DBusString *filename);
264 typedef struct DBusDirIter DBusDirIter;
266 DBusDirIter* _dbus_directory_open (const DBusString *filename,
268 dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter,
269 DBusString *filename,
271 void _dbus_directory_close (DBusDirIter *iter);
273 dbus_bool_t _dbus_check_dir_is_private_to_user (DBusString *dir,
276 void _dbus_fd_set_close_on_exec (int fd);
278 const char* _dbus_get_tmpdir (void);
283 void _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
285 void _dbus_generate_random_bytes_buffer (char *buffer,
287 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
289 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
292 const char *_dbus_errno_to_string (int errnum);
293 const char* _dbus_error_from_errno (int error_number);
295 void _dbus_disable_sigpipe (void);
298 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
300 int _dbus_printf_string_upper_bound (const char *format,
305 * Portable struct with stat() results
309 unsigned long mode; /**< File mode */
310 unsigned long nlink; /**< Number of hard links */
311 dbus_uid_t uid; /**< User owning file */
312 dbus_gid_t gid; /**< Group owning file */
313 unsigned long size; /**< Size of file */
314 unsigned long atime; /**< Access time */
315 unsigned long mtime; /**< Modify time */
316 unsigned long ctime; /**< Creation time */
319 dbus_bool_t _dbus_stat (const DBusString *filename,
322 dbus_bool_t _dbus_full_duplex_pipe (int *fd1,
324 dbus_bool_t blocking,
327 void _dbus_print_backtrace (void);
329 dbus_bool_t _dbus_become_daemon (const DBusString *pidfile,
332 dbus_bool_t _dbus_write_pid_file (const DBusString *filename,
335 dbus_bool_t _dbus_change_identity (unsigned long uid,
339 typedef void (* DBusSignalHandler) (int sig);
341 void _dbus_set_signal_handler (int sig,
342 DBusSignalHandler handler);
344 dbus_bool_t _dbus_user_at_console (const char *username,
347 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
348 * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
350 #if !defined (DBUS_VA_COPY)
351 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
352 # define DBUS_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
353 # elif defined (DBUS_VA_COPY_AS_ARRAY)
354 # define DBUS_VA_COPY(ap1, ap2) memcpy ((ap1), (ap2), sizeof (va_list))
355 # else /* va_list is a pointer */
356 # define DBUS_VA_COPY(ap1, ap2) ((ap1) = (ap2))
357 # endif /* va_list is a pointer */
358 #endif /* !DBUS_VA_COPY */
360 /* On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
361 * or b in an 80-bit register, thus failing to compare the two 64-bit
362 * doubles for bitwise equality.
364 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
365 (((const char*)&(p))[(i)])
366 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b) \
367 (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) && \
368 _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) && \
369 _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) && \
370 _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) && \
371 _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) && \
372 _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) && \
373 _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) && \
374 _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
376 dbus_bool_t _dbus_parse_uid (const DBusString *uid_str,
381 #endif /* DBUS_SYSDEPS_H */