• Main Page
  • Related Pages
  • Modules
  • Data Structures
  • Files
  • File List

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 const char* _dbus_getenv (const char *varname);
00087 dbus_bool_t _dbus_setenv (const char *varname,
00088                           const char *value);
00089 dbus_bool_t _dbus_clearenv (void);
00090 char **     _dbus_get_environment (void);
00091 
00093 typedef unsigned long dbus_pid_t;
00095 typedef unsigned long dbus_uid_t;
00097 typedef unsigned long dbus_gid_t;
00098 
00100 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
00101 
00102 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
00103 
00104 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
00105 
00107 #define DBUS_PID_FORMAT "%lu"
00108 
00109 #define DBUS_UID_FORMAT "%lu"
00110 
00111 #define DBUS_GID_FORMAT "%lu"
00112 
00113 
00124 dbus_bool_t _dbus_open_tcp_socket  (int              *fd,
00125                                     DBusError        *error);
00126 dbus_bool_t _dbus_close_socket     (int               fd,
00127                                     DBusError        *error);
00128 int         _dbus_read_socket      (int               fd,
00129                                     DBusString       *buffer,
00130                                     int               count);
00131 int         _dbus_write_socket     (int               fd,
00132                                     const DBusString *buffer,
00133                                     int               start,
00134                                     int               len);
00135 int         _dbus_write_socket_two (int               fd,
00136                                     const DBusString *buffer1,
00137                                     int               start1,
00138                                     int               len1,
00139                                     const DBusString *buffer2,
00140                                     int               start2,
00141                                     int               len2);
00142 
00143 int _dbus_read_socket_with_unix_fds      (int               fd,
00144                                           DBusString       *buffer,
00145                                           int               count,
00146                                           int              *fds,
00147                                           int              *n_fds);
00148 int _dbus_write_socket_with_unix_fds     (int               fd,
00149                                           const DBusString *buffer,
00150                                           int               start,
00151                                           int               len,
00152                                           const int        *fds,
00153                                           int               n_fds);
00154 int _dbus_write_socket_with_unix_fds_two (int               fd,
00155                                           const DBusString *buffer1,
00156                                           int               start1,
00157                                           int               len1,
00158                                           const DBusString *buffer2,
00159                                           int               start2,
00160                                           int               len2,
00161                                           const int        *fds,
00162                                           int               n_fds);
00163 
00164 dbus_bool_t _dbus_socket_is_invalid (int              fd);
00165 
00166 int _dbus_connect_tcp_socket  (const char     *host,
00167                                const char     *port,
00168                                const char     *family,
00169                                DBusError      *error);
00170 int _dbus_connect_tcp_socket_with_nonce  (const char     *host,
00171                                           const char     *port,
00172                                           const char     *family,
00173                                           const char     *noncefile,
00174                                           DBusError      *error);
00175 int _dbus_listen_tcp_socket   (const char     *host,
00176                                const char     *port,
00177                                const char     *family,
00178                                DBusString     *retport,
00179                                int           **fds_p,
00180                                DBusError      *error);
00181 int _dbus_accept              (int             listen_fd);
00182 
00183 
00184 dbus_bool_t _dbus_read_credentials_socket (int               client_fd,
00185                                            DBusCredentials  *credentials,
00186                                            DBusError        *error);
00187 dbus_bool_t _dbus_send_credentials_socket (int              server_fd,
00188                                            DBusError       *error);
00189 
00190 dbus_bool_t _dbus_credentials_add_from_user            (DBusCredentials  *credentials,
00191                                                         const DBusString *username);
00192 dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials  *credentials);
00193 dbus_bool_t _dbus_append_user_from_current_process     (DBusString        *str);
00194 
00195 dbus_bool_t _dbus_parse_unix_user_from_config   (const DBusString  *username,
00196                                                  dbus_uid_t        *uid_p);
00197 dbus_bool_t _dbus_parse_unix_group_from_config  (const DBusString  *groupname,
00198                                                  dbus_gid_t        *gid_p);
00199 dbus_bool_t _dbus_unix_groups_from_uid          (dbus_uid_t         uid,
00200                                                  dbus_gid_t       **group_ids,
00201                                                  int               *n_group_ids);
00202 dbus_bool_t _dbus_unix_user_is_at_console       (dbus_uid_t         uid,
00203                                                  DBusError         *error);
00204 dbus_bool_t _dbus_unix_user_is_process_owner    (dbus_uid_t         uid);
00205 dbus_bool_t _dbus_windows_user_is_process_owner (const char        *windows_sid);
00206 
00207 dbus_bool_t _dbus_append_keyring_directory_for_credentials (DBusString      *directory,
00208                                                             DBusCredentials *credentials);
00209 
00210 void _dbus_daemon_publish_session_bus_address (const char* address);
00211 
00212 void _dbus_daemon_unpublish_session_bus_address (void);
00213 
00214 dbus_bool_t _dbus_socket_can_pass_unix_fd(int fd);
00215 
00219 typedef struct DBusAtomic DBusAtomic;
00220 
00224 struct DBusAtomic
00225 {
00226 #ifdef DBUS_WIN
00227   volatile long value; 
00228 #else
00229   volatile dbus_int32_t value; 
00230 #endif
00231 };
00232 
00233 /* The value we get from autofoo is in the form of a cpp expression;
00234  * convert that to a conventional defined/undef switch. (We can't get
00235  * the conventional defined/undef because of multiarch builds only running
00236  * ./configure once, on Darwin.) */
00237 #if DBUS_HAVE_ATOMIC_INT_COND
00238 #   define DBUS_HAVE_ATOMIC_INT 1
00239 #else
00240 #   undef DBUS_HAVE_ATOMIC_INT
00241 #endif
00242 
00243 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic);
00244 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic);
00245 
00246 
00247 /* AIX uses different values for poll */
00248 
00249 #ifdef _AIX
00250 
00251 #define _DBUS_POLLIN      0x0001
00252 
00253 #define _DBUS_POLLPRI     0x0004
00254 
00255 #define _DBUS_POLLOUT     0x0002
00256 
00257 #define _DBUS_POLLERR     0x4000
00258 
00259 #define _DBUS_POLLHUP     0x2000
00260 
00261 #define _DBUS_POLLNVAL    0x8000
00262 #elif defined(__HAIKU__)
00263 
00264 #define _DBUS_POLLIN      0x0001
00265 
00266 #define _DBUS_POLLOUT     0x0002
00267 
00268 #define _DBUS_POLLERR     0x0004
00269 
00270 #define _DBUS_POLLPRI     0x0020
00271 
00272 #define _DBUS_POLLHUP     0x0080
00273 
00274 #define _DBUS_POLLNVAL    0x1000
00275 #else
00276 
00277 #define _DBUS_POLLIN      0x0001
00278 
00279 #define _DBUS_POLLPRI     0x0002
00280 
00281 #define _DBUS_POLLOUT     0x0004
00282 
00283 #define _DBUS_POLLERR     0x0008
00284 
00285 #define _DBUS_POLLHUP     0x0010
00286 
00287 #define _DBUS_POLLNVAL    0x0020
00288 #endif
00289 
00293 typedef struct
00294 {
00295   int fd;            
00296   short events;      
00297   short revents;     
00298 } DBusPollFD;
00299 
00300 int _dbus_poll (DBusPollFD *fds,
00301                 int         n_fds,
00302                 int         timeout_milliseconds);
00303 
00304 void _dbus_sleep_milliseconds (int milliseconds);
00305 
00306 void _dbus_get_current_time (long *tv_sec,
00307                              long *tv_usec);
00308 
00312 dbus_bool_t    _dbus_create_directory        (const DBusString *filename,
00313                                               DBusError        *error);
00314 dbus_bool_t    _dbus_delete_directory        (const DBusString *filename,
00315                                               DBusError        *error);
00316 
00317 dbus_bool_t _dbus_concat_dir_and_file (DBusString       *dir,
00318                                        const DBusString *next_component);
00319 dbus_bool_t _dbus_string_get_dirname  (const DBusString *filename,
00320                                        DBusString       *dirname);
00321 dbus_bool_t _dbus_path_is_absolute    (const DBusString *filename);
00322 
00323 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs);
00324 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs);
00325 
00326 dbus_bool_t _dbus_append_system_config_file  (DBusString *str);
00327 dbus_bool_t _dbus_append_session_config_file (DBusString *str);
00328 
00330 typedef struct DBusDirIter DBusDirIter;
00331 
00332 DBusDirIter* _dbus_directory_open          (const DBusString *filename,
00333                                             DBusError        *error);
00334 dbus_bool_t  _dbus_directory_get_next_file (DBusDirIter      *iter,
00335                                             DBusString       *filename,
00336                                             DBusError        *error);
00337 void         _dbus_directory_close         (DBusDirIter      *iter);
00338 
00339 dbus_bool_t  _dbus_check_dir_is_private_to_user    (DBusString *dir,
00340                                                     DBusError *error);
00341 
00342 void _dbus_fd_set_close_on_exec (intptr_t fd);
00343 
00344 const char* _dbus_get_tmpdir      (void);
00345 
00349 void        _dbus_generate_pseudorandom_bytes_buffer (char *buffer,
00350                                                       int   n_bytes);
00351 void        _dbus_generate_random_bytes_buffer (char       *buffer,
00352                                                 int         n_bytes);
00353 dbus_bool_t _dbus_generate_random_bytes        (DBusString *str,
00354                                                 int         n_bytes);
00355 dbus_bool_t _dbus_generate_random_ascii        (DBusString *str,
00356                                                 int         n_bytes);
00357 
00358 const char* _dbus_error_from_errno (int error_number);
00359 const char* _dbus_error_from_system_errno (void);
00360 
00361 void        _dbus_set_errno_to_zero                  (void);
00362 dbus_bool_t _dbus_get_is_errno_nonzero               (void);
00363 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void);
00364 dbus_bool_t _dbus_get_is_errno_enomem                (void);
00365 dbus_bool_t _dbus_get_is_errno_eintr                 (void);
00366 dbus_bool_t _dbus_get_is_errno_epipe                 (void);
00367 const char* _dbus_strerror_from_errno                (void);
00368 
00369 void _dbus_disable_sigpipe (void);
00370 
00371 
00372 void _dbus_exit (int code) _DBUS_GNUC_NORETURN;
00373 
00374 int _dbus_printf_string_upper_bound (const char *format,
00375                                      va_list args);
00376 
00377 
00381 typedef struct
00382 {
00383   unsigned long mode;  
00384   unsigned long nlink; 
00385   dbus_uid_t    uid;   
00386   dbus_gid_t    gid;   
00387   unsigned long size;  
00388   unsigned long atime; 
00389   unsigned long mtime; 
00390   unsigned long ctime; 
00391 } DBusStat;
00392 
00393 dbus_bool_t _dbus_stat             (const DBusString *filename,
00394                                     DBusStat         *statbuf,
00395                                     DBusError        *error);
00396 dbus_bool_t _dbus_full_duplex_pipe (int              *fd1,
00397                                     int              *fd2,
00398                                     dbus_bool_t       blocking,
00399                                     DBusError        *error);
00400 
00401 void        _dbus_print_backtrace  (void);
00402 
00403 dbus_bool_t _dbus_become_daemon   (const DBusString *pidfile,
00404                                    DBusPipe         *print_pid_pipe,
00405                                    DBusError        *error,
00406                                    dbus_bool_t       keep_umask);
00407 
00408 dbus_bool_t _dbus_verify_daemon_user    (const char *user);
00409 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
00410                                          DBusError  *error);
00411 
00412 dbus_bool_t _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile,
00413                                               DBusPipe         *print_pid_pipe,
00414                                               dbus_pid_t        pid_to_write,
00415                                               DBusError        *error);
00416 
00417 dbus_bool_t _dbus_command_for_pid (unsigned long  pid,
00418                                    DBusString    *str,
00419                                    int            max_len,
00420                                    DBusError     *error);
00421 
00423 typedef void (* DBusSignalHandler) (int sig);
00424 
00425 void _dbus_set_signal_handler (int               sig,
00426                                DBusSignalHandler handler);
00427 
00428 dbus_bool_t _dbus_user_at_console (const char *username,
00429                                    DBusError  *error);
00430 
00431 void _dbus_init_system_log (void);
00432 
00433 typedef enum {
00434   DBUS_SYSTEM_LOG_INFO,
00435   DBUS_SYSTEM_LOG_SECURITY,
00436   DBUS_SYSTEM_LOG_FATAL
00437 } DBusSystemLogSeverity;
00438 
00439 void _dbus_system_log (DBusSystemLogSeverity severity, const char *msg, ...) _DBUS_GNUC_PRINTF (2, 3);
00440 void _dbus_system_logv (DBusSystemLogSeverity severity, const char *msg, va_list args);
00441 
00442 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables.
00443  * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy.
00444  */
00445 #if !defined (DBUS_VA_COPY)
00446 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
00447 #    define DBUS_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
00448 #  elif defined (DBUS_VA_COPY_AS_ARRAY)
00449 #    define DBUS_VA_COPY(ap1, ap2)   memcpy ((ap1), (ap2), sizeof (va_list))
00450 #  else /* va_list is a pointer */
00451 #    define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
00452 #  endif /* va_list is a pointer */
00453 #endif /* !DBUS_VA_COPY */
00454 
00455 
00460 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
00461     (((const char*)&(p))[(i)])
00462 
00467 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b)                                       \
00468      (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) &&       \
00469       _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) &&       \
00470       _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) &&       \
00471       _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) &&       \
00472       _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) &&       \
00473       _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) &&       \
00474       _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) &&       \
00475       _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
00476 
00477 dbus_bool_t _dbus_get_autolaunch_address (DBusString *address, 
00478                                           DBusError *error);
00479 
00480 dbus_bool_t _dbus_lookup_session_address (dbus_bool_t *supported,
00481                                           DBusString  *address,
00482                                           DBusError   *error);
00483 
00487 typedef union DBusGUID DBusGUID;
00488 
00489 dbus_bool_t _dbus_read_local_machine_uuid   (DBusGUID         *machine_id,
00490                                              dbus_bool_t       create_if_not_found,
00491                                              DBusError        *error);
00492 
00498 dbus_bool_t _dbus_threads_init_platform_specific (void);
00499 
00500 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs, 
00501                                           const char *suffix, 
00502                                           DBusList **dir_list);
00503 
00504 unsigned long _dbus_pid_for_log (void);
00505 
00506 /* FIXME move back to dbus-sysdeps-unix.h probably -
00507  * the PID file handling just needs a little more abstraction
00508  * in the bus daemon first.
00509  */
00510 dbus_pid_t    _dbus_getpid (void);
00511 
00512 dbus_bool_t _dbus_change_to_daemon_user (const char *user,
00513                                          DBusError  *error);
00514 
00515 void _dbus_flush_caches (void);
00516 
00517 /*
00518  * replaces the term DBUS_PREFIX in configure_time_path by the
00519  * current dbus installation directory. On unix this function is a noop
00520  *
00521  * @param configure_time_path
00522  * @return real path
00523  */
00524 const char *
00525 _dbus_replace_install_prefix (const char *configure_time_path);
00526 
00529 DBUS_END_DECLS
00530 
00531 #endif /* DBUS_SYSDEPS_H */

Generated on Mon Sep 27 2010 22:54:24 for D-Bus by  doxygen 1.7.1