2 * Copyright (c) 2000-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 General Public License as
7 * 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 General Public License for more details.
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
18 #ifndef __XFS_QUOTA_H__
19 #define __XFS_QUOTA_H__
24 * The ondisk form of a dquot structure.
26 #define XFS_DQUOT_MAGIC 0x4451 /* 'DQ' */
27 #define XFS_DQUOT_VERSION (u_int8_t)0x01 /* latest version number */
30 * uid_t and gid_t are hard-coded to 32 bits in the inode.
31 * Hence, an 'id' in a dquot is 32 bits..
33 typedef __uint32_t xfs_dqid_t;
36 * Even though users may not have quota limits occupying all 64-bits,
37 * they may need 64-bit accounting. Hence, 64-bit quota-counters,
38 * and quota-limits. This is a waste in the common case, but hey ...
40 typedef __uint64_t xfs_qcnt_t;
41 typedef __uint16_t xfs_qwarncnt_t;
44 * This is the main portion of the on-disk representation of quota
45 * information for a user. This is the q_core of the xfs_dquot_t that
46 * is kept in kernel memory. We pad this with some more expansion room
47 * to construct the on disk structure.
49 typedef struct xfs_disk_dquot {
50 __be16 d_magic; /* dquot magic = XFS_DQUOT_MAGIC */
51 __u8 d_version; /* dquot version */
52 __u8 d_flags; /* XFS_DQ_USER/PROJ/GROUP */
53 __be32 d_id; /* user,project,group id */
54 __be64 d_blk_hardlimit;/* absolute limit on disk blks */
55 __be64 d_blk_softlimit;/* preferred limit on disk blks */
56 __be64 d_ino_hardlimit;/* maximum # allocated inodes */
57 __be64 d_ino_softlimit;/* preferred inode limit */
58 __be64 d_bcount; /* disk blocks owned by the user */
59 __be64 d_icount; /* inodes owned by the user */
60 __be32 d_itimer; /* zero if within inode limits if not,
61 this is when we refuse service */
62 __be32 d_btimer; /* similar to above; for disk blocks */
63 __be16 d_iwarns; /* warnings issued wrt num inodes */
64 __be16 d_bwarns; /* warnings issued wrt disk blocks */
65 __be32 d_pad0; /* 64 bit align */
66 __be64 d_rtb_hardlimit;/* absolute limit on realtime blks */
67 __be64 d_rtb_softlimit;/* preferred limit on RT disk blks */
68 __be64 d_rtbcount; /* realtime blocks owned */
69 __be32 d_rtbtimer; /* similar to above; for RT disk blocks */
70 __be16 d_rtbwarns; /* warnings issued wrt RT disk blocks */
75 * This is what goes on disk. This is separated from the xfs_disk_dquot because
76 * carrying the unnecessary padding would be a waste of memory.
78 typedef struct xfs_dqblk {
79 xfs_disk_dquot_t dd_diskdq; /* portion that lives incore as well */
80 char dd_fill[32]; /* filling for posterity */
84 * flags for q_flags field in the dquot.
86 #define XFS_DQ_USER 0x0001 /* a user quota */
87 #define XFS_DQ_PROJ 0x0002 /* project quota */
88 #define XFS_DQ_GROUP 0x0004 /* a group quota */
89 #define XFS_DQ_DIRTY 0x0008 /* dquot is dirty */
90 #define XFS_DQ_WANT 0x0010 /* for lookup/reclaim race */
91 #define XFS_DQ_INACTIVE 0x0020 /* dq off mplist & hashlist */
93 #define XFS_DQ_ALLTYPES (XFS_DQ_USER|XFS_DQ_PROJ|XFS_DQ_GROUP)
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.
99 #define XFS_DQUOT_LOGRES(mp) (sizeof(xfs_disk_dquot_t) * 3)
103 * These are the structures used to lay out dquots and quotaoff
104 * records on the log. Quite similar to those of inodes.
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.
112 typedef struct xfs_dq_logformat {
113 __uint16_t qlf_type; /* dquot log item type */
114 __uint16_t qlf_size; /* size of this item */
115 xfs_dqid_t qlf_id; /* usr/grp/proj id : 32 bits */
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;
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.
129 typedef 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;
138 * Disk quotas status in m_qflags, and also sb_qflags. 16 bits.
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 */
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 */
146 #define XFS_GQUOTA_ACCT 0x0040 /* group quota accounting ON */
149 * Quota Accounting/Enforcement flags
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)
156 #define XFS_IS_QUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_ALL_QUOTA_ACCT)
157 #define XFS_IS_UQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_UQUOTA_ACCT)
158 #define XFS_IS_PQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_PQUOTA_ACCT)
159 #define XFS_IS_GQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_GQUOTA_ACCT)
160 #define XFS_IS_UQUOTA_ENFORCED(mp) ((mp)->m_qflags & XFS_UQUOTA_ENFD)
161 #define XFS_IS_OQUOTA_ENFORCED(mp) ((mp)->m_qflags & XFS_OQUOTA_ENFD)
164 * Incore only flags for quotaoff - these bits get cleared when quota(s)
165 * are in the process of getting turned off. These flags are in m_qflags but
166 * never in sb_qflags.
168 #define XFS_UQUOTA_ACTIVE 0x0100 /* uquotas are being turned off */
169 #define XFS_PQUOTA_ACTIVE 0x0200 /* pquotas are being turned off */
170 #define XFS_GQUOTA_ACTIVE 0x0400 /* gquotas are being turned off */
173 * Checking XFS_IS_*QUOTA_ON() while holding any inode lock guarantees
174 * quota will be not be switched off as long as that inode lock is held.
176 #define XFS_IS_QUOTA_ON(mp) ((mp)->m_qflags & (XFS_UQUOTA_ACTIVE | \
177 XFS_GQUOTA_ACTIVE | \
179 #define XFS_IS_OQUOTA_ON(mp) ((mp)->m_qflags & (XFS_GQUOTA_ACTIVE | \
181 #define XFS_IS_UQUOTA_ON(mp) ((mp)->m_qflags & XFS_UQUOTA_ACTIVE)
182 #define XFS_IS_GQUOTA_ON(mp) ((mp)->m_qflags & XFS_GQUOTA_ACTIVE)
183 #define XFS_IS_PQUOTA_ON(mp) ((mp)->m_qflags & XFS_PQUOTA_ACTIVE)
186 * Flags to tell various functions what to do. Not all of these are meaningful
187 * to a single function. None of these XFS_QMOPT_* flags are meant to have
188 * persistent values (ie. their values can and will change between versions)
190 #define XFS_QMOPT_DQALLOC 0x0000002 /* alloc dquot ondisk if needed */
191 #define XFS_QMOPT_UQUOTA 0x0000004 /* user dquot requested */
192 #define XFS_QMOPT_PQUOTA 0x0000008 /* project dquot requested */
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) */
199 #define XFS_QMOPT_DOWARN 0x0000400 /* increase warning cnt if needed */
200 #define XFS_QMOPT_ILOCKED 0x0000800 /* inode is already locked (excl) */
201 #define XFS_QMOPT_DQREPAIR 0x0001000 /* repair dquot if damaged */
202 #define XFS_QMOPT_GQUOTA 0x0002000 /* group dquot requested */
203 #define XFS_QMOPT_ENOSPC 0x0004000 /* enospc instead of edquot (prj) */
206 * flags to xfs_trans_mod_dquot to indicate which field needs to be
209 #define XFS_QMOPT_RES_REGBLKS 0x0010000
210 #define XFS_QMOPT_RES_RTBLKS 0x0020000
211 #define XFS_QMOPT_BCOUNT 0x0040000
212 #define XFS_QMOPT_ICOUNT 0x0080000
213 #define XFS_QMOPT_RTBCOUNT 0x0100000
214 #define XFS_QMOPT_DELBCOUNT 0x0200000
215 #define XFS_QMOPT_DELRTBCOUNT 0x0400000
216 #define XFS_QMOPT_RES_INOS 0x0800000
219 * flags for dqflush and dqflush_all.
221 #define XFS_QMOPT_SYNC 0x1000000
222 #define XFS_QMOPT_ASYNC 0x2000000
223 #define XFS_QMOPT_DELWRI 0x4000000
228 #define XFS_QMOPT_INHERIT 0x8000000
231 * flags to xfs_trans_mod_dquot.
233 #define XFS_TRANS_DQ_RES_BLKS XFS_QMOPT_RES_REGBLKS
234 #define XFS_TRANS_DQ_RES_RTBLKS XFS_QMOPT_RES_RTBLKS
235 #define XFS_TRANS_DQ_RES_INOS XFS_QMOPT_RES_INOS
236 #define XFS_TRANS_DQ_BCOUNT XFS_QMOPT_BCOUNT
237 #define XFS_TRANS_DQ_DELBCOUNT XFS_QMOPT_DELBCOUNT
238 #define XFS_TRANS_DQ_ICOUNT XFS_QMOPT_ICOUNT
239 #define XFS_TRANS_DQ_RTBCOUNT XFS_QMOPT_RTBCOUNT
240 #define XFS_TRANS_DQ_DELRTBCOUNT XFS_QMOPT_DELRTBCOUNT
243 #define XFS_QMOPT_QUOTALL \
244 (XFS_QMOPT_UQUOTA | XFS_QMOPT_PQUOTA | XFS_QMOPT_GQUOTA)
245 #define XFS_QMOPT_RESBLK_MASK (XFS_QMOPT_RES_REGBLKS | XFS_QMOPT_RES_RTBLKS)
249 * This check is done typically without holding the inode lock;
250 * that may seem racy, but it is harmless in the context that it is used.
251 * The inode cannot go inactive as long a reference is kept, and
252 * therefore if dquot(s) were attached, they'll stay consistent.
253 * If, for example, the ownership of the inode changes while
254 * we didn't have the inode locked, the appropriate dquot(s) will be
255 * attached atomically.
257 #define XFS_NOT_DQATTACHED(mp, ip) ((XFS_IS_UQUOTA_ON(mp) &&\
258 (ip)->i_udquot == NULL) || \
259 (XFS_IS_OQUOTA_ON(mp) && \
260 (ip)->i_gdquot == NULL))
262 #define XFS_QM_NEED_QUOTACHECK(mp) \
263 ((XFS_IS_UQUOTA_ON(mp) && \
264 (mp->m_sb.sb_qflags & XFS_UQUOTA_CHKD) == 0) || \
265 (XFS_IS_GQUOTA_ON(mp) && \
266 ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \
267 (mp->m_sb.sb_qflags & XFS_PQUOTA_ACCT))) || \
268 (XFS_IS_PQUOTA_ON(mp) && \
269 ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \
270 (mp->m_sb.sb_qflags & XFS_GQUOTA_ACCT))))
272 #define XFS_MOUNT_QUOTA_SET1 (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
273 XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\
274 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD)
276 #define XFS_MOUNT_QUOTA_SET2 (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
277 XFS_UQUOTA_CHKD|XFS_GQUOTA_ACCT|\
278 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD)
280 #define XFS_MOUNT_QUOTA_ALL (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
281 XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\
282 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD|\
287 * The structure kept inside the xfs_trans_t keep track of dquot changes
288 * within a transaction and apply them later.
290 typedef struct xfs_dqtrx {
291 struct xfs_dquot *qt_dquot; /* the dquot this refers to */
292 ulong qt_blk_res; /* blks reserved on a dquot */
293 ulong qt_blk_res_used; /* blks used from the reservation */
294 ulong qt_ino_res; /* inode reserved on a dquot */
295 ulong qt_ino_res_used; /* inodes used from the reservation */
296 long qt_bcount_delta; /* dquot blk count changes */
297 long qt_delbcnt_delta; /* delayed dquot blk count changes */
298 long qt_icount_delta; /* dquot inode count changes */
299 ulong qt_rtblk_res; /* # blks reserved on a dquot */
300 ulong qt_rtblk_res_used;/* # blks used from reservation */
301 long qt_rtbcount_delta;/* dquot realtime blk changes */
302 long qt_delrtb_delta; /* delayed RT blk count changes */
306 * Dquot transaction functions, used if quota is enabled.
308 typedef void (*qo_dup_dqinfo_t)(struct xfs_trans *, struct xfs_trans *);
309 typedef void (*qo_mod_dquot_byino_t)(struct xfs_trans *,
310 struct xfs_inode *, uint, long);
311 typedef void (*qo_free_dqinfo_t)(struct xfs_trans *);
312 typedef void (*qo_apply_dquot_deltas_t)(struct xfs_trans *);
313 typedef void (*qo_unreserve_and_mod_dquots_t)(struct xfs_trans *);
314 typedef int (*qo_reserve_quota_nblks_t)(
315 struct xfs_trans *, struct xfs_mount *,
316 struct xfs_inode *, long, long, uint);
317 typedef int (*qo_reserve_quota_bydquots_t)(
318 struct xfs_trans *, struct xfs_mount *,
319 struct xfs_dquot *, struct xfs_dquot *,
321 typedef struct xfs_dqtrxops {
322 qo_dup_dqinfo_t qo_dup_dqinfo;
323 qo_free_dqinfo_t qo_free_dqinfo;
324 qo_mod_dquot_byino_t qo_mod_dquot_byino;
325 qo_apply_dquot_deltas_t qo_apply_dquot_deltas;
326 qo_reserve_quota_nblks_t qo_reserve_quota_nblks;
327 qo_reserve_quota_bydquots_t qo_reserve_quota_bydquots;
328 qo_unreserve_and_mod_dquots_t qo_unreserve_and_mod_dquots;
331 #define XFS_DQTRXOP(mp, tp, op, args...) \
332 ((mp)->m_qm_ops->xfs_dqtrxops ? \
333 ((mp)->m_qm_ops->xfs_dqtrxops->op)(tp, ## args) : 0)
335 #define XFS_DQTRXOP_VOID(mp, tp, op, args...) \
336 ((mp)->m_qm_ops->xfs_dqtrxops ? \
337 ((mp)->m_qm_ops->xfs_dqtrxops->op)(tp, ## args) : (void)0)
339 #define XFS_TRANS_DUP_DQINFO(mp, otp, ntp) \
340 XFS_DQTRXOP_VOID(mp, otp, qo_dup_dqinfo, ntp)
341 #define XFS_TRANS_FREE_DQINFO(mp, tp) \
342 XFS_DQTRXOP_VOID(mp, tp, qo_free_dqinfo)
343 #define XFS_TRANS_MOD_DQUOT_BYINO(mp, tp, ip, field, delta) \
344 XFS_DQTRXOP_VOID(mp, tp, qo_mod_dquot_byino, ip, field, delta)
345 #define XFS_TRANS_APPLY_DQUOT_DELTAS(mp, tp) \
346 XFS_DQTRXOP_VOID(mp, tp, qo_apply_dquot_deltas)
347 #define XFS_TRANS_RESERVE_QUOTA_NBLKS(mp, tp, ip, nblks, ninos, fl) \
348 XFS_DQTRXOP(mp, tp, qo_reserve_quota_nblks, mp, ip, nblks, ninos, fl)
349 #define XFS_TRANS_RESERVE_QUOTA_BYDQUOTS(mp, tp, ud, gd, nb, ni, fl) \
350 XFS_DQTRXOP(mp, tp, qo_reserve_quota_bydquots, mp, ud, gd, nb, ni, fl)
351 #define XFS_TRANS_UNRESERVE_AND_MOD_DQUOTS(mp, tp) \
352 XFS_DQTRXOP_VOID(mp, tp, qo_unreserve_and_mod_dquots)
354 #define XFS_TRANS_UNRESERVE_QUOTA_NBLKS(mp, tp, ip, nblks, ninos, flags) \
355 XFS_TRANS_RESERVE_QUOTA_NBLKS(mp, tp, ip, -(nblks), -(ninos), flags)
356 #define XFS_TRANS_RESERVE_QUOTA(mp, tp, ud, gd, nb, ni, f) \
357 XFS_TRANS_RESERVE_QUOTA_BYDQUOTS(mp, tp, ud, gd, nb, ni, \
358 f | XFS_QMOPT_RES_REGBLKS)
359 #define XFS_TRANS_UNRESERVE_QUOTA(mp, tp, ud, gd, nb, ni, f) \
360 XFS_TRANS_RESERVE_QUOTA_BYDQUOTS(mp, tp, ud, gd, -(nb), -(ni), \
361 f | XFS_QMOPT_RES_REGBLKS)
363 extern int xfs_qm_dqcheck(xfs_disk_dquot_t *, xfs_dqid_t, uint, uint, char *);
364 extern int xfs_mount_reset_sbqflags(struct xfs_mount *);
366 extern struct xfs_qmops xfs_qmcore_xfs;
368 #endif /* __KERNEL__ */
370 #endif /* __XFS_QUOTA_H__ */