blob: 6e0393a5b2eafd4c98ec08fae1a0d83372a03672 [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.
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
41#define __DQUOT_VERSION__ "dquot_6.5.1"
42#define __DQUOT_NUM_VERSION__ 6*10000+5*100+1
43
44typedef __kernel_uid32_t qid_t; /* Type in which we store ids in memory */
45typedef __u64 qsize_t; /* Type in which we store sizes */
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047/* 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
103struct 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
124struct if_dqinfo {
125 __u64 dqi_bgrace;
126 __u64 dqi_igrace;
127 __u32 dqi_flags;
128 __u32 dqi_valid;
129};
130
Jan Kara8e893462007-10-16 23:29:31 -0700131/*
132 * Definitions for quota netlink interface
133 */
134#define QUOTA_NL_NOWARN 0
135#define QUOTA_NL_IHARDWARN 1 /* Inode hardlimit reached */
136#define QUOTA_NL_ISOFTLONGWARN 2 /* Inode grace time expired */
137#define QUOTA_NL_ISOFTWARN 3 /* Inode softlimit reached */
138#define QUOTA_NL_BHARDWARN 4 /* Block hardlimit reached */
139#define QUOTA_NL_BSOFTLONGWARN 5 /* Block grace time expired */
140#define QUOTA_NL_BSOFTWARN 6 /* Block softlimit reached */
141
142enum {
143 QUOTA_NL_C_UNSPEC,
144 QUOTA_NL_C_WARNING,
145 __QUOTA_NL_C_MAX,
146};
147#define QUOTA_NL_C_MAX (__QUOTA_NL_C_MAX - 1)
148
149enum {
150 QUOTA_NL_A_UNSPEC,
151 QUOTA_NL_A_QTYPE,
152 QUOTA_NL_A_EXCESS_ID,
153 QUOTA_NL_A_WARNING,
154 QUOTA_NL_A_DEV_MAJOR,
155 QUOTA_NL_A_DEV_MINOR,
156 QUOTA_NL_A_CAUSED_ID,
157 __QUOTA_NL_A_MAX,
158};
159#define QUOTA_NL_A_MAX (__QUOTA_NL_A_MAX - 1)
160
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162#ifdef __KERNEL__
David Woodhouse0409d3a2006-04-25 14:52:13 +0100163#include <linux/spinlock.h>
Robert P. J. Dayae4472a2007-02-12 00:51:52 -0800164#include <linux/rwsem.h>
David Woodhouse0409d3a2006-04-25 14:52:13 +0100165#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
167#include <linux/dqblk_xfs.h>
168#include <linux/dqblk_v1.h>
169#include <linux/dqblk_v2.h>
170
Mike Frysingeracd64b72007-05-08 00:31:51 -0700171extern spinlock_t dq_data_lock;
172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173/* Maximal numbers of writes for quota operation (insert/delete/update)
Jan Kara4e5117b2005-06-23 22:01:03 -0700174 * (over VFS all formats) */
175#define DQUOT_INIT_ALLOC max(V1_INIT_ALLOC, V2_INIT_ALLOC)
176#define DQUOT_INIT_REWRITE max(V1_INIT_REWRITE, V2_INIT_REWRITE)
177#define DQUOT_DEL_ALLOC max(V1_DEL_ALLOC, V2_DEL_ALLOC)
178#define DQUOT_DEL_REWRITE max(V1_DEL_REWRITE, V2_DEL_REWRITE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
180/*
181 * Data for one user/group kept in memory
182 */
183struct mem_dqblk {
184 __u32 dqb_bhardlimit; /* absolute limit on disk blks alloc */
185 __u32 dqb_bsoftlimit; /* preferred limit on disk blks */
186 qsize_t dqb_curspace; /* current used space */
187 __u32 dqb_ihardlimit; /* absolute limit on allocated inodes */
188 __u32 dqb_isoftlimit; /* preferred inode limit */
189 __u32 dqb_curinodes; /* current # allocated inodes */
190 time_t dqb_btime; /* time limit for excessive disk use */
191 time_t dqb_itime; /* time limit for excessive inode use */
192};
193
194/*
195 * Data for one quotafile kept in memory
196 */
197struct quota_format_type;
198
199struct mem_dqinfo {
200 struct quota_format_type *dqi_format;
201 struct list_head dqi_dirty_list; /* List of dirty dquots */
202 unsigned long dqi_flags;
203 unsigned int dqi_bgrace;
204 unsigned int dqi_igrace;
205 union {
206 struct v1_mem_dqinfo v1_i;
207 struct v2_mem_dqinfo v2_i;
208 } u;
209};
210
211struct super_block;
212
213#define DQF_MASK 0xffff /* Mask for format specific flags */
214#define DQF_INFO_DIRTY_B 16
215#define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B) /* Is info dirty? */
216
217extern void mark_info_dirty(struct super_block *sb, int type);
218#define info_dirty(info) test_bit(DQF_INFO_DIRTY_B, &(info)->dqi_flags)
219#define info_any_dquot_dirty(info) (!list_empty(&(info)->dqi_dirty_list))
220#define info_any_dirty(info) (info_dirty(info) || info_any_dquot_dirty(info))
221
222#define sb_dqopt(sb) (&(sb)->s_dquot)
223#define sb_dqinfo(sb, type) (sb_dqopt(sb)->info+(type))
224
225struct dqstats {
226 int lookups;
227 int drops;
228 int reads;
229 int writes;
230 int cache_hits;
231 int allocated_dquots;
232 int free_dquots;
233 int syncs;
234};
235
236extern struct dqstats dqstats;
237
238#define DQ_MOD_B 0 /* dquot modified since read */
239#define DQ_BLKS_B 1 /* uid/gid has been warned about blk limit */
240#define DQ_INODES_B 2 /* uid/gid has been warned about inode limit */
241#define DQ_FAKE_B 3 /* no limits only usage */
242#define DQ_READ_B 4 /* dquot was read into memory */
243#define DQ_ACTIVE_B 5 /* dquot is active (dquot_release not called) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
245struct dquot {
246 struct hlist_node dq_hash; /* Hash list in memory */
247 struct list_head dq_inuse; /* List of all quotas */
248 struct list_head dq_free; /* Free list element */
249 struct list_head dq_dirty; /* List of dirty dquots */
Ingo Molnard3be9152006-03-23 03:00:29 -0800250 struct mutex dq_lock; /* dquot IO lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 atomic_t dq_count; /* Use count */
252 wait_queue_head_t dq_wait_unused; /* Wait queue for dquot to become unused */
253 struct super_block *dq_sb; /* superblock this applies to */
254 unsigned int dq_id; /* ID this applies to (uid, gid) */
255 loff_t dq_off; /* Offset of dquot on disk */
256 unsigned long dq_flags; /* See DQ_* */
257 short dq_type; /* Type of quota */
258 struct mem_dqblk dq_dqb; /* Diskquota usage */
259};
260
261#define NODQUOT (struct dquot *)NULL
262
263#define QUOTA_OK 0
264#define NO_QUOTA 1
265
266/* Operations which must be implemented by each quota format */
267struct quota_format_ops {
268 int (*check_quota_file)(struct super_block *sb, int type); /* Detect whether file is in our format */
269 int (*read_file_info)(struct super_block *sb, int type); /* Read main info about file - called on quotaon() */
270 int (*write_file_info)(struct super_block *sb, int type); /* Write main info about file */
271 int (*free_file_info)(struct super_block *sb, int type); /* Called on quotaoff() */
272 int (*read_dqblk)(struct dquot *dquot); /* Read structure for one user */
273 int (*commit_dqblk)(struct dquot *dquot); /* Write structure for one user */
274 int (*release_dqblk)(struct dquot *dquot); /* Called when last reference to dquot is being dropped */
275};
276
277/* Operations working with dquots */
278struct dquot_operations {
279 int (*initialize) (struct inode *, int);
280 int (*drop) (struct inode *);
281 int (*alloc_space) (struct inode *, qsize_t, int);
282 int (*alloc_inode) (const struct inode *, unsigned long);
283 int (*free_space) (struct inode *, qsize_t);
284 int (*free_inode) (const struct inode *, unsigned long);
285 int (*transfer) (struct inode *, struct iattr *);
286 int (*write_dquot) (struct dquot *); /* Ordinary dquot write */
287 int (*acquire_dquot) (struct dquot *); /* Quota is going to be created on disk */
288 int (*release_dquot) (struct dquot *); /* Quota is going to be deleted from disk */
289 int (*mark_dirty) (struct dquot *); /* Dquot is marked dirty */
290 int (*write_info) (struct super_block *, int); /* Write of quota "superblock" */
291};
292
293/* Operations handling requests from userspace */
294struct quotactl_ops {
295 int (*quota_on)(struct super_block *, int, int, char *);
296 int (*quota_off)(struct super_block *, int);
297 int (*quota_sync)(struct super_block *, int);
298 int (*get_info)(struct super_block *, int, struct if_dqinfo *);
299 int (*set_info)(struct super_block *, int, struct if_dqinfo *);
300 int (*get_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
301 int (*set_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
302 int (*get_xstate)(struct super_block *, struct fs_quota_stat *);
303 int (*set_xstate)(struct super_block *, unsigned int, int);
304 int (*get_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
305 int (*set_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
306};
307
308struct quota_format_type {
309 int qf_fmt_id; /* Quota format id */
310 struct quota_format_ops *qf_ops; /* Operations of format */
311 struct module *qf_owner; /* Module implementing quota format */
312 struct quota_format_type *qf_next;
313};
314
315#define DQUOT_USR_ENABLED 0x01 /* User diskquotas enabled */
316#define DQUOT_GRP_ENABLED 0x02 /* Group diskquotas enabled */
317
318struct quota_info {
319 unsigned int flags; /* Flags for diskquotas on this device */
Ingo Molnard3be9152006-03-23 03:00:29 -0800320 struct mutex dqio_mutex; /* lock device while I/O in progress */
321 struct mutex dqonoff_mutex; /* Serialize quotaon & quotaoff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 struct rw_semaphore dqptr_sem; /* serialize ops using quota_info struct, pointers from inode to dquots */
323 struct inode *files[MAXQUOTAS]; /* inodes of quotafiles */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 struct mem_dqinfo info[MAXQUOTAS]; /* Information for each quota type */
325 struct quota_format_ops *ops[MAXQUOTAS]; /* Operations for each type */
326};
327
328/* Inline would be better but we need to dereference super_block which is not defined yet */
329int mark_dquot_dirty(struct dquot *dquot);
330
331#define dquot_dirty(dquot) test_bit(DQ_MOD_B, &(dquot)->dq_flags)
332
333#define sb_has_quota_enabled(sb, type) ((type)==USRQUOTA ? \
334 (sb_dqopt(sb)->flags & DQUOT_USR_ENABLED) : (sb_dqopt(sb)->flags & DQUOT_GRP_ENABLED))
335
336#define sb_any_quota_enabled(sb) (sb_has_quota_enabled(sb, USRQUOTA) | \
337 sb_has_quota_enabled(sb, GRPQUOTA))
338
339int register_quota_format(struct quota_format_type *fmt);
340void unregister_quota_format(struct quota_format_type *fmt);
341
342struct quota_module_name {
343 int qm_fmt_id;
344 char *qm_mod_name;
345};
346
347#define INIT_QUOTA_MODULE_NAMES {\
348 {QFMT_VFS_OLD, "quota_v1"},\
349 {QFMT_VFS_V0, "quota_v2"},\
350 {0, NULL}}
351
352#else
353
354# /* nodep */ include <sys/cdefs.h>
355
356__BEGIN_DECLS
357long quotactl __P ((unsigned int, const char *, int, caddr_t));
358__END_DECLS
359
360#endif /* __KERNEL__ */
361#endif /* _QUOTA_ */