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