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(
131 struct cmsghdr cmsghdr
;
132 uint8_t buf
[CMSG_SPACE(sizeof(int))];
136 .msg_control
= &control
,
137 .msg_controllen
= sizeof(control
),
141 struct cmsghdr
*cmsg
;
142 _cleanup_close_
int data_fd
= -1;
144 assert(socket_fd
>= 0);
148 data_fd
= fd_duplicate_data_fd(fd
);
152 cmsg
= CMSG_FIRSTHDR(&mh
);
153 cmsg
->cmsg_level
= SOL_SOCKET
;
154 cmsg
->cmsg_type
= SCM_RIGHTS
;
155 cmsg
->cmsg_len
= CMSG_LEN(sizeof(int));
156 memcpy(CMSG_DATA(cmsg
), &data_fd
, sizeof(int));
158 mh
.msg_controllen
= CMSG_SPACE(sizeof(int));
159 iovec
= IOVEC_MAKE_STRING(name
);
161 if (sendmsg(socket_fd
, &mh
, MSG_NOSIGNAL
) < 0)
167 static int recv_item(
173 struct cmsghdr cmsghdr
;
174 uint8_t buf
[CMSG_SPACE(sizeof(int))];
176 char buffer
[PATH_MAX
+2];
177 struct iovec iov
= IOVEC_INIT(buffer
, sizeof(buffer
)-1);
179 .msg_control
= &control
,
180 .msg_controllen
= sizeof(control
),
184 struct cmsghdr
*cmsg
;
185 _cleanup_close_
int found_fd
= -1;
189 assert(socket_fd
>= 0);
193 n
= recvmsg(socket_fd
, &mh
, MSG_CMSG_CLOEXEC
);
197 CMSG_FOREACH(cmsg
, &mh
) {
198 if (cmsg
->cmsg_level
== SOL_SOCKET
&&
199 cmsg
->cmsg_type
== SCM_RIGHTS
) {
201 if (cmsg
->cmsg_len
== CMSG_LEN(sizeof(int))) {
202 assert(found_fd
< 0);
203 found_fd
= *(int*) CMSG_DATA(cmsg
);
214 copy
= strdup(buffer
);
219 *ret_fd
= TAKE_FD(found_fd
);
224 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(portable_metadata_hash_ops
, char, string_hash_func
, string_compare_func
,
225 PortableMetadata
, portable_metadata_unref
);
227 static int extract_now(
231 PortableMetadata
**ret_os_release
,
232 Hashmap
**ret_unit_files
) {
234 _cleanup_hashmap_free_ Hashmap
*unit_files
= NULL
;
235 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*os_release
= NULL
;
236 _cleanup_(lookup_paths_free
) LookupPaths paths
= {};
237 _cleanup_close_
int os_release_fd
= -1;
238 _cleanup_free_
char *os_release_path
= NULL
;
242 /* Extracts the metadata from a directory tree 'where'. Extracts two kinds of information: the /etc/os-release
243 * data, and all unit files matching the specified expression. Note that this function is called in two very
244 * different but also similar contexts. When the tool gets invoked on a directory tree, we'll process it
245 * directly, and in-process, and thus can return the requested data directly, via 'ret_os_release' and
246 * 'ret_unit_files'. However, if the tool is invoked on a raw disk image — which needs to be mounted first — we
247 * are invoked in a child process with private mounts and then need to send the collected data to our
248 * parent. To handle both cases in one call this function also gets a 'socket_fd' parameter, which when >= 0 is
249 * used to send the data to the parent. */
253 /* First, find /etc/os-release and send it upstream (or just save it). */
254 r
= open_os_release(where
, &os_release_path
, &os_release_fd
);
256 log_debug_errno(r
, "Couldn't acquire os-release file, ignoring: %m");
258 if (socket_fd
>= 0) {
259 r
= send_item(socket_fd
, "/etc/os-release", os_release_fd
);
261 return log_debug_errno(r
, "Failed to send os-release file: %m");
264 if (ret_os_release
) {
265 os_release
= portable_metadata_new("/etc/os-release", os_release_fd
);
270 os_release
->source
= TAKE_PTR(os_release_path
);
274 /* Then, send unit file data to the parent (or/and add it to the hashmap). For that we use our usual unit
275 * discovery logic. Note that we force looking inside of /lib/systemd/system/ for units too, as we mightbe
276 * compiled for a split-usr system but the image might be a legacy-usr one. */
277 r
= lookup_paths_init(&paths
, UNIT_FILE_SYSTEM
, LOOKUP_PATHS_SPLIT_USR
, where
);
279 return log_debug_errno(r
, "Failed to acquire lookup paths: %m");
281 unit_files
= hashmap_new(&portable_metadata_hash_ops
);
285 STRV_FOREACH(i
, paths
.search_path
) {
286 _cleanup_free_
char *resolved
= NULL
;
287 _cleanup_closedir_
DIR *d
= NULL
;
290 r
= chase_symlinks_and_opendir(*i
, where
, 0, &resolved
, &d
);
292 log_debug_errno(r
, "Failed to open unit path '%s', ignoring: %m", *i
);
296 FOREACH_DIRENT(de
, d
, return log_debug_errno(errno
, "Failed to read directory: %m")) {
297 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*m
= NULL
;
298 _cleanup_close_
int fd
= -1;
300 if (!unit_name_is_valid(de
->d_name
, UNIT_NAME_ANY
))
303 if (!unit_match(de
->d_name
, matches
))
306 /* Filter out duplicates */
307 if (hashmap_get(unit_files
, de
->d_name
))
310 dirent_ensure_type(d
, de
);
311 if (!IN_SET(de
->d_type
, DT_LNK
, DT_REG
))
314 fd
= openat(dirfd(d
), de
->d_name
, O_CLOEXEC
|O_RDONLY
);
316 log_debug_errno(errno
, "Failed to open unit file '%s', ignoring: %m", de
->d_name
);
320 if (socket_fd
>= 0) {
321 r
= send_item(socket_fd
, de
->d_name
, fd
);
323 return log_debug_errno(r
, "Failed to send unit metadata to parent: %m");
326 m
= portable_metadata_new(de
->d_name
, fd
);
331 m
->source
= path_join(resolved
, de
->d_name
);
335 r
= hashmap_put(unit_files
, m
->name
, m
);
337 return log_debug_errno(r
, "Failed to add unit to hashmap: %m");
343 *ret_os_release
= TAKE_PTR(os_release
);
345 *ret_unit_files
= TAKE_PTR(unit_files
);
350 static int portable_extract_by_path(
353 PortableMetadata
**ret_os_release
,
354 Hashmap
**ret_unit_files
,
355 sd_bus_error
*error
) {
357 _cleanup_hashmap_free_ Hashmap
*unit_files
= NULL
;
358 _cleanup_(portable_metadata_unrefp
) PortableMetadata
* os_release
= NULL
;
359 _cleanup_(loop_device_unrefp
) LoopDevice
*d
= NULL
;
364 r
= loop_device_make_by_path(path
, O_RDONLY
, LO_FLAGS_PARTSCAN
, &d
);
366 /* We can't turn this into a loop-back block device, and this returns EISDIR? Then this is a directory
367 * tree and not a raw device. It's easy then. */
369 r
= extract_now(path
, matches
, -1, &os_release
, &unit_files
);
374 return log_debug_errno(r
, "Failed to set up loopback device: %m");
376 _cleanup_(dissected_image_unrefp
) DissectedImage
*m
= NULL
;
377 _cleanup_(rmdir_and_freep
) char *tmpdir
= NULL
;
378 _cleanup_(close_pairp
) int seq
[2] = { -1, -1 };
379 _cleanup_(sigkill_waitp
) pid_t child
= 0;
381 /* We now have a loopback block device, let's fork off a child in its own mount namespace, mount it
382 * there, and extract the metadata we need. The metadata is sent from the child back to us. */
384 BLOCK_SIGNALS(SIGCHLD
);
386 r
= mkdtemp_malloc("/tmp/inspect-XXXXXX", &tmpdir
);
388 return log_debug_errno(r
, "Failed to create temporary directory: %m");
390 r
= dissect_image(d
->fd
, NULL
, 0, DISSECT_IMAGE_READ_ONLY
|DISSECT_IMAGE_REQUIRE_ROOT
|DISSECT_IMAGE_DISCARD_ON_LOOP
, &m
);
392 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Couldn't identify a suitable partition table or file system in '%s'.", path
);
393 else if (r
== -EADDRNOTAVAIL
)
394 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "No root partition for specified root hash found in '%s'.", path
);
395 else if (r
== -ENOTUNIQ
)
396 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Multiple suitable root partitions found in image '%s'.", path
);
397 else if (r
== -ENXIO
)
398 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "No suitable root partition found in image '%s'.", path
);
399 else if (r
== -EPROTONOSUPPORT
)
400 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
);
404 if (socketpair(AF_UNIX
, SOCK_SEQPACKET
|SOCK_CLOEXEC
, 0, seq
) < 0)
405 return log_debug_errno(errno
, "Failed to allocated SOCK_SEQPACKET socket: %m");
407 r
= safe_fork("(sd-dissect)", FORK_RESET_SIGNALS
|FORK_DEATHSIG
|FORK_NEW_MOUNTNS
|FORK_MOUNTNS_SLAVE
|FORK_LOG
, &child
);
411 seq
[0] = safe_close(seq
[0]);
413 r
= dissected_image_mount(m
, tmpdir
, UID_INVALID
, DISSECT_IMAGE_READ_ONLY
|DISSECT_IMAGE_VALIDATE_OS
);
415 log_debug_errno(r
, "Failed to mount dissected image: %m");
419 r
= extract_now(tmpdir
, matches
, seq
[1], NULL
, NULL
);
422 _exit(r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
);
425 seq
[1] = safe_close(seq
[1]);
427 unit_files
= hashmap_new(&portable_metadata_hash_ops
);
432 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*add
= NULL
;
433 _cleanup_free_
char *name
= NULL
;
434 _cleanup_close_
int fd
= -1;
436 r
= recv_item(seq
[0], &name
, &fd
);
438 return log_debug_errno(r
, "Failed to receive item: %m");
440 /* We can't really distinguish a zero-length datagram without any fds from EOF (both are signalled the
441 * same way by recvmsg()). Hence, accept either as end notification. */
442 if (isempty(name
) && fd
< 0)
445 if (isempty(name
) || fd
< 0) {
446 log_debug("Invalid item sent from child.");
450 add
= portable_metadata_new(name
, fd
);
455 /* Note that we do not initialize 'add->source' here, as the source path is not usable here as
456 * it refers to a path only valid in the short-living namespaced child process we forked
459 if (PORTABLE_METADATA_IS_UNIT(add
)) {
460 r
= hashmap_put(unit_files
, add
->name
, add
);
462 return log_debug_errno(r
, "Failed to add item to unit file list: %m");
466 } else if (PORTABLE_METADATA_IS_OS_RELEASE(add
)) {
469 os_release
= TAKE_PTR(add
);
471 assert_not_reached("Unexpected metadata item from child.");
474 r
= wait_for_terminate_and_check("(sd-dissect)", child
, 0);
481 return sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Image '%s' lacks os-release data, refusing.", path
);
483 if (hashmap_isempty(unit_files
))
484 return sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Couldn't find any matching unit files in image '%s', refusing.", path
);
487 *ret_unit_files
= TAKE_PTR(unit_files
);
490 *ret_os_release
= TAKE_PTR(os_release
);
495 int portable_extract(
496 const char *name_or_path
,
498 PortableMetadata
**ret_os_release
,
499 Hashmap
**ret_unit_files
,
500 sd_bus_error
*error
) {
502 _cleanup_(image_unrefp
) Image
*image
= NULL
;
505 assert(name_or_path
);
507 r
= image_find_harder(IMAGE_PORTABLE
, name_or_path
, &image
);
511 return portable_extract_by_path(image
->path
, matches
, ret_os_release
, ret_unit_files
, error
);
514 static int unit_file_is_active(
517 sd_bus_error
*error
) {
519 static const char *const active_states
[] = {
531 /* If we are looking at a plain or instance things are easy, we can just query the state */
532 if (unit_name_is_valid(name
, UNIT_NAME_PLAIN
|UNIT_NAME_INSTANCE
)) {
533 _cleanup_free_
char *path
= NULL
, *buf
= NULL
;
535 path
= unit_dbus_path_from_name(name
);
539 r
= sd_bus_get_property_string(
541 "org.freedesktop.systemd1",
543 "org.freedesktop.systemd1.Unit",
548 return log_debug_errno(r
, "Failed to retrieve unit state: %s", bus_error_message(error
, r
));
550 return strv_contains((char**) active_states
, buf
);
553 /* Otherwise we need to enumerate. But let's build the most restricted query we can */
554 if (unit_name_is_valid(name
, UNIT_NAME_TEMPLATE
)) {
555 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
, *reply
= NULL
;
556 const char *at
, *prefix
, *joined
;
558 r
= sd_bus_message_new_method_call(
561 "org.freedesktop.systemd1",
562 "/org/freedesktop/systemd1",
563 "org.freedesktop.systemd1.Manager",
564 "ListUnitsByPatterns");
568 r
= sd_bus_message_append_strv(m
, (char**) active_states
);
572 at
= strchr(name
, '@');
575 prefix
= strndupa(name
, at
+ 1 - name
);
576 joined
= strjoina(prefix
, "*", at
+ 1);
578 r
= sd_bus_message_append_strv(m
, STRV_MAKE(joined
));
582 r
= sd_bus_call(bus
, m
, 0, error
, &reply
);
584 return log_debug_errno(r
, "Failed to list units: %s", bus_error_message(error
, r
));
586 r
= sd_bus_message_enter_container(reply
, SD_BUS_TYPE_ARRAY
, "(ssssssouso)");
590 r
= sd_bus_message_enter_container(reply
, SD_BUS_TYPE_STRUCT
, "ssssssouso");
600 static int portable_changes_add(
601 PortableChange
**changes
,
603 PortableChangeType type
,
605 const char *source
) {
607 _cleanup_free_
char *p
= NULL
, *s
= NULL
;
611 assert(!changes
== !n_changes
);
616 c
= reallocarray(*changes
, *n_changes
+ 1, sizeof(PortableChange
));
625 path_simplify(p
, false);
632 path_simplify(s
, false);
635 c
[(*n_changes
)++] = (PortableChange
) {
638 .source
= TAKE_PTR(s
),
644 static int portable_changes_add_with_prefix(
645 PortableChange
**changes
,
647 PortableChangeType type
,
650 const char *source
) {
653 assert(!changes
== !n_changes
);
659 path
= prefix_roota(prefix
, path
);
662 source
= prefix_roota(prefix
, source
);
665 return portable_changes_add(changes
, n_changes
, type
, path
, source
);
668 void portable_changes_free(PortableChange
*changes
, size_t n_changes
) {
671 assert(changes
|| n_changes
== 0);
673 for (i
= 0; i
< n_changes
; i
++) {
674 free(changes
[i
].path
);
675 free(changes
[i
].source
);
681 static int install_chroot_dropin(
682 const char *image_path
,
684 const PortableMetadata
*m
,
685 const char *dropin_dir
,
687 PortableChange
**changes
,
690 _cleanup_free_
char *text
= NULL
, *dropin
= NULL
;
697 dropin
= path_join(dropin_dir
, "20-portable.conf");
701 text
= strjoin(PORTABLE_DROPIN_MARKER_BEGIN
, image_path
, PORTABLE_DROPIN_MARKER_END
"\n");
705 if (endswith(m
->name
, ".service"))
706 if (!strextend(&text
,
709 IN_SET(type
, IMAGE_DIRECTORY
, IMAGE_SUBVOLUME
) ? "RootDirectory=" : "RootImage=", image_path
, "\n"
710 "Environment=PORTABLE=", basename(image_path
), "\n"
711 "LogExtraFields=PORTABLE=", basename(image_path
), "\n",
716 r
= write_string_file(dropin
, text
, WRITE_STRING_FILE_CREATE
|WRITE_STRING_FILE_ATOMIC
);
718 return log_debug_errno(r
, "Failed to write '%s': %m", dropin
);
720 (void) portable_changes_add(changes
, n_changes
, PORTABLE_WRITE
, dropin
, NULL
);
723 *ret_dropin
= TAKE_PTR(dropin
);
728 static int find_profile(const char *name
, const char *unit
, char **ret
) {
734 assert_se(dot
= strrchr(unit
, '.'));
736 NULSTR_FOREACH(p
, profile_dirs
) {
737 _cleanup_free_
char *joined
;
739 joined
= strjoin(p
, "/", name
, "/", dot
+ 1, ".conf");
743 if (laccess(joined
, F_OK
) >= 0) {
744 *ret
= TAKE_PTR(joined
);
755 static int install_profile_dropin(
756 const char *image_path
,
757 const PortableMetadata
*m
,
758 const char *dropin_dir
,
762 PortableChange
**changes
,
765 _cleanup_free_
char *dropin
= NULL
, *from
= NULL
;
775 r
= find_profile(profile
, m
->name
, &from
);
778 return log_debug_errno(errno
, "Profile '%s' is not accessible: %m", profile
);
780 log_debug_errno(errno
, "Skipping link to profile '%s', as it does not exist: %m", profile
);
784 dropin
= path_join(dropin_dir
, "10-profile.conf");
788 if (flags
& PORTABLE_PREFER_COPY
) {
790 r
= copy_file_atomic(from
, dropin
, 0644, 0, 0, COPY_REFLINK
);
792 return log_debug_errno(r
, "Failed to copy %s %s %s: %m", from
, special_glyph(SPECIAL_GLYPH_ARROW
), dropin
);
794 (void) portable_changes_add(changes
, n_changes
, PORTABLE_COPY
, dropin
, from
);
798 if (symlink(from
, dropin
) < 0)
799 return log_debug_errno(errno
, "Failed to link %s %s %s: %m", from
, special_glyph(SPECIAL_GLYPH_ARROW
), dropin
);
801 (void) portable_changes_add(changes
, n_changes
, PORTABLE_SYMLINK
, dropin
, from
);
805 *ret_dropin
= TAKE_PTR(dropin
);
810 static const char *attached_path(const LookupPaths
*paths
, PortableFlags flags
) {
815 if (flags
& PORTABLE_RUNTIME
)
816 where
= paths
->runtime_attached
;
818 where
= paths
->persistent_attached
;
824 static int attach_unit_file(
825 const LookupPaths
*paths
,
826 const char *image_path
,
828 const PortableMetadata
*m
,
831 PortableChange
**changes
,
834 _cleanup_(unlink_and_freep
) char *chroot_dropin
= NULL
, *profile_dropin
= NULL
;
835 _cleanup_(rmdir_and_freep
) char *dropin_dir
= NULL
;
836 const char *where
, *path
;
842 assert(PORTABLE_METADATA_IS_UNIT(m
));
844 where
= attached_path(paths
, flags
);
846 (void) mkdir_parents(where
, 0755);
847 if (mkdir(where
, 0755) < 0) {
851 (void) portable_changes_add(changes
, n_changes
, PORTABLE_MKDIR
, where
, NULL
);
853 path
= prefix_roota(where
, m
->name
);
854 dropin_dir
= strjoin(path
, ".d");
858 if (mkdir(dropin_dir
, 0755) < 0) {
862 (void) portable_changes_add(changes
, n_changes
, PORTABLE_MKDIR
, dropin_dir
, NULL
);
864 /* We install the drop-ins first, and the actual unit file last to achieve somewhat atomic behaviour if PID 1
865 * is reloaded while we are creating things here: as long as only the drop-ins exist the unit doesn't exist at
868 r
= install_chroot_dropin(image_path
, type
, m
, dropin_dir
, &chroot_dropin
, changes
, n_changes
);
872 r
= install_profile_dropin(image_path
, m
, dropin_dir
, profile
, flags
, &profile_dropin
, changes
, n_changes
);
876 if ((flags
& PORTABLE_PREFER_SYMLINK
) && m
->source
) {
878 if (symlink(m
->source
, path
) < 0)
879 return log_debug_errno(errno
, "Failed to symlink unit file '%s': %m", path
);
881 (void) portable_changes_add(changes
, n_changes
, PORTABLE_SYMLINK
, path
, m
->source
);
884 _cleanup_(unlink_and_freep
) char *tmp
= NULL
;
885 _cleanup_close_
int fd
= -1;
887 fd
= open_tmpfile_linkable(where
, O_WRONLY
|O_CLOEXEC
, &tmp
);
889 return log_debug_errno(fd
, "Failed to create unit file '%s': %m", path
);
891 r
= copy_bytes(m
->fd
, fd
, UINT64_MAX
, COPY_REFLINK
);
893 return log_debug_errno(r
, "Failed to copy unit file '%s': %m", path
);
895 if (fchmod(fd
, 0644) < 0)
896 return log_debug_errno(errno
, "Failed to change unit file access mode for '%s': %m", path
);
898 r
= link_tmpfile(fd
, tmp
, path
);
900 return log_debug_errno(r
, "Failed to install unit file '%s': %m", path
);
904 (void) portable_changes_add(changes
, n_changes
, PORTABLE_COPY
, path
, m
->source
);
907 /* All is established now, now let's disable any rollbacks */
908 chroot_dropin
= mfree(chroot_dropin
);
909 profile_dropin
= mfree(profile_dropin
);
910 dropin_dir
= mfree(dropin_dir
);
915 static int image_symlink(
916 const char *image_path
,
920 const char *fn
, *where
;
926 fn
= last_path_component(image_path
);
928 if (flags
& PORTABLE_RUNTIME
)
929 where
= "/run/portables/";
931 where
= "/etc/portables/";
933 joined
= strjoin(where
, fn
);
941 static int install_image_symlink(
942 const char *image_path
,
944 PortableChange
**changes
,
947 _cleanup_free_
char *sl
= NULL
;
952 /* If the image is outside of the image search also link it into it, so that it can be found with short image
953 * names and is listed among the images. */
955 if (image_in_search_path(IMAGE_PORTABLE
, image_path
))
958 r
= image_symlink(image_path
, flags
, &sl
);
960 return log_debug_errno(r
, "Failed to generate image symlink path: %m");
962 (void) mkdir_parents(sl
, 0755);
964 if (symlink(image_path
, sl
) < 0)
965 return log_debug_errno(errno
, "Failed to link %s %s %s: %m", image_path
, special_glyph(SPECIAL_GLYPH_ARROW
), sl
);
967 (void) portable_changes_add(changes
, n_changes
, PORTABLE_SYMLINK
, sl
, image_path
);
973 const char *name_or_path
,
977 PortableChange
**changes
,
979 sd_bus_error
*error
) {
981 _cleanup_hashmap_free_ Hashmap
*unit_files
= NULL
;
982 _cleanup_(lookup_paths_free
) LookupPaths paths
= {};
983 _cleanup_(image_unrefp
) Image
*image
= NULL
;
984 PortableMetadata
*item
;
988 assert(name_or_path
);
990 r
= image_find_harder(IMAGE_PORTABLE
, name_or_path
, &image
);
994 r
= portable_extract_by_path(image
->path
, matches
, NULL
, &unit_files
, error
);
998 r
= lookup_paths_init(&paths
, UNIT_FILE_SYSTEM
, LOOKUP_PATHS_SPLIT_USR
, NULL
);
1002 HASHMAP_FOREACH(item
, unit_files
, iterator
) {
1003 r
= unit_file_exists(UNIT_FILE_SYSTEM
, &paths
, item
->name
);
1005 return sd_bus_error_set_errnof(error
, r
, "Failed to determine whether unit '%s' exists on the host: %m", item
->name
);
1007 return sd_bus_error_setf(error
, BUS_ERROR_UNIT_EXISTS
, "Unit file '%s' exists on the host already, refusing.", item
->name
);
1009 r
= unit_file_is_active(bus
, item
->name
, error
);
1013 return sd_bus_error_setf(error
, BUS_ERROR_UNIT_EXISTS
, "Unit file '%s' is active already, refusing.", item
->name
);
1016 HASHMAP_FOREACH(item
, unit_files
, iterator
) {
1017 r
= attach_unit_file(&paths
, image
->path
, image
->type
, item
, profile
, flags
, changes
, n_changes
);
1022 /* We don't care too much for the image symlink, it's just a convenience thing, it's not necessary for proper
1023 * operation otherwise. */
1024 (void) install_image_symlink(image
->path
, flags
, changes
, n_changes
);
1029 static bool marker_matches_image(const char *marker
, const char *name_or_path
) {
1033 assert(name_or_path
);
1035 a
= last_path_component(marker
);
1037 if (image_name_is_valid(name_or_path
)) {
1040 /* We shall match against an image name. In that case let's compare the last component, and optionally
1041 * allow either a suffix of ".raw" or a series of "/". */
1043 e
= startswith(a
, name_or_path
);
1048 e
[strspn(e
, "/")] == 0 ||
1054 /* We shall match against a path. Let's ignore any prefix here though, as often there are many ways to
1055 * reach the same file. However, in this mode, let's validate any file suffix. */
1057 l
= strcspn(a
, "/");
1058 b
= last_path_component(name_or_path
);
1060 if (strcspn(b
, "/") != l
)
1063 return memcmp(a
, b
, l
) == 0;
1067 static int test_chroot_dropin(
1071 const char *name_or_path
,
1072 char **ret_marker
) {
1074 _cleanup_free_
char *line
= NULL
, *marker
= NULL
;
1075 _cleanup_fclose_
FILE *f
= NULL
;
1076 _cleanup_close_
int fd
= -1;
1077 const char *p
, *e
, *k
;
1084 /* We recognize unis created from portable images via the drop-in we created for them */
1086 p
= strjoina(fname
, ".d/20-portable.conf");
1087 fd
= openat(dirfd(d
), p
, O_RDONLY
|O_CLOEXEC
);
1089 if (errno
== ENOENT
)
1092 return log_debug_errno(errno
, "Failed to open %s/%s: %m", where
, p
);
1095 r
= fdopen_unlocked(fd
, "r", &f
);
1097 return log_debug_errno(r
, "Failed to convert file handle: %m");
1100 r
= read_line(f
, LONG_LINE_MAX
, &line
);
1102 return log_debug_errno(r
, "Failed to read from %s/%s: %m", where
, p
);
1104 e
= startswith(line
, PORTABLE_DROPIN_MARKER_BEGIN
);
1108 k
= endswith(e
, PORTABLE_DROPIN_MARKER_END
);
1112 marker
= strndup(e
, k
- e
);
1119 r
= marker_matches_image(marker
, name_or_path
);
1122 *ret_marker
= TAKE_PTR(marker
);
1127 int portable_detach(
1129 const char *name_or_path
,
1130 PortableFlags flags
,
1131 PortableChange
**changes
,
1133 sd_bus_error
*error
) {
1135 _cleanup_(lookup_paths_free
) LookupPaths paths
= {};
1136 _cleanup_set_free_free_ Set
*unit_files
= NULL
, *markers
= NULL
;
1137 _cleanup_closedir_
DIR *d
= NULL
;
1138 const char *where
, *item
;
1144 assert(name_or_path
);
1146 r
= lookup_paths_init(&paths
, UNIT_FILE_SYSTEM
, LOOKUP_PATHS_SPLIT_USR
, NULL
);
1150 where
= attached_path(&paths
, flags
);
1154 if (errno
== ENOENT
)
1157 return log_debug_errno(errno
, "Failed to open '%s' directory: %m", where
);
1160 unit_files
= set_new(&string_hash_ops
);
1164 markers
= set_new(&path_hash_ops
);
1168 FOREACH_DIRENT(de
, d
, return log_debug_errno(errno
, "Failed to enumerate '%s' directory: %m", where
)) {
1169 _cleanup_free_
char *marker
= NULL
;
1170 UnitFileState state
;
1172 if (!unit_name_is_valid(de
->d_name
, UNIT_NAME_ANY
))
1175 /* Filter out duplicates */
1176 if (set_get(unit_files
, de
->d_name
))
1179 dirent_ensure_type(d
, de
);
1180 if (!IN_SET(de
->d_type
, DT_LNK
, DT_REG
))
1183 r
= test_chroot_dropin(d
, where
, de
->d_name
, name_or_path
, &marker
);
1189 r
= unit_file_lookup_state(UNIT_FILE_SYSTEM
, &paths
, de
->d_name
, &state
);
1191 return log_debug_errno(r
, "Failed to determine unit file state of '%s': %m", de
->d_name
);
1192 if (!IN_SET(state
, UNIT_FILE_STATIC
, UNIT_FILE_DISABLED
, UNIT_FILE_LINKED
, UNIT_FILE_RUNTIME
, UNIT_FILE_LINKED_RUNTIME
))
1193 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
));
1195 r
= unit_file_is_active(bus
, de
->d_name
, error
);
1199 return sd_bus_error_setf(error
, BUS_ERROR_UNIT_EXISTS
, "Unit file '%s' is active, can't detach.", de
->d_name
);
1201 r
= set_put_strdup(unit_files
, de
->d_name
);
1203 return log_debug_errno(r
, "Failed to add unit name '%s' to set: %m", de
->d_name
);
1205 if (path_is_absolute(marker
) &&
1206 !image_in_search_path(IMAGE_PORTABLE
, marker
)) {
1208 r
= set_ensure_allocated(&markers
, &path_hash_ops
);
1212 r
= set_put(markers
, marker
);
1215 else if (r
!= -EEXIST
)
1220 if (set_isempty(unit_files
))
1223 SET_FOREACH(item
, unit_files
, iterator
) {
1224 _cleanup_free_
char *md
= NULL
;
1227 if (unlinkat(dirfd(d
), item
, 0) < 0) {
1228 log_debug_errno(errno
, "Can't remove unit file %s/%s: %m", where
, item
);
1230 if (errno
!= ENOENT
&& ret
>= 0)
1233 portable_changes_add_with_prefix(changes
, n_changes
, PORTABLE_UNLINK
, where
, item
, NULL
);
1235 FOREACH_STRING(suffix
, ".d/10-profile.conf", ".d/20-portable.conf") {
1236 _cleanup_free_
char *dropin
= NULL
;
1238 dropin
= strjoin(item
, suffix
);
1242 if (unlinkat(dirfd(d
), dropin
, 0) < 0) {
1243 log_debug_errno(errno
, "Can't remove drop-in %s/%s: %m", where
, dropin
);
1245 if (errno
!= ENOENT
&& ret
>= 0)
1248 portable_changes_add_with_prefix(changes
, n_changes
, PORTABLE_UNLINK
, where
, dropin
, NULL
);
1251 md
= strjoin(item
, ".d");
1255 if (unlinkat(dirfd(d
), md
, AT_REMOVEDIR
) < 0) {
1256 log_debug_errno(errno
, "Can't remove drop-in directory %s/%s: %m", where
, md
);
1258 if (errno
!= ENOENT
&& ret
>= 0)
1261 portable_changes_add_with_prefix(changes
, n_changes
, PORTABLE_UNLINK
, where
, md
, NULL
);
1264 /* Now, also drop any image symlink, for images outside of the sarch path */
1265 SET_FOREACH(item
, markers
, iterator
) {
1266 _cleanup_free_
char *sl
= NULL
;
1269 r
= image_symlink(item
, flags
, &sl
);
1271 log_debug_errno(r
, "Failed to determine image symlink for '%s', ignoring: %m", item
);
1275 if (lstat(sl
, &st
) < 0) {
1276 log_debug_errno(errno
, "Failed to stat '%s', ignoring: %m", sl
);
1280 if (!S_ISLNK(st
.st_mode
)) {
1281 log_debug("Image '%s' is not a symlink, ignoring.", sl
);
1285 if (unlink(sl
) < 0) {
1286 log_debug_errno(errno
, "Can't remove image symlink '%s': %m", sl
);
1288 if (errno
!= ENOENT
&& ret
>= 0)
1291 portable_changes_add(changes
, n_changes
, PORTABLE_UNLINK
, sl
, NULL
);
1294 /* Try to remove the unit file directory, if we can */
1295 if (rmdir(where
) >= 0)
1296 portable_changes_add(changes
, n_changes
, PORTABLE_UNLINK
, where
, NULL
);
1301 log_debug("No unit files associated with '%s' found. Image not attached?", name_or_path
);
1302 return sd_bus_error_setf(error
, BUS_ERROR_NO_SUCH_UNIT
, "No unit files associated with '%s' found. Image not attached?", name_or_path
);
1305 static int portable_get_state_internal(
1307 const char *name_or_path
,
1308 PortableFlags flags
,
1310 sd_bus_error
*error
) {
1312 _cleanup_(lookup_paths_free
) LookupPaths paths
= {};
1313 bool found_enabled
= false, found_running
= false;
1314 _cleanup_set_free_free_ Set
*unit_files
= NULL
;
1315 _cleanup_closedir_
DIR *d
= NULL
;
1320 assert(name_or_path
);
1323 r
= lookup_paths_init(&paths
, UNIT_FILE_SYSTEM
, LOOKUP_PATHS_SPLIT_USR
, NULL
);
1327 where
= attached_path(&paths
, flags
);
1331 if (errno
== ENOENT
) {
1332 /* If the 'attached' directory doesn't exist at all, then we know for sure this image isn't attached. */
1333 *ret
= PORTABLE_DETACHED
;
1337 return log_debug_errno(errno
, "Failed to open '%s' directory: %m", where
);
1340 unit_files
= set_new(&string_hash_ops
);
1344 FOREACH_DIRENT(de
, d
, return log_debug_errno(errno
, "Failed to enumerate '%s' directory: %m", where
)) {
1345 UnitFileState state
;
1347 if (!unit_name_is_valid(de
->d_name
, UNIT_NAME_ANY
))
1350 /* Filter out duplicates */
1351 if (set_get(unit_files
, de
->d_name
))
1354 dirent_ensure_type(d
, de
);
1355 if (!IN_SET(de
->d_type
, DT_LNK
, DT_REG
))
1358 r
= test_chroot_dropin(d
, where
, de
->d_name
, name_or_path
, NULL
);
1364 r
= unit_file_lookup_state(UNIT_FILE_SYSTEM
, &paths
, de
->d_name
, &state
);
1366 return log_debug_errno(r
, "Failed to determine unit file state of '%s': %m", de
->d_name
);
1367 if (!IN_SET(state
, UNIT_FILE_STATIC
, UNIT_FILE_DISABLED
, UNIT_FILE_LINKED
, UNIT_FILE_LINKED_RUNTIME
))
1368 found_enabled
= true;
1370 r
= unit_file_is_active(bus
, de
->d_name
, error
);
1374 found_running
= true;
1376 r
= set_put_strdup(unit_files
, de
->d_name
);
1378 return log_debug_errno(r
, "Failed to add unit name '%s' to set: %m", de
->d_name
);
1381 *ret
= found_running
? (!set_isempty(unit_files
) && (flags
& PORTABLE_RUNTIME
) ? PORTABLE_RUNNING_RUNTIME
: PORTABLE_RUNNING
) :
1382 found_enabled
? (flags
& PORTABLE_RUNTIME
? PORTABLE_ENABLED_RUNTIME
: PORTABLE_ENABLED
) :
1383 !set_isempty(unit_files
) ? (flags
& PORTABLE_RUNTIME
? PORTABLE_ATTACHED_RUNTIME
: PORTABLE_ATTACHED
) : PORTABLE_DETACHED
;
1388 int portable_get_state(
1390 const char *name_or_path
,
1391 PortableFlags flags
,
1393 sd_bus_error
*error
) {
1395 PortableState state
;
1398 assert(name_or_path
);
1401 /* We look for matching units twice: once in the regular directories, and once in the runtime directories — but
1402 * the latter only if we didn't find anything in the former. */
1404 r
= portable_get_state_internal(bus
, name_or_path
, flags
& ~PORTABLE_RUNTIME
, &state
, error
);
1408 if (state
== PORTABLE_DETACHED
) {
1409 r
= portable_get_state_internal(bus
, name_or_path
, flags
| PORTABLE_RUNTIME
, &state
, error
);
1418 int portable_get_profiles(char ***ret
) {
1421 return conf_files_list_nulstr(ret
, NULL
, NULL
, CONF_FILES_DIRECTORY
|CONF_FILES_BASENAME
|CONF_FILES_FILTER_MASKED
, profile_dirs
);
1424 static const char* const portable_change_type_table
[_PORTABLE_CHANGE_TYPE_MAX
] = {
1425 [PORTABLE_COPY
] = "copy",
1426 [PORTABLE_MKDIR
] = "mkdir",
1427 [PORTABLE_SYMLINK
] = "symlink",
1428 [PORTABLE_UNLINK
] = "unlink",
1429 [PORTABLE_WRITE
] = "write",
1432 DEFINE_STRING_TABLE_LOOKUP(portable_change_type
, PortableChangeType
);
1434 static const char* const portable_state_table
[_PORTABLE_STATE_MAX
] = {
1435 [PORTABLE_DETACHED
] = "detached",
1436 [PORTABLE_ATTACHED
] = "attached",
1437 [PORTABLE_ATTACHED_RUNTIME
] = "attached-runtime",
1438 [PORTABLE_ENABLED
] = "enabled",
1439 [PORTABLE_ENABLED_RUNTIME
] = "enabled-runtime",
1440 [PORTABLE_RUNNING
] = "running",
1441 [PORTABLE_RUNNING_RUNTIME
] = "running-runtime",
1444 DEFINE_STRING_TABLE_LOOKUP(portable_state
, PortableState
);