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