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