1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
15 #include "alloc-util.h"
16 #include "bus-container.h"
17 #include "bus-control.h"
18 #include "bus-internal.h"
19 #include "bus-kernel.h"
20 #include "bus-label.h"
21 #include "bus-message.h"
22 #include "bus-objects.h"
23 #include "bus-protocol.h"
25 #include "bus-socket.h"
26 #include "bus-track.h"
28 #include "cgroup-util.h"
30 #include "errno-util.h"
32 #include "hexdecoct.h"
33 #include "hostname-util.h"
36 #include "memory-util.h"
37 #include "missing_syscall.h"
38 #include "parse-util.h"
39 #include "path-util.h"
40 #include "process-util.h"
41 #include "string-util.h"
43 #include "user-util.h"
45 #define log_debug_bus_message(m) \
47 sd_bus_message *_mm = (m); \
48 log_debug("Got message type=%s sender=%s destination=%s path=%s interface=%s member=%s cookie=%" PRIu64 " reply_cookie=%" PRIu64 " signature=%s error-name=%s error-message=%s", \
49 bus_message_type_to_string(_mm->header->type), \
50 strna(sd_bus_message_get_sender(_mm)), \
51 strna(sd_bus_message_get_destination(_mm)), \
52 strna(sd_bus_message_get_path(_mm)), \
53 strna(sd_bus_message_get_interface(_mm)), \
54 strna(sd_bus_message_get_member(_mm)), \
55 BUS_MESSAGE_COOKIE(_mm), \
57 strna(_mm->root_container.signature), \
58 strna(_mm->error.name), \
59 strna(_mm->error.message)); \
62 static int bus_poll(sd_bus
*bus
, bool need_more
, uint64_t timeout_usec
);
63 static void bus_detach_io_events(sd_bus
*b
);
64 static void bus_detach_inotify_event(sd_bus
*b
);
66 static thread_local sd_bus
*default_system_bus
= NULL
;
67 static thread_local sd_bus
*default_user_bus
= NULL
;
68 static thread_local sd_bus
*default_starter_bus
= NULL
;
70 static sd_bus
**bus_choose_default(int (**bus_open
)(sd_bus
**)) {
73 /* Let's try our best to reuse another cached connection. If
74 * the starter bus type is set, connect via our normal
75 * connection logic, ignoring $DBUS_STARTER_ADDRESS, so that
76 * we can share the connection with the user/system default
79 e
= secure_getenv("DBUS_STARTER_BUS_TYPE");
81 if (streq(e
, "system")) {
83 *bus_open
= sd_bus_open_system
;
84 return &default_system_bus
;
85 } else if (STR_IN_SET(e
, "user", "session")) {
87 *bus_open
= sd_bus_open_user
;
88 return &default_user_bus
;
92 /* No type is specified, so we have not other option than to
93 * use the starter address if it is set. */
94 e
= secure_getenv("DBUS_STARTER_ADDRESS");
97 *bus_open
= sd_bus_open
;
98 return &default_starter_bus
;
101 /* Finally, if nothing is set use the cached connection for
104 if (cg_pid_get_owner_uid(0, NULL
) >= 0) {
106 *bus_open
= sd_bus_open_user
;
107 return &default_user_bus
;
110 *bus_open
= sd_bus_open_system
;
111 return &default_system_bus
;
115 sd_bus
*bus_resolve(sd_bus
*bus
) {
116 switch ((uintptr_t) bus
) {
117 case (uintptr_t) SD_BUS_DEFAULT
:
118 return *(bus_choose_default(NULL
));
119 case (uintptr_t) SD_BUS_DEFAULT_USER
:
120 return default_user_bus
;
121 case (uintptr_t) SD_BUS_DEFAULT_SYSTEM
:
122 return default_system_bus
;
128 void bus_close_io_fds(sd_bus
*b
) {
131 bus_detach_io_events(b
);
133 if (b
->input_fd
!= b
->output_fd
)
134 safe_close(b
->output_fd
);
135 b
->output_fd
= b
->input_fd
= safe_close(b
->input_fd
);
138 void bus_close_inotify_fd(sd_bus
*b
) {
141 bus_detach_inotify_event(b
);
143 b
->inotify_fd
= safe_close(b
->inotify_fd
);
144 b
->inotify_watches
= mfree(b
->inotify_watches
);
145 b
->n_inotify_watches
= 0;
148 static void bus_reset_queues(sd_bus
*b
) {
151 while (b
->rqueue_size
> 0)
152 bus_message_unref_queued(b
->rqueue
[--b
->rqueue_size
], b
);
154 b
->rqueue
= mfree(b
->rqueue
);
155 b
->rqueue_allocated
= 0;
157 while (b
->wqueue_size
> 0)
158 bus_message_unref_queued(b
->wqueue
[--b
->wqueue_size
], b
);
160 b
->wqueue
= mfree(b
->wqueue
);
161 b
->wqueue_allocated
= 0;
164 static sd_bus
* bus_free(sd_bus
*b
) {
168 assert(!b
->track_queue
);
171 b
->state
= BUS_CLOSED
;
173 sd_bus_detach_event(b
);
175 while ((s
= b
->slots
)) {
176 /* At this point only floating slots can still be
177 * around, because the non-floating ones keep a
178 * reference to the bus, and we thus couldn't be
179 * destructing right now... We forcibly disconnect the
180 * slots here, so that they still can be referenced by
181 * apps, but are dead. */
184 bus_slot_disconnect(s
, true);
187 if (b
->default_bus_ptr
)
188 *b
->default_bus_ptr
= NULL
;
191 bus_close_inotify_fd(b
);
196 free(b
->unique_name
);
197 free(b
->auth_buffer
);
200 free(b
->description
);
201 free(b
->patch_sender
);
204 strv_free(b
->exec_argv
);
206 close_many(b
->fds
, b
->n_fds
);
211 ordered_hashmap_free_free(b
->reply_callbacks
);
212 prioq_free(b
->reply_callbacks_prioq
);
214 assert(b
->match_callbacks
.type
== BUS_MATCH_ROOT
);
215 bus_match_free(&b
->match_callbacks
);
217 hashmap_free_free(b
->vtable_methods
);
218 hashmap_free_free(b
->vtable_properties
);
220 assert(hashmap_isempty(b
->nodes
));
221 hashmap_free(b
->nodes
);
225 assert_se(pthread_mutex_destroy(&b
->memfd_cache_mutex
) == 0);
230 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus
*, bus_free
);
232 _public_
int sd_bus_new(sd_bus
**ret
) {
233 _cleanup_free_ sd_bus
*b
= NULL
;
235 assert_return(ret
, -EINVAL
);
246 .message_version
= 1,
247 .creds_mask
= SD_BUS_CREDS_WELL_KNOWN_NAMES
|SD_BUS_CREDS_UNIQUE_NAME
,
249 .original_pid
= getpid_cached(),
250 .n_groups
= SIZE_MAX
,
251 .close_on_exit
= true,
254 /* We guarantee that wqueue always has space for at least one entry */
255 if (!GREEDY_REALLOC(b
->wqueue
, b
->wqueue_allocated
, 1))
258 assert_se(pthread_mutex_init(&b
->memfd_cache_mutex
, NULL
) == 0);
264 _public_
int sd_bus_set_address(sd_bus
*bus
, const char *address
) {
265 assert_return(bus
, -EINVAL
);
266 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
267 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
268 assert_return(address
, -EINVAL
);
269 assert_return(!bus_pid_changed(bus
), -ECHILD
);
271 return free_and_strdup(&bus
->address
, address
);
274 _public_
int sd_bus_set_fd(sd_bus
*bus
, int input_fd
, int output_fd
) {
275 assert_return(bus
, -EINVAL
);
276 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
277 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
278 assert_return(input_fd
>= 0, -EBADF
);
279 assert_return(output_fd
>= 0, -EBADF
);
280 assert_return(!bus_pid_changed(bus
), -ECHILD
);
282 bus
->input_fd
= input_fd
;
283 bus
->output_fd
= output_fd
;
287 _public_
int sd_bus_set_exec(sd_bus
*bus
, const char *path
, char *const *argv
) {
288 _cleanup_strv_free_
char **a
= NULL
;
291 assert_return(bus
, -EINVAL
);
292 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
293 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
294 assert_return(path
, -EINVAL
);
295 assert_return(!strv_isempty(argv
), -EINVAL
);
296 assert_return(!bus_pid_changed(bus
), -ECHILD
);
302 r
= free_and_strdup(&bus
->exec_path
, path
);
306 return strv_free_and_replace(bus
->exec_argv
, a
);
309 _public_
int sd_bus_set_bus_client(sd_bus
*bus
, int b
) {
310 assert_return(bus
, -EINVAL
);
311 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
312 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
313 assert_return(!bus
->patch_sender
, -EPERM
);
314 assert_return(!bus_pid_changed(bus
), -ECHILD
);
316 bus
->bus_client
= !!b
;
320 _public_
int sd_bus_set_monitor(sd_bus
*bus
, int b
) {
321 assert_return(bus
, -EINVAL
);
322 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
323 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
324 assert_return(!bus_pid_changed(bus
), -ECHILD
);
326 bus
->is_monitor
= !!b
;
330 _public_
int sd_bus_negotiate_fds(sd_bus
*bus
, int b
) {
331 assert_return(bus
, -EINVAL
);
332 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
333 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
334 assert_return(!bus_pid_changed(bus
), -ECHILD
);
336 bus
->accept_fd
= !!b
;
340 _public_
int sd_bus_negotiate_timestamp(sd_bus
*bus
, int b
) {
341 assert_return(bus
, -EINVAL
);
342 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
343 assert_return(!IN_SET(bus
->state
, BUS_CLOSING
, BUS_CLOSED
), -EPERM
);
344 assert_return(!bus_pid_changed(bus
), -ECHILD
);
346 /* This is not actually supported by any of our transports these days, but we do honour it for synthetic
347 * replies, and maybe one day classic D-Bus learns this too */
348 bus
->attach_timestamp
= !!b
;
353 _public_
int sd_bus_negotiate_creds(sd_bus
*bus
, int b
, uint64_t mask
) {
354 assert_return(bus
, -EINVAL
);
355 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
356 assert_return(mask
<= _SD_BUS_CREDS_ALL
, -EINVAL
);
357 assert_return(!IN_SET(bus
->state
, BUS_CLOSING
, BUS_CLOSED
), -EPERM
);
358 assert_return(!bus_pid_changed(bus
), -ECHILD
);
360 SET_FLAG(bus
->creds_mask
, mask
, b
);
362 /* The well knowns we need unconditionally, so that matches can work */
363 bus
->creds_mask
|= SD_BUS_CREDS_WELL_KNOWN_NAMES
|SD_BUS_CREDS_UNIQUE_NAME
;
368 _public_
int sd_bus_set_server(sd_bus
*bus
, int b
, sd_id128_t server_id
) {
369 assert_return(bus
, -EINVAL
);
370 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
371 assert_return(b
|| sd_id128_equal(server_id
, SD_ID128_NULL
), -EINVAL
);
372 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
373 assert_return(!bus_pid_changed(bus
), -ECHILD
);
375 bus
->is_server
= !!b
;
376 bus
->server_id
= server_id
;
380 _public_
int sd_bus_set_anonymous(sd_bus
*bus
, int b
) {
381 assert_return(bus
, -EINVAL
);
382 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
383 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
384 assert_return(!bus_pid_changed(bus
), -ECHILD
);
386 bus
->anonymous_auth
= !!b
;
390 _public_
int sd_bus_set_trusted(sd_bus
*bus
, int b
) {
391 assert_return(bus
, -EINVAL
);
392 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
393 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
394 assert_return(!bus_pid_changed(bus
), -ECHILD
);
400 _public_
int sd_bus_set_description(sd_bus
*bus
, const char *description
) {
401 assert_return(bus
, -EINVAL
);
402 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
403 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
404 assert_return(!bus_pid_changed(bus
), -ECHILD
);
406 return free_and_strdup(&bus
->description
, description
);
409 _public_
int sd_bus_set_allow_interactive_authorization(sd_bus
*bus
, int b
) {
410 assert_return(bus
, -EINVAL
);
411 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
412 assert_return(!bus_pid_changed(bus
), -ECHILD
);
414 bus
->allow_interactive_authorization
= !!b
;
418 _public_
int sd_bus_get_allow_interactive_authorization(sd_bus
*bus
) {
419 assert_return(bus
, -EINVAL
);
420 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
421 assert_return(!bus_pid_changed(bus
), -ECHILD
);
423 return bus
->allow_interactive_authorization
;
426 _public_
int sd_bus_set_watch_bind(sd_bus
*bus
, int b
) {
427 assert_return(bus
, -EINVAL
);
428 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
429 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
430 assert_return(!bus_pid_changed(bus
), -ECHILD
);
432 bus
->watch_bind
= !!b
;
436 _public_
int sd_bus_get_watch_bind(sd_bus
*bus
) {
437 assert_return(bus
, -EINVAL
);
438 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
439 assert_return(!bus_pid_changed(bus
), -ECHILD
);
441 return bus
->watch_bind
;
444 _public_
int sd_bus_set_connected_signal(sd_bus
*bus
, int b
) {
445 assert_return(bus
, -EINVAL
);
446 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
447 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
448 assert_return(!bus_pid_changed(bus
), -ECHILD
);
450 bus
->connected_signal
= !!b
;
454 _public_
int sd_bus_get_connected_signal(sd_bus
*bus
) {
455 assert_return(bus
, -EINVAL
);
456 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
457 assert_return(!bus_pid_changed(bus
), -ECHILD
);
459 return bus
->connected_signal
;
462 static int synthesize_connected_signal(sd_bus
*bus
) {
463 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
468 /* If enabled, synthesizes a local "Connected" signal mirroring the local "Disconnected" signal. This is called
469 * whenever we fully established a connection, i.e. after the authorization phase, and after receiving the
470 * Hello() reply. Or in other words, whenever we enter BUS_RUNNING state.
472 * This is useful so that clients can start doing stuff whenever the connection is fully established in a way
473 * that works independently from whether we connected to a full bus or just a direct connection. */
475 if (!bus
->connected_signal
)
478 r
= sd_bus_message_new_signal(
481 "/org/freedesktop/DBus/Local",
482 "org.freedesktop.DBus.Local",
487 bus_message_set_sender_local(bus
, m
);
488 m
->read_counter
= ++bus
->read_counter
;
490 r
= bus_seal_synthetic_message(bus
, m
);
494 r
= bus_rqueue_make_room(bus
);
498 /* Insert at the very front */
499 memmove(bus
->rqueue
+ 1, bus
->rqueue
, sizeof(sd_bus_message
*) * bus
->rqueue_size
);
500 bus
->rqueue
[0] = bus_message_ref_queued(m
, bus
);
506 void bus_set_state(sd_bus
*bus
, enum bus_state state
) {
507 static const char * const table
[_BUS_STATE_MAX
] = {
508 [BUS_UNSET
] = "UNSET",
509 [BUS_WATCH_BIND
] = "WATCH_BIND",
510 [BUS_OPENING
] = "OPENING",
511 [BUS_AUTHENTICATING
] = "AUTHENTICATING",
512 [BUS_HELLO
] = "HELLO",
513 [BUS_RUNNING
] = "RUNNING",
514 [BUS_CLOSING
] = "CLOSING",
515 [BUS_CLOSED
] = "CLOSED",
519 assert(state
< _BUS_STATE_MAX
);
521 if (state
== bus
->state
)
524 log_debug("Bus %s: changing state %s → %s", strna(bus
->description
), table
[bus
->state
], table
[state
]);
528 static int hello_callback(sd_bus_message
*reply
, void *userdata
, sd_bus_error
*error
) {
536 assert(IN_SET(bus
->state
, BUS_HELLO
, BUS_CLOSING
));
538 r
= sd_bus_message_get_errno(reply
);
544 r
= sd_bus_message_read(reply
, "s", &s
);
548 if (!service_name_is_valid(s
) || s
[0] != ':') {
553 r
= free_and_strdup(&bus
->unique_name
, s
);
557 if (bus
->state
== BUS_HELLO
) {
558 bus_set_state(bus
, BUS_RUNNING
);
560 r
= synthesize_connected_signal(bus
);
568 /* When Hello() failed, let's propagate this in two ways: first we return the error immediately here,
569 * which is the propagated up towards the event loop. Let's also invalidate the connection, so that
570 * if the user then calls back into us again we won't wait any longer. */
572 bus_set_state(bus
, BUS_CLOSING
);
576 static int bus_send_hello(sd_bus
*bus
) {
577 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
582 if (!bus
->bus_client
)
585 r
= sd_bus_message_new_method_call(
588 "org.freedesktop.DBus",
589 "/org/freedesktop/DBus",
590 "org.freedesktop.DBus",
595 return sd_bus_call_async(bus
, NULL
, m
, hello_callback
, NULL
, 0);
598 int bus_start_running(sd_bus
*bus
) {
599 struct reply_callback
*c
;
604 assert(bus
->state
< BUS_HELLO
);
606 /* We start all method call timeouts when we enter BUS_HELLO or BUS_RUNNING mode. At this point let's convert
607 * all relative to absolute timestamps. Note that we do not reshuffle the reply callback priority queue since
608 * adding a fixed value to all entries should not alter the internal order. */
610 n
= now(CLOCK_MONOTONIC
);
611 ORDERED_HASHMAP_FOREACH(c
, bus
->reply_callbacks
) {
612 if (c
->timeout_usec
== 0)
615 c
->timeout_usec
= usec_add(n
, c
->timeout_usec
);
618 if (bus
->bus_client
) {
619 bus_set_state(bus
, BUS_HELLO
);
623 bus_set_state(bus
, BUS_RUNNING
);
625 r
= synthesize_connected_signal(bus
);
632 static int parse_address_key(const char **p
, const char *key
, char **value
) {
633 size_t l
, n
= 0, allocated
= 0;
634 _cleanup_free_
char *r
= NULL
;
643 if (strncmp(*p
, key
, l
) != 0)
656 while (!IN_SET(*a
, ';', ',', 0)) {
670 c
= (char) ((x
<< 4) | y
);
677 if (!GREEDY_REALLOC(r
, allocated
, n
+ 2))
695 free_and_replace(*value
, r
);
700 static void skip_address_key(const char **p
) {
704 *p
+= strcspn(*p
, ",");
710 static int parse_unix_address(sd_bus
*b
, const char **p
, char **guid
) {
711 _cleanup_free_
char *path
= NULL
, *abstract
= NULL
;
720 while (!IN_SET(**p
, 0, ';')) {
721 r
= parse_address_key(p
, "guid", guid
);
727 r
= parse_address_key(p
, "path", &path
);
733 r
= parse_address_key(p
, "abstract", &abstract
);
742 if (!path
&& !abstract
)
745 if (path
&& abstract
)
750 if (l
>= sizeof(b
->sockaddr
.un
.sun_path
)) /* We insist on NUL termination */
753 b
->sockaddr
.un
= (struct sockaddr_un
) {
754 .sun_family
= AF_UNIX
,
757 memcpy(b
->sockaddr
.un
.sun_path
, path
, l
);
758 b
->sockaddr_size
= offsetof(struct sockaddr_un
, sun_path
) + l
+ 1;
763 l
= strlen(abstract
);
764 if (l
>= sizeof(b
->sockaddr
.un
.sun_path
) - 1) /* We insist on NUL termination */
767 b
->sockaddr
.un
= (struct sockaddr_un
) {
768 .sun_family
= AF_UNIX
,
771 memcpy(b
->sockaddr
.un
.sun_path
+1, abstract
, l
);
772 b
->sockaddr_size
= offsetof(struct sockaddr_un
, sun_path
) + 1 + l
;
780 static int parse_tcp_address(sd_bus
*b
, const char **p
, char **guid
) {
781 _cleanup_free_
char *host
= NULL
, *port
= NULL
, *family
= NULL
;
783 struct addrinfo
*result
, hints
= {
784 .ai_socktype
= SOCK_STREAM
,
792 while (!IN_SET(**p
, 0, ';')) {
793 r
= parse_address_key(p
, "guid", guid
);
799 r
= parse_address_key(p
, "host", &host
);
805 r
= parse_address_key(p
, "port", &port
);
811 r
= parse_address_key(p
, "family", &family
);
824 if (streq(family
, "ipv4"))
825 hints
.ai_family
= AF_INET
;
826 else if (streq(family
, "ipv6"))
827 hints
.ai_family
= AF_INET6
;
832 r
= getaddrinfo(host
, port
, &hints
, &result
);
836 return -EADDRNOTAVAIL
;
838 memcpy(&b
->sockaddr
, result
->ai_addr
, result
->ai_addrlen
);
839 b
->sockaddr_size
= result
->ai_addrlen
;
841 freeaddrinfo(result
);
848 static int parse_exec_address(sd_bus
*b
, const char **p
, char **guid
) {
850 unsigned n_argv
= 0, j
;
852 size_t allocated
= 0;
860 while (!IN_SET(**p
, 0, ';')) {
861 r
= parse_address_key(p
, "guid", guid
);
867 r
= parse_address_key(p
, "path", &path
);
873 if (startswith(*p
, "argv")) {
877 ul
= strtoul(*p
+ 4, (char**) p
, 10);
878 if (errno
> 0 || **p
!= '=' || ul
> 256) {
886 if (!GREEDY_REALLOC0(argv
, allocated
, ul
+ 2)) {
894 r
= parse_address_key(p
, NULL
, argv
+ ul
);
909 /* Make sure there are no holes in the array, with the
910 * exception of argv[0] */
911 for (j
= 1; j
< n_argv
; j
++)
917 if (argv
&& argv
[0] == NULL
) {
918 argv
[0] = strdup(path
);
933 for (j
= 0; j
< n_argv
; j
++)
941 static int parse_container_unix_address(sd_bus
*b
, const char **p
, char **guid
) {
942 _cleanup_free_
char *machine
= NULL
, *pid
= NULL
;
950 while (!IN_SET(**p
, 0, ';')) {
951 r
= parse_address_key(p
, "guid", guid
);
957 r
= parse_address_key(p
, "machine", &machine
);
963 r
= parse_address_key(p
, "pid", &pid
);
972 if (!machine
== !pid
)
976 if (!hostname_is_valid(machine
, VALID_HOSTNAME_DOT_HOST
))
979 free_and_replace(b
->machine
, machine
);
981 b
->machine
= mfree(b
->machine
);
984 r
= parse_pid(pid
, &b
->nspid
);
990 b
->sockaddr
.un
= (struct sockaddr_un
) {
991 .sun_family
= AF_UNIX
,
992 /* Note that we use the old /var/run prefix here, to increase compatibility with really old containers */
993 .sun_path
= "/var/run/dbus/system_bus_socket",
995 b
->sockaddr_size
= SOCKADDR_UN_LEN(b
->sockaddr
.un
);
1001 static void bus_reset_parsed_address(sd_bus
*b
) {
1005 b
->sockaddr_size
= 0;
1006 b
->exec_argv
= strv_free(b
->exec_argv
);
1007 b
->exec_path
= mfree(b
->exec_path
);
1008 b
->server_id
= SD_ID128_NULL
;
1009 b
->machine
= mfree(b
->machine
);
1013 static int bus_parse_next_address(sd_bus
*b
) {
1014 _cleanup_free_
char *guid
= NULL
;
1022 if (b
->address
[b
->address_index
] == 0)
1025 bus_reset_parsed_address(b
);
1027 a
= b
->address
+ b
->address_index
;
1036 if (startswith(a
, "unix:")) {
1039 r
= parse_unix_address(b
, &a
, &guid
);
1044 } else if (startswith(a
, "tcp:")) {
1047 r
= parse_tcp_address(b
, &a
, &guid
);
1053 } else if (startswith(a
, "unixexec:")) {
1056 r
= parse_exec_address(b
, &a
, &guid
);
1062 } else if (startswith(a
, "x-machine-unix:")) {
1065 r
= parse_container_unix_address(b
, &a
, &guid
);
1078 r
= sd_id128_from_string(guid
, &b
->server_id
);
1083 b
->address_index
= a
- b
->address
;
1087 static void bus_kill_exec(sd_bus
*bus
) {
1088 if (pid_is_valid(bus
->busexec_pid
) > 0) {
1089 sigterm_wait(bus
->busexec_pid
);
1090 bus
->busexec_pid
= 0;
1094 static int bus_start_address(sd_bus
*b
) {
1100 bus_close_io_fds(b
);
1101 bus_close_inotify_fd(b
);
1105 /* If you provide multiple different bus-addresses, we
1106 * try all of them in order and use the first one that
1110 r
= bus_socket_exec(b
);
1111 else if ((b
->nspid
> 0 || b
->machine
) && b
->sockaddr
.sa
.sa_family
!= AF_UNSPEC
)
1112 r
= bus_container_connect_socket(b
);
1113 else if (b
->sockaddr
.sa
.sa_family
!= AF_UNSPEC
)
1114 r
= bus_socket_connect(b
);
1121 q
= bus_attach_io_events(b
);
1125 q
= bus_attach_inotify_event(b
);
1132 b
->last_connect_error
= -r
;
1135 r
= bus_parse_next_address(b
);
1139 return b
->last_connect_error
> 0 ? -b
->last_connect_error
: -ECONNREFUSED
;
1143 int bus_next_address(sd_bus
*b
) {
1146 bus_reset_parsed_address(b
);
1147 return bus_start_address(b
);
1150 static int bus_start_fd(sd_bus
*b
) {
1155 assert(b
->input_fd
>= 0);
1156 assert(b
->output_fd
>= 0);
1158 if (DEBUG_LOGGING
) {
1159 _cleanup_free_
char *pi
= NULL
, *po
= NULL
;
1160 (void) fd_get_path(b
->input_fd
, &pi
);
1161 (void) fd_get_path(b
->output_fd
, &po
);
1162 log_debug("sd-bus: starting bus%s%s on fds %d/%d (%s, %s)...",
1163 b
->description
? " " : "", strempty(b
->description
),
1164 b
->input_fd
, b
->output_fd
,
1165 pi
?: "???", po
?: "???");
1168 r
= fd_nonblock(b
->input_fd
, true);
1172 r
= fd_cloexec(b
->input_fd
, true);
1176 if (b
->input_fd
!= b
->output_fd
) {
1177 r
= fd_nonblock(b
->output_fd
, true);
1181 r
= fd_cloexec(b
->output_fd
, true);
1186 if (fstat(b
->input_fd
, &st
) < 0)
1189 return bus_socket_take_fd(b
);
1192 _public_
int sd_bus_start(sd_bus
*bus
) {
1195 assert_return(bus
, -EINVAL
);
1196 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
1197 assert_return(bus
->state
== BUS_UNSET
, -EPERM
);
1198 assert_return(!bus_pid_changed(bus
), -ECHILD
);
1200 bus_set_state(bus
, BUS_OPENING
);
1202 if (bus
->is_server
&& bus
->bus_client
)
1205 if (bus
->input_fd
>= 0)
1206 r
= bus_start_fd(bus
);
1207 else if (bus
->address
|| bus
->sockaddr
.sa
.sa_family
!= AF_UNSPEC
|| bus
->exec_path
|| bus
->machine
)
1208 r
= bus_start_address(bus
);
1217 return bus_send_hello(bus
);
1220 _public_
int sd_bus_open_with_description(sd_bus
**ret
, const char *description
) {
1222 _cleanup_(bus_freep
) sd_bus
*b
= NULL
;
1225 assert_return(ret
, -EINVAL
);
1227 /* Let's connect to the starter bus if it is set, and
1228 * otherwise to the bus that is appropriate for the scope
1229 * we are running in */
1231 e
= secure_getenv("DBUS_STARTER_BUS_TYPE");
1233 if (streq(e
, "system"))
1234 return sd_bus_open_system_with_description(ret
, description
);
1235 else if (STR_IN_SET(e
, "session", "user"))
1236 return sd_bus_open_user_with_description(ret
, description
);
1239 e
= secure_getenv("DBUS_STARTER_ADDRESS");
1241 if (cg_pid_get_owner_uid(0, NULL
) >= 0)
1242 return sd_bus_open_user_with_description(ret
, description
);
1244 return sd_bus_open_system_with_description(ret
, description
);
1251 r
= sd_bus_set_address(b
, e
);
1255 b
->bus_client
= true;
1257 /* We don't know whether the bus is trusted or not, so better
1258 * be safe, and authenticate everything */
1260 b
->is_local
= false;
1261 b
->creds_mask
|= SD_BUS_CREDS_UID
| SD_BUS_CREDS_EUID
| SD_BUS_CREDS_EFFECTIVE_CAPS
;
1263 r
= sd_bus_start(b
);
1271 _public_
int sd_bus_open(sd_bus
**ret
) {
1272 return sd_bus_open_with_description(ret
, NULL
);
1275 int bus_set_address_system(sd_bus
*b
) {
1281 e
= secure_getenv("DBUS_SYSTEM_BUS_ADDRESS");
1283 r
= sd_bus_set_address(b
, e
?: DEFAULT_SYSTEM_BUS_ADDRESS
);
1285 b
->is_system
= true;
1289 _public_
int sd_bus_open_system_with_description(sd_bus
**ret
, const char *description
) {
1290 _cleanup_(bus_freep
) sd_bus
*b
= NULL
;
1293 assert_return(ret
, -EINVAL
);
1300 r
= sd_bus_set_description(b
, description
);
1305 r
= bus_set_address_system(b
);
1309 b
->bus_client
= true;
1311 /* Let's do per-method access control on the system bus. We
1312 * need the caller's UID and capability set for that. */
1314 b
->creds_mask
|= SD_BUS_CREDS_UID
| SD_BUS_CREDS_EUID
| SD_BUS_CREDS_EFFECTIVE_CAPS
;
1317 r
= sd_bus_start(b
);
1325 _public_
int sd_bus_open_system(sd_bus
**ret
) {
1326 return sd_bus_open_system_with_description(ret
, NULL
);
1329 int bus_set_address_user(sd_bus
*b
) {
1331 _cleanup_free_
char *_a
= NULL
;
1336 a
= secure_getenv("DBUS_SESSION_BUS_ADDRESS");
1339 _cleanup_free_
char *ee
= NULL
;
1341 e
= secure_getenv("XDG_RUNTIME_DIR");
1343 return log_debug_errno(SYNTHETIC_ERRNO(ENOMEDIUM
),
1344 "sd-bus: $XDG_RUNTIME_DIR not set, cannot connect to user bus.");
1346 ee
= bus_address_escape(e
);
1350 if (asprintf(&_a
, DEFAULT_USER_BUS_ADDRESS_FMT
, ee
) < 0)
1355 r
= sd_bus_set_address(b
, a
);
1361 _public_
int sd_bus_open_user_with_description(sd_bus
**ret
, const char *description
) {
1362 _cleanup_(bus_freep
) sd_bus
*b
= NULL
;
1365 assert_return(ret
, -EINVAL
);
1372 r
= sd_bus_set_description(b
, description
);
1377 r
= bus_set_address_user(b
);
1381 b
->bus_client
= true;
1383 /* We don't do any per-method access control on the user bus. */
1387 r
= sd_bus_start(b
);
1395 _public_
int sd_bus_open_user(sd_bus
**ret
) {
1396 return sd_bus_open_user_with_description(ret
, NULL
);
1399 int bus_set_address_system_remote(sd_bus
*b
, const char *host
) {
1400 _cleanup_free_
char *e
= NULL
;
1401 char *m
= NULL
, *c
= NULL
, *a
, *rbracket
= NULL
, *p
= NULL
;
1406 /* Skip ":"s in ipv6 addresses */
1410 rbracket
= strchr(host
, ']');
1413 t
= strndupa(host
+ 1, rbracket
- host
- 1);
1414 e
= bus_address_escape(t
);
1417 } else if ((a
= strchr(host
, '@'))) {
1418 if (*(a
+ 1) == '[') {
1419 _cleanup_free_
char *t
= NULL
;
1421 rbracket
= strchr(a
+ 1, ']');
1424 t
= new0(char, strlen(host
));
1427 strncat(t
, host
, a
- host
+ 1);
1428 strncat(t
, a
+ 2, rbracket
- a
- 2);
1429 e
= bus_address_escape(t
);
1432 } else if (*(a
+ 1) == '\0' || strchr(a
+ 1, '@'))
1436 /* Let's see if a port was given */
1437 m
= strchr(rbracket
? rbracket
+ 1 : host
, ':');
1440 bool got_forward_slash
= false;
1446 p
= strndupa(p
, t
- p
);
1447 got_forward_slash
= true;
1450 if (!in_charset(p
, "0123456789") || *p
== '\0') {
1451 if (!hostname_is_valid(p
, 0) || got_forward_slash
)
1455 goto interpret_port_as_machine_old_syntax
;
1459 /* Let's see if a machine was given */
1460 m
= strchr(rbracket
? rbracket
+ 1 : host
, '/');
1463 interpret_port_as_machine_old_syntax
:
1464 /* Let's make sure this is not a port of some kind,
1465 * and is a valid machine name. */
1466 if (!in_charset(m
, "0123456789") && hostname_is_valid(m
, 0))
1467 c
= strjoina(",argv", p
? "7" : "5", "=--machine=", m
);
1473 t
= strndupa(host
, strcspn(host
, ":/"));
1475 e
= bus_address_escape(t
);
1480 a
= strjoin("unixexec:path=ssh,argv1=-xT", p
? ",argv2=-p,argv3=" : "", strempty(p
),
1481 ",argv", p
? "4" : "2", "=--,argv", p
? "5" : "3", "=", e
,
1482 ",argv", p
? "6" : "4", "=systemd-stdio-bridge", c
);
1486 return free_and_replace(b
->address
, a
);
1489 _public_
int sd_bus_open_system_remote(sd_bus
**ret
, const char *host
) {
1490 _cleanup_(bus_freep
) sd_bus
*b
= NULL
;
1493 assert_return(host
, -EINVAL
);
1494 assert_return(ret
, -EINVAL
);
1500 r
= bus_set_address_system_remote(b
, host
);
1504 b
->bus_client
= true;
1506 b
->is_system
= true;
1507 b
->is_local
= false;
1509 r
= sd_bus_start(b
);
1517 int bus_set_address_machine(sd_bus
*b
, bool user
, const char *machine
) {
1518 _cleanup_free_
char *a
= NULL
;
1524 rhs
= strchr(machine
, '@');
1526 _cleanup_free_
char *u
= NULL
, *eu
= NULL
, *erhs
= NULL
;
1528 /* If there's an "@" in the container specification, we'll connect as a user specified at its
1529 * left hand side, which is useful in combination with user=true. This isn't as trivial as it
1530 * might sound: it's not sufficient to enter the container and connect to some socket there,
1531 * since the --user socket path depends on $XDG_RUNTIME_DIR which is set via PAM. Thus, to be
1532 * able to connect, we need to have a PAM session. Our way out? We use systemd-run to get
1533 * into the container and acquire a PAM session there, and then invoke systemd-stdio-bridge
1534 * in it, which propagates the bus transport to us.*/
1538 u
= strndup(machine
, rhs
- machine
);
1540 u
= getusername_malloc(); /* Empty user name, let's use the local one */
1544 eu
= bus_address_escape(u
);
1550 /* No "@" specified but we shall connect to the user instance? Then assume root (and
1551 * not a user named identically to the calling one). This means:
1553 * --machine=foobar --user → connect to user bus of root user in container "foobar"
1554 * --machine=@foobar --user → connect to user bus of user named like the calling user in container "foobar"
1556 * Why? so that behaviour for "--machine=foobar --system" is roughly similar to
1557 * "--machine=foobar --user": both times we unconditionally connect as root user
1558 * regardless what the calling user is. */
1563 if (!isempty(rhs
)) {
1564 erhs
= bus_address_escape(rhs
);
1569 /* systemd-run -M… -PGq --wait -pUser=… -pPAMName=login systemd-stdio-bridge */
1571 a
= strjoin("unixexec:path=systemd-run,"
1572 "argv1=-M", erhs
?: ".host", ","
1575 "argv4=-pUser%3d", eu
?: "root", ",",
1576 "argv5=-pPAMName%3dlogin,"
1577 "argv6=systemd-stdio-bridge");
1584 /* Ideally we'd use the "--user" switch to systemd-stdio-bridge here, but it's only
1585 * available in recent systemd versions. Using the "-p" switch with the explicit path
1586 * is a working alternative, and is compatible with older versions, hence that's what
1589 k
= strjoin(a
, ",argv7=-punix:path%3d%24%7bXDG_RUNTIME_DIR%7d/bus");
1593 free_and_replace(a
, k
);
1596 _cleanup_free_
char *e
= NULL
;
1598 /* Just a container name, we can go the simple way, and just join the container, and connect
1599 * to the well-known path of the system bus there. */
1601 e
= bus_address_escape(machine
);
1605 a
= strjoin("x-machine-unix:machine=", e
);
1610 return free_and_replace(b
->address
, a
);
1613 static int user_and_machine_valid(const char *user_and_machine
) {
1616 /* Checks if a container specification in the form "user@container" or just "container" is valid.
1618 * If the "@" syntax is used we'll allow either the "user" or the "container" part to be omitted, but
1621 h
= strchr(user_and_machine
, '@');
1623 h
= user_and_machine
;
1625 _cleanup_free_
char *user
= NULL
;
1627 user
= strndup(user_and_machine
, h
- user_and_machine
);
1631 if (!isempty(user
) && !valid_user_group_name(user
, VALID_USER_RELAX
))
1637 return !isempty(user
);
1640 return hostname_is_valid(h
, VALID_HOSTNAME_DOT_HOST
);
1643 static int user_and_machine_equivalent(const char *user_and_machine
) {
1644 _cleanup_free_
char *un
= NULL
;
1647 /* Returns true if the specified user+machine name are actually equivalent to our own identity and
1648 * our own host. If so we can shortcut things. Why bother? Because that way we don't have to fork
1649 * off short-lived worker processes that are then unavailable for authentication and logging in the
1650 * peer. Moreover joining a namespace requires privileges. If we are in the right namespace anyway,
1651 * we can avoid permission problems thus. */
1653 assert(user_and_machine
);
1655 /* Omitting the user name means that we shall use the same user name as we run as locally, which
1656 * means we'll end up on the same host, let's shortcut */
1657 if (streq(user_and_machine
, "@.host"))
1660 /* Otherwise, if we are root, then we can also allow the ".host" syntax, as that's the user this
1661 * would connect to. */
1662 if (geteuid() == 0 && STR_IN_SET(user_and_machine
, ".host", "root@.host"))
1665 /* Otherwise, we have to figure our user name, and compare things with that. */
1666 un
= getusername_malloc();
1670 f
= startswith(user_and_machine
, un
);
1674 return STR_IN_SET(f
, "@", "@.host");
1677 _public_
int sd_bus_open_system_machine(sd_bus
**ret
, const char *user_and_machine
) {
1678 _cleanup_(bus_freep
) sd_bus
*b
= NULL
;
1681 assert_return(user_and_machine
, -EINVAL
);
1682 assert_return(ret
, -EINVAL
);
1684 if (user_and_machine_equivalent(user_and_machine
))
1685 return sd_bus_open_system(ret
);
1687 r
= user_and_machine_valid(user_and_machine
);
1691 assert_return(r
> 0, -EINVAL
);
1697 r
= bus_set_address_machine(b
, false, user_and_machine
);
1701 b
->bus_client
= true;
1702 b
->is_system
= true;
1704 r
= sd_bus_start(b
);
1712 _public_
int sd_bus_open_user_machine(sd_bus
**ret
, const char *user_and_machine
) {
1713 _cleanup_(bus_freep
) sd_bus
*b
= NULL
;
1716 assert_return(user_and_machine
, -EINVAL
);
1717 assert_return(ret
, -EINVAL
);
1719 /* Shortcut things if we'd end up on this host and as the same user. */
1720 if (user_and_machine_equivalent(user_and_machine
))
1721 return sd_bus_open_user(ret
);
1723 r
= user_and_machine_valid(user_and_machine
);
1727 assert_return(r
> 0, -EINVAL
);
1733 r
= bus_set_address_machine(b
, true, user_and_machine
);
1737 b
->bus_client
= true;
1740 r
= sd_bus_start(b
);
1748 _public_
void sd_bus_close(sd_bus
*bus
) {
1751 if (bus
->state
== BUS_CLOSED
)
1753 if (bus_pid_changed(bus
))
1756 /* Don't leave ssh hanging around */
1759 bus_set_state(bus
, BUS_CLOSED
);
1761 sd_bus_detach_event(bus
);
1763 /* Drop all queued messages so that they drop references to
1764 * the bus object and the bus may be freed */
1765 bus_reset_queues(bus
);
1767 bus_close_io_fds(bus
);
1768 bus_close_inotify_fd(bus
);
1771 _public_ sd_bus
*sd_bus_close_unref(sd_bus
*bus
) {
1777 return sd_bus_unref(bus
);
1780 _public_ sd_bus
* sd_bus_flush_close_unref(sd_bus
*bus
) {
1784 /* Have to do this before flush() to prevent hang */
1788 return sd_bus_close_unref(bus
);
1791 void bus_enter_closing(sd_bus
*bus
) {
1794 if (!IN_SET(bus
->state
, BUS_WATCH_BIND
, BUS_OPENING
, BUS_AUTHENTICATING
, BUS_HELLO
, BUS_RUNNING
))
1797 bus_set_state(bus
, BUS_CLOSING
);
1800 DEFINE_PUBLIC_TRIVIAL_REF_UNREF_FUNC(sd_bus
, sd_bus
, bus_free
);
1802 _public_
int sd_bus_is_open(sd_bus
*bus
) {
1803 assert_return(bus
, -EINVAL
);
1804 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
1805 assert_return(!bus_pid_changed(bus
), -ECHILD
);
1807 return BUS_IS_OPEN(bus
->state
);
1810 _public_
int sd_bus_is_ready(sd_bus
*bus
) {
1811 assert_return(bus
, -EINVAL
);
1812 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
1813 assert_return(!bus_pid_changed(bus
), -ECHILD
);
1815 return bus
->state
== BUS_RUNNING
;
1818 _public_
int sd_bus_can_send(sd_bus
*bus
, char type
) {
1821 assert_return(bus
, -EINVAL
);
1822 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
1823 assert_return(bus
->state
!= BUS_UNSET
, -ENOTCONN
);
1824 assert_return(!bus_pid_changed(bus
), -ECHILD
);
1826 if (bus
->is_monitor
)
1829 if (type
== SD_BUS_TYPE_UNIX_FD
) {
1830 if (!bus
->accept_fd
)
1833 r
= bus_ensure_running(bus
);
1837 return bus
->can_fds
;
1840 return bus_type_is_valid(type
);
1843 _public_
int sd_bus_get_bus_id(sd_bus
*bus
, sd_id128_t
*id
) {
1846 assert_return(bus
, -EINVAL
);
1847 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
1848 assert_return(id
, -EINVAL
);
1849 assert_return(!bus_pid_changed(bus
), -ECHILD
);
1851 r
= bus_ensure_running(bus
);
1855 *id
= bus
->server_id
;
1859 #define COOKIE_CYCLED (UINT32_C(1) << 31)
1861 static uint64_t cookie_inc(uint64_t cookie
) {
1863 /* Stay within the 32bit range, since classic D-Bus can't deal with more */
1864 if (cookie
>= UINT32_MAX
)
1865 return COOKIE_CYCLED
; /* Don't go back to zero, but use the highest bit for checking
1866 * whether we are looping. */
1871 static int next_cookie(sd_bus
*b
) {
1872 uint64_t new_cookie
;
1876 new_cookie
= cookie_inc(b
->cookie
);
1878 /* Small optimization: don't bother with checking for cookie reuse until we overran cookiespace at
1879 * least once, but then do it thorougly. */
1880 if (FLAGS_SET(new_cookie
, COOKIE_CYCLED
)) {
1883 /* Check if the cookie is currently in use. If so, pick the next one */
1884 for (i
= 0; i
< COOKIE_CYCLED
; i
++) {
1885 if (!ordered_hashmap_contains(b
->reply_callbacks
, &new_cookie
))
1888 new_cookie
= cookie_inc(new_cookie
);
1891 /* Can't fulfill request */
1896 b
->cookie
= new_cookie
;
1900 static int bus_seal_message(sd_bus
*b
, sd_bus_message
*m
, usec_t timeout
) {
1907 /* If we copy the same message to multiple
1908 * destinations, avoid using the same cookie
1910 b
->cookie
= MAX(b
->cookie
, BUS_MESSAGE_COOKIE(m
));
1915 r
= sd_bus_get_method_call_timeout(b
, &timeout
);
1920 if (!m
->sender
&& b
->patch_sender
) {
1921 r
= sd_bus_message_set_sender(m
, b
->patch_sender
);
1930 return sd_bus_message_seal(m
, b
->cookie
, timeout
);
1933 static int bus_remarshal_message(sd_bus
*b
, sd_bus_message
**m
) {
1934 bool remarshal
= false;
1938 /* wrong packet version */
1939 if (b
->message_version
!= 0 && b
->message_version
!= (*m
)->header
->version
)
1942 /* wrong packet endianness */
1943 if (b
->message_endian
!= 0 && b
->message_endian
!= (*m
)->header
->endian
)
1946 return remarshal
? bus_message_remarshal(b
, m
) : 0;
1949 int bus_seal_synthetic_message(sd_bus
*b
, sd_bus_message
*m
) {
1953 /* Fake some timestamps, if they were requested, and not
1954 * already initialized */
1955 if (b
->attach_timestamp
) {
1956 if (m
->realtime
<= 0)
1957 m
->realtime
= now(CLOCK_REALTIME
);
1959 if (m
->monotonic
<= 0)
1960 m
->monotonic
= now(CLOCK_MONOTONIC
);
1963 /* The bus specification says the serial number cannot be 0,
1964 * hence let's fill something in for synthetic messages. Since
1965 * synthetic messages might have a fake sender and we don't
1966 * want to interfere with the real sender's serial numbers we
1967 * pick a fixed, artificial one. We use UINT32_MAX rather
1968 * than UINT64_MAX since dbus1 only had 32bit identifiers,
1969 * even though kdbus can do 64bit. */
1970 return sd_bus_message_seal(m
, 0xFFFFFFFFULL
, 0);
1973 static int bus_write_message(sd_bus
*bus
, sd_bus_message
*m
, size_t *idx
) {
1979 r
= bus_socket_write_message(bus
, m
, idx
);
1983 if (*idx
>= BUS_MESSAGE_SIZE(m
))
1984 log_debug("Sent message type=%s sender=%s destination=%s path=%s interface=%s member=%s cookie=%" PRIu64
" reply_cookie=%" PRIu64
" signature=%s error-name=%s error-message=%s",
1985 bus_message_type_to_string(m
->header
->type
),
1986 strna(sd_bus_message_get_sender(m
)),
1987 strna(sd_bus_message_get_destination(m
)),
1988 strna(sd_bus_message_get_path(m
)),
1989 strna(sd_bus_message_get_interface(m
)),
1990 strna(sd_bus_message_get_member(m
)),
1991 BUS_MESSAGE_COOKIE(m
),
1993 strna(m
->root_container
.signature
),
1994 strna(m
->error
.name
),
1995 strna(m
->error
.message
));
2000 static int dispatch_wqueue(sd_bus
*bus
) {
2004 assert(IN_SET(bus
->state
, BUS_RUNNING
, BUS_HELLO
));
2006 while (bus
->wqueue_size
> 0) {
2008 r
= bus_write_message(bus
, bus
->wqueue
[0], &bus
->windex
);
2012 /* Didn't do anything this time */
2014 else if (bus
->windex
>= BUS_MESSAGE_SIZE(bus
->wqueue
[0])) {
2015 /* Fully written. Let's drop the entry from
2018 * This isn't particularly optimized, but
2019 * well, this is supposed to be our worst-case
2020 * buffer only, and the socket buffer is
2021 * supposed to be our primary buffer, and if
2022 * it got full, then all bets are off
2026 bus_message_unref_queued(bus
->wqueue
[0], bus
);
2027 memmove(bus
->wqueue
, bus
->wqueue
+ 1, sizeof(sd_bus_message
*) * bus
->wqueue_size
);
2037 static int bus_read_message(sd_bus
*bus
) {
2040 return bus_socket_read_message(bus
);
2043 int bus_rqueue_make_room(sd_bus
*bus
) {
2046 if (bus
->rqueue_size
>= BUS_RQUEUE_MAX
)
2049 if (!GREEDY_REALLOC(bus
->rqueue
, bus
->rqueue_allocated
, bus
->rqueue_size
+ 1))
2055 static void rqueue_drop_one(sd_bus
*bus
, size_t i
) {
2057 assert(i
< bus
->rqueue_size
);
2059 bus_message_unref_queued(bus
->rqueue
[i
], bus
);
2060 memmove(bus
->rqueue
+ i
, bus
->rqueue
+ i
+ 1, sizeof(sd_bus_message
*) * (bus
->rqueue_size
- i
- 1));
2064 static int dispatch_rqueue(sd_bus
*bus
, sd_bus_message
**m
) {
2069 assert(IN_SET(bus
->state
, BUS_RUNNING
, BUS_HELLO
));
2072 if (bus
->rqueue_size
> 0) {
2073 /* Dispatch a queued message */
2074 *m
= sd_bus_message_ref(bus
->rqueue
[0]);
2075 rqueue_drop_one(bus
, 0);
2079 /* Try to read a new message */
2080 r
= bus_read_message(bus
);
2092 _public_
int sd_bus_send(sd_bus
*bus
, sd_bus_message
*_m
, uint64_t *cookie
) {
2093 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= sd_bus_message_ref(_m
);
2096 assert_return(m
, -EINVAL
);
2099 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2101 assert_return(bus
= m
->bus
, -ENOTCONN
);
2102 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2104 if (!BUS_IS_OPEN(bus
->state
))
2108 r
= sd_bus_can_send(bus
, SD_BUS_TYPE_UNIX_FD
);
2115 /* If the cookie number isn't kept, then we know that no reply
2117 if (!cookie
&& !m
->sealed
)
2118 m
->header
->flags
|= BUS_MESSAGE_NO_REPLY_EXPECTED
;
2120 r
= bus_seal_message(bus
, m
, 0);
2124 /* Remarshall if we have to. This will possibly unref the
2125 * message and place a replacement in m */
2126 r
= bus_remarshal_message(bus
, &m
);
2130 /* If this is a reply and no reply was requested, then let's
2131 * suppress this, if we can */
2135 if (IN_SET(bus
->state
, BUS_RUNNING
, BUS_HELLO
) && bus
->wqueue_size
<= 0) {
2138 r
= bus_write_message(bus
, m
, &idx
);
2140 if (ERRNO_IS_DISCONNECT(r
)) {
2141 bus_enter_closing(bus
);
2148 if (idx
< BUS_MESSAGE_SIZE(m
)) {
2149 /* Wasn't fully written. So let's remember how
2150 * much was written. Note that the first entry
2151 * of the wqueue array is always allocated so
2152 * that we always can remember how much was
2154 bus
->wqueue
[0] = bus_message_ref_queued(m
, bus
);
2155 bus
->wqueue_size
= 1;
2160 /* Just append it to the queue. */
2162 if (bus
->wqueue_size
>= BUS_WQUEUE_MAX
)
2165 if (!GREEDY_REALLOC(bus
->wqueue
, bus
->wqueue_allocated
, bus
->wqueue_size
+ 1))
2168 bus
->wqueue
[bus
->wqueue_size
++] = bus_message_ref_queued(m
, bus
);
2173 *cookie
= BUS_MESSAGE_COOKIE(m
);
2178 _public_
int sd_bus_send_to(sd_bus
*bus
, sd_bus_message
*m
, const char *destination
, uint64_t *cookie
) {
2181 assert_return(m
, -EINVAL
);
2184 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2186 assert_return(bus
= m
->bus
, -ENOTCONN
);
2187 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2189 if (!BUS_IS_OPEN(bus
->state
))
2192 if (!streq_ptr(m
->destination
, destination
)) {
2197 r
= sd_bus_message_set_destination(m
, destination
);
2202 return sd_bus_send(bus
, m
, cookie
);
2205 static usec_t
calc_elapse(sd_bus
*bus
, uint64_t usec
) {
2208 assert_cc(sizeof(usec_t
) == sizeof(uint64_t));
2210 if (usec
== USEC_INFINITY
)
2213 /* We start all timeouts the instant we enter BUS_HELLO/BUS_RUNNING state, so that the don't run in parallel
2214 * with any connection setup states. Hence, if a method callback is started earlier than that we just store the
2215 * relative timestamp, and afterwards the absolute one. */
2217 if (IN_SET(bus
->state
, BUS_WATCH_BIND
, BUS_OPENING
, BUS_AUTHENTICATING
))
2220 return usec_add(now(CLOCK_MONOTONIC
), usec
);
2223 static int timeout_compare(const void *a
, const void *b
) {
2224 const struct reply_callback
*x
= a
, *y
= b
;
2226 if (x
->timeout_usec
!= 0 && y
->timeout_usec
== 0)
2229 if (x
->timeout_usec
== 0 && y
->timeout_usec
!= 0)
2232 return CMP(x
->timeout_usec
, y
->timeout_usec
);
2235 _public_
int sd_bus_call_async(
2239 sd_bus_message_handler_t callback
,
2243 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= sd_bus_message_ref(_m
);
2244 _cleanup_(sd_bus_slot_unrefp
) sd_bus_slot
*s
= NULL
;
2247 assert_return(m
, -EINVAL
);
2248 assert_return(m
->header
->type
== SD_BUS_MESSAGE_METHOD_CALL
, -EINVAL
);
2249 assert_return(!m
->sealed
|| (!!callback
== !(m
->header
->flags
& BUS_MESSAGE_NO_REPLY_EXPECTED
)), -EINVAL
);
2252 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2254 assert_return(bus
= m
->bus
, -ENOTCONN
);
2255 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2257 if (!BUS_IS_OPEN(bus
->state
))
2260 /* If no callback is specified and there's no interest in a slot, then there's no reason to ask for a reply */
2261 if (!callback
&& !slot
&& !m
->sealed
)
2262 m
->header
->flags
|= BUS_MESSAGE_NO_REPLY_EXPECTED
;
2264 r
= ordered_hashmap_ensure_allocated(&bus
->reply_callbacks
, &uint64_hash_ops
);
2268 r
= prioq_ensure_allocated(&bus
->reply_callbacks_prioq
, timeout_compare
);
2272 r
= bus_seal_message(bus
, m
, usec
);
2276 r
= bus_remarshal_message(bus
, &m
);
2280 if (slot
|| callback
) {
2281 s
= bus_slot_allocate(bus
, !slot
, BUS_REPLY_CALLBACK
, sizeof(struct reply_callback
), userdata
);
2285 s
->reply_callback
.callback
= callback
;
2287 s
->reply_callback
.cookie
= BUS_MESSAGE_COOKIE(m
);
2288 r
= ordered_hashmap_put(bus
->reply_callbacks
, &s
->reply_callback
.cookie
, &s
->reply_callback
);
2290 s
->reply_callback
.cookie
= 0;
2294 s
->reply_callback
.timeout_usec
= calc_elapse(bus
, m
->timeout
);
2295 if (s
->reply_callback
.timeout_usec
!= 0) {
2296 r
= prioq_put(bus
->reply_callbacks_prioq
, &s
->reply_callback
, &s
->reply_callback
.prioq_idx
);
2298 s
->reply_callback
.timeout_usec
= 0;
2304 r
= sd_bus_send(bus
, m
, s
? &s
->reply_callback
.cookie
: NULL
);
2315 int bus_ensure_running(sd_bus
*bus
) {
2320 if (bus
->state
== BUS_RUNNING
)
2324 if (IN_SET(bus
->state
, BUS_UNSET
, BUS_CLOSED
, BUS_CLOSING
))
2327 r
= sd_bus_process(bus
, NULL
);
2330 if (bus
->state
== BUS_RUNNING
)
2335 r
= sd_bus_wait(bus
, UINT64_MAX
);
2341 _public_
int sd_bus_call(
2345 sd_bus_error
*error
,
2346 sd_bus_message
**reply
) {
2348 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= sd_bus_message_ref(_m
);
2354 bus_assert_return(m
, -EINVAL
, error
);
2355 bus_assert_return(m
->header
->type
== SD_BUS_MESSAGE_METHOD_CALL
, -EINVAL
, error
);
2356 bus_assert_return(!(m
->header
->flags
& BUS_MESSAGE_NO_REPLY_EXPECTED
), -EINVAL
, error
);
2357 bus_assert_return(!bus_error_is_dirty(error
), -EINVAL
, error
);
2360 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2362 assert_return(bus
= m
->bus
, -ENOTCONN
);
2363 bus_assert_return(!bus_pid_changed(bus
), -ECHILD
, error
);
2365 if (!BUS_IS_OPEN(bus
->state
)) {
2370 r
= bus_ensure_running(bus
);
2374 i
= bus
->rqueue_size
;
2376 r
= bus_seal_message(bus
, m
, usec
);
2380 r
= bus_remarshal_message(bus
, &m
);
2384 r
= sd_bus_send(bus
, m
, &cookie
);
2388 timeout
= calc_elapse(bus
, m
->timeout
);
2393 while (i
< bus
->rqueue_size
) {
2394 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*incoming
= NULL
;
2396 incoming
= sd_bus_message_ref(bus
->rqueue
[i
]);
2398 if (incoming
->reply_cookie
== cookie
) {
2399 /* Found a match! */
2401 rqueue_drop_one(bus
, i
);
2402 log_debug_bus_message(incoming
);
2404 if (incoming
->header
->type
== SD_BUS_MESSAGE_METHOD_RETURN
) {
2406 if (incoming
->n_fds
<= 0 || bus
->accept_fd
) {
2408 *reply
= TAKE_PTR(incoming
);
2413 return sd_bus_error_setf(error
, SD_BUS_ERROR_INCONSISTENT_MESSAGE
, "Reply message contained file descriptors which I couldn't accept. Sorry.");
2415 } else if (incoming
->header
->type
== SD_BUS_MESSAGE_METHOD_ERROR
)
2416 return sd_bus_error_copy(error
, &incoming
->error
);
2422 } else if (BUS_MESSAGE_COOKIE(incoming
) == cookie
&&
2425 streq(bus
->unique_name
, incoming
->sender
)) {
2427 rqueue_drop_one(bus
, i
);
2429 /* Our own message? Somebody is trying to send its own client a message,
2430 * let's not dead-lock, let's fail immediately. */
2436 /* Try to read more, right-away */
2440 r
= bus_read_message(bus
);
2442 if (ERRNO_IS_DISCONNECT(r
)) {
2443 bus_enter_closing(bus
);
2455 n
= now(CLOCK_MONOTONIC
);
2465 r
= bus_poll(bus
, true, left
);
2473 r
= dispatch_wqueue(bus
);
2475 if (ERRNO_IS_DISCONNECT(r
)) {
2476 bus_enter_closing(bus
);
2485 return sd_bus_error_set_errno(error
, r
);
2488 _public_
int sd_bus_get_fd(sd_bus
*bus
) {
2489 assert_return(bus
, -EINVAL
);
2490 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2491 assert_return(bus
->input_fd
== bus
->output_fd
, -EPERM
);
2492 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2494 if (bus
->state
== BUS_CLOSED
)
2497 if (bus
->inotify_fd
>= 0)
2498 return bus
->inotify_fd
;
2500 if (bus
->input_fd
>= 0)
2501 return bus
->input_fd
;
2506 _public_
int sd_bus_get_events(sd_bus
*bus
) {
2509 assert_return(bus
, -EINVAL
);
2510 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2511 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2513 switch (bus
->state
) {
2519 case BUS_WATCH_BIND
:
2527 case BUS_AUTHENTICATING
:
2528 if (bus_socket_auth_needs_write(bus
))
2536 if (bus
->rqueue_size
<= 0)
2538 if (bus
->wqueue_size
> 0)
2546 assert_not_reached("Unknown state");
2552 _public_
int sd_bus_get_timeout(sd_bus
*bus
, uint64_t *timeout_usec
) {
2553 struct reply_callback
*c
;
2555 assert_return(bus
, -EINVAL
);
2556 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2557 assert_return(timeout_usec
, -EINVAL
);
2558 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2560 if (!BUS_IS_OPEN(bus
->state
) && bus
->state
!= BUS_CLOSING
)
2563 if (bus
->track_queue
) {
2568 switch (bus
->state
) {
2570 case BUS_AUTHENTICATING
:
2571 *timeout_usec
= bus
->auth_timeout
;
2576 if (bus
->rqueue_size
> 0) {
2581 c
= prioq_peek(bus
->reply_callbacks_prioq
);
2583 *timeout_usec
= UINT64_MAX
;
2587 if (c
->timeout_usec
== 0) {
2588 *timeout_usec
= UINT64_MAX
;
2592 *timeout_usec
= c
->timeout_usec
;
2599 case BUS_WATCH_BIND
:
2601 *timeout_usec
= UINT64_MAX
;
2605 assert_not_reached("Unknown or unexpected stat");
2609 static int process_timeout(sd_bus
*bus
) {
2610 _cleanup_(sd_bus_error_free
) sd_bus_error error_buffer
= SD_BUS_ERROR_NULL
;
2611 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
* m
= NULL
;
2612 struct reply_callback
*c
;
2619 assert(IN_SET(bus
->state
, BUS_RUNNING
, BUS_HELLO
));
2621 c
= prioq_peek(bus
->reply_callbacks_prioq
);
2625 n
= now(CLOCK_MONOTONIC
);
2626 if (c
->timeout_usec
> n
)
2629 r
= bus_message_new_synthetic_error(
2632 &SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_NO_REPLY
, "Method call timed out"),
2637 m
->read_counter
= ++bus
->read_counter
;
2639 r
= bus_seal_synthetic_message(bus
, m
);
2643 assert_se(prioq_pop(bus
->reply_callbacks_prioq
) == c
);
2644 c
->timeout_usec
= 0;
2646 ordered_hashmap_remove(bus
->reply_callbacks
, &c
->cookie
);
2649 slot
= container_of(c
, sd_bus_slot
, reply_callback
);
2651 bus
->iteration_counter
++;
2653 is_hello
= bus
->state
== BUS_HELLO
&& c
->callback
== hello_callback
;
2655 bus
->current_message
= m
;
2656 bus
->current_slot
= sd_bus_slot_ref(slot
);
2657 bus
->current_handler
= c
->callback
;
2658 bus
->current_userdata
= slot
->userdata
;
2659 r
= c
->callback(m
, slot
->userdata
, &error_buffer
);
2660 bus
->current_userdata
= NULL
;
2661 bus
->current_handler
= NULL
;
2662 bus
->current_slot
= NULL
;
2663 bus
->current_message
= NULL
;
2666 bus_slot_disconnect(slot
, true);
2668 sd_bus_slot_unref(slot
);
2670 /* When this is the hello message and it timed out, then make sure to propagate the error up, don't just log
2671 * and ignore the callback handler's return value. */
2675 return bus_maybe_reply_error(m
, r
, &error_buffer
);
2678 static int process_hello(sd_bus
*bus
, sd_bus_message
*m
) {
2682 if (bus
->state
!= BUS_HELLO
)
2685 /* Let's make sure the first message on the bus is the HELLO
2686 * reply. But note that we don't actually parse the message
2687 * here (we leave that to the usual handling), we just verify
2688 * we don't let any earlier msg through. */
2690 if (!IN_SET(m
->header
->type
, SD_BUS_MESSAGE_METHOD_RETURN
, SD_BUS_MESSAGE_METHOD_ERROR
))
2693 if (m
->reply_cookie
!= 1)
2699 static int process_reply(sd_bus
*bus
, sd_bus_message
*m
) {
2700 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*synthetic_reply
= NULL
;
2701 _cleanup_(sd_bus_error_free
) sd_bus_error error_buffer
= SD_BUS_ERROR_NULL
;
2702 struct reply_callback
*c
;
2710 if (!IN_SET(m
->header
->type
, SD_BUS_MESSAGE_METHOD_RETURN
, SD_BUS_MESSAGE_METHOD_ERROR
))
2713 if (m
->destination
&& bus
->unique_name
&& !streq_ptr(m
->destination
, bus
->unique_name
))
2716 c
= ordered_hashmap_remove(bus
->reply_callbacks
, &m
->reply_cookie
);
2722 slot
= container_of(c
, sd_bus_slot
, reply_callback
);
2724 if (m
->n_fds
> 0 && !bus
->accept_fd
) {
2726 /* If the reply contained a file descriptor which we
2727 * didn't want we pass an error instead. */
2729 r
= bus_message_new_synthetic_error(
2732 &SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_INCONSISTENT_MESSAGE
, "Reply message contained file descriptor"),
2737 /* Copy over original timestamp */
2738 synthetic_reply
->realtime
= m
->realtime
;
2739 synthetic_reply
->monotonic
= m
->monotonic
;
2740 synthetic_reply
->seqnum
= m
->seqnum
;
2741 synthetic_reply
->read_counter
= m
->read_counter
;
2743 r
= bus_seal_synthetic_message(bus
, synthetic_reply
);
2747 m
= synthetic_reply
;
2749 r
= sd_bus_message_rewind(m
, true);
2754 if (c
->timeout_usec
!= 0) {
2755 prioq_remove(bus
->reply_callbacks_prioq
, c
, &c
->prioq_idx
);
2756 c
->timeout_usec
= 0;
2759 is_hello
= bus
->state
== BUS_HELLO
&& c
->callback
== hello_callback
;
2761 bus
->current_slot
= sd_bus_slot_ref(slot
);
2762 bus
->current_handler
= c
->callback
;
2763 bus
->current_userdata
= slot
->userdata
;
2764 r
= c
->callback(m
, slot
->userdata
, &error_buffer
);
2765 bus
->current_userdata
= NULL
;
2766 bus
->current_handler
= NULL
;
2767 bus
->current_slot
= NULL
;
2770 bus_slot_disconnect(slot
, true);
2772 sd_bus_slot_unref(slot
);
2774 /* When this is the hello message and it failed, then make sure to propagate the error up, don't just log and
2775 * ignore the callback handler's return value. */
2779 return bus_maybe_reply_error(m
, r
, &error_buffer
);
2782 static int process_filter(sd_bus
*bus
, sd_bus_message
*m
) {
2783 _cleanup_(sd_bus_error_free
) sd_bus_error error_buffer
= SD_BUS_ERROR_NULL
;
2784 struct filter_callback
*l
;
2791 bus
->filter_callbacks_modified
= false;
2793 LIST_FOREACH(callbacks
, l
, bus
->filter_callbacks
) {
2796 if (bus
->filter_callbacks_modified
)
2799 /* Don't run this more than once per iteration */
2800 if (l
->last_iteration
== bus
->iteration_counter
)
2803 l
->last_iteration
= bus
->iteration_counter
;
2805 r
= sd_bus_message_rewind(m
, true);
2809 slot
= container_of(l
, sd_bus_slot
, filter_callback
);
2811 bus
->current_slot
= sd_bus_slot_ref(slot
);
2812 bus
->current_handler
= l
->callback
;
2813 bus
->current_userdata
= slot
->userdata
;
2814 r
= l
->callback(m
, slot
->userdata
, &error_buffer
);
2815 bus
->current_userdata
= NULL
;
2816 bus
->current_handler
= NULL
;
2817 bus
->current_slot
= sd_bus_slot_unref(slot
);
2819 r
= bus_maybe_reply_error(m
, r
, &error_buffer
);
2825 } while (bus
->filter_callbacks_modified
);
2830 static int process_match(sd_bus
*bus
, sd_bus_message
*m
) {
2837 bus
->match_callbacks_modified
= false;
2839 r
= bus_match_run(bus
, &bus
->match_callbacks
, m
);
2843 } while (bus
->match_callbacks_modified
);
2848 static int process_builtin(sd_bus
*bus
, sd_bus_message
*m
) {
2849 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
2855 if (bus
->is_monitor
)
2858 if (bus
->manual_peer_interface
)
2861 if (m
->header
->type
!= SD_BUS_MESSAGE_METHOD_CALL
)
2864 if (!streq_ptr(m
->interface
, "org.freedesktop.DBus.Peer"))
2867 if (m
->header
->flags
& BUS_MESSAGE_NO_REPLY_EXPECTED
)
2870 if (streq_ptr(m
->member
, "Ping"))
2871 r
= sd_bus_message_new_method_return(m
, &reply
);
2872 else if (streq_ptr(m
->member
, "GetMachineId")) {
2874 char sid
[SD_ID128_STRING_MAX
];
2876 r
= sd_id128_get_machine(&id
);
2880 r
= sd_bus_message_new_method_return(m
, &reply
);
2884 r
= sd_bus_message_append(reply
, "s", sd_id128_to_string(id
, sid
));
2886 r
= sd_bus_message_new_method_errorf(
2888 SD_BUS_ERROR_UNKNOWN_METHOD
,
2889 "Unknown method '%s' on interface '%s'.", m
->member
, m
->interface
);
2894 r
= sd_bus_send(bus
, reply
, NULL
);
2901 static int process_fd_check(sd_bus
*bus
, sd_bus_message
*m
) {
2905 /* If we got a message with a file descriptor which we didn't
2906 * want to accept, then let's drop it. How can this even
2907 * happen? For example, when the kernel queues a message into
2908 * an activatable names's queue which allows fds, and then is
2909 * delivered to us later even though we ourselves did not
2912 if (bus
->is_monitor
)
2921 if (m
->header
->type
!= SD_BUS_MESSAGE_METHOD_CALL
)
2922 return 1; /* just eat it up */
2924 return sd_bus_reply_method_errorf(m
, SD_BUS_ERROR_INCONSISTENT_MESSAGE
, "Message contains file descriptors, which I cannot accept. Sorry.");
2927 static int process_message(sd_bus
*bus
, sd_bus_message
*m
) {
2933 bus
->current_message
= m
;
2934 bus
->iteration_counter
++;
2936 log_debug_bus_message(m
);
2938 r
= process_hello(bus
, m
);
2942 r
= process_reply(bus
, m
);
2946 r
= process_fd_check(bus
, m
);
2950 r
= process_filter(bus
, m
);
2954 r
= process_match(bus
, m
);
2958 r
= process_builtin(bus
, m
);
2962 r
= bus_process_object(bus
, m
);
2965 bus
->current_message
= NULL
;
2969 static int dispatch_track(sd_bus
*bus
) {
2972 if (!bus
->track_queue
)
2975 bus_track_dispatch(bus
->track_queue
);
2979 static int process_running(sd_bus
*bus
, sd_bus_message
**ret
) {
2980 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2984 assert(IN_SET(bus
->state
, BUS_RUNNING
, BUS_HELLO
));
2986 r
= process_timeout(bus
);
2990 r
= dispatch_wqueue(bus
);
2994 r
= dispatch_track(bus
);
2998 r
= dispatch_rqueue(bus
, &m
);
3004 r
= process_message(bus
, m
);
3009 r
= sd_bus_message_rewind(m
, true);
3017 if (m
->header
->type
== SD_BUS_MESSAGE_METHOD_CALL
) {
3019 log_debug("Unprocessed message call sender=%s object=%s interface=%s member=%s",
3020 strna(sd_bus_message_get_sender(m
)),
3021 strna(sd_bus_message_get_path(m
)),
3022 strna(sd_bus_message_get_interface(m
)),
3023 strna(sd_bus_message_get_member(m
)));
3025 r
= sd_bus_reply_method_errorf(
3027 SD_BUS_ERROR_UNKNOWN_OBJECT
,
3028 "Unknown object '%s'.", m
->path
);
3042 static int bus_exit_now(sd_bus
*bus
) {
3045 /* Exit due to close, if this is requested. If this is bus object is attached to an event source, invokes
3046 * sd_event_exit(), otherwise invokes libc exit(). */
3048 if (bus
->exited
) /* did we already exit? */
3050 if (!bus
->exit_triggered
) /* was the exit condition triggered? */
3052 if (!bus
->exit_on_disconnect
) /* Shall we actually exit on disconnection? */
3055 bus
->exited
= true; /* never exit more than once */
3057 log_debug("Bus connection disconnected, exiting.");
3060 return sd_event_exit(bus
->event
, EXIT_FAILURE
);
3064 assert_not_reached("exit() didn't exit?");
3067 static int process_closing_reply_callback(sd_bus
*bus
, struct reply_callback
*c
) {
3068 _cleanup_(sd_bus_error_free
) sd_bus_error error_buffer
= SD_BUS_ERROR_NULL
;
3069 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
3076 r
= bus_message_new_synthetic_error(
3079 &SD_BUS_ERROR_MAKE_CONST(SD_BUS_ERROR_NO_REPLY
, "Connection terminated"),
3084 m
->read_counter
= ++bus
->read_counter
;
3086 r
= bus_seal_synthetic_message(bus
, m
);
3090 if (c
->timeout_usec
!= 0) {
3091 prioq_remove(bus
->reply_callbacks_prioq
, c
, &c
->prioq_idx
);
3092 c
->timeout_usec
= 0;
3095 ordered_hashmap_remove(bus
->reply_callbacks
, &c
->cookie
);
3098 slot
= container_of(c
, sd_bus_slot
, reply_callback
);
3100 bus
->iteration_counter
++;
3102 bus
->current_message
= m
;
3103 bus
->current_slot
= sd_bus_slot_ref(slot
);
3104 bus
->current_handler
= c
->callback
;
3105 bus
->current_userdata
= slot
->userdata
;
3106 r
= c
->callback(m
, slot
->userdata
, &error_buffer
);
3107 bus
->current_userdata
= NULL
;
3108 bus
->current_handler
= NULL
;
3109 bus
->current_slot
= NULL
;
3110 bus
->current_message
= NULL
;
3113 bus_slot_disconnect(slot
, true);
3115 sd_bus_slot_unref(slot
);
3117 return bus_maybe_reply_error(m
, r
, &error_buffer
);
3120 static int process_closing(sd_bus
*bus
, sd_bus_message
**ret
) {
3121 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
3122 struct reply_callback
*c
;
3126 assert(bus
->state
== BUS_CLOSING
);
3128 /* First, fail all outstanding method calls */
3129 c
= ordered_hashmap_first(bus
->reply_callbacks
);
3131 return process_closing_reply_callback(bus
, c
);
3133 /* Then, fake-drop all remaining bus tracking references */
3135 bus_track_close(bus
->tracks
);
3139 /* Then, synthesize a Disconnected message */
3140 r
= sd_bus_message_new_signal(
3143 "/org/freedesktop/DBus/Local",
3144 "org.freedesktop.DBus.Local",
3149 bus_message_set_sender_local(bus
, m
);
3150 m
->read_counter
= ++bus
->read_counter
;
3152 r
= bus_seal_synthetic_message(bus
, m
);
3158 bus
->current_message
= m
;
3159 bus
->iteration_counter
++;
3161 r
= process_filter(bus
, m
);
3165 r
= process_match(bus
, m
);
3169 /* Nothing else to do, exit now, if the condition holds */
3170 bus
->exit_triggered
= true;
3171 (void) bus_exit_now(bus
);
3179 bus
->current_message
= NULL
;
3184 static int bus_process_internal(sd_bus
*bus
, sd_bus_message
**ret
) {
3187 /* Returns 0 when we didn't do anything. This should cause the
3188 * caller to invoke sd_bus_wait() before returning the next
3189 * time. Returns > 0 when we did something, which possibly
3190 * means *ret is filled in with an unprocessed message. */
3192 assert_return(bus
, -EINVAL
);
3193 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
3194 assert_return(!bus_pid_changed(bus
), -ECHILD
);
3196 /* We don't allow recursively invoking sd_bus_process(). */
3197 assert_return(!bus
->current_message
, -EBUSY
);
3198 assert(!bus
->current_slot
); /* This should be NULL whenever bus->current_message is */
3200 BUS_DONT_DESTROY(bus
);
3202 switch (bus
->state
) {
3210 case BUS_WATCH_BIND
:
3211 r
= bus_socket_process_watch_bind(bus
);
3215 r
= bus_socket_process_opening(bus
);
3218 case BUS_AUTHENTICATING
:
3219 r
= bus_socket_process_authenticating(bus
);
3224 r
= process_running(bus
, ret
);
3228 /* This branch initializes *ret, hence we don't use the generic error checking below */
3232 return process_closing(bus
, ret
);
3235 assert_not_reached("Unknown state");
3238 if (ERRNO_IS_DISCONNECT(r
)) {
3239 bus_enter_closing(bus
);
3250 _public_
int sd_bus_process(sd_bus
*bus
, sd_bus_message
**ret
) {
3251 return bus_process_internal(bus
, ret
);
3254 _public_
int sd_bus_process_priority(sd_bus
*bus
, int64_t priority
, sd_bus_message
**ret
) {
3255 return bus_process_internal(bus
, ret
);
3258 static int bus_poll(sd_bus
*bus
, bool need_more
, uint64_t timeout_usec
) {
3259 struct pollfd p
[2] = {};
3260 usec_t m
= USEC_INFINITY
;
3265 if (bus
->state
== BUS_CLOSING
)
3268 if (!BUS_IS_OPEN(bus
->state
))
3271 if (bus
->state
== BUS_WATCH_BIND
) {
3272 assert(bus
->inotify_fd
>= 0);
3274 p
[0].events
= POLLIN
;
3275 p
[0].fd
= bus
->inotify_fd
;
3280 e
= sd_bus_get_events(bus
);
3285 /* The caller really needs some more data, he doesn't
3286 * care about what's already read, or any timeouts
3287 * except its own. */
3291 /* The caller wants to process if there's something to
3292 * process, but doesn't care otherwise */
3294 r
= sd_bus_get_timeout(bus
, &until
);
3298 m
= usec_sub_unsigned(until
, now(CLOCK_MONOTONIC
));
3301 p
[0].fd
= bus
->input_fd
;
3302 if (bus
->output_fd
== bus
->input_fd
) {
3306 p
[0].events
= e
& POLLIN
;
3307 p
[1].fd
= bus
->output_fd
;
3308 p
[1].events
= e
& POLLOUT
;
3313 if (timeout_usec
!= UINT64_MAX
&& (m
== USEC_INFINITY
|| timeout_usec
< m
))
3316 r
= ppoll_usec(p
, n
, m
);
3323 _public_
int sd_bus_wait(sd_bus
*bus
, uint64_t timeout_usec
) {
3325 assert_return(bus
, -EINVAL
);
3326 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
3327 assert_return(!bus_pid_changed(bus
), -ECHILD
);
3329 if (bus
->state
== BUS_CLOSING
)
3332 if (!BUS_IS_OPEN(bus
->state
))
3335 if (bus
->rqueue_size
> 0)
3338 return bus_poll(bus
, false, timeout_usec
);
3341 _public_
int sd_bus_flush(sd_bus
*bus
) {
3344 assert_return(bus
, -EINVAL
);
3345 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
3346 assert_return(!bus_pid_changed(bus
), -ECHILD
);
3348 if (bus
->state
== BUS_CLOSING
)
3351 if (!BUS_IS_OPEN(bus
->state
))
3354 /* We never were connected? Don't hang in inotify for good, as there's no timeout set for it */
3355 if (bus
->state
== BUS_WATCH_BIND
)
3358 r
= bus_ensure_running(bus
);
3362 if (bus
->wqueue_size
<= 0)
3366 r
= dispatch_wqueue(bus
);
3368 if (ERRNO_IS_DISCONNECT(r
)) {
3369 bus_enter_closing(bus
);
3376 if (bus
->wqueue_size
<= 0)
3379 r
= bus_poll(bus
, false, UINT64_MAX
);
3385 _public_
int sd_bus_add_filter(
3388 sd_bus_message_handler_t callback
,
3393 assert_return(bus
, -EINVAL
);
3394 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
3395 assert_return(callback
, -EINVAL
);
3396 assert_return(!bus_pid_changed(bus
), -ECHILD
);
3398 s
= bus_slot_allocate(bus
, !slot
, BUS_FILTER_CALLBACK
, sizeof(struct filter_callback
), userdata
);
3402 s
->filter_callback
.callback
= callback
;
3404 bus
->filter_callbacks_modified
= true;
3405 LIST_PREPEND(callbacks
, bus
->filter_callbacks
, &s
->filter_callback
);
3413 static int add_match_callback(
3416 sd_bus_error
*ret_error
) {
3418 sd_bus_slot
*match_slot
= userdata
;
3419 bool failed
= false;
3425 sd_bus_slot_ref(match_slot
);
3427 if (sd_bus_message_is_method_error(m
, NULL
)) {
3428 log_debug_errno(sd_bus_message_get_errno(m
),
3429 "Unable to add match %s, failing connection: %s",
3430 match_slot
->match_callback
.match_string
,
3431 sd_bus_message_get_error(m
)->message
);
3435 log_debug("Match %s successfully installed.", match_slot
->match_callback
.match_string
);
3437 if (match_slot
->match_callback
.install_callback
) {
3440 bus
= sd_bus_message_get_bus(m
);
3442 /* This function has been called as slot handler, and we want to call another slot handler. Let's
3443 * update the slot callback metadata temporarily with our own data, and then revert back to the old
3446 assert(bus
->current_slot
== match_slot
->match_callback
.install_slot
);
3447 assert(bus
->current_handler
== add_match_callback
);
3448 assert(bus
->current_userdata
== userdata
);
3450 bus
->current_slot
= match_slot
;
3451 bus
->current_handler
= match_slot
->match_callback
.install_callback
;
3452 bus
->current_userdata
= match_slot
->userdata
;
3454 r
= match_slot
->match_callback
.install_callback(m
, match_slot
->userdata
, ret_error
);
3456 bus
->current_slot
= match_slot
->match_callback
.install_slot
;
3457 bus
->current_handler
= add_match_callback
;
3458 bus
->current_userdata
= userdata
;
3460 if (failed
) /* Generic failure handling: destroy the connection */
3461 bus_enter_closing(sd_bus_message_get_bus(m
));
3466 /* We don't need the install method reply slot anymore, let's free it */
3467 match_slot
->match_callback
.install_slot
= sd_bus_slot_unref(match_slot
->match_callback
.install_slot
);
3469 if (failed
&& match_slot
->floating
)
3470 bus_slot_disconnect(match_slot
, true);
3472 sd_bus_slot_unref(match_slot
);
3477 static int bus_add_match_full(
3482 sd_bus_message_handler_t callback
,
3483 sd_bus_message_handler_t install_callback
,
3486 struct bus_match_component
*components
= NULL
;
3487 unsigned n_components
= 0;
3488 sd_bus_slot
*s
= NULL
;
3491 assert_return(bus
, -EINVAL
);
3492 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
3493 assert_return(match
, -EINVAL
);
3494 assert_return(!bus_pid_changed(bus
), -ECHILD
);
3496 r
= bus_match_parse(match
, &components
, &n_components
);
3500 s
= bus_slot_allocate(bus
, !slot
, BUS_MATCH_CALLBACK
, sizeof(struct match_callback
), userdata
);
3506 s
->match_callback
.callback
= callback
;
3507 s
->match_callback
.install_callback
= install_callback
;
3509 if (bus
->bus_client
) {
3510 enum bus_match_scope scope
;
3512 scope
= bus_match_get_scope(components
, n_components
);
3514 /* Do not install server-side matches for matches against the local service, interface or bus path. */
3515 if (scope
!= BUS_MATCH_LOCAL
) {
3517 /* We store the original match string, so that we can use it to remove the match again. */
3519 s
->match_callback
.match_string
= strdup(match
);
3520 if (!s
->match_callback
.match_string
) {
3526 r
= bus_add_match_internal_async(bus
,
3527 &s
->match_callback
.install_slot
,
3528 s
->match_callback
.match_string
,
3535 /* Make the slot of the match call floating now. We need the reference, but we don't
3536 * want that this match pins the bus object, hence we first create it non-floating, but
3537 * then make it floating. */
3538 r
= sd_bus_slot_set_floating(s
->match_callback
.install_slot
, true);
3540 r
= bus_add_match_internal(bus
, s
->match_callback
.match_string
, &s
->match_callback
.after
);
3544 s
->match_added
= true;
3548 bus
->match_callbacks_modified
= true;
3549 r
= bus_match_add(&bus
->match_callbacks
, components
, n_components
, &s
->match_callback
);
3558 bus_match_parse_free(components
, n_components
);
3559 sd_bus_slot_unref(s
);
3564 _public_
int sd_bus_add_match(
3568 sd_bus_message_handler_t callback
,
3571 return bus_add_match_full(bus
, slot
, false, match
, callback
, NULL
, userdata
);
3574 _public_
int sd_bus_add_match_async(
3578 sd_bus_message_handler_t callback
,
3579 sd_bus_message_handler_t install_callback
,
3582 return bus_add_match_full(bus
, slot
, true, match
, callback
, install_callback
, userdata
);
3585 bool bus_pid_changed(sd_bus
*bus
) {
3588 /* We don't support people creating a bus connection and
3589 * keeping it around over a fork(). Let's complain. */
3591 return bus
->original_pid
!= getpid_cached();
3594 static int io_callback(sd_event_source
*s
, int fd
, uint32_t revents
, void *userdata
) {
3595 sd_bus
*bus
= userdata
;
3600 /* Note that this is called both on input_fd, output_fd as well as inotify_fd events */
3602 r
= sd_bus_process(bus
, NULL
);
3604 log_debug_errno(r
, "Processing of bus failed, closing down: %m");
3605 bus_enter_closing(bus
);
3611 static int time_callback(sd_event_source
*s
, uint64_t usec
, void *userdata
) {
3612 sd_bus
*bus
= userdata
;
3617 r
= sd_bus_process(bus
, NULL
);
3619 log_debug_errno(r
, "Processing of bus failed, closing down: %m");
3620 bus_enter_closing(bus
);
3626 static int prepare_callback(sd_event_source
*s
, void *userdata
) {
3627 sd_bus
*bus
= userdata
;
3634 e
= sd_bus_get_events(bus
);
3640 if (bus
->output_fd
!= bus
->input_fd
) {
3642 r
= sd_event_source_set_io_events(bus
->input_io_event_source
, e
& POLLIN
);
3646 r
= sd_event_source_set_io_events(bus
->output_io_event_source
, e
& POLLOUT
);
3648 r
= sd_event_source_set_io_events(bus
->input_io_event_source
, e
);
3652 r
= sd_bus_get_timeout(bus
, &until
);
3658 j
= sd_event_source_set_time(bus
->time_event_source
, until
);
3665 r
= sd_event_source_set_enabled(bus
->time_event_source
, r
> 0);
3672 log_debug_errno(r
, "Preparing of bus events failed, closing down: %m");
3673 bus_enter_closing(bus
);
3678 static int quit_callback(sd_event_source
*event
, void *userdata
) {
3679 sd_bus
*bus
= userdata
;
3683 if (bus
->close_on_exit
) {
3691 int bus_attach_io_events(sd_bus
*bus
) {
3696 if (bus
->input_fd
< 0)
3702 if (!bus
->input_io_event_source
) {
3703 r
= sd_event_add_io(bus
->event
, &bus
->input_io_event_source
, bus
->input_fd
, 0, io_callback
, bus
);
3707 r
= sd_event_source_set_prepare(bus
->input_io_event_source
, prepare_callback
);
3711 r
= sd_event_source_set_priority(bus
->input_io_event_source
, bus
->event_priority
);
3715 r
= sd_event_source_set_description(bus
->input_io_event_source
, "bus-input");
3717 r
= sd_event_source_set_io_fd(bus
->input_io_event_source
, bus
->input_fd
);
3722 if (bus
->output_fd
!= bus
->input_fd
) {
3723 assert(bus
->output_fd
>= 0);
3725 if (!bus
->output_io_event_source
) {
3726 r
= sd_event_add_io(bus
->event
, &bus
->output_io_event_source
, bus
->output_fd
, 0, io_callback
, bus
);
3730 r
= sd_event_source_set_priority(bus
->output_io_event_source
, bus
->event_priority
);
3734 r
= sd_event_source_set_description(bus
->input_io_event_source
, "bus-output");
3736 r
= sd_event_source_set_io_fd(bus
->output_io_event_source
, bus
->output_fd
);
3745 static void bus_detach_io_events(sd_bus
*bus
) {
3748 if (bus
->input_io_event_source
) {
3749 sd_event_source_set_enabled(bus
->input_io_event_source
, SD_EVENT_OFF
);
3750 bus
->input_io_event_source
= sd_event_source_unref(bus
->input_io_event_source
);
3753 if (bus
->output_io_event_source
) {
3754 sd_event_source_set_enabled(bus
->output_io_event_source
, SD_EVENT_OFF
);
3755 bus
->output_io_event_source
= sd_event_source_unref(bus
->output_io_event_source
);
3759 int bus_attach_inotify_event(sd_bus
*bus
) {
3764 if (bus
->inotify_fd
< 0)
3770 if (!bus
->inotify_event_source
) {
3771 r
= sd_event_add_io(bus
->event
, &bus
->inotify_event_source
, bus
->inotify_fd
, EPOLLIN
, io_callback
, bus
);
3775 r
= sd_event_source_set_priority(bus
->inotify_event_source
, bus
->event_priority
);
3779 r
= sd_event_source_set_description(bus
->inotify_event_source
, "bus-inotify");
3781 r
= sd_event_source_set_io_fd(bus
->inotify_event_source
, bus
->inotify_fd
);
3788 static void bus_detach_inotify_event(sd_bus
*bus
) {
3791 if (bus
->inotify_event_source
) {
3792 sd_event_source_set_enabled(bus
->inotify_event_source
, SD_EVENT_OFF
);
3793 bus
->inotify_event_source
= sd_event_source_unref(bus
->inotify_event_source
);
3797 _public_
int sd_bus_attach_event(sd_bus
*bus
, sd_event
*event
, int priority
) {
3800 assert_return(bus
, -EINVAL
);
3801 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
3802 assert_return(!bus
->event
, -EBUSY
);
3804 assert(!bus
->input_io_event_source
);
3805 assert(!bus
->output_io_event_source
);
3806 assert(!bus
->time_event_source
);
3809 bus
->event
= sd_event_ref(event
);
3811 r
= sd_event_default(&bus
->event
);
3816 bus
->event_priority
= priority
;
3818 r
= sd_event_add_time(bus
->event
, &bus
->time_event_source
, CLOCK_MONOTONIC
, 0, 0, time_callback
, bus
);
3822 r
= sd_event_source_set_priority(bus
->time_event_source
, priority
);
3826 r
= sd_event_source_set_description(bus
->time_event_source
, "bus-time");
3830 r
= sd_event_add_exit(bus
->event
, &bus
->quit_event_source
, quit_callback
, bus
);
3834 r
= sd_event_source_set_description(bus
->quit_event_source
, "bus-exit");
3838 r
= bus_attach_io_events(bus
);
3842 r
= bus_attach_inotify_event(bus
);
3849 sd_bus_detach_event(bus
);
3853 _public_
int sd_bus_detach_event(sd_bus
*bus
) {
3854 assert_return(bus
, -EINVAL
);
3855 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
3860 bus_detach_io_events(bus
);
3861 bus_detach_inotify_event(bus
);
3863 if (bus
->time_event_source
) {
3864 sd_event_source_set_enabled(bus
->time_event_source
, SD_EVENT_OFF
);
3865 bus
->time_event_source
= sd_event_source_unref(bus
->time_event_source
);
3868 if (bus
->quit_event_source
) {
3869 sd_event_source_set_enabled(bus
->quit_event_source
, SD_EVENT_OFF
);
3870 bus
->quit_event_source
= sd_event_source_unref(bus
->quit_event_source
);
3873 bus
->event
= sd_event_unref(bus
->event
);
3877 _public_ sd_event
* sd_bus_get_event(sd_bus
*bus
) {
3878 assert_return(bus
= bus_resolve(bus
), NULL
);
3883 _public_ sd_bus_message
* sd_bus_get_current_message(sd_bus
*bus
) {
3884 assert_return(bus
= bus_resolve(bus
), NULL
);
3886 return bus
->current_message
;
3889 _public_ sd_bus_slot
* sd_bus_get_current_slot(sd_bus
*bus
) {
3890 assert_return(bus
= bus_resolve(bus
), NULL
);
3892 return bus
->current_slot
;
3895 _public_ sd_bus_message_handler_t
sd_bus_get_current_handler(sd_bus
*bus
) {
3896 assert_return(bus
= bus_resolve(bus
), NULL
);
3898 return bus
->current_handler
;
3901 _public_
void* sd_bus_get_current_userdata(sd_bus
*bus
) {
3902 assert_return(bus
= bus_resolve(bus
), NULL
);
3904 return bus
->current_userdata
;
3907 static int bus_default(int (*bus_open
)(sd_bus
**), sd_bus
**default_bus
, sd_bus
**ret
) {
3912 assert(default_bus
);
3915 return !!*default_bus
;
3918 *ret
= sd_bus_ref(*default_bus
);
3926 b
->default_bus_ptr
= default_bus
;
3934 _public_
int sd_bus_default_system(sd_bus
**ret
) {
3935 return bus_default(sd_bus_open_system
, &default_system_bus
, ret
);
3938 _public_
int sd_bus_default_user(sd_bus
**ret
) {
3939 return bus_default(sd_bus_open_user
, &default_user_bus
, ret
);
3942 _public_
int sd_bus_default(sd_bus
**ret
) {
3943 int (*bus_open
)(sd_bus
**) = NULL
;
3946 busp
= bus_choose_default(&bus_open
);
3947 return bus_default(bus_open
, busp
, ret
);
3950 _public_
int sd_bus_get_tid(sd_bus
*b
, pid_t
*tid
) {
3951 assert_return(b
, -EINVAL
);
3952 assert_return(tid
, -EINVAL
);
3953 assert_return(!bus_pid_changed(b
), -ECHILD
);
3961 return sd_event_get_tid(b
->event
, tid
);
3966 _public_
int sd_bus_path_encode(const char *prefix
, const char *external_id
, char **ret_path
) {
3967 _cleanup_free_
char *e
= NULL
;
3970 assert_return(object_path_is_valid(prefix
), -EINVAL
);
3971 assert_return(external_id
, -EINVAL
);
3972 assert_return(ret_path
, -EINVAL
);
3974 e
= bus_label_escape(external_id
);
3978 ret
= path_join(prefix
, e
);
3986 _public_
int sd_bus_path_decode(const char *path
, const char *prefix
, char **external_id
) {
3990 assert_return(object_path_is_valid(path
), -EINVAL
);
3991 assert_return(object_path_is_valid(prefix
), -EINVAL
);
3992 assert_return(external_id
, -EINVAL
);
3994 e
= object_path_startswith(path
, prefix
);
3996 *external_id
= NULL
;
4000 ret
= bus_label_unescape(e
);
4008 _public_
int sd_bus_path_encode_many(char **out
, const char *path_template
, ...) {
4009 _cleanup_strv_free_
char **labels
= NULL
;
4010 char *path
, *path_pos
, **label_pos
;
4011 const char *sep
, *template_pos
;
4016 assert_return(out
, -EINVAL
);
4017 assert_return(path_template
, -EINVAL
);
4019 path_length
= strlen(path_template
);
4021 va_start(list
, path_template
);
4022 for (sep
= strchr(path_template
, '%'); sep
; sep
= strchr(sep
+ 1, '%')) {
4026 arg
= va_arg(list
, const char *);
4032 label
= bus_label_escape(arg
);
4038 r
= strv_consume(&labels
, label
);
4044 /* add label length, but account for the format character */
4045 path_length
+= strlen(label
) - 1;
4049 path
= malloc(path_length
+ 1);
4056 for (template_pos
= path_template
; *template_pos
; ) {
4057 sep
= strchrnul(template_pos
, '%');
4058 path_pos
= mempcpy(path_pos
, template_pos
, sep
- template_pos
);
4062 path_pos
= stpcpy(path_pos
, *label_pos
++);
4063 template_pos
= sep
+ 1;
4071 _public_
int sd_bus_path_decode_many(const char *path
, const char *path_template
, ...) {
4072 _cleanup_strv_free_
char **labels
= NULL
;
4073 const char *template_pos
, *path_pos
;
4079 * This decodes an object-path based on a template argument. The
4080 * template consists of a verbatim path, optionally including special
4083 * - Each occurrence of '%' in the template matches an arbitrary
4084 * substring of a label in the given path. At most one such
4085 * directive is allowed per label. For each such directive, the
4086 * caller must provide an output parameter (char **) via va_arg. If
4087 * NULL is passed, the given label is verified, but not returned.
4088 * For each matched label, the *decoded* label is stored in the
4089 * passed output argument, and the caller is responsible to free
4090 * it. Note that the output arguments are only modified if the
4091 * actually path matched the template. Otherwise, they're left
4094 * This function returns <0 on error, 0 if the path does not match the
4095 * template, 1 if it matched.
4098 assert_return(path
, -EINVAL
);
4099 assert_return(path_template
, -EINVAL
);
4103 for (template_pos
= path_template
; *template_pos
; ) {
4108 /* verify everything until the next '%' matches verbatim */
4109 sep
= strchrnul(template_pos
, '%');
4110 length
= sep
- template_pos
;
4111 if (strncmp(path_pos
, template_pos
, length
))
4115 template_pos
+= length
;
4120 /* We found the next '%' character. Everything up until here
4121 * matched. We now skip ahead to the end of this label and make
4122 * sure it matches the tail of the label in the path. Then we
4123 * decode the string in-between and save it for later use. */
4125 ++template_pos
; /* skip over '%' */
4127 sep
= strchrnul(template_pos
, '/');
4128 length
= sep
- template_pos
; /* length of suffix to match verbatim */
4130 /* verify the suffixes match */
4131 sep
= strchrnul(path_pos
, '/');
4132 if (sep
- path_pos
< (ssize_t
)length
||
4133 strncmp(sep
- length
, template_pos
, length
))
4136 template_pos
+= length
; /* skip over matched label */
4137 length
= sep
- path_pos
- length
; /* length of sub-label to decode */
4139 /* store unescaped label for later use */
4140 label
= bus_label_unescape_n(path_pos
, length
);
4144 r
= strv_consume(&labels
, label
);
4148 path_pos
= sep
; /* skip decoded label and suffix */
4151 /* end of template must match end of path */
4155 /* copy the labels over to the caller */
4156 va_start(list
, path_template
);
4157 for (label_pos
= labels
; label_pos
&& *label_pos
; ++label_pos
) {
4160 arg
= va_arg(list
, char **);
4168 labels
= mfree(labels
);
4172 _public_
int sd_bus_try_close(sd_bus
*bus
) {
4173 assert_return(bus
, -EINVAL
);
4174 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4175 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4180 _public_
int sd_bus_get_description(sd_bus
*bus
, const char **description
) {
4181 assert_return(bus
, -EINVAL
);
4182 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4183 assert_return(description
, -EINVAL
);
4184 assert_return(bus
->description
, -ENXIO
);
4185 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4187 if (bus
->description
)
4188 *description
= bus
->description
;
4189 else if (bus
->is_system
)
4190 *description
= "system";
4191 else if (bus
->is_user
)
4192 *description
= "user";
4194 *description
= NULL
;
4199 _public_
int sd_bus_get_scope(sd_bus
*bus
, const char **scope
) {
4200 assert_return(bus
, -EINVAL
);
4201 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4202 assert_return(scope
, -EINVAL
);
4203 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4210 if (bus
->is_system
) {
4218 _public_
int sd_bus_get_address(sd_bus
*bus
, const char **address
) {
4219 assert_return(bus
, -EINVAL
);
4220 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4221 assert_return(address
, -EINVAL
);
4222 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4225 *address
= bus
->address
;
4232 _public_
int sd_bus_get_creds_mask(sd_bus
*bus
, uint64_t *mask
) {
4233 assert_return(bus
, -EINVAL
);
4234 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4235 assert_return(mask
, -EINVAL
);
4236 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4238 *mask
= bus
->creds_mask
;
4242 _public_
int sd_bus_is_bus_client(sd_bus
*bus
) {
4243 assert_return(bus
, -EINVAL
);
4244 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4245 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4247 return bus
->bus_client
;
4250 _public_
int sd_bus_is_server(sd_bus
*bus
) {
4251 assert_return(bus
, -EINVAL
);
4252 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4253 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4255 return bus
->is_server
;
4258 _public_
int sd_bus_is_anonymous(sd_bus
*bus
) {
4259 assert_return(bus
, -EINVAL
);
4260 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4261 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4263 return bus
->anonymous_auth
;
4266 _public_
int sd_bus_is_trusted(sd_bus
*bus
) {
4267 assert_return(bus
, -EINVAL
);
4268 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4269 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4271 return bus
->trusted
;
4274 _public_
int sd_bus_is_monitor(sd_bus
*bus
) {
4275 assert_return(bus
, -EINVAL
);
4276 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4277 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4279 return bus
->is_monitor
;
4282 static void flush_close(sd_bus
*bus
) {
4286 /* Flushes and closes the specified bus. We take a ref before,
4287 * to ensure the flushing does not cause the bus to be
4290 sd_bus_flush_close_unref(sd_bus_ref(bus
));
4293 _public_
void sd_bus_default_flush_close(void) {
4294 flush_close(default_starter_bus
);
4295 flush_close(default_user_bus
);
4296 flush_close(default_system_bus
);
4299 _public_
int sd_bus_set_exit_on_disconnect(sd_bus
*bus
, int b
) {
4300 assert_return(bus
, -EINVAL
);
4301 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4303 /* Turns on exit-on-disconnect, and triggers it immediately if the bus connection was already
4304 * disconnected. Note that this is triggered exclusively on disconnections triggered by the server side, never
4305 * from the client side. */
4306 bus
->exit_on_disconnect
= b
;
4308 /* If the exit condition was triggered already, exit immediately. */
4309 return bus_exit_now(bus
);
4312 _public_
int sd_bus_get_exit_on_disconnect(sd_bus
*bus
) {
4313 assert_return(bus
, -EINVAL
);
4314 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4316 return bus
->exit_on_disconnect
;
4319 _public_
int sd_bus_set_sender(sd_bus
*bus
, const char *sender
) {
4320 assert_return(bus
, -EINVAL
);
4321 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4322 assert_return(!bus
->bus_client
, -EPERM
);
4323 assert_return(!sender
|| service_name_is_valid(sender
), -EINVAL
);
4325 return free_and_strdup(&bus
->patch_sender
, sender
);
4328 _public_
int sd_bus_get_sender(sd_bus
*bus
, const char **ret
) {
4329 assert_return(bus
, -EINVAL
);
4330 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4331 assert_return(ret
, -EINVAL
);
4333 if (!bus
->patch_sender
)
4336 *ret
= bus
->patch_sender
;
4340 _public_
int sd_bus_get_n_queued_read(sd_bus
*bus
, uint64_t *ret
) {
4341 assert_return(bus
, -EINVAL
);
4342 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4343 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4344 assert_return(ret
, -EINVAL
);
4346 *ret
= bus
->rqueue_size
;
4350 _public_
int sd_bus_get_n_queued_write(sd_bus
*bus
, uint64_t *ret
) {
4351 assert_return(bus
, -EINVAL
);
4352 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4353 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4354 assert_return(ret
, -EINVAL
);
4356 *ret
= bus
->wqueue_size
;
4360 _public_
int sd_bus_set_method_call_timeout(sd_bus
*bus
, uint64_t usec
) {
4361 assert_return(bus
, -EINVAL
);
4362 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4364 bus
->method_call_timeout
= usec
;
4368 _public_
int sd_bus_get_method_call_timeout(sd_bus
*bus
, uint64_t *ret
) {
4372 assert_return(bus
, -EINVAL
);
4373 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4374 assert_return(ret
, -EINVAL
);
4376 if (bus
->method_call_timeout
!= 0) {
4377 *ret
= bus
->method_call_timeout
;
4381 e
= secure_getenv("SYSTEMD_BUS_TIMEOUT");
4382 if (e
&& parse_sec(e
, &usec
) >= 0 && usec
!= 0) {
4383 /* Save the parsed value to avoid multiple parsing. To change the timeout value,
4384 * use sd_bus_set_method_call_timeout() instead of setenv(). */
4385 *ret
= bus
->method_call_timeout
= usec
;
4389 *ret
= bus
->method_call_timeout
= BUS_DEFAULT_TIMEOUT
;
4393 _public_
int sd_bus_set_close_on_exit(sd_bus
*bus
, int b
) {
4394 assert_return(bus
, -EINVAL
);
4395 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4397 bus
->close_on_exit
= b
;
4401 _public_
int sd_bus_get_close_on_exit(sd_bus
*bus
) {
4402 assert_return(bus
, -EINVAL
);
4403 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4405 return bus
->close_on_exit
;
4408 _public_
int sd_bus_enqueue_for_read(sd_bus
*bus
, sd_bus_message
*m
) {
4411 assert_return(bus
, -EINVAL
);
4412 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
4413 assert_return(m
, -EINVAL
);
4414 assert_return(m
->sealed
, -EINVAL
);
4415 assert_return(!bus_pid_changed(bus
), -ECHILD
);
4417 if (!BUS_IS_OPEN(bus
->state
))
4420 /* Re-enqueue a message for reading. This is primarily useful for PolicyKit-style authentication,
4421 * where we accept a message, then determine we need to interactively authenticate the user, and then
4422 * we want to process the message again. */
4424 r
= bus_rqueue_make_room(bus
);
4428 bus
->rqueue
[bus
->rqueue_size
++] = bus_message_ref_queued(m
, bus
);
projects / thirdparty / systemd.git / blob