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