]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/libsystemd/sd-bus/sd-bus.c
Merge pull request #16603 from benzea/benzea/special-app-slice
[thirdparty/systemd.git] / src / libsystemd / sd-bus / sd-bus.c
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include <endian.h>
4 #include <netdb.h>
5 #include <poll.h>
6 #include <pthread.h>
7 #include <signal.h>
8 #include <stdlib.h>
9 #include <sys/mman.h>
10 #include <sys/stat.h>
11 #include <sys/wait.h>
12 #include <unistd.h>
13
14 #include "sd-bus.h"
15
16 #include "alloc-util.h"
17 #include "bus-container.h"
18 #include "bus-control.h"
19 #include "bus-internal.h"
20 #include "bus-kernel.h"
21 #include "bus-label.h"
22 #include "bus-message.h"
23 #include "bus-objects.h"
24 #include "bus-protocol.h"
25 #include "bus-slot.h"
26 #include "bus-socket.h"
27 #include "bus-track.h"
28 #include "bus-type.h"
29 #include "bus-util.h"
30 #include "cgroup-util.h"
31 #include "def.h"
32 #include "errno-util.h"
33 #include "fd-util.h"
34 #include "hexdecoct.h"
35 #include "hostname-util.h"
36 #include "macro.h"
37 #include "memory-util.h"
38 #include "missing_syscall.h"
39 #include "parse-util.h"
40 #include "path-util.h"
41 #include "process-util.h"
42 #include "string-util.h"
43 #include "strv.h"
44
45 #define log_debug_bus_message(m) \
46 do { \
47 sd_bus_message *_mm = (m); \
48 log_debug("Got message type=%s sender=%s destination=%s path=%s interface=%s member=%s cookie=%" PRIu64 " reply_cookie=%" PRIu64 " signature=%s error-name=%s error-message=%s", \
49 bus_message_type_to_string(_mm->header->type), \
50 strna(sd_bus_message_get_sender(_mm)), \
51 strna(sd_bus_message_get_destination(_mm)), \
52 strna(sd_bus_message_get_path(_mm)), \
53 strna(sd_bus_message_get_interface(_mm)), \
54 strna(sd_bus_message_get_member(_mm)), \
55 BUS_MESSAGE_COOKIE(_mm), \
56 _mm->reply_cookie, \
57 strna(_mm->root_container.signature), \
58 strna(_mm->error.name), \
59 strna(_mm->error.message)); \
60 } while (false)
61
62 static int bus_poll(sd_bus *bus, bool need_more, uint64_t timeout_usec);
63 static void bus_detach_io_events(sd_bus *b);
64 static void bus_detach_inotify_event(sd_bus *b);
65
66 static thread_local sd_bus *default_system_bus = NULL;
67 static thread_local sd_bus *default_user_bus = NULL;
68 static thread_local sd_bus *default_starter_bus = NULL;
69
70 static sd_bus **bus_choose_default(int (**bus_open)(sd_bus **)) {
71 const char *e;
72
73 /* Let's try our best to reuse another cached connection. If
74 * the starter bus type is set, connect via our normal
75 * connection logic, ignoring $DBUS_STARTER_ADDRESS, so that
76 * we can share the connection with the user/system default
77 * bus. */
78
79 e = secure_getenv("DBUS_STARTER_BUS_TYPE");
80 if (e) {
81 if (streq(e, "system")) {
82 if (bus_open)
83 *bus_open = sd_bus_open_system;
84 return &default_system_bus;
85 } else if (STR_IN_SET(e, "user", "session")) {
86 if (bus_open)
87 *bus_open = sd_bus_open_user;
88 return &default_user_bus;
89 }
90 }
91
92 /* No type is specified, so we have not other option than to
93 * use the starter address if it is set. */
94 e = secure_getenv("DBUS_STARTER_ADDRESS");
95 if (e) {
96 if (bus_open)
97 *bus_open = sd_bus_open;
98 return &default_starter_bus;
99 }
100
101 /* Finally, if nothing is set use the cached connection for
102 * the right scope */
103
104 if (cg_pid_get_owner_uid(0, NULL) >= 0) {
105 if (bus_open)
106 *bus_open = sd_bus_open_user;
107 return &default_user_bus;
108 } else {
109 if (bus_open)
110 *bus_open = sd_bus_open_system;
111 return &default_system_bus;
112 }
113 }
114
115 sd_bus *bus_resolve(sd_bus *bus) {
116 switch ((uintptr_t) bus) {
117 case (uintptr_t) SD_BUS_DEFAULT:
118 return *(bus_choose_default(NULL));
119 case (uintptr_t) SD_BUS_DEFAULT_USER:
120 return default_user_bus;
121 case (uintptr_t) SD_BUS_DEFAULT_SYSTEM:
122 return default_system_bus;
123 default:
124 return bus;
125 }
126 }
127
128 void bus_close_io_fds(sd_bus *b) {
129 assert(b);
130
131 bus_detach_io_events(b);
132
133 if (b->input_fd != b->output_fd)
134 safe_close(b->output_fd);
135 b->output_fd = b->input_fd = safe_close(b->input_fd);
136 }
137
138 void bus_close_inotify_fd(sd_bus *b) {
139 assert(b);
140
141 bus_detach_inotify_event(b);
142
143 b->inotify_fd = safe_close(b->inotify_fd);
144 b->inotify_watches = mfree(b->inotify_watches);
145 b->n_inotify_watches = 0;
146 }
147
148 static void bus_reset_queues(sd_bus *b) {
149 assert(b);
150
151 while (b->rqueue_size > 0)
152 bus_message_unref_queued(b->rqueue[--b->rqueue_size], b);
153
154 b->rqueue = mfree(b->rqueue);
155 b->rqueue_allocated = 0;
156
157 while (b->wqueue_size > 0)
158 bus_message_unref_queued(b->wqueue[--b->wqueue_size], b);
159
160 b->wqueue = mfree(b->wqueue);
161 b->wqueue_allocated = 0;
162 }
163
164 static sd_bus* bus_free(sd_bus *b) {
165 sd_bus_slot *s;
166
167 assert(b);
168 assert(!b->track_queue);
169 assert(!b->tracks);
170
171 b->state = BUS_CLOSED;
172
173 sd_bus_detach_event(b);
174
175 while ((s = b->slots)) {
176 /* At this point only floating slots can still be
177 * around, because the non-floating ones keep a
178 * reference to the bus, and we thus couldn't be
179 * destructing right now... We forcibly disconnect the
180 * slots here, so that they still can be referenced by
181 * apps, but are dead. */
182
183 assert(s->floating);
184 bus_slot_disconnect(s, true);
185 }
186
187 if (b->default_bus_ptr)
188 *b->default_bus_ptr = NULL;
189
190 bus_close_io_fds(b);
191 bus_close_inotify_fd(b);
192
193 free(b->label);
194 free(b->groups);
195 free(b->rbuffer);
196 free(b->unique_name);
197 free(b->auth_buffer);
198 free(b->address);
199 free(b->machine);
200 free(b->description);
201 free(b->patch_sender);
202
203 free(b->exec_path);
204 strv_free(b->exec_argv);
205
206 close_many(b->fds, b->n_fds);
207 free(b->fds);
208
209 bus_reset_queues(b);
210
211 ordered_hashmap_free_free(b->reply_callbacks);
212 prioq_free(b->reply_callbacks_prioq);
213
214 assert(b->match_callbacks.type == BUS_MATCH_ROOT);
215 bus_match_free(&b->match_callbacks);
216
217 hashmap_free_free(b->vtable_methods);
218 hashmap_free_free(b->vtable_properties);
219
220 assert(hashmap_isempty(b->nodes));
221 hashmap_free(b->nodes);
222
223 bus_flush_memfd(b);
224
225 assert_se(pthread_mutex_destroy(&b->memfd_cache_mutex) == 0);
226
227 return mfree(b);
228 }
229
230 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus*, bus_free);
231
232 _public_ int sd_bus_new(sd_bus **ret) {
233 _cleanup_free_ sd_bus *b = NULL;
234
235 assert_return(ret, -EINVAL);
236
237 b = new(sd_bus, 1);
238 if (!b)
239 return -ENOMEM;
240
241 *b = (sd_bus) {
242 .n_ref = 1,
243 .input_fd = -1,
244 .output_fd = -1,
245 .inotify_fd = -1,
246 .message_version = 1,
247 .creds_mask = SD_BUS_CREDS_WELL_KNOWN_NAMES|SD_BUS_CREDS_UNIQUE_NAME,
248 .accept_fd = true,
249 .original_pid = getpid_cached(),
250 .n_groups = (size_t) -1,
251 .close_on_exit = true,
252 };
253
254 /* We guarantee that wqueue always has space for at least one entry */
255 if (!GREEDY_REALLOC(b->wqueue, b->wqueue_allocated, 1))
256 return -ENOMEM;
257
258 assert_se(pthread_mutex_init(&b->memfd_cache_mutex, NULL) == 0);
259
260 *ret = TAKE_PTR(b);
261 return 0;
262 }
263
264 _public_ int sd_bus_set_address(sd_bus *bus, const char *address) {
265 assert_return(bus, -EINVAL);
266 assert_return(bus = bus_resolve(bus), -ENOPKG);
267 assert_return(bus->state == BUS_UNSET, -EPERM);
268 assert_return(address, -EINVAL);
269 assert_return(!bus_pid_changed(bus), -ECHILD);
270
271 return free_and_strdup(&bus->address, address);
272 }
273
274 _public_ int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd) {
275 assert_return(bus, -EINVAL);
276 assert_return(bus = bus_resolve(bus), -ENOPKG);
277 assert_return(bus->state == BUS_UNSET, -EPERM);
278 assert_return(input_fd >= 0, -EBADF);
279 assert_return(output_fd >= 0, -EBADF);
280 assert_return(!bus_pid_changed(bus), -ECHILD);
281
282 bus->input_fd = input_fd;
283 bus->output_fd = output_fd;
284 return 0;
285 }
286
287 _public_ int sd_bus_set_exec(sd_bus *bus, const char *path, char *const *argv) {
288 _cleanup_strv_free_ char **a = NULL;
289 int r;
290
291 assert_return(bus, -EINVAL);
292 assert_return(bus = bus_resolve(bus), -ENOPKG);
293 assert_return(bus->state == BUS_UNSET, -EPERM);
294 assert_return(path, -EINVAL);
295 assert_return(!strv_isempty(argv), -EINVAL);
296 assert_return(!bus_pid_changed(bus), -ECHILD);
297
298 a = strv_copy(argv);
299 if (!a)
300 return -ENOMEM;
301
302 r = free_and_strdup(&bus->exec_path, path);
303 if (r < 0)
304 return r;
305
306 return strv_free_and_replace(bus->exec_argv, a);
307 }
308
309 _public_ int sd_bus_set_bus_client(sd_bus *bus, int b) {
310 assert_return(bus, -EINVAL);
311 assert_return(bus = bus_resolve(bus), -ENOPKG);
312 assert_return(bus->state == BUS_UNSET, -EPERM);
313 assert_return(!bus->patch_sender, -EPERM);
314 assert_return(!bus_pid_changed(bus), -ECHILD);
315
316 bus->bus_client = !!b;
317 return 0;
318 }
319
320 _public_ int sd_bus_set_monitor(sd_bus *bus, int b) {
321 assert_return(bus, -EINVAL);
322 assert_return(bus = bus_resolve(bus), -ENOPKG);
323 assert_return(bus->state == BUS_UNSET, -EPERM);
324 assert_return(!bus_pid_changed(bus), -ECHILD);
325
326 bus->is_monitor = !!b;
327 return 0;
328 }
329
330 _public_ int sd_bus_negotiate_fds(sd_bus *bus, int b) {
331 assert_return(bus, -EINVAL);
332 assert_return(bus = bus_resolve(bus), -ENOPKG);
333 assert_return(bus->state == BUS_UNSET, -EPERM);
334 assert_return(!bus_pid_changed(bus), -ECHILD);
335
336 bus->accept_fd = !!b;
337 return 0;
338 }
339
340 _public_ int sd_bus_negotiate_timestamp(sd_bus *bus, int b) {
341 assert_return(bus, -EINVAL);
342 assert_return(bus = bus_resolve(bus), -ENOPKG);
343 assert_return(!IN_SET(bus->state, BUS_CLOSING, BUS_CLOSED), -EPERM);
344 assert_return(!bus_pid_changed(bus), -ECHILD);
345
346 /* This is not actually supported by any of our transports these days, but we do honour it for synthetic
347 * replies, and maybe one day classic D-Bus learns this too */
348 bus->attach_timestamp = !!b;
349
350 return 0;
351 }
352
353 _public_ int sd_bus_negotiate_creds(sd_bus *bus, int b, uint64_t mask) {
354 assert_return(bus, -EINVAL);
355 assert_return(bus = bus_resolve(bus), -ENOPKG);
356 assert_return(mask <= _SD_BUS_CREDS_ALL, -EINVAL);
357 assert_return(!IN_SET(bus->state, BUS_CLOSING, BUS_CLOSED), -EPERM);
358 assert_return(!bus_pid_changed(bus), -ECHILD);
359
360 SET_FLAG(bus->creds_mask, mask, b);
361
362 /* The well knowns we need unconditionally, so that matches can work */
363 bus->creds_mask |= SD_BUS_CREDS_WELL_KNOWN_NAMES|SD_BUS_CREDS_UNIQUE_NAME;
364
365 return 0;
366 }
367
368 _public_ int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t server_id) {
369 assert_return(bus, -EINVAL);
370 assert_return(bus = bus_resolve(bus), -ENOPKG);
371 assert_return(b || sd_id128_equal(server_id, SD_ID128_NULL), -EINVAL);
372 assert_return(bus->state == BUS_UNSET, -EPERM);
373 assert_return(!bus_pid_changed(bus), -ECHILD);
374
375 bus->is_server = !!b;
376 bus->server_id = server_id;
377 return 0;
378 }
379
380 _public_ int sd_bus_set_anonymous(sd_bus *bus, int b) {
381 assert_return(bus, -EINVAL);
382 assert_return(bus = bus_resolve(bus), -ENOPKG);
383 assert_return(bus->state == BUS_UNSET, -EPERM);
384 assert_return(!bus_pid_changed(bus), -ECHILD);
385
386 bus->anonymous_auth = !!b;
387 return 0;
388 }
389
390 _public_ int sd_bus_set_trusted(sd_bus *bus, int b) {
391 assert_return(bus, -EINVAL);
392 assert_return(bus = bus_resolve(bus), -ENOPKG);
393 assert_return(bus->state == BUS_UNSET, -EPERM);
394 assert_return(!bus_pid_changed(bus), -ECHILD);
395
396 bus->trusted = !!b;
397 return 0;
398 }
399
400 _public_ int sd_bus_set_description(sd_bus *bus, const char *description) {
401 assert_return(bus, -EINVAL);
402 assert_return(bus = bus_resolve(bus), -ENOPKG);
403 assert_return(bus->state == BUS_UNSET, -EPERM);
404 assert_return(!bus_pid_changed(bus), -ECHILD);
405
406 return free_and_strdup(&bus->description, description);
407 }
408
409 _public_ int sd_bus_set_allow_interactive_authorization(sd_bus *bus, int b) {
410 assert_return(bus, -EINVAL);
411 assert_return(bus = bus_resolve(bus), -ENOPKG);
412 assert_return(!bus_pid_changed(bus), -ECHILD);
413
414 bus->allow_interactive_authorization = !!b;
415 return 0;
416 }
417
418 _public_ int sd_bus_get_allow_interactive_authorization(sd_bus *bus) {
419 assert_return(bus, -EINVAL);
420 assert_return(bus = bus_resolve(bus), -ENOPKG);
421 assert_return(!bus_pid_changed(bus), -ECHILD);
422
423 return bus->allow_interactive_authorization;
424 }
425
426 _public_ int sd_bus_set_watch_bind(sd_bus *bus, int b) {
427 assert_return(bus, -EINVAL);
428 assert_return(bus = bus_resolve(bus), -ENOPKG);
429 assert_return(bus->state == BUS_UNSET, -EPERM);
430 assert_return(!bus_pid_changed(bus), -ECHILD);
431
432 bus->watch_bind = !!b;
433 return 0;
434 }
435
436 _public_ int sd_bus_get_watch_bind(sd_bus *bus) {
437 assert_return(bus, -EINVAL);
438 assert_return(bus = bus_resolve(bus), -ENOPKG);
439 assert_return(!bus_pid_changed(bus), -ECHILD);
440
441 return bus->watch_bind;
442 }
443
444 _public_ int sd_bus_set_connected_signal(sd_bus *bus, int b) {
445 assert_return(bus, -EINVAL);
446 assert_return(bus = bus_resolve(bus), -ENOPKG);
447 assert_return(bus->state == BUS_UNSET, -EPERM);
448 assert_return(!bus_pid_changed(bus), -ECHILD);
449
450 bus->connected_signal = !!b;
451 return 0;
452 }
453
454 _public_ int sd_bus_get_connected_signal(sd_bus *bus) {
455 assert_return(bus, -EINVAL);
456 assert_return(bus = bus_resolve(bus), -ENOPKG);
457 assert_return(!bus_pid_changed(bus), -ECHILD);
458
459 return bus->connected_signal;
460 }
461
462 static int synthesize_connected_signal(sd_bus *bus) {
463 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
464 int r;
465
466 assert(bus);
467
468 /* If enabled, synthesizes a local "Connected" signal mirroring the local "Disconnected" signal. This is called
469 * whenever we fully established a connection, i.e. after the authorization phase, and after receiving the
470 * Hello() reply. Or in other words, whenever we enter BUS_RUNNING state.
471 *
472 * This is useful so that clients can start doing stuff whenever the connection is fully established in a way
473 * that works independently from whether we connected to a full bus or just a direct connection. */
474
475 if (!bus->connected_signal)
476 return 0;
477
478 r = sd_bus_message_new_signal(
479 bus,
480 &m,
481 "/org/freedesktop/DBus/Local",
482 "org.freedesktop.DBus.Local",
483 "Connected");
484 if (r < 0)
485 return r;
486
487 bus_message_set_sender_local(bus, m);
488 m->read_counter = ++bus->read_counter;
489
490 r = bus_seal_synthetic_message(bus, m);
491 if (r < 0)
492 return r;
493
494 r = bus_rqueue_make_room(bus);
495 if (r < 0)
496 return r;
497
498 /* Insert at the very front */
499 memmove(bus->rqueue + 1, bus->rqueue, sizeof(sd_bus_message*) * bus->rqueue_size);
500 bus->rqueue[0] = bus_message_ref_queued(m, bus);
501 bus->rqueue_size++;
502
503 return 0;
504 }
505
506 void bus_set_state(sd_bus *bus, enum bus_state state) {
507 static const char * const table[_BUS_STATE_MAX] = {
508 [BUS_UNSET] = "UNSET",
509 [BUS_WATCH_BIND] = "WATCH_BIND",
510 [BUS_OPENING] = "OPENING",
511 [BUS_AUTHENTICATING] = "AUTHENTICATING",
512 [BUS_HELLO] = "HELLO",
513 [BUS_RUNNING] = "RUNNING",
514 [BUS_CLOSING] = "CLOSING",
515 [BUS_CLOSED] = "CLOSED",
516 };
517
518 assert(bus);
519 assert(state < _BUS_STATE_MAX);
520
521 if (state == bus->state)
522 return;
523
524 log_debug("Bus %s: changing state %s → %s", strna(bus->description), table[bus->state], table[state]);
525 bus->state = state;
526 }
527
528 static int hello_callback(sd_bus_message *reply, void *userdata, sd_bus_error *error) {
529 const char *s;
530 sd_bus *bus;
531 int r;
532
533 assert(reply);
534 bus = reply->bus;
535 assert(bus);
536 assert(IN_SET(bus->state, BUS_HELLO, BUS_CLOSING));
537
538 r = sd_bus_message_get_errno(reply);
539 if (r > 0) {
540 r = -r;
541 goto fail;
542 }
543
544 r = sd_bus_message_read(reply, "s", &s);
545 if (r < 0)
546 goto fail;
547
548 if (!service_name_is_valid(s) || s[0] != ':') {
549 r = -EBADMSG;
550 goto fail;
551 }
552
553 r = free_and_strdup(&bus->unique_name, s);
554 if (r < 0)
555 goto fail;
556
557 if (bus->state == BUS_HELLO) {
558 bus_set_state(bus, BUS_RUNNING);
559
560 r = synthesize_connected_signal(bus);
561 if (r < 0)
562 goto fail;
563 }
564
565 return 1;
566
567 fail:
568 /* When Hello() failed, let's propagate this in two ways: first we return the error immediately here,
569 * which is the propagated up towards the event loop. Let's also invalidate the connection, so that
570 * if the user then calls back into us again we won't wait any longer. */
571
572 bus_set_state(bus, BUS_CLOSING);
573 return r;
574 }
575
576 static int bus_send_hello(sd_bus *bus) {
577 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
578 int r;
579
580 assert(bus);
581
582 if (!bus->bus_client)
583 return 0;
584
585 r = sd_bus_message_new_method_call(
586 bus,
587 &m,
588 "org.freedesktop.DBus",
589 "/org/freedesktop/DBus",
590 "org.freedesktop.DBus",
591 "Hello");
592 if (r < 0)
593 return r;
594
595 return sd_bus_call_async(bus, NULL, m, hello_callback, NULL, 0);
596 }
597
598 int bus_start_running(sd_bus *bus) {
599 struct reply_callback *c;
600 usec_t n;
601 int r;
602
603 assert(bus);
604 assert(bus->state < BUS_HELLO);
605
606 /* We start all method call timeouts when we enter BUS_HELLO or BUS_RUNNING mode. At this point let's convert
607 * all relative to absolute timestamps. Note that we do not reshuffle the reply callback priority queue since
608 * adding a fixed value to all entries should not alter the internal order. */
609
610 n = now(CLOCK_MONOTONIC);
611 ORDERED_HASHMAP_FOREACH(c, bus->reply_callbacks) {
612 if (c->timeout_usec == 0)
613 continue;
614
615 c->timeout_usec = usec_add(n, c->timeout_usec);
616 }
617
618 if (bus->bus_client) {
619 bus_set_state(bus, BUS_HELLO);
620 return 1;
621 }
622
623 bus_set_state(bus, BUS_RUNNING);
624
625 r = synthesize_connected_signal(bus);
626 if (r < 0)
627 return r;
628
629 return 1;
630 }
631
632 static int parse_address_key(const char **p, const char *key, char **value) {
633 size_t l, n = 0, allocated = 0;
634 _cleanup_free_ char *r = NULL;
635 const char *a;
636
637 assert(p);
638 assert(*p);
639 assert(value);
640
641 if (key) {
642 l = strlen(key);
643 if (strncmp(*p, key, l) != 0)
644 return 0;
645
646 if ((*p)[l] != '=')
647 return 0;
648
649 if (*value)
650 return -EINVAL;
651
652 a = *p + l + 1;
653 } else
654 a = *p;
655
656 while (!IN_SET(*a, ';', ',', 0)) {
657 char c;
658
659 if (*a == '%') {
660 int x, y;
661
662 x = unhexchar(a[1]);
663 if (x < 0)
664 return x;
665
666 y = unhexchar(a[2]);
667 if (y < 0)
668 return y;
669
670 c = (char) ((x << 4) | y);
671 a += 3;
672 } else {
673 c = *a;
674 a++;
675 }
676
677 if (!GREEDY_REALLOC(r, allocated, n + 2))
678 return -ENOMEM;
679
680 r[n++] = c;
681 }
682
683 if (!r) {
684 r = strdup("");
685 if (!r)
686 return -ENOMEM;
687 } else
688 r[n] = 0;
689
690 if (*a == ',')
691 a++;
692
693 *p = a;
694
695 free_and_replace(*value, r);
696
697 return 1;
698 }
699
700 static void skip_address_key(const char **p) {
701 assert(p);
702 assert(*p);
703
704 *p += strcspn(*p, ",");
705
706 if (**p == ',')
707 (*p)++;
708 }
709
710 static int parse_unix_address(sd_bus *b, const char **p, char **guid) {
711 _cleanup_free_ char *path = NULL, *abstract = NULL;
712 size_t l;
713 int r;
714
715 assert(b);
716 assert(p);
717 assert(*p);
718 assert(guid);
719
720 while (!IN_SET(**p, 0, ';')) {
721 r = parse_address_key(p, "guid", guid);
722 if (r < 0)
723 return r;
724 else if (r > 0)
725 continue;
726
727 r = parse_address_key(p, "path", &path);
728 if (r < 0)
729 return r;
730 else if (r > 0)
731 continue;
732
733 r = parse_address_key(p, "abstract", &abstract);
734 if (r < 0)
735 return r;
736 else if (r > 0)
737 continue;
738
739 skip_address_key(p);
740 }
741
742 if (!path && !abstract)
743 return -EINVAL;
744
745 if (path && abstract)
746 return -EINVAL;
747
748 if (path) {
749 l = strlen(path);
750 if (l >= sizeof(b->sockaddr.un.sun_path)) /* We insist on NUL termination */
751 return -E2BIG;
752
753 b->sockaddr.un = (struct sockaddr_un) {
754 .sun_family = AF_UNIX,
755 };
756
757 memcpy(b->sockaddr.un.sun_path, path, l);
758 b->sockaddr_size = offsetof(struct sockaddr_un, sun_path) + l + 1;
759
760 } else {
761 assert(abstract);
762
763 l = strlen(abstract);
764 if (l >= sizeof(b->sockaddr.un.sun_path) - 1) /* We insist on NUL termination */
765 return -E2BIG;
766
767 b->sockaddr.un = (struct sockaddr_un) {
768 .sun_family = AF_UNIX,
769 };
770
771 memcpy(b->sockaddr.un.sun_path+1, abstract, l);
772 b->sockaddr_size = offsetof(struct sockaddr_un, sun_path) + 1 + l;
773 }
774
775 b->is_local = true;
776
777 return 0;
778 }
779
780 static int parse_tcp_address(sd_bus *b, const char **p, char **guid) {
781 _cleanup_free_ char *host = NULL, *port = NULL, *family = NULL;
782 int r;
783 struct addrinfo *result, hints = {
784 .ai_socktype = SOCK_STREAM,
785 };
786
787 assert(b);
788 assert(p);
789 assert(*p);
790 assert(guid);
791
792 while (!IN_SET(**p, 0, ';')) {
793 r = parse_address_key(p, "guid", guid);
794 if (r < 0)
795 return r;
796 else if (r > 0)
797 continue;
798
799 r = parse_address_key(p, "host", &host);
800 if (r < 0)
801 return r;
802 else if (r > 0)
803 continue;
804
805 r = parse_address_key(p, "port", &port);
806 if (r < 0)
807 return r;
808 else if (r > 0)
809 continue;
810
811 r = parse_address_key(p, "family", &family);
812 if (r < 0)
813 return r;
814 else if (r > 0)
815 continue;
816
817 skip_address_key(p);
818 }
819
820 if (!host || !port)
821 return -EINVAL;
822
823 if (family) {
824 if (streq(family, "ipv4"))
825 hints.ai_family = AF_INET;
826 else if (streq(family, "ipv6"))
827 hints.ai_family = AF_INET6;
828 else
829 return -EINVAL;
830 }
831
832 r = getaddrinfo(host, port, &hints, &result);
833 if (r == EAI_SYSTEM)
834 return -errno;
835 else if (r != 0)
836 return -EADDRNOTAVAIL;
837
838 memcpy(&b->sockaddr, result->ai_addr, result->ai_addrlen);
839 b->sockaddr_size = result->ai_addrlen;
840
841 freeaddrinfo(result);
842
843 b->is_local = false;
844
845 return 0;
846 }
847
848 static int parse_exec_address(sd_bus *b, const char **p, char **guid) {
849 char *path = NULL;
850 unsigned n_argv = 0, j;
851 char **argv = NULL;
852 size_t allocated = 0;
853 int r;
854
855 assert(b);
856 assert(p);
857 assert(*p);
858 assert(guid);
859
860 while (!IN_SET(**p, 0, ';')) {
861 r = parse_address_key(p, "guid", guid);
862 if (r < 0)
863 goto fail;
864 else if (r > 0)
865 continue;
866
867 r = parse_address_key(p, "path", &path);
868 if (r < 0)
869 goto fail;
870 else if (r > 0)
871 continue;
872
873 if (startswith(*p, "argv")) {
874 unsigned ul;
875
876 errno = 0;
877 ul = strtoul(*p + 4, (char**) p, 10);
878 if (errno > 0 || **p != '=' || ul > 256) {
879 r = -EINVAL;
880 goto fail;
881 }
882
883 (*p)++;
884
885 if (ul >= n_argv) {
886 if (!GREEDY_REALLOC0(argv, allocated, ul + 2)) {
887 r = -ENOMEM;
888 goto fail;
889 }
890
891 n_argv = ul + 1;
892 }
893
894 r = parse_address_key(p, NULL, argv + ul);
895 if (r < 0)
896 goto fail;
897
898 continue;
899 }
900
901 skip_address_key(p);
902 }
903
904 if (!path) {
905 r = -EINVAL;
906 goto fail;
907 }
908
909 /* Make sure there are no holes in the array, with the
910 * exception of argv[0] */
911 for (j = 1; j < n_argv; j++)
912 if (!argv[j]) {
913 r = -EINVAL;
914 goto fail;
915 }
916
917 if (argv && argv[0] == NULL) {
918 argv[0] = strdup(path);
919 if (!argv[0]) {
920 r = -ENOMEM;
921 goto fail;
922 }
923 }
924
925 b->exec_path = path;
926 b->exec_argv = argv;
927
928 b->is_local = false;
929
930 return 0;
931
932 fail:
933 for (j = 0; j < n_argv; j++)
934 free(argv[j]);
935
936 free(argv);
937 free(path);
938 return r;
939 }
940
941 static int parse_container_unix_address(sd_bus *b, const char **p, char **guid) {
942 _cleanup_free_ char *machine = NULL, *pid = NULL;
943 int r;
944
945 assert(b);
946 assert(p);
947 assert(*p);
948 assert(guid);
949
950 while (!IN_SET(**p, 0, ';')) {
951 r = parse_address_key(p, "guid", guid);
952 if (r < 0)
953 return r;
954 else if (r > 0)
955 continue;
956
957 r = parse_address_key(p, "machine", &machine);
958 if (r < 0)
959 return r;
960 else if (r > 0)
961 continue;
962
963 r = parse_address_key(p, "pid", &pid);
964 if (r < 0)
965 return r;
966 else if (r > 0)
967 continue;
968
969 skip_address_key(p);
970 }
971
972 if (!machine == !pid)
973 return -EINVAL;
974
975 if (machine) {
976 if (!streq(machine, ".host") && !machine_name_is_valid(machine))
977 return -EINVAL;
978
979 free_and_replace(b->machine, machine);
980 } else
981 b->machine = mfree(b->machine);
982
983 if (pid) {
984 r = parse_pid(pid, &b->nspid);
985 if (r < 0)
986 return r;
987 } else
988 b->nspid = 0;
989
990 b->sockaddr.un = (struct sockaddr_un) {
991 .sun_family = AF_UNIX,
992 /* Note that we use the old /var/run prefix here, to increase compatibility with really old containers */
993 .sun_path = "/var/run/dbus/system_bus_socket",
994 };
995 b->sockaddr_size = SOCKADDR_UN_LEN(b->sockaddr.un);
996 b->is_local = false;
997
998 return 0;
999 }
1000
1001 static void bus_reset_parsed_address(sd_bus *b) {
1002 assert(b);
1003
1004 zero(b->sockaddr);
1005 b->sockaddr_size = 0;
1006 b->exec_argv = strv_free(b->exec_argv);
1007 b->exec_path = mfree(b->exec_path);
1008 b->server_id = SD_ID128_NULL;
1009 b->machine = mfree(b->machine);
1010 b->nspid = 0;
1011 }
1012
1013 static int bus_parse_next_address(sd_bus *b) {
1014 _cleanup_free_ char *guid = NULL;
1015 const char *a;
1016 int r;
1017
1018 assert(b);
1019
1020 if (!b->address)
1021 return 0;
1022 if (b->address[b->address_index] == 0)
1023 return 0;
1024
1025 bus_reset_parsed_address(b);
1026
1027 a = b->address + b->address_index;
1028
1029 while (*a != 0) {
1030
1031 if (*a == ';') {
1032 a++;
1033 continue;
1034 }
1035
1036 if (startswith(a, "unix:")) {
1037 a += 5;
1038
1039 r = parse_unix_address(b, &a, &guid);
1040 if (r < 0)
1041 return r;
1042 break;
1043
1044 } else if (startswith(a, "tcp:")) {
1045
1046 a += 4;
1047 r = parse_tcp_address(b, &a, &guid);
1048 if (r < 0)
1049 return r;
1050
1051 break;
1052
1053 } else if (startswith(a, "unixexec:")) {
1054
1055 a += 9;
1056 r = parse_exec_address(b, &a, &guid);
1057 if (r < 0)
1058 return r;
1059
1060 break;
1061
1062 } else if (startswith(a, "x-machine-unix:")) {
1063
1064 a += 15;
1065 r = parse_container_unix_address(b, &a, &guid);
1066 if (r < 0)
1067 return r;
1068
1069 break;
1070 }
1071
1072 a = strchr(a, ';');
1073 if (!a)
1074 return 0;
1075 }
1076
1077 if (guid) {
1078 r = sd_id128_from_string(guid, &b->server_id);
1079 if (r < 0)
1080 return r;
1081 }
1082
1083 b->address_index = a - b->address;
1084 return 1;
1085 }
1086
1087 static void bus_kill_exec(sd_bus *bus) {
1088 if (pid_is_valid(bus->busexec_pid) > 0) {
1089 sigterm_wait(bus->busexec_pid);
1090 bus->busexec_pid = 0;
1091 }
1092 }
1093
1094 static int bus_start_address(sd_bus *b) {
1095 int r;
1096
1097 assert(b);
1098
1099 for (;;) {
1100 bus_close_io_fds(b);
1101 bus_close_inotify_fd(b);
1102
1103 bus_kill_exec(b);
1104
1105 /* If you provide multiple different bus-addresses, we
1106 * try all of them in order and use the first one that
1107 * succeeds. */
1108
1109 if (b->exec_path)
1110 r = bus_socket_exec(b);
1111 else if ((b->nspid > 0 || b->machine) && b->sockaddr.sa.sa_family != AF_UNSPEC)
1112 r = bus_container_connect_socket(b);
1113 else if (b->sockaddr.sa.sa_family != AF_UNSPEC)
1114 r = bus_socket_connect(b);
1115 else
1116 goto next;
1117
1118 if (r >= 0) {
1119 int q;
1120
1121 q = bus_attach_io_events(b);
1122 if (q < 0)
1123 return q;
1124
1125 q = bus_attach_inotify_event(b);
1126 if (q < 0)
1127 return q;
1128
1129 return r;
1130 }
1131
1132 b->last_connect_error = -r;
1133
1134 next:
1135 r = bus_parse_next_address(b);
1136 if (r < 0)
1137 return r;
1138 if (r == 0)
1139 return b->last_connect_error > 0 ? -b->last_connect_error : -ECONNREFUSED;
1140 }
1141 }
1142
1143 int bus_next_address(sd_bus *b) {
1144 assert(b);
1145
1146 bus_reset_parsed_address(b);
1147 return bus_start_address(b);
1148 }
1149
1150 static int bus_start_fd(sd_bus *b) {
1151 struct stat st;
1152 int r;
1153
1154 assert(b);
1155 assert(b->input_fd >= 0);
1156 assert(b->output_fd >= 0);
1157
1158 if (DEBUG_LOGGING) {
1159 _cleanup_free_ char *pi = NULL, *po = NULL;
1160 (void) fd_get_path(b->input_fd, &pi);
1161 (void) fd_get_path(b->output_fd, &po);
1162 log_debug("sd-bus: starting bus%s%s on fds %d/%d (%s, %s)...",
1163 b->description ? " " : "", strempty(b->description),
1164 b->input_fd, b->output_fd,
1165 pi ?: "???", po ?: "???");
1166 }
1167
1168 r = fd_nonblock(b->input_fd, true);
1169 if (r < 0)
1170 return r;
1171
1172 r = fd_cloexec(b->input_fd, true);
1173 if (r < 0)
1174 return r;
1175
1176 if (b->input_fd != b->output_fd) {
1177 r = fd_nonblock(b->output_fd, true);
1178 if (r < 0)
1179 return r;
1180
1181 r = fd_cloexec(b->output_fd, true);
1182 if (r < 0)
1183 return r;
1184 }
1185
1186 if (fstat(b->input_fd, &st) < 0)
1187 return -errno;
1188
1189 return bus_socket_take_fd(b);
1190 }
1191
1192 _public_ int sd_bus_start(sd_bus *bus) {
1193 int r;
1194
1195 assert_return(bus, -EINVAL);
1196 assert_return(bus = bus_resolve(bus), -ENOPKG);
1197 assert_return(bus->state == BUS_UNSET, -EPERM);
1198 assert_return(!bus_pid_changed(bus), -ECHILD);
1199
1200 bus_set_state(bus, BUS_OPENING);
1201
1202 if (bus->is_server && bus->bus_client)
1203 return -EINVAL;
1204
1205 if (bus->input_fd >= 0)
1206 r = bus_start_fd(bus);
1207 else if (bus->address || bus->sockaddr.sa.sa_family != AF_UNSPEC || bus->exec_path || bus->machine)
1208 r = bus_start_address(bus);
1209 else
1210 return -EINVAL;
1211
1212 if (r < 0) {
1213 sd_bus_close(bus);
1214 return r;
1215 }
1216
1217 return bus_send_hello(bus);
1218 }
1219
1220 _public_ int sd_bus_open_with_description(sd_bus **ret, const char *description) {
1221 const char *e;
1222 _cleanup_(bus_freep) sd_bus *b = NULL;
1223 int r;
1224
1225 assert_return(ret, -EINVAL);
1226
1227 /* Let's connect to the starter bus if it is set, and
1228 * otherwise to the bus that is appropriate for the scope
1229 * we are running in */
1230
1231 e = secure_getenv("DBUS_STARTER_BUS_TYPE");
1232 if (e) {
1233 if (streq(e, "system"))
1234 return sd_bus_open_system_with_description(ret, description);
1235 else if (STR_IN_SET(e, "session", "user"))
1236 return sd_bus_open_user_with_description(ret, description);
1237 }
1238
1239 e = secure_getenv("DBUS_STARTER_ADDRESS");
1240 if (!e) {
1241 if (cg_pid_get_owner_uid(0, NULL) >= 0)
1242 return sd_bus_open_user_with_description(ret, description);
1243 else
1244 return sd_bus_open_system_with_description(ret, description);
1245 }
1246
1247 r = sd_bus_new(&b);
1248 if (r < 0)
1249 return r;
1250
1251 r = sd_bus_set_address(b, e);
1252 if (r < 0)
1253 return r;
1254
1255 b->bus_client = true;
1256
1257 /* We don't know whether the bus is trusted or not, so better
1258 * be safe, and authenticate everything */
1259 b->trusted = false;
1260 b->is_local = false;
1261 b->creds_mask |= SD_BUS_CREDS_UID | SD_BUS_CREDS_EUID | SD_BUS_CREDS_EFFECTIVE_CAPS;
1262
1263 r = sd_bus_start(b);
1264 if (r < 0)
1265 return r;
1266
1267 *ret = TAKE_PTR(b);
1268 return 0;
1269 }
1270
1271 _public_ int sd_bus_open(sd_bus **ret) {
1272 return sd_bus_open_with_description(ret, NULL);
1273 }
1274
1275 int bus_set_address_system(sd_bus *b) {
1276 const char *e;
1277 int r;
1278
1279 assert(b);
1280
1281 e = secure_getenv("DBUS_SYSTEM_BUS_ADDRESS");
1282
1283 r = sd_bus_set_address(b, e ?: DEFAULT_SYSTEM_BUS_ADDRESS);
1284 if (r >= 0)
1285 b->is_system = true;
1286 return r;
1287 }
1288
1289 _public_ int sd_bus_open_system_with_description(sd_bus **ret, const char *description) {
1290 _cleanup_(bus_freep) sd_bus *b = NULL;
1291 int r;
1292
1293 assert_return(ret, -EINVAL);
1294
1295 r = sd_bus_new(&b);
1296 if (r < 0)
1297 return r;
1298
1299 if (description) {
1300 r = sd_bus_set_description(b, description);
1301 if (r < 0)
1302 return r;
1303 }
1304
1305 r = bus_set_address_system(b);
1306 if (r < 0)
1307 return r;
1308
1309 b->bus_client = true;
1310
1311 /* Let's do per-method access control on the system bus. We
1312 * need the caller's UID and capability set for that. */
1313 b->trusted = false;
1314 b->creds_mask |= SD_BUS_CREDS_UID | SD_BUS_CREDS_EUID | SD_BUS_CREDS_EFFECTIVE_CAPS;
1315 b->is_local = true;
1316
1317 r = sd_bus_start(b);
1318 if (r < 0)
1319 return r;
1320
1321 *ret = TAKE_PTR(b);
1322 return 0;
1323 }
1324
1325 _public_ int sd_bus_open_system(sd_bus **ret) {
1326 return sd_bus_open_system_with_description(ret, NULL);
1327 }
1328
1329 int bus_set_address_user(sd_bus *b) {
1330 const char *a;
1331 _cleanup_free_ char *_a = NULL;
1332 int r;
1333
1334 assert(b);
1335
1336 a = secure_getenv("DBUS_SESSION_BUS_ADDRESS");
1337 if (!a) {
1338 const char *e;
1339 _cleanup_free_ char *ee = NULL;
1340
1341 e = secure_getenv("XDG_RUNTIME_DIR");
1342 if (!e)
1343 return log_debug_errno(SYNTHETIC_ERRNO(ENOMEDIUM),
1344 "sd-bus: $XDG_RUNTIME_DIR not set, cannot connect to user bus.");
1345
1346 ee = bus_address_escape(e);
1347 if (!ee)
1348 return -ENOMEM;
1349
1350 if (asprintf(&_a, DEFAULT_USER_BUS_ADDRESS_FMT, ee) < 0)
1351 return -ENOMEM;
1352 a = _a;
1353 }
1354
1355 r = sd_bus_set_address(b, a);
1356 if (r >= 0)
1357 b->is_user = true;
1358 return r;
1359 }
1360
1361 _public_ int sd_bus_open_user_with_description(sd_bus **ret, const char *description) {
1362 _cleanup_(bus_freep) sd_bus *b = NULL;
1363 int r;
1364
1365 assert_return(ret, -EINVAL);
1366
1367 r = sd_bus_new(&b);
1368 if (r < 0)
1369 return r;
1370
1371 if (description) {
1372 r = sd_bus_set_description(b, description);
1373 if (r < 0)
1374 return r;
1375 }
1376
1377 r = bus_set_address_user(b);
1378 if (r < 0)
1379 return r;
1380
1381 b->bus_client = true;
1382
1383 /* We don't do any per-method access control on the user bus. */
1384 b->trusted = true;
1385 b->is_local = true;
1386
1387 r = sd_bus_start(b);
1388 if (r < 0)
1389 return r;
1390
1391 *ret = TAKE_PTR(b);
1392 return 0;
1393 }
1394
1395 _public_ int sd_bus_open_user(sd_bus **ret) {
1396 return sd_bus_open_user_with_description(ret, NULL);
1397 }
1398
1399 int bus_set_address_system_remote(sd_bus *b, const char *host) {
1400 _cleanup_free_ char *e = NULL;
1401 char *m = NULL, *c = NULL, *a, *rbracket = NULL, *p = NULL;
1402
1403 assert(b);
1404 assert(host);
1405
1406 /* Skip ":"s in ipv6 addresses */
1407 if (*host == '[') {
1408 char *t;
1409
1410 rbracket = strchr(host, ']');
1411 if (!rbracket)
1412 return -EINVAL;
1413 t = strndupa(host + 1, rbracket - host - 1);
1414 e = bus_address_escape(t);
1415 if (!e)
1416 return -ENOMEM;
1417 } else if ((a = strchr(host, '@'))) {
1418 if (*(a + 1) == '[') {
1419 _cleanup_free_ char *t = NULL;
1420
1421 rbracket = strchr(a + 1, ']');
1422 if (!rbracket)
1423 return -EINVAL;
1424 t = new0(char, strlen(host));
1425 if (!t)
1426 return -ENOMEM;
1427 strncat(t, host, a - host + 1);
1428 strncat(t, a + 2, rbracket - a - 2);
1429 e = bus_address_escape(t);
1430 if (!e)
1431 return -ENOMEM;
1432 } else if (*(a + 1) == '\0' || strchr(a + 1, '@'))
1433 return -EINVAL;
1434 }
1435
1436 /* Let's see if a port was given */
1437 m = strchr(rbracket ? rbracket + 1 : host, ':');
1438 if (m) {
1439 char *t;
1440 bool got_forward_slash = false;
1441
1442 p = m + 1;
1443
1444 t = strchr(p, '/');
1445 if (t) {
1446 p = strndupa(p, t - p);
1447 got_forward_slash = true;
1448 }
1449
1450 if (!in_charset(p, "0123456789") || *p == '\0') {
1451 if (!machine_name_is_valid(p) || got_forward_slash)
1452 return -EINVAL;
1453
1454 m = TAKE_PTR(p);
1455 goto interpret_port_as_machine_old_syntax;
1456 }
1457 }
1458
1459 /* Let's see if a machine was given */
1460 m = strchr(rbracket ? rbracket + 1 : host, '/');
1461 if (m) {
1462 m++;
1463 interpret_port_as_machine_old_syntax:
1464 /* Let's make sure this is not a port of some kind,
1465 * and is a valid machine name. */
1466 if (!in_charset(m, "0123456789") && machine_name_is_valid(m))
1467 c = strjoina(",argv", p ? "7" : "5", "=--machine=", m);
1468 }
1469
1470 if (!e) {
1471 char *t;
1472
1473 t = strndupa(host, strcspn(host, ":/"));
1474
1475 e = bus_address_escape(t);
1476 if (!e)
1477 return -ENOMEM;
1478 }
1479
1480 a = strjoin("unixexec:path=ssh,argv1=-xT", p ? ",argv2=-p,argv3=" : "", strempty(p),
1481 ",argv", p ? "4" : "2", "=--,argv", p ? "5" : "3", "=", e,
1482 ",argv", p ? "6" : "4", "=systemd-stdio-bridge", c);
1483 if (!a)
1484 return -ENOMEM;
1485
1486 return free_and_replace(b->address, a);
1487 }
1488
1489 _public_ int sd_bus_open_system_remote(sd_bus **ret, const char *host) {
1490 _cleanup_(bus_freep) sd_bus *b = NULL;
1491 int r;
1492
1493 assert_return(host, -EINVAL);
1494 assert_return(ret, -EINVAL);
1495
1496 r = sd_bus_new(&b);
1497 if (r < 0)
1498 return r;
1499
1500 r = bus_set_address_system_remote(b, host);
1501 if (r < 0)
1502 return r;
1503
1504 b->bus_client = true;
1505 b->trusted = false;
1506 b->is_system = true;
1507 b->is_local = false;
1508
1509 r = sd_bus_start(b);
1510 if (r < 0)
1511 return r;
1512
1513 *ret = TAKE_PTR(b);
1514 return 0;
1515 }
1516
1517 int bus_set_address_system_machine(sd_bus *b, const char *machine) {
1518 _cleanup_free_ char *e = NULL;
1519 char *a;
1520
1521 assert(b);
1522 assert(machine);
1523
1524 e = bus_address_escape(machine);
1525 if (!e)
1526 return -ENOMEM;
1527
1528 a = strjoin("x-machine-unix:machine=", e);
1529 if (!a)
1530 return -ENOMEM;
1531
1532 return free_and_replace(b->address, a);
1533 }
1534
1535 _public_ int sd_bus_open_system_machine(sd_bus **ret, const char *machine) {
1536 _cleanup_(bus_freep) sd_bus *b = NULL;
1537 int r;
1538
1539 assert_return(machine, -EINVAL);
1540 assert_return(ret, -EINVAL);
1541 assert_return(streq(machine, ".host") || machine_name_is_valid(machine), -EINVAL);
1542
1543 r = sd_bus_new(&b);
1544 if (r < 0)
1545 return r;
1546
1547 r = bus_set_address_system_machine(b, machine);
1548 if (r < 0)
1549 return r;
1550
1551 b->bus_client = true;
1552 b->trusted = false;
1553 b->is_system = true;
1554 b->is_local = false;
1555
1556 r = sd_bus_start(b);
1557 if (r < 0)
1558 return r;
1559
1560 *ret = TAKE_PTR(b);
1561 return 0;
1562 }
1563
1564 _public_ void sd_bus_close(sd_bus *bus) {
1565 if (!bus)
1566 return;
1567 if (bus->state == BUS_CLOSED)
1568 return;
1569 if (bus_pid_changed(bus))
1570 return;
1571
1572 /* Don't leave ssh hanging around */
1573 bus_kill_exec(bus);
1574
1575 bus_set_state(bus, BUS_CLOSED);
1576
1577 sd_bus_detach_event(bus);
1578
1579 /* Drop all queued messages so that they drop references to
1580 * the bus object and the bus may be freed */
1581 bus_reset_queues(bus);
1582
1583 bus_close_io_fds(bus);
1584 bus_close_inotify_fd(bus);
1585 }
1586
1587 _public_ sd_bus *sd_bus_close_unref(sd_bus *bus) {
1588 if (!bus)
1589 return NULL;
1590
1591 sd_bus_close(bus);
1592
1593 return sd_bus_unref(bus);
1594 }
1595
1596 _public_ sd_bus* sd_bus_flush_close_unref(sd_bus *bus) {
1597 if (!bus)
1598 return NULL;
1599
1600 /* Have to do this before flush() to prevent hang */
1601 bus_kill_exec(bus);
1602 sd_bus_flush(bus);
1603
1604 return sd_bus_close_unref(bus);
1605 }
1606
1607 void bus_enter_closing(sd_bus *bus) {
1608 assert(bus);
1609
1610 if (!IN_SET(bus->state, BUS_WATCH_BIND, BUS_OPENING, BUS_AUTHENTICATING, BUS_HELLO, BUS_RUNNING))
1611 return;
1612
1613 bus_set_state(bus, BUS_CLOSING);
1614 }
1615
1616 DEFINE_PUBLIC_TRIVIAL_REF_UNREF_FUNC(sd_bus, sd_bus, bus_free);
1617
1618 _public_ int sd_bus_is_open(sd_bus *bus) {
1619 assert_return(bus, -EINVAL);
1620 assert_return(bus = bus_resolve(bus), -ENOPKG);
1621 assert_return(!bus_pid_changed(bus), -ECHILD);
1622
1623 return BUS_IS_OPEN(bus->state);
1624 }
1625
1626 _public_ int sd_bus_is_ready(sd_bus *bus) {
1627 assert_return(bus, -EINVAL);
1628 assert_return(bus = bus_resolve(bus), -ENOPKG);
1629 assert_return(!bus_pid_changed(bus), -ECHILD);
1630
1631 return bus->state == BUS_RUNNING;
1632 }
1633
1634 _public_ int sd_bus_can_send(sd_bus *bus, char type) {
1635 int r;
1636
1637 assert_return(bus, -EINVAL);
1638 assert_return(bus = bus_resolve(bus), -ENOPKG);
1639 assert_return(bus->state != BUS_UNSET, -ENOTCONN);
1640 assert_return(!bus_pid_changed(bus), -ECHILD);
1641
1642 if (bus->is_monitor)
1643 return 0;
1644
1645 if (type == SD_BUS_TYPE_UNIX_FD) {
1646 if (!bus->accept_fd)
1647 return 0;
1648
1649 r = bus_ensure_running(bus);
1650 if (r < 0)
1651 return r;
1652
1653 return bus->can_fds;
1654 }
1655
1656 return bus_type_is_valid(type);
1657 }
1658
1659 _public_ int sd_bus_get_bus_id(sd_bus *bus, sd_id128_t *id) {
1660 int r;
1661
1662 assert_return(bus, -EINVAL);
1663 assert_return(bus = bus_resolve(bus), -ENOPKG);
1664 assert_return(id, -EINVAL);
1665 assert_return(!bus_pid_changed(bus), -ECHILD);
1666
1667 r = bus_ensure_running(bus);
1668 if (r < 0)
1669 return r;
1670
1671 *id = bus->server_id;
1672 return 0;
1673 }
1674
1675 #define COOKIE_CYCLED (UINT32_C(1) << 31)
1676
1677 static uint64_t cookie_inc(uint64_t cookie) {
1678
1679 /* Stay within the 32bit range, since classic D-Bus can't deal with more */
1680 if (cookie >= UINT32_MAX)
1681 return COOKIE_CYCLED; /* Don't go back to zero, but use the highest bit for checking
1682 * whether we are looping. */
1683
1684 return cookie + 1;
1685 }
1686
1687 static int next_cookie(sd_bus *b) {
1688 uint64_t new_cookie;
1689
1690 assert(b);
1691
1692 new_cookie = cookie_inc(b->cookie);
1693
1694 /* Small optimization: don't bother with checking for cookie reuse until we overran cookiespace at
1695 * least once, but then do it thorougly. */
1696 if (FLAGS_SET(new_cookie, COOKIE_CYCLED)) {
1697 uint32_t i;
1698
1699 /* Check if the cookie is currently in use. If so, pick the next one */
1700 for (i = 0; i < COOKIE_CYCLED; i++) {
1701 if (!ordered_hashmap_contains(b->reply_callbacks, &new_cookie))
1702 goto good;
1703
1704 new_cookie = cookie_inc(new_cookie);
1705 }
1706
1707 /* Can't fulfill request */
1708 return -EBUSY;
1709 }
1710
1711 good:
1712 b->cookie = new_cookie;
1713 return 0;
1714 }
1715
1716 static int bus_seal_message(sd_bus *b, sd_bus_message *m, usec_t timeout) {
1717 int r;
1718
1719 assert(b);
1720 assert(m);
1721
1722 if (m->sealed) {
1723 /* If we copy the same message to multiple
1724 * destinations, avoid using the same cookie
1725 * numbers. */
1726 b->cookie = MAX(b->cookie, BUS_MESSAGE_COOKIE(m));
1727 return 0;
1728 }
1729
1730 if (timeout == 0) {
1731 r = sd_bus_get_method_call_timeout(b, &timeout);
1732 if (r < 0)
1733 return r;
1734 }
1735
1736 if (!m->sender && b->patch_sender) {
1737 r = sd_bus_message_set_sender(m, b->patch_sender);
1738 if (r < 0)
1739 return r;
1740 }
1741
1742 r = next_cookie(b);
1743 if (r < 0)
1744 return r;
1745
1746 return sd_bus_message_seal(m, b->cookie, timeout);
1747 }
1748
1749 static int bus_remarshal_message(sd_bus *b, sd_bus_message **m) {
1750 bool remarshal = false;
1751
1752 assert(b);
1753
1754 /* wrong packet version */
1755 if (b->message_version != 0 && b->message_version != (*m)->header->version)
1756 remarshal = true;
1757
1758 /* wrong packet endianness */
1759 if (b->message_endian != 0 && b->message_endian != (*m)->header->endian)
1760 remarshal = true;
1761
1762 return remarshal ? bus_message_remarshal(b, m) : 0;
1763 }
1764
1765 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m) {
1766 assert(b);
1767 assert(m);
1768
1769 /* Fake some timestamps, if they were requested, and not
1770 * already initialized */
1771 if (b->attach_timestamp) {
1772 if (m->realtime <= 0)
1773 m->realtime = now(CLOCK_REALTIME);
1774
1775 if (m->monotonic <= 0)
1776 m->monotonic = now(CLOCK_MONOTONIC);
1777 }
1778
1779 /* The bus specification says the serial number cannot be 0,
1780 * hence let's fill something in for synthetic messages. Since
1781 * synthetic messages might have a fake sender and we don't
1782 * want to interfere with the real sender's serial numbers we
1783 * pick a fixed, artificial one. We use (uint32_t) -1 rather
1784 * than (uint64_t) -1 since dbus1 only had 32bit identifiers,
1785 * even though kdbus can do 64bit. */
1786 return sd_bus_message_seal(m, 0xFFFFFFFFULL, 0);
1787 }
1788
1789 static int bus_write_message(sd_bus *bus, sd_bus_message *m, size_t *idx) {
1790 int r;
1791
1792 assert(bus);
1793 assert(m);
1794
1795 r = bus_socket_write_message(bus, m, idx);
1796 if (r <= 0)
1797 return r;
1798
1799 if (*idx >= BUS_MESSAGE_SIZE(m))
1800 log_debug("Sent message type=%s sender=%s destination=%s path=%s interface=%s member=%s cookie=%" PRIu64 " reply_cookie=%" PRIu64 " signature=%s error-name=%s error-message=%s",
1801 bus_message_type_to_string(m->header->type),
1802 strna(sd_bus_message_get_sender(m)),
1803 strna(sd_bus_message_get_destination(m)),
1804 strna(sd_bus_message_get_path(m)),
1805 strna(sd_bus_message_get_interface(m)),
1806 strna(sd_bus_message_get_member(m)),
1807 BUS_MESSAGE_COOKIE(m),
1808 m->reply_cookie,
1809 strna(m->root_container.signature),
1810 strna(m->error.name),
1811 strna(m->error.message));
1812
1813 return r;
1814 }
1815
1816 static int dispatch_wqueue(sd_bus *bus) {
1817 int r, ret = 0;
1818
1819 assert(bus);
1820 assert(IN_SET(bus->state, BUS_RUNNING, BUS_HELLO));
1821
1822 while (bus->wqueue_size > 0) {
1823
1824 r = bus_write_message(bus, bus->wqueue[0], &bus->windex);
1825 if (r < 0)
1826 return r;
1827 else if (r == 0)
1828 /* Didn't do anything this time */
1829 return ret;
1830 else if (bus->windex >= BUS_MESSAGE_SIZE(bus->wqueue[0])) {
1831 /* Fully written. Let's drop the entry from
1832 * the queue.
1833 *
1834 * This isn't particularly optimized, but
1835 * well, this is supposed to be our worst-case
1836 * buffer only, and the socket buffer is
1837 * supposed to be our primary buffer, and if
1838 * it got full, then all bets are off
1839 * anyway. */
1840
1841 bus->wqueue_size--;
1842 bus_message_unref_queued(bus->wqueue[0], bus);
1843 memmove(bus->wqueue, bus->wqueue + 1, sizeof(sd_bus_message*) * bus->wqueue_size);
1844 bus->windex = 0;
1845
1846 ret = 1;
1847 }
1848 }
1849
1850 return ret;
1851 }
1852
1853 static int bus_read_message(sd_bus *bus) {
1854 assert(bus);
1855
1856 return bus_socket_read_message(bus);
1857 }
1858
1859 int bus_rqueue_make_room(sd_bus *bus) {
1860 assert(bus);
1861
1862 if (bus->rqueue_size >= BUS_RQUEUE_MAX)
1863 return -ENOBUFS;
1864
1865 if (!GREEDY_REALLOC(bus->rqueue, bus->rqueue_allocated, bus->rqueue_size + 1))
1866 return -ENOMEM;
1867
1868 return 0;
1869 }
1870
1871 static void rqueue_drop_one(sd_bus *bus, size_t i) {
1872 assert(bus);
1873 assert(i < bus->rqueue_size);
1874
1875 bus_message_unref_queued(bus->rqueue[i], bus);
1876 memmove(bus->rqueue + i, bus->rqueue + i + 1, sizeof(sd_bus_message*) * (bus->rqueue_size - i - 1));
1877 bus->rqueue_size--;
1878 }
1879
1880 static int dispatch_rqueue(sd_bus *bus, sd_bus_message **m) {
1881 int r, ret = 0;
1882
1883 assert(bus);
1884 assert(m);
1885 assert(IN_SET(bus->state, BUS_RUNNING, BUS_HELLO));
1886
1887 for (;;) {
1888 if (bus->rqueue_size > 0) {
1889 /* Dispatch a queued message */
1890 *m = sd_bus_message_ref(bus->rqueue[0]);
1891 rqueue_drop_one(bus, 0);
1892 return 1;
1893 }
1894
1895 /* Try to read a new message */
1896 r = bus_read_message(bus);
1897 if (r < 0)
1898 return r;
1899 if (r == 0) {
1900 *m = NULL;
1901 return ret;
1902 }
1903
1904 ret = 1;
1905 }
1906 }
1907
1908 _public_ int sd_bus_send(sd_bus *bus, sd_bus_message *_m, uint64_t *cookie) {
1909 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = sd_bus_message_ref(_m);
1910 int r;
1911
1912 assert_return(m, -EINVAL);
1913
1914 if (bus)
1915 assert_return(bus = bus_resolve(bus), -ENOPKG);
1916 else
1917 assert_return(bus = m->bus, -ENOTCONN);
1918 assert_return(!bus_pid_changed(bus), -ECHILD);
1919
1920 if (!BUS_IS_OPEN(bus->state))
1921 return -ENOTCONN;
1922
1923 if (m->n_fds > 0) {
1924 r = sd_bus_can_send(bus, SD_BUS_TYPE_UNIX_FD);
1925 if (r < 0)
1926 return r;
1927 if (r == 0)
1928 return -EOPNOTSUPP;
1929 }
1930
1931 /* If the cookie number isn't kept, then we know that no reply
1932 * is expected */
1933 if (!cookie && !m->sealed)
1934 m->header->flags |= BUS_MESSAGE_NO_REPLY_EXPECTED;
1935
1936 r = bus_seal_message(bus, m, 0);
1937 if (r < 0)
1938 return r;
1939
1940 /* Remarshall if we have to. This will possibly unref the
1941 * message and place a replacement in m */
1942 r = bus_remarshal_message(bus, &m);
1943 if (r < 0)
1944 return r;
1945
1946 /* If this is a reply and no reply was requested, then let's
1947 * suppress this, if we can */
1948 if (m->dont_send)
1949 goto finish;
1950
1951 if (IN_SET(bus->state, BUS_RUNNING, BUS_HELLO) && bus->wqueue_size <= 0) {
1952 size_t idx = 0;
1953
1954 r = bus_write_message(bus, m, &idx);
1955 if (r < 0) {
1956 if (ERRNO_IS_DISCONNECT(r)) {
1957 bus_enter_closing(bus);
1958 return -ECONNRESET;
1959 }
1960
1961 return r;
1962 }
1963
1964 if (idx < BUS_MESSAGE_SIZE(m)) {
1965 /* Wasn't fully written. So let's remember how
1966 * much was written. Note that the first entry
1967 * of the wqueue array is always allocated so
1968 * that we always can remember how much was
1969 * written. */
1970 bus->wqueue[0] = bus_message_ref_queued(m, bus);
1971 bus->wqueue_size = 1;
1972 bus->windex = idx;
1973 }
1974
1975 } else {
1976 /* Just append it to the queue. */
1977
1978 if (bus->wqueue_size >= BUS_WQUEUE_MAX)
1979 return -ENOBUFS;
1980
1981 if (!GREEDY_REALLOC(bus->wqueue, bus->wqueue_allocated, bus->wqueue_size + 1))
1982 return -ENOMEM;
1983
1984 bus->wqueue[bus->wqueue_size++] = bus_message_ref_queued(m, bus);
1985 }
1986
1987 finish:
1988 if (cookie)
1989 *cookie = BUS_MESSAGE_COOKIE(m);
1990
1991 return 1;
1992 }
1993
1994 _public_ int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *cookie) {
1995 int r;
1996
1997 assert_return(m, -EINVAL);
1998
1999 if (bus)
2000 assert_return(bus = bus_resolve(bus), -ENOPKG);
2001 else
2002 assert_return(bus = m->bus, -ENOTCONN);
2003 assert_return(!bus_pid_changed(bus), -ECHILD);
2004
2005 if (!BUS_IS_OPEN(bus->state))
2006 return -ENOTCONN;
2007
2008 if (!streq_ptr(m->destination, destination)) {
2009
2010 if (!destination)
2011 return -EEXIST;
2012
2013 r = sd_bus_message_set_destination(m, destination);
2014 if (r < 0)
2015 return r;
2016 }
2017
2018 return sd_bus_send(bus, m, cookie);
2019 }
2020
2021 static usec_t calc_elapse(sd_bus *bus, uint64_t usec) {
2022 assert(bus);
2023
2024 if (usec == (uint64_t) -1)
2025 return 0;
2026
2027 /* We start all timeouts the instant we enter BUS_HELLO/BUS_RUNNING state, so that the don't run in parallel
2028 * with any connection setup states. Hence, if a method callback is started earlier than that we just store the
2029 * relative timestamp, and afterwards the absolute one. */
2030
2031 if (IN_SET(bus->state, BUS_WATCH_BIND, BUS_OPENING, BUS_AUTHENTICATING))
2032 return usec;
2033 else
2034 return now(CLOCK_MONOTONIC) + usec;
2035 }
2036
2037 static int timeout_compare(const void *a, const void *b) {
2038 const struct reply_callback *x = a, *y = b;
2039
2040 if (x->timeout_usec != 0 && y->timeout_usec == 0)
2041 return -1;
2042
2043 if (x->timeout_usec == 0 && y->timeout_usec != 0)
2044 return 1;
2045
2046 return CMP(x->timeout_usec, y->timeout_usec);
2047 }
2048
2049 _public_ int sd_bus_call_async(
2050 sd_bus *bus,
2051 sd_bus_slot **slot,
2052 sd_bus_message *_m,
2053 sd_bus_message_handler_t callback,
2054 void *userdata,
2055 uint64_t usec) {
2056
2057 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = sd_bus_message_ref(_m);
2058 _cleanup_(sd_bus_slot_unrefp) sd_bus_slot *s = NULL;
2059 int r;
2060
2061 assert_return(m, -EINVAL);
2062 assert_return(m->header->type == SD_BUS_MESSAGE_METHOD_CALL, -EINVAL);
2063 assert_return(!m->sealed || (!!callback == !(m->header->flags & BUS_MESSAGE_NO_REPLY_EXPECTED)), -EINVAL);
2064
2065 if (bus)
2066 assert_return(bus = bus_resolve(bus), -ENOPKG);
2067 else
2068 assert_return(bus = m->bus, -ENOTCONN);
2069 assert_return(!bus_pid_changed(bus), -ECHILD);
2070
2071 if (!BUS_IS_OPEN(bus->state))
2072 return -ENOTCONN;
2073
2074 /* If no callback is specified and there's no interest in a slot, then there's no reason to ask for a reply */
2075 if (!callback && !slot && !m->sealed)
2076 m->header->flags |= BUS_MESSAGE_NO_REPLY_EXPECTED;
2077
2078 r = ordered_hashmap_ensure_allocated(&bus->reply_callbacks, &uint64_hash_ops);
2079 if (r < 0)
2080 return r;
2081
2082 r = prioq_ensure_allocated(&bus->reply_callbacks_prioq, timeout_compare);
2083 if (r < 0)
2084 return r;
2085
2086 r = bus_seal_message(bus, m, usec);
2087 if (r < 0)
2088 return r;
2089
2090 r = bus_remarshal_message(bus, &m);
2091 if (r < 0)
2092 return r;
2093
2094 if (slot || callback) {
2095 s = bus_slot_allocate(bus, !slot, BUS_REPLY_CALLBACK, sizeof(struct reply_callback), userdata);
2096 if (!s)
2097 return -ENOMEM;
2098
2099 s->reply_callback.callback = callback;
2100
2101 s->reply_callback.cookie = BUS_MESSAGE_COOKIE(m);
2102 r = ordered_hashmap_put(bus->reply_callbacks, &s->reply_callback.cookie, &s->reply_callback);
2103 if (r < 0) {
2104 s->reply_callback.cookie = 0;
2105 return r;
2106 }
2107
2108 s->reply_callback.timeout_usec = calc_elapse(bus, m->timeout);
2109 if (s->reply_callback.timeout_usec != 0) {
2110 r = prioq_put(bus->reply_callbacks_prioq, &s->reply_callback, &s->reply_callback.prioq_idx);
2111 if (r < 0) {
2112 s->reply_callback.timeout_usec = 0;
2113 return r;
2114 }
2115 }
2116 }
2117
2118 r = sd_bus_send(bus, m, s ? &s->reply_callback.cookie : NULL);
2119 if (r < 0)
2120 return r;
2121
2122 if (slot)
2123 *slot = s;
2124 s = NULL;
2125
2126 return r;
2127 }
2128
2129 int bus_ensure_running(sd_bus *bus) {
2130 int r;
2131
2132 assert(bus);
2133
2134 if (bus->state == BUS_RUNNING)
2135 return 1;
2136
2137 for (;;) {
2138 if (IN_SET(bus->state, BUS_UNSET, BUS_CLOSED, BUS_CLOSING))
2139 return -ENOTCONN;
2140
2141 r = sd_bus_process(bus, NULL);
2142 if (r < 0)
2143 return r;
2144 if (bus->state == BUS_RUNNING)
2145 return 1;
2146 if (r > 0)
2147 continue;
2148
2149 r = sd_bus_wait(bus, (uint64_t) -1);
2150 if (r < 0)
2151 return r;
2152 }
2153 }
2154
2155 _public_ int sd_bus_call(
2156 sd_bus *bus,
2157 sd_bus_message *_m,
2158 uint64_t usec,
2159 sd_bus_error *error,
2160 sd_bus_message **reply) {
2161
2162 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = sd_bus_message_ref(_m);
2163 usec_t timeout;
2164 uint64_t cookie;
2165 size_t i;
2166 int r;
2167
2168 bus_assert_return(m, -EINVAL, error);
2169 bus_assert_return(m->header->type == SD_BUS_MESSAGE_METHOD_CALL, -EINVAL, error);
2170 bus_assert_return(!(m->header->flags & BUS_MESSAGE_NO_REPLY_EXPECTED), -EINVAL, error);
2171 bus_assert_return(!bus_error_is_dirty(error), -EINVAL, error);
2172
2173 if (bus)
2174 assert_return(bus = bus_resolve(bus), -ENOPKG);
2175 else
2176 assert_return(bus = m->bus, -ENOTCONN);
2177 bus_assert_return(!bus_pid_changed(bus), -ECHILD, error);
2178
2179 if (!BUS_IS_OPEN(bus->state)) {
2180 r = -ENOTCONN;
2181 goto fail;
2182 }
2183
2184 r = bus_ensure_running(bus);
2185 if (r < 0)
2186 goto fail;
2187
2188 i = bus->rqueue_size;
2189
2190 r = bus_seal_message(bus, m, usec);
2191 if (r < 0)
2192 goto fail;
2193
2194 r = bus_remarshal_message(bus, &m);
2195 if (r < 0)
2196 goto fail;
2197
2198 r = sd_bus_send(bus, m, &cookie);
2199 if (r < 0)
2200 goto fail;
2201
2202 timeout = calc_elapse(bus, m->timeout);
2203
2204 for (;;) {
2205 usec_t left;
2206
2207 while (i < bus->rqueue_size) {
2208 _cleanup_(sd_bus_message_unrefp) sd_bus_message *incoming = NULL;
2209
2210 incoming = sd_bus_message_ref(bus->rqueue[i]);
2211
2212 if (incoming->reply_cookie == cookie) {
2213 /* Found a match! */
2214
2215 rqueue_drop_one(bus, i);
2216 log_debug_bus_message(incoming);
2217
2218 if (incoming->header->type == SD_BUS_MESSAGE_METHOD_RETURN) {
2219
2220 if (incoming->n_fds <= 0 || bus->accept_fd) {
2221 if (reply)
2222 *reply = TAKE_PTR(incoming);
2223
2224 return 1;
2225 }
2226
2227 return sd_bus_error_setf(error, SD_BUS_ERROR_INCONSISTENT_MESSAGE, "Reply message contained file descriptors which I couldn't accept. Sorry.");
2228
2229 } else if (incoming->header->type == SD_BUS_MESSAGE_METHOD_ERROR)
2230 return sd_bus_error_copy(error, &incoming->error);
2231 else {
2232 r = -EIO;
2233 goto fail;
2234 }
2235
2236 } else if (BUS_MESSAGE_COOKIE(incoming) == cookie &&
2237 bus->unique_name &&
2238 incoming->sender &&
2239 streq(bus->unique_name, incoming->sender)) {
2240
2241 rqueue_drop_one(bus, i);
2242
2243 /* Our own message? Somebody is trying to send its own client a message,
2244 * let's not dead-lock, let's fail immediately. */
2245
2246 r = -ELOOP;
2247 goto fail;
2248 }
2249
2250 /* Try to read more, right-away */
2251 i++;
2252 }
2253
2254 r = bus_read_message(bus);
2255 if (r < 0) {
2256 if (ERRNO_IS_DISCONNECT(r)) {
2257 bus_enter_closing(bus);
2258 r = -ECONNRESET;
2259 }
2260
2261 goto fail;
2262 }
2263 if (r > 0)
2264 continue;
2265
2266 if (timeout > 0) {
2267 usec_t n;
2268
2269 n = now(CLOCK_MONOTONIC);
2270 if (n >= timeout) {
2271 r = -ETIMEDOUT;
2272 goto fail;
2273 }
2274
2275 left = timeout - n;
2276 } else
2277 left = (uint64_t) -1;
2278
2279 r = bus_poll(bus, true, left);
2280 if (r < 0)
2281 goto fail;
2282 if (r == 0) {
2283 r = -ETIMEDOUT;
2284 goto fail;
2285 }
2286
2287 r = dispatch_wqueue(bus);
2288 if (r < 0) {
2289 if (ERRNO_IS_DISCONNECT(r)) {
2290 bus_enter_closing(bus);
2291 r = -ECONNRESET;
2292 }
2293
2294 goto fail;
2295 }
2296 }
2297
2298 fail:
2299 return sd_bus_error_set_errno(error, r);
2300 }
2301
2302 _public_ int sd_bus_get_fd(sd_bus *bus) {
2303 assert_return(bus, -EINVAL);
2304 assert_return(bus = bus_resolve(bus), -ENOPKG);
2305 assert_return(bus->input_fd == bus->output_fd, -EPERM);
2306 assert_return(!bus_pid_changed(bus), -ECHILD);
2307
2308 if (bus->state == BUS_CLOSED)
2309 return -ENOTCONN;
2310
2311 if (bus->inotify_fd >= 0)
2312 return bus->inotify_fd;
2313
2314 if (bus->input_fd >= 0)
2315 return bus->input_fd;
2316
2317 return -ENOTCONN;
2318 }
2319
2320 _public_ int sd_bus_get_events(sd_bus *bus) {
2321 int flags = 0;
2322
2323 assert_return(bus, -EINVAL);
2324 assert_return(bus = bus_resolve(bus), -ENOPKG);
2325 assert_return(!bus_pid_changed(bus), -ECHILD);
2326
2327 switch (bus->state) {
2328
2329 case BUS_UNSET:
2330 case BUS_CLOSED:
2331 return -ENOTCONN;
2332
2333 case BUS_WATCH_BIND:
2334 flags |= POLLIN;
2335 break;
2336
2337 case BUS_OPENING:
2338 flags |= POLLOUT;
2339 break;
2340
2341 case BUS_AUTHENTICATING:
2342 if (bus_socket_auth_needs_write(bus))
2343 flags |= POLLOUT;
2344
2345 flags |= POLLIN;
2346 break;
2347
2348 case BUS_RUNNING:
2349 case BUS_HELLO:
2350 if (bus->rqueue_size <= 0)
2351 flags |= POLLIN;
2352 if (bus->wqueue_size > 0)
2353 flags |= POLLOUT;
2354 break;
2355
2356 case BUS_CLOSING:
2357 break;
2358
2359 default:
2360 assert_not_reached("Unknown state");
2361 }
2362
2363 return flags;
2364 }
2365
2366 _public_ int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec) {
2367 struct reply_callback *c;
2368
2369 assert_return(bus, -EINVAL);
2370 assert_return(bus = bus_resolve(bus), -ENOPKG);
2371 assert_return(timeout_usec, -EINVAL);
2372 assert_return(!bus_pid_changed(bus), -ECHILD);
2373
2374 if (!BUS_IS_OPEN(bus->state) && bus->state != BUS_CLOSING)
2375 return -ENOTCONN;
2376
2377 if (bus->track_queue) {
2378 *timeout_usec = 0;
2379 return 1;
2380 }
2381
2382 switch (bus->state) {
2383
2384 case BUS_AUTHENTICATING:
2385 *timeout_usec = bus->auth_timeout;
2386 return 1;
2387
2388 case BUS_RUNNING:
2389 case BUS_HELLO:
2390 if (bus->rqueue_size > 0) {
2391 *timeout_usec = 0;
2392 return 1;
2393 }
2394
2395 c = prioq_peek(bus->reply_callbacks_prioq);
2396 if (!c) {
2397 *timeout_usec = (uint64_t) -1;
2398 return 0;
2399 }
2400
2401 if (c->timeout_usec == 0) {
2402 *timeout_usec = (uint64_t) -1;
2403 return 0;
2404 }
2405
2406 *timeout_usec = c->timeout_usec;
2407 return 1;
2408
2409 case BUS_CLOSING:
2410 *timeout_usec = 0;
2411 return 1;
2412
2413 case BUS_WATCH_BIND:
2414 case BUS_OPENING:
2415 *timeout_usec = (uint64_t) -1;
2416 return 0;
2417
2418 default:
2419 assert_not_reached("Unknown or unexpected stat");
2420 }
2421 }
2422
2423 static int process_timeout(sd_bus *bus) {
2424 _cleanup_(sd_bus_error_free) sd_bus_error error_buffer = SD_BUS_ERROR_NULL;
2425 _cleanup_(sd_bus_message_unrefp) sd_bus_message* m = NULL;
2426 struct reply_callback *c;
2427 sd_bus_slot *slot;
2428 bool is_hello;
2429 usec_t n;
2430 int r;
2431
2432 assert(bus);
2433 assert(IN_SET(bus->state, BUS_RUNNING, BUS_HELLO));
2434
2435 c = prioq_peek(bus->reply_callbacks_prioq);
2436 if (!c)
2437 return 0;
2438
2439 n = now(CLOCK_MONOTONIC);
2440 if (c->timeout_usec > n)
2441 return 0;
2442
2443 r = bus_message_new_synthetic_error(
2444 bus,
2445 c->cookie,
2446 &SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_NO_REPLY, "Method call timed out"),
2447 &m);
2448 if (r < 0)
2449 return r;
2450
2451 m->read_counter = ++bus->read_counter;
2452
2453 r = bus_seal_synthetic_message(bus, m);
2454 if (r < 0)
2455 return r;
2456
2457 assert_se(prioq_pop(bus->reply_callbacks_prioq) == c);
2458 c->timeout_usec = 0;
2459
2460 ordered_hashmap_remove(bus->reply_callbacks, &c->cookie);
2461 c->cookie = 0;
2462
2463 slot = container_of(c, sd_bus_slot, reply_callback);
2464
2465 bus->iteration_counter++;
2466
2467 is_hello = bus->state == BUS_HELLO && c->callback == hello_callback;
2468
2469 bus->current_message = m;
2470 bus->current_slot = sd_bus_slot_ref(slot);
2471 bus->current_handler = c->callback;
2472 bus->current_userdata = slot->userdata;
2473 r = c->callback(m, slot->userdata, &error_buffer);
2474 bus->current_userdata = NULL;
2475 bus->current_handler = NULL;
2476 bus->current_slot = NULL;
2477 bus->current_message = NULL;
2478
2479 if (slot->floating)
2480 bus_slot_disconnect(slot, true);
2481
2482 sd_bus_slot_unref(slot);
2483
2484 /* When this is the hello message and it timed out, then make sure to propagate the error up, don't just log
2485 * and ignore the callback handler's return value. */
2486 if (is_hello)
2487 return r;
2488
2489 return bus_maybe_reply_error(m, r, &error_buffer);
2490 }
2491
2492 static int process_hello(sd_bus *bus, sd_bus_message *m) {
2493 assert(bus);
2494 assert(m);
2495
2496 if (bus->state != BUS_HELLO)
2497 return 0;
2498
2499 /* Let's make sure the first message on the bus is the HELLO
2500 * reply. But note that we don't actually parse the message
2501 * here (we leave that to the usual handling), we just verify
2502 * we don't let any earlier msg through. */
2503
2504 if (!IN_SET(m->header->type, SD_BUS_MESSAGE_METHOD_RETURN, SD_BUS_MESSAGE_METHOD_ERROR))
2505 return -EIO;
2506
2507 if (m->reply_cookie != 1)
2508 return -EIO;
2509
2510 return 0;
2511 }
2512
2513 static int process_reply(sd_bus *bus, sd_bus_message *m) {
2514 _cleanup_(sd_bus_message_unrefp) sd_bus_message *synthetic_reply = NULL;
2515 _cleanup_(sd_bus_error_free) sd_bus_error error_buffer = SD_BUS_ERROR_NULL;
2516 struct reply_callback *c;
2517 sd_bus_slot *slot;
2518 bool is_hello;
2519 int r;
2520
2521 assert(bus);
2522 assert(m);
2523
2524 if (!IN_SET(m->header->type, SD_BUS_MESSAGE_METHOD_RETURN, SD_BUS_MESSAGE_METHOD_ERROR))
2525 return 0;
2526
2527 if (m->destination && bus->unique_name && !streq_ptr(m->destination, bus->unique_name))
2528 return 0;
2529
2530 c = ordered_hashmap_remove(bus->reply_callbacks, &m->reply_cookie);
2531 if (!c)
2532 return 0;
2533
2534 c->cookie = 0;
2535
2536 slot = container_of(c, sd_bus_slot, reply_callback);
2537
2538 if (m->n_fds > 0 && !bus->accept_fd) {
2539
2540 /* If the reply contained a file descriptor which we
2541 * didn't want we pass an error instead. */
2542
2543 r = bus_message_new_synthetic_error(
2544 bus,
2545 m->reply_cookie,
2546 &SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_INCONSISTENT_MESSAGE, "Reply message contained file descriptor"),
2547 &synthetic_reply);
2548 if (r < 0)
2549 return r;
2550
2551 /* Copy over original timestamp */
2552 synthetic_reply->realtime = m->realtime;
2553 synthetic_reply->monotonic = m->monotonic;
2554 synthetic_reply->seqnum = m->seqnum;
2555 synthetic_reply->read_counter = m->read_counter;
2556
2557 r = bus_seal_synthetic_message(bus, synthetic_reply);
2558 if (r < 0)
2559 return r;
2560
2561 m = synthetic_reply;
2562 } else {
2563 r = sd_bus_message_rewind(m, true);
2564 if (r < 0)
2565 return r;
2566 }
2567
2568 if (c->timeout_usec != 0) {
2569 prioq_remove(bus->reply_callbacks_prioq, c, &c->prioq_idx);
2570 c->timeout_usec = 0;
2571 }
2572
2573 is_hello = bus->state == BUS_HELLO && c->callback == hello_callback;
2574
2575 bus->current_slot = sd_bus_slot_ref(slot);
2576 bus->current_handler = c->callback;
2577 bus->current_userdata = slot->userdata;
2578 r = c->callback(m, slot->userdata, &error_buffer);
2579 bus->current_userdata = NULL;
2580 bus->current_handler = NULL;
2581 bus->current_slot = NULL;
2582
2583 if (slot->floating)
2584 bus_slot_disconnect(slot, true);
2585
2586 sd_bus_slot_unref(slot);
2587
2588 /* When this is the hello message and it failed, then make sure to propagate the error up, don't just log and
2589 * ignore the callback handler's return value. */
2590 if (is_hello)
2591 return r;
2592
2593 return bus_maybe_reply_error(m, r, &error_buffer);
2594 }
2595
2596 static int process_filter(sd_bus *bus, sd_bus_message *m) {
2597 _cleanup_(sd_bus_error_free) sd_bus_error error_buffer = SD_BUS_ERROR_NULL;
2598 struct filter_callback *l;
2599 int r;
2600
2601 assert(bus);
2602 assert(m);
2603
2604 do {
2605 bus->filter_callbacks_modified = false;
2606
2607 LIST_FOREACH(callbacks, l, bus->filter_callbacks) {
2608 sd_bus_slot *slot;
2609
2610 if (bus->filter_callbacks_modified)
2611 break;
2612
2613 /* Don't run this more than once per iteration */
2614 if (l->last_iteration == bus->iteration_counter)
2615 continue;
2616
2617 l->last_iteration = bus->iteration_counter;
2618
2619 r = sd_bus_message_rewind(m, true);
2620 if (r < 0)
2621 return r;
2622
2623 slot = container_of(l, sd_bus_slot, filter_callback);
2624
2625 bus->current_slot = sd_bus_slot_ref(slot);
2626 bus->current_handler = l->callback;
2627 bus->current_userdata = slot->userdata;
2628 r = l->callback(m, slot->userdata, &error_buffer);
2629 bus->current_userdata = NULL;
2630 bus->current_handler = NULL;
2631 bus->current_slot = sd_bus_slot_unref(slot);
2632
2633 r = bus_maybe_reply_error(m, r, &error_buffer);
2634 if (r != 0)
2635 return r;
2636
2637 }
2638
2639 } while (bus->filter_callbacks_modified);
2640
2641 return 0;
2642 }
2643
2644 static int process_match(sd_bus *bus, sd_bus_message *m) {
2645 int r;
2646
2647 assert(bus);
2648 assert(m);
2649
2650 do {
2651 bus->match_callbacks_modified = false;
2652
2653 r = bus_match_run(bus, &bus->match_callbacks, m);
2654 if (r != 0)
2655 return r;
2656
2657 } while (bus->match_callbacks_modified);
2658
2659 return 0;
2660 }
2661
2662 static int process_builtin(sd_bus *bus, sd_bus_message *m) {
2663 _cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL;
2664 int r;
2665
2666 assert(bus);
2667 assert(m);
2668
2669 if (bus->is_monitor)
2670 return 0;
2671
2672 if (bus->manual_peer_interface)
2673 return 0;
2674
2675 if (m->header->type != SD_BUS_MESSAGE_METHOD_CALL)
2676 return 0;
2677
2678 if (!streq_ptr(m->interface, "org.freedesktop.DBus.Peer"))
2679 return 0;
2680
2681 if (m->header->flags & BUS_MESSAGE_NO_REPLY_EXPECTED)
2682 return 1;
2683
2684 if (streq_ptr(m->member, "Ping"))
2685 r = sd_bus_message_new_method_return(m, &reply);
2686 else if (streq_ptr(m->member, "GetMachineId")) {
2687 sd_id128_t id;
2688 char sid[SD_ID128_STRING_MAX];
2689
2690 r = sd_id128_get_machine(&id);
2691 if (r < 0)
2692 return r;
2693
2694 r = sd_bus_message_new_method_return(m, &reply);
2695 if (r < 0)
2696 return r;
2697
2698 r = sd_bus_message_append(reply, "s", sd_id128_to_string(id, sid));
2699 } else {
2700 r = sd_bus_message_new_method_errorf(
2701 m, &reply,
2702 SD_BUS_ERROR_UNKNOWN_METHOD,
2703 "Unknown method '%s' on interface '%s'.", m->member, m->interface);
2704 }
2705 if (r < 0)
2706 return r;
2707
2708 r = sd_bus_send(bus, reply, NULL);
2709 if (r < 0)
2710 return r;
2711
2712 return 1;
2713 }
2714
2715 static int process_fd_check(sd_bus *bus, sd_bus_message *m) {
2716 assert(bus);
2717 assert(m);
2718
2719 /* If we got a message with a file descriptor which we didn't
2720 * want to accept, then let's drop it. How can this even
2721 * happen? For example, when the kernel queues a message into
2722 * an activatable names's queue which allows fds, and then is
2723 * delivered to us later even though we ourselves did not
2724 * negotiate it. */
2725
2726 if (bus->is_monitor)
2727 return 0;
2728
2729 if (m->n_fds <= 0)
2730 return 0;
2731
2732 if (bus->accept_fd)
2733 return 0;
2734
2735 if (m->header->type != SD_BUS_MESSAGE_METHOD_CALL)
2736 return 1; /* just eat it up */
2737
2738 return sd_bus_reply_method_errorf(m, SD_BUS_ERROR_INCONSISTENT_MESSAGE, "Message contains file descriptors, which I cannot accept. Sorry.");
2739 }
2740
2741 static int process_message(sd_bus *bus, sd_bus_message *m) {
2742 int r;
2743
2744 assert(bus);
2745 assert(m);
2746
2747 bus->current_message = m;
2748 bus->iteration_counter++;
2749
2750 log_debug_bus_message(m);
2751
2752 r = process_hello(bus, m);
2753 if (r != 0)
2754 goto finish;
2755
2756 r = process_reply(bus, m);
2757 if (r != 0)
2758 goto finish;
2759
2760 r = process_fd_check(bus, m);
2761 if (r != 0)
2762 goto finish;
2763
2764 r = process_filter(bus, m);
2765 if (r != 0)
2766 goto finish;
2767
2768 r = process_match(bus, m);
2769 if (r != 0)
2770 goto finish;
2771
2772 r = process_builtin(bus, m);
2773 if (r != 0)
2774 goto finish;
2775
2776 r = bus_process_object(bus, m);
2777
2778 finish:
2779 bus->current_message = NULL;
2780 return r;
2781 }
2782
2783 static int dispatch_track(sd_bus *bus) {
2784 assert(bus);
2785
2786 if (!bus->track_queue)
2787 return 0;
2788
2789 bus_track_dispatch(bus->track_queue);
2790 return 1;
2791 }
2792
2793 static int process_running(sd_bus *bus, sd_bus_message **ret) {
2794 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
2795 int r;
2796
2797 assert(bus);
2798 assert(IN_SET(bus->state, BUS_RUNNING, BUS_HELLO));
2799
2800 r = process_timeout(bus);
2801 if (r != 0)
2802 goto null_message;
2803
2804 r = dispatch_wqueue(bus);
2805 if (r != 0)
2806 goto null_message;
2807
2808 r = dispatch_track(bus);
2809 if (r != 0)
2810 goto null_message;
2811
2812 r = dispatch_rqueue(bus, &m);
2813 if (r < 0)
2814 return r;
2815 if (!m)
2816 goto null_message;
2817
2818 r = process_message(bus, m);
2819 if (r != 0)
2820 goto null_message;
2821
2822 if (ret) {
2823 r = sd_bus_message_rewind(m, true);
2824 if (r < 0)
2825 return r;
2826
2827 *ret = TAKE_PTR(m);
2828 return 1;
2829 }
2830
2831 if (m->header->type == SD_BUS_MESSAGE_METHOD_CALL) {
2832
2833 log_debug("Unprocessed message call sender=%s object=%s interface=%s member=%s",
2834 strna(sd_bus_message_get_sender(m)),
2835 strna(sd_bus_message_get_path(m)),
2836 strna(sd_bus_message_get_interface(m)),
2837 strna(sd_bus_message_get_member(m)));
2838
2839 r = sd_bus_reply_method_errorf(
2840 m,
2841 SD_BUS_ERROR_UNKNOWN_OBJECT,
2842 "Unknown object '%s'.", m->path);
2843 if (r < 0)
2844 return r;
2845 }
2846
2847 return 1;
2848
2849 null_message:
2850 if (r >= 0 && ret)
2851 *ret = NULL;
2852
2853 return r;
2854 }
2855
2856 static int bus_exit_now(sd_bus *bus) {
2857 assert(bus);
2858
2859 /* Exit due to close, if this is requested. If this is bus object is attached to an event source, invokes
2860 * sd_event_exit(), otherwise invokes libc exit(). */
2861
2862 if (bus->exited) /* did we already exit? */
2863 return 0;
2864 if (!bus->exit_triggered) /* was the exit condition triggered? */
2865 return 0;
2866 if (!bus->exit_on_disconnect) /* Shall we actually exit on disconnection? */
2867 return 0;
2868
2869 bus->exited = true; /* never exit more than once */
2870
2871 log_debug("Bus connection disconnected, exiting.");
2872
2873 if (bus->event)
2874 return sd_event_exit(bus->event, EXIT_FAILURE);
2875 else
2876 exit(EXIT_FAILURE);
2877
2878 assert_not_reached("exit() didn't exit?");
2879 }
2880
2881 static int process_closing_reply_callback(sd_bus *bus, struct reply_callback *c) {
2882 _cleanup_(sd_bus_error_free) sd_bus_error error_buffer = SD_BUS_ERROR_NULL;
2883 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
2884 sd_bus_slot *slot;
2885 int r;
2886
2887 assert(bus);
2888 assert(c);
2889
2890 r = bus_message_new_synthetic_error(
2891 bus,
2892 c->cookie,
2893 &SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_NO_REPLY, "Connection terminated"),
2894 &m);
2895 if (r < 0)
2896 return r;
2897
2898 m->read_counter = ++bus->read_counter;
2899
2900 r = bus_seal_synthetic_message(bus, m);
2901 if (r < 0)
2902 return r;
2903
2904 if (c->timeout_usec != 0) {
2905 prioq_remove(bus->reply_callbacks_prioq, c, &c->prioq_idx);
2906 c->timeout_usec = 0;
2907 }
2908
2909 ordered_hashmap_remove(bus->reply_callbacks, &c->cookie);
2910 c->cookie = 0;
2911
2912 slot = container_of(c, sd_bus_slot, reply_callback);
2913
2914 bus->iteration_counter++;
2915
2916 bus->current_message = m;
2917 bus->current_slot = sd_bus_slot_ref(slot);
2918 bus->current_handler = c->callback;
2919 bus->current_userdata = slot->userdata;
2920 r = c->callback(m, slot->userdata, &error_buffer);
2921 bus->current_userdata = NULL;
2922 bus->current_handler = NULL;
2923 bus->current_slot = NULL;
2924 bus->current_message = NULL;
2925
2926 if (slot->floating)
2927 bus_slot_disconnect(slot, true);
2928
2929 sd_bus_slot_unref(slot);
2930
2931 return bus_maybe_reply_error(m, r, &error_buffer);
2932 }
2933
2934 static int process_closing(sd_bus *bus, sd_bus_message **ret) {
2935 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
2936 struct reply_callback *c;
2937 int r;
2938
2939 assert(bus);
2940 assert(bus->state == BUS_CLOSING);
2941
2942 /* First, fail all outstanding method calls */
2943 c = ordered_hashmap_first(bus->reply_callbacks);
2944 if (c)
2945 return process_closing_reply_callback(bus, c);
2946
2947 /* Then, fake-drop all remaining bus tracking references */
2948 if (bus->tracks) {
2949 bus_track_close(bus->tracks);
2950 return 1;
2951 }
2952
2953 /* Then, synthesize a Disconnected message */
2954 r = sd_bus_message_new_signal(
2955 bus,
2956 &m,
2957 "/org/freedesktop/DBus/Local",
2958 "org.freedesktop.DBus.Local",
2959 "Disconnected");
2960 if (r < 0)
2961 return r;
2962
2963 bus_message_set_sender_local(bus, m);
2964 m->read_counter = ++bus->read_counter;
2965
2966 r = bus_seal_synthetic_message(bus, m);
2967 if (r < 0)
2968 return r;
2969
2970 sd_bus_close(bus);
2971
2972 bus->current_message = m;
2973 bus->iteration_counter++;
2974
2975 r = process_filter(bus, m);
2976 if (r != 0)
2977 goto finish;
2978
2979 r = process_match(bus, m);
2980 if (r != 0)
2981 goto finish;
2982
2983 /* Nothing else to do, exit now, if the condition holds */
2984 bus->exit_triggered = true;
2985 (void) bus_exit_now(bus);
2986
2987 if (ret)
2988 *ret = TAKE_PTR(m);
2989
2990 r = 1;
2991
2992 finish:
2993 bus->current_message = NULL;
2994
2995 return r;
2996 }
2997
2998 static int bus_process_internal(sd_bus *bus, sd_bus_message **ret) {
2999 int r;
3000
3001 /* Returns 0 when we didn't do anything. This should cause the
3002 * caller to invoke sd_bus_wait() before returning the next
3003 * time. Returns > 0 when we did something, which possibly
3004 * means *ret is filled in with an unprocessed message. */
3005
3006 assert_return(bus, -EINVAL);
3007 assert_return(bus = bus_resolve(bus), -ENOPKG);
3008 assert_return(!bus_pid_changed(bus), -ECHILD);
3009
3010 /* We don't allow recursively invoking sd_bus_process(). */
3011 assert_return(!bus->current_message, -EBUSY);
3012 assert(!bus->current_slot); /* This should be NULL whenever bus->current_message is */
3013
3014 BUS_DONT_DESTROY(bus);
3015
3016 switch (bus->state) {
3017
3018 case BUS_UNSET:
3019 return -ENOTCONN;
3020
3021 case BUS_CLOSED:
3022 return -ECONNRESET;
3023
3024 case BUS_WATCH_BIND:
3025 r = bus_socket_process_watch_bind(bus);
3026 break;
3027
3028 case BUS_OPENING:
3029 r = bus_socket_process_opening(bus);
3030 break;
3031
3032 case BUS_AUTHENTICATING:
3033 r = bus_socket_process_authenticating(bus);
3034 break;
3035
3036 case BUS_RUNNING:
3037 case BUS_HELLO:
3038 r = process_running(bus, ret);
3039 if (r >= 0)
3040 return r;
3041
3042 /* This branch initializes *ret, hence we don't use the generic error checking below */
3043 break;
3044
3045 case BUS_CLOSING:
3046 return process_closing(bus, ret);
3047
3048 default:
3049 assert_not_reached("Unknown state");
3050 }
3051
3052 if (ERRNO_IS_DISCONNECT(r)) {
3053 bus_enter_closing(bus);
3054 r = 1;
3055 } else if (r < 0)
3056 return r;
3057
3058 if (ret)
3059 *ret = NULL;
3060
3061 return r;
3062 }
3063
3064 _public_ int sd_bus_process(sd_bus *bus, sd_bus_message **ret) {
3065 return bus_process_internal(bus, ret);
3066 }
3067
3068 _public_ int sd_bus_process_priority(sd_bus *bus, int64_t priority, sd_bus_message **ret) {
3069 return bus_process_internal(bus, ret);
3070 }
3071
3072 static int bus_poll(sd_bus *bus, bool need_more, uint64_t timeout_usec) {
3073 struct pollfd p[2] = {};
3074 int r, n;
3075 struct timespec ts;
3076 usec_t m = USEC_INFINITY;
3077
3078 assert(bus);
3079
3080 if (bus->state == BUS_CLOSING)
3081 return 1;
3082
3083 if (!BUS_IS_OPEN(bus->state))
3084 return -ENOTCONN;
3085
3086 if (bus->state == BUS_WATCH_BIND) {
3087 assert(bus->inotify_fd >= 0);
3088
3089 p[0].events = POLLIN;
3090 p[0].fd = bus->inotify_fd;
3091 n = 1;
3092 } else {
3093 int e;
3094
3095 e = sd_bus_get_events(bus);
3096 if (e < 0)
3097 return e;
3098
3099 if (need_more)
3100 /* The caller really needs some more data, he doesn't
3101 * care about what's already read, or any timeouts
3102 * except its own. */
3103 e |= POLLIN;
3104 else {
3105 usec_t until;
3106 /* The caller wants to process if there's something to
3107 * process, but doesn't care otherwise */
3108
3109 r = sd_bus_get_timeout(bus, &until);
3110 if (r < 0)
3111 return r;
3112 if (r > 0)
3113 m = usec_sub_unsigned(until, now(CLOCK_MONOTONIC));
3114 }
3115
3116 p[0].fd = bus->input_fd;
3117 if (bus->output_fd == bus->input_fd) {
3118 p[0].events = e;
3119 n = 1;
3120 } else {
3121 p[0].events = e & POLLIN;
3122 p[1].fd = bus->output_fd;
3123 p[1].events = e & POLLOUT;
3124 n = 2;
3125 }
3126 }
3127
3128 if (timeout_usec != (uint64_t) -1 && (m == USEC_INFINITY || timeout_usec < m))
3129 m = timeout_usec;
3130
3131 r = ppoll(p, n, m == USEC_INFINITY ? NULL : timespec_store(&ts, m), NULL);
3132 if (r < 0)
3133 return -errno;
3134 if (r == 0)
3135 return 0;
3136
3137 if (p[0].revents & POLLNVAL)
3138 return -EBADF;
3139 if (n >= 2 && (p[1].revents & POLLNVAL))
3140 return -EBADF;
3141
3142 return 1;
3143 }
3144
3145 _public_ int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec) {
3146
3147 assert_return(bus, -EINVAL);
3148 assert_return(bus = bus_resolve(bus), -ENOPKG);
3149 assert_return(!bus_pid_changed(bus), -ECHILD);
3150
3151 if (bus->state == BUS_CLOSING)
3152 return 0;
3153
3154 if (!BUS_IS_OPEN(bus->state))
3155 return -ENOTCONN;
3156
3157 if (bus->rqueue_size > 0)
3158 return 0;
3159
3160 return bus_poll(bus, false, timeout_usec);
3161 }
3162
3163 _public_ int sd_bus_flush(sd_bus *bus) {
3164 int r;
3165
3166 assert_return(bus, -EINVAL);
3167 assert_return(bus = bus_resolve(bus), -ENOPKG);
3168 assert_return(!bus_pid_changed(bus), -ECHILD);
3169
3170 if (bus->state == BUS_CLOSING)
3171 return 0;
3172
3173 if (!BUS_IS_OPEN(bus->state))
3174 return -ENOTCONN;
3175
3176 /* We never were connected? Don't hang in inotify for good, as there's no timeout set for it */
3177 if (bus->state == BUS_WATCH_BIND)
3178 return -EUNATCH;
3179
3180 r = bus_ensure_running(bus);
3181 if (r < 0)
3182 return r;
3183
3184 if (bus->wqueue_size <= 0)
3185 return 0;
3186
3187 for (;;) {
3188 r = dispatch_wqueue(bus);
3189 if (r < 0) {
3190 if (ERRNO_IS_DISCONNECT(r)) {
3191 bus_enter_closing(bus);
3192 return -ECONNRESET;
3193 }
3194
3195 return r;
3196 }
3197
3198 if (bus->wqueue_size <= 0)
3199 return 0;
3200
3201 r = bus_poll(bus, false, (uint64_t) -1);
3202 if (r < 0)
3203 return r;
3204 }
3205 }
3206
3207 _public_ int sd_bus_add_filter(
3208 sd_bus *bus,
3209 sd_bus_slot **slot,
3210 sd_bus_message_handler_t callback,
3211 void *userdata) {
3212
3213 sd_bus_slot *s;
3214
3215 assert_return(bus, -EINVAL);
3216 assert_return(bus = bus_resolve(bus), -ENOPKG);
3217 assert_return(callback, -EINVAL);
3218 assert_return(!bus_pid_changed(bus), -ECHILD);
3219
3220 s = bus_slot_allocate(bus, !slot, BUS_FILTER_CALLBACK, sizeof(struct filter_callback), userdata);
3221 if (!s)
3222 return -ENOMEM;
3223
3224 s->filter_callback.callback = callback;
3225
3226 bus->filter_callbacks_modified = true;
3227 LIST_PREPEND(callbacks, bus->filter_callbacks, &s->filter_callback);
3228
3229 if (slot)
3230 *slot = s;
3231
3232 return 0;
3233 }
3234
3235 static int add_match_callback(
3236 sd_bus_message *m,
3237 void *userdata,
3238 sd_bus_error *ret_error) {
3239
3240 sd_bus_slot *match_slot = userdata;
3241 bool failed = false;
3242 int r;
3243
3244 assert(m);
3245 assert(match_slot);
3246
3247 sd_bus_slot_ref(match_slot);
3248
3249 if (sd_bus_message_is_method_error(m, NULL)) {
3250 log_debug_errno(sd_bus_message_get_errno(m),
3251 "Unable to add match %s, failing connection: %s",
3252 match_slot->match_callback.match_string,
3253 sd_bus_message_get_error(m)->message);
3254
3255 failed = true;
3256 } else
3257 log_debug("Match %s successfully installed.", match_slot->match_callback.match_string);
3258
3259 if (match_slot->match_callback.install_callback) {
3260 sd_bus *bus;
3261
3262 bus = sd_bus_message_get_bus(m);
3263
3264 /* This function has been called as slot handler, and we want to call another slot handler. Let's
3265 * update the slot callback metadata temporarily with our own data, and then revert back to the old
3266 * values. */
3267
3268 assert(bus->current_slot == match_slot->match_callback.install_slot);
3269 assert(bus->current_handler == add_match_callback);
3270 assert(bus->current_userdata == userdata);
3271
3272 bus->current_slot = match_slot;
3273 bus->current_handler = match_slot->match_callback.install_callback;
3274 bus->current_userdata = match_slot->userdata;
3275
3276 r = match_slot->match_callback.install_callback(m, match_slot->userdata, ret_error);
3277
3278 bus->current_slot = match_slot->match_callback.install_slot;
3279 bus->current_handler = add_match_callback;
3280 bus->current_userdata = userdata;
3281 } else {
3282 if (failed) /* Generic failure handling: destroy the connection */
3283 bus_enter_closing(sd_bus_message_get_bus(m));
3284
3285 r = 1;
3286 }
3287
3288 /* We don't need the install method reply slot anymore, let's free it */
3289 match_slot->match_callback.install_slot = sd_bus_slot_unref(match_slot->match_callback.install_slot);
3290
3291 if (failed && match_slot->floating)
3292 bus_slot_disconnect(match_slot, true);
3293
3294 sd_bus_slot_unref(match_slot);
3295
3296 return r;
3297 }
3298
3299 static int bus_add_match_full(
3300 sd_bus *bus,
3301 sd_bus_slot **slot,
3302 bool asynchronous,
3303 const char *match,
3304 sd_bus_message_handler_t callback,
3305 sd_bus_message_handler_t install_callback,
3306 void *userdata) {
3307
3308 struct bus_match_component *components = NULL;
3309 unsigned n_components = 0;
3310 sd_bus_slot *s = NULL;
3311 int r = 0;
3312
3313 assert_return(bus, -EINVAL);
3314 assert_return(bus = bus_resolve(bus), -ENOPKG);
3315 assert_return(match, -EINVAL);
3316 assert_return(!bus_pid_changed(bus), -ECHILD);
3317
3318 r = bus_match_parse(match, &components, &n_components);
3319 if (r < 0)
3320 goto finish;
3321
3322 s = bus_slot_allocate(bus, !slot, BUS_MATCH_CALLBACK, sizeof(struct match_callback), userdata);
3323 if (!s) {
3324 r = -ENOMEM;
3325 goto finish;
3326 }
3327
3328 s->match_callback.callback = callback;
3329 s->match_callback.install_callback = install_callback;
3330
3331 if (bus->bus_client) {
3332 enum bus_match_scope scope;
3333
3334 scope = bus_match_get_scope(components, n_components);
3335
3336 /* Do not install server-side matches for matches against the local service, interface or bus path. */
3337 if (scope != BUS_MATCH_LOCAL) {
3338
3339 /* We store the original match string, so that we can use it to remove the match again. */
3340
3341 s->match_callback.match_string = strdup(match);
3342 if (!s->match_callback.match_string) {
3343 r = -ENOMEM;
3344 goto finish;
3345 }
3346
3347 if (asynchronous) {
3348 r = bus_add_match_internal_async(bus,
3349 &s->match_callback.install_slot,
3350 s->match_callback.match_string,
3351 add_match_callback,
3352 s);
3353
3354 if (r < 0)
3355 return r;
3356
3357 /* Make the slot of the match call floating now. We need the reference, but we don't
3358 * want that this match pins the bus object, hence we first create it non-floating, but
3359 * then make it floating. */
3360 r = sd_bus_slot_set_floating(s->match_callback.install_slot, true);
3361 } else
3362 r = bus_add_match_internal(bus, s->match_callback.match_string, &s->match_callback.after);
3363 if (r < 0)
3364 goto finish;
3365
3366 s->match_added = true;
3367 }
3368 }
3369
3370 bus->match_callbacks_modified = true;
3371 r = bus_match_add(&bus->match_callbacks, components, n_components, &s->match_callback);
3372 if (r < 0)
3373 goto finish;
3374
3375 if (slot)
3376 *slot = s;
3377 s = NULL;
3378
3379 finish:
3380 bus_match_parse_free(components, n_components);
3381 sd_bus_slot_unref(s);
3382
3383 return r;
3384 }
3385
3386 _public_ int sd_bus_add_match(
3387 sd_bus *bus,
3388 sd_bus_slot **slot,
3389 const char *match,
3390 sd_bus_message_handler_t callback,
3391 void *userdata) {
3392
3393 return bus_add_match_full(bus, slot, false, match, callback, NULL, userdata);
3394 }
3395
3396 _public_ int sd_bus_add_match_async(
3397 sd_bus *bus,
3398 sd_bus_slot **slot,
3399 const char *match,
3400 sd_bus_message_handler_t callback,
3401 sd_bus_message_handler_t install_callback,
3402 void *userdata) {
3403
3404 return bus_add_match_full(bus, slot, true, match, callback, install_callback, userdata);
3405 }
3406
3407 bool bus_pid_changed(sd_bus *bus) {
3408 assert(bus);
3409
3410 /* We don't support people creating a bus connection and
3411 * keeping it around over a fork(). Let's complain. */
3412
3413 return bus->original_pid != getpid_cached();
3414 }
3415
3416 static int io_callback(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
3417 sd_bus *bus = userdata;
3418 int r;
3419
3420 assert(bus);
3421
3422 /* Note that this is called both on input_fd, output_fd as well as inotify_fd events */
3423
3424 r = sd_bus_process(bus, NULL);
3425 if (r < 0) {
3426 log_debug_errno(r, "Processing of bus failed, closing down: %m");
3427 bus_enter_closing(bus);
3428 }
3429
3430 return 1;
3431 }
3432
3433 static int time_callback(sd_event_source *s, uint64_t usec, void *userdata) {
3434 sd_bus *bus = userdata;
3435 int r;
3436
3437 assert(bus);
3438
3439 r = sd_bus_process(bus, NULL);
3440 if (r < 0) {
3441 log_debug_errno(r, "Processing of bus failed, closing down: %m");
3442 bus_enter_closing(bus);
3443 }
3444
3445 return 1;
3446 }
3447
3448 static int prepare_callback(sd_event_source *s, void *userdata) {
3449 sd_bus *bus = userdata;
3450 int r, e;
3451 usec_t until;
3452
3453 assert(s);
3454 assert(bus);
3455
3456 e = sd_bus_get_events(bus);
3457 if (e < 0) {
3458 r = e;
3459 goto fail;
3460 }
3461
3462 if (bus->output_fd != bus->input_fd) {
3463
3464 r = sd_event_source_set_io_events(bus->input_io_event_source, e & POLLIN);
3465 if (r < 0)
3466 goto fail;
3467
3468 r = sd_event_source_set_io_events(bus->output_io_event_source, e & POLLOUT);
3469 } else
3470 r = sd_event_source_set_io_events(bus->input_io_event_source, e);
3471 if (r < 0)
3472 goto fail;
3473
3474 r = sd_bus_get_timeout(bus, &until);
3475 if (r < 0)
3476 goto fail;
3477 if (r > 0) {
3478 int j;
3479
3480 j = sd_event_source_set_time(bus->time_event_source, until);
3481 if (j < 0) {
3482 r = j;
3483 goto fail;
3484 }
3485 }
3486
3487 r = sd_event_source_set_enabled(bus->time_event_source, r > 0);
3488 if (r < 0)
3489 goto fail;
3490
3491 return 1;
3492
3493 fail:
3494 log_debug_errno(r, "Preparing of bus events failed, closing down: %m");
3495 bus_enter_closing(bus);
3496
3497 return 1;
3498 }
3499
3500 static int quit_callback(sd_event_source *event, void *userdata) {
3501 sd_bus *bus = userdata;
3502
3503 assert(event);
3504
3505 if (bus->close_on_exit) {
3506 sd_bus_flush(bus);
3507 sd_bus_close(bus);
3508 }
3509
3510 return 1;
3511 }
3512
3513 int bus_attach_io_events(sd_bus *bus) {
3514 int r;
3515
3516 assert(bus);
3517
3518 if (bus->input_fd < 0)
3519 return 0;
3520
3521 if (!bus->event)
3522 return 0;
3523
3524 if (!bus->input_io_event_source) {
3525 r = sd_event_add_io(bus->event, &bus->input_io_event_source, bus->input_fd, 0, io_callback, bus);
3526 if (r < 0)
3527 return r;
3528
3529 r = sd_event_source_set_prepare(bus->input_io_event_source, prepare_callback);
3530 if (r < 0)
3531 return r;
3532
3533 r = sd_event_source_set_priority(bus->input_io_event_source, bus->event_priority);
3534 if (r < 0)
3535 return r;
3536
3537 r = sd_event_source_set_description(bus->input_io_event_source, "bus-input");
3538 } else
3539 r = sd_event_source_set_io_fd(bus->input_io_event_source, bus->input_fd);
3540
3541 if (r < 0)
3542 return r;
3543
3544 if (bus->output_fd != bus->input_fd) {
3545 assert(bus->output_fd >= 0);
3546
3547 if (!bus->output_io_event_source) {
3548 r = sd_event_add_io(bus->event, &bus->output_io_event_source, bus->output_fd, 0, io_callback, bus);
3549 if (r < 0)
3550 return r;
3551
3552 r = sd_event_source_set_priority(bus->output_io_event_source, bus->event_priority);
3553 if (r < 0)
3554 return r;
3555
3556 r = sd_event_source_set_description(bus->input_io_event_source, "bus-output");
3557 } else
3558 r = sd_event_source_set_io_fd(bus->output_io_event_source, bus->output_fd);
3559
3560 if (r < 0)
3561 return r;
3562 }
3563
3564 return 0;
3565 }
3566
3567 static void bus_detach_io_events(sd_bus *bus) {
3568 assert(bus);
3569
3570 if (bus->input_io_event_source) {
3571 sd_event_source_set_enabled(bus->input_io_event_source, SD_EVENT_OFF);
3572 bus->input_io_event_source = sd_event_source_unref(bus->input_io_event_source);
3573 }
3574
3575 if (bus->output_io_event_source) {
3576 sd_event_source_set_enabled(bus->output_io_event_source, SD_EVENT_OFF);
3577 bus->output_io_event_source = sd_event_source_unref(bus->output_io_event_source);
3578 }
3579 }
3580
3581 int bus_attach_inotify_event(sd_bus *bus) {
3582 int r;
3583
3584 assert(bus);
3585
3586 if (bus->inotify_fd < 0)
3587 return 0;
3588
3589 if (!bus->event)
3590 return 0;
3591
3592 if (!bus->inotify_event_source) {
3593 r = sd_event_add_io(bus->event, &bus->inotify_event_source, bus->inotify_fd, EPOLLIN, io_callback, bus);
3594 if (r < 0)
3595 return r;
3596
3597 r = sd_event_source_set_priority(bus->inotify_event_source, bus->event_priority);
3598 if (r < 0)
3599 return r;
3600
3601 r = sd_event_source_set_description(bus->inotify_event_source, "bus-inotify");
3602 } else
3603 r = sd_event_source_set_io_fd(bus->inotify_event_source, bus->inotify_fd);
3604 if (r < 0)
3605 return r;
3606
3607 return 0;
3608 }
3609
3610 static void bus_detach_inotify_event(sd_bus *bus) {
3611 assert(bus);
3612
3613 if (bus->inotify_event_source) {
3614 sd_event_source_set_enabled(bus->inotify_event_source, SD_EVENT_OFF);
3615 bus->inotify_event_source = sd_event_source_unref(bus->inotify_event_source);
3616 }
3617 }
3618
3619 _public_ int sd_bus_attach_event(sd_bus *bus, sd_event *event, int priority) {
3620 int r;
3621
3622 assert_return(bus, -EINVAL);
3623 assert_return(bus = bus_resolve(bus), -ENOPKG);
3624 assert_return(!bus->event, -EBUSY);
3625
3626 assert(!bus->input_io_event_source);
3627 assert(!bus->output_io_event_source);
3628 assert(!bus->time_event_source);
3629
3630 if (event)
3631 bus->event = sd_event_ref(event);
3632 else {
3633 r = sd_event_default(&bus->event);
3634 if (r < 0)
3635 return r;
3636 }
3637
3638 bus->event_priority = priority;
3639
3640 r = sd_event_add_time(bus->event, &bus->time_event_source, CLOCK_MONOTONIC, 0, 0, time_callback, bus);
3641 if (r < 0)
3642 goto fail;
3643
3644 r = sd_event_source_set_priority(bus->time_event_source, priority);
3645 if (r < 0)
3646 goto fail;
3647
3648 r = sd_event_source_set_description(bus->time_event_source, "bus-time");
3649 if (r < 0)
3650 goto fail;
3651
3652 r = sd_event_add_exit(bus->event, &bus->quit_event_source, quit_callback, bus);
3653 if (r < 0)
3654 goto fail;
3655
3656 r = sd_event_source_set_description(bus->quit_event_source, "bus-exit");
3657 if (r < 0)
3658 goto fail;
3659
3660 r = bus_attach_io_events(bus);
3661 if (r < 0)
3662 goto fail;
3663
3664 r = bus_attach_inotify_event(bus);
3665 if (r < 0)
3666 goto fail;
3667
3668 return 0;
3669
3670 fail:
3671 sd_bus_detach_event(bus);
3672 return r;
3673 }
3674
3675 _public_ int sd_bus_detach_event(sd_bus *bus) {
3676 assert_return(bus, -EINVAL);
3677 assert_return(bus = bus_resolve(bus), -ENOPKG);
3678
3679 if (!bus->event)
3680 return 0;
3681
3682 bus_detach_io_events(bus);
3683 bus_detach_inotify_event(bus);
3684
3685 if (bus->time_event_source) {
3686 sd_event_source_set_enabled(bus->time_event_source, SD_EVENT_OFF);
3687 bus->time_event_source = sd_event_source_unref(bus->time_event_source);
3688 }
3689
3690 if (bus->quit_event_source) {
3691 sd_event_source_set_enabled(bus->quit_event_source, SD_EVENT_OFF);
3692 bus->quit_event_source = sd_event_source_unref(bus->quit_event_source);
3693 }
3694
3695 bus->event = sd_event_unref(bus->event);
3696 return 1;
3697 }
3698
3699 _public_ sd_event* sd_bus_get_event(sd_bus *bus) {
3700 assert_return(bus = bus_resolve(bus), NULL);
3701
3702 return bus->event;
3703 }
3704
3705 _public_ sd_bus_message* sd_bus_get_current_message(sd_bus *bus) {
3706 assert_return(bus = bus_resolve(bus), NULL);
3707
3708 return bus->current_message;
3709 }
3710
3711 _public_ sd_bus_slot* sd_bus_get_current_slot(sd_bus *bus) {
3712 assert_return(bus = bus_resolve(bus), NULL);
3713
3714 return bus->current_slot;
3715 }
3716
3717 _public_ sd_bus_message_handler_t sd_bus_get_current_handler(sd_bus *bus) {
3718 assert_return(bus = bus_resolve(bus), NULL);
3719
3720 return bus->current_handler;
3721 }
3722
3723 _public_ void* sd_bus_get_current_userdata(sd_bus *bus) {
3724 assert_return(bus = bus_resolve(bus), NULL);
3725
3726 return bus->current_userdata;
3727 }
3728
3729 static int bus_default(int (*bus_open)(sd_bus **), sd_bus **default_bus, sd_bus **ret) {
3730 sd_bus *b = NULL;
3731 int r;
3732
3733 assert(bus_open);
3734 assert(default_bus);
3735
3736 if (!ret)
3737 return !!*default_bus;
3738
3739 if (*default_bus) {
3740 *ret = sd_bus_ref(*default_bus);
3741 return 0;
3742 }
3743
3744 r = bus_open(&b);
3745 if (r < 0)
3746 return r;
3747
3748 b->default_bus_ptr = default_bus;
3749 b->tid = gettid();
3750 *default_bus = b;
3751
3752 *ret = b;
3753 return 1;
3754 }
3755
3756 _public_ int sd_bus_default_system(sd_bus **ret) {
3757 return bus_default(sd_bus_open_system, &default_system_bus, ret);
3758 }
3759
3760 _public_ int sd_bus_default_user(sd_bus **ret) {
3761 return bus_default(sd_bus_open_user, &default_user_bus, ret);
3762 }
3763
3764 _public_ int sd_bus_default(sd_bus **ret) {
3765 int (*bus_open)(sd_bus **) = NULL;
3766 sd_bus **busp;
3767
3768 busp = bus_choose_default(&bus_open);
3769 return bus_default(bus_open, busp, ret);
3770 }
3771
3772 _public_ int sd_bus_get_tid(sd_bus *b, pid_t *tid) {
3773 assert_return(b, -EINVAL);
3774 assert_return(tid, -EINVAL);
3775 assert_return(!bus_pid_changed(b), -ECHILD);
3776
3777 if (b->tid != 0) {
3778 *tid = b->tid;
3779 return 0;
3780 }
3781
3782 if (b->event)
3783 return sd_event_get_tid(b->event, tid);
3784
3785 return -ENXIO;
3786 }
3787
3788 _public_ int sd_bus_path_encode(const char *prefix, const char *external_id, char **ret_path) {
3789 _cleanup_free_ char *e = NULL;
3790 char *ret;
3791
3792 assert_return(object_path_is_valid(prefix), -EINVAL);
3793 assert_return(external_id, -EINVAL);
3794 assert_return(ret_path, -EINVAL);
3795
3796 e = bus_label_escape(external_id);
3797 if (!e)
3798 return -ENOMEM;
3799
3800 ret = path_join(prefix, e);
3801 if (!ret)
3802 return -ENOMEM;
3803
3804 *ret_path = ret;
3805 return 0;
3806 }
3807
3808 _public_ int sd_bus_path_decode(const char *path, const char *prefix, char **external_id) {
3809 const char *e;
3810 char *ret;
3811
3812 assert_return(object_path_is_valid(path), -EINVAL);
3813 assert_return(object_path_is_valid(prefix), -EINVAL);
3814 assert_return(external_id, -EINVAL);
3815
3816 e = object_path_startswith(path, prefix);
3817 if (!e) {
3818 *external_id = NULL;
3819 return 0;
3820 }
3821
3822 ret = bus_label_unescape(e);
3823 if (!ret)
3824 return -ENOMEM;
3825
3826 *external_id = ret;
3827 return 1;
3828 }
3829
3830 _public_ int sd_bus_path_encode_many(char **out, const char *path_template, ...) {
3831 _cleanup_strv_free_ char **labels = NULL;
3832 char *path, *path_pos, **label_pos;
3833 const char *sep, *template_pos;
3834 size_t path_length;
3835 va_list list;
3836 int r;
3837
3838 assert_return(out, -EINVAL);
3839 assert_return(path_template, -EINVAL);
3840
3841 path_length = strlen(path_template);
3842
3843 va_start(list, path_template);
3844 for (sep = strchr(path_template, '%'); sep; sep = strchr(sep + 1, '%')) {
3845 const char *arg;
3846 char *label;
3847
3848 arg = va_arg(list, const char *);
3849 if (!arg) {
3850 va_end(list);
3851 return -EINVAL;
3852 }
3853
3854 label = bus_label_escape(arg);
3855 if (!label) {
3856 va_end(list);
3857 return -ENOMEM;
3858 }
3859
3860 r = strv_consume(&labels, label);
3861 if (r < 0) {
3862 va_end(list);
3863 return r;
3864 }
3865
3866 /* add label length, but account for the format character */
3867 path_length += strlen(label) - 1;
3868 }
3869 va_end(list);
3870
3871 path = malloc(path_length + 1);
3872 if (!path)
3873 return -ENOMEM;
3874
3875 path_pos = path;
3876 label_pos = labels;
3877
3878 for (template_pos = path_template; *template_pos; ) {
3879 sep = strchrnul(template_pos, '%');
3880 path_pos = mempcpy(path_pos, template_pos, sep - template_pos);
3881 if (!*sep)
3882 break;
3883
3884 path_pos = stpcpy(path_pos, *label_pos++);
3885 template_pos = sep + 1;
3886 }
3887
3888 *path_pos = 0;
3889 *out = path;
3890 return 0;
3891 }
3892
3893 _public_ int sd_bus_path_decode_many(const char *path, const char *path_template, ...) {
3894 _cleanup_strv_free_ char **labels = NULL;
3895 const char *template_pos, *path_pos;
3896 char **label_pos;
3897 va_list list;
3898 int r;
3899
3900 /*
3901 * This decodes an object-path based on a template argument. The
3902 * template consists of a verbatim path, optionally including special
3903 * directives:
3904 *
3905 * - Each occurrence of '%' in the template matches an arbitrary
3906 * substring of a label in the given path. At most one such
3907 * directive is allowed per label. For each such directive, the
3908 * caller must provide an output parameter (char **) via va_arg. If
3909 * NULL is passed, the given label is verified, but not returned.
3910 * For each matched label, the *decoded* label is stored in the
3911 * passed output argument, and the caller is responsible to free
3912 * it. Note that the output arguments are only modified if the
3913 * actually path matched the template. Otherwise, they're left
3914 * untouched.
3915 *
3916 * This function returns <0 on error, 0 if the path does not match the
3917 * template, 1 if it matched.
3918 */
3919
3920 assert_return(path, -EINVAL);
3921 assert_return(path_template, -EINVAL);
3922
3923 path_pos = path;
3924
3925 for (template_pos = path_template; *template_pos; ) {
3926 const char *sep;
3927 size_t length;
3928 char *label;
3929
3930 /* verify everything until the next '%' matches verbatim */
3931 sep = strchrnul(template_pos, '%');
3932 length = sep - template_pos;
3933 if (strncmp(path_pos, template_pos, length))
3934 return 0;
3935
3936 path_pos += length;
3937 template_pos += length;
3938
3939 if (!*template_pos)
3940 break;
3941
3942 /* We found the next '%' character. Everything up until here
3943 * matched. We now skip ahead to the end of this label and make
3944 * sure it matches the tail of the label in the path. Then we
3945 * decode the string in-between and save it for later use. */
3946
3947 ++template_pos; /* skip over '%' */
3948
3949 sep = strchrnul(template_pos, '/');
3950 length = sep - template_pos; /* length of suffix to match verbatim */
3951
3952 /* verify the suffixes match */
3953 sep = strchrnul(path_pos, '/');
3954 if (sep - path_pos < (ssize_t)length ||
3955 strncmp(sep - length, template_pos, length))
3956 return 0;
3957
3958 template_pos += length; /* skip over matched label */
3959 length = sep - path_pos - length; /* length of sub-label to decode */
3960
3961 /* store unescaped label for later use */
3962 label = bus_label_unescape_n(path_pos, length);
3963 if (!label)
3964 return -ENOMEM;
3965
3966 r = strv_consume(&labels, label);
3967 if (r < 0)
3968 return r;
3969
3970 path_pos = sep; /* skip decoded label and suffix */
3971 }
3972
3973 /* end of template must match end of path */
3974 if (*path_pos)
3975 return 0;
3976
3977 /* copy the labels over to the caller */
3978 va_start(list, path_template);
3979 for (label_pos = labels; label_pos && *label_pos; ++label_pos) {
3980 char **arg;
3981
3982 arg = va_arg(list, char **);
3983 if (arg)
3984 *arg = *label_pos;
3985 else
3986 free(*label_pos);
3987 }
3988 va_end(list);
3989
3990 labels = mfree(labels);
3991 return 1;
3992 }
3993
3994 _public_ int sd_bus_try_close(sd_bus *bus) {
3995 assert_return(bus, -EINVAL);
3996 assert_return(bus = bus_resolve(bus), -ENOPKG);
3997 assert_return(!bus_pid_changed(bus), -ECHILD);
3998
3999 return -EOPNOTSUPP;
4000 }
4001
4002 _public_ int sd_bus_get_description(sd_bus *bus, const char **description) {
4003 assert_return(bus, -EINVAL);
4004 assert_return(bus = bus_resolve(bus), -ENOPKG);
4005 assert_return(description, -EINVAL);
4006 assert_return(bus->description, -ENXIO);
4007 assert_return(!bus_pid_changed(bus), -ECHILD);
4008
4009 if (bus->description)
4010 *description = bus->description;
4011 else if (bus->is_system)
4012 *description = "system";
4013 else if (bus->is_user)
4014 *description = "user";
4015 else
4016 *description = NULL;
4017
4018 return 0;
4019 }
4020
4021 _public_ int sd_bus_get_scope(sd_bus *bus, const char **scope) {
4022 assert_return(bus, -EINVAL);
4023 assert_return(bus = bus_resolve(bus), -ENOPKG);
4024 assert_return(scope, -EINVAL);
4025 assert_return(!bus_pid_changed(bus), -ECHILD);
4026
4027 if (bus->is_user) {
4028 *scope = "user";
4029 return 0;
4030 }
4031
4032 if (bus->is_system) {
4033 *scope = "system";
4034 return 0;
4035 }
4036
4037 return -ENODATA;
4038 }
4039
4040 _public_ int sd_bus_get_address(sd_bus *bus, const char **address) {
4041 assert_return(bus, -EINVAL);
4042 assert_return(bus = bus_resolve(bus), -ENOPKG);
4043 assert_return(address, -EINVAL);
4044 assert_return(!bus_pid_changed(bus), -ECHILD);
4045
4046 if (bus->address) {
4047 *address = bus->address;
4048 return 0;
4049 }
4050
4051 return -ENODATA;
4052 }
4053
4054 _public_ int sd_bus_get_creds_mask(sd_bus *bus, uint64_t *mask) {
4055 assert_return(bus, -EINVAL);
4056 assert_return(bus = bus_resolve(bus), -ENOPKG);
4057 assert_return(mask, -EINVAL);
4058 assert_return(!bus_pid_changed(bus), -ECHILD);
4059
4060 *mask = bus->creds_mask;
4061 return 0;
4062 }
4063
4064 _public_ int sd_bus_is_bus_client(sd_bus *bus) {
4065 assert_return(bus, -EINVAL);
4066 assert_return(bus = bus_resolve(bus), -ENOPKG);
4067 assert_return(!bus_pid_changed(bus), -ECHILD);
4068
4069 return bus->bus_client;
4070 }
4071
4072 _public_ int sd_bus_is_server(sd_bus *bus) {
4073 assert_return(bus, -EINVAL);
4074 assert_return(bus = bus_resolve(bus), -ENOPKG);
4075 assert_return(!bus_pid_changed(bus), -ECHILD);
4076
4077 return bus->is_server;
4078 }
4079
4080 _public_ int sd_bus_is_anonymous(sd_bus *bus) {
4081 assert_return(bus, -EINVAL);
4082 assert_return(bus = bus_resolve(bus), -ENOPKG);
4083 assert_return(!bus_pid_changed(bus), -ECHILD);
4084
4085 return bus->anonymous_auth;
4086 }
4087
4088 _public_ int sd_bus_is_trusted(sd_bus *bus) {
4089 assert_return(bus, -EINVAL);
4090 assert_return(bus = bus_resolve(bus), -ENOPKG);
4091 assert_return(!bus_pid_changed(bus), -ECHILD);
4092
4093 return bus->trusted;
4094 }
4095
4096 _public_ int sd_bus_is_monitor(sd_bus *bus) {
4097 assert_return(bus, -EINVAL);
4098 assert_return(bus = bus_resolve(bus), -ENOPKG);
4099 assert_return(!bus_pid_changed(bus), -ECHILD);
4100
4101 return bus->is_monitor;
4102 }
4103
4104 static void flush_close(sd_bus *bus) {
4105 if (!bus)
4106 return;
4107
4108 /* Flushes and closes the specified bus. We take a ref before,
4109 * to ensure the flushing does not cause the bus to be
4110 * unreferenced. */
4111
4112 sd_bus_flush_close_unref(sd_bus_ref(bus));
4113 }
4114
4115 _public_ void sd_bus_default_flush_close(void) {
4116 flush_close(default_starter_bus);
4117 flush_close(default_user_bus);
4118 flush_close(default_system_bus);
4119 }
4120
4121 _public_ int sd_bus_set_exit_on_disconnect(sd_bus *bus, int b) {
4122 assert_return(bus, -EINVAL);
4123 assert_return(bus = bus_resolve(bus), -ENOPKG);
4124
4125 /* Turns on exit-on-disconnect, and triggers it immediately if the bus connection was already
4126 * disconnected. Note that this is triggered exclusively on disconnections triggered by the server side, never
4127 * from the client side. */
4128 bus->exit_on_disconnect = b;
4129
4130 /* If the exit condition was triggered already, exit immediately. */
4131 return bus_exit_now(bus);
4132 }
4133
4134 _public_ int sd_bus_get_exit_on_disconnect(sd_bus *bus) {
4135 assert_return(bus, -EINVAL);
4136 assert_return(bus = bus_resolve(bus), -ENOPKG);
4137
4138 return bus->exit_on_disconnect;
4139 }
4140
4141 _public_ int sd_bus_set_sender(sd_bus *bus, const char *sender) {
4142 assert_return(bus, -EINVAL);
4143 assert_return(bus = bus_resolve(bus), -ENOPKG);
4144 assert_return(!bus->bus_client, -EPERM);
4145 assert_return(!sender || service_name_is_valid(sender), -EINVAL);
4146
4147 return free_and_strdup(&bus->patch_sender, sender);
4148 }
4149
4150 _public_ int sd_bus_get_sender(sd_bus *bus, const char **ret) {
4151 assert_return(bus, -EINVAL);
4152 assert_return(bus = bus_resolve(bus), -ENOPKG);
4153 assert_return(ret, -EINVAL);
4154
4155 if (!bus->patch_sender)
4156 return -ENODATA;
4157
4158 *ret = bus->patch_sender;
4159 return 0;
4160 }
4161
4162 _public_ int sd_bus_get_n_queued_read(sd_bus *bus, uint64_t *ret) {
4163 assert_return(bus, -EINVAL);
4164 assert_return(bus = bus_resolve(bus), -ENOPKG);
4165 assert_return(!bus_pid_changed(bus), -ECHILD);
4166 assert_return(ret, -EINVAL);
4167
4168 *ret = bus->rqueue_size;
4169 return 0;
4170 }
4171
4172 _public_ int sd_bus_get_n_queued_write(sd_bus *bus, uint64_t *ret) {
4173 assert_return(bus, -EINVAL);
4174 assert_return(bus = bus_resolve(bus), -ENOPKG);
4175 assert_return(!bus_pid_changed(bus), -ECHILD);
4176 assert_return(ret, -EINVAL);
4177
4178 *ret = bus->wqueue_size;
4179 return 0;
4180 }
4181
4182 _public_ int sd_bus_set_method_call_timeout(sd_bus *bus, uint64_t usec) {
4183 assert_return(bus, -EINVAL);
4184 assert_return(bus = bus_resolve(bus), -ENOPKG);
4185
4186 bus->method_call_timeout = usec;
4187 return 0;
4188 }
4189
4190 _public_ int sd_bus_get_method_call_timeout(sd_bus *bus, uint64_t *ret) {
4191 const char *e;
4192 usec_t usec;
4193
4194 assert_return(bus, -EINVAL);
4195 assert_return(bus = bus_resolve(bus), -ENOPKG);
4196 assert_return(ret, -EINVAL);
4197
4198 if (bus->method_call_timeout != 0) {
4199 *ret = bus->method_call_timeout;
4200 return 0;
4201 }
4202
4203 e = secure_getenv("SYSTEMD_BUS_TIMEOUT");
4204 if (e && parse_sec(e, &usec) >= 0 && usec != 0) {
4205 /* Save the parsed value to avoid multiple parsing. To change the timeout value,
4206 * use sd_bus_set_method_call_timeout() instead of setenv(). */
4207 *ret = bus->method_call_timeout = usec;
4208 return 0;
4209 }
4210
4211 *ret = bus->method_call_timeout = BUS_DEFAULT_TIMEOUT;
4212 return 0;
4213 }
4214
4215 _public_ int sd_bus_set_close_on_exit(sd_bus *bus, int b) {
4216 assert_return(bus, -EINVAL);
4217 assert_return(bus = bus_resolve(bus), -ENOPKG);
4218
4219 bus->close_on_exit = b;
4220 return 0;
4221 }
4222
4223 _public_ int sd_bus_get_close_on_exit(sd_bus *bus) {
4224 assert_return(bus, -EINVAL);
4225 assert_return(bus = bus_resolve(bus), -ENOPKG);
4226
4227 return bus->close_on_exit;
4228 }
4229
4230 _public_ int sd_bus_enqueue_for_read(sd_bus *bus, sd_bus_message *m) {
4231 int r;
4232
4233 assert_return(bus, -EINVAL);
4234 assert_return(bus = bus_resolve(bus), -ENOPKG);
4235 assert_return(m, -EINVAL);
4236 assert_return(m->sealed, -EINVAL);
4237 assert_return(!bus_pid_changed(bus), -ECHILD);
4238
4239 if (!BUS_IS_OPEN(bus->state))
4240 return -ENOTCONN;
4241
4242 /* Re-enqueue a message for reading. This is primarily useful for PolicyKit-style authentication,
4243 * where we accept a message, then determine we need to interactively authenticate the user, and then
4244 * we want to process the message again. */
4245
4246 r = bus_rqueue_make_room(bus);
4247 if (r < 0)
4248 return r;
4249
4250 bus->rqueue[bus->rqueue_size++] = bus_message_ref_queued(m, bus);
4251 return 0;
4252 }