1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
|
.TH QUOTACTL 2
.SH NAME
quotactl \- manipulate disk quotas
.SH SYNOPSIS
.nf
.B #include <linux/quota.h>
.B #include <xfs/xqm.h>
.B #include <linux/dqblk_v1.h>
.B #include <linux/dqblk_v2.h>
.LP
.B long quotactl(int cmd, char \(**special, qid_t id, caddr_t addr)
.fi
.SH DESCRIPTION
.LP
.IX "filesystem" "quotactl() disk quotas" "" "\fLquotactl()\fP \(em disk quotas"
.IX "quotactl() disk quotas" "" "\fLquotactl()\fP \(em disk quotas"
.IX "disk quotas quotactl()" "" "disk quotas \(em \fLquotactl()\fP"
.LP
The
.B quotactl(\|)
call manipulates disk quotas.
.I cmd
indicates a command to be applied to
.SM UID
.IR id
or
.SM GID
.IR id .
To set the type of quota use the
.IR "QCMD(cmd, type)"
macro.
.I special
is a pointer to a null-terminated string containing the path
name of the block special device for the filesystem being manipulated.
.I addr
is the address of an optional, command specific, data structure
which is copied in or out of the system. The interpretation of
.I addr
is given with each command below.
.TP 15
.SB Q_QUOTAON
Turn on quotas for a filesystem.
.I id
is the identification number of the quota format to be used. Format numbers
are defined in the header file of appropriate format. Currently there are
two supported quota formats whose numbers are defined by constants
.IR QFMT_VFS_OLD
(original quota format) and
.IR QFMT_VFS_V0
(new VFS v0 quota format).
.IR addr
points to the path name of file containing the quotas for the filesystem.
The quota file must exist; it is normally created with the
.BR quotacheck (8)
program. This call is restricted to the super-user.
.TP
.SB Q_QUOTAOFF
Turn off quotas for a filesystem.
.I addr
and
.I id
are ignored.
This call is restricted to the super-user.
.TP
.SB Q_GETQUOTA
Get disk quota limits and current usage for user or group
.IR id .
.I addr
is a pointer to an
.B if_dqblk
structure (defined in
.BR <linux/quota.h> ).
The field
.I dqb_valid
defines the entries in the structure which are set correctly. On
.B Q_GETQUOTA
call all entries are valid. Only the super-user may get the quotas
of a user other than himself.
.TP
.SB Q_SETQUOTA
Set current quota information for user or group
.IR id .
.I addr
is a pointer to an
.B if_dqblk
structure (defined in
.BR <linux/quota.h> ).
The field
.I dqb_valid
defines which entries in the quota structure are valid and should be set. The constants for
.I dqb_valid
field are defined in the
.B <linux/quota.h>
header file. This call obsoletes calls
.B Q_SETQLIM
and
.B Q_SETUSE
in the previous quota interfaces. This call is restricted to the super-user.
.TP
.SB Q_GETINFO
Get information (like grace times) about quotafile.
.I addr
should be a pointer to an
.B if_dqinfo
structure (defined in
.IR <linux/quota.h> ).
The
.I dqi_valid
field in the structure defines entries in it
which are valid. On
.B Q_GETINFO
call all entries are valid.
Parameter
.I id
is ignored.
.TP
.SB Q_SETINFO
Set information about quotafile.
.I addr
should be a pointer to
.B if_dqinfo
structure (defined in
.IR <linux/quota.h> ).
The field
.I dqi_valid
defines which entries in the quota info structure are valid and should be set. The constants for
.I dqi_valid
field are defined in the
.B <linux/quota.h>
header file. This call obsoletes calls
.B Q_SETGRACE
and
.B Q_SETFLAGS
in the previous quota interfaces. Parameter
.I id
is ignored. This operation is restricted to super-user.
.TP
.SB Q_GETFMT
Get quota format used on the specified filesystem.
.I addr
should be a pointer to a memory (4 bytes) where the format number will be stored.
.TP
.SB Q_SYNC
Update the on-disk copy of quota usages for a filesystem.
If
.I special
is null then all filesystems with active quotas are sync'ed.
.I addr
and
.I id
are ignored.
.TP
.SB Q_GETSTATS
Get statistics and other generic information about quota subsystem.
.I addr
should be a pointer to
.B dqstats
structure (defined in
.BR <linux/quota.h> )
in which data should be stored.
.I special
and
.I id
are ignored.
.TP
For XFS filesystems making use of the XFS Quota Manager (XQM), the above commands are bypassed and the following commands are used:
.TP 15
.SB Q_XQUOTAON
Turn on quotas for an XFS filesystem.
XFS provides the ability to turn on/off quota limit enforcement
with quota accounting.
Therefore, XFS expects the addr to be a pointer to an unsigned int
that contains either the flags XFS_QUOTA_UDQ_ACCT and/or
XFS_QUOTA_UDQ_ENFD (for user quota), or XFS_QUOTA_GDQ_ACCT and/or
XFS_QUOTA_GDQ_ENFD (for group quota), as defined in
.BR <xfs/xqm.h> .
This call is restricted to the superuser.
.TP
.SB Q_XQUOTAOFF
Turn off quotas for an XFS filesystem.
As in Q_QUOTAON, XFS filesystems expect a pointer to an unsigned int
that specifies whether quota accounting and/or limit enforcement need
to be turned off.
This call is restricted to the superuser.
.TP
.SB Q_XGETQUOTA
Get disk quota limits and current usage for user
.IR id .
.I addr
is a pointer to a
.B fs_disk_quota
structure (defined in
.BR <xfs/xqm.h> ).
Only the superuser may get the quotas of a user other than himself.
.TP
.SB Q_XSETQLIM
Set disk quota limits for user
.IR id .
.I addr
is a pointer to a
.B fs_disk_quota
structure (defined in
.BR <xfs/xqm.h> ).
This call is restricted to the superuser.
.TP
.SB Q_XGETQSTAT
Returns a
.B fs_quota_stat
structure containing XFS filesystem specific quota information.
This is useful in finding out how much space is spent to store quota
information, and also to get quotaon/off status of a given local XFS
filesystem.
.TP
.SB Q_XQUOTARM
Free the disk space taken by disk quotas.
Quotas must have already been turned off.
.PP
There is no command equivalent to
.B Q_SYNC
for XFS since
.IR sync (1)
writes quota information to disk (in addition to the other filesystem
metadata it writes out).
.SH RETURN VALUES
.LP
.B quotactl(\|)
returns:
.TP
0
on success.
.TP
\-1
on failure and sets
.B errno
to indicate the error.
.SH ERRORS
.TP 15
.SM EFAULT
.I addr
or
.I special
are invalid.
.TP
.SM ENOSYS
The kernel has not been compiled with the
.SB QUOTA
option.
.TP
.SM EINVAL
.IP
.I cmd
or
.I type
is invalid.
.TP
.SM ENOENT
The file specified by
.I special
or
.I addr
does not exist.
.TP
.SM ENOTBLK
.I special
is not a block device.
.TP
.SM EPERM
The call is privileged and the caller was not the super-user.
.TP
.SM ESRCH
No disc quota is found for the indicated user.
.IP
Quotas have not been turned on for this filesystem.
.LP
If
.I cmd
is
.BR \s-1Q_QUOTAON\s0 ,
.B quotactl(\|)
may set errno to:
.TP 15
.SM EACCES
The quota file pointed to by
.I addr
exists but is not a regular file.
.IP
The quota file pointed to by
.I addr
exists but is not on the
filesystem pointed to by
.IR special .
.TP
.SM EINVAL
The quota file is corrupted.
.TP
.SM ESRCH
Specified quota format was not found.
.TP
.SM EBUSY
.SB Q_QUOTAON
attempted while another
.SB Q_QUOTAON
has already taken place.
.SH "SEE ALSO"
.BR quota (1),
.BR getrlimit (2),
.BR quotacheck (8),
.BR quotaon (8)
|