chiark / gitweb /
21d693b4bc9d6f9cc2480a6306128a4bcc5ab154
[elogind.git] / src / systemd / sd-bus.h
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3 #ifndef foosdbushfoo
4 #define foosdbushfoo
5
6 /***
7   This file is part of systemd.
8
9   Copyright 2013 Lennart Poettering
10
11   systemd is free software; you can redistribute it and/or modify it
12   under the terms of the GNU Lesser General Public License as published by
13   the Free Software Foundation; either version 2.1 of the License, or
14   (at your option) any later version.
15
16   systemd is distributed in the hope that it will be useful, but
17   WITHOUT ANY WARRANTY; without even the implied warranty of
18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   Lesser General Public License for more details.
20
21   You should have received a copy of the GNU Lesser General Public License
22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 ***/
24
25 #include <inttypes.h>
26 #include <sys/types.h>
27 #include <sys/uio.h>
28
29 #include "sd-id128.h"
30 #include "sd-event.h"
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 /* Flags */
50
51 enum {
52         SD_BUS_CREDS_PID              = 1ULL << 0,
53         SD_BUS_CREDS_PID_STARTTIME    = 1ULL << 1,
54         SD_BUS_CREDS_TID              = 1ULL << 2,
55         SD_BUS_CREDS_UID              = 1ULL << 3,
56         SD_BUS_CREDS_EUID             = 1ULL << 4,
57         SD_BUS_CREDS_SUID             = 1ULL << 5,
58         SD_BUS_CREDS_FSUID            = 1ULL << 6,
59         SD_BUS_CREDS_GID              = 1ULL << 7,
60         SD_BUS_CREDS_EGID             = 1ULL << 8,
61         SD_BUS_CREDS_SGID             = 1ULL << 9,
62         SD_BUS_CREDS_FSGID            = 1ULL << 10,
63         SD_BUS_CREDS_COMM             = 1ULL << 11,
64         SD_BUS_CREDS_TID_COMM         = 1ULL << 12,
65         SD_BUS_CREDS_EXE              = 1ULL << 13,
66         SD_BUS_CREDS_CMDLINE          = 1ULL << 14,
67         SD_BUS_CREDS_CGROUP           = 1ULL << 15,
68         SD_BUS_CREDS_UNIT             = 1ULL << 16,
69         SD_BUS_CREDS_USER_UNIT        = 1ULL << 17,
70         SD_BUS_CREDS_SLICE            = 1ULL << 18,
71         SD_BUS_CREDS_SESSION          = 1ULL << 19,
72         SD_BUS_CREDS_OWNER_UID        = 1ULL << 20,
73         SD_BUS_CREDS_EFFECTIVE_CAPS   = 1ULL << 21,
74         SD_BUS_CREDS_PERMITTED_CAPS   = 1ULL << 22,
75         SD_BUS_CREDS_INHERITABLE_CAPS = 1ULL << 23,
76         SD_BUS_CREDS_BOUNDING_CAPS    = 1ULL << 24,
77         SD_BUS_CREDS_SELINUX_CONTEXT  = 1ULL << 25,
78         SD_BUS_CREDS_AUDIT_SESSION_ID = 1ULL << 26,
79         SD_BUS_CREDS_AUDIT_LOGIN_UID  = 1ULL << 27,
80         SD_BUS_CREDS_UNIQUE_NAME      = 1ULL << 28,
81         SD_BUS_CREDS_WELL_KNOWN_NAMES = 1ULL << 29,
82         SD_BUS_CREDS_DESCRIPTION      = 1ULL << 30,
83         SD_BUS_CREDS_AUGMENT          = 1ULL << 63, /* special flag, if on sd-bus will augment creds struct, in a potentially race-full way. */
84         _SD_BUS_CREDS_ALL             = (1ULL << 31) -1,
85 };
86
87 enum {
88         SD_BUS_NAME_REPLACE_EXISTING  = 1ULL << 0,
89         SD_BUS_NAME_ALLOW_REPLACEMENT = 1ULL << 1,
90         SD_BUS_NAME_QUEUE             = 1ULL << 2,
91 };
92
93 /* Callbacks */
94
95 typedef int (*sd_bus_message_handler_t)(sd_bus *bus, sd_bus_message *m, void *userdata, sd_bus_error *ret_error);
96 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);
97 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);
98 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);
99 typedef int (*sd_bus_node_enumerator_t) (sd_bus *bus, const char *path, void *userdata, char ***ret_nodes, sd_bus_error *ret_error);
100 typedef int (*sd_bus_track_handler_t) (sd_bus_track *track, void *userdata);
101
102 #include "sd-bus-protocol.h"
103 #include "sd-bus-vtable.h"
104
105 /* Connections */
106
107 int sd_bus_default(sd_bus **ret);
108 int sd_bus_default_user(sd_bus **ret);
109 int sd_bus_default_system(sd_bus **ret);
110
111 int sd_bus_open(sd_bus **ret);
112 int sd_bus_open_user(sd_bus **ret);
113 int sd_bus_open_system(sd_bus **ret);
114 int sd_bus_open_system_remote(sd_bus **ret, const char *host);
115 int sd_bus_open_system_container(sd_bus **ret, const char *machine);
116
117 int sd_bus_new(sd_bus **ret);
118 int sd_bus_set_address(sd_bus *bus, const char *address);
119 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
120 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
121 int sd_bus_set_bus_client(sd_bus *bus, int b);
122 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t owner_id);
123 int sd_bus_set_anonymous(sd_bus *bus, int b);
124 int sd_bus_set_trusted(sd_bus *bus, int b);
125 int sd_bus_set_description(sd_bus *bus, const char *description);
126 int sd_bus_set_monitor(sd_bus *bus, int b);
127 int sd_bus_negotiate_fds(sd_bus *bus, int b);
128 int sd_bus_negotiate_timestamp(sd_bus *bus, int b);
129 int sd_bus_negotiate_creds(sd_bus *bus, uint64_t creds_mask);
130 int sd_bus_start(sd_bus *ret);
131
132 int sd_bus_try_close(sd_bus *bus);
133 void sd_bus_close(sd_bus *bus);
134
135 sd_bus *sd_bus_ref(sd_bus *bus);
136 sd_bus *sd_bus_unref(sd_bus *bus);
137
138 int sd_bus_is_open(sd_bus *bus);
139 int sd_bus_can_send(sd_bus *bus, char type);
140 int sd_bus_get_owner_id(sd_bus *bus, sd_id128_t *id);
141 int sd_bus_get_owner_creds(sd_bus *bus, uint64_t creds_mask, sd_bus_creds **ret);
142 int sd_bus_get_description(sd_bus *bus, const char **description);
143 int sd_bus_get_tid(sd_bus *bus, pid_t *tid);
144
145 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *cookie);
146 int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *cookie);
147 int sd_bus_call(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *ret_error, sd_bus_message **reply);
148 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);
149
150 int sd_bus_get_fd(sd_bus *bus);
151 int sd_bus_get_events(sd_bus *bus);
152 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
153 int sd_bus_process(sd_bus *bus, sd_bus_message **r);
154 int sd_bus_process_priority(sd_bus *bus, int64_t max_priority, sd_bus_message **r);
155 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
156 int sd_bus_flush(sd_bus *bus);
157
158 sd_bus_slot* sd_bus_get_current_slot(sd_bus *bus);
159 sd_bus_message* sd_bus_get_current_message(sd_bus *bus);
160 sd_bus_message_handler_t sd_bus_get_current_handler(sd_bus *bus);
161 void* sd_bus_get_current_userdata(sd_bus *bus);
162
163 int sd_bus_attach_event(sd_bus *bus, sd_event *e, int priority);
164 int sd_bus_detach_event(sd_bus *bus);
165 sd_event *sd_bus_get_event(sd_bus *bus);
166
167 int sd_bus_add_filter(sd_bus *bus, sd_bus_slot **slot, sd_bus_message_handler_t callback, void *userdata);
168 int sd_bus_add_match(sd_bus *bus, sd_bus_slot **slot, const char *match, sd_bus_message_handler_t callback, void *userdata);
169 int sd_bus_add_object(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_message_handler_t callback, void *userdata);
170 int sd_bus_add_fallback(sd_bus *bus, sd_bus_slot **slot, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
171 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);
172 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);
173 int sd_bus_add_node_enumerator(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
174 int sd_bus_add_object_manager(sd_bus *bus, sd_bus_slot **slot, const char *path);
175
176 /* Slot object */
177
178 sd_bus_slot* sd_bus_slot_ref(sd_bus_slot *slot);
179 sd_bus_slot* sd_bus_slot_unref(sd_bus_slot *slot);
180
181 sd_bus* sd_bus_slot_get_bus(sd_bus_slot *slot);
182 void *sd_bus_slot_get_userdata(sd_bus_slot *slot);
183 void *sd_bus_slot_set_userdata(sd_bus_slot *slot, void *userdata);
184 int sd_bus_slot_set_description(sd_bus_slot *slot, const char *description);
185 int sd_bus_slot_get_description(sd_bus_slot *slot, char **description);
186
187 sd_bus_message* sd_bus_slot_get_current_message(sd_bus_slot *slot);
188 sd_bus_message_handler_t sd_bus_slot_get_current_handler(sd_bus_slot *bus);
189 void *sd_bus_slot_get_current_userdata(sd_bus_slot *slot);
190
191 /* Message object */
192
193 int sd_bus_message_new_signal(sd_bus *bus, sd_bus_message **m, const char *path, const char *interface, const char *member);
194 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);
195 int sd_bus_message_new_method_return(sd_bus_message *call, sd_bus_message **m);
196 int sd_bus_message_new_method_error(sd_bus_message *call, sd_bus_message **m, const sd_bus_error *e);
197 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);
198 int sd_bus_message_new_method_errno(sd_bus_message *call, sd_bus_message **m, int error, const sd_bus_error *e);
199 int sd_bus_message_new_method_errnof(sd_bus_message *call, sd_bus_message **m, int error, const char *format, ...) _sd_printf_(4, 5);
200
201 sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
202 sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
203
204 int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
205 int sd_bus_message_get_cookie(sd_bus_message *m, uint64_t *cookie);
206 int sd_bus_message_get_reply_cookie(sd_bus_message *m, uint64_t *cookie);
207 int sd_bus_message_get_priority(sd_bus_message *m, int64_t *priority);
208
209 int sd_bus_message_get_expect_reply(sd_bus_message *m);
210 int sd_bus_message_get_auto_start(sd_bus_message *m);
211 int sd_bus_message_get_allow_interactive_authorization(sd_bus_message *m);
212
213 const char *sd_bus_message_get_signature(sd_bus_message *m, int complete);
214 const char *sd_bus_message_get_path(sd_bus_message *m);
215 const char *sd_bus_message_get_interface(sd_bus_message *m);
216 const char *sd_bus_message_get_member(sd_bus_message *m);
217 const char *sd_bus_message_get_destination(sd_bus_message *m);
218 const char *sd_bus_message_get_sender(sd_bus_message *m);
219 const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
220 int sd_bus_message_get_errno(sd_bus_message *m);
221
222 int sd_bus_message_get_monotonic_usec(sd_bus_message *m, uint64_t *usec);
223 int sd_bus_message_get_realtime_usec(sd_bus_message *m, uint64_t *usec);
224 int sd_bus_message_get_seqnum(sd_bus_message *m, uint64_t* seqnum);
225
226 sd_bus* sd_bus_message_get_bus(sd_bus_message *m);
227 sd_bus_creds *sd_bus_message_get_creds(sd_bus_message *m); /* do not unref the result */
228
229 int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
230 int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
231 int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
232 int sd_bus_message_is_empty(sd_bus_message *m);
233
234 int sd_bus_message_set_expect_reply(sd_bus_message *m, int b);
235 int sd_bus_message_set_auto_start(sd_bus_message *m, int b);
236 int sd_bus_message_set_allow_interactive_authorization(sd_bus_message *m, int b);
237
238 int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
239 int sd_bus_message_set_priority(sd_bus_message *m, int64_t priority);
240
241 int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
242 int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
243 int sd_bus_message_append_array(sd_bus_message *m, char type, const void *ptr, size_t size);
244 int sd_bus_message_append_array_space(sd_bus_message *m, char type, size_t size, void **ptr);
245 int sd_bus_message_append_array_iovec(sd_bus_message *m, char type, const struct iovec *iov, unsigned n);
246 int sd_bus_message_append_array_memfd(sd_bus_message *m, char type, int memfd);
247 int sd_bus_message_append_string_space(sd_bus_message *m, size_t size, char **s);
248 int sd_bus_message_append_string_iovec(sd_bus_message *m, const struct iovec *iov, unsigned n);
249 int sd_bus_message_append_string_memfd(sd_bus_message *m, int memfd);
250 int sd_bus_message_append_strv(sd_bus_message *m, char **l);
251 int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
252 int sd_bus_message_close_container(sd_bus_message *m);
253 int sd_bus_message_copy(sd_bus_message *m, sd_bus_message *source, int all);
254
255 int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
256 int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
257 int sd_bus_message_read_array(sd_bus_message *m, char type, const void **ptr, size_t *size);
258 int sd_bus_message_read_strv(sd_bus_message *m, char ***l); /* free the result! */
259 int sd_bus_message_skip(sd_bus_message *m, const char *types);
260 int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
261 int sd_bus_message_exit_container(sd_bus_message *m);
262 int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
263 int sd_bus_message_verify_type(sd_bus_message *m, char type, const char *contents);
264 int sd_bus_message_at_end(sd_bus_message *m, int complete);
265 int sd_bus_message_rewind(sd_bus_message *m, int complete);
266
267 /* Bus management */
268
269 int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
270 int sd_bus_request_name(sd_bus *bus, const char *name, uint64_t flags);
271 int sd_bus_release_name(sd_bus *bus, const char *name);
272 int sd_bus_list_names(sd_bus *bus, char ***acquired, char ***activatable); /* free the results */
273 int sd_bus_get_name_creds(sd_bus *bus, const char *name, uint64_t mask, sd_bus_creds **creds); /* unref the result! */
274 int sd_bus_get_name_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
275
276 /* Convenience calls */
277
278 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, ...);
279 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);
280 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);
281 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! */
282 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! */
283 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 *ret_type, ...);
284
285 int sd_bus_reply_method_return(sd_bus_message *call, const char *types, ...);
286 int sd_bus_reply_method_error(sd_bus_message *call, const sd_bus_error *e);
287 int sd_bus_reply_method_errorf(sd_bus_message *call, const char *name, const char *format, ...) _sd_printf_(3, 4);
288 int sd_bus_reply_method_errno(sd_bus_message *call, int error, const sd_bus_error *e);
289 int sd_bus_reply_method_errnof(sd_bus_message *call, int error, const char *format, ...) _sd_printf_(3, 4);
290
291 int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
292
293 int sd_bus_emit_properties_changed_strv(sd_bus *bus, const char *path, const char *interface, char **names);
294 int sd_bus_emit_properties_changed(sd_bus *bus, const char *path, const char *interface, const char *name, ...) _sd_sentinel_;
295
296 int sd_bus_emit_interfaces_added_strv(sd_bus *bus, const char *path, char **interfaces);
297 int sd_bus_emit_interfaces_added(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
298 int sd_bus_emit_interfaces_removed_strv(sd_bus *bus, const char *path, char **interfaces);
299 int sd_bus_emit_interfaces_removed(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
300
301 int sd_bus_query_sender_creds(sd_bus_message *call, uint64_t mask, sd_bus_creds **creds);
302 int sd_bus_query_sender_privilege(sd_bus_message *call, int capability);
303
304 /* Credential handling */
305
306 int sd_bus_creds_new_from_pid(sd_bus_creds **ret, pid_t pid, uint64_t creds_mask);
307 sd_bus_creds *sd_bus_creds_ref(sd_bus_creds *c);
308 sd_bus_creds *sd_bus_creds_unref(sd_bus_creds *c);
309 uint64_t sd_bus_creds_get_mask(const sd_bus_creds *c);
310
311 int sd_bus_creds_get_pid(sd_bus_creds *c, pid_t *pid);
312 int sd_bus_creds_get_pid_starttime(sd_bus_creds *c, uint64_t *usec);
313 int sd_bus_creds_get_tid(sd_bus_creds *c, pid_t *tid);
314 int sd_bus_creds_get_uid(sd_bus_creds *c, uid_t *uid);
315 int sd_bus_creds_get_euid(sd_bus_creds *c, uid_t *euid);
316 int sd_bus_creds_get_suid(sd_bus_creds *c, uid_t *suid);
317 int sd_bus_creds_get_fsuid(sd_bus_creds *c, uid_t *fsuid);
318 int sd_bus_creds_get_gid(sd_bus_creds *c, gid_t *gid);
319 int sd_bus_creds_get_egid(sd_bus_creds *c, gid_t *egid);
320 int sd_bus_creds_get_sgid(sd_bus_creds *c, gid_t *sgid);
321 int sd_bus_creds_get_fsgid(sd_bus_creds *c, gid_t *fsgid);
322 int sd_bus_creds_get_comm(sd_bus_creds *c, const char **comm);
323 int sd_bus_creds_get_tid_comm(sd_bus_creds *c, const char **comm);
324 int sd_bus_creds_get_exe(sd_bus_creds *c, const char **exe);
325 int sd_bus_creds_get_cmdline(sd_bus_creds *c, char ***cmdline);
326 int sd_bus_creds_get_cgroup(sd_bus_creds *c, const char **cgroup);
327 int sd_bus_creds_get_unit(sd_bus_creds *c, const char **unit);
328 int sd_bus_creds_get_user_unit(sd_bus_creds *c, const char **unit);
329 int sd_bus_creds_get_slice(sd_bus_creds *c, const char **slice);
330 int sd_bus_creds_get_session(sd_bus_creds *c, const char **session);
331 int sd_bus_creds_get_owner_uid(sd_bus_creds *c, uid_t *uid);
332 int sd_bus_creds_has_effective_cap(sd_bus_creds *c, int capability);
333 int sd_bus_creds_has_permitted_cap(sd_bus_creds *c, int capability);
334 int sd_bus_creds_has_inheritable_cap(sd_bus_creds *c, int capability);
335 int sd_bus_creds_has_bounding_cap(sd_bus_creds *c, int capability);
336 int sd_bus_creds_get_selinux_context(sd_bus_creds *c, const char **context);
337 int sd_bus_creds_get_audit_session_id(sd_bus_creds *c, uint32_t *sessionid);
338 int sd_bus_creds_get_audit_login_uid(sd_bus_creds *c, uid_t *loginuid);
339 int sd_bus_creds_get_unique_name(sd_bus_creds *c, const char **name);
340 int sd_bus_creds_get_well_known_names(sd_bus_creds *c, char ***names);
341 int sd_bus_creds_get_description(sd_bus_creds *c, const char **name);
342
343 /* Error structures */
344
345 struct sd_bus_name_error_mapping {
346         const char* name;
347         int code;
348 };
349 typedef struct sd_bus_name_error_mapping sd_bus_name_error_mapping;
350
351 #define SD_BUS_ERROR_MAKE_CONST(name, message) ((const sd_bus_error) {(name), (message), 0})
352 #define SD_BUS_ERROR_NULL SD_BUS_ERROR_MAKE_CONST(NULL, NULL)
353
354 #ifndef SD_BUS_ERROR_MAPPING
355 #  define _SD_BUS_ERROR_XCONCAT(x, y) x ## y
356 #  define _SD_BUS_ERROR_CONCAT(x, y) _SD_BUS_ERROR_XCONCAT(x, y)
357 #  define SD_BUS_ERROR_MAPPING(name)                                    \
358         __attribute((__section__("sd_bus_errnomap")))                   \
359         __attribute((__used__))                                         \
360         const sd_bus_name_error_mapping _SD_BUS_ERROR_CONCAT(_sd_bus_errno_mapping_, name)[]
361 #  define SD_BUS_ERROR_MAPPING_USE(name)                                \
362         extern                                                          \
363         const sd_bus_name_error_mapping _SD_BUS_ERROR_CONCAT(_sd_bus_errno_mapping_, name)[]; \
364         __attribute((__used__))                                         \
365         static const sd_bus_name_error_mapping*                         \
366         _SD_BUS_ERROR_CONCAT(sd_bus_name_error_mapping_ref, __COUNTER__) \
367         = _SD_BUS_ERROR_CONCAT(_sd_bus_errno_mapping_, name);
368 #endif
369
370
371 void sd_bus_error_free(sd_bus_error *e);
372 int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message);
373 int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...)  _sd_printf_(3, 4);
374 int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
375 int sd_bus_error_set_errno(sd_bus_error *e, int error);
376 int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) _sd_printf_(3, 4);
377 int sd_bus_error_get_errno(const sd_bus_error *e);
378 int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
379 int sd_bus_error_is_set(const sd_bus_error *e);
380 int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
381
382 /* Auxiliary macros */
383
384 #define SD_BUS_MESSAGE_APPEND_ID128(x) 16,                              \
385                 (x).bytes[0],  (x).bytes[1],  (x).bytes[2],  (x).bytes[3], \
386                 (x).bytes[4],  (x).bytes[5],  (x).bytes[6],  (x).bytes[7], \
387                 (x).bytes[8],  (x).bytes[9],  (x).bytes[10], (x).bytes[11], \
388                 (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
389
390 #define SD_BUS_MESSAGE_READ_ID128(x) 16,                                \
391                 &(x).bytes[0],  &(x).bytes[1],  &(x).bytes[2],  &(x).bytes[3], \
392                 &(x).bytes[4],  &(x).bytes[5],  &(x).bytes[6],  &(x).bytes[7], \
393                 &(x).bytes[8],  &(x).bytes[9],  &(x).bytes[10], &(x).bytes[11], \
394                 &(x).bytes[12], &(x).bytes[13], &(x).bytes[14], &(x).bytes[15]
395
396 /* Label escaping */
397
398 int sd_bus_path_encode(const char *prefix, const char *external_id, char **ret_path);
399 int sd_bus_path_decode(const char *path, const char *prefix, char **ret_external_id);
400
401 /* Tracking peers */
402
403 int sd_bus_track_new(sd_bus *bus, sd_bus_track **track, sd_bus_track_handler_t handler, void *userdata);
404 sd_bus_track* sd_bus_track_ref(sd_bus_track *track);
405 sd_bus_track* sd_bus_track_unref(sd_bus_track *track);
406
407 sd_bus* sd_bus_track_get_bus(sd_bus_track *track);
408 void *sd_bus_track_get_userdata(sd_bus_track *track);
409 void *sd_bus_track_set_userdata(sd_bus_track *track, void *userdata);
410
411 int sd_bus_track_add_sender(sd_bus_track *track, sd_bus_message *m);
412 int sd_bus_track_remove_sender(sd_bus_track *track, sd_bus_message *m);
413 int sd_bus_track_add_name(sd_bus_track *track, const char *name);
414 int sd_bus_track_remove_name(sd_bus_track *track, const char *name);
415
416 unsigned sd_bus_track_count(sd_bus_track *track);
417 const char* sd_bus_track_contains(sd_bus_track *track, const char *names);
418 const char* sd_bus_track_first(sd_bus_track *track);
419 const char* sd_bus_track_next(sd_bus_track *track);
420
421 _SD_END_DECLARATIONS;
422
423 #endif