xref: /freebsd/share/man/man9/VOP_ALLOCATE.9 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 2013 Hudson River Trading LLC
4.\" Written by: John H. Baldwin <jhb@FreeBSD.org>
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\" $FreeBSD$
29.\"
30.Dd October 3, 2013
31.Dt VOP_ALLOCATE 9
32.Os
33.Sh NAME
34.Nm VOP_ALLOCATE
35.Nd allocate storage for a file
36.Sh SYNOPSIS
37.In sys/param.h
38.In sys/vnode.h
39.Ft int
40.Fn VOP_ALLOCATE "struct vnode *vp" "off_t *offset" "off_t *len"
41.Sh DESCRIPTION
42This call allocates storage for a range of offsets in a file.
43It is used to implement the
44.Xr posix_fallocate
45system call.
46.Pp
47Its arguments are:
48.Bl -tag -width offset
49.It Fa vp
50The vnode of the file.
51.It Fa offset
52The start of the range to allocate storage for in the file.
53.It Fa len
54The length of the range to allocate storage for in the file.
55.El
56.Pp
57The
58.Fa offset
59and
60.Fa len
61arguments are updated to reflect the portion of the range that
62still needs to be allocated on return.
63A partial allocation is considered a successful operation.
64The file's contents are not changed.
65.Sh LOCKS
66The file should be exclusively locked on entry and will still be locked on exit.
67.Sh RETURN VALUES
68Zero is returned if the call is successful, otherwise an appropriate
69error code is returned.
70.Sh ERRORS
71.Bl -tag -width Er
72.It Bq Er EFBIG
73An attempt was made to write a file that exceeds the process's file size
74limit or the maximum file size.
75.It Bq Er ENOSPC
76The file system is full.
77.It Bq Er EPERM
78An append-only flag is set on the file, but the caller is attempting to
79write before the current end of file.
80.El
81.Sh SEE ALSO
82.Xr vnode 9 ,
83.Xr VOP_READ 9 ,
84.Xr VOP_WRITE 9
85