2 * Copyright (c) 1982, 1986 Regents of the University of California.
5 * This code is derived from software contributed to Berkeley by
6 * Robert Elz at The University of Melbourne.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
36 #include <linux/errno.h>
37 #include <linux/types.h>
39 #define __DQUOT_VERSION__ "dquot_6.5.2"
42 #define USRQUOTA 0 /* element used for user quotas */
43 #define GRPQUOTA 1 /* element used for group quotas */
46 * Definitions for the default names of the quotas files.
48 #define INITQFNAMES { \
49 "user", /* USRQUOTA */ \
50 "group", /* GRPQUOTA */ \
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).
60 #define SUBCMDMASK 0x00ff
62 #define QCMD(cmd, type) (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))
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 */
73 /* Quota format type IDs */
74 #define QFMT_VFS_OLD 1
79 /* Size of block in which space limits are passed through the quota
81 #define QIF_DQBLKSIZE_BITS 10
82 #define QIF_DQBLKSIZE (1 << QIF_DQBLKSIZE_BITS)
85 * Quota structure used for communication with userspace via quotactl
86 * Following flags are used to specify which fields are valid
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)
103 #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)
109 __u64 dqb_bhardlimit;
110 __u64 dqb_bsoftlimit;
112 __u64 dqb_ihardlimit;
113 __u64 dqb_isoftlimit;
121 * Structure used for setting quota information about file via quotactl
122 * Following flags are used to specify which fields are valid
127 #define IIF_ALL (IIF_BGRACE | IIF_IGRACE | IIF_FLAGS)
137 * Definitions for quota netlink interface
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 */
146 #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 */
156 #define QUOTA_NL_C_MAX (__QUOTA_NL_C_MAX - 1)
161 QUOTA_NL_A_EXCESS_ID,
163 QUOTA_NL_A_DEV_MAJOR,
164 QUOTA_NL_A_DEV_MINOR,
165 QUOTA_NL_A_CAUSED_ID,
168 #define QUOTA_NL_A_MAX (__QUOTA_NL_A_MAX - 1)
172 #include <linux/list.h>
173 #include <linux/mutex.h>
174 #include <linux/rwsem.h>
175 #include <linux/spinlock.h>
176 #include <linux/wait.h>
177 #include <linux/percpu.h>
178 #include <linux/smp.h>
180 #include <linux/dqblk_xfs.h>
181 #include <linux/dqblk_v1.h>
182 #include <linux/dqblk_v2.h>
184 #include <asm/atomic.h>
186 typedef __kernel_uid32_t qid_t; /* Type in which we store ids in memory */
187 typedef long long qsize_t; /* Type in which we store sizes */
189 extern spinlock_t dq_data_lock;
191 /* Maximal numbers of writes for quota operation (insert/delete/update)
192 * (over VFS all formats) */
193 #define DQUOT_INIT_ALLOC max(V1_INIT_ALLOC, V2_INIT_ALLOC)
194 #define DQUOT_INIT_REWRITE max(V1_INIT_REWRITE, V2_INIT_REWRITE)
195 #define DQUOT_DEL_ALLOC max(V1_DEL_ALLOC, V2_DEL_ALLOC)
196 #define DQUOT_DEL_REWRITE max(V1_DEL_REWRITE, V2_DEL_REWRITE)
199 * Data for one user/group kept in memory
202 qsize_t dqb_bhardlimit; /* absolute limit on disk blks alloc */
203 qsize_t dqb_bsoftlimit; /* preferred limit on disk blks */
204 qsize_t dqb_curspace; /* current used space */
205 qsize_t dqb_rsvspace; /* current reserved space for delalloc*/
206 qsize_t dqb_ihardlimit; /* absolute limit on allocated inodes */
207 qsize_t dqb_isoftlimit; /* preferred inode limit */
208 qsize_t dqb_curinodes; /* current # allocated inodes */
209 time_t dqb_btime; /* time limit for excessive disk use */
210 time_t dqb_itime; /* time limit for excessive inode use */
214 * Data for one quotafile kept in memory
216 struct quota_format_type;
219 struct quota_format_type *dqi_format;
220 int dqi_fmt_id; /* Id of the dqi_format - used when turning
221 * quotas on after remount RW */
222 struct list_head dqi_dirty_list; /* List of dirty dquots */
223 unsigned long dqi_flags;
224 unsigned int dqi_bgrace;
225 unsigned int dqi_igrace;
226 qsize_t dqi_maxblimit;
227 qsize_t dqi_maxilimit;
233 #define DQF_MASK 0xffff /* Mask for format specific flags */
234 #define DQF_INFO_DIRTY_B 16
235 #define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B) /* Is info dirty? */
237 extern void mark_info_dirty(struct super_block *sb, int type);
238 static inline int info_dirty(struct mem_dqinfo *info)
240 return test_bit(DQF_INFO_DIRTY_B, &info->dqi_flags);
256 int stat[_DQST_DQSTAT_LAST];
259 extern struct dqstats *dqstats_pcpu;
260 extern struct dqstats dqstats;
262 static inline void dqstats_inc(unsigned int type)
265 per_cpu_ptr(dqstats_pcpu, smp_processor_id())->stat[type]++;
267 dqstats.stat[type]++;
271 static inline void dqstats_dec(unsigned int type)
274 per_cpu_ptr(dqstats_pcpu, smp_processor_id())->stat[type]--;
276 dqstats.stat[type]--;
280 #define DQ_MOD_B 0 /* dquot modified since read */
281 #define DQ_BLKS_B 1 /* uid/gid has been warned about blk limit */
282 #define DQ_INODES_B 2 /* uid/gid has been warned about inode limit */
283 #define DQ_FAKE_B 3 /* no limits only usage */
284 #define DQ_READ_B 4 /* dquot was read into memory */
285 #define DQ_ACTIVE_B 5 /* dquot is active (dquot_release not called) */
286 #define DQ_LASTSET_B 6 /* Following 6 bits (see QIF_) are reserved\
287 * for the mask of entries set via SETQUOTA\
288 * quotactl. They are set under dq_data_lock\
289 * and the quota format handling dquot can\
290 * clear them when it sees fit. */
293 struct hlist_node dq_hash; /* Hash list in memory */
294 struct list_head dq_inuse; /* List of all quotas */
295 struct list_head dq_free; /* Free list element */
296 struct list_head dq_dirty; /* List of dirty dquots */
297 struct mutex dq_lock; /* dquot IO lock */
298 atomic_t dq_count; /* Use count */
299 wait_queue_head_t dq_wait_unused; /* Wait queue for dquot to become unused */
300 struct super_block *dq_sb; /* superblock this applies to */
301 unsigned int dq_id; /* ID this applies to (uid, gid) */
302 loff_t dq_off; /* Offset of dquot on disk */
303 unsigned long dq_flags; /* See DQ_* */
304 short dq_type; /* Type of quota */
305 struct mem_dqblk dq_dqb; /* Diskquota usage */
308 /* Operations which must be implemented by each quota format */
309 struct quota_format_ops {
310 int (*check_quota_file)(struct super_block *sb, int type); /* Detect whether file is in our format */
311 int (*read_file_info)(struct super_block *sb, int type); /* Read main info about file - called on quotaon() */
312 int (*write_file_info)(struct super_block *sb, int type); /* Write main info about file */
313 int (*free_file_info)(struct super_block *sb, int type); /* Called on quotaoff() */
314 int (*read_dqblk)(struct dquot *dquot); /* Read structure for one user */
315 int (*commit_dqblk)(struct dquot *dquot); /* Write structure for one user */
316 int (*release_dqblk)(struct dquot *dquot); /* Called when last reference to dquot is being dropped */
319 /* Operations working with dquots */
320 struct dquot_operations {
321 int (*write_dquot) (struct dquot *); /* Ordinary dquot write */
322 struct dquot *(*alloc_dquot)(struct super_block *, int); /* Allocate memory for new dquot */
323 void (*destroy_dquot)(struct dquot *); /* Free memory for dquot */
324 int (*acquire_dquot) (struct dquot *); /* Quota is going to be created on disk */
325 int (*release_dquot) (struct dquot *); /* Quota is going to be deleted from disk */
326 int (*mark_dirty) (struct dquot *); /* Dquot is marked dirty */
327 int (*write_info) (struct super_block *, int); /* Write of quota "superblock" */
328 /* get reserved quota for delayed alloc, value returned is managed by
330 qsize_t *(*get_reserved_space) (struct inode *);
333 /* Operations handling requests from userspace */
334 struct quotactl_ops {
335 int (*quota_on)(struct super_block *, int, int, char *, int);
336 int (*quota_off)(struct super_block *, int, int);
337 int (*quota_sync)(struct super_block *, int, int);
338 int (*get_info)(struct super_block *, int, struct if_dqinfo *);
339 int (*set_info)(struct super_block *, int, struct if_dqinfo *);
340 int (*get_dqblk)(struct super_block *, int, qid_t, struct fs_disk_quota *);
341 int (*set_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
342 int (*get_xstate)(struct super_block *, struct fs_quota_stat *);
343 int (*set_xstate)(struct super_block *, unsigned int, int);
344 int (*set_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
347 struct quota_format_type {
348 int qf_fmt_id; /* Quota format id */
349 const struct quota_format_ops *qf_ops; /* Operations of format */
350 struct module *qf_owner; /* Module implementing quota format */
351 struct quota_format_type *qf_next;
354 /* Quota state flags - they actually come in two flavors - for users and groups */
356 _DQUOT_USAGE_ENABLED = 0, /* Track disk usage for users */
357 _DQUOT_LIMITS_ENABLED, /* Enforce quota limits for users */
358 _DQUOT_SUSPENDED, /* User diskquotas are off, but
359 * we have necessary info in
360 * memory to turn them on */
363 #define DQUOT_USAGE_ENABLED (1 << _DQUOT_USAGE_ENABLED)
364 #define DQUOT_LIMITS_ENABLED (1 << _DQUOT_LIMITS_ENABLED)
365 #define DQUOT_SUSPENDED (1 << _DQUOT_SUSPENDED)
366 #define DQUOT_STATE_FLAGS (DQUOT_USAGE_ENABLED | DQUOT_LIMITS_ENABLED | \
368 /* Other quota flags */
369 #define DQUOT_STATE_LAST (_DQUOT_STATE_FLAGS * MAXQUOTAS)
370 #define DQUOT_QUOTA_SYS_FILE (1 << DQUOT_STATE_LAST)
371 /* Quota file is a special
372 * system file and user cannot
373 * touch it. Filesystem is
374 * responsible for setting
375 * S_NOQUOTA, S_NOATIME flags
377 #define DQUOT_NEGATIVE_USAGE (1 << (DQUOT_STATE_LAST + 1))
378 /* Allow negative quota usage */
380 static inline unsigned int dquot_state_flag(unsigned int flags, int type)
382 return flags << _DQUOT_STATE_FLAGS * type;
385 static inline unsigned int dquot_generic_flag(unsigned int flags, int type)
387 return (flags >> _DQUOT_STATE_FLAGS * type) & DQUOT_STATE_FLAGS;
390 #ifdef CONFIG_QUOTA_NETLINK_INTERFACE
391 extern void quota_send_warning(short type, unsigned int id, dev_t dev,
392 const char warntype);
394 static inline void quota_send_warning(short type, unsigned int id, dev_t dev,
399 #endif /* CONFIG_QUOTA_NETLINK_INTERFACE */
402 unsigned int flags; /* Flags for diskquotas on this device */
403 struct mutex dqio_mutex; /* lock device while I/O in progress */
404 struct mutex dqonoff_mutex; /* Serialize quotaon & quotaoff */
405 struct rw_semaphore dqptr_sem; /* serialize ops using quota_info struct, pointers from inode to dquots */
406 struct inode *files[MAXQUOTAS]; /* inodes of quotafiles */
407 struct mem_dqinfo info[MAXQUOTAS]; /* Information for each quota type */
408 const struct quota_format_ops *ops[MAXQUOTAS]; /* Operations for each type */
411 int register_quota_format(struct quota_format_type *fmt);
412 void unregister_quota_format(struct quota_format_type *fmt);
414 struct quota_module_name {
419 #define INIT_QUOTA_MODULE_NAMES {\
420 {QFMT_VFS_OLD, "quota_v1"},\
421 {QFMT_VFS_V0, "quota_v2"},\
426 # /* nodep */ include <sys/cdefs.h>
429 long quotactl __P ((unsigned int, const char *, int, caddr_t));
432 #endif /* __KERNEL__ */