xref: /linux-6.15/include/linux/quotaops.h (revision 6faeeea4) 
1 /*
2  * Definitions for diskquota-operations. When diskquota is configured these
3  * macros expand to the right source-code.
4  *
5  * Author:  Marco van Wieringen <[email protected]>
6  */
7 #ifndef _LINUX_QUOTAOPS_
8 #define _LINUX_QUOTAOPS_
9 
10 #include <linux/fs.h>
11 
12 #define DQUOT_SPACE_WARN	0x1
13 #define DQUOT_SPACE_RESERVE	0x2
14 #define DQUOT_SPACE_NOFAIL	0x4
15 
16 static inline struct quota_info *sb_dqopt(struct super_block *sb)
17 {
18 	return &sb->s_dquot;
19 }
20 
21 /* i_mutex must being held */
22 static inline bool is_quota_modification(struct inode *inode, struct iattr *ia)
23 {
24 	return (ia->ia_valid & ATTR_SIZE && ia->ia_size != inode->i_size) ||
25 		(ia->ia_valid & ATTR_UID && !uid_eq(ia->ia_uid, inode->i_uid)) ||
26 		(ia->ia_valid & ATTR_GID && !gid_eq(ia->ia_gid, inode->i_gid));
27 }
28 
29 #if defined(CONFIG_QUOTA)
30 
31 #define quota_error(sb, fmt, args...) \
32 	__quota_error((sb), __func__, fmt , ## args)
33 
34 extern __printf(3, 4)
35 void __quota_error(struct super_block *sb, const char *func,
36 		   const char *fmt, ...);
37 
38 /*
39  * declaration of quota_function calls in kernel.
40  */
41 void inode_add_rsv_space(struct inode *inode, qsize_t number);
42 void inode_claim_rsv_space(struct inode *inode, qsize_t number);
43 void inode_sub_rsv_space(struct inode *inode, qsize_t number);
44 void inode_reclaim_rsv_space(struct inode *inode, qsize_t number);
45 
46 void dquot_initialize(struct inode *inode);
47 void dquot_drop(struct inode *inode);
48 struct dquot *dqget(struct super_block *sb, struct kqid qid);
49 static inline struct dquot *dqgrab(struct dquot *dquot)
50 {
51 	/* Make sure someone else has active reference to dquot */
52 	WARN_ON_ONCE(!atomic_read(&dquot->dq_count));
53 	WARN_ON_ONCE(!test_bit(DQ_ACTIVE_B, &dquot->dq_flags));
54 	atomic_inc(&dquot->dq_count);
55 	return dquot;
56 }
57 void dqput(struct dquot *dquot);
58 int dquot_scan_active(struct super_block *sb,
59 		      int (*fn)(struct dquot *dquot, unsigned long priv),
60 		      unsigned long priv);
61 struct dquot *dquot_alloc(struct super_block *sb, int type);
62 void dquot_destroy(struct dquot *dquot);
63 
64 int __dquot_alloc_space(struct inode *inode, qsize_t number, int flags);
65 void __dquot_free_space(struct inode *inode, qsize_t number, int flags);
66 
67 int dquot_alloc_inode(struct inode *inode);
68 
69 int dquot_claim_space_nodirty(struct inode *inode, qsize_t number);
70 void dquot_free_inode(struct inode *inode);
71 void dquot_reclaim_space_nodirty(struct inode *inode, qsize_t number);
72 
73 int dquot_disable(struct super_block *sb, int type, unsigned int flags);
74 /* Suspend quotas on remount RO */
75 static inline int dquot_suspend(struct super_block *sb, int type)
76 {
77 	return dquot_disable(sb, type, DQUOT_SUSPENDED);
78 }
79 int dquot_resume(struct super_block *sb, int type);
80 
81 int dquot_commit(struct dquot *dquot);
82 int dquot_acquire(struct dquot *dquot);
83 int dquot_release(struct dquot *dquot);
84 int dquot_commit_info(struct super_block *sb, int type);
85 int dquot_mark_dquot_dirty(struct dquot *dquot);
86 
87 int dquot_file_open(struct inode *inode, struct file *file);
88 
89 int dquot_enable(struct inode *inode, int type, int format_id,
90 	unsigned int flags);
91 int dquot_quota_on(struct super_block *sb, int type, int format_id,
92  	struct path *path);
93 int dquot_quota_on_mount(struct super_block *sb, char *qf_name,
94  	int format_id, int type);
95 int dquot_quota_off(struct super_block *sb, int type);
96 int dquot_writeback_dquots(struct super_block *sb, int type);
97 int dquot_quota_sync(struct super_block *sb, int type);
98 int dquot_get_dqinfo(struct super_block *sb, int type, struct if_dqinfo *ii);
99 int dquot_set_dqinfo(struct super_block *sb, int type, struct if_dqinfo *ii);
100 int dquot_get_dqblk(struct super_block *sb, struct kqid id,
101 		struct qc_dqblk *di);
102 int dquot_set_dqblk(struct super_block *sb, struct kqid id,
103 		struct qc_dqblk *di);
104 
105 int __dquot_transfer(struct inode *inode, struct dquot **transfer_to);
106 int dquot_transfer(struct inode *inode, struct iattr *iattr);
107 
108 static inline struct mem_dqinfo *sb_dqinfo(struct super_block *sb, int type)
109 {
110 	return sb_dqopt(sb)->info + type;
111 }
112 
113 /*
114  * Functions for checking status of quota
115  */
116 
117 static inline bool sb_has_quota_usage_enabled(struct super_block *sb, int type)
118 {
119 	return sb_dqopt(sb)->flags &
120 				dquot_state_flag(DQUOT_USAGE_ENABLED, type);
121 }
122 
123 static inline bool sb_has_quota_limits_enabled(struct super_block *sb, int type)
124 {
125 	return sb_dqopt(sb)->flags &
126 				dquot_state_flag(DQUOT_LIMITS_ENABLED, type);
127 }
128 
129 static inline bool sb_has_quota_suspended(struct super_block *sb, int type)
130 {
131 	return sb_dqopt(sb)->flags &
132 				dquot_state_flag(DQUOT_SUSPENDED, type);
133 }
134 
135 static inline unsigned sb_any_quota_suspended(struct super_block *sb)
136 {
137 	unsigned type, tmsk = 0;
138 	for (type = 0; type < MAXQUOTAS; type++)
139 		tmsk |= sb_has_quota_suspended(sb, type) << type;
140 	return tmsk;
141 }
142 
143 /* Does kernel know about any quota information for given sb + type? */
144 static inline bool sb_has_quota_loaded(struct super_block *sb, int type)
145 {
146 	/* Currently if anything is on, then quota usage is on as well */
147 	return sb_has_quota_usage_enabled(sb, type);
148 }
149 
150 static inline unsigned sb_any_quota_loaded(struct super_block *sb)
151 {
152 	unsigned type, tmsk = 0;
153 	for (type = 0; type < MAXQUOTAS; type++)
154 		tmsk |= sb_has_quota_loaded(sb, type) << type;
155 	return	tmsk;
156 }
157 
158 static inline bool sb_has_quota_active(struct super_block *sb, int type)
159 {
160 	return sb_has_quota_loaded(sb, type) &&
161 	       !sb_has_quota_suspended(sb, type);
162 }
163 
164 /*
165  * Operations supported for diskquotas.
166  */
167 extern const struct dquot_operations dquot_operations;
168 extern const struct quotactl_ops dquot_quotactl_ops;
169 extern const struct quotactl_ops dquot_quotactl_sysfile_ops;
170 
171 #else
172 
173 static inline int sb_has_quota_usage_enabled(struct super_block *sb, int type)
174 {
175 	return 0;
176 }
177 
178 static inline int sb_has_quota_limits_enabled(struct super_block *sb, int type)
179 {
180 	return 0;
181 }
182 
183 static inline int sb_has_quota_suspended(struct super_block *sb, int type)
184 {
185 	return 0;
186 }
187 
188 static inline int sb_any_quota_suspended(struct super_block *sb)
189 {
190 	return 0;
191 }
192 
193 /* Does kernel know about any quota information for given sb + type? */
194 static inline int sb_has_quota_loaded(struct super_block *sb, int type)
195 {
196 	return 0;
197 }
198 
199 static inline int sb_any_quota_loaded(struct super_block *sb)
200 {
201 	return 0;
202 }
203 
204 static inline int sb_has_quota_active(struct super_block *sb, int type)
205 {
206 	return 0;
207 }
208 
209 static inline void dquot_initialize(struct inode *inode)
210 {
211 }
212 
213 static inline void dquot_drop(struct inode *inode)
214 {
215 }
216 
217 static inline int dquot_alloc_inode(struct inode *inode)
218 {
219 	return 0;
220 }
221 
222 static inline void dquot_free_inode(struct inode *inode)
223 {
224 }
225 
226 static inline int dquot_transfer(struct inode *inode, struct iattr *iattr)
227 {
228 	return 0;
229 }
230 
231 static inline int __dquot_alloc_space(struct inode *inode, qsize_t number,
232 		int flags)
233 {
234 	if (!(flags & DQUOT_SPACE_RESERVE))
235 		inode_add_bytes(inode, number);
236 	return 0;
237 }
238 
239 static inline void __dquot_free_space(struct inode *inode, qsize_t number,
240 		int flags)
241 {
242 	if (!(flags & DQUOT_SPACE_RESERVE))
243 		inode_sub_bytes(inode, number);
244 }
245 
246 static inline int dquot_claim_space_nodirty(struct inode *inode, qsize_t number)
247 {
248 	inode_add_bytes(inode, number);
249 	return 0;
250 }
251 
252 static inline int dquot_reclaim_space_nodirty(struct inode *inode,
253 					      qsize_t number)
254 {
255 	inode_sub_bytes(inode, number);
256 	return 0;
257 }
258 
259 static inline int dquot_disable(struct super_block *sb, int type,
260 		unsigned int flags)
261 {
262 	return 0;
263 }
264 
265 static inline int dquot_suspend(struct super_block *sb, int type)
266 {
267 	return 0;
268 }
269 
270 static inline int dquot_resume(struct super_block *sb, int type)
271 {
272 	return 0;
273 }
274 
275 #define dquot_file_open		generic_file_open
276 
277 static inline int dquot_writeback_dquots(struct super_block *sb, int type)
278 {
279 	return 0;
280 }
281 
282 #endif /* CONFIG_QUOTA */
283 
284 static inline int dquot_alloc_space_nodirty(struct inode *inode, qsize_t nr)
285 {
286 	return __dquot_alloc_space(inode, nr, DQUOT_SPACE_WARN);
287 }
288 
289 static inline void dquot_alloc_space_nofail(struct inode *inode, qsize_t nr)
290 {
291 	__dquot_alloc_space(inode, nr, DQUOT_SPACE_WARN|DQUOT_SPACE_NOFAIL);
292 	mark_inode_dirty_sync(inode);
293 }
294 
295 static inline int dquot_alloc_space(struct inode *inode, qsize_t nr)
296 {
297 	int ret;
298 
299 	ret = dquot_alloc_space_nodirty(inode, nr);
300 	if (!ret) {
301 		/*
302 		 * Mark inode fully dirty. Since we are allocating blocks, inode
303 		 * would become fully dirty soon anyway and it reportedly
304 		 * reduces lock contention.
305 		 */
306 		mark_inode_dirty(inode);
307 	}
308 	return ret;
309 }
310 
311 static inline int dquot_alloc_block_nodirty(struct inode *inode, qsize_t nr)
312 {
313 	return dquot_alloc_space_nodirty(inode, nr << inode->i_blkbits);
314 }
315 
316 static inline void dquot_alloc_block_nofail(struct inode *inode, qsize_t nr)
317 {
318 	dquot_alloc_space_nofail(inode, nr << inode->i_blkbits);
319 }
320 
321 static inline int dquot_alloc_block(struct inode *inode, qsize_t nr)
322 {
323 	return dquot_alloc_space(inode, nr << inode->i_blkbits);
324 }
325 
326 static inline int dquot_prealloc_block_nodirty(struct inode *inode, qsize_t nr)
327 {
328 	return __dquot_alloc_space(inode, nr << inode->i_blkbits, 0);
329 }
330 
331 static inline int dquot_prealloc_block(struct inode *inode, qsize_t nr)
332 {
333 	int ret;
334 
335 	ret = dquot_prealloc_block_nodirty(inode, nr);
336 	if (!ret)
337 		mark_inode_dirty_sync(inode);
338 	return ret;
339 }
340 
341 static inline int dquot_reserve_block(struct inode *inode, qsize_t nr)
342 {
343 	return __dquot_alloc_space(inode, nr << inode->i_blkbits,
344 				DQUOT_SPACE_WARN|DQUOT_SPACE_RESERVE);
345 }
346 
347 static inline int dquot_claim_block(struct inode *inode, qsize_t nr)
348 {
349 	int ret;
350 
351 	ret = dquot_claim_space_nodirty(inode, nr << inode->i_blkbits);
352 	if (!ret)
353 		mark_inode_dirty_sync(inode);
354 	return ret;
355 }
356 
357 static inline void dquot_reclaim_block(struct inode *inode, qsize_t nr)
358 {
359 	dquot_reclaim_space_nodirty(inode, nr << inode->i_blkbits);
360 	mark_inode_dirty_sync(inode);
361 }
362 
363 static inline void dquot_free_space_nodirty(struct inode *inode, qsize_t nr)
364 {
365 	__dquot_free_space(inode, nr, 0);
366 }
367 
368 static inline void dquot_free_space(struct inode *inode, qsize_t nr)
369 {
370 	dquot_free_space_nodirty(inode, nr);
371 	mark_inode_dirty_sync(inode);
372 }
373 
374 static inline void dquot_free_block_nodirty(struct inode *inode, qsize_t nr)
375 {
376 	dquot_free_space_nodirty(inode, nr << inode->i_blkbits);
377 }
378 
379 static inline void dquot_free_block(struct inode *inode, qsize_t nr)
380 {
381 	dquot_free_space(inode, nr << inode->i_blkbits);
382 }
383 
384 static inline void dquot_release_reservation_block(struct inode *inode,
385 		qsize_t nr)
386 {
387 	__dquot_free_space(inode, nr << inode->i_blkbits, DQUOT_SPACE_RESERVE);
388 }
389 
390 unsigned int qtype_enforce_flag(int type);
391 
392 #endif /* _LINUX_QUOTAOPS_ */
393