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