dbus/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 <dbus/dbus-errors.h>
  29 #include <dbus/dbus-file.h>
  30 #include <dbus/dbus-string.h>
  31 #include <dbus/dbus-pipe.h>
  32
  33 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
  34  * stuff straight out of string.h, so have this here for now.
  35  */
  36 #include <string.h>
  37 #include <stdarg.h>
  38
  39
  40 /* AIX sys/poll.h does #define events reqevents, and other
  41  * wonderousness, so must include sys/poll before declaring
  42  * DBusPollFD
  43  */
  44 #ifdef HAVE_POLL
  45 #include <sys/poll.h>
  46 #endif
  47
  48 #ifdef DBUS_WINCE
  49 /* Windows CE lacks some system functions (such as errno and clock).
  50    We bring them in here.  */
  51 #include "dbus-sysdeps-wince-glue.h"
  52 #endif
  53
  54 DBUS_BEGIN_DECLS
  55
  56 #ifdef DBUS_WIN
  57 #define _DBUS_PATH_SEPARATOR ";"
  58 #else
  59 #define _DBUS_PATH_SEPARATOR ":"
  60 #endif
  61
  62 /* Forward declarations */
  63
  64
  65 /** An opaque list type */
  66 typedef struct DBusList DBusList;
  67
  68 /** Object that contains a list of credentials such as UNIX or Windows user ID */
  69 typedef struct DBusCredentials DBusCredentials;
  70
  71 /**
  72  * @addtogroup DBusSysdeps
  73  *
  74  * @{
  75  */
  76
  77 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
  78
  79 const char* _dbus_getenv (const char *varname);
  80 dbus_bool_t _dbus_setenv (const char *varname,
  81                           const char *value);
  82 dbus_bool_t _dbus_clearenv (void);
  83 char **     _dbus_get_environment (void);
  84
  85 /** A process ID */
  86 typedef unsigned long dbus_pid_t;
  87 /** A user ID */
  88 typedef unsigned long dbus_uid_t;
  89 /** A group ID */
  90 typedef unsigned long dbus_gid_t;
  91
  92 /** an invalid PID used to represent an uninitialized dbus_pid_t field */
  93 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
  94 /** an invalid UID used to represent an uninitialized dbus_uid_t field */
  95 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
  96 /** an invalid GID used to represent an uninitialized dbus_gid_t field */
  97 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
  98
  99 /** an appropriate printf format for dbus_pid_t */
 100 #define DBUS_PID_FORMAT "%lu"
 101 /** an appropriate printf format for dbus_uid_t */
 102 #define DBUS_UID_FORMAT "%lu"
 103 /** an appropriate printf format for dbus_gid_t */
 104 #define DBUS_GID_FORMAT "%lu"
 105
 106
 107 /**
 108  * Socket interface
 109  *
 110  *  @todo Use for the file descriptors a struct
 111  *           - struct DBusSocket{ int d; }; -
 112  *        instead of int to get type-safety which
 113  *        will be checked by the compiler.
 114  *
 115  */
 116
 117 dbus_bool_t _dbus_open_tcp_socket  (int              *fd,
 118                                     DBusError        *error);
 119 dbus_bool_t _dbus_close_socket     (int               fd,
 120                                     DBusError        *error);
 121 int         _dbus_read_socket      (int               fd,
 122                                     DBusString       *buffer,
 123                                     int               count);
 124 int         _dbus_write_socket     (int               fd,
 125                                     const DBusString *buffer,
 126                                     int               start,
 127                                     int               len);
 128 int         _dbus_write_socket_two (int               fd,
 129                                     const DBusString *buffer1,
 130                                     int               start1,
 131                                     int               len1,
 132                                     const DBusString *buffer2,
 133                                     int               start2,
 134                                     int               len2);
 135
 136 int _dbus_read_socket_with_unix_fds      (int               fd,
 137                                           DBusString       *buffer,
 138                                           int               count,
 139                                           int              *fds,
 140                                           int              *n_fds);
 141 int _dbus_write_socket_with_unix_fds     (int               fd,
 142                                           const DBusString *buffer,
 143                                           int               start,
 144                                           int               len,
 145                                           const int        *fds,
 146                                           int               n_fds);
 147 int _dbus_write_socket_with_unix_fds_two (int               fd,
 148                                           const DBusString *buffer1,
 149                                           int               start1,
 150                                           int               len1,
 151                                           const DBusString *buffer2,
 152                                           int               start2,
 153                                           int               len2,
 154                                           const int        *fds,
 155                                           int               n_fds);
 156
 157 dbus_bool_t _dbus_socket_is_invalid (int              fd);
 158
 159 int _dbus_connect_tcp_socket  (const char     *host,
 160                                const char     *port,
 161                                const char     *family,
 162                                DBusError      *error);
 163 int _dbus_connect_tcp_socket_with_nonce  (const char     *host,
 164                                           const char     *port,
 165                                           const char     *family,
 166                                           const char     *noncefile,
 167                                           DBusError      *error);
 168 int _dbus_listen_tcp_socket   (const char     *host,
 169                                const char     *port,
 170                                const char     *family,
 171                                DBusString     *retport,
 172                                int           **fds_p,
 173                                DBusError      *error);
 174 int _dbus_accept              (int             listen_fd);
 175
 176
 177 dbus_bool_t _dbus_read_credentials_socket (int               client_fd,
 178                                            DBusCredentials  *credentials,
 179                                            DBusError        *error);
 180 dbus_bool_t _dbus_send_credentials_socket (int              server_fd,
 181                                            DBusError       *error);
 182
 183 dbus_bool_t _dbus_credentials_add_from_user            (DBusCredentials  *credentials,
 184                                                         const DBusString *username);
 185 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials  *credentials);
 186 dbus_bool_t _dbus_append_user_from_current_process     (DBusString        *str);
 187
 188 dbus_bool_t _dbus_parse_unix_user_from_config   (const DBusString  *username,
 189                                                  dbus_uid_t        *uid_p);
 190 dbus_bool_t _dbus_parse_unix_group_from_config  (const DBusString  *groupname,
 191                                                  dbus_gid_t        *gid_p);
 192 dbus_bool_t _dbus_unix_groups_from_uid          (dbus_uid_t         uid,
 193                                                  dbus_gid_t       **group_ids,
 194                                                  int               *n_group_ids);
 195 dbus_bool_t _dbus_unix_user_is_at_console       (dbus_uid_t         uid,
 196                                                  DBusError         *error);
 197 dbus_bool_t _dbus_unix_user_is_process_owner    (dbus_uid_t         uid);
 198 dbus_bool_t _dbus_windows_user_is_process_owner (const char        *windows_sid);
 199
 200 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString      *directory,
 201                                                             DBusCredentials *credentials);
 202
 203 void _dbus_daemon_publish_session_bus_address (const char* address);
 204
 205 void _dbus_daemon_unpublish_session_bus_address (void);
 206
 207 dbus_bool_t _dbus_socket_can_pass_unix_fd(int fd);
 208
 209 /** Opaque type representing an atomically-modifiable integer
 210  * that can be used from multiple threads.
 211  */
 212 typedef struct DBusAtomic DBusAtomic;
 213
 214 /**
 215  * An atomic integer safe to increment or decrement from multiple threads.
 216  */
 217 struct DBusAtomic
 218 {
 219 #ifdef DBUS_WIN
 220   volatile long value; /**< Value of the atomic integer. */
 221 #else
 222   volatile dbus_int32_t value; /**< Value of the atomic integer. */
 223 #endif
 224 };
 225
 226 /* The value we get from autofoo is in the form of a cpp expression;
 227  * convert that to a conventional defined/undef switch. (We can't get
 228  * the conventional defined/undef because of multiarch builds only running
 229  * ./configure once, on Darwin.) */
 230 #if DBUS_HAVE_ATOMIC_INT_COND
 231 #   define DBUS_HAVE_ATOMIC_INT 1
 232 #else
 233 #   undef DBUS_HAVE_ATOMIC_INT
 234 #endif
 235
 236 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
 237 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
 238
 239
 240 /* AIX uses different values for poll */
 241
 242 #ifdef _AIX
 243 /** There is data to read */
 244 #define _DBUS_POLLIN      0x0001
 245 /** There is urgent data to read */
 246 #define _DBUS_POLLPRI     0x0004
 247 /** Writing now will not block */
 248 #define _DBUS_POLLOUT     0x0002
 249 /** Error condition */
 250 #define _DBUS_POLLERR     0x4000
 251 /** Hung up */
 252 #define _DBUS_POLLHUP     0x2000
 253 /** Invalid request: fd not open */
 254 #define _DBUS_POLLNVAL    0x8000
 255 #elif defined(__HAIKU__)
 256 /** There is data to read */
 257 #define _DBUS_POLLIN      0x0001
 258 /** Writing now will not block */
 259 #define _DBUS_POLLOUT     0x0002
 260 /** Error condition */
 261 #define _DBUS_POLLERR     0x0004
 262 /** There is urgent data to read */
 263 #define _DBUS_POLLPRI     0x0020
 264 /** Hung up */
 265 #define _DBUS_POLLHUP     0x0080
 266 /** Invalid request: fd not open */
 267 #define _DBUS_POLLNVAL    0x1000
 268 #else
 269 /** There is data to read */
 270 #define _DBUS_POLLIN      0x0001
 271 /** There is urgent data to read */
 272 #define _DBUS_POLLPRI     0x0002
 273 /** Writing now will not block */
 274 #define _DBUS_POLLOUT     0x0004
 275 /** Error condition */
 276 #define _DBUS_POLLERR     0x0008
 277 /** Hung up */
 278 #define _DBUS_POLLHUP     0x0010
 279 /** Invalid request: fd not open */
 280 #define _DBUS_POLLNVAL    0x0020
 281 #endif
 282
 283 /**
 284  * A portable struct pollfd wrapper.
 285  */
 286 typedef struct
 287 {
 288   int fd;            /**< File descriptor */
 289   short events;      /**< Events to poll for */
 290   short revents;     /**< Events that occurred */
 291 } DBusPollFD;
 292
 293 int _dbus_poll (DBusPollFD *fds,
 294                 int         n_fds,
 295                 int         timeout_milliseconds);
 296
 297 void _dbus_sleep_milliseconds (int milliseconds);
 298
 299 void _dbus_get_current_time (long *tv_sec,
 300                              long *tv_usec);
 301
 302 /**
 303  * directory interface
 304  */
 305 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
 306                                               DBusError        *error);
 307 dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
 308                                               DBusError        *error);
 309
 310 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
 311                                        const DBusString *next_component);
 312 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
 313                                        DBusString       *dirname);
 314 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
 315
 316 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
 317 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs);
 318
 319 dbus_bool_t _dbus_append_system_config_file  (DBusString *str);
 320 dbus_bool_t _dbus_append_session_config_file (DBusString *str);
 321
 322 /** Opaque type for reading a directory listing */
 323 typedef struct DBusDirIter DBusDirIter;
 324
 325 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
 326                                             DBusError        *error);
 327 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
 328                                             DBusString       *filename,
 329                                             DBusError        *error);
 330 void         _dbus_directory_close         (DBusDirIter      *iter);
 331
 332 dbus_bool_t  _dbus_check_dir_is_private_to_user    (DBusString *dir,
 333                                                     DBusError *error);
 334
 335 void _dbus_fd_set_close_on_exec (int fd);
 336
 337 const char* _dbus_get_tmpdir      (void);
 338
 339 /**
 340  * Random numbers
 341  */
 342 void        _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
 343                                                       int   n_bytes);
 344 void        _dbus_generate_random_bytes_buffer (char       *buffer,
 345                                                 int         n_bytes);
 346 dbus_bool_t _dbus_generate_random_bytes        (DBusString *str,
 347                                                 int         n_bytes);
 348 dbus_bool_t _dbus_generate_random_ascii        (DBusString *str,
 349                                                 int         n_bytes);
 350
 351 const char* _dbus_error_from_errno (int error_number);
 352 const char* _dbus_error_from_system_errno (void);
 353
 354 void        _dbus_set_errno_to_zero                  (void);
 355 dbus_bool_t _dbus_get_is_errno_nonzero               (void);
 356 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void);
 357 dbus_bool_t _dbus_get_is_errno_enomem                (void);
 358 dbus_bool_t _dbus_get_is_errno_eintr                 (void);
 359 dbus_bool_t _dbus_get_is_errno_epipe                 (void);
 360 const char* _dbus_strerror_from_errno                (void);
 361
 362 void _dbus_disable_sigpipe (void);
 363
 364
 365 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
 366
 367 int _dbus_printf_string_upper_bound (const char *format,
 368                                      va_list args);
 369
 370
 371 /**
 372  * Portable struct with stat() results
 373  */
 374 typedef struct
 375 {
 376   unsigned long mode;  /**< File mode */
 377   unsigned long nlink; /**< Number of hard links */
 378   dbus_uid_t    uid;   /**< User owning file */
 379   dbus_gid_t    gid;   /**< Group owning file */
 380   unsigned long size;  /**< Size of file */
 381   unsigned long atime; /**< Access time */
 382   unsigned long mtime; /**< Modify time */
 383   unsigned long ctime; /**< Creation time */
 384 } DBusStat;
 385
 386 dbus_bool_t _dbus_stat             (const DBusString *filename,
 387                                     DBusStat         *statbuf,
 388                                     DBusError        *error);
 389 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
 390                                     int              *fd2,
 391                                     dbus_bool_t       blocking,
 392                                     DBusError        *error);
 393
 394 void        _dbus_print_backtrace  (void);
 395
 396 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
 397                                    DBusPipe         *print_pid_pipe,
 398                                    DBusError        *error,
 399                                    dbus_bool_t       keep_umask);
 400
 401 dbus_bool_t _dbus_verify_daemon_user    (const char *user);
 402 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
 403                                          DBusError  *error);
 404
 405 dbus_bool_t _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile,
 406                                               DBusPipe         *print_pid_pipe,
 407                                               dbus_pid_t        pid_to_write,
 408                                               DBusError        *error);
 409
 410 dbus_bool_t _dbus_command_for_pid (unsigned long  pid,
 411                                    DBusString    *str,
 412                                    int            max_len,
 413                                    DBusError     *error);
 414
 415 /** A UNIX signal handler */
 416 typedef void (* DBusSignalHandler) (int sig);
 417
 418 void _dbus_set_signal_handler (int               sig,
 419                                DBusSignalHandler handler);
 420
 421 dbus_bool_t _dbus_user_at_console (const char *username,
 422                                    DBusError  *error);
 423
 424 void _dbus_init_system_log (void);
 425
 426 typedef enum {
 427   DBUS_SYSTEM_LOG_INFO,
 428   DBUS_SYSTEM_LOG_SECURITY,
 429   DBUS_SYSTEM_LOG_FATAL
 430 } DBusSystemLogSeverity;
 431
 432 void _dbus_system_log (DBusSystemLogSeverity severity, const char *msg, ...) _DBUS_GNUC_PRINTF (2, 3);
 433 void _dbus_system_logv (DBusSystemLogSeverity severity, const char *msg, va_list args);
 434
 435 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
 436  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
 437  */
 438 #if !defined (DBUS_VA_COPY)
 439 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
 440 #    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
 441 #  elif defined (DBUS_VA_COPY_AS_ARRAY)
 442 #    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
 443 #  else /* va_list is a pointer */
 444 #    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
 445 #  endif /* va_list is a pointer */
 446 #endif /* !DBUS_VA_COPY */
 447
 448
 449 /**
 450  * Casts a primitive C type to a byte array and then indexes
 451  * a particular byte of the array.
 452  */
 453 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
 454     (((const char*)&(p))[(i)])
 455 /** On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
 456  * or b in an 80-bit register, thus failing to compare the two 64-bit
 457  * doubles for bitwise equality. So this macro compares the two doubles
 458  * bitwise.
 459  */
 460 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b)                                       \
 461      (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) &&       \
 462       _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) &&       \
 463       _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) &&       \
 464       _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) &&       \
 465       _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) &&       \
 466       _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) &&       \
 467       _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) &&       \
 468       _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
 469
 470 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address,
 471                                           DBusError *error);
 472
 473 dbus_bool_t _dbus_lookup_session_address (dbus_bool_t *supported,
 474                                           DBusString  *address,
 475                                           DBusError   *error);
 476
 477 /** Type representing a universally unique ID
 478  * @todo rename to UUID instead of GUID
 479  */
 480 typedef union DBusGUID DBusGUID;
 481
 482 dbus_bool_t _dbus_read_local_machine_uuid   (DBusGUID         *machine_id,
 483                                              dbus_bool_t       create_if_not_found,
 484                                              DBusError        *error);
 485
 486 /**
 487  * Initialize threads as in dbus_threads_init_default(), appropriately
 488  * for the platform.
 489  * @returns #FALSE if no memory
 490  */
 491 dbus_bool_t _dbus_threads_init_platform_specific (void);
 492
 493 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs,
 494                                           const char *suffix,
 495                                           DBusList **dir_list);
 496
 497 unsigned long _dbus_pid_for_log (void);
 498
 499 /* FIXME move back to dbus-sysdeps-unix.h probably -
 500  * the PID file handling just needs a little more abstraction
 501  * in the bus daemon first.
 502  */
 503 dbus_pid_t    _dbus_getpid (void);
 504
 505 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
 506                                          DBusError  *error);
 507
 508 void _dbus_flush_caches (void);
 509
 510 /** @} */
 511
 512 DBUS_END_DECLS
 513
 514 #endif /* DBUS_SYSDEPS_H */