1 .\" Copyright (c) 2016, Oracle. All rights reserved.
3 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
4 .\" This is free documentation; you can redistribute it and/or
5 .\" modify it under the terms of the GNU General Public License as
6 .\" published by the Free Software Foundation; either version 2 of
7 .\" the License, or (at your option) any later version.
9 .\" The GNU General Public License's references to "object code"
10 .\" and "executables" are to be interpreted as the output of any
11 .\" document formatting or typesetting system, including
12 .\" intermediate and printed output.
14 .\" This manual is distributed in the hope that it will be useful,
15 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
16 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 .\" GNU General Public License for more details.
19 .\" You should have received a copy of the GNU General Public
20 .\" License along with this manual; if not, see
21 .\" <http://www.gnu.org/licenses/>.
23 .TH IOCTL-FIDEDUPERANGE 2 2017-09-15 "Linux" "Linux Programmer's Manual"
25 ioctl_fideduperange \- share some the data of one file with another file
28 .B #include <sys/ioctl.h>
30 .B #include <linux/fs.h>
32 .BI "int ioctl(int " src_fd ", FIDEDUPERANGE, struct file_dedupe_range *" arg );
34 If a filesystem supports files sharing physical storage between multiple
37 operation can be used to make some of the data in the
41 file by sharing the underlying storage if the file data is identical
43 Both files must reside within the same filesystem.
44 This reduces storage consumption by allowing the filesystem
45 to store one shared copy of the data.
46 If a file write should occur to a shared
47 region, the filesystem must ensure that the changes remain private to the file
49 This behavior is commonly referred to as "copy on write".
51 This ioctl performs the "compare and share if identical" operation on up to
53 bytes from file descriptor
57 This information is conveyed in a structure of the following form:
61 struct file_dedupe_range {
67 struct file_dedupe_range_info info[0];
72 Deduplication is atomic with regards to concurrent writes, so no locks need to
73 be taken to obtain a consistent deduplicated copy.
76 .IR reserved1 " and " reserved2
79 Destinations for the deduplication operation are conveyed in the array at the
81 The number of destinations is given in
83 and the destination information is conveyed in the following form:
87 struct file_dedupe_range_info {
97 Each deduplication operation targets
99 bytes in file descriptor
108 must be open for reading and
110 must be open for writing.
111 The combined size of the struct
112 .IR file_dedupe_range
114 .IR file_dedupe_range_info
115 array must not exceed the system page size.
118 is filesystem dependent and is typically 16\ MiB.
119 This limit will be enforced silently by the filesystem.
120 By convention, the storage used by
124 and the previous contents in
128 Upon successful completion of this ioctl, the number of bytes successfully
129 deduplicated is returned in
131 and a status code for the deduplication operation is returned in
133 If even a single byte in the range does not match, the deduplication
134 request will be ignored and
137 .BR FILE_DEDUPE_RANGE_DIFFERS .
141 .B FILE_DEDUPE_RANGE_SAME
142 for success, a negative error code in case of error, or
143 .B FILE_DEDUPE_RANGE_DIFFERS
144 if the data did not match.
147 On error, \-1 is returned, and
149 is set to indicate the error.
152 Error codes can be one of, but are not limited to, the following:
155 The kernel was unable to allocate sufficient memory to perform the
158 is so large that the input argument description spans more than a single
163 is not open for reading;
165 is not open for writing or is open for append-only writes; or the filesystem
168 resides on does not support deduplication.
171 The filesystem does not support deduplicating the ranges of the given files.
172 This error can also appear if either file descriptor represents
173 a device, FIFO, or socket.
174 Disk filesystems generally require the offset and length arguments
175 to be aligned to the fundamental block size.
176 Neither Btrfs nor XFS support
177 overlapping deduplication ranges in the same file.
180 One of the files is a directory and the filesystem does not support shared
181 regions in directories.
184 This can appear if the filesystem does not support deduplicating either file
185 descriptor, or if either file descriptor refers to special inodes.
192 One of the files is a swap file.
193 Swap files cannot share storage.
196 .IR dest_fd " and " src_fd
197 are not on the same mounted filesystem.
199 This ioctl operation first appeared in Linux 4.5.
200 It was previously known as
201 .B BTRFS_IOC_FILE_EXTENT_SAME
202 and was private to Btrfs.
204 This API is Linux-specific.
206 Because a copy-on-write operation requires the allocation of new storage, the
208 operation may unshare shared blocks to guarantee that subsequent writes will
209 not fail because of lack of disk space.
211 Some filesystems may limit the amount of data that can be deduplicated in a