blob: b8fbf26eb88579265a95e490700bb370d52544d2 [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
47extern spinlock_t dq_data_lock;
48
49/* Size of blocks in which are counted size limits */
50#define QUOTABLOCK_BITS 10
51#define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
52
53/* Conversion routines from and to quota blocks */
54#define qb2kb(x) ((x) << (QUOTABLOCK_BITS-10))
55#define kb2qb(x) ((x) >> (QUOTABLOCK_BITS-10))
56#define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
57
58#define MAXQUOTAS 2
59#define USRQUOTA 0 /* element used for user quotas */
60#define GRPQUOTA 1 /* element used for group quotas */
61
62/*
63 * Definitions for the default names of the quotas files.
64 */
65#define INITQFNAMES { \
66 "user", /* USRQUOTA */ \
67 "group", /* GRPQUOTA */ \
68 "undefined", \
69};
70
71/*
72 * Command definitions for the 'quotactl' system call.
73 * The commands are broken into a main command defined below
74 * and a subcommand that is used to convey the type of
75 * quota that is being manipulated (see above).
76 */
77#define SUBCMDMASK 0x00ff
78#define SUBCMDSHIFT 8
79#define QCMD(cmd, type) (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))
80
81#define Q_SYNC 0x800001 /* sync disk copy of a filesystems quotas */
82#define Q_QUOTAON 0x800002 /* turn quotas on */
83#define Q_QUOTAOFF 0x800003 /* turn quotas off */
84#define Q_GETFMT 0x800004 /* get quota format used on given filesystem */
85#define Q_GETINFO 0x800005 /* get information about quota files */
86#define Q_SETINFO 0x800006 /* set information about quota files */
87#define Q_GETQUOTA 0x800007 /* get user quota structure */
88#define Q_SETQUOTA 0x800008 /* set user quota structure */
89
90/*
91 * Quota structure used for communication with userspace via quotactl
92 * Following flags are used to specify which fields are valid
93 */
94#define QIF_BLIMITS 1
95#define QIF_SPACE 2
96#define QIF_ILIMITS 4
97#define QIF_INODES 8
98#define QIF_BTIME 16
99#define QIF_ITIME 32
100#define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
101#define QIF_USAGE (QIF_SPACE | QIF_INODES)
102#define QIF_TIMES (QIF_BTIME | QIF_ITIME)
103#define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
104
105struct if_dqblk {
106 __u64 dqb_bhardlimit;
107 __u64 dqb_bsoftlimit;
108 __u64 dqb_curspace;
109 __u64 dqb_ihardlimit;
110 __u64 dqb_isoftlimit;
111 __u64 dqb_curinodes;
112 __u64 dqb_btime;
113 __u64 dqb_itime;
114 __u32 dqb_valid;
115};
116
117/*
118 * Structure used for setting quota information about file via quotactl
119 * Following flags are used to specify which fields are valid
120 */
121#define IIF_BGRACE 1
122#define IIF_IGRACE 2
123#define IIF_FLAGS 4
124#define IIF_ALL (IIF_BGRACE | IIF_IGRACE | IIF_FLAGS)
125
126struct if_dqinfo {
127 __u64 dqi_bgrace;
128 __u64 dqi_igrace;
129 __u32 dqi_flags;
130 __u32 dqi_valid;
131};
132
133#ifdef __KERNEL__
David Woodhouse0409d3a2006-04-25 14:52:13 +0100134#include <linux/spinlock.h>
135#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137#include <linux/dqblk_xfs.h>
138#include <linux/dqblk_v1.h>
139#include <linux/dqblk_v2.h>
140
141/* Maximal numbers of writes for quota operation (insert/delete/update)
Jan Kara4e5117b2005-06-23 22:01:03 -0700142 * (over VFS all formats) */
143#define DQUOT_INIT_ALLOC max(V1_INIT_ALLOC, V2_INIT_ALLOC)
144#define DQUOT_INIT_REWRITE max(V1_INIT_REWRITE, V2_INIT_REWRITE)
145#define DQUOT_DEL_ALLOC max(V1_DEL_ALLOC, V2_DEL_ALLOC)
146#define DQUOT_DEL_REWRITE max(V1_DEL_REWRITE, V2_DEL_REWRITE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
148/*
149 * Data for one user/group kept in memory
150 */
151struct mem_dqblk {
152 __u32 dqb_bhardlimit; /* absolute limit on disk blks alloc */
153 __u32 dqb_bsoftlimit; /* preferred limit on disk blks */
154 qsize_t dqb_curspace; /* current used space */
155 __u32 dqb_ihardlimit; /* absolute limit on allocated inodes */
156 __u32 dqb_isoftlimit; /* preferred inode limit */
157 __u32 dqb_curinodes; /* current # allocated inodes */
158 time_t dqb_btime; /* time limit for excessive disk use */
159 time_t dqb_itime; /* time limit for excessive inode use */
160};
161
162/*
163 * Data for one quotafile kept in memory
164 */
165struct quota_format_type;
166
167struct mem_dqinfo {
168 struct quota_format_type *dqi_format;
169 struct list_head dqi_dirty_list; /* List of dirty dquots */
170 unsigned long dqi_flags;
171 unsigned int dqi_bgrace;
172 unsigned int dqi_igrace;
173 union {
174 struct v1_mem_dqinfo v1_i;
175 struct v2_mem_dqinfo v2_i;
176 } u;
177};
178
179struct super_block;
180
181#define DQF_MASK 0xffff /* Mask for format specific flags */
182#define DQF_INFO_DIRTY_B 16
183#define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B) /* Is info dirty? */
184
185extern void mark_info_dirty(struct super_block *sb, int type);
186#define info_dirty(info) test_bit(DQF_INFO_DIRTY_B, &(info)->dqi_flags)
187#define info_any_dquot_dirty(info) (!list_empty(&(info)->dqi_dirty_list))
188#define info_any_dirty(info) (info_dirty(info) || info_any_dquot_dirty(info))
189
190#define sb_dqopt(sb) (&(sb)->s_dquot)
191#define sb_dqinfo(sb, type) (sb_dqopt(sb)->info+(type))
192
193struct dqstats {
194 int lookups;
195 int drops;
196 int reads;
197 int writes;
198 int cache_hits;
199 int allocated_dquots;
200 int free_dquots;
201 int syncs;
202};
203
204extern struct dqstats dqstats;
205
206#define DQ_MOD_B 0 /* dquot modified since read */
207#define DQ_BLKS_B 1 /* uid/gid has been warned about blk limit */
208#define DQ_INODES_B 2 /* uid/gid has been warned about inode limit */
209#define DQ_FAKE_B 3 /* no limits only usage */
210#define DQ_READ_B 4 /* dquot was read into memory */
211#define DQ_ACTIVE_B 5 /* dquot is active (dquot_release not called) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
213struct dquot {
214 struct hlist_node dq_hash; /* Hash list in memory */
215 struct list_head dq_inuse; /* List of all quotas */
216 struct list_head dq_free; /* Free list element */
217 struct list_head dq_dirty; /* List of dirty dquots */
Ingo Molnard3be9152006-03-23 03:00:29 -0800218 struct mutex dq_lock; /* dquot IO lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 atomic_t dq_count; /* Use count */
220 wait_queue_head_t dq_wait_unused; /* Wait queue for dquot to become unused */
221 struct super_block *dq_sb; /* superblock this applies to */
222 unsigned int dq_id; /* ID this applies to (uid, gid) */
223 loff_t dq_off; /* Offset of dquot on disk */
224 unsigned long dq_flags; /* See DQ_* */
225 short dq_type; /* Type of quota */
226 struct mem_dqblk dq_dqb; /* Diskquota usage */
227};
228
229#define NODQUOT (struct dquot *)NULL
230
231#define QUOTA_OK 0
232#define NO_QUOTA 1
233
234/* Operations which must be implemented by each quota format */
235struct quota_format_ops {
236 int (*check_quota_file)(struct super_block *sb, int type); /* Detect whether file is in our format */
237 int (*read_file_info)(struct super_block *sb, int type); /* Read main info about file - called on quotaon() */
238 int (*write_file_info)(struct super_block *sb, int type); /* Write main info about file */
239 int (*free_file_info)(struct super_block *sb, int type); /* Called on quotaoff() */
240 int (*read_dqblk)(struct dquot *dquot); /* Read structure for one user */
241 int (*commit_dqblk)(struct dquot *dquot); /* Write structure for one user */
242 int (*release_dqblk)(struct dquot *dquot); /* Called when last reference to dquot is being dropped */
243};
244
245/* Operations working with dquots */
246struct dquot_operations {
247 int (*initialize) (struct inode *, int);
248 int (*drop) (struct inode *);
249 int (*alloc_space) (struct inode *, qsize_t, int);
250 int (*alloc_inode) (const struct inode *, unsigned long);
251 int (*free_space) (struct inode *, qsize_t);
252 int (*free_inode) (const struct inode *, unsigned long);
253 int (*transfer) (struct inode *, struct iattr *);
254 int (*write_dquot) (struct dquot *); /* Ordinary dquot write */
255 int (*acquire_dquot) (struct dquot *); /* Quota is going to be created on disk */
256 int (*release_dquot) (struct dquot *); /* Quota is going to be deleted from disk */
257 int (*mark_dirty) (struct dquot *); /* Dquot is marked dirty */
258 int (*write_info) (struct super_block *, int); /* Write of quota "superblock" */
259};
260
261/* Operations handling requests from userspace */
262struct quotactl_ops {
263 int (*quota_on)(struct super_block *, int, int, char *);
264 int (*quota_off)(struct super_block *, int);
265 int (*quota_sync)(struct super_block *, int);
266 int (*get_info)(struct super_block *, int, struct if_dqinfo *);
267 int (*set_info)(struct super_block *, int, struct if_dqinfo *);
268 int (*get_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
269 int (*set_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
270 int (*get_xstate)(struct super_block *, struct fs_quota_stat *);
271 int (*set_xstate)(struct super_block *, unsigned int, int);
272 int (*get_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
273 int (*set_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
274};
275
276struct quota_format_type {
277 int qf_fmt_id; /* Quota format id */
278 struct quota_format_ops *qf_ops; /* Operations of format */
279 struct module *qf_owner; /* Module implementing quota format */
280 struct quota_format_type *qf_next;
281};
282
283#define DQUOT_USR_ENABLED 0x01 /* User diskquotas enabled */
284#define DQUOT_GRP_ENABLED 0x02 /* Group diskquotas enabled */
285
286struct quota_info {
287 unsigned int flags; /* Flags for diskquotas on this device */
Ingo Molnard3be9152006-03-23 03:00:29 -0800288 struct mutex dqio_mutex; /* lock device while I/O in progress */
289 struct mutex dqonoff_mutex; /* Serialize quotaon & quotaoff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 struct rw_semaphore dqptr_sem; /* serialize ops using quota_info struct, pointers from inode to dquots */
291 struct inode *files[MAXQUOTAS]; /* inodes of quotafiles */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 struct mem_dqinfo info[MAXQUOTAS]; /* Information for each quota type */
293 struct quota_format_ops *ops[MAXQUOTAS]; /* Operations for each type */
294};
295
296/* Inline would be better but we need to dereference super_block which is not defined yet */
297int mark_dquot_dirty(struct dquot *dquot);
298
299#define dquot_dirty(dquot) test_bit(DQ_MOD_B, &(dquot)->dq_flags)
300
301#define sb_has_quota_enabled(sb, type) ((type)==USRQUOTA ? \
302 (sb_dqopt(sb)->flags & DQUOT_USR_ENABLED) : (sb_dqopt(sb)->flags & DQUOT_GRP_ENABLED))
303
304#define sb_any_quota_enabled(sb) (sb_has_quota_enabled(sb, USRQUOTA) | \
305 sb_has_quota_enabled(sb, GRPQUOTA))
306
307int register_quota_format(struct quota_format_type *fmt);
308void unregister_quota_format(struct quota_format_type *fmt);
309
310struct quota_module_name {
311 int qm_fmt_id;
312 char *qm_mod_name;
313};
314
315#define INIT_QUOTA_MODULE_NAMES {\
316 {QFMT_VFS_OLD, "quota_v1"},\
317 {QFMT_VFS_V0, "quota_v2"},\
318 {0, NULL}}
319
320#else
321
322# /* nodep */ include <sys/cdefs.h>
323
324__BEGIN_DECLS
325long quotactl __P ((unsigned int, const char *, int, caddr_t));
326__END_DECLS
327
328#endif /* __KERNEL__ */
329#endif /* _QUOTA_ */