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