ioctl_ficlonerange, ioctl_ficlone — share some the data of one file with another file
#include <sys/ioctl.h> #include <linux/fs.h>
int
ioctl( |
int dest_fd, |
| FICLONERANGE, | |
struct file_clone_range * arg); |
int
ioctl( |
int dest_fd, |
| FICLONE, | |
int src_fd); |
If a filesystem supports files sharing physical storage
between multiple files ("reflink"), this ioctl(2) operation can be
used to make some of the data in the src_fd file appear in the
dest_fd file by
sharing the underlying storage, which is faster than making a
separate physical copy of the data. Both files must reside
within the same filesystem. If a file write should occur to a
shared region, the filesystem must ensure that the changes
remain private to the file being written. This behavior is
commonly referred to as "copy on write".
This ioctl reflinks up to src_length bytes from file
descriptor src_fd at
offset src_offset
into the file dest_fd
at offset dest_offset, provided that
both are files. If src_length is zero, the ioctl
reflinks to the end of the source file. This information is
conveyed in a structure of the following form:
struct file_clone_range { __s64 src_fd;__u64 src_offset;__u64 src_length;__u64 dest_offset;};
Clones are atomic with regards to concurrent writes, so no locks need to be taken to obtain a consistent cloned copy.
The FICLONE ioctl
clones entire files.
Error codes can be one of, but are not limited to, the following:
dest_fd and
src_fd are not
on the same mounted filesystem.
One of the files is a directory and the filesystem does not support shared regions in directories.
The filesystem does not support reflinking the ranges of the given files. This error can also appear if either file descriptor represents a device, FIFO, or socket. Disk filesystems generally require the offset and length arguments to be aligned to the fundamental block size. XFS and Btrfs do not support overlapping reflink ranges in the same file.
src_fd is
not open for reading; dest_fd is not open for
writing or is open for append-only writes; or the
filesystem which src_fd resides on does
not support reflink.
dest_fd is
immutable.
One of the files is a swap file. Swap files cannot share storage.
This can appear if the filesystem does not support reflinking either file descriptor.
These ioctl operations first appeared in Linux 4.5. They
were previously known as BTRFS_IOC_CLONE and BTRFS_IOC_CLONE_RANGE, and were private to
Btrfs.
Because a copy-on-write operation requires the allocation of new storage, the fallocate(2) operation may unshare shared blocks to guarantee that subsequent writes will not fail because of lack of disk space.
This page is part of release 4.07 of the Linux man-pages project. A
description of the project, information about reporting bugs,
and the latest version of this page, can be found at
https://www.kernel.org/doc/man−pages/.
|
Copyright (c) 2016, Oracle. All rights reserved. %%%LICENSE_START(GPLv2+_DOC_FULL) This is free documentation; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. The GNU General Public License's references to "object code" and "executables" are to be interpreted as the output of any document formatting or typesetting system, including intermediate and printed output. This manual is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this manual; if not, see <http://www.gnu.org/licenses/>. %%%LICENSE_END |