diff options
Diffstat (limited to 'include/linux/quota.h')
-rw-r--r-- | include/linux/quota.h | 327 |
1 files changed, 327 insertions, 0 deletions
diff --git a/include/linux/quota.h b/include/linux/quota.h new file mode 100644 index 000000000000..ac5b90f4f256 --- /dev/null +++ b/include/linux/quota.h | |||
@@ -0,0 +1,327 @@ | |||
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> | ||
40 | #include <linux/spinlock.h> | ||
41 | |||
42 | #define __DQUOT_VERSION__ "dquot_6.5.1" | ||
43 | #define __DQUOT_NUM_VERSION__ 6*10000+5*100+1 | ||
44 | |||
45 | typedef __kernel_uid32_t qid_t; /* Type in which we store ids in memory */ | ||
46 | typedef __u64 qsize_t; /* Type in which we store sizes */ | ||
47 | |||
48 | extern spinlock_t dq_data_lock; | ||
49 | |||
50 | /* Size of blocks in which are counted size limits */ | ||
51 | #define QUOTABLOCK_BITS 10 | ||
52 | #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS) | ||
53 | |||
54 | /* Conversion routines from and to quota blocks */ | ||
55 | #define qb2kb(x) ((x) << (QUOTABLOCK_BITS-10)) | ||
56 | #define kb2qb(x) ((x) >> (QUOTABLOCK_BITS-10)) | ||
57 | #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS) | ||
58 | |||
59 | #define MAXQUOTAS 2 | ||
60 | #define USRQUOTA 0 /* element used for user quotas */ | ||
61 | #define GRPQUOTA 1 /* element used for group quotas */ | ||
62 | |||
63 | /* | ||
64 | * Definitions for the default names of the quotas files. | ||
65 | */ | ||
66 | #define INITQFNAMES { \ | ||
67 | "user", /* USRQUOTA */ \ | ||
68 | "group", /* GRPQUOTA */ \ | ||
69 | "undefined", \ | ||
70 | }; | ||
71 | |||
72 | /* | ||
73 | * Command definitions for the 'quotactl' system call. | ||
74 | * The commands are broken into a main command defined below | ||
75 | * and a subcommand that is used to convey the type of | ||
76 | * quota that is being manipulated (see above). | ||
77 | */ | ||
78 | #define SUBCMDMASK 0x00ff | ||
79 | #define SUBCMDSHIFT 8 | ||
80 | #define QCMD(cmd, type) (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK)) | ||
81 | |||
82 | #define Q_SYNC 0x800001 /* sync disk copy of a filesystems quotas */ | ||
83 | #define Q_QUOTAON 0x800002 /* turn quotas on */ | ||
84 | #define Q_QUOTAOFF 0x800003 /* turn quotas off */ | ||
85 | #define Q_GETFMT 0x800004 /* get quota format used on given filesystem */ | ||
86 | #define Q_GETINFO 0x800005 /* get information about quota files */ | ||
87 | #define Q_SETINFO 0x800006 /* set information about quota files */ | ||
88 | #define Q_GETQUOTA 0x800007 /* get user quota structure */ | ||
89 | #define Q_SETQUOTA 0x800008 /* set user quota structure */ | ||
90 | |||
91 | /* | ||
92 | * Quota structure used for communication with userspace via quotactl | ||
93 | * Following flags are used to specify which fields are valid | ||
94 | */ | ||
95 | #define QIF_BLIMITS 1 | ||
96 | #define QIF_SPACE 2 | ||
97 | #define QIF_ILIMITS 4 | ||
98 | #define QIF_INODES 8 | ||
99 | #define QIF_BTIME 16 | ||
100 | #define QIF_ITIME 32 | ||
101 | #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS) | ||
102 | #define QIF_USAGE (QIF_SPACE | QIF_INODES) | ||
103 | #define QIF_TIMES (QIF_BTIME | QIF_ITIME) | ||
104 | #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES) | ||
105 | |||
106 | struct if_dqblk { | ||
107 | __u64 dqb_bhardlimit; | ||
108 | __u64 dqb_bsoftlimit; | ||
109 | __u64 dqb_curspace; | ||
110 | __u64 dqb_ihardlimit; | ||
111 | __u64 dqb_isoftlimit; | ||
112 | __u64 dqb_curinodes; | ||
113 | __u64 dqb_btime; | ||
114 | __u64 dqb_itime; | ||
115 | __u32 dqb_valid; | ||
116 | }; | ||
117 | |||
118 | /* | ||
119 | * Structure used for setting quota information about file via quotactl | ||
120 | * Following flags are used to specify which fields are valid | ||
121 | */ | ||
122 | #define IIF_BGRACE 1 | ||
123 | #define IIF_IGRACE 2 | ||
124 | #define IIF_FLAGS 4 | ||
125 | #define IIF_ALL (IIF_BGRACE | IIF_IGRACE | IIF_FLAGS) | ||
126 | |||
127 | struct if_dqinfo { | ||
128 | __u64 dqi_bgrace; | ||
129 | __u64 dqi_igrace; | ||
130 | __u32 dqi_flags; | ||
131 | __u32 dqi_valid; | ||
132 | }; | ||
133 | |||
134 | #ifdef __KERNEL__ | ||
135 | |||
136 | #include <linux/dqblk_xfs.h> | ||
137 | #include <linux/dqblk_v1.h> | ||
138 | #include <linux/dqblk_v2.h> | ||
139 | |||
140 | /* Maximal numbers of writes for quota operation (insert/delete/update) | ||
141 | * (over all formats) - info block, 4 pointer blocks, data block */ | ||
142 | #define DQUOT_MAX_WRITES 6 | ||
143 | |||
144 | /* | ||
145 | * Data for one user/group kept in memory | ||
146 | */ | ||
147 | struct mem_dqblk { | ||
148 | __u32 dqb_bhardlimit; /* absolute limit on disk blks alloc */ | ||
149 | __u32 dqb_bsoftlimit; /* preferred limit on disk blks */ | ||
150 | qsize_t dqb_curspace; /* current used space */ | ||
151 | __u32 dqb_ihardlimit; /* absolute limit on allocated inodes */ | ||
152 | __u32 dqb_isoftlimit; /* preferred inode limit */ | ||
153 | __u32 dqb_curinodes; /* current # allocated inodes */ | ||
154 | time_t dqb_btime; /* time limit for excessive disk use */ | ||
155 | time_t dqb_itime; /* time limit for excessive inode use */ | ||
156 | }; | ||
157 | |||
158 | /* | ||
159 | * Data for one quotafile kept in memory | ||
160 | */ | ||
161 | struct quota_format_type; | ||
162 | |||
163 | struct mem_dqinfo { | ||
164 | struct quota_format_type *dqi_format; | ||
165 | struct list_head dqi_dirty_list; /* List of dirty dquots */ | ||
166 | unsigned long dqi_flags; | ||
167 | unsigned int dqi_bgrace; | ||
168 | unsigned int dqi_igrace; | ||
169 | union { | ||
170 | struct v1_mem_dqinfo v1_i; | ||
171 | struct v2_mem_dqinfo v2_i; | ||
172 | } u; | ||
173 | }; | ||
174 | |||
175 | struct super_block; | ||
176 | |||
177 | #define DQF_MASK 0xffff /* Mask for format specific flags */ | ||
178 | #define DQF_INFO_DIRTY_B 16 | ||
179 | #define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B) /* Is info dirty? */ | ||
180 | |||
181 | extern void mark_info_dirty(struct super_block *sb, int type); | ||
182 | #define info_dirty(info) test_bit(DQF_INFO_DIRTY_B, &(info)->dqi_flags) | ||
183 | #define info_any_dquot_dirty(info) (!list_empty(&(info)->dqi_dirty_list)) | ||
184 | #define info_any_dirty(info) (info_dirty(info) || info_any_dquot_dirty(info)) | ||
185 | |||
186 | #define sb_dqopt(sb) (&(sb)->s_dquot) | ||
187 | #define sb_dqinfo(sb, type) (sb_dqopt(sb)->info+(type)) | ||
188 | |||
189 | struct dqstats { | ||
190 | int lookups; | ||
191 | int drops; | ||
192 | int reads; | ||
193 | int writes; | ||
194 | int cache_hits; | ||
195 | int allocated_dquots; | ||
196 | int free_dquots; | ||
197 | int syncs; | ||
198 | }; | ||
199 | |||
200 | extern struct dqstats dqstats; | ||
201 | |||
202 | #define DQ_MOD_B 0 /* dquot modified since read */ | ||
203 | #define DQ_BLKS_B 1 /* uid/gid has been warned about blk limit */ | ||
204 | #define DQ_INODES_B 2 /* uid/gid has been warned about inode limit */ | ||
205 | #define DQ_FAKE_B 3 /* no limits only usage */ | ||
206 | #define DQ_READ_B 4 /* dquot was read into memory */ | ||
207 | #define DQ_ACTIVE_B 5 /* dquot is active (dquot_release not called) */ | ||
208 | #define DQ_WAITFREE_B 6 /* dquot being waited (by invalidate_dquots) */ | ||
209 | |||
210 | struct dquot { | ||
211 | struct hlist_node dq_hash; /* Hash list in memory */ | ||
212 | struct list_head dq_inuse; /* List of all quotas */ | ||
213 | struct list_head dq_free; /* Free list element */ | ||
214 | struct list_head dq_dirty; /* List of dirty dquots */ | ||
215 | struct semaphore dq_lock; /* dquot IO lock */ | ||
216 | atomic_t dq_count; /* Use count */ | ||
217 | wait_queue_head_t dq_wait_unused; /* Wait queue for dquot to become unused */ | ||
218 | struct super_block *dq_sb; /* superblock this applies to */ | ||
219 | unsigned int dq_id; /* ID this applies to (uid, gid) */ | ||
220 | loff_t dq_off; /* Offset of dquot on disk */ | ||
221 | unsigned long dq_flags; /* See DQ_* */ | ||
222 | short dq_type; /* Type of quota */ | ||
223 | struct mem_dqblk dq_dqb; /* Diskquota usage */ | ||
224 | }; | ||
225 | |||
226 | #define NODQUOT (struct dquot *)NULL | ||
227 | |||
228 | #define QUOTA_OK 0 | ||
229 | #define NO_QUOTA 1 | ||
230 | |||
231 | /* Operations which must be implemented by each quota format */ | ||
232 | struct quota_format_ops { | ||
233 | int (*check_quota_file)(struct super_block *sb, int type); /* Detect whether file is in our format */ | ||
234 | int (*read_file_info)(struct super_block *sb, int type); /* Read main info about file - called on quotaon() */ | ||
235 | int (*write_file_info)(struct super_block *sb, int type); /* Write main info about file */ | ||
236 | int (*free_file_info)(struct super_block *sb, int type); /* Called on quotaoff() */ | ||
237 | int (*read_dqblk)(struct dquot *dquot); /* Read structure for one user */ | ||
238 | int (*commit_dqblk)(struct dquot *dquot); /* Write structure for one user */ | ||
239 | int (*release_dqblk)(struct dquot *dquot); /* Called when last reference to dquot is being dropped */ | ||
240 | }; | ||
241 | |||
242 | /* Operations working with dquots */ | ||
243 | struct dquot_operations { | ||
244 | int (*initialize) (struct inode *, int); | ||
245 | int (*drop) (struct inode *); | ||
246 | int (*alloc_space) (struct inode *, qsize_t, int); | ||
247 | int (*alloc_inode) (const struct inode *, unsigned long); | ||
248 | int (*free_space) (struct inode *, qsize_t); | ||
249 | int (*free_inode) (const struct inode *, unsigned long); | ||
250 | int (*transfer) (struct inode *, struct iattr *); | ||
251 | int (*write_dquot) (struct dquot *); /* Ordinary dquot write */ | ||
252 | int (*acquire_dquot) (struct dquot *); /* Quota is going to be created on disk */ | ||
253 | int (*release_dquot) (struct dquot *); /* Quota is going to be deleted from disk */ | ||
254 | int (*mark_dirty) (struct dquot *); /* Dquot is marked dirty */ | ||
255 | int (*write_info) (struct super_block *, int); /* Write of quota "superblock" */ | ||
256 | }; | ||
257 | |||
258 | /* Operations handling requests from userspace */ | ||
259 | struct quotactl_ops { | ||
260 | int (*quota_on)(struct super_block *, int, int, char *); | ||
261 | int (*quota_off)(struct super_block *, int); | ||
262 | int (*quota_sync)(struct super_block *, int); | ||
263 | int (*get_info)(struct super_block *, int, struct if_dqinfo *); | ||
264 | int (*set_info)(struct super_block *, int, struct if_dqinfo *); | ||
265 | int (*get_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *); | ||
266 | int (*set_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *); | ||
267 | int (*get_xstate)(struct super_block *, struct fs_quota_stat *); | ||
268 | int (*set_xstate)(struct super_block *, unsigned int, int); | ||
269 | int (*get_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *); | ||
270 | int (*set_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *); | ||
271 | }; | ||
272 | |||
273 | struct quota_format_type { | ||
274 | int qf_fmt_id; /* Quota format id */ | ||
275 | struct quota_format_ops *qf_ops; /* Operations of format */ | ||
276 | struct module *qf_owner; /* Module implementing quota format */ | ||
277 | struct quota_format_type *qf_next; | ||
278 | }; | ||
279 | |||
280 | #define DQUOT_USR_ENABLED 0x01 /* User diskquotas enabled */ | ||
281 | #define DQUOT_GRP_ENABLED 0x02 /* Group diskquotas enabled */ | ||
282 | |||
283 | struct quota_info { | ||
284 | unsigned int flags; /* Flags for diskquotas on this device */ | ||
285 | struct semaphore dqio_sem; /* lock device while I/O in progress */ | ||
286 | struct semaphore dqonoff_sem; /* Serialize quotaon & quotaoff */ | ||
287 | struct rw_semaphore dqptr_sem; /* serialize ops using quota_info struct, pointers from inode to dquots */ | ||
288 | struct inode *files[MAXQUOTAS]; /* inodes of quotafiles */ | ||
289 | struct vfsmount *mnt[MAXQUOTAS]; /* mountpoint entries of filesystems with quota files */ | ||
290 | struct mem_dqinfo info[MAXQUOTAS]; /* Information for each quota type */ | ||
291 | struct quota_format_ops *ops[MAXQUOTAS]; /* Operations for each type */ | ||
292 | }; | ||
293 | |||
294 | /* Inline would be better but we need to dereference super_block which is not defined yet */ | ||
295 | int mark_dquot_dirty(struct dquot *dquot); | ||
296 | |||
297 | #define dquot_dirty(dquot) test_bit(DQ_MOD_B, &(dquot)->dq_flags) | ||
298 | |||
299 | #define sb_has_quota_enabled(sb, type) ((type)==USRQUOTA ? \ | ||
300 | (sb_dqopt(sb)->flags & DQUOT_USR_ENABLED) : (sb_dqopt(sb)->flags & DQUOT_GRP_ENABLED)) | ||
301 | |||
302 | #define sb_any_quota_enabled(sb) (sb_has_quota_enabled(sb, USRQUOTA) | \ | ||
303 | sb_has_quota_enabled(sb, GRPQUOTA)) | ||
304 | |||
305 | int register_quota_format(struct quota_format_type *fmt); | ||
306 | void unregister_quota_format(struct quota_format_type *fmt); | ||
307 | |||
308 | struct quota_module_name { | ||
309 | int qm_fmt_id; | ||
310 | char *qm_mod_name; | ||
311 | }; | ||
312 | |||
313 | #define INIT_QUOTA_MODULE_NAMES {\ | ||
314 | {QFMT_VFS_OLD, "quota_v1"},\ | ||
315 | {QFMT_VFS_V0, "quota_v2"},\ | ||
316 | {0, NULL}} | ||
317 | |||
318 | #else | ||
319 | |||
320 | # /* nodep */ include <sys/cdefs.h> | ||
321 | |||
322 | __BEGIN_DECLS | ||
323 | long quotactl __P ((unsigned int, const char *, int, caddr_t)); | ||
324 | __END_DECLS | ||
325 | |||
326 | #endif /* __KERNEL__ */ | ||
327 | #endif /* _QUOTA_ */ | ||