D-Bus  1.4.18
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 #ifdef HAVE_STDINT_H
00031 #include <stdint.h>
00032 #endif
00033 
00034 #ifdef HAVE_INTTYPES_H
00035 #include <inttypes.h>
00036 #endif
00037 
00038 #include <dbus/dbus-errors.h>
00039 #include <dbus/dbus-file.h>
00040 #include <dbus/dbus-string.h>
00041 
00042 /* this is perhaps bogus, but strcmp() etc. are faster if we use the
00043  * stuff straight out of string.h, so have this here for now.
00044  */
00045 #include <string.h>
00046 #include <stdarg.h>
00047 
00048 /* AIX sys/poll.h does #define events reqevents, and other
00049  * wonderousness, so must include sys/poll before declaring
00050  * DBusPollFD
00051  */ 
00052 #ifdef HAVE_POLL
00053 #include <sys/poll.h>
00054 #endif
00055 
00056 #ifdef DBUS_WINCE
00057 /* Windows CE lacks some system functions (such as errno and clock).
00058    We bring them in here.  */
00059 #include "dbus-sysdeps-wince-glue.h"
00060 #endif
00061 
00062 DBUS_BEGIN_DECLS
00063 
00064 #ifdef DBUS_WIN
00065 #define _DBUS_PATH_SEPARATOR ";"
00066 #else
00067 #define _DBUS_PATH_SEPARATOR ":"
00068 #endif
00069 
00070 /* Forward declarations */
00071 
00072 
00074 typedef struct DBusList DBusList;
00075 
00077 typedef struct DBusCredentials DBusCredentials;
00078 
00080 typedef struct DBusPipe DBusPipe;
00081 
00088 void _dbus_abort (void) _DBUS_GNUC_NORETURN;
00089 
00090 dbus_bool_t _dbus_check_setuid (void);
00091 const char* _dbus_getenv (const char *varname);
00092 dbus_bool_t _dbus_setenv (const char *varname,
00093                           const char *value);
00094 dbus_bool_t _dbus_clearenv (void);
00095 char **     _dbus_get_environment (void);
00096 
00098 typedef unsigned long dbus_pid_t;
00100 typedef unsigned long dbus_uid_t;
00102 typedef unsigned long dbus_gid_t;
00103 
00105 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
00106 
00107 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
00108 
00109 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
00110 
00112 #define DBUS_PID_FORMAT "%lu"
00113 
00114 #define DBUS_UID_FORMAT "%lu"
00115 
00116 #define DBUS_GID_FORMAT "%lu"
00117 
00118 
00129 dbus_bool_t _dbus_open_tcp_socket  (int              *fd,
00130                                     DBusError        *error);
00131 dbus_bool_t _dbus_close_socket     (int               fd,
00132                                     DBusError        *error);
00133 int         _dbus_read_socket      (int               fd,
00134                                     DBusString       *buffer,
00135                                     int               count);
00136 int         _dbus_write_socket     (int               fd,
00137                                     const DBusString *buffer,
00138                                     int               start,
00139                                     int               len);
00140 int         _dbus_write_socket_two (int               fd,
00141                                     const DBusString *buffer1,
00142                                     int               start1,
00143                                     int               len1,
00144                                     const DBusString *buffer2,
00145                                     int               start2,
00146                                     int               len2);
00147 
00148 int _dbus_read_socket_with_unix_fds      (int               fd,
00149                                           DBusString       *buffer,
00150                                           int               count,
00151                                           int              *fds,
00152                                           int              *n_fds);
00153 int _dbus_write_socket_with_unix_fds     (int               fd,
00154                                           const DBusString *buffer,
00155                                           int               start,
00156                                           int               len,
00157                                           const int        *fds,
00158                                           int               n_fds);
00159 int _dbus_write_socket_with_unix_fds_two (int               fd,
00160                                           const DBusString *buffer1,
00161                                           int               start1,
00162                                           int               len1,
00163                                           const DBusString *buffer2,
00164                                           int               start2,
00165                                           int               len2,
00166                                           const int        *fds,
00167                                           int               n_fds);
00168 
00169 dbus_bool_t _dbus_socket_is_invalid (int              fd);
00170 
00171 int _dbus_connect_tcp_socket  (const char     *host,
00172                                const char     *port,
00173                                const char     *family,
00174                                DBusError      *error);
00175 int _dbus_connect_tcp_socket_with_nonce  (const char     *host,
00176                                           const char     *port,
00177                                           const char     *family,
00178                                           const char     *noncefile,
00179                                           DBusError      *error);
00180 int _dbus_listen_tcp_socket   (const char     *host,
00181                                const char     *port,
00182                                const char     *family,
00183                                DBusString     *retport,
00184                                int           **fds_p,
00185                                DBusError      *error);
00186 int _dbus_accept              (int             listen_fd);
00187 
00188 
00189 dbus_bool_t _dbus_read_credentials_socket (int               client_fd,
00190                                            DBusCredentials  *credentials,
00191                                            DBusError        *error);
00192 dbus_bool_t _dbus_send_credentials_socket (int              server_fd,
00193                                            DBusError       *error);
00194 
00195 dbus_bool_t _dbus_credentials_add_from_user            (DBusCredentials  *credentials,
00196                                                         const DBusString *username);
00197 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials  *credentials);
00198 dbus_bool_t _dbus_append_user_from_current_process     (DBusString        *str);
00199 
00200 dbus_bool_t _dbus_parse_unix_user_from_config   (const DBusString  *username,
00201                                                  dbus_uid_t        *uid_p);
00202 dbus_bool_t _dbus_parse_unix_group_from_config  (const DBusString  *groupname,
00203                                                  dbus_gid_t        *gid_p);
00204 dbus_bool_t _dbus_unix_groups_from_uid          (dbus_uid_t         uid,
00205                                                  dbus_gid_t       **group_ids,
00206                                                  int               *n_group_ids);
00207 dbus_bool_t _dbus_unix_user_is_at_console       (dbus_uid_t         uid,
00208                                                  DBusError         *error);
00209 dbus_bool_t _dbus_unix_user_is_process_owner    (dbus_uid_t         uid);
00210 dbus_bool_t _dbus_windows_user_is_process_owner (const char        *windows_sid);
00211 
00212 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString      *directory,
00213                                                             DBusCredentials *credentials);
00214 
00215 dbus_bool_t _dbus_daemon_is_session_bus_address_published (const char *scope);
00216 
00217 dbus_bool_t _dbus_daemon_publish_session_bus_address (const char* address, const char* shm_name);
00218 
00219 void _dbus_daemon_unpublish_session_bus_address (void);
00220 
00221 dbus_bool_t _dbus_socket_can_pass_unix_fd(int fd);
00222 
00226 typedef struct DBusAtomic DBusAtomic;
00227 
00231 struct DBusAtomic
00232 {
00233 #ifdef DBUS_WIN
00234   volatile long value; 
00235 #else
00236   volatile dbus_int32_t value; 
00237 #endif
00238 };
00239 
00240 /* The value we get from autofoo is in the form of a cpp expression;
00241  * convert that to a conventional defined/undef switch. (We can't get
00242  * the conventional defined/undef because of multiarch builds only running
00243  * ./configure once, on Darwin.) */
00244 #if DBUS_HAVE_ATOMIC_INT_COND
00245 #   define DBUS_HAVE_ATOMIC_INT 1
00246 #else
00247 #   undef DBUS_HAVE_ATOMIC_INT
00248 #endif
00249 
00250 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
00251 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
00252 dbus_int32_t _dbus_atomic_get (DBusAtomic *atomic);
00253 
00254 
00255 /* AIX uses different values for poll */
00256 
00257 #ifdef _AIX
00258 
00259 #define _DBUS_POLLIN      0x0001
00260 
00261 #define _DBUS_POLLPRI     0x0004
00262 
00263 #define _DBUS_POLLOUT     0x0002
00264 
00265 #define _DBUS_POLLERR     0x4000
00266 
00267 #define _DBUS_POLLHUP     0x2000
00268 
00269 #define _DBUS_POLLNVAL    0x8000
00270 #elif defined(__HAIKU__)
00271 
00272 #define _DBUS_POLLIN      0x0001
00273 
00274 #define _DBUS_POLLOUT     0x0002
00275 
00276 #define _DBUS_POLLERR     0x0004
00277 
00278 #define _DBUS_POLLPRI     0x0020
00279 
00280 #define _DBUS_POLLHUP     0x0080
00281 
00282 #define _DBUS_POLLNVAL    0x1000
00283 #else
00284 
00285 #define _DBUS_POLLIN      0x0001
00286 
00287 #define _DBUS_POLLPRI     0x0002
00288 
00289 #define _DBUS_POLLOUT     0x0004
00290 
00291 #define _DBUS_POLLERR     0x0008
00292 
00293 #define _DBUS_POLLHUP     0x0010
00294 
00295 #define _DBUS_POLLNVAL    0x0020
00296 #endif
00297 
00301 typedef struct
00302 {
00303   int fd;            
00304   short events;      
00305   short revents;     
00306 } DBusPollFD;
00307 
00308 int _dbus_poll (DBusPollFD *fds,
00309                 int         n_fds,
00310                 int         timeout_milliseconds);
00311 
00312 void _dbus_sleep_milliseconds (int milliseconds);
00313 
00314 void _dbus_get_current_time (long *tv_sec,
00315                              long *tv_usec);
00316 
00320 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
00321                                               DBusError        *error);
00322 dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
00323                                               DBusError        *error);
00324 
00325 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
00326                                        const DBusString *next_component);
00327 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
00328                                        DBusString       *dirname);
00329 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
00330 
00331 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
00332 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs);
00333 
00334 dbus_bool_t _dbus_append_system_config_file  (DBusString *str);
00335 dbus_bool_t _dbus_append_session_config_file (DBusString *str);
00336 
00338 typedef struct DBusDirIter DBusDirIter;
00339 
00340 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
00341                                             DBusError        *error);
00342 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
00343                                             DBusString       *filename,
00344                                             DBusError        *error);
00345 void         _dbus_directory_close         (DBusDirIter      *iter);
00346 
00347 dbus_bool_t  _dbus_check_dir_is_private_to_user    (DBusString *dir,
00348                                                     DBusError *error);
00349 
00350 void _dbus_fd_set_close_on_exec (intptr_t fd);
00351 
00352 const char* _dbus_get_tmpdir      (void);
00353 
00357 void        _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
00358                                                       int   n_bytes);
00359 void        _dbus_generate_random_bytes_buffer (char       *buffer,
00360                                                 int         n_bytes);
00361 dbus_bool_t _dbus_generate_random_bytes        (DBusString *str,
00362                                                 int         n_bytes);
00363 dbus_bool_t _dbus_generate_random_ascii        (DBusString *str,
00364                                                 int         n_bytes);
00365 
00366 const char* _dbus_error_from_errno (int error_number);
00367 const char* _dbus_error_from_system_errno (void);
00368 
00369 void        _dbus_set_errno_to_zero                  (void);
00370 dbus_bool_t _dbus_get_is_errno_nonzero               (void);
00371 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void);
00372 dbus_bool_t _dbus_get_is_errno_enomem                (void);
00373 dbus_bool_t _dbus_get_is_errno_eintr                 (void);
00374 dbus_bool_t _dbus_get_is_errno_epipe                 (void);
00375 dbus_bool_t _dbus_get_is_errno_etoomanyrefs           (void);
00376 const char* _dbus_strerror_from_errno                (void);
00377 
00378 void _dbus_disable_sigpipe (void);
00379 
00380 
00381 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
00382 
00383 int _dbus_printf_string_upper_bound (const char *format,
00384                                      va_list args);
00385 
00386 
00390 typedef struct
00391 {
00392   unsigned long mode;  
00393   unsigned long nlink; 
00394   dbus_uid_t    uid;   
00395   dbus_gid_t    gid;   
00396   unsigned long size;  
00397   unsigned long atime; 
00398   unsigned long mtime; 
00399   unsigned long ctime; 
00400 } DBusStat;
00401 
00402 dbus_bool_t _dbus_stat             (const DBusString *filename,
00403                                     DBusStat         *statbuf,
00404                                     DBusError        *error);
00405 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
00406                                     int              *fd2,
00407                                     dbus_bool_t       blocking,
00408                                     DBusError        *error);
00409 
00410 void        _dbus_print_backtrace  (void);
00411 
00412 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
00413                                    DBusPipe         *print_pid_pipe,
00414                                    DBusError        *error,
00415                                    dbus_bool_t       keep_umask);
00416 
00417 dbus_bool_t _dbus_verify_daemon_user    (const char *user);
00418 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
00419                                          DBusError  *error);
00420 
00421 dbus_bool_t _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile,
00422                                               DBusPipe         *print_pid_pipe,
00423                                               dbus_pid_t        pid_to_write,
00424                                               DBusError        *error);
00425 
00426 dbus_bool_t _dbus_command_for_pid (unsigned long  pid,
00427                                    DBusString    *str,
00428                                    int            max_len,
00429                                    DBusError     *error);
00430 
00432 typedef void (* DBusSignalHandler) (int sig);
00433 
00434 void _dbus_set_signal_handler (int               sig,
00435                                DBusSignalHandler handler);
00436 
00437 dbus_bool_t _dbus_user_at_console (const char *username,
00438                                    DBusError  *error);
00439 
00440 void _dbus_init_system_log (void);
00441 
00442 typedef enum {
00443   DBUS_SYSTEM_LOG_INFO,
00444   DBUS_SYSTEM_LOG_SECURITY,
00445   DBUS_SYSTEM_LOG_FATAL
00446 } DBusSystemLogSeverity;
00447 
00448 void _dbus_system_log (DBusSystemLogSeverity severity, const char *msg, ...) _DBUS_GNUC_PRINTF (2, 3);
00449 void _dbus_system_logv (DBusSystemLogSeverity severity, const char *msg, va_list args);
00450 
00451 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
00452  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
00453  */
00454 #if !defined (DBUS_VA_COPY)
00455 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
00456 #    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
00457 #  elif defined (DBUS_VA_COPY_AS_ARRAY)
00458 #    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
00459 #  else /* va_list is a pointer */
00460 #    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
00461 #  endif /* va_list is a pointer */
00462 #endif /* !DBUS_VA_COPY */
00463 
00464 
00469 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
00470     (((const char*)&(p))[(i)])
00471 
00476 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b)                                       \
00477      (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) &&       \
00478       _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) &&       \
00479       _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) &&       \
00480       _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) &&       \
00481       _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) &&       \
00482       _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) &&       \
00483       _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) &&       \
00484       _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
00485 
00486 dbus_bool_t _dbus_get_autolaunch_address (const char *scope,
00487                                           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 
00527 void _dbus_request_file_descriptor_limit (unsigned int limit);
00528 
00529 /*
00530  * replaces the term DBUS_PREFIX in configure_time_path by the
00531  * current dbus installation directory. On unix this function is a noop
00532  *
00533  * @param configure_time_path
00534  * @return real path
00535  */
00536 const char *
00537 _dbus_replace_install_prefix (const char *configure_time_path);
00538 
00539 /* Do not set this too high: it is a denial-of-service risk.
00540  * See <https://bugs.freedesktop.org/show_bug.cgi?id=82820>
00541  *
00542  * (This needs to be in the non-Unix-specific header so that
00543  * the config-parser can use it.)
00544  */
00545 #define DBUS_DEFAULT_MESSAGE_UNIX_FDS 16
00546 
00549 DBUS_END_DECLS
00550 
00551 
00552 #ifdef DBUS_WIN
00553 #include "dbus-sysdeps-win.h"
00554 #endif
00555 
00556 #endif /* DBUS_SYSDEPS_H */