]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Copyright (c) 1982, 1986 Regents of the University of California. | |
3 | * All rights reserved. | |
4 | * | |
5 | * This code is derived from software contributed to Berkeley by | |
6 | * Robert Elz at The University of Melbourne. | |
7 | * | |
8 | * Redistribution and use in source and binary forms, with or without | |
9 | * modification, are permitted provided that the following conditions | |
10 | * are met: | |
11 | * 1. Redistributions of source code must retain the above copyright | |
12 | * notice, this list of conditions and the following disclaimer. | |
13 | * 2. Redistributions in binary form must reproduce the above copyright | |
14 | * notice, this list of conditions and the following disclaimer in the | |
15 | * documentation and/or other materials provided with the distribution. | |
16 | * 3. Neither the name of the University nor the names of its contributors | |
17 | * may be used to endorse or promote products derived from this software | |
18 | * without specific prior written permission. | |
19 | * | |
20 | * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
21 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
22 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
23 | * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
24 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
25 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
26 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
27 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
28 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
29 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
30 | * SUCH DAMAGE. | |
31 | * | |
32 | * Version: $Id: quota.h,v 2.0 1996/11/17 16:48:14 mvw Exp mvw $ | |
33 | */ | |
34 | ||
35 | #ifndef _LINUX_QUOTA_ | |
36 | #define _LINUX_QUOTA_ | |
37 | ||
38 | #include <linux/errno.h> | |
39 | #include <linux/types.h> | |
1da177e4 LT |
40 | |
41 | #define __DQUOT_VERSION__ "dquot_6.5.1" | |
42 | #define __DQUOT_NUM_VERSION__ 6*10000+5*100+1 | |
43 | ||
44 | typedef __kernel_uid32_t qid_t; /* Type in which we store ids in memory */ | |
45 | typedef __u64 qsize_t; /* Type in which we store sizes */ | |
46 | ||
1da177e4 LT |
47 | /* Size of blocks in which are counted size limits */ |
48 | #define QUOTABLOCK_BITS 10 | |
49 | #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS) | |
50 | ||
51 | /* Conversion routines from and to quota blocks */ | |
52 | #define qb2kb(x) ((x) << (QUOTABLOCK_BITS-10)) | |
53 | #define kb2qb(x) ((x) >> (QUOTABLOCK_BITS-10)) | |
54 | #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS) | |
55 | ||
56 | #define MAXQUOTAS 2 | |
57 | #define USRQUOTA 0 /* element used for user quotas */ | |
58 | #define GRPQUOTA 1 /* element used for group quotas */ | |
59 | ||
60 | /* | |
61 | * Definitions for the default names of the quotas files. | |
62 | */ | |
63 | #define INITQFNAMES { \ | |
64 | "user", /* USRQUOTA */ \ | |
65 | "group", /* GRPQUOTA */ \ | |
66 | "undefined", \ | |
67 | }; | |
68 | ||
69 | /* | |
70 | * Command definitions for the 'quotactl' system call. | |
71 | * The commands are broken into a main command defined below | |
72 | * and a subcommand that is used to convey the type of | |
73 | * quota that is being manipulated (see above). | |
74 | */ | |
75 | #define SUBCMDMASK 0x00ff | |
76 | #define SUBCMDSHIFT 8 | |
77 | #define QCMD(cmd, type) (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK)) | |
78 | ||
79 | #define Q_SYNC 0x800001 /* sync disk copy of a filesystems quotas */ | |
80 | #define Q_QUOTAON 0x800002 /* turn quotas on */ | |
81 | #define Q_QUOTAOFF 0x800003 /* turn quotas off */ | |
82 | #define Q_GETFMT 0x800004 /* get quota format used on given filesystem */ | |
83 | #define Q_GETINFO 0x800005 /* get information about quota files */ | |
84 | #define Q_SETINFO 0x800006 /* set information about quota files */ | |
85 | #define Q_GETQUOTA 0x800007 /* get user quota structure */ | |
86 | #define Q_SETQUOTA 0x800008 /* set user quota structure */ | |
87 | ||
88 | /* | |
89 | * Quota structure used for communication with userspace via quotactl | |
90 | * Following flags are used to specify which fields are valid | |
91 | */ | |
92 | #define QIF_BLIMITS 1 | |
93 | #define QIF_SPACE 2 | |
94 | #define QIF_ILIMITS 4 | |
95 | #define QIF_INODES 8 | |
96 | #define QIF_BTIME 16 | |
97 | #define QIF_ITIME 32 | |
98 | #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS) | |
99 | #define QIF_USAGE (QIF_SPACE | QIF_INODES) | |
100 | #define QIF_TIMES (QIF_BTIME | QIF_ITIME) | |
101 | #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES) | |
102 | ||
103 | struct if_dqblk { | |
104 | __u64 dqb_bhardlimit; | |
105 | __u64 dqb_bsoftlimit; | |
106 | __u64 dqb_curspace; | |
107 | __u64 dqb_ihardlimit; | |
108 | __u64 dqb_isoftlimit; | |
109 | __u64 dqb_curinodes; | |
110 | __u64 dqb_btime; | |
111 | __u64 dqb_itime; | |
112 | __u32 dqb_valid; | |
113 | }; | |
114 | ||
115 | /* | |
116 | * Structure used for setting quota information about file via quotactl | |
117 | * Following flags are used to specify which fields are valid | |
118 | */ | |
119 | #define IIF_BGRACE 1 | |
120 | #define IIF_IGRACE 2 | |
121 | #define IIF_FLAGS 4 | |
122 | #define IIF_ALL (IIF_BGRACE | IIF_IGRACE | IIF_FLAGS) | |
123 | ||
124 | struct if_dqinfo { | |
125 | __u64 dqi_bgrace; | |
126 | __u64 dqi_igrace; | |
127 | __u32 dqi_flags; | |
128 | __u32 dqi_valid; | |
129 | }; | |
130 | ||
8e893469 JK |
131 | /* |
132 | * Definitions for quota netlink interface | |
133 | */ | |
134 | #define QUOTA_NL_NOWARN 0 | |
135 | #define QUOTA_NL_IHARDWARN 1 /* Inode hardlimit reached */ | |
136 | #define QUOTA_NL_ISOFTLONGWARN 2 /* Inode grace time expired */ | |
137 | #define QUOTA_NL_ISOFTWARN 3 /* Inode softlimit reached */ | |
138 | #define QUOTA_NL_BHARDWARN 4 /* Block hardlimit reached */ | |
139 | #define QUOTA_NL_BSOFTLONGWARN 5 /* Block grace time expired */ | |
140 | #define QUOTA_NL_BSOFTWARN 6 /* Block softlimit reached */ | |
141 | ||
142 | enum { | |
143 | QUOTA_NL_C_UNSPEC, | |
144 | QUOTA_NL_C_WARNING, | |
145 | __QUOTA_NL_C_MAX, | |
146 | }; | |
147 | #define QUOTA_NL_C_MAX (__QUOTA_NL_C_MAX - 1) | |
148 | ||
149 | enum { | |
150 | QUOTA_NL_A_UNSPEC, | |
151 | QUOTA_NL_A_QTYPE, | |
152 | QUOTA_NL_A_EXCESS_ID, | |
153 | QUOTA_NL_A_WARNING, | |
154 | QUOTA_NL_A_DEV_MAJOR, | |
155 | QUOTA_NL_A_DEV_MINOR, | |
156 | QUOTA_NL_A_CAUSED_ID, | |
157 | __QUOTA_NL_A_MAX, | |
158 | }; | |
159 | #define QUOTA_NL_A_MAX (__QUOTA_NL_A_MAX - 1) | |
160 | ||
161 | ||
1da177e4 | 162 | #ifdef __KERNEL__ |
8b91de2e | 163 | #include <linux/list.h> |
0409d3a3 | 164 | #include <linux/mutex.h> |
8b91de2e MW |
165 | #include <linux/rwsem.h> |
166 | #include <linux/spinlock.h> | |
167 | #include <linux/wait.h> | |
1da177e4 LT |
168 | |
169 | #include <linux/dqblk_xfs.h> | |
170 | #include <linux/dqblk_v1.h> | |
171 | #include <linux/dqblk_v2.h> | |
172 | ||
8b91de2e MW |
173 | #include <asm/atomic.h> |
174 | ||
acd64b73 MF |
175 | extern spinlock_t dq_data_lock; |
176 | ||
1da177e4 | 177 | /* Maximal numbers of writes for quota operation (insert/delete/update) |
4e5117ba JK |
178 | * (over VFS all formats) */ |
179 | #define DQUOT_INIT_ALLOC max(V1_INIT_ALLOC, V2_INIT_ALLOC) | |
180 | #define DQUOT_INIT_REWRITE max(V1_INIT_REWRITE, V2_INIT_REWRITE) | |
181 | #define DQUOT_DEL_ALLOC max(V1_DEL_ALLOC, V2_DEL_ALLOC) | |
182 | #define DQUOT_DEL_REWRITE max(V1_DEL_REWRITE, V2_DEL_REWRITE) | |
1da177e4 LT |
183 | |
184 | /* | |
185 | * Data for one user/group kept in memory | |
186 | */ | |
187 | struct mem_dqblk { | |
188 | __u32 dqb_bhardlimit; /* absolute limit on disk blks alloc */ | |
189 | __u32 dqb_bsoftlimit; /* preferred limit on disk blks */ | |
190 | qsize_t dqb_curspace; /* current used space */ | |
191 | __u32 dqb_ihardlimit; /* absolute limit on allocated inodes */ | |
192 | __u32 dqb_isoftlimit; /* preferred inode limit */ | |
193 | __u32 dqb_curinodes; /* current # allocated inodes */ | |
194 | time_t dqb_btime; /* time limit for excessive disk use */ | |
195 | time_t dqb_itime; /* time limit for excessive inode use */ | |
196 | }; | |
197 | ||
198 | /* | |
199 | * Data for one quotafile kept in memory | |
200 | */ | |
201 | struct quota_format_type; | |
202 | ||
203 | struct mem_dqinfo { | |
204 | struct quota_format_type *dqi_format; | |
0ff5af83 JK |
205 | int dqi_fmt_id; /* Id of the dqi_format - used when turning |
206 | * quotas on after remount RW */ | |
1da177e4 LT |
207 | struct list_head dqi_dirty_list; /* List of dirty dquots */ |
208 | unsigned long dqi_flags; | |
209 | unsigned int dqi_bgrace; | |
210 | unsigned int dqi_igrace; | |
338bf9af AP |
211 | qsize_t dqi_maxblimit; |
212 | qsize_t dqi_maxilimit; | |
1da177e4 LT |
213 | union { |
214 | struct v1_mem_dqinfo v1_i; | |
215 | struct v2_mem_dqinfo v2_i; | |
216 | } u; | |
217 | }; | |
218 | ||
219 | struct super_block; | |
220 | ||
221 | #define DQF_MASK 0xffff /* Mask for format specific flags */ | |
222 | #define DQF_INFO_DIRTY_B 16 | |
223 | #define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B) /* Is info dirty? */ | |
224 | ||
225 | extern void mark_info_dirty(struct super_block *sb, int type); | |
226 | #define info_dirty(info) test_bit(DQF_INFO_DIRTY_B, &(info)->dqi_flags) | |
1da177e4 LT |
227 | |
228 | #define sb_dqopt(sb) (&(sb)->s_dquot) | |
229 | #define sb_dqinfo(sb, type) (sb_dqopt(sb)->info+(type)) | |
230 | ||
231 | struct dqstats { | |
232 | int lookups; | |
233 | int drops; | |
234 | int reads; | |
235 | int writes; | |
236 | int cache_hits; | |
237 | int allocated_dquots; | |
238 | int free_dquots; | |
239 | int syncs; | |
240 | }; | |
241 | ||
242 | extern struct dqstats dqstats; | |
243 | ||
244 | #define DQ_MOD_B 0 /* dquot modified since read */ | |
245 | #define DQ_BLKS_B 1 /* uid/gid has been warned about blk limit */ | |
246 | #define DQ_INODES_B 2 /* uid/gid has been warned about inode limit */ | |
247 | #define DQ_FAKE_B 3 /* no limits only usage */ | |
248 | #define DQ_READ_B 4 /* dquot was read into memory */ | |
249 | #define DQ_ACTIVE_B 5 /* dquot is active (dquot_release not called) */ | |
1da177e4 LT |
250 | |
251 | struct dquot { | |
252 | struct hlist_node dq_hash; /* Hash list in memory */ | |
253 | struct list_head dq_inuse; /* List of all quotas */ | |
254 | struct list_head dq_free; /* Free list element */ | |
255 | struct list_head dq_dirty; /* List of dirty dquots */ | |
d3be915f | 256 | struct mutex dq_lock; /* dquot IO lock */ |
1da177e4 LT |
257 | atomic_t dq_count; /* Use count */ |
258 | wait_queue_head_t dq_wait_unused; /* Wait queue for dquot to become unused */ | |
259 | struct super_block *dq_sb; /* superblock this applies to */ | |
260 | unsigned int dq_id; /* ID this applies to (uid, gid) */ | |
261 | loff_t dq_off; /* Offset of dquot on disk */ | |
262 | unsigned long dq_flags; /* See DQ_* */ | |
263 | short dq_type; /* Type of quota */ | |
264 | struct mem_dqblk dq_dqb; /* Diskquota usage */ | |
265 | }; | |
266 | ||
267 | #define NODQUOT (struct dquot *)NULL | |
268 | ||
269 | #define QUOTA_OK 0 | |
270 | #define NO_QUOTA 1 | |
271 | ||
272 | /* Operations which must be implemented by each quota format */ | |
273 | struct quota_format_ops { | |
274 | int (*check_quota_file)(struct super_block *sb, int type); /* Detect whether file is in our format */ | |
275 | int (*read_file_info)(struct super_block *sb, int type); /* Read main info about file - called on quotaon() */ | |
276 | int (*write_file_info)(struct super_block *sb, int type); /* Write main info about file */ | |
277 | int (*free_file_info)(struct super_block *sb, int type); /* Called on quotaoff() */ | |
278 | int (*read_dqblk)(struct dquot *dquot); /* Read structure for one user */ | |
279 | int (*commit_dqblk)(struct dquot *dquot); /* Write structure for one user */ | |
280 | int (*release_dqblk)(struct dquot *dquot); /* Called when last reference to dquot is being dropped */ | |
281 | }; | |
282 | ||
283 | /* Operations working with dquots */ | |
284 | struct dquot_operations { | |
285 | int (*initialize) (struct inode *, int); | |
286 | int (*drop) (struct inode *); | |
287 | int (*alloc_space) (struct inode *, qsize_t, int); | |
288 | int (*alloc_inode) (const struct inode *, unsigned long); | |
289 | int (*free_space) (struct inode *, qsize_t); | |
290 | int (*free_inode) (const struct inode *, unsigned long); | |
291 | int (*transfer) (struct inode *, struct iattr *); | |
292 | int (*write_dquot) (struct dquot *); /* Ordinary dquot write */ | |
293 | int (*acquire_dquot) (struct dquot *); /* Quota is going to be created on disk */ | |
294 | int (*release_dquot) (struct dquot *); /* Quota is going to be deleted from disk */ | |
295 | int (*mark_dirty) (struct dquot *); /* Dquot is marked dirty */ | |
296 | int (*write_info) (struct super_block *, int); /* Write of quota "superblock" */ | |
297 | }; | |
298 | ||
299 | /* Operations handling requests from userspace */ | |
300 | struct quotactl_ops { | |
0ff5af83 JK |
301 | int (*quota_on)(struct super_block *, int, int, char *, int); |
302 | int (*quota_off)(struct super_block *, int, int); | |
1da177e4 LT |
303 | int (*quota_sync)(struct super_block *, int); |
304 | int (*get_info)(struct super_block *, int, struct if_dqinfo *); | |
305 | int (*set_info)(struct super_block *, int, struct if_dqinfo *); | |
306 | int (*get_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *); | |
307 | int (*set_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *); | |
308 | int (*get_xstate)(struct super_block *, struct fs_quota_stat *); | |
309 | int (*set_xstate)(struct super_block *, unsigned int, int); | |
310 | int (*get_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *); | |
311 | int (*set_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *); | |
312 | }; | |
313 | ||
314 | struct quota_format_type { | |
315 | int qf_fmt_id; /* Quota format id */ | |
316 | struct quota_format_ops *qf_ops; /* Operations of format */ | |
317 | struct module *qf_owner; /* Module implementing quota format */ | |
318 | struct quota_format_type *qf_next; | |
319 | }; | |
320 | ||
321 | #define DQUOT_USR_ENABLED 0x01 /* User diskquotas enabled */ | |
322 | #define DQUOT_GRP_ENABLED 0x02 /* Group diskquotas enabled */ | |
0ff5af83 JK |
323 | #define DQUOT_USR_SUSPENDED 0x04 /* User diskquotas are off, but |
324 | * we have necessary info in | |
325 | * memory to turn them on */ | |
326 | #define DQUOT_GRP_SUSPENDED 0x08 /* The same for group quotas */ | |
1da177e4 LT |
327 | |
328 | struct quota_info { | |
329 | unsigned int flags; /* Flags for diskquotas on this device */ | |
d3be915f IM |
330 | struct mutex dqio_mutex; /* lock device while I/O in progress */ |
331 | struct mutex dqonoff_mutex; /* Serialize quotaon & quotaoff */ | |
1da177e4 LT |
332 | struct rw_semaphore dqptr_sem; /* serialize ops using quota_info struct, pointers from inode to dquots */ |
333 | struct inode *files[MAXQUOTAS]; /* inodes of quotafiles */ | |
1da177e4 LT |
334 | struct mem_dqinfo info[MAXQUOTAS]; /* Information for each quota type */ |
335 | struct quota_format_ops *ops[MAXQUOTAS]; /* Operations for each type */ | |
336 | }; | |
337 | ||
1da177e4 LT |
338 | #define sb_has_quota_enabled(sb, type) ((type)==USRQUOTA ? \ |
339 | (sb_dqopt(sb)->flags & DQUOT_USR_ENABLED) : (sb_dqopt(sb)->flags & DQUOT_GRP_ENABLED)) | |
340 | ||
341 | #define sb_any_quota_enabled(sb) (sb_has_quota_enabled(sb, USRQUOTA) | \ | |
342 | sb_has_quota_enabled(sb, GRPQUOTA)) | |
343 | ||
0ff5af83 JK |
344 | #define sb_has_quota_suspended(sb, type) \ |
345 | ((type) == USRQUOTA ? (sb_dqopt(sb)->flags & DQUOT_USR_SUSPENDED) : \ | |
346 | (sb_dqopt(sb)->flags & DQUOT_GRP_SUSPENDED)) | |
347 | ||
c32e026e JK |
348 | #define sb_any_quota_suspended(sb) (sb_has_quota_suspended(sb, USRQUOTA) | \ |
349 | sb_has_quota_suspended(sb, GRPQUOTA)) | |
350 | ||
1da177e4 LT |
351 | int register_quota_format(struct quota_format_type *fmt); |
352 | void unregister_quota_format(struct quota_format_type *fmt); | |
353 | ||
354 | struct quota_module_name { | |
355 | int qm_fmt_id; | |
356 | char *qm_mod_name; | |
357 | }; | |
358 | ||
359 | #define INIT_QUOTA_MODULE_NAMES {\ | |
360 | {QFMT_VFS_OLD, "quota_v1"},\ | |
361 | {QFMT_VFS_V0, "quota_v2"},\ | |
362 | {0, NULL}} | |
363 | ||
364 | #else | |
365 | ||
366 | # /* nodep */ include <sys/cdefs.h> | |
367 | ||
368 | __BEGIN_DECLS | |
369 | long quotactl __P ((unsigned int, const char *, int, caddr_t)); | |
370 | __END_DECLS | |
371 | ||
372 | #endif /* __KERNEL__ */ | |
373 | #endif /* _QUOTA_ */ |