From: Philip Withnall Date: Tue, 2 Jun 2026 14:56:28 +0000 (+0100) Subject: sysupdate: Add varlink ListTargets() method X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8cb753139020d146d1eff0102105f82a96cfb634;p=thirdparty%2Fsystemd.git sysupdate: Add varlink ListTargets() method And add integration tests for it using `jq`. --- diff --git a/src/shared/varlink-io.systemd.SysUpdate.c b/src/shared/varlink-io.systemd.SysUpdate.c index 94a7180a509..d2a4b61a5da 100644 --- a/src/shared/varlink-io.systemd.SysUpdate.c +++ b/src/shared/varlink-io.systemd.SysUpdate.c @@ -25,6 +25,11 @@ static SD_VARLINK_DEFINE_STRUCT_TYPE( SD_VARLINK_FIELD_COMMENT("Name of the target, unique within a class."), SD_VARLINK_DEFINE_FIELD(name, SD_VARLINK_STRING, SD_VARLINK_NULLABLE)); +static SD_VARLINK_DEFINE_STRUCT_TYPE( + Target, + SD_VARLINK_FIELD_COMMENT("Identifier for the target."), + SD_VARLINK_DEFINE_FIELD_BY_TYPE(id, TargetIdentifier, 0)); + static SD_VARLINK_DEFINE_STRUCT_TYPE( Feature, SD_VARLINK_FIELD_COMMENT("Identifier for the feature."), @@ -55,6 +60,11 @@ static SD_VARLINK_DEFINE_METHOD( SD_VARLINK_FIELD_COMMENT("The version string for the new version which is available."), SD_VARLINK_DEFINE_OUTPUT(available, SD_VARLINK_STRING, 0)); +static SD_VARLINK_DEFINE_METHOD( + ListTargets, + SD_VARLINK_FIELD_COMMENT("The configured targets."), + SD_VARLINK_DEFINE_OUTPUT_BY_TYPE(targets, Target, SD_VARLINK_ARRAY)); + static SD_VARLINK_DEFINE_ERROR(NoUpdateNeeded); static SD_VARLINK_DEFINE_ERROR(NoSuchTarget); @@ -68,12 +78,16 @@ SD_VARLINK_DEFINE_INTERFACE( &vl_method_ListFeatures, SD_VARLINK_SYMBOL_COMMENT("Check if there’s a new version available"), &vl_method_CheckNew, + SD_VARLINK_SYMBOL_COMMENT("Show targets"), + &vl_method_ListTargets, /* Types */ SD_VARLINK_SYMBOL_COMMENT("Class of a Target."), &vl_type_TargetClass, SD_VARLINK_SYMBOL_COMMENT("Identifier for a component of the system (i.e. the host itself, a sysext, a confext, etc.) that can be updated by systemd-sysupdate(8)."), &vl_type_TargetIdentifier, + SD_VARLINK_SYMBOL_COMMENT("Type containing a configured sysupdate target."), + &vl_type_Target, SD_VARLINK_SYMBOL_COMMENT("Type containing a configured sysupdate feature."), &vl_type_Feature, diff --git a/src/sysupdate/sysupdate-target.c b/src/sysupdate/sysupdate-target.c index ef132960f33..8559026927c 100644 --- a/src/sysupdate/sysupdate-target.c +++ b/src/sysupdate/sysupdate-target.c @@ -1,5 +1,7 @@ /* SPDX-License-Identifier: LGPL-2.1-or-later */ +#include "alloc-util.h" +#include "macro.h" #include "string-table.h" #include "sysupdate-target.h" @@ -14,9 +16,39 @@ static const char* const target_class_table[_TARGET_CLASS_MAX] = { DEFINE_STRING_TABLE_LOOKUP(target_class, TargetClass); +int target_identifier_new(TargetClass class, const char *name, TargetIdentifier **ret) { + _cleanup_(target_identifier_freep) TargetIdentifier *t = NULL; + + assert(name); + assert(ret); + + t = new(TargetIdentifier, 1); + if (!t) + return -ENOMEM; + + *t = (TargetIdentifier) { + .class = class, + .name = strdup(name), + }; + + if (!t->name) + return -ENOMEM; + + *ret = TAKE_PTR(t); + return 0; +} + void target_identifier_done(TargetIdentifier *t) { assert(t); t->class = _TARGET_CLASS_INVALID; t->name = mfree(t->name); } + +TargetIdentifier *target_identifier_free(TargetIdentifier *t) { + if (!t) + return NULL; + + target_identifier_done(t); + return mfree(t); +} diff --git a/src/sysupdate/sysupdate-target.h b/src/sysupdate/sysupdate-target.h index 9c0a13bf4ad..5c8d93e809a 100644 --- a/src/sysupdate/sysupdate-target.h +++ b/src/sysupdate/sysupdate-target.h @@ -29,4 +29,8 @@ typedef struct TargetIdentifier { char *name; } TargetIdentifier; +int target_identifier_new(TargetClass class, const char *name, TargetIdentifier **ret); void target_identifier_done(TargetIdentifier *t); +TargetIdentifier *target_identifier_free(TargetIdentifier *t); + +DEFINE_TRIVIAL_CLEANUP_FUNC(TargetIdentifier*, target_identifier_free); diff --git a/src/sysupdate/sysupdate.c b/src/sysupdate/sysupdate.c index 9ed5d8db464..cd9325ee57e 100644 --- a/src/sysupdate/sysupdate.c +++ b/src/sysupdate/sysupdate.c @@ -38,6 +38,8 @@ #include "path-util.h" #include "pretty-print.h" #include "runtime-scope.h" +#include "set.h" +#include "siphash24.h" #include "sort-util.h" #include "stdio-util.h" #include "string-util.h" @@ -1268,6 +1270,145 @@ static int context_load_paths_from_image(Context *context, Image *image) { } } +static void target_identifier_hash_func(const TargetIdentifier *t, struct siphash *state) { + assert(t); + + siphash24_compress_typesafe(t->class, state); + siphash24_compress_string(t->name, state); +} + +static int target_identifier_compare_func(const TargetIdentifier *x, const TargetIdentifier *y) { + int r; + + assert(x); + assert(y); + + r = CMP(x->class, y->class); + if (r != 0) + return r; + + return strcmp(x->name, y->name); +} + +DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(target_identifier_hash_ops, + TargetIdentifier, target_identifier_hash_func, target_identifier_compare_func, + TargetIdentifier, target_identifier_free); + +static int enumerate_image_class(RuntimeScope runtime_scope, TargetClass class, Set **targets) { + _cleanup_hashmap_free_ Hashmap *images = NULL; + Image *image; + int r; + + r = image_discover(runtime_scope, (ImageClass) class, NULL, &images); + if (r < 0) + return r; + + HASHMAP_FOREACH(image, images) { + _cleanup_(target_identifier_freep) TargetIdentifier *t = NULL; + bool have = false; + _cleanup_(context_done) Context image_context = CONTEXT_NULL; + + if (image_is_host(image)) + continue; /* We already enroll the host ourselves */ + + if (!image_type_can_sysupdate(image->type)) + continue; + + r = context_load_paths_from_image(&image_context, image); + if (r < 0) + return r; + + /* Load the components in a separate Context specific to the given Image before + * committing to loading that state to the main Context. */ + r = context_load_offline( + &image_context, + PROCESS_IMAGE_READ_ONLY, + /* read_definitions_flags= */ 0); + if (r < 0) + return r; + + r = context_list_components(&image_context, /* ret_component_names= */ NULL, &have); + if (r < 0) + return r; + if (!have) { + log_debug("Skipping %s because it has no default component", image->path); + continue; + } + + r = target_identifier_new(class, image->name, &t); + if (r < 0) + return r; + + r = set_ensure_consume(targets, &target_identifier_hash_ops, TAKE_PTR(t)); + if (r < 0) + return r; + } + + return 0; +} + +static int context_enumerate_components(Context *context, Set **targets) { + _cleanup_strv_free_ char **component_names = NULL; + bool have_default_component; + int r; + + assert(context); + + r = context_list_components(context, &component_names, &have_default_component); + if (r < 0) + return r; + + if (have_default_component) { + _cleanup_(target_identifier_freep) TargetIdentifier *t = NULL; + + r = target_identifier_new(TARGET_HOST, "host", &t); + if (r < 0) + return r; + + r = set_ensure_consume(targets, &target_identifier_hash_ops, TAKE_PTR(t)); + if (r < 0) + return r; + } + + STRV_FOREACH(component, component_names) { + _cleanup_(target_identifier_freep) TargetIdentifier *t = NULL; + + r = target_identifier_new(TARGET_COMPONENT, *component, &t); + if (r < 0) + return r; + + r = set_ensure_consume(targets, &target_identifier_hash_ops, TAKE_PTR(t)); + if (r < 0) + return r; + } + + return 0; +} + +static int context_enumerate_targets(Context *context, Set **targets) { + static const TargetClass discoverable_classes[] = { + TARGET_MACHINE, + TARGET_PORTABLE, + TARGET_SYSEXT, + TARGET_CONFEXT, + }; + int r; + + assert(context); + + FOREACH_ARRAY(class, discoverable_classes, ELEMENTSOF(discoverable_classes)) { + r = enumerate_image_class(RUNTIME_SCOPE_SYSTEM, *class, targets); + if (r < 0) + return r; + } + + r = context_enumerate_components(context, targets); + if (r < 0) + return r; + + return 0; +} + /* Load a Context to point to the target given by the TargetIdentifier. The TargetIdentifier will have been * syntactically validated by dispatch_target_identifier(), but might still point to components which don’t * exist, images which the user isn’t privileged to access, etc. This function validates the TargetIdentifier @@ -2877,6 +3018,67 @@ static int verb_components(int argc, char *argv[], uintptr_t _data, void *userda return 0; } +static int vl_method_list_targets(sd_varlink *link, sd_json_variant *parameters, sd_varlink_method_flags_t flags, void *userdata) { + _cleanup_(context_done) Context context = CONTEXT_NULL; + _cleanup_set_free_ Set *targets = NULL; + int r; + + assert(link); + + r = sd_varlink_dispatch(link, parameters, NULL, NULL); + if (r != 0) + return r; + + /* Listing targets doesn’t require a polkit check */ + + if (getenv_bool("SYSTEMD_SYSUPDATE_NO_VERIFY") > 0) + context.verify = 0; + + /* ListTargets is always offline */ + context.offline = true; + + r = context_load_offline( + &context, + PROCESS_IMAGE_READ_ONLY, + /* read_definitions_flags= */ 0); + if (r < 0) + return r; + + _cleanup_(sd_json_variant_unrefp) sd_json_variant *l = NULL; + + r = context_enumerate_targets(&context, &targets); + if (r < 0) + return r; + + /* Sort to ensure consistent ordering */ + size_t n; + _cleanup_free_ TargetIdentifier **sorted = NULL; + r = set_dump_sorted(targets, (void***) &sorted, &n); + if (r < 0) + return log_oom(); + + FOREACH_ARRAY(p, sorted, n) { + TargetIdentifier *target_identifier = *p; + const char *name = (target_identifier->class != TARGET_HOST) ? target_identifier->name : NULL; + + r = sd_json_variant_append_arraybo(&l, + SD_JSON_BUILD_PAIR_OBJECT("id", + JSON_BUILD_PAIR_ENUM("class", target_class_to_string(target_identifier->class)), + SD_JSON_BUILD_PAIR_STRING("name", name))); + if (r < 0) + return r; + } + + if (!l) { + r = sd_json_variant_new_array(&l, NULL, 0); + if (r < 0) + return r; + } + + return sd_varlink_replybo(link, + SD_JSON_BUILD_PAIR_VARIANT("targets", l)); +} + VERB(verb_enable_component, "enable-component", "COMPONENT…", 1, VERB_ANY, 0, "Enable component"); VERB(verb_enable_component, "disable-component", "COMPONENT…", 1, VERB_ANY, 0, @@ -3268,7 +3470,8 @@ static int vl_server(void) { r = sd_varlink_server_bind_method_many( varlink_server, "io.systemd.SysUpdate.CheckNew", vl_method_check_new, - "io.systemd.SysUpdate.ListFeatures", vl_method_list_features); + "io.systemd.SysUpdate.ListFeatures", vl_method_list_features, + "io.systemd.SysUpdate.ListTargets", vl_method_list_targets); if (r < 0) return log_error_errno(r, "Failed to bind Varlink method: %m"); diff --git a/test/units/TEST-72-SYSUPDATE.sh b/test/units/TEST-72-SYSUPDATE.sh index 6e3e3603b0c..abca295d7d0 100755 --- a/test/units/TEST-72-SYSUPDATE.sh +++ b/test/units/TEST-72-SYSUPDATE.sh @@ -647,8 +647,11 @@ MatchPattern=some-component_@v CurrentSymlink=some-component EOF "$SYSUPDATE" --json=short components | grep -F '{"default":false,"components":["some-component"]}' >/dev/null +varlinkctl call "$VARLINK_SOCKET" io.systemd.SysUpdate.ListTargets | jq -e '.targets | all(.id.class != "host")' >/dev/null mkdir /run/sysupdate.d "$SYSUPDATE" --json=short components | grep -F '{"default":false,"components":["some-component"]}' >/dev/null +varlinkctl call "$VARLINK_SOCKET" io.systemd.SysUpdate.ListTargets | jq -e '.targets | all(.id.class != "host")' >/dev/null +[[ $(varlinkctl call "$VARLINK_SOCKET" io.systemd.SysUpdate.ListTargets | jq -r '.targets[0].id.name') == "some-component" ]] # Regression test for https://github.com/systemd/systemd/issues/42330 — the # 'pending'/'reboot' verbs and the '--reboot' switch compare the newest installed @@ -1441,4 +1444,8 @@ cmp "$WORKDIR/source/pack-v2" "$WORKDIR/blobs/pack-v2" rm -rf "$CONFIGDIR/01-manifest-yes-and-retry.transfer" \ "$WORKDIR/source/pack-v1" "$WORKDIR/source/pack-v2" +# Test that listing components/targets when none are configured gives an empty list. +"$SYSUPDATE" components |& grep "No components defined." >/dev/null +[[ $(varlinkctl call "$VARLINK_SOCKET" io.systemd.SysUpdate.ListTargets | jq -r '.targets') == "[]" ]] + touch /testok