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 1.2
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
28 #include <dbus/dbus-string.h>
29 #include <dbus/dbus-errors.h>
31 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
32 * stuff straight out of string.h, so have this here for now.
36 /* and it would just be annoying to abstract this */
41 /* The idea of this file is to encapsulate everywhere that we're
42 * relying on external libc features, for ease of security
43 * auditing. The idea is from vsftpd. This also gives us a chance to
44 * make things more convenient to use, e.g. by reading into a
45 * DBusString. Operating system headers aren't intended to be used
46 * outside of this file and a limited number of others (such as
50 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
51 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx ) \
52 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
53 #define _DBUS_GNUC_SCANF( format_idx, arg_idx ) \
54 __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
55 #define _DBUS_GNUC_FORMAT( arg_idx ) \
56 __attribute__((__format_arg__ (arg_idx)))
57 #define _DBUS_GNUC_NORETURN \
58 __attribute__((__noreturn__))
60 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
61 #define _DBUS_GNUC_SCANF( format_idx, arg_idx )
62 #define _DBUS_GNUC_FORMAT( arg_idx )
63 #define _DBUS_GNUC_NORETURN
64 #endif /* !__GNUC__ */
66 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
68 const char* _dbus_getenv (const char *varname);
69 dbus_bool_t _dbus_setenv (const char *varname,
72 int _dbus_read (int fd,
75 int _dbus_write (int fd,
76 const DBusString *buffer,
79 int _dbus_write_two (int fd,
80 const DBusString *buffer1,
83 const DBusString *buffer2,
87 typedef unsigned long dbus_pid_t;
88 typedef unsigned long dbus_uid_t;
89 typedef unsigned long dbus_gid_t;
91 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
92 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
93 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
95 #define DBUS_PID_FORMAT "%lu"
96 #define DBUS_UID_FORMAT "%lu"
97 #define DBUS_GID_FORMAT "%lu"
101 /* Set to DBUS_PID_UNSET etc. if not available */
107 int _dbus_connect_unix_socket (const char *path,
109 int _dbus_listen_unix_socket (const char *path,
111 int _dbus_connect_tcp_socket (const char *host,
114 int _dbus_listen_tcp_socket (const char *host,
117 int _dbus_accept (int listen_fd);
119 dbus_bool_t _dbus_read_credentials_unix_socket (int client_fd,
120 DBusCredentials *credentials,
122 dbus_bool_t _dbus_send_credentials_unix_socket (int server_fd,
126 void _dbus_credentials_clear (DBusCredentials *credentials);
127 void _dbus_credentials_from_current_process (DBusCredentials *credentials);
128 dbus_bool_t _dbus_credentials_match (const DBusCredentials *expected_credentials,
129 const DBusCredentials *provided_credentials);
132 typedef struct DBusUserInfo DBusUserInfo;
133 typedef struct DBusGroupInfo DBusGroupInfo;
137 dbus_uid_t uid; /**< UID */
138 dbus_gid_t primary_gid; /**< GID */
139 dbus_gid_t *group_ids; /**< Groups IDs, *including* above primary group */
140 int n_group_ids; /**< Size of group IDs array */
141 char *username; /**< Username */
142 char *homedir; /**< Home directory */
147 dbus_gid_t gid; /**< GID */
148 char *groupname; /**< Group name */
151 dbus_bool_t _dbus_user_info_fill (DBusUserInfo *info,
152 const DBusString *username,
154 dbus_bool_t _dbus_user_info_fill_uid (DBusUserInfo *info,
157 void _dbus_user_info_free (DBusUserInfo *info);
159 dbus_bool_t _dbus_group_info_fill (DBusGroupInfo *info,
160 const DBusString *groupname,
162 dbus_bool_t _dbus_group_info_fill_gid (DBusGroupInfo *info,
165 void _dbus_group_info_free (DBusGroupInfo *info);
168 unsigned long _dbus_getpid (void);
169 dbus_uid_t _dbus_getuid (void);
170 dbus_gid_t _dbus_getgid (void);
172 typedef int dbus_atomic_t;
174 dbus_atomic_t _dbus_atomic_inc (dbus_atomic_t *atomic);
175 dbus_atomic_t _dbus_atomic_dec (dbus_atomic_t *atomic);
177 #define _DBUS_POLLIN 0x0001 /* There is data to read */
178 #define _DBUS_POLLPRI 0x0002 /* There is urgent data to read */
179 #define _DBUS_POLLOUT 0x0004 /* Writing now will not block */
180 #define _DBUS_POLLERR 0x0008 /* Error condition */
181 #define _DBUS_POLLHUP 0x0010 /* Hung up */
182 #define _DBUS_POLLNVAL 0x0020 /* Invalid request: fd not open */
191 int _dbus_poll (DBusPollFD *fds,
193 int timeout_milliseconds);
195 void _dbus_sleep_milliseconds (int milliseconds);
197 void _dbus_get_current_time (long *tv_sec,
201 dbus_bool_t _dbus_file_get_contents (DBusString *str,
202 const DBusString *filename,
204 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
205 const DBusString *filename,
208 dbus_bool_t _dbus_create_file_exclusively (const DBusString *filename,
210 dbus_bool_t _dbus_delete_file (const DBusString *filename,
212 dbus_bool_t _dbus_create_directory (const DBusString *filename,
215 dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir,
216 const DBusString *next_component);
217 dbus_bool_t _dbus_string_get_dirname (const DBusString *filename,
218 DBusString *dirname);
219 dbus_bool_t _dbus_path_is_absolute (const DBusString *filename);
221 typedef struct DBusDirIter DBusDirIter;
223 DBusDirIter* _dbus_directory_open (const DBusString *filename,
225 dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter,
226 DBusString *filename,
228 void _dbus_directory_close (DBusDirIter *iter);
231 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
233 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
236 const char *_dbus_errno_to_string (int errnum);
237 const char* _dbus_error_from_errno (int error_number);
239 void _dbus_disable_sigpipe (void);
241 void _dbus_fd_set_close_on_exec (int fd);
243 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
257 dbus_bool_t _dbus_stat (const DBusString *filename,
260 dbus_bool_t _dbus_full_duplex_pipe (int *fd1,
262 dbus_bool_t blocking,
264 dbus_bool_t _dbus_close (int fd,
267 void _dbus_print_backtrace (void);
269 dbus_bool_t _dbus_become_daemon (const DBusString *pidfile,
271 dbus_bool_t _dbus_write_pid_file (const DBusString *filename,
274 dbus_bool_t _dbus_change_identity (unsigned long uid,
278 typedef void (* DBusSignalHandler) (int sig);
280 void _dbus_set_signal_handler (int sig,
281 DBusSignalHandler handler);
286 #endif /* DBUS_SYSDEPS_H */