xref: /freebsd/share/man/man9/VFS_QUOTACTL.9 (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
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.Dd May 29, 2021
30.Dt VFS_QUOTACTL 9
31.Os
32.Sh NAME
33.Nm VFS_QUOTACTL
34.Nd manipulate file system quotas
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/mount.h
38.In sys/vnode.h
39.Ft int
40.Fn VFS_QUOTACTL "struct mount *mp" "int cmds" "uid_t uid" "void *arg" "bool *mp_busy"
41.Sh DESCRIPTION
42Implement file system quotas.
43.Pp
44The
45.Fa mp_busy
46argument is an input/output parameter.
47.Fn VFS_QUOTACTL
48must be called with
49.Fa mp
50marked busy through
51.Xr vfs_busy 9
52and
53.Fa *mp_busy
54set to true.
55The filesystem implementation of
56.Fn VFS_QUOTACTL
57may then unbusy
58.Fa mp
59using
60.Xr vfs_unbusy 9
61prior to performing quota file I/O.
62In this case the implementation must set
63.Fa *mp_busy
64to false to indicate that the caller must not unbusy
65.Fa mp
66upon completion of
67.Fn VFS_QUOTACTL .
68.Pp
69See
70.Xr quotactl 2
71for a description of the remaining arguments.
72.Sh SEE ALSO
73.Xr quotactl 2 ,
74.Xr vnode 9
75.Sh AUTHORS
76This manual page was written by
77.An Doug Rabson .
78