blob: 54b837fa64f2398752dd9cdef85cd3607ffda1d0 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 */
32
33#ifndef _LINUX_QUOTA_
34#define _LINUX_QUOTA_
35
36#include <linux/errno.h>
37#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Jan Kara571b46e2008-10-30 09:17:52 +010039#define __DQUOT_VERSION__ "dquot_6.5.2"
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#define MAXQUOTAS 2
42#define USRQUOTA 0 /* element used for user quotas */
43#define GRPQUOTA 1 /* element used for group quotas */
44
45/*
46 * Definitions for the default names of the quotas files.
47 */
48#define INITQFNAMES { \
49 "user", /* USRQUOTA */ \
50 "group", /* GRPQUOTA */ \
51 "undefined", \
52};
53
54/*
55 * Command definitions for the 'quotactl' system call.
56 * The commands are broken into a main command defined below
57 * and a subcommand that is used to convey the type of
58 * quota that is being manipulated (see above).
59 */
60#define SUBCMDMASK 0x00ff
61#define SUBCMDSHIFT 8
62#define QCMD(cmd, type) (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))
63
64#define Q_SYNC 0x800001 /* sync disk copy of a filesystems quotas */
65#define Q_QUOTAON 0x800002 /* turn quotas on */
66#define Q_QUOTAOFF 0x800003 /* turn quotas off */
67#define Q_GETFMT 0x800004 /* get quota format used on given filesystem */
68#define Q_GETINFO 0x800005 /* get information about quota files */
69#define Q_SETINFO 0x800006 /* set information about quota files */
70#define Q_GETQUOTA 0x800007 /* get user quota structure */
71#define Q_SETQUOTA 0x800008 /* set user quota structure */
72
Jan Kara5cd9d5b2008-11-25 15:31:31 +010073/* Quota format type IDs */
74#define QFMT_VFS_OLD 1
75#define QFMT_VFS_V0 2
76
Jan Kara12095462008-08-20 14:45:12 +020077/* Size of block in which space limits are passed through the quota
78 * interface */
79#define QIF_DQBLKSIZE_BITS 10
80#define QIF_DQBLKSIZE (1 << QIF_DQBLKSIZE_BITS)
81
Linus Torvalds1da177e2005-04-16 15:20:36 -070082/*
83 * Quota structure used for communication with userspace via quotactl
84 * Following flags are used to specify which fields are valid
85 */
Jan Kara4d59bce2008-10-02 16:48:10 +020086enum {
87 QIF_BLIMITS_B = 0,
88 QIF_SPACE_B,
89 QIF_ILIMITS_B,
90 QIF_INODES_B,
91 QIF_BTIME_B,
92 QIF_ITIME_B,
93};
94
95#define QIF_BLIMITS (1 << QIF_BLIMITS_B)
96#define QIF_SPACE (1 << QIF_SPACE_B)
97#define QIF_ILIMITS (1 << QIF_ILIMITS_B)
98#define QIF_INODES (1 << QIF_INODES_B)
99#define QIF_BTIME (1 << QIF_BTIME_B)
100#define QIF_ITIME (1 << QIF_ITIME_B)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101#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
106struct 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
127struct if_dqinfo {
128 __u64 dqi_bgrace;
129 __u64 dqi_igrace;
130 __u32 dqi_flags;
131 __u32 dqi_valid;
132};
133
Jan Kara8e893462007-10-16 23:29:31 -0700134/*
135 * Definitions for quota netlink interface
136 */
137#define QUOTA_NL_NOWARN 0
138#define QUOTA_NL_IHARDWARN 1 /* Inode hardlimit reached */
139#define QUOTA_NL_ISOFTLONGWARN 2 /* Inode grace time expired */
140#define QUOTA_NL_ISOFTWARN 3 /* Inode softlimit reached */
141#define QUOTA_NL_BHARDWARN 4 /* Block hardlimit reached */
142#define QUOTA_NL_BSOFTLONGWARN 5 /* Block grace time expired */
143#define QUOTA_NL_BSOFTWARN 6 /* Block softlimit reached */
Jan Kara657d3bf2008-07-25 01:46:52 -0700144#define QUOTA_NL_IHARDBELOW 7 /* Usage got below inode hardlimit */
145#define QUOTA_NL_ISOFTBELOW 8 /* Usage got below inode softlimit */
146#define QUOTA_NL_BHARDBELOW 9 /* Usage got below block hardlimit */
147#define QUOTA_NL_BSOFTBELOW 10 /* Usage got below block softlimit */
Jan Kara8e893462007-10-16 23:29:31 -0700148
149enum {
150 QUOTA_NL_C_UNSPEC,
151 QUOTA_NL_C_WARNING,
152 __QUOTA_NL_C_MAX,
153};
154#define QUOTA_NL_C_MAX (__QUOTA_NL_C_MAX - 1)
155
156enum {
157 QUOTA_NL_A_UNSPEC,
158 QUOTA_NL_A_QTYPE,
159 QUOTA_NL_A_EXCESS_ID,
160 QUOTA_NL_A_WARNING,
161 QUOTA_NL_A_DEV_MAJOR,
162 QUOTA_NL_A_DEV_MINOR,
163 QUOTA_NL_A_CAUSED_ID,
164 __QUOTA_NL_A_MAX,
165};
166#define QUOTA_NL_A_MAX (__QUOTA_NL_A_MAX - 1)
167
168
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169#ifdef __KERNEL__
Matthew Wilcox8b91de22008-02-26 09:53:20 -0500170#include <linux/list.h>
David Woodhouse0409d3a2006-04-25 14:52:13 +0100171#include <linux/mutex.h>
Matthew Wilcox8b91de22008-02-26 09:53:20 -0500172#include <linux/rwsem.h>
173#include <linux/spinlock.h>
174#include <linux/wait.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
176#include <linux/dqblk_xfs.h>
177#include <linux/dqblk_v1.h>
178#include <linux/dqblk_v2.h>
179
Matthew Wilcox8b91de22008-02-26 09:53:20 -0500180#include <asm/atomic.h>
181
Jan Kara74abb982008-07-25 01:46:51 -0700182typedef __kernel_uid32_t qid_t; /* Type in which we store ids in memory */
Jan Karadb49d2d2008-10-01 18:21:39 +0200183typedef long long qsize_t; /* Type in which we store sizes */
Jan Kara74abb982008-07-25 01:46:51 -0700184
Mike Frysingeracd64b72007-05-08 00:31:51 -0700185extern spinlock_t dq_data_lock;
186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187/* Maximal numbers of writes for quota operation (insert/delete/update)
Jan Kara4e5117b2005-06-23 22:01:03 -0700188 * (over VFS all formats) */
189#define DQUOT_INIT_ALLOC max(V1_INIT_ALLOC, V2_INIT_ALLOC)
190#define DQUOT_INIT_REWRITE max(V1_INIT_REWRITE, V2_INIT_REWRITE)
191#define DQUOT_DEL_ALLOC max(V1_DEL_ALLOC, V2_DEL_ALLOC)
192#define DQUOT_DEL_REWRITE max(V1_DEL_REWRITE, V2_DEL_REWRITE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194/*
195 * Data for one user/group kept in memory
196 */
197struct mem_dqblk {
Jan Kara12095462008-08-20 14:45:12 +0200198 qsize_t dqb_bhardlimit; /* absolute limit on disk blks alloc */
199 qsize_t dqb_bsoftlimit; /* preferred limit on disk blks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 qsize_t dqb_curspace; /* current used space */
Mingming Caof18df222009-01-13 16:43:09 +0100201 qsize_t dqb_rsvspace; /* current reserved space for delalloc*/
Jan Kara12095462008-08-20 14:45:12 +0200202 qsize_t dqb_ihardlimit; /* absolute limit on allocated inodes */
203 qsize_t dqb_isoftlimit; /* preferred inode limit */
204 qsize_t dqb_curinodes; /* current # allocated inodes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 time_t dqb_btime; /* time limit for excessive disk use */
206 time_t dqb_itime; /* time limit for excessive inode use */
207};
208
209/*
210 * Data for one quotafile kept in memory
211 */
212struct quota_format_type;
213
214struct mem_dqinfo {
215 struct quota_format_type *dqi_format;
Jan Kara0ff5af82008-04-28 02:14:33 -0700216 int dqi_fmt_id; /* Id of the dqi_format - used when turning
217 * quotas on after remount RW */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 struct list_head dqi_dirty_list; /* List of dirty dquots */
219 unsigned long dqi_flags;
220 unsigned int dqi_bgrace;
221 unsigned int dqi_igrace;
Andrew Perepechko338bf9a2008-04-28 02:14:31 -0700222 qsize_t dqi_maxblimit;
223 qsize_t dqi_maxilimit;
Jan Karae3d4d562008-10-02 18:44:14 +0200224 void *dqi_priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225};
226
227struct super_block;
228
229#define DQF_MASK 0xffff /* Mask for format specific flags */
230#define DQF_INFO_DIRTY_B 16
231#define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B) /* Is info dirty? */
232
233extern void mark_info_dirty(struct super_block *sb, int type);
Jan Kara03b06342008-07-25 01:46:52 -0700234static inline int info_dirty(struct mem_dqinfo *info)
235{
236 return test_bit(DQF_INFO_DIRTY_B, &info->dqi_flags);
237}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239struct dqstats {
240 int lookups;
241 int drops;
242 int reads;
243 int writes;
244 int cache_hits;
245 int allocated_dquots;
246 int free_dquots;
247 int syncs;
248};
249
250extern struct dqstats dqstats;
251
252#define DQ_MOD_B 0 /* dquot modified since read */
253#define DQ_BLKS_B 1 /* uid/gid has been warned about blk limit */
254#define DQ_INODES_B 2 /* uid/gid has been warned about inode limit */
255#define DQ_FAKE_B 3 /* no limits only usage */
256#define DQ_READ_B 4 /* dquot was read into memory */
257#define DQ_ACTIVE_B 5 /* dquot is active (dquot_release not called) */
Jan Kara4d59bce2008-10-02 16:48:10 +0200258#define DQ_LASTSET_B 6 /* Following 6 bits (see QIF_) are reserved\
259 * for the mask of entries set via SETQUOTA\
260 * quotactl. They are set under dq_data_lock\
261 * and the quota format handling dquot can\
262 * clear them when it sees fit. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
264struct dquot {
265 struct hlist_node dq_hash; /* Hash list in memory */
266 struct list_head dq_inuse; /* List of all quotas */
267 struct list_head dq_free; /* Free list element */
268 struct list_head dq_dirty; /* List of dirty dquots */
Ingo Molnard3be9152006-03-23 03:00:29 -0800269 struct mutex dq_lock; /* dquot IO lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 atomic_t dq_count; /* Use count */
271 wait_queue_head_t dq_wait_unused; /* Wait queue for dquot to become unused */
272 struct super_block *dq_sb; /* superblock this applies to */
273 unsigned int dq_id; /* ID this applies to (uid, gid) */
274 loff_t dq_off; /* Offset of dquot on disk */
275 unsigned long dq_flags; /* See DQ_* */
276 short dq_type; /* Type of quota */
277 struct mem_dqblk dq_dqb; /* Diskquota usage */
278};
279
280#define NODQUOT (struct dquot *)NULL
281
282#define QUOTA_OK 0
283#define NO_QUOTA 1
284
285/* Operations which must be implemented by each quota format */
286struct quota_format_ops {
287 int (*check_quota_file)(struct super_block *sb, int type); /* Detect whether file is in our format */
288 int (*read_file_info)(struct super_block *sb, int type); /* Read main info about file - called on quotaon() */
289 int (*write_file_info)(struct super_block *sb, int type); /* Write main info about file */
290 int (*free_file_info)(struct super_block *sb, int type); /* Called on quotaoff() */
291 int (*read_dqblk)(struct dquot *dquot); /* Read structure for one user */
292 int (*commit_dqblk)(struct dquot *dquot); /* Write structure for one user */
293 int (*release_dqblk)(struct dquot *dquot); /* Called when last reference to dquot is being dropped */
294};
295
296/* Operations working with dquots */
297struct dquot_operations {
298 int (*initialize) (struct inode *, int);
299 int (*drop) (struct inode *);
300 int (*alloc_space) (struct inode *, qsize_t, int);
Jan Kara12095462008-08-20 14:45:12 +0200301 int (*alloc_inode) (const struct inode *, qsize_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 int (*free_space) (struct inode *, qsize_t);
Jan Kara12095462008-08-20 14:45:12 +0200303 int (*free_inode) (const struct inode *, qsize_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 int (*transfer) (struct inode *, struct iattr *);
305 int (*write_dquot) (struct dquot *); /* Ordinary dquot write */
Jan Kara74f783a2008-08-19 14:51:22 +0200306 struct dquot *(*alloc_dquot)(struct super_block *, int); /* Allocate memory for new dquot */
307 void (*destroy_dquot)(struct dquot *); /* Free memory for dquot */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 int (*acquire_dquot) (struct dquot *); /* Quota is going to be created on disk */
309 int (*release_dquot) (struct dquot *); /* Quota is going to be deleted from disk */
310 int (*mark_dirty) (struct dquot *); /* Dquot is marked dirty */
311 int (*write_info) (struct super_block *, int); /* Write of quota "superblock" */
Mingming Caof18df222009-01-13 16:43:09 +0100312 /* reserve quota for delayed block allocation */
313 int (*reserve_space) (struct inode *, qsize_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314};
315
316/* Operations handling requests from userspace */
317struct quotactl_ops {
Jan Kara0ff5af82008-04-28 02:14:33 -0700318 int (*quota_on)(struct super_block *, int, int, char *, int);
319 int (*quota_off)(struct super_block *, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 int (*quota_sync)(struct super_block *, int);
321 int (*get_info)(struct super_block *, int, struct if_dqinfo *);
322 int (*set_info)(struct super_block *, int, struct if_dqinfo *);
323 int (*get_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
324 int (*set_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
325 int (*get_xstate)(struct super_block *, struct fs_quota_stat *);
326 int (*set_xstate)(struct super_block *, unsigned int, int);
327 int (*get_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
328 int (*set_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
329};
330
331struct quota_format_type {
332 int qf_fmt_id; /* Quota format id */
333 struct quota_format_ops *qf_ops; /* Operations of format */
334 struct module *qf_owner; /* Module implementing quota format */
335 struct quota_format_type *qf_next;
336};
337
Jan Karaf55abc02008-08-20 17:50:32 +0200338/* Quota state flags - they actually come in two flavors - for users and groups */
339enum {
340 _DQUOT_USAGE_ENABLED = 0, /* Track disk usage for users */
341 _DQUOT_LIMITS_ENABLED, /* Enforce quota limits for users */
342 _DQUOT_SUSPENDED, /* User diskquotas are off, but
Jan Kara0ff5af82008-04-28 02:14:33 -0700343 * we have necessary info in
344 * memory to turn them on */
Jan Karaf55abc02008-08-20 17:50:32 +0200345 _DQUOT_STATE_FLAGS
346};
347#define DQUOT_USAGE_ENABLED (1 << _DQUOT_USAGE_ENABLED)
348#define DQUOT_LIMITS_ENABLED (1 << _DQUOT_LIMITS_ENABLED)
349#define DQUOT_SUSPENDED (1 << _DQUOT_SUSPENDED)
350#define DQUOT_STATE_FLAGS (DQUOT_USAGE_ENABLED | DQUOT_LIMITS_ENABLED | \
351 DQUOT_SUSPENDED)
Jan Karaca785ec2008-09-30 17:53:37 +0200352/* Other quota flags */
353#define DQUOT_QUOTA_SYS_FILE (1 << 6) /* Quota file is a special
354 * system file and user cannot
355 * touch it. Filesystem is
356 * responsible for setting
357 * S_NOQUOTA, S_NOATIME flags
358 */
Jan Karadb49d2d2008-10-01 18:21:39 +0200359#define DQUOT_NEGATIVE_USAGE (1 << 7) /* Allow negative quota usage */
Jan Karaf55abc02008-08-20 17:50:32 +0200360
361static inline unsigned int dquot_state_flag(unsigned int flags, int type)
362{
363 if (type == USRQUOTA)
364 return flags;
365 return flags << _DQUOT_STATE_FLAGS;
366}
367
368static inline unsigned int dquot_generic_flag(unsigned int flags, int type)
369{
370 if (type == USRQUOTA)
371 return flags;
372 return flags >> _DQUOT_STATE_FLAGS;
373}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
375struct quota_info {
376 unsigned int flags; /* Flags for diskquotas on this device */
Ingo Molnard3be9152006-03-23 03:00:29 -0800377 struct mutex dqio_mutex; /* lock device while I/O in progress */
378 struct mutex dqonoff_mutex; /* Serialize quotaon & quotaoff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 struct rw_semaphore dqptr_sem; /* serialize ops using quota_info struct, pointers from inode to dquots */
380 struct inode *files[MAXQUOTAS]; /* inodes of quotafiles */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 struct mem_dqinfo info[MAXQUOTAS]; /* Information for each quota type */
382 struct quota_format_ops *ops[MAXQUOTAS]; /* Operations for each type */
383};
384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385int register_quota_format(struct quota_format_type *fmt);
386void unregister_quota_format(struct quota_format_type *fmt);
387
388struct quota_module_name {
389 int qm_fmt_id;
390 char *qm_mod_name;
391};
392
393#define INIT_QUOTA_MODULE_NAMES {\
394 {QFMT_VFS_OLD, "quota_v1"},\
395 {QFMT_VFS_V0, "quota_v2"},\
396 {0, NULL}}
397
398#else
399
400# /* nodep */ include <sys/cdefs.h>
401
402__BEGIN_DECLS
403long quotactl __P ((unsigned int, const char *, int, caddr_t));
404__END_DECLS
405
406#endif /* __KERNEL__ */
407#endif /* _QUOTA_ */