D-Bus  1.6.28
dbus-sysdeps.h
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)
3  *
4  * Copyright (C) 2002, 2003 Red Hat, Inc.
5  * Copyright (C) 2003 CodeFactory AB
6  *
7  * Licensed under the Academic Free License version 2.1
8  *
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.
13  *
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.
18  *
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  *
23  */
24 
25 #ifndef DBUS_SYSDEPS_H
26 #define DBUS_SYSDEPS_H
27 
28 #include "config.h"
29 
30 #ifdef HAVE_STDINT_H
31 #include <stdint.h>
32 #endif
33 
34 #ifdef HAVE_INTTYPES_H
35 #include <inttypes.h>
36 #endif
37 
38 #include <dbus/dbus-errors.h>
39 #include <dbus/dbus-file.h>
40 #include <dbus/dbus-string.h>
41 
42 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
43  * stuff straight out of string.h, so have this here for now.
44  */
45 #include <string.h>
46 #include <stdarg.h>
47 
48 /* AIX sys/poll.h does #define events reqevents, and other
49  * wonderousness, so must include sys/poll before declaring
50  * DBusPollFD
51  */
52 #ifdef HAVE_POLL
53 #include <sys/poll.h>
54 #endif
55 
56 #ifdef DBUS_WINCE
57 /* Windows CE lacks some system functions (such as errno and clock).
58  We bring them in here. */
59 #include "dbus-sysdeps-wince-glue.h"
60 #endif
61 
63 
64 #ifdef DBUS_WIN
65 #define _DBUS_PATH_SEPARATOR ";"
66 #else
67 #define _DBUS_PATH_SEPARATOR ":"
68 #endif
69 
70 /* Forward declarations */
71 
72 
74 typedef struct DBusList DBusList;
75 
77 typedef struct DBusCredentials DBusCredentials;
78 
80 typedef struct DBusPipe DBusPipe;
81 
88 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
89 
91 const char* _dbus_getenv (const char *varname);
92 dbus_bool_t _dbus_setenv (const char *varname,
93  const char *value);
95 char ** _dbus_get_environment (void);
96 
98 typedef unsigned long dbus_pid_t;
100 typedef unsigned long dbus_uid_t;
102 typedef unsigned long dbus_gid_t;
103 
105 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
106 
107 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
108 
109 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
110 
112 #define DBUS_PID_FORMAT "%lu"
113 
114 #define DBUS_UID_FORMAT "%lu"
115 
116 #define DBUS_GID_FORMAT "%lu"
117 
118 
130  DBusError *error);
131 int _dbus_read_socket (int fd,
132  DBusString *buffer,
133  int count);
134 int _dbus_write_socket (int fd,
135  const DBusString *buffer,
136  int start,
137  int len);
138 int _dbus_write_socket_two (int fd,
139  const DBusString *buffer1,
140  int start1,
141  int len1,
142  const DBusString *buffer2,
143  int start2,
144  int len2);
145 
147  DBusString *buffer,
148  int count,
149  int *fds,
150  int *n_fds);
151 int _dbus_write_socket_with_unix_fds (int fd,
152  const DBusString *buffer,
153  int start,
154  int len,
155  const int *fds,
156  int n_fds);
157 int _dbus_write_socket_with_unix_fds_two (int fd,
158  const DBusString *buffer1,
159  int start1,
160  int len1,
161  const DBusString *buffer2,
162  int start2,
163  int len2,
164  const int *fds,
165  int n_fds);
166 
167 dbus_bool_t _dbus_socket_is_invalid (int fd);
168 
169 int _dbus_connect_tcp_socket (const char *host,
170  const char *port,
171  const char *family,
172  DBusError *error);
173 int _dbus_connect_tcp_socket_with_nonce (const char *host,
174  const char *port,
175  const char *family,
176  const char *noncefile,
177  DBusError *error);
178 int _dbus_listen_tcp_socket (const char *host,
179  const char *port,
180  const char *family,
181  DBusString *retport,
182  int **fds_p,
183  DBusError *error);
184 int _dbus_accept (int listen_fd);
185 
186 
188  DBusCredentials *credentials,
189  DBusError *error);
191  DBusError *error);
192 
194  const DBusString *username);
197 
199  dbus_uid_t *uid_p);
201  dbus_gid_t *gid_p);
203  dbus_gid_t **group_ids,
204  int *n_group_ids);
206  DBusError *error);
208 dbus_bool_t _dbus_windows_user_is_process_owner (const char *windows_sid);
209 
211  DBusCredentials *credentials);
212 
213 dbus_bool_t _dbus_daemon_is_session_bus_address_published (const char *scope);
214 
215 dbus_bool_t _dbus_daemon_publish_session_bus_address (const char* address, const char* shm_name);
216 
217 void _dbus_daemon_unpublish_session_bus_address (void);
218 
220 
224 typedef struct DBusAtomic DBusAtomic;
225 
230 {
231 #ifdef DBUS_WIN
232  volatile long value;
233 #else
234  volatile dbus_int32_t value;
235 #endif
236 };
237 
238 /* The value we get from autofoo is in the form of a cpp expression;
239  * convert that to a conventional defined/undef switch. (We can't get
240  * the conventional defined/undef because of multiarch builds only running
241  * ./configure once, on Darwin.) */
242 #if DBUS_HAVE_ATOMIC_INT_COND
243 # define DBUS_HAVE_ATOMIC_INT 1
244 #else
245 # undef DBUS_HAVE_ATOMIC_INT
246 #endif
247 
251 
252 
253 /* AIX uses different values for poll */
254 
255 #ifdef _AIX
256 
257 #define _DBUS_POLLIN 0x0001
258 
259 #define _DBUS_POLLPRI 0x0004
260 
261 #define _DBUS_POLLOUT 0x0002
262 
263 #define _DBUS_POLLERR 0x4000
264 
265 #define _DBUS_POLLHUP 0x2000
266 
267 #define _DBUS_POLLNVAL 0x8000
268 #elif defined(__HAIKU__)
269 
270 #define _DBUS_POLLIN 0x0001
271 
272 #define _DBUS_POLLOUT 0x0002
273 
274 #define _DBUS_POLLERR 0x0004
275 
276 #define _DBUS_POLLPRI 0x0020
277 
278 #define _DBUS_POLLHUP 0x0080
279 
280 #define _DBUS_POLLNVAL 0x1000
281 #else
282 
283 #define _DBUS_POLLIN 0x0001
284 
285 #define _DBUS_POLLPRI 0x0002
286 
287 #define _DBUS_POLLOUT 0x0004
288 
289 #define _DBUS_POLLERR 0x0008
290 
291 #define _DBUS_POLLHUP 0x0010
292 
293 #define _DBUS_POLLNVAL 0x0020
294 #endif
295 
299 typedef struct
300 {
301  int fd;
302  short events;
303  short revents;
304 } DBusPollFD;
305 
306 int _dbus_poll (DBusPollFD *fds,
307  int n_fds,
308  int timeout_milliseconds);
309 
310 void _dbus_sleep_milliseconds (int milliseconds);
311 
312 void _dbus_get_monotonic_time (long *tv_sec,
313  long *tv_usec);
314 
315 void _dbus_get_real_time (long *tv_sec,
316  long *tv_usec);
317 
322  DBusError *error);
324  DBusError *error);
325 
327  const DBusString *next_component);
329  DBusString *dirname);
331 
334 
337 
339 typedef struct DBusDirIter DBusDirIter;
340 
342  DBusError *error);
344  DBusString *filename,
345  DBusError *error);
347 
349  DBusError *error);
350 
351 void _dbus_fd_set_close_on_exec (intptr_t fd);
352 
353 const char* _dbus_get_tmpdir (void);
354 
359  int n_bytes);
360 void _dbus_generate_random_bytes_buffer (char *buffer,
361  int n_bytes);
363  int n_bytes);
365  int n_bytes);
366 
367 const char* _dbus_error_from_errno (int error_number);
368 const char* _dbus_error_from_system_errno (void);
369 
370 void _dbus_set_errno_to_zero (void);
377 const char* _dbus_strerror_from_errno (void);
378 
379 void _dbus_disable_sigpipe (void);
380 
381 
382 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
383 
384 int _dbus_printf_string_upper_bound (const char *format,
385  va_list args);
386 
387 
391 typedef struct
392 {
393  unsigned long mode;
394  unsigned long nlink;
395  dbus_uid_t uid;
396  dbus_gid_t gid;
397  unsigned long size;
398  unsigned long atime;
399  unsigned long mtime;
400  unsigned long ctime;
401 } DBusStat;
402 
403 dbus_bool_t _dbus_stat (const DBusString *filename,
404  DBusStat *statbuf,
405  DBusError *error);
407  int *fd2,
408  dbus_bool_t blocking,
409  DBusError *error);
410 
411 void _dbus_print_backtrace (void);
412 
414  DBusPipe *print_pid_pipe,
415  DBusError *error,
416  dbus_bool_t keep_umask);
417 
418 dbus_bool_t _dbus_verify_daemon_user (const char *user);
419 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
420  DBusError *error);
421 
423  DBusPipe *print_pid_pipe,
424  dbus_pid_t pid_to_write,
425  DBusError *error);
426 
427 dbus_bool_t _dbus_command_for_pid (unsigned long pid,
428  DBusString *str,
429  int max_len,
430  DBusError *error);
431 
433 typedef void (* DBusSignalHandler) (int sig);
434 
435 void _dbus_set_signal_handler (int sig,
436  DBusSignalHandler handler);
437 
438 dbus_bool_t _dbus_user_at_console (const char *username,
439  DBusError *error);
440 
441 void _dbus_init_system_log (void);
442 
443 typedef enum {
444  DBUS_SYSTEM_LOG_INFO,
445  DBUS_SYSTEM_LOG_SECURITY,
446  DBUS_SYSTEM_LOG_FATAL
447 } DBusSystemLogSeverity;
448 
449 void _dbus_system_log (DBusSystemLogSeverity severity, const char *msg, ...) _DBUS_GNUC_PRINTF (2, 3);
450 void _dbus_system_logv (DBusSystemLogSeverity severity, const char *msg, va_list args);
451 
452 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
453  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
454  */
455 #if !defined (DBUS_VA_COPY)
456 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
457 # define DBUS_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
458 # elif defined (DBUS_VA_COPY_AS_ARRAY)
459 # define DBUS_VA_COPY(ap1, ap2) memcpy ((ap1), (ap2), sizeof (va_list))
460 # else /* va_list is a pointer */
461 # define DBUS_VA_COPY(ap1, ap2) ((ap1) = (ap2))
462 # endif /* va_list is a pointer */
463 #endif /* !DBUS_VA_COPY */
464 
465 
470 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
471  (((const char*)&(p))[(i)])
472 
477 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b) \
478  (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) && \
479  _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) && \
480  _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) && \
481  _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) && \
482  _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) && \
483  _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) && \
484  _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) && \
485  _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
486 
487 dbus_bool_t _dbus_get_autolaunch_address (const char *scope,
488  DBusString *address,
489  DBusError *error);
490 
492  DBusString *address,
493  DBusError *error);
494 
498 typedef union DBusGUID DBusGUID;
499 
501  dbus_bool_t create_if_not_found,
502  DBusError *error);
503 
510 
512  const char *suffix,
513  DBusList **dir_list);
514 
515 unsigned long _dbus_pid_for_log (void);
516 
517 /* FIXME move back to dbus-sysdeps-unix.h probably -
518  * the PID file handling just needs a little more abstraction
519  * in the bus daemon first.
520  */
521 dbus_pid_t _dbus_getpid (void);
522 
523 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
524  DBusError *error);
525 
526 void _dbus_flush_caches (void);
527 
528 /*
529  * replaces the term DBUS_PREFIX in configure_time_path by the
530  * current dbus installation directory. On unix this function is a noop
531  *
532  * @param configure_time_path
533  * @return real path
534  */
535 const char *
536 _dbus_replace_install_prefix (const char *configure_time_path);
537 
538 /* Do not set this too high: it is a denial-of-service risk.
539  * See <https://bugs.freedesktop.org/show_bug.cgi?id=82820>
540  *
541  * (This needs to be in the non-Unix-specific header so that
542  * the config-parser can use it.)
543  */
544 #define DBUS_DEFAULT_MESSAGE_UNIX_FDS 16
545 
546 typedef struct DBusRLimit DBusRLimit;
547 
548 DBusRLimit *_dbus_rlimit_save_fd_limit (DBusError *error);
549 dbus_bool_t _dbus_rlimit_raise_fd_limit_if_privileged (unsigned int desired,
550  DBusError *error);
551 dbus_bool_t _dbus_rlimit_restore_fd_limit (DBusRLimit *saved,
552  DBusError *error);
553 void _dbus_rlimit_free (DBusRLimit *lim);
554 
558 
559 
560 #ifdef DBUS_WIN
561 #include "dbus-sysdeps-win.h"
562 #endif
563 
564 #endif /* DBUS_SYSDEPS_H */