user namespace: add the framework
[linux-2.6.git] / include / linux / quota.h
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
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
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
131 #ifdef __KERNEL__
132 #include <linux/spinlock.h>
133 #include <linux/rwsem.h>
134 #include <linux/mutex.h>
135
136 #include <linux/dqblk_xfs.h>
137 #include <linux/dqblk_v1.h>
138 #include <linux/dqblk_v2.h>
139
140 extern spinlock_t dq_data_lock;
141
142 /* Maximal numbers of writes for quota operation (insert/delete/update)
143  * (over VFS all formats) */
144 #define DQUOT_INIT_ALLOC max(V1_INIT_ALLOC, V2_INIT_ALLOC)
145 #define DQUOT_INIT_REWRITE max(V1_INIT_REWRITE, V2_INIT_REWRITE)
146 #define DQUOT_DEL_ALLOC max(V1_DEL_ALLOC, V2_DEL_ALLOC)
147 #define DQUOT_DEL_REWRITE max(V1_DEL_REWRITE, V2_DEL_REWRITE)
148
149 /*
150  * Data for one user/group kept in memory
151  */
152 struct mem_dqblk {
153         __u32 dqb_bhardlimit;   /* absolute limit on disk blks alloc */
154         __u32 dqb_bsoftlimit;   /* preferred limit on disk blks */
155         qsize_t dqb_curspace;   /* current used space */
156         __u32 dqb_ihardlimit;   /* absolute limit on allocated inodes */
157         __u32 dqb_isoftlimit;   /* preferred inode limit */
158         __u32 dqb_curinodes;    /* current # allocated inodes */
159         time_t dqb_btime;       /* time limit for excessive disk use */
160         time_t dqb_itime;       /* time limit for excessive inode use */
161 };
162
163 /*
164  * Data for one quotafile kept in memory
165  */
166 struct quota_format_type;
167
168 struct mem_dqinfo {
169         struct quota_format_type *dqi_format;
170         struct list_head dqi_dirty_list;        /* List of dirty dquots */
171         unsigned long dqi_flags;
172         unsigned int dqi_bgrace;
173         unsigned int dqi_igrace;
174         union {
175                 struct v1_mem_dqinfo v1_i;
176                 struct v2_mem_dqinfo v2_i;
177         } u;
178 };
179
180 struct super_block;
181
182 #define DQF_MASK 0xffff         /* Mask for format specific flags */
183 #define DQF_INFO_DIRTY_B 16
184 #define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B)  /* Is info dirty? */
185
186 extern void mark_info_dirty(struct super_block *sb, int type);
187 #define info_dirty(info) test_bit(DQF_INFO_DIRTY_B, &(info)->dqi_flags)
188 #define info_any_dquot_dirty(info) (!list_empty(&(info)->dqi_dirty_list))
189 #define info_any_dirty(info) (info_dirty(info) || info_any_dquot_dirty(info))
190
191 #define sb_dqopt(sb) (&(sb)->s_dquot)
192 #define sb_dqinfo(sb, type) (sb_dqopt(sb)->info+(type))
193
194 struct dqstats {
195         int lookups;
196         int drops;
197         int reads;
198         int writes;
199         int cache_hits;
200         int allocated_dquots;
201         int free_dquots;
202         int syncs;
203 };
204
205 extern struct dqstats dqstats;
206
207 #define DQ_MOD_B        0       /* dquot modified since read */
208 #define DQ_BLKS_B       1       /* uid/gid has been warned about blk limit */
209 #define DQ_INODES_B     2       /* uid/gid has been warned about inode limit */
210 #define DQ_FAKE_B       3       /* no limits only usage */
211 #define DQ_READ_B       4       /* dquot was read into memory */
212 #define DQ_ACTIVE_B     5       /* dquot is active (dquot_release not called) */
213
214 struct dquot {
215         struct hlist_node dq_hash;      /* Hash list in memory */
216         struct list_head dq_inuse;      /* List of all quotas */
217         struct list_head dq_free;       /* Free list element */
218         struct list_head dq_dirty;      /* List of dirty dquots */
219         struct mutex dq_lock;           /* dquot IO lock */
220         atomic_t dq_count;              /* Use count */
221         wait_queue_head_t dq_wait_unused;       /* Wait queue for dquot to become unused */
222         struct super_block *dq_sb;      /* superblock this applies to */
223         unsigned int dq_id;             /* ID this applies to (uid, gid) */
224         loff_t dq_off;                  /* Offset of dquot on disk */
225         unsigned long dq_flags;         /* See DQ_* */
226         short dq_type;                  /* Type of quota */
227         struct mem_dqblk dq_dqb;        /* Diskquota usage */
228 };
229
230 #define NODQUOT (struct dquot *)NULL
231
232 #define QUOTA_OK          0
233 #define NO_QUOTA          1
234
235 /* Operations which must be implemented by each quota format */
236 struct quota_format_ops {
237         int (*check_quota_file)(struct super_block *sb, int type);      /* Detect whether file is in our format */
238         int (*read_file_info)(struct super_block *sb, int type);        /* Read main info about file - called on quotaon() */
239         int (*write_file_info)(struct super_block *sb, int type);       /* Write main info about file */
240         int (*free_file_info)(struct super_block *sb, int type);        /* Called on quotaoff() */
241         int (*read_dqblk)(struct dquot *dquot);         /* Read structure for one user */
242         int (*commit_dqblk)(struct dquot *dquot);       /* Write structure for one user */
243         int (*release_dqblk)(struct dquot *dquot);      /* Called when last reference to dquot is being dropped */
244 };
245
246 /* Operations working with dquots */
247 struct dquot_operations {
248         int (*initialize) (struct inode *, int);
249         int (*drop) (struct inode *);
250         int (*alloc_space) (struct inode *, qsize_t, int);
251         int (*alloc_inode) (const struct inode *, unsigned long);
252         int (*free_space) (struct inode *, qsize_t);
253         int (*free_inode) (const struct inode *, unsigned long);
254         int (*transfer) (struct inode *, struct iattr *);
255         int (*write_dquot) (struct dquot *);            /* Ordinary dquot write */
256         int (*acquire_dquot) (struct dquot *);          /* Quota is going to be created on disk */
257         int (*release_dquot) (struct dquot *);          /* Quota is going to be deleted from disk */
258         int (*mark_dirty) (struct dquot *);             /* Dquot is marked dirty */
259         int (*write_info) (struct super_block *, int);  /* Write of quota "superblock" */
260 };
261
262 /* Operations handling requests from userspace */
263 struct quotactl_ops {
264         int (*quota_on)(struct super_block *, int, int, char *);
265         int (*quota_off)(struct super_block *, int);
266         int (*quota_sync)(struct super_block *, int);
267         int (*get_info)(struct super_block *, int, struct if_dqinfo *);
268         int (*set_info)(struct super_block *, int, struct if_dqinfo *);
269         int (*get_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
270         int (*set_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
271         int (*get_xstate)(struct super_block *, struct fs_quota_stat *);
272         int (*set_xstate)(struct super_block *, unsigned int, int);
273         int (*get_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
274         int (*set_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
275 };
276
277 struct quota_format_type {
278         int qf_fmt_id;  /* Quota format id */
279         struct quota_format_ops *qf_ops;        /* Operations of format */
280         struct module *qf_owner;                /* Module implementing quota format */
281         struct quota_format_type *qf_next;
282 };
283
284 #define DQUOT_USR_ENABLED       0x01            /* User diskquotas enabled */
285 #define DQUOT_GRP_ENABLED       0x02            /* Group diskquotas enabled */
286
287 struct quota_info {
288         unsigned int flags;                     /* Flags for diskquotas on this device */
289         struct mutex dqio_mutex;                /* lock device while I/O in progress */
290         struct mutex dqonoff_mutex;             /* Serialize quotaon & quotaoff */
291         struct rw_semaphore dqptr_sem;          /* serialize ops using quota_info struct, pointers from inode to dquots */
292         struct inode *files[MAXQUOTAS];         /* inodes of quotafiles */
293         struct mem_dqinfo info[MAXQUOTAS];      /* Information for each quota type */
294         struct quota_format_ops *ops[MAXQUOTAS];        /* Operations for each type */
295 };
296
297 /* Inline would be better but we need to dereference super_block which is not defined yet */
298 int mark_dquot_dirty(struct dquot *dquot);
299
300 #define dquot_dirty(dquot) test_bit(DQ_MOD_B, &(dquot)->dq_flags)
301
302 #define sb_has_quota_enabled(sb, type) ((type)==USRQUOTA ? \
303         (sb_dqopt(sb)->flags & DQUOT_USR_ENABLED) : (sb_dqopt(sb)->flags & DQUOT_GRP_ENABLED))
304
305 #define sb_any_quota_enabled(sb) (sb_has_quota_enabled(sb, USRQUOTA) | \
306                                   sb_has_quota_enabled(sb, GRPQUOTA))
307
308 int register_quota_format(struct quota_format_type *fmt);
309 void unregister_quota_format(struct quota_format_type *fmt);
310
311 struct quota_module_name {
312         int qm_fmt_id;
313         char *qm_mod_name;
314 };
315
316 #define INIT_QUOTA_MODULE_NAMES {\
317         {QFMT_VFS_OLD, "quota_v1"},\
318         {QFMT_VFS_V0, "quota_v2"},\
319         {0, NULL}}
320
321 #else
322
323 # /* nodep */ include <sys/cdefs.h>
324
325 __BEGIN_DECLS
326 long quotactl __P ((unsigned int, const char *, int, caddr_t));
327 __END_DECLS
328
329 #endif /* __KERNEL__ */
330 #endif /* _QUOTA_ */