D-Bus 1.15.0
dbus-sysdeps-unix.h
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-sysdeps-unix.h UNIX-specific wrappers around system/libc features (internal to D-Bus implementation)
3 *
4 * Copyright (C) 2002, 2003, 2006 Red Hat, Inc.
5 * Copyright (C) 2003 CodeFactory AB
6 *
7 * Licensed under the Academic Free License version 2.1
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 *
23 */
24
25#ifndef DBUS_SYSDEPS_UNIX_H
26#define DBUS_SYSDEPS_UNIX_H
27
28#include <dbus/dbus-sysdeps.h>
29
30#ifdef DBUS_WIN
31#error "Don't include this on Windows"
32#endif
33
35
43DBUS_PRIVATE_EXPORT
45_dbus_close (int fd,
46 DBusError *error);
47DBUS_PRIVATE_EXPORT
48int _dbus_dup (int fd,
49 DBusError *error);
50DBUS_PRIVATE_EXPORT
51int
52_dbus_read (int fd,
53 DBusString *buffer,
54 int count);
55int
56_dbus_write (int fd,
57 const DBusString *buffer,
58 int start,
59 int len);
60int
61_dbus_write_two (int fd,
62 const DBusString *buffer1,
63 int start1,
64 int len1,
65 const DBusString *buffer2,
66 int start2,
67 int len2);
68
70 DBusError *error);
71
72dbus_bool_t _dbus_read_credentials (int client_fd,
73 DBusCredentials *credentials,
74 DBusError *error);
75dbus_bool_t _dbus_send_credentials (int server_fd,
76 DBusError *error);
77
79 const char *launchd_env_var,
80 DBusError *error);
81
86
91{
92 size_t refcount;
97 char *username;
98 char *homedir;
99};
100
105{
106 size_t refcount;
108 char *groupname;
109};
110
112 const DBusString *username,
113 DBusError *error);
115 dbus_uid_t uid,
116 DBusError *error);
118
120 const DBusString *groupname,
121 DBusError *error);
123 dbus_gid_t gid,
124 DBusError *error);
126
127DBUS_PRIVATE_EXPORT
129
130DBUS_PRIVATE_EXPORT
131void _dbus_close_all (void);
132DBUS_PRIVATE_EXPORT
134DBUS_PRIVATE_EXPORT
135void _dbus_fd_clear_close_on_exec (int fd);
136
138 DBusString *address,
139 DBusError *error);
140
141DBUS_PRIVATE_EXPORT
142void _dbus_fd_set_close_on_exec (int fd);
143
144typedef enum
145{
146 DBUS_FORCE_STDIN_NULL = (1 << 0),
147 DBUS_FORCE_STDOUT_NULL = (1 << 1),
148 DBUS_FORCE_STDERR_NULL = (1 << 2)
149} DBusEnsureStandardFdsFlags;
150
151DBUS_PRIVATE_EXPORT
152dbus_bool_t _dbus_ensure_standard_fds (DBusEnsureStandardFdsFlags flags,
153 const char **error_str_p);
154
156typedef void (* DBusSignalHandler) (int sig);
157
158void _dbus_set_signal_handler (int sig,
159 DBusSignalHandler handler);
160
161dbus_bool_t _dbus_reset_oom_score_adj (const char **error_str_p);
162
166
167#endif /* DBUS_SYSDEPS_UNIX_H */
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
DBUS_PRIVATE_EXPORT void _dbus_fd_clear_close_on_exec(int fd)
Sets the file descriptor to not be close-on-exec.
dbus_bool_t _dbus_reset_oom_score_adj(const char **error_str_p)
If the current process has been protected from the Linux OOM killer (the oom_score_adj process parame...
dbus_bool_t _dbus_group_info_fill(DBusGroupInfo *info, const DBusString *groupname, DBusError *error)
Initializes the given DBusGroupInfo struct with information about the given group name.
DBUS_PRIVATE_EXPORT void _dbus_fd_set_all_close_on_exec(void)
Sets all file descriptors except the first three (i.e.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_close(int fd, DBusError *error)
Closes a file descriptor.
int _dbus_write(int fd, const DBusString *buffer, int start, int len)
Thin wrapper around the write() system call that writes a part of a DBusString and handles EINTR for ...
void(* DBusSignalHandler)(int sig)
A UNIX signal handler.
void _dbus_set_signal_handler(int sig, DBusSignalHandler handler)
Installs a UNIX signal handler.
int _dbus_write_two(int fd, const DBusString *buffer1, int start1, int len1, const DBusString *buffer2, int start2, int len2)
Like _dbus_write() but will use writev() if possible to write both buffers in sequence.
dbus_bool_t _dbus_lookup_launchd_socket(DBusString *socket_path, const char *launchd_env_var, DBusError *error)
quries launchd for a specific env var which holds the socket path.
int _dbus_listen_systemd_sockets(DBusSocket **fd, DBusError *error)
Acquires one or more sockets passed in from systemd.
dbus_bool_t _dbus_append_address_from_socket(DBusSocket fd, DBusString *address, DBusError *error)
Read the address from the socket and append it to the string.
dbus_bool_t _dbus_user_info_fill(DBusUserInfo *info, const DBusString *username, DBusError *error)
Gets user info for the given username.
void _dbus_user_info_free(DBusUserInfo *info)
Frees the members of info (but not info itself)
Definition: dbus-userdb.c:106
void _dbus_group_info_free(DBusGroupInfo *info)
Frees the members of info (but not info itself).
Definition: dbus-userdb.c:119
DBUS_PRIVATE_EXPORT void _dbus_close_all(void)
Closes all file descriptors except the first three (i.e.
dbus_bool_t _dbus_group_info_fill_gid(DBusGroupInfo *info, dbus_gid_t gid, DBusError *error)
Initializes the given DBusGroupInfo struct with information about the given group ID.
DBUS_PRIVATE_EXPORT int _dbus_dup(int fd, DBusError *error)
Duplicates a file descriptor.
DBUS_PRIVATE_EXPORT void _dbus_fd_set_close_on_exec(int fd)
Sets the file descriptor to be close on exec.
DBUS_PRIVATE_EXPORT int _dbus_read(int fd, DBusString *buffer, int count)
Thin wrapper around the read() system call that appends the data it reads to the DBusString buffer.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_ensure_standard_fds(DBusEnsureStandardFdsFlags flags, const char **error_str_p)
Ensure that the standard file descriptors stdin, stdout and stderr are open, by opening /dev/null if ...
DBUS_PRIVATE_EXPORT dbus_uid_t _dbus_geteuid(void)
Gets our effective UID.
dbus_bool_t _dbus_user_info_fill_uid(DBusUserInfo *info, dbus_uid_t uid, DBusError *error)
Gets user info for the given user ID.
unsigned long dbus_uid_t
A user ID.
Definition: dbus-sysdeps.h:135
unsigned long dbus_gid_t
A group ID.
Definition: dbus-sysdeps.h:137
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
Object representing an exception.
Definition: dbus-errors.h:49
Information about a UNIX group.
dbus_gid_t gid
GID.
char * groupname
Group name.
size_t refcount
Reference count.
Socket interface.
Definition: dbus-sysdeps.h:179
Information about a UNIX user.
int n_group_ids
Size of group IDs array.
dbus_uid_t uid
UID.
char * homedir
Home directory.
dbus_gid_t * group_ids
Groups IDs, including above primary group.
size_t refcount
Reference count.
char * username
Username.
dbus_gid_t primary_gid
GID.