Line data Source code
1 : /* SPDX-License-Identifier: LGPL-2.1+ */
2 : #ifndef foosdbushfoo
3 : #define foosdbushfoo
4 :
5 : /***
6 : systemd is free software; you can redistribute it and/or modify it
7 : under the terms of the GNU Lesser General Public License as published by
8 : the Free Software Foundation; either version 2.1 of the License, or
9 : (at your option) any later version.
10 :
11 : systemd is distributed in the hope that it will be useful, but
12 : WITHOUT ANY WARRANTY; without even the implied warranty of
13 : MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 : Lesser General Public License for more details.
15 :
16 : You should have received a copy of the GNU Lesser General Public License
17 : along with systemd; If not, see <http://www.gnu.org/licenses/>.
18 : ***/
19 :
20 : #include <inttypes.h>
21 : #include <stdarg.h>
22 : #include <sys/types.h>
23 : #include <sys/uio.h>
24 :
25 : #include "sd-event.h"
26 : #include "sd-id128.h"
27 :
28 : #include "_sd-common.h"
29 :
30 : _SD_BEGIN_DECLARATIONS;
31 :
32 : #define SD_BUS_DEFAULT ((sd_bus *) 1)
33 : #define SD_BUS_DEFAULT_USER ((sd_bus *) 2)
34 : #define SD_BUS_DEFAULT_SYSTEM ((sd_bus *) 3)
35 :
36 : /* https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-marshaling-signature */
37 : #define SD_BUS_MAXIMUM_SIGNATURE_LENGTH 255
38 :
39 : /* https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names */
40 : #define SD_BUS_MAXIMUM_NAME_LENGTH 255
41 :
42 : /* Types */
43 :
44 : typedef struct sd_bus sd_bus;
45 : typedef struct sd_bus_message sd_bus_message;
46 : typedef struct sd_bus_slot sd_bus_slot;
47 : typedef struct sd_bus_creds sd_bus_creds;
48 : typedef struct sd_bus_track sd_bus_track;
49 :
50 : typedef struct {
51 : const char *name;
52 : const char *message;
53 : int _need_free;
54 : } sd_bus_error;
55 :
56 : typedef struct {
57 : const char* name;
58 : int code;
59 : } sd_bus_error_map;
60 :
61 : /* Flags */
62 :
63 : enum {
64 : SD_BUS_CREDS_PID = 1ULL << 0,
65 : SD_BUS_CREDS_TID = 1ULL << 1,
66 : SD_BUS_CREDS_PPID = 1ULL << 2,
67 : SD_BUS_CREDS_UID = 1ULL << 3,
68 : SD_BUS_CREDS_EUID = 1ULL << 4,
69 : SD_BUS_CREDS_SUID = 1ULL << 5,
70 : SD_BUS_CREDS_FSUID = 1ULL << 6,
71 : SD_BUS_CREDS_GID = 1ULL << 7,
72 : SD_BUS_CREDS_EGID = 1ULL << 8,
73 : SD_BUS_CREDS_SGID = 1ULL << 9,
74 : SD_BUS_CREDS_FSGID = 1ULL << 10,
75 : SD_BUS_CREDS_SUPPLEMENTARY_GIDS = 1ULL << 11,
76 : SD_BUS_CREDS_COMM = 1ULL << 12,
77 : SD_BUS_CREDS_TID_COMM = 1ULL << 13,
78 : SD_BUS_CREDS_EXE = 1ULL << 14,
79 : SD_BUS_CREDS_CMDLINE = 1ULL << 15,
80 : SD_BUS_CREDS_CGROUP = 1ULL << 16,
81 : SD_BUS_CREDS_UNIT = 1ULL << 17,
82 : SD_BUS_CREDS_SLICE = 1ULL << 18,
83 : SD_BUS_CREDS_USER_UNIT = 1ULL << 19,
84 : SD_BUS_CREDS_USER_SLICE = 1ULL << 20,
85 : SD_BUS_CREDS_SESSION = 1ULL << 21,
86 : SD_BUS_CREDS_OWNER_UID = 1ULL << 22,
87 : SD_BUS_CREDS_EFFECTIVE_CAPS = 1ULL << 23,
88 : SD_BUS_CREDS_PERMITTED_CAPS = 1ULL << 24,
89 : SD_BUS_CREDS_INHERITABLE_CAPS = 1ULL << 25,
90 : SD_BUS_CREDS_BOUNDING_CAPS = 1ULL << 26,
91 : SD_BUS_CREDS_SELINUX_CONTEXT = 1ULL << 27,
92 : SD_BUS_CREDS_AUDIT_SESSION_ID = 1ULL << 28,
93 : SD_BUS_CREDS_AUDIT_LOGIN_UID = 1ULL << 29,
94 : SD_BUS_CREDS_TTY = 1ULL << 30,
95 : SD_BUS_CREDS_UNIQUE_NAME = 1ULL << 31,
96 : SD_BUS_CREDS_WELL_KNOWN_NAMES = 1ULL << 32,
97 : SD_BUS_CREDS_DESCRIPTION = 1ULL << 33,
98 : SD_BUS_CREDS_AUGMENT = 1ULL << 63, /* special flag, if on sd-bus will augment creds struct, in a potentially race-full way. */
99 : _SD_BUS_CREDS_ALL = (1ULL << 34) -1
100 : };
101 :
102 : enum {
103 : SD_BUS_NAME_REPLACE_EXISTING = 1ULL << 0,
104 : SD_BUS_NAME_ALLOW_REPLACEMENT = 1ULL << 1,
105 : SD_BUS_NAME_QUEUE = 1ULL << 2
106 : };
107 :
108 : /* Callbacks */
109 :
110 : typedef int (*sd_bus_message_handler_t)(sd_bus_message *m, void *userdata, sd_bus_error *ret_error);
111 : 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);
112 : 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);
113 : 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);
114 : typedef int (*sd_bus_node_enumerator_t) (sd_bus *bus, const char *prefix, void *userdata, char ***ret_nodes, sd_bus_error *ret_error);
115 : typedef int (*sd_bus_track_handler_t) (sd_bus_track *track, void *userdata);
116 : typedef _sd_destroy_t sd_bus_destroy_t;
117 :
118 : #include "sd-bus-protocol.h"
119 : #include "sd-bus-vtable.h"
120 :
121 : /* Connections */
122 :
123 : int sd_bus_default(sd_bus **ret);
124 : int sd_bus_default_user(sd_bus **ret);
125 : int sd_bus_default_system(sd_bus **ret);
126 :
127 : int sd_bus_open(sd_bus **ret);
128 : int sd_bus_open_with_description(sd_bus **ret, const char *description);
129 : int sd_bus_open_user(sd_bus **ret);
130 : int sd_bus_open_user_with_description(sd_bus **ret, const char *description);
131 : int sd_bus_open_system(sd_bus **ret);
132 : int sd_bus_open_system_with_description(sd_bus **ret, const char *description);
133 : int sd_bus_open_system_remote(sd_bus **ret, const char *host);
134 : int sd_bus_open_system_machine(sd_bus **ret, const char *machine);
135 :
136 : int sd_bus_new(sd_bus **ret);
137 :
138 : int sd_bus_set_address(sd_bus *bus, const char *address);
139 : int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd);
140 : int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]);
141 : int sd_bus_get_address(sd_bus *bus, const char **address);
142 : int sd_bus_set_bus_client(sd_bus *bus, int b);
143 : int sd_bus_is_bus_client(sd_bus *bus);
144 : int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t bus_id);
145 : int sd_bus_is_server(sd_bus *bus);
146 : int sd_bus_set_anonymous(sd_bus *bus, int b);
147 : int sd_bus_is_anonymous(sd_bus *bus);
148 : int sd_bus_set_trusted(sd_bus *bus, int b);
149 : int sd_bus_is_trusted(sd_bus *bus);
150 : int sd_bus_set_monitor(sd_bus *bus, int b);
151 : int sd_bus_is_monitor(sd_bus *bus);
152 : int sd_bus_set_description(sd_bus *bus, const char *description);
153 : int sd_bus_get_description(sd_bus *bus, const char **description);
154 : int sd_bus_negotiate_creds(sd_bus *bus, int b, uint64_t creds_mask);
155 : int sd_bus_negotiate_timestamp(sd_bus *bus, int b);
156 : int sd_bus_negotiate_fds(sd_bus *bus, int b);
157 : int sd_bus_can_send(sd_bus *bus, char type);
158 : int sd_bus_get_creds_mask(sd_bus *bus, uint64_t *creds_mask);
159 : int sd_bus_set_allow_interactive_authorization(sd_bus *bus, int b);
160 : int sd_bus_get_allow_interactive_authorization(sd_bus *bus);
161 : int sd_bus_set_exit_on_disconnect(sd_bus *bus, int b);
162 : int sd_bus_get_exit_on_disconnect(sd_bus *bus);
163 : int sd_bus_set_close_on_exit(sd_bus *bus, int b);
164 : int sd_bus_get_close_on_exit(sd_bus *bus);
165 : int sd_bus_set_watch_bind(sd_bus *bus, int b);
166 : int sd_bus_get_watch_bind(sd_bus *bus);
167 : int sd_bus_set_connected_signal(sd_bus *bus, int b);
168 : int sd_bus_get_connected_signal(sd_bus *bus);
169 : int sd_bus_set_sender(sd_bus *bus, const char *sender);
170 : int sd_bus_get_sender(sd_bus *bus, const char **ret);
171 :
172 : int sd_bus_start(sd_bus *bus);
173 :
174 : int sd_bus_try_close(sd_bus *bus);
175 : void sd_bus_close(sd_bus *bus);
176 :
177 : sd_bus *sd_bus_ref(sd_bus *bus);
178 : sd_bus *sd_bus_unref(sd_bus *bus);
179 : sd_bus *sd_bus_close_unref(sd_bus *bus);
180 : sd_bus *sd_bus_flush_close_unref(sd_bus *bus);
181 :
182 : void sd_bus_default_flush_close(void);
183 :
184 : int sd_bus_is_open(sd_bus *bus);
185 : int sd_bus_is_ready(sd_bus *bus);
186 :
187 : int sd_bus_get_bus_id(sd_bus *bus, sd_id128_t *id);
188 : int sd_bus_get_scope(sd_bus *bus, const char **scope);
189 : int sd_bus_get_tid(sd_bus *bus, pid_t *tid);
190 : int sd_bus_get_owner_creds(sd_bus *bus, uint64_t creds_mask, sd_bus_creds **ret);
191 :
192 : int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *cookie);
193 : int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *cookie);
194 : int sd_bus_call(sd_bus *bus, sd_bus_message *m, uint64_t usec, sd_bus_error *ret_error, sd_bus_message **reply);
195 : 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);
196 :
197 : int sd_bus_get_fd(sd_bus *bus);
198 : int sd_bus_get_events(sd_bus *bus);
199 : int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec);
200 : int sd_bus_process(sd_bus *bus, sd_bus_message **r);
201 : int sd_bus_process_priority(sd_bus *bus, int64_t max_priority, sd_bus_message **r);
202 : int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec);
203 : int sd_bus_flush(sd_bus *bus);
204 :
205 : sd_bus_slot* sd_bus_get_current_slot(sd_bus *bus);
206 : sd_bus_message* sd_bus_get_current_message(sd_bus *bus);
207 : sd_bus_message_handler_t sd_bus_get_current_handler(sd_bus *bus);
208 : void* sd_bus_get_current_userdata(sd_bus *bus);
209 :
210 : int sd_bus_attach_event(sd_bus *bus, sd_event *e, int priority);
211 : int sd_bus_detach_event(sd_bus *bus);
212 : sd_event *sd_bus_get_event(sd_bus *bus);
213 :
214 : int sd_bus_get_n_queued_read(sd_bus *bus, uint64_t *ret);
215 : int sd_bus_get_n_queued_write(sd_bus *bus, uint64_t *ret);
216 :
217 : int sd_bus_set_method_call_timeout(sd_bus *bus, uint64_t usec);
218 : int sd_bus_get_method_call_timeout(sd_bus *bus, uint64_t *ret);
219 :
220 : int sd_bus_add_filter(sd_bus *bus, sd_bus_slot **slot, sd_bus_message_handler_t callback, void *userdata);
221 : int sd_bus_add_match(sd_bus *bus, sd_bus_slot **slot, const char *match, sd_bus_message_handler_t callback, void *userdata);
222 : int sd_bus_add_match_async(sd_bus *bus, sd_bus_slot **slot, const char *match, sd_bus_message_handler_t callback, sd_bus_message_handler_t install_callback, void *userdata);
223 : int sd_bus_add_object(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_message_handler_t callback, void *userdata);
224 : int sd_bus_add_fallback(sd_bus *bus, sd_bus_slot **slot, const char *prefix, sd_bus_message_handler_t callback, void *userdata);
225 : 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);
226 : 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);
227 : int sd_bus_add_node_enumerator(sd_bus *bus, sd_bus_slot **slot, const char *path, sd_bus_node_enumerator_t callback, void *userdata);
228 : int sd_bus_add_object_manager(sd_bus *bus, sd_bus_slot **slot, const char *path);
229 :
230 : /* Slot object */
231 :
232 : sd_bus_slot* sd_bus_slot_ref(sd_bus_slot *slot);
233 : sd_bus_slot* sd_bus_slot_unref(sd_bus_slot *slot);
234 :
235 : sd_bus* sd_bus_slot_get_bus(sd_bus_slot *slot);
236 : void *sd_bus_slot_get_userdata(sd_bus_slot *slot);
237 : void *sd_bus_slot_set_userdata(sd_bus_slot *slot, void *userdata);
238 : int sd_bus_slot_set_description(sd_bus_slot *slot, const char *description);
239 : int sd_bus_slot_get_description(sd_bus_slot *slot, const char **description);
240 : int sd_bus_slot_get_floating(sd_bus_slot *slot);
241 : int sd_bus_slot_set_floating(sd_bus_slot *slot, int b);
242 : int sd_bus_slot_set_destroy_callback(sd_bus_slot *s, sd_bus_destroy_t callback);
243 : int sd_bus_slot_get_destroy_callback(sd_bus_slot *s, sd_bus_destroy_t *callback);
244 :
245 : sd_bus_message* sd_bus_slot_get_current_message(sd_bus_slot *slot);
246 : sd_bus_message_handler_t sd_bus_slot_get_current_handler(sd_bus_slot *slot);
247 : void *sd_bus_slot_get_current_userdata(sd_bus_slot *slot);
248 :
249 : /* Message object */
250 :
251 : int sd_bus_message_new(sd_bus *bus, sd_bus_message **m, uint8_t type);
252 : int sd_bus_message_new_signal(sd_bus *bus, sd_bus_message **m, const char *path, const char *interface, const char *member);
253 : 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);
254 : int sd_bus_message_new_method_return(sd_bus_message *call, sd_bus_message **m);
255 : int sd_bus_message_new_method_error(sd_bus_message *call, sd_bus_message **m, const sd_bus_error *e);
256 : 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);
257 : int sd_bus_message_new_method_errno(sd_bus_message *call, sd_bus_message **m, int error, const sd_bus_error *e);
258 : int sd_bus_message_new_method_errnof(sd_bus_message *call, sd_bus_message **m, int error, const char *format, ...) _sd_printf_(4, 5);
259 :
260 : sd_bus_message* sd_bus_message_ref(sd_bus_message *m);
261 : sd_bus_message* sd_bus_message_unref(sd_bus_message *m);
262 :
263 : int sd_bus_message_seal(sd_bus_message *m, uint64_t cookie, uint64_t timeout_usec);
264 :
265 : int sd_bus_message_get_type(sd_bus_message *m, uint8_t *type);
266 : int sd_bus_message_get_cookie(sd_bus_message *m, uint64_t *cookie);
267 : int sd_bus_message_get_reply_cookie(sd_bus_message *m, uint64_t *cookie);
268 : int sd_bus_message_get_priority(sd_bus_message *m, int64_t *priority);
269 :
270 : int sd_bus_message_get_expect_reply(sd_bus_message *m);
271 : int sd_bus_message_get_auto_start(sd_bus_message *m);
272 : int sd_bus_message_get_allow_interactive_authorization(sd_bus_message *m);
273 :
274 : const char *sd_bus_message_get_signature(sd_bus_message *m, int complete);
275 : const char *sd_bus_message_get_path(sd_bus_message *m);
276 : const char *sd_bus_message_get_interface(sd_bus_message *m);
277 : const char *sd_bus_message_get_member(sd_bus_message *m);
278 : const char *sd_bus_message_get_destination(sd_bus_message *m);
279 : const char *sd_bus_message_get_sender(sd_bus_message *m);
280 : const sd_bus_error *sd_bus_message_get_error(sd_bus_message *m);
281 : int sd_bus_message_get_errno(sd_bus_message *m);
282 :
283 : int sd_bus_message_get_monotonic_usec(sd_bus_message *m, uint64_t *usec);
284 : int sd_bus_message_get_realtime_usec(sd_bus_message *m, uint64_t *usec);
285 : int sd_bus_message_get_seqnum(sd_bus_message *m, uint64_t* seqnum);
286 :
287 : sd_bus* sd_bus_message_get_bus(sd_bus_message *m);
288 : sd_bus_creds *sd_bus_message_get_creds(sd_bus_message *m); /* do not unref the result */
289 :
290 : int sd_bus_message_is_signal(sd_bus_message *m, const char *interface, const char *member);
291 : int sd_bus_message_is_method_call(sd_bus_message *m, const char *interface, const char *member);
292 : int sd_bus_message_is_method_error(sd_bus_message *m, const char *name);
293 : int sd_bus_message_is_empty(sd_bus_message *m);
294 : int sd_bus_message_has_signature(sd_bus_message *m, const char *signature);
295 :
296 : int sd_bus_message_set_expect_reply(sd_bus_message *m, int b);
297 : int sd_bus_message_set_auto_start(sd_bus_message *m, int b);
298 : int sd_bus_message_set_allow_interactive_authorization(sd_bus_message *m, int b);
299 :
300 : int sd_bus_message_set_destination(sd_bus_message *m, const char *destination);
301 : int sd_bus_message_set_sender(sd_bus_message *m, const char *sender);
302 : int sd_bus_message_set_priority(sd_bus_message *m, int64_t priority);
303 :
304 : int sd_bus_message_append(sd_bus_message *m, const char *types, ...);
305 : int sd_bus_message_appendv(sd_bus_message *m, const char *types, va_list ap);
306 : int sd_bus_message_append_basic(sd_bus_message *m, char type, const void *p);
307 : int sd_bus_message_append_array(sd_bus_message *m, char type, const void *ptr, size_t size);
308 : int sd_bus_message_append_array_space(sd_bus_message *m, char type, size_t size, void **ptr);
309 : int sd_bus_message_append_array_iovec(sd_bus_message *m, char type, const struct iovec *iov, unsigned n);
310 : int sd_bus_message_append_array_memfd(sd_bus_message *m, char type, int memfd, uint64_t offset, uint64_t size);
311 : int sd_bus_message_append_string_space(sd_bus_message *m, size_t size, char **s);
312 : int sd_bus_message_append_string_iovec(sd_bus_message *m, const struct iovec *iov, unsigned n);
313 : int sd_bus_message_append_string_memfd(sd_bus_message *m, int memfd, uint64_t offset, uint64_t size);
314 : int sd_bus_message_append_strv(sd_bus_message *m, char **l);
315 : int sd_bus_message_open_container(sd_bus_message *m, char type, const char *contents);
316 : int sd_bus_message_close_container(sd_bus_message *m);
317 : int sd_bus_message_copy(sd_bus_message *m, sd_bus_message *source, int all);
318 :
319 : int sd_bus_message_read(sd_bus_message *m, const char *types, ...);
320 : int sd_bus_message_readv(sd_bus_message *m, const char *types, va_list ap);
321 : int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);
322 : int sd_bus_message_read_array(sd_bus_message *m, char type, const void **ptr, size_t *size);
323 : int sd_bus_message_read_strv(sd_bus_message *m, char ***l); /* free the result! */
324 : int sd_bus_message_skip(sd_bus_message *m, const char *types);
325 : int sd_bus_message_enter_container(sd_bus_message *m, char type, const char *contents);
326 : int sd_bus_message_exit_container(sd_bus_message *m);
327 : int sd_bus_message_peek_type(sd_bus_message *m, char *type, const char **contents);
328 : int sd_bus_message_verify_type(sd_bus_message *m, char type, const char *contents);
329 : int sd_bus_message_at_end(sd_bus_message *m, int complete);
330 : int sd_bus_message_rewind(sd_bus_message *m, int complete);
331 :
332 : /* Bus management */
333 :
334 : int sd_bus_get_unique_name(sd_bus *bus, const char **unique);
335 : int sd_bus_request_name(sd_bus *bus, const char *name, uint64_t flags);
336 : int sd_bus_request_name_async(sd_bus *bus, sd_bus_slot **ret_slot, const char *name, uint64_t flags, sd_bus_message_handler_t callback, void *userdata);
337 : int sd_bus_release_name(sd_bus *bus, const char *name);
338 : int sd_bus_release_name_async(sd_bus *bus, sd_bus_slot **ret_slot, const char *name, sd_bus_message_handler_t callback, void *userdata);
339 : int sd_bus_list_names(sd_bus *bus, char ***acquired, char ***activatable); /* free the results */
340 : int sd_bus_get_name_creds(sd_bus *bus, const char *name, uint64_t mask, sd_bus_creds **creds); /* unref the result! */
341 : int sd_bus_get_name_machine_id(sd_bus *bus, const char *name, sd_id128_t *machine);
342 :
343 : /* Convenience calls */
344 :
345 : 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, ...);
346 : 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, ...);
347 : 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);
348 : 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);
349 : 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! */
350 : 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! */
351 : 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, ...);
352 :
353 : int sd_bus_reply_method_return(sd_bus_message *call, const char *types, ...);
354 : int sd_bus_reply_method_error(sd_bus_message *call, const sd_bus_error *e);
355 : int sd_bus_reply_method_errorf(sd_bus_message *call, const char *name, const char *format, ...) _sd_printf_(3, 4);
356 : int sd_bus_reply_method_errno(sd_bus_message *call, int error, const sd_bus_error *e);
357 : int sd_bus_reply_method_errnof(sd_bus_message *call, int error, const char *format, ...) _sd_printf_(3, 4);
358 :
359 : int sd_bus_emit_signal(sd_bus *bus, const char *path, const char *interface, const char *member, const char *types, ...);
360 :
361 : int sd_bus_emit_properties_changed_strv(sd_bus *bus, const char *path, const char *interface, char **names);
362 : int sd_bus_emit_properties_changed(sd_bus *bus, const char *path, const char *interface, const char *name, ...) _sd_sentinel_;
363 :
364 : int sd_bus_emit_object_added(sd_bus *bus, const char *path);
365 : int sd_bus_emit_object_removed(sd_bus *bus, const char *path);
366 : int sd_bus_emit_interfaces_added_strv(sd_bus *bus, const char *path, char **interfaces);
367 : int sd_bus_emit_interfaces_added(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
368 : int sd_bus_emit_interfaces_removed_strv(sd_bus *bus, const char *path, char **interfaces);
369 : int sd_bus_emit_interfaces_removed(sd_bus *bus, const char *path, const char *interface, ...) _sd_sentinel_;
370 :
371 : int sd_bus_query_sender_creds(sd_bus_message *call, uint64_t mask, sd_bus_creds **creds);
372 : int sd_bus_query_sender_privilege(sd_bus_message *call, int capability);
373 :
374 : int sd_bus_match_signal(sd_bus *bus, sd_bus_slot **ret, const char *sender, const char *path, const char *interface, const char *member, sd_bus_message_handler_t callback, void *userdata);
375 : int sd_bus_match_signal_async(sd_bus *bus, sd_bus_slot **ret, const char *sender, const char *path, const char *interface, const char *member, sd_bus_message_handler_t match_callback, sd_bus_message_handler_t add_callback, void *userdata);
376 :
377 : /* Credential handling */
378 :
379 : int sd_bus_creds_new_from_pid(sd_bus_creds **ret, pid_t pid, uint64_t creds_mask);
380 : sd_bus_creds *sd_bus_creds_ref(sd_bus_creds *c);
381 : sd_bus_creds *sd_bus_creds_unref(sd_bus_creds *c);
382 : uint64_t sd_bus_creds_get_mask(const sd_bus_creds *c);
383 : uint64_t sd_bus_creds_get_augmented_mask(const sd_bus_creds *c);
384 :
385 : int sd_bus_creds_get_pid(sd_bus_creds *c, pid_t *pid);
386 : int sd_bus_creds_get_ppid(sd_bus_creds *c, pid_t *ppid);
387 : int sd_bus_creds_get_tid(sd_bus_creds *c, pid_t *tid);
388 : int sd_bus_creds_get_uid(sd_bus_creds *c, uid_t *uid);
389 : int sd_bus_creds_get_euid(sd_bus_creds *c, uid_t *euid);
390 : int sd_bus_creds_get_suid(sd_bus_creds *c, uid_t *suid);
391 : int sd_bus_creds_get_fsuid(sd_bus_creds *c, uid_t *fsuid);
392 : int sd_bus_creds_get_gid(sd_bus_creds *c, gid_t *gid);
393 : int sd_bus_creds_get_egid(sd_bus_creds *c, gid_t *egid);
394 : int sd_bus_creds_get_sgid(sd_bus_creds *c, gid_t *sgid);
395 : int sd_bus_creds_get_fsgid(sd_bus_creds *c, gid_t *fsgid);
396 : int sd_bus_creds_get_supplementary_gids(sd_bus_creds *c, const gid_t **gids);
397 : int sd_bus_creds_get_comm(sd_bus_creds *c, const char **comm);
398 : int sd_bus_creds_get_tid_comm(sd_bus_creds *c, const char **comm);
399 : int sd_bus_creds_get_exe(sd_bus_creds *c, const char **exe);
400 : int sd_bus_creds_get_cmdline(sd_bus_creds *c, char ***cmdline);
401 : int sd_bus_creds_get_cgroup(sd_bus_creds *c, const char **cgroup);
402 : int sd_bus_creds_get_unit(sd_bus_creds *c, const char **unit);
403 : int sd_bus_creds_get_slice(sd_bus_creds *c, const char **slice);
404 : int sd_bus_creds_get_user_unit(sd_bus_creds *c, const char **unit);
405 : int sd_bus_creds_get_user_slice(sd_bus_creds *c, const char **slice);
406 : int sd_bus_creds_get_session(sd_bus_creds *c, const char **session);
407 : int sd_bus_creds_get_owner_uid(sd_bus_creds *c, uid_t *uid);
408 : int sd_bus_creds_has_effective_cap(sd_bus_creds *c, int capability);
409 : int sd_bus_creds_has_permitted_cap(sd_bus_creds *c, int capability);
410 : int sd_bus_creds_has_inheritable_cap(sd_bus_creds *c, int capability);
411 : int sd_bus_creds_has_bounding_cap(sd_bus_creds *c, int capability);
412 : int sd_bus_creds_get_selinux_context(sd_bus_creds *c, const char **context);
413 : int sd_bus_creds_get_audit_session_id(sd_bus_creds *c, uint32_t *sessionid);
414 : int sd_bus_creds_get_audit_login_uid(sd_bus_creds *c, uid_t *loginuid);
415 : int sd_bus_creds_get_tty(sd_bus_creds *c, const char **tty);
416 : int sd_bus_creds_get_unique_name(sd_bus_creds *c, const char **name);
417 : int sd_bus_creds_get_well_known_names(sd_bus_creds *c, char ***names);
418 : int sd_bus_creds_get_description(sd_bus_creds *c, const char **name);
419 :
420 : /* Error structures */
421 :
422 : #define SD_BUS_ERROR_MAKE_CONST(name, message) ((const sd_bus_error) {(name), (message), 0})
423 : #define SD_BUS_ERROR_NULL SD_BUS_ERROR_MAKE_CONST(NULL, NULL)
424 :
425 : void sd_bus_error_free(sd_bus_error *e);
426 : int sd_bus_error_set(sd_bus_error *e, const char *name, const char *message);
427 : int sd_bus_error_setf(sd_bus_error *e, const char *name, const char *format, ...) _sd_printf_(3, 4);
428 : int sd_bus_error_set_const(sd_bus_error *e, const char *name, const char *message);
429 : int sd_bus_error_set_errno(sd_bus_error *e, int error);
430 : int sd_bus_error_set_errnof(sd_bus_error *e, int error, const char *format, ...) _sd_printf_(3, 4);
431 : int sd_bus_error_set_errnofv(sd_bus_error *e, int error, const char *format, va_list ap) _sd_printf_(3,0);
432 : int sd_bus_error_get_errno(const sd_bus_error *e);
433 : int sd_bus_error_copy(sd_bus_error *dest, const sd_bus_error *e);
434 : int sd_bus_error_move(sd_bus_error *dest, sd_bus_error *e);
435 : int sd_bus_error_is_set(const sd_bus_error *e);
436 : int sd_bus_error_has_name(const sd_bus_error *e, const char *name);
437 :
438 : #define SD_BUS_ERROR_MAP(_name, _code) \
439 : { \
440 : .name = _name, \
441 : .code = _code, \
442 : }
443 : #define SD_BUS_ERROR_MAP_END \
444 : { \
445 : .name = NULL, \
446 : .code = - 'x', \
447 : }
448 :
449 : int sd_bus_error_add_map(const sd_bus_error_map *map);
450 :
451 : /* Auxiliary macros */
452 :
453 : #define SD_BUS_MESSAGE_APPEND_ID128(x) 16, \
454 : (x).bytes[0], (x).bytes[1], (x).bytes[2], (x).bytes[3], \
455 : (x).bytes[4], (x).bytes[5], (x).bytes[6], (x).bytes[7], \
456 : (x).bytes[8], (x).bytes[9], (x).bytes[10], (x).bytes[11], \
457 : (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
458 :
459 : #define SD_BUS_MESSAGE_READ_ID128(x) 16, \
460 : &(x).bytes[0], &(x).bytes[1], &(x).bytes[2], &(x).bytes[3], \
461 : &(x).bytes[4], &(x).bytes[5], &(x).bytes[6], &(x).bytes[7], \
462 : &(x).bytes[8], &(x).bytes[9], &(x).bytes[10], &(x).bytes[11], \
463 : &(x).bytes[12], &(x).bytes[13], &(x).bytes[14], &(x).bytes[15]
464 :
465 : /* Label escaping */
466 :
467 : int sd_bus_path_encode(const char *prefix, const char *external_id, char **ret_path);
468 : int sd_bus_path_encode_many(char **out, const char *path_template, ...);
469 : int sd_bus_path_decode(const char *path, const char *prefix, char **ret_external_id);
470 : int sd_bus_path_decode_many(const char *path, const char *path_template, ...);
471 :
472 : /* Tracking peers */
473 :
474 : int sd_bus_track_new(sd_bus *bus, sd_bus_track **track, sd_bus_track_handler_t handler, void *userdata);
475 : sd_bus_track* sd_bus_track_ref(sd_bus_track *track);
476 : sd_bus_track* sd_bus_track_unref(sd_bus_track *track);
477 :
478 : sd_bus* sd_bus_track_get_bus(sd_bus_track *track);
479 : void *sd_bus_track_get_userdata(sd_bus_track *track);
480 : void *sd_bus_track_set_userdata(sd_bus_track *track, void *userdata);
481 :
482 : int sd_bus_track_add_sender(sd_bus_track *track, sd_bus_message *m);
483 : int sd_bus_track_remove_sender(sd_bus_track *track, sd_bus_message *m);
484 : int sd_bus_track_add_name(sd_bus_track *track, const char *name);
485 : int sd_bus_track_remove_name(sd_bus_track *track, const char *name);
486 :
487 : int sd_bus_track_set_recursive(sd_bus_track *track, int b);
488 : int sd_bus_track_get_recursive(sd_bus_track *track);
489 :
490 : unsigned sd_bus_track_count(sd_bus_track *track);
491 : int sd_bus_track_count_sender(sd_bus_track *track, sd_bus_message *m);
492 : int sd_bus_track_count_name(sd_bus_track *track, const char *name);
493 :
494 : const char* sd_bus_track_contains(sd_bus_track *track, const char *name);
495 : const char* sd_bus_track_first(sd_bus_track *track);
496 : const char* sd_bus_track_next(sd_bus_track *track);
497 :
498 : int sd_bus_track_set_destroy_callback(sd_bus_track *s, sd_bus_destroy_t callback);
499 : int sd_bus_track_get_destroy_callback(sd_bus_track *s, sd_bus_destroy_t *ret);
500 :
501 : /* Define helpers so that __attribute__((cleanup(sd_bus_unrefp))) and similar may be used. */
502 300 : _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_unref);
503 14 : _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_close_unref);
504 56 : _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus, sd_bus_flush_close_unref);
505 46 : _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_slot, sd_bus_slot_unref);
506 1467 : _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_message, sd_bus_message_unref);
507 29 : _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_creds, sd_bus_creds_unref);
508 2 : _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_bus_track, sd_bus_track_unref);
509 :
510 : _SD_END_DECLARATIONS;
511 :
512 : #endif
|
