]>
git.ipfire.org Git - thirdparty/xfsprogs-dev.git/blob - include/xqm.h
2 * Copyright (c) 1995, 2001, 2004-2005 Silicon Graphics, Inc.
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public License
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it would be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this program; if not, write the Free Software Foundation,
16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 * Disk quota - quotactl(2) commands for the XFS Quota Manager (XQM).
27 #define XQM_CMD(x) (('X'<<8)+(x)) /* note: forms first QCMD argument */
28 #define Q_XQUOTAON XQM_CMD(1) /* enable accounting/enforcement */
29 #define Q_XQUOTAOFF XQM_CMD(2) /* disable accounting/enforcement */
30 #define Q_XGETQUOTA XQM_CMD(3) /* get disk limits and usage */
31 #define Q_XSETQLIM XQM_CMD(4) /* set disk limits */
32 #define Q_XGETQSTAT XQM_CMD(5) /* get quota subsystem status */
33 #define Q_XQUOTARM XQM_CMD(6) /* free disk space used by dquots */
34 #define Q_XQUOTASYNC XQM_CMD(7) /* delalloc flush, updates dquots */
35 #define Q_XGETQSTATV XQM_CMD(8) /* newer version of get quota */
36 #define Q_XGETNEXTQUOTA XQM_CMD(9) /* get disk limits and usage */
39 * fs_disk_quota structure:
41 * This contains the current quota information regarding a user/proj/group.
42 * It is 64-bit aligned, and all the blk units are in BBs (Basic Blocks) of
45 #define FS_DQUOT_VERSION 1 /* fs_disk_quota.d_version */
46 typedef struct fs_disk_quota
{
47 __s8 d_version
; /* version of this structure */
48 __s8 d_flags
; /* XFS_{USER,PROJ,GROUP}_QUOTA */
49 __u16 d_fieldmask
; /* field specifier */
50 __u32 d_id
; /* user, project, or group ID */
51 __u64 d_blk_hardlimit
;/* absolute limit on disk blks */
52 __u64 d_blk_softlimit
;/* preferred limit on disk blks */
53 __u64 d_ino_hardlimit
;/* maximum # allocated inodes */
54 __u64 d_ino_softlimit
;/* preferred inode limit */
55 __u64 d_bcount
; /* # disk blocks owned by the user */
56 __u64 d_icount
; /* # inodes owned by the user */
57 __s32 d_itimer
; /* zero if within inode limits */
58 /* if not, we refuse service */
59 __s32 d_btimer
; /* similar to above; for disk blocks */
60 __u16 d_iwarns
; /* # warnings issued wrt num inodes */
61 __u16 d_bwarns
; /* # warnings issued wrt disk blocks */
62 __s32 d_padding2
; /* padding2 - for future use */
63 __u64 d_rtb_hardlimit
;/* absolute limit on realtime blks */
64 __u64 d_rtb_softlimit
;/* preferred limit on RT disk blks */
65 __u64 d_rtbcount
; /* # realtime blocks owned */
66 __s32 d_rtbtimer
; /* similar to above; for RT disk blks */
67 __u16 d_rtbwarns
; /* # warnings issued wrt RT disk blks */
68 __s16 d_padding3
; /* padding3 - for future use */
69 char d_padding4
[8]; /* yet more padding */
73 * These fields are sent to Q_XSETQLIM to specify fields that need to change.
75 #define FS_DQ_ISOFT (1<<0)
76 #define FS_DQ_IHARD (1<<1)
77 #define FS_DQ_BSOFT (1<<2)
78 #define FS_DQ_BHARD (1<<3)
79 #define FS_DQ_RTBSOFT (1<<4)
80 #define FS_DQ_RTBHARD (1<<5)
81 #define FS_DQ_LIMIT_MASK (FS_DQ_ISOFT | FS_DQ_IHARD | FS_DQ_BSOFT | \
82 FS_DQ_BHARD | FS_DQ_RTBSOFT | FS_DQ_RTBHARD)
84 * These timers can only be set in super user's dquot. For others, timers are
85 * automatically started and stopped. Superusers timer values set the limits
86 * for the rest. In case these values are zero, the DQ_{F,B}TIMELIMIT values
87 * defined below are used.
88 * These values also apply only to the d_fieldmask field for Q_XSETQLIM.
90 #define FS_DQ_BTIMER (1<<6)
91 #define FS_DQ_ITIMER (1<<7)
92 #define FS_DQ_RTBTIMER (1<<8)
93 #define FS_DQ_TIMER_MASK (FS_DQ_BTIMER | FS_DQ_ITIMER | FS_DQ_RTBTIMER)
96 * Warning counts are set in both super user's dquot and others. For others,
97 * warnings are set/cleared by the administrators (or automatically by going
98 * below the soft limit). Superusers warning values set the warning limits
99 * for the rest. In case these values are zero, the DQ_{F,B}WARNLIMIT values
100 * defined below are used.
101 * These values also apply only to the d_fieldmask field for Q_XSETQLIM.
103 #define FS_DQ_BWARNS (1<<9)
104 #define FS_DQ_IWARNS (1<<10)
105 #define FS_DQ_RTBWARNS (1<<11)
106 #define FS_DQ_WARNS_MASK (FS_DQ_BWARNS | FS_DQ_IWARNS | FS_DQ_RTBWARNS)
109 * Various flags related to quotactl(2). Only relevant to XFS filesystems.
111 #define XFS_QUOTA_UDQ_ACCT (1<<0) /* user quota accounting */
112 #define XFS_QUOTA_UDQ_ENFD (1<<1) /* user quota limits enforcement */
113 #define XFS_QUOTA_GDQ_ACCT (1<<2) /* group quota accounting */
114 #define XFS_QUOTA_GDQ_ENFD (1<<3) /* group quota limits enforcement */
115 #define XFS_QUOTA_PDQ_ACCT (1<<4) /* project quota accounting */
116 #define XFS_QUOTA_PDQ_ENFD (1<<5) /* project quota limits enforcement */
118 #define XFS_USER_QUOTA (1<<0) /* user quota type */
119 #define XFS_PROJ_QUOTA (1<<1) /* project quota type */
120 #define XFS_GROUP_QUOTA (1<<2) /* group quota type */
123 * fs_quota_stat is the struct returned in Q_XGETQSTAT for a given file system.
124 * Provides a centralized way to get meta information about the quota subsystem.
125 * eg. space taken up for user and group quotas, number of dquots currently
128 #define FS_QSTAT_VERSION 1 /* fs_quota_stat.qs_version */
131 * Some basic information about 'quota files'.
133 typedef struct fs_qfilestat
{
134 __u64 qfs_ino
; /* inode number */
135 __u64 qfs_nblks
; /* number of BBs 512-byte-blks */
136 __u32 qfs_nextents
; /* number of extents */
139 typedef struct fs_quota_stat
{
140 __s8 qs_version
; /* version number for future changes */
141 __u16 qs_flags
; /* XFS_QUOTA_{U,P,G}DQ_{ACCT,ENFD} */
142 __s8 qs_pad
; /* unused */
143 fs_qfilestat_t qs_uquota
; /* user quota storage information */
144 fs_qfilestat_t qs_gquota
; /* group quota storage information */
145 __u32 qs_incoredqs
; /* number of dquots incore */
146 __s32 qs_btimelimit
; /* limit for blks timer */
147 __s32 qs_itimelimit
; /* limit for inodes timer */
148 __s32 qs_rtbtimelimit
;/* limit for rt blks timer */
149 __u16 qs_bwarnlimit
; /* limit for num warnings */
150 __u16 qs_iwarnlimit
; /* limit for num warnings */
154 #ifndef FS_QSTATV_VERSION1
155 #define FS_QSTATV_VERSION1 1 /* fs_quota_statv.qs_version */
159 * Some basic information about 'quota files' for Q_XGETQSTATV command
161 struct fs_qfilestatv
{
162 __u64 qfs_ino
; /* inode number */
163 __u64 qfs_nblks
; /* number of BBs 512-byte-blks */
164 __u32 qfs_nextents
; /* number of extents */
165 __u32 qfs_pad
; /* pad for 8-byte alignment */
168 struct fs_quota_statv
{
169 __s8 qs_version
; /* version for future changes */
170 __u8 qs_pad1
; /* pad for 16bit alignment */
171 __u16 qs_flags
; /* FS_QUOTA_.* flags */
172 __u32 qs_incoredqs
; /* number of dquots incore */
173 struct fs_qfilestatv qs_uquota
; /* user quota information */
174 struct fs_qfilestatv qs_gquota
; /* group quota information */
175 struct fs_qfilestatv qs_pquota
; /* project quota information */
176 __s32 qs_btimelimit
; /* limit for blks timer */
177 __s32 qs_itimelimit
; /* limit for inodes timer */
178 __s32 qs_rtbtimelimit
;/* limit for rt blks timer */
179 __u16 qs_bwarnlimit
; /* limit for num warnings */
180 __u16 qs_iwarnlimit
; /* limit for num warnings */
181 __u64 qs_pad2
[8]; /* for future proofing */
184 #endif /* __XQM_H__ */