4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or https://opensource.org/licenses/CDDL-1.0.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
22 * Copyright (c) 2023, Klara Inc.
26 #include <linux/compat.h>
30 #include <sys/zfs_znode.h>
31 #include <sys/zfs_vnops.h>
32 #include <sys/zfeature.h>
35 * Clone part of a file via block cloning.
37 * Note that we are not required to update file offsets; the kernel will take
38 * care of that depending on how it was called.
41 zpl_clone_file_range_impl(struct file
*src_file
, loff_t src_off
,
42 struct file
*dst_file
, loff_t dst_off
, size_t len
)
44 struct inode
*src_i
= file_inode(src_file
);
45 struct inode
*dst_i
= file_inode(dst_file
);
46 uint64_t src_off_o
= (uint64_t)src_off
;
47 uint64_t dst_off_o
= (uint64_t)dst_off
;
48 uint64_t len_o
= (uint64_t)len
;
50 fstrans_cookie_t cookie
;
53 if (!zfs_bclone_enabled
)
56 if (!spa_feature_is_enabled(
57 dmu_objset_spa(ITOZSB(dst_i
)->z_os
), SPA_FEATURE_BLOCK_CLONING
))
61 spl_inode_lock_shared(src_i
);
62 spl_inode_lock(dst_i
);
65 cookie
= spl_fstrans_mark();
67 err
= -zfs_clone_range(ITOZ(src_i
), &src_off_o
, ITOZ(dst_i
),
68 &dst_off_o
, &len_o
, cr
);
70 spl_fstrans_unmark(cookie
);
73 spl_inode_unlock(dst_i
);
75 spl_inode_unlock_shared(src_i
);
80 return ((ssize_t
)len_o
);
83 #if defined(HAVE_VFS_COPY_FILE_RANGE) || \
84 defined(HAVE_VFS_FILE_OPERATIONS_EXTEND)
86 * Entry point for copy_file_range(). Copy len bytes from src_off in src_file
87 * to dst_off in dst_file. We are permitted to do this however we like, so we
88 * try to just clone the blocks, and if we can't support it, fall back to the
89 * kernel's generic byte copy function.
92 zpl_copy_file_range(struct file
*src_file
, loff_t src_off
,
93 struct file
*dst_file
, loff_t dst_off
, size_t len
, unsigned int flags
)
97 /* Flags is reserved for future extensions and must be zero. */
101 /* Try to do it via zfs_clone_range() and allow shortening. */
102 ret
= zpl_clone_file_range_impl(src_file
, src_off
,
103 dst_file
, dst_off
, len
);
105 #ifdef HAVE_VFS_GENERIC_COPY_FILE_RANGE
107 * Since Linux 5.3 the filesystem driver is responsible for executing
108 * an appropriate fallback, and a generic fallback function is provided.
110 if (ret
== -EOPNOTSUPP
|| ret
== -EINVAL
|| ret
== -EXDEV
||
112 ret
= generic_copy_file_range(src_file
, src_off
, dst_file
,
113 dst_off
, len
, flags
);
116 * Before Linux 5.3 the filesystem has to return -EOPNOTSUPP to signal
117 * to the kernel that it should fallback to a content copy.
119 if (ret
== -EINVAL
|| ret
== -EXDEV
|| ret
== -EAGAIN
)
121 #endif /* HAVE_VFS_GENERIC_COPY_FILE_RANGE */
125 #endif /* HAVE_VFS_COPY_FILE_RANGE || HAVE_VFS_FILE_OPERATIONS_EXTEND */
127 #ifdef HAVE_VFS_REMAP_FILE_RANGE
129 * Entry point for FICLONE/FICLONERANGE/FIDEDUPERANGE.
131 * FICLONE and FICLONERANGE are basically the same as copy_file_range(), except
132 * that they must clone - they cannot fall back to copying. FICLONE is exactly
133 * FICLONERANGE, for the entire file. We don't need to try to tell them apart;
134 * the kernel will sort that out for us.
136 * FIDEDUPERANGE is for turning a non-clone into a clone, that is, compare the
137 * range in both files and if they're the same, arrange for them to be backed
138 * by the same storage.
140 * REMAP_FILE_CAN_SHORTEN lets us know we can clone less than the given range
141 * if we want. It's designed for filesystems that may need to shorten the
142 * length for alignment, EOF, or any other requirement. ZFS may shorten the
143 * request when there is outstanding dirty data which hasn't been written.
146 zpl_remap_file_range(struct file
*src_file
, loff_t src_off
,
147 struct file
*dst_file
, loff_t dst_off
, loff_t len
, unsigned int flags
)
149 if (flags
& ~(REMAP_FILE_DEDUP
| REMAP_FILE_CAN_SHORTEN
))
152 /* No support for dedup yet */
153 if (flags
& REMAP_FILE_DEDUP
)
154 return (-EOPNOTSUPP
);
156 /* Zero length means to clone everything to the end of the file */
158 len
= i_size_read(file_inode(src_file
)) - src_off
;
160 ssize_t ret
= zpl_clone_file_range_impl(src_file
, src_off
,
161 dst_file
, dst_off
, len
);
163 if (!(flags
& REMAP_FILE_CAN_SHORTEN
) && ret
>= 0 && ret
!= len
)
168 #endif /* HAVE_VFS_REMAP_FILE_RANGE */
170 #if defined(HAVE_VFS_CLONE_FILE_RANGE) || \
171 defined(HAVE_VFS_FILE_OPERATIONS_EXTEND)
173 * Entry point for FICLONE and FICLONERANGE, before Linux 4.20.
176 zpl_clone_file_range(struct file
*src_file
, loff_t src_off
,
177 struct file
*dst_file
, loff_t dst_off
, uint64_t len
)
179 /* Zero length means to clone everything to the end of the file */
181 len
= i_size_read(file_inode(src_file
)) - src_off
;
183 /* The entire length must be cloned or this is an error. */
184 ssize_t ret
= zpl_clone_file_range_impl(src_file
, src_off
,
185 dst_file
, dst_off
, len
);
187 if (ret
>= 0 && ret
!= len
)
192 #endif /* HAVE_VFS_CLONE_FILE_RANGE || HAVE_VFS_FILE_OPERATIONS_EXTEND */
194 #ifdef HAVE_VFS_DEDUPE_FILE_RANGE
196 * Entry point for FIDEDUPERANGE, before Linux 4.20.
199 zpl_dedupe_file_range(struct file
*src_file
, loff_t src_off
,
200 struct file
*dst_file
, loff_t dst_off
, uint64_t len
)
202 /* No support for dedup yet */
203 return (-EOPNOTSUPP
);
205 #endif /* HAVE_VFS_DEDUPE_FILE_RANGE */
207 /* Entry point for FICLONE, before Linux 4.5. */
209 zpl_ioctl_ficlone(struct file
*dst_file
, void *arg
)
211 unsigned long sfd
= (unsigned long)arg
;
213 struct file
*src_file
= fget(sfd
);
214 if (src_file
== NULL
)
217 if (dst_file
->f_op
!= src_file
->f_op
) {
222 size_t len
= i_size_read(file_inode(src_file
));
224 ssize_t ret
= zpl_clone_file_range_impl(src_file
, 0, dst_file
, 0, len
);
229 if (ret
== -EOPNOTSUPP
)
240 /* Entry point for FICLONERANGE, before Linux 4.5. */
242 zpl_ioctl_ficlonerange(struct file
*dst_file
, void __user
*arg
)
244 zfs_ioc_compat_file_clone_range_t fcr
;
246 if (copy_from_user(&fcr
, arg
, sizeof (fcr
)))
249 struct file
*src_file
= fget(fcr
.fcr_src_fd
);
250 if (src_file
== NULL
)
253 if (dst_file
->f_op
!= src_file
->f_op
) {
258 size_t len
= fcr
.fcr_src_length
;
260 len
= i_size_read(file_inode(src_file
)) - fcr
.fcr_src_offset
;
262 ssize_t ret
= zpl_clone_file_range_impl(src_file
, fcr
.fcr_src_offset
,
263 dst_file
, fcr
.fcr_dest_offset
, len
);
268 if (ret
== -EOPNOTSUPP
)
279 /* Entry point for FIDEDUPERANGE, before Linux 4.5. */
281 zpl_ioctl_fideduperange(struct file
*filp
, void *arg
)
285 /* No support for dedup yet */