Debian Codegraph @

src/shared/copy.h

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include "shared-forward.h"
5
6 typedef enum CopyFlags {
7 COPY_REFLINK = 1 << 0, /* Try to reflink */
8 COPY_MERGE = 1 << 1, /* Merge existing trees with our new one to copy */
9 COPY_REPLACE = 1 << 2, /* Replace an existing file if there's one */
10 COPY_SAME_MOUNT = 1 << 3, /* Don't descend recursively into other file systems, across mount point boundaries */
11 COPY_MERGE_EMPTY = 1 << 4, /* Merge an existing, empty directory with our new tree to copy */
12 COPY_CRTIME = 1 << 5, /* Generate a user.crtime_usec xattr off the source crtime if there is one, on copying */
13 COPY_SIGINT = 1 << 6, /* Check for SIGINT regularly and return EINTR if seen (caller needs to block SIGINT) */
14 COPY_SIGTERM = 1 << 7, /* ditto, but for SIGTERM */
15 COPY_MAC_CREATE = 1 << 8, /* Create files with the correct MAC label (currently SELinux only) */
16 COPY_HARDLINKS = 1 << 9, /* Try to reproduce hard links */
17 COPY_FSYNC = 1 << 10, /* fsync() after we are done */
18 COPY_FSYNC_FULL = 1 << 11, /* fsync_full() after we are done */
19 COPY_SYNCFS = 1 << 12, /* syncfs() the *top-level* dir after we are done */
20 COPY_ALL_XATTRS = 1 << 13, /* Preserve all xattrs when copying, not just those in the user namespace */
21 COPY_HOLES = 1 << 14, /* Copy holes */
22 COPY_GRACEFUL_WARN = 1 << 15, /* Skip copying file types that aren't supported by the target filesystem */
23 COPY_TRUNCATE = 1 << 16, /* Truncate to current file offset after copying */
24 COPY_LOCK_BSD = 1 << 17, /* Return a BSD exclusively locked file descriptor referring to the copied image/directory. */
25 COPY_VERIFY_LINKED = 1 << 18, /* Check the source file is still linked after copying. */
26 COPY_RESTORE_DIRECTORY_TIMESTAMPS = 1 << 19, /* Make sure existing directory timestamps don't change during copying. */
27 /* A root image might be subject to lots of random writes so we provide a flag to try to disable COW
28 * on a copied file which tends to not perform well in combination with lots of random writes.
29 *
30 * Note: btrfs actually isn't impressed by us setting the flag after making the copy, but this at
31 * least makes the intention clear. We don't want to unconditionally set the flag before doing the
32 * copy because reflinking from COW to NOCOW files is not supported.
33 */
34 COPY_NOCOW_AFTER = 1 << 20,
35 COPY_PRESERVE_FS_VERITY = 1 << 21, /* Preserve fs-verity when copying. */
36 COPY_MERGE_APPLY_STAT = 1 << 22, /* When we reuse an existing directory inode, apply source ownership/mode/xattrs/timestamps */
37 COPY_SEEK0_SOURCE = 1 << 23, /* Seek back to start of source file before copying */
38 COPY_SEEK0_TARGET = 1 << 24, /* Seek back to start of target file before copying */
39 } CopyFlags;
40
41 typedef enum DenyType {
42 DENY_DONT = 0, /* we want INT_TO_PTR(DENY_DONT) to map to NULL */
43 DENY_INODE,
44 DENY_CONTENTS,
45 _DENY_TYPE_MAX,
46 _DENY_TYPE_INVALID = -EINVAL,
47 } DenyType;
48
49 typedef int (*copy_progress_bytes_t)(uint64_t n_bytes, uint64_t bytes_per_second, void *userdata);
50 typedef int (*copy_progress_path_t)(const char *path, const struct stat *st, void *userdata);
51
52 int copy_file_fd_at_full(int dir_fdf, const char *from, int fdt, CopyFlags copy_flags, copy_progress_bytes_t progress, void *userdata);
53 static inline int copy_file_fd_at(int dir_fdf, const char *from, int fdt, CopyFlags copy_flags, copy_progress_bytes_t progress, void *userdata) {
54 return copy_file_fd_at_full(dir_fdf, from, fdt, copy_flags, progress, userdata);
55 }
56 static inline int copy_file_fd_full(const char *from, int fdt, CopyFlags copy_flags) {
57 return copy_file_fd_at_full(AT_FDCWD, from, fdt, copy_flags, NULL, NULL);
58 }
59 static inline int copy_file_fd(const char *from, int fdt, CopyFlags copy_flags) {
60 return copy_file_fd_at(AT_FDCWD, from, fdt, copy_flags, NULL, NULL);
61 }
62
63 int copy_file_at_full(int dir_fdf, const char *from, int dir_fdt, const char *to, int open_flags, mode_t mode, unsigned chattr_flags, unsigned chattr_mask, CopyFlags copy_flags, copy_progress_bytes_t progress, void *userdata);
64 static inline int copy_file_at(int dir_fdf, const char *from, int dir_fdt, const char *to, int open_flags, mode_t mode, CopyFlags copy_flags) {
65 return copy_file_at_full(dir_fdf, from, dir_fdt, to, open_flags, mode, 0, 0, copy_flags, NULL, NULL);
66 }
67 static inline int copy_file_full(const char *from, const char *to, int open_flags, mode_t mode, unsigned chattr_flags, unsigned chattr_mask, CopyFlags copy_flags, copy_progress_bytes_t progress, void *userdata) {
68 return copy_file_at_full(AT_FDCWD, from, AT_FDCWD, to, open_flags, mode, chattr_flags, chattr_mask, copy_flags, progress, userdata);
69 }
70 static inline int copy_file(const char *from, const char *to, int open_flags, mode_t mode, CopyFlags copy_flags) {
71 return copy_file_at(AT_FDCWD, from, AT_FDCWD, to, open_flags, mode, copy_flags);
72 }
73
74 int copy_file_atomic_at_full(int dir_fdf, const char *from, int dir_fdt, const char *to, mode_t mode, unsigned chattr_flags, unsigned chattr_mask, CopyFlags copy_flags, copy_progress_bytes_t progress, void *userdata);
75 static inline int copy_file_atomic_at(int dir_fdf, const char *from, int dir_fdt, const char *to, mode_t mode, CopyFlags copy_flags) {
76 return copy_file_atomic_at_full(dir_fdf, from, dir_fdt, to, mode, 0, 0, copy_flags, NULL, NULL);
77 }
78 static inline int copy_file_atomic_full(const char *from, const char *to, mode_t mode, unsigned chattr_flags, unsigned chattr_mask, CopyFlags copy_flags, copy_progress_bytes_t progress, void *userdata) {
79 return copy_file_atomic_at_full(AT_FDCWD, from, AT_FDCWD, to, mode, chattr_flags, chattr_mask, copy_flags, progress, userdata);
80 }
81 static inline int copy_file_atomic(const char *from, const char *to, mode_t mode, CopyFlags copy_flags) {
82 return copy_file_atomic_full(from, to, mode, 0, 0, copy_flags, NULL, NULL);
83 }
84
85 int copy_tree_at_full(int fdf, const char *from, int fdt, const char *to, uid_t override_uid, gid_t override_gid, CopyFlags copy_flags, Hashmap *denylist, Hashmap *subvolumes, copy_progress_path_t progress_path, copy_progress_bytes_t progress_bytes, void *userdata);
86 static inline int copy_tree_at(int fdf, const char *from, int fdt, const char *to, uid_t override_uid, gid_t override_gid, CopyFlags copy_flags, Hashmap *denylist, Hashmap *subvolumes) {
87 return copy_tree_at_full(fdf, from, fdt, to, override_uid, override_gid, copy_flags, denylist, subvolumes, NULL, NULL, NULL);
88 }
89 static inline int copy_tree(const char *from, const char *to, uid_t override_uid, gid_t override_gid, CopyFlags copy_flags, Hashmap *denylist, Hashmap *subvolumes) {
90 return copy_tree_at_full(AT_FDCWD, from, AT_FDCWD, to, override_uid, override_gid, copy_flags, denylist, subvolumes, NULL, NULL, NULL);
91 }
92
93 int copy_directory_at_full(int dir_fdf, const char *from, int dir_fdt, const char *to, uid_t override_uid, gid_t override_gid, CopyFlags copy_flags, copy_progress_path_t progress_path, copy_progress_bytes_t progress_bytes, void *userdata);
94 static inline int copy_directory_at(int dir_fdf, const char *from, int dir_fdt, const char *to, uid_t override_uid, gid_t override_gid, CopyFlags copy_flags) {
95 return copy_directory_at_full(dir_fdf, from, dir_fdt, to, override_uid, override_gid, copy_flags, NULL, NULL, NULL);
96 }
97
98 int copy_bytes_full(int fdf, int fdt, uint64_t max_bytes, CopyFlags copy_flags, void **ret_remains, size_t *ret_remains_size, copy_progress_bytes_t progress, void *userdata);
99 static inline int copy_bytes(int fdf, int fdt, uint64_t max_bytes, CopyFlags copy_flags) {
100 return copy_bytes_full(fdf, fdt, max_bytes, copy_flags, NULL, NULL, NULL, NULL);
101 }
102
103 int copy_times(int fdf, int fdt, CopyFlags flags);
104 int copy_access(int fdf, int fdt);
105 int copy_owner(int fdf, int fdt);
106 int copy_rights_with_fallback(int fdf, int fdt, const char *patht);
107 static inline int copy_rights(int fdf, int fdt) {
108 return copy_rights_with_fallback(fdf, fdt, NULL); /* no fallback */
109 }
110 int copy_xattr(int df, const char *from, int dt, const char *to, CopyFlags copy_flags);
111
112 int reflink(int infd, int outfd);
113 int reflink_range(int infd, uint64_t in_offset, int outfd, uint64_t out_offset, uint64_t sz);