2 This file is part of systemd.
4 Copyright 2013 Lennart Poettering
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
30 #include "alloc-util.h"
31 #include "bus-container.h"
32 #include "bus-control.h"
33 #include "bus-internal.h"
34 #include "bus-kernel.h"
35 #include "bus-label.h"
36 #include "bus-message.h"
37 #include "bus-objects.h"
38 #include "bus-protocol.h"
40 #include "bus-socket.h"
41 #include "bus-track.h"
44 #include "cgroup-util.h"
47 #include "hexdecoct.h"
48 #include "hostname-util.h"
51 #include "parse-util.h"
52 #include "string-util.h"
56 #define log_debug_bus_message(m) \
58 sd_bus_message *_mm = (m); \
59 log_debug("Got message type=%s sender=%s destination=%s object=%s interface=%s member=%s cookie=%" PRIu64 " reply_cookie=%" PRIu64 " error=%s", \
60 bus_message_type_to_string(_mm->header->type), \
61 strna(sd_bus_message_get_sender(_mm)), \
62 strna(sd_bus_message_get_destination(_mm)), \
63 strna(sd_bus_message_get_path(_mm)), \
64 strna(sd_bus_message_get_interface(_mm)), \
65 strna(sd_bus_message_get_member(_mm)), \
66 BUS_MESSAGE_COOKIE(_mm), \
68 strna(_mm->error.message)); \
71 static int bus_poll(sd_bus *bus, bool need_more, uint64_t timeout_usec);
72 static int attach_io_events(sd_bus *b);
73 static void detach_io_events(sd_bus *b);
75 static thread_local sd_bus *default_system_bus = NULL;
76 #if 0 /// UNNEEDED by elogind
77 static thread_local sd_bus *default_user_bus = NULL;
79 static thread_local sd_bus *default_starter_bus = NULL;
81 static void bus_close_fds(sd_bus *b) {
86 if (b->input_fd != b->output_fd)
87 safe_close(b->output_fd);
88 b->output_fd = b->input_fd = safe_close(b->input_fd);
91 static void bus_reset_queues(sd_bus *b) {
94 while (b->rqueue_size > 0)
95 sd_bus_message_unref(b->rqueue[--b->rqueue_size]);
97 b->rqueue = mfree(b->rqueue);
98 b->rqueue_allocated = 0;
100 while (b->wqueue_size > 0)
101 sd_bus_message_unref(b->wqueue[--b->wqueue_size]);
103 b->wqueue = mfree(b->wqueue);
104 b->wqueue_allocated = 0;
107 static void bus_free(sd_bus *b) {
111 assert(!b->track_queue);
114 b->state = BUS_CLOSED;
116 sd_bus_detach_event(b);
118 while ((s = b->slots)) {
119 /* At this point only floating slots can still be
120 * around, because the non-floating ones keep a
121 * reference to the bus, and we thus couldn't be
122 * destructing right now... We forcibly disconnect the
123 * slots here, so that they still can be referenced by
124 * apps, but are dead. */
127 bus_slot_disconnect(s);
128 sd_bus_slot_unref(s);
131 if (b->default_bus_ptr)
132 *b->default_bus_ptr = NULL;
137 munmap(b->kdbus_buffer, KDBUS_POOL_SIZE);
141 free(b->unique_name);
142 free(b->auth_buffer);
147 free(b->cgroup_root);
148 free(b->description);
151 strv_free(b->exec_argv);
153 close_many(b->fds, b->n_fds);
158 ordered_hashmap_free_free(b->reply_callbacks);
159 prioq_free(b->reply_callbacks_prioq);
161 assert(b->match_callbacks.type == BUS_MATCH_ROOT);
162 bus_match_free(&b->match_callbacks);
164 hashmap_free_free(b->vtable_methods);
165 hashmap_free_free(b->vtable_properties);
167 assert(hashmap_isempty(b->nodes));
168 hashmap_free(b->nodes);
170 bus_kernel_flush_memfd(b);
172 assert_se(pthread_mutex_destroy(&b->memfd_cache_mutex) == 0);
177 _public_ int sd_bus_new(sd_bus **ret) {
180 assert_return(ret, -EINVAL);
186 r->n_ref = REFCNT_INIT;
187 r->input_fd = r->output_fd = -1;
188 r->message_version = 1;
189 r->creds_mask |= SD_BUS_CREDS_WELL_KNOWN_NAMES|SD_BUS_CREDS_UNIQUE_NAME;
190 r->hello_flags |= KDBUS_HELLO_ACCEPT_FD;
191 r->attach_flags |= KDBUS_ATTACH_NAMES;
192 r->original_pid = getpid();
194 assert_se(pthread_mutex_init(&r->memfd_cache_mutex, NULL) == 0);
196 /* We guarantee that wqueue always has space for at least one
198 if (!GREEDY_REALLOC(r->wqueue, r->wqueue_allocated, 1)) {
207 _public_ int sd_bus_set_address(sd_bus *bus, const char *address) {
210 assert_return(bus, -EINVAL);
211 assert_return(bus->state == BUS_UNSET, -EPERM);
212 assert_return(address, -EINVAL);
213 assert_return(!bus_pid_changed(bus), -ECHILD);
225 _public_ int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd) {
226 assert_return(bus, -EINVAL);
227 assert_return(bus->state == BUS_UNSET, -EPERM);
228 assert_return(input_fd >= 0, -EBADF);
229 assert_return(output_fd >= 0, -EBADF);
230 assert_return(!bus_pid_changed(bus), -ECHILD);
232 bus->input_fd = input_fd;
233 bus->output_fd = output_fd;
237 _public_ int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]) {
240 assert_return(bus, -EINVAL);
241 assert_return(bus->state == BUS_UNSET, -EPERM);
242 assert_return(path, -EINVAL);
243 assert_return(!strv_isempty(argv), -EINVAL);
244 assert_return(!bus_pid_changed(bus), -ECHILD);
256 free(bus->exec_path);
257 strv_free(bus->exec_argv);
265 _public_ int sd_bus_set_bus_client(sd_bus *bus, int b) {
266 assert_return(bus, -EINVAL);
267 assert_return(bus->state == BUS_UNSET, -EPERM);
268 assert_return(!bus_pid_changed(bus), -ECHILD);
270 bus->bus_client = !!b;
274 _public_ int sd_bus_set_monitor(sd_bus *bus, int b) {
275 assert_return(bus, -EINVAL);
276 assert_return(bus->state == BUS_UNSET, -EPERM);
277 assert_return(!bus_pid_changed(bus), -ECHILD);
279 SET_FLAG(bus->hello_flags, KDBUS_HELLO_MONITOR, b);
283 _public_ int sd_bus_negotiate_fds(sd_bus *bus, int b) {
284 assert_return(bus, -EINVAL);
285 assert_return(bus->state == BUS_UNSET, -EPERM);
286 assert_return(!bus_pid_changed(bus), -ECHILD);
288 SET_FLAG(bus->hello_flags, KDBUS_HELLO_ACCEPT_FD, b);
292 _public_ int sd_bus_negotiate_timestamp(sd_bus *bus, int b) {
294 assert_return(bus, -EINVAL);
295 assert_return(!IN_SET(bus->state, BUS_CLOSING, BUS_CLOSED), -EPERM);
296 assert_return(!bus_pid_changed(bus), -ECHILD);
298 new_flags = bus->attach_flags;
299 SET_FLAG(new_flags, KDBUS_ATTACH_TIMESTAMP, b);
301 if (bus->attach_flags == new_flags)
304 bus->attach_flags = new_flags;
305 if (bus->state != BUS_UNSET && bus->is_kernel)
306 bus_kernel_realize_attach_flags(bus);
311 _public_ int sd_bus_negotiate_creds(sd_bus *bus, int b, uint64_t mask) {
314 assert_return(bus, -EINVAL);
315 assert_return(mask <= _SD_BUS_CREDS_ALL, -EINVAL);
316 assert_return(!IN_SET(bus->state, BUS_CLOSING, BUS_CLOSED), -EPERM);
317 assert_return(!bus_pid_changed(bus), -ECHILD);
319 SET_FLAG(bus->creds_mask, mask, b);
321 /* The well knowns we need unconditionally, so that matches can work */
322 bus->creds_mask |= SD_BUS_CREDS_WELL_KNOWN_NAMES|SD_BUS_CREDS_UNIQUE_NAME;
324 /* Make sure we don't lose the timestamp flag */
325 new_flags = (bus->attach_flags & KDBUS_ATTACH_TIMESTAMP) | attach_flags_to_kdbus(bus->creds_mask);
326 if (bus->attach_flags == new_flags)
329 bus->attach_flags = new_flags;
330 if (bus->state != BUS_UNSET && bus->is_kernel)
331 bus_kernel_realize_attach_flags(bus);
336 _public_ int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t server_id) {
337 assert_return(bus, -EINVAL);
338 assert_return(b || sd_id128_equal(server_id, SD_ID128_NULL), -EINVAL);
339 assert_return(bus->state == BUS_UNSET, -EPERM);
340 assert_return(!bus_pid_changed(bus), -ECHILD);
342 bus->is_server = !!b;
343 bus->server_id = server_id;
347 _public_ int sd_bus_set_anonymous(sd_bus *bus, int b) {
348 assert_return(bus, -EINVAL);
349 assert_return(bus->state == BUS_UNSET, -EPERM);
350 assert_return(!bus_pid_changed(bus), -ECHILD);
352 bus->anonymous_auth = !!b;
356 _public_ int sd_bus_set_trusted(sd_bus *bus, int b) {
357 assert_return(bus, -EINVAL);
358 assert_return(bus->state == BUS_UNSET, -EPERM);
359 assert_return(!bus_pid_changed(bus), -ECHILD);
365 _public_ int sd_bus_set_description(sd_bus *bus, const char *description) {
366 assert_return(bus, -EINVAL);
367 assert_return(bus->state == BUS_UNSET, -EPERM);
368 assert_return(!bus_pid_changed(bus), -ECHILD);
370 return free_and_strdup(&bus->description, description);
373 _public_ int sd_bus_set_allow_interactive_authorization(sd_bus *bus, int b) {
374 assert_return(bus, -EINVAL);
375 assert_return(!bus_pid_changed(bus), -ECHILD);
377 bus->allow_interactive_authorization = !!b;
381 _public_ int sd_bus_get_allow_interactive_authorization(sd_bus *bus) {
382 assert_return(bus, -EINVAL);
383 assert_return(!bus_pid_changed(bus), -ECHILD);
385 return bus->allow_interactive_authorization;
388 static int hello_callback(sd_bus_message *reply, void *userdata, sd_bus_error *error) {
396 assert(bus->state == BUS_HELLO || bus->state == BUS_CLOSING);
398 r = sd_bus_message_get_errno(reply);
402 r = sd_bus_message_read(reply, "s", &s);
406 if (!service_name_is_valid(s) || s[0] != ':')
409 bus->unique_name = strdup(s);
410 if (!bus->unique_name)
413 if (bus->state == BUS_HELLO)
414 bus->state = BUS_RUNNING;
419 static int bus_send_hello(sd_bus *bus) {
420 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
425 if (!bus->bus_client || bus->is_kernel)
428 r = sd_bus_message_new_method_call(
431 "org.freedesktop.DBus",
432 "/org/freedesktop/DBus",
433 "org.freedesktop.DBus",
438 return sd_bus_call_async(bus, NULL, m, hello_callback, NULL, 0);
441 int bus_start_running(sd_bus *bus) {
444 if (bus->bus_client && !bus->is_kernel) {
445 bus->state = BUS_HELLO;
449 bus->state = BUS_RUNNING;
453 static int parse_address_key(const char **p, const char *key, char **value) {
454 size_t l, n = 0, allocated = 0;
464 if (strncmp(*p, key, l) != 0)
477 while (*a != ';' && *a != ',' && *a != 0) {
495 c = (char) ((x << 4) | y);
502 if (!GREEDY_REALLOC(r, allocated, n + 2))
526 static void skip_address_key(const char **p) {
530 *p += strcspn(*p, ",");
536 static int parse_unix_address(sd_bus *b, const char **p, char **guid) {
537 _cleanup_free_ char *path = NULL, *abstract = NULL;
546 while (**p != 0 && **p != ';') {
547 r = parse_address_key(p, "guid", guid);
553 r = parse_address_key(p, "path", &path);
559 r = parse_address_key(p, "abstract", &abstract);
568 if (!path && !abstract)
571 if (path && abstract)
576 if (l > sizeof(b->sockaddr.un.sun_path))
579 b->sockaddr.un.sun_family = AF_UNIX;
580 strncpy(b->sockaddr.un.sun_path, path, sizeof(b->sockaddr.un.sun_path));
581 b->sockaddr_size = offsetof(struct sockaddr_un, sun_path) + l;
582 } else if (abstract) {
583 l = strlen(abstract);
584 if (l > sizeof(b->sockaddr.un.sun_path) - 1)
587 b->sockaddr.un.sun_family = AF_UNIX;
588 b->sockaddr.un.sun_path[0] = 0;
589 strncpy(b->sockaddr.un.sun_path+1, abstract, sizeof(b->sockaddr.un.sun_path)-1);
590 b->sockaddr_size = offsetof(struct sockaddr_un, sun_path) + 1 + l;
598 static int parse_tcp_address(sd_bus *b, const char **p, char **guid) {
599 _cleanup_free_ char *host = NULL, *port = NULL, *family = NULL;
601 struct addrinfo *result, hints = {
602 .ai_socktype = SOCK_STREAM,
603 .ai_flags = AI_ADDRCONFIG,
611 while (**p != 0 && **p != ';') {
612 r = parse_address_key(p, "guid", guid);
618 r = parse_address_key(p, "host", &host);
624 r = parse_address_key(p, "port", &port);
630 r = parse_address_key(p, "family", &family);
643 if (streq(family, "ipv4"))
644 hints.ai_family = AF_INET;
645 else if (streq(family, "ipv6"))
646 hints.ai_family = AF_INET6;
651 r = getaddrinfo(host, port, &hints, &result);
655 return -EADDRNOTAVAIL;
657 memcpy(&b->sockaddr, result->ai_addr, result->ai_addrlen);
658 b->sockaddr_size = result->ai_addrlen;
660 freeaddrinfo(result);
667 static int parse_exec_address(sd_bus *b, const char **p, char **guid) {
669 unsigned n_argv = 0, j;
671 size_t allocated = 0;
679 while (**p != 0 && **p != ';') {
680 r = parse_address_key(p, "guid", guid);
686 r = parse_address_key(p, "path", &path);
692 if (startswith(*p, "argv")) {
696 ul = strtoul(*p + 4, (char**) p, 10);
697 if (errno > 0 || **p != '=' || ul > 256) {
705 if (!GREEDY_REALLOC0(argv, allocated, ul + 2)) {
713 r = parse_address_key(p, NULL, argv + ul);
728 /* Make sure there are no holes in the array, with the
729 * exception of argv[0] */
730 for (j = 1; j < n_argv; j++)
736 if (argv && argv[0] == NULL) {
737 argv[0] = strdup(path);
752 for (j = 0; j < n_argv; j++)
760 static int parse_kernel_address(sd_bus *b, const char **p, char **guid) {
761 _cleanup_free_ char *path = NULL;
769 while (**p != 0 && **p != ';') {
770 r = parse_address_key(p, "guid", guid);
776 r = parse_address_key(p, "path", &path);
797 static int parse_container_unix_address(sd_bus *b, const char **p, char **guid) {
798 _cleanup_free_ char *machine = NULL, *pid = NULL;
806 while (**p != 0 && **p != ';') {
807 r = parse_address_key(p, "guid", guid);
813 r = parse_address_key(p, "machine", &machine);
819 r = parse_address_key(p, "pid", &pid);
828 if (!machine == !pid)
832 if (!machine_name_is_valid(machine))
836 b->machine = machine;
839 b->machine = mfree(b->machine);
843 r = parse_pid(pid, &b->nspid);
849 b->sockaddr.un.sun_family = AF_UNIX;
850 strncpy(b->sockaddr.un.sun_path, "/var/run/dbus/system_bus_socket", sizeof(b->sockaddr.un.sun_path));
851 b->sockaddr_size = SOCKADDR_UN_LEN(b->sockaddr.un);
857 static int parse_container_kernel_address(sd_bus *b, const char **p, char **guid) {
858 _cleanup_free_ char *machine = NULL, *pid = NULL;
866 while (**p != 0 && **p != ';') {
867 r = parse_address_key(p, "guid", guid);
873 r = parse_address_key(p, "machine", &machine);
879 r = parse_address_key(p, "pid", &pid);
888 if (!machine == !pid)
892 if (!machine_name_is_valid(machine))
896 b->machine = machine;
899 b->machine = mfree(b->machine);
903 r = parse_pid(pid, &b->nspid);
909 r = free_and_strdup(&b->kernel, "/sys/fs/kdbus/0-system/bus");
918 static void bus_reset_parsed_address(sd_bus *b) {
922 b->sockaddr_size = 0;
923 b->exec_argv = strv_free(b->exec_argv);
924 b->exec_path = mfree(b->exec_path);
925 b->server_id = SD_ID128_NULL;
926 b->kernel = mfree(b->kernel);
927 b->machine = mfree(b->machine);
931 static int bus_parse_next_address(sd_bus *b) {
932 _cleanup_free_ char *guid = NULL;
940 if (b->address[b->address_index] == 0)
943 bus_reset_parsed_address(b);
945 a = b->address + b->address_index;
954 if (startswith(a, "unix:")) {
957 r = parse_unix_address(b, &a, &guid);
962 } else if (startswith(a, "tcp:")) {
965 r = parse_tcp_address(b, &a, &guid);
971 } else if (startswith(a, "unixexec:")) {
974 r = parse_exec_address(b, &a, &guid);
980 } else if (startswith(a, "kernel:")) {
983 r = parse_kernel_address(b, &a, &guid);
988 } else if (startswith(a, "x-machine-unix:")) {
991 r = parse_container_unix_address(b, &a, &guid);
996 } else if (startswith(a, "x-machine-kernel:")) {
999 r = parse_container_kernel_address(b, &a, &guid);
1012 r = sd_id128_from_string(guid, &b->server_id);
1017 b->address_index = a - b->address;
1021 static int bus_start_address(sd_bus *b) {
1022 bool container_kdbus_available = false;
1023 bool kdbus_available = false;
1029 bool skipped = false;
1034 * Usually, if you provide multiple different bus-addresses, we
1035 * try all of them in order. We use the first one that
1036 * succeeds. However, if you mix kernel and unix addresses, we
1037 * never try unix-addresses if a previous kernel address was
1038 * tried and kdbus was available. This is required to prevent
1039 * clients to fallback to the bus-proxy if kdbus is available
1040 * but failed (eg., too many connections).
1044 r = bus_socket_exec(b);
1045 else if ((b->nspid > 0 || b->machine) && b->kernel) {
1046 r = bus_container_connect_kernel(b);
1047 if (r < 0 && !IN_SET(r, -ENOENT, -ESOCKTNOSUPPORT))
1048 container_kdbus_available = true;
1050 } else if ((b->nspid > 0 || b->machine) && b->sockaddr.sa.sa_family != AF_UNSPEC) {
1051 if (!container_kdbus_available)
1052 r = bus_container_connect_socket(b);
1056 } else if (b->kernel) {
1057 r = bus_kernel_connect(b);
1058 if (r < 0 && !IN_SET(r, -ENOENT, -ESOCKTNOSUPPORT))
1059 kdbus_available = true;
1061 } else if (b->sockaddr.sa.sa_family != AF_UNSPEC) {
1062 if (!kdbus_available)
1063 r = bus_socket_connect(b);
1071 r = attach_io_events(b);
1076 b->last_connect_error = -r;
1079 r = bus_parse_next_address(b);
1083 return b->last_connect_error ? -b->last_connect_error : -ECONNREFUSED;
1087 int bus_next_address(sd_bus *b) {
1090 bus_reset_parsed_address(b);
1091 return bus_start_address(b);
1094 static int bus_start_fd(sd_bus *b) {
1099 assert(b->input_fd >= 0);
1100 assert(b->output_fd >= 0);
1102 r = fd_nonblock(b->input_fd, true);
1106 r = fd_cloexec(b->input_fd, true);
1110 if (b->input_fd != b->output_fd) {
1111 r = fd_nonblock(b->output_fd, true);
1115 r = fd_cloexec(b->output_fd, true);
1120 if (fstat(b->input_fd, &st) < 0)
1123 if (S_ISCHR(b->input_fd))
1124 return bus_kernel_take_fd(b);
1126 return bus_socket_take_fd(b);
1129 _public_ int sd_bus_start(sd_bus *bus) {
1132 assert_return(bus, -EINVAL);
1133 assert_return(bus->state == BUS_UNSET, -EPERM);
1134 assert_return(!bus_pid_changed(bus), -ECHILD);
1136 bus->state = BUS_OPENING;
1138 if (bus->is_server && bus->bus_client)
1141 if (bus->input_fd >= 0)
1142 r = bus_start_fd(bus);
1143 else if (bus->address || bus->sockaddr.sa.sa_family != AF_UNSPEC || bus->exec_path || bus->kernel || bus->machine)
1144 r = bus_start_address(bus);
1153 return bus_send_hello(bus);
1156 _public_ int sd_bus_open(sd_bus **ret) {
1161 assert_return(ret, -EINVAL);
1163 /* Let's connect to the starter bus if it is set, and
1164 * otherwise to the bus that is appropropriate for the scope
1165 * we are running in */
1167 e = secure_getenv("DBUS_STARTER_BUS_TYPE");
1169 if (streq(e, "system"))
1170 return sd_bus_open_system(ret);
1171 #if 0 /// elogind does not support systemd units
1172 else if (STR_IN_SET(e, "session", "user"))
1173 return sd_bus_open_user(ret);
1177 e = secure_getenv("DBUS_STARTER_ADDRESS");
1179 #if 0 /// elogind does not support systemd units
1180 if (cg_pid_get_owner_uid(0, NULL) >= 0)
1181 return sd_bus_open_user(ret);
1184 return sd_bus_open_system(ret);
1191 r = sd_bus_set_address(b, e);
1195 b->bus_client = true;
1197 /* We don't know whether the bus is trusted or not, so better
1198 * be safe, and authenticate everything */
1200 b->is_local = false;
1201 b->attach_flags |= KDBUS_ATTACH_CAPS | KDBUS_ATTACH_CREDS;
1202 b->creds_mask |= SD_BUS_CREDS_UID | SD_BUS_CREDS_EUID | SD_BUS_CREDS_EFFECTIVE_CAPS;
1204 r = sd_bus_start(b);
1216 int bus_set_address_system(sd_bus *b) {
1220 e = secure_getenv("DBUS_SYSTEM_BUS_ADDRESS");
1222 return sd_bus_set_address(b, e);
1224 return sd_bus_set_address(b, DEFAULT_SYSTEM_BUS_ADDRESS);
1227 _public_ int sd_bus_open_system(sd_bus **ret) {
1231 assert_return(ret, -EINVAL);
1237 r = bus_set_address_system(b);
1241 b->bus_client = true;
1242 b->is_system = true;
1244 /* Let's do per-method access control on the system bus. We
1245 * need the caller's UID and capability set for that. */
1247 b->attach_flags |= KDBUS_ATTACH_CAPS | KDBUS_ATTACH_CREDS;
1248 b->creds_mask |= SD_BUS_CREDS_UID | SD_BUS_CREDS_EUID | SD_BUS_CREDS_EFFECTIVE_CAPS;
1251 r = sd_bus_start(b);
1263 #if 0 /// elogind can not open/use a user bus
1264 int bus_set_address_user(sd_bus *b) {
1271 e = secure_getenv("DBUS_SESSION_BUS_ADDRESS");
1273 return sd_bus_set_address(b, e);
1275 r = cg_pid_get_owner_uid(0, &uid);
1279 e = secure_getenv("XDG_RUNTIME_DIR");
1281 _cleanup_free_ char *ee = NULL;
1283 ee = bus_address_escape(e);
1287 (void) asprintf(&b->address, KERNEL_USER_BUS_ADDRESS_FMT ";" UNIX_USER_BUS_ADDRESS_FMT, uid, ee);
1289 (void) asprintf(&b->address, KERNEL_USER_BUS_ADDRESS_FMT, uid);
1298 _public_ int sd_bus_open_user(sd_bus **ret) {
1299 #if 0 /// elogind does not support user buses
1303 assert_return(ret, -EINVAL);
1309 r = bus_set_address_user(b);
1313 b->bus_client = true;
1316 /* We don't do any per-method access control on the user
1321 r = sd_bus_start(b);
1332 return sd_bus_open_system(ret);
1336 int bus_set_address_system_remote(sd_bus *b, const char *host) {
1337 _cleanup_free_ char *e = NULL;
1338 char *m = NULL, *c = NULL;
1343 /* Let's see if we shall enter some container */
1344 m = strchr(host, ':');
1348 /* Let's make sure this is not a port of some kind,
1349 * and is a valid machine name. */
1350 if (!in_charset(m, "0123456789") && machine_name_is_valid(m)) {
1353 /* Cut out the host part */
1354 t = strndupa(host, m - host - 1);
1355 e = bus_address_escape(t);
1359 c = strjoina(",argv4=--machine=", m);
1364 e = bus_address_escape(host);
1369 b->address = strjoin("unixexec:path=ssh,argv1=-xT,argv2=", e, ",argv3=systemd-stdio-bridge", c);
1376 _public_ int sd_bus_open_system_remote(sd_bus **ret, const char *host) {
1380 assert_return(host, -EINVAL);
1381 assert_return(ret, -EINVAL);
1383 r = sd_bus_new(&bus);
1387 r = bus_set_address_system_remote(bus, host);
1391 bus->bus_client = true;
1392 bus->trusted = false;
1393 bus->is_system = true;
1394 bus->is_local = false;
1396 r = sd_bus_start(bus);
1408 int bus_set_address_system_machine(sd_bus *b, const char *machine) {
1409 _cleanup_free_ char *e = NULL;
1414 e = bus_address_escape(machine);
1418 b->address = strjoin("x-machine-kernel:machine=", e, ";x-machine-unix:machine=", e);
1425 _public_ int sd_bus_open_system_machine(sd_bus **ret, const char *machine) {
1429 assert_return(machine, -EINVAL);
1430 assert_return(ret, -EINVAL);
1431 assert_return(machine_name_is_valid(machine), -EINVAL);
1433 r = sd_bus_new(&bus);
1437 r = bus_set_address_system_machine(bus, machine);
1441 bus->bus_client = true;
1442 bus->trusted = false;
1443 bus->is_system = true;
1444 bus->is_local = false;
1446 r = sd_bus_start(bus);
1458 _public_ void sd_bus_close(sd_bus *bus) {
1462 if (bus->state == BUS_CLOSED)
1464 if (bus_pid_changed(bus))
1467 bus->state = BUS_CLOSED;
1469 sd_bus_detach_event(bus);
1471 /* Drop all queued messages so that they drop references to
1472 * the bus object and the bus may be freed */
1473 bus_reset_queues(bus);
1475 if (!bus->is_kernel)
1478 /* We'll leave the fd open in case this is a kernel bus, since
1479 * there might still be memblocks around that reference this
1480 * bus, and they might need to invoke the KDBUS_CMD_FREE
1481 * ioctl on the fd when they are freed. */
1484 _public_ sd_bus* sd_bus_flush_close_unref(sd_bus *bus) {
1492 return sd_bus_unref(bus);
1495 static void bus_enter_closing(sd_bus *bus) {
1498 if (bus->state != BUS_OPENING &&
1499 bus->state != BUS_AUTHENTICATING &&
1500 bus->state != BUS_HELLO &&
1501 bus->state != BUS_RUNNING)
1504 bus->state = BUS_CLOSING;
1507 _public_ sd_bus *sd_bus_ref(sd_bus *bus) {
1512 assert_se(REFCNT_INC(bus->n_ref) >= 2);
1517 _public_ sd_bus *sd_bus_unref(sd_bus *bus) {
1523 i = REFCNT_DEC(bus->n_ref);
1531 _public_ int sd_bus_is_open(sd_bus *bus) {
1533 assert_return(bus, -EINVAL);
1534 assert_return(!bus_pid_changed(bus), -ECHILD);
1536 return BUS_IS_OPEN(bus->state);
1539 _public_ int sd_bus_can_send(sd_bus *bus, char type) {
1542 assert_return(bus, -EINVAL);
1543 assert_return(bus->state != BUS_UNSET, -ENOTCONN);
1544 assert_return(!bus_pid_changed(bus), -ECHILD);
1546 if (bus->hello_flags & KDBUS_HELLO_MONITOR)
1549 if (type == SD_BUS_TYPE_UNIX_FD) {
1550 if (!(bus->hello_flags & KDBUS_HELLO_ACCEPT_FD))
1553 r = bus_ensure_running(bus);
1557 return bus->can_fds;
1560 return bus_type_is_valid(type);
1563 _public_ int sd_bus_get_bus_id(sd_bus *bus, sd_id128_t *id) {
1566 assert_return(bus, -EINVAL);
1567 assert_return(id, -EINVAL);
1568 assert_return(!bus_pid_changed(bus), -ECHILD);
1570 r = bus_ensure_running(bus);
1574 *id = bus->server_id;
1578 static int bus_seal_message(sd_bus *b, sd_bus_message *m, usec_t timeout) {
1583 /* If we copy the same message to multiple
1584 * destinations, avoid using the same cookie
1586 b->cookie = MAX(b->cookie, BUS_MESSAGE_COOKIE(m));
1591 timeout = BUS_DEFAULT_TIMEOUT;
1593 return bus_message_seal(m, ++b->cookie, timeout);
1596 static int bus_remarshal_message(sd_bus *b, sd_bus_message **m) {
1597 bool remarshal = false;
1601 /* wrong packet version */
1602 if (b->message_version != 0 && b->message_version != (*m)->header->version)
1605 /* wrong packet endianness */
1606 if (b->message_endian != 0 && b->message_endian != (*m)->header->endian)
1609 /* TODO: kdbus-messages received from the kernel contain data which is
1610 * not allowed to be passed to KDBUS_CMD_SEND. Therefore, we have to
1611 * force remarshaling of the message. Technically, we could just
1612 * recreate the kdbus message, but that is non-trivial as other parts of
1613 * the message refer to m->kdbus already. This should be fixed! */
1614 if ((*m)->kdbus && (*m)->release_kdbus)
1617 return remarshal ? bus_message_remarshal(b, m) : 0;
1620 int bus_seal_synthetic_message(sd_bus *b, sd_bus_message *m) {
1624 /* Fake some timestamps, if they were requested, and not
1625 * already initialized */
1626 if (b->attach_flags & KDBUS_ATTACH_TIMESTAMP) {
1627 if (m->realtime <= 0)
1628 m->realtime = now(CLOCK_REALTIME);
1630 if (m->monotonic <= 0)
1631 m->monotonic = now(CLOCK_MONOTONIC);
1634 /* The bus specification says the serial number cannot be 0,
1635 * hence let's fill something in for synthetic messages. Since
1636 * synthetic messages might have a fake sender and we don't
1637 * want to interfere with the real sender's serial numbers we
1638 * pick a fixed, artificial one. We use (uint32_t) -1 rather
1639 * than (uint64_t) -1 since dbus1 only had 32bit identifiers,
1640 * even though kdbus can do 64bit. */
1641 return bus_message_seal(m, 0xFFFFFFFFULL, 0);
1644 static int bus_write_message(sd_bus *bus, sd_bus_message *m, bool hint_sync_call, size_t *idx) {
1651 r = bus_kernel_write_message(bus, m, hint_sync_call);
1653 r = bus_socket_write_message(bus, m, idx);
1658 if (bus->is_kernel || *idx >= BUS_MESSAGE_SIZE(m))
1659 log_debug("Sent message type=%s sender=%s destination=%s object=%s interface=%s member=%s cookie=%" PRIu64 " reply_cookie=%" PRIu64 " error=%s",
1660 bus_message_type_to_string(m->header->type),
1661 strna(sd_bus_message_get_sender(m)),
1662 strna(sd_bus_message_get_destination(m)),
1663 strna(sd_bus_message_get_path(m)),
1664 strna(sd_bus_message_get_interface(m)),
1665 strna(sd_bus_message_get_member(m)),
1666 BUS_MESSAGE_COOKIE(m),
1668 strna(m->error.message));
1673 static int dispatch_wqueue(sd_bus *bus) {
1677 assert(bus->state == BUS_RUNNING || bus->state == BUS_HELLO);
1679 while (bus->wqueue_size > 0) {
1681 r = bus_write_message(bus, bus->wqueue[0], false, &bus->windex);
1685 /* Didn't do anything this time */
1687 else if (bus->is_kernel || bus->windex >= BUS_MESSAGE_SIZE(bus->wqueue[0])) {
1688 /* Fully written. Let's drop the entry from
1691 * This isn't particularly optimized, but
1692 * well, this is supposed to be our worst-case
1693 * buffer only, and the socket buffer is
1694 * supposed to be our primary buffer, and if
1695 * it got full, then all bets are off
1699 sd_bus_message_unref(bus->wqueue[0]);
1700 memmove(bus->wqueue, bus->wqueue + 1, sizeof(sd_bus_message*) * bus->wqueue_size);
1710 static int bus_read_message(sd_bus *bus, bool hint_priority, int64_t priority) {
1714 return bus_kernel_read_message(bus, hint_priority, priority);
1716 return bus_socket_read_message(bus);
1719 int bus_rqueue_make_room(sd_bus *bus) {
1722 if (bus->rqueue_size >= BUS_RQUEUE_MAX)
1725 if (!GREEDY_REALLOC(bus->rqueue, bus->rqueue_allocated, bus->rqueue_size + 1))
1731 static int dispatch_rqueue(sd_bus *bus, bool hint_priority, int64_t priority, sd_bus_message **m) {
1736 assert(bus->state == BUS_RUNNING || bus->state == BUS_HELLO);
1738 /* Note that the priority logic is only available on kdbus,
1739 * where the rqueue is unused. We check the rqueue here
1740 * anyway, because it's simple... */
1743 if (bus->rqueue_size > 0) {
1744 /* Dispatch a queued message */
1746 *m = bus->rqueue[0];
1748 memmove(bus->rqueue, bus->rqueue + 1, sizeof(sd_bus_message*) * bus->rqueue_size);
1752 /* Try to read a new message */
1753 r = bus_read_message(bus, hint_priority, priority);
1763 static int bus_send_internal(sd_bus *bus, sd_bus_message *_m, uint64_t *cookie, bool hint_sync_call) {
1764 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = sd_bus_message_ref(_m);
1767 assert_return(m, -EINVAL);
1772 assert_return(!bus_pid_changed(bus), -ECHILD);
1773 assert_return(!bus->is_kernel || !(bus->hello_flags & KDBUS_HELLO_MONITOR), -EROFS);
1775 if (!BUS_IS_OPEN(bus->state))
1779 r = sd_bus_can_send(bus, SD_BUS_TYPE_UNIX_FD);
1786 /* If the cookie number isn't kept, then we know that no reply
1788 if (!cookie && !m->sealed)
1789 m->header->flags |= BUS_MESSAGE_NO_REPLY_EXPECTED;
1791 r = bus_seal_message(bus, m, 0);
1795 /* Remarshall if we have to. This will possibly unref the
1796 * message and place a replacement in m */
1797 r = bus_remarshal_message(bus, &m);
1801 /* If this is a reply and no reply was requested, then let's
1802 * suppress this, if we can */
1806 if ((bus->state == BUS_RUNNING || bus->state == BUS_HELLO) && bus->wqueue_size <= 0) {
1809 r = bus_write_message(bus, m, hint_sync_call, &idx);
1811 if (IN_SET(r, -ENOTCONN, -ECONNRESET, -EPIPE, -ESHUTDOWN)) {
1812 bus_enter_closing(bus);
1819 if (!bus->is_kernel && idx < BUS_MESSAGE_SIZE(m)) {
1820 /* Wasn't fully written. So let's remember how
1821 * much was written. Note that the first entry
1822 * of the wqueue array is always allocated so
1823 * that we always can remember how much was
1825 bus->wqueue[0] = sd_bus_message_ref(m);
1826 bus->wqueue_size = 1;
1831 /* Just append it to the queue. */
1833 if (bus->wqueue_size >= BUS_WQUEUE_MAX)
1836 if (!GREEDY_REALLOC(bus->wqueue, bus->wqueue_allocated, bus->wqueue_size + 1))
1839 bus->wqueue[bus->wqueue_size++] = sd_bus_message_ref(m);
1844 *cookie = BUS_MESSAGE_COOKIE(m);
1849 _public_ int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *cookie) {
1850 return bus_send_internal(bus, m, cookie, false);
1853 _public_ int sd_bus_send_to(sd_bus *bus, sd_bus_message *m, const char *destination, uint64_t *cookie) {
1856 assert_return(m, -EINVAL);
1861 assert_return(!bus_pid_changed(bus), -ECHILD);
1863 if (!BUS_IS_OPEN(bus->state))
1866 if (!streq_ptr(m->destination, destination)) {
1871 r = sd_bus_message_set_destination(m, destination);
1876 return sd_bus_send(bus, m, cookie);
1879 static usec_t calc_elapse(uint64_t usec) {
1880 if (usec == (uint64_t) -1)
1883 return now(CLOCK_MONOTONIC) + usec;
1886 static int timeout_compare(const void *a, const void *b) {
1887 const struct reply_callback *x = a, *y = b;
1889 if (x->timeout != 0 && y->timeout == 0)
1892 if (x->timeout == 0 && y->timeout != 0)
1895 if (x->timeout < y->timeout)
1898 if (x->timeout > y->timeout)
1904 _public_ int sd_bus_call_async(
1908 sd_bus_message_handler_t callback,
1912 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = sd_bus_message_ref(_m);
1913 _cleanup_(sd_bus_slot_unrefp) sd_bus_slot *s = NULL;
1916 assert_return(m, -EINVAL);
1917 assert_return(m->header->type == SD_BUS_MESSAGE_METHOD_CALL, -EINVAL);
1918 assert_return(!(m->header->flags & BUS_MESSAGE_NO_REPLY_EXPECTED), -EINVAL);
1919 assert_return(callback, -EINVAL);
1924 assert_return(!bus_pid_changed(bus), -ECHILD);
1925 assert_return(!bus->is_kernel || !(bus->hello_flags & KDBUS_HELLO_MONITOR), -EROFS);
1927 if (!BUS_IS_OPEN(bus->state))
1930 r = ordered_hashmap_ensure_allocated(&bus->reply_callbacks, &uint64_hash_ops);
1934 r = prioq_ensure_allocated(&bus->reply_callbacks_prioq, timeout_compare);
1938 r = bus_seal_message(bus, m, usec);
1942 r = bus_remarshal_message(bus, &m);
1946 s = bus_slot_allocate(bus, !slot, BUS_REPLY_CALLBACK, sizeof(struct reply_callback), userdata);
1950 s->reply_callback.callback = callback;
1952 s->reply_callback.cookie = BUS_MESSAGE_COOKIE(m);
1953 r = ordered_hashmap_put(bus->reply_callbacks, &s->reply_callback.cookie, &s->reply_callback);
1955 s->reply_callback.cookie = 0;
1959 s->reply_callback.timeout = calc_elapse(m->timeout);
1960 if (s->reply_callback.timeout != 0) {
1961 r = prioq_put(bus->reply_callbacks_prioq, &s->reply_callback, &s->reply_callback.prioq_idx);
1963 s->reply_callback.timeout = 0;
1968 r = sd_bus_send(bus, m, &s->reply_callback.cookie);
1979 int bus_ensure_running(sd_bus *bus) {
1984 if (bus->state == BUS_UNSET || bus->state == BUS_CLOSED || bus->state == BUS_CLOSING)
1986 if (bus->state == BUS_RUNNING)
1990 r = sd_bus_process(bus, NULL);
1993 if (bus->state == BUS_RUNNING)
1998 r = sd_bus_wait(bus, (uint64_t) -1);
2004 _public_ int sd_bus_call(
2008 sd_bus_error *error,
2009 sd_bus_message **reply) {
2011 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = sd_bus_message_ref(_m);
2017 bus_assert_return(m, -EINVAL, error);
2018 bus_assert_return(m->header->type == SD_BUS_MESSAGE_METHOD_CALL, -EINVAL, error);
2019 bus_assert_return(!(m->header->flags & BUS_MESSAGE_NO_REPLY_EXPECTED), -EINVAL, error);
2020 bus_assert_return(!bus_error_is_dirty(error), -EINVAL, error);
2025 bus_assert_return(!bus_pid_changed(bus), -ECHILD, error);
2026 bus_assert_return(!bus->is_kernel || !(bus->hello_flags & KDBUS_HELLO_MONITOR), -EROFS, error);
2028 if (!BUS_IS_OPEN(bus->state)) {
2033 r = bus_ensure_running(bus);
2037 i = bus->rqueue_size;
2039 r = bus_seal_message(bus, m, usec);
2043 r = bus_remarshal_message(bus, &m);
2047 r = bus_send_internal(bus, m, &cookie, true);
2051 timeout = calc_elapse(m->timeout);
2056 while (i < bus->rqueue_size) {
2057 sd_bus_message *incoming = NULL;
2059 incoming = bus->rqueue[i];
2061 if (incoming->reply_cookie == cookie) {
2062 /* Found a match! */
2064 memmove(bus->rqueue + i, bus->rqueue + i + 1, sizeof(sd_bus_message*) * (bus->rqueue_size - i - 1));
2066 log_debug_bus_message(incoming);
2068 if (incoming->header->type == SD_BUS_MESSAGE_METHOD_RETURN) {
2070 if (incoming->n_fds <= 0 || (bus->hello_flags & KDBUS_HELLO_ACCEPT_FD)) {
2074 sd_bus_message_unref(incoming);
2079 r = sd_bus_error_setf(error, SD_BUS_ERROR_INCONSISTENT_MESSAGE, "Reply message contained file descriptors which I couldn't accept. Sorry.");
2080 sd_bus_message_unref(incoming);
2083 } else if (incoming->header->type == SD_BUS_MESSAGE_METHOD_ERROR) {
2084 r = sd_bus_error_copy(error, &incoming->error);
2085 sd_bus_message_unref(incoming);
2092 } else if (BUS_MESSAGE_COOKIE(incoming) == cookie &&
2095 streq(bus->unique_name, incoming->sender)) {
2097 memmove(bus->rqueue + i, bus->rqueue + i + 1, sizeof(sd_bus_message*) * (bus->rqueue_size - i - 1));
2100 /* Our own message? Somebody is trying
2101 * to send its own client a message,
2102 * let's not dead-lock, let's fail
2105 sd_bus_message_unref(incoming);
2110 /* Try to read more, right-away */
2114 r = bus_read_message(bus, false, 0);
2116 if (IN_SET(r, -ENOTCONN, -ECONNRESET, -EPIPE, -ESHUTDOWN)) {
2117 bus_enter_closing(bus);
2129 n = now(CLOCK_MONOTONIC);
2137 left = (uint64_t) -1;
2139 r = bus_poll(bus, true, left);
2147 r = dispatch_wqueue(bus);
2149 if (IN_SET(r, -ENOTCONN, -ECONNRESET, -EPIPE, -ESHUTDOWN)) {
2150 bus_enter_closing(bus);
2159 return sd_bus_error_set_errno(error, r);
2162 _public_ int sd_bus_get_fd(sd_bus *bus) {
2164 assert_return(bus, -EINVAL);
2165 assert_return(bus->input_fd == bus->output_fd, -EPERM);
2166 assert_return(!bus_pid_changed(bus), -ECHILD);
2168 return bus->input_fd;
2171 _public_ int sd_bus_get_events(sd_bus *bus) {
2174 assert_return(bus, -EINVAL);
2175 assert_return(!bus_pid_changed(bus), -ECHILD);
2177 if (!BUS_IS_OPEN(bus->state) && bus->state != BUS_CLOSING)
2180 if (bus->state == BUS_OPENING)
2182 else if (bus->state == BUS_AUTHENTICATING) {
2184 if (bus_socket_auth_needs_write(bus))
2189 } else if (bus->state == BUS_RUNNING || bus->state == BUS_HELLO) {
2190 if (bus->rqueue_size <= 0)
2192 if (bus->wqueue_size > 0)
2199 _public_ int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec) {
2200 struct reply_callback *c;
2202 assert_return(bus, -EINVAL);
2203 assert_return(timeout_usec, -EINVAL);
2204 assert_return(!bus_pid_changed(bus), -ECHILD);
2206 if (!BUS_IS_OPEN(bus->state) && bus->state != BUS_CLOSING)
2209 if (bus->track_queue) {
2214 if (bus->state == BUS_CLOSING) {
2219 if (bus->state == BUS_AUTHENTICATING) {
2220 *timeout_usec = bus->auth_timeout;
2224 if (bus->state != BUS_RUNNING && bus->state != BUS_HELLO) {
2225 *timeout_usec = (uint64_t) -1;
2229 if (bus->rqueue_size > 0) {
2234 c = prioq_peek(bus->reply_callbacks_prioq);
2236 *timeout_usec = (uint64_t) -1;
2240 if (c->timeout == 0) {
2241 *timeout_usec = (uint64_t) -1;
2245 *timeout_usec = c->timeout;
2249 static int process_timeout(sd_bus *bus) {
2250 _cleanup_(sd_bus_error_free) sd_bus_error error_buffer = SD_BUS_ERROR_NULL;
2251 _cleanup_(sd_bus_message_unrefp) sd_bus_message* m = NULL;
2252 struct reply_callback *c;
2259 c = prioq_peek(bus->reply_callbacks_prioq);
2263 n = now(CLOCK_MONOTONIC);
2267 r = bus_message_new_synthetic_error(
2270 &SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_NO_REPLY, "Method call timed out"),
2275 r = bus_seal_synthetic_message(bus, m);
2279 assert_se(prioq_pop(bus->reply_callbacks_prioq) == c);
2282 ordered_hashmap_remove(bus->reply_callbacks, &c->cookie);
2285 slot = container_of(c, sd_bus_slot, reply_callback);
2287 bus->iteration_counter++;
2289 bus->current_message = m;
2290 bus->current_slot = sd_bus_slot_ref(slot);
2291 bus->current_handler = c->callback;
2292 bus->current_userdata = slot->userdata;
2293 r = c->callback(m, slot->userdata, &error_buffer);
2294 bus->current_userdata = NULL;
2295 bus->current_handler = NULL;
2296 bus->current_slot = NULL;
2297 bus->current_message = NULL;
2299 if (slot->floating) {
2300 bus_slot_disconnect(slot);
2301 sd_bus_slot_unref(slot);
2304 sd_bus_slot_unref(slot);
2306 return bus_maybe_reply_error(m, r, &error_buffer);
2309 static int process_hello(sd_bus *bus, sd_bus_message *m) {
2313 if (bus->state != BUS_HELLO)
2316 /* Let's make sure the first message on the bus is the HELLO
2317 * reply. But note that we don't actually parse the message
2318 * here (we leave that to the usual handling), we just verify
2319 * we don't let any earlier msg through. */
2321 if (m->header->type != SD_BUS_MESSAGE_METHOD_RETURN &&
2322 m->header->type != SD_BUS_MESSAGE_METHOD_ERROR)
2325 if (m->reply_cookie != 1)
2331 static int process_reply(sd_bus *bus, sd_bus_message *m) {
2332 _cleanup_(sd_bus_message_unrefp) sd_bus_message *synthetic_reply = NULL;
2333 _cleanup_(sd_bus_error_free) sd_bus_error error_buffer = SD_BUS_ERROR_NULL;
2334 struct reply_callback *c;
2341 if (m->header->type != SD_BUS_MESSAGE_METHOD_RETURN &&
2342 m->header->type != SD_BUS_MESSAGE_METHOD_ERROR)
2345 if (bus->is_kernel && (bus->hello_flags & KDBUS_HELLO_MONITOR))
2348 if (m->destination && bus->unique_name && !streq_ptr(m->destination, bus->unique_name))
2351 c = ordered_hashmap_remove(bus->reply_callbacks, &m->reply_cookie);
2357 slot = container_of(c, sd_bus_slot, reply_callback);
2359 if (m->n_fds > 0 && !(bus->hello_flags & KDBUS_HELLO_ACCEPT_FD)) {
2361 /* If the reply contained a file descriptor which we
2362 * didn't want we pass an error instead. */
2364 r = bus_message_new_synthetic_error(
2367 &SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_INCONSISTENT_MESSAGE, "Reply message contained file descriptor"),
2372 /* Copy over original timestamp */
2373 synthetic_reply->realtime = m->realtime;
2374 synthetic_reply->monotonic = m->monotonic;
2375 synthetic_reply->seqnum = m->seqnum;
2377 r = bus_seal_synthetic_message(bus, synthetic_reply);
2381 m = synthetic_reply;
2383 r = sd_bus_message_rewind(m, true);
2388 if (c->timeout != 0) {
2389 prioq_remove(bus->reply_callbacks_prioq, c, &c->prioq_idx);
2393 bus->current_slot = sd_bus_slot_ref(slot);
2394 bus->current_handler = c->callback;
2395 bus->current_userdata = slot->userdata;
2396 r = c->callback(m, slot->userdata, &error_buffer);
2397 bus->current_userdata = NULL;
2398 bus->current_handler = NULL;
2399 bus->current_slot = NULL;
2401 if (slot->floating) {
2402 bus_slot_disconnect(slot);
2403 sd_bus_slot_unref(slot);
2406 sd_bus_slot_unref(slot);
2408 return bus_maybe_reply_error(m, r, &error_buffer);
2411 static int process_filter(sd_bus *bus, sd_bus_message *m) {
2412 _cleanup_(sd_bus_error_free) sd_bus_error error_buffer = SD_BUS_ERROR_NULL;
2413 struct filter_callback *l;
2420 bus->filter_callbacks_modified = false;
2422 LIST_FOREACH(callbacks, l, bus->filter_callbacks) {
2425 if (bus->filter_callbacks_modified)
2428 /* Don't run this more than once per iteration */
2429 if (l->last_iteration == bus->iteration_counter)
2432 l->last_iteration = bus->iteration_counter;
2434 r = sd_bus_message_rewind(m, true);
2438 slot = container_of(l, sd_bus_slot, filter_callback);
2440 bus->current_slot = sd_bus_slot_ref(slot);
2441 bus->current_handler = l->callback;
2442 bus->current_userdata = slot->userdata;
2443 r = l->callback(m, slot->userdata, &error_buffer);
2444 bus->current_userdata = NULL;
2445 bus->current_handler = NULL;
2446 bus->current_slot = sd_bus_slot_unref(slot);
2448 r = bus_maybe_reply_error(m, r, &error_buffer);
2454 } while (bus->filter_callbacks_modified);
2459 static int process_match(sd_bus *bus, sd_bus_message *m) {
2466 bus->match_callbacks_modified = false;
2468 r = bus_match_run(bus, &bus->match_callbacks, m);
2472 } while (bus->match_callbacks_modified);
2477 static int process_builtin(sd_bus *bus, sd_bus_message *m) {
2478 _cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL;
2484 if (bus->hello_flags & KDBUS_HELLO_MONITOR)
2487 if (bus->manual_peer_interface)
2490 if (m->header->type != SD_BUS_MESSAGE_METHOD_CALL)
2493 if (!streq_ptr(m->interface, "org.freedesktop.DBus.Peer"))
2496 if (m->header->flags & BUS_MESSAGE_NO_REPLY_EXPECTED)
2499 if (streq_ptr(m->member, "Ping"))
2500 r = sd_bus_message_new_method_return(m, &reply);
2501 else if (streq_ptr(m->member, "GetMachineId")) {
2505 r = sd_id128_get_machine(&id);
2509 r = sd_bus_message_new_method_return(m, &reply);
2513 r = sd_bus_message_append(reply, "s", sd_id128_to_string(id, sid));
2515 r = sd_bus_message_new_method_errorf(
2517 SD_BUS_ERROR_UNKNOWN_METHOD,
2518 "Unknown method '%s' on interface '%s'.", m->member, m->interface);
2524 r = sd_bus_send(bus, reply, NULL);
2531 static int process_fd_check(sd_bus *bus, sd_bus_message *m) {
2535 /* If we got a message with a file descriptor which we didn't
2536 * want to accept, then let's drop it. How can this even
2537 * happen? For example, when the kernel queues a message into
2538 * an activatable names's queue which allows fds, and then is
2539 * delivered to us later even though we ourselves did not
2542 if (bus->hello_flags & KDBUS_HELLO_MONITOR)
2548 if (bus->hello_flags & KDBUS_HELLO_ACCEPT_FD)
2551 if (m->header->type != SD_BUS_MESSAGE_METHOD_CALL)
2552 return 1; /* just eat it up */
2554 return sd_bus_reply_method_errorf(m, SD_BUS_ERROR_INCONSISTENT_MESSAGE, "Message contains file descriptors, which I cannot accept. Sorry.");
2557 static int process_message(sd_bus *bus, sd_bus_message *m) {
2563 bus->current_message = m;
2564 bus->iteration_counter++;
2566 log_debug_bus_message(m);
2568 r = process_hello(bus, m);
2572 r = process_reply(bus, m);
2576 r = process_fd_check(bus, m);
2580 r = process_filter(bus, m);
2584 r = process_match(bus, m);
2588 r = process_builtin(bus, m);
2592 r = bus_process_object(bus, m);
2595 bus->current_message = NULL;
2599 static int dispatch_track(sd_bus *bus) {
2602 if (!bus->track_queue)
2605 bus_track_dispatch(bus->track_queue);
2609 static int process_running(sd_bus *bus, bool hint_priority, int64_t priority, sd_bus_message **ret) {
2610 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
2614 assert(bus->state == BUS_RUNNING || bus->state == BUS_HELLO);
2616 r = process_timeout(bus);
2620 r = dispatch_wqueue(bus);
2624 r = dispatch_track(bus);
2628 r = dispatch_rqueue(bus, hint_priority, priority, &m);
2634 r = process_message(bus, m);
2639 r = sd_bus_message_rewind(m, true);
2648 if (m->header->type == SD_BUS_MESSAGE_METHOD_CALL) {
2650 log_debug("Unprocessed message call sender=%s object=%s interface=%s member=%s",
2651 strna(sd_bus_message_get_sender(m)),
2652 strna(sd_bus_message_get_path(m)),
2653 strna(sd_bus_message_get_interface(m)),
2654 strna(sd_bus_message_get_member(m)));
2656 r = sd_bus_reply_method_errorf(
2658 SD_BUS_ERROR_UNKNOWN_OBJECT,
2659 "Unknown object '%s'.", m->path);
2673 static int bus_exit_now(sd_bus *bus) {
2676 /* Exit due to close, if this is requested. If this is bus object is attached to an event source, invokes
2677 * sd_event_exit(), otherwise invokes libc exit(). */
2679 if (bus->exited) /* did we already exit? */
2681 if (!bus->exit_triggered) /* was the exit condition triggered? */
2683 if (!bus->exit_on_disconnect) /* Shall we actually exit on disconnection? */
2686 bus->exited = true; /* never exit more than once */
2688 log_debug("Bus connection disconnected, exiting.");
2691 return sd_event_exit(bus->event, EXIT_FAILURE);
2695 assert_not_reached("exit() didn't exit?");
2698 static int process_closing_reply_callback(sd_bus *bus, struct reply_callback *c) {
2699 _cleanup_(sd_bus_error_free) sd_bus_error error_buffer = SD_BUS_ERROR_NULL;
2700 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
2707 r = bus_message_new_synthetic_error(
2710 &SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_NO_REPLY, "Connection terminated"),
2715 r = bus_seal_synthetic_message(bus, m);
2719 if (c->timeout != 0) {
2720 prioq_remove(bus->reply_callbacks_prioq, c, &c->prioq_idx);
2724 ordered_hashmap_remove(bus->reply_callbacks, &c->cookie);
2727 slot = container_of(c, sd_bus_slot, reply_callback);
2729 bus->iteration_counter++;
2731 bus->current_message = m;
2732 bus->current_slot = sd_bus_slot_ref(slot);
2733 bus->current_handler = c->callback;
2734 bus->current_userdata = slot->userdata;
2735 r = c->callback(m, slot->userdata, &error_buffer);
2736 bus->current_userdata = NULL;
2737 bus->current_handler = NULL;
2738 bus->current_slot = NULL;
2739 bus->current_message = NULL;
2741 if (slot->floating) {
2742 bus_slot_disconnect(slot);
2743 sd_bus_slot_unref(slot);
2746 sd_bus_slot_unref(slot);
2748 return bus_maybe_reply_error(m, r, &error_buffer);
2751 static int process_closing(sd_bus *bus, sd_bus_message **ret) {
2752 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
2753 struct reply_callback *c;
2757 assert(bus->state == BUS_CLOSING);
2759 /* First, fail all outstanding method calls */
2760 c = ordered_hashmap_first(bus->reply_callbacks);
2762 return process_closing_reply_callback(bus, c);
2764 /* Then, fake-drop all remaining bus tracking references */
2766 bus_track_close(bus->tracks);
2770 /* Then, synthesize a Disconnected message */
2771 r = sd_bus_message_new_signal(
2774 "/org/freedesktop/DBus/Local",
2775 "org.freedesktop.DBus.Local",
2780 bus_message_set_sender_local(bus, m);
2782 r = bus_seal_synthetic_message(bus, m);
2788 bus->current_message = m;
2789 bus->iteration_counter++;
2791 r = process_filter(bus, m);
2795 r = process_match(bus, m);
2799 /* Nothing else to do, exit now, if the condition holds */
2800 bus->exit_triggered = true;
2801 (void) bus_exit_now(bus);
2811 bus->current_message = NULL;
2816 static int bus_process_internal(sd_bus *bus, bool hint_priority, int64_t priority, sd_bus_message **ret) {
2817 BUS_DONT_DESTROY(bus);
2820 /* Returns 0 when we didn't do anything. This should cause the
2821 * caller to invoke sd_bus_wait() before returning the next
2822 * time. Returns > 0 when we did something, which possibly
2823 * means *ret is filled in with an unprocessed message. */
2825 assert_return(bus, -EINVAL);
2826 assert_return(!bus_pid_changed(bus), -ECHILD);
2828 /* We don't allow recursively invoking sd_bus_process(). */
2829 assert_return(!bus->current_message, -EBUSY);
2830 assert(!bus->current_slot);
2832 switch (bus->state) {
2841 r = bus_socket_process_opening(bus);
2842 if (IN_SET(r, -ENOTCONN, -ECONNRESET, -EPIPE, -ESHUTDOWN)) {
2843 bus_enter_closing(bus);
2851 case BUS_AUTHENTICATING:
2852 r = bus_socket_process_authenticating(bus);
2853 if (IN_SET(r, -ENOTCONN, -ECONNRESET, -EPIPE, -ESHUTDOWN)) {
2854 bus_enter_closing(bus);
2866 r = process_running(bus, hint_priority, priority, ret);
2867 if (IN_SET(r, -ENOTCONN, -ECONNRESET, -EPIPE, -ESHUTDOWN)) {
2868 bus_enter_closing(bus);
2878 return process_closing(bus, ret);
2881 assert_not_reached("Unknown state");
2884 _public_ int sd_bus_process(sd_bus *bus, sd_bus_message **ret) {
2885 return bus_process_internal(bus, false, 0, ret);
2888 _public_ int sd_bus_process_priority(sd_bus *bus, int64_t priority, sd_bus_message **ret) {
2889 return bus_process_internal(bus, true, priority, ret);
2892 static int bus_poll(sd_bus *bus, bool need_more, uint64_t timeout_usec) {
2893 struct pollfd p[2] = {};
2896 usec_t m = USEC_INFINITY;
2900 if (bus->state == BUS_CLOSING)
2903 if (!BUS_IS_OPEN(bus->state))
2906 e = sd_bus_get_events(bus);
2911 /* The caller really needs some more data, he doesn't
2912 * care about what's already read, or any timeouts
2913 * except its own. */
2917 /* The caller wants to process if there's something to
2918 * process, but doesn't care otherwise */
2920 r = sd_bus_get_timeout(bus, &until);
2925 nw = now(CLOCK_MONOTONIC);
2926 m = until > nw ? until - nw : 0;
2930 if (timeout_usec != (uint64_t) -1 && (m == (uint64_t) -1 || timeout_usec < m))
2933 p[0].fd = bus->input_fd;
2934 if (bus->output_fd == bus->input_fd) {
2938 p[0].events = e & POLLIN;
2939 p[1].fd = bus->output_fd;
2940 p[1].events = e & POLLOUT;
2944 r = ppoll(p, n, m == (uint64_t) -1 ? NULL : timespec_store(&ts, m), NULL);
2948 return r > 0 ? 1 : 0;
2951 _public_ int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec) {
2953 assert_return(bus, -EINVAL);
2954 assert_return(!bus_pid_changed(bus), -ECHILD);
2956 if (bus->state == BUS_CLOSING)
2959 if (!BUS_IS_OPEN(bus->state))
2962 if (bus->rqueue_size > 0)
2965 return bus_poll(bus, false, timeout_usec);
2968 _public_ int sd_bus_flush(sd_bus *bus) {
2971 assert_return(bus, -EINVAL);
2972 assert_return(!bus_pid_changed(bus), -ECHILD);
2974 if (bus->state == BUS_CLOSING)
2977 if (!BUS_IS_OPEN(bus->state))
2980 r = bus_ensure_running(bus);
2984 if (bus->wqueue_size <= 0)
2988 r = dispatch_wqueue(bus);
2990 if (IN_SET(r, -ENOTCONN, -ECONNRESET, -EPIPE, -ESHUTDOWN)) {
2991 bus_enter_closing(bus);
2998 if (bus->wqueue_size <= 0)
3001 r = bus_poll(bus, false, (uint64_t) -1);
3007 _public_ int sd_bus_add_filter(
3010 sd_bus_message_handler_t callback,
3015 assert_return(bus, -EINVAL);
3016 assert_return(callback, -EINVAL);
3017 assert_return(!bus_pid_changed(bus), -ECHILD);
3019 s = bus_slot_allocate(bus, !slot, BUS_FILTER_CALLBACK, sizeof(struct filter_callback), userdata);
3023 s->filter_callback.callback = callback;
3025 bus->filter_callbacks_modified = true;
3026 LIST_PREPEND(callbacks, bus->filter_callbacks, &s->filter_callback);
3034 _public_ int sd_bus_add_match(
3038 sd_bus_message_handler_t callback,
3041 struct bus_match_component *components = NULL;
3042 unsigned n_components = 0;
3043 sd_bus_slot *s = NULL;
3046 assert_return(bus, -EINVAL);
3047 assert_return(match, -EINVAL);
3048 assert_return(!bus_pid_changed(bus), -ECHILD);
3050 r = bus_match_parse(match, &components, &n_components);
3054 s = bus_slot_allocate(bus, !slot, BUS_MATCH_CALLBACK, sizeof(struct match_callback), userdata);
3060 s->match_callback.callback = callback;
3061 s->match_callback.cookie = ++bus->match_cookie;
3063 if (bus->bus_client) {
3064 enum bus_match_scope scope;
3066 scope = bus_match_get_scope(components, n_components);
3068 /* Do not install server-side matches for matches
3069 * against the local service, interface or bus
3071 if (scope != BUS_MATCH_LOCAL) {
3073 if (!bus->is_kernel) {
3074 /* When this is not a kernel transport, we
3075 * store the original match string, so that we
3076 * can use it to remove the match again */
3078 s->match_callback.match_string = strdup(match);
3079 if (!s->match_callback.match_string) {
3085 r = bus_add_match_internal(bus, s->match_callback.match_string, components, n_components, s->match_callback.cookie);
3089 s->match_added = true;
3093 bus->match_callbacks_modified = true;
3094 r = bus_match_add(&bus->match_callbacks, components, n_components, &s->match_callback);
3103 bus_match_parse_free(components, n_components);
3104 sd_bus_slot_unref(s);
3109 #if 0 /// UNNEEDED by elogind
3110 int bus_remove_match_by_string(
3113 sd_bus_message_handler_t callback,
3116 struct bus_match_component *components = NULL;
3117 unsigned n_components = 0;
3118 struct match_callback *c;
3121 assert_return(bus, -EINVAL);
3122 assert_return(match, -EINVAL);
3123 assert_return(!bus_pid_changed(bus), -ECHILD);
3125 r = bus_match_parse(match, &components, &n_components);
3129 r = bus_match_find(&bus->match_callbacks, components, n_components, NULL, NULL, &c);
3133 sd_bus_slot_unref(container_of(c, sd_bus_slot, match_callback));
3136 bus_match_parse_free(components, n_components);
3142 bool bus_pid_changed(sd_bus *bus) {
3145 /* We don't support people creating a bus connection and
3146 * keeping it around over a fork(). Let's complain. */
3148 return bus->original_pid != getpid();
3151 static int io_callback(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
3152 sd_bus *bus = userdata;
3157 r = sd_bus_process(bus, NULL);
3164 static int time_callback(sd_event_source *s, uint64_t usec, void *userdata) {
3165 sd_bus *bus = userdata;
3170 r = sd_bus_process(bus, NULL);
3177 static int prepare_callback(sd_event_source *s, void *userdata) {
3178 sd_bus *bus = userdata;
3185 e = sd_bus_get_events(bus);
3189 if (bus->output_fd != bus->input_fd) {
3191 r = sd_event_source_set_io_events(bus->input_io_event_source, e & POLLIN);
3195 r = sd_event_source_set_io_events(bus->output_io_event_source, e & POLLOUT);
3199 r = sd_event_source_set_io_events(bus->input_io_event_source, e);
3204 r = sd_bus_get_timeout(bus, &until);
3210 j = sd_event_source_set_time(bus->time_event_source, until);
3215 r = sd_event_source_set_enabled(bus->time_event_source, r > 0);
3222 static int quit_callback(sd_event_source *event, void *userdata) {
3223 sd_bus *bus = userdata;
3233 static int attach_io_events(sd_bus *bus) {
3238 if (bus->input_fd < 0)
3244 if (!bus->input_io_event_source) {
3245 r = sd_event_add_io(bus->event, &bus->input_io_event_source, bus->input_fd, 0, io_callback, bus);
3249 r = sd_event_source_set_prepare(bus->input_io_event_source, prepare_callback);
3253 r = sd_event_source_set_priority(bus->input_io_event_source, bus->event_priority);
3257 r = sd_event_source_set_description(bus->input_io_event_source, "bus-input");
3259 r = sd_event_source_set_io_fd(bus->input_io_event_source, bus->input_fd);
3264 if (bus->output_fd != bus->input_fd) {
3265 assert(bus->output_fd >= 0);
3267 if (!bus->output_io_event_source) {
3268 r = sd_event_add_io(bus->event, &bus->output_io_event_source, bus->output_fd, 0, io_callback, bus);
3272 r = sd_event_source_set_priority(bus->output_io_event_source, bus->event_priority);
3276 r = sd_event_source_set_description(bus->input_io_event_source, "bus-output");
3278 r = sd_event_source_set_io_fd(bus->output_io_event_source, bus->output_fd);
3287 static void detach_io_events(sd_bus *bus) {
3290 if (bus->input_io_event_source) {
3291 sd_event_source_set_enabled(bus->input_io_event_source, SD_EVENT_OFF);
3292 bus->input_io_event_source = sd_event_source_unref(bus->input_io_event_source);
3295 if (bus->output_io_event_source) {
3296 sd_event_source_set_enabled(bus->output_io_event_source, SD_EVENT_OFF);
3297 bus->output_io_event_source = sd_event_source_unref(bus->output_io_event_source);
3301 _public_ int sd_bus_attach_event(sd_bus *bus, sd_event *event, int priority) {
3304 assert_return(bus, -EINVAL);
3305 assert_return(!bus->event, -EBUSY);
3307 assert(!bus->input_io_event_source);
3308 assert(!bus->output_io_event_source);
3309 assert(!bus->time_event_source);
3312 bus->event = sd_event_ref(event);
3314 r = sd_event_default(&bus->event);
3319 bus->event_priority = priority;
3321 r = sd_event_add_time(bus->event, &bus->time_event_source, CLOCK_MONOTONIC, 0, 0, time_callback, bus);
3325 r = sd_event_source_set_priority(bus->time_event_source, priority);
3329 r = sd_event_source_set_description(bus->time_event_source, "bus-time");
3333 r = sd_event_add_exit(bus->event, &bus->quit_event_source, quit_callback, bus);
3337 r = sd_event_source_set_description(bus->quit_event_source, "bus-exit");
3341 r = attach_io_events(bus);
3348 sd_bus_detach_event(bus);
3352 _public_ int sd_bus_detach_event(sd_bus *bus) {
3353 assert_return(bus, -EINVAL);
3358 detach_io_events(bus);
3360 if (bus->time_event_source) {
3361 sd_event_source_set_enabled(bus->time_event_source, SD_EVENT_OFF);
3362 bus->time_event_source = sd_event_source_unref(bus->time_event_source);
3365 if (bus->quit_event_source) {
3366 sd_event_source_set_enabled(bus->quit_event_source, SD_EVENT_OFF);
3367 bus->quit_event_source = sd_event_source_unref(bus->quit_event_source);
3370 bus->event = sd_event_unref(bus->event);
3374 _public_ sd_event* sd_bus_get_event(sd_bus *bus) {
3375 assert_return(bus, NULL);
3380 _public_ sd_bus_message* sd_bus_get_current_message(sd_bus *bus) {
3381 assert_return(bus, NULL);
3383 return bus->current_message;
3386 _public_ sd_bus_slot* sd_bus_get_current_slot(sd_bus *bus) {
3387 assert_return(bus, NULL);
3389 return bus->current_slot;
3392 _public_ sd_bus_message_handler_t sd_bus_get_current_handler(sd_bus *bus) {
3393 assert_return(bus, NULL);
3395 return bus->current_handler;
3398 _public_ void* sd_bus_get_current_userdata(sd_bus *bus) {
3399 assert_return(bus, NULL);
3401 return bus->current_userdata;
3404 static int bus_default(int (*bus_open)(sd_bus **), sd_bus **default_bus, sd_bus **ret) {
3409 assert(default_bus);
3412 return !!*default_bus;
3415 *ret = sd_bus_ref(*default_bus);
3423 b->default_bus_ptr = default_bus;
3431 _public_ int sd_bus_default_system(sd_bus **ret) {
3432 return bus_default(sd_bus_open_system, &default_system_bus, ret);
3436 _public_ int sd_bus_default_user(sd_bus **ret) {
3437 #if 0 /// elogind does not support user buses
3438 return bus_default(sd_bus_open_user, &default_user_bus, ret);
3440 return sd_bus_default_system(ret);
3444 _public_ int sd_bus_default(sd_bus **ret) {
3448 /* Let's try our best to reuse another cached connection. If
3449 * the starter bus type is set, connect via our normal
3450 * connection logic, ignoring $DBUS_STARTER_ADDRESS, so that
3451 * we can share the connection with the user/system default
3454 e = secure_getenv("DBUS_STARTER_BUS_TYPE");
3456 if (streq(e, "system"))
3457 return sd_bus_default_system(ret);
3458 #if 0 /// elogind does not support systemd units
3459 else if (STR_IN_SET(e, "user", "session"))
3460 return sd_bus_default_user(ret);
3464 /* No type is specified, so we have not other option than to
3465 * use the starter address if it is set. */
3467 e = secure_getenv("DBUS_STARTER_ADDRESS");
3470 return bus_default(sd_bus_open, &default_starter_bus, ret);
3473 /* Finally, if nothing is set use the cached connection for
3474 * the right scope */
3476 #if 0 /// elogind does not support systemd units
3477 if (cg_pid_get_owner_uid(0, NULL) >= 0)
3478 return sd_bus_default_user(ret);
3481 return sd_bus_default_system(ret);
3484 _public_ int sd_bus_get_tid(sd_bus *b, pid_t *tid) {
3485 assert_return(b, -EINVAL);
3486 assert_return(tid, -EINVAL);
3487 assert_return(!bus_pid_changed(b), -ECHILD);
3495 return sd_event_get_tid(b->event, tid);
3500 _public_ int sd_bus_path_encode(const char *prefix, const char *external_id, char **ret_path) {
3501 _cleanup_free_ char *e = NULL;
3504 assert_return(object_path_is_valid(prefix), -EINVAL);
3505 assert_return(external_id, -EINVAL);
3506 assert_return(ret_path, -EINVAL);
3508 e = bus_label_escape(external_id);
3512 ret = strjoin(prefix, "/", e);
3520 _public_ int sd_bus_path_decode(const char *path, const char *prefix, char **external_id) {
3524 assert_return(object_path_is_valid(path), -EINVAL);
3525 assert_return(object_path_is_valid(prefix), -EINVAL);
3526 assert_return(external_id, -EINVAL);
3528 e = object_path_startswith(path, prefix);
3530 *external_id = NULL;
3534 ret = bus_label_unescape(e);
3542 _public_ int sd_bus_path_encode_many(char **out, const char *path_template, ...) {
3543 _cleanup_strv_free_ char **labels = NULL;
3544 char *path, *path_pos, **label_pos;
3545 const char *sep, *template_pos;
3550 assert_return(out, -EINVAL);
3551 assert_return(path_template, -EINVAL);
3553 path_length = strlen(path_template);
3555 va_start(list, path_template);
3556 for (sep = strchr(path_template, '%'); sep; sep = strchr(sep + 1, '%')) {
3560 arg = va_arg(list, const char *);
3566 label = bus_label_escape(arg);
3572 r = strv_consume(&labels, label);
3578 /* add label length, but account for the format character */
3579 path_length += strlen(label) - 1;
3583 path = malloc(path_length + 1);
3590 for (template_pos = path_template; *template_pos; ) {
3591 sep = strchrnul(template_pos, '%');
3592 path_pos = mempcpy(path_pos, template_pos, sep - template_pos);
3596 path_pos = stpcpy(path_pos, *label_pos++);
3597 template_pos = sep + 1;
3605 _public_ int sd_bus_path_decode_many(const char *path, const char *path_template, ...) {
3606 _cleanup_strv_free_ char **labels = NULL;
3607 const char *template_pos, *path_pos;
3613 * This decodes an object-path based on a template argument. The
3614 * template consists of a verbatim path, optionally including special
3617 * - Each occurrence of '%' in the template matches an arbitrary
3618 * substring of a label in the given path. At most one such
3619 * directive is allowed per label. For each such directive, the
3620 * caller must provide an output parameter (char **) via va_arg. If
3621 * NULL is passed, the given label is verified, but not returned.
3622 * For each matched label, the *decoded* label is stored in the
3623 * passed output argument, and the caller is responsible to free
3624 * it. Note that the output arguments are only modified if the
3625 * actualy path matched the template. Otherwise, they're left
3628 * This function returns <0 on error, 0 if the path does not match the
3629 * template, 1 if it matched.
3632 assert_return(path, -EINVAL);
3633 assert_return(path_template, -EINVAL);
3637 for (template_pos = path_template; *template_pos; ) {
3642 /* verify everything until the next '%' matches verbatim */
3643 sep = strchrnul(template_pos, '%');
3644 length = sep - template_pos;
3645 if (strncmp(path_pos, template_pos, length))
3649 template_pos += length;
3654 /* We found the next '%' character. Everything up until here
3655 * matched. We now skip ahead to the end of this label and make
3656 * sure it matches the tail of the label in the path. Then we
3657 * decode the string in-between and save it for later use. */
3659 ++template_pos; /* skip over '%' */
3661 sep = strchrnul(template_pos, '/');
3662 length = sep - template_pos; /* length of suffix to match verbatim */
3664 /* verify the suffixes match */
3665 sep = strchrnul(path_pos, '/');
3666 if (sep - path_pos < (ssize_t)length ||
3667 strncmp(sep - length, template_pos, length))
3670 template_pos += length; /* skip over matched label */
3671 length = sep - path_pos - length; /* length of sub-label to decode */
3673 /* store unescaped label for later use */
3674 label = bus_label_unescape_n(path_pos, length);
3678 r = strv_consume(&labels, label);
3682 path_pos = sep; /* skip decoded label and suffix */
3685 /* end of template must match end of path */
3689 /* copy the labels over to the caller */
3690 va_start(list, path_template);
3691 for (label_pos = labels; label_pos && *label_pos; ++label_pos) {
3694 arg = va_arg(list, char **);
3707 _public_ int sd_bus_try_close(sd_bus *bus) {
3710 assert_return(bus, -EINVAL);
3711 assert_return(!bus_pid_changed(bus), -ECHILD);
3713 if (!bus->is_kernel)
3716 if (!BUS_IS_OPEN(bus->state))
3719 if (bus->rqueue_size > 0)
3722 if (bus->wqueue_size > 0)
3725 r = bus_kernel_try_close(bus);
3733 _public_ int sd_bus_get_description(sd_bus *bus, const char **description) {
3734 assert_return(bus, -EINVAL);
3735 assert_return(description, -EINVAL);
3736 assert_return(bus->description, -ENXIO);
3737 assert_return(!bus_pid_changed(bus), -ECHILD);
3739 *description = bus->description;
3743 int bus_get_root_path(sd_bus *bus) {
3746 if (bus->cgroup_root)
3749 r = cg_get_root_path(&bus->cgroup_root);
3751 bus->cgroup_root = strdup("/");
3752 if (!bus->cgroup_root)
3761 _public_ int sd_bus_get_scope(sd_bus *bus, const char **scope) {
3764 assert_return(bus, -EINVAL);
3765 assert_return(scope, -EINVAL);
3766 assert_return(!bus_pid_changed(bus), -ECHILD);
3768 if (bus->is_kernel) {
3769 _cleanup_free_ char *n = NULL;
3772 r = bus_kernel_get_bus_name(bus, &n);
3776 if (streq(n, "0-system")) {
3781 dash = strchr(n, '-');
3782 if (streq_ptr(dash, "-user")) {
3793 if (bus->is_system) {
3801 _public_ int sd_bus_get_address(sd_bus *bus, const char **address) {
3803 assert_return(bus, -EINVAL);
3804 assert_return(address, -EINVAL);
3805 assert_return(!bus_pid_changed(bus), -ECHILD);
3808 *address = bus->address;
3815 _public_ int sd_bus_get_creds_mask(sd_bus *bus, uint64_t *mask) {
3816 assert_return(bus, -EINVAL);
3817 assert_return(mask, -EINVAL);
3818 assert_return(!bus_pid_changed(bus), -ECHILD);
3820 *mask = bus->creds_mask;
3824 _public_ int sd_bus_is_bus_client(sd_bus *bus) {
3825 assert_return(bus, -EINVAL);
3826 assert_return(!bus_pid_changed(bus), -ECHILD);
3828 return bus->bus_client;
3831 _public_ int sd_bus_is_server(sd_bus *bus) {
3832 assert_return(bus, -EINVAL);
3833 assert_return(!bus_pid_changed(bus), -ECHILD);
3835 return bus->is_server;
3838 _public_ int sd_bus_is_anonymous(sd_bus *bus) {
3839 assert_return(bus, -EINVAL);
3840 assert_return(!bus_pid_changed(bus), -ECHILD);
3842 return bus->anonymous_auth;
3845 _public_ int sd_bus_is_trusted(sd_bus *bus) {
3846 assert_return(bus, -EINVAL);
3847 assert_return(!bus_pid_changed(bus), -ECHILD);
3849 return bus->trusted;
3852 _public_ int sd_bus_is_monitor(sd_bus *bus) {
3853 assert_return(bus, -EINVAL);
3854 assert_return(!bus_pid_changed(bus), -ECHILD);
3856 return !!(bus->hello_flags & KDBUS_HELLO_MONITOR);
3859 static void flush_close(sd_bus *bus) {
3863 /* Flushes and closes the specified bus. We take a ref before,
3864 * to ensure the flushing does not cause the bus to be
3867 sd_bus_flush_close_unref(sd_bus_ref(bus));
3870 _public_ void sd_bus_default_flush_close(void) {
3871 flush_close(default_starter_bus);
3872 #if 0 /// There is no user bus with elogind
3873 flush_close(default_user_bus);
3875 flush_close(default_system_bus);
3878 _public_ int sd_bus_set_exit_on_disconnect(sd_bus *bus, int b) {
3879 assert_return(bus, -EINVAL);
3881 /* Turns on exit-on-disconnect, and triggers it immediately if the bus connection was already
3882 * disconnected. Note that this is triggered exclusively on disconnections triggered by the server side, never
3883 * from the client side. */
3884 bus->exit_on_disconnect = b;
3886 /* If the exit condition was triggered already, exit immediately. */
3887 return bus_exit_now(bus);
3890 _public_ int sd_bus_get_exit_on_disconnect(sd_bus *bus) {
3891 assert_return(bus, -EINVAL);
3893 return bus->exit_on_disconnect;