Internal system-dependent API
[D-Bus secret internal implementation details]

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  DBusPipe
struct  DBusStat
 Portable struct with stat() results. More...

Defines

#define _DBUS_GNUC_PRINTF(format_idx, arg_idx)
 used to tell gcc about printf format strings
#define _DBUS_GNUC_NORETURN
 used to tell gcc about functions that never return, such as _dbus_abort()
#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_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.

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.

Functions

void _dbus_abort (void)
 Aborts the program with SIGABRT (dumping core).
dbus_bool_t _dbus_setenv (const char *varname, const char *value)
 Wrapper for setenv().
const char * _dbus_getenv (const char *varname)
 Wrapper for getenv().
dbus_bool_t _dbus_clearenv (void)
 Wrapper for clearenv().
char ** _dbus_get_environment (void)
 Gets a NULL-terminated list of key=value pairs from the environment.
void _dbus_pipe_init (DBusPipe *pipe, int fd)
void _dbus_pipe_init_stdout (DBusPipe *pipe)
 init a pipe with stdout
dbus_bool_t _dbus_pipe_is_valid (DBusPipe *pipe)
 check if a pipe is valid; pipes can be set invalid, similar to a -1 file descriptor.
dbus_bool_t _dbus_pipe_is_stdout_or_stderr (DBusPipe *pipe)
 Check if a pipe is stdout or stderr.
void _dbus_pipe_invalidate (DBusPipe *pipe)
 Initializes a pipe to an invalid value.
dbus_bool_t _dbus_split_paths_and_append (DBusString *dirs, const char *suffix, DBusList **dir_list)
 Split paths into a list of char strings.
dbus_bool_t _dbus_open_tcp_socket (int *fd, DBusError *error)
 Socket interface.
dbus_bool_t _dbus_close_socket (int fd, DBusError *error)
 Closes a socket.
int _dbus_read_socket (int fd, DBusString *buffer, int count)
 Like _dbus_read(), but only works on sockets so is available on Windows.
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.
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.
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.
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.
int _dbus_accept (int listen_fd)
 Accepts a connection on a listening socket.
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.
dbus_bool_t _dbus_send_credentials_socket (int server_fd, DBusError *error)
 Sends a single nul byte with our UNIX credentials as ancillary data.
dbus_bool_t _dbus_credentials_add_from_user (DBusCredentials *credentials, const DBusString *username)
 Adds the credentials corresponding to the given username.
dbus_bool_t _dbus_credentials_add_from_current_process (DBusCredentials *credentials)
 Adds the credentials of the current process to the passed-in credentials object.
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.
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_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_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_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_unix_user_is_process_owner (dbus_uid_t uid)
 Checks to see if the UNIX user ID matches the UID of the process.
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.
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_int32_t _dbus_atomic_inc (DBusAtomic *atomic)
 Atomically increments an integer.
dbus_int32_t _dbus_atomic_dec (DBusAtomic *atomic)
 Atomically decrement an integer.
int _dbus_poll (DBusPollFD *fds, int n_fds, int timeout_milliseconds)
 Wrapper for poll().
void _dbus_sleep_milliseconds (int milliseconds)
 Sleeps the given number of milliseconds.
void _dbus_get_current_time (long *tv_sec, long *tv_usec)
 Get current time, as in gettimeofday().
dbus_bool_t _dbus_file_exists (const char *file)
 File/directory interface.
dbus_bool_t _dbus_file_get_contents (DBusString *str, const DBusString *filename, DBusError *error)
 Appends the contents of the given file to the string, returning error code.
dbus_bool_t _dbus_string_save_to_file (const DBusString *str, const DBusString *filename, DBusError *error)
 Writes a string out to a file.
dbus_bool_t _dbus_make_file_world_readable (const DBusString *filename, DBusError *error)
 Makes the file readable by every user in the system.
dbus_bool_t _dbus_create_file_exclusively (const DBusString *filename, DBusError *error)
 Creates the given file, failing if the file already exists.
dbus_bool_t _dbus_delete_file (const DBusString *filename, DBusError *error)
 Deletes the given file.
dbus_bool_t _dbus_create_directory (const DBusString *filename, DBusError *error)
 Creates a directory; succeeds if the directory is created or already existed.
dbus_bool_t _dbus_delete_directory (const DBusString *filename, DBusError *error)
 Removes a directory; Directory must be empty.
dbus_bool_t _dbus_concat_dir_and_file (DBusString *dir, const DBusString *next_component)
 Appends the given filename to the given directory.
dbus_bool_t _dbus_string_get_dirname (const DBusString *filename, DBusString *dirname)
 Get the directory name from a complete filename.
dbus_bool_t _dbus_path_is_absolute (const DBusString *filename)
 Checks whether the filename is an absolute path.
dbus_bool_t _dbus_get_standard_session_servicedirs (DBusList **dirs)
 Returns the standard directories for a session bus to look for service activation files.
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_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).
dbus_bool_t _dbus_append_session_config_file (DBusString *str)
 Append the absolute path of the session.conf file.
int _dbus_pipe_write (DBusPipe *pipe, const DBusString *buffer, int start, int len, DBusError *error)
 write data to a pipe.
int _dbus_pipe_close (DBusPipe *pipe, DBusError *error)
 close a pipe.
DBusDirIter * _dbus_directory_open (const DBusString *filename, DBusError *error)
 Open a directory to iterate over.
dbus_bool_t _dbus_directory_get_next_file (DBusDirIter *iter, DBusString *filename, DBusError *error)
 Get next file in the directory.
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.
void _dbus_fd_set_close_on_exec (int fd)
 Sets the file descriptor to be close on exec.
const char * _dbus_get_tmpdir (void)
 Gets the temporary files directory by inspecting the environment variables TMPDIR, TMP, and TEMP in that order.
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.
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.
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.
const char * _dbus_error_from_errno (int error_number)
 Converts a UNIX or Windows errno into a DBusError name.
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.
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).
dbus_bool_t _dbus_get_is_errno_enomem (void)
 See if errno is ENOMEM.
dbus_bool_t _dbus_get_is_errno_eintr (void)
 See if errno is EINTR.
dbus_bool_t _dbus_get_is_errno_epipe (void)
 See if errno is EPIPE.
const char * _dbus_strerror_from_errno (void)
 Get error message from errno.
void _dbus_disable_sigpipe (void)
 signal (SIGPIPE, SIG_IGN);
void _dbus_exit (int code) _DBUS_GNUC_NORETURN
 Exit the process, returning the given value.
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.
dbus_bool_t _dbus_stat (const DBusString *filename, DBusStat *statbuf, DBusError *error)
 stat() wrapper.
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()).
void _dbus_print_backtrace (void)
 On GNU libc systems, print a crude backtrace to stderr.
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_bool_t _dbus_verify_daemon_user (const char *user)
 Verify that after the fork we can successfully change to this user.
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_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).
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.
void _dbus_set_signal_handler (int sig, DBusSignalHandler handler)
 Installs a UNIX signal handler.
dbus_bool_t _dbus_user_at_console (const char *username, DBusError *error)
 Checks if user is at the console.
void _dbus_init_system_log (void)
void _dbus_log_info (const char *msg, va_list args)
 Log an informative message.
void _dbus_log_security (const char *msg, va_list args)
 Log a security-related message.
dbus_bool_t _dbus_get_autolaunch_address (DBusString *address, DBusError *error)
 Determines the address of the session bus by querying a platform-specific method.
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.
dbus_bool_t _dbus_threads_init_platform_specific (void)
 Initialize threads as in dbus_threads_init_default(), appropriately for the platform.
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.
dbus_pid_t _dbus_getpid (void)
 Gets our process ID.
void _dbus_flush_caches (void)
 Called when the bus daemon is signaled to reload its configuration; any caches should be nuked.

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.

Define Documentation

#define _DBUS_DOUBLES_BITWISE_EQUAL ( a,
b   ) 

Value:

(_DBUS_BYTE_OF_PRIMITIVE (a, 0) == _DBUS_BYTE_OF_PRIMITIVE (b, 0) &&       \
      _DBUS_BYTE_OF_PRIMITIVE (a, 1) == _DBUS_BYTE_OF_PRIMITIVE (b, 1) &&       \
      _DBUS_BYTE_OF_PRIMITIVE (a, 2) == _DBUS_BYTE_OF_PRIMITIVE (b, 2) &&       \
      _DBUS_BYTE_OF_PRIMITIVE (a, 3) == _DBUS_BYTE_OF_PRIMITIVE (b, 3) &&       \
      _DBUS_BYTE_OF_PRIMITIVE (a, 4) == _DBUS_BYTE_OF_PRIMITIVE (b, 4) &&       \
      _DBUS_BYTE_OF_PRIMITIVE (a, 5) == _DBUS_BYTE_OF_PRIMITIVE (b, 5) &&       \
      _DBUS_BYTE_OF_PRIMITIVE (a, 6) == _DBUS_BYTE_OF_PRIMITIVE (b, 6) &&       \
      _DBUS_BYTE_OF_PRIMITIVE (a, 7) == _DBUS_BYTE_OF_PRIMITIVE (b, 7))
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 459 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 475 of file dbus-sysdeps.h.

Function Documentation

int _dbus_accept ( int  listen_fd  ) 

Accepts a connection on a listening socket.

Handles EINTR for you.

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

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

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:
directory string to append directory to
credentials credentials the directory should be for
Returns:
FALSE on no memory

Definition at line 3291 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_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:
str the string to append to
Returns:
FALSE if no memory

Definition at line 3259 of file dbus-sysdeps-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:
str the string to append to
Returns:
FALSE if no memory

Definition at line 3247 of file dbus-sysdeps-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:
str the string to append to
Returns:
FALSE on no memory

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

References _dbus_geteuid(), and _dbus_string_append_uint().

dbus_int32_t _dbus_atomic_dec ( DBusAtomic *  atomic  ) 

Atomically decrement an integer.

Parameters:
atomic pointer to the integer to decrement
Returns:
the value before decrementing
Todo:
implement arch-specific faster atomic ops

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

References _DBUS_LOCK, _DBUS_UNLOCK, and DBusAtomic::value.

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

dbus_int32_t _dbus_atomic_inc ( DBusAtomic *  atomic  ) 

Atomically increments an integer.

Parameters:
atomic pointer to the integer to increment
Returns:
the value before incrementing
Todo:
implement arch-specific faster atomic ops

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

References _DBUS_LOCK, _DBUS_UNLOCK, and DBusAtomic::value.

Referenced by _dbus_connection_ref_unlocked(), _dbus_server_ref_unlocked(), dbus_connection_ref(), dbus_malloc(), dbus_malloc0(), dbus_message_ref(), dbus_pending_call_ref(), dbus_realloc(), and dbus_server_ref().

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:
pidfile NULL, or pidfile to create
print_pid_pipe pipe to print daemon's pid to, or -1 for none
error return location for errors
keep_umask TRUE to keep the original umask
Returns:
FALSE on failure

Definition at line 78 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_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:
user the user to become
error return location for errors
Returns:
FALSE on failure

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

References _dbus_error_from_errno(), _dbus_get_user_id_and_primary_group(), _dbus_geteuid(), _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:
dir the name of the directory
error error return
Returns:
FALSE on failure

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

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

dbus_bool_t _dbus_clearenv ( void   ) 

Wrapper for clearenv().

Returns:
TRUE on success.

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

References FALSE, NULL, and TRUE.

dbus_bool_t _dbus_close_socket ( int  fd,
DBusError *  error 
)

Closes a socket.

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

Parameters:
fd the socket
error return location for an error
Returns:
FALSE if error is set

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

References _dbus_close().

Referenced by _dbus_babysitter_unref(), _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:
pid Process id
str Append command to this string
max_len Maximum length of returned command
error return location for errors
Returns:
FALSE on error

Definition at line 1196 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_init(), dbus_set_error(), FALSE, 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:
dir the directory name
next_component the filename
Returns:
TRUE on success

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

References _dbus_string_append_byte(), _dbus_string_copy(), _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(), and _dbus_split_paths_and_append().

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.

Parameters:
host the host name to connect to
port the port to connect to
family the address family to listen on, NULL for all
error return location for error code
Returns:
connection file descriptor or -1 on error

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

References _dbus_close(), _dbus_error_from_errno(), _dbus_open_tcp_socket(), _DBUS_ZERO, dbus_set_error(), and NULL.

Referenced by _dbus_transport_new_for_tcp_socket().

dbus_bool_t _dbus_create_directory ( const DBusString *  filename,
DBusError *  error 
)

Creates a directory; succeeds if the directory is created or already existed.

Parameters:
filename directory filename
error initialized error object
Returns:
TRUE on success

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

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

Referenced by _dbus_keyring_new_for_credentials().

dbus_bool_t _dbus_create_file_exclusively ( const DBusString *  filename,
DBusError *  error 
)

Creates the given file, failing if the file already exists.

Parameters:
filename the filename
error error location
Returns:
TRUE if we created the file and it didn't exist

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

References _dbus_close(), DBUS_ERROR_FAILED, dbus_set_error(), FALSE, NULL, and TRUE.

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:
credentials credentials 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 1713 of file dbus-sysdeps-unix.c.

References _dbus_assert, _dbus_credentials_add_unix_pid(), _dbus_credentials_add_unix_uid(), _dbus_geteuid(), _dbus_getpid(), FALSE, 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.

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:
credentials credentials to fill in
username the username
Returns:
TRUE if the username existed and we got some credentials

Definition at line 490 of file dbus-userdb.c.

References _dbus_credentials_add_unix_uid(), _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:
filename directory filename
error initialized error object
Returns:
TRUE on success

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

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

dbus_bool_t _dbus_delete_file ( const DBusString *  filename,
DBusError *  error 
)

Deletes the given file.

Parameters:
filename the filename
error error location
Returns:
TRUE if unlink() succeeded

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

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

Parameters:
iter the iterator
filename string to be set to the next file in the dir
error return location for error
Returns:
TRUE if filename was filled in with a new filename

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

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

DBusDirIter* _dbus_directory_open ( const DBusString *  filename,
DBusError *  error 
)

Open a directory to iterate over.

Parameters:
filename the directory name
error exception return object or NULL
Returns:
new iterator, or NULL on error

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

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

const char* _dbus_error_from_errno ( int  error_number  ) 

Converts a UNIX or Windows errno into a DBusError name.

Todo:
should cover more errnos, specifically those from open().
Parameters:
error_number the errno.
Returns:
an error name

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

References DBUS_ERROR_ACCESS_DENIED, DBUS_ERROR_ADDRESS_IN_USE, DBUS_ERROR_FAILED, DBUS_ERROR_FILE_EXISTS, DBUS_ERROR_FILE_NOT_FOUND, DBUS_ERROR_LIMITS_EXCEEDED, DBUS_ERROR_NO_MEMORY, DBUS_ERROR_NO_NETWORK, DBUS_ERROR_NO_SERVER, DBUS_ERROR_NOT_SUPPORTED, and DBUS_ERROR_TIMEOUT.

Referenced by _dbus_become_daemon(), _dbus_change_to_daemon_user(), _dbus_check_dir_is_private_to_user(), _dbus_close(), _dbus_command_for_pid(), _dbus_connect_tcp_socket(), _dbus_connect_unix_socket(), _dbus_directory_get_next_file(), _dbus_directory_open(), _dbus_file_get_contents(), _dbus_full_duplex_pipe(), _dbus_get_autolaunch_address(), _dbus_listen_tcp_socket(), _dbus_listen_unix_socket(), _dbus_read_credentials_socket(), _dbus_stat(), and _dbus_string_save_to_file().

void _dbus_exit ( int  code  ) 

Exit the process, returning the given value.

Parameters:
code the exit code

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

Referenced by _dbus_abort().

void _dbus_fd_set_close_on_exec ( int  fd  ) 

Sets the file descriptor to be close on exec.

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

Parameters:
fd the file descriptor

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

Referenced by _dbus_server_new_for_domain_socket(), _dbus_server_new_for_tcp_socket(), _dbus_spawn_async_with_babysitter(), _dbus_transport_new_for_domain_socket(), and _dbus_transport_new_for_tcp_socket().

dbus_bool_t _dbus_file_exists ( const char *  file  ) 

File/directory interface.

File/directory interface.

Parameters:
file full path to the file
Returns:
TRUE if file exists

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

Referenced by _dbus_user_at_console().

dbus_bool_t _dbus_file_get_contents ( DBusString *  str,
const DBusString *  filename,
DBusError *  error 
)

Appends the contents of the given file to the string, returning error code.

At the moment, won't open a file more than a megabyte in size.

Parameters:
str the string to append to
filename filename to load
error place to set an error
Returns:
FALSE if error was set

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

References _dbus_close(), _dbus_error_from_errno(), _dbus_read(), _dbus_string_set_length(), DBUS_ERROR_FAILED, dbus_set_error(), FALSE, NULL, and TRUE.

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

Todo:
libdbus only uses this for the debug-pipe server, so in principle it could be in dbus-sysdeps-util.c, except that dbus-sysdeps-util.c isn't in libdbus when tests are enabled and the debug-pipe server is used.
Parameters:
fd1 return location for one end
fd2 return location for the other end
blocking TRUE if pipe should be blocking
error error return
Returns:
FALSE on failure (if error is set)

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

References _dbus_close(), _dbus_error_from_errno(), _dbus_warn(), 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:
str the string
n_bytes the number of random ASCII bytes to append to string
Returns:
TRUE on success, FALSE if no memory or other failure

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

References _dbus_assert, _dbus_generate_random_bytes(), _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:
str the string
n_bytes the number of random bytes to append to string
Returns:
TRUE on success, FALSE if no memory

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

References _dbus_close(), _dbus_read(), _dbus_string_set_length(), 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:
buffer an allocated buffer
n_bytes the number of bytes in buffer to write to

Definition at line 882 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 ( DBusString *  address,
DBusError *  error 
)

Determines the address of the session bus by querying a platform-specific method.

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

Parameters:
address a DBusString where the address can be stored
error a DBusError to store the error in case of failure
Returns:
TRUE on success, FALSE if an error happened

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

References _dbus_assert, _dbus_error_from_errno(), _dbus_get_local_machine_uuid_encoded(), _DBUS_N_ELEMENTS, _dbus_read(), _dbus_string_free(), _dbus_string_init(), _dbus_string_set_length(), DBUS_ERROR_SPAWN_EXEC_FAILED, dbus_set_error(), FALSE, NULL, READ_END, TRUE, and WRITE_END.

void _dbus_get_current_time ( long *  tv_sec,
long *  tv_usec 
)

Get current time, as in gettimeofday().

Parameters:
tv_sec return location for number of seconds
tv_usec return location for number of microseconds (thousandths)

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

References NULL.

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

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 211 of file dbus-sysdeps.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 3362 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 1075 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 1065 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 1085 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 1055 of file dbus-sysdeps.c.

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:
dirs the directory list we are returning
Returns:
FALSE on OOM

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

References _dbus_concat_dir_and_file(), _dbus_getenv(), _dbus_homedir_from_current_process(), _dbus_split_paths_and_append(), _dbus_string_append(), _dbus_string_free(), _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:
dirs the directory list we are returning
Returns:
FALSE on OOM

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

References _dbus_getenv(), _dbus_split_paths_and_append(), _dbus_string_append(), _dbus_string_free(), _dbus_string_init(), FALSE, 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

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

References _dbus_assert, and NULL.

const char * _dbus_getenv ( const char *  varname  ) 

Wrapper for getenv().

Parameters:
varname name of environment variable
Returns:
value of environment variable or NULL if unset

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

Referenced by _dbus_abort(), _dbus_append_keyring_directory_for_credentials(), _dbus_become_daemon(), _dbus_get_standard_session_servicedirs(), and _dbus_get_standard_system_servicedirs().

dbus_pid_t _dbus_getpid ( void   ) 

Gets our process ID.

Returns:
process ID

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

Referenced by _dbus_credentials_add_from_current_process().

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.

Parameters:
host the host name to listen on
port the port to listen on, if zero a free port will be used
family the address family to listen on, NULL for all
retport string to return the actual port listened on
fds_p location to store returned file descriptors
error return location for errors
Returns:
the number of listening file descriptors or -1 on error

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

References _dbus_close(), _dbus_error_from_errno(), _dbus_string_append(), _DBUS_ZERO, DBUS_ERROR_NO_MEMORY, dbus_free(), dbus_realloc(), dbus_set_error(), and NULL.

Referenced by _dbus_server_new_for_tcp_socket().

void _dbus_log_info ( const char *  msg,
va_list  args 
)

Log an informative message.

Intended for use primarily by the system bus.

Parameters:
msg a printf-style format string
args arguments for the format string

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

void _dbus_log_security ( const char *  msg,
va_list  args 
)

Log a security-related message.

Intended for use primarily by the system bus.

Parameters:
msg a printf-style format string
args arguments for the format string

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

dbus_bool_t _dbus_make_file_world_readable ( const DBusString *  filename,
DBusError *  error 
)

Makes the file readable by every user in the system.

Parameters:
filename the filename
error error location
Returns:
TRUE if the file's permissions could be changed.

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

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

dbus_bool_t _dbus_open_tcp_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.

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

Referenced by _dbus_connect_tcp_socket().

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:
groupname the groupname text
gid_p place to return the gid
Returns:
TRUE on success

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

References _dbus_get_group_id().

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:
username the username text
uid_p place to return the uid
Returns:
TRUE on success

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

References _dbus_get_user_id().

dbus_bool_t _dbus_path_is_absolute ( const DBusString *  filename  ) 

Checks whether the filename is an absolute path.

Parameters:
filename the filename
Returns:
TRUE if an absolute path

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

References FALSE.

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 1784 of file dbus-sysdeps-unix.c.

Referenced by _dbus_abort(), and _dbus_warn_check_failed().

int _dbus_pipe_close ( DBusPipe *  pipe,
DBusError *  error 
)

close a pipe.

Parameters:
pipe the pipe instance
error return location for an error
Returns:
FALSE if error is set

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

References _dbus_close(), and _dbus_pipe_invalidate().

void _dbus_pipe_init_stdout ( DBusPipe *  pipe  ) 

init a pipe with stdout

Parameters:
pipe the pipe

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

void _dbus_pipe_invalidate ( DBusPipe *  pipe  ) 

Initializes a pipe to an invalid value.

Parameters:
pipe the pipe

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

Referenced by _dbus_pipe_close().

dbus_bool_t _dbus_pipe_is_stdout_or_stderr ( DBusPipe *  pipe  ) 

Check if a pipe is stdout or stderr.

Parameters:
pipe the pipe instance
Returns:
TRUE if pipe is one of the standard out/err channels

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

dbus_bool_t _dbus_pipe_is_valid ( DBusPipe *  pipe  ) 

check if a pipe is valid; pipes can be set invalid, similar to a -1 file descriptor.

Parameters:
pipe the pipe instance
Returns:
FALSE if pipe is not valid

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

Referenced by _dbus_write_pid_to_file_and_pipe().

int _dbus_pipe_write ( DBusPipe *  pipe,
const DBusString *  buffer,
int  start,
int  len,
DBusError *  error 
)

write data to a pipe.

Parameters:
pipe the pipe instance
buffer the buffer to write data from
start the first byte in the buffer to write
len the number of bytes to try to write
error error return
Returns:
the number of bytes written or -1 on error

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

References _dbus_write(), DBUS_ERROR_FAILED, and dbus_set_error().

Referenced by _dbus_write_pid_to_file_and_pipe().

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

Wrapper for poll().

Parameters:
fds the file descriptors to poll
n_fds number of descriptors in the array
timeout_milliseconds timeout or -1 for infinite
Returns:
numbers of fds with revents, or <0 on error

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

References _DBUS_POLLERR, _DBUS_POLLHUP, _DBUS_POLLIN, _DBUS_POLLNVAL, _DBUS_POLLOUT, _DBUS_POLLPRI, _dbus_warn(), DBusPollFD::events, 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 2704 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:
format a printf-style format string
args arguments for the format string
Returns:
length of the given format string and args

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

Referenced by _dbus_string_append_printf_valist().

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.

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_fd the client file descriptor
credentials object to add client credentials to
error location to store error code
Returns:
TRUE on success

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

References _dbus_assert, _dbus_credentials_add_adt_audit_data(), _dbus_credentials_add_unix_pid(), _dbus_credentials_add_unix_uid(), _dbus_credentials_clear(), _dbus_error_from_errno(), 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_id guid to init with the machine's uuid
create_if_not_found try to create the uuid if it doesn't exist
error the error return
Returns:
FALSE if the error is set

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

References _dbus_read_uuid_file(), and _dbus_string_init_const().

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:
fd the socket
buffer string to append data to
count max amount of data to read
Returns:
number of bytes appended to the string

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

References _dbus_read().

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_fd file descriptor for connection to server
error return location for error code
Returns:
TRUE if the byte was sent

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

References FALSE, and TRUE.

void _dbus_set_signal_handler ( int  sig,
DBusSignalHandler  handler 
)

Installs a UNIX signal handler.

Parameters:
sig the signal to handle
handler the handler

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

References NULL.

dbus_bool_t _dbus_setenv ( const char *  varname,
const char *  value 
)

Wrapper for setenv().

If the value is NULL, unsets the environment variable.

There is an unfixable memleak in that it is unsafe to free memory malloced for use with setenv. This is because we can not rely on internal implementation details of the underlying libc library.

Parameters:
varname name of environment variable
value value of environment variable
Returns:
TRUE on success.

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

References _dbus_assert, FALSE, NULL, and TRUE.

void _dbus_sleep_milliseconds ( int  milliseconds  ) 

Sleeps the given number of milliseconds.

Parameters:
milliseconds number of milliseconds

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

Referenced by _dbus_abort().

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:
dirs string with pathes
suffix string concated to each path in dirs
dir_list contains a list of splitted pathes return TRUE is pathes could be splittes,FALSE in oom case

Definition at line 313 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_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:
filename the filename to stat
statbuf the stat info to fill in
error return location for error
Returns:
FALSE if error was set

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

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

Referenced by _dbus_is_console_user().

const char* _dbus_strerror_from_errno ( void   ) 

Get error message from errno.

Returns:
_dbus_strerror(errno)

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

dbus_bool_t _dbus_string_get_dirname ( const DBusString *  filename,
DBusString *  dirname 
)

Get the directory name from a complete filename.

Parameters:
filename the filename
dirname string to append directory name to
Returns:
FALSE if no memory

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

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

dbus_bool_t _dbus_string_save_to_file ( const DBusString *  str,
const DBusString *  filename,
DBusError *  error 
)

Writes a string out to a file.

If the file exists, it will be atomically overwritten by the new data.

Parameters:
str the string to write out
filename the file to save string to
error error to be filled in on failure
Returns:
FALSE on failure

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

References _dbus_close(), _dbus_error_from_errno(), _dbus_generate_random_ascii(), _dbus_string_append(), _dbus_string_copy(), _dbus_string_free(), _dbus_string_init(), _dbus_write(), DBUS_ERROR_NO_MEMORY, dbus_set_error(), FALSE, NULL, and TRUE.

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 359 of file dbus-sysdeps-pthread.c.

References dbus_threads_init().

Referenced by dbus_threads_init_default().

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:
uid the UID
group_ids return location for array of group IDs
n_group_ids return location for length of returned array
Returns:
TRUE if the UID existed and we got some credentials

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

References _dbus_groups_from_uid().

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:
uid UID of person to check
error return location for errors
Returns:
TRUE if the UID is the same as the console user and there are no errors

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

References _dbus_is_console_user().

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:
uid the UNIX user ID
Returns:
TRUE if this uid owns the process.

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

References _dbus_geteuid().

dbus_bool_t _dbus_user_at_console ( const char *  username,
DBusError *  error 
)

Checks if user is at the console.

Parameters:
username user to check
error return location for errors
Returns:
TRUE is the user is at the consolei and there are no errors

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

References _dbus_file_exists(), _dbus_string_append(), _dbus_string_free(), _dbus_string_init(), 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:
user the username given in the daemon configuration
Returns:
TRUE if username is valid

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

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

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_sid the Windows user SID
Returns:
TRUE if this user owns the process.

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

References FALSE.

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:
pidfile the file to write to or NULL
print_pid_pipe the pipe to write to or NULL
pid_to_write the pid to write out
error error on failure
Returns:
FALSE if error is set

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

References _dbus_pipe_is_valid(), _dbus_pipe_write(), _dbus_string_append(), _dbus_string_append_int(), _dbus_string_free(), _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:
fd the file descriptor to write
buffer the buffer to write data from
start the first byte in the buffer to write
len the number of bytes to try to write
Returns:
the number of bytes written or -1 on error

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

References _dbus_write().

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:
fd the file descriptor
buffer1 first buffer
start1 first byte to write in first buffer
len1 number of bytes to write from first buffer
buffer2 second buffer, or NULL
start2 first byte to write in second buffer
len2 number of bytes to write in second buffer
Returns:
total bytes written from both buffers, or -1 on error

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

References _dbus_write_two().

Generated on Wed May 13 13:46:38 2009 for D-Bus by  doxygen 1.5.6