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