Merge tag 'renesas-pinctrl-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6-block.git] / fs / xfs / xfs_quota.h
CommitLineData
1da177e4 1/*
7b718769
NS
2 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
1da177e4 4 *
7b718769
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
1da177e4
LT
7 * published by the Free Software Foundation.
8 *
7b718769
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.
1da177e4 13 *
7b718769
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
1da177e4
LT
17 */
18#ifndef __XFS_QUOTA_H__
19#define __XFS_QUOTA_H__
20
fcafb71b
CH
21struct xfs_trans;
22
1da177e4
LT
23/*
24 * The ondisk form of a dquot structure.
25 */
26#define XFS_DQUOT_MAGIC 0x4451 /* 'DQ' */
27#define XFS_DQUOT_VERSION (u_int8_t)0x01 /* latest version number */
28
29/*
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..
32 */
c310ab6c 33typedef __uint32_t xfs_dqid_t;
1da177e4
LT
34
35/*
c41564b5 36 * Even though users may not have quota limits occupying all 64-bits,
1da177e4
LT
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 ...
39 */
40typedef __uint64_t xfs_qcnt_t;
41typedef __uint16_t xfs_qwarncnt_t;
42
43/*
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.
48 */
49typedef struct xfs_disk_dquot {
1149d96a
CH
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,
1da177e4 61 this is when we refuse service */
1149d96a
CH
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 */
71 __be16 d_pad;
1da177e4
LT
72} xfs_disk_dquot_t;
73
74/*
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.
77 */
78typedef struct xfs_dqblk {
79 xfs_disk_dquot_t dd_diskdq; /* portion that lives incore as well */
3fe58f30
CH
80 char dd_fill[4]; /* filling for posterity */
81
82 /*
83 * These two are only present on filesystems with the CRC bits set.
84 */
85 __be32 dd_crc; /* checksum */
86 __be64 dd_lsn; /* last modification in log */
87 uuid_t dd_uuid; /* location information */
1da177e4
LT
88} xfs_dqblk_t;
89
90/*
91 * flags for q_flags field in the dquot.
92 */
93#define XFS_DQ_USER 0x0001 /* a user quota */
c8ad20ff 94#define XFS_DQ_PROJ 0x0002 /* project quota */
1da177e4 95#define XFS_DQ_GROUP 0x0004 /* a group quota */
df6771bd 96#define XFS_DQ_DIRTY 0x0008 /* dquot is dirty */
92678554 97#define XFS_DQ_FREEING 0x0010 /* dquot is beeing torn down */
1da177e4 98
c8ad20ff
NS
99#define XFS_DQ_ALLTYPES (XFS_DQ_USER|XFS_DQ_PROJ|XFS_DQ_GROUP)
100
0b1b213f
CH
101#define XFS_DQ_FLAGS \
102 { XFS_DQ_USER, "USER" }, \
103 { XFS_DQ_PROJ, "PROJ" }, \
104 { XFS_DQ_GROUP, "GROUP" }, \
92678554
CH
105 { XFS_DQ_DIRTY, "DIRTY" }, \
106 { XFS_DQ_FREEING, "FREEING" }
0b1b213f 107
1da177e4
LT
108/*
109 * In the worst case, when both user and group quotas are on,
110 * we can have a max of three dquots changing in a single transaction.
111 */
112#define XFS_DQUOT_LOGRES(mp) (sizeof(xfs_disk_dquot_t) * 3)
113
114
115/*
116 * These are the structures used to lay out dquots and quotaoff
117 * records on the log. Quite similar to those of inodes.
118 */
119
120/*
121 * log format struct for dquots.
122 * The first two fields must be the type and size fitting into
123 * 32 bits : log_recovery code assumes that.
124 */
125typedef struct xfs_dq_logformat {
126 __uint16_t qlf_type; /* dquot log item type */
127 __uint16_t qlf_size; /* size of this item */
c8ad20ff 128 xfs_dqid_t qlf_id; /* usr/grp/proj id : 32 bits */
1da177e4
LT
129 __int64_t qlf_blkno; /* blkno of dquot buffer */
130 __int32_t qlf_len; /* len of dquot buffer */
131 __uint32_t qlf_boffset; /* off of dquot in buffer */
132} xfs_dq_logformat_t;
133
134/*
135 * log format struct for QUOTAOFF records.
136 * The first two fields must be the type and size fitting into
137 * 32 bits : log_recovery code assumes that.
138 * We write two LI_QUOTAOFF logitems per quotaoff, the last one keeps a pointer
139 * to the first and ensures that the first logitem is taken out of the AIL
140 * only when the last one is securely committed.
141 */
142typedef struct xfs_qoff_logformat {
143 unsigned short qf_type; /* quotaoff log item type */
144 unsigned short qf_size; /* size of this item */
145 unsigned int qf_flags; /* USR and/or GRP */
146 char qf_pad[12]; /* padding for future */
147} xfs_qoff_logformat_t;
148
149
150/*
151 * Disk quotas status in m_qflags, and also sb_qflags. 16 bits.
152 */
153#define XFS_UQUOTA_ACCT 0x0001 /* user quota accounting ON */
154#define XFS_UQUOTA_ENFD 0x0002 /* user quota limits enforced */
155#define XFS_UQUOTA_CHKD 0x0004 /* quotacheck run on usr quotas */
c8ad20ff
NS
156#define XFS_PQUOTA_ACCT 0x0008 /* project quota accounting ON */
157#define XFS_OQUOTA_ENFD 0x0010 /* other (grp/prj) quota limits enforced */
158#define XFS_OQUOTA_CHKD 0x0020 /* quotacheck run on other (grp/prj) quotas */
1da177e4
LT
159#define XFS_GQUOTA_ACCT 0x0040 /* group quota accounting ON */
160
4cd4a034
TS
161/*
162 * Quota Accounting/Enforcement flags
163 */
164#define XFS_ALL_QUOTA_ACCT \
165 (XFS_UQUOTA_ACCT | XFS_GQUOTA_ACCT | XFS_PQUOTA_ACCT)
166#define XFS_ALL_QUOTA_ENFD (XFS_UQUOTA_ENFD | XFS_OQUOTA_ENFD)
167#define XFS_ALL_QUOTA_CHKD (XFS_UQUOTA_CHKD | XFS_OQUOTA_CHKD)
168
169#define XFS_IS_QUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_ALL_QUOTA_ACCT)
4cd4a034
TS
170#define XFS_IS_UQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_UQUOTA_ACCT)
171#define XFS_IS_PQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_PQUOTA_ACCT)
172#define XFS_IS_GQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_GQUOTA_ACCT)
e6d29426
KO
173#define XFS_IS_UQUOTA_ENFORCED(mp) ((mp)->m_qflags & XFS_UQUOTA_ENFD)
174#define XFS_IS_OQUOTA_ENFORCED(mp) ((mp)->m_qflags & XFS_OQUOTA_ENFD)
4cd4a034 175
1da177e4
LT
176/*
177 * Incore only flags for quotaoff - these bits get cleared when quota(s)
178 * are in the process of getting turned off. These flags are in m_qflags but
179 * never in sb_qflags.
180 */
c8ad20ff
NS
181#define XFS_UQUOTA_ACTIVE 0x0100 /* uquotas are being turned off */
182#define XFS_PQUOTA_ACTIVE 0x0200 /* pquotas are being turned off */
183#define XFS_GQUOTA_ACTIVE 0x0400 /* gquotas are being turned off */
4177af3a
CS
184#define XFS_ALL_QUOTA_ACTIVE \
185 (XFS_UQUOTA_ACTIVE | XFS_PQUOTA_ACTIVE | XFS_GQUOTA_ACTIVE)
1da177e4
LT
186
187/*
188 * Checking XFS_IS_*QUOTA_ON() while holding any inode lock guarantees
189 * quota will be not be switched off as long as that inode lock is held.
190 */
191#define XFS_IS_QUOTA_ON(mp) ((mp)->m_qflags & (XFS_UQUOTA_ACTIVE | \
c8ad20ff
NS
192 XFS_GQUOTA_ACTIVE | \
193 XFS_PQUOTA_ACTIVE))
194#define XFS_IS_OQUOTA_ON(mp) ((mp)->m_qflags & (XFS_GQUOTA_ACTIVE | \
195 XFS_PQUOTA_ACTIVE))
1da177e4
LT
196#define XFS_IS_UQUOTA_ON(mp) ((mp)->m_qflags & XFS_UQUOTA_ACTIVE)
197#define XFS_IS_GQUOTA_ON(mp) ((mp)->m_qflags & XFS_GQUOTA_ACTIVE)
c8ad20ff 198#define XFS_IS_PQUOTA_ON(mp) ((mp)->m_qflags & XFS_PQUOTA_ACTIVE)
1da177e4
LT
199
200/*
201 * Flags to tell various functions what to do. Not all of these are meaningful
202 * to a single function. None of these XFS_QMOPT_* flags are meant to have
203 * persistent values (ie. their values can and will change between versions)
204 */
1da177e4
LT
205#define XFS_QMOPT_DQALLOC 0x0000002 /* alloc dquot ondisk if needed */
206#define XFS_QMOPT_UQUOTA 0x0000004 /* user dquot requested */
c8ad20ff 207#define XFS_QMOPT_PQUOTA 0x0000008 /* project dquot requested */
1da177e4 208#define XFS_QMOPT_FORCE_RES 0x0000010 /* ignore quota limits */
1da177e4 209#define XFS_QMOPT_SBVERSION 0x0000040 /* change superblock version num */
9a2a7de2 210#define XFS_QMOPT_DOWARN 0x0000400 /* increase warning cnt if needed */
9a2a7de2 211#define XFS_QMOPT_DQREPAIR 0x0001000 /* repair dquot if damaged */
c8ad20ff 212#define XFS_QMOPT_GQUOTA 0x0002000 /* group dquot requested */
9a2a7de2 213#define XFS_QMOPT_ENOSPC 0x0004000 /* enospc instead of edquot (prj) */
1da177e4
LT
214
215/*
216 * flags to xfs_trans_mod_dquot to indicate which field needs to be
217 * modified.
218 */
219#define XFS_QMOPT_RES_REGBLKS 0x0010000
220#define XFS_QMOPT_RES_RTBLKS 0x0020000
221#define XFS_QMOPT_BCOUNT 0x0040000
222#define XFS_QMOPT_ICOUNT 0x0080000
223#define XFS_QMOPT_RTBCOUNT 0x0100000
224#define XFS_QMOPT_DELBCOUNT 0x0200000
225#define XFS_QMOPT_DELRTBCOUNT 0x0400000
226#define XFS_QMOPT_RES_INOS 0x0800000
227
1da177e4
LT
228/*
229 * flags for dqalloc.
230 */
20026d92 231#define XFS_QMOPT_INHERIT 0x1000000
1da177e4
LT
232
233/*
234 * flags to xfs_trans_mod_dquot.
235 */
236#define XFS_TRANS_DQ_RES_BLKS XFS_QMOPT_RES_REGBLKS
237#define XFS_TRANS_DQ_RES_RTBLKS XFS_QMOPT_RES_RTBLKS
238#define XFS_TRANS_DQ_RES_INOS XFS_QMOPT_RES_INOS
239#define XFS_TRANS_DQ_BCOUNT XFS_QMOPT_BCOUNT
240#define XFS_TRANS_DQ_DELBCOUNT XFS_QMOPT_DELBCOUNT
241#define XFS_TRANS_DQ_ICOUNT XFS_QMOPT_ICOUNT
242#define XFS_TRANS_DQ_RTBCOUNT XFS_QMOPT_RTBCOUNT
243#define XFS_TRANS_DQ_DELRTBCOUNT XFS_QMOPT_DELRTBCOUNT
244
245
c8ad20ff
NS
246#define XFS_QMOPT_QUOTALL \
247 (XFS_QMOPT_UQUOTA | XFS_QMOPT_PQUOTA | XFS_QMOPT_GQUOTA)
1da177e4
LT
248#define XFS_QMOPT_RESBLK_MASK (XFS_QMOPT_RES_REGBLKS | XFS_QMOPT_RES_RTBLKS)
249
250#ifdef __KERNEL__
251/*
252 * This check is done typically without holding the inode lock;
c41564b5 253 * that may seem racy, but it is harmless in the context that it is used.
1da177e4
LT
254 * The inode cannot go inactive as long a reference is kept, and
255 * therefore if dquot(s) were attached, they'll stay consistent.
256 * If, for example, the ownership of the inode changes while
257 * we didn't have the inode locked, the appropriate dquot(s) will be
258 * attached atomically.
259 */
260#define XFS_NOT_DQATTACHED(mp, ip) ((XFS_IS_UQUOTA_ON(mp) &&\
261 (ip)->i_udquot == NULL) || \
c8ad20ff 262 (XFS_IS_OQUOTA_ON(mp) && \
1da177e4
LT
263 (ip)->i_gdquot == NULL))
264
c8ad20ff
NS
265#define XFS_QM_NEED_QUOTACHECK(mp) \
266 ((XFS_IS_UQUOTA_ON(mp) && \
267 (mp->m_sb.sb_qflags & XFS_UQUOTA_CHKD) == 0) || \
268 (XFS_IS_GQUOTA_ON(mp) && \
269 ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \
270 (mp->m_sb.sb_qflags & XFS_PQUOTA_ACCT))) || \
271 (XFS_IS_PQUOTA_ON(mp) && \
272 ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \
273 (mp->m_sb.sb_qflags & XFS_GQUOTA_ACCT))))
1da177e4 274
c8ad20ff
NS
275#define XFS_MOUNT_QUOTA_SET1 (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
276 XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\
277 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD)
278
279#define XFS_MOUNT_QUOTA_SET2 (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
1da177e4 280 XFS_UQUOTA_CHKD|XFS_GQUOTA_ACCT|\
c8ad20ff
NS
281 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD)
282
283#define XFS_MOUNT_QUOTA_ALL (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
284 XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\
285 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD|\
286 XFS_GQUOTA_ACCT)
1da177e4
LT
287
288
289/*
290 * The structure kept inside the xfs_trans_t keep track of dquot changes
291 * within a transaction and apply them later.
292 */
293typedef struct xfs_dqtrx {
294 struct xfs_dquot *qt_dquot; /* the dquot this refers to */
295 ulong qt_blk_res; /* blks reserved on a dquot */
296 ulong qt_blk_res_used; /* blks used from the reservation */
297 ulong qt_ino_res; /* inode reserved on a dquot */
298 ulong qt_ino_res_used; /* inodes used from the reservation */
299 long qt_bcount_delta; /* dquot blk count changes */
300 long qt_delbcnt_delta; /* delayed dquot blk count changes */
301 long qt_icount_delta; /* dquot inode count changes */
302 ulong qt_rtblk_res; /* # blks reserved on a dquot */
303 ulong qt_rtblk_res_used;/* # blks used from reservation */
304 long qt_rtbcount_delta;/* dquot realtime blk changes */
305 long qt_delrtb_delta; /* delayed RT blk count changes */
306} xfs_dqtrx_t;
307
7d095257
CH
308#ifdef CONFIG_XFS_QUOTA
309extern void xfs_trans_dup_dqinfo(struct xfs_trans *, struct xfs_trans *);
310extern void xfs_trans_free_dqinfo(struct xfs_trans *);
311extern void xfs_trans_mod_dquot_byino(struct xfs_trans *, struct xfs_inode *,
312 uint, long);
313extern void xfs_trans_apply_dquot_deltas(struct xfs_trans *);
314extern void xfs_trans_unreserve_and_mod_dquots(struct xfs_trans *);
315extern int xfs_trans_reserve_quota_nblks(struct xfs_trans *,
316 struct xfs_inode *, long, long, uint);
317extern int xfs_trans_reserve_quota_bydquots(struct xfs_trans *,
318 struct xfs_mount *, struct xfs_dquot *,
319 struct xfs_dquot *, long, long, uint);
320
321extern int xfs_qm_vop_dqalloc(struct xfs_inode *, uid_t, gid_t, prid_t, uint,
322 struct xfs_dquot **, struct xfs_dquot **);
323extern void xfs_qm_vop_create_dqattach(struct xfs_trans *, struct xfs_inode *,
324 struct xfs_dquot *, struct xfs_dquot *);
325extern int xfs_qm_vop_rename_dqattach(struct xfs_inode **);
326extern struct xfs_dquot *xfs_qm_vop_chown(struct xfs_trans *,
327 struct xfs_inode *, struct xfs_dquot **, struct xfs_dquot *);
328extern int xfs_qm_vop_chown_reserve(struct xfs_trans *, struct xfs_inode *,
329 struct xfs_dquot *, struct xfs_dquot *, uint);
330extern int xfs_qm_dqattach(struct xfs_inode *, uint);
331extern int xfs_qm_dqattach_locked(struct xfs_inode *, uint);
332extern void xfs_qm_dqdetach(struct xfs_inode *);
333extern void xfs_qm_dqrele(struct xfs_dquot *);
334extern void xfs_qm_statvfs(struct xfs_inode *, struct kstatfs *);
7d095257
CH
335extern int xfs_qm_newmount(struct xfs_mount *, uint *, uint *);
336extern void xfs_qm_mount_quotas(struct xfs_mount *);
337extern void xfs_qm_unmount(struct xfs_mount *);
338extern void xfs_qm_unmount_quotas(struct xfs_mount *);
339
340#else
493b87e5
CH
341static inline int
342xfs_qm_vop_dqalloc(struct xfs_inode *ip, uid_t uid, gid_t gid, prid_t prid,
343 uint flags, struct xfs_dquot **udqp, struct xfs_dquot **gdqp)
344{
345 *udqp = NULL;
346 *gdqp = NULL;
347 return 0;
348}
7d095257
CH
349#define xfs_trans_dup_dqinfo(tp, tp2)
350#define xfs_trans_free_dqinfo(tp)
351#define xfs_trans_mod_dquot_byino(tp, ip, fields, delta)
352#define xfs_trans_apply_dquot_deltas(tp)
353#define xfs_trans_unreserve_and_mod_dquots(tp)
5d2bf8a5
CH
354static inline int xfs_trans_reserve_quota_nblks(struct xfs_trans *tp,
355 struct xfs_inode *ip, long nblks, long ninos, uint flags)
356{
357 return 0;
358}
359static inline int xfs_trans_reserve_quota_bydquots(struct xfs_trans *tp,
360 struct xfs_mount *mp, struct xfs_dquot *udqp,
361 struct xfs_dquot *gdqp, long nblks, long nions, uint flags)
362{
363 return 0;
364}
7d095257
CH
365#define xfs_qm_vop_create_dqattach(tp, ip, u, g)
366#define xfs_qm_vop_rename_dqattach(it) (0)
367#define xfs_qm_vop_chown(tp, ip, old, new) (NULL)
368#define xfs_qm_vop_chown_reserve(tp, ip, u, g, fl) (0)
369#define xfs_qm_dqattach(ip, fl) (0)
370#define xfs_qm_dqattach_locked(ip, fl) (0)
371#define xfs_qm_dqdetach(ip)
372#define xfs_qm_dqrele(d)
373#define xfs_qm_statvfs(ip, s)
7d095257
CH
374#define xfs_qm_newmount(mp, a, b) (0)
375#define xfs_qm_mount_quotas(mp)
376#define xfs_qm_unmount(mp)
5d2bf8a5 377#define xfs_qm_unmount_quotas(mp)
7d095257
CH
378#endif /* CONFIG_XFS_QUOTA */
379
380#define xfs_trans_unreserve_quota_nblks(tp, ip, nblks, ninos, flags) \
381 xfs_trans_reserve_quota_nblks(tp, ip, -(nblks), -(ninos), flags)
382#define xfs_trans_reserve_quota(tp, mp, ud, gd, nb, ni, f) \
383 xfs_trans_reserve_quota_bydquots(tp, mp, ud, gd, nb, ni, \
1da177e4
LT
384 f | XFS_QMOPT_RES_REGBLKS)
385
a0fa2b67
DC
386extern int xfs_qm_dqcheck(struct xfs_mount *, xfs_disk_dquot_t *,
387 xfs_dqid_t, uint, uint, char *);
4cd4a034 388extern int xfs_mount_reset_sbqflags(struct xfs_mount *);
1da177e4 389
3fe58f30
CH
390extern const struct xfs_buf_ops xfs_dquot_buf_ops;
391
1da177e4 392#endif /* __KERNEL__ */
1da177e4 393#endif /* __XFS_QUOTA_H__ */