chiark / gitweb /
Prep 229.9: Make all supportable API functions visible.
[elogind.git] / src / systemd / sd-bus.h
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>
24 #include <stdarg.h>
25 #include <sys/types.h>
26 #include <sys/uio.h>
27
28 #include "sd-event.h"
29 #include "sd-id128.h"
30
31 #include "_sd-common.h"
32
33 _SD_BEGIN_DECLARATIONS;
34
35 /* Types */
36
37 typedef struct sd_bus sd_bus;
38 typedef struct sd_bus_message sd_bus_message;
39 typedef struct sd_bus_slot sd_bus_slot;
40 typedef struct sd_bus_creds sd_bus_creds;
41 typedef struct sd_bus_track sd_bus_track;
42
43 typedef struct {
44         const char *name;
45         const char *message;
46         int _need_free;
47 } sd_bus_error;
48
49 typedef struct {
50         const char* name;
51         int code;
52 } sd_bus_error_map;
53
54 /* Flags */
55
56 enum {
57         SD_BUS_CREDS_PID                = 1ULL << 0,
58         SD_BUS_CREDS_TID                = 1ULL << 1,
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,
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,
91         SD_BUS_CREDS_AUGMENT            = 1ULL << 63, /* special flag, if on sd-bus will augment creds struct, in a potentially race-full way. */
92         _SD_BUS_CREDS_ALL               = (1ULL << 34) -1
93 };
94
95 enum {
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
101 /* Callbacks */
102
103 typedef int (*sd_bus_message_handler_t)(sd_bus_message *m, void *userdata, sd_bus_error *ret_error);
104 typedef 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);
105 typedef 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);
106 typedef 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);
107 typedef int (*sd_bus_node_enumerator_t) (sd_bus *bus, const char *prefix, void *userdata, char ***ret_nodes, sd_bus_error *ret_error);
108 typedef int (*sd_bus_track_handler_t) (sd_bus_track *track, void *userdata);
109
110 #include "sd-bus-protocol.h"
111 #include "sd-bus-vtable.h"
112
113 /* Connections */
114
115 int sd_bus_default(sd_bus **ret);
116 int sd_bus_default_user(sd_bus **ret);
117 int sd_bus_default_system(sd_bus **ret);
118
119 int sd_bus_open(sd_bus **ret);
120 int sd_bus_open_user(sd_bus **ret);
121 int sd_bus_open_system(sd_bus **ret);
122 int sd_bus_open_system_remote(sd_bus **ret, const char *host);
123 int sd_bus_open_system_machine(sd_bus **ret, const char *machine);
124
125 int sd_bus_new(sd_bus **ret);
126
127 int sd_bus_set_address(sd_bus *bus, const char *address);
128 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
129 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
130 int sd_bus_get_address(sd_bus *bus, const char **address);
131 int sd_bus_set_bus_client(sd_bus *bus, int b);
132 int sd_bus_is_bus_client(sd_bus *bus);
133 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t bus_id);
134 int sd_bus_is_server(sd_bus *bus);
135 int sd_bus_set_anonymous(sd_bus *bus, int b);
136 int sd_bus_is_anonymous(sd_bus *bus);
137 int sd_bus_set_trusted(sd_bus *bus, int b);
138 int sd_bus_is_trusted(sd_bus *bus);
139 int sd_bus_set_monitor(sd_bus *bus, int b);
140 int sd_bus_is_monitor(sd_bus *bus);
141 int sd_bus_set_description(sd_bus *bus, const char *description);
142 int sd_bus_get_description(sd_bus *bus, const char **description);
143 int sd_bus_negotiate_creds(sd_bus *bus, int b, uint64_t creds_mask);
144 int sd_bus_negotiate_timestamp(sd_bus *bus, int b);
145 int sd_bus_negotiate_fds(sd_bus *bus, int b);
146 int sd_bus_can_send(sd_bus *bus, char type);
147 int sd_bus_get_creds_mask(sd_bus *bus, uint64_t *creds_mask);
148 int sd_bus_set_allow_interactive_authorization(sd_bus *bus, int b);
149 int sd_bus_get_allow_interactive_authorization(sd_bus *bus);
150
151 int sd_bus_set_exit_on_disconnect(sd_bus *bus, int b);
152 #if 0 /// UNNEEDED by elogind
153 int sd_bus_get_exit_on_disconnect(sd_bus *bus);
154 #endif // 0
155
156 int sd_bus_start(sd_bus *ret);
157
158 int sd_bus_try_close(sd_bus *bus);
159 void sd_bus_close(sd_bus *bus);
160
161 sd_bus *sd_bus_ref(sd_bus *bus);
162 sd_bus *sd_bus_unref(sd_bus *bus);
163 sd_bus *sd_bus_flush_close_unref(sd_bus *bus);
164
165 void sd_bus_default_flush_close(void);
166
167 int sd_bus_is_open(sd_bus *bus);
168
169 int sd_bus_get_bus_id(sd_bus *bus, sd_id128_t *id);
170 int sd_bus_get_scope(sd_bus *bus, const char **scope);
171 int sd_bus_get_tid(sd_bus *bus, pid_t *tid);
172 int sd_bus_get_owner_creds(sd_bus *bus, uint64_t creds_mask, sd_bus_creds **ret);
173
174 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *cookie);
175 int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *cookie);
176 int sd_bus_call(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *ret_error, sd_bus_message **reply);
177 int 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);
178
179 int sd_bus_get_fd(sd_bus *bus);
180 int sd_bus_get_events(sd_bus *bus);
181 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
182 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
183 int sd_bus_process_priority(sd_bus *bus, int64_t max_priority, sd_bus_message **r);
184 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
185 int sd_bus_flush(sd_bus *bus);
186
187 sd_bus_slot* sd_bus_get_current_slot(sd_bus *bus);
188 sd_bus_message* sd_bus_get_current_message(sd_bus *bus);
189 sd_bus_message_handler_t sd_bus_get_current_handler(sd_bus *bus);
190 void* sd_bus_get_current_userdata(sd_bus *bus);
191
192 int sd_bus_attach_event(sd_bus *bus, sd_event *e, int priority);
193 int sd_bus_detach_event(sd_bus *bus);
194 sd_event *sd_bus_get_event(sd_bus *bus);
195
196 int sd_bus_add_filter(sd_bus *bus, sd_bus_slot **slot, sd_bus_message_handler_t callback, void *userdata);
197 int sd_bus_add_match(sd_bus *bus, sd_bus_slot **slot, const char *match, sd_bus_message_handler_t callback, void *userdata);
198 int sd_bus_add_object(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_message_handler_t callback, void *userdata);
199 int sd_bus_add_fallback(sd_bus *bus, sd_bus_slot **slot, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
200 int 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);
201 int 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);
202 int sd_bus_add_node_enumerator(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
203 int sd_bus_add_object_manager(sd_bus *bus, sd_bus_slot **slot, const char *path);
204
205 /* Slot object */
206
207 sd_bus_slot* sd_bus_slot_ref(sd_bus_slot *slot);
208 sd_bus_slot* sd_bus_slot_unref(sd_bus_slot *slot);
209
210 sd_bus* sd_bus_slot_get_bus(sd_bus_slot *slot);
211 void *sd_bus_slot_get_userdata(sd_bus_slot *slot);
212 void *sd_bus_slot_set_userdata(sd_bus_slot *slot, void *userdata);
213 int sd_bus_slot_set_description(sd_bus_slot *slot, const char *description);
214 int sd_bus_slot_get_description(sd_bus_slot *slot, const char **description);
215
216 sd_bus_message* sd_bus_slot_get_current_message(sd_bus_slot *slot);
217 sd_bus_message_handler_t sd_bus_slot_get_current_handler(sd_bus_slot *bus);
218 void *sd_bus_slot_get_current_userdata(sd_bus_slot *slot);
219
220 /* Message object */
221
222 int sd_bus_message_new_signal(sd_bus *bus, sd_bus_message **m, const char *path, const char *interface, const char *member);
223 int 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);
224 int sd_bus_message_new_method_return(sd_bus_message *call, sd_bus_message **m);
225 int sd_bus_message_new_method_error(sd_bus_message *call, sd_bus_message **m, const sd_bus_error *e);
226 int sd_bus_message_new_method_errorf(sd_bus_message *call, sd_bus_message **m, const char *name, const char *format, ...) _sd_printf_(4, 5);
227 int sd_bus_message_new_method_errno(sd_bus_message *call, sd_bus_message **m, int error, const sd_bus_error *e);
228 int sd_bus_message_new_method_errnof(sd_bus_message *call, sd_bus_message **m, int error, const char *format, ...) _sd_printf_(4, 5);
229
230 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
231 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
232
233 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
234 int sd_bus_message_get_cookie(sd_bus_message *m, uint64_t *cookie);
235 int sd_bus_message_get_reply_cookie(sd_bus_message *m, uint64_t *cookie);
236 int sd_bus_message_get_priority(sd_bus_message *m, int64_t *priority);
237
238 int sd_bus_message_get_expect_reply(sd_bus_message *m);
239 int sd_bus_message_get_auto_start(sd_bus_message *m);
240 int sd_bus_message_get_allow_interactive_authorization(sd_bus_message *m);
241
242 const char *sd_bus_message_get_signature(sd_bus_message *m, int complete);
243 const char *sd_bus_message_get_path(sd_bus_message *m);
244 const char *sd_bus_message_get_interface(sd_bus_message *m);
245 const char *sd_bus_message_get_member(sd_bus_message *m);
246 const char *sd_bus_message_get_destination(sd_bus_message *m);
247 const char *sd_bus_message_get_sender(sd_bus_message *m);
248 const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
249 int sd_bus_message_get_errno(sd_bus_message *m);
250
251 int sd_bus_message_get_monotonic_usec(sd_bus_message *m, uint64_t *usec);
252 int sd_bus_message_get_realtime_usec(sd_bus_message *m, uint64_t *usec);
253 int sd_bus_message_get_seqnum(sd_bus_message *m, uint64_t* seqnum);
254
255 sd_bus* sd_bus_message_get_bus(sd_bus_message *m);
256 sd_bus_creds *sd_bus_message_get_creds(sd_bus_message *m); /* do not unref the result */
257
258 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
259 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
260 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
261 int sd_bus_message_is_empty(sd_bus_message *m);
262 int sd_bus_message_has_signature(sd_bus_message *m, const char *signature);
263
264 int sd_bus_message_set_expect_reply(sd_bus_message *m, int b);
265 int sd_bus_message_set_auto_start(sd_bus_message *m, int b);
266 int sd_bus_message_set_allow_interactive_authorization(sd_bus_message *m, int b);
267
268 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
269 int sd_bus_message_set_priority(sd_bus_message *m, int64_t priority);
270
271 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
272 int sd_bus_message_appendv(sd_bus_message *m, const char *types, va_list ap);
273 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
274 int sd_bus_message_append_array(sd_bus_message *m, char type, const void *ptr, size_t size);
275 int sd_bus_message_append_array_space(sd_bus_message *m, char type, size_t size, void **ptr);
276 int sd_bus_message_append_array_iovec(sd_bus_message *m, char type, const struct iovec *iov, unsigned n);
277 int sd_bus_message_append_array_memfd(sd_bus_message *m, char type, int memfd, uint64_t offset, uint64_t size);
278 int sd_bus_message_append_string_space(sd_bus_message *m, size_t size, char **s);
279 int sd_bus_message_append_string_iovec(sd_bus_message *m, const struct iovec *iov, unsigned n);
280 int sd_bus_message_append_string_memfd(sd_bus_message *m, int memfd, uint64_t offset, uint64_t size);
281 int sd_bus_message_append_strv(sd_bus_message *m, char **l);
282 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
283 int sd_bus_message_close_container(sd_bus_message *m);
284 int sd_bus_message_copy(sd_bus_message *m, sd_bus_message *source, int all);
285
286 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
287 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
288 int sd_bus_message_read_array(sd_bus_message *m, char type, const void **ptr, size_t *size);
289 int sd_bus_message_read_strv(sd_bus_message *m, char ***l); /* free the result! */
290 int sd_bus_message_skip(sd_bus_message *m, const char *types);
291 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
292 int sd_bus_message_exit_container(sd_bus_message *m);
293 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
294 int sd_bus_message_verify_type(sd_bus_message *m, char type, const char *contents);
295 int sd_bus_message_at_end(sd_bus_message *m, int complete);
296 int sd_bus_message_rewind(sd_bus_message *m, int complete);
297
298 /* Bus management */
299
300 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
301 int sd_bus_request_name(sd_bus *bus, const char *name, uint64_t flags);
302 int sd_bus_release_name(sd_bus *bus, const char *name);
303 int sd_bus_list_names(sd_bus *bus, char ***acquired, char ***activatable); /* free the results */
304 int sd_bus_get_name_creds(sd_bus *bus, const char *name, uint64_t mask, sd_bus_creds **creds); /* unref the result! */
305 int sd_bus_get_name_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
306
307 /* Convenience calls */
308
309 int 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, ...);
310 int 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, ...);
311 int 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);
312 int 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);
313 int 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! */
314 int 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! */
315 int 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, ...);
316
317 int sd_bus_reply_method_return(sd_bus_message *call, const char *types, ...);
318 int sd_bus_reply_method_error(sd_bus_message *call, const sd_bus_error *e);
319 int sd_bus_reply_method_errorf(sd_bus_message *call, const char *name, const char *format, ...) _sd_printf_(3, 4);
320 int sd_bus_reply_method_errno(sd_bus_message *call, int error, const sd_bus_error *e);
321 int sd_bus_reply_method_errnof(sd_bus_message *call, int error, const char *format, ...) _sd_printf_(3, 4);
322
323 int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
324
325 int sd_bus_emit_properties_changed_strv(sd_bus *bus, const char *path, const char *interface, char **names);
326 int sd_bus_emit_properties_changed(sd_bus *bus, const char *path, const char *interface, const char *name, ...) _sd_sentinel_;
327
328 int sd_bus_emit_object_added(sd_bus *bus, const char *path);
329 int sd_bus_emit_object_removed(sd_bus *bus, const char *path);
330 int sd_bus_emit_interfaces_added_strv(sd_bus *bus, const char *path, char **interfaces);
331 int sd_bus_emit_interfaces_added(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
332 int sd_bus_emit_interfaces_removed_strv(sd_bus *bus, const char *path, char **interfaces);
333 int sd_bus_emit_interfaces_removed(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
334
335 int sd_bus_query_sender_creds(sd_bus_message *call, uint64_t mask, sd_bus_creds **creds);
336 int sd_bus_query_sender_privilege(sd_bus_message *call, int capability);
337
338 /* Credential handling */
339
340 int sd_bus_creds_new_from_pid(sd_bus_creds **ret, pid_t pid, uint64_t creds_mask);
341 sd_bus_creds *sd_bus_creds_ref(sd_bus_creds *c);
342 sd_bus_creds *sd_bus_creds_unref(sd_bus_creds *c);
343 uint64_t sd_bus_creds_get_mask(const sd_bus_creds *c);
344 uint64_t sd_bus_creds_get_augmented_mask(const sd_bus_creds *c);
345
346 int sd_bus_creds_get_pid(sd_bus_creds *c, pid_t *pid);
347 int sd_bus_creds_get_ppid(sd_bus_creds *c, pid_t *ppid);
348 int sd_bus_creds_get_tid(sd_bus_creds *c, pid_t *tid);
349 int sd_bus_creds_get_uid(sd_bus_creds *c, uid_t *uid);
350 int sd_bus_creds_get_euid(sd_bus_creds *c, uid_t *euid);
351 int sd_bus_creds_get_suid(sd_bus_creds *c, uid_t *suid);
352 int sd_bus_creds_get_fsuid(sd_bus_creds *c, uid_t *fsuid);
353 int sd_bus_creds_get_gid(sd_bus_creds *c, gid_t *gid);
354 int sd_bus_creds_get_egid(sd_bus_creds *c, gid_t *egid);
355 int sd_bus_creds_get_sgid(sd_bus_creds *c, gid_t *sgid);
356 int sd_bus_creds_get_fsgid(sd_bus_creds *c, gid_t *fsgid);
357 int sd_bus_creds_get_supplementary_gids(sd_bus_creds *c, const gid_t **gids);
358 int sd_bus_creds_get_comm(sd_bus_creds *c, const char **comm);
359 int sd_bus_creds_get_tid_comm(sd_bus_creds *c, const char **comm);
360 int sd_bus_creds_get_exe(sd_bus_creds *c, const char **exe);
361 int sd_bus_creds_get_cmdline(sd_bus_creds *c, char ***cmdline);
362 int sd_bus_creds_get_cgroup(sd_bus_creds *c, const char **cgroup);
363 #if 0 /// unsupported by elogind
364 int sd_bus_creds_get_unit(sd_bus_creds *c, const char **unit);
365 int sd_bus_creds_get_slice(sd_bus_creds *c, const char **slice);
366 int sd_bus_creds_get_user_unit(sd_bus_creds *c, const char **unit);
367 int sd_bus_creds_get_user_slice(sd_bus_creds *c, const char **slice);
368 #endif // 0
369 int sd_bus_creds_get_session(sd_bus_creds *c, const char **session);
370 int sd_bus_creds_get_owner_uid(sd_bus_creds *c, uid_t *uid);
371 int sd_bus_creds_has_effective_cap(sd_bus_creds *c, int capability);
372 int sd_bus_creds_has_permitted_cap(sd_bus_creds *c, int capability);
373 int sd_bus_creds_has_inheritable_cap(sd_bus_creds *c, int capability);
374 int sd_bus_creds_has_bounding_cap(sd_bus_creds *c, int capability);
375 int sd_bus_creds_get_selinux_context(sd_bus_creds *c, const char **context);
376 int sd_bus_creds_get_audit_session_id(sd_bus_creds *c, uint32_t *sessionid);
377 int sd_bus_creds_get_audit_login_uid(sd_bus_creds *c, uid_t *loginuid);
378 int sd_bus_creds_get_tty(sd_bus_creds *c, const char **tty);
379 int sd_bus_creds_get_unique_name(sd_bus_creds *c, const char **name);
380 int sd_bus_creds_get_well_known_names(sd_bus_creds *c, char ***names);
381 int sd_bus_creds_get_description(sd_bus_creds *c, const char **name);
382
383 /* Error structures */
384
385 #define SD_BUS_ERROR_MAKE_CONST(name, message) ((const sd_bus_error) {(name), (message), 0})
386 #define SD_BUS_ERROR_NULL SD_BUS_ERROR_MAKE_CONST(NULL, NULL)
387
388 void sd_bus_error_free(sd_bus_error *e);
389 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message);
390 int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...)  _sd_printf_(3, 4);
391 int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
392 int sd_bus_error_set_errno(sd_bus_error *e, int error);
393 int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) _sd_printf_(3, 4);
394 int sd_bus_error_set_errnofv(sd_bus_error *e, int error, const char *format, va_list ap) _sd_printf_(3,0);
395 int sd_bus_error_get_errno(const sd_bus_error *e);
396 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
397 int sd_bus_error_is_set(const sd_bus_error *e);
398 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
399
400 #define SD_BUS_ERROR_MAP(_name, _code)          \
401         {                                       \
402                 .name = _name,                  \
403                 .code = _code,                  \
404         }
405 #define SD_BUS_ERROR_MAP_END                    \
406         {                                       \
407                 .name = NULL,                   \
408                 .code = - 'x',                  \
409         }
410
411 int sd_bus_error_add_map(const sd_bus_error_map *map);
412
413 /* Auxiliary macros */
414
415 #define SD_BUS_MESSAGE_APPEND_ID128(x) 16,                              \
416                 (x).bytes[0],  (x).bytes[1],  (x).bytes[2],  (x).bytes[3], \
417                 (x).bytes[4],  (x).bytes[5],  (x).bytes[6],  (x).bytes[7], \
418                 (x).bytes[8],  (x).bytes[9],  (x).bytes[10], (x).bytes[11], \
419                 (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
420
421 #define SD_BUS_MESSAGE_READ_ID128(x) 16,                                \
422                 &(x).bytes[0],  &(x).bytes[1],  &(x).bytes[2],  &(x).bytes[3], \
423                 &(x).bytes[4],  &(x).bytes[5],  &(x).bytes[6],  &(x).bytes[7], \
424                 &(x).bytes[8],  &(x).bytes[9],  &(x).bytes[10], &(x).bytes[11], \
425                 &(x).bytes[12], &(x).bytes[13], &(x).bytes[14], &(x).bytes[15]
426
427 /* Label escaping */
428
429 int sd_bus_path_encode(const char *prefix, const char *external_id, char **ret_path);
430 int sd_bus_path_encode_many(char **out, const char *path_template, ...);
431 int sd_bus_path_decode(const char *path, const char *prefix, char **ret_external_id);
432 int sd_bus_path_decode_many(const char *path, const char *path_template, ...);
433
434 /* Tracking peers */
435
436 int sd_bus_track_new(sd_bus *bus, sd_bus_track **track, sd_bus_track_handler_t handler, void *userdata);
437 sd_bus_track* sd_bus_track_ref(sd_bus_track *track);
438 sd_bus_track* sd_bus_track_unref(sd_bus_track *track);
439
440 sd_bus* sd_bus_track_get_bus(sd_bus_track *track);
441 void *sd_bus_track_get_userdata(sd_bus_track *track);
442 void *sd_bus_track_set_userdata(sd_bus_track *track, void *userdata);
443
444 int sd_bus_track_add_sender(sd_bus_track *track, sd_bus_message *m);
445 int sd_bus_track_remove_sender(sd_bus_track *track, sd_bus_message *m);
446 int sd_bus_track_add_name(sd_bus_track *track, const char *name);
447 int sd_bus_track_remove_name(sd_bus_track *track, const char *name);
448
449 #if 0 /// UNNEEDED by elogind
450 int sd_bus_track_set_recursive(sd_bus_track *track, int b);
451 int sd_bus_track_get_recursive(sd_bus_track *track);
452 #endif // 0
453
454 unsigned sd_bus_track_count(sd_bus_track *track);
455 #if 0 /// UNNEEDED by elogind
456 int sd_bus_track_count_sender(sd_bus_track *track, sd_bus_message *m);
457 int sd_bus_track_count_name(sd_bus_track *track, const char *name);
458 #endif // 0
459
460 const char* sd_bus_track_contains(sd_bus_track *track, const char *name);
461 const char* sd_bus_track_first(sd_bus_track *track);
462 const char* sd_bus_track_next(sd_bus_track *track);
463
464 /* Define helpers so that __attribute__((cleanup(sd_bus_unrefp))) and similar may be used. */
465 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_unref);
466 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_flush_close_unref);
467 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_slot, sd_bus_slot_unref);
468 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_message, sd_bus_message_unref);
469 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_creds, sd_bus_creds_unref);
470 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_track, sd_bus_track_unref);
471
472 _SD_END_DECLARATIONS;
473
474 #endif