1 .\" Copyright (c) 2010, Jan Kara
2 .\" A few pieces copyright (c) 1996 Andries Brouwer (aeb@cwi.nl)
3 .\" and copyright 2010 (c) Michael Kerrisk <mtk.manpages@gmail.com>
5 .\" SPDX-License-Identifier: Linux-man-pages-copyleft
7 .TH QUOTACTL 2 2021-03-22 "Linux" "Linux Programmer's Manual"
9 quotactl \- manipulate disk quotas
12 .RI ( libc ", " \-lc )
15 .B #include <sys/quota.h>
16 .BR "#include <xfs/xqm.h>" " /* Definition of " Q_X* " and " XFS_QUOTA_* \
18 .RB " (or " <linux/dqblk_xfs.h> "; see NOTES) */"
20 .BI "int quotactl(int " cmd ", const char *" special ", int " id \
24 The quota system can be used to set per-user, per-group, and per-project limits
25 on the amount of disk space used on a filesystem.
26 For each user and/or group,
27 a soft limit and a hard limit can be set for each filesystem.
28 The hard limit can't be exceeded.
29 The soft limit can be exceeded, but warnings will ensue.
30 Moreover, the user can't exceed the soft limit for more than grace period
31 duration (one week by default) at a time;
32 after this, the soft limit counts as a hard limit.
36 call manipulates disk quotas.
39 argument indicates a command to be applied to the user or
53 for group quotas, or (since Linux 4.1)
54 .\" 847aac644e92e5624f2c153bab409bf713d5ff9a
59 value is described below.
63 argument is a pointer to a null-terminated string containing the pathname
64 of the (mounted) block special device for the filesystem being manipulated.
68 argument is the address of an optional, command-specific, data structure
69 that is copied in or out of the system.
72 is given with each operation below.
76 value is one of the following operations:
79 Turn on quotas for a filesystem.
82 argument is the identification number of the quota format to be used.
83 Currently, there are three supported quota formats:
87 The original quota format.
90 The standard VFS v0 quota format, which can handle 32-bit UIDs and GIDs
91 and quota limits up to 2^42 bytes and 2^32 inodes.
94 A quota format that can handle 32-bit UIDs and GIDs
95 and quota limits of 2^63 - 1 bytes and 2^63 - 1 inodes.
100 argument points to the pathname of a file containing the quotas for
102 The quota file must exist; it is normally created with the
106 Quota information can be also stored in hidden system inodes
107 for ext4, XFS, and other filesystems if the filesystem is configured so.
108 In this case, there are no visible quota files and there is no need to
111 Quota information is always kept consistent by the filesystem and the
113 operation serves only to enable enforcement of quota limits.
114 The presence of hidden
115 system inodes with quota information is indicated by the
119 field returned by the
123 This operation requires privilege
124 .RB ( CAP_SYS_ADMIN ).
127 Turn off quotas for a filesystem.
132 arguments are ignored.
133 This operation requires privilege
134 .RB ( CAP_SYS_ADMIN ).
137 Get disk quota limits and current usage for user or group
141 argument is a pointer to a
149 /* uint64_t is an unsigned 64\-bit integer;
150 uint32_t is an unsigned 32\-bit integer */
152 struct dqblk { /* Definition since Linux 2.4.22 */
153 uint64_t dqb_bhardlimit; /* Absolute limit on disk
154 quota blocks alloc */
155 uint64_t dqb_bsoftlimit; /* Preferred limit on
157 uint64_t dqb_curspace; /* Current occupied space
159 uint64_t dqb_ihardlimit; /* Maximum number of
161 uint64_t dqb_isoftlimit; /* Preferred inode limit */
162 uint64_t dqb_curinodes; /* Current number of
164 uint64_t dqb_btime; /* Time limit for excessive
166 uint64_t dqb_itime; /* Time limit for excessive
168 uint32_t dqb_valid; /* Bit mask of QIF_*
172 /* Flags in dqb_valid that indicate which fields in
173 dqblk structure are valid. */
175 #define QIF_BLIMITS 1
177 #define QIF_ILIMITS 4
181 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
182 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
183 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
184 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
190 field is a bit mask that is set to indicate the entries in the
192 structure that are valid.
193 Currently, the kernel fills in all entries of the
195 structure and marks them as valid in the
198 Unprivileged users may retrieve only their own quotas;
200 .RB ( CAP_SYS_ADMIN )
201 can retrieve the quotas of any user.
203 .BR Q_GETNEXTQUOTA " (since Linux 4.6)"
204 .\" commit 926132c0257a5a8d149a6a395cc3405e55420566
205 This operation is the same as
207 but it returns quota information for the next ID greater than or equal to
209 that has a quota set.
213 argument is a pointer to a
215 structure whose fields are as for the
217 except for the addition of a
219 field that is used to return the ID for which
220 quota information is being returned:
225 uint64_t dqb_bhardlimit;
226 uint64_t dqb_bsoftlimit;
227 uint64_t dqb_curspace;
228 uint64_t dqb_ihardlimit;
229 uint64_t dqb_isoftlimit;
230 uint64_t dqb_curinodes;
240 Set quota information for user or group
242 using the information supplied in the
244 structure pointed to by
250 structure indicates which entries in the structure have been set by the caller.
251 This operation supersedes the
255 operations in the previous quota interfaces.
256 This operation requires privilege
257 .RB ( CAP_SYS_ADMIN ).
259 .BR Q_GETINFO " (since Linux 2.4.22)"
260 Get information (like grace times) about quotafile.
263 argument should be a pointer to a
266 This structure is defined in
272 /* uint64_t is an unsigned 64\-bit integer;
273 uint32_t is an unsigned 32\-bit integer */
275 struct dqinfo { /* Defined since kernel 2.4.22 */
276 uint64_t dqi_bgrace; /* Time before block soft limit
277 becomes hard limit */
278 uint64_t dqi_igrace; /* Time before inode soft limit
279 becomes hard limit */
280 uint32_t dqi_flags; /* Flags for quotafile
285 /* Bits for dqi_flags */
287 /* Quota format QFMT_VFS_OLD */
289 #define DQF_ROOT_SQUASH (1 << 0) /* Root squash enabled */
290 /* Before Linux v4.0, this had been defined
291 privately as V1_DQF_RSQUASH */
293 /* Quota format QFMT_VFS_V0 / QFMT_VFS_V1 */
295 #define DQF_SYS_FILE (1 << 16) /* Quota stored in
298 /* Flags in dqi_valid that indicate which fields in
299 dqinfo structure are valid. */
304 #define IIF_ALL (IIF_BGRACE | IIF_IGRACE | IIF_FLAGS)
312 structure indicates the entries in the structure that are valid.
313 Currently, the kernel fills in all entries of the
315 structure and marks them all as valid in the
322 .BR Q_SETINFO " (since Linux 2.4.22)"
323 Set information about quotafile.
326 argument should be a pointer to a
333 structure indicates the entries in the structure
334 that have been set by the caller.
335 This operation supersedes the
339 operations in the previous quota interfaces.
343 This operation requires privilege
344 .RB ( CAP_SYS_ADMIN ).
346 .BR Q_GETFMT " (since Linux 2.4.22)"
347 Get quota format used on the specified filesystem.
350 argument should be a pointer to a 4-byte buffer
351 where the format number will be stored.
354 Update the on-disk copy of quota usages for a filesystem.
357 is NULL, then all filesystems with active quotas are sync'ed.
362 arguments are ignored.
364 .BR Q_GETSTATS " (supported up to Linux 2.4.21)"
365 Get statistics and other generic information about the quota subsystem.
368 argument should be a pointer to a
370 structure in which data should be stored.
371 This structure is defined in
377 arguments are ignored.
379 This operation is obsolete and was removed in Linux 2.4.22.
381 .I /proc/sys/fs/quota/
382 carry the information instead.
384 For XFS filesystems making use of the XFS Quota Manager (XQM),
385 the above operations are bypassed and the following operations are used:
388 Turn on quotas for an XFS filesystem.
389 XFS provides the ability to turn on/off quota limit enforcement
390 with quota accounting.
391 Therefore, XFS expects
393 to be a pointer to an
395 that contains a bitwise combination of the following flags (defined in
400 XFS_QUOTA_UDQ_ACCT /* User quota accounting */
401 XFS_QUOTA_UDQ_ENFD /* User quota limits enforcement */
402 XFS_QUOTA_GDQ_ACCT /* Group quota accounting */
403 XFS_QUOTA_GDQ_ENFD /* Group quota limits enforcement */
404 XFS_QUOTA_PDQ_ACCT /* Project quota accounting */
405 XFS_QUOTA_PDQ_ENFD /* Project quota limits enforcement */
409 This operation requires privilege
410 .RB ( CAP_SYS_ADMIN ).
416 Turn off quotas for an XFS filesystem.
419 XFS filesystems expect a pointer to an
421 that specifies whether quota accounting and/or limit enforcement need
422 to be turned off (using the same flags as for
425 This operation requires privilege
426 .RB ( CAP_SYS_ADMIN ).
432 Get disk quota limits and current usage for user
436 argument is a pointer to an
438 structure, which is defined in
444 /* All the blk units are in BBs (Basic Blocks) of
447 #define FS_DQUOT_VERSION 1 /* fs_disk_quota.d_version */
449 #define XFS_USER_QUOTA (1<<0) /* User quota type */
450 #define XFS_PROJ_QUOTA (1<<1) /* Project quota type */
451 #define XFS_GROUP_QUOTA (1<<2) /* Group quota type */
453 struct fs_disk_quota {
454 int8_t d_version; /* Version of this structure */
455 int8_t d_flags; /* XFS_{USER,PROJ,GROUP}_QUOTA */
456 uint16_t d_fieldmask; /* Field specifier */
457 uint32_t d_id; /* User, project, or group ID */
458 uint64_t d_blk_hardlimit; /* Absolute limit on
460 uint64_t d_blk_softlimit; /* Preferred limit on
462 uint64_t d_ino_hardlimit; /* Maximum # allocated
464 uint64_t d_ino_softlimit; /* Preferred inode limit */
465 uint64_t d_bcount; /* # disk blocks owned by
467 uint64_t d_icount; /* # inodes owned by the user */
468 int32_t d_itimer; /* Zero if within inode limits */
469 /* If not, we refuse service */
470 int32_t d_btimer; /* Similar to above; for
472 uint16_t d_iwarns; /* # warnings issued with
473 respect to # of inodes */
474 uint16_t d_bwarns; /* # warnings issued with
475 respect to disk blocks */
476 int32_t d_padding2; /* Padding \- for future use */
477 uint64_t d_rtb_hardlimit; /* Absolute limit on realtime
479 uint64_t d_rtb_softlimit; /* Preferred limit on RT
481 uint64_t d_rtbcount; /* # realtime blocks owned */
482 int32_t d_rtbtimer; /* Similar to above; for RT
484 uint16_t d_rtbwarns; /* # warnings issued with
485 respect to RT disk blocks */
486 int16_t d_padding3; /* Padding \- for future use */
487 char d_padding4[8]; /* Yet more padding */
492 Unprivileged users may retrieve only their own quotas;
494 .RB ( CAP_SYS_ADMIN )
495 may retrieve the quotas of any user.
497 .BR Q_XGETNEXTQUOTA " (since Linux 4.6)"
498 .\" commit 8b37524962b9c54423374717786198f5c0820a28
499 This operation is the same as
501 but it returns (in the
505 quota information for the next ID greater than or equal to
507 that has a quota set.
512 field, no separate structure type is needed (in contrast with
519 Set disk quota limits for user
523 argument is a pointer to an
526 This operation requires privilege
527 .RB ( CAP_SYS_ADMIN ).
530 Returns XFS filesystem-specific quota information in the
534 This is useful for finding out how much space is used to store quota
535 information, and also to get the quota on/off status of a given local XFS
539 structure itself is defined as follows:
543 #define FS_QSTAT_VERSION 1 /* fs_quota_stat.qs_version */
545 struct fs_qfilestat {
546 uint64_t qfs_ino; /* Inode number */
547 uint64_t qfs_nblks; /* Number of BBs
549 uint32_t qfs_nextents; /* Number of extents */
552 struct fs_quota_stat {
553 int8_t qs_version; /* Version number for
555 uint16_t qs_flags; /* XFS_QUOTA_{U,P,G}DQ_{ACCT,ENFD} */
556 int8_t qs_pad; /* Unused */
557 struct fs_qfilestat qs_uquota; /* User quota storage
559 struct fs_qfilestat qs_gquota; /* Group quota storage
561 uint32_t qs_incoredqs; /* Number of dquots in core */
562 int32_t qs_btimelimit; /* Limit for blocks timer */
563 int32_t qs_itimelimit; /* Limit for inodes timer */
564 int32_t qs_rtbtimelimit;/* Limit for RT
566 uint16_t qs_bwarnlimit; /* Limit for # of warnings */
567 uint16_t qs_iwarnlimit; /* Limit for # of warnings */
577 Returns XFS filesystem-specific quota information in the
581 This version of the operation uses a structure with proper versioning support,
582 along with appropriate layout (all fields are naturally aligned) and
583 padding to avoiding special compat handling;
584 it also provides the ability to get statistics regarding
585 the project quota file.
588 structure itself is defined as follows:
592 #define FS_QSTATV_VERSION1 1 /* fs_quota_statv.qs_version */
594 struct fs_qfilestatv {
595 uint64_t qfs_ino; /* Inode number */
596 uint64_t qfs_nblks; /* Number of BBs
598 uint32_t qfs_nextents; /* Number of extents */
599 uint32_t qfs_pad; /* Pad for 8\-byte alignment */
602 struct fs_quota_statv {
603 int8_t qs_version; /* Version for future
605 uint8_t qs_pad1; /* Pad for 16\-bit alignment */
606 uint16_t qs_flags; /* XFS_QUOTA_.* flags */
607 uint32_t qs_incoredqs; /* Number of dquots incore */
608 struct fs_qfilestatv qs_uquota; /* User quota
610 struct fs_qfilestatv qs_gquota; /* Group quota
612 struct fs_qfilestatv qs_pquota; /* Project quota
614 int32_t qs_btimelimit; /* Limit for blocks timer */
615 int32_t qs_itimelimit; /* Limit for inodes timer */
616 int32_t qs_rtbtimelimit; /* Limit for RT blocks
618 uint16_t qs_bwarnlimit; /* Limit for # of warnings */
619 uint16_t qs_iwarnlimit; /* Limit for # of warnings */
620 uint64_t qs_pad2[8]; /* For future proofing */
627 field of the structure should be filled with the version of the structure
628 supported by the callee (for now, only
631 The kernel will fill the structure in accordance with
637 .BR Q_XQUOTARM " (buggy until Linux 3.16)"
638 .\" 9da93f9b7cdf8ab28da6b364cdc1fafc8670b4dc
639 Free the disk space taken by disk quotas.
642 argument should be a pointer to an
644 value containing flags (the same as in
649 which identify what types of quota
651 (Note that the quota type passed in the
653 argument is ignored, but should remain valid in order to pass preliminary
654 quotactl syscall handler checks.)
656 Quotas must have already been turned off.
661 .BR Q_XQUOTASYNC " (since Linux 2.6.15; no-op since Linux 3.4)"
662 .\" Added in commit ee34807a65aa0c5911dc27682863afca780a003e
663 This operation was an XFS quota equivalent to
665 but it is no-op since Linux 3.4,
666 .\" 4b217ed9e30f94b6e8e5e262020ef0ceab6113af
669 writes quota information to disk now
670 (in addition to the other filesystem metadata that it writes out).
672 .IR special ", " id " and " addr
673 arguments are ignored.
677 returns 0; on error \-1
680 is set to indicate the error.
687 and the quota file pointed to by
689 exists, but is not a regular file or
690 is not on the filesystem pointed to by
699 had already been performed.
717 but the specified quota file is corrupted.
719 .BR EINVAL " (since Linux 5.5)"
720 .\" 3dd4d40b420846dd35869ccc8f8627feef2cff32
726 does not point to valid quota types.
729 The file specified by
736 The kernel has not been compiled with the
742 is not a block device.
745 The caller lacked the required privilege
746 .RB ( CAP_SYS_ADMIN )
747 for the specified operation.
753 but the specified limits are out of the range allowed by the quota format.
756 No disk quota is found for the indicated user.
757 Quotas have not been turned on for this filesystem.
763 but the specified quota format was not found.
770 .BR Q_XGETNEXTQUOTA ,
771 but there is no ID greater than or equal to
773 that has an active quota.
778 .IR <linux/dqblk_xfs.h> ,
779 taking into account that there are several naming discrepancies:
781 Quota enabling flags (of format
782 .BR XFS_QUOTA_[UGP]DQ_{ACCT,ENFD} )
783 are defined without a leading "X", as
784 .BR FS_QUOTA_[UGP]DQ_{ACCT,ENFD} .
787 .B XFS_{USER,GROUP,PROJ}_QUOTA
788 quota type flags, which are defined as
789 .BR FS_{USER,GROUP,PROJ}_QUOTA .
793 header file defines its own
798 constants for the available quota types, but their values are the same as for
799 constants without the