blob: b462916b2a0a4c53d8af6e1c14f4f94491907e2a [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
Jan Kara30673932009-11-30 22:17:41 +010076#define QFMT_OCFS2 3
Jan Kara498c6012009-11-16 18:09:47 +010077#define QFMT_VFS_V1 4
Jan Kara5cd9d5b2008-11-25 15:31:31 +010078
Jan Kara12095462008-08-20 14:45:12 +020079/* Size of block in which space limits are passed through the quota
80 * interface */
81#define QIF_DQBLKSIZE_BITS 10
82#define QIF_DQBLKSIZE (1 << QIF_DQBLKSIZE_BITS)
83
Linus Torvalds1da177e2005-04-16 15:20:36 -070084/*
85 * Quota structure used for communication with userspace via quotactl
86 * Following flags are used to specify which fields are valid
87 */
Jan Kara4d59bce2008-10-02 16:48:10 +020088enum {
89 QIF_BLIMITS_B = 0,
90 QIF_SPACE_B,
91 QIF_ILIMITS_B,
92 QIF_INODES_B,
93 QIF_BTIME_B,
94 QIF_ITIME_B,
95};
96
97#define QIF_BLIMITS (1 << QIF_BLIMITS_B)
98#define QIF_SPACE (1 << QIF_SPACE_B)
99#define QIF_ILIMITS (1 << QIF_ILIMITS_B)
100#define QIF_INODES (1 << QIF_INODES_B)
101#define QIF_BTIME (1 << QIF_BTIME_B)
102#define QIF_ITIME (1 << QIF_ITIME_B)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103#define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
104#define QIF_USAGE (QIF_SPACE | QIF_INODES)
105#define QIF_TIMES (QIF_BTIME | QIF_ITIME)
106#define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
107
108struct if_dqblk {
109 __u64 dqb_bhardlimit;
110 __u64 dqb_bsoftlimit;
111 __u64 dqb_curspace;
112 __u64 dqb_ihardlimit;
113 __u64 dqb_isoftlimit;
114 __u64 dqb_curinodes;
115 __u64 dqb_btime;
116 __u64 dqb_itime;
117 __u32 dqb_valid;
118};
119
120/*
121 * Structure used for setting quota information about file via quotactl
122 * Following flags are used to specify which fields are valid
123 */
124#define IIF_BGRACE 1
125#define IIF_IGRACE 2
126#define IIF_FLAGS 4
127#define IIF_ALL (IIF_BGRACE | IIF_IGRACE | IIF_FLAGS)
128
129struct if_dqinfo {
130 __u64 dqi_bgrace;
131 __u64 dqi_igrace;
132 __u32 dqi_flags;
133 __u32 dqi_valid;
134};
135
Jan Kara8e893462007-10-16 23:29:31 -0700136/*
137 * Definitions for quota netlink interface
138 */
139#define QUOTA_NL_NOWARN 0
140#define QUOTA_NL_IHARDWARN 1 /* Inode hardlimit reached */
141#define QUOTA_NL_ISOFTLONGWARN 2 /* Inode grace time expired */
142#define QUOTA_NL_ISOFTWARN 3 /* Inode softlimit reached */
143#define QUOTA_NL_BHARDWARN 4 /* Block hardlimit reached */
144#define QUOTA_NL_BSOFTLONGWARN 5 /* Block grace time expired */
145#define QUOTA_NL_BSOFTWARN 6 /* Block softlimit reached */
Jan Kara657d3bf2008-07-25 01:46:52 -0700146#define QUOTA_NL_IHARDBELOW 7 /* Usage got below inode hardlimit */
147#define QUOTA_NL_ISOFTBELOW 8 /* Usage got below inode softlimit */
148#define QUOTA_NL_BHARDBELOW 9 /* Usage got below block hardlimit */
149#define QUOTA_NL_BSOFTBELOW 10 /* Usage got below block softlimit */
Jan Kara8e893462007-10-16 23:29:31 -0700150
151enum {
152 QUOTA_NL_C_UNSPEC,
153 QUOTA_NL_C_WARNING,
154 __QUOTA_NL_C_MAX,
155};
156#define QUOTA_NL_C_MAX (__QUOTA_NL_C_MAX - 1)
157
158enum {
159 QUOTA_NL_A_UNSPEC,
160 QUOTA_NL_A_QTYPE,
161 QUOTA_NL_A_EXCESS_ID,
162 QUOTA_NL_A_WARNING,
163 QUOTA_NL_A_DEV_MAJOR,
164 QUOTA_NL_A_DEV_MINOR,
165 QUOTA_NL_A_CAUSED_ID,
166 __QUOTA_NL_A_MAX,
167};
168#define QUOTA_NL_A_MAX (__QUOTA_NL_A_MAX - 1)
169
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171#ifdef __KERNEL__
Matthew Wilcox8b91de22008-02-26 09:53:20 -0500172#include <linux/list.h>
David Woodhouse0409d3a2006-04-25 14:52:13 +0100173#include <linux/mutex.h>
Matthew Wilcox8b91de22008-02-26 09:53:20 -0500174#include <linux/rwsem.h>
175#include <linux/spinlock.h>
176#include <linux/wait.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
178#include <linux/dqblk_xfs.h>
179#include <linux/dqblk_v1.h>
180#include <linux/dqblk_v2.h>
181
Matthew Wilcox8b91de22008-02-26 09:53:20 -0500182#include <asm/atomic.h>
183
Jan Kara74abb982008-07-25 01:46:51 -0700184typedef __kernel_uid32_t qid_t; /* Type in which we store ids in memory */
Jan Karadb49d2d2008-10-01 18:21:39 +0200185typedef long long qsize_t; /* Type in which we store sizes */
Jan Kara74abb982008-07-25 01:46:51 -0700186
Mike Frysingeracd64b72007-05-08 00:31:51 -0700187extern spinlock_t dq_data_lock;
188
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189/* Maximal numbers of writes for quota operation (insert/delete/update)
Jan Kara4e5117b2005-06-23 22:01:03 -0700190 * (over VFS all formats) */
191#define DQUOT_INIT_ALLOC max(V1_INIT_ALLOC, V2_INIT_ALLOC)
192#define DQUOT_INIT_REWRITE max(V1_INIT_REWRITE, V2_INIT_REWRITE)
193#define DQUOT_DEL_ALLOC max(V1_DEL_ALLOC, V2_DEL_ALLOC)
194#define DQUOT_DEL_REWRITE max(V1_DEL_REWRITE, V2_DEL_REWRITE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196/*
197 * Data for one user/group kept in memory
198 */
199struct mem_dqblk {
Jan Kara12095462008-08-20 14:45:12 +0200200 qsize_t dqb_bhardlimit; /* absolute limit on disk blks alloc */
201 qsize_t dqb_bsoftlimit; /* preferred limit on disk blks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 qsize_t dqb_curspace; /* current used space */
Mingming Caof18df222009-01-13 16:43:09 +0100203 qsize_t dqb_rsvspace; /* current reserved space for delalloc*/
Jan Kara12095462008-08-20 14:45:12 +0200204 qsize_t dqb_ihardlimit; /* absolute limit on allocated inodes */
205 qsize_t dqb_isoftlimit; /* preferred inode limit */
206 qsize_t dqb_curinodes; /* current # allocated inodes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 time_t dqb_btime; /* time limit for excessive disk use */
208 time_t dqb_itime; /* time limit for excessive inode use */
209};
210
211/*
212 * Data for one quotafile kept in memory
213 */
214struct quota_format_type;
215
216struct mem_dqinfo {
217 struct quota_format_type *dqi_format;
Jan Kara0ff5af82008-04-28 02:14:33 -0700218 int dqi_fmt_id; /* Id of the dqi_format - used when turning
219 * quotas on after remount RW */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 struct list_head dqi_dirty_list; /* List of dirty dquots */
221 unsigned long dqi_flags;
222 unsigned int dqi_bgrace;
223 unsigned int dqi_igrace;
Andrew Perepechko338bf9a2008-04-28 02:14:31 -0700224 qsize_t dqi_maxblimit;
225 qsize_t dqi_maxilimit;
Jan Karae3d4d562008-10-02 18:44:14 +0200226 void *dqi_priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227};
228
229struct super_block;
230
231#define DQF_MASK 0xffff /* Mask for format specific flags */
232#define DQF_INFO_DIRTY_B 16
233#define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B) /* Is info dirty? */
234
235extern void mark_info_dirty(struct super_block *sb, int type);
Jan Kara03b06342008-07-25 01:46:52 -0700236static inline int info_dirty(struct mem_dqinfo *info)
237{
238 return test_bit(DQF_INFO_DIRTY_B, &info->dqi_flags);
239}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241struct dqstats {
242 int lookups;
243 int drops;
244 int reads;
245 int writes;
246 int cache_hits;
247 int allocated_dquots;
248 int free_dquots;
249 int syncs;
250};
251
252extern struct dqstats dqstats;
253
254#define DQ_MOD_B 0 /* dquot modified since read */
255#define DQ_BLKS_B 1 /* uid/gid has been warned about blk limit */
256#define DQ_INODES_B 2 /* uid/gid has been warned about inode limit */
257#define DQ_FAKE_B 3 /* no limits only usage */
258#define DQ_READ_B 4 /* dquot was read into memory */
259#define DQ_ACTIVE_B 5 /* dquot is active (dquot_release not called) */
Jan Kara4d59bce2008-10-02 16:48:10 +0200260#define DQ_LASTSET_B 6 /* Following 6 bits (see QIF_) are reserved\
261 * for the mask of entries set via SETQUOTA\
262 * quotactl. They are set under dq_data_lock\
263 * and the quota format handling dquot can\
264 * clear them when it sees fit. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
266struct dquot {
267 struct hlist_node dq_hash; /* Hash list in memory */
268 struct list_head dq_inuse; /* List of all quotas */
269 struct list_head dq_free; /* Free list element */
270 struct list_head dq_dirty; /* List of dirty dquots */
Ingo Molnard3be9152006-03-23 03:00:29 -0800271 struct mutex dq_lock; /* dquot IO lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 atomic_t dq_count; /* Use count */
273 wait_queue_head_t dq_wait_unused; /* Wait queue for dquot to become unused */
274 struct super_block *dq_sb; /* superblock this applies to */
275 unsigned int dq_id; /* ID this applies to (uid, gid) */
276 loff_t dq_off; /* Offset of dquot on disk */
277 unsigned long dq_flags; /* See DQ_* */
278 short dq_type; /* Type of quota */
279 struct mem_dqblk dq_dqb; /* Diskquota usage */
280};
281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282/* Operations which must be implemented by each quota format */
283struct quota_format_ops {
284 int (*check_quota_file)(struct super_block *sb, int type); /* Detect whether file is in our format */
285 int (*read_file_info)(struct super_block *sb, int type); /* Read main info about file - called on quotaon() */
286 int (*write_file_info)(struct super_block *sb, int type); /* Write main info about file */
287 int (*free_file_info)(struct super_block *sb, int type); /* Called on quotaoff() */
288 int (*read_dqblk)(struct dquot *dquot); /* Read structure for one user */
289 int (*commit_dqblk)(struct dquot *dquot); /* Write structure for one user */
290 int (*release_dqblk)(struct dquot *dquot); /* Called when last reference to dquot is being dropped */
291};
292
293/* Operations working with dquots */
294struct dquot_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 int (*write_dquot) (struct dquot *); /* Ordinary dquot write */
Jan Kara74f783a2008-08-19 14:51:22 +0200296 struct dquot *(*alloc_dquot)(struct super_block *, int); /* Allocate memory for new dquot */
297 void (*destroy_dquot)(struct dquot *); /* Free memory for dquot */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 int (*acquire_dquot) (struct dquot *); /* Quota is going to be created on disk */
299 int (*release_dquot) (struct dquot *); /* Quota is going to be deleted from disk */
300 int (*mark_dirty) (struct dquot *); /* Dquot is marked dirty */
301 int (*write_info) (struct super_block *, int); /* Write of quota "superblock" */
Dmitry Monakhovfd8fbfc2009-12-14 15:21:13 +0300302 /* get reserved quota for delayed alloc, value returned is managed by
303 * quota code only */
304 qsize_t *(*get_reserved_space) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305};
306
307/* Operations handling requests from userspace */
308struct quotactl_ops {
Jan Kara0ff5af82008-04-28 02:14:33 -0700309 int (*quota_on)(struct super_block *, int, int, char *, int);
310 int (*quota_off)(struct super_block *, int, int);
Christoph Hellwig5fb324a2010-02-16 03:44:52 -0500311 int (*quota_sync)(struct super_block *, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 int (*get_info)(struct super_block *, int, struct if_dqinfo *);
313 int (*set_info)(struct super_block *, int, struct if_dqinfo *);
314 int (*get_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
315 int (*set_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
316 int (*get_xstate)(struct super_block *, struct fs_quota_stat *);
317 int (*set_xstate)(struct super_block *, unsigned int, int);
318 int (*get_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
319 int (*set_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
320};
321
322struct quota_format_type {
323 int qf_fmt_id; /* Quota format id */
Alexey Dobriyan1472da52009-10-16 15:26:03 +0400324 const struct quota_format_ops *qf_ops; /* Operations of format */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 struct module *qf_owner; /* Module implementing quota format */
326 struct quota_format_type *qf_next;
327};
328
Jan Karaf55abc02008-08-20 17:50:32 +0200329/* Quota state flags - they actually come in two flavors - for users and groups */
330enum {
331 _DQUOT_USAGE_ENABLED = 0, /* Track disk usage for users */
332 _DQUOT_LIMITS_ENABLED, /* Enforce quota limits for users */
333 _DQUOT_SUSPENDED, /* User diskquotas are off, but
Jan Kara0ff5af82008-04-28 02:14:33 -0700334 * we have necessary info in
335 * memory to turn them on */
Jan Karaf55abc02008-08-20 17:50:32 +0200336 _DQUOT_STATE_FLAGS
337};
338#define DQUOT_USAGE_ENABLED (1 << _DQUOT_USAGE_ENABLED)
339#define DQUOT_LIMITS_ENABLED (1 << _DQUOT_LIMITS_ENABLED)
340#define DQUOT_SUSPENDED (1 << _DQUOT_SUSPENDED)
341#define DQUOT_STATE_FLAGS (DQUOT_USAGE_ENABLED | DQUOT_LIMITS_ENABLED | \
342 DQUOT_SUSPENDED)
Jan Karaca785ec2008-09-30 17:53:37 +0200343/* Other quota flags */
Dmitry Monakhovad1e6e82010-02-16 08:31:49 +0300344#define DQUOT_STATE_LAST (_DQUOT_STATE_FLAGS * MAXQUOTAS)
345#define DQUOT_QUOTA_SYS_FILE (1 << DQUOT_STATE_LAST)
346 /* Quota file is a special
Jan Karaca785ec2008-09-30 17:53:37 +0200347 * system file and user cannot
348 * touch it. Filesystem is
349 * responsible for setting
350 * S_NOQUOTA, S_NOATIME flags
351 */
Dmitry Monakhovad1e6e82010-02-16 08:31:49 +0300352#define DQUOT_NEGATIVE_USAGE (1 << (DQUOT_STATE_LAST + 1))
353 /* Allow negative quota usage */
Jan Karaf55abc02008-08-20 17:50:32 +0200354
355static inline unsigned int dquot_state_flag(unsigned int flags, int type)
356{
Dmitry Monakhovad1e6e82010-02-16 08:31:49 +0300357 return flags << _DQUOT_STATE_FLAGS * type;
Jan Karaf55abc02008-08-20 17:50:32 +0200358}
359
360static inline unsigned int dquot_generic_flag(unsigned int flags, int type)
361{
Dmitry Monakhovad1e6e82010-02-16 08:31:49 +0300362 return (flags >> _DQUOT_STATE_FLAGS * type) & DQUOT_STATE_FLAGS;
Jan Karaf55abc02008-08-20 17:50:32 +0200363}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Steven Whitehouse86e931a2009-09-28 12:35:17 +0100365#ifdef CONFIG_QUOTA_NETLINK_INTERFACE
366extern void quota_send_warning(short type, unsigned int id, dev_t dev,
367 const char warntype);
368#else
369static inline void quota_send_warning(short type, unsigned int id, dev_t dev,
370 const char warntype)
371{
372 return;
373}
374#endif /* CONFIG_QUOTA_NETLINK_INTERFACE */
375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376struct quota_info {
377 unsigned int flags; /* Flags for diskquotas on this device */
Ingo Molnard3be9152006-03-23 03:00:29 -0800378 struct mutex dqio_mutex; /* lock device while I/O in progress */
379 struct mutex dqonoff_mutex; /* Serialize quotaon & quotaoff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 struct rw_semaphore dqptr_sem; /* serialize ops using quota_info struct, pointers from inode to dquots */
381 struct inode *files[MAXQUOTAS]; /* inodes of quotafiles */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 struct mem_dqinfo info[MAXQUOTAS]; /* Information for each quota type */
Alexey Dobriyan1472da52009-10-16 15:26:03 +0400383 const struct quota_format_ops *ops[MAXQUOTAS]; /* Operations for each type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384};
385
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386int register_quota_format(struct quota_format_type *fmt);
387void unregister_quota_format(struct quota_format_type *fmt);
388
389struct quota_module_name {
390 int qm_fmt_id;
391 char *qm_mod_name;
392};
393
394#define INIT_QUOTA_MODULE_NAMES {\
395 {QFMT_VFS_OLD, "quota_v1"},\
396 {QFMT_VFS_V0, "quota_v2"},\
397 {0, NULL}}
398
399#else
400
401# /* nodep */ include <sys/cdefs.h>
402
403__BEGIN_DECLS
404long quotactl __P ((unsigned int, const char *, int, caddr_t));
405__END_DECLS
406
407#endif /* __KERNEL__ */
408#endif /* _QUOTA_ */