]> git.ipfire.org Git - thirdparty/xfsprogs-dev.git/blame - include/xfs_quota.h
Merge back recent changes from xfs kernel headers.
[thirdparty/xfsprogs-dev.git] / include / xfs_quota.h
CommitLineData
2bd0ea18 1/*
f302e9e4
NS
2 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
5000d01d 4 *
f302e9e4
NS
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
2bd0ea18 7 * published by the Free Software Foundation.
5000d01d 8 *
f302e9e4
NS
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 General Public License for more details.
5000d01d 13 *
f302e9e4
NS
14 * You should have received a copy of the GNU 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
2bd0ea18
NS
17 */
18#ifndef __XFS_QUOTA_H__
19#define __XFS_QUOTA_H__
20
eae766ca
NS
21/*
22 * The ondisk form of a dquot structure.
23 */
24#define XFS_DQUOT_MAGIC 0x4451 /* 'DQ' */
25#define XFS_DQUOT_VERSION (u_int8_t)0x01 /* latest version number */
26
5000d01d 27/*
b36eef04
NS
28 * uid_t and gid_t are hard-coded to 32 bits in the inode.
29 * Hence, an 'id' in a dquot is 32 bits..
2bd0ea18 30 */
be8e601c 31typedef __uint32_t xfs_dqid_t;
b36eef04 32
2bd0ea18 33/*
5000d01d 34 * Eventhough users may not have quota limits occupying all 64-bits,
2bd0ea18 35 * they may need 64-bit accounting. Hence, 64-bit quota-counters,
b36eef04 36 * and quota-limits. This is a waste in the common case, but hey ...
2bd0ea18
NS
37 */
38typedef __uint64_t xfs_qcnt_t;
5000d01d 39typedef __uint16_t xfs_qwarncnt_t;
2bd0ea18 40
eae766ca
NS
41/*
42 * This is the main portion of the on-disk representation of quota
43 * information for a user. This is the q_core of the xfs_dquot_t that
44 * is kept in kernel memory. We pad this with some more expansion room
45 * to construct the on disk structure.
46 */
47typedef struct xfs_disk_dquot {
f302e9e4
NS
48 __be16 d_magic; /* dquot magic = XFS_DQUOT_MAGIC */
49 __u8 d_version; /* dquot version */
50 __u8 d_flags; /* XFS_DQ_USER/PROJ/GROUP */
51 __be32 d_id; /* user,project,group id */
52 __be64 d_blk_hardlimit;/* absolute limit on disk blks */
53 __be64 d_blk_softlimit;/* preferred limit on disk blks */
54 __be64 d_ino_hardlimit;/* maximum # allocated inodes */
55 __be64 d_ino_softlimit;/* preferred inode limit */
56 __be64 d_bcount; /* disk blocks owned by the user */
57 __be64 d_icount; /* inodes owned by the user */
58 __be32 d_itimer; /* zero if within inode limits if not,
eae766ca 59 this is when we refuse service */
f302e9e4
NS
60 __be32 d_btimer; /* similar to above; for disk blocks */
61 __be16 d_iwarns; /* warnings issued wrt num inodes */
62 __be16 d_bwarns; /* warnings issued wrt disk blocks */
63 __be32 d_pad0; /* 64 bit align */
64 __be64 d_rtb_hardlimit;/* absolute limit on realtime blks */
65 __be64 d_rtb_softlimit;/* preferred limit on RT disk blks */
66 __be64 d_rtbcount; /* realtime blocks owned */
67 __be32 d_rtbtimer; /* similar to above; for RT disk blocks */
68 __be16 d_rtbwarns; /* warnings issued wrt RT disk blocks */
69 __be16 d_pad;
eae766ca
NS
70} xfs_disk_dquot_t;
71
72/*
73 * This is what goes on disk. This is separated from the xfs_disk_dquot because
74 * carrying the unnecessary padding would be a waste of memory.
75 */
76typedef struct xfs_dqblk {
77 xfs_disk_dquot_t dd_diskdq; /* portion that lives incore as well */
78 char dd_fill[32]; /* filling for posterity */
79} xfs_dqblk_t;
80
81/*
82 * flags for q_flags field in the dquot.
83 */
84#define XFS_DQ_USER 0x0001 /* a user quota */
9b27bdbb 85#define XFS_DQ_PROJ 0x0002 /* project quota */
eae766ca
NS
86#define XFS_DQ_GROUP 0x0004 /* a group quota */
87#define XFS_DQ_FLOCKED 0x0008 /* flush lock taken */
88#define XFS_DQ_DIRTY 0x0010 /* dquot is dirty */
89#define XFS_DQ_WANT 0x0020 /* for lookup/reclaim race */
90#define XFS_DQ_INACTIVE 0x0040 /* dq off mplist & hashlist */
91#define XFS_DQ_MARKER 0x0080 /* sentinel */
92
46eca962
NS
93#define XFS_DQ_ALLTYPES (XFS_DQ_USER|XFS_DQ_PROJ|XFS_DQ_GROUP)
94
eae766ca
NS
95/*
96 * In the worst case, when both user and group quotas are on,
97 * we can have a max of three dquots changing in a single transaction.
98 */
99#define XFS_DQUOT_LOGRES(mp) (sizeof(xfs_disk_dquot_t) * 3)
100
101
102/*
103 * These are the structures used to lay out dquots and quotaoff
104 * records on the log. Quite similar to those of inodes.
105 */
106
107/*
108 * log format struct for dquots.
109 * The first two fields must be the type and size fitting into
110 * 32 bits : log_recovery code assumes that.
111 */
112typedef struct xfs_dq_logformat {
113 __uint16_t qlf_type; /* dquot log item type */
114 __uint16_t qlf_size; /* size of this item */
46eca962 115 xfs_dqid_t qlf_id; /* usr/grp/proj id : 32 bits */
eae766ca
NS
116 __int64_t qlf_blkno; /* blkno of dquot buffer */
117 __int32_t qlf_len; /* len of dquot buffer */
118 __uint32_t qlf_boffset; /* off of dquot in buffer */
119} xfs_dq_logformat_t;
120
121/*
122 * log format struct for QUOTAOFF records.
123 * The first two fields must be the type and size fitting into
124 * 32 bits : log_recovery code assumes that.
125 * We write two LI_QUOTAOFF logitems per quotaoff, the last one keeps a pointer
126 * to the first and ensures that the first logitem is taken out of the AIL
127 * only when the last one is securely committed.
128 */
129typedef struct xfs_qoff_logformat {
130 unsigned short qf_type; /* quotaoff log item type */
131 unsigned short qf_size; /* size of this item */
132 unsigned int qf_flags; /* USR and/or GRP */
133 char qf_pad[12]; /* padding for future */
134} xfs_qoff_logformat_t;
135
136
5000d01d 137/*
2bd0ea18
NS
138 * Disk quotas status in m_qflags, and also sb_qflags. 16 bits.
139 */
dfc130f3
RC
140#define XFS_UQUOTA_ACCT 0x0001 /* user quota accounting ON */
141#define XFS_UQUOTA_ENFD 0x0002 /* user quota limits enforced */
142#define XFS_UQUOTA_CHKD 0x0004 /* quotacheck run on usr quotas */
46eca962
NS
143#define XFS_PQUOTA_ACCT 0x0008 /* project quota accounting ON */
144#define XFS_OQUOTA_ENFD 0x0010 /* other (grp/prj) quota limits enforced */
145#define XFS_OQUOTA_CHKD 0x0020 /* quotacheck run on other (grp/prj) quotas */
dfc130f3 146#define XFS_GQUOTA_ACCT 0x0040 /* group quota accounting ON */
5000d01d 147
f302e9e4
NS
148/*
149 * Quota Accounting/Enforcement flags
150 */
151#define XFS_ALL_QUOTA_ACCT \
152 (XFS_UQUOTA_ACCT | XFS_GQUOTA_ACCT | XFS_PQUOTA_ACCT)
153#define XFS_ALL_QUOTA_ENFD (XFS_UQUOTA_ENFD | XFS_OQUOTA_ENFD)
154#define XFS_ALL_QUOTA_CHKD (XFS_UQUOTA_CHKD | XFS_OQUOTA_CHKD)
155
156#define XFS_IS_QUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_ALL_QUOTA_ACCT)
157#define XFS_IS_QUOTA_ENFORCED(mp) ((mp)->m_qflags & XFS_ALL_QUOTA_ENFD)
158#define XFS_IS_UQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_UQUOTA_ACCT)
159#define XFS_IS_PQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_PQUOTA_ACCT)
160#define XFS_IS_GQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_GQUOTA_ACCT)
161
5000d01d 162/*
2bd0ea18
NS
163 * Incore only flags for quotaoff - these bits get cleared when quota(s)
164 * are in the process of getting turned off. These flags are in m_qflags but
165 * never in sb_qflags.
166 */
46eca962
NS
167#define XFS_UQUOTA_ACTIVE 0x0100 /* uquotas are being turned off */
168#define XFS_PQUOTA_ACTIVE 0x0200 /* pquotas are being turned off */
169#define XFS_GQUOTA_ACTIVE 0x0400 /* gquotas are being turned off */
2bd0ea18 170
2bd0ea18
NS
171/*
172 * Checking XFS_IS_*QUOTA_ON() while holding any inode lock guarantees
173 * quota will be not be switched off as long as that inode lock is held.
174 */
5000d01d 175#define XFS_IS_QUOTA_ON(mp) ((mp)->m_qflags & (XFS_UQUOTA_ACTIVE | \
46eca962
NS
176 XFS_GQUOTA_ACTIVE | \
177 XFS_PQUOTA_ACTIVE))
178#define XFS_IS_OQUOTA_ON(mp) ((mp)->m_qflags & (XFS_GQUOTA_ACTIVE | \
179 XFS_PQUOTA_ACTIVE))
2bd0ea18 180#define XFS_IS_UQUOTA_ON(mp) ((mp)->m_qflags & XFS_UQUOTA_ACTIVE)
5000d01d 181#define XFS_IS_GQUOTA_ON(mp) ((mp)->m_qflags & XFS_GQUOTA_ACTIVE)
46eca962 182#define XFS_IS_PQUOTA_ON(mp) ((mp)->m_qflags & XFS_PQUOTA_ACTIVE)
2bd0ea18
NS
183
184/*
185 * Flags to tell various functions what to do. Not all of these are meaningful
186 * to a single function. None of these XFS_QMOPT_* flags are meant to have
187 * persistent values (ie. their values can and will change between versions)
188 */
189#define XFS_QMOPT_DQLOCK 0x0000001 /* dqlock */
190#define XFS_QMOPT_DQALLOC 0x0000002 /* alloc dquot ondisk if needed */
191#define XFS_QMOPT_UQUOTA 0x0000004 /* user dquot requested */
46eca962 192#define XFS_QMOPT_PQUOTA 0x0000008 /* project dquot requested */
2bd0ea18
NS
193#define XFS_QMOPT_FORCE_RES 0x0000010 /* ignore quota limits */
194#define XFS_QMOPT_DQSUSER 0x0000020 /* don't cache super users dquot */
195#define XFS_QMOPT_SBVERSION 0x0000040 /* change superblock version num */
196#define XFS_QMOPT_QUOTAOFF 0x0000080 /* quotas are being turned off */
197#define XFS_QMOPT_UMOUNTING 0x0000100 /* filesys is being unmounted */
198#define XFS_QMOPT_DOLOG 0x0000200 /* log buf changes (in quotacheck) */
dfc130f3 199#define XFS_QMOPT_DOWARN 0x0000400 /* increase warning cnt if necessary */
2bd0ea18
NS
200#define XFS_QMOPT_ILOCKED 0x0000800 /* inode is already locked (excl) */
201#define XFS_QMOPT_DQREPAIR 0x0001000 /* repair dquot, if damaged. */
46eca962 202#define XFS_QMOPT_GQUOTA 0x0002000 /* group dquot requested */
2bd0ea18 203
5000d01d 204/*
2bd0ea18
NS
205 * flags to xfs_trans_mod_dquot to indicate which field needs to be
206 * modified.
207 */
5000d01d 208#define XFS_QMOPT_RES_REGBLKS 0x0010000
2bd0ea18
NS
209#define XFS_QMOPT_RES_RTBLKS 0x0020000
210#define XFS_QMOPT_BCOUNT 0x0040000
211#define XFS_QMOPT_ICOUNT 0x0080000
212#define XFS_QMOPT_RTBCOUNT 0x0100000
213#define XFS_QMOPT_DELBCOUNT 0x0200000
214#define XFS_QMOPT_DELRTBCOUNT 0x0400000
215#define XFS_QMOPT_RES_INOS 0x0800000
216
217/*
218 * flags for dqflush and dqflush_all.
219 */
220#define XFS_QMOPT_SYNC 0x1000000
221#define XFS_QMOPT_ASYNC 0x2000000
222#define XFS_QMOPT_DELWRI 0x4000000
223
7e039a24
NS
224/*
225 * flags for dqalloc.
226 */
227#define XFS_QMOPT_INHERIT 0x8000000
228
5000d01d 229/*
2bd0ea18
NS
230 * flags to xfs_trans_mod_dquot.
231 */
232#define XFS_TRANS_DQ_RES_BLKS XFS_QMOPT_RES_REGBLKS
dfc130f3 233#define XFS_TRANS_DQ_RES_RTBLKS XFS_QMOPT_RES_RTBLKS
2bd0ea18
NS
234#define XFS_TRANS_DQ_RES_INOS XFS_QMOPT_RES_INOS
235#define XFS_TRANS_DQ_BCOUNT XFS_QMOPT_BCOUNT
236#define XFS_TRANS_DQ_DELBCOUNT XFS_QMOPT_DELBCOUNT
237#define XFS_TRANS_DQ_ICOUNT XFS_QMOPT_ICOUNT
238#define XFS_TRANS_DQ_RTBCOUNT XFS_QMOPT_RTBCOUNT
239#define XFS_TRANS_DQ_DELRTBCOUNT XFS_QMOPT_DELRTBCOUNT
240
241
46eca962
NS
242#define XFS_QMOPT_QUOTALL \
243 (XFS_QMOPT_UQUOTA | XFS_QMOPT_PQUOTA | XFS_QMOPT_GQUOTA)
2bd0ea18
NS
244#define XFS_QMOPT_RESBLK_MASK (XFS_QMOPT_RES_REGBLKS | XFS_QMOPT_RES_RTBLKS)
245
eae766ca 246#ifdef __KERNEL__
2bd0ea18
NS
247/*
248 * This check is done typically without holding the inode lock;
249 * that may seem racey, but it is harmless in the context that it is used.
5000d01d 250 * The inode cannot go inactive as long a reference is kept, and
2bd0ea18
NS
251 * therefore if dquot(s) were attached, they'll stay consistent.
252 * If, for example, the ownership of the inode changes while
eae766ca 253 * we didn't have the inode locked, the appropriate dquot(s) will be
2bd0ea18
NS
254 * attached atomically.
255 */
256#define XFS_NOT_DQATTACHED(mp, ip) ((XFS_IS_UQUOTA_ON(mp) &&\
257 (ip)->i_udquot == NULL) || \
46eca962 258 (XFS_IS_OQUOTA_ON(mp) && \
b36eef04 259 (ip)->i_gdquot == NULL))
2bd0ea18 260
f302e9e4
NS
261#define XFS_QM_NEED_QUOTACHECK(mp) \
262 ((XFS_IS_UQUOTA_ON(mp) && \
263 (mp->m_sb.sb_qflags & XFS_UQUOTA_CHKD) == 0) || \
264 (XFS_IS_GQUOTA_ON(mp) && \
265 ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \
266 (mp->m_sb.sb_qflags & XFS_PQUOTA_ACCT))) || \
267 (XFS_IS_PQUOTA_ON(mp) && \
268 ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \
269 (mp->m_sb.sb_qflags & XFS_GQUOTA_ACCT))))
2bd0ea18 270
46eca962
NS
271#define XFS_MOUNT_QUOTA_SET1 (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
272 XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\
273 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD)
274
275#define XFS_MOUNT_QUOTA_SET2 (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
b36eef04 276 XFS_UQUOTA_CHKD|XFS_GQUOTA_ACCT|\
46eca962
NS
277 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD)
278
279#define XFS_MOUNT_QUOTA_ALL (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
280 XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\
281 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD|\
282 XFS_GQUOTA_ACCT)
2bd0ea18 283#define XFS_MOUNT_QUOTA_MASK (XFS_MOUNT_QUOTA_ALL | XFS_UQUOTA_ACTIVE | \
46eca962 284 XFS_GQUOTA_ACTIVE | XFS_PQUOTA_ACTIVE)
2bd0ea18 285
2bd0ea18 286
2bd0ea18 287/*
eae766ca
NS
288 * The structure kept inside the xfs_trans_t keep track of dquot changes
289 * within a transaction and apply them later.
2bd0ea18 290 */
eae766ca
NS
291typedef struct xfs_dqtrx {
292 struct xfs_dquot *qt_dquot; /* the dquot this refers to */
293 ulong qt_blk_res; /* blks reserved on a dquot */
294 ulong qt_blk_res_used; /* blks used from the reservation */
295 ulong qt_ino_res; /* inode reserved on a dquot */
296 ulong qt_ino_res_used; /* inodes used from the reservation */
297 long qt_bcount_delta; /* dquot blk count changes */
298 long qt_delbcnt_delta; /* delayed dquot blk count changes */
299 long qt_icount_delta; /* dquot inode count changes */
300 ulong qt_rtblk_res; /* # blks reserved on a dquot */
301 ulong qt_rtblk_res_used;/* # blks used from reservation */
302 long qt_rtbcount_delta;/* dquot realtime blk changes */
303 long qt_delrtb_delta; /* delayed RT blk count changes */
304} xfs_dqtrx_t;
2bd0ea18
NS
305
306/*
eae766ca 307 * Dquot transaction functions, used if quota is enabled.
2bd0ea18 308 */
eae766ca
NS
309typedef void (*qo_dup_dqinfo_t)(struct xfs_trans *, struct xfs_trans *);
310typedef void (*qo_mod_dquot_byino_t)(struct xfs_trans *,
311 struct xfs_inode *, uint, long);
312typedef void (*qo_free_dqinfo_t)(struct xfs_trans *);
313typedef void (*qo_apply_dquot_deltas_t)(struct xfs_trans *);
314typedef void (*qo_unreserve_and_mod_dquots_t)(struct xfs_trans *);
315typedef int (*qo_reserve_quota_nblks_t)(
316 struct xfs_trans *, struct xfs_mount *,
317 struct xfs_inode *, long, long, uint);
318typedef int (*qo_reserve_quota_bydquots_t)(
319 struct xfs_trans *, struct xfs_mount *,
320 struct xfs_dquot *, struct xfs_dquot *,
321 long, long, uint);
322typedef struct xfs_dqtrxops {
323 qo_dup_dqinfo_t qo_dup_dqinfo;
324 qo_free_dqinfo_t qo_free_dqinfo;
325 qo_mod_dquot_byino_t qo_mod_dquot_byino;
326 qo_apply_dquot_deltas_t qo_apply_dquot_deltas;
327 qo_reserve_quota_nblks_t qo_reserve_quota_nblks;
328 qo_reserve_quota_bydquots_t qo_reserve_quota_bydquots;
329 qo_unreserve_and_mod_dquots_t qo_unreserve_and_mod_dquots;
330} xfs_dqtrxops_t;
331
332#define XFS_DQTRXOP(mp, tp, op, args...) \
062998e3
NS
333 ((mp)->m_qm_ops.xfs_dqtrxops ? \
334 ((mp)->m_qm_ops.xfs_dqtrxops->op)(tp, ## args) : 0)
335
336#define XFS_DQTRXOP_VOID(mp, tp, op, args...) \
337 ((mp)->m_qm_ops.xfs_dqtrxops ? \
338 ((mp)->m_qm_ops.xfs_dqtrxops->op)(tp, ## args) : (void)0)
eae766ca
NS
339
340#define XFS_TRANS_DUP_DQINFO(mp, otp, ntp) \
062998e3 341 XFS_DQTRXOP_VOID(mp, otp, qo_dup_dqinfo, ntp)
eae766ca 342#define XFS_TRANS_FREE_DQINFO(mp, tp) \
062998e3 343 XFS_DQTRXOP_VOID(mp, tp, qo_free_dqinfo)
eae766ca 344#define XFS_TRANS_MOD_DQUOT_BYINO(mp, tp, ip, field, delta) \
062998e3 345 XFS_DQTRXOP_VOID(mp, tp, qo_mod_dquot_byino, ip, field, delta)
eae766ca 346#define XFS_TRANS_APPLY_DQUOT_DELTAS(mp, tp) \
062998e3 347 XFS_DQTRXOP_VOID(mp, tp, qo_apply_dquot_deltas)
eae766ca
NS
348#define XFS_TRANS_RESERVE_QUOTA_NBLKS(mp, tp, ip, nblks, ninos, fl) \
349 XFS_DQTRXOP(mp, tp, qo_reserve_quota_nblks, mp, ip, nblks, ninos, fl)
350#define XFS_TRANS_RESERVE_QUOTA_BYDQUOTS(mp, tp, ud, gd, nb, ni, fl) \
351 XFS_DQTRXOP(mp, tp, qo_reserve_quota_bydquots, mp, ud, gd, nb, ni, fl)
352#define XFS_TRANS_UNRESERVE_AND_MOD_DQUOTS(mp, tp) \
062998e3 353 XFS_DQTRXOP_VOID(mp, tp, qo_unreserve_and_mod_dquots)
eae766ca 354
f302e9e4
NS
355#define XFS_TRANS_UNRESERVE_QUOTA_NBLKS(mp, tp, ip, nblks, ninos, flags) \
356 XFS_TRANS_RESERVE_QUOTA_NBLKS(mp, tp, ip, -(nblks), -(ninos), flags)
eae766ca
NS
357#define XFS_TRANS_RESERVE_QUOTA(mp, tp, ud, gd, nb, ni, f) \
358 XFS_TRANS_RESERVE_QUOTA_BYDQUOTS(mp, tp, ud, gd, nb, ni, \
359 f | XFS_QMOPT_RES_REGBLKS)
360#define XFS_TRANS_UNRESERVE_QUOTA(mp, tp, ud, gd, nb, ni, f) \
361 XFS_TRANS_RESERVE_QUOTA_BYDQUOTS(mp, tp, ud, gd, -(nb), -(ni), \
362 f | XFS_QMOPT_RES_REGBLKS)
363
364extern int xfs_qm_dqcheck(xfs_disk_dquot_t *, xfs_dqid_t, uint, uint, char *);
f302e9e4 365extern int xfs_mount_reset_sbqflags(struct xfs_mount *);
eae766ca
NS
366
367extern struct bhv_vfsops xfs_qmops;
368
2bd0ea18
NS
369#endif /* __KERNEL__ */
370
371#endif /* __XFS_QUOTA_H__ */