25 #ifndef DBUS_SYSDEPS_H
26 #define DBUS_SYSDEPS_H
29 #warning Please include config.h before dbus-sysdeps.h
37 #ifdef HAVE_INTTYPES_H
41 #include <dbus/dbus-errors.h>
42 #include <dbus/dbus-file.h>
43 #include <dbus/dbus-string.h>
51 #if !defined(BROKEN_POLL) && (defined(__APPLE__) || defined(__INTERIX))
91 #include "dbus-sysdeps-wince-glue.h"
101 #define _DBUS_PATH_SEPARATOR ";"
103 #define _DBUS_PATH_SEPARATOR ":"
142 #define DBUS_PID_UNSET ((dbus_pid_t) -1)
144 #define DBUS_UID_UNSET ((dbus_uid_t) -1)
146 #define DBUS_GID_UNSET ((dbus_gid_t) -1)
149 #define DBUS_PID_FORMAT "%lu"
151 #define DBUS_UID_FORMAT "%lu"
153 #define DBUS_GID_FORMAT "%lu"
161 # define DBUS_SOCKET_FORMAT "Iu"
162 # define DBUS_SOCKET_INIT { INVALID_SOCKET }
164 _DBUS_WARN_UNUSED_RESULT
166 _dbus_socket_printable (
DBusSocket s) {
return s.sock; }
168 _DBUS_WARN_UNUSED_RESULT
170 _dbus_socket_is_valid (
DBusSocket s) {
return s.sock != INVALID_SOCKET; }
173 _dbus_socket_invalidate (
DBusSocket *s) { s->sock = INVALID_SOCKET; }
175 _DBUS_WARN_UNUSED_RESULT
177 _dbus_socket_get_int (
DBusSocket s) {
return (
int)s.sock; }
182 # define DBUS_SOCKET_FORMAT "d"
183 # define DBUS_SOCKET_INIT { -1 }
185 _DBUS_WARN_UNUSED_RESULT
187 _dbus_socket_printable (
DBusSocket s) {
return s.fd; }
189 _DBUS_WARN_UNUSED_RESULT
191 _dbus_socket_is_valid (
DBusSocket s) {
return s.fd >= 0; }
194 _dbus_socket_invalidate (
DBusSocket *s) { s->fd = -1; }
196 _DBUS_WARN_UNUSED_RESULT
198 _dbus_socket_get_int (
DBusSocket s) {
return s.fd; }
202 _DBUS_WARN_UNUSED_RESULT
204 _dbus_socket_get_invalid (
void)
238 unsigned int *n_fds);
240 int _dbus_write_socket_with_unix_fds (
DBusSocket fd,
246 int _dbus_write_socket_with_unix_fds_two (
DBusSocket fd,
260 DBusSocket _dbus_connect_tcp_socket_with_nonce (
const char *host,
263 const char *noncefile,
269 const char **retfamily,
282 DBUS_CREDENTIALS_ADD_FLAGS_USER_DATABASE = (1 << 0),
283 DBUS_CREDENTIALS_ADD_FLAGS_NONE = 0
284 } DBusCredentialsAddFlags;
288 DBusCredentialsAddFlags flags,
300 dbus_gid_t **group_ids,
349 # define DBUS_POLLABLE_FORMAT "Iu"
351 static inline DBusPollable
352 _dbus_socket_get_pollable (
DBusSocket s) {
return s; }
355 _dbus_pollable_printable (DBusPollable p) {
return p.sock; }
358 _dbus_pollable_is_valid (DBusPollable p) {
return _dbus_socket_is_valid (p); }
361 _dbus_pollable_invalidate (DBusPollable *p) { _dbus_socket_invalidate (p); }
364 _dbus_pollable_equals (DBusPollable a, DBusPollable b) {
return a.sock == b.sock; }
373 typedef int DBusPollable;
374 # define DBUS_POLLABLE_FORMAT "d"
376 static inline DBusPollable
377 _dbus_socket_get_pollable (
DBusSocket s) {
return s.fd; }
380 _dbus_pollable_printable (DBusPollable p) {
return p; }
383 _dbus_pollable_is_valid (DBusPollable p) {
return p >= 0; }
386 _dbus_pollable_invalidate (DBusPollable *p) { *p = -1; }
389 _dbus_pollable_equals (DBusPollable a, DBusPollable b) {
return a == b; }
393 #if defined(HAVE_POLL) && !defined(BROKEN_POLL)
401 #define _DBUS_POLLIN POLLIN
403 #define _DBUS_POLLPRI POLLPRI
405 #define _DBUS_POLLOUT POLLOUT
407 #define _DBUS_POLLERR POLLERR
409 #define _DBUS_POLLHUP POLLHUP
411 #define _DBUS_POLLNVAL POLLNVAL
425 #define _DBUS_POLLIN 0x0001
427 #define _DBUS_POLLPRI 0x0002
429 #define _DBUS_POLLOUT 0x0004
431 #define _DBUS_POLLERR 0x0008
433 #define _DBUS_POLLHUP 0x0010
435 #define _DBUS_POLLNVAL 0x0020
441 int timeout_milliseconds);
502 _DBUS_WARN_UNUSED_RESULT
519 int _dbus_get_low_level_socket_errno (
void);
521 int _dbus_save_socket_errno (
void);
522 void _dbus_restore_socket_errno (
int saved_errno);
535 void _dbus_exit (
int code) _DBUS_GNUC_NORETURN;
539 va_list args) _DBUS_GNUC_PRINTF (1, 0);
541 #ifdef DBUS_ENABLE_VERBOSE_MODE
543 void _dbus_print_thread (
void);
584 dbus_pid_t pid_to_write,
596 DBUS_LOG_FLAGS_STDERR = (1 << 0),
597 DBUS_LOG_FLAGS_SYSTEM_LOG = (1 << 1)
605 DBUS_SYSTEM_LOG_INFO,
606 DBUS_SYSTEM_LOG_WARNING,
607 DBUS_SYSTEM_LOG_SECURITY,
608 DBUS_SYSTEM_LOG_ERROR
609 } DBusSystemLogSeverity;
612 void _dbus_log (DBusSystemLogSeverity severity,
614 ...) _DBUS_GNUC_PRINTF (2, 3);
616 void _dbus_logv (DBusSystemLogSeverity severity,
618 va_list args) _DBUS_GNUC_PRINTF (2, 0);
624 #define _DBUS_BYTE_OF_PRIMITIVE(p, i) \
625 (((const char*)&(p))[(i)])
631 #define _DBUS_DOUBLES_BITWISE_EQUAL(a, b) \
632 (_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) && \
633 _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) && \
634 _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) && \
635 _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) && \
636 _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) && \
637 _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) && \
638 _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) && \
639 _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
704 #define DBUS_DEFAULT_MESSAGE_UNIX_FDS 16
706 typedef struct DBusRLimit DBusRLimit;
708 DBusRLimit *_dbus_rlimit_save_fd_limit (
DBusError *error);
710 dbus_bool_t _dbus_rlimit_restore_fd_limit (DBusRLimit *saved,
712 void _dbus_rlimit_free (DBusRLimit *lim);
719 dbus_bool_t _dbus_inet_sockaddr_to_string (
const void *sockaddr_pointer,
723 const char **family_name,
726 void _dbus_set_error_with_inet_sockaddr (
DBusError *error,
727 const void *sockaddr_pointer,
729 const char *description,
731 void _dbus_combine_tcp_errors (
DBusList **sources,
743 #include "dbus-sysdeps-win.h"
An atomic integer safe to increment or decrement from multiple threads.
dbus_bool_t _dbus_split_paths_and_append(DBusString *dirs, const char *suffix, DBusList **dir_list)
Split paths into a list of char strings.
void _dbus_daemon_unpublish_session_bus_address(void)
Clear the platform-specific centralized location where the session bus address is published...
volatile dbus_int32_t value
Value of the atomic integer.
dbus_bool_t _dbus_check_dir_is_private_to_user(DBusString *dir, DBusError *error)
Checks to make sure the given directory is private to the user.
dbus_bool_t _dbus_get_is_errno_enomem(int e)
See if errno is ENOMEM.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_read_local_machine_uuid(DBusGUID *machine_id, dbus_bool_t create_if_not_found, DBusError *error)
Reads the uuid of the machine we're running on from the dbus configuration.
void _dbus_abort(void)
Aborts the program with SIGABRT (dumping core).
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_ensure_directory(const DBusString *filename, DBusError *error)
Creates a directory; succeeds if the directory is created or already existed.
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_socketpair(DBusSocket *fd1, DBusSocket *fd2, dbus_bool_t blocking, DBusError *error)
Creates pair of connect sockets (as in socketpair()).
Portable struct with stat() results.
dbus_bool_t _dbus_parse_unix_group_from_config(const DBusString *groupname, dbus_gid_t *gid_p)
Parse a UNIX group from the bus config file.
DBUS_PRIVATE_EXPORT void _dbus_log(DBusSystemLogSeverity severity, const char *msg,...)
Log a message to the system log file (e.g.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_path_is_absolute(const DBusString *filename)
Checks whether the filename is an absolute path.
unsigned long atime
Access time.
dbus_bool_t _dbus_check_setuid(void)
NOTE: If you modify this function, please also consider making the corresponding change in GLib...
dbus_bool_t _dbus_threads_init_platform_specific(void)
Initialize threads as in dbus_threads_init_default(), appropriately for the platform.
dbus_bool_t _dbus_get_standard_session_servicedirs(DBusList **dirs)
Returns the standard directories for a session bus to look for service activation files...
A globally unique ID ; we have one for each DBusServer, and also one for each machine with libdbus in...
DBUS_PRIVATE_EXPORT dbus_pid_t _dbus_getpid(void)
Gets our process ID.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_concat_dir_and_file(DBusString *dir, const DBusString *next_component)
Appends the given filename to the given directory.
DBUS_PRIVATE_EXPORT int _dbus_read_socket(DBusSocket fd, DBusString *buffer, int count)
Like _dbus_read(), but only works on sockets so is available on Windows.
dbus_bool_t _dbus_command_for_pid(unsigned long pid, DBusString *str, int max_len, DBusError *error)
Get a printable string describing the command used to execute the process with pid.
dbus_bool_t _dbus_get_system_config_file(DBusString *str)
Get the absolute path of the system.conf file (there is no system bus on Windows so this can just ret...
short events
Events to poll for.
dbus_bool_t _dbus_send_credentials_socket(DBusSocket server_fd, DBusError *error)
Sends a single nul byte with our UNIX credentials as ancillary data.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_close_socket(DBusSocket fd, DBusError *error)
Closes a socket.
dbus_bool_t _dbus_get_autolaunch_address(const char *scope, DBusString *address, DBusError *error)
Returns the address of a new session bus.
dbus_bool_t _dbus_clearenv(void)
Wrapper for clearenv().
dbus_bool_t _dbus_credentials_add_from_user(DBusCredentials *credentials, const DBusString *username, DBusCredentialsAddFlags flags, DBusError *error)
Adds the credentials corresponding to the given username.
Internals of directory iterator.
dbus_bool_t _dbus_user_at_console(const char *username, DBusError *error)
Checks if user is at the console.
unsigned long mode
File mode.
unsigned long dbus_pid_t
A process ID.
void _dbus_threads_unlock_platform_specific(void)
Undo _dbus_threads_lock_platform_specific().
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_append_user_from_current_process(DBusString *str)
Append to the string the identity we would like to have when we authenticate, on UNIX this is the cur...
void _dbus_threads_lock_platform_specific(void)
Lock a static mutex used to protect _dbus_threads_init_platform_specific().
dbus_gid_t gid
Group owning file.
DBUS_PRIVATE_EXPORT void _dbus_atomic_set_nonzero(DBusAtomic *atomic)
Atomically set the value of an integer to something nonzero.
dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock(int e)
See if errno is EAGAIN or EWOULDBLOCK (this has to be done differently for Winsock so is abstracted) ...
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
dbus_bool_t _dbus_get_session_config_file(DBusString *str)
Get the absolute path of the session.conf file.
void _dbus_daemon_report_stopping(void)
Report to a service manager that the daemon calling this function is shutting down.
_DBUS_WARN_UNUSED_RESULT dbus_bool_t _dbus_generate_random_bytes_buffer(char *buffer, int n_bytes, DBusError *error)
Random numbers.
dbus_bool_t _dbus_write_pid_to_file_and_pipe(const DBusString *pidfile, DBusPipe *print_pid_pipe, dbus_pid_t pid_to_write, DBusError *error)
Writes the given pid_to_write to a pidfile (if non-NULL) and/or to a pipe (if non-NULL).
int _dbus_write_socket_two(DBusSocket fd, const DBusString *buffer1, int start1, int len1, const DBusString *buffer2, int start2, int len2)
Like _dbus_write_two() but only works on sockets and is thus available on Windows.
DBusSocket _dbus_accept(DBusSocket listen_fd)
Accepts a connection on a listening socket.
DBUS_PRIVATE_EXPORT dbus_int32_t _dbus_atomic_inc(DBusAtomic *atomic)
Atomically increments an integer.
DBUS_PRIVATE_EXPORT void _dbus_print_backtrace(void)
On GNU libc systems, print a crude backtrace to stderr.
dbus_bool_t _dbus_change_to_daemon_user(const char *user, DBusError *error)
Changes the user and group the bus is running as.
dbus_bool_t _dbus_append_keyring_directory_for_credentials(DBusString *directory, DBusCredentials *credentials)
Appends the directory in which a keyring for the given credentials should be stored.
dbus_bool_t _dbus_read_credentials_socket(DBusSocket client_fd, DBusCredentials *credentials, DBusError *error)
Reads a single byte which must be nul (an error occurs otherwise), and reads unix credentials if avai...
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_create_directory(const DBusString *filename, DBusError *error)
directory interface
dbus_bool_t _dbus_verify_daemon_user(const char *user)
Verify that after the fork we can successfully change to this user.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_delete_directory(const DBusString *filename, DBusError *error)
Removes a directory; Directory must be empty.
Object representing an exception.
DBUS_PRIVATE_EXPORT void _dbus_atomic_set_zero(DBusAtomic *atomic)
Atomically set the value of an integer to 0.
DBUS_PRIVATE_EXPORT void _dbus_get_monotonic_time(long *tv_sec, long *tv_usec)
Get current time, as in gettimeofday().
void _dbus_disable_sigpipe(void)
signal (SIGPIPE, SIG_IGN);
dbus_bool_t _dbus_stat(const DBusString *filename, DBusStat *statbuf, DBusError *error)
stat() wrapper.
dbus_bool_t _dbus_unix_user_is_process_owner(dbus_uid_t uid)
Checks to see if the UNIX user ID matches the UID of the process.
DBUS_PRIVATE_EXPORT const char * _dbus_error_from_system_errno(void)
Converts the current system errno value into a DBusError name.
dbus_bool_t _dbus_unix_user_is_at_console(dbus_uid_t uid, DBusError *error)
Checks to see if the UNIX user ID is at the console.
dbus_bool_t _dbus_string_get_dirname(const DBusString *filename, DBusString *dirname)
Get the directory name from a complete filename.
dbus_bool_t _dbus_windows_user_is_process_owner(const char *windows_sid)
Checks to see if the Windows user SID matches the owner of the process.
int _dbus_read_socket_with_unix_fds(DBusSocket fd, DBusString *buffer, int count, int *fds, unsigned int *n_fds)
Like _dbus_read_socket() but also tries to read unix fds from the socket.
unsigned long ctime
Creation time.
DBUS_PRIVATE_EXPORT void _dbus_flush_caches(void)
Called when the bus daemon is signaled to reload its configuration; any caches should be nuked...
DBUS_PRIVATE_EXPORT const char * _dbus_get_tmpdir(void)
Gets the temporary files directory by inspecting the environment variables TMPDIR, TMP, and TEMP in that order.
dbus_bool_t _dbus_credentials_add_from_current_process(DBusCredentials *credentials)
Adds the most important credentials of the current process (the uid and pid) to the passed-in credent...
unsigned long nlink
Number of hard links.
DBusPollable fd
File descriptor.
dbus_uid_t uid
User owning file.
dbus_bool_t _dbus_become_daemon(const DBusString *pidfile, DBusPipe *print_pid_pipe, DBusError *error, dbus_bool_t keep_umask)
Does the chdir, fork, setsid, etc.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_generate_random_ascii(DBusString *str, int n_bytes, DBusError *error)
Generates the given number of random bytes, where the bytes are chosen from the alphanumeric ASCII su...
DBUS_PRIVATE_EXPORT void _dbus_exit(int code) _DBUS_GNUC_NORETURN
Exit the process, returning the given value.
unsigned long _dbus_pid_for_log(void)
The only reason this is separate from _dbus_getpid() is to allow it on Windows for logging but not fo...
void _dbus_directory_close(DBusDirIter *iter)
Closes a directory iteration.
DBUS_PRIVATE_EXPORT const char * _dbus_strerror_from_errno(void)
Get error message from errno.
DBusSocket _dbus_connect_tcp_socket(const char *host, const char *port, const char *family, DBusError *error)
Creates a socket and connects to a socket at the given host and port.
DBUS_PRIVATE_EXPORT dbus_int32_t _dbus_atomic_dec(DBusAtomic *atomic)
Atomically decrement an integer.
dbus_bool_t _dbus_parse_unix_user_from_config(const DBusString *username, dbus_uid_t *uid_p)
Parse a UNIX user from the bus config file.
DBUS_PRIVATE_EXPORT dbus_uid_t _dbus_getuid(void)
Gets our UID.
DBUS_PRIVATE_EXPORT void _dbus_init_system_log(const char *tag, DBusLogFlags flags)
Initialize the system log.
void _dbus_daemon_report_ready(void)
Report to a service manager that the daemon calling this function is ready for use.
dbus_bool_t _dbus_generate_random_bytes(DBusString *str, int n_bytes, DBusError *error)
Generates the given number of securely random bytes, using the best mechanism we can come up with...
dbus_bool_t _dbus_replace_install_prefix(DBusString *path)
Replace the DBUS_PREFIX in the given path, in-place, by the current D-Bus installation directory...
dbus_bool_t _dbus_set_socket_nonblocking(DBusSocket fd, DBusError *error)
Sets a file descriptor to be nonblocking.
char ** _dbus_get_environment(void)
Gets a NULL-terminated list of key=value pairs from the environment.
dbus_bool_t _dbus_get_is_errno_epipe(int e)
See if errno is EPIPE.
void _dbus_daemon_report_reloaded(void)
Report to a service manager that the daemon calling this function is reloading configuration.
dbus_bool_t _dbus_set_up_transient_session_servicedirs(DBusList **dirs, DBusError *error)
Returns the standard directories for a session bus to look for transient service activation files...
dbus_bool_t _dbus_lookup_session_address(dbus_bool_t *supported, DBusString *address, DBusError *error)
Determines the address of the session bus by querying a platform-specific method. ...
DBUS_PRIVATE_EXPORT void _dbus_logv(DBusSystemLogSeverity severity, const char *msg, va_list args)
Log a message to the system log file (e.g.
dbus_bool_t _dbus_unix_groups_from_uid(dbus_uid_t uid, dbus_gid_t **group_ids, int *n_group_ids)
Gets all groups corresponding to the given UNIX user ID.
dbus_bool_t _dbus_get_is_errno_eintr(int e)
See if errno is EINTR.
unsigned long mtime
Modify time.
void _dbus_daemon_report_reloading(void)
Report to a service manager that the daemon calling this function is reloading configuration.
DBUS_PRIVATE_EXPORT int _dbus_write_socket(DBusSocket fd, const DBusString *buffer, int start, int len)
Like _dbus_write(), but only supports sockets and is thus available on Windows.
DBusDirIter * _dbus_directory_open(const DBusString *filename, DBusError *error)
Open a directory to iterate over.
DBUS_PRIVATE_EXPORT dbus_int32_t _dbus_atomic_get(DBusAtomic *atomic)
Atomically get the value of an integer.
DBUS_PRIVATE_EXPORT void _dbus_sleep_milliseconds(int milliseconds)
Sleeps the given number of milliseconds.
DBUS_PRIVATE_EXPORT const char * _dbus_error_from_errno(int error_number)
Converts a UNIX errno, or Windows errno or WinSock error value into a DBusError name.
unsigned long dbus_gid_t
A group ID.
unsigned long size
Size of file.
DBUS_PRIVATE_EXPORT int _dbus_printf_string_upper_bound(const char *format, va_list args)
Measure the length of the given format string and arguments, not including the terminating nul...
int dbus_int32_t
A 32-bit signed integer on all platforms.
int _dbus_listen_tcp_socket(const char *host, const char *port, const char *family, DBusString *retport, const char **retfamily, DBusSocket **fds_p, DBusError *error)
Creates a socket and binds it to the given path, then listens on the socket.
dbus_bool_t _dbus_socket_can_pass_unix_fd(DBusSocket fd)
Checks whether file descriptors may be passed via the socket.
const char * _dbus_getenv(const char *varname)
Wrapper for getenv().
unsigned long dbus_uid_t
A user ID.
DBUS_PRIVATE_EXPORT int _dbus_poll(DBusPollFD *fds, int n_fds, int timeout_milliseconds)
Wrapper for poll().
short revents
Events that occurred.
dbus_bool_t _dbus_get_is_errno_etoomanyrefs(int e)
See if errno is ETOOMANYREFS.
void _dbus_set_errno_to_zero(void)
Assign 0 to the global errno variable.
dbus_bool_t _dbus_get_standard_system_servicedirs(DBusList **dirs)
Returns the standard directories for a system bus to look for service activation files.
dbus_bool_t _dbus_directory_get_next_file(DBusDirIter *iter, DBusString *filename, DBusError *error)
Get next file in the directory.
DBUS_PRIVATE_EXPORT void _dbus_get_real_time(long *tv_sec, long *tv_usec)
Get current time, as in gettimeofday().
unsigned short dbus_uint16_t
A 16-bit unsigned integer on all platforms.
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.