1 // SPDX-License-Identifier: GPL-2.0 1 // SPDX-License-Identifier: GPL-2.0
2 /* 2 /*
3 * Copyright (c) 2000-2005 Silicon Graphics, I 3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
4 * All Rights Reserved. 4 * All Rights Reserved.
5 */ 5 */
6 #ifndef __XFS_DQUOT_H__ 6 #ifndef __XFS_DQUOT_H__
7 #define __XFS_DQUOT_H__ 7 #define __XFS_DQUOT_H__
8 8
9 /* 9 /*
10 * Dquots are structures that hold quota infor 10 * Dquots are structures that hold quota information about a user or a group,
11 * much like inodes are for files. In fact, dq 11 * much like inodes are for files. In fact, dquots share many characteristics
12 * with inodes. However, dquots can also be a 12 * with inodes. However, dquots can also be a centralized resource, relative
13 * to a collection of inodes. In this respect, 13 * to a collection of inodes. In this respect, dquots share some characteristics
14 * of the superblock. 14 * of the superblock.
15 * XFS dquots exploit both those in its algori 15 * XFS dquots exploit both those in its algorithms. They make every attempt
16 * to not be a bottleneck when quotas are on a 16 * to not be a bottleneck when quotas are on and have minimal impact, if any,
17 * when quotas are off. 17 * when quotas are off.
18 */ 18 */
19 19
20 struct xfs_mount; 20 struct xfs_mount;
21 struct xfs_trans; 21 struct xfs_trans;
22 22
23 enum { 23 enum {
24 XFS_QLOWSP_1_PCNT = 0, 24 XFS_QLOWSP_1_PCNT = 0,
25 XFS_QLOWSP_3_PCNT, 25 XFS_QLOWSP_3_PCNT,
26 XFS_QLOWSP_5_PCNT, 26 XFS_QLOWSP_5_PCNT,
27 XFS_QLOWSP_MAX 27 XFS_QLOWSP_MAX
28 }; 28 };
29 29
30 struct xfs_dquot_res { 30 struct xfs_dquot_res {
31 /* Total resources allocated and reser 31 /* Total resources allocated and reserved. */
32 xfs_qcnt_t reserved; 32 xfs_qcnt_t reserved;
33 33
34 /* Total resources allocated. */ 34 /* Total resources allocated. */
35 xfs_qcnt_t count; 35 xfs_qcnt_t count;
36 36
37 /* Absolute and preferred limits. */ 37 /* Absolute and preferred limits. */
38 xfs_qcnt_t hardlimit; 38 xfs_qcnt_t hardlimit;
39 xfs_qcnt_t softlimit; 39 xfs_qcnt_t softlimit;
40 40
41 /* 41 /*
42 * For root dquots, this is the defaul 42 * For root dquots, this is the default grace period, in seconds.
43 * Otherwise, this is when the quota g 43 * Otherwise, this is when the quota grace period expires,
44 * in seconds since the Unix epoch. 44 * in seconds since the Unix epoch.
45 */ 45 */
46 time64_t timer; 46 time64_t timer;
>> 47
>> 48 /*
>> 49 * For root dquots, this is the maximum number of warnings that will
>> 50 * be issued for this quota type. Otherwise, this is the number of
>> 51 * warnings issued against this quota. Note that none of this is
>> 52 * implemented.
>> 53 */
>> 54 xfs_qwarncnt_t warnings;
47 }; 55 };
48 56
49 static inline bool 57 static inline bool
50 xfs_dquot_res_over_limits( 58 xfs_dquot_res_over_limits(
51 const struct xfs_dquot_res *qres) 59 const struct xfs_dquot_res *qres)
52 { 60 {
53 if ((qres->softlimit && qres->softlimi 61 if ((qres->softlimit && qres->softlimit < qres->reserved) ||
54 (qres->hardlimit && qres->hardlimi 62 (qres->hardlimit && qres->hardlimit < qres->reserved))
55 return true; 63 return true;
56 return false; 64 return false;
57 } 65 }
58 66
59 /* 67 /*
60 * The incore dquot structure 68 * The incore dquot structure
61 */ 69 */
62 struct xfs_dquot { 70 struct xfs_dquot {
63 struct list_head q_lru; 71 struct list_head q_lru;
64 struct xfs_mount *q_mount; 72 struct xfs_mount *q_mount;
65 xfs_dqtype_t q_type; 73 xfs_dqtype_t q_type;
66 uint16_t q_flags; 74 uint16_t q_flags;
67 xfs_dqid_t q_id; 75 xfs_dqid_t q_id;
68 uint q_nrefs; 76 uint q_nrefs;
69 int q_bufoffset; 77 int q_bufoffset;
70 xfs_daddr_t q_blkno; 78 xfs_daddr_t q_blkno;
71 xfs_fileoff_t q_fileoffset; 79 xfs_fileoff_t q_fileoffset;
72 80
73 struct xfs_dquot_res q_blk; /* reg 81 struct xfs_dquot_res q_blk; /* regular blocks */
74 struct xfs_dquot_res q_ino; /* ino 82 struct xfs_dquot_res q_ino; /* inodes */
75 struct xfs_dquot_res q_rtb; /* rea 83 struct xfs_dquot_res q_rtb; /* realtime blocks */
76 84
77 struct xfs_dq_logitem q_logitem; 85 struct xfs_dq_logitem q_logitem;
78 86
79 xfs_qcnt_t q_prealloc_lo_ 87 xfs_qcnt_t q_prealloc_lo_wmark;
80 xfs_qcnt_t q_prealloc_hi_ 88 xfs_qcnt_t q_prealloc_hi_wmark;
81 int64_t q_low_space[XF 89 int64_t q_low_space[XFS_QLOWSP_MAX];
82 struct mutex q_qlock; 90 struct mutex q_qlock;
83 struct completion q_flush; 91 struct completion q_flush;
84 atomic_t q_pincount; 92 atomic_t q_pincount;
85 struct wait_queue_head q_pinwait; 93 struct wait_queue_head q_pinwait;
86 }; 94 };
87 95
88 /* 96 /*
89 * Lock hierarchy for q_qlock: 97 * Lock hierarchy for q_qlock:
90 * XFS_QLOCK_NORMAL is the implicit defau 98 * XFS_QLOCK_NORMAL is the implicit default,
91 * XFS_QLOCK_NESTED is the dquot with the 99 * XFS_QLOCK_NESTED is the dquot with the higher id in xfs_dqlock2
92 */ 100 */
93 enum { 101 enum {
94 XFS_QLOCK_NORMAL = 0, 102 XFS_QLOCK_NORMAL = 0,
95 XFS_QLOCK_NESTED, 103 XFS_QLOCK_NESTED,
96 }; 104 };
97 105
98 /* 106 /*
99 * Manage the q_flush completion queue embedde 107 * Manage the q_flush completion queue embedded in the dquot. This completion
100 * queue synchronizes processes attempting to 108 * queue synchronizes processes attempting to flush the in-core dquot back to
101 * disk. 109 * disk.
102 */ 110 */
103 static inline void xfs_dqflock(struct xfs_dquo 111 static inline void xfs_dqflock(struct xfs_dquot *dqp)
104 { 112 {
105 wait_for_completion(&dqp->q_flush); 113 wait_for_completion(&dqp->q_flush);
106 } 114 }
107 115
108 static inline bool xfs_dqflock_nowait(struct x 116 static inline bool xfs_dqflock_nowait(struct xfs_dquot *dqp)
109 { 117 {
110 return try_wait_for_completion(&dqp->q 118 return try_wait_for_completion(&dqp->q_flush);
111 } 119 }
112 120
113 static inline void xfs_dqfunlock(struct xfs_dq 121 static inline void xfs_dqfunlock(struct xfs_dquot *dqp)
114 { 122 {
115 complete(&dqp->q_flush); 123 complete(&dqp->q_flush);
116 } 124 }
117 125
118 static inline int xfs_dqlock_nowait(struct xfs 126 static inline int xfs_dqlock_nowait(struct xfs_dquot *dqp)
119 { 127 {
120 return mutex_trylock(&dqp->q_qlock); 128 return mutex_trylock(&dqp->q_qlock);
121 } 129 }
122 130
123 static inline void xfs_dqlock(struct xfs_dquot 131 static inline void xfs_dqlock(struct xfs_dquot *dqp)
124 { 132 {
125 mutex_lock(&dqp->q_qlock); 133 mutex_lock(&dqp->q_qlock);
126 } 134 }
127 135
128 static inline void xfs_dqunlock(struct xfs_dqu 136 static inline void xfs_dqunlock(struct xfs_dquot *dqp)
129 { 137 {
130 mutex_unlock(&dqp->q_qlock); 138 mutex_unlock(&dqp->q_qlock);
131 } 139 }
132 140
133 static inline int 141 static inline int
134 xfs_dquot_type(const struct xfs_dquot *dqp) 142 xfs_dquot_type(const struct xfs_dquot *dqp)
135 { 143 {
136 return dqp->q_type & XFS_DQTYPE_REC_MA 144 return dqp->q_type & XFS_DQTYPE_REC_MASK;
137 } 145 }
138 146
139 static inline int xfs_this_quota_on(struct xfs 147 static inline int xfs_this_quota_on(struct xfs_mount *mp, xfs_dqtype_t type)
140 { 148 {
141 switch (type) { 149 switch (type) {
142 case XFS_DQTYPE_USER: 150 case XFS_DQTYPE_USER:
143 return XFS_IS_UQUOTA_ON(mp); 151 return XFS_IS_UQUOTA_ON(mp);
144 case XFS_DQTYPE_GROUP: 152 case XFS_DQTYPE_GROUP:
145 return XFS_IS_GQUOTA_ON(mp); 153 return XFS_IS_GQUOTA_ON(mp);
146 case XFS_DQTYPE_PROJ: 154 case XFS_DQTYPE_PROJ:
147 return XFS_IS_PQUOTA_ON(mp); 155 return XFS_IS_PQUOTA_ON(mp);
148 default: 156 default:
149 return 0; 157 return 0;
150 } 158 }
151 } 159 }
152 160
153 static inline struct xfs_dquot *xfs_inode_dquo 161 static inline struct xfs_dquot *xfs_inode_dquot(
154 struct xfs_inode *ip, 162 struct xfs_inode *ip,
155 xfs_dqtype_t type) 163 xfs_dqtype_t type)
156 { 164 {
157 switch (type) { 165 switch (type) {
158 case XFS_DQTYPE_USER: 166 case XFS_DQTYPE_USER:
159 return ip->i_udquot; 167 return ip->i_udquot;
160 case XFS_DQTYPE_GROUP: 168 case XFS_DQTYPE_GROUP:
161 return ip->i_gdquot; 169 return ip->i_gdquot;
162 case XFS_DQTYPE_PROJ: 170 case XFS_DQTYPE_PROJ:
163 return ip->i_pdquot; 171 return ip->i_pdquot;
164 default: 172 default:
165 return NULL; 173 return NULL;
166 } 174 }
167 } 175 }
168 176
169 /* Decide if the dquot's limits are actually b 177 /* Decide if the dquot's limits are actually being enforced. */
170 static inline bool 178 static inline bool
171 xfs_dquot_is_enforced( 179 xfs_dquot_is_enforced(
172 const struct xfs_dquot *dqp) 180 const struct xfs_dquot *dqp)
173 { 181 {
174 switch (xfs_dquot_type(dqp)) { 182 switch (xfs_dquot_type(dqp)) {
175 case XFS_DQTYPE_USER: 183 case XFS_DQTYPE_USER:
176 return XFS_IS_UQUOTA_ENFORCED( 184 return XFS_IS_UQUOTA_ENFORCED(dqp->q_mount);
177 case XFS_DQTYPE_GROUP: 185 case XFS_DQTYPE_GROUP:
178 return XFS_IS_GQUOTA_ENFORCED( 186 return XFS_IS_GQUOTA_ENFORCED(dqp->q_mount);
179 case XFS_DQTYPE_PROJ: 187 case XFS_DQTYPE_PROJ:
180 return XFS_IS_PQUOTA_ENFORCED( 188 return XFS_IS_PQUOTA_ENFORCED(dqp->q_mount);
181 } 189 }
182 ASSERT(0); 190 ASSERT(0);
183 return false; 191 return false;
184 } 192 }
185 193
186 /* 194 /*
187 * Check whether a dquot is under low free spa 195 * Check whether a dquot is under low free space conditions. We assume the quota
188 * is enabled and enforced. 196 * is enabled and enforced.
189 */ 197 */
190 static inline bool xfs_dquot_lowsp(struct xfs_ 198 static inline bool xfs_dquot_lowsp(struct xfs_dquot *dqp)
191 { 199 {
192 int64_t freesp; 200 int64_t freesp;
193 201
194 freesp = dqp->q_blk.hardlimit - dqp->q 202 freesp = dqp->q_blk.hardlimit - dqp->q_blk.reserved;
195 if (freesp < dqp->q_low_space[XFS_QLOW 203 if (freesp < dqp->q_low_space[XFS_QLOWSP_1_PCNT])
196 return true; 204 return true;
197 205
198 return false; 206 return false;
199 } 207 }
200 208
201 void xfs_dquot_to_disk(struct xfs_disk_dquot * 209 void xfs_dquot_to_disk(struct xfs_disk_dquot *ddqp, struct xfs_dquot *dqp);
202 210
203 #define XFS_DQ_IS_LOCKED(dqp) (mutex_is_lock 211 #define XFS_DQ_IS_LOCKED(dqp) (mutex_is_locked(&((dqp)->q_qlock)))
204 #define XFS_DQ_IS_DIRTY(dqp) ((dqp)->q_flag 212 #define XFS_DQ_IS_DIRTY(dqp) ((dqp)->q_flags & XFS_DQFLAG_DIRTY)
205 213
206 void xfs_qm_dqdestroy(struct xfs_dq 214 void xfs_qm_dqdestroy(struct xfs_dquot *dqp);
207 int xfs_qm_dqflush(struct xfs_dquo 215 int xfs_qm_dqflush(struct xfs_dquot *dqp, struct xfs_buf **bpp);
208 void xfs_qm_dqunpin_wait(struct xfs 216 void xfs_qm_dqunpin_wait(struct xfs_dquot *dqp);
209 void xfs_qm_adjust_dqtimers(struct 217 void xfs_qm_adjust_dqtimers(struct xfs_dquot *d);
210 void xfs_qm_adjust_dqlimits(struct 218 void xfs_qm_adjust_dqlimits(struct xfs_dquot *d);
211 xfs_dqid_t xfs_qm_id_for_quotatype(struct 219 xfs_dqid_t xfs_qm_id_for_quotatype(struct xfs_inode *ip,
212 xfs_dqtype_t t 220 xfs_dqtype_t type);
213 int xfs_qm_dqget(struct xfs_mount 221 int xfs_qm_dqget(struct xfs_mount *mp, xfs_dqid_t id,
214 xfs_dqtype_t t 222 xfs_dqtype_t type, bool can_alloc,
215 struct xfs_dqu 223 struct xfs_dquot **dqpp);
216 int xfs_qm_dqget_inode(struct xfs_ 224 int xfs_qm_dqget_inode(struct xfs_inode *ip, xfs_dqtype_t type,
217 bool can_alloc 225 bool can_alloc, struct xfs_dquot **dqpp);
218 int xfs_qm_dqget_next(struct xfs_m 226 int xfs_qm_dqget_next(struct xfs_mount *mp, xfs_dqid_t id,
219 xfs_dqtype_t t 227 xfs_dqtype_t type, struct xfs_dquot **dqpp);
220 int xfs_qm_dqget_uncached(struct x 228 int xfs_qm_dqget_uncached(struct xfs_mount *mp,
221 xfs_dqid_t id, 229 xfs_dqid_t id, xfs_dqtype_t type,
222 struct xfs_dqu 230 struct xfs_dquot **dqpp);
223 void xfs_qm_dqput(struct xfs_dquot 231 void xfs_qm_dqput(struct xfs_dquot *dqp);
224 232
225 void xfs_dqlock2(struct xfs_dquot * 233 void xfs_dqlock2(struct xfs_dquot *, struct xfs_dquot *);
226 void xfs_dqlockn(struct xfs_dqtrx * <<
227 234
228 void xfs_dquot_set_prealloc_limits( 235 void xfs_dquot_set_prealloc_limits(struct xfs_dquot *);
229 236
230 static inline struct xfs_dquot *xfs_qm_dqhold( 237 static inline struct xfs_dquot *xfs_qm_dqhold(struct xfs_dquot *dqp)
231 { 238 {
232 xfs_dqlock(dqp); 239 xfs_dqlock(dqp);
233 dqp->q_nrefs++; 240 dqp->q_nrefs++;
234 xfs_dqunlock(dqp); 241 xfs_dqunlock(dqp);
235 return dqp; 242 return dqp;
236 } 243 }
237 244
>> 245 typedef int (*xfs_qm_dqiterate_fn)(struct xfs_dquot *dq,
>> 246 xfs_dqtype_t type, void *priv);
>> 247 int xfs_qm_dqiterate(struct xfs_mount *mp, xfs_dqtype_t type,
>> 248 xfs_qm_dqiterate_fn iter_fn, void *priv);
>> 249
238 time64_t xfs_dquot_set_timeout(struct xfs_moun 250 time64_t xfs_dquot_set_timeout(struct xfs_mount *mp, time64_t timeout);
239 time64_t xfs_dquot_set_grace_period(time64_t g 251 time64_t xfs_dquot_set_grace_period(time64_t grace);
240 <<
241 void xfs_qm_init_dquot_blk(struct xfs_trans *t <<
242 type, struct xfs_buf *bp); <<
243 252
244 #endif /* __XFS_DQUOT_H__ */ 253 #endif /* __XFS_DQUOT_H__ */
245 254
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.