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