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