D-Bus 1.2.24

dbus-sysdeps.h

00001 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
00002 /* dbus-sysdeps.h Wrappers around system/libc features (internal to D-Bus implementation)
00003  * 
00004  * Copyright (C) 2002, 2003  Red Hat, Inc.
00005  * Copyright (C) 2003 CodeFactory AB
00006  *
00007  * Licensed under the Academic Free License version 2.1
00008  * 
00009  * This program is free software; you can redistribute it and/or modify
00010  * it under the terms of the GNU General Public License as published by
00011  * the Free Software Foundation; either version 2 of the License, or
00012  * (at your option) any later version.
00013  *
00014  * This program is distributed in the hope that it will be useful,
00015  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017  * GNU General Public License for more details.
00018  * 
00019  * You should have received a copy of the GNU General Public License
00020  * along with this program; if not, write to the Free Software
00021  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
00022  *
00023  */
00024 
00025 #ifndef DBUS_SYSDEPS_H
00026 #define DBUS_SYSDEPS_H
00027 
00028 #include <config.h>
00029 
00030 #include <dbus/dbus-errors.h>
00031 
00032 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
00033  * stuff straight out of string.h, so have this here for now.
00034  */
00035 #include <string.h>
00036 #include <stdarg.h>
00037 
00038  
00039 /* AIX sys/poll.h does #define events reqevents, and other
00040  * wonderousness, so must include sys/poll before declaring
00041  * DBusPollFD
00042  */ 
00043 #ifdef HAVE_POLL
00044 #include <sys/poll.h>
00045 #endif
00046 
00047 DBUS_BEGIN_DECLS
00048 
00049 #ifdef DBUS_WIN
00050 #define _DBUS_PATH_SEPARATOR ";"
00051 #else
00052 #define _DBUS_PATH_SEPARATOR ":"
00053 #endif
00054 
00055 /* Forward declarations */
00056 
00058 typedef struct DBusString DBusString;
00059 
00061 typedef struct DBusList DBusList;
00062 
00064 typedef struct DBusCredentials DBusCredentials;
00065 
00072 /* The idea of this file is to encapsulate everywhere that we're
00073  * relying on external libc features, for ease of security
00074  * auditing. The idea is from vsftpd. This also gives us a chance to
00075  * make things more convenient to use, e.g.  by reading into a
00076  * DBusString. Operating system headers aren't intended to be used
00077  * outside of this file and a limited number of others (such as
00078  * dbus-memory.c)
00079  */
00080 
00081 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
00082 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )    \
00083   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
00084 #define _DBUS_GNUC_NORETURN                         \
00085   __attribute__((__noreturn__))
00086 #else   /* !__GNUC__ */
00087 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
00088 #define _DBUS_GNUC_NORETURN
00089 #endif  /* !__GNUC__ */
00090 
00098 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
00099 
00100 const char* _dbus_getenv (const char *varname);
00101 dbus_bool_t _dbus_setenv (const char *varname,
00102                           const char *value);
00103 dbus_bool_t _dbus_clearenv (void);
00104 char **     _dbus_get_environment (void);
00105 
00107 typedef unsigned long dbus_pid_t;
00109 typedef unsigned long dbus_uid_t;
00111 typedef unsigned long dbus_gid_t;
00112 
00114 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
00115 
00116 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
00117 
00118 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
00119 
00121 #define DBUS_PID_FORMAT "%lu"
00122 
00123 #define DBUS_UID_FORMAT "%lu"
00124 
00125 #define DBUS_GID_FORMAT "%lu"
00126 
00127 
00138 dbus_bool_t _dbus_open_tcp_socket  (int              *fd,
00139                                     DBusError        *error);
00140 dbus_bool_t _dbus_close_socket     (int               fd,
00141                                     DBusError        *error);
00142 int         _dbus_read_socket      (int               fd,
00143                                     DBusString       *buffer,
00144                                     int               count);
00145 int         _dbus_write_socket     (int               fd,
00146                                     const DBusString *buffer,
00147                                     int               start,
00148                                     int               len);
00149 int         _dbus_write_socket_two (int               fd,
00150                                     const DBusString *buffer1,
00151                                     int               start1,
00152                                     int               len1,
00153                                     const DBusString *buffer2,
00154                                     int               start2,
00155                                     int               len2);
00156 int _dbus_connect_tcp_socket  (const char     *host,
00157                                const char     *port,
00158                                const char     *family,
00159                                DBusError      *error);
00160 int _dbus_listen_tcp_socket   (const char     *host,
00161                                const char     *port,
00162                                const char     *family,
00163                                DBusString     *retport,
00164                                int           **fds_p,
00165                                DBusError      *error);
00166 int _dbus_accept              (int             listen_fd);
00167 
00168 
00169 dbus_bool_t _dbus_read_credentials_socket (int               client_fd,
00170                                            DBusCredentials  *credentials,
00171                                            DBusError        *error);
00172 dbus_bool_t _dbus_send_credentials_socket (int              server_fd,
00173                                            DBusError       *error);
00174 
00175 dbus_bool_t _dbus_credentials_add_from_user            (DBusCredentials  *credentials,
00176                                                         const DBusString *username);
00177 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials  *credentials);
00178 dbus_bool_t _dbus_append_user_from_current_process     (DBusString        *str);
00179 
00180 dbus_bool_t _dbus_parse_unix_user_from_config   (const DBusString  *username,
00181                                                  dbus_uid_t        *uid_p);
00182 dbus_bool_t _dbus_parse_unix_group_from_config  (const DBusString  *groupname,
00183                                                  dbus_gid_t        *gid_p);
00184 dbus_bool_t _dbus_unix_groups_from_uid          (dbus_uid_t         uid,
00185                                                  dbus_gid_t       **group_ids,
00186                                                  int               *n_group_ids);
00187 dbus_bool_t _dbus_unix_user_is_at_console       (dbus_uid_t         uid,
00188                                                  DBusError         *error);
00189 dbus_bool_t _dbus_unix_user_is_process_owner    (dbus_uid_t         uid);
00190 dbus_bool_t _dbus_windows_user_is_process_owner (const char        *windows_sid);
00191 
00192 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString      *directory,
00193                                                             DBusCredentials *credentials);
00194 
00198 typedef struct DBusAtomic DBusAtomic;
00199 
00203 struct DBusAtomic
00204 {
00205 #ifdef DBUS_WIN
00206   volatile long value; 
00207 #else
00208   volatile dbus_int32_t value; 
00209 #endif
00210 };
00211 
00212 /* The value we get from autofoo is in the form of a cpp expression;
00213  * convert that to a conventional defined/undef switch. (We can't get
00214  * the conventional defined/undef because of multiarch builds only running
00215  * ./configure once, on Darwin.) */
00216 #if DBUS_HAVE_ATOMIC_INT_COND
00217 #   define DBUS_HAVE_ATOMIC_INT 1
00218 #else
00219 #   undef DBUS_HAVE_ATOMIC_INT
00220 #endif
00221 
00222 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
00223 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
00224 
00225 
00226 /* AIX uses different values for poll */
00227 
00228 #ifdef _AIX
00229 
00230 #define _DBUS_POLLIN      0x0001
00231 
00232 #define _DBUS_POLLPRI     0x0004
00233 
00234 #define _DBUS_POLLOUT     0x0002
00235 
00236 #define _DBUS_POLLERR     0x4000
00237 
00238 #define _DBUS_POLLHUP     0x2000
00239 
00240 #define _DBUS_POLLNVAL    0x8000
00241 #elif defined(__HAIKU__)
00242 
00243 #define _DBUS_POLLIN      0x0001
00244 
00245 #define _DBUS_POLLOUT     0x0002
00246 
00247 #define _DBUS_POLLERR     0x0004
00248 
00249 #define _DBUS_POLLPRI     0x0020
00250 
00251 #define _DBUS_POLLHUP     0x0080
00252 
00253 #define _DBUS_POLLNVAL    0x1000
00254 #else
00255 
00256 #define _DBUS_POLLIN      0x0001
00257 
00258 #define _DBUS_POLLPRI     0x0002
00259 
00260 #define _DBUS_POLLOUT     0x0004
00261 
00262 #define _DBUS_POLLERR     0x0008
00263 
00264 #define _DBUS_POLLHUP     0x0010
00265 
00266 #define _DBUS_POLLNVAL    0x0020
00267 #endif
00268 
00272 typedef struct
00273 {
00274   int fd;            
00275   short events;      
00276   short revents;     
00277 } DBusPollFD;
00278 
00279 int _dbus_poll (DBusPollFD *fds,
00280                 int         n_fds,
00281                 int         timeout_milliseconds);
00282 
00283 void _dbus_sleep_milliseconds (int milliseconds);
00284 
00285 void _dbus_get_current_time (long *tv_sec,
00286                              long *tv_usec);
00287 
00291 dbus_bool_t _dbus_file_exists         (const char       *file);
00292 dbus_bool_t _dbus_file_get_contents   (DBusString       *str,
00293                                        const DBusString *filename,
00294                                        DBusError        *error);
00295 dbus_bool_t _dbus_string_save_to_file (const DBusString *str,
00296                                        const DBusString *filename,
00297                                        DBusError        *error);
00298 
00299 dbus_bool_t _dbus_make_file_world_readable   (const DBusString *filename,
00300                                               DBusError *error);
00301 
00302 dbus_bool_t    _dbus_create_file_exclusively (const DBusString *filename,
00303                                               DBusError        *error);
00304 dbus_bool_t    _dbus_delete_file             (const DBusString *filename,
00305                                               DBusError        *error);
00306 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
00307                                               DBusError        *error);
00308 dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
00309                                               DBusError        *error);
00310 
00311 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
00312                                        const DBusString *next_component);
00313 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
00314                                        DBusString       *dirname);
00315 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
00316 
00317 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
00318 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs);
00319 
00320 dbus_bool_t _dbus_append_system_config_file  (DBusString *str);
00321 dbus_bool_t _dbus_append_session_config_file (DBusString *str);
00322 
00323 typedef struct {
00324   int fd_or_handle;
00325 } DBusPipe;
00326 
00327 void        _dbus_pipe_init                (DBusPipe         *pipe,
00328                                             int               fd);
00329 void        _dbus_pipe_init_stdout         (DBusPipe         *pipe);
00330 int         _dbus_pipe_write               (DBusPipe         *pipe,
00331                                             const DBusString *buffer,
00332                                             int               start,
00333                                             int               len,
00334                                             DBusError        *error);
00335 int         _dbus_pipe_close               (DBusPipe         *pipe,
00336                                             DBusError        *error);
00337 dbus_bool_t _dbus_pipe_is_valid            (DBusPipe         *pipe);
00338 void        _dbus_pipe_invalidate          (DBusPipe         *pipe);
00339 dbus_bool_t _dbus_pipe_is_stdout_or_stderr (DBusPipe         *pipe);
00340 
00341 
00343 typedef struct DBusDirIter DBusDirIter;
00344 
00345 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
00346                                             DBusError        *error);
00347 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
00348                                             DBusString       *filename,
00349                                             DBusError        *error);
00350 void         _dbus_directory_close         (DBusDirIter      *iter);
00351 
00352 dbus_bool_t  _dbus_check_dir_is_private_to_user    (DBusString *dir,
00353                                                     DBusError *error);
00354 
00355 void _dbus_fd_set_close_on_exec (int fd);
00356 
00357 const char* _dbus_get_tmpdir      (void);
00358 
00362 void        _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
00363                                                       int   n_bytes);
00364 void        _dbus_generate_random_bytes_buffer (char       *buffer,
00365                                                 int         n_bytes);
00366 dbus_bool_t _dbus_generate_random_bytes        (DBusString *str,
00367                                                 int         n_bytes);
00368 dbus_bool_t _dbus_generate_random_ascii        (DBusString *str,
00369                                                 int         n_bytes);
00370 
00371 const char* _dbus_error_from_errno (int error_number);
00372 
00373 void        _dbus_set_errno_to_zero                  (void);
00374 dbus_bool_t _dbus_get_is_errno_nonzero               (void);
00375 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void);
00376 dbus_bool_t _dbus_get_is_errno_enomem                (void);
00377 dbus_bool_t _dbus_get_is_errno_eintr                 (void);
00378 dbus_bool_t _dbus_get_is_errno_epipe                 (void);
00379 const char* _dbus_strerror_from_errno                (void);
00380 
00381 void _dbus_disable_sigpipe (void);
00382 
00383 
00384 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
00385 
00386 int _dbus_printf_string_upper_bound (const char *format,
00387                                      va_list args);
00388 
00389 
00393 typedef struct
00394 {
00395   unsigned long mode;  
00396   unsigned long nlink; 
00397   dbus_uid_t    uid;   
00398   dbus_gid_t    gid;   
00399   unsigned long size;  
00400   unsigned long atime; 
00401   unsigned long mtime; 
00402   unsigned long ctime; 
00403 } DBusStat;
00404 
00405 dbus_bool_t _dbus_stat             (const DBusString *filename,
00406                                     DBusStat         *statbuf,
00407                                     DBusError        *error);
00408 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
00409                                     int              *fd2,
00410                                     dbus_bool_t       blocking,
00411                                     DBusError        *error);
00412 
00413 void        _dbus_print_backtrace  (void);
00414 
00415 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
00416                                    DBusPipe         *print_pid_pipe,
00417                                    DBusError        *error,
00418                                    dbus_bool_t       keep_umask);
00419 
00420 dbus_bool_t _dbus_verify_daemon_user    (const char *user);
00421 
00422 dbus_bool_t _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile,
00423                                               DBusPipe         *print_pid_pipe,
00424                                               dbus_pid_t        pid_to_write,
00425                                               DBusError        *error);
00426 
00427 dbus_bool_t _dbus_command_for_pid (unsigned long  pid,
00428                                    DBusString    *str,
00429                                    int            max_len,
00430                                    DBusError     *error);
00431 
00433 typedef void (* DBusSignalHandler) (int sig);
00434 
00435 void _dbus_set_signal_handler (int               sig,
00436                                DBusSignalHandler handler);
00437 
00438 dbus_bool_t _dbus_user_at_console (const char *username,
00439                                    DBusError  *error);
00440 
00441 void _dbus_init_system_log (void);
00442 
00443 typedef enum {
00444   DBUS_SYSTEM_LOG_INFO,
00445   DBUS_SYSTEM_LOG_SECURITY,
00446   DBUS_SYSTEM_LOG_FATAL
00447 } DBusSystemLogSeverity;
00448 
00449 void _dbus_system_log (DBusSystemLogSeverity severity, const char *msg, ...) _DBUS_GNUC_PRINTF (2, 3);
00450 void _dbus_system_logv (DBusSystemLogSeverity severity, const char *msg, va_list args);
00451 
00452 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
00453  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
00454  */
00455 #if !defined (DBUS_VA_COPY)
00456 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
00457 #    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
00458 #  elif defined (DBUS_VA_COPY_AS_ARRAY)
00459 #    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
00460 #  else /* va_list is a pointer */
00461 #    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
00462 #  endif /* va_list is a pointer */
00463 #endif /* !DBUS_VA_COPY */
00464 
00465 
00470 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
00471     (((const char*)&(p))[(i)])
00472 
00477 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b)                                       \
00478      (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) &&       \
00479       _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) &&       \
00480       _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) &&       \
00481       _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) &&       \
00482       _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) &&       \
00483       _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) &&       \
00484       _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) &&       \
00485       _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
00486 
00487 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address, 
00488                                           DBusError *error);
00489 
00490 dbus_bool_t _dbus_lookup_session_address (dbus_bool_t *supported,
00491                                           DBusString  *address,
00492                                           DBusError   *error);
00493 
00497 typedef union DBusGUID DBusGUID;
00498 
00499 dbus_bool_t _dbus_read_local_machine_uuid   (DBusGUID         *machine_id,
00500                                              dbus_bool_t       create_if_not_found,
00501                                              DBusError        *error);
00502 
00508 dbus_bool_t _dbus_threads_init_platform_specific (void);
00509 
00510 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs, 
00511                                           const char *suffix, 
00512                                           DBusList **dir_list);
00513 
00514 unsigned long _dbus_pid_for_log (void);
00515 
00516 /* FIXME move back to dbus-sysdeps-unix.h probably -
00517  * the PID file handling just needs a little more abstraction
00518  * in the bus daemon first.
00519  */
00520 dbus_pid_t    _dbus_getpid (void);
00521 
00522 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
00523                                          DBusError  *error);
00524 
00525 void _dbus_flush_caches (void);
00526 
00529 DBUS_END_DECLS
00530 
00531 #endif /* DBUS_SYSDEPS_H */