1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 #include <linux/loop.h>
5 #include "bus-common-errors.h"
7 #include "conf-files.h"
10 #include "dirent-util.h"
11 #include "dissect-image.h"
17 #include "locale-util.h"
18 #include "loop-util.h"
19 #include "machine-image.h"
21 #include "nulstr-util.h"
23 #include "path-lookup.h"
25 #include "process-util.h"
27 #include "signal-util.h"
28 #include "socket-util.h"
29 #include "sort-util.h"
30 #include "string-table.h"
32 #include "tmpfile-util.h"
33 #include "user-util.h"
35 static const char profile_dirs
[] = CONF_PATHS_NULSTR("systemd/portable/profile");
37 /* Markers used in the first line of our 20-portable.conf unit file drop-in to determine, that a) the unit file was
38 * dropped there by the portable service logic and b) for which image it was dropped there. */
39 #define PORTABLE_DROPIN_MARKER_BEGIN "# Drop-in created for image '"
40 #define PORTABLE_DROPIN_MARKER_END "', do not edit."
42 static bool prefix_match(const char *unit
, const char *prefix
) {
45 p
= startswith(unit
, prefix
);
49 /* Only respect prefixes followed by dash or dot or when there's a complete match */
50 return IN_SET(*p
, '-', '.', '@', 0);
53 static bool unit_match(const char *unit
, char **matches
) {
57 dot
= strrchr(unit
, '.');
61 if (!STR_IN_SET(dot
, ".service", ".socket", ".target", ".timer", ".path"))
64 /* Empty match expression means: everything */
65 if (strv_isempty(matches
))
68 /* Otherwise, at least one needs to match */
69 STRV_FOREACH(i
, matches
)
70 if (prefix_match(unit
, *i
))
76 static PortableMetadata
*portable_metadata_new(const char *name
, int fd
) {
79 m
= malloc0(offsetof(PortableMetadata
, name
) + strlen(name
) + 1);
83 strcpy(m
->name
, name
);
89 PortableMetadata
*portable_metadata_unref(PortableMetadata
*i
) {
99 static int compare_metadata(PortableMetadata
*const *x
, PortableMetadata
*const *y
) {
100 return strcmp((*x
)->name
, (*y
)->name
);
103 int portable_metadata_hashmap_to_sorted_array(Hashmap
*unit_files
, PortableMetadata
***ret
) {
105 _cleanup_free_ PortableMetadata
**sorted
= NULL
;
107 PortableMetadata
*item
;
110 sorted
= new(PortableMetadata
*, hashmap_size(unit_files
));
114 HASHMAP_FOREACH(item
, unit_files
, iterator
)
117 assert(k
== hashmap_size(unit_files
));
119 typesafe_qsort(sorted
, k
, compare_metadata
);
121 *ret
= TAKE_PTR(sorted
);
125 static int send_item(
130 CMSG_BUFFER_TYPE(CMSG_SPACE(sizeof(int))) control
= {};
133 .msg_control
= &control
,
134 .msg_controllen
= sizeof(control
),
138 struct cmsghdr
*cmsg
;
139 _cleanup_close_
int data_fd
= -1;
141 assert(socket_fd
>= 0);
145 data_fd
= fd_duplicate_data_fd(fd
);
149 cmsg
= CMSG_FIRSTHDR(&mh
);
150 cmsg
->cmsg_level
= SOL_SOCKET
;
151 cmsg
->cmsg_type
= SCM_RIGHTS
;
152 cmsg
->cmsg_len
= CMSG_LEN(sizeof(int));
153 memcpy(CMSG_DATA(cmsg
), &data_fd
, sizeof(int));
155 iovec
= IOVEC_MAKE_STRING(name
);
157 if (sendmsg(socket_fd
, &mh
, MSG_NOSIGNAL
) < 0)
163 static int recv_item(
168 CMSG_BUFFER_TYPE(CMSG_SPACE(sizeof(int))) control
;
169 char buffer
[PATH_MAX
+2];
170 struct iovec iov
= IOVEC_INIT(buffer
, sizeof(buffer
)-1);
172 .msg_control
= &control
,
173 .msg_controllen
= sizeof(control
),
177 struct cmsghdr
*cmsg
;
178 _cleanup_close_
int found_fd
= -1;
182 assert(socket_fd
>= 0);
186 n
= recvmsg_safe(socket_fd
, &mh
, MSG_CMSG_CLOEXEC
);
190 CMSG_FOREACH(cmsg
, &mh
) {
191 if (cmsg
->cmsg_level
== SOL_SOCKET
&&
192 cmsg
->cmsg_type
== SCM_RIGHTS
) {
194 if (cmsg
->cmsg_len
== CMSG_LEN(sizeof(int))) {
195 assert(found_fd
< 0);
196 found_fd
= *(int*) CMSG_DATA(cmsg
);
207 copy
= strdup(buffer
);
212 *ret_fd
= TAKE_FD(found_fd
);
217 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(portable_metadata_hash_ops
, char, string_hash_func
, string_compare_func
,
218 PortableMetadata
, portable_metadata_unref
);
220 static int extract_now(
224 PortableMetadata
**ret_os_release
,
225 Hashmap
**ret_unit_files
) {
227 _cleanup_hashmap_free_ Hashmap
*unit_files
= NULL
;
228 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*os_release
= NULL
;
229 _cleanup_(lookup_paths_free
) LookupPaths paths
= {};
230 _cleanup_close_
int os_release_fd
= -1;
231 _cleanup_free_
char *os_release_path
= NULL
;
235 /* Extracts the metadata from a directory tree 'where'. Extracts two kinds of information: the /etc/os-release
236 * data, and all unit files matching the specified expression. Note that this function is called in two very
237 * different but also similar contexts. When the tool gets invoked on a directory tree, we'll process it
238 * directly, and in-process, and thus can return the requested data directly, via 'ret_os_release' and
239 * 'ret_unit_files'. However, if the tool is invoked on a raw disk image — which needs to be mounted first — we
240 * are invoked in a child process with private mounts and then need to send the collected data to our
241 * parent. To handle both cases in one call this function also gets a 'socket_fd' parameter, which when >= 0 is
242 * used to send the data to the parent. */
246 /* First, find /etc/os-release and send it upstream (or just save it). */
247 r
= open_os_release(where
, &os_release_path
, &os_release_fd
);
249 log_debug_errno(r
, "Couldn't acquire os-release file, ignoring: %m");
251 if (socket_fd
>= 0) {
252 r
= send_item(socket_fd
, "/etc/os-release", os_release_fd
);
254 return log_debug_errno(r
, "Failed to send os-release file: %m");
257 if (ret_os_release
) {
258 os_release
= portable_metadata_new("/etc/os-release", os_release_fd
);
263 os_release
->source
= TAKE_PTR(os_release_path
);
267 /* Then, send unit file data to the parent (or/and add it to the hashmap). For that we use our usual unit
268 * discovery logic. Note that we force looking inside of /lib/systemd/system/ for units too, as we mightbe
269 * compiled for a split-usr system but the image might be a legacy-usr one. */
270 r
= lookup_paths_init(&paths
, UNIT_FILE_SYSTEM
, LOOKUP_PATHS_SPLIT_USR
, where
);
272 return log_debug_errno(r
, "Failed to acquire lookup paths: %m");
274 unit_files
= hashmap_new(&portable_metadata_hash_ops
);
278 STRV_FOREACH(i
, paths
.search_path
) {
279 _cleanup_free_
char *resolved
= NULL
;
280 _cleanup_closedir_
DIR *d
= NULL
;
283 r
= chase_symlinks_and_opendir(*i
, where
, 0, &resolved
, &d
);
285 log_debug_errno(r
, "Failed to open unit path '%s', ignoring: %m", *i
);
289 FOREACH_DIRENT(de
, d
, return log_debug_errno(errno
, "Failed to read directory: %m")) {
290 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*m
= NULL
;
291 _cleanup_close_
int fd
= -1;
293 if (!unit_name_is_valid(de
->d_name
, UNIT_NAME_ANY
))
296 if (!unit_match(de
->d_name
, matches
))
299 /* Filter out duplicates */
300 if (hashmap_get(unit_files
, de
->d_name
))
303 dirent_ensure_type(d
, de
);
304 if (!IN_SET(de
->d_type
, DT_LNK
, DT_REG
))
307 fd
= openat(dirfd(d
), de
->d_name
, O_CLOEXEC
|O_RDONLY
);
309 log_debug_errno(errno
, "Failed to open unit file '%s', ignoring: %m", de
->d_name
);
313 if (socket_fd
>= 0) {
314 r
= send_item(socket_fd
, de
->d_name
, fd
);
316 return log_debug_errno(r
, "Failed to send unit metadata to parent: %m");
319 m
= portable_metadata_new(de
->d_name
, fd
);
324 m
->source
= path_join(resolved
, de
->d_name
);
328 r
= hashmap_put(unit_files
, m
->name
, m
);
330 return log_debug_errno(r
, "Failed to add unit to hashmap: %m");
336 *ret_os_release
= TAKE_PTR(os_release
);
338 *ret_unit_files
= TAKE_PTR(unit_files
);
343 static int portable_extract_by_path(
346 PortableMetadata
**ret_os_release
,
347 Hashmap
**ret_unit_files
,
348 sd_bus_error
*error
) {
350 _cleanup_hashmap_free_ Hashmap
*unit_files
= NULL
;
351 _cleanup_(portable_metadata_unrefp
) PortableMetadata
* os_release
= NULL
;
352 _cleanup_(loop_device_unrefp
) LoopDevice
*d
= NULL
;
357 r
= loop_device_make_by_path(path
, O_RDONLY
, LO_FLAGS_PARTSCAN
, &d
);
359 /* We can't turn this into a loop-back block device, and this returns EISDIR? Then this is a directory
360 * tree and not a raw device. It's easy then. */
362 r
= extract_now(path
, matches
, -1, &os_release
, &unit_files
);
367 return log_debug_errno(r
, "Failed to set up loopback device: %m");
369 _cleanup_(dissected_image_unrefp
) DissectedImage
*m
= NULL
;
370 _cleanup_(rmdir_and_freep
) char *tmpdir
= NULL
;
371 _cleanup_(close_pairp
) int seq
[2] = { -1, -1 };
372 _cleanup_(sigkill_waitp
) pid_t child
= 0;
374 /* We now have a loopback block device, let's fork off a child in its own mount namespace, mount it
375 * there, and extract the metadata we need. The metadata is sent from the child back to us. */
377 BLOCK_SIGNALS(SIGCHLD
);
379 r
= mkdtemp_malloc("/tmp/inspect-XXXXXX", &tmpdir
);
381 return log_debug_errno(r
, "Failed to create temporary directory: %m");
383 r
= dissect_image(d
->fd
, NULL
, 0, NULL
, DISSECT_IMAGE_READ_ONLY
|DISSECT_IMAGE_REQUIRE_ROOT
|DISSECT_IMAGE_DISCARD_ON_LOOP
|DISSECT_IMAGE_RELAX_VAR_CHECK
, &m
);
385 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Couldn't identify a suitable partition table or file system in '%s'.", path
);
386 else if (r
== -EADDRNOTAVAIL
)
387 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "No root partition for specified root hash found in '%s'.", path
);
388 else if (r
== -ENOTUNIQ
)
389 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Multiple suitable root partitions found in image '%s'.", path
);
390 else if (r
== -ENXIO
)
391 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "No suitable root partition found in image '%s'.", path
);
392 else if (r
== -EPROTONOSUPPORT
)
393 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Device '%s' is loopback block device with partition scanning turned off, please turn it on.", path
);
397 if (socketpair(AF_UNIX
, SOCK_SEQPACKET
|SOCK_CLOEXEC
, 0, seq
) < 0)
398 return log_debug_errno(errno
, "Failed to allocated SOCK_SEQPACKET socket: %m");
400 r
= safe_fork("(sd-dissect)", FORK_RESET_SIGNALS
|FORK_DEATHSIG
|FORK_NEW_MOUNTNS
|FORK_MOUNTNS_SLAVE
|FORK_LOG
, &child
);
404 seq
[0] = safe_close(seq
[0]);
406 r
= dissected_image_mount(m
, tmpdir
, UID_INVALID
, DISSECT_IMAGE_READ_ONLY
|DISSECT_IMAGE_VALIDATE_OS
);
408 log_debug_errno(r
, "Failed to mount dissected image: %m");
412 r
= extract_now(tmpdir
, matches
, seq
[1], NULL
, NULL
);
415 _exit(r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
);
418 seq
[1] = safe_close(seq
[1]);
420 unit_files
= hashmap_new(&portable_metadata_hash_ops
);
425 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*add
= NULL
;
426 _cleanup_free_
char *name
= NULL
;
427 _cleanup_close_
int fd
= -1;
429 r
= recv_item(seq
[0], &name
, &fd
);
431 return log_debug_errno(r
, "Failed to receive item: %m");
433 /* We can't really distinguish a zero-length datagram without any fds from EOF (both are signalled the
434 * same way by recvmsg()). Hence, accept either as end notification. */
435 if (isempty(name
) && fd
< 0)
438 if (isempty(name
) || fd
< 0) {
439 log_debug("Invalid item sent from child.");
443 add
= portable_metadata_new(name
, fd
);
448 /* Note that we do not initialize 'add->source' here, as the source path is not usable here as
449 * it refers to a path only valid in the short-living namespaced child process we forked
452 if (PORTABLE_METADATA_IS_UNIT(add
)) {
453 r
= hashmap_put(unit_files
, add
->name
, add
);
455 return log_debug_errno(r
, "Failed to add item to unit file list: %m");
459 } else if (PORTABLE_METADATA_IS_OS_RELEASE(add
)) {
462 os_release
= TAKE_PTR(add
);
464 assert_not_reached("Unexpected metadata item from child.");
467 r
= wait_for_terminate_and_check("(sd-dissect)", child
, 0);
474 return sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Image '%s' lacks os-release data, refusing.", path
);
476 if (hashmap_isempty(unit_files
))
477 return sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Couldn't find any matching unit files in image '%s', refusing.", path
);
480 *ret_unit_files
= TAKE_PTR(unit_files
);
483 *ret_os_release
= TAKE_PTR(os_release
);
488 int portable_extract(
489 const char *name_or_path
,
491 PortableMetadata
**ret_os_release
,
492 Hashmap
**ret_unit_files
,
493 sd_bus_error
*error
) {
495 _cleanup_(image_unrefp
) Image
*image
= NULL
;
498 assert(name_or_path
);
500 r
= image_find_harder(IMAGE_PORTABLE
, name_or_path
, &image
);
504 return portable_extract_by_path(image
->path
, matches
, ret_os_release
, ret_unit_files
, error
);
507 static int unit_file_is_active(
510 sd_bus_error
*error
) {
512 static const char *const active_states
[] = {
524 /* If we are looking at a plain or instance things are easy, we can just query the state */
525 if (unit_name_is_valid(name
, UNIT_NAME_PLAIN
|UNIT_NAME_INSTANCE
)) {
526 _cleanup_free_
char *path
= NULL
, *buf
= NULL
;
528 path
= unit_dbus_path_from_name(name
);
532 r
= sd_bus_get_property_string(
534 "org.freedesktop.systemd1",
536 "org.freedesktop.systemd1.Unit",
541 return log_debug_errno(r
, "Failed to retrieve unit state: %s", bus_error_message(error
, r
));
543 return strv_contains((char**) active_states
, buf
);
546 /* Otherwise we need to enumerate. But let's build the most restricted query we can */
547 if (unit_name_is_valid(name
, UNIT_NAME_TEMPLATE
)) {
548 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
, *reply
= NULL
;
549 const char *at
, *prefix
, *joined
;
551 r
= sd_bus_message_new_method_call(
554 "org.freedesktop.systemd1",
555 "/org/freedesktop/systemd1",
556 "org.freedesktop.systemd1.Manager",
557 "ListUnitsByPatterns");
561 r
= sd_bus_message_append_strv(m
, (char**) active_states
);
565 at
= strchr(name
, '@');
568 prefix
= strndupa(name
, at
+ 1 - name
);
569 joined
= strjoina(prefix
, "*", at
+ 1);
571 r
= sd_bus_message_append_strv(m
, STRV_MAKE(joined
));
575 r
= sd_bus_call(bus
, m
, 0, error
, &reply
);
577 return log_debug_errno(r
, "Failed to list units: %s", bus_error_message(error
, r
));
579 r
= sd_bus_message_enter_container(reply
, SD_BUS_TYPE_ARRAY
, "(ssssssouso)");
583 r
= sd_bus_message_enter_container(reply
, SD_BUS_TYPE_STRUCT
, "ssssssouso");
593 static int portable_changes_add(
594 PortableChange
**changes
,
596 PortableChangeType type
,
598 const char *source
) {
600 _cleanup_free_
char *p
= NULL
, *s
= NULL
;
604 assert(!changes
== !n_changes
);
609 c
= reallocarray(*changes
, *n_changes
+ 1, sizeof(PortableChange
));
618 path_simplify(p
, false);
625 path_simplify(s
, false);
628 c
[(*n_changes
)++] = (PortableChange
) {
631 .source
= TAKE_PTR(s
),
637 static int portable_changes_add_with_prefix(
638 PortableChange
**changes
,
640 PortableChangeType type
,
643 const char *source
) {
646 assert(!changes
== !n_changes
);
652 path
= prefix_roota(prefix
, path
);
655 source
= prefix_roota(prefix
, source
);
658 return portable_changes_add(changes
, n_changes
, type
, path
, source
);
661 void portable_changes_free(PortableChange
*changes
, size_t n_changes
) {
664 assert(changes
|| n_changes
== 0);
666 for (i
= 0; i
< n_changes
; i
++) {
667 free(changes
[i
].path
);
668 free(changes
[i
].source
);
674 static int install_chroot_dropin(
675 const char *image_path
,
677 const PortableMetadata
*m
,
678 const char *dropin_dir
,
680 PortableChange
**changes
,
683 _cleanup_free_
char *text
= NULL
, *dropin
= NULL
;
690 dropin
= path_join(dropin_dir
, "20-portable.conf");
694 text
= strjoin(PORTABLE_DROPIN_MARKER_BEGIN
, image_path
, PORTABLE_DROPIN_MARKER_END
"\n");
698 if (endswith(m
->name
, ".service"))
699 if (!strextend(&text
,
702 IN_SET(type
, IMAGE_DIRECTORY
, IMAGE_SUBVOLUME
) ? "RootDirectory=" : "RootImage=", image_path
, "\n"
703 "Environment=PORTABLE=", basename(image_path
), "\n"
704 "BindReadOnlyPaths=-/etc/os-release:/run/host/etc/os-release /usr/lib/os-release:/run/host/usr/lib/os-release\n"
705 "LogExtraFields=PORTABLE=", basename(image_path
), "\n",
710 r
= write_string_file(dropin
, text
, WRITE_STRING_FILE_CREATE
|WRITE_STRING_FILE_ATOMIC
);
712 return log_debug_errno(r
, "Failed to write '%s': %m", dropin
);
714 (void) portable_changes_add(changes
, n_changes
, PORTABLE_WRITE
, dropin
, NULL
);
717 *ret_dropin
= TAKE_PTR(dropin
);
722 static int find_profile(const char *name
, const char *unit
, char **ret
) {
728 assert_se(dot
= strrchr(unit
, '.'));
730 NULSTR_FOREACH(p
, profile_dirs
) {
731 _cleanup_free_
char *joined
;
733 joined
= strjoin(p
, "/", name
, "/", dot
+ 1, ".conf");
737 if (laccess(joined
, F_OK
) >= 0) {
738 *ret
= TAKE_PTR(joined
);
749 static int install_profile_dropin(
750 const char *image_path
,
751 const PortableMetadata
*m
,
752 const char *dropin_dir
,
756 PortableChange
**changes
,
759 _cleanup_free_
char *dropin
= NULL
, *from
= NULL
;
769 r
= find_profile(profile
, m
->name
, &from
);
772 return log_debug_errno(errno
, "Profile '%s' is not accessible: %m", profile
);
774 log_debug_errno(errno
, "Skipping link to profile '%s', as it does not exist: %m", profile
);
778 dropin
= path_join(dropin_dir
, "10-profile.conf");
782 if (flags
& PORTABLE_PREFER_COPY
) {
784 r
= copy_file_atomic(from
, dropin
, 0644, 0, 0, COPY_REFLINK
);
786 return log_debug_errno(r
, "Failed to copy %s %s %s: %m", from
, special_glyph(SPECIAL_GLYPH_ARROW
), dropin
);
788 (void) portable_changes_add(changes
, n_changes
, PORTABLE_COPY
, dropin
, from
);
792 if (symlink(from
, dropin
) < 0)
793 return log_debug_errno(errno
, "Failed to link %s %s %s: %m", from
, special_glyph(SPECIAL_GLYPH_ARROW
), dropin
);
795 (void) portable_changes_add(changes
, n_changes
, PORTABLE_SYMLINK
, dropin
, from
);
799 *ret_dropin
= TAKE_PTR(dropin
);
804 static const char *attached_path(const LookupPaths
*paths
, PortableFlags flags
) {
809 if (flags
& PORTABLE_RUNTIME
)
810 where
= paths
->runtime_attached
;
812 where
= paths
->persistent_attached
;
818 static int attach_unit_file(
819 const LookupPaths
*paths
,
820 const char *image_path
,
822 const PortableMetadata
*m
,
825 PortableChange
**changes
,
828 _cleanup_(unlink_and_freep
) char *chroot_dropin
= NULL
, *profile_dropin
= NULL
;
829 _cleanup_(rmdir_and_freep
) char *dropin_dir
= NULL
;
830 const char *where
, *path
;
836 assert(PORTABLE_METADATA_IS_UNIT(m
));
838 where
= attached_path(paths
, flags
);
840 (void) mkdir_parents(where
, 0755);
841 if (mkdir(where
, 0755) < 0) {
845 (void) portable_changes_add(changes
, n_changes
, PORTABLE_MKDIR
, where
, NULL
);
847 path
= prefix_roota(where
, m
->name
);
848 dropin_dir
= strjoin(path
, ".d");
852 if (mkdir(dropin_dir
, 0755) < 0) {
856 (void) portable_changes_add(changes
, n_changes
, PORTABLE_MKDIR
, dropin_dir
, NULL
);
858 /* We install the drop-ins first, and the actual unit file last to achieve somewhat atomic behaviour if PID 1
859 * is reloaded while we are creating things here: as long as only the drop-ins exist the unit doesn't exist at
862 r
= install_chroot_dropin(image_path
, type
, m
, dropin_dir
, &chroot_dropin
, changes
, n_changes
);
866 r
= install_profile_dropin(image_path
, m
, dropin_dir
, profile
, flags
, &profile_dropin
, changes
, n_changes
);
870 if ((flags
& PORTABLE_PREFER_SYMLINK
) && m
->source
) {
872 if (symlink(m
->source
, path
) < 0)
873 return log_debug_errno(errno
, "Failed to symlink unit file '%s': %m", path
);
875 (void) portable_changes_add(changes
, n_changes
, PORTABLE_SYMLINK
, path
, m
->source
);
878 _cleanup_(unlink_and_freep
) char *tmp
= NULL
;
879 _cleanup_close_
int fd
= -1;
881 fd
= open_tmpfile_linkable(path
, O_WRONLY
|O_CLOEXEC
, &tmp
);
883 return log_debug_errno(fd
, "Failed to create unit file '%s': %m", path
);
885 r
= copy_bytes(m
->fd
, fd
, UINT64_MAX
, COPY_REFLINK
);
887 return log_debug_errno(r
, "Failed to copy unit file '%s': %m", path
);
889 if (fchmod(fd
, 0644) < 0)
890 return log_debug_errno(errno
, "Failed to change unit file access mode for '%s': %m", path
);
892 r
= link_tmpfile(fd
, tmp
, path
);
894 return log_debug_errno(r
, "Failed to install unit file '%s': %m", path
);
898 (void) portable_changes_add(changes
, n_changes
, PORTABLE_COPY
, path
, m
->source
);
901 /* All is established now, now let's disable any rollbacks */
902 chroot_dropin
= mfree(chroot_dropin
);
903 profile_dropin
= mfree(profile_dropin
);
904 dropin_dir
= mfree(dropin_dir
);
909 static int image_symlink(
910 const char *image_path
,
914 const char *fn
, *where
;
920 fn
= last_path_component(image_path
);
922 if (flags
& PORTABLE_RUNTIME
)
923 where
= "/run/portables/";
925 where
= "/etc/portables/";
927 joined
= strjoin(where
, fn
);
935 static int install_image_symlink(
936 const char *image_path
,
938 PortableChange
**changes
,
941 _cleanup_free_
char *sl
= NULL
;
946 /* If the image is outside of the image search also link it into it, so that it can be found with short image
947 * names and is listed among the images. */
949 if (image_in_search_path(IMAGE_PORTABLE
, image_path
))
952 r
= image_symlink(image_path
, flags
, &sl
);
954 return log_debug_errno(r
, "Failed to generate image symlink path: %m");
956 (void) mkdir_parents(sl
, 0755);
958 if (symlink(image_path
, sl
) < 0)
959 return log_debug_errno(errno
, "Failed to link %s %s %s: %m", image_path
, special_glyph(SPECIAL_GLYPH_ARROW
), sl
);
961 (void) portable_changes_add(changes
, n_changes
, PORTABLE_SYMLINK
, sl
, image_path
);
967 const char *name_or_path
,
971 PortableChange
**changes
,
973 sd_bus_error
*error
) {
975 _cleanup_hashmap_free_ Hashmap
*unit_files
= NULL
;
976 _cleanup_(lookup_paths_free
) LookupPaths paths
= {};
977 _cleanup_(image_unrefp
) Image
*image
= NULL
;
978 PortableMetadata
*item
;
982 assert(name_or_path
);
984 r
= image_find_harder(IMAGE_PORTABLE
, name_or_path
, &image
);
988 r
= portable_extract_by_path(image
->path
, matches
, NULL
, &unit_files
, error
);
992 r
= lookup_paths_init(&paths
, UNIT_FILE_SYSTEM
, LOOKUP_PATHS_SPLIT_USR
, NULL
);
996 HASHMAP_FOREACH(item
, unit_files
, iterator
) {
997 r
= unit_file_exists(UNIT_FILE_SYSTEM
, &paths
, item
->name
);
999 return sd_bus_error_set_errnof(error
, r
, "Failed to determine whether unit '%s' exists on the host: %m", item
->name
);
1001 return sd_bus_error_setf(error
, BUS_ERROR_UNIT_EXISTS
, "Unit file '%s' exists on the host already, refusing.", item
->name
);
1003 r
= unit_file_is_active(bus
, item
->name
, error
);
1007 return sd_bus_error_setf(error
, BUS_ERROR_UNIT_EXISTS
, "Unit file '%s' is active already, refusing.", item
->name
);
1010 HASHMAP_FOREACH(item
, unit_files
, iterator
) {
1011 r
= attach_unit_file(&paths
, image
->path
, image
->type
, item
, profile
, flags
, changes
, n_changes
);
1016 /* We don't care too much for the image symlink, it's just a convenience thing, it's not necessary for proper
1017 * operation otherwise. */
1018 (void) install_image_symlink(image
->path
, flags
, changes
, n_changes
);
1023 static bool marker_matches_image(const char *marker
, const char *name_or_path
) {
1027 assert(name_or_path
);
1029 a
= last_path_component(marker
);
1031 if (image_name_is_valid(name_or_path
)) {
1034 /* We shall match against an image name. In that case let's compare the last component, and optionally
1035 * allow either a suffix of ".raw" or a series of "/". */
1037 e
= startswith(a
, name_or_path
);
1042 e
[strspn(e
, "/")] == 0 ||
1048 /* We shall match against a path. Let's ignore any prefix here though, as often there are many ways to
1049 * reach the same file. However, in this mode, let's validate any file suffix. */
1051 l
= strcspn(a
, "/");
1052 b
= last_path_component(name_or_path
);
1054 if (strcspn(b
, "/") != l
)
1057 return memcmp(a
, b
, l
) == 0;
1061 static int test_chroot_dropin(
1065 const char *name_or_path
,
1066 char **ret_marker
) {
1068 _cleanup_free_
char *line
= NULL
, *marker
= NULL
;
1069 _cleanup_fclose_
FILE *f
= NULL
;
1070 _cleanup_close_
int fd
= -1;
1071 const char *p
, *e
, *k
;
1078 /* We recognize unis created from portable images via the drop-in we created for them */
1080 p
= strjoina(fname
, ".d/20-portable.conf");
1081 fd
= openat(dirfd(d
), p
, O_RDONLY
|O_CLOEXEC
);
1083 if (errno
== ENOENT
)
1086 return log_debug_errno(errno
, "Failed to open %s/%s: %m", where
, p
);
1089 r
= take_fdopen_unlocked(&fd
, "r", &f
);
1091 return log_debug_errno(r
, "Failed to convert file handle: %m");
1093 r
= read_line(f
, LONG_LINE_MAX
, &line
);
1095 return log_debug_errno(r
, "Failed to read from %s/%s: %m", where
, p
);
1097 e
= startswith(line
, PORTABLE_DROPIN_MARKER_BEGIN
);
1101 k
= endswith(e
, PORTABLE_DROPIN_MARKER_END
);
1105 marker
= strndup(e
, k
- e
);
1112 r
= marker_matches_image(marker
, name_or_path
);
1115 *ret_marker
= TAKE_PTR(marker
);
1120 int portable_detach(
1122 const char *name_or_path
,
1123 PortableFlags flags
,
1124 PortableChange
**changes
,
1126 sd_bus_error
*error
) {
1128 _cleanup_(lookup_paths_free
) LookupPaths paths
= {};
1129 _cleanup_set_free_ Set
*unit_files
= NULL
, *markers
= NULL
;
1130 _cleanup_closedir_
DIR *d
= NULL
;
1131 const char *where
, *item
;
1137 assert(name_or_path
);
1139 r
= lookup_paths_init(&paths
, UNIT_FILE_SYSTEM
, LOOKUP_PATHS_SPLIT_USR
, NULL
);
1143 where
= attached_path(&paths
, flags
);
1147 if (errno
== ENOENT
)
1150 return log_debug_errno(errno
, "Failed to open '%s' directory: %m", where
);
1153 FOREACH_DIRENT(de
, d
, return log_debug_errno(errno
, "Failed to enumerate '%s' directory: %m", where
)) {
1154 _cleanup_free_
char *marker
= NULL
;
1155 UnitFileState state
;
1157 if (!unit_name_is_valid(de
->d_name
, UNIT_NAME_ANY
))
1160 /* Filter out duplicates */
1161 if (set_contains(unit_files
, de
->d_name
))
1164 dirent_ensure_type(d
, de
);
1165 if (!IN_SET(de
->d_type
, DT_LNK
, DT_REG
))
1168 r
= test_chroot_dropin(d
, where
, de
->d_name
, name_or_path
, &marker
);
1174 r
= unit_file_lookup_state(UNIT_FILE_SYSTEM
, &paths
, de
->d_name
, &state
);
1176 return log_debug_errno(r
, "Failed to determine unit file state of '%s': %m", de
->d_name
);
1177 if (!IN_SET(state
, UNIT_FILE_STATIC
, UNIT_FILE_DISABLED
, UNIT_FILE_LINKED
, UNIT_FILE_RUNTIME
, UNIT_FILE_LINKED_RUNTIME
))
1178 return sd_bus_error_setf(error
, BUS_ERROR_UNIT_EXISTS
, "Unit file '%s' is in state '%s', can't detach.", de
->d_name
, unit_file_state_to_string(state
));
1180 r
= unit_file_is_active(bus
, de
->d_name
, error
);
1184 return sd_bus_error_setf(error
, BUS_ERROR_UNIT_EXISTS
, "Unit file '%s' is active, can't detach.", de
->d_name
);
1186 r
= set_put_strdup(&unit_files
, de
->d_name
);
1188 return log_debug_errno(r
, "Failed to add unit name '%s' to set: %m", de
->d_name
);
1190 if (path_is_absolute(marker
) &&
1191 !image_in_search_path(IMAGE_PORTABLE
, marker
)) {
1193 r
= set_ensure_consume(&markers
, &path_hash_ops_free
, TAKE_PTR(marker
));
1199 if (set_isempty(unit_files
))
1202 SET_FOREACH(item
, unit_files
, iterator
) {
1203 _cleanup_free_
char *md
= NULL
;
1206 if (unlinkat(dirfd(d
), item
, 0) < 0) {
1207 log_debug_errno(errno
, "Can't remove unit file %s/%s: %m", where
, item
);
1209 if (errno
!= ENOENT
&& ret
>= 0)
1212 portable_changes_add_with_prefix(changes
, n_changes
, PORTABLE_UNLINK
, where
, item
, NULL
);
1214 FOREACH_STRING(suffix
, ".d/10-profile.conf", ".d/20-portable.conf") {
1215 _cleanup_free_
char *dropin
= NULL
;
1217 dropin
= strjoin(item
, suffix
);
1221 if (unlinkat(dirfd(d
), dropin
, 0) < 0) {
1222 log_debug_errno(errno
, "Can't remove drop-in %s/%s: %m", where
, dropin
);
1224 if (errno
!= ENOENT
&& ret
>= 0)
1227 portable_changes_add_with_prefix(changes
, n_changes
, PORTABLE_UNLINK
, where
, dropin
, NULL
);
1230 md
= strjoin(item
, ".d");
1234 if (unlinkat(dirfd(d
), md
, AT_REMOVEDIR
) < 0) {
1235 log_debug_errno(errno
, "Can't remove drop-in directory %s/%s: %m", where
, md
);
1237 if (errno
!= ENOENT
&& ret
>= 0)
1240 portable_changes_add_with_prefix(changes
, n_changes
, PORTABLE_UNLINK
, where
, md
, NULL
);
1243 /* Now, also drop any image symlink, for images outside of the sarch path */
1244 SET_FOREACH(item
, markers
, iterator
) {
1245 _cleanup_free_
char *sl
= NULL
;
1248 r
= image_symlink(item
, flags
, &sl
);
1250 log_debug_errno(r
, "Failed to determine image symlink for '%s', ignoring: %m", item
);
1254 if (lstat(sl
, &st
) < 0) {
1255 log_debug_errno(errno
, "Failed to stat '%s', ignoring: %m", sl
);
1259 if (!S_ISLNK(st
.st_mode
)) {
1260 log_debug("Image '%s' is not a symlink, ignoring.", sl
);
1264 if (unlink(sl
) < 0) {
1265 log_debug_errno(errno
, "Can't remove image symlink '%s': %m", sl
);
1267 if (errno
!= ENOENT
&& ret
>= 0)
1270 portable_changes_add(changes
, n_changes
, PORTABLE_UNLINK
, sl
, NULL
);
1273 /* Try to remove the unit file directory, if we can */
1274 if (rmdir(where
) >= 0)
1275 portable_changes_add(changes
, n_changes
, PORTABLE_UNLINK
, where
, NULL
);
1280 log_debug("No unit files associated with '%s' found. Image not attached?", name_or_path
);
1281 return sd_bus_error_setf(error
, BUS_ERROR_NO_SUCH_UNIT
, "No unit files associated with '%s' found. Image not attached?", name_or_path
);
1284 static int portable_get_state_internal(
1286 const char *name_or_path
,
1287 PortableFlags flags
,
1289 sd_bus_error
*error
) {
1291 _cleanup_(lookup_paths_free
) LookupPaths paths
= {};
1292 bool found_enabled
= false, found_running
= false;
1293 _cleanup_set_free_ Set
*unit_files
= NULL
;
1294 _cleanup_closedir_
DIR *d
= NULL
;
1299 assert(name_or_path
);
1302 r
= lookup_paths_init(&paths
, UNIT_FILE_SYSTEM
, LOOKUP_PATHS_SPLIT_USR
, NULL
);
1306 where
= attached_path(&paths
, flags
);
1310 if (errno
== ENOENT
) {
1311 /* If the 'attached' directory doesn't exist at all, then we know for sure this image isn't attached. */
1312 *ret
= PORTABLE_DETACHED
;
1316 return log_debug_errno(errno
, "Failed to open '%s' directory: %m", where
);
1319 FOREACH_DIRENT(de
, d
, return log_debug_errno(errno
, "Failed to enumerate '%s' directory: %m", where
)) {
1320 UnitFileState state
;
1322 if (!unit_name_is_valid(de
->d_name
, UNIT_NAME_ANY
))
1325 /* Filter out duplicates */
1326 if (set_contains(unit_files
, de
->d_name
))
1329 dirent_ensure_type(d
, de
);
1330 if (!IN_SET(de
->d_type
, DT_LNK
, DT_REG
))
1333 r
= test_chroot_dropin(d
, where
, de
->d_name
, name_or_path
, NULL
);
1339 r
= unit_file_lookup_state(UNIT_FILE_SYSTEM
, &paths
, de
->d_name
, &state
);
1341 return log_debug_errno(r
, "Failed to determine unit file state of '%s': %m", de
->d_name
);
1342 if (!IN_SET(state
, UNIT_FILE_STATIC
, UNIT_FILE_DISABLED
, UNIT_FILE_LINKED
, UNIT_FILE_LINKED_RUNTIME
))
1343 found_enabled
= true;
1345 r
= unit_file_is_active(bus
, de
->d_name
, error
);
1349 found_running
= true;
1351 r
= set_put_strdup(&unit_files
, de
->d_name
);
1353 return log_debug_errno(r
, "Failed to add unit name '%s' to set: %m", de
->d_name
);
1356 *ret
= found_running
? (!set_isempty(unit_files
) && (flags
& PORTABLE_RUNTIME
) ? PORTABLE_RUNNING_RUNTIME
: PORTABLE_RUNNING
) :
1357 found_enabled
? (flags
& PORTABLE_RUNTIME
? PORTABLE_ENABLED_RUNTIME
: PORTABLE_ENABLED
) :
1358 !set_isempty(unit_files
) ? (flags
& PORTABLE_RUNTIME
? PORTABLE_ATTACHED_RUNTIME
: PORTABLE_ATTACHED
) : PORTABLE_DETACHED
;
1363 int portable_get_state(
1365 const char *name_or_path
,
1366 PortableFlags flags
,
1368 sd_bus_error
*error
) {
1370 PortableState state
;
1373 assert(name_or_path
);
1376 /* We look for matching units twice: once in the regular directories, and once in the runtime directories — but
1377 * the latter only if we didn't find anything in the former. */
1379 r
= portable_get_state_internal(bus
, name_or_path
, flags
& ~PORTABLE_RUNTIME
, &state
, error
);
1383 if (state
== PORTABLE_DETACHED
) {
1384 r
= portable_get_state_internal(bus
, name_or_path
, flags
| PORTABLE_RUNTIME
, &state
, error
);
1393 int portable_get_profiles(char ***ret
) {
1396 return conf_files_list_nulstr(ret
, NULL
, NULL
, CONF_FILES_DIRECTORY
|CONF_FILES_BASENAME
|CONF_FILES_FILTER_MASKED
, profile_dirs
);
1399 static const char* const portable_change_type_table
[_PORTABLE_CHANGE_TYPE_MAX
] = {
1400 [PORTABLE_COPY
] = "copy",
1401 [PORTABLE_MKDIR
] = "mkdir",
1402 [PORTABLE_SYMLINK
] = "symlink",
1403 [PORTABLE_UNLINK
] = "unlink",
1404 [PORTABLE_WRITE
] = "write",
1407 DEFINE_STRING_TABLE_LOOKUP(portable_change_type
, PortableChangeType
);
1409 static const char* const portable_state_table
[_PORTABLE_STATE_MAX
] = {
1410 [PORTABLE_DETACHED
] = "detached",
1411 [PORTABLE_ATTACHED
] = "attached",
1412 [PORTABLE_ATTACHED_RUNTIME
] = "attached-runtime",
1413 [PORTABLE_ENABLED
] = "enabled",
1414 [PORTABLE_ENABLED_RUNTIME
] = "enabled-runtime",
1415 [PORTABLE_RUNNING
] = "running",
1416 [PORTABLE_RUNNING_RUNTIME
] = "running-runtime",
1419 DEFINE_STRING_TABLE_LOOKUP(portable_state
, PortableState
);