xref: /linux-6.15/include/linux/quotaops.h (revision bb66fc67) 
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(const struct inode *inode);
68 
69 int dquot_claim_space_nodirty(struct inode *inode, qsize_t number);
70 void dquot_free_inode(const 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 fs_disk_quota *di);
102 int dquot_set_dqblk(struct super_block *sb, struct kqid id,
103 		struct fs_disk_quota *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 
170 #else
171 
172 static inline int sb_has_quota_usage_enabled(struct super_block *sb, int type)
173 {
174 	return 0;
175 }
176 
177 static inline int sb_has_quota_limits_enabled(struct super_block *sb, int type)
178 {
179 	return 0;
180 }
181 
182 static inline int sb_has_quota_suspended(struct super_block *sb, int type)
183 {
184 	return 0;
185 }
186 
187 static inline int sb_any_quota_suspended(struct super_block *sb)
188 {
189 	return 0;
190 }
191 
192 /* Does kernel know about any quota information for given sb + type? */
193 static inline int sb_has_quota_loaded(struct super_block *sb, int type)
194 {
195 	return 0;
196 }
197 
198 static inline int sb_any_quota_loaded(struct super_block *sb)
199 {
200 	return 0;
201 }
202 
203 static inline int sb_has_quota_active(struct super_block *sb, int type)
204 {
205 	return 0;
206 }
207 
208 static inline void dquot_initialize(struct inode *inode)
209 {
210 }
211 
212 static inline void dquot_drop(struct inode *inode)
213 {
214 }
215 
216 static inline int dquot_alloc_inode(const struct inode *inode)
217 {
218 	return 0;
219 }
220 
221 static inline void dquot_free_inode(const struct inode *inode)
222 {
223 }
224 
225 static inline int dquot_transfer(struct inode *inode, struct iattr *iattr)
226 {
227 	return 0;
228 }
229 
230 static inline int __dquot_alloc_space(struct inode *inode, qsize_t number,
231 		int flags)
232 {
233 	if (!(flags & DQUOT_SPACE_RESERVE))
234 		inode_add_bytes(inode, number);
235 	return 0;
236 }
237 
238 static inline void __dquot_free_space(struct inode *inode, qsize_t number,
239 		int flags)
240 {
241 	if (!(flags & DQUOT_SPACE_RESERVE))
242 		inode_sub_bytes(inode, number);
243 }
244 
245 static inline int dquot_claim_space_nodirty(struct inode *inode, qsize_t number)
246 {
247 	inode_add_bytes(inode, number);
248 	return 0;
249 }
250 
251 static inline int dquot_reclaim_space_nodirty(struct inode *inode,
252 					      qsize_t number)
253 {
254 	inode_sub_bytes(inode, number);
255 	return 0;
256 }
257 
258 static inline int dquot_disable(struct super_block *sb, int type,
259 		unsigned int flags)
260 {
261 	return 0;
262 }
263 
264 static inline int dquot_suspend(struct super_block *sb, int type)
265 {
266 	return 0;
267 }
268 
269 static inline int dquot_resume(struct super_block *sb, int type)
270 {
271 	return 0;
272 }
273 
274 #define dquot_file_open		generic_file_open
275 
276 static inline int dquot_writeback_dquots(struct super_block *sb, int type)
277 {
278 	return 0;
279 }
280 
281 #endif /* CONFIG_QUOTA */
282 
283 static inline int dquot_alloc_space_nodirty(struct inode *inode, qsize_t nr)
284 {
285 	return __dquot_alloc_space(inode, nr, DQUOT_SPACE_WARN);
286 }
287 
288 static inline void dquot_alloc_space_nofail(struct inode *inode, qsize_t nr)
289 {
290 	__dquot_alloc_space(inode, nr, DQUOT_SPACE_WARN|DQUOT_SPACE_NOFAIL);
291 	mark_inode_dirty_sync(inode);
292 }
293 
294 static inline int dquot_alloc_space(struct inode *inode, qsize_t nr)
295 {
296 	int ret;
297 
298 	ret = dquot_alloc_space_nodirty(inode, nr);
299 	if (!ret) {
300 		/*
301 		 * Mark inode fully dirty. Since we are allocating blocks, inode
302 		 * would become fully dirty soon anyway and it reportedly
303 		 * reduces lock contention.
304 		 */
305 		mark_inode_dirty(inode);
306 	}
307 	return ret;
308 }
309 
310 static inline int dquot_alloc_block_nodirty(struct inode *inode, qsize_t nr)
311 {
312 	return dquot_alloc_space_nodirty(inode, nr << inode->i_blkbits);
313 }
314 
315 static inline void dquot_alloc_block_nofail(struct inode *inode, qsize_t nr)
316 {
317 	dquot_alloc_space_nofail(inode, nr << inode->i_blkbits);
318 }
319 
320 static inline int dquot_alloc_block(struct inode *inode, qsize_t nr)
321 {
322 	return dquot_alloc_space(inode, nr << inode->i_blkbits);
323 }
324 
325 static inline int dquot_prealloc_block_nodirty(struct inode *inode, qsize_t nr)
326 {
327 	return __dquot_alloc_space(inode, nr << inode->i_blkbits, 0);
328 }
329 
330 static inline int dquot_prealloc_block(struct inode *inode, qsize_t nr)
331 {
332 	int ret;
333 
334 	ret = dquot_prealloc_block_nodirty(inode, nr);
335 	if (!ret)
336 		mark_inode_dirty_sync(inode);
337 	return ret;
338 }
339 
340 static inline int dquot_reserve_block(struct inode *inode, qsize_t nr)
341 {
342 	return __dquot_alloc_space(inode, nr << inode->i_blkbits,
343 				DQUOT_SPACE_WARN|DQUOT_SPACE_RESERVE);
344 }
345 
346 static inline int dquot_claim_block(struct inode *inode, qsize_t nr)
347 {
348 	int ret;
349 
350 	ret = dquot_claim_space_nodirty(inode, nr << inode->i_blkbits);
351 	if (!ret)
352 		mark_inode_dirty_sync(inode);
353 	return ret;
354 }
355 
356 static inline void dquot_reclaim_block(struct inode *inode, qsize_t nr)
357 {
358 	dquot_reclaim_space_nodirty(inode, nr << inode->i_blkbits);
359 	mark_inode_dirty_sync(inode);
360 }
361 
362 static inline void dquot_free_space_nodirty(struct inode *inode, qsize_t nr)
363 {
364 	__dquot_free_space(inode, nr, 0);
365 }
366 
367 static inline void dquot_free_space(struct inode *inode, qsize_t nr)
368 {
369 	dquot_free_space_nodirty(inode, nr);
370 	mark_inode_dirty_sync(inode);
371 }
372 
373 static inline void dquot_free_block_nodirty(struct inode *inode, qsize_t nr)
374 {
375 	dquot_free_space_nodirty(inode, nr << inode->i_blkbits);
376 }
377 
378 static inline void dquot_free_block(struct inode *inode, qsize_t nr)
379 {
380 	dquot_free_space(inode, nr << inode->i_blkbits);
381 }
382 
383 static inline void dquot_release_reservation_block(struct inode *inode,
384 		qsize_t nr)
385 {
386 	__dquot_free_space(inode, nr << inode->i_blkbits, DQUOT_SPACE_RESERVE);
387 }
388 
389 #endif /* _LINUX_QUOTAOPS_ */
390