man2/quotactl.2

   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>
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of
  11 .\" this manual under the conditions for verbatim copying, provided that
  12 .\" the entire resulting derived work is distributed under the terms of
  13 .\" a permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume
  17 .\" no responsibility for errors or omissions, or for damages resulting
  18 .\" from the use of the information contained herein.  The author(s) may
  19 .\" not have taken the same level of care in the production of this
  20 .\" manual, which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .TH QUOTACTL 2 2021-03-22 "Linux" "Linux Programmer's Manual"
  28 .SH NAME
  29 quotactl \- manipulate disk quotas
  30 .SH SYNOPSIS
  31 .nf
  32 .B #include <sys/quota.h>
  33 .B #include <xfs/xqm.h> /* for XFS quotas */
  34 .PP
  35 .BI "int quotactl(int " cmd ", const char *" special ", int " id \
  36 ", caddr_t " addr );
  37 .fi
  38 .SH DESCRIPTION
  39 The quota system can be used to set per-user, per-group, and per-project limits
  40 on the amount of disk space used on a filesystem.
  41 For each user and/or group,
  42 a soft limit and a hard limit can be set for each filesystem.
  43 The hard limit can't be exceeded.
  44 The soft limit can be exceeded, but warnings will ensue.
  45 Moreover, the user can't exceed the soft limit for more than grace period
  46 duration (one week by default) at a time;
  47 after this, the soft limit counts as a hard limit.
  48 .PP
  49 The
  50 .BR quotactl ()
  51 call manipulates disk quotas.
  52 The
  53 .I cmd
  54 argument indicates a command to be applied to the user or
  55 group ID specified in
  56 .IR id .
  57 To initialize the
  58 .IR cmd
  59 argument, use the
  60 .IR "QCMD(subcmd, type)"
  61 macro.
  62 The
  63 .I type
  64 value is either
  65 .BR USRQUOTA ,
  66 for user quotas,
  67 .BR GRPQUOTA ,
  68 for group quotas, or (since Linux 4.1)
  69 .\" 847aac644e92e5624f2c153bab409bf713d5ff9a
  70 .BR PRJQUOTA ,
  71 for project quotas.
  72 The
  73 .I subcmd
  74 value is described below.
  75 .PP
  76 The
  77 .I special
  78 argument is a pointer to a null-terminated string containing the pathname
  79 of the (mounted) block special device for the filesystem being manipulated.
  80 .PP
  81 The
  82 .I addr
  83 argument is the address of an optional, command-specific, data structure
  84 that is copied in or out of the system.
  85 The interpretation of
  86 .I addr
  87 is given with each operation below.
  88 .PP
  89 The
  90 .I subcmd
  91 value is one of the following operations:
  92 .TP
  93 .B Q_QUOTAON
  94 Turn on quotas for a filesystem.
  95 The
  96 .I id
  97 argument is the identification number of the quota format to be used.
  98 Currently, there are three supported quota formats:
  99 .RS
 100 .TP 13
 101 .BR QFMT_VFS_OLD
 102 The original quota format.
 103 .TP
 104 .BR QFMT_VFS_V0
 105 The standard VFS v0 quota format, which can handle 32-bit UIDs and GIDs
 106 and quota limits up to 2^42 bytes and 2^32 inodes.
 107 .TP
 108 .BR QFMT_VFS_V1
 109 A quota format that can handle 32-bit UIDs and GIDs
 110 and quota limits of 2^64 bytes and 2^64 inodes.
 111 .RE
 112 .IP
 113 The
 114 .IR addr
 115 argument points to the pathname of a file containing the quotas for
 116 the filesystem.
 117 The quota file must exist; it is normally created with the
 118 .BR quotacheck (8)
 119 program
 120 .IP
 121 Quota information can be also stored in hidden system inodes
 122 for ext4, XFS, and other filesystems if the filesystem is configured so.
 123 In this case, there are no visible quota files and there is no need to
 124 use
 125 .BR quotacheck (8).
 126 Quota information is always kept consistent by the filesystem and the
 127 .B Q_QUOTAON
 128 operation serves only to enable enforcement of quota limits.
 129 The presence of hidden
 130 system inodes with quota information is indicated by the
 131 .B DQF_SYS_FILE
 132 flag in the
 133 .I dqi_flags
 134 field returned by the
 135 .B Q_GETINFO
 136 operation.
 137 .IP
 138 This operation requires privilege
 139 .RB ( CAP_SYS_ADMIN ).
 140 .TP
 141 .B Q_QUOTAOFF
 142 Turn off quotas for a filesystem.
 143 The
 144 .I addr
 145 and
 146 .I id
 147 arguments are ignored.
 148 This operation requires privilege
 149 .RB ( CAP_SYS_ADMIN ).
 150 .TP
 151 .B Q_GETQUOTA
 152 Get disk quota limits and current usage for user or group
 153 .IR id .
 154 The
 155 .I addr
 156 argument is a pointer to a
 157 .I dqblk
 158 structure defined in
 159 .IR <sys/quota.h>
 160 as follows:
 161 .IP
 162 .in +4n
 163 .EX
 164 /* uint64_t is an unsigned 64\-bit integer;
 165    uint32_t is an unsigned 32\-bit integer */
 166
 167 struct dqblk {      /* Definition since Linux 2.4.22 */
 168     uint64_t dqb_bhardlimit;  /* Absolute limit on disk
 169                                  quota blocks alloc */
 170     uint64_t dqb_bsoftlimit;  /* Preferred limit on
 171                                  disk quota blocks */
 172     uint64_t dqb_curspace;    /* Current occupied space
 173                                  (in bytes) */
 174     uint64_t dqb_ihardlimit;  /* Maximum number of
 175                                  allocated inodes */
 176     uint64_t dqb_isoftlimit;  /* Preferred inode limit */
 177     uint64_t dqb_curinodes;   /* Current number of
 178                                  allocated inodes */
 179     uint64_t dqb_btime;       /* Time limit for excessive
 180                                  disk use */
 181     uint64_t dqb_itime;       /* Time limit for excessive
 182                                  files */
 183     uint32_t dqb_valid;       /* Bit mask of QIF_*
 184                                  constants */
 185 };
 186
 187 /* Flags in dqb_valid that indicate which fields in
 188    dqblk structure are valid. */
 189
 190 #define QIF_BLIMITS   1
 191 #define QIF_SPACE     2
 192 #define QIF_ILIMITS   4
 193 #define QIF_INODES    8
 194 #define QIF_BTIME     16
 195 #define QIF_ITIME     32
 196 #define QIF_LIMITS    (QIF_BLIMITS | QIF_ILIMITS)
 197 #define QIF_USAGE     (QIF_SPACE | QIF_INODES)
 198 #define QIF_TIMES     (QIF_BTIME | QIF_ITIME)
 199 #define QIF_ALL       (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 200 .EE
 201 .in
 202 .IP
 203 The
 204 .I dqb_valid
 205 field is a bit mask that is set to indicate the entries in the
 206 .I dqblk
 207 structure that are valid.
 208 Currently, the kernel fills in all entries of the
 209 .I dqblk
 210 structure and marks them as valid in the
 211 .I dqb_valid
 212 field.
 213 Unprivileged users may retrieve only their own quotas;
 214 a privileged user
 215 .RB ( CAP_SYS_ADMIN )
 216 can retrieve the quotas of any user.
 217 .TP
 218 .BR Q_GETNEXTQUOTA " (since Linux 4.6)"
 219 .\" commit 926132c0257a5a8d149a6a395cc3405e55420566
 220 This operation is the same as
 221 .BR Q_GETQUOTA ,
 222 but it returns quota information for the next ID greater than or equal to
 223 .IR id
 224 that has a quota set.
 225 .IP
 226 The
 227 .I addr
 228 argument is a pointer to a
 229 .I nextdqblk
 230 structure whose fields are as for the
 231 .IR dqblk ,
 232 except for the addition of a
 233 .I dqb_id
 234 field that is used to return the ID for which
 235 quota information is being returned:
 236 .IP
 237 .in +4n
 238 .EX
 239 struct nextdqblk {
 240     uint64_t dqb_bhardlimit;
 241     uint64_t dqb_bsoftlimit;
 242     uint64_t dqb_curspace;
 243     uint64_t dqb_ihardlimit;
 244     uint64_t dqb_isoftlimit;
 245     uint64_t dqb_curinodes;
 246     uint64_t dqb_btime;
 247     uint64_t dqb_itime;
 248     uint32_t dqb_valid;
 249     uint32_t dqb_id;
 250 };
 251 .EE
 252 .in
 253 .TP
 254 .B Q_SETQUOTA
 255 Set quota information for user or group
 256 .IR id ,
 257 using the information supplied in the
 258 .I dqblk
 259 structure pointed to by
 260 .IR addr .
 261 The
 262 .I dqb_valid
 263 field of the
 264 .I dqblk
 265 structure indicates which entries in the structure have been set by the caller.
 266 This operation supersedes the
 267 .B Q_SETQLIM
 268 and
 269 .B Q_SETUSE
 270 operations in the previous quota interfaces.
 271 This operation requires privilege
 272 .RB ( CAP_SYS_ADMIN ).
 273 .TP
 274 .BR Q_GETINFO " (since Linux 2.4.22)"
 275 Get information (like grace times) about quotafile.
 276 The
 277 .I addr
 278 argument should be a pointer to a
 279 .I dqinfo
 280 structure.
 281 This structure is defined in
 282 .IR <sys/quota.h>
 283 as follows:
 284 .IP
 285 .in +4n
 286 .EX
 287 /* uint64_t is an unsigned 64\-bit integer;
 288    uint32_t is an unsigned 32\-bit integer */
 289
 290 struct dqinfo {         /* Defined since kernel 2.4.22 */
 291     uint64_t dqi_bgrace;  /* Time before block soft limit
 292                              becomes hard limit */
 293     uint64_t dqi_igrace;  /* Time before inode soft limit
 294                              becomes hard limit */
 295     uint32_t dqi_flags;   /* Flags for quotafile
 296                              (DQF_*) */
 297     uint32_t dqi_valid;
 298 };
 299
 300 /* Bits for dqi_flags */
 301
 302 /* Quota format QFMT_VFS_OLD */
 303
 304 #define DQF_ROOT_SQUASH (1 << 0) /* Root squash enabled */
 305               /* Before Linux v4.0, this had been defined
 306                  privately as V1_DQF_RSQUASH */
 307
 308 /* Quota format QFMT_VFS_V0 / QFMT_VFS_V1 */
 309
 310 #define DQF_SYS_FILE    (1 << 16)   /* Quota stored in
 311                                        a system file */
 312
 313 /* Flags in dqi_valid that indicate which fields in
 314    dqinfo structure are valid. */
 315
 316 #define IIF_BGRACE  1
 317 #define IIF_IGRACE  2
 318 #define IIF_FLAGS   4
 319 #define IIF_ALL     (IIF_BGRACE | IIF_IGRACE | IIF_FLAGS)
 320 .EE
 321 .in
 322 .IP
 323 The
 324 .I dqi_valid
 325 field in the
 326 .I dqinfo
 327 structure indicates the entries in the structure that are valid.
 328 Currently, the kernel fills in all entries of the
 329 .I dqinfo
 330 structure and marks them all as valid in the
 331 .I dqi_valid
 332 field.
 333 The
 334 .I id
 335 argument is ignored.
 336 .TP
 337 .BR Q_SETINFO " (since Linux 2.4.22)"
 338 Set information about quotafile.
 339 The
 340 .I addr
 341 argument should be a pointer to a
 342 .I dqinfo
 343 structure.
 344 The
 345 .I dqi_valid
 346 field of the
 347 .I dqinfo
 348 structure indicates the entries in the structure
 349 that have been set by the caller.
 350 This operation supersedes the
 351 .B Q_SETGRACE
 352 and
 353 .B Q_SETFLAGS
 354 operations in the previous quota interfaces.
 355 The
 356 .I id
 357 argument is ignored.
 358 This operation requires privilege
 359 .RB ( CAP_SYS_ADMIN ).
 360 .TP
 361 .BR Q_GETFMT " (since Linux 2.4.22)"
 362 Get quota format used on the specified filesystem.
 363 The
 364 .I addr
 365 argument should be a pointer to a 4-byte buffer
 366 where the format number will be stored.
 367 .TP
 368 .B Q_SYNC
 369 Update the on-disk copy of quota usages for a filesystem.
 370 If
 371 .I special
 372 is NULL, then all filesystems with active quotas are sync'ed.
 373 The
 374 .I addr
 375 and
 376 .I id
 377 arguments are ignored.
 378 .TP
 379 .BR Q_GETSTATS " (supported up to Linux 2.4.21)"
 380 Get statistics and other generic information about the quota subsystem.
 381 The
 382 .I addr
 383 argument should be a pointer to a
 384 .I dqstats
 385 structure in which data should be stored.
 386 This structure is defined in
 387 .IR <sys/quota.h> .
 388 The
 389 .I special
 390 and
 391 .I id
 392 arguments are ignored.
 393 .IP
 394 This operation is obsolete and was removed in Linux 2.4.22.
 395 Files in
 396 .I /proc/sys/fs/quota/
 397 carry the information instead.
 398 .PP
 399 For XFS filesystems making use of the XFS Quota Manager (XQM),
 400 the above operations are bypassed and the following operations are used:
 401 .TP
 402 .B Q_XQUOTAON
 403 Turn on quotas for an XFS filesystem.
 404 XFS provides the ability to turn on/off quota limit enforcement
 405 with quota accounting.
 406 Therefore, XFS expects
 407 .I addr
 408 to be a pointer to an
 409 .I "unsigned int"
 410 that contains a bitwise combination of the following flags (defined in
 411 .IR <xfs/xqm.h> ):
 412 .IP
 413 .in +4n
 414 .EX
 415 XFS_QUOTA_UDQ_ACCT  /* User quota accounting */
 416 XFS_QUOTA_UDQ_ENFD  /* User quota limits enforcement */
 417 XFS_QUOTA_GDQ_ACCT  /* Group quota accounting */
 418 XFS_QUOTA_GDQ_ENFD  /* Group quota limits enforcement */
 419 XFS_QUOTA_PDQ_ACCT  /* Project quota accounting */
 420 XFS_QUOTA_PDQ_ENFD  /* Project quota limits enforcement */
 421 .EE
 422 .in
 423 .IP
 424 This operation requires privilege
 425 .RB ( CAP_SYS_ADMIN ).
 426 The
 427 .I id
 428 argument is ignored.
 429 .TP
 430 .B Q_XQUOTAOFF
 431 Turn off quotas for an XFS filesystem.
 432 As with
 433 .BR Q_QUOTAON ,
 434 XFS filesystems expect a pointer to an
 435 .I "unsigned int"
 436 that specifies whether quota accounting and/or limit enforcement need
 437 to be turned off (using the same flags as for
 438 .B Q_XQUOTAON
 439 operation).
 440 This operation requires privilege
 441 .RB ( CAP_SYS_ADMIN ).
 442 The
 443 .I id
 444 argument is ignored.
 445 .TP
 446 .B Q_XGETQUOTA
 447 Get disk quota limits and current usage for user
 448 .IR id .
 449 The
 450 .I addr
 451 argument is a pointer to an
 452 .I fs_disk_quota
 453 structure, which is defined in
 454 .I <xfs/xqm.h>
 455 as follows:
 456 .IP
 457 .in +4n
 458 .EX
 459 /* All the blk units are in BBs (Basic Blocks) of
 460    512 bytes. */
 461
 462 #define FS_DQUOT_VERSION  1  /* fs_disk_quota.d_version */
 463
 464 #define XFS_USER_QUOTA    (1<<0)  /* User quota type */
 465 #define XFS_PROJ_QUOTA    (1<<1)  /* Project quota type */
 466 #define XFS_GROUP_QUOTA   (1<<2)  /* Group quota type */
 467
 468 struct fs_disk_quota {
 469     int8_t   d_version;   /* Version of this structure */
 470     int8_t   d_flags;     /* XFS_{USER,PROJ,GROUP}_QUOTA */
 471     uint16_t d_fieldmask; /* Field specifier */
 472     uint32_t d_id;        /* User, project, or group ID */
 473     uint64_t d_blk_hardlimit; /* Absolute limit on
 474                                  disk blocks */
 475     uint64_t d_blk_softlimit; /* Preferred limit on
 476                                  disk blocks */
 477     uint64_t d_ino_hardlimit; /* Maximum # allocated
 478                                  inodes */
 479     uint64_t d_ino_softlimit; /* Preferred inode limit */
 480     uint64_t d_bcount;    /* # disk blocks owned by
 481                              the user */
 482     uint64_t d_icount;    /* # inodes owned by the user */
 483     int32_t  d_itimer;    /* Zero if within inode limits */
 484                           /* If not, we refuse service */
 485     int32_t  d_btimer;    /* Similar to above; for
 486                              disk blocks */
 487     uint16_t d_iwarns;    /* # warnings issued with
 488                              respect to # of inodes */
 489     uint16_t d_bwarns;    /* # warnings issued with
 490                              respect to disk blocks */
 491     int32_t  d_padding2;  /* Padding \- for future use */
 492     uint64_t d_rtb_hardlimit; /* Absolute limit on realtime
 493                                  (RT) disk blocks */
 494     uint64_t d_rtb_softlimit; /* Preferred limit on RT
 495                                  disk blocks */
 496     uint64_t d_rtbcount;  /* # realtime blocks owned */
 497     int32_t  d_rtbtimer;  /* Similar to above; for RT
 498                              disk blocks */
 499     uint16_t d_rtbwarns;  /* # warnings issued with
 500                              respect to RT disk blocks */
 501     int16_t  d_padding3;  /* Padding \- for future use */
 502     char     d_padding4[8];   /* Yet more padding */
 503 };
 504 .EE
 505 .in
 506 .IP
 507 Unprivileged users may retrieve only their own quotas;
 508 a privileged user
 509 .RB ( CAP_SYS_ADMIN )
 510 may retrieve the quotas of any user.
 511 .TP
 512 .BR Q_XGETNEXTQUOTA " (since Linux 4.6)"
 513 .\" commit 8b37524962b9c54423374717786198f5c0820a28
 514 This operation is the same as
 515 .BR Q_XGETQUOTA ,
 516 but it returns (in the
 517 .I fs_disk_quota
 518 structure pointed by
 519 .IR addr )
 520 quota information for the next ID greater than or equal to
 521 .IR id
 522 that has a quota set.
 523 Note that since
 524 .I fs_disk_quota
 525 already has
 526 .I q_id
 527 field, no separate structure type is needed (in contrast with
 528 .B Q_GETQUOTA
 529 and
 530 .B Q_GETNEXTQUOTA
 531 operations)
 532 .TP
 533 .B Q_XSETQLIM
 534 Set disk quota limits for user
 535 .IR id .
 536 The
 537 .I addr
 538 argument is a pointer to an
 539 .I fs_disk_quota
 540 structure.
 541 This operation requires privilege
 542 .RB ( CAP_SYS_ADMIN ).
 543 .TP
 544 .B Q_XGETQSTAT
 545 Returns XFS filesystem-specific quota information in the
 546 .I fs_quota_stat
 547 structure pointed by
 548 .IR addr .
 549 This is useful for finding out how much space is used to store quota
 550 information, and also to get the quota on/off status of a given local XFS
 551 filesystem.
 552 The
 553 .I fs_quota_stat
 554 structure itself is defined as follows:
 555 .IP
 556 .in +4n
 557 .EX
 558 #define FS_QSTAT_VERSION 1  /* fs_quota_stat.qs_version */
 559
 560 struct fs_qfilestat {
 561     uint64_t qfs_ino;       /* Inode number */
 562     uint64_t qfs_nblks;     /* Number of BBs
 563                                512\-byte\-blocks */
 564     uint32_t qfs_nextents;  /* Number of extents */
 565 };
 566
 567 struct fs_quota_stat {
 568     int8_t   qs_version; /* Version number for
 569                             future changes */
 570     uint16_t qs_flags; /* XFS_QUOTA_{U,P,G}DQ_{ACCT,ENFD} */
 571     int8_t   qs_pad;   /* Unused */
 572     struct fs_qfilestat qs_uquota;  /* User quota storage
 573                                        information */
 574     struct fs_qfilestat qs_gquota;  /* Group quota storage
 575                                        information */
 576     uint32_t qs_incoredqs;   /* Number of dquots in core */
 577     int32_t  qs_btimelimit;  /* Limit for blocks timer */
 578     int32_t  qs_itimelimit;  /* Limit for inodes timer */
 579     int32_t  qs_rtbtimelimit;/* Limit for RT
 580                                 blocks timer */
 581     uint16_t qs_bwarnlimit;  /* Limit for # of warnings */
 582     uint16_t qs_iwarnlimit;  /* Limit for # of warnings */
 583 };
 584 .EE
 585 .in
 586 .IP
 587 The
 588 .I id
 589 argument is ignored.
 590 .TP
 591 .B Q_XGETQSTATV
 592 Returns XFS filesystem-specific quota information in the
 593 .I fs_quota_statv
 594 pointed to by
 595 .IR addr .
 596 This version of the operation uses a structure with proper versioning support,
 597 along with appropriate layout (all fields are naturally aligned) and
 598 padding to avoiding special compat handling;
 599 it also provides the ability to get statistics regarding
 600 the project quota file.
 601 The
 602 .I fs_quota_statv
 603 structure itself is defined as follows:
 604 .IP
 605 .in +4n
 606 .EX
 607 #define FS_QSTATV_VERSION1 1 /* fs_quota_statv.qs_version */
 608
 609 struct fs_qfilestatv {
 610     uint64_t qfs_ino;       /* Inode number */
 611     uint64_t qfs_nblks;     /* Number of BBs
 612                                512\-byte\-blocks */
 613     uint32_t qfs_nextents;  /* Number of extents */
 614     uint32_t qfs_pad;       /* Pad for 8\-byte alignment */
 615 };
 616
 617 struct fs_quota_statv {
 618     int8_t   qs_version;    /* Version for future
 619                                changes */
 620     uint8_t  qs_pad1;       /* Pad for 16\-bit alignment */
 621     uint16_t qs_flags;      /* XFS_QUOTA_.* flags */
 622     uint32_t qs_incoredqs;  /* Number of dquots incore */
 623     struct fs_qfilestatv qs_uquota;  /* User quota
 624                                         information */
 625     struct fs_qfilestatv qs_gquota;  /* Group quota
 626                                         information */
 627     struct fs_qfilestatv qs_pquota;  /* Project quota
 628                                         information */
 629     int32_t  qs_btimelimit;   /* Limit for blocks timer */
 630     int32_t  qs_itimelimit;   /* Limit for inodes timer */
 631     int32_t  qs_rtbtimelimit; /* Limit for RT blocks
 632                                  timer */
 633     uint16_t qs_bwarnlimit;   /* Limit for # of warnings */
 634     uint16_t qs_iwarnlimit;   /* Limit for # of warnings */
 635     uint64_t qs_pad2[8];      /* For future proofing */
 636 };
 637 .EE
 638 .in
 639 .IP
 640 The
 641 .I qs_version
 642 field of the structure should be filled with the version of the structure
 643 supported by the callee (for now, only
 644 .I FS_QSTAT_VERSION1
 645 is supported).
 646 The kernel will fill the structure in accordance with
 647 version provided.
 648 The
 649 .I id
 650 argument is ignored.
 651 .TP
 652 .B Q_XQUOTARM " (since Linux 3.16)"
 653 .\" 9da93f9b7cdf8ab28da6b364cdc1fafc8670b4dc
 654 Free the disk space taken by disk quotas.
 655 The
 656 .I addr
 657 argument should be a pointer to an
 658 .I "unsigned int"
 659 value containing flags (the same as in
 660 .I d_flags
 661 field of
 662 .I fs_disk_quota
 663 structure)
 664 which identify what types of quota
 665 should be removed.
 666 (Note that the quota type passed in the
 667 .I cmd
 668 argument is ignored, but should remain valid in order to pass preliminary
 669 quotactl syscall handler checks.)
 670 .IP
 671 Quotas must have already been turned off.
 672 The
 673 .I id
 674 argument is ignored.
 675 .TP
 676 .BR Q_XQUOTASYNC " (since Linux 2.6.15; no-op since Linux 3.4)"
 677 .\" Added in commit ee34807a65aa0c5911dc27682863afca780a003e
 678 This operation was an XFS quota equivalent to
 679 .BR Q_SYNC ,
 680 but it is no-op since Linux 3.4,
 681 .\" 4b217ed9e30f94b6e8e5e262020ef0ceab6113af
 682 as
 683 .BR sync (1)
 684 writes quota information to disk now
 685 (in addition to the other filesystem metadata that it writes out).
 686 The
 687 .IR special ", " id " and " addr
 688 arguments are ignored.
 689 .SH RETURN VALUE
 690 On success,
 691 .BR quotactl ()
 692 returns 0; on error \-1
 693 is returned, and
 694 .I errno
 695 is set to indicate the error.
 696 .SH ERRORS
 697 .TP
 698 .B EACCES
 699 .I cmd
 700 is
 701 .BR Q_QUOTAON ,
 702 and the quota file pointed to by
 703 .I addr
 704 exists, but is not a regular file or
 705 is not on the filesystem pointed to by
 706 .IR special .
 707 .TP
 708 .B EBUSY
 709 .I cmd
 710 is
 711 .BR Q_QUOTAON ,
 712 but another
 713 .B Q_QUOTAON
 714 had already been performed.
 715 .TP
 716 .B EFAULT
 717 .I addr
 718 or
 719 .I special
 720 is invalid.
 721 .TP
 722 .B EINVAL
 723 .I cmd
 724 or
 725 .I type
 726 is invalid.
 727 .TP
 728 .B EINVAL
 729 .I cmd
 730 is
 731 .BR Q_QUOTAON ,
 732 but the specified quota file is corrupted.
 733 .TP
 734 .BR EINVAL " (since Linux 5.5)"
 735 .\" 3dd4d40b420846dd35869ccc8f8627feef2cff32
 736 .I cmd
 737 is
 738 .BR Q_XQUOTARM ,
 739 but
 740 .I addr
 741 does not point to valid quota types.
 742 .TP
 743 .B ENOENT
 744 The file specified by
 745 .I special
 746 or
 747 .I addr
 748 does not exist.
 749 .TP
 750 .B ENOSYS
 751 The kernel has not been compiled with the
 752 .B CONFIG_QUOTA
 753 option.
 754 .TP
 755 .B ENOTBLK
 756 .I special
 757 is not a block device.
 758 .TP
 759 .B EPERM
 760 The caller lacked the required privilege
 761 .RB ( CAP_SYS_ADMIN )
 762 for the specified operation.
 763 .TP
 764 .B ERANGE
 765 .I cmd
 766 is
 767 .BR Q_SETQUOTA ,
 768 but the specified limits are out of the range allowed by the quota format.
 769 .TP
 770 .B ESRCH
 771 No disk quota is found for the indicated user.
 772 Quotas have not been turned on for this filesystem.
 773 .TP
 774 .B ESRCH
 775 .I cmd
 776 is
 777 .BR Q_QUOTAON ,
 778 but the specified quota format was not found.
 779 .TP
 780 .B ESRCH
 781 .I cmd
 782 is
 783 .B Q_GETNEXTQUOTA
 784 or
 785 .BR Q_XGETNEXTQUOTA ,
 786 but there is no ID greater than or equal to
 787 .IR id
 788 that has an active quota.
 789 .SH NOTES
 790 Instead of
 791 .I <xfs/xqm.h>
 792 one can use
 793 .IR <linux/dqblk_xfs.h> ,
 794 taking into account that there are several naming discrepancies:
 795 .IP \(bu 3
 796 Quota enabling flags (of format
 797 .BR XFS_QUOTA_[UGP]DQ_{ACCT,ENFD} )
 798 are defined without a leading "X", as
 799 .BR FS_QUOTA_[UGP]DQ_{ACCT,ENFD} .
 800 .IP \(bu
 801 The same is true for
 802 .B XFS_{USER,GROUP,PROJ}_QUOTA
 803 quota type flags, which are defined as
 804 .BR FS_{USER,GROUP,PROJ}_QUOTA .
 805 .IP \(bu
 806 The
 807 .I dqblk_xfs.h
 808 header file defines its own
 809 .BR XQM_USRQUOTA ,
 810 .BR XQM_GRPQUOTA ,
 811 and
 812 .B XQM_PRJQUOTA
 813 constants for the available quota types, but their values are the same as for
 814 constants without the
 815 .B XQM_
 816 prefix.
 817 .SH SEE ALSO
 818 .BR quota (1),
 819 .BR getrlimit (2),
 820 .BR quotacheck (8),
 821 .BR quotaon (8)