D-Bus 1.4.1
|
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 dbus_bool_t _dbus_daemon_is_session_bus_address_published (const char *scope); 00211 00212 dbus_bool_t _dbus_daemon_publish_session_bus_address (const char* address, const char* shm_name); 00213 00214 void _dbus_daemon_unpublish_session_bus_address (void); 00215 00216 dbus_bool_t _dbus_socket_can_pass_unix_fd(int fd); 00217 00221 typedef struct DBusAtomic DBusAtomic; 00222 00226 struct DBusAtomic 00227 { 00228 #ifdef DBUS_WIN 00229 volatile long value; 00230 #else 00231 volatile dbus_int32_t value; 00232 #endif 00233 }; 00234 00235 /* The value we get from autofoo is in the form of a cpp expression; 00236 * convert that to a conventional defined/undef switch. (We can't get 00237 * the conventional defined/undef because of multiarch builds only running 00238 * ./configure once, on Darwin.) */ 00239 #if DBUS_HAVE_ATOMIC_INT_COND 00240 # define DBUS_HAVE_ATOMIC_INT 1 00241 #else 00242 # undef DBUS_HAVE_ATOMIC_INT 00243 #endif 00244 00245 dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic); 00246 dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic); 00247 00248 00249 /* AIX uses different values for poll */ 00250 00251 #ifdef _AIX 00252 00253 #define _DBUS_POLLIN 0x0001 00254 00255 #define _DBUS_POLLPRI 0x0004 00256 00257 #define _DBUS_POLLOUT 0x0002 00258 00259 #define _DBUS_POLLERR 0x4000 00260 00261 #define _DBUS_POLLHUP 0x2000 00262 00263 #define _DBUS_POLLNVAL 0x8000 00264 #elif defined(__HAIKU__) 00265 00266 #define _DBUS_POLLIN 0x0001 00267 00268 #define _DBUS_POLLOUT 0x0002 00269 00270 #define _DBUS_POLLERR 0x0004 00271 00272 #define _DBUS_POLLPRI 0x0020 00273 00274 #define _DBUS_POLLHUP 0x0080 00275 00276 #define _DBUS_POLLNVAL 0x1000 00277 #else 00278 00279 #define _DBUS_POLLIN 0x0001 00280 00281 #define _DBUS_POLLPRI 0x0002 00282 00283 #define _DBUS_POLLOUT 0x0004 00284 00285 #define _DBUS_POLLERR 0x0008 00286 00287 #define _DBUS_POLLHUP 0x0010 00288 00289 #define _DBUS_POLLNVAL 0x0020 00290 #endif 00291 00295 typedef struct 00296 { 00297 int fd; 00298 short events; 00299 short revents; 00300 } DBusPollFD; 00301 00302 int _dbus_poll (DBusPollFD *fds, 00303 int n_fds, 00304 int timeout_milliseconds); 00305 00306 void _dbus_sleep_milliseconds (int milliseconds); 00307 00308 void _dbus_get_current_time (long *tv_sec, 00309 long *tv_usec); 00310 00314 dbus_bool_t _dbus_create_directory (const DBusString *filename, 00315 DBusError *error); 00316 dbus_bool_t _dbus_delete_directory (const DBusString *filename, 00317 DBusError *error); 00318 00319 dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir, 00320 const DBusString *next_component); 00321 dbus_bool_t _dbus_string_get_dirname (const DBusString *filename, 00322 DBusString *dirname); 00323 dbus_bool_t _dbus_path_is_absolute (const DBusString *filename); 00324 00325 dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs); 00326 dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs); 00327 00328 dbus_bool_t _dbus_append_system_config_file (DBusString *str); 00329 dbus_bool_t _dbus_append_session_config_file (DBusString *str); 00330 00332 typedef struct DBusDirIter DBusDirIter; 00333 00334 DBusDirIter* _dbus_directory_open (const DBusString *filename, 00335 DBusError *error); 00336 dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter, 00337 DBusString *filename, 00338 DBusError *error); 00339 void _dbus_directory_close (DBusDirIter *iter); 00340 00341 dbus_bool_t _dbus_check_dir_is_private_to_user (DBusString *dir, 00342 DBusError *error); 00343 00344 void _dbus_fd_set_close_on_exec (intptr_t fd); 00345 00346 const char* _dbus_get_tmpdir (void); 00347 00351 void _dbus_generate_pseudorandom_bytes_buffer (char *buffer, 00352 int n_bytes); 00353 void _dbus_generate_random_bytes_buffer (char *buffer, 00354 int n_bytes); 00355 dbus_bool_t _dbus_generate_random_bytes (DBusString *str, 00356 int n_bytes); 00357 dbus_bool_t _dbus_generate_random_ascii (DBusString *str, 00358 int n_bytes); 00359 00360 const char* _dbus_error_from_errno (int error_number); 00361 const char* _dbus_error_from_system_errno (void); 00362 00363 void _dbus_set_errno_to_zero (void); 00364 dbus_bool_t _dbus_get_is_errno_nonzero (void); 00365 dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void); 00366 dbus_bool_t _dbus_get_is_errno_enomem (void); 00367 dbus_bool_t _dbus_get_is_errno_eintr (void); 00368 dbus_bool_t _dbus_get_is_errno_epipe (void); 00369 const char* _dbus_strerror_from_errno (void); 00370 00371 void _dbus_disable_sigpipe (void); 00372 00373 00374 void _dbus_exit (int code) _DBUS_GNUC_NORETURN; 00375 00376 int _dbus_printf_string_upper_bound (const char *format, 00377 va_list args); 00378 00379 00383 typedef struct 00384 { 00385 unsigned long mode; 00386 unsigned long nlink; 00387 dbus_uid_t uid; 00388 dbus_gid_t gid; 00389 unsigned long size; 00390 unsigned long atime; 00391 unsigned long mtime; 00392 unsigned long ctime; 00393 } DBusStat; 00394 00395 dbus_bool_t _dbus_stat (const DBusString *filename, 00396 DBusStat *statbuf, 00397 DBusError *error); 00398 dbus_bool_t _dbus_full_duplex_pipe (int *fd1, 00399 int *fd2, 00400 dbus_bool_t blocking, 00401 DBusError *error); 00402 00403 void _dbus_print_backtrace (void); 00404 00405 dbus_bool_t _dbus_become_daemon (const DBusString *pidfile, 00406 DBusPipe *print_pid_pipe, 00407 DBusError *error, 00408 dbus_bool_t keep_umask); 00409 00410 dbus_bool_t _dbus_verify_daemon_user (const char *user); 00411 dbus_bool_t _dbus_change_to_daemon_user (const char *user, 00412 DBusError *error); 00413 00414 dbus_bool_t _dbus_write_pid_to_file_and_pipe (const DBusString *pidfile, 00415 DBusPipe *print_pid_pipe, 00416 dbus_pid_t pid_to_write, 00417 DBusError *error); 00418 00419 dbus_bool_t _dbus_command_for_pid (unsigned long pid, 00420 DBusString *str, 00421 int max_len, 00422 DBusError *error); 00423 00425 typedef void (* DBusSignalHandler) (int sig); 00426 00427 void _dbus_set_signal_handler (int sig, 00428 DBusSignalHandler handler); 00429 00430 dbus_bool_t _dbus_user_at_console (const char *username, 00431 DBusError *error); 00432 00433 void _dbus_init_system_log (void); 00434 00435 typedef enum { 00436 DBUS_SYSTEM_LOG_INFO, 00437 DBUS_SYSTEM_LOG_SECURITY, 00438 DBUS_SYSTEM_LOG_FATAL 00439 } DBusSystemLogSeverity; 00440 00441 void _dbus_system_log (DBusSystemLogSeverity severity, const char *msg, ...) _DBUS_GNUC_PRINTF (2, 3); 00442 void _dbus_system_logv (DBusSystemLogSeverity severity, const char *msg, va_list args); 00443 00444 /* Define DBUS_VA_COPY() to do the right thing for copying va_list variables. 00445 * config.h may have already defined DBUS_VA_COPY as va_copy or __va_copy. 00446 */ 00447 #if !defined (DBUS_VA_COPY) 00448 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32)) 00449 # define DBUS_VA_COPY(ap1, ap2) (*(ap1) = *(ap2)) 00450 # elif defined (DBUS_VA_COPY_AS_ARRAY) 00451 # define DBUS_VA_COPY(ap1, ap2) memcpy ((ap1), (ap2), sizeof (va_list)) 00452 # else /* va_list is a pointer */ 00453 # define DBUS_VA_COPY(ap1, ap2) ((ap1) = (ap2)) 00454 # endif /* va_list is a pointer */ 00455 #endif /* !DBUS_VA_COPY */ 00456 00457 00462 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \ 00463 (((const char*)&(p))[(i)]) 00464 00469 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b) \ 00470 (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) && \ 00471 _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) && \ 00472 _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) && \ 00473 _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) && \ 00474 _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) && \ 00475 _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) && \ 00476 _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) && \ 00477 _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7)) 00478 00479 dbus_bool_t _dbus_get_autolaunch_address (const char *scope, 00480 DBusString *address, 00481 DBusError *error); 00482 00483 dbus_bool_t _dbus_lookup_session_address (dbus_bool_t *supported, 00484 DBusString *address, 00485 DBusError *error); 00486 00490 typedef union DBusGUID DBusGUID; 00491 00492 dbus_bool_t _dbus_read_local_machine_uuid (DBusGUID *machine_id, 00493 dbus_bool_t create_if_not_found, 00494 DBusError *error); 00495 00501 dbus_bool_t _dbus_threads_init_platform_specific (void); 00502 00503 dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs, 00504 const char *suffix, 00505 DBusList **dir_list); 00506 00507 unsigned long _dbus_pid_for_log (void); 00508 00509 /* FIXME move back to dbus-sysdeps-unix.h probably - 00510 * the PID file handling just needs a little more abstraction 00511 * in the bus daemon first. 00512 */ 00513 dbus_pid_t _dbus_getpid (void); 00514 00515 dbus_bool_t _dbus_change_to_daemon_user (const char *user, 00516 DBusError *error); 00517 00518 void _dbus_flush_caches (void); 00519 00520 /* 00521 * replaces the term DBUS_PREFIX in configure_time_path by the 00522 * current dbus installation directory. On unix this function is a noop 00523 * 00524 * @param configure_time_path 00525 * @return real path 00526 */ 00527 const char * 00528 _dbus_replace_install_prefix (const char *configure_time_path); 00529 00530 void _dbus_request_file_descriptor_limit (unsigned int limit); 00531 00534 DBUS_END_DECLS 00535 00536 #endif /* DBUS_SYSDEPS_H */