mirror of
https://git.FreeBSD.org/src.git
synced 2025-01-13 14:40:22 +00:00
Create a man page for VOP_COPY_FILE_RANGE(9).
r350315 created a Linux compatible copy_file_range(2) syscall. It uses a VOP method called VOP_COPY_FILE_RANGE so that file systems, such as the NFSv4.2 client can do file system specific copying. For NFSv4.2, this allows the copying to be done locally on the NFS server, avoiding transferring the data across the wire twice. This is a new man page (content changed). Reviewed by: kib, asomers Relnotes: yes Differential Revision: https://reviews.freebsd.org/D20584
This commit is contained in:
Rick Macklem
parent
6639e9bc31
commit
4b5b98d22d
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=350319
@ -397,6 +397,7 @@ MAN= accept_filter.9 \
|
||||
VOP_ATTRIB.9 \
|
||||
VOP_BMAP.9 \
|
||||
VOP_BWRITE.9 \
|
||||
VOP_COPY_FILE_RANGE.9 \
|
||||
VOP_CREATE.9 \
|
||||
VOP_FSYNC.9 \
|
||||
VOP_GETACL.9 \
|
||||
|
||||
124
share/man/man9/VOP_COPY_FILE_RANGE.9
Normal file
124
share/man/man9/VOP_COPY_FILE_RANGE.9
Normal file
@ -0,0 +1,124 @@
|
||||
.\" SPDX-License-Identifier: BSD-2-Clause
|
||||
.\"
|
||||
.\" Copyright (c) 2019 Rick Macklem
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd July 24, 2019
|
||||
.Dt VOP_COPY_FILE_RANGE 9
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm VOP_COPY_FILE_RANGE
|
||||
.Nd copy a byte range from one regular file to another within a file system
|
||||
.Sh SYNOPSIS
|
||||
.In sys/param.h
|
||||
.In sys/vnode.h
|
||||
.Ft int
|
||||
.Fo VOP_COPY_FILE_RANGE
|
||||
.Fa "struct vnode *invp"
|
||||
.Fa "off_t *inoff"
|
||||
.Fa "struct vnode *outvp"
|
||||
.Fa "off_t *outoff"
|
||||
.Fa "size_t *len"
|
||||
.Fa "unsigned int flags"
|
||||
.Fa "struct ucred *incred"
|
||||
.Fa "struct ucred *outcred"
|
||||
.Fa "struct thread *fsize_td"
|
||||
.Sh DESCRIPTION
|
||||
This entry point copies a byte range from one regular file to another within a
|
||||
file system.
|
||||
.Pp
|
||||
The arguments are:
|
||||
.Bl -tag -width ioflag
|
||||
.It Fa invp
|
||||
The vnode of the input file.
|
||||
.It Fa inoff
|
||||
A pointer to the file offset for the input file.
|
||||
.It Fa outvp
|
||||
The vnode of the output file.
|
||||
.It Fa outoff
|
||||
A pointer to the file offset for the output file.
|
||||
.It Fa len
|
||||
A pointer to the number of bytes to be copied.
|
||||
.It Fa flags
|
||||
Flags, should be set to 0 for now.
|
||||
.It Fa incred
|
||||
The credentials used to read
|
||||
.Fa invp .
|
||||
.It Fa outcred
|
||||
The credentials used to write
|
||||
.Fa outvp .
|
||||
.It Fa fsize_td
|
||||
The thread pointer to be passed to vn_rlimit_fsize().
|
||||
This will be
|
||||
.Dv NULL
|
||||
for a server thread without limits, such as for the NFS
|
||||
server or
|
||||
.Dv curthread
|
||||
otherwise.
|
||||
.El
|
||||
.Pp
|
||||
On entry and on return, the
|
||||
.Fa inoff
|
||||
and
|
||||
.Fa outoff
|
||||
arguments point to the locations of the file offsets.
|
||||
These file offsets should be updated by the number of bytes copied.
|
||||
The
|
||||
.Fa len
|
||||
argument points to the location that stores the number of bytes
|
||||
to be copied.
|
||||
It should be reduced by the number of bytes copied, which implies that
|
||||
the value pointed to by
|
||||
.Fa len
|
||||
will normally be zero for a non-error return.
|
||||
However, a copy of less bytes than requested is permitted.
|
||||
.Sh LOCKS
|
||||
The vnode are unlocked on entry and must be unlocked on return.
|
||||
The byte ranges for both
|
||||
.Fa invp
|
||||
and
|
||||
.Fa outvp
|
||||
should be range locked when this call is done.
|
||||
.Sh RETURN VALUES
|
||||
Zero is returned on success, otherwise an error code is returned.
|
||||
.Sh ERRORS
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er EFBIG
|
||||
If the copy exceeds the process's file size limit or the maximum file size
|
||||
for the file system
|
||||
.Fa invp
|
||||
and
|
||||
.Fa outvp
|
||||
reside on.
|
||||
.It Bq Er EINTR
|
||||
A signal interrupted the VOP call before it could be completed.
|
||||
.It Bq Er EIO
|
||||
An I/O error occurred while reading/writing the files.
|
||||
.It Bq Er ENOSPC
|
||||
The file system is full.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr vn_rdwr 9 ,
|
||||
.Xr vnode 9
|
||||
Loading…
Reference in New Issue
Block a user