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