xref: /freebsd/share/man/man9/VFS_QUOTACTL.9 (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 1996 Doug Rabson
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\" $FreeBSD$
30.\"
31.Dd May 29, 2021
32.Dt VFS_QUOTACTL 9
33.Os
34.Sh NAME
35.Nm VFS_QUOTACTL
36.Nd manipulate file system quotas
37.Sh SYNOPSIS
38.In sys/param.h
39.In sys/mount.h
40.In sys/vnode.h
41.Ft int
42.Fn VFS_QUOTACTL "struct mount *mp" "int cmds" "uid_t uid" "void *arg" "bool *mp_busy"
43.Sh DESCRIPTION
44Implement file system quotas.
45.Pp
46The
47.Fa mp_busy
48argument is an input/output parameter.
49.Fn VFS_QUOTACTL
50must be called with
51.Fa mp
52marked busy through
53.Xr vfs_busy 9
54and
55.Fa *mp_busy
56set to true.
57The filesystem implementation of
58.Fn VFS_QUOTACTL
59may then unbusy
60.Fa mp
61using
62.Xr vfs_unbusy 9
63prior to performing quota file I/O.
64In this case the implementation must set
65.Fa *mp_busy
66to false to indicate that the caller must not unbusy
67.Fa mp
68upon completion of
69.Fn VFS_QUOTACTL .
70.Pp
71See
72.Xr quotactl 2
73for a description of the remaining arguments.
74.Sh SEE ALSO
75.Xr quotactl 2 ,
76.Xr vnode 9
77.Sh AUTHORS
78This manual page was written by
79.An Doug Rabson .
80