1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
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 */
18typedef uint64_t	xfs_qcnt_t;
19typedef uint16_t	xfs_qwarncnt_t;
20
21typedef uint8_t		xfs_dqtype_t;
22
23#define XFS_DQTYPE_STRINGS \
24	{ XFS_DQTYPE_USER,	"USER" }, \
25	{ XFS_DQTYPE_PROJ,	"PROJ" }, \
26	{ XFS_DQTYPE_GROUP,	"GROUP" }, \
27	{ XFS_DQTYPE_BIGTIME,	"BIGTIME" }
28
29/*
30 * flags for q_flags field in the dquot.
31 */
32#define XFS_DQFLAG_DIRTY	(1 << 0)	/* dquot is dirty */
33#define XFS_DQFLAG_FREEING	(1 << 1)	/* dquot is being torn down */
34
35#define XFS_DQFLAG_STRINGS \
36	{ XFS_DQFLAG_DIRTY,	"DIRTY" }, \
37	{ XFS_DQFLAG_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))
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 */
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 */
102#define XFS_QMOPT_GQUOTA	0x0002000 /* group dquot requested */
103
104/*
105 * flags to xfs_trans_mod_dquot to indicate which field needs to be
106 * modified.
107 */
108#define XFS_QMOPT_RES_REGBLKS	0x0010000
109#define XFS_QMOPT_RES_RTBLKS	0x0020000
110#define XFS_QMOPT_BCOUNT	0x0040000
111#define XFS_QMOPT_ICOUNT	0x0080000
112#define XFS_QMOPT_RTBCOUNT	0x0100000
113#define XFS_QMOPT_DELBCOUNT	0x0200000
114#define XFS_QMOPT_DELRTBCOUNT	0x0400000
115#define XFS_QMOPT_RES_INOS	0x0800000
116
117/*
118 * flags for dqalloc.
119 */
120#define XFS_QMOPT_INHERIT	0x1000000
121
122/*
123 * flags to xfs_trans_mod_dquot.
124 */
125#define XFS_TRANS_DQ_RES_BLKS	XFS_QMOPT_RES_REGBLKS
126#define XFS_TRANS_DQ_RES_RTBLKS	XFS_QMOPT_RES_RTBLKS
127#define XFS_TRANS_DQ_RES_INOS	XFS_QMOPT_RES_INOS
128#define XFS_TRANS_DQ_BCOUNT	XFS_QMOPT_BCOUNT
129#define XFS_TRANS_DQ_DELBCOUNT	XFS_QMOPT_DELBCOUNT
130#define XFS_TRANS_DQ_ICOUNT	XFS_QMOPT_ICOUNT
131#define XFS_TRANS_DQ_RTBCOUNT	XFS_QMOPT_RTBCOUNT
132#define XFS_TRANS_DQ_DELRTBCOUNT XFS_QMOPT_DELRTBCOUNT
133
134
135#define XFS_QMOPT_QUOTALL	\
136		(XFS_QMOPT_UQUOTA | XFS_QMOPT_PQUOTA | XFS_QMOPT_GQUOTA)
137#define XFS_QMOPT_RESBLK_MASK	(XFS_QMOPT_RES_REGBLKS | XFS_QMOPT_RES_RTBLKS)
138
139extern xfs_failaddr_t xfs_dquot_verify(struct xfs_mount *mp,
140		struct xfs_disk_dquot *ddq, xfs_dqid_t id);
141extern xfs_failaddr_t xfs_dqblk_verify(struct xfs_mount *mp,
142		struct xfs_dqblk *dqb, xfs_dqid_t id);
143extern int xfs_calc_dquots_per_chunk(unsigned int nbblks);
144extern void xfs_dqblk_repair(struct xfs_mount *mp, struct xfs_dqblk *dqb,
145		xfs_dqid_t id, xfs_dqtype_t type);
146
147struct xfs_dquot;
148time64_t xfs_dquot_from_disk_ts(struct xfs_disk_dquot *ddq,
149		__be32 dtimer);
150__be32 xfs_dquot_to_disk_ts(struct xfs_dquot *ddq, time64_t timer);
151
152#endif	/* __XFS_QUOTA_H__ */
153