D-Bus  1.7.6
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);
93 char ** _dbus_get_environment (void);
94 
96 typedef unsigned long dbus_pid_t;
98 typedef unsigned long dbus_uid_t;
100 typedef unsigned long dbus_gid_t;
101 
103 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
104 
105 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
106 
107 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
108 
110 #define DBUS_PID_FORMAT "%lu"
111 
112 #define DBUS_UID_FORMAT "%lu"
113 
114 #define DBUS_GID_FORMAT "%lu"
115 
116 
128  DBusError *error);
129 int _dbus_read_socket (int fd,
130  DBusString *buffer,
131  int count);
132 int _dbus_write_socket (int fd,
133  const DBusString *buffer,
134  int start,
135  int len);
136 int _dbus_write_socket_two (int fd,
137  const DBusString *buffer1,
138  int start1,
139  int len1,
140  const DBusString *buffer2,
141  int start2,
142  int len2);
143 
145  DBusString *buffer,
146  int count,
147  int *fds,
148  int *n_fds);
149 int _dbus_write_socket_with_unix_fds (int fd,
150  const DBusString *buffer,
151  int start,
152  int len,
153  const int *fds,
154  int n_fds);
155 int _dbus_write_socket_with_unix_fds_two (int fd,
156  const DBusString *buffer1,
157  int start1,
158  int len1,
159  const DBusString *buffer2,
160  int start2,
161  int len2,
162  const int *fds,
163  int n_fds);
164 
165 dbus_bool_t _dbus_socket_is_invalid (int fd);
166 
167 int _dbus_connect_tcp_socket (const char *host,
168  const char *port,
169  const char *family,
170  DBusError *error);
171 int _dbus_connect_tcp_socket_with_nonce (const char *host,
172  const char *port,
173  const char *family,
174  const char *noncefile,
175  DBusError *error);
176 int _dbus_listen_tcp_socket (const char *host,
177  const char *port,
178  const char *family,
179  DBusString *retport,
180  int **fds_p,
181  DBusError *error);
182 int _dbus_accept (int listen_fd);
183 
184 
186  DBusCredentials *credentials,
187  DBusError *error);
189  DBusError *error);
190 
192  const DBusString *username);
195 
197  dbus_uid_t *uid_p);
199  dbus_gid_t *gid_p);
201  dbus_gid_t **group_ids,
202  int *n_group_ids);
204  DBusError *error);
206 dbus_bool_t _dbus_windows_user_is_process_owner (const char *windows_sid);
207 
209  DBusCredentials *credentials);
210 
211 dbus_bool_t _dbus_daemon_is_session_bus_address_published (const char *scope);
212 
213 dbus_bool_t _dbus_daemon_publish_session_bus_address (const char* address, const char* shm_name);
214 
215 void _dbus_daemon_unpublish_session_bus_address (void);
216 
218 
222 typedef struct DBusAtomic DBusAtomic;
223 
228 {
229 #ifdef DBUS_WIN
230  volatile long value;
231 #else
232  volatile dbus_int32_t value;
233 #endif
234 };
235 
236 /* The value we get from autofoo is in the form of a cpp expression;
237  * convert that to a conventional defined/undef switch. (We can't get
238  * the conventional defined/undef because of multiarch builds only running
239  * ./configure once, on Darwin.) */
240 #if DBUS_HAVE_ATOMIC_INT_COND
241 # define DBUS_HAVE_ATOMIC_INT 1
242 #else
243 # undef DBUS_HAVE_ATOMIC_INT
244 #endif
245 
246 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
247 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
248 dbus_int32_t _dbus_atomic_get (DBusAtomic *atomic);
249 
250 
251 /* AIX uses different values for poll */
252 
253 #ifdef _AIX
254 
255 #define _DBUS_POLLIN 0x0001
256 
257 #define _DBUS_POLLPRI 0x0004
258 
259 #define _DBUS_POLLOUT 0x0002
260 
261 #define _DBUS_POLLERR 0x4000
262 
263 #define _DBUS_POLLHUP 0x2000
264 
265 #define _DBUS_POLLNVAL 0x8000
266 #elif defined(__HAIKU__)
267 
268 #define _DBUS_POLLIN 0x0001
269 
270 #define _DBUS_POLLOUT 0x0002
271 
272 #define _DBUS_POLLERR 0x0004
273 
274 #define _DBUS_POLLPRI 0x0020
275 
276 #define _DBUS_POLLHUP 0x0080
277 
278 #define _DBUS_POLLNVAL 0x1000
279 #elif defined(__QNX__)
280 
281 #define _DBUS_POLLOUT 0x0002
282 
283 #define _DBUS_POLLIN 0x0005
284 
285 #define _DBUS_POLLPRI 0x0008
286 
287 #define _DBUS_POLLERR 0x0020
288 
289 #define _DBUS_POLLHUP 0x0040
290 
291 #define _DBUS_POLLNVAL 0x1000
292 #else
293 
294 #define _DBUS_POLLIN 0x0001
295 
296 #define _DBUS_POLLPRI 0x0002
297 
298 #define _DBUS_POLLOUT 0x0004
299 
300 #define _DBUS_POLLERR 0x0008
301 
302 #define _DBUS_POLLHUP 0x0010
303 
304 #define _DBUS_POLLNVAL 0x0020
305 #endif
306 
310 typedef struct
311 {
312  int fd;
313  short events;
314  short revents;
315 } DBusPollFD;
316 
317 int _dbus_poll (DBusPollFD *fds,
318  int n_fds,
319  int timeout_milliseconds);
320 
321 void _dbus_sleep_milliseconds (int milliseconds);
322 
323 void _dbus_get_monotonic_time (long *tv_sec,
324  long *tv_usec);
325 
326 void _dbus_get_real_time (long *tv_sec,
327  long *tv_usec);
328 
333  DBusError *error);
335  DBusError *error);
336 
338  const DBusString *next_component);
340  DBusString *dirname);
342 
345 
348 
350 typedef struct DBusDirIter DBusDirIter;
351 
353  DBusError *error);
355  DBusString *filename,
356  DBusError *error);
358 
360  DBusError *error);
361 
362 void _dbus_fd_set_close_on_exec (intptr_t fd);
363 
364 const char* _dbus_get_tmpdir (void);
365 
370  int n_bytes);
371 void _dbus_generate_random_bytes_buffer (char *buffer,
372  int n_bytes);
374  int n_bytes);
376  int n_bytes);
377 
378 const char* _dbus_error_from_errno (int error_number);
379 const char* _dbus_error_from_system_errno (void);
380 
381 void _dbus_set_errno_to_zero (void);
387 const char* _dbus_strerror_from_errno (void);
388 
389 void _dbus_disable_sigpipe (void);
390 
391 
392 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
393 
394 int _dbus_printf_string_upper_bound (const char *format,
395  va_list args);
396 
397 
401 typedef struct
402 {
403  unsigned long mode;
404  unsigned long nlink;
405  dbus_uid_t uid;
406  dbus_gid_t gid;
407  unsigned long size;
408  unsigned long atime;
409  unsigned long mtime;
410  unsigned long ctime;
411 } DBusStat;
412 
413 dbus_bool_t _dbus_stat (const DBusString *filename,
414  DBusStat *statbuf,
415  DBusError *error);
417  int *fd2,
418  dbus_bool_t blocking,
419  DBusError *error);
420 
421 void _dbus_print_backtrace (void);
422 
424  DBusPipe *print_pid_pipe,
425  DBusError *error,
426  dbus_bool_t keep_umask);
427 
428 dbus_bool_t _dbus_verify_daemon_user (const char *user);
429 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
430  DBusError *error);
431 
433  DBusPipe *print_pid_pipe,
434  dbus_pid_t pid_to_write,
435  DBusError *error);
436 
437 dbus_bool_t _dbus_command_for_pid (unsigned long pid,
438  DBusString *str,
439  int max_len,
440  DBusError *error);
441 
443 typedef void (* DBusSignalHandler) (int sig);
444 
445 void _dbus_set_signal_handler (int sig,
446  DBusSignalHandler handler);
447 
448 dbus_bool_t _dbus_user_at_console (const char *username,
449  DBusError *error);
450 
451 void _dbus_init_system_log (dbus_bool_t is_daemon);
452 
453 typedef enum {
454  DBUS_SYSTEM_LOG_INFO,
455  DBUS_SYSTEM_LOG_SECURITY,
456  DBUS_SYSTEM_LOG_FATAL
457 } DBusSystemLogSeverity;
458 
459 void _dbus_system_log (DBusSystemLogSeverity severity, const char *msg, ...) _DBUS_GNUC_PRINTF (2, 3);
460 void _dbus_system_logv (DBusSystemLogSeverity severity, const char *msg, va_list args);
461 
462 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
463  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
464  */
465 #if !defined (DBUS_VA_COPY)
466 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
467 # define DBUS_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
468 # elif defined (DBUS_VA_COPY_AS_ARRAY)
469 # define DBUS_VA_COPY(ap1, ap2) memcpy ((ap1), (ap2), sizeof (va_list))
470 # else /* va_list is a pointer */
471 # define DBUS_VA_COPY(ap1, ap2) ((ap1) = (ap2))
472 # endif /* va_list is a pointer */
473 #endif /* !DBUS_VA_COPY */
474 
475 
480 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
481  (((const char*)&(p))[(i)])
482 
487 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b) \
488  (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) && \
489  _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) && \
490  _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) && \
491  _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) && \
492  _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) && \
493  _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) && \
494  _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) && \
495  _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
496 
497 dbus_bool_t _dbus_get_autolaunch_address (const char *scope,
498  DBusString *address,
499  DBusError *error);
500 
502  DBusString *address,
503  DBusError *error);
504 
508 typedef union DBusGUID DBusGUID;
509 
511  dbus_bool_t create_if_not_found,
512  DBusError *error);
513 
520 
525 
530 
532  const char *suffix,
533  DBusList **dir_list);
534 
535 unsigned long _dbus_pid_for_log (void);
536 
537 /* FIXME move back to dbus-sysdeps-unix.h probably -
538  * the PID file handling just needs a little more abstraction
539  * in the bus daemon first.
540  */
541 dbus_pid_t _dbus_getpid (void);
542 
543 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
544  DBusError *error);
545 
546 void _dbus_flush_caches (void);
547 
548 void _dbus_request_file_descriptor_limit (unsigned int limit);
549 
550 /*
551  * replaces the term DBUS_PREFIX in configure_time_path by the
552  * current dbus installation directory. On unix this function is a noop
553  *
554  * @param configure_time_path
555  * @return real path
556  */
557 const char *
558 _dbus_replace_install_prefix (const char *configure_time_path);
559 
563 
564 
565 #ifdef DBUS_WIN
566 #include "dbus-sysdeps-win.h"
567 #endif
568 
569 #endif /* DBUS_SYSDEPS_H */