xref: /freebsd-13-stable/share/man/man9/VOP_ALLOCATE.9 (revision b144e70a3325e033163aa4e6e15d0446e245702d)
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.Dd October 3, 2013
29.Dt VOP_ALLOCATE 9
30.Os
31.Sh NAME
32.Nm VOP_ALLOCATE
33.Nd allocate storage for a file
34.Sh SYNOPSIS
35.In sys/param.h
36.In sys/vnode.h
37.Ft int
38.Fn VOP_ALLOCATE "struct vnode *vp" "off_t *offset" "off_t *len"
39.Sh DESCRIPTION
40This call allocates storage for a range of offsets in a file.
41It is used to implement the
42.Xr posix_fallocate
43system call.
44.Pp
45Its arguments are:
46.Bl -tag -width offset
47.It Fa vp
48The vnode of the file.
49.It Fa offset
50The start of the range to allocate storage for in the file.
51.It Fa len
52The length of the range to allocate storage for in the file.
53.El
54.Pp
55The
56.Fa offset
57and
58.Fa len
59arguments are updated to reflect the portion of the range that
60still needs to be allocated on return.
61A partial allocation is considered a successful operation.
62The file's contents are not changed.
63.Sh LOCKS
64The file should be exclusively locked on entry and will still be locked on exit.
65.Sh RETURN VALUES
66Zero is returned if the call is successful, otherwise an appropriate
67error code is returned.
68.Sh ERRORS
69.Bl -tag -width Er
70.It Bq Er EFBIG
71An attempt was made to write a file that exceeds the process's file size
72limit or the maximum file size.
73.It Bq Er ENOSPC
74The file system is full.
75.It Bq Er EPERM
76An append-only flag is set on the file, but the caller is attempting to
77write before the current end of file.
78.El
79.Sh SEE ALSO
80.Xr vnode 9 ,
81.Xr VOP_READ 9 ,
82.Xr VOP_WRITE 9
83