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