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