[linux-2.6-block.git] / fs / xfs / libxfs / xfs_quota_defs.h

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 */
#ifndef __XFS_QUOTA_DEFS_H__
#define __XFS_QUOTA_DEFS_H__

/*
 * Quota definitions shared between user and kernel source trees.
 */

/*
 * Even though users may not have quota limits occupying all 64-bits,
 * they may need 64-bit accounting. Hence, 64-bit quota-counters,
 * and quota-limits. This is a waste in the common case, but hey ...
 */
typedef uint64_t	xfs_qcnt_t;
typedef uint16_t	xfs_qwarncnt_t;

/*
 * flags for q_flags field in the dquot.
 */
#define XFS_DQ_USER		0x0001		/* a user quota */
#define XFS_DQ_PROJ		0x0002		/* project quota */
#define XFS_DQ_GROUP		0x0004		/* a group quota */
#define XFS_DQ_DIRTY		0x0008		/* dquot is dirty */
#define XFS_DQ_FREEING		0x0010		/* dquot is being torn down */

#define XFS_DQ_ALLTYPES		(XFS_DQ_USER|XFS_DQ_PROJ|XFS_DQ_GROUP)

#define XFS_DQ_FLAGS \
	{ XFS_DQ_USER,		"USER" }, \
	{ XFS_DQ_PROJ,		"PROJ" }, \
	{ XFS_DQ_GROUP,		"GROUP" }, \
	{ XFS_DQ_DIRTY,		"DIRTY" }, \
	{ XFS_DQ_FREEING,	"FREEING" }

/*
 * We have the possibility of all three quota types being active at once, and
 * hence free space modification requires modification of all three current
 * dquots in a single transaction. For this case we need to have a reservation
 * of at least 3 dquots.
 *
 * However, a chmod operation can change both UID and GID in a single
 * transaction, resulting in requiring {old, new} x {uid, gid} dquots to be
 * modified. Hence for this case we need to reserve space for at least 4 dquots.
 *
 * And in the worst case, there's a rename operation that can be modifying up to
 * 4 inodes with dquots attached to them. In reality, the only inodes that can
 * have their dquots modified are the source and destination directory inodes
 * due to directory name creation and removal. That can require space allocation
 * and/or freeing on both directory inodes, and hence all three dquots on each
 * inode can be modified. And if the directories are world writeable, all the
 * dquots can be unique and so 6 dquots can be modified....
 *
 * And, of course, we also need to take into account the dquot log format item
 * used to describe each dquot.
 */
#define XFS_DQUOT_LOGRES(mp)	\
	((sizeof(struct xfs_dq_logformat) + sizeof(struct xfs_disk_dquot)) * 6)

#define XFS_IS_QUOTA_RUNNING(mp)	((mp)->m_qflags & XFS_ALL_QUOTA_ACCT)
#define XFS_IS_UQUOTA_RUNNING(mp)	((mp)->m_qflags & XFS_UQUOTA_ACCT)
#define XFS_IS_PQUOTA_RUNNING(mp)	((mp)->m_qflags & XFS_PQUOTA_ACCT)
#define XFS_IS_GQUOTA_RUNNING(mp)	((mp)->m_qflags & XFS_GQUOTA_ACCT)
#define XFS_IS_UQUOTA_ENFORCED(mp)	((mp)->m_qflags & XFS_UQUOTA_ENFD)
#define XFS_IS_GQUOTA_ENFORCED(mp)	((mp)->m_qflags & XFS_GQUOTA_ENFD)
#define XFS_IS_PQUOTA_ENFORCED(mp)	((mp)->m_qflags & XFS_PQUOTA_ENFD)

/*
 * Incore only flags for quotaoff - these bits get cleared when quota(s)
 * are in the process of getting turned off. These flags are in m_qflags but
 * never in sb_qflags.
 */
#define XFS_UQUOTA_ACTIVE	0x1000  /* uquotas are being turned off */
#define XFS_GQUOTA_ACTIVE	0x2000  /* gquotas are being turned off */
#define XFS_PQUOTA_ACTIVE	0x4000  /* pquotas are being turned off */
#define XFS_ALL_QUOTA_ACTIVE	\
	(XFS_UQUOTA_ACTIVE | XFS_GQUOTA_ACTIVE | XFS_PQUOTA_ACTIVE)

/*
 * Checking XFS_IS_*QUOTA_ON() while holding any inode lock guarantees
 * quota will be not be switched off as long as that inode lock is held.
 */
#define XFS_IS_QUOTA_ON(mp)	((mp)->m_qflags & (XFS_UQUOTA_ACTIVE | \
						   XFS_GQUOTA_ACTIVE | \
						   XFS_PQUOTA_ACTIVE))
#define XFS_IS_UQUOTA_ON(mp)	((mp)->m_qflags & XFS_UQUOTA_ACTIVE)
#define XFS_IS_GQUOTA_ON(mp)	((mp)->m_qflags & XFS_GQUOTA_ACTIVE)
#define XFS_IS_PQUOTA_ON(mp)	((mp)->m_qflags & XFS_PQUOTA_ACTIVE)

/*
 * Flags to tell various functions what to do. Not all of these are meaningful
 * to a single function. None of these XFS_QMOPT_* flags are meant to have
 * persistent values (ie. their values can and will change between versions)
 */
#define XFS_QMOPT_UQUOTA	0x0000004 /* user dquot requested */
#define XFS_QMOPT_PQUOTA	0x0000008 /* project dquot requested */
#define XFS_QMOPT_FORCE_RES	0x0000010 /* ignore quota limits */
#define XFS_QMOPT_SBVERSION	0x0000040 /* change superblock version num */
#define XFS_QMOPT_GQUOTA	0x0002000 /* group dquot requested */
#define XFS_QMOPT_ENOSPC	0x0004000 /* enospc instead of edquot (prj) */

/*
 * flags to xfs_trans_mod_dquot to indicate which field needs to be
 * modified.
 */
#define XFS_QMOPT_RES_REGBLKS	0x0010000
#define XFS_QMOPT_RES_RTBLKS	0x0020000
#define XFS_QMOPT_BCOUNT	0x0040000
#define XFS_QMOPT_ICOUNT	0x0080000
#define XFS_QMOPT_RTBCOUNT	0x0100000
#define XFS_QMOPT_DELBCOUNT	0x0200000
#define XFS_QMOPT_DELRTBCOUNT	0x0400000
#define XFS_QMOPT_RES_INOS	0x0800000

/*
 * flags for dqalloc.
 */
#define XFS_QMOPT_INHERIT	0x1000000

/*
 * flags to xfs_trans_mod_dquot.
 */
#define XFS_TRANS_DQ_RES_BLKS	XFS_QMOPT_RES_REGBLKS
#define XFS_TRANS_DQ_RES_RTBLKS	XFS_QMOPT_RES_RTBLKS
#define XFS_TRANS_DQ_RES_INOS	XFS_QMOPT_RES_INOS
#define XFS_TRANS_DQ_BCOUNT	XFS_QMOPT_BCOUNT
#define XFS_TRANS_DQ_DELBCOUNT	XFS_QMOPT_DELBCOUNT
#define XFS_TRANS_DQ_ICOUNT	XFS_QMOPT_ICOUNT
#define XFS_TRANS_DQ_RTBCOUNT	XFS_QMOPT_RTBCOUNT
#define XFS_TRANS_DQ_DELRTBCOUNT XFS_QMOPT_DELRTBCOUNT


#define XFS_QMOPT_QUOTALL	\
		(XFS_QMOPT_UQUOTA | XFS_QMOPT_PQUOTA | XFS_QMOPT_GQUOTA)
#define XFS_QMOPT_RESBLK_MASK	(XFS_QMOPT_RES_REGBLKS | XFS_QMOPT_RES_RTBLKS)

extern xfs_failaddr_t xfs_dquot_verify(struct xfs_mount *mp,
		struct xfs_disk_dquot *ddq, xfs_dqid_t id, uint type);
extern xfs_failaddr_t xfs_dqblk_verify(struct xfs_mount *mp,
		struct xfs_dqblk *dqb, xfs_dqid_t id, uint type);
extern int xfs_calc_dquots_per_chunk(unsigned int nbblks);
extern int xfs_dqblk_repair(struct xfs_mount *mp, struct xfs_dqblk *dqb,
		xfs_dqid_t id, uint type);

#endif	/* __XFS_QUOTA_H__ */
Commit	Line	Data
0b61f8a4	1	// SPDX-License-Identifier: GPL-2.0
76456fc2 DC	2	/*
	3	* Copyright (c) 2000-2005 Silicon Graphics, Inc.
	4	* All Rights Reserved.
76456fc2 DC	5	*/
	6	#ifndef __XFS_QUOTA_DEFS_H__
	7	#define __XFS_QUOTA_DEFS_H__
	8
	9	/*
	10	* Quota definitions shared between user and kernel source trees.
	11	*/
	12
	13	/*
	14	* Even though users may not have quota limits occupying all 64-bits,
	15	* they may need 64-bit accounting. Hence, 64-bit quota-counters,
	16	* and quota-limits. This is a waste in the common case, but hey ...
	17	*/
c8ce540d DW	18	typedef uint64_t xfs_qcnt_t;
c8ce540d DW	19	typedef uint16_t xfs_qwarncnt_t;
76456fc2 DC	20
	21	/*
	22	* flags for q_flags field in the dquot.
	23	*/
	24	#define XFS_DQ_USER 0x0001 /* a user quota */
	25	#define XFS_DQ_PROJ 0x0002 /* project quota */
	26	#define XFS_DQ_GROUP 0x0004 /* a group quota */
	27	#define XFS_DQ_DIRTY 0x0008 /* dquot is dirty */
296c24e2	28	#define XFS_DQ_FREEING 0x0010 /* dquot is being torn down */
76456fc2 DC	29
	30	#define XFS_DQ_ALLTYPES (XFS_DQ_USER\|XFS_DQ_PROJ\|XFS_DQ_GROUP)
	31
	32	#define XFS_DQ_FLAGS \
	33	{ XFS_DQ_USER, "USER" }, \
	34	{ XFS_DQ_PROJ, "PROJ" }, \
	35	{ XFS_DQ_GROUP, "GROUP" }, \
	36	{ XFS_DQ_DIRTY, "DIRTY" }, \
	37	{ XFS_DQ_FREEING, "FREEING" }
	38
	39	/*
	40	* We have the possibility of all three quota types being active at once, and
	41	* hence free space modification requires modification of all three current
	42	* dquots in a single transaction. For this case we need to have a reservation
	43	* of at least 3 dquots.
	44	*
	45	* However, a chmod operation can change both UID and GID in a single
	46	* transaction, resulting in requiring {old, new} x {uid, gid} dquots to be
	47	* modified. Hence for this case we need to reserve space for at least 4 dquots.
	48	*
	49	* And in the worst case, there's a rename operation that can be modifying up to
	50	* 4 inodes with dquots attached to them. In reality, the only inodes that can
	51	* have their dquots modified are the source and destination directory inodes
	52	* due to directory name creation and removal. That can require space allocation
	53	* and/or freeing on both directory inodes, and hence all three dquots on each
	54	* inode can be modified. And if the directories are world writeable, all the
	55	* dquots can be unique and so 6 dquots can be modified....
	56	*
	57	* And, of course, we also need to take into account the dquot log format item
	58	* used to describe each dquot.
	59	*/
	60	#define XFS_DQUOT_LOGRES(mp) \
	61	((sizeof(struct xfs_dq_logformat) + sizeof(struct xfs_disk_dquot)) * 6)
	62
	63	#define XFS_IS_QUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_ALL_QUOTA_ACCT)
	64	#define XFS_IS_UQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_UQUOTA_ACCT)
	65	#define XFS_IS_PQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_PQUOTA_ACCT)
	66	#define XFS_IS_GQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_GQUOTA_ACCT)
	67	#define XFS_IS_UQUOTA_ENFORCED(mp) ((mp)->m_qflags & XFS_UQUOTA_ENFD)
	68	#define XFS_IS_GQUOTA_ENFORCED(mp) ((mp)->m_qflags & XFS_GQUOTA_ENFD)
	69	#define XFS_IS_PQUOTA_ENFORCED(mp) ((mp)->m_qflags & XFS_PQUOTA_ENFD)
	70
	71	/*
	72	* Incore only flags for quotaoff - these bits get cleared when quota(s)
	73	* are in the process of getting turned off. These flags are in m_qflags but
	74	* never in sb_qflags.
	75	*/
	76	#define XFS_UQUOTA_ACTIVE 0x1000 /* uquotas are being turned off */
	77	#define XFS_GQUOTA_ACTIVE 0x2000 /* gquotas are being turned off */
	78	#define XFS_PQUOTA_ACTIVE 0x4000 /* pquotas are being turned off */
	79	#define XFS_ALL_QUOTA_ACTIVE \
	80	(XFS_UQUOTA_ACTIVE \| XFS_GQUOTA_ACTIVE \| XFS_PQUOTA_ACTIVE)
	81
	82	/*
	83	* Checking XFS_IS_*QUOTA_ON() while holding any inode lock guarantees
	84	* quota will be not be switched off as long as that inode lock is held.
	85	*/
	86	#define XFS_IS_QUOTA_ON(mp) ((mp)->m_qflags & (XFS_UQUOTA_ACTIVE \| \
	87	XFS_GQUOTA_ACTIVE \| \
	88	XFS_PQUOTA_ACTIVE))
76456fc2 DC	89	#define XFS_IS_UQUOTA_ON(mp) ((mp)->m_qflags & XFS_UQUOTA_ACTIVE)
	90	#define XFS_IS_GQUOTA_ON(mp) ((mp)->m_qflags & XFS_GQUOTA_ACTIVE)
	91	#define XFS_IS_PQUOTA_ON(mp) ((mp)->m_qflags & XFS_PQUOTA_ACTIVE)
	92
	93	/*
	94	* Flags to tell various functions what to do. Not all of these are meaningful
	95	* to a single function. None of these XFS_QMOPT_* flags are meant to have
	96	* persistent values (ie. their values can and will change between versions)
	97	*/
76456fc2 DC	98	#define XFS_QMOPT_UQUOTA 0x0000004 /* user dquot requested */
	99	#define XFS_QMOPT_PQUOTA 0x0000008 /* project dquot requested */
	100	#define XFS_QMOPT_FORCE_RES 0x0000010 /* ignore quota limits */
	101	#define XFS_QMOPT_SBVERSION 0x0000040 /* change superblock version num */
76456fc2 DC	102	#define XFS_QMOPT_GQUOTA 0x0002000 /* group dquot requested */
	103	#define XFS_QMOPT_ENOSPC 0x0004000 /* enospc instead of edquot (prj) */
	104
	105	/*
	106	* flags to xfs_trans_mod_dquot to indicate which field needs to be
	107	* modified.
	108	*/
	109	#define XFS_QMOPT_RES_REGBLKS 0x0010000
	110	#define XFS_QMOPT_RES_RTBLKS 0x0020000
	111	#define XFS_QMOPT_BCOUNT 0x0040000
	112	#define XFS_QMOPT_ICOUNT 0x0080000
	113	#define XFS_QMOPT_RTBCOUNT 0x0100000
	114	#define XFS_QMOPT_DELBCOUNT 0x0200000
	115	#define XFS_QMOPT_DELRTBCOUNT 0x0400000
	116	#define XFS_QMOPT_RES_INOS 0x0800000
	117
	118	/*
	119	* flags for dqalloc.
	120	*/
	121	#define XFS_QMOPT_INHERIT 0x1000000
	122
	123	/*
	124	* flags to xfs_trans_mod_dquot.
	125	*/
	126	#define XFS_TRANS_DQ_RES_BLKS XFS_QMOPT_RES_REGBLKS
	127	#define XFS_TRANS_DQ_RES_RTBLKS XFS_QMOPT_RES_RTBLKS
	128	#define XFS_TRANS_DQ_RES_INOS XFS_QMOPT_RES_INOS
	129	#define XFS_TRANS_DQ_BCOUNT XFS_QMOPT_BCOUNT
	130	#define XFS_TRANS_DQ_DELBCOUNT XFS_QMOPT_DELBCOUNT
	131	#define XFS_TRANS_DQ_ICOUNT XFS_QMOPT_ICOUNT
	132	#define XFS_TRANS_DQ_RTBCOUNT XFS_QMOPT_RTBCOUNT
	133	#define XFS_TRANS_DQ_DELRTBCOUNT XFS_QMOPT_DELRTBCOUNT
	134
	135
	136	#define XFS_QMOPT_QUOTALL \
	137	(XFS_QMOPT_UQUOTA \| XFS_QMOPT_PQUOTA \| XFS_QMOPT_GQUOTA)
	138	#define XFS_QMOPT_RESBLK_MASK (XFS_QMOPT_RES_REGBLKS \| XFS_QMOPT_RES_RTBLKS)
	139
eebf3cab	140	extern xfs_failaddr_t xfs_dquot_verify(struct xfs_mount *mp,
e381a0f6	141	struct xfs_disk_dquot *ddq, xfs_dqid_t id, uint type);
7224fa48 ES	142	extern xfs_failaddr_t xfs_dqblk_verify(struct xfs_mount *mp,
7224fa48 ES	143	struct xfs_dqblk *dqb, xfs_dqid_t id, uint type);
6ea94bb5	144	extern int xfs_calc_dquots_per_chunk(unsigned int nbblks);
48fa1db8	145	extern int xfs_dqblk_repair(struct xfs_mount mp, struct xfs_dqblk dqb,
eeea7980	146	xfs_dqid_t id, uint type);
9aede1d8	147
76456fc2	148	#endif /* __XFS_QUOTA_H__ */