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