]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/systemd/sd-bus.h
Merge pull request #2495 from heftig/master
[thirdparty/systemd.git] / src / systemd / sd-bus.h
CommitLineData
de1c301e
LP
1#ifndef foosdbushfoo
2#define foosdbushfoo
3
4/***
5 This file is part of systemd.
6
7 Copyright 2013 Lennart Poettering
8
9 systemd is free software; you can redistribute it and/or modify it
10 under the terms of the GNU Lesser General Public License as published by
11 the Free Software Foundation; either version 2.1 of the License, or
12 (at your option) any later version.
13
14 systemd is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 Lesser General Public License for more details.
18
19 You should have received a copy of the GNU Lesser General Public License
20 along with systemd; If not, see <http://www.gnu.org/licenses/>.
21***/
22
23#include <inttypes.h>
07a0d22f 24#include <stdarg.h>
de1c301e 25#include <sys/types.h>
938bcbab 26#include <sys/uio.h>
de1c301e 27
40ca29a1 28#include "sd-event.h"
71d35b6b
TA
29#include "sd-id128.h"
30
aacf3b48 31#include "_sd-common.h"
de1c301e 32
0095c454 33_SD_BEGIN_DECLARATIONS;
b29b8bc2 34
29ddb38f
LP
35/* Types */
36
de1c301e
LP
37typedef struct sd_bus sd_bus;
38typedef struct sd_bus_message sd_bus_message;
19befb2d 39typedef struct sd_bus_slot sd_bus_slot;
5b12334d 40typedef struct sd_bus_creds sd_bus_creds;
8f8f05a9 41typedef struct sd_bus_track sd_bus_track;
de1c301e
LP
42
43typedef struct {
44 const char *name;
45 const char *message;
79f8d3d2 46 int _need_free;
de1c301e
LP
47} sd_bus_error;
48
5f86c1f4
LP
49typedef struct {
50 const char* name;
51 int code;
52} sd_bus_error_map;
53
5b12334d
LP
54/* Flags */
55
56enum {
02581590 57 SD_BUS_CREDS_PID = 1ULL << 0,
32802361 58 SD_BUS_CREDS_TID = 1ULL << 1,
1386e47d
LP
59 SD_BUS_CREDS_PPID = 1ULL << 2,
60 SD_BUS_CREDS_UID = 1ULL << 3,
61 SD_BUS_CREDS_EUID = 1ULL << 4,
62 SD_BUS_CREDS_SUID = 1ULL << 5,
63 SD_BUS_CREDS_FSUID = 1ULL << 6,
64 SD_BUS_CREDS_GID = 1ULL << 7,
65 SD_BUS_CREDS_EGID = 1ULL << 8,
66 SD_BUS_CREDS_SGID = 1ULL << 9,
67 SD_BUS_CREDS_FSGID = 1ULL << 10,
68 SD_BUS_CREDS_SUPPLEMENTARY_GIDS = 1ULL << 11,
69 SD_BUS_CREDS_COMM = 1ULL << 12,
70 SD_BUS_CREDS_TID_COMM = 1ULL << 13,
71 SD_BUS_CREDS_EXE = 1ULL << 14,
72 SD_BUS_CREDS_CMDLINE = 1ULL << 15,
73 SD_BUS_CREDS_CGROUP = 1ULL << 16,
74 SD_BUS_CREDS_UNIT = 1ULL << 17,
329ac4bc
LP
75 SD_BUS_CREDS_SLICE = 1ULL << 18,
76 SD_BUS_CREDS_USER_UNIT = 1ULL << 19,
77 SD_BUS_CREDS_USER_SLICE = 1ULL << 20,
78 SD_BUS_CREDS_SESSION = 1ULL << 21,
79 SD_BUS_CREDS_OWNER_UID = 1ULL << 22,
80 SD_BUS_CREDS_EFFECTIVE_CAPS = 1ULL << 23,
81 SD_BUS_CREDS_PERMITTED_CAPS = 1ULL << 24,
82 SD_BUS_CREDS_INHERITABLE_CAPS = 1ULL << 25,
83 SD_BUS_CREDS_BOUNDING_CAPS = 1ULL << 26,
84 SD_BUS_CREDS_SELINUX_CONTEXT = 1ULL << 27,
85 SD_BUS_CREDS_AUDIT_SESSION_ID = 1ULL << 28,
86 SD_BUS_CREDS_AUDIT_LOGIN_UID = 1ULL << 29,
87 SD_BUS_CREDS_TTY = 1ULL << 30,
88 SD_BUS_CREDS_UNIQUE_NAME = 1ULL << 31,
89 SD_BUS_CREDS_WELL_KNOWN_NAMES = 1ULL << 32,
90 SD_BUS_CREDS_DESCRIPTION = 1ULL << 33,
02581590 91 SD_BUS_CREDS_AUGMENT = 1ULL << 63, /* special flag, if on sd-bus will augment creds struct, in a potentially race-full way. */
329ac4bc 92 _SD_BUS_CREDS_ALL = (1ULL << 34) -1,
5b12334d
LP
93};
94
29a07cdb
LP
95enum {
96 SD_BUS_NAME_REPLACE_EXISTING = 1ULL << 0,
97 SD_BUS_NAME_ALLOW_REPLACEMENT = 1ULL << 1,
98 SD_BUS_NAME_QUEUE = 1ULL << 2,
99};
100
29ddb38f
LP
101/* Callbacks */
102
19070062 103typedef int (*sd_bus_message_handler_t)(sd_bus_message *m, void *userdata, sd_bus_error *ret_error);
ebcf1f97
LP
104typedef int (*sd_bus_property_get_t) (sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, void *userdata, sd_bus_error *ret_error);
105typedef int (*sd_bus_property_set_t) (sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *value, void *userdata, sd_bus_error *ret_error);
f00c3121 106typedef int (*sd_bus_object_find_t) (sd_bus *bus, const char *path, const char *interface, void *userdata, void **ret_found, sd_bus_error *ret_error);
19070062 107typedef int (*sd_bus_node_enumerator_t) (sd_bus *bus, const char *prefix, void *userdata, char ***ret_nodes, sd_bus_error *ret_error);
8f8f05a9 108typedef int (*sd_bus_track_handler_t) (sd_bus_track *track, void *userdata);
29ddb38f
LP
109
110#include "sd-bus-protocol.h"
111#include "sd-bus-vtable.h"
29ddb38f 112
de1c301e
LP
113/* Connections */
114
69727e6d 115int sd_bus_default(sd_bus **ret);
76b54375
LP
116int sd_bus_default_user(sd_bus **ret);
117int sd_bus_default_system(sd_bus **ret);
118
af08d2f9 119int sd_bus_open(sd_bus **ret);
de1c301e 120int sd_bus_open_user(sd_bus **ret);
0f8bd8de 121int sd_bus_open_system(sd_bus **ret);
3db729cb 122int sd_bus_open_system_remote(sd_bus **ret, const char *host);
de33fc62 123int sd_bus_open_system_machine(sd_bus **ret, const char *machine);
021a1e78
LP
124
125int sd_bus_new(sd_bus **ret);
224b3787 126
021a1e78 127int sd_bus_set_address(sd_bus *bus, const char *address);
15d5af81 128int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
2fd9ae2e 129int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
224b3787 130int sd_bus_get_address(sd_bus *bus, const char **address);
94bbf1ba 131int sd_bus_set_bus_client(sd_bus *bus, int b);
224b3787 132int sd_bus_is_bus_client(sd_bus *bus);
5b820358 133int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t bus_id);
224b3787 134int sd_bus_is_server(sd_bus *bus);
2181a7f5 135int sd_bus_set_anonymous(sd_bus *bus, int b);
224b3787 136int sd_bus_is_anonymous(sd_bus *bus);
adacb957 137int sd_bus_set_trusted(sd_bus *bus, int b);
224b3787 138int sd_bus_is_trusted(sd_bus *bus);
09365592 139int sd_bus_set_monitor(sd_bus *bus, int b);
224b3787
LP
140int sd_bus_is_monitor(sd_bus *bus);
141int sd_bus_set_description(sd_bus *bus, const char *description);
142int sd_bus_get_description(sd_bus *bus, const char **description);
882897af
LP
143int sd_bus_negotiate_creds(sd_bus *bus, int b, uint64_t creds_mask);
144int sd_bus_negotiate_timestamp(sd_bus *bus, int b);
264ad849 145int sd_bus_negotiate_fds(sd_bus *bus, int b);
224b3787 146int sd_bus_can_send(sd_bus *bus, char type);
224b3787 147int sd_bus_get_creds_mask(sd_bus *bus, uint64_t *creds_mask);
c0765ddb
LP
148int sd_bus_set_allow_interactive_authorization(sd_bus *bus, int b);
149int sd_bus_get_allow_interactive_authorization(sd_bus *bus);
224b3787 150
021a1e78
LP
151int sd_bus_start(sd_bus *ret);
152
ae095f86 153int sd_bus_try_close(sd_bus *bus);
de1c301e
LP
154void sd_bus_close(sd_bus *bus);
155
156sd_bus *sd_bus_ref(sd_bus *bus);
157sd_bus *sd_bus_unref(sd_bus *bus);
03976f7b 158sd_bus *sd_bus_flush_close_unref(sd_bus *bus);
de1c301e 159
fa2f8973
LP
160void sd_bus_default_flush_close(void);
161
e3017af9 162int sd_bus_is_open(sd_bus *bus);
224b3787 163
5c302692 164int sd_bus_get_bus_id(sd_bus *bus, sd_id128_t *id);
3acc1daf 165int sd_bus_get_scope(sd_bus *bus, const char **scope);
69727e6d 166int sd_bus_get_tid(sd_bus *bus, pid_t *tid);
224b3787 167int sd_bus_get_owner_creds(sd_bus *bus, uint64_t creds_mask, sd_bus_creds **ret);
de1c301e 168
693eb9a2
LP
169int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *cookie);
170int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *cookie);
ebcf1f97 171int sd_bus_call(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *ret_error, sd_bus_message **reply);
19befb2d 172int sd_bus_call_async(sd_bus *bus, sd_bus_slot **slot, sd_bus_message *m, sd_bus_message_handler_t callback, void *userdata, uint64_t usec);
de1c301e
LP
173
174int sd_bus_get_fd(sd_bus *bus);
175int sd_bus_get_events(sd_bus *bus);
e3017af9 176int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
de1c301e 177int sd_bus_process(sd_bus *bus, sd_bus_message **r);
766c5809 178int sd_bus_process_priority(sd_bus *bus, int64_t max_priority, sd_bus_message **r);
de1c301e
LP
179int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
180int sd_bus_flush(sd_bus *bus);
f7fce345 181
19befb2d 182sd_bus_slot* sd_bus_get_current_slot(sd_bus *bus);
caa82984
LP
183sd_bus_message* sd_bus_get_current_message(sd_bus *bus);
184sd_bus_message_handler_t sd_bus_get_current_handler(sd_bus *bus);
185void* sd_bus_get_current_userdata(sd_bus *bus);
affff0b6 186
40ca29a1
LP
187int sd_bus_attach_event(sd_bus *bus, sd_event *e, int priority);
188int sd_bus_detach_event(sd_bus *bus);
2be44176 189sd_event *sd_bus_get_event(sd_bus *bus);
40ca29a1 190
19befb2d
LP
191int sd_bus_add_filter(sd_bus *bus, sd_bus_slot **slot, sd_bus_message_handler_t callback, void *userdata);
192int sd_bus_add_match(sd_bus *bus, sd_bus_slot **slot, const char *match, sd_bus_message_handler_t callback, void *userdata);
193int sd_bus_add_object(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_message_handler_t callback, void *userdata);
194int sd_bus_add_fallback(sd_bus *bus, sd_bus_slot **slot, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
195int sd_bus_add_object_vtable(sd_bus *bus, sd_bus_slot **slot, const char *path, const char *interface, const sd_bus_vtable *vtable, void *userdata);
196int sd_bus_add_fallback_vtable(sd_bus *bus, sd_bus_slot **slot, const char *prefix, const char *interface, const sd_bus_vtable *vtable, sd_bus_object_find_t find, void *userdata);
197int sd_bus_add_node_enumerator(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
198int sd_bus_add_object_manager(sd_bus *bus, sd_bus_slot **slot, const char *path);
de1c301e 199
19befb2d 200/* Slot object */
29ddb38f 201
19befb2d
LP
202sd_bus_slot* sd_bus_slot_ref(sd_bus_slot *slot);
203sd_bus_slot* sd_bus_slot_unref(sd_bus_slot *slot);
a652755d 204
19befb2d 205sd_bus* sd_bus_slot_get_bus(sd_bus_slot *slot);
19befb2d
LP
206void *sd_bus_slot_get_userdata(sd_bus_slot *slot);
207void *sd_bus_slot_set_userdata(sd_bus_slot *slot, void *userdata);
9cbfc66c 208int sd_bus_slot_set_description(sd_bus_slot *slot, const char *description);
839b6dbb 209int sd_bus_slot_get_description(sd_bus_slot *slot, const char **description);
9cbfc66c 210
19befb2d 211sd_bus_message* sd_bus_slot_get_current_message(sd_bus_slot *slot);
caa82984
LP
212sd_bus_message_handler_t sd_bus_slot_get_current_handler(sd_bus_slot *bus);
213void *sd_bus_slot_get_current_userdata(sd_bus_slot *slot);
29ddb38f
LP
214
215/* Message object */
a4297f08 216
151b9b96
LP
217int sd_bus_message_new_signal(sd_bus *bus, sd_bus_message **m, const char *path, const char *interface, const char *member);
218int sd_bus_message_new_method_call(sd_bus *bus, sd_bus_message **m, const char *destination, const char *path, const char *interface, const char *member);
df2d202e 219int sd_bus_message_new_method_return(sd_bus_message *call, sd_bus_message **m);
151b9b96 220int sd_bus_message_new_method_error(sd_bus_message *call, sd_bus_message **m, const sd_bus_error *e);
62ae7570 221int sd_bus_message_new_method_errorf(sd_bus_message *call, sd_bus_message **m, const char *name, const char *format, ...) _sd_printf_(4, 5);
151b9b96 222int sd_bus_message_new_method_errno(sd_bus_message *call, sd_bus_message **m, int error, const sd_bus_error *e);
62ae7570 223int sd_bus_message_new_method_errnof(sd_bus_message *call, sd_bus_message **m, int error, const char *format, ...) _sd_printf_(4, 5);
de1c301e
LP
224
225sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
226sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
227
228int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
693eb9a2
LP
229int sd_bus_message_get_cookie(sd_bus_message *m, uint64_t *cookie);
230int sd_bus_message_get_reply_cookie(sd_bus_message *m, uint64_t *cookie);
53a83f4b
LP
231int sd_bus_message_get_priority(sd_bus_message *m, int64_t *priority);
232
eee9ec0e
LP
233int sd_bus_message_get_expect_reply(sd_bus_message *m);
234int sd_bus_message_get_auto_start(sd_bus_message *m);
53a83f4b 235int sd_bus_message_get_allow_interactive_authorization(sd_bus_message *m);
de1c301e 236
40ca29a1 237const char *sd_bus_message_get_signature(sd_bus_message *m, int complete);
de1c301e
LP
238const char *sd_bus_message_get_path(sd_bus_message *m);
239const char *sd_bus_message_get_interface(sd_bus_message *m);
240const char *sd_bus_message_get_member(sd_bus_message *m);
241const char *sd_bus_message_get_destination(sd_bus_message *m);
242const char *sd_bus_message_get_sender(sd_bus_message *m);
243const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
40ca29a1 244int sd_bus_message_get_errno(sd_bus_message *m);
de1c301e 245
1fedcf59
LP
246int sd_bus_message_get_monotonic_usec(sd_bus_message *m, uint64_t *usec);
247int sd_bus_message_get_realtime_usec(sd_bus_message *m, uint64_t *usec);
6a0e376c
LP
248int sd_bus_message_get_seqnum(sd_bus_message *m, uint64_t* seqnum);
249
69727e6d 250sd_bus* sd_bus_message_get_bus(sd_bus_message *m);
5b12334d 251sd_bus_creds *sd_bus_message_get_creds(sd_bus_message *m); /* do not unref the result */
de1c301e
LP
252
253int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
254int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
255int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
8022212b 256int sd_bus_message_is_empty(sd_bus_message *m);
64e96a19 257int sd_bus_message_has_signature(sd_bus_message *m, const char *signature);
de1c301e 258
eee9ec0e
LP
259int sd_bus_message_set_expect_reply(sd_bus_message *m, int b);
260int sd_bus_message_set_auto_start(sd_bus_message *m, int b);
53a83f4b
LP
261int sd_bus_message_set_allow_interactive_authorization(sd_bus_message *m, int b);
262
de1c301e 263int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
ca7b42c8 264int sd_bus_message_set_priority(sd_bus_message *m, int64_t priority);
de1c301e
LP
265
266int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
267int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
f8e013f8
LP
268int sd_bus_message_append_array(sd_bus_message *m, char type, const void *ptr, size_t size);
269int sd_bus_message_append_array_space(sd_bus_message *m, char type, size_t size, void **ptr);
938bcbab 270int sd_bus_message_append_array_iovec(sd_bus_message *m, char type, const struct iovec *iov, unsigned n);
7dcd79c2 271int sd_bus_message_append_array_memfd(sd_bus_message *m, char type, int memfd, uint64_t offset, uint64_t size);
f8e013f8 272int sd_bus_message_append_string_space(sd_bus_message *m, size_t size, char **s);
938bcbab 273int sd_bus_message_append_string_iovec(sd_bus_message *m, const struct iovec *iov, unsigned n);
7dcd79c2 274int sd_bus_message_append_string_memfd(sd_bus_message *m, int memfd, uint64_t offset, uint64_t size);
55736ed0 275int sd_bus_message_append_strv(sd_bus_message *m, char **l);
de1c301e
LP
276int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
277int sd_bus_message_close_container(sd_bus_message *m);
c430fee6 278int sd_bus_message_copy(sd_bus_message *m, sd_bus_message *source, int all);
de1c301e 279
de1c301e 280int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
9a17484d 281int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
f8e013f8 282int sd_bus_message_read_array(sd_bus_message *m, char type, const void **ptr, size_t *size);
63be1989 283int sd_bus_message_read_strv(sd_bus_message *m, char ***l); /* free the result! */
9b07511d 284int sd_bus_message_skip(sd_bus_message *m, const char *types);
9a17484d
LP
285int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
286int sd_bus_message_exit_container(sd_bus_message *m);
287int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
c430fee6 288int sd_bus_message_verify_type(sd_bus_message *m, char type, const char *contents);
7b058942 289int sd_bus_message_at_end(sd_bus_message *m, int complete);
89ffcd2a 290int sd_bus_message_rewind(sd_bus_message *m, int complete);
de1c301e 291
5b12334d
LP
292/* Bus management */
293
294int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
29a07cdb 295int sd_bus_request_name(sd_bus *bus, const char *name, uint64_t flags);
5b12334d 296int sd_bus_release_name(sd_bus *bus, const char *name);
71f2ab46 297int sd_bus_list_names(sd_bus *bus, char ***acquired, char ***activatable); /* free the results */
056f95d0
DM
298int sd_bus_get_name_creds(sd_bus *bus, const char *name, uint64_t mask, sd_bus_creds **creds); /* unref the result! */
299int sd_bus_get_name_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
5b12334d 300
917b5dc7
LP
301/* Convenience calls */
302
ebcf1f97 303int sd_bus_call_method(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, sd_bus_message **reply, const char *types, ...);
5d941c92 304int sd_bus_call_method_async(sd_bus *bus, sd_bus_slot **slot, const char *destination, const char *path, const char *interface, const char *member, sd_bus_message_handler_t callback, void *userdata, const char *types, ...);
ebcf1f97
LP
305int sd_bus_get_property(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, sd_bus_message **reply, const char *type);
306int sd_bus_get_property_trivial(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, char type, void *ret_ptr);
307int sd_bus_get_property_string(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, char **ret); /* free the result! */
308int sd_bus_get_property_strv(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, char ***ret); /* free the result! */
882897af 309int sd_bus_set_property(sd_bus *bus, const char *destination, const char *path, const char *interface, const char *member, sd_bus_error *ret_error, const char *type, ...);
911121a7 310
df2d202e
LP
311int sd_bus_reply_method_return(sd_bus_message *call, const char *types, ...);
312int sd_bus_reply_method_error(sd_bus_message *call, const sd_bus_error *e);
62ae7570 313int sd_bus_reply_method_errorf(sd_bus_message *call, const char *name, const char *format, ...) _sd_printf_(3, 4);
df2d202e 314int sd_bus_reply_method_errno(sd_bus_message *call, int error, const sd_bus_error *e);
62ae7570 315int sd_bus_reply_method_errnof(sd_bus_message *call, int error, const char *format, ...) _sd_printf_(3, 4);
29ddb38f
LP
316
317int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
318
319int sd_bus_emit_properties_changed_strv(sd_bus *bus, const char *path, const char *interface, char **names);
aacf3b48 320int sd_bus_emit_properties_changed(sd_bus *bus, const char *path, const char *interface, const char *name, ...) _sd_sentinel_;
29ddb38f 321
d95eb43e
DH
322int sd_bus_emit_object_added(sd_bus *bus, const char *path);
323int sd_bus_emit_object_removed(sd_bus *bus, const char *path);
4be39163 324int sd_bus_emit_interfaces_added_strv(sd_bus *bus, const char *path, char **interfaces);
aacf3b48 325int sd_bus_emit_interfaces_added(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
4be39163 326int sd_bus_emit_interfaces_removed_strv(sd_bus *bus, const char *path, char **interfaces);
aacf3b48 327int sd_bus_emit_interfaces_removed(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
917b5dc7 328
5b12334d 329int sd_bus_query_sender_creds(sd_bus_message *call, uint64_t mask, sd_bus_creds **creds);
def9a7aa 330int sd_bus_query_sender_privilege(sd_bus_message *call, int capability);
5b12334d
LP
331
332/* Credential handling */
333
151b9b96 334int sd_bus_creds_new_from_pid(sd_bus_creds **ret, pid_t pid, uint64_t creds_mask);
5b12334d
LP
335sd_bus_creds *sd_bus_creds_ref(sd_bus_creds *c);
336sd_bus_creds *sd_bus_creds_unref(sd_bus_creds *c);
4cf8496d 337uint64_t sd_bus_creds_get_mask(const sd_bus_creds *c);
0f514420 338uint64_t sd_bus_creds_get_augmented_mask(const sd_bus_creds *c);
5b12334d 339
5b12334d 340int sd_bus_creds_get_pid(sd_bus_creds *c, pid_t *pid);
1386e47d 341int sd_bus_creds_get_ppid(sd_bus_creds *c, pid_t *ppid);
5b12334d 342int sd_bus_creds_get_tid(sd_bus_creds *c, pid_t *tid);
49b832c5 343int sd_bus_creds_get_uid(sd_bus_creds *c, uid_t *uid);
705a415f
LP
344int sd_bus_creds_get_euid(sd_bus_creds *c, uid_t *euid);
345int sd_bus_creds_get_suid(sd_bus_creds *c, uid_t *suid);
346int sd_bus_creds_get_fsuid(sd_bus_creds *c, uid_t *fsuid);
49b832c5 347int sd_bus_creds_get_gid(sd_bus_creds *c, gid_t *gid);
705a415f
LP
348int sd_bus_creds_get_egid(sd_bus_creds *c, gid_t *egid);
349int sd_bus_creds_get_sgid(sd_bus_creds *c, gid_t *sgid);
350int sd_bus_creds_get_fsgid(sd_bus_creds *c, gid_t *fsgid);
02581590 351int sd_bus_creds_get_supplementary_gids(sd_bus_creds *c, const gid_t **gids);
cd6d5e1c
ZJS
352int sd_bus_creds_get_comm(sd_bus_creds *c, const char **comm);
353int sd_bus_creds_get_tid_comm(sd_bus_creds *c, const char **comm);
354int sd_bus_creds_get_exe(sd_bus_creds *c, const char **exe);
5b12334d 355int sd_bus_creds_get_cmdline(sd_bus_creds *c, char ***cmdline);
cd6d5e1c 356int sd_bus_creds_get_cgroup(sd_bus_creds *c, const char **cgroup);
5b12334d 357int sd_bus_creds_get_unit(sd_bus_creds *c, const char **unit);
5b12334d 358int sd_bus_creds_get_slice(sd_bus_creds *c, const char **slice);
329ac4bc
LP
359int sd_bus_creds_get_user_unit(sd_bus_creds *c, const char **unit);
360int sd_bus_creds_get_user_slice(sd_bus_creds *c, const char **slice);
5b12334d
LP
361int sd_bus_creds_get_session(sd_bus_creds *c, const char **session);
362int sd_bus_creds_get_owner_uid(sd_bus_creds *c, uid_t *uid);
363int sd_bus_creds_has_effective_cap(sd_bus_creds *c, int capability);
364int sd_bus_creds_has_permitted_cap(sd_bus_creds *c, int capability);
365int sd_bus_creds_has_inheritable_cap(sd_bus_creds *c, int capability);
366int sd_bus_creds_has_bounding_cap(sd_bus_creds *c, int capability);
cd6d5e1c 367int sd_bus_creds_get_selinux_context(sd_bus_creds *c, const char **context);
5b12334d
LP
368int sd_bus_creds_get_audit_session_id(sd_bus_creds *c, uint32_t *sessionid);
369int sd_bus_creds_get_audit_login_uid(sd_bus_creds *c, uid_t *loginuid);
4761e880 370int sd_bus_creds_get_tty(sd_bus_creds *c, const char **tty);
49b832c5
LP
371int sd_bus_creds_get_unique_name(sd_bus_creds *c, const char **name);
372int sd_bus_creds_get_well_known_names(sd_bus_creds *c, char ***names);
455971c1 373int sd_bus_creds_get_description(sd_bus_creds *c, const char **name);
de1c301e 374
fbfa72b0 375/* Error structures */
de1c301e 376
442e2def 377#define SD_BUS_ERROR_MAKE_CONST(name, message) ((const sd_bus_error) {(name), (message), 0})
14c24659 378#define SD_BUS_ERROR_NULL SD_BUS_ERROR_MAKE_CONST(NULL, NULL)
fedfcdee 379
de1c301e 380void sd_bus_error_free(sd_bus_error *e);
29ddb38f 381int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message);
62ae7570 382int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...) _sd_printf_(3, 4);
40ca29a1
LP
383int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
384int sd_bus_error_set_errno(sd_bus_error *e, int error);
62ae7570 385int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) _sd_printf_(3, 4);
83e44331 386int sd_bus_error_set_errnofv(sd_bus_error *e, int error, const char *format, va_list ap) _sd_printf_(3,0);
40ca29a1 387int sd_bus_error_get_errno(const sd_bus_error *e);
de1c301e
LP
388int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
389int sd_bus_error_is_set(const sd_bus_error *e);
390int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
391
5f86c1f4
LP
392#define SD_BUS_ERROR_MAP(_name, _code) \
393 { \
394 .name = _name, \
395 .code = _code, \
396 }
397#define SD_BUS_ERROR_MAP_END \
398 { \
399 .name = NULL, \
400 .code = - 'x', \
401 }
402
403int sd_bus_error_add_map(const sd_bus_error_map *map);
404
5b12334d
LP
405/* Auxiliary macros */
406
40ca29a1
LP
407#define SD_BUS_MESSAGE_APPEND_ID128(x) 16, \
408 (x).bytes[0], (x).bytes[1], (x).bytes[2], (x).bytes[3], \
409 (x).bytes[4], (x).bytes[5], (x).bytes[6], (x).bytes[7], \
9444b1f2
LP
410 (x).bytes[8], (x).bytes[9], (x).bytes[10], (x).bytes[11], \
411 (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
412
29f8d1f2
LP
413#define SD_BUS_MESSAGE_READ_ID128(x) 16, \
414 &(x).bytes[0], &(x).bytes[1], &(x).bytes[2], &(x).bytes[3], \
415 &(x).bytes[4], &(x).bytes[5], &(x).bytes[6], &(x).bytes[7], \
416 &(x).bytes[8], &(x).bytes[9], &(x).bytes[10], &(x).bytes[11], \
417 &(x).bytes[12], &(x).bytes[13], &(x).bytes[14], &(x).bytes[15]
418
5b12334d
LP
419/* Label escaping */
420
a6278b88 421int sd_bus_path_encode(const char *prefix, const char *external_id, char **ret_path);
dfb815c3 422int sd_bus_path_encode_many(char **out, const char *path_template, ...);
a6278b88 423int sd_bus_path_decode(const char *path, const char *prefix, char **ret_external_id);
dfb815c3 424int sd_bus_path_decode_many(const char *path, const char *path_template, ...);
28383ba1 425
8f8f05a9
LP
426/* Tracking peers */
427
428int sd_bus_track_new(sd_bus *bus, sd_bus_track **track, sd_bus_track_handler_t handler, void *userdata);
429sd_bus_track* sd_bus_track_ref(sd_bus_track *track);
430sd_bus_track* sd_bus_track_unref(sd_bus_track *track);
04552566 431
8f8f05a9 432sd_bus* sd_bus_track_get_bus(sd_bus_track *track);
04552566
LP
433void *sd_bus_track_get_userdata(sd_bus_track *track);
434void *sd_bus_track_set_userdata(sd_bus_track *track, void *userdata);
8f8f05a9
LP
435
436int sd_bus_track_add_sender(sd_bus_track *track, sd_bus_message *m);
437int sd_bus_track_remove_sender(sd_bus_track *track, sd_bus_message *m);
438int sd_bus_track_add_name(sd_bus_track *track, const char *name);
439int sd_bus_track_remove_name(sd_bus_track *track, const char *name);
440
441unsigned sd_bus_track_count(sd_bus_track *track);
442const char* sd_bus_track_contains(sd_bus_track *track, const char *names);
443const char* sd_bus_track_first(sd_bus_track *track);
444const char* sd_bus_track_next(sd_bus_track *track);
445
4afd3348
LP
446/* Define helpers so that __attribute__((cleanup(sd_bus_unrefp))) and similar may be used. */
447_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_unref);
448_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_flush_close_unref);
449_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_slot, sd_bus_slot_unref);
450_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_message, sd_bus_message_unref);
451_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_creds, sd_bus_creds_unref);
452_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_track, sd_bus_track_unref);
453
0095c454 454_SD_END_DECLARATIONS;
b29b8bc2 455
de1c301e 456#endif