D-Bus  1.8.1
Data Structures | Macros | Typedefs | Enumerations | Functions

Internal system-dependent API available on UNIX and Windows. More...

Data Structures

struct  DBusAtomic
 An atomic integer safe to increment or decrement from multiple threads. More...
 
struct  DBusPollFD
 A portable struct pollfd wrapper. More...
 
struct  DBusStat
 Portable struct with stat() results. More...
 

Macros

#define DBUS_PID_UNSET   ((dbus_pid_t) -1)
 an invalid PID used to represent an uninitialized dbus_pid_t field
 
#define DBUS_UID_UNSET   ((dbus_uid_t) -1)
 an invalid UID used to represent an uninitialized dbus_uid_t field
 
#define DBUS_GID_UNSET   ((dbus_gid_t) -1)
 an invalid GID used to represent an uninitialized dbus_gid_t field
 
#define DBUS_PID_FORMAT   "%lu"
 an appropriate printf format for dbus_pid_t
 
#define DBUS_UID_FORMAT   "%lu"
 an appropriate printf format for dbus_uid_t
 
#define DBUS_GID_FORMAT   "%lu"
 an appropriate printf format for dbus_gid_t
 
#define _DBUS_POLLIN   0x0001
 There is data to read.
 
#define _DBUS_POLLPRI   0x0002
 There is urgent data to read.
 
#define _DBUS_POLLOUT   0x0004
 Writing now will not block.
 
#define _DBUS_POLLERR   0x0008
 Error condition.
 
#define _DBUS_POLLHUP   0x0010
 Hung up.
 
#define _DBUS_POLLNVAL   0x0020
 Invalid request: fd not open.
 
#define DBUS_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
 
#define _DBUS_BYTE_OF_PRIMITIVE(p, i)   (((const char*)&(p))[(i)])
 Casts a primitive C type to a byte array and then indexes a particular byte of the array.
 
#define _DBUS_DOUBLES_BITWISE_EQUAL(a, b)
 On x86 there is an 80-bit FPU, and if you do "a == b" it may have a or b in an 80-bit register, thus failing to compare the two 64-bit doubles for bitwise equality. More...
 

Typedefs

typedef unsigned long dbus_pid_t
 A process ID.
 
typedef unsigned long dbus_uid_t
 A user ID.
 
typedef unsigned long dbus_gid_t
 A group ID.
 
typedef struct DBusAtomic DBusAtomic
 Opaque type representing an atomically-modifiable integer that can be used from multiple threads.
 
typedef struct DBusDirIter DBusDirIter
 Opaque type for reading a directory listing.
 
typedef void(* DBusSignalHandler )(int sig)
 A UNIX signal handler.
 
typedef union DBusGUID DBusGUID
 Type representing a universally unique ID. More...
 

Enumerations

enum  DBusSystemLogSeverity { DBUS_SYSTEM_LOG_INFO, DBUS_SYSTEM_LOG_SECURITY, DBUS_SYSTEM_LOG_FATAL }
 

Functions

void _dbus_abort (void)
 Aborts the program with SIGABRT (dumping core).
 
const char * _dbus_getenv (const char *varname)
 Wrapper for getenv(). More...
 
dbus_bool_t _dbus_clearenv (void)
 Wrapper for clearenv(). More...
 
dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs, const char *suffix, DBusList **dir_list)
 Split paths into a list of char strings. More...
 
dbus_bool_t _dbus_check_setuid (void)
 NOTE: If you modify this function, please also consider making the corresponding change in GLib. More...
 
char ** _dbus_get_environment (void)
 Gets a NULL-terminated list of key=value pairs from the environment. More...
 
dbus_bool_t _dbus_close_socket (int fd, DBusError *error)
 Socket interface. More...
 
int _dbus_read_socket (int fd, DBusString *buffer, int count)
 Like _dbus_read(), but only works on sockets so is available on Windows. More...
 
int _dbus_write_socket (int fd, const DBusString *buffer, int start, int len)
 Like _dbus_write(), but only supports sockets and is thus available on Windows. More...
 
int _dbus_write_socket_two (int 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. More...
 
int _dbus_read_socket_with_unix_fds (int fd, DBusString *buffer, int count, int *fds, int *n_fds)
 Like _dbus_read_socket() but also tries to read unix fds from the socket. More...
 
int _dbus_write_socket_with_unix_fds (int fd, const DBusString *buffer, int start, int len, const int *fds, int n_fds)
 
int _dbus_write_socket_with_unix_fds_two (int fd, const DBusString *buffer1, int start1, int len1, const DBusString *buffer2, int start2, int len2, const int *fds, int n_fds)
 
dbus_bool_t _dbus_socket_is_invalid (int fd)
 
int _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. More...
 
int _dbus_connect_tcp_socket_with_nonce (const char *host, const char *port, const char *family, const char *noncefile, DBusError *error)
 
int _dbus_listen_tcp_socket (const char *host, const char *port, const char *family, DBusString *retport, int **fds_p, DBusError *error)
 Creates a socket and binds it to the given path, then listens on the socket. More...
 
int _dbus_accept (int listen_fd)
 Accepts a connection on a listening socket. More...
 
dbus_bool_t _dbus_read_credentials_socket (int client_fd, DBusCredentials *credentials, DBusError *error)
 Reads a single byte which must be nul (an error occurs otherwise), and reads unix credentials if available. More...
 
dbus_bool_t _dbus_send_credentials_socket (int server_fd, DBusError *error)
 Sends a single nul byte with our UNIX credentials as ancillary data. More...
 
dbus_bool_t _dbus_credentials_add_from_user (DBusCredentials *credentials, const DBusString *username)
 Adds the credentials corresponding to the given username. More...
 
dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials *credentials)
 Adds the credentials of the current process to the passed-in credentials object. More...
 
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 current process UID and on Windows something else, probably a Windows SID string. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
dbus_bool_t _dbus_daemon_is_session_bus_address_published (const char *scope)
 
dbus_bool_t _dbus_daemon_publish_session_bus_address (const char *address, const char *shm_name)
 
void _dbus_daemon_unpublish_session_bus_address (void)
 
dbus_bool_t _dbus_socket_can_pass_unix_fd (int fd)
 Checks whether file descriptors may be passed via the socket. More...
 
dbus_int32_t _dbus_atomic_inc (DBusAtomic *atomic)
 Atomically increments an integer. More...
 
dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic)
 Atomically decrement an integer. More...
 
dbus_int32_t _dbus_atomic_get (DBusAtomic *atomic)
 Atomically get the value of an integer. More...
 
int _dbus_poll (DBusPollFD *fds, int n_fds, int timeout_milliseconds)
 Wrapper for poll(). More...
 
void _dbus_sleep_milliseconds (int milliseconds)
 Sleeps the given number of milliseconds. More...
 
void _dbus_get_monotonic_time (long *tv_sec, long *tv_usec)
 Get current time, as in gettimeofday(). More...
 
void _dbus_get_real_time (long *tv_sec, long *tv_usec)
 Get current time, as in gettimeofday(). More...
 
dbus_bool_t _dbus_create_directory (const DBusString *filename, DBusError *error)
 directory interface More...
 
dbus_bool_t _dbus_delete_directory (const DBusString *filename, DBusError *error)
 Removes a directory; Directory must be empty. More...
 
dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir, const DBusString *next_component)
 Appends the given filename to the given directory. More...
 
dbus_bool_t _dbus_string_get_dirname (const DBusString *filename, DBusString *dirname)
 Get the directory name from a complete filename. More...
 
dbus_bool_t _dbus_path_is_absolute (const DBusString *filename)
 Checks whether the filename is an absolute path. More...
 
dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs)
 Returns the standard directories for a session bus to look for service activation files. More...
 
dbus_bool_t _dbus_get_standard_system_servicedirs (DBusList **dirs)
 Returns the standard directories for a system bus to look for service activation files. More...
 
dbus_bool_t _dbus_append_system_config_file (DBusString *str)
 Append the absolute path of the system.conf file (there is no system bus on Windows so this can just return FALSE and print a warning or something) More...
 
dbus_bool_t _dbus_append_session_config_file (DBusString *str)
 Append the absolute path of the session.conf file. More...
 
DBusDirIter_dbus_directory_open (const DBusString *filename, DBusError *error)
 Open a directory to iterate over. More...
 
dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter, DBusString *filename, DBusError *error)
 Get next file in the directory. More...
 
void _dbus_directory_close (DBusDirIter *iter)
 Closes a directory iteration.
 
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. More...
 
void _dbus_fd_set_close_on_exec (intptr_t fd)
 Sets the file descriptor to be close on exec. More...
 
const char * _dbus_get_tmpdir (void)
 Gets the temporary files directory by inspecting the environment variables TMPDIR, TMP, and TEMP in that order. More...
 
void _dbus_generate_pseudorandom_bytes_buffer (char *buffer, int n_bytes)
 Random numbers.
 
void _dbus_generate_random_bytes_buffer (char *buffer, int n_bytes)
 Fills n_bytes of the given buffer with random bytes. More...
 
dbus_bool_t _dbus_generate_random_bytes (DBusString *str, int n_bytes)
 Generates the given number of random bytes, using the best mechanism we can come up with. More...
 
dbus_bool_t _dbus_generate_random_ascii (DBusString *str, int n_bytes)
 Generates the given number of random bytes, where the bytes are chosen from the alphanumeric ASCII subset. More...
 
const char * _dbus_error_from_errno (int error_number)
 Converts a UNIX errno, or Windows errno or WinSock error value into a DBusError name. More...
 
const char * _dbus_error_from_system_errno (void)
 Converts the current system errno value into a DBusError name. More...
 
void _dbus_set_errno_to_zero (void)
 Assign 0 to the global errno variable.
 
dbus_bool_t _dbus_get_is_errno_nonzero (void)
 See if errno is set. More...
 
dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock (void)
 See if errno is EAGAIN or EWOULDBLOCK (this has to be done differently for Winsock so is abstracted) More...
 
dbus_bool_t _dbus_get_is_errno_enomem (void)
 See if errno is ENOMEM. More...
 
dbus_bool_t _dbus_get_is_errno_eintr (void)
 See if errno is EINTR. More...
 
dbus_bool_t _dbus_get_is_errno_epipe (void)
 See if errno is EPIPE. More...
 
const char * _dbus_strerror_from_errno (void)
 Get error message from errno. More...
 
void _dbus_disable_sigpipe (void)
 signal (SIGPIPE, SIG_IGN);
 
void _dbus_exit (int code) _DBUS_GNUC_NORETURN
 Exit the process, returning the given value. More...
 
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. More...
 
dbus_bool_t _dbus_stat (const DBusString *filename, DBusStat *statbuf, DBusError *error)
 stat() wrapper. More...
 
dbus_bool_t _dbus_full_duplex_pipe (int *fd1, int *fd2, dbus_bool_t blocking, DBusError *error)
 Creates a full-duplex pipe (as in socketpair()). More...
 
void _dbus_print_backtrace (void)
 On GNU libc systems, print a crude backtrace to stderr. More...
 
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. More...
 
dbus_bool_t _dbus_verify_daemon_user (const char *user)
 Verify that after the fork we can successfully change to this user. More...
 
dbus_bool_t _dbus_change_to_daemon_user (const char *user, DBusError *error)
 Changes the user and group the bus is running as. More...
 
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). More...
 
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. More...
 
void _dbus_set_signal_handler (int sig, DBusSignalHandler handler)
 Installs a UNIX signal handler. More...
 
dbus_bool_t _dbus_user_at_console (const char *username, DBusError *error)
 Checks if user is at the console. More...
 
void _dbus_init_system_log (dbus_bool_t is_daemon)
 
void _dbus_system_log (DBusSystemLogSeverity severity, const char *msg,...)
 Log a message to the system log file (e.g. More...
 
void _dbus_system_logv (DBusSystemLogSeverity severity, const char *msg, va_list args)
 Log a message to the system log file (e.g. More...
 
dbus_bool_t _dbus_get_autolaunch_address (const char *scope, DBusString *address, DBusError *error)
 Returns the address of a new session bus. More...
 
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. More...
 
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. More...
 
dbus_bool_t _dbus_threads_init_platform_specific (void)
 Initialize threads as in dbus_threads_init_default(), appropriately for the platform. More...
 
void _dbus_threads_lock_platform_specific (void)
 Lock a static mutex used to protect _dbus_threads_init_platform_specific().
 
void _dbus_threads_unlock_platform_specific (void)
 Undo _dbus_threads_lock_platform_specific().
 
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 for other purposes. More...
 
dbus_pid_t _dbus_getpid (void)
 Gets our process ID. More...
 
void _dbus_flush_caches (void)
 Called when the bus daemon is signaled to reload its configuration; any caches should be nuked. More...
 
void _dbus_request_file_descriptor_limit (unsigned int limit)
 Attempt to ensure that the current process can open at least limit file descriptors. More...
 
const char * _dbus_replace_install_prefix (const char *configure_time_path)
 

Detailed Description

Internal system-dependent API available on UNIX and Windows.

The system-dependent API has a dual purpose. First, it encapsulates all usage of operating system APIs for ease of auditing and to avoid cluttering the rest of the code with bizarre OS quirks and headers. Second, it abstracts different operating system APIs for portability.

Macro Definition Documentation

#define _DBUS_DOUBLES_BITWISE_EQUAL (   a,
 
)
Value:
#define _DBUS_BYTE_OF_PRIMITIVE(p, i)
Casts a primitive C type to a byte array and then indexes a particular byte of the array...
Definition: dbus-sysdeps.h:480

On x86 there is an 80-bit FPU, and if you do "a == b" it may have a or b in an 80-bit register, thus failing to compare the two 64-bit doubles for bitwise equality.

So this macro compares the two doubles bitwise.

Definition at line 487 of file dbus-sysdeps.h.

Typedef Documentation

typedef union DBusGUID DBusGUID

Type representing a universally unique ID.

Todo:
rename to UUID instead of GUID

Definition at line 508 of file dbus-sysdeps.h.

Function Documentation

int _dbus_accept ( int  listen_fd)

Accepts a connection on a listening socket.

Handles EINTR for you.

This will enable FD_CLOEXEC for the returned socket.

Parameters
listen_fdthe listen file descriptor
Returns
the connection fd of the client, or -1 on error

Handles EINTR for you.

Parameters
listen_fdthe listen file descriptor
Returns
the connection fd of the client, or -1 on error

Definition at line 1930 of file dbus-sysdeps-unix.c.

References _dbus_fd_set_close_on_exec(), and NULL.

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.

The credentials should have either a Windows or UNIX user in them. The directory should be an absolute path.

On UNIX the directory is ~/.dbus-keyrings while on Windows it should probably be something else, since the dotfile convention is not normal on Windows.

Parameters
directorystring to append directory to
credentialscredentials the directory should be for
Returns
FALSE on no memory

Definition at line 3789 of file dbus-sysdeps-unix.c.

References _dbus_assert, _dbus_concat_dir_and_file(), _dbus_credentials_are_anonymous(), _dbus_credentials_get_unix_uid(), _dbus_getenv(), _dbus_homedir_from_uid(), _dbus_string_append(), _dbus_string_copy(), _dbus_string_free(), _dbus_string_get_const_data(), _dbus_string_get_length(), _dbus_string_init(), _dbus_string_init_const(), _dbus_string_set_length(), _dbus_warn(), DBUS_UID_UNSET, FALSE, NULL, and TRUE.

Referenced by _dbus_keyring_new_for_credentials().

dbus_bool_t _dbus_append_session_config_file ( DBusString str)

Append the absolute path of the session.conf file.

Parameters
strthe string to append to
Returns
FALSE if no memory

Definition at line 1355 of file dbus-sysdeps-util-unix.c.

References _dbus_string_append().

dbus_bool_t _dbus_append_system_config_file ( DBusString str)

Append the absolute path of the system.conf file (there is no system bus on Windows so this can just return FALSE and print a warning or something)

Parameters
strthe string to append to
Returns
FALSE if no memory

Definition at line 1343 of file dbus-sysdeps-util-unix.c.

References _dbus_string_append().

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 current process UID and on Windows something else, probably a Windows SID string.

No escaping is required, that is done in dbus-auth.c. The username here need not be anything human-readable, it can be the machine-readable form i.e. a user id.

Parameters
strthe string to append to
Returns
FALSE on no memory

No escaping is required, that is done in dbus-auth.c. The username here need not be anything human-readable, it can be the machine-readable form i.e. a user id.

Parameters
strthe string to append to
Returns
FALSE on no memory
Todo:
to which class belongs this

Definition at line 2361 of file dbus-sysdeps-unix.c.

References _dbus_geteuid(), _dbus_getpid(), _dbus_string_append(), _dbus_string_append_uint(), FALSE, and NULL.

dbus_int32_t _dbus_atomic_dec ( DBusAtomic atomic)

Atomically decrement an integer.

Parameters
atomicpointer to the integer to decrement
Returns
the value before decrementing

Definition at line 2486 of file dbus-sysdeps-unix.c.

References DBusAtomic::value.

Referenced by _dbus_connection_unref_unlocked(), _dbus_pending_call_unref_and_unlock(), _dbus_server_unref_unlocked(), dbus_connection_unref(), dbus_free(), dbus_message_unref(), dbus_pending_call_unref(), dbus_server_ref(), and dbus_server_unref().

dbus_int32_t _dbus_atomic_get ( DBusAtomic atomic)

Atomically get the value of an integer.

It may change at any time thereafter, so this is mostly only useful for assertions.

Parameters
atomicpointer to the integer to get
Returns
the value at this moment

Definition at line 2510 of file dbus-sysdeps-unix.c.

References DBusAtomic::value.

Referenced by _dbus_connection_close_if_only_one_ref().

dbus_int32_t _dbus_atomic_inc ( DBusAtomic atomic)
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.

to become a daemon process.

Parameters
pidfileNULL, or pidfile to create
print_pid_pipepipe to print daemon's pid to, or -1 for none
errorreturn location for errors
keep_umaskTRUE to keep the original umask
Returns
FALSE on failure

to become a daemon process.

Parameters
pidfileNULL, or pidfile to create
print_pid_pipefile descriptor to print daemon's pid to, or -1 for none
errorreturn location for errors
keep_umaskTRUE to keep the original umask
Returns
FALSE on failure

Definition at line 83 of file dbus-sysdeps-util-unix.c.

References _dbus_assert_not_reached, _dbus_error_from_errno(), _dbus_getenv(), _dbus_write_pid_to_file_and_pipe(), DBUS_ERROR_FAILED, DBUS_ERROR_NOT_SUPPORTED, dbus_set_error(), FALSE, DBusError::message, NULL, and TRUE.

dbus_bool_t _dbus_change_to_daemon_user ( const char *  user,
DBusError error 
)

Changes the user and group the bus is running as.

Parameters
userthe user to become
errorreturn location for errors
Returns
FALSE on failure

Definition at line 330 of file dbus-sysdeps-util-unix.c.

References _dbus_error_from_errno(), _dbus_get_user_id_and_primary_group(), _dbus_string_init_const(), _dbus_warn(), DBUS_ERROR_FAILED, dbus_set_error(), FALSE, NULL, and TRUE.

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.

Parameters
dirthe name of the directory
errorerror return
Returns
FALSE on failure

Definition at line 1985 of file dbus-sysdeps-unix.c.

References _dbus_error_from_errno(), _dbus_string_get_const_data(), DBUS_ERROR_FAILED, dbus_set_error(), FALSE, and TRUE.

dbus_bool_t _dbus_check_setuid ( void  )

NOTE: If you modify this function, please also consider making the corresponding change in GLib.

See glib/gutils.c:g_check_setuid().

Returns TRUE if the current process was executed as setuid (or an equivalent __libc_enable_secure is available). See: http://osdir.com/ml/linux.lfs.hardened/2007-04/msg00032.html

Definition at line 4016 of file dbus-sysdeps-unix.c.

References FALSE, and TRUE.

Referenced by _dbus_get_autolaunch_address(), _dbus_getenv(), _dbus_keyring_new_for_credentials(), _dbus_lookup_launchd_socket(), and _dbus_threads_init_platform_specific().

dbus_bool_t _dbus_clearenv ( void  )

Wrapper for clearenv().

Returns
TRUE on success.

Definition at line 201 of file dbus-sysdeps.c.

References FALSE, NULL, and TRUE.

dbus_bool_t _dbus_close_socket ( int  fd,
DBusError error 
)

Socket interface.

Todo:
Use for the file descriptors a struct
  • struct DBusSocket{ int d; }; - instead of int to get type-safety which will be checked by the compiler.

Socket interface.

Should not be used on non-socket file descriptors or handles.

Parameters
fdthe socket
errorreturn location for an error
Returns
FALSE if error is set

Socket interface.

Parameters
fdthe file descriptor
errorerror object
Returns
FALSE if error set

Definition at line 201 of file dbus-sysdeps-unix.c.

References _dbus_close(), _dbus_error_from_errno(), _dbus_strerror_from_errno(), dbus_set_error(), FALSE, and TRUE.

Referenced by _dbus_babysitter_unref(), _dbus_server_listen_platform_specific(), _dbus_server_new_for_domain_socket(), _dbus_server_new_for_tcp_socket(), _dbus_transport_new_for_domain_socket(), and _dbus_transport_new_for_tcp_socket().

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.

This string should only be used for informative purposes such as logging; it may not be trusted.

The command is guaranteed to be printable ASCII and no longer than max_len.

Parameters
pidProcess id
strAppend command to this string
max_lenMaximum length of returned command
errorreturn location for errors
Returns
FALSE on error

Definition at line 1116 of file dbus-sysdeps-util-unix.c.

References _dbus_close(), _dbus_error_from_errno(), _dbus_read(), _dbus_string_append_printf(), _dbus_string_copy(), _dbus_string_free(), _dbus_string_get_const_data(), _dbus_string_get_length(), _dbus_string_init(), dbus_set_error(), FALSE, NULL, and TRUE.

dbus_bool_t _dbus_concat_dir_and_file ( DBusString dir,
const DBusString next_component 
)

Appends the given filename to the given directory.

Todo:
it might be cute to collapse multiple '/' such as "foo//" concat "//bar"
Parameters
dirthe directory name
next_componentthe filename
Returns
TRUE on success
Todo:
it might be cute to collapse multiple '/' such as "foo//" concat "//bar"
Parameters
dirthe directory name
next_componentthe filename
Returns
TRUE on success

Definition at line 2721 of file dbus-sysdeps-unix.c.

References _dbus_string_append_byte(), _dbus_string_copy(), _dbus_string_get_byte(), _dbus_string_get_length(), _dbus_string_shorten(), FALSE, and TRUE.

Referenced by _dbus_append_keyring_directory_for_credentials(), _dbus_get_standard_session_servicedirs(), _dbus_keyring_new_for_credentials(), _dbus_server_listen_platform_specific(), _dbus_split_paths_and_append(), and _dbus_user_at_console().

int _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.

The connection fd is returned, and is set up as nonblocking.

This will set FD_CLOEXEC for the socket returned

Parameters
hostthe host name to connect to
portthe port to connect to
familythe address family to listen on, NULL for all
errorreturn location for error code
Returns
connection file descriptor or -1 on error

The connection fd is returned, and is set up as nonblocking.

Parameters
hostthe host name to connect to
portthe port to connect to
familythe address family to listen on, NULL for all
errorreturn location for error code
Returns
connection file descriptor or -1 on error

Definition at line 1216 of file dbus-sysdeps-unix.c.

References NULL.

dbus_bool_t _dbus_create_directory ( const DBusString filename,
DBusError error 
)

directory interface

directory interface

Parameters
filenamedirectory filename
errorinitialized error object
Returns
TRUE on success

Definition at line 2687 of file dbus-sysdeps-unix.c.

References _dbus_strerror_from_errno(), _dbus_string_get_const_data(), DBUS_ERROR_FAILED, dbus_set_error(), FALSE, NULL, and TRUE.

Referenced by _dbus_keyring_new_for_credentials().

dbus_bool_t _dbus_credentials_add_from_current_process ( DBusCredentials credentials)

Adds the credentials of the current process to the passed-in credentials object.

Parameters
credentialscredentials to add to
Returns
FALSE if no memory; does not properly roll back on failure, so only some credentials may have been added

Definition at line 2331 of file dbus-sysdeps-unix.c.

References _dbus_assert, _dbus_credentials_add_pid(), _dbus_credentials_add_unix_uid(), _dbus_credentials_add_windows_sid(), _dbus_geteuid(), _dbus_getpid(), FALSE, NULL, and TRUE.

Referenced by _dbus_credentials_new_from_current_process(), and _dbus_keyring_new_for_credentials().

dbus_bool_t _dbus_credentials_add_from_user ( DBusCredentials credentials,
const DBusString username 
)

Adds the credentials corresponding to the given username.

Parameters
credentialscredentials to fill in
usernamethe username
Returns
TRUE if the username existed and we got some credentials

Used among other purposes to parses a desired identity provided from a client in the auth protocol. On UNIX this means parsing a UID, on Windows probably parsing an SID string.

Todo:
this is broken because it treats OOM and parse error the same way. Needs a DBusError.
Parameters
credentialscredentials to fill in
usernamethe username
Returns
TRUE if the username existed and we got some credentials

Definition at line 2048 of file dbus-sysdeps-win.c.

References _dbus_credentials_add_unix_uid(), _dbus_credentials_add_windows_sid(), _dbus_string_get_const_data(), _dbus_user_database_get_system(), _dbus_user_database_get_username(), _dbus_user_database_lock_system(), _dbus_user_database_unlock_system(), FALSE, NULL, TRUE, and DBusUserInfo::uid.

dbus_bool_t _dbus_delete_directory ( const DBusString filename,
DBusError error 
)

Removes a directory; Directory must be empty.

Parameters
filenamedirectory filename
errorinitialized error object
Returns
TRUE on success

Definition at line 3889 of file dbus-sysdeps-unix.c.

References _dbus_string_get_const_data(), DBUS_ERROR_FAILED, dbus_set_error(), FALSE, and TRUE.

dbus_bool_t _dbus_directory_get_next_file ( DBusDirIter iter,
DBusString filename,
DBusError error 
)

Get next file in the directory.

Will not return "." or ".." on UNIX. If an error occurs, the contents of "filename" are undefined. The error is never set if the function succeeds.

This function is not re-entrant, and not necessarily thread-safe. Only use it for test code or single-threaded utilities.

Parameters
iterthe iterator
filenamestring to be set to the next file in the dir
errorreturn location for error
Returns
TRUE if filename was filled in with a new filename

Will not return "." or ".." on UNIX. If an error occurs, the contents of "filename" are undefined. The error is never set if the function succeeds.

Todo:
for thread safety, I think we have to use readdir_r(). (GLib has the same issue, should file a bug.)
Parameters
iterthe iterator
filenamestring to be set to the next file in the dir
errorreturn location for error
Returns
TRUE if filename was filled in with a new filename

Definition at line 710 of file dbus-sysdeps-util-unix.c.

References _dbus_error_from_errno(), _dbus_string_append(), _dbus_string_set_length(), DBusDirIter::d, DBUS_ERROR_NO_MEMORY, dbus_set_error(), FALSE, NULL, and TRUE.

DBusDirIter* _dbus_directory_open ( const DBusString filename,
DBusError error 
)

Open a directory to iterate over.

Parameters
filenamethe directory name
errorexception return object or NULL
Returns
new iterator, or NULL on error

Definition at line 662 of file dbus-sysdeps-util-unix.c.

References _dbus_error_from_errno(), _dbus_string_get_const_data(), DBusDirIter::d, DBUS_ERROR_NO_MEMORY, dbus_new0, dbus_set_error(), and NULL.

const char* _dbus_error_from_errno ( int  error_number)
const char* _dbus_error_from_system_errno ( void  )

Converts the current system errno value into a DBusError name.

Returns
an error name

Definition at line 706 of file dbus-sysdeps.c.

References _dbus_error_from_errno().

void _dbus_exit ( int  code)

Exit the process, returning the given value.

Parameters
codethe exit code

Definition at line 2857 of file dbus-sysdeps-unix.c.

Referenced by _dbus_abort().

void _dbus_fd_set_close_on_exec ( intptr_t  handle)

Sets the file descriptor to be close on exec.

Should be called for all file descriptors in D-Bus code.

Parameters
fdthe file descriptor

Should be called for all file descriptors in D-Bus code.

Parameters
handlethe Windows HANDLE

Definition at line 2899 of file dbus-sysdeps-unix.c.

Referenced by _dbus_accept(), _dbus_connect_exec(), _dbus_dup(), _dbus_full_duplex_pipe(), _dbus_listen_tcp_socket(), _dbus_read_socket_with_unix_fds(), and _dbus_server_new_for_launchd().

void _dbus_flush_caches ( void  )

Called when the bus daemon is signaled to reload its configuration; any caches should be nuked.

Of course any caches that need explicit reload are probably broken, but c'est la vie.

Definition at line 3770 of file dbus-sysdeps-unix.c.

References _dbus_user_database_flush_system().

dbus_bool_t _dbus_full_duplex_pipe ( int *  fd1,
int *  fd2,
dbus_bool_t  blocking,
DBusError error 
)

Creates a full-duplex pipe (as in socketpair()).

Sets both ends of the pipe nonblocking.

Marks both file descriptors as close-on-exec

Parameters
fd1return location for one end
fd2return location for the other end
blockingTRUE if pipe should be blocking
errorerror return
Returns
FALSE on failure (if error is set)

Sets both ends of the pipe nonblocking.

Parameters
fd1return location for one end
fd2return location for the other end
blockingTRUE if pipe should be blocking
errorerror return
Returns
FALSE on failure (if error is set)

Definition at line 3071 of file dbus-sysdeps-unix.c.

References _dbus_close(), _dbus_error_from_errno(), _dbus_fd_set_close_on_exec(), _dbus_strerror_from_errno(), _dbus_warn(), _DBUS_ZERO, DBUS_ERROR_FAILED, dbus_set_error(), FALSE, NULL, and TRUE.

Referenced by _dbus_spawn_async_with_babysitter().

dbus_bool_t _dbus_generate_random_ascii ( DBusString str,
int  n_bytes 
)

Generates the given number of random bytes, where the bytes are chosen from the alphanumeric ASCII subset.

Parameters
strthe string
n_bytesthe number of random ASCII bytes to append to string
Returns
TRUE on success, FALSE if no memory or other failure

Definition at line 575 of file dbus-sysdeps.c.

References _dbus_assert, _dbus_generate_random_bytes(), _dbus_string_get_byte(), _dbus_string_get_length(), _dbus_string_set_byte(), _dbus_string_validate_ascii(), FALSE, and TRUE.

Referenced by _dbus_server_listen_platform_specific(), and _dbus_string_save_to_file().

dbus_bool_t _dbus_generate_random_bytes ( DBusString str,
int  n_bytes 
)

Generates the given number of random bytes, using the best mechanism we can come up with.

Parameters
strthe string
n_bytesthe number of random bytes to append to string
Returns
TRUE on success, FALSE if no memory

Definition at line 2814 of file dbus-sysdeps-unix.c.

References _dbus_close(), _dbus_read(), _dbus_string_get_data_len(), _dbus_string_get_length(), _dbus_string_lengthen(), _dbus_string_set_length(), FALSE, NULL, and TRUE.

Referenced by _dbus_generate_random_ascii(), and _dbus_generate_random_bytes_buffer().

void _dbus_generate_random_bytes_buffer ( char *  buffer,
int  n_bytes 
)

Fills n_bytes of the given buffer with random bytes.

Parameters
bufferan allocated buffer
n_bytesthe number of bytes in buffer to write to

Definition at line 543 of file dbus-sysdeps.c.

References _dbus_generate_pseudorandom_bytes_buffer(), _dbus_generate_random_bytes(), _dbus_string_copy_to_buffer(), _dbus_string_free(), and _dbus_string_init().

Referenced by _dbus_generate_uuid().

dbus_bool_t _dbus_get_autolaunch_address ( const char *  scope,
DBusString address,
DBusError error 
)

Returns the address of a new session bus.

If successful, returns TRUE and appends the address to address. If a failure happens, returns FALSE and sets an error in error.

Parameters
scopescope of autolaunch (Windows only)
addressa DBusString where the address can be stored
errora DBusError to store the error in case of failure
Returns
TRUE on success, FALSE if an error happened

Definition at line 3470 of file dbus-sysdeps-unix.c.

References _dbus_assert, _dbus_check_setuid(), _dbus_get_local_machine_uuid_encoded(), _dbus_getenv(), _DBUS_N_ELEMENTS, _dbus_string_free(), _dbus_string_get_const_data(), _dbus_string_get_data(), _dbus_string_init(), DBUS_ERROR_FAILED, DBUS_ERROR_NOT_SUPPORTED, dbus_set_error_const(), FALSE, NULL, and TRUE.

char** _dbus_get_environment ( void  )

Gets a NULL-terminated list of key=value pairs from the environment.

Use dbus_free_string_array to free it.

Returns
the environment or NULL on OOM

Definition at line 49 of file dbus-sysdeps-util.c.

References _dbus_assert, _dbus_strdup(), dbus_free_string_array(), dbus_new0, and NULL.

dbus_bool_t _dbus_get_is_errno_eagain_or_ewouldblock ( void  )

See if errno is EAGAIN or EWOULDBLOCK (this has to be done differently for Winsock so is abstracted)

Returns
TRUE if errno == EAGAIN or errno == EWOULDBLOCK

Definition at line 3876 of file dbus-sysdeps-unix.c.

dbus_bool_t _dbus_get_is_errno_eintr ( void  )

See if errno is EINTR.

Returns
TRUE if errno == EINTR

Definition at line 749 of file dbus-sysdeps.c.

dbus_bool_t _dbus_get_is_errno_enomem ( void  )

See if errno is ENOMEM.

Returns
TRUE if errno == ENOMEM

Definition at line 739 of file dbus-sysdeps.c.

dbus_bool_t _dbus_get_is_errno_epipe ( void  )

See if errno is EPIPE.

Returns
TRUE if errno == EPIPE

Definition at line 759 of file dbus-sysdeps.c.

dbus_bool_t _dbus_get_is_errno_nonzero ( void  )

See if errno is set.

Returns
TRUE if errno is not 0

Definition at line 729 of file dbus-sysdeps.c.

void _dbus_get_monotonic_time ( long *  tv_sec,
long *  tv_usec 
)

Get current time, as in gettimeofday().

Use the monotonic clock if available, to avoid problems when the system time changes.

Parameters
tv_secreturn location for number of seconds
tv_usecreturn location for number of microseconds

Definition at line 2634 of file dbus-sysdeps-unix.c.

References _dbus_get_real_time(), and NULL.

Referenced by _dbus_connection_block_pending_call().

void _dbus_get_real_time ( long *  tv_sec,
long *  tv_usec 
)

Get current time, as in gettimeofday().

Never uses the monotonic clock.

Parameters
tv_secreturn location for number of seconds
tv_usecreturn location for number of microseconds

Definition at line 2665 of file dbus-sysdeps-unix.c.

References NULL.

Referenced by _dbus_generate_pseudorandom_bytes_buffer(), _dbus_generate_uuid(), and _dbus_get_monotonic_time().

dbus_bool_t _dbus_get_standard_session_servicedirs ( DBusList **  dirs)

Returns the standard directories for a session bus to look for service activation files.

On UNIX this should be the standard xdg freedesktop.org data directories:

XDG_DATA_HOME=${XDG_DATA_HOME-$HOME/.local/share} XDG_DATA_DIRS=${XDG_DATA_DIRS-/usr/local/share:/usr/share}

and

DBUS_DATADIR

Parameters
dirsthe directory list we are returning
Returns
FALSE on OOM

On Windows this should be data directories:

CommonProgramFiles%/dbus

and

relocated DBUS_DATADIR

Parameters
dirsthe directory list we are returning
Returns
FALSE on OOM

Definition at line 1217 of file dbus-sysdeps-util-unix.c.

References _dbus_concat_dir_and_file(), _dbus_getenv(), _dbus_homedir_from_current_process(), _dbus_path_is_absolute(), _dbus_split_paths_and_append(), _dbus_string_append(), _dbus_string_free(), _dbus_string_get_const_data(), _dbus_string_init(), _dbus_string_init_const(), FALSE, NULL, and TRUE.

dbus_bool_t _dbus_get_standard_system_servicedirs ( DBusList **  dirs)

Returns the standard directories for a system bus to look for service activation files.

On UNIX this should be the standard xdg freedesktop.org data directories:

XDG_DATA_DIRS=${XDG_DATA_DIRS-/usr/local/share:/usr/share}

and

DBUS_DATADIR

On Windows there is no system bus and this function can return nothing.

Parameters
dirsthe directory list we are returning
Returns
FALSE on OOM

Definition at line 1309 of file dbus-sysdeps-util-unix.c.

References _dbus_split_paths_and_append(), _dbus_string_init_const(), NULL, and TRUE.

const char* _dbus_get_tmpdir ( void  )

Gets the temporary files directory by inspecting the environment variables TMPDIR, TMP, and TEMP in that order.

If none of those are set "/tmp" is returned

Returns
location of temp directory, or NULL if no memory for locking

Definition at line 3216 of file dbus-sysdeps-unix.c.

References _dbus_abort(), _dbus_assert, _DBUS_LOCK, _DBUS_UNLOCK, _dbus_warn(), and NULL.

const char * _dbus_getenv ( const char *  varname)

Wrapper for getenv().

Parameters
varnamename of environment variable
Returns
value of environment variable or NULL if unset

Definition at line 185 of file dbus-sysdeps.c.

References _dbus_check_setuid(), and NULL.

Referenced by _dbus_abort(), _dbus_append_keyring_directory_for_credentials(), _dbus_become_daemon(), _dbus_get_autolaunch_address(), _dbus_get_standard_session_servicedirs(), and _dbus_server_new_for_launchd().

dbus_pid_t _dbus_getpid ( void  )
int _dbus_listen_tcp_socket ( const char *  host,
const char *  port,
const char *  family,
DBusString retport,
int **  fds_p,
DBusError error 
)

Creates a socket and binds it to the given path, then listens on the socket.

The socket is set to be nonblocking. In case of port=0 a random free port is used and returned in the port parameter. If inaddr_any is specified, the hostname is ignored.

This will set FD_CLOEXEC for the socket returned

Parameters
hostthe host name to listen on
portthe port to listen on, if zero a free port will be used
familythe address family to listen on, NULL for all
retportstring to return the actual port listened on
fds_plocation to store returned file descriptors
errorreturn location for errors
Returns
the number of listening file descriptors or -1 on error

The socket is set to be nonblocking. In case of port=0 a random free port is used and returned in the port parameter. If inaddr_any is specified, the hostname is ignored.

Parameters
hostthe host name to listen on
portthe port to listen on, if zero a free port will be used
familythe address family to listen on, NULL for all
retportstring to return the actual port listened on
fds_plocation to store returned file descriptors
errorreturn location for errors
Returns
the number of listening file descriptors or -1 on error

Definition at line 1340 of file dbus-sysdeps-unix.c.

References _dbus_close(), _dbus_error_from_errno(), _dbus_fd_set_close_on_exec(), _dbus_strerror_from_errno(), _dbus_string_append(), _dbus_string_get_const_data(), _dbus_string_get_length(), _dbus_warn(), _DBUS_ZERO, DBUS_ERROR_BAD_ADDRESS, DBUS_ERROR_INVALID_ARGS, DBUS_ERROR_NO_MEMORY, dbus_free(), dbus_realloc(), dbus_set_error(), and NULL.

Referenced by _dbus_server_new_for_tcp_socket().

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.

The first parameter will be a boolean specifying whether or not a dynamic session lookup is supported on this platform.

If supported is TRUE and the return value is TRUE, the address will be appended to address. If a failure happens, returns FALSE and sets an error in error.

If supported is FALSE, ignore the return value.

Parameters
supportedreturns whether this method is supported
addressa DBusString where the address can be stored
errora DBusError to store the error in case of failure
Returns
TRUE on success, FALSE if an error happened

Definition at line 3745 of file dbus-sysdeps-unix.c.

References FALSE, and TRUE.

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.

On Windows, this should simply always fail (just return FALSE).

Parameters
groupnamethe groupname text
gid_pplace to return the gid
Returns
TRUE on success

Definition at line 959 of file dbus-sysdeps-util-unix.c.

References _dbus_get_group_id(), and FALSE.

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.

On Windows, this should simply always fail (just return FALSE).

Parameters
usernamethe username text
uid_pplace to return the uid
Returns
TRUE on success

Definition at line 943 of file dbus-sysdeps-util-unix.c.

References _dbus_get_user_id(), and FALSE.

dbus_bool_t _dbus_path_is_absolute ( const DBusString filename)

Checks whether the filename is an absolute path.

Parameters
filenamethe filename
Returns
TRUE if an absolute path

Definition at line 597 of file dbus-sysdeps-util-unix.c.

References _dbus_string_get_byte(), _dbus_string_get_length(), and FALSE.

Referenced by _dbus_get_standard_session_servicedirs().

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 for other purposes.

Returns
process ID to put in log messages

Definition at line 2402 of file dbus-sysdeps-unix.c.

References _dbus_getpid().

Referenced by _dbus_abort(), _dbus_real_assert(), _dbus_real_assert_not_reached(), and _dbus_warn_check_failed().

int _dbus_poll ( DBusPollFD fds,
int  n_fds,
int  timeout_milliseconds 
)

Wrapper for poll().

Parameters
fdsthe file descriptors to poll
n_fdsnumber of descriptors in the array
timeout_millisecondstimeout or -1 for infinite
Returns
numbers of fds with revents, or <0 on error

Definition at line 2535 of file dbus-sysdeps-unix.c.

References _dbus_assert_not_reached, _DBUS_POLLERR, _DBUS_POLLHUP, _DBUS_POLLIN, _DBUS_POLLNVAL, _DBUS_POLLOUT, _DBUS_POLLPRI, _dbus_strerror_from_errno(), _dbus_warn(), DBusPollFD::events, FALSE, DBusPollFD::fd, NULL, and DBusPollFD::revents.

void _dbus_print_backtrace ( void  )

On GNU libc systems, print a crude backtrace to stderr.

On other systems, print "no backtrace support" and block for possible gdb attachment if an appropriate environment variable is set.

Definition at line 3029 of file dbus-sysdeps-unix.c.

Referenced by _dbus_abort().

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.

Parameters
formata printf-style format string
argsarguments for the format string
Returns
length of the given format string and args, or -1 if no memory

Measure the length of the given format string and arguments, not including the terminating nul.

Definition at line 3146 of file dbus-sysdeps-unix.c.

References dbus_free(), dbus_malloc(), and NULL.

Referenced by _dbus_string_append_printf_valist().

dbus_bool_t _dbus_read_credentials_socket ( int  handle,
DBusCredentials credentials,
DBusError error 
)

Reads a single byte which must be nul (an error occurs otherwise), and reads unix credentials if available.

Clears the credentials object, then adds pid/uid if available, so any previous credentials stored in the object are lost.

Return value indicates whether a byte was read, not whether we got valid credentials. On some systems, such as Linux, reading/writing the byte isn't actually required, but we do it anyway just to avoid multiple codepaths.

Fails if no byte is available, so you must select() first.

The point of the byte is that on some systems we have to use sendmsg()/recvmsg() to transmit credentials.

Parameters
client_fdthe client file descriptor
credentialsobject to add client credentials to
errorlocation to store error code
Returns
TRUE on success

Fills in pid/uid/gid with -1 if no credentials are available. Return value indicates whether a byte was read, not whether we got valid credentials. On some systems, such as Linux, reading/writing the byte isn't actually required, but we do it anyway just to avoid multiple codepaths.

Fails if no byte is available, so you must select() first.

The point of the byte is that on some systems we have to use sendmsg()/recvmsg() to transmit credentials.

Parameters
handlethe client file descriptor
credentialsstruct to fill with credentials of client
errorlocation to store error code
Returns
TRUE on success

Definition at line 1627 of file dbus-sysdeps-unix.c.

References _dbus_assert, _dbus_credentials_add_adt_audit_data(), _dbus_credentials_add_pid(), _dbus_credentials_add_unix_uid(), _dbus_credentials_add_windows_sid(), _dbus_credentials_clear(), _dbus_error_from_errno(), _dbus_read_socket(), _dbus_string_free(), _dbus_string_init(), _DBUS_ZERO, DBUS_ERROR_FAILED, DBUS_PID_FORMAT, DBUS_PID_UNSET, dbus_set_error(), DBUS_UID_FORMAT, DBUS_UID_UNSET, FALSE, NULL, and TRUE.

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.

Optionally try to create it (only root can do this usually).

On UNIX, reads a file that gets created by dbus-uuidgen in a post-install script. On Windows, if there's a standard machine uuid we could just use that, but I can't find one with the right properties (the hardware profile guid can change without rebooting I believe). If there's no standard one we might want to use the registry instead of a file for this, and I'm not sure how we'd ensure the uuid gets created.

Parameters
machine_idguid to init with the machine's uuid
create_if_not_foundtry to create the uuid if it doesn't exist
errorthe error return
Returns
FALSE if the error is set

Definition at line 3573 of file dbus-sysdeps-unix.c.

References _dbus_generate_uuid(), _dbus_read_uuid_file(), _dbus_string_init_const(), _dbus_write_uuid_file(), DBusGUID::as_uint32s, dbus_error_free(), DBUS_ERROR_NO_MEMORY, dbus_set_error(), FALSE, NULL, and TRUE.

Referenced by _dbus_get_local_machine_uuid_encoded(), and dbus_internal_do_not_use_get_uuid().

int _dbus_read_socket ( int  fd,
DBusString buffer,
int  count 
)

Like _dbus_read(), but only works on sockets so is available on Windows.

Parameters
fdthe socket
bufferstring to append data to
countmax amount of data to read
Returns
number of bytes appended to the string

Like _dbus_read(), but only works on sockets so is available on Windows.

Thin wrapper around the read() system call that appends the data it reads to the DBusString buffer. It appends up to the given count, and returns the same value and same errno as read(). The only exception is that _dbus_read_socket() handles EINTR for you. _dbus_read_socket() can return ENOMEM, even though regular UNIX read doesn't.

Parameters
fdthe file descriptor to read from
bufferthe buffer to append data to
countthe amount of data to read
Returns
the number of bytes read or -1

Definition at line 217 of file dbus-sysdeps-unix.c.

References _dbus_assert, _dbus_read(), _dbus_string_get_data_len(), _dbus_string_get_length(), _dbus_string_lengthen(), _dbus_string_set_length(), and _dbus_verbose_bytes_of_string().

Referenced by _dbus_read_credentials_socket(), and _dbus_read_socket_with_unix_fds().

int _dbus_read_socket_with_unix_fds ( int  fd,
DBusString buffer,
int  count,
int *  fds,
int *  n_fds 
)

Like _dbus_read_socket() but also tries to read unix fds from the socket.

When there are more fds to read than space in the array passed this function will fail with ENOSPC.

Parameters
fdthe socket
bufferstring to append data to
countmax amount of data to read
fdsarray to place read file descriptors in
n_fdson input space in fds array, on output how many fds actually got read
Returns
number of bytes appended to string

Definition at line 273 of file dbus-sysdeps-unix.c.

References _dbus_assert, _dbus_fd_set_close_on_exec(), _dbus_read_socket(), _dbus_string_get_data_len(), _dbus_string_get_length(), _dbus_string_lengthen(), _dbus_string_set_length(), _dbus_verbose_bytes_of_string(), _DBUS_ZERO, FALSE, and TRUE.

void _dbus_request_file_descriptor_limit ( unsigned int  limit)

Attempt to ensure that the current process can open at least limit file descriptors.

If limit is lower than the current, it will not be lowered. No error is returned if the request can not be satisfied.

Parameters
limitnumber of file descriptors

Definition at line 393 of file dbus-sysdeps-util-unix.c.

dbus_bool_t _dbus_send_credentials_socket ( int  server_fd,
DBusError error 
)

Sends a single nul byte with our UNIX credentials as ancillary data.

Returns TRUE if the data was successfully written. On systems that don't support sending credentials, just writes a byte, doesn't send any credentials. On some systems, such as Linux, reading/writing the byte isn't actually required, but we do it anyway just to avoid multiple codepaths.

Fails if no byte can be written, so you must select() first.

The point of the byte is that on some systems we have to use sendmsg()/recvmsg() to transmit credentials.

Parameters
server_fdfile descriptor for connection to server
errorreturn location for error code
Returns
TRUE if the byte was sent

Definition at line 1909 of file dbus-sysdeps-unix.c.

References _dbus_assert, _dbus_error_from_errno(), _dbus_strerror_from_errno(), _dbus_string_init_const_len(), _dbus_write_socket(), DBUS_ERROR_IO_ERROR, dbus_set_error(), FALSE, and TRUE.

void _dbus_set_signal_handler ( int  sig,
DBusSignalHandler  handler 
)

Installs a UNIX signal handler.

Parameters
sigthe signal to handle
handlerthe handler

Installs a UNIX signal handler.

Parameters
sigthe signal to handle
handlerthe handler

Definition at line 522 of file dbus-sysdeps-util-unix.c.

References NULL.

void _dbus_sleep_milliseconds ( int  milliseconds)

Sleeps the given number of milliseconds.

Parameters
millisecondsnumber of milliseconds

Definition at line 2766 of file dbus-sysdeps-unix.c.

Referenced by _dbus_abort().

dbus_bool_t _dbus_socket_can_pass_unix_fd ( int  fd)

Checks whether file descriptors may be passed via the socket.

Parameters
fdthe socket
Returns
TRUE when fd passing over this socket is supported

Definition at line 3917 of file dbus-sysdeps-unix.c.

References _DBUS_ZERO, and FALSE.

Referenced by _dbus_transport_new_for_socket().

dbus_bool_t _dbus_split_paths_and_append ( DBusString dirs,
const char *  suffix,
DBusList **  dir_list 
)

Split paths into a list of char strings.

Parameters
dirsstring with pathes
suffixstring concated to each path in dirs
dir_listcontains a list of splitted pathes return TRUE is pathes could be splittes,FALSE in oom case

Definition at line 226 of file dbus-sysdeps.c.

References _dbus_concat_dir_and_file(), _dbus_list_append(), _dbus_list_clear(), _dbus_list_foreach(), _dbus_string_chop_white(), _dbus_string_copy_data(), _dbus_string_copy_len(), _dbus_string_find(), _dbus_string_free(), _dbus_string_get_length(), _dbus_string_init(), _dbus_string_init_const(), dbus_free(), FALSE, NULL, and TRUE.

Referenced by _dbus_get_standard_session_servicedirs(), and _dbus_get_standard_system_servicedirs().

dbus_bool_t _dbus_stat ( const DBusString filename,
DBusStat statbuf,
DBusError error 
)

stat() wrapper.

Parameters
filenamethe filename to stat
statbufthe stat info to fill in
errorreturn location for error
Returns
FALSE if error was set

Definition at line 614 of file dbus-sysdeps-util-unix.c.

References _dbus_error_from_errno(), _dbus_string_get_const_data(), DBusStat::atime, DBusStat::ctime, DBUS_GID_UNSET, dbus_set_error(), DBUS_UID_UNSET, FALSE, DBusStat::gid, DBusStat::mode, DBusStat::mtime, DBusStat::nlink, NULL, DBusStat::size, TRUE, and DBusStat::uid.

Referenced by _dbus_is_console_user().

const char* _dbus_strerror_from_errno ( void  )
dbus_bool_t _dbus_string_get_dirname ( const DBusString filename,
DBusString dirname 
)

Get the directory name from a complete filename.

Parameters
filenamethe filename
dirnamestring to append directory name to
Returns
FALSE if no memory

Definition at line 1040 of file dbus-sysdeps-util-unix.c.

References _dbus_assert, _dbus_string_append(), _dbus_string_copy_len(), _dbus_string_find_byte_backward(), _dbus_string_get_byte(), _dbus_string_get_length(), and NULL.

void _dbus_system_log ( DBusSystemLogSeverity  severity,
const char *  msg,
  ... 
)

Log a message to the system log file (e.g.

syslog on Unix).

Parameters
severitya severity value
msga printf-style format string

Definition at line 454 of file dbus-sysdeps-util-unix.c.

References _dbus_system_logv().

void _dbus_system_logv ( DBusSystemLogSeverity  severity,
const char *  msg,
va_list  args 
)

Log a message to the system log file (e.g.

syslog on Unix).

Parameters
severitya severity value
msga printf-style format string
argsarguments for the format string

If the FATAL severity is given, this function will terminate the program with an error code.

Definition at line 476 of file dbus-sysdeps-util-unix.c.

References _dbus_getpid(), and DBUS_PID_FORMAT.

Referenced by _dbus_system_log().

dbus_bool_t _dbus_threads_init_platform_specific ( void  )

Initialize threads as in dbus_threads_init_default(), appropriately for the platform.

Returns
FALSE if no memory

Definition at line 278 of file dbus-sysdeps-pthread.c.

References _dbus_check_setuid(), FALSE, and TRUE.

Referenced by dbus_threads_init().

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.

On UNIX, just calls _dbus_groups_from_uid(). On Windows, should always fail since we don't know any UNIX groups.

Parameters
uidthe UID
group_idsreturn location for array of group IDs
n_group_idsreturn location for length of returned array
Returns
TRUE if the UID existed and we got some credentials

Definition at line 976 of file dbus-sysdeps-util-unix.c.

References _dbus_groups_from_uid(), and FALSE.

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.

Should always fail on Windows (set the error to DBUS_ERROR_NOT_SUPPORTED).

Parameters
uidUID of person to check
errorreturn location for errors
Returns
TRUE if the UID is the same as the console user and there are no errors

Definition at line 993 of file dbus-sysdeps-util-unix.c.

References _dbus_is_console_user(), DBUS_ERROR_NOT_SUPPORTED, dbus_set_error(), and FALSE.

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.

Should always return FALSE on Windows.

Parameters
uidthe UNIX user ID
Returns
TRUE if this uid owns the process.

Definition at line 1008 of file dbus-sysdeps-util-unix.c.

References _dbus_geteuid(), and FALSE.

dbus_bool_t _dbus_user_at_console ( const char *  username,
DBusError error 
)

Checks if user is at the console.

Parameters
usernameuser to check
errorreturn location for errors
Returns
TRUE is the user is at the consolei and there are no errors

Definition at line 553 of file dbus-sysdeps-util-unix.c.

References _dbus_concat_dir_and_file(), _dbus_file_exists(), _dbus_string_append(), _dbus_string_free(), _dbus_string_get_const_data(), _dbus_string_init(), _dbus_string_init_const(), and FALSE.

Referenced by _dbus_is_console_user().

dbus_bool_t _dbus_verify_daemon_user ( const char *  user)

Verify that after the fork we can successfully change to this user.

Parameters
userthe username given in the daemon configuration
Returns
TRUE if username is valid

Definition at line 310 of file dbus-sysdeps-util-unix.c.

References _dbus_get_user_id_and_primary_group(), _dbus_string_init_const(), NULL, and TRUE.

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.

Should always return FALSE on UNIX.

Parameters
windows_sidthe Windows user SID
Returns
TRUE if this user owns the process.

Definition at line 1021 of file dbus-sysdeps-util-unix.c.

References FALSE, and TRUE.

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).

Does nothing if pidfile and print_pid_pipe are both NULL.

Parameters
pidfilethe file to write to or NULL
print_pid_pipethe pipe to write to or NULL
pid_to_writethe pid to write out
errorerror on failure
Returns
FALSE if error is set

Definition at line 236 of file dbus-sysdeps-util-unix.c.

References _dbus_string_append(), _dbus_string_append_int(), _dbus_string_free(), _dbus_string_get_const_data(), _dbus_string_get_length(), _dbus_string_init(), DBUS_ERROR_FAILED, dbus_error_is_set(), dbus_set_error(), FALSE, NULL, and TRUE.

Referenced by _dbus_become_daemon().

int _dbus_write_socket ( int  fd,
const DBusString buffer,
int  start,
int  len 
)

Like _dbus_write(), but only supports sockets and is thus available on Windows.

Parameters
fdthe file descriptor to write
bufferthe buffer to write data from
startthe first byte in the buffer to write
lenthe number of bytes to try to write
Returns
the number of bytes written or -1 on error

Like _dbus_write(), but only supports sockets and is thus available on Windows.

Parameters
fdthe file descriptor to write
bufferthe buffer to write data from
startthe first byte in the buffer to write
lenthe number of bytes to try to write
Returns
the number of bytes written or -1 on error

Definition at line 235 of file dbus-sysdeps-unix.c.

References _dbus_strerror_from_errno(), _dbus_string_get_const_data_len(), _dbus_verbose_bytes_of_string(), and _dbus_write().

Referenced by _dbus_send_credentials_socket().

int _dbus_write_socket_two ( int  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.

Parameters
fdthe file descriptor
buffer1first buffer
start1first byte to write in first buffer
len1number of bytes to write from first buffer
buffer2second buffer, or NULL
start2first byte to write in second buffer
len2number of bytes to write in second buffer
Returns
total bytes written from both buffers, or -1 on error

Like _dbus_write_two() but only works on sockets and is thus available on Windows.

The return value is the number of bytes written in the first buffer, plus the number written in the second. If the first buffer is written successfully and an error occurs writing the second, the number of bytes in the first is returned (i.e. the error is ignored), on systems that don't have writev. Handles EINTR for you. The second buffer may be NULL.

Parameters
fdthe file descriptor
buffer1first buffer
start1first byte to write in first buffer
len1number of bytes to write from first buffer
buffer2second buffer, or NULL
start2first byte to write in second buffer
len2number of bytes to write in second buffer
Returns
total bytes written from both buffers, or -1 on error

Definition at line 509 of file dbus-sysdeps-unix.c.

References _dbus_assert, _dbus_strerror_from_errno(), _dbus_string_get_const_data_len(), _dbus_write_two(), _DBUS_ZERO, and NULL.