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