D-Bus: dbus-sysdeps.h Source File

D-Bus 1.10.22

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 #ifndef VERSION
29 #warning Please include config.h before dbus-sysdeps.h
30 #include "config.h"
31 #endif
32
33 #ifdef HAVE_STDINT_H
34 #include <stdint.h>
35 #endif
36
37 #ifdef HAVE_INTTYPES_H
38 #include <inttypes.h>
39 #endif
40
41 #include <dbus/dbus-errors.h>
42 #include <dbus/dbus-file.h>
43 #include <dbus/dbus-string.h>
44
45 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
46 * stuff straight out of string.h, so have this here for now.
47 */
48 #include <string.h>
49 #include <stdarg.h>
50
51 /* AIX sys/poll.h does #define events reqevents, and other
52 * wonderousness, so must include sys/poll before declaring
53 * DBusPollFD
54 */
55 #ifdef HAVE_POLL
56 #include <sys/poll.h>
57 #endif
58
59 #ifdef DBUS_WINCE
60 /* Windows CE lacks some system functions (such as errno and clock).
61 We bring them in here. */
62 #include "dbus-sysdeps-wince-glue.h"
63 #endif
64
65 #ifdef DBUS_WIN
66 #include <ws2tcpip.h>
67 #endif
68
69 DBUS_BEGIN_DECLS
70
71 #ifdef DBUS_WIN
72 #define _DBUS_PATH_SEPARATOR ";"
73 #else
74 #define _DBUS_PATH_SEPARATOR ":"
75 #endif
76
77 /* Forward declarations */
78
79
81 typedef struct DBusList DBusList;
82
84 typedef struct DBusCredentials DBusCredentials;
85
87 typedef struct DBusPipe DBusPipe;
88
95 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
96
97 dbus_bool_t _dbus_check_setuid (void);
98 DBUS_PRIVATE_EXPORT
99 const char* _dbus_getenv (const char *varname);
100 DBUS_PRIVATE_EXPORT
101 dbus_bool_t _dbus_clearenv (void);
102 char ** _dbus_get_environment (void);
103
105 typedef unsigned long dbus_pid_t;
107 typedef unsigned long dbus_uid_t;
109 typedef unsigned long dbus_gid_t;
110
112 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
113
114 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
115
116 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
117
119 #define DBUS_PID_FORMAT "%lu"
120
121 #define DBUS_UID_FORMAT "%lu"
122
123 #define DBUS_GID_FORMAT "%lu"
124
128 #ifdef DBUS_WIN
129
130 typedef struct { SOCKET sock; } DBusSocket;
131 # define DBUS_SOCKET_FORMAT "Iu"
132 # define DBUS_SOCKET_INIT { INVALID_SOCKET }
133
134 static inline SOCKET
135 _dbus_socket_printable (DBusSocket s) { return s.sock; }
136
137 static inline dbus_bool_t
138 _dbus_socket_is_valid (DBusSocket s) { return s.sock != INVALID_SOCKET; }
139
140 static inline void
141 _dbus_socket_invalidate (DBusSocket *s) { s->sock = INVALID_SOCKET; }
142
143 static inline int
144 _dbus_socket_get_int (DBusSocket s) { return (int)s.sock; }
145
146 #else /* not DBUS_WIN */
147
148 typedef struct { int fd; } DBusSocket;
149 # define DBUS_SOCKET_FORMAT "d"
150 # define DBUS_SOCKET_INIT { -1 }
151
152 static inline int
153 _dbus_socket_printable (DBusSocket s) { return s.fd; }
154
155 static inline dbus_bool_t
156 _dbus_socket_is_valid (DBusSocket s) { return s.fd >= 0; }
157
158 static inline void
159 _dbus_socket_invalidate (DBusSocket *s) { s->fd = -1; }
160
161 static inline int
162 _dbus_socket_get_int (DBusSocket s) { return s.fd; }
163
164 #endif /* not DBUS_WIN */
165
166 static inline DBusSocket
167 _dbus_socket_get_invalid (void)
168 {
169 DBusSocket s = DBUS_SOCKET_INIT;
170
171 return s;
172 }
173
174 dbus_bool_t _dbus_set_socket_nonblocking (DBusSocket fd,
175 DBusError *error);
176
177 DBUS_PRIVATE_EXPORT
178 dbus_bool_t _dbus_close_socket (DBusSocket fd,
179 DBusError *error);
180 DBUS_PRIVATE_EXPORT
181 int _dbus_read_socket (DBusSocket fd,
182 DBusString *buffer,
183 int count);
184 DBUS_PRIVATE_EXPORT
185 int _dbus_write_socket (DBusSocket fd,
186 const DBusString *buffer,
187 int start,
188 int len);
189 int _dbus_write_socket_two (DBusSocket fd,
190 const DBusString *buffer1,
191 int start1,
192 int len1,
193 const DBusString *buffer2,
194 int start2,
195 int len2);
196
197 int _dbus_read_socket_with_unix_fds (DBusSocket fd,
198 DBusString *buffer,
199 int count,
200 int *fds,
201 int *n_fds);
202 DBUS_PRIVATE_EXPORT
203 int _dbus_write_socket_with_unix_fds (DBusSocket fd,
204 const DBusString *buffer,
205 int start,
206 int len,
207 const int *fds,
208 int n_fds);
209 int _dbus_write_socket_with_unix_fds_two (DBusSocket fd,
210 const DBusString *buffer1,
211 int start1,
212 int len1,
213 const DBusString *buffer2,
214 int start2,
215 int len2,
216 const int *fds,
217 int n_fds);
218
219 DBusSocket _dbus_connect_tcp_socket (const char *host,
220 const char *port,
221 const char *family,
222 DBusError *error);
223 DBusSocket _dbus_connect_tcp_socket_with_nonce (const char *host,
224 const char *port,
225 const char *family,
226 const char *noncefile,
227 DBusError *error);
228 int _dbus_listen_tcp_socket (const char *host,
229 const char *port,
230 const char *family,
231 DBusString *retport,
232 DBusSocket **fds_p,
233 DBusError *error);
234 DBusSocket _dbus_accept (DBusSocket listen_fd);
235
236 dbus_bool_t _dbus_read_credentials_socket (DBusSocket client_fd,
237 DBusCredentials *credentials,
238 DBusError *error);
239 dbus_bool_t _dbus_send_credentials_socket (DBusSocket server_fd,
240 DBusError *error);
241
242 dbus_bool_t _dbus_credentials_add_from_user (DBusCredentials *credentials,
243 const DBusString *username);
244 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials *credentials);
245 DBUS_PRIVATE_EXPORT
246 dbus_bool_t _dbus_append_user_from_current_process (DBusString *str);
247
248 dbus_bool_t _dbus_parse_unix_user_from_config (const DBusString *username,
249 dbus_uid_t *uid_p);
250 dbus_bool_t _dbus_parse_unix_group_from_config (const DBusString *groupname,
251 dbus_gid_t *gid_p);
252 dbus_bool_t _dbus_unix_groups_from_uid (dbus_uid_t uid,
253 dbus_gid_t **group_ids,
254 int *n_group_ids);
255 dbus_bool_t _dbus_unix_user_is_at_console (dbus_uid_t uid,
256 DBusError *error);
257 dbus_bool_t _dbus_unix_user_is_process_owner (dbus_uid_t uid);
258 dbus_bool_t _dbus_windows_user_is_process_owner (const char *windows_sid);
259
260 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString *directory,
261 DBusCredentials *credentials);
262
263 dbus_bool_t _dbus_daemon_is_session_bus_address_published (const char *scope);
264
265 dbus_bool_t _dbus_daemon_publish_session_bus_address (const char* address, const char* shm_name);
266
267 void _dbus_daemon_unpublish_session_bus_address (void);
268
269 dbus_bool_t _dbus_socket_can_pass_unix_fd(DBusSocket fd);
270
274 typedef struct DBusAtomic DBusAtomic;
275
279 struct DBusAtomic
280 {
281 #ifdef DBUS_WIN
282 volatile long value;
283 #else
284 volatile dbus_int32_t value;
285 #endif
286 };
287
288 /* The value we get from autofoo is in the form of a cpp expression;
289 * convert that to a conventional defined/undef switch. (We can't get
290 * the conventional defined/undef because of multiarch builds only running
291 * ./configure once, on Darwin.) */
292 #if DBUS_HAVE_ATOMIC_INT_COND
293 # define DBUS_HAVE_ATOMIC_INT 1
294 #else
295 # undef DBUS_HAVE_ATOMIC_INT
296 #endif
297
298 DBUS_PRIVATE_EXPORT
299 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
300 DBUS_PRIVATE_EXPORT
301 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
302 DBUS_PRIVATE_EXPORT
303 dbus_int32_t _dbus_atomic_get (DBusAtomic *atomic);
304
305 #ifdef DBUS_WIN
306
307 /* On Windows, you can only poll sockets. We emulate Unix poll() using
308 * select(), so it doesn't matter what precise type we put in DBusPollFD;
309 * use DBusSocket so that the compiler can check we are doing it right.
310 */
311 typedef DBusSocket DBusPollable;
312 # define DBUS_POLLABLE_FORMAT "Iu"
313
314 static inline DBusPollable
315 _dbus_socket_get_pollable (DBusSocket s) { return s; }
316
317 static inline SOCKET
318 _dbus_pollable_printable (DBusPollable p) { return p.sock; }
319
320 static inline dbus_bool_t
321 _dbus_pollable_is_valid (DBusPollable p) { return _dbus_socket_is_valid (p); }
322
323 static inline void
324 _dbus_pollable_invalidate (DBusPollable *p) { _dbus_socket_invalidate (p); }
325
326 static inline dbus_bool_t
327 _dbus_pollable_equals (DBusPollable a, DBusPollable b) { return a.sock == b.sock; }
328
329 #else /* !DBUS_WIN */
330
331 /* On Unix, you can poll sockets, pipes, etc., and we must put exactly
332 * "int" in DBusPollFD because we're relying on its layout exactly matching
333 * struct pollfd. (This is silly, and one day we should use a better
334 * abstraction.)
335 */
336 typedef int DBusPollable;
337 # define DBUS_POLLABLE_FORMAT "d"
338
339 static inline DBusPollable
340 _dbus_socket_get_pollable (DBusSocket s) { return s.fd; }
341
342 static inline int
343 _dbus_pollable_printable (DBusPollable p) { return p; }
344
345 static inline dbus_bool_t
346 _dbus_pollable_is_valid (DBusPollable p) { return p >= 0; }
347
348 static inline void
349 _dbus_pollable_invalidate (DBusPollable *p) { *p = -1; }
350
351 static inline dbus_bool_t
352 _dbus_pollable_equals (DBusPollable a, DBusPollable b) { return a == b; }
353
354 #endif /* !DBUS_WIN */
355
356 #if defined(HAVE_POLL) && !defined(BROKEN_POLL)
357
361 typedef struct pollfd DBusPollFD;
362
364 #define _DBUS_POLLIN POLLIN
365
366 #define _DBUS_POLLPRI POLLPRI
367
368 #define _DBUS_POLLOUT POLLOUT
369
370 #define _DBUS_POLLERR POLLERR
371
372 #define _DBUS_POLLHUP POLLHUP
373
374 #define _DBUS_POLLNVAL POLLNVAL
375 #else
376 /* Emulate poll() via select(). Because we aren't really going to call
377 * poll(), any similarly-shaped struct is acceptable, and any power of 2
378 * will do for the events/revents; these values happen to match Linux
379 * and *BSD. */
380 typedef struct
381 {
382 DBusPollable fd;
383 short events;
384 short revents;
385 } DBusPollFD;
386
388 #define _DBUS_POLLIN 0x0001
389
390 #define _DBUS_POLLPRI 0x0002
391
392 #define _DBUS_POLLOUT 0x0004
393
394 #define _DBUS_POLLERR 0x0008
395
396 #define _DBUS_POLLHUP 0x0010
397
398 #define _DBUS_POLLNVAL 0x0020
399 #endif
400
401 DBUS_PRIVATE_EXPORT
402 int _dbus_poll (DBusPollFD *fds,
403 int n_fds,
404 int timeout_milliseconds);
405
406 DBUS_PRIVATE_EXPORT
407 void _dbus_sleep_milliseconds (int milliseconds);
408
409 DBUS_PRIVATE_EXPORT
410 void _dbus_get_monotonic_time (long *tv_sec,
411 long *tv_usec);
412
413 DBUS_PRIVATE_EXPORT
414 void _dbus_get_real_time (long *tv_sec,
415 long *tv_usec);
416
420 DBUS_PRIVATE_EXPORT
421 dbus_bool_t _dbus_create_directory (const DBusString *filename,
422 DBusError *error);
423 DBUS_PRIVATE_EXPORT
424 dbus_bool_t _dbus_ensure_directory (const DBusString *filename,
425 DBusError *error);
426 DBUS_PRIVATE_EXPORT
427 dbus_bool_t _dbus_delete_directory (const DBusString *filename,
428 DBusError *error);
429
430 DBUS_PRIVATE_EXPORT
431 dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir,
432 const DBusString *next_component);
433 dbus_bool_t _dbus_string_get_dirname (const DBusString *filename,
434 DBusString *dirname);
435 DBUS_PRIVATE_EXPORT
436 dbus_bool_t _dbus_path_is_absolute (const DBusString *filename);
437
438 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
439 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs);
440
441 dbus_bool_t _dbus_append_system_config_file (DBusString *str);
442 dbus_bool_t _dbus_append_session_config_file (DBusString *str);
443
445 typedef struct DBusDirIter DBusDirIter;
446
447 DBusDirIter* _dbus_directory_open (const DBusString *filename,
448 DBusError *error);
449 dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter,
450 DBusString *filename,
451 DBusError *error);
452 void _dbus_directory_close (DBusDirIter *iter);
453
454 dbus_bool_t _dbus_check_dir_is_private_to_user (DBusString *dir,
455 DBusError *error);
456
457 DBUS_PRIVATE_EXPORT
458 const char* _dbus_get_tmpdir (void);
459
463 _DBUS_GNUC_WARN_UNUSED_RESULT
464 dbus_bool_t _dbus_generate_random_bytes_buffer (char *buffer,
465 int n_bytes,
466 DBusError *error);
467 dbus_bool_t _dbus_generate_random_bytes (DBusString *str,
468 int n_bytes,
469 DBusError *error);
470 DBUS_PRIVATE_EXPORT
471 dbus_bool_t _dbus_generate_random_ascii (DBusString *str,
472 int n_bytes,
473 DBusError *error);
474
475 DBUS_PRIVATE_EXPORT
476 const char* _dbus_error_from_errno (int error_number);
477 DBUS_PRIVATE_EXPORT
478 const char* _dbus_error_from_system_errno (void);
479
480 int _dbus_save_socket_errno (void);
481 void _dbus_restore_socket_errno (int saved_errno);
482 void _dbus_set_errno_to_zero (void);
483 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (int e);
484 dbus_bool_t _dbus_get_is_errno_enomem (int e);
485 dbus_bool_t _dbus_get_is_errno_eintr (int e);
486 dbus_bool_t _dbus_get_is_errno_epipe (int e);
487 dbus_bool_t _dbus_get_is_errno_etoomanyrefs (int e);
488 DBUS_PRIVATE_EXPORT
489 const char* _dbus_strerror_from_errno (void);
490
491 void _dbus_disable_sigpipe (void);
492
493 DBUS_PRIVATE_EXPORT
494 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
495
496 DBUS_PRIVATE_EXPORT
497 int _dbus_printf_string_upper_bound (const char *format,
498 va_list args);
499
500
504 typedef struct
505 {
506 unsigned long mode;
507 unsigned long nlink;
508 dbus_uid_t uid;
509 dbus_gid_t gid;
510 unsigned long size;
511 unsigned long atime;
512 unsigned long mtime;
513 unsigned long ctime;
514 } DBusStat;
515
516 dbus_bool_t _dbus_stat (const DBusString *filename,
517 DBusStat *statbuf,
518 DBusError *error);
519 DBUS_PRIVATE_EXPORT
520 dbus_bool_t _dbus_socketpair (DBusSocket *fd1,
521 DBusSocket *fd2,
522 dbus_bool_t blocking,
523 DBusError *error);
524
525 void _dbus_print_backtrace (void);
526
527 dbus_bool_t _dbus_become_daemon (const DBusString *pidfile,
528 DBusPipe *print_pid_pipe,
529 DBusError *error,
530 dbus_bool_t keep_umask);
531
532 dbus_bool_t _dbus_verify_daemon_user (const char *user);
533 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
534 DBusError *error);
535
536 dbus_bool_t _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile,
537 DBusPipe *print_pid_pipe,
538 dbus_pid_t pid_to_write,
539 DBusError *error);
540
541 dbus_bool_t _dbus_command_for_pid (unsigned long pid,
542 DBusString *str,
543 int max_len,
544 DBusError *error);
545
547 typedef void (* DBusSignalHandler) (int sig);
548
549 void _dbus_set_signal_handler (int sig,
550 DBusSignalHandler handler);
551
552 dbus_bool_t _dbus_user_at_console (const char *username,
553 DBusError *error);
554
555 void _dbus_init_system_log (dbus_bool_t is_daemon);
556
557 typedef enum {
558 DBUS_SYSTEM_LOG_INFO,
559 DBUS_SYSTEM_LOG_WARNING,
560 DBUS_SYSTEM_LOG_SECURITY,
561 DBUS_SYSTEM_LOG_FATAL
562 } DBusSystemLogSeverity;
563
564 void _dbus_system_log (DBusSystemLogSeverity severity, const char *msg, ...) _DBUS_GNUC_PRINTF (2, 3);
565 void _dbus_system_logv (DBusSystemLogSeverity severity, const char *msg, va_list args);
566
567 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
568 * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
569 */
570 #if !defined (DBUS_VA_COPY)
571 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
572 # define DBUS_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
573 # elif defined (DBUS_VA_COPY_AS_ARRAY)
574 # define DBUS_VA_COPY(ap1, ap2) memcpy ((ap1), (ap2), sizeof (va_list))
575 # else /* va_list is a pointer */
576 # define DBUS_VA_COPY(ap1, ap2) ((ap1) = (ap2))
577 # endif /* va_list is a pointer */
578 #endif /* !DBUS_VA_COPY */
579
580
585 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
586 (((const char*)&(p))[(i)])
587
592 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b) \
593 (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) && \
594 _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) && \
595 _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) && \
596 _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) && \
597 _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) && \
598 _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) && \
599 _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) && \
600 _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
601
602 dbus_bool_t _dbus_get_autolaunch_address (const char *scope,
603 DBusString *address,
604 DBusError *error);
605
606 dbus_bool_t _dbus_lookup_session_address (dbus_bool_t *supported,
607 DBusString *address,
608 DBusError *error);
609
613 typedef union DBusGUID DBusGUID;
614
615 dbus_bool_t _dbus_read_local_machine_uuid (DBusGUID *machine_id,
616 dbus_bool_t create_if_not_found,
617 DBusError *error);
618
624 dbus_bool_t _dbus_threads_init_platform_specific (void);
625
629 void _dbus_threads_lock_platform_specific (void);
630
634 void _dbus_threads_unlock_platform_specific (void);
635
636 DBUS_PRIVATE_EXPORT
637 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs,
638 const char *suffix,
639 DBusList **dir_list);
640
641 unsigned long _dbus_pid_for_log (void);
642
643 /* FIXME move back to dbus-sysdeps-unix.h probably -
644 * the PID file handling just needs a little more abstraction
645 * in the bus daemon first.
646 */
647 DBUS_PRIVATE_EXPORT
648 dbus_pid_t _dbus_getpid (void);
649
650 DBUS_PRIVATE_EXPORT
651 dbus_uid_t _dbus_getuid (void);
652
653 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
654 DBusError *error);
655
656 DBUS_PRIVATE_EXPORT
657 void _dbus_flush_caches (void);
658
659 /*
660 * replaces the term DBUS_PREFIX in configure_time_path by the
661 * current dbus installation directory. On unix this function is a noop
662 *
663 * @param configure_time_path
664 * @return real path
665 */
666 const char *
667 _dbus_replace_install_prefix (const char *configure_time_path);
668
669 /* Do not set this too high: it is a denial-of-service risk.
670 * See <https://bugs.freedesktop.org/show_bug.cgi?id=82820>
671 *
672 * (This needs to be in the non-Unix-specific header so that
673 * the config-parser can use it.)
674 */
675 #define DBUS_DEFAULT_MESSAGE_UNIX_FDS 16
676
677 typedef struct DBusRLimit DBusRLimit;
678
679 DBusRLimit *_dbus_rlimit_save_fd_limit (DBusError *error);
680 dbus_bool_t _dbus_rlimit_raise_fd_limit_if_privileged (unsigned int desired,
681 DBusError *error);
682 dbus_bool_t _dbus_rlimit_restore_fd_limit (DBusRLimit *saved,
683 DBusError *error);
684 void _dbus_rlimit_free (DBusRLimit *lim);
685
688 DBUS_END_DECLS
689
690
691 #ifdef DBUS_WIN
692 #include "dbus-sysdeps-win.h"
693 #endif
694
695 #endif /* DBUS_SYSDEPS_H */
DBusAtomic
An atomic integer safe to increment or decrement from multiple threads.
Definition: dbus-sysdeps.h:279
_dbus_split_paths_and_append
dbus_bool_t _dbus_split_paths_and_append(DBusString *dirs, const char *suffix, DBusList **dir_list)
Split paths into a list of char strings.
Definition: dbus-sysdeps.c:226
DBusCredentials
Definition: dbus-credentials.c:48
_dbus_append_system_config_file
dbus_bool_t _dbus_append_system_config_file(DBusString *str)
Append the absolute path of the system.conf file (there is no system bus on Windows so this can just ...
Definition: dbus-sysdeps-util-unix.c:1435
DBusAtomic::value
volatile dbus_int32_t value
Value of the atomic integer.
Definition: dbus-sysdeps.h:284
_dbus_check_dir_is_private_to_user
dbus_bool_t _dbus_check_dir_is_private_to_user(DBusString *dir, DBusError *error)
Checks to make sure the given directory is private to the user.
Definition: dbus-sysdeps-unix.c:2275
_dbus_get_is_errno_enomem
dbus_bool_t _dbus_get_is_errno_enomem(int e)
See if errno is ENOMEM.
Definition: dbus-sysdeps.c:705
_dbus_ensure_directory
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_ensure_directory(const DBusString *filename, DBusError *error)
Creates a directory; succeeds if the directory is created or already existed.
Definition: dbus-sysdeps-unix.c:2956
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
_dbus_socketpair
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_socketpair(DBusSocket *fd1, DBusSocket *fd2, dbus_bool_t blocking, DBusError *error)
Creates pair of connect sockets (as in socketpair()).
Definition: dbus-sysdeps-unix.c:3370
DBusStat
Portable struct with stat() results.
Definition: dbus-sysdeps.h:504
_dbus_parse_unix_group_from_config
dbus_bool_t _dbus_parse_unix_group_from_config(const DBusString *groupname, dbus_gid_t *gid_p)
Parse a UNIX group from the bus config file.
Definition: dbus-sysdeps-util-unix.c:1051
_dbus_path_is_absolute
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_path_is_absolute(const DBusString *filename)
Checks whether the filename is an absolute path.
Definition: dbus-sysdeps-util-unix.c:689
DBusStat::atime
unsigned long atime
Access time.
Definition: dbus-sysdeps.h:511
_dbus_check_setuid
dbus_bool_t _dbus_check_setuid(void)
NOTE: If you modify this function, please also consider making the corresponding change in GLib...
Definition: dbus-sysdeps-unix.c:4407
_dbus_threads_init_platform_specific
dbus_bool_t _dbus_threads_init_platform_specific(void)
Initialize threads as in dbus_threads_init_default(), appropriately for the platform.
Definition: dbus-sysdeps-pthread.c:278
_dbus_get_standard_session_servicedirs
dbus_bool_t _dbus_get_standard_session_servicedirs(DBusList **dirs)
Returns the standard directories for a session bus to look for service activation files...
Definition: dbus-sysdeps-util-unix.c:1309
DBusPollFD
Definition: dbus-sysdeps.h:380
DBusGUID
A globally unique ID ; we have one for each DBusServer, and also one for each machine with libdbus in...
Definition: dbus-internals.h:390
_dbus_getpid
DBUS_PRIVATE_EXPORT dbus_pid_t _dbus_getpid(void)
Gets our process ID.
Definition: dbus-sysdeps-unix.c:2662
_dbus_concat_dir_and_file
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_concat_dir_and_file(DBusString *dir, const DBusString *next_component)
Appends the given filename to the given directory.
Definition: dbus-sysdeps-unix.c:3019
_dbus_read_socket
DBUS_PRIVATE_EXPORT int _dbus_read_socket(DBusSocket fd, DBusString *buffer, int count)
Like _dbus_read(), but only works on sockets so is available on Windows.
Definition: dbus-sysdeps-unix.c:299
_dbus_command_for_pid
dbus_bool_t _dbus_command_for_pid(unsigned long pid, DBusString *str, int max_len, DBusError *error)
Get a printable string describing the command used to execute the process with pid.
Definition: dbus-sysdeps-util-unix.c:1208
DBusPollFD::events
short events
Events to poll for.
Definition: dbus-sysdeps.h:383
_dbus_send_credentials_socket
dbus_bool_t _dbus_send_credentials_socket(DBusSocket server_fd, DBusError *error)
Sends a single nul byte with our UNIX credentials as ancillary data.
Definition: dbus-sysdeps-unix.c:2199
_dbus_close_socket
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_close_socket(DBusSocket fd, DBusError *error)
Closes a socket.
Definition: dbus-sysdeps-unix.c:283
DBusSignalHandler
void(* DBusSignalHandler)(int sig)
A UNIX signal handler.
Definition: dbus-sysdeps.h:547
_dbus_abort
void _dbus_abort(void)
Aborts the program with SIGABRT (dumping core).
Definition: dbus-sysdeps.c:77
_dbus_get_autolaunch_address
dbus_bool_t _dbus_get_autolaunch_address(const char *scope, DBusString *address, DBusError *error)
Returns the address of a new session bus.
Definition: dbus-sysdeps-unix.c:3769
_dbus_clearenv
dbus_bool_t _dbus_clearenv(void)
Wrapper for clearenv().
Definition: dbus-sysdeps.c:201
DBusDirIter
Internals of directory iterator.
Definition: dbus-sysdeps-util-unix.c:740
_dbus_user_at_console
dbus_bool_t _dbus_user_at_console(const char *username, DBusError *error)
Checks if user is at the console.
Definition: dbus-sysdeps-util-unix.c:645
DBusStat::mode
unsigned long mode
File mode.
Definition: dbus-sysdeps.h:506
_dbus_read_socket_with_unix_fds
int _dbus_read_socket_with_unix_fds(DBusSocket fd, DBusString *buffer, int count, int *fds, int *n_fds)
Like _dbus_read_socket() but also tries to read unix fds from the socket.
Definition: dbus-sysdeps-unix.c:355
dbus_pid_t
unsigned long dbus_pid_t
A process ID.
Definition: dbus-sysdeps.h:105
DBusSocket
Socket interface.
Definition: dbus-sysdeps.h:148
_dbus_threads_unlock_platform_specific
void _dbus_threads_unlock_platform_specific(void)
Undo _dbus_threads_lock_platform_specific().
Definition: dbus-sysdeps-pthread.c:299
_dbus_append_user_from_current_process
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_append_user_from_current_process(DBusString *str)
Append to the string the identity we would like to have when we authenticate, on UNIX this is the cur...
Definition: dbus-sysdeps-unix.c:2651
_dbus_threads_lock_platform_specific
void _dbus_threads_lock_platform_specific(void)
Lock a static mutex used to protect _dbus_threads_init_platform_specific().
Definition: dbus-sysdeps-pthread.c:293
DBusStat::gid
dbus_gid_t gid
Group owning file.
Definition: dbus-sysdeps.h:509
DBusPipe
Definition: dbus-pipe.h:41
DBusString
Definition: dbus-string.h:42
_dbus_get_is_errno_eagain_or_ewouldblock
dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock(int e)
See if errno is EAGAIN or EWOULDBLOCK (this has to be done differently for Winsock so is abstracted) ...
Definition: dbus-sysdeps-unix.c:4267
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
_dbus_write_pid_to_file_and_pipe
dbus_bool_t _dbus_write_pid_to_file_and_pipe(const DBusString *pidfile, DBusPipe *print_pid_pipe, dbus_pid_t pid_to_write, DBusError *error)
Writes the given pid_to_write to a pidfile (if non-NULL) and/or to a pipe (if non-NULL).
Definition: dbus-sysdeps-util-unix.c:238
_dbus_write_socket_two
int _dbus_write_socket_two(DBusSocket fd, const DBusString *buffer1, int start1, int len1, const DBusString *buffer2, int start2, int len2)
Like _dbus_write_two() but only works on sockets and is thus available on Windows.
Definition: dbus-sysdeps-unix.c:628
_dbus_accept
DBusSocket _dbus_accept(DBusSocket listen_fd)
Accepts a connection on a listening socket.
Definition: dbus-sysdeps-unix.c:2220
_dbus_atomic_inc
DBUS_PRIVATE_EXPORT dbus_int32_t _dbus_atomic_inc(DBusAtomic *atomic)
Atomically increments an integer.
Definition: dbus-sysdeps-unix.c:2753
_dbus_change_to_daemon_user
dbus_bool_t _dbus_change_to_daemon_user(const char *user, DBusError *error)
Changes the user and group the bus is running as.
Definition: dbus-sysdeps-util-unix.c:332
_dbus_append_keyring_directory_for_credentials
dbus_bool_t _dbus_append_keyring_directory_for_credentials(DBusString *directory, DBusCredentials *credentials)
Appends the directory in which a keyring for the given credentials should be stored.
Definition: dbus-sysdeps-unix.c:4180
_dbus_read_credentials_socket
dbus_bool_t _dbus_read_credentials_socket(DBusSocket client_fd, DBusCredentials *credentials, DBusError *error)
Reads a single byte which must be nul (an error occurs otherwise), and reads unix credentials if avai...
Definition: dbus-sysdeps-unix.c:1886
_dbus_create_directory
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_create_directory(const DBusString *filename, DBusError *error)
directory interface
Definition: dbus-sysdeps-unix.c:2988
_dbus_verify_daemon_user
dbus_bool_t _dbus_verify_daemon_user(const char *user)
Verify that after the fork we can successfully change to this user.
Definition: dbus-sysdeps-util-unix.c:312
_dbus_delete_directory
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_delete_directory(const DBusString *filename, DBusError *error)
Removes a directory; Directory must be empty.
Definition: dbus-sysdeps-unix.c:4280
DBusError
Object representing an exception.
Definition: dbus-errors.h:48
_dbus_set_signal_handler
void _dbus_set_signal_handler(int sig, DBusSignalHandler handler)
Installs a UNIX signal handler.
Definition: dbus-sysdeps-util-unix.c:614
_dbus_get_monotonic_time
DBUS_PRIVATE_EXPORT void _dbus_get_monotonic_time(long *tv_sec, long *tv_usec)
Get current time, as in gettimeofday().
Definition: dbus-sysdeps-unix.c:2903
_dbus_listen_tcp_socket
int _dbus_listen_tcp_socket(const char *host, const char *port, const char *family, DBusString *retport, DBusSocket **fds_p, DBusError *error)
Creates a socket and binds it to the given path, then listens on the socket.
Definition: dbus-sysdeps-unix.c:1460
_dbus_disable_sigpipe
void _dbus_disable_sigpipe(void)
signal (SIGPIPE, SIG_IGN);
Definition: dbus-sysdeps-unix.c:3178
_dbus_stat
dbus_bool_t _dbus_stat(const DBusString *filename, DBusStat *statbuf, DBusError *error)
stat() wrapper.
Definition: dbus-sysdeps-util-unix.c:706
_dbus_unix_user_is_process_owner
dbus_bool_t _dbus_unix_user_is_process_owner(dbus_uid_t uid)
Checks to see if the UNIX user ID matches the UID of the process.
Definition: dbus-sysdeps-util-unix.c:1100
_dbus_error_from_system_errno
DBUS_PRIVATE_EXPORT const char * _dbus_error_from_system_errno(void)
Converts the current system errno value into a DBusError name.
Definition: dbus-sysdeps.c:682
_dbus_unix_user_is_at_console
dbus_bool_t _dbus_unix_user_is_at_console(dbus_uid_t uid, DBusError *error)
Checks to see if the UNIX user ID is at the console.
Definition: dbus-sysdeps-util-unix.c:1085
_dbus_string_get_dirname
dbus_bool_t _dbus_string_get_dirname(const DBusString *filename, DBusString *dirname)
Get the directory name from a complete filename.
Definition: dbus-sysdeps-util-unix.c:1132
_dbus_windows_user_is_process_owner
dbus_bool_t _dbus_windows_user_is_process_owner(const char *windows_sid)
Checks to see if the Windows user SID matches the owner of the process.
Definition: dbus-sysdeps-util-unix.c:1113
_dbus_system_logv
void _dbus_system_logv(DBusSystemLogSeverity severity, const char *msg, va_list args)
Log a message to the system log file (e.g.
Definition: dbus-sysdeps-util-unix.c:565
DBusStat::ctime
unsigned long ctime
Creation time.
Definition: dbus-sysdeps.h:513
_dbus_flush_caches
DBUS_PRIVATE_EXPORT void _dbus_flush_caches(void)
Called when the bus daemon is signaled to reload its configuration; any caches should be nuked...
Definition: dbus-sysdeps-unix.c:4161
_dbus_get_tmpdir
DBUS_PRIVATE_EXPORT const char * _dbus_get_tmpdir(void)
Gets the temporary files directory by inspecting the environment variables TMPDIR, TMP, and TEMP in that order.
Definition: dbus-sysdeps-unix.c:3515
_dbus_credentials_add_from_current_process
dbus_bool_t _dbus_credentials_add_from_current_process(DBusCredentials *credentials)
Adds the credentials of the current process to the passed-in credentials object.
Definition: dbus-sysdeps-unix.c:2621
DBusStat::nlink
unsigned long nlink
Number of hard links.
Definition: dbus-sysdeps.h:507
DBusPollFD::fd
DBusPollable fd
File descriptor.
Definition: dbus-sysdeps.h:382
_dbus_generate_random_bytes_buffer
_DBUS_GNUC_WARN_UNUSED_RESULT dbus_bool_t _dbus_generate_random_bytes_buffer(char *buffer, int n_bytes, DBusError *error)
Random numbers.
Definition: dbus-sysdeps.c:516
DBusStat::uid
dbus_uid_t uid
User owning file.
Definition: dbus-sysdeps.h:508
_dbus_become_daemon
dbus_bool_t _dbus_become_daemon(const DBusString *pidfile, DBusPipe *print_pid_pipe, DBusError *error, dbus_bool_t keep_umask)
Does the chdir, fork, setsid, etc.
Definition: dbus-sysdeps-util-unix.c:85
_dbus_system_log
void _dbus_system_log(DBusSystemLogSeverity severity, const char *msg,...)
Log a message to the system log file (e.g.
Definition: dbus-sysdeps-util-unix.c:543
_dbus_generate_random_ascii
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_generate_random_ascii(DBusString *str, int n_bytes, DBusError *error)
Generates the given number of random bytes, where the bytes are chosen from the alphanumeric ASCII su...
Definition: dbus-sysdeps.c:550
_dbus_exit
DBUS_PRIVATE_EXPORT void _dbus_exit(int code) _DBUS_GNUC_NORETURN
Exit the process, returning the given value.
Definition: dbus-sysdeps-unix.c:3149
_dbus_pid_for_log
unsigned long _dbus_pid_for_log(void)
The only reason this is separate from _dbus_getpid() is to allow it on Windows for logging but not fo...
Definition: dbus-sysdeps-unix.c:2692
_dbus_directory_close
void _dbus_directory_close(DBusDirIter *iter)
Closes a directory iteration.
Definition: dbus-sysdeps-util-unix.c:850
_dbus_strerror_from_errno
DBUS_PRIVATE_EXPORT const char * _dbus_strerror_from_errno(void)
Get error message from errno.
Definition: dbus-sysdeps.c:749
_dbus_connect_tcp_socket
DBusSocket _dbus_connect_tcp_socket(const char *host, const char *port, const char *family, DBusError *error)
Creates a socket and connects to a socket at the given host and port.
Definition: dbus-sysdeps-unix.c:1335
_dbus_atomic_dec
DBUS_PRIVATE_EXPORT dbus_int32_t _dbus_atomic_dec(DBusAtomic *atomic)
Atomically decrement an integer.
Definition: dbus-sysdeps-unix.c:2776
_dbus_parse_unix_user_from_config
dbus_bool_t _dbus_parse_unix_user_from_config(const DBusString *username, dbus_uid_t *uid_p)
Parse a UNIX user from the bus config file.
Definition: dbus-sysdeps-util-unix.c:1035
DBusList
A node in a linked list.
Definition: dbus-list.h:34
_dbus_getuid
DBUS_PRIVATE_EXPORT dbus_uid_t _dbus_getuid(void)
Gets our UID.
Definition: dbus-sysdeps-unix.c:2671
_dbus_generate_random_bytes
dbus_bool_t _dbus_generate_random_bytes(DBusString *str, int n_bytes, DBusError *error)
Generates the given number of securely random bytes, using the best mechanism we can come up with...
Definition: dbus-sysdeps-unix.c:3094
_dbus_set_socket_nonblocking
dbus_bool_t _dbus_set_socket_nonblocking(DBusSocket fd, DBusError *error)
Sets a file descriptor to be nonblocking.
Definition: dbus-sysdeps-unix.c:3283
_dbus_get_environment
char ** _dbus_get_environment(void)
Gets a NULL-terminated list of key=value pairs from the environment.
Definition: dbus-sysdeps-util.c:49
_dbus_get_is_errno_epipe
dbus_bool_t _dbus_get_is_errno_epipe(int e)
See if errno is EPIPE.
Definition: dbus-sysdeps.c:725
_dbus_lookup_session_address
dbus_bool_t _dbus_lookup_session_address(dbus_bool_t *supported, DBusString *address, DBusError *error)
Determines the address of the session bus by querying a platform-specific method. ...
Definition: dbus-sysdeps-unix.c:4129
_dbus_read_local_machine_uuid
dbus_bool_t _dbus_read_local_machine_uuid(DBusGUID *machine_id, dbus_bool_t create_if_not_found, DBusError *error)
Reads the uuid of the machine we&#39;re running on from the dbus configuration.
Definition: dbus-sysdeps-unix.c:3883
_dbus_unix_groups_from_uid
dbus_bool_t _dbus_unix_groups_from_uid(dbus_uid_t uid, dbus_gid_t **group_ids, int *n_group_ids)
Gets all groups corresponding to the given UNIX user ID.
Definition: dbus-sysdeps-util-unix.c:1068
_dbus_get_is_errno_eintr
dbus_bool_t _dbus_get_is_errno_eintr(int e)
See if errno is EINTR.
Definition: dbus-sysdeps.c:715
DBusStat::mtime
unsigned long mtime
Modify time.
Definition: dbus-sysdeps.h:512
_dbus_print_backtrace
void _dbus_print_backtrace(void)
On GNU libc systems, print a crude backtrace to stderr.
Definition: dbus-sysdeps-unix.c:3328
_dbus_write_socket
DBUS_PRIVATE_EXPORT int _dbus_write_socket(DBusSocket fd, const DBusString *buffer, int start, int len)
Like _dbus_write(), but only supports sockets and is thus available on Windows.
Definition: dbus-sysdeps-unix.c:317
_dbus_directory_open
DBusDirIter * _dbus_directory_open(const DBusString *filename, DBusError *error)
Open a directory to iterate over.
Definition: dbus-sysdeps-util-unix.c:754
_dbus_atomic_get
DBUS_PRIVATE_EXPORT dbus_int32_t _dbus_atomic_get(DBusAtomic *atomic)
Atomically get the value of an integer.
Definition: dbus-sysdeps-unix.c:2800
_dbus_sleep_milliseconds
DBUS_PRIVATE_EXPORT void _dbus_sleep_milliseconds(int milliseconds)
Sleeps the given number of milliseconds.
Definition: dbus-sysdeps-unix.c:3064
_dbus_error_from_errno
DBUS_PRIVATE_EXPORT const char * _dbus_error_from_errno(int error_number)
Converts a UNIX errno, or Windows errno or WinSock error value into a DBusError name.
Definition: dbus-sysdeps.c:590
dbus_gid_t
unsigned long dbus_gid_t
A group ID.
Definition: dbus-sysdeps.h:109
DBusStat::size
unsigned long size
Size of file.
Definition: dbus-sysdeps.h:510
_dbus_printf_string_upper_bound
DBUS_PRIVATE_EXPORT int _dbus_printf_string_upper_bound(const char *format, va_list args)
Measure the length of the given format string and arguments, not including the terminating nul...
Definition: dbus-sysdeps-unix.c:3445
_dbus_append_session_config_file
dbus_bool_t _dbus_append_session_config_file(DBusString *str)
Append the absolute path of the session.conf file.
Definition: dbus-sysdeps-util-unix.c:1447
_dbus_socket_can_pass_unix_fd
dbus_bool_t _dbus_socket_can_pass_unix_fd(DBusSocket fd)
Checks whether file descriptors may be passed via the socket.
Definition: dbus-sysdeps-unix.c:4308
_dbus_getenv
const char * _dbus_getenv(const char *varname)
Wrapper for getenv().
Definition: dbus-sysdeps.c:185
dbus_uid_t
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:107
_dbus_poll
DBUS_PRIVATE_EXPORT int _dbus_poll(DBusPollFD *fds, int n_fds, int timeout_milliseconds)
Wrapper for poll().
Definition: dbus-sysdeps-unix.c:2825
DBusPollFD::revents
short revents
Events that occurred.
Definition: dbus-sysdeps.h:384
_dbus_get_is_errno_etoomanyrefs
dbus_bool_t _dbus_get_is_errno_etoomanyrefs(int e)
See if errno is ETOOMANYREFS.
Definition: dbus-sysdeps.c:735
_dbus_set_errno_to_zero
void _dbus_set_errno_to_zero(void)
Assign 0 to the global errno variable.
Definition: dbus-sysdeps.c:691
_dbus_get_standard_system_servicedirs
dbus_bool_t _dbus_get_standard_system_servicedirs(DBusList **dirs)
Returns the standard directories for a system bus to look for service activation files.
Definition: dbus-sysdeps-util-unix.c:1401
_dbus_directory_get_next_file
dbus_bool_t _dbus_directory_get_next_file(DBusDirIter *iter, DBusString *filename, DBusError *error)
Get next file in the directory.
Definition: dbus-sysdeps-util-unix.c:802
_dbus_get_real_time
DBUS_PRIVATE_EXPORT void _dbus_get_real_time(long *tv_sec, long *tv_usec)
Get current time, as in gettimeofday().
Definition: dbus-sysdeps-unix.c:2934
_dbus_credentials_add_from_user
dbus_bool_t _dbus_credentials_add_from_user(DBusCredentials *credentials, const DBusString *username)
Adds the credentials corresponding to the given username.
Definition: dbus-sysdeps-win.c:2063
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.