www.LinuxHowtos.org howtos, tips&tricks and tutorials for linux

from small one page howto to huge articles all in one place

Other .linuxhowtos.org sites:gentoo.linuxhowtos.org

Last additions:

using iotop to find disk usage hogs

words:

887

views:

215077

userrating:

May 25th. 2007:

Words

486

Views

261735

why adblockers are bad

Workaround and fixes for the current Core Dump Handling vulnerability affected kernels

words:

161

views:

153956

userrating:

April, 26th. 2006:

Words

Views

110011

New subdomain: toolsntoys.linuxhowtos.org

You are here: manpages

quotactl

Section: System Calls (2)
Updated: 202-0-05
Index Return to Main Contents

NAME

quotactl, quotactl_fd - manipulate disk quotas

LIBRARY

Standard C library (libc,~-lc)

SYNOPSIS

#include <xfs/xqm.h> /* Definition of Q_X* and XFS_QUOTA_* constants
                        (or <linux/dqblk_xfs.h>; see NOTES) */
#include <sys/quota.h>
int quotactl(int op, const char *_Nullable special, int id,
             caddr_t addr);
#include <xfs/xqm.h> /* Definition of Q_X* and XFS_QUOTA_* constants
                        (or <linux/dqblk_xfs.h>; see NOTES) */
#include <sys/syscall.h>    /* Definition of SYS_* constants */
#include <unistd.h>
int syscall(SYS_quotactl_fd, int fd, int op, int id, caddr_t addr);

DESCRIPTION

The quota system can be used to set pe-user, pe-group, and pe-project limits on the amount of disk space used on a filesystem. For each user and/or group, a soft limit and a hard limit can be set for each filesystem. The hard limit can't be exceeded. The soft limit can be exceeded, but warnings will ensue. Moreover, the user can't exceed the soft limit for more than grace period duration (one week by default) at a time; after this, the soft limit counts as a hard limit. The quotactl() and quotactl_fd() calls manipulate disk quotas. The difference between these functions is the way the filesystem being manipulated is specified, see description of the arguments below. See NOTES for why one variant might be preferred over the other. The op argument indicates an operation to be applied to the user or group ID specified in id. To initialize the op argument, use the QCMD(subop, type) macro. The type value is either USRQUOTA, for user quotas, GRPQUOTA, for group quotas, or (since Linux 4.1) PRJQUOTA, for project quotas. The subop value is described below. For quotactl(), the special argument is a pointer to a nul-terminated string containing the pathname of the (mounted) block special device for the filesystem being manipulated. For quotactl_fd(), the fd argument is a file descriptor (which may be opened with the O_PATH flag) referring to a file or directory on the filesystem being manipulated. The addr argument is the address of an optional, operatio-specific, data structure that is copied in or out of the system. The interpretation of addr is given with each operation below. The subop value is one of the following operations:

Q_QUOTAON(2const): Q_QUOTAOFF(2const) Q_GETQUOTA(2const) Q_GETNEXTQUOTA(2const) Q_SETQUOTA(2const) Q_GETINFO(2const) Q_SETINFO(2const) Q_GETFMT(2const) Q_SYNC(2const) Q_GETSTATS(2const) For XFS filesystems making use of the XFS Quota Manager (XQM), the above operations are bypassed and the following operations are used:
Q_XQUOTAON(2const): Q_XQUOTAOFF(2const) Q_XGETQUOTA(2const) Q_XGETNEXTQUOTA(2const) Q_XSETQLIM(2const) Q_XGETQSTAT(2const) Q_XGETQSTATV(2const) Q_XQUOTARM(2const) Q_XQUOTASYNC(2const)

RETURN VALUE

On success, 0 is returned; on error, -1 is returned, and errno is set to indicate the error.

ERRORS

EFAULT: addr or special is invalid.
EINVAL: op or type is invalid.
ENOENT: The file specified by special or addr does not exist.
ENOSYS: The kernel has not been compiled with the CONFIG_QUOTA option.
ENOTBLK: special is not a block device.
EPERM: The caller lacked the required privilege (CAP_SYS_ADMIN) for the specified operation.
ESRCH: No disk quota is found for the indicated user. Quotas have not been turned on for this filesystem.

NOTES

Alternative XFS header

Instead of <xfs/xqm.h> one can use <linux/dqblk_xfs.h>, taking into account that there are several naming discrepancies:

[bu]: Quota enabling flags (of format XFS_QUOTA_[UGP]DQ_{ACCT,ENFD}) are defined without a leading "X", as FS_QUOTA_[UGP]DQ_{ACCT,ENFD}.
[bu]: The same is true for XFS_{USER,GROUP,PROJ}_QUOTA quota type flags, which are defined as FS_{USER,GROUP,PROJ}_QUOTA.
[bu]: The dqblk_xfs.h header file defines its own XQM_USRQUOTA, XQM_GRPQUOTA, and XQM_PRJQUOTA constants for the available quota types, but their values are the same as for constants without the XQM_ prefix.

quotactl() versus quotactl_fd()

The original quotactl() variant of this system call requires specifying the block device containing the filesystem to operate on. This makes it impossible to use in cases where the filesystem has no backing block device (e.g., tmpfs). Even when the block device does exist, it might be difficult to locate (requires scanning /proc/self/mounts and even some filesyste-specific parsing in the case of, for example, bcachefs). quotactl_fd() instead works on the mount point, which avoids this limitation and is simpler to use (since the filesystem to manipulate is typically specified by its mount point anyway).