1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2013 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
39 #include "bus-internal.h"
40 #include "bus-message.h"
42 #include "bus-socket.h"
43 #include "bus-kernel.h"
44 #include "bus-control.h"
45 #include "bus-introspect.h"
46 #include "bus-signature.h"
47 #include "bus-objects.h"
49 #include "bus-container.h"
51 static int bus_poll(sd_bus *bus, bool need_more, uint64_t timeout_usec);
53 static void bus_close_fds(sd_bus *b) {
57 close_nointr_nofail(b->input_fd);
59 if (b->output_fd >= 0 && b->output_fd != b->input_fd)
60 close_nointr_nofail(b->output_fd);
62 b->input_fd = b->output_fd = -1;
65 static void bus_node_destroy(sd_bus *b, struct node *n) {
66 struct node_callback *c;
67 struct node_vtable *v;
68 struct node_enumerator *e;
76 bus_node_destroy(b, n->child);
78 while ((c = n->callbacks)) {
79 LIST_REMOVE(callbacks, n->callbacks, c);
83 while ((v = n->vtables)) {
84 LIST_REMOVE(vtables, n->vtables, v);
89 while ((e = n->enumerators)) {
90 LIST_REMOVE(enumerators, n->enumerators, e);
95 LIST_REMOVE(siblings, n->parent->child, n);
97 assert_se(hashmap_remove(b->nodes, n->path) == n);
102 static void bus_free(sd_bus *b) {
103 struct filter_callback *f;
109 sd_bus_detach_event(b);
114 munmap(b->kdbus_buffer, KDBUS_POOL_SIZE);
117 free(b->unique_name);
118 free(b->auth_buffer);
124 strv_free(b->exec_argv);
126 close_many(b->fds, b->n_fds);
129 for (i = 0; i < b->rqueue_size; i++)
130 sd_bus_message_unref(b->rqueue[i]);
133 for (i = 0; i < b->wqueue_size; i++)
134 sd_bus_message_unref(b->wqueue[i]);
137 hashmap_free_free(b->reply_callbacks);
138 prioq_free(b->reply_callbacks_prioq);
140 while ((f = b->filter_callbacks)) {
141 LIST_REMOVE(callbacks, b->filter_callbacks, f);
145 bus_match_free(&b->match_callbacks);
147 hashmap_free_free(b->vtable_methods);
148 hashmap_free_free(b->vtable_properties);
150 while ((n = hashmap_first(b->nodes)))
151 bus_node_destroy(b, n);
153 hashmap_free(b->nodes);
155 bus_kernel_flush_memfd(b);
157 assert_se(pthread_mutex_destroy(&b->memfd_cache_mutex) == 0);
162 int sd_bus_new(sd_bus **ret) {
165 assert_return(ret, -EINVAL);
171 r->n_ref = REFCNT_INIT;
172 r->input_fd = r->output_fd = -1;
173 r->message_version = 1;
174 r->hello_flags |= KDBUS_HELLO_ACCEPT_FD;
175 r->original_pid = getpid();
177 assert_se(pthread_mutex_init(&r->memfd_cache_mutex, NULL) == 0);
179 /* We guarantee that wqueue always has space for at least one
181 r->wqueue = new(sd_bus_message*, 1);
191 int sd_bus_set_address(sd_bus *bus, const char *address) {
194 assert_return(bus, -EINVAL);
195 assert_return(bus->state == BUS_UNSET, -EPERM);
196 assert_return(address, -EINVAL);
197 assert_return(!bus_pid_changed(bus), -ECHILD);
209 int sd_bus_set_fd(sd_bus *bus, int input_fd, int output_fd) {
210 assert_return(bus, -EINVAL);
211 assert_return(bus->state == BUS_UNSET, -EPERM);
212 assert_return(input_fd >= 0, -EINVAL);
213 assert_return(output_fd >= 0, -EINVAL);
214 assert_return(!bus_pid_changed(bus), -ECHILD);
216 bus->input_fd = input_fd;
217 bus->output_fd = output_fd;
221 int sd_bus_set_exec(sd_bus *bus, const char *path, char *const argv[]) {
224 assert_return(bus, -EINVAL);
225 assert_return(bus->state == BUS_UNSET, -EPERM);
226 assert_return(path, -EINVAL);
227 assert_return(!strv_isempty(argv), -EINVAL);
228 assert_return(!bus_pid_changed(bus), -ECHILD);
240 free(bus->exec_path);
241 strv_free(bus->exec_argv);
249 int sd_bus_set_bus_client(sd_bus *bus, int b) {
250 assert_return(bus, -EINVAL);
251 assert_return(bus->state == BUS_UNSET, -EPERM);
252 assert_return(!bus_pid_changed(bus), -ECHILD);
254 bus->bus_client = !!b;
258 int sd_bus_negotiate_fds(sd_bus *bus, int b) {
259 assert_return(bus, -EINVAL);
260 assert_return(bus->state == BUS_UNSET, -EPERM);
261 assert_return(!bus_pid_changed(bus), -ECHILD);
263 SET_FLAG(bus->hello_flags, KDBUS_HELLO_ACCEPT_FD, b);
267 int sd_bus_negotiate_attach_comm(sd_bus *bus, int b) {
268 assert_return(bus, -EINVAL);
269 assert_return(bus->state == BUS_UNSET, -EPERM);
270 assert_return(!bus_pid_changed(bus), -ECHILD);
272 SET_FLAG(bus->hello_flags, KDBUS_HELLO_ATTACH_COMM, b);
276 int sd_bus_negotiate_attach_exe(sd_bus *bus, int b) {
277 assert_return(bus, -EINVAL);
278 assert_return(bus->state == BUS_UNSET, -EPERM);
279 assert_return(!bus_pid_changed(bus), -ECHILD);
281 SET_FLAG(bus->hello_flags, KDBUS_HELLO_ATTACH_EXE, b);
285 int sd_bus_negotiate_attach_cmdline(sd_bus *bus, int b) {
286 assert_return(bus, -EINVAL);
287 assert_return(bus->state == BUS_UNSET, -EPERM);
288 assert_return(!bus_pid_changed(bus), -ECHILD);
290 SET_FLAG(bus->hello_flags, KDBUS_HELLO_ATTACH_CMDLINE, b);
294 int sd_bus_negotiate_attach_cgroup(sd_bus *bus, int b) {
295 assert_return(bus, -EINVAL);
296 assert_return(bus->state == BUS_UNSET, -EPERM);
297 assert_return(!bus_pid_changed(bus), -ECHILD);
299 SET_FLAG(bus->hello_flags, KDBUS_HELLO_ATTACH_CGROUP, b);
303 int sd_bus_negotiate_attach_caps(sd_bus *bus, int b) {
304 assert_return(bus, -EINVAL);
305 assert_return(bus->state == BUS_UNSET, -EPERM);
306 assert_return(!bus_pid_changed(bus), -ECHILD);
308 SET_FLAG(bus->hello_flags, KDBUS_HELLO_ATTACH_CAPS, b);
312 int sd_bus_negotiate_attach_selinux_context(sd_bus *bus, int b) {
313 assert_return(bus, -EINVAL);
314 assert_return(bus->state == BUS_UNSET, -EPERM);
315 assert_return(!bus_pid_changed(bus), -ECHILD);
317 SET_FLAG(bus->hello_flags, KDBUS_HELLO_ATTACH_SECLABEL, b);
321 int sd_bus_negotiate_attach_audit(sd_bus *bus, int b) {
322 assert_return(bus, -EINVAL);
323 assert_return(bus->state == BUS_UNSET, -EPERM);
324 assert_return(!bus_pid_changed(bus), -ECHILD);
326 SET_FLAG(bus->hello_flags, KDBUS_HELLO_ATTACH_AUDIT, b);
330 int sd_bus_set_server(sd_bus *bus, int b, sd_id128_t server_id) {
331 assert_return(bus, -EINVAL);
332 assert_return(b || sd_id128_equal(server_id, SD_ID128_NULL), -EINVAL);
333 assert_return(bus->state == BUS_UNSET, -EPERM);
334 assert_return(!bus_pid_changed(bus), -ECHILD);
336 bus->is_server = !!b;
337 bus->server_id = server_id;
341 int sd_bus_set_anonymous(sd_bus *bus, int b) {
342 assert_return(bus, -EINVAL);
343 assert_return(bus->state == BUS_UNSET, -EPERM);
344 assert_return(!bus_pid_changed(bus), -ECHILD);
346 bus->anonymous_auth = !!b;
350 static int hello_callback(sd_bus *bus, sd_bus_message *reply, void *userdata) {
355 assert(bus->state == BUS_HELLO);
358 r = sd_bus_message_get_errno(reply);
364 r = sd_bus_message_read(reply, "s", &s);
368 if (!service_name_is_valid(s) || s[0] != ':')
371 bus->unique_name = strdup(s);
372 if (!bus->unique_name)
375 bus->state = BUS_RUNNING;
380 static int bus_send_hello(sd_bus *bus) {
381 _cleanup_bus_message_unref_ sd_bus_message *m = NULL;
386 if (!bus->bus_client || bus->is_kernel)
389 r = sd_bus_message_new_method_call(
391 "org.freedesktop.DBus",
393 "org.freedesktop.DBus",
399 return sd_bus_send_with_reply(bus, m, hello_callback, NULL, 0, &bus->hello_serial);
402 int bus_start_running(sd_bus *bus) {
405 if (bus->bus_client && !bus->is_kernel) {
406 bus->state = BUS_HELLO;
410 bus->state = BUS_RUNNING;
414 static int parse_address_key(const char **p, const char *key, char **value) {
425 if (strncmp(*p, key, l) != 0)
438 while (*a != ';' && *a != ',' && *a != 0) {
456 c = (char) ((x << 4) | y);
463 t = realloc(r, n + 2);
491 static void skip_address_key(const char **p) {
495 *p += strcspn(*p, ",");
501 static int parse_unix_address(sd_bus *b, const char **p, char **guid) {
502 _cleanup_free_ char *path = NULL, *abstract = NULL;
511 while (**p != 0 && **p != ';') {
512 r = parse_address_key(p, "guid", guid);
518 r = parse_address_key(p, "path", &path);
524 r = parse_address_key(p, "abstract", &abstract);
533 if (!path && !abstract)
536 if (path && abstract)
541 if (l > sizeof(b->sockaddr.un.sun_path))
544 b->sockaddr.un.sun_family = AF_UNIX;
545 strncpy(b->sockaddr.un.sun_path, path, sizeof(b->sockaddr.un.sun_path));
546 b->sockaddr_size = offsetof(struct sockaddr_un, sun_path) + l;
547 } else if (abstract) {
548 l = strlen(abstract);
549 if (l > sizeof(b->sockaddr.un.sun_path) - 1)
552 b->sockaddr.un.sun_family = AF_UNIX;
553 b->sockaddr.un.sun_path[0] = 0;
554 strncpy(b->sockaddr.un.sun_path+1, abstract, sizeof(b->sockaddr.un.sun_path)-1);
555 b->sockaddr_size = offsetof(struct sockaddr_un, sun_path) + 1 + l;
561 static int parse_tcp_address(sd_bus *b, const char **p, char **guid) {
562 _cleanup_free_ char *host = NULL, *port = NULL, *family = NULL;
564 struct addrinfo *result, hints = {
565 .ai_socktype = SOCK_STREAM,
566 .ai_flags = AI_ADDRCONFIG,
574 while (**p != 0 && **p != ';') {
575 r = parse_address_key(p, "guid", guid);
581 r = parse_address_key(p, "host", &host);
587 r = parse_address_key(p, "port", &port);
593 r = parse_address_key(p, "family", &family);
606 if (streq(family, "ipv4"))
607 hints.ai_family = AF_INET;
608 else if (streq(family, "ipv6"))
609 hints.ai_family = AF_INET6;
614 r = getaddrinfo(host, port, &hints, &result);
618 return -EADDRNOTAVAIL;
620 memcpy(&b->sockaddr, result->ai_addr, result->ai_addrlen);
621 b->sockaddr_size = result->ai_addrlen;
623 freeaddrinfo(result);
628 static int parse_exec_address(sd_bus *b, const char **p, char **guid) {
630 unsigned n_argv = 0, j;
639 while (**p != 0 && **p != ';') {
640 r = parse_address_key(p, "guid", guid);
646 r = parse_address_key(p, "path", &path);
652 if (startswith(*p, "argv")) {
656 ul = strtoul(*p + 4, (char**) p, 10);
657 if (errno > 0 || **p != '=' || ul > 256) {
667 x = realloc(argv, sizeof(char*) * (ul + 2));
673 memset(x + n_argv, 0, sizeof(char*) * (ul - n_argv + 2));
679 r = parse_address_key(p, NULL, argv + ul);
694 /* Make sure there are no holes in the array, with the
695 * exception of argv[0] */
696 for (j = 1; j < n_argv; j++)
702 if (argv && argv[0] == NULL) {
703 argv[0] = strdup(path);
715 for (j = 0; j < n_argv; j++)
723 static int parse_kernel_address(sd_bus *b, const char **p, char **guid) {
724 _cleanup_free_ char *path = NULL;
732 while (**p != 0 && **p != ';') {
733 r = parse_address_key(p, "guid", guid);
739 r = parse_address_key(p, "path", &path);
758 static int parse_container_address(sd_bus *b, const char **p, char **guid) {
759 _cleanup_free_ char *machine = NULL;
767 while (**p != 0 && **p != ';') {
768 r = parse_address_key(p, "guid", guid);
774 r = parse_address_key(p, "machine", &machine);
787 b->machine = machine;
790 b->sockaddr.un.sun_family = AF_UNIX;
791 strncpy(b->sockaddr.un.sun_path, "/var/run/dbus/system_bus_socket", sizeof(b->sockaddr.un.sun_path));
792 b->sockaddr_size = offsetof(struct sockaddr_un, sun_path) + sizeof("/var/run/dbus/system_bus_socket") - 1;
797 static void bus_reset_parsed_address(sd_bus *b) {
801 b->sockaddr_size = 0;
802 strv_free(b->exec_argv);
806 b->server_id = SD_ID128_NULL;
813 static int bus_parse_next_address(sd_bus *b) {
814 _cleanup_free_ char *guid = NULL;
822 if (b->address[b->address_index] == 0)
825 bus_reset_parsed_address(b);
827 a = b->address + b->address_index;
836 if (startswith(a, "unix:")) {
839 r = parse_unix_address(b, &a, &guid);
844 } else if (startswith(a, "tcp:")) {
847 r = parse_tcp_address(b, &a, &guid);
853 } else if (startswith(a, "unixexec:")) {
856 r = parse_exec_address(b, &a, &guid);
862 } else if (startswith(a, "kernel:")) {
865 r = parse_kernel_address(b, &a, &guid);
870 } else if (startswith(a, "x-container:")) {
873 r = parse_container_address(b, &a, &guid);
886 r = sd_id128_from_string(guid, &b->server_id);
891 b->address_index = a - b->address;
895 static int bus_start_address(sd_bus *b) {
905 r = bus_socket_exec(b);
909 b->last_connect_error = -r;
910 } else if (b->kernel) {
912 r = bus_kernel_connect(b);
916 b->last_connect_error = -r;
918 } else if (b->machine) {
920 r = bus_container_connect(b);
924 b->last_connect_error = -r;
926 } else if (b->sockaddr.sa.sa_family != AF_UNSPEC) {
928 r = bus_socket_connect(b);
932 b->last_connect_error = -r;
935 r = bus_parse_next_address(b);
939 return b->last_connect_error ? -b->last_connect_error : -ECONNREFUSED;
943 int bus_next_address(sd_bus *b) {
946 bus_reset_parsed_address(b);
947 return bus_start_address(b);
950 static int bus_start_fd(sd_bus *b) {
955 assert(b->input_fd >= 0);
956 assert(b->output_fd >= 0);
958 r = fd_nonblock(b->input_fd, true);
962 r = fd_cloexec(b->input_fd, true);
966 if (b->input_fd != b->output_fd) {
967 r = fd_nonblock(b->output_fd, true);
971 r = fd_cloexec(b->output_fd, true);
976 if (fstat(b->input_fd, &st) < 0)
979 if (S_ISCHR(b->input_fd))
980 return bus_kernel_take_fd(b);
982 return bus_socket_take_fd(b);
985 int sd_bus_start(sd_bus *bus) {
988 assert_return(bus, -EINVAL);
989 assert_return(bus->state == BUS_UNSET, -EPERM);
990 assert_return(!bus_pid_changed(bus), -ECHILD);
992 bus->state = BUS_OPENING;
994 if (bus->is_server && bus->bus_client)
997 if (bus->input_fd >= 0)
998 r = bus_start_fd(bus);
999 else if (bus->address || bus->sockaddr.sa.sa_family != AF_UNSPEC || bus->exec_path || bus->kernel || bus->machine)
1000 r = bus_start_address(bus);
1007 return bus_send_hello(bus);
1010 int sd_bus_open_system(sd_bus **ret) {
1015 assert_return(ret, -EINVAL);
1021 e = secure_getenv("DBUS_SYSTEM_BUS_ADDRESS");
1023 r = sd_bus_set_address(b, e);
1027 b->sockaddr.un.sun_family = AF_UNIX;
1028 strncpy(b->sockaddr.un.sun_path, "/run/dbus/system_bus_socket", sizeof(b->sockaddr.un.sun_path));
1029 b->sockaddr_size = offsetof(struct sockaddr_un, sun_path) + sizeof("/run/dbus/system_bus_socket") - 1;
1032 b->bus_client = true;
1034 r = sd_bus_start(b);
1046 int sd_bus_open_user(sd_bus **ret) {
1052 assert_return(ret, -EINVAL);
1058 e = secure_getenv("DBUS_SESSION_BUS_ADDRESS");
1060 r = sd_bus_set_address(b, e);
1064 e = secure_getenv("XDG_RUNTIME_DIR");
1071 if (l + 4 > sizeof(b->sockaddr.un.sun_path)) {
1076 b->sockaddr.un.sun_family = AF_UNIX;
1077 memcpy(mempcpy(b->sockaddr.un.sun_path, e, l), "/bus", 4);
1078 b->sockaddr_size = offsetof(struct sockaddr_un, sun_path) + l + 4;
1081 b->bus_client = true;
1083 r = sd_bus_start(b);
1095 int sd_bus_open_system_remote(const char *host, sd_bus **ret) {
1096 _cleanup_free_ char *e = NULL;
1101 assert_return(host, -EINVAL);
1102 assert_return(ret, -EINVAL);
1104 e = bus_address_escape(host);
1108 p = strjoin("unixexec:path=ssh,argv1=-xT,argv2=", e, ",argv3=systemd-stdio-bridge", NULL);
1112 r = sd_bus_new(&bus);
1119 bus->bus_client = true;
1121 r = sd_bus_start(bus);
1131 int sd_bus_open_system_container(const char *machine, sd_bus **ret) {
1132 _cleanup_free_ char *e = NULL;
1137 assert_return(machine, -EINVAL);
1138 assert_return(ret, -EINVAL);
1140 e = bus_address_escape(machine);
1144 p = strjoin("x-container:machine=", e, NULL);
1148 r = sd_bus_new(&bus);
1155 bus->bus_client = true;
1157 r = sd_bus_start(bus);
1167 void sd_bus_close(sd_bus *bus) {
1170 if (bus->state == BUS_CLOSED)
1172 if (bus_pid_changed(bus))
1175 bus->state = BUS_CLOSED;
1177 sd_bus_detach_event(bus);
1179 if (!bus->is_kernel)
1182 /* We'll leave the fd open in case this is a kernel bus, since
1183 * there might still be memblocks around that reference this
1184 * bus, and they might need to invoke the
1185 * KDBUS_CMD_MSG_RELEASE ioctl on the fd when they are
1189 sd_bus *sd_bus_ref(sd_bus *bus) {
1193 assert_se(REFCNT_INC(bus->n_ref) >= 2);
1198 sd_bus *sd_bus_unref(sd_bus *bus) {
1202 if (REFCNT_DEC(bus->n_ref) <= 0)
1208 int sd_bus_is_open(sd_bus *bus) {
1210 assert_return(bus, -EINVAL);
1211 assert_return(!bus_pid_changed(bus), -ECHILD);
1213 return BUS_IS_OPEN(bus->state);
1216 int sd_bus_can_send(sd_bus *bus, char type) {
1219 assert_return(bus, -EINVAL);
1220 assert_return(bus->state != BUS_UNSET, -ENOTCONN);
1221 assert_return(!bus_pid_changed(bus), -ECHILD);
1223 if (type == SD_BUS_TYPE_UNIX_FD) {
1224 if (!(bus->hello_flags & KDBUS_HELLO_ACCEPT_FD))
1227 r = bus_ensure_running(bus);
1231 return bus->can_fds;
1234 return bus_type_is_valid(type);
1237 int sd_bus_get_server_id(sd_bus *bus, sd_id128_t *server_id) {
1240 assert_return(bus, -EINVAL);
1241 assert_return(server_id, -EINVAL);
1242 assert_return(!bus_pid_changed(bus), -ECHILD);
1244 r = bus_ensure_running(bus);
1248 *server_id = bus->server_id;
1252 static int bus_seal_message(sd_bus *b, sd_bus_message *m) {
1255 if (m->header->version > b->message_version)
1261 return bus_message_seal(m, ++b->serial);
1264 static int dispatch_wqueue(sd_bus *bus) {
1268 assert(bus->state == BUS_RUNNING || bus->state == BUS_HELLO);
1270 while (bus->wqueue_size > 0) {
1273 r = bus_kernel_write_message(bus, bus->wqueue[0]);
1275 r = bus_socket_write_message(bus, bus->wqueue[0], &bus->windex);
1281 /* Didn't do anything this time */
1283 else if (bus->is_kernel || bus->windex >= BUS_MESSAGE_SIZE(bus->wqueue[0])) {
1284 /* Fully written. Let's drop the entry from
1287 * This isn't particularly optimized, but
1288 * well, this is supposed to be our worst-case
1289 * buffer only, and the socket buffer is
1290 * supposed to be our primary buffer, and if
1291 * it got full, then all bets are off
1294 sd_bus_message_unref(bus->wqueue[0]);
1295 bus->wqueue_size --;
1296 memmove(bus->wqueue, bus->wqueue + 1, sizeof(sd_bus_message*) * bus->wqueue_size);
1306 static int dispatch_rqueue(sd_bus *bus, sd_bus_message **m) {
1307 sd_bus_message *z = NULL;
1312 assert(bus->state == BUS_RUNNING || bus->state == BUS_HELLO);
1314 if (bus->rqueue_size > 0) {
1315 /* Dispatch a queued message */
1317 *m = bus->rqueue[0];
1318 bus->rqueue_size --;
1319 memmove(bus->rqueue, bus->rqueue + 1, sizeof(sd_bus_message*) * bus->rqueue_size);
1323 /* Try to read a new message */
1326 r = bus_kernel_read_message(bus, &z);
1328 r = bus_socket_read_message(bus, &z);
1344 int sd_bus_send(sd_bus *bus, sd_bus_message *m, uint64_t *serial) {
1347 assert_return(bus, -EINVAL);
1348 assert_return(BUS_IS_OPEN(bus->state), -ENOTCONN);
1349 assert_return(m, -EINVAL);
1350 assert_return(!bus_pid_changed(bus), -ECHILD);
1353 r = sd_bus_can_send(bus, SD_BUS_TYPE_UNIX_FD);
1360 /* If the serial number isn't kept, then we know that no reply
1362 if (!serial && !m->sealed)
1363 m->header->flags |= SD_BUS_MESSAGE_NO_REPLY_EXPECTED;
1365 r = bus_seal_message(bus, m);
1369 /* If this is a reply and no reply was requested, then let's
1370 * suppress this, if we can */
1371 if (m->dont_send && !serial)
1374 if ((bus->state == BUS_RUNNING || bus->state == BUS_HELLO) && bus->wqueue_size <= 0) {
1378 r = bus_kernel_write_message(bus, m);
1380 r = bus_socket_write_message(bus, m, &idx);
1385 } else if (!bus->is_kernel && idx < BUS_MESSAGE_SIZE(m)) {
1386 /* Wasn't fully written. So let's remember how
1387 * much was written. Note that the first entry
1388 * of the wqueue array is always allocated so
1389 * that we always can remember how much was
1391 bus->wqueue[0] = sd_bus_message_ref(m);
1392 bus->wqueue_size = 1;
1398 /* Just append it to the queue. */
1400 if (bus->wqueue_size >= BUS_WQUEUE_MAX)
1403 q = realloc(bus->wqueue, sizeof(sd_bus_message*) * (bus->wqueue_size + 1));
1408 q[bus->wqueue_size ++] = sd_bus_message_ref(m);
1412 *serial = BUS_MESSAGE_SERIAL(m);
1417 static usec_t calc_elapse(uint64_t usec) {
1418 if (usec == (uint64_t) -1)
1422 usec = BUS_DEFAULT_TIMEOUT;
1424 return now(CLOCK_MONOTONIC) + usec;
1427 static int timeout_compare(const void *a, const void *b) {
1428 const struct reply_callback *x = a, *y = b;
1430 if (x->timeout != 0 && y->timeout == 0)
1433 if (x->timeout == 0 && y->timeout != 0)
1436 if (x->timeout < y->timeout)
1439 if (x->timeout > y->timeout)
1445 int sd_bus_send_with_reply(
1448 sd_bus_message_handler_t callback,
1453 struct reply_callback *c;
1456 assert_return(bus, -EINVAL);
1457 assert_return(BUS_IS_OPEN(bus->state), -ENOTCONN);
1458 assert_return(m, -EINVAL);
1459 assert_return(m->header->type == SD_BUS_MESSAGE_METHOD_CALL, -EINVAL);
1460 assert_return(!(m->header->flags & SD_BUS_MESSAGE_NO_REPLY_EXPECTED), -EINVAL);
1461 assert_return(callback, -EINVAL);
1462 assert_return(!bus_pid_changed(bus), -ECHILD);
1464 r = hashmap_ensure_allocated(&bus->reply_callbacks, uint64_hash_func, uint64_compare_func);
1468 if (usec != (uint64_t) -1) {
1469 r = prioq_ensure_allocated(&bus->reply_callbacks_prioq, timeout_compare);
1474 r = bus_seal_message(bus, m);
1478 c = new0(struct reply_callback, 1);
1482 c->callback = callback;
1483 c->userdata = userdata;
1484 c->serial = BUS_MESSAGE_SERIAL(m);
1485 c->timeout = calc_elapse(usec);
1487 r = hashmap_put(bus->reply_callbacks, &c->serial, c);
1493 if (c->timeout != 0) {
1494 r = prioq_put(bus->reply_callbacks_prioq, c, &c->prioq_idx);
1497 sd_bus_send_with_reply_cancel(bus, c->serial);
1502 r = sd_bus_send(bus, m, serial);
1504 sd_bus_send_with_reply_cancel(bus, c->serial);
1511 int sd_bus_send_with_reply_cancel(sd_bus *bus, uint64_t serial) {
1512 struct reply_callback *c;
1514 assert_return(bus, -EINVAL);
1515 assert_return(serial != 0, -EINVAL);
1516 assert_return(!bus_pid_changed(bus), -ECHILD);
1518 c = hashmap_remove(bus->reply_callbacks, &serial);
1522 if (c->timeout != 0)
1523 prioq_remove(bus->reply_callbacks_prioq, c, &c->prioq_idx);
1529 int bus_ensure_running(sd_bus *bus) {
1534 if (bus->state == BUS_UNSET || bus->state == BUS_CLOSED)
1536 if (bus->state == BUS_RUNNING)
1540 r = sd_bus_process(bus, NULL);
1543 if (bus->state == BUS_RUNNING)
1548 r = sd_bus_wait(bus, (uint64_t) -1);
1554 int sd_bus_send_with_reply_and_block(
1558 sd_bus_error *error,
1559 sd_bus_message **reply) {
1566 assert_return(bus, -EINVAL);
1567 assert_return(BUS_IS_OPEN(bus->state), -ENOTCONN);
1568 assert_return(m, -EINVAL);
1569 assert_return(m->header->type == SD_BUS_MESSAGE_METHOD_CALL, -EINVAL);
1570 assert_return(!(m->header->flags & SD_BUS_MESSAGE_NO_REPLY_EXPECTED), -EINVAL);
1571 assert_return(!bus_error_is_dirty(error), -EINVAL);
1572 assert_return(!bus_pid_changed(bus), -ECHILD);
1574 r = bus_ensure_running(bus);
1578 r = sd_bus_send(bus, m, &serial);
1582 timeout = calc_elapse(usec);
1586 sd_bus_message *incoming = NULL;
1591 if (bus->rqueue_size >= BUS_RQUEUE_MAX)
1594 /* Make sure there's room for queuing this
1595 * locally, before we read the message */
1597 q = realloc(bus->rqueue, (bus->rqueue_size + 1) * sizeof(sd_bus_message*));
1606 r = bus_kernel_read_message(bus, &incoming);
1608 r = bus_socket_read_message(bus, &incoming);
1613 if (incoming->reply_serial == serial) {
1614 /* Found a match! */
1616 if (incoming->header->type == SD_BUS_MESSAGE_METHOD_RETURN) {
1621 sd_bus_message_unref(incoming);
1626 if (incoming->header->type == SD_BUS_MESSAGE_METHOD_ERROR) {
1629 r = sd_bus_error_copy(error, &incoming->error);
1631 sd_bus_message_unref(incoming);
1635 k = sd_bus_error_get_errno(&incoming->error);
1636 sd_bus_message_unref(incoming);
1640 sd_bus_message_unref(incoming);
1644 /* There's already guaranteed to be room for
1645 * this, so need to resize things here */
1646 bus->rqueue[bus->rqueue_size ++] = incoming;
1649 /* Try to read more, right-away */
1658 n = now(CLOCK_MONOTONIC);
1664 left = (uint64_t) -1;
1666 r = bus_poll(bus, true, left);
1670 r = dispatch_wqueue(bus);
1676 int sd_bus_get_fd(sd_bus *bus) {
1678 assert_return(bus, -EINVAL);
1679 assert_return(BUS_IS_OPEN(bus->state), -ENOTCONN);
1680 assert_return(bus->input_fd == bus->output_fd, -EPERM);
1681 assert_return(!bus_pid_changed(bus), -ECHILD);
1683 return bus->input_fd;
1686 int sd_bus_get_events(sd_bus *bus) {
1689 assert_return(bus, -EINVAL);
1690 assert_return(BUS_IS_OPEN(bus->state), -ENOTCONN);
1691 assert_return(!bus_pid_changed(bus), -ECHILD);
1693 if (bus->state == BUS_OPENING)
1695 else if (bus->state == BUS_AUTHENTICATING) {
1697 if (bus_socket_auth_needs_write(bus))
1702 } else if (bus->state == BUS_RUNNING || bus->state == BUS_HELLO) {
1703 if (bus->rqueue_size <= 0)
1705 if (bus->wqueue_size > 0)
1712 int sd_bus_get_timeout(sd_bus *bus, uint64_t *timeout_usec) {
1713 struct reply_callback *c;
1715 assert_return(bus, -EINVAL);
1716 assert_return(timeout_usec, -EINVAL);
1717 assert_return(BUS_IS_OPEN(bus->state), -ENOTCONN);
1718 assert_return(!bus_pid_changed(bus), -ECHILD);
1720 if (bus->state == BUS_AUTHENTICATING) {
1721 *timeout_usec = bus->auth_timeout;
1725 if (bus->state != BUS_RUNNING && bus->state != BUS_HELLO) {
1726 *timeout_usec = (uint64_t) -1;
1730 if (bus->rqueue_size > 0) {
1735 c = prioq_peek(bus->reply_callbacks_prioq);
1737 *timeout_usec = (uint64_t) -1;
1741 *timeout_usec = c->timeout;
1745 static int process_timeout(sd_bus *bus) {
1746 _cleanup_bus_message_unref_ sd_bus_message* m = NULL;
1747 struct reply_callback *c;
1753 c = prioq_peek(bus->reply_callbacks_prioq);
1757 n = now(CLOCK_MONOTONIC);
1761 r = bus_message_new_synthetic_error(
1764 &SD_BUS_ERROR_MAKE(SD_BUS_ERROR_NO_REPLY, "Method call timed out"),
1769 assert_se(prioq_pop(bus->reply_callbacks_prioq) == c);
1770 hashmap_remove(bus->reply_callbacks, &c->serial);
1772 r = c->callback(bus, m, c->userdata);
1775 return r < 0 ? r : 1;
1778 static int process_hello(sd_bus *bus, sd_bus_message *m) {
1782 if (bus->state != BUS_HELLO)
1785 /* Let's make sure the first message on the bus is the HELLO
1786 * reply. But note that we don't actually parse the message
1787 * here (we leave that to the usual handling), we just verify
1788 * we don't let any earlier msg through. */
1790 if (m->header->type != SD_BUS_MESSAGE_METHOD_RETURN &&
1791 m->header->type != SD_BUS_MESSAGE_METHOD_ERROR)
1794 if (m->reply_serial != bus->hello_serial)
1800 static int process_reply(sd_bus *bus, sd_bus_message *m) {
1801 struct reply_callback *c;
1807 if (m->header->type != SD_BUS_MESSAGE_METHOD_RETURN &&
1808 m->header->type != SD_BUS_MESSAGE_METHOD_ERROR)
1811 c = hashmap_remove(bus->reply_callbacks, &m->reply_serial);
1815 if (c->timeout != 0)
1816 prioq_remove(bus->reply_callbacks_prioq, c, &c->prioq_idx);
1818 r = sd_bus_message_rewind(m, true);
1822 r = c->callback(bus, m, c->userdata);
1828 static int process_filter(sd_bus *bus, sd_bus_message *m) {
1829 struct filter_callback *l;
1836 bus->filter_callbacks_modified = false;
1838 LIST_FOREACH(callbacks, l, bus->filter_callbacks) {
1840 if (bus->filter_callbacks_modified)
1843 /* Don't run this more than once per iteration */
1844 if (l->last_iteration == bus->iteration_counter)
1847 l->last_iteration = bus->iteration_counter;
1849 r = sd_bus_message_rewind(m, true);
1853 r = l->callback(bus, m, l->userdata);
1859 } while (bus->filter_callbacks_modified);
1864 static int process_match(sd_bus *bus, sd_bus_message *m) {
1871 bus->match_callbacks_modified = false;
1873 r = bus_match_run(bus, &bus->match_callbacks, m);
1877 } while (bus->match_callbacks_modified);
1882 static int process_builtin(sd_bus *bus, sd_bus_message *m) {
1883 _cleanup_bus_message_unref_ sd_bus_message *reply = NULL;
1889 if (m->header->type != SD_BUS_MESSAGE_METHOD_CALL)
1892 if (!streq_ptr(m->interface, "org.freedesktop.DBus.Peer"))
1895 if (m->header->flags & SD_BUS_MESSAGE_NO_REPLY_EXPECTED)
1898 if (streq_ptr(m->member, "Ping"))
1899 r = sd_bus_message_new_method_return(bus, m, &reply);
1900 else if (streq_ptr(m->member, "GetMachineId")) {
1904 r = sd_id128_get_machine(&id);
1908 r = sd_bus_message_new_method_return(bus, m, &reply);
1912 r = sd_bus_message_append(reply, "s", sd_id128_to_string(id, sid));
1914 r = sd_bus_message_new_method_errorf(
1916 SD_BUS_ERROR_UNKNOWN_METHOD,
1917 "Unknown method '%s' on interface '%s'.", m->member, m->interface);
1923 r = sd_bus_send(bus, reply, NULL);
1930 static int process_message(sd_bus *bus, sd_bus_message *m) {
1936 bus->iteration_counter++;
1938 log_debug("Got message sender=%s object=%s interface=%s member=%s",
1939 strna(sd_bus_message_get_sender(m)),
1940 strna(sd_bus_message_get_path(m)),
1941 strna(sd_bus_message_get_interface(m)),
1942 strna(sd_bus_message_get_member(m)));
1944 r = process_hello(bus, m);
1948 r = process_reply(bus, m);
1952 r = process_filter(bus, m);
1956 r = process_match(bus, m);
1960 r = process_builtin(bus, m);
1964 return bus_process_object(bus, m);
1967 static int process_running(sd_bus *bus, sd_bus_message **ret) {
1968 _cleanup_bus_message_unref_ sd_bus_message *m = NULL;
1972 assert(bus->state == BUS_RUNNING || bus->state == BUS_HELLO);
1974 r = process_timeout(bus);
1978 r = dispatch_wqueue(bus);
1982 r = dispatch_rqueue(bus, &m);
1988 r = process_message(bus, m);
1993 r = sd_bus_message_rewind(m, true);
2002 if (m->header->type == SD_BUS_MESSAGE_METHOD_CALL) {
2004 r = sd_bus_reply_method_errorf(
2006 SD_BUS_ERROR_UNKNOWN_OBJECT,
2007 "Unknown object '%s'.", m->path);
2021 int sd_bus_process(sd_bus *bus, sd_bus_message **ret) {
2022 BUS_DONT_DESTROY(bus);
2025 /* Returns 0 when we didn't do anything. This should cause the
2026 * caller to invoke sd_bus_wait() before returning the next
2027 * time. Returns > 0 when we did something, which possibly
2028 * means *ret is filled in with an unprocessed message. */
2030 assert_return(bus, -EINVAL);
2031 assert_return(!bus_pid_changed(bus), -ECHILD);
2033 /* We don't allow recursively invoking sd_bus_process(). */
2034 assert_return(!bus->processing, -EBUSY);
2036 switch (bus->state) {
2043 r = bus_socket_process_opening(bus);
2050 case BUS_AUTHENTICATING:
2052 r = bus_socket_process_authenticating(bus);
2062 bus->processing = true;
2063 r = process_running(bus, ret);
2064 bus->processing = false;
2069 assert_not_reached("Unknown state");
2072 static int bus_poll(sd_bus *bus, bool need_more, uint64_t timeout_usec) {
2073 struct pollfd p[2] = {};
2076 usec_t m = (usec_t) -1;
2079 assert_return(BUS_IS_OPEN(bus->state), -ENOTCONN);
2081 e = sd_bus_get_events(bus);
2086 /* The caller really needs some more data, he doesn't
2087 * care about what's already read, or any timeouts
2092 /* The caller wants to process if there's something to
2093 * process, but doesn't care otherwise */
2095 r = sd_bus_get_timeout(bus, &until);
2100 nw = now(CLOCK_MONOTONIC);
2101 m = until > nw ? until - nw : 0;
2105 if (timeout_usec != (uint64_t) -1 && (m == (uint64_t) -1 || timeout_usec < m))
2108 p[0].fd = bus->input_fd;
2109 if (bus->output_fd == bus->input_fd) {
2113 p[0].events = e & POLLIN;
2114 p[1].fd = bus->output_fd;
2115 p[1].events = e & POLLOUT;
2119 r = ppoll(p, n, m == (uint64_t) -1 ? NULL : timespec_store(&ts, m), NULL);
2123 return r > 0 ? 1 : 0;
2126 int sd_bus_wait(sd_bus *bus, uint64_t timeout_usec) {
2128 assert_return(bus, -EINVAL);
2129 assert_return(BUS_IS_OPEN(bus->state), -ENOTCONN);
2130 assert_return(!bus_pid_changed(bus), -ECHILD);
2132 if (bus->rqueue_size > 0)
2135 return bus_poll(bus, false, timeout_usec);
2138 int sd_bus_flush(sd_bus *bus) {
2141 assert_return(bus, -EINVAL);
2142 assert_return(BUS_IS_OPEN(bus->state), -ENOTCONN);
2143 assert_return(!bus_pid_changed(bus), -ECHILD);
2145 r = bus_ensure_running(bus);
2149 if (bus->wqueue_size <= 0)
2153 r = dispatch_wqueue(bus);
2157 if (bus->wqueue_size <= 0)
2160 r = bus_poll(bus, false, (uint64_t) -1);
2166 int sd_bus_add_filter(sd_bus *bus, sd_bus_message_handler_t callback, void *userdata) {
2167 struct filter_callback *f;
2169 assert_return(bus, -EINVAL);
2170 assert_return(callback, -EINVAL);
2171 assert_return(!bus_pid_changed(bus), -ECHILD);
2173 f = new0(struct filter_callback, 1);
2176 f->callback = callback;
2177 f->userdata = userdata;
2179 bus->filter_callbacks_modified = true;
2180 LIST_PREPEND(callbacks, bus->filter_callbacks, f);
2184 int sd_bus_remove_filter(sd_bus *bus, sd_bus_message_handler_t callback, void *userdata) {
2185 struct filter_callback *f;
2187 assert_return(bus, -EINVAL);
2188 assert_return(callback, -EINVAL);
2189 assert_return(!bus_pid_changed(bus), -ECHILD);
2191 LIST_FOREACH(callbacks, f, bus->filter_callbacks) {
2192 if (f->callback == callback && f->userdata == userdata) {
2193 bus->filter_callbacks_modified = true;
2194 LIST_REMOVE(callbacks, bus->filter_callbacks, f);
2203 int sd_bus_add_match(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata) {
2204 struct bus_match_component *components = NULL;
2205 unsigned n_components = 0;
2206 uint64_t cookie = 0;
2209 assert_return(bus, -EINVAL);
2210 assert_return(match, -EINVAL);
2211 assert_return(!bus_pid_changed(bus), -ECHILD);
2213 r = bus_match_parse(match, &components, &n_components);
2217 if (bus->bus_client) {
2218 cookie = ++bus->match_cookie;
2220 r = bus_add_match_internal(bus, match, components, n_components, cookie);
2225 bus->match_callbacks_modified = true;
2226 r = bus_match_add(&bus->match_callbacks, components, n_components, callback, userdata, cookie, NULL);
2228 if (bus->bus_client)
2229 bus_remove_match_internal(bus, match, cookie);
2233 bus_match_parse_free(components, n_components);
2237 int sd_bus_remove_match(sd_bus *bus, const char *match, sd_bus_message_handler_t callback, void *userdata) {
2238 struct bus_match_component *components = NULL;
2239 unsigned n_components = 0;
2241 uint64_t cookie = 0;
2243 assert_return(bus, -EINVAL);
2244 assert_return(match, -EINVAL);
2245 assert_return(!bus_pid_changed(bus), -ECHILD);
2247 r = bus_match_parse(match, &components, &n_components);
2251 bus->match_callbacks_modified = true;
2252 r = bus_match_remove(&bus->match_callbacks, components, n_components, callback, userdata, &cookie);
2254 if (bus->bus_client)
2255 q = bus_remove_match_internal(bus, match, cookie);
2257 bus_match_parse_free(components, n_components);
2259 return r < 0 ? r : q;
2262 bool bus_pid_changed(sd_bus *bus) {
2265 /* We don't support people creating a bus connection and
2266 * keeping it around over a fork(). Let's complain. */
2268 return bus->original_pid != getpid();
2271 static int io_callback(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
2272 void *bus = userdata;
2277 r = sd_bus_process(bus, NULL);
2284 static int time_callback(sd_event_source *s, uint64_t usec, void *userdata) {
2285 void *bus = userdata;
2290 r = sd_bus_process(bus, NULL);
2297 static int prepare_callback(sd_event_source *s, void *userdata) {
2298 sd_bus *bus = userdata;
2305 e = sd_bus_get_events(bus);
2309 if (bus->output_fd != bus->input_fd) {
2311 r = sd_event_source_set_io_events(bus->input_io_event_source, e & POLLIN);
2315 r = sd_event_source_set_io_events(bus->output_io_event_source, e & POLLOUT);
2319 r = sd_event_source_set_io_events(bus->input_io_event_source, e);
2324 r = sd_bus_get_timeout(bus, &until);
2330 j = sd_event_source_set_time(bus->time_event_source, until);
2335 r = sd_event_source_set_enabled(bus->time_event_source, r > 0);
2342 static int quit_callback(sd_event_source *event, void *userdata) {
2343 sd_bus *bus = userdata;
2352 int sd_bus_attach_event(sd_bus *bus, sd_event *event, int priority) {
2355 assert_return(bus, -EINVAL);
2356 assert_return(event, -EINVAL);
2357 assert_return(!bus->event, -EBUSY);
2359 assert(!bus->input_io_event_source);
2360 assert(!bus->output_io_event_source);
2361 assert(!bus->time_event_source);
2363 bus->event = sd_event_ref(event);
2365 r = sd_event_add_io(event, bus->input_fd, 0, io_callback, bus, &bus->input_io_event_source);
2369 r = sd_event_source_set_priority(bus->input_io_event_source, priority);
2373 if (bus->output_fd != bus->input_fd) {
2374 r = sd_event_add_io(event, bus->output_fd, 0, io_callback, bus, &bus->output_io_event_source);
2378 r = sd_event_source_set_priority(bus->output_io_event_source, priority);
2383 r = sd_event_source_set_prepare(bus->input_io_event_source, prepare_callback);
2387 r = sd_event_add_monotonic(event, 0, 0, time_callback, bus, &bus->time_event_source);
2391 r = sd_event_source_set_priority(bus->time_event_source, priority);
2395 r = sd_event_add_quit(event, quit_callback, bus, &bus->quit_event_source);
2402 sd_bus_detach_event(bus);
2406 int sd_bus_detach_event(sd_bus *bus) {
2407 assert_return(bus, -EINVAL);
2408 assert_return(bus->event, -ENXIO);
2410 if (bus->input_io_event_source)
2411 bus->input_io_event_source = sd_event_source_unref(bus->input_io_event_source);
2413 if (bus->output_io_event_source)
2414 bus->output_io_event_source = sd_event_source_unref(bus->output_io_event_source);
2416 if (bus->time_event_source)
2417 bus->time_event_source = sd_event_source_unref(bus->time_event_source);
2419 if (bus->quit_event_source)
2420 bus->quit_event_source = sd_event_source_unref(bus->quit_event_source);
2423 bus->event = sd_event_unref(bus->event);