1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 #include "alloc-util.h"
4 #include "bus-internal.h"
5 #include "bus-introspect.h"
6 #include "bus-message.h"
7 #include "bus-objects.h"
8 #include "bus-signature.h"
12 #include "missing_capability.h"
14 #include "string-util.h"
17 static int node_vtable_get_userdata(
20 struct node_vtable
*c
,
22 sd_bus_error
*error
) {
32 s
= container_of(c
, sd_bus_slot
, node_vtable
);
35 bus
->current_slot
= sd_bus_slot_ref(s
);
36 bus
->current_userdata
= u
;
37 r
= c
->find(bus
, path
, c
->interface
, u
, &found_u
, error
);
38 bus
->current_userdata
= NULL
;
39 bus
->current_slot
= sd_bus_slot_unref(s
);
43 if (sd_bus_error_is_set(error
))
44 return -sd_bus_error_get_errno(error
);
56 static void *vtable_method_convert_userdata(const sd_bus_vtable
*p
, void *u
) {
59 return (uint8_t*) u
+ p
->x
.method
.offset
;
62 static void *vtable_property_convert_userdata(const sd_bus_vtable
*p
, void *u
) {
65 return (uint8_t*) u
+ p
->x
.property
.offset
;
68 static int vtable_property_get_userdata(
71 struct vtable_member
*p
,
73 sd_bus_error
*error
) {
83 r
= node_vtable_get_userdata(bus
, path
, p
->parent
, &u
, error
);
86 if (bus
->nodes_modified
)
89 *userdata
= vtable_property_convert_userdata(p
->vtable
, u
);
93 static int add_enumerated_to_set(
96 struct node_enumerator
*first
,
98 sd_bus_error
*error
) {
100 struct node_enumerator
*c
;
107 LIST_FOREACH(enumerators
, c
, first
) {
108 char **children
= NULL
, **k
;
111 if (bus
->nodes_modified
)
114 slot
= container_of(c
, sd_bus_slot
, node_enumerator
);
116 bus
->current_slot
= sd_bus_slot_ref(slot
);
117 bus
->current_userdata
= slot
->userdata
;
118 r
= c
->callback(bus
, prefix
, slot
->userdata
, &children
, error
);
119 bus
->current_userdata
= NULL
;
120 bus
->current_slot
= sd_bus_slot_unref(slot
);
124 if (sd_bus_error_is_set(error
))
125 return -sd_bus_error_get_errno(error
);
127 STRV_FOREACH(k
, children
) {
133 if (!object_path_is_valid(*k
)) {
139 if (!object_path_startswith(*k
, prefix
)) {
144 r
= set_consume(s
, *k
);
158 /* if set, add_subtree() works recursively */
159 CHILDREN_RECURSIVE
= 1 << 0,
160 /* if set, add_subtree() scans object-manager hierarchies recursively */
161 CHILDREN_SUBHIERARCHIES
= 1 << 1,
164 static int add_subtree_to_set(
170 sd_bus_error
*error
) {
180 r
= add_enumerated_to_set(bus
, prefix
, n
->enumerators
, s
, error
);
183 if (bus
->nodes_modified
)
186 LIST_FOREACH(siblings
, i
, n
->child
) {
189 if (!object_path_startswith(i
->path
, prefix
))
196 r
= set_consume(s
, t
);
197 if (r
< 0 && r
!= -EEXIST
)
200 if ((flags
& CHILDREN_RECURSIVE
) &&
201 ((flags
& CHILDREN_SUBHIERARCHIES
) || !i
->object_managers
)) {
202 r
= add_subtree_to_set(bus
, prefix
, i
, flags
, s
, error
);
205 if (bus
->nodes_modified
)
213 static int get_child_nodes(
219 sd_bus_error
*error
) {
229 s
= set_new(&string_hash_ops
);
233 r
= add_subtree_to_set(bus
, prefix
, n
, flags
, s
, error
);
243 static int node_callbacks_run(
246 struct node_callback
*first
,
247 bool require_fallback
,
248 bool *found_object
) {
250 struct node_callback
*c
;
255 assert(found_object
);
257 LIST_FOREACH(callbacks
, c
, first
) {
258 _cleanup_(sd_bus_error_free
) sd_bus_error error_buffer
= SD_BUS_ERROR_NULL
;
261 if (bus
->nodes_modified
)
264 if (require_fallback
&& !c
->is_fallback
)
267 *found_object
= true;
269 if (c
->last_iteration
== bus
->iteration_counter
)
272 c
->last_iteration
= bus
->iteration_counter
;
274 r
= sd_bus_message_rewind(m
, true);
278 slot
= container_of(c
, sd_bus_slot
, node_callback
);
280 bus
->current_slot
= sd_bus_slot_ref(slot
);
281 bus
->current_handler
= c
->callback
;
282 bus
->current_userdata
= slot
->userdata
;
283 r
= c
->callback(m
, slot
->userdata
, &error_buffer
);
284 bus
->current_userdata
= NULL
;
285 bus
->current_handler
= NULL
;
286 bus
->current_slot
= sd_bus_slot_unref(slot
);
288 r
= bus_maybe_reply_error(m
, r
, &error_buffer
);
296 #define CAPABILITY_SHIFT(x) (((x) >> __builtin_ctzll(_SD_BUS_VTABLE_CAPABILITY_MASK)) & 0xFFFF)
298 static int check_access(sd_bus
*bus
, sd_bus_message
*m
, struct vtable_member
*c
, sd_bus_error
*error
) {
306 /* If the entire bus is trusted let's grant access */
310 /* If the member is marked UNPRIVILEGED let's grant access */
311 if (c
->vtable
->flags
& SD_BUS_VTABLE_UNPRIVILEGED
)
314 /* Check have the caller has the requested capability
315 * set. Note that the flags value contains the capability
316 * number plus one, which we need to subtract here. We do this
317 * so that we have 0 as special value for "default
319 cap
= CAPABILITY_SHIFT(c
->vtable
->flags
);
321 cap
= CAPABILITY_SHIFT(c
->parent
->vtable
[0].flags
);
327 r
= sd_bus_query_sender_privilege(m
, cap
);
333 return sd_bus_error_setf(error
, SD_BUS_ERROR_ACCESS_DENIED
, "Access to %s.%s() not permitted.", c
->interface
, c
->member
);
336 static int method_callbacks_run(
339 struct vtable_member
*c
,
340 bool require_fallback
,
341 bool *found_object
) {
343 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
344 const char *signature
;
351 assert(found_object
);
353 if (require_fallback
&& !c
->parent
->is_fallback
)
356 r
= check_access(bus
, m
, c
, &error
);
358 return bus_maybe_reply_error(m
, r
, &error
);
360 r
= node_vtable_get_userdata(bus
, m
->path
, c
->parent
, &u
, &error
);
362 return bus_maybe_reply_error(m
, r
, &error
);
363 if (bus
->nodes_modified
)
366 u
= vtable_method_convert_userdata(c
->vtable
, u
);
368 *found_object
= true;
370 if (c
->last_iteration
== bus
->iteration_counter
)
373 c
->last_iteration
= bus
->iteration_counter
;
375 r
= sd_bus_message_rewind(m
, true);
379 signature
= sd_bus_message_get_signature(m
, true);
383 if (!streq(strempty(c
->vtable
->x
.method
.signature
), signature
))
384 return sd_bus_reply_method_errorf(
386 SD_BUS_ERROR_INVALID_ARGS
,
387 "Invalid arguments '%s' to call %s.%s(), expecting '%s'.",
388 signature
, c
->interface
, c
->member
, strempty(c
->vtable
->x
.method
.signature
));
390 /* Keep track what the signature of the reply to this message
391 * should be, so that this can be enforced when sealing the
393 m
->enforced_reply_signature
= strempty(c
->vtable
->x
.method
.result
);
395 if (c
->vtable
->x
.method
.handler
) {
398 slot
= container_of(c
->parent
, sd_bus_slot
, node_vtable
);
400 bus
->current_slot
= sd_bus_slot_ref(slot
);
401 bus
->current_handler
= c
->vtable
->x
.method
.handler
;
402 bus
->current_userdata
= u
;
403 r
= c
->vtable
->x
.method
.handler(m
, u
, &error
);
404 bus
->current_userdata
= NULL
;
405 bus
->current_handler
= NULL
;
406 bus
->current_slot
= sd_bus_slot_unref(slot
);
408 return bus_maybe_reply_error(m
, r
, &error
);
411 /* If the method callback is NULL, make this a successful NOP */
412 r
= sd_bus_reply_method_return(m
, NULL
);
419 static int invoke_property_get(
422 const sd_bus_vtable
*v
,
424 const char *interface
,
425 const char *property
,
426 sd_bus_message
*reply
,
428 sd_bus_error
*error
) {
441 if (v
->x
.property
.get
) {
443 bus
->current_slot
= sd_bus_slot_ref(slot
);
444 bus
->current_userdata
= userdata
;
445 r
= v
->x
.property
.get(bus
, path
, interface
, property
, reply
, userdata
, error
);
446 bus
->current_userdata
= NULL
;
447 bus
->current_slot
= sd_bus_slot_unref(slot
);
451 if (sd_bus_error_is_set(error
))
452 return -sd_bus_error_get_errno(error
);
456 /* Automatic handling if no callback is defined. */
458 if (streq(v
->x
.property
.signature
, "as"))
459 return sd_bus_message_append_strv(reply
, *(char***) userdata
);
461 assert(signature_is_single(v
->x
.property
.signature
, false));
462 assert(bus_type_is_basic(v
->x
.property
.signature
[0]));
464 switch (v
->x
.property
.signature
[0]) {
466 case SD_BUS_TYPE_STRING
:
467 case SD_BUS_TYPE_SIGNATURE
:
468 p
= strempty(*(char**) userdata
);
471 case SD_BUS_TYPE_OBJECT_PATH
:
472 p
= *(char**) userdata
;
481 return sd_bus_message_append_basic(reply
, v
->x
.property
.signature
[0], p
);
484 static int invoke_property_set(
487 const sd_bus_vtable
*v
,
489 const char *interface
,
490 const char *property
,
491 sd_bus_message
*value
,
493 sd_bus_error
*error
) {
505 if (v
->x
.property
.set
) {
507 bus
->current_slot
= sd_bus_slot_ref(slot
);
508 bus
->current_userdata
= userdata
;
509 r
= v
->x
.property
.set(bus
, path
, interface
, property
, value
, userdata
, error
);
510 bus
->current_userdata
= NULL
;
511 bus
->current_slot
= sd_bus_slot_unref(slot
);
515 if (sd_bus_error_is_set(error
))
516 return -sd_bus_error_get_errno(error
);
520 /* Automatic handling if no callback is defined. */
522 assert(signature_is_single(v
->x
.property
.signature
, false));
523 assert(bus_type_is_basic(v
->x
.property
.signature
[0]));
525 switch (v
->x
.property
.signature
[0]) {
527 case SD_BUS_TYPE_STRING
:
528 case SD_BUS_TYPE_OBJECT_PATH
:
529 case SD_BUS_TYPE_SIGNATURE
: {
533 r
= sd_bus_message_read_basic(value
, v
->x
.property
.signature
[0], &p
);
541 free(*(char**) userdata
);
542 *(char**) userdata
= n
;
548 r
= sd_bus_message_read_basic(value
, v
->x
.property
.signature
[0], userdata
);
558 static int property_get_set_callbacks_run(
561 struct vtable_member
*c
,
562 bool require_fallback
,
564 bool *found_object
) {
566 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
567 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
575 assert(found_object
);
577 if (require_fallback
&& !c
->parent
->is_fallback
)
580 r
= vtable_property_get_userdata(bus
, m
->path
, c
, &u
, &error
);
582 return bus_maybe_reply_error(m
, r
, &error
);
583 if (bus
->nodes_modified
)
586 slot
= container_of(c
->parent
, sd_bus_slot
, node_vtable
);
588 *found_object
= true;
590 r
= sd_bus_message_new_method_return(m
, &reply
);
595 /* Note that we do not protect against reexecution
596 * here (using the last_iteration check, see below),
597 * should the node tree have changed and we got called
598 * again. We assume that property Get() calls are
599 * ultimately without side-effects or if they aren't
600 * then at least idempotent. */
602 r
= sd_bus_message_open_container(reply
, 'v', c
->vtable
->x
.property
.signature
);
606 /* Note that we do not do an access check here. Read
607 * access to properties is always unrestricted, since
608 * PropertiesChanged signals broadcast contents
611 r
= invoke_property_get(bus
, slot
, c
->vtable
, m
->path
, c
->interface
, c
->member
, reply
, u
, &error
);
613 return bus_maybe_reply_error(m
, r
, &error
);
615 if (bus
->nodes_modified
)
618 r
= sd_bus_message_close_container(reply
);
623 const char *signature
= NULL
;
626 if (c
->vtable
->type
!= _SD_BUS_VTABLE_WRITABLE_PROPERTY
)
627 return sd_bus_reply_method_errorf(m
, SD_BUS_ERROR_PROPERTY_READ_ONLY
, "Property '%s' is not writable.", c
->member
);
629 /* Avoid that we call the set routine more than once
630 * if the processing of this message got restarted
631 * because the node tree changed. */
632 if (c
->last_iteration
== bus
->iteration_counter
)
635 c
->last_iteration
= bus
->iteration_counter
;
637 r
= sd_bus_message_peek_type(m
, &type
, &signature
);
641 if (type
!= 'v' || !streq(strempty(signature
), strempty(c
->vtable
->x
.property
.signature
)))
642 return sd_bus_reply_method_errorf(m
, SD_BUS_ERROR_INVALID_ARGS
, "Incorrect parameters for property '%s', expected '%s', got '%s'.", c
->member
, strempty(c
->vtable
->x
.property
.signature
), strempty(signature
));
644 r
= sd_bus_message_enter_container(m
, 'v', c
->vtable
->x
.property
.signature
);
648 r
= check_access(bus
, m
, c
, &error
);
650 return bus_maybe_reply_error(m
, r
, &error
);
652 r
= invoke_property_set(bus
, slot
, c
->vtable
, m
->path
, c
->interface
, c
->member
, m
, u
, &error
);
654 return bus_maybe_reply_error(m
, r
, &error
);
656 if (bus
->nodes_modified
)
659 r
= sd_bus_message_exit_container(m
);
664 r
= sd_bus_send(bus
, reply
, NULL
);
671 static int vtable_append_one_property(
673 sd_bus_message
*reply
,
675 struct node_vtable
*c
,
676 const sd_bus_vtable
*v
,
678 sd_bus_error
*error
) {
689 r
= sd_bus_message_open_container(reply
, 'e', "sv");
693 r
= sd_bus_message_append(reply
, "s", v
->x
.property
.member
);
697 r
= sd_bus_message_open_container(reply
, 'v', v
->x
.property
.signature
);
701 slot
= container_of(c
, sd_bus_slot
, node_vtable
);
703 r
= invoke_property_get(bus
, slot
, v
, path
, c
->interface
, v
->x
.property
.member
, reply
, vtable_property_convert_userdata(v
, userdata
), error
);
706 if (bus
->nodes_modified
)
709 r
= sd_bus_message_close_container(reply
);
713 r
= sd_bus_message_close_container(reply
);
720 static int vtable_append_all_properties(
722 sd_bus_message
*reply
,
724 struct node_vtable
*c
,
726 sd_bus_error
*error
) {
728 const sd_bus_vtable
*v
;
736 if (c
->vtable
[0].flags
& SD_BUS_VTABLE_HIDDEN
)
739 for (v
= c
->vtable
+1; v
->type
!= _SD_BUS_VTABLE_END
; v
++) {
740 if (!IN_SET(v
->type
, _SD_BUS_VTABLE_PROPERTY
, _SD_BUS_VTABLE_WRITABLE_PROPERTY
))
743 if (v
->flags
& SD_BUS_VTABLE_HIDDEN
)
746 if (v
->flags
& SD_BUS_VTABLE_PROPERTY_EXPLICIT
)
749 r
= vtable_append_one_property(bus
, reply
, path
, c
, v
, userdata
, error
);
752 if (bus
->nodes_modified
)
759 static int property_get_all_callbacks_run(
762 struct node_vtable
*first
,
763 bool require_fallback
,
765 bool *found_object
) {
767 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
768 struct node_vtable
*c
;
769 bool found_interface
;
774 assert(found_object
);
776 r
= sd_bus_message_new_method_return(m
, &reply
);
780 r
= sd_bus_message_open_container(reply
, 'a', "{sv}");
784 found_interface
= !iface
||
785 streq(iface
, "org.freedesktop.DBus.Properties") ||
786 streq(iface
, "org.freedesktop.DBus.Peer") ||
787 streq(iface
, "org.freedesktop.DBus.Introspectable");
789 LIST_FOREACH(vtables
, c
, first
) {
790 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
793 if (require_fallback
&& !c
->is_fallback
)
796 r
= node_vtable_get_userdata(bus
, m
->path
, c
, &u
, &error
);
798 return bus_maybe_reply_error(m
, r
, &error
);
799 if (bus
->nodes_modified
)
804 *found_object
= true;
806 if (iface
&& !streq(c
->interface
, iface
))
808 found_interface
= true;
810 r
= vtable_append_all_properties(bus
, reply
, m
->path
, c
, u
, &error
);
812 return bus_maybe_reply_error(m
, r
, &error
);
813 if (bus
->nodes_modified
)
820 if (!found_interface
) {
821 r
= sd_bus_reply_method_errorf(
823 SD_BUS_ERROR_UNKNOWN_INTERFACE
,
824 "Unknown interface '%s'.", iface
);
831 r
= sd_bus_message_close_container(reply
);
835 r
= sd_bus_send(bus
, reply
, NULL
);
842 static int bus_node_exists(
846 bool require_fallback
) {
848 struct node_vtable
*c
;
849 struct node_callback
*k
;
856 /* Tests if there's anything attached directly to this node
857 * for the specified path */
859 if (!require_fallback
&& (n
->enumerators
|| n
->object_managers
))
862 LIST_FOREACH(callbacks
, k
, n
->callbacks
) {
863 if (require_fallback
&& !k
->is_fallback
)
869 LIST_FOREACH(vtables
, c
, n
->vtables
) {
870 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
872 if (require_fallback
&& !c
->is_fallback
)
875 r
= node_vtable_get_userdata(bus
, path
, c
, NULL
, &error
);
878 if (bus
->nodes_modified
)
885 static int process_introspect(
889 bool require_fallback
,
890 bool *found_object
) {
892 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
893 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
894 _cleanup_set_free_free_ Set
*s
= NULL
;
895 const char *previous_interface
= NULL
;
896 struct introspect intro
;
897 struct node_vtable
*c
;
904 assert(found_object
);
906 r
= get_child_nodes(bus
, m
->path
, n
, 0, &s
, &error
);
908 return bus_maybe_reply_error(m
, r
, &error
);
909 if (bus
->nodes_modified
)
912 r
= introspect_begin(&intro
, bus
->trusted
);
916 r
= introspect_write_default_interfaces(&intro
, !require_fallback
&& n
->object_managers
);
920 empty
= set_isempty(s
);
922 LIST_FOREACH(vtables
, c
, n
->vtables
) {
923 if (require_fallback
&& !c
->is_fallback
)
926 r
= node_vtable_get_userdata(bus
, m
->path
, c
, NULL
, &error
);
928 r
= bus_maybe_reply_error(m
, r
, &error
);
931 if (bus
->nodes_modified
) {
940 if (c
->vtable
[0].flags
& SD_BUS_VTABLE_HIDDEN
)
943 if (!streq_ptr(previous_interface
, c
->interface
)) {
945 if (previous_interface
)
946 fputs(" </interface>\n", intro
.f
);
948 fprintf(intro
.f
, " <interface name=\"%s\">\n", c
->interface
);
951 r
= introspect_write_interface(&intro
, c
->vtable
);
955 previous_interface
= c
->interface
;
958 if (previous_interface
)
959 fputs(" </interface>\n", intro
.f
);
962 /* Nothing?, let's see if we exist at all, and if not
963 * refuse to do anything */
964 r
= bus_node_exists(bus
, n
, m
->path
, require_fallback
);
966 r
= bus_maybe_reply_error(m
, r
, &error
);
969 if (bus
->nodes_modified
) {
975 *found_object
= true;
977 r
= introspect_write_child_nodes(&intro
, s
, m
->path
);
981 r
= introspect_finish(&intro
, bus
, m
, &reply
);
985 r
= sd_bus_send(bus
, reply
, NULL
);
992 introspect_free(&intro
);
996 static int object_manager_serialize_path(
998 sd_bus_message
*reply
,
1001 bool require_fallback
,
1002 sd_bus_error
*error
) {
1004 const char *previous_interface
= NULL
;
1005 bool found_something
= false;
1006 struct node_vtable
*i
;
1016 n
= hashmap_get(bus
->nodes
, prefix
);
1020 LIST_FOREACH(vtables
, i
, n
->vtables
) {
1023 if (require_fallback
&& !i
->is_fallback
)
1026 r
= node_vtable_get_userdata(bus
, path
, i
, &u
, error
);
1029 if (bus
->nodes_modified
)
1034 if (!found_something
) {
1036 /* Open the object part */
1038 r
= sd_bus_message_open_container(reply
, 'e', "oa{sa{sv}}");
1042 r
= sd_bus_message_append(reply
, "o", path
);
1046 r
= sd_bus_message_open_container(reply
, 'a', "{sa{sv}}");
1050 r
= sd_bus_message_append(reply
, "{sa{sv}}", "org.freedesktop.DBus.Peer", 0);
1054 r
= sd_bus_message_append(reply
, "{sa{sv}}", "org.freedesktop.DBus.Introspectable", 0);
1058 r
= sd_bus_message_append(reply
, "{sa{sv}}", "org.freedesktop.DBus.Properties", 0);
1062 r
= sd_bus_message_append(reply
, "{sa{sv}}", "org.freedesktop.DBus.ObjectManager", 0);
1066 found_something
= true;
1069 if (!streq_ptr(previous_interface
, i
->interface
)) {
1071 /* Maybe close the previous interface part */
1073 if (previous_interface
) {
1074 r
= sd_bus_message_close_container(reply
);
1078 r
= sd_bus_message_close_container(reply
);
1083 /* Open the new interface part */
1085 r
= sd_bus_message_open_container(reply
, 'e', "sa{sv}");
1089 r
= sd_bus_message_append(reply
, "s", i
->interface
);
1093 r
= sd_bus_message_open_container(reply
, 'a', "{sv}");
1098 r
= vtable_append_all_properties(bus
, reply
, path
, i
, u
, error
);
1101 if (bus
->nodes_modified
)
1104 previous_interface
= i
->interface
;
1107 if (previous_interface
) {
1108 r
= sd_bus_message_close_container(reply
);
1112 r
= sd_bus_message_close_container(reply
);
1117 if (found_something
) {
1118 r
= sd_bus_message_close_container(reply
);
1122 r
= sd_bus_message_close_container(reply
);
1130 static int object_manager_serialize_path_and_fallbacks(
1132 sd_bus_message
*reply
,
1134 sd_bus_error
*error
) {
1144 /* First, add all vtables registered for this path */
1145 r
= object_manager_serialize_path(bus
, reply
, path
, path
, false, error
);
1148 if (bus
->nodes_modified
)
1151 /* Second, add fallback vtables registered for any of the prefixes */
1152 prefix
= newa(char, strlen(path
) + 1);
1153 OBJECT_PATH_FOREACH_PREFIX(prefix
, path
) {
1154 r
= object_manager_serialize_path(bus
, reply
, prefix
, path
, true, error
);
1157 if (bus
->nodes_modified
)
1164 static int process_get_managed_objects(
1168 bool require_fallback
,
1169 bool *found_object
) {
1171 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1172 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
1173 _cleanup_set_free_free_ Set
*s
= NULL
;
1181 assert(found_object
);
1183 /* Spec says, GetManagedObjects() is only implemented on the root of a
1184 * sub-tree. Therefore, we require a registered object-manager on
1185 * exactly the queried path, otherwise, we refuse to respond. */
1187 if (require_fallback
|| !n
->object_managers
)
1190 r
= get_child_nodes(bus
, m
->path
, n
, CHILDREN_RECURSIVE
, &s
, &error
);
1192 return bus_maybe_reply_error(m
, r
, &error
);
1193 if (bus
->nodes_modified
)
1196 r
= sd_bus_message_new_method_return(m
, &reply
);
1200 r
= sd_bus_message_open_container(reply
, 'a', "{oa{sa{sv}}}");
1204 SET_FOREACH(path
, s
, i
) {
1205 r
= object_manager_serialize_path_and_fallbacks(bus
, reply
, path
, &error
);
1207 return bus_maybe_reply_error(m
, r
, &error
);
1209 if (bus
->nodes_modified
)
1213 r
= sd_bus_message_close_container(reply
);
1217 r
= sd_bus_send(bus
, reply
, NULL
);
1224 static int object_find_and_run(
1228 bool require_fallback
,
1229 bool *found_object
) {
1232 struct vtable_member vtable_key
, *v
;
1238 assert(found_object
);
1240 n
= hashmap_get(bus
->nodes
, p
);
1244 /* First, try object callbacks */
1245 r
= node_callbacks_run(bus
, m
, n
->callbacks
, require_fallback
, found_object
);
1248 if (bus
->nodes_modified
)
1251 if (!m
->interface
|| !m
->member
)
1254 /* Then, look for a known method */
1255 vtable_key
.path
= (char*) p
;
1256 vtable_key
.interface
= m
->interface
;
1257 vtable_key
.member
= m
->member
;
1259 v
= hashmap_get(bus
->vtable_methods
, &vtable_key
);
1261 r
= method_callbacks_run(bus
, m
, v
, require_fallback
, found_object
);
1264 if (bus
->nodes_modified
)
1268 /* Then, look for a known property */
1269 if (streq(m
->interface
, "org.freedesktop.DBus.Properties")) {
1272 get
= streq(m
->member
, "Get");
1274 if (get
|| streq(m
->member
, "Set")) {
1276 r
= sd_bus_message_rewind(m
, true);
1280 vtable_key
.path
= (char*) p
;
1282 r
= sd_bus_message_read(m
, "ss", &vtable_key
.interface
, &vtable_key
.member
);
1284 return sd_bus_reply_method_errorf(m
, SD_BUS_ERROR_INVALID_ARGS
, "Expected interface and member parameters");
1286 v
= hashmap_get(bus
->vtable_properties
, &vtable_key
);
1288 r
= property_get_set_callbacks_run(bus
, m
, v
, require_fallback
, get
, found_object
);
1293 } else if (streq(m
->member
, "GetAll")) {
1296 r
= sd_bus_message_rewind(m
, true);
1300 r
= sd_bus_message_read(m
, "s", &iface
);
1302 return sd_bus_reply_method_errorf(m
, SD_BUS_ERROR_INVALID_ARGS
, "Expected interface parameter");
1307 r
= property_get_all_callbacks_run(bus
, m
, n
->vtables
, require_fallback
, iface
, found_object
);
1312 } else if (sd_bus_message_is_method_call(m
, "org.freedesktop.DBus.Introspectable", "Introspect")) {
1314 if (!isempty(sd_bus_message_get_signature(m
, true)))
1315 return sd_bus_reply_method_errorf(m
, SD_BUS_ERROR_INVALID_ARGS
, "Expected no parameters");
1317 r
= process_introspect(bus
, m
, n
, require_fallback
, found_object
);
1321 } else if (sd_bus_message_is_method_call(m
, "org.freedesktop.DBus.ObjectManager", "GetManagedObjects")) {
1323 if (!isempty(sd_bus_message_get_signature(m
, true)))
1324 return sd_bus_reply_method_errorf(m
, SD_BUS_ERROR_INVALID_ARGS
, "Expected no parameters");
1326 r
= process_get_managed_objects(bus
, m
, n
, require_fallback
, found_object
);
1331 if (bus
->nodes_modified
)
1334 if (!*found_object
) {
1335 r
= bus_node_exists(bus
, n
, m
->path
, require_fallback
);
1337 return bus_maybe_reply_error(m
, r
, NULL
);
1338 if (bus
->nodes_modified
)
1341 *found_object
= true;
1347 int bus_process_object(sd_bus
*bus
, sd_bus_message
*m
) {
1350 bool found_object
= false;
1355 if (bus
->is_monitor
)
1358 if (m
->header
->type
!= SD_BUS_MESSAGE_METHOD_CALL
)
1361 if (hashmap_isempty(bus
->nodes
))
1364 /* Never respond to broadcast messages */
1365 if (bus
->bus_client
&& !m
->destination
)
1371 pl
= strlen(m
->path
);
1375 bus
->nodes_modified
= false;
1377 r
= object_find_and_run(bus
, m
, m
->path
, false, &found_object
);
1381 /* Look for fallback prefixes */
1382 OBJECT_PATH_FOREACH_PREFIX(prefix
, m
->path
) {
1384 if (bus
->nodes_modified
)
1387 r
= object_find_and_run(bus
, m
, prefix
, true, &found_object
);
1392 } while (bus
->nodes_modified
);
1397 if (sd_bus_message_is_method_call(m
, "org.freedesktop.DBus.Properties", "Get") ||
1398 sd_bus_message_is_method_call(m
, "org.freedesktop.DBus.Properties", "Set"))
1399 r
= sd_bus_reply_method_errorf(
1401 SD_BUS_ERROR_UNKNOWN_PROPERTY
,
1402 "Unknown property or interface.");
1404 r
= sd_bus_reply_method_errorf(
1406 SD_BUS_ERROR_UNKNOWN_METHOD
,
1407 "Unknown method '%s' or interface '%s'.", m
->member
, m
->interface
);
1415 static struct node
*bus_node_allocate(sd_bus
*bus
, const char *path
) {
1416 struct node
*n
, *parent
;
1418 _cleanup_free_
char *s
= NULL
;
1424 assert(path
[0] == '/');
1426 n
= hashmap_get(bus
->nodes
, path
);
1430 r
= hashmap_ensure_allocated(&bus
->nodes
, &string_hash_ops
);
1438 if (streq(path
, "/"))
1441 e
= strrchr(path
, '/');
1444 p
= strndupa(path
, MAX(1, e
- path
));
1446 parent
= bus_node_allocate(bus
, p
);
1451 n
= new0(struct node
, 1);
1456 n
->path
= TAKE_PTR(s
);
1458 r
= hashmap_put(bus
->nodes
, n
->path
, n
);
1465 LIST_PREPEND(siblings
, parent
->child
, n
);
1470 void bus_node_gc(sd_bus
*b
, struct node
*n
) {
1483 assert_se(hashmap_remove(b
->nodes
, n
->path
) == n
);
1486 LIST_REMOVE(siblings
, n
->parent
->child
, n
);
1489 bus_node_gc(b
, n
->parent
);
1493 static int bus_find_parent_object_manager(sd_bus
*bus
, struct node
**out
, const char *path
) {
1499 n
= hashmap_get(bus
->nodes
, path
);
1503 prefix
= newa(char, strlen(path
) + 1);
1504 OBJECT_PATH_FOREACH_PREFIX(prefix
, path
) {
1505 n
= hashmap_get(bus
->nodes
, prefix
);
1511 while (n
&& !n
->object_managers
)
1519 static int bus_add_object(
1524 sd_bus_message_handler_t callback
,
1531 assert_return(bus
, -EINVAL
);
1532 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
1533 assert_return(object_path_is_valid(path
), -EINVAL
);
1534 assert_return(callback
, -EINVAL
);
1535 assert_return(!bus_pid_changed(bus
), -ECHILD
);
1537 n
= bus_node_allocate(bus
, path
);
1541 s
= bus_slot_allocate(bus
, !slot
, BUS_NODE_CALLBACK
, sizeof(struct node_callback
), userdata
);
1547 s
->node_callback
.callback
= callback
;
1548 s
->node_callback
.is_fallback
= fallback
;
1550 s
->node_callback
.node
= n
;
1551 LIST_PREPEND(callbacks
, n
->callbacks
, &s
->node_callback
);
1552 bus
->nodes_modified
= true;
1560 sd_bus_slot_unref(s
);
1561 bus_node_gc(bus
, n
);
1566 _public_
int sd_bus_add_object(
1570 sd_bus_message_handler_t callback
,
1573 return bus_add_object(bus
, slot
, false, path
, callback
, userdata
);
1576 _public_
int sd_bus_add_fallback(
1580 sd_bus_message_handler_t callback
,
1583 return bus_add_object(bus
, slot
, true, prefix
, callback
, userdata
);
1586 static void vtable_member_hash_func(const struct vtable_member
*m
, struct siphash
*state
) {
1589 string_hash_func(m
->path
, state
);
1590 string_hash_func(m
->interface
, state
);
1591 string_hash_func(m
->member
, state
);
1594 static int vtable_member_compare_func(const struct vtable_member
*x
, const struct vtable_member
*y
) {
1600 r
= strcmp(x
->path
, y
->path
);
1604 r
= strcmp(x
->interface
, y
->interface
);
1608 return strcmp(x
->member
, y
->member
);
1611 DEFINE_PRIVATE_HASH_OPS(vtable_member_hash_ops
, struct vtable_member
, vtable_member_hash_func
, vtable_member_compare_func
);
1613 static int add_object_vtable_internal(
1617 const char *interface
,
1618 const sd_bus_vtable
*vtable
,
1620 sd_bus_object_find_t find
,
1623 sd_bus_slot
*s
= NULL
;
1624 struct node_vtable
*i
, *existing
= NULL
;
1625 const sd_bus_vtable
*v
;
1629 assert_return(bus
, -EINVAL
);
1630 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
1631 assert_return(object_path_is_valid(path
), -EINVAL
);
1632 assert_return(interface_name_is_valid(interface
), -EINVAL
);
1633 assert_return(vtable
, -EINVAL
);
1634 assert_return(vtable
[0].type
== _SD_BUS_VTABLE_START
, -EINVAL
);
1635 assert_return(vtable
[0].x
.start
.element_size
== sizeof(struct sd_bus_vtable
), -EINVAL
);
1636 assert_return(!bus_pid_changed(bus
), -ECHILD
);
1637 assert_return(!streq(interface
, "org.freedesktop.DBus.Properties") &&
1638 !streq(interface
, "org.freedesktop.DBus.Introspectable") &&
1639 !streq(interface
, "org.freedesktop.DBus.Peer") &&
1640 !streq(interface
, "org.freedesktop.DBus.ObjectManager"), -EINVAL
);
1642 r
= hashmap_ensure_allocated(&bus
->vtable_methods
, &vtable_member_hash_ops
);
1646 r
= hashmap_ensure_allocated(&bus
->vtable_properties
, &vtable_member_hash_ops
);
1650 n
= bus_node_allocate(bus
, path
);
1654 LIST_FOREACH(vtables
, i
, n
->vtables
) {
1655 if (i
->is_fallback
!= fallback
) {
1660 if (streq(i
->interface
, interface
)) {
1662 if (i
->vtable
== vtable
) {
1671 s
= bus_slot_allocate(bus
, !slot
, BUS_NODE_VTABLE
, sizeof(struct node_vtable
), userdata
);
1677 s
->node_vtable
.is_fallback
= fallback
;
1678 s
->node_vtable
.vtable
= vtable
;
1679 s
->node_vtable
.find
= find
;
1681 s
->node_vtable
.interface
= strdup(interface
);
1682 if (!s
->node_vtable
.interface
) {
1687 for (v
= s
->node_vtable
.vtable
+1; v
->type
!= _SD_BUS_VTABLE_END
; v
++) {
1691 case _SD_BUS_VTABLE_METHOD
: {
1692 struct vtable_member
*m
;
1694 if (!member_name_is_valid(v
->x
.method
.member
) ||
1695 !signature_is_valid(strempty(v
->x
.method
.signature
), false) ||
1696 !signature_is_valid(strempty(v
->x
.method
.result
), false) ||
1697 !(v
->x
.method
.handler
|| (isempty(v
->x
.method
.signature
) && isempty(v
->x
.method
.result
))) ||
1698 v
->flags
& (SD_BUS_VTABLE_PROPERTY_CONST
|SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE
|SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION
)) {
1703 m
= new0(struct vtable_member
, 1);
1709 m
->parent
= &s
->node_vtable
;
1711 m
->interface
= s
->node_vtable
.interface
;
1712 m
->member
= v
->x
.method
.member
;
1715 r
= hashmap_put(bus
->vtable_methods
, m
, m
);
1724 case _SD_BUS_VTABLE_WRITABLE_PROPERTY
:
1726 if (!(v
->x
.property
.set
|| bus_type_is_basic(v
->x
.property
.signature
[0]))) {
1731 if (v
->flags
& SD_BUS_VTABLE_PROPERTY_CONST
) {
1737 case _SD_BUS_VTABLE_PROPERTY
: {
1738 struct vtable_member
*m
;
1740 if (!member_name_is_valid(v
->x
.property
.member
) ||
1741 !signature_is_single(v
->x
.property
.signature
, false) ||
1742 !(v
->x
.property
.get
|| bus_type_is_basic(v
->x
.property
.signature
[0]) || streq(v
->x
.property
.signature
, "as")) ||
1743 (v
->flags
& SD_BUS_VTABLE_METHOD_NO_REPLY
) ||
1744 (!!(v
->flags
& SD_BUS_VTABLE_PROPERTY_CONST
) + !!(v
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE
) + !!(v
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION
)) > 1 ||
1745 ((v
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE
) && (v
->flags
& SD_BUS_VTABLE_PROPERTY_EXPLICIT
)) ||
1746 (v
->flags
& SD_BUS_VTABLE_UNPRIVILEGED
&& v
->type
== _SD_BUS_VTABLE_PROPERTY
)) {
1751 m
= new0(struct vtable_member
, 1);
1757 m
->parent
= &s
->node_vtable
;
1759 m
->interface
= s
->node_vtable
.interface
;
1760 m
->member
= v
->x
.property
.member
;
1763 r
= hashmap_put(bus
->vtable_properties
, m
, m
);
1772 case _SD_BUS_VTABLE_SIGNAL
:
1774 if (!member_name_is_valid(v
->x
.signal
.member
) ||
1775 !signature_is_valid(strempty(v
->x
.signal
.signature
), false) ||
1776 v
->flags
& SD_BUS_VTABLE_UNPRIVILEGED
) {
1789 s
->node_vtable
.node
= n
;
1790 LIST_INSERT_AFTER(vtables
, n
->vtables
, existing
, &s
->node_vtable
);
1791 bus
->nodes_modified
= true;
1799 sd_bus_slot_unref(s
);
1800 bus_node_gc(bus
, n
);
1805 _public_
int sd_bus_add_object_vtable(
1809 const char *interface
,
1810 const sd_bus_vtable
*vtable
,
1813 return add_object_vtable_internal(bus
, slot
, path
, interface
, vtable
, false, NULL
, userdata
);
1816 _public_
int sd_bus_add_fallback_vtable(
1820 const char *interface
,
1821 const sd_bus_vtable
*vtable
,
1822 sd_bus_object_find_t find
,
1825 return add_object_vtable_internal(bus
, slot
, prefix
, interface
, vtable
, true, find
, userdata
);
1828 _public_
int sd_bus_add_node_enumerator(
1832 sd_bus_node_enumerator_t callback
,
1839 assert_return(bus
, -EINVAL
);
1840 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
1841 assert_return(object_path_is_valid(path
), -EINVAL
);
1842 assert_return(callback
, -EINVAL
);
1843 assert_return(!bus_pid_changed(bus
), -ECHILD
);
1845 n
= bus_node_allocate(bus
, path
);
1849 s
= bus_slot_allocate(bus
, !slot
, BUS_NODE_ENUMERATOR
, sizeof(struct node_enumerator
), userdata
);
1855 s
->node_enumerator
.callback
= callback
;
1857 s
->node_enumerator
.node
= n
;
1858 LIST_PREPEND(enumerators
, n
->enumerators
, &s
->node_enumerator
);
1859 bus
->nodes_modified
= true;
1867 sd_bus_slot_unref(s
);
1868 bus_node_gc(bus
, n
);
1873 static int emit_properties_changed_on_interface(
1877 const char *interface
,
1878 bool require_fallback
,
1879 bool *found_interface
,
1882 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1883 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1884 bool has_invalidating
= false, has_changing
= false;
1885 struct vtable_member key
= {};
1886 struct node_vtable
*c
;
1896 assert(found_interface
);
1898 n
= hashmap_get(bus
->nodes
, prefix
);
1902 r
= sd_bus_message_new_signal(bus
, &m
, path
, "org.freedesktop.DBus.Properties", "PropertiesChanged");
1906 r
= sd_bus_message_append(m
, "s", interface
);
1910 r
= sd_bus_message_open_container(m
, 'a', "{sv}");
1915 key
.interface
= interface
;
1917 LIST_FOREACH(vtables
, c
, n
->vtables
) {
1918 if (require_fallback
&& !c
->is_fallback
)
1921 if (!streq(c
->interface
, interface
))
1924 r
= node_vtable_get_userdata(bus
, path
, c
, &u
, &error
);
1927 if (bus
->nodes_modified
)
1932 *found_interface
= true;
1935 /* If the caller specified a list of
1936 * properties we include exactly those in the
1937 * PropertiesChanged message */
1939 STRV_FOREACH(property
, names
) {
1940 struct vtable_member
*v
;
1942 assert_return(member_name_is_valid(*property
), -EINVAL
);
1944 key
.member
= *property
;
1945 v
= hashmap_get(bus
->vtable_properties
, &key
);
1949 /* If there are two vtables for the same
1950 * interface, let's handle this property when
1951 * we come to that vtable. */
1955 assert_return(v
->vtable
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE
||
1956 v
->vtable
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION
, -EDOM
);
1958 assert_return(!(v
->vtable
->flags
& SD_BUS_VTABLE_HIDDEN
), -EDOM
);
1960 if (v
->vtable
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION
) {
1961 has_invalidating
= true;
1965 has_changing
= true;
1967 r
= vtable_append_one_property(bus
, m
, m
->path
, c
, v
->vtable
, u
, &error
);
1970 if (bus
->nodes_modified
)
1974 const sd_bus_vtable
*v
;
1976 /* If the caller specified no properties list
1977 * we include all properties that are marked
1978 * as changing in the message. */
1980 for (v
= c
->vtable
+1; v
->type
!= _SD_BUS_VTABLE_END
; v
++) {
1981 if (!IN_SET(v
->type
, _SD_BUS_VTABLE_PROPERTY
, _SD_BUS_VTABLE_WRITABLE_PROPERTY
))
1984 if (v
->flags
& SD_BUS_VTABLE_HIDDEN
)
1987 if (v
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION
) {
1988 has_invalidating
= true;
1992 if (!(v
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE
))
1995 has_changing
= true;
1997 r
= vtable_append_one_property(bus
, m
, m
->path
, c
, v
, u
, &error
);
2000 if (bus
->nodes_modified
)
2006 if (!has_invalidating
&& !has_changing
)
2009 r
= sd_bus_message_close_container(m
);
2013 r
= sd_bus_message_open_container(m
, 'a', "s");
2017 if (has_invalidating
) {
2018 LIST_FOREACH(vtables
, c
, n
->vtables
) {
2019 if (require_fallback
&& !c
->is_fallback
)
2022 if (!streq(c
->interface
, interface
))
2025 r
= node_vtable_get_userdata(bus
, path
, c
, &u
, &error
);
2028 if (bus
->nodes_modified
)
2034 STRV_FOREACH(property
, names
) {
2035 struct vtable_member
*v
;
2037 key
.member
= *property
;
2038 assert_se(v
= hashmap_get(bus
->vtable_properties
, &key
));
2039 assert(c
== v
->parent
);
2041 if (!(v
->vtable
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION
))
2044 r
= sd_bus_message_append(m
, "s", *property
);
2049 const sd_bus_vtable
*v
;
2051 for (v
= c
->vtable
+1; v
->type
!= _SD_BUS_VTABLE_END
; v
++) {
2052 if (!IN_SET(v
->type
, _SD_BUS_VTABLE_PROPERTY
, _SD_BUS_VTABLE_WRITABLE_PROPERTY
))
2055 if (v
->flags
& SD_BUS_VTABLE_HIDDEN
)
2058 if (!(v
->flags
& SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION
))
2061 r
= sd_bus_message_append(m
, "s", v
->x
.property
.member
);
2069 r
= sd_bus_message_close_container(m
);
2073 r
= sd_bus_send(bus
, m
, NULL
);
2080 _public_
int sd_bus_emit_properties_changed_strv(
2083 const char *interface
,
2086 bool found_interface
= false;
2090 assert_return(bus
, -EINVAL
);
2091 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2092 assert_return(object_path_is_valid(path
), -EINVAL
);
2093 assert_return(interface_name_is_valid(interface
), -EINVAL
);
2094 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2096 if (!BUS_IS_OPEN(bus
->state
))
2099 /* A non-NULL but empty names list means nothing needs to be
2100 generated. A NULL list OTOH indicates that all properties
2101 that are set to EMITS_CHANGE or EMITS_INVALIDATION shall be
2102 included in the PropertiesChanged message. */
2103 if (names
&& names
[0] == NULL
)
2106 BUS_DONT_DESTROY(bus
);
2109 bus
->nodes_modified
= false;
2111 r
= emit_properties_changed_on_interface(bus
, path
, path
, interface
, false, &found_interface
, names
);
2114 if (bus
->nodes_modified
)
2117 prefix
= newa(char, strlen(path
) + 1);
2118 OBJECT_PATH_FOREACH_PREFIX(prefix
, path
) {
2119 r
= emit_properties_changed_on_interface(bus
, prefix
, path
, interface
, true, &found_interface
, names
);
2122 if (bus
->nodes_modified
)
2126 } while (bus
->nodes_modified
);
2128 return found_interface
? 0 : -ENOENT
;
2131 _public_
int sd_bus_emit_properties_changed(
2134 const char *interface
,
2135 const char *name
, ...) {
2139 assert_return(bus
, -EINVAL
);
2140 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2141 assert_return(object_path_is_valid(path
), -EINVAL
);
2142 assert_return(interface_name_is_valid(interface
), -EINVAL
);
2143 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2145 if (!BUS_IS_OPEN(bus
->state
))
2151 names
= strv_from_stdarg_alloca(name
);
2153 return sd_bus_emit_properties_changed_strv(bus
, path
, interface
, names
);
2156 static int object_added_append_all_prefix(
2162 bool require_fallback
) {
2164 const char *previous_interface
= NULL
;
2165 struct node_vtable
*c
;
2175 n
= hashmap_get(bus
->nodes
, prefix
);
2179 LIST_FOREACH(vtables
, c
, n
->vtables
) {
2180 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2183 if (require_fallback
&& !c
->is_fallback
)
2186 r
= node_vtable_get_userdata(bus
, path
, c
, &u
, &error
);
2189 if (bus
->nodes_modified
)
2194 if (!streq_ptr(c
->interface
, previous_interface
)) {
2195 /* If a child-node already handled this interface, we
2196 * skip it on any of its parents. The child vtables
2197 * always fully override any conflicting vtables of
2198 * any parent node. */
2199 if (set_get(s
, c
->interface
))
2202 r
= set_put(s
, c
->interface
);
2206 if (previous_interface
) {
2207 r
= sd_bus_message_close_container(m
);
2210 r
= sd_bus_message_close_container(m
);
2215 r
= sd_bus_message_open_container(m
, 'e', "sa{sv}");
2218 r
= sd_bus_message_append(m
, "s", c
->interface
);
2221 r
= sd_bus_message_open_container(m
, 'a', "{sv}");
2225 previous_interface
= c
->interface
;
2228 r
= vtable_append_all_properties(bus
, m
, path
, c
, u
, &error
);
2231 if (bus
->nodes_modified
)
2235 if (previous_interface
) {
2236 r
= sd_bus_message_close_container(m
);
2239 r
= sd_bus_message_close_container(m
);
2247 static int object_added_append_all(sd_bus
*bus
, sd_bus_message
*m
, const char *path
) {
2248 _cleanup_set_free_ Set
*s
= NULL
;
2257 * This appends all interfaces registered on path @path. We first add
2258 * the builtin interfaces, which are always available and handled by
2259 * sd-bus. Then, we add all interfaces registered on the exact node,
2260 * followed by all fallback interfaces registered on any parent prefix.
2262 * If an interface is registered multiple times on the same node with
2263 * different vtables, we merge all the properties across all vtables.
2264 * However, if a child node has the same interface registered as one of
2265 * its parent nodes has as fallback, we make the child overwrite the
2266 * parent instead of extending it. Therefore, we keep a "Set" of all
2267 * handled interfaces during parent traversal, so we skip interfaces on
2268 * a parent that were overwritten by a child.
2271 s
= set_new(&string_hash_ops
);
2275 r
= sd_bus_message_append(m
, "{sa{sv}}", "org.freedesktop.DBus.Peer", 0);
2278 r
= sd_bus_message_append(m
, "{sa{sv}}", "org.freedesktop.DBus.Introspectable", 0);
2281 r
= sd_bus_message_append(m
, "{sa{sv}}", "org.freedesktop.DBus.Properties", 0);
2284 r
= sd_bus_message_append(m
, "{sa{sv}}", "org.freedesktop.DBus.ObjectManager", 0);
2288 r
= object_added_append_all_prefix(bus
, m
, s
, path
, path
, false);
2291 if (bus
->nodes_modified
)
2294 prefix
= newa(char, strlen(path
) + 1);
2295 OBJECT_PATH_FOREACH_PREFIX(prefix
, path
) {
2296 r
= object_added_append_all_prefix(bus
, m
, s
, prefix
, path
, true);
2299 if (bus
->nodes_modified
)
2306 _public_
int sd_bus_emit_object_added(sd_bus
*bus
, const char *path
) {
2307 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2308 struct node
*object_manager
;
2312 * This emits an InterfacesAdded signal on the given path, by iterating
2313 * all registered vtables and fallback vtables on the path. All
2314 * properties are queried and included in the signal.
2315 * This call is equivalent to sd_bus_emit_interfaces_added() with an
2316 * explicit list of registered interfaces. However, unlike
2317 * interfaces_added(), this call can figure out the list of supported
2318 * interfaces itself. Furthermore, it properly adds the builtin
2319 * org.freedesktop.DBus.* interfaces.
2322 assert_return(bus
, -EINVAL
);
2323 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2324 assert_return(object_path_is_valid(path
), -EINVAL
);
2325 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2327 if (!BUS_IS_OPEN(bus
->state
))
2330 r
= bus_find_parent_object_manager(bus
, &object_manager
, path
);
2336 BUS_DONT_DESTROY(bus
);
2339 bus
->nodes_modified
= false;
2340 m
= sd_bus_message_unref(m
);
2342 r
= sd_bus_message_new_signal(bus
, &m
, object_manager
->path
, "org.freedesktop.DBus.ObjectManager", "InterfacesAdded");
2346 r
= sd_bus_message_append_basic(m
, 'o', path
);
2350 r
= sd_bus_message_open_container(m
, 'a', "{sa{sv}}");
2354 r
= object_added_append_all(bus
, m
, path
);
2358 if (bus
->nodes_modified
)
2361 r
= sd_bus_message_close_container(m
);
2365 } while (bus
->nodes_modified
);
2367 return sd_bus_send(bus
, m
, NULL
);
2370 static int object_removed_append_all_prefix(
2376 bool require_fallback
) {
2378 const char *previous_interface
= NULL
;
2379 struct node_vtable
*c
;
2389 n
= hashmap_get(bus
->nodes
, prefix
);
2393 LIST_FOREACH(vtables
, c
, n
->vtables
) {
2394 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2397 if (require_fallback
&& !c
->is_fallback
)
2399 if (streq_ptr(c
->interface
, previous_interface
))
2402 /* If a child-node already handled this interface, we
2403 * skip it on any of its parents. The child vtables
2404 * always fully override any conflicting vtables of
2405 * any parent node. */
2406 if (set_get(s
, c
->interface
))
2409 r
= node_vtable_get_userdata(bus
, path
, c
, &u
, &error
);
2412 if (bus
->nodes_modified
)
2417 r
= set_put(s
, c
->interface
);
2421 r
= sd_bus_message_append(m
, "s", c
->interface
);
2425 previous_interface
= c
->interface
;
2431 static int object_removed_append_all(sd_bus
*bus
, sd_bus_message
*m
, const char *path
) {
2432 _cleanup_set_free_ Set
*s
= NULL
;
2440 /* see sd_bus_emit_object_added() for details */
2442 s
= set_new(&string_hash_ops
);
2446 r
= sd_bus_message_append(m
, "s", "org.freedesktop.DBus.Peer");
2449 r
= sd_bus_message_append(m
, "s", "org.freedesktop.DBus.Introspectable");
2452 r
= sd_bus_message_append(m
, "s", "org.freedesktop.DBus.Properties");
2455 r
= sd_bus_message_append(m
, "s", "org.freedesktop.DBus.ObjectManager");
2459 r
= object_removed_append_all_prefix(bus
, m
, s
, path
, path
, false);
2462 if (bus
->nodes_modified
)
2465 prefix
= newa(char, strlen(path
) + 1);
2466 OBJECT_PATH_FOREACH_PREFIX(prefix
, path
) {
2467 r
= object_removed_append_all_prefix(bus
, m
, s
, prefix
, path
, true);
2470 if (bus
->nodes_modified
)
2477 _public_
int sd_bus_emit_object_removed(sd_bus
*bus
, const char *path
) {
2478 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2479 struct node
*object_manager
;
2483 * This is like sd_bus_emit_object_added(), but emits an
2484 * InterfacesRemoved signal on the given path. This only includes any
2485 * registered interfaces but skips the properties. Note that this will
2486 * call into the find() callbacks of any registered vtable. Therefore,
2487 * you must call this function before destroying/unlinking your object.
2488 * Otherwise, the list of interfaces will be incomplete. However, note
2489 * that this will *NOT* call into any property callback. Therefore, the
2490 * object might be in an "destructed" state, as long as we can find it.
2493 assert_return(bus
, -EINVAL
);
2494 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2495 assert_return(object_path_is_valid(path
), -EINVAL
);
2496 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2498 if (!BUS_IS_OPEN(bus
->state
))
2501 r
= bus_find_parent_object_manager(bus
, &object_manager
, path
);
2507 BUS_DONT_DESTROY(bus
);
2510 bus
->nodes_modified
= false;
2511 m
= sd_bus_message_unref(m
);
2513 r
= sd_bus_message_new_signal(bus
, &m
, object_manager
->path
, "org.freedesktop.DBus.ObjectManager", "InterfacesRemoved");
2517 r
= sd_bus_message_append_basic(m
, 'o', path
);
2521 r
= sd_bus_message_open_container(m
, 'a', "s");
2525 r
= object_removed_append_all(bus
, m
, path
);
2529 if (bus
->nodes_modified
)
2532 r
= sd_bus_message_close_container(m
);
2536 } while (bus
->nodes_modified
);
2538 return sd_bus_send(bus
, m
, NULL
);
2541 static int interfaces_added_append_one_prefix(
2546 const char *interface
,
2547 bool require_fallback
) {
2549 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
2550 bool found_interface
= false;
2551 struct node_vtable
*c
;
2562 n
= hashmap_get(bus
->nodes
, prefix
);
2566 LIST_FOREACH(vtables
, c
, n
->vtables
) {
2567 if (require_fallback
&& !c
->is_fallback
)
2570 if (!streq(c
->interface
, interface
))
2573 r
= node_vtable_get_userdata(bus
, path
, c
, &u
, &error
);
2576 if (bus
->nodes_modified
)
2581 if (!found_interface
) {
2582 r
= sd_bus_message_append_basic(m
, 's', interface
);
2586 r
= sd_bus_message_open_container(m
, 'a', "{sv}");
2590 found_interface
= true;
2593 r
= vtable_append_all_properties(bus
, m
, path
, c
, u
, &error
);
2596 if (bus
->nodes_modified
)
2600 if (found_interface
) {
2601 r
= sd_bus_message_close_container(m
);
2606 return found_interface
;
2609 static int interfaces_added_append_one(
2613 const char *interface
) {
2623 r
= interfaces_added_append_one_prefix(bus
, m
, path
, path
, interface
, false);
2626 if (bus
->nodes_modified
)
2629 prefix
= newa(char, strlen(path
) + 1);
2630 OBJECT_PATH_FOREACH_PREFIX(prefix
, path
) {
2631 r
= interfaces_added_append_one_prefix(bus
, m
, prefix
, path
, interface
, true);
2634 if (bus
->nodes_modified
)
2641 _public_
int sd_bus_emit_interfaces_added_strv(sd_bus
*bus
, const char *path
, char **interfaces
) {
2642 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2643 struct node
*object_manager
;
2647 assert_return(bus
, -EINVAL
);
2648 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2649 assert_return(object_path_is_valid(path
), -EINVAL
);
2650 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2652 if (!BUS_IS_OPEN(bus
->state
))
2655 if (strv_isempty(interfaces
))
2658 r
= bus_find_parent_object_manager(bus
, &object_manager
, path
);
2664 BUS_DONT_DESTROY(bus
);
2667 bus
->nodes_modified
= false;
2668 m
= sd_bus_message_unref(m
);
2670 r
= sd_bus_message_new_signal(bus
, &m
, object_manager
->path
, "org.freedesktop.DBus.ObjectManager", "InterfacesAdded");
2674 r
= sd_bus_message_append_basic(m
, 'o', path
);
2678 r
= sd_bus_message_open_container(m
, 'a', "{sa{sv}}");
2682 STRV_FOREACH(i
, interfaces
) {
2683 assert_return(interface_name_is_valid(*i
), -EINVAL
);
2685 r
= sd_bus_message_open_container(m
, 'e', "sa{sv}");
2689 r
= interfaces_added_append_one(bus
, m
, path
, *i
);
2693 if (bus
->nodes_modified
)
2696 r
= sd_bus_message_close_container(m
);
2701 if (bus
->nodes_modified
)
2704 r
= sd_bus_message_close_container(m
);
2708 } while (bus
->nodes_modified
);
2710 return sd_bus_send(bus
, m
, NULL
);
2713 _public_
int sd_bus_emit_interfaces_added(sd_bus
*bus
, const char *path
, const char *interface
, ...) {
2716 assert_return(bus
, -EINVAL
);
2717 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2718 assert_return(object_path_is_valid(path
), -EINVAL
);
2719 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2721 if (!BUS_IS_OPEN(bus
->state
))
2724 interfaces
= strv_from_stdarg_alloca(interface
);
2726 return sd_bus_emit_interfaces_added_strv(bus
, path
, interfaces
);
2729 _public_
int sd_bus_emit_interfaces_removed_strv(sd_bus
*bus
, const char *path
, char **interfaces
) {
2730 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
2731 struct node
*object_manager
;
2734 assert_return(bus
, -EINVAL
);
2735 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2736 assert_return(object_path_is_valid(path
), -EINVAL
);
2737 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2739 if (!BUS_IS_OPEN(bus
->state
))
2742 if (strv_isempty(interfaces
))
2745 r
= bus_find_parent_object_manager(bus
, &object_manager
, path
);
2751 r
= sd_bus_message_new_signal(bus
, &m
, object_manager
->path
, "org.freedesktop.DBus.ObjectManager", "InterfacesRemoved");
2755 r
= sd_bus_message_append_basic(m
, 'o', path
);
2759 r
= sd_bus_message_append_strv(m
, interfaces
);
2763 return sd_bus_send(bus
, m
, NULL
);
2766 _public_
int sd_bus_emit_interfaces_removed(sd_bus
*bus
, const char *path
, const char *interface
, ...) {
2769 assert_return(bus
, -EINVAL
);
2770 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2771 assert_return(object_path_is_valid(path
), -EINVAL
);
2772 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2774 if (!BUS_IS_OPEN(bus
->state
))
2777 interfaces
= strv_from_stdarg_alloca(interface
);
2779 return sd_bus_emit_interfaces_removed_strv(bus
, path
, interfaces
);
2782 _public_
int sd_bus_add_object_manager(sd_bus
*bus
, sd_bus_slot
**slot
, const char *path
) {
2787 assert_return(bus
, -EINVAL
);
2788 assert_return(bus
= bus_resolve(bus
), -ENOPKG
);
2789 assert_return(object_path_is_valid(path
), -EINVAL
);
2790 assert_return(!bus_pid_changed(bus
), -ECHILD
);
2792 n
= bus_node_allocate(bus
, path
);
2796 s
= bus_slot_allocate(bus
, !slot
, BUS_NODE_OBJECT_MANAGER
, sizeof(struct node_object_manager
), NULL
);
2802 s
->node_object_manager
.node
= n
;
2803 LIST_PREPEND(object_managers
, n
->object_managers
, &s
->node_object_manager
);
2804 bus
->nodes_modified
= true;
2812 sd_bus_slot_unref(s
);
2813 bus_node_gc(bus
, n
);