1 .\" SPDX-License-Identifier: BSD-2-Clause
3 .\" Copyright (c) 2019 Rick Macklem
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .Dt VOP_COPY_FILE_RANGE 9
32 .Nm VOP_COPY_FILE_RANGE
33 .Nd copy a byte range from one regular file to another within a file system
38 .Fo VOP_COPY_FILE_RANGE
39 .Fa "struct vnode *invp"
41 .Fa "struct vnode *outvp"
44 .Fa "unsigned int flags"
45 .Fa "struct ucred *incred"
46 .Fa "struct ucred *outcred"
47 .Fa "struct thread *fsize_td"
49 This entry point copies a byte range from one regular file to another within a
53 .Bl -tag -width ioflag
55 The vnode of the input file.
57 A pointer to the file offset for the input file.
59 The vnode of the output file.
61 A pointer to the file offset for the output file.
63 A pointer to the number of bytes to be copied.
65 Flags, should be set to 0 for now.
67 The credentials used to read
70 The credentials used to write
73 The thread pointer to be passed to vn_rlimit_fsize().
76 for a server thread without limits, such as for the NFS
82 On entry and on return, the
86 arguments point to the locations of the file offsets.
87 These file offsets should be updated by the number of bytes copied.
90 argument points to the location that stores the number of bytes
92 It should be reduced by the number of bytes copied, which implies that
93 the value pointed to by
95 will normally be zero for a non-error return.
96 However, a copy of fewer bytes than requested is permitted.
98 The vnode are unlocked on entry and must be unlocked on return.
99 The byte ranges for both
103 should be range locked when this call is done.
105 Zero is returned on success, otherwise an error code is returned.
109 If the copy exceeds the process's file size limit or the maximum file size
116 A signal interrupted the VOP call before it could be completed.
118 An I/O error occurred while reading/writing the files.
120 The file system is full.