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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  *
  23  */
  24
  25 #ifndef DBUS_SYSDEPS_H
  26 #define DBUS_SYSDEPS_H
  27
  28 #include <config.h>
  29
  30 #include <dbus/dbus-errors.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 DBUS_BEGIN_DECLS
  39
  40 #ifdef DBUS_WIN
  41 #define _DBUS_PATH_SEPARATOR ";"
  42 #else
  43 #define _DBUS_PATH_SEPARATOR ":"
  44 #endif
  45
  46 /* Forward declarations */
  47
  48 /** An opaque string type */
  49 typedef struct DBusString DBusString;
  50
  51 /** An opaque list type */
  52 typedef struct DBusList DBusList;
  53
  54 /** Object that contains a list of credentials such as UNIX or Windows user ID */
  55 typedef struct DBusCredentials DBusCredentials;
  56
  57 /**
  58  * @addtogroup DBusSysdeps
  59  *
  60  * @{
  61  */
  62
  63 /* The idea of this file is to encapsulate everywhere that we're
  64  * relying on external libc features, for ease of security
  65  * auditing. The idea is from vsftpd. This also gives us a chance to
  66  * make things more convenient to use, e.g.  by reading into a
  67  * DBusString. Operating system headers aren't intended to be used
  68  * outside of this file and a limited number of others (such as
  69  * dbus-memory.c)
  70  */
  71
  72 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
  73 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )    \
  74   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
  75 #define _DBUS_GNUC_NORETURN                         \
  76   __attribute__((__noreturn__))
  77 #else   /* !__GNUC__ */
  78 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
  79 #define _DBUS_GNUC_NORETURN
  80 #endif  /* !__GNUC__ */
  81
  82 /** @def _DBUS_GNUC_PRINTF
  83  * used to tell gcc about printf format strings
  84  */
  85 /** @def _DBUS_GNUC_NORETURN
  86  * used to tell gcc about functions that never return, such as _dbus_abort()
  87  */
  88
  89 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
  90
  91 const char* _dbus_getenv (const char *varname);
  92 dbus_bool_t _dbus_setenv (const char *varname,
  93                           const char *value);
  94 dbus_bool_t _dbus_clearenv (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 int _dbus_connect_tcp_socket  (const char     *host,
 147                                const char     *port,
 148                                const char     *family,
 149                                DBusError      *error);
 150 int _dbus_listen_tcp_socket   (const char     *host,
 151                                const char     *port,
 152                                const char     *family,
 153                                DBusString     *retport,
 154                                int           **fds_p,
 155                                DBusError      *error);
 156 int _dbus_accept              (int             listen_fd);
 157
 158
 159 dbus_bool_t _dbus_read_credentials_socket (int               client_fd,
 160                                            DBusCredentials  *credentials,
 161                                            DBusError        *error);
 162 dbus_bool_t _dbus_send_credentials_socket (int              server_fd,
 163                                            DBusError       *error);
 164
 165 dbus_bool_t _dbus_credentials_add_from_user            (DBusCredentials  *credentials,
 166                                                         const DBusString *username);
 167 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials  *credentials);
 168 dbus_bool_t _dbus_append_user_from_current_process     (DBusString        *str);
 169
 170 dbus_bool_t _dbus_parse_unix_user_from_config   (const DBusString  *username,
 171                                                  dbus_uid_t        *uid_p);
 172 dbus_bool_t _dbus_parse_unix_group_from_config  (const DBusString  *groupname,
 173                                                  dbus_gid_t        *gid_p);
 174 dbus_bool_t _dbus_unix_groups_from_uid          (dbus_uid_t         uid,
 175                                                  dbus_gid_t       **group_ids,
 176                                                  int               *n_group_ids);
 177 dbus_bool_t _dbus_unix_user_is_at_console       (dbus_uid_t         uid,
 178                                                  DBusError         *error);
 179 dbus_bool_t _dbus_unix_user_is_process_owner    (dbus_uid_t         uid);
 180 dbus_bool_t _dbus_windows_user_is_process_owner (const char        *windows_sid);
 181
 182 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString      *directory,
 183                                                             DBusCredentials *credentials);
 184
 185 /** Opaque type representing an atomically-modifiable integer
 186  * that can be used from multiple threads.
 187  */
 188 typedef struct DBusAtomic DBusAtomic;
 189
 190 /**
 191  * An atomic integer safe to increment or decrement from multiple threads.
 192  */
 193 struct DBusAtomic
 194 {
 195 #ifdef DBUS_WIN
 196   volatile long value; /**< Value of the atomic integer. */
 197 #else
 198   volatile dbus_int32_t value; /**< Value of the atomic integer. */
 199 #endif
 200 };
 201
 202 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
 203 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
 204
 205 /** There is data to read */
 206 #define _DBUS_POLLIN      0x0001
 207 /** There is urgent data to read */
 208 #define _DBUS_POLLPRI     0x0002
 209 /** Writing now will not block */
 210 #define _DBUS_POLLOUT     0x0004
 211 /** Error condition */
 212 #define _DBUS_POLLERR     0x0008
 213 /** Hung up */
 214 #define _DBUS_POLLHUP     0x0010
 215 /** Invalid request: fd not open */
 216 #define _DBUS_POLLNVAL    0x0020
 217
 218 /**
 219  * A portable struct pollfd wrapper.
 220  */
 221 typedef struct
 222 {
 223   int fd;            /**< File descriptor */
 224   short events;      /**< Events to poll for */
 225   short revents;     /**< Events that occurred */
 226 } DBusPollFD;
 227
 228 int _dbus_poll (DBusPollFD *fds,
 229                 int         n_fds,
 230                 int         timeout_milliseconds);
 231
 232 void _dbus_sleep_milliseconds (int milliseconds);
 233
 234 void _dbus_get_current_time (long *tv_sec,
 235                              long *tv_usec);
 236
 237 /**
 238  * File/directory interface
 239  */
 240 dbus_bool_t _dbus_file_exists         (const char       *file);
 241 dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
 242                                        const DBusString *filename,
 243                                        DBusError        *error);
 244 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
 245                                        const DBusString *filename,
 246                                        DBusError        *error);
 247
 248 dbus_bool_t _dbus_make_file_world_readable   (const DBusString *filename,
 249                                               DBusError *error);
 250
 251 dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
 252                                               DBusError        *error);
 253 dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
 254                                               DBusError        *error);
 255 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
 256                                               DBusError        *error);
 257 dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
 258                                               DBusError        *error);
 259
 260 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
 261                                        const DBusString *next_component);
 262 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
 263                                        DBusString       *dirname);
 264 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
 265
 266 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
 267 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs);
 268
 269 dbus_bool_t _dbus_append_system_config_file  (DBusString *str);
 270 dbus_bool_t _dbus_append_session_config_file (DBusString *str);
 271
 272 typedef struct {
 273   int fd_or_handle;
 274 } DBusPipe;
 275
 276 void        _dbus_pipe_init                (DBusPipe         *pipe,
 277                                             int               fd);
 278 void        _dbus_pipe_init_stdout         (DBusPipe         *pipe);
 279 int         _dbus_pipe_write               (DBusPipe         *pipe,
 280                                             const DBusString *buffer,
 281                                             int               start,
 282                                             int               len,
 283                                             DBusError        *error);
 284 int         _dbus_pipe_close               (DBusPipe         *pipe,
 285                                             DBusError        *error);
 286 dbus_bool_t _dbus_pipe_is_valid            (DBusPipe         *pipe);
 287 void        _dbus_pipe_invalidate          (DBusPipe         *pipe);
 288 dbus_bool_t _dbus_pipe_is_stdout_or_stderr (DBusPipe         *pipe);
 289
 290
 291 /** Opaque type for reading a directory listing */
 292 typedef struct DBusDirIter DBusDirIter;
 293
 294 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
 295                                             DBusError        *error);
 296 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
 297                                             DBusString       *filename,
 298                                             DBusError        *error);
 299 void         _dbus_directory_close         (DBusDirIter      *iter);
 300
 301 dbus_bool_t  _dbus_check_dir_is_private_to_user    (DBusString *dir,
 302                                                     DBusError *error);
 303
 304 void _dbus_fd_set_close_on_exec (int fd);
 305
 306 const char* _dbus_get_tmpdir      (void);
 307
 308 /**
 309  * Random numbers
 310  */
 311 void        _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
 312                                                       int   n_bytes);
 313 void        _dbus_generate_random_bytes_buffer (char       *buffer,
 314                                                 int         n_bytes);
 315 dbus_bool_t _dbus_generate_random_bytes        (DBusString *str,
 316                                                 int         n_bytes);
 317 dbus_bool_t _dbus_generate_random_ascii        (DBusString *str,
 318                                                 int         n_bytes);
 319
 320 const char* _dbus_error_from_errno (int error_number);
 321
 322 void        _dbus_set_errno_to_zero                  (void);
 323 dbus_bool_t _dbus_get_is_errno_nonzero               (void);
 324 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void);
 325 dbus_bool_t _dbus_get_is_errno_enomem                (void);
 326 dbus_bool_t _dbus_get_is_errno_eintr                 (void);
 327 const char* _dbus_strerror_from_errno                (void);
 328
 329 void _dbus_disable_sigpipe (void);
 330
 331
 332 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
 333
 334 int _dbus_printf_string_upper_bound (const char *format,
 335                                      va_list args);
 336
 337
 338 /**
 339  * Portable struct with stat() results
 340  */
 341 typedef struct
 342 {
 343   unsigned long mode;  /**< File mode */
 344   unsigned long nlink; /**< Number of hard links */
 345   dbus_uid_t    uid;   /**< User owning file */
 346   dbus_gid_t    gid;   /**< Group owning file */
 347   unsigned long size;  /**< Size of file */
 348   unsigned long atime; /**< Access time */
 349   unsigned long mtime; /**< Modify time */
 350   unsigned long ctime; /**< Creation time */
 351 } DBusStat;
 352
 353 dbus_bool_t _dbus_stat             (const DBusString *filename,
 354                                     DBusStat         *statbuf,
 355                                     DBusError        *error);
 356 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
 357                                     int              *fd2,
 358                                     dbus_bool_t       blocking,
 359                                     DBusError        *error);
 360
 361 void        _dbus_print_backtrace  (void);
 362
 363 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
 364                                    DBusPipe         *print_pid_pipe,
 365                                    DBusError        *error);
 366 dbus_bool_t _dbus_write_pid_file  (const DBusString *filename,
 367                                    unsigned long     pid,
 368                                    DBusError        *error);
 369 dbus_bool_t _dbus_verify_daemon_user    (const char *user);
 370 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
 371                                          DBusError  *error);
 372
 373 /** A UNIX signal handler */
 374 typedef void (* DBusSignalHandler) (int sig);
 375
 376 void _dbus_set_signal_handler (int               sig,
 377                                DBusSignalHandler handler);
 378
 379 dbus_bool_t _dbus_user_at_console (const char *username,
 380                                    DBusError  *error);
 381
 382 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
 383  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
 384  */
 385 #if !defined (DBUS_VA_COPY)
 386 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
 387 #    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
 388 #  elif defined (DBUS_VA_COPY_AS_ARRAY)
 389 #    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
 390 #  else /* va_list is a pointer */
 391 #    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
 392 #  endif /* va_list is a pointer */
 393 #endif /* !DBUS_VA_COPY */
 394
 395
 396 /**
 397  * Casts a primitive C type to a byte array and then indexes
 398  * a particular byte of the array.
 399  */
 400 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
 401     (((const char*)&(p))[(i)])
 402 /** On x86 there is an 80-bit FPU, and if you do "a == b" it may have a
 403  * or b in an 80-bit register, thus failing to compare the two 64-bit
 404  * doubles for bitwise equality. So this macro compares the two doubles
 405  * bitwise.
 406  */
 407 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b)                                       \
 408      (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) &&       \
 409       _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) &&       \
 410       _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) &&       \
 411       _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) &&       \
 412       _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) &&       \
 413       _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) &&       \
 414       _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) &&       \
 415       _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
 416
 417 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address,
 418                                           DBusError *error);
 419
 420 /** Type representing a universally unique ID
 421  * @todo rename to UUID instead of GUID
 422  */
 423 typedef union DBusGUID DBusGUID;
 424
 425 dbus_bool_t _dbus_read_local_machine_uuid   (DBusGUID         *machine_id,
 426                                              dbus_bool_t       create_if_not_found,
 427                                              DBusError        *error);
 428
 429 /**
 430  * Initialize threads as in dbus_threads_init_default(), appropriately
 431  * for the platform.
 432  * @returns #FALSE if no memory
 433  */
 434 dbus_bool_t _dbus_threads_init_platform_specific (void);
 435
 436 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs,
 437                                           const char *suffix,
 438                                           DBusList **dir_list);
 439
 440 unsigned long _dbus_pid_for_log (void);
 441
 442 /* FIXME move back to dbus-sysdeps-unix.h probably -
 443  * the PID file handling just needs a little more abstraction
 444  * in the bus daemon first.
 445  */
 446 dbus_pid_t    _dbus_getpid (void);
 447
 448 void _dbus_flush_caches (void);
 449
 450 /** @} */
 451
 452 DBUS_END_DECLS
 453
 454 #endif /* DBUS_SYSDEPS_H */