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