[deliverable/linux.git] / include / linux / quota.h

/*
 * Copyright (c) 1982, 1986 Regents of the University of California.
 * All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Robert Elz at The University of Melbourne.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _LINUX_QUOTA_
#define _LINUX_QUOTA_

#include <linux/errno.h>
#include <linux/types.h>

#define __DQUOT_VERSION__	"dquot_6.5.2"

#define MAXQUOTAS 2
#define USRQUOTA  0		/* element used for user quotas */
#define GRPQUOTA  1		/* element used for group quotas */

/*
 * Definitions for the default names of the quotas files.
 */
#define INITQFNAMES { \
	"user",    /* USRQUOTA */ \
	"group",   /* GRPQUOTA */ \
	"undefined", \
};

/*
 * Command definitions for the 'quotactl' system call.
 * The commands are broken into a main command defined below
 * and a subcommand that is used to convey the type of
 * quota that is being manipulated (see above).
 */
#define SUBCMDMASK  0x00ff
#define SUBCMDSHIFT 8
#define QCMD(cmd, type)  (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))

#define Q_SYNC     0x800001	/* sync disk copy of a filesystems quotas */
#define Q_QUOTAON  0x800002	/* turn quotas on */
#define Q_QUOTAOFF 0x800003	/* turn quotas off */
#define Q_GETFMT   0x800004	/* get quota format used on given filesystem */
#define Q_GETINFO  0x800005	/* get information about quota files */
#define Q_SETINFO  0x800006	/* set information about quota files */
#define Q_GETQUOTA 0x800007	/* get user quota structure */
#define Q_SETQUOTA 0x800008	/* set user quota structure */

/* Quota format type IDs */
#define	QFMT_VFS_OLD 1
#define	QFMT_VFS_V0 2
#define QFMT_OCFS2 3
#define	QFMT_VFS_V1 4

/* Size of block in which space limits are passed through the quota
 * interface */
#define QIF_DQBLKSIZE_BITS 10
#define QIF_DQBLKSIZE (1 << QIF_DQBLKSIZE_BITS)

/*
 * Quota structure used for communication with userspace via quotactl
 * Following flags are used to specify which fields are valid
 */
enum {
	QIF_BLIMITS_B = 0,
	QIF_SPACE_B,
	QIF_ILIMITS_B,
	QIF_INODES_B,
	QIF_BTIME_B,
	QIF_ITIME_B,
};

#define QIF_BLIMITS	(1 << QIF_BLIMITS_B)
#define QIF_SPACE	(1 << QIF_SPACE_B)
#define QIF_ILIMITS	(1 << QIF_ILIMITS_B)
#define QIF_INODES	(1 << QIF_INODES_B)
#define QIF_BTIME	(1 << QIF_BTIME_B)
#define QIF_ITIME	(1 << QIF_ITIME_B)
#define QIF_LIMITS	(QIF_BLIMITS | QIF_ILIMITS)
#define QIF_USAGE	(QIF_SPACE | QIF_INODES)
#define QIF_TIMES	(QIF_BTIME | QIF_ITIME)
#define QIF_ALL		(QIF_LIMITS | QIF_USAGE | QIF_TIMES)

struct if_dqblk {
	__u64 dqb_bhardlimit;
	__u64 dqb_bsoftlimit;
	__u64 dqb_curspace;
	__u64 dqb_ihardlimit;
	__u64 dqb_isoftlimit;
	__u64 dqb_curinodes;
	__u64 dqb_btime;
	__u64 dqb_itime;
	__u32 dqb_valid;
};

/*
 * Structure used for setting quota information about file via quotactl
 * Following flags are used to specify which fields are valid
 */
#define IIF_BGRACE	1
#define IIF_IGRACE	2
#define IIF_FLAGS	4
#define IIF_ALL		(IIF_BGRACE | IIF_IGRACE | IIF_FLAGS)

struct if_dqinfo {
	__u64 dqi_bgrace;
	__u64 dqi_igrace;
	__u32 dqi_flags;
	__u32 dqi_valid;
};

/*
 * Definitions for quota netlink interface
 */
#define QUOTA_NL_NOWARN 0
#define QUOTA_NL_IHARDWARN 1		/* Inode hardlimit reached */
#define QUOTA_NL_ISOFTLONGWARN 2 	/* Inode grace time expired */
#define QUOTA_NL_ISOFTWARN 3		/* Inode softlimit reached */
#define QUOTA_NL_BHARDWARN 4		/* Block hardlimit reached */
#define QUOTA_NL_BSOFTLONGWARN 5	/* Block grace time expired */
#define QUOTA_NL_BSOFTWARN 6		/* Block softlimit reached */
#define QUOTA_NL_IHARDBELOW 7		/* Usage got below inode hardlimit */
#define QUOTA_NL_ISOFTBELOW 8		/* Usage got below inode softlimit */
#define QUOTA_NL_BHARDBELOW 9		/* Usage got below block hardlimit */
#define QUOTA_NL_BSOFTBELOW 10		/* Usage got below block softlimit */

enum {
	QUOTA_NL_C_UNSPEC,
	QUOTA_NL_C_WARNING,
	__QUOTA_NL_C_MAX,
};
#define QUOTA_NL_C_MAX (__QUOTA_NL_C_MAX - 1)

enum {
	QUOTA_NL_A_UNSPEC,
	QUOTA_NL_A_QTYPE,
	QUOTA_NL_A_EXCESS_ID,
	QUOTA_NL_A_WARNING,
	QUOTA_NL_A_DEV_MAJOR,
	QUOTA_NL_A_DEV_MINOR,
	QUOTA_NL_A_CAUSED_ID,
	__QUOTA_NL_A_MAX,
};
#define QUOTA_NL_A_MAX (__QUOTA_NL_A_MAX - 1)


#ifdef __KERNEL__
#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/rwsem.h>
#include <linux/spinlock.h>
#include <linux/wait.h>
#include <linux/percpu_counter.h>

#include <linux/dqblk_xfs.h>
#include <linux/dqblk_v1.h>
#include <linux/dqblk_v2.h>

#include <linux/atomic.h>
#include <linux/uidgid.h>
#include <linux/projid.h>

#undef USRQUOTA
#undef GRPQUOTA
enum quota_type {
	USRQUOTA = 0,		/* element used for user quotas */
	GRPQUOTA = 1,		/* element used for group quotas */
	PRJQUOTA = 2,		/* element used for project quotas */
};

typedef __kernel_uid32_t qid_t; /* Type in which we store ids in memory */
typedef long long qsize_t;	/* Type in which we store sizes */

struct kqid {			/* Type in which we store the quota identifier */
	union {
		kuid_t uid;
		kgid_t gid;
		kprojid_t projid;
	};
	enum quota_type type;  /* USRQUOTA (uid) or GRPQUOTA (gid) or PRJQUOTA (projid) */
};

extern bool qid_eq(struct kqid left, struct kqid right);
extern bool qid_lt(struct kqid left, struct kqid right);
extern qid_t from_kqid(struct user_namespace *to, struct kqid qid);
extern qid_t from_kqid_munged(struct user_namespace *to, struct kqid qid);
extern bool qid_valid(struct kqid qid);

/**
 *	make_kqid - Map a user-namespace, type, qid tuple into a kqid.
 *	@from: User namespace that the qid is in
 *	@type: The type of quota
 *	@qid: Quota identifier
 *
 *	Maps a user-namespace, type qid tuple into a kernel internal
 *	kqid, and returns that kqid.
 *
 *	When there is no mapping defined for the user-namespace, type,
 *	qid tuple an invalid kqid is returned.  Callers are expected to
 *	test for and handle handle invalid kqids being returned.
 *	Invalid kqids may be tested for using qid_valid().
 */
static inline struct kqid make_kqid(struct user_namespace *from,
				    enum quota_type type, qid_t qid)
{
	struct kqid kqid;

	kqid.type = type;
	switch (type) {
	case USRQUOTA:
		kqid.uid = make_kuid(from, qid);
		break;
	case GRPQUOTA:
		kqid.gid = make_kgid(from, qid);
		break;
	case PRJQUOTA:
		kqid.projid = make_kprojid(from, qid);
		break;
	default:
		BUG();
	}
	return kqid;
}

/**
 *	make_kqid_invalid - Explicitly make an invalid kqid
 *	@type: The type of quota identifier
 *
 *	Returns an invalid kqid with the specified type.
 */
static inline struct kqid make_kqid_invalid(enum quota_type type)
{
	struct kqid kqid;

	kqid.type = type;
	switch (type) {
	case USRQUOTA:
		kqid.uid = INVALID_UID;
		break;
	case GRPQUOTA:
		kqid.gid = INVALID_GID;
		break;
	case PRJQUOTA:
		kqid.projid = INVALID_PROJID;
		break;
	default:
		BUG();
	}
	return kqid;
}

/**
 *	make_kqid_uid - Make a kqid from a kuid
 *	@uid: The kuid to make the quota identifier from
 */
static inline struct kqid make_kqid_uid(kuid_t uid)
{
	struct kqid kqid;
	kqid.type = USRQUOTA;
	kqid.uid = uid;
	return kqid;
}

/**
 *	make_kqid_gid - Make a kqid from a kgid
 *	@gid: The kgid to make the quota identifier from
 */
static inline struct kqid make_kqid_gid(kgid_t gid)
{
	struct kqid kqid;
	kqid.type = GRPQUOTA;
	kqid.gid = gid;
	return kqid;
}

/**
 *	make_kqid_projid - Make a kqid from a projid
 *	@projid: The kprojid to make the quota identifier from
 */
static inline struct kqid make_kqid_projid(kprojid_t projid)
{
	struct kqid kqid;
	kqid.type = PRJQUOTA;
	kqid.projid = projid;
	return kqid;
}


extern spinlock_t dq_data_lock;

/* Maximal numbers of writes for quota operation (insert/delete/update)
 * (over VFS all formats) */
#define DQUOT_INIT_ALLOC max(V1_INIT_ALLOC, V2_INIT_ALLOC)
#define DQUOT_INIT_REWRITE max(V1_INIT_REWRITE, V2_INIT_REWRITE)
#define DQUOT_DEL_ALLOC max(V1_DEL_ALLOC, V2_DEL_ALLOC)
#define DQUOT_DEL_REWRITE max(V1_DEL_REWRITE, V2_DEL_REWRITE)

/*
 * Data for one user/group kept in memory
 */
struct mem_dqblk {
	qsize_t dqb_bhardlimit;	/* absolute limit on disk blks alloc */
	qsize_t dqb_bsoftlimit;	/* preferred limit on disk blks */
	qsize_t dqb_curspace;	/* current used space */
	qsize_t dqb_rsvspace;   /* current reserved space for delalloc*/
	qsize_t dqb_ihardlimit;	/* absolute limit on allocated inodes */
	qsize_t dqb_isoftlimit;	/* preferred inode limit */
	qsize_t dqb_curinodes;	/* current # allocated inodes */
	time_t dqb_btime;	/* time limit for excessive disk use */
	time_t dqb_itime;	/* time limit for excessive inode use */
};

/*
 * Data for one quotafile kept in memory
 */
struct quota_format_type;

struct mem_dqinfo {
	struct quota_format_type *dqi_format;
	int dqi_fmt_id;		/* Id of the dqi_format - used when turning
				 * quotas on after remount RW */
	struct list_head dqi_dirty_list;	/* List of dirty dquots */
	unsigned long dqi_flags;
	unsigned int dqi_bgrace;
	unsigned int dqi_igrace;
	qsize_t dqi_maxblimit;
	qsize_t dqi_maxilimit;
	void *dqi_priv;
};

struct super_block;

#define DQF_MASK 0xffff		/* Mask for format specific flags */
#define DQF_GETINFO_MASK 0x1ffff	/* Mask for flags passed to userspace */
#define DQF_SETINFO_MASK 0xffff		/* Mask for flags modifiable from userspace */
#define DQF_SYS_FILE_B		16
#define DQF_SYS_FILE (1 << DQF_SYS_FILE_B)	/* Quota file stored as system file */
#define DQF_INFO_DIRTY_B	31
#define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B)	/* Is info dirty? */

extern void mark_info_dirty(struct super_block *sb, int type);
static inline int info_dirty(struct mem_dqinfo *info)
{
	return test_bit(DQF_INFO_DIRTY_B, &info->dqi_flags);
}

enum {
	DQST_LOOKUPS,
	DQST_DROPS,
	DQST_READS,
	DQST_WRITES,
	DQST_CACHE_HITS,
	DQST_ALLOC_DQUOTS,
	DQST_FREE_DQUOTS,
	DQST_SYNCS,
	_DQST_DQSTAT_LAST
};

struct dqstats {
	int stat[_DQST_DQSTAT_LAST];
	struct percpu_counter counter[_DQST_DQSTAT_LAST];
};

extern struct dqstats *dqstats_pcpu;
extern struct dqstats dqstats;

static inline void dqstats_inc(unsigned int type)
{
	percpu_counter_inc(&dqstats.counter[type]);
}

static inline void dqstats_dec(unsigned int type)
{
	percpu_counter_dec(&dqstats.counter[type]);
}

#define DQ_MOD_B	0	/* dquot modified since read */
#define DQ_BLKS_B	1	/* uid/gid has been warned about blk limit */
#define DQ_INODES_B	2	/* uid/gid has been warned about inode limit */
#define DQ_FAKE_B	3	/* no limits only usage */
#define DQ_READ_B	4	/* dquot was read into memory */
#define DQ_ACTIVE_B	5	/* dquot is active (dquot_release not called) */
#define DQ_LASTSET_B	6	/* Following 6 bits (see QIF_) are reserved\
				 * for the mask of entries set via SETQUOTA\
				 * quotactl. They are set under dq_data_lock\
				 * and the quota format handling dquot can\
				 * clear them when it sees fit. */

struct dquot {
	struct hlist_node dq_hash;	/* Hash list in memory */
	struct list_head dq_inuse;	/* List of all quotas */
	struct list_head dq_free;	/* Free list element */
	struct list_head dq_dirty;	/* List of dirty dquots */
	struct mutex dq_lock;		/* dquot IO lock */
	atomic_t dq_count;		/* Use count */
	wait_queue_head_t dq_wait_unused;	/* Wait queue for dquot to become unused */
	struct super_block *dq_sb;	/* superblock this applies to */
	unsigned int dq_id;		/* ID this applies to (uid, gid) */
	loff_t dq_off;			/* Offset of dquot on disk */
	unsigned long dq_flags;		/* See DQ_* */
	short dq_type;			/* Type of quota */
	struct mem_dqblk dq_dqb;	/* Diskquota usage */
};

/* Operations which must be implemented by each quota format */
struct quota_format_ops {
	int (*check_quota_file)(struct super_block *sb, int type);	/* Detect whether file is in our format */
	int (*read_file_info)(struct super_block *sb, int type);	/* Read main info about file - called on quotaon() */
	int (*write_file_info)(struct super_block *sb, int type);	/* Write main info about file */
	int (*free_file_info)(struct super_block *sb, int type);	/* Called on quotaoff() */
	int (*read_dqblk)(struct dquot *dquot);		/* Read structure for one user */
	int (*commit_dqblk)(struct dquot *dquot);	/* Write structure for one user */
	int (*release_dqblk)(struct dquot *dquot);	/* Called when last reference to dquot is being dropped */
};

/* Operations working with dquots */
struct dquot_operations {
	int (*write_dquot) (struct dquot *);		/* Ordinary dquot write */
	struct dquot *(*alloc_dquot)(struct super_block *, int);	/* Allocate memory for new dquot */
	void (*destroy_dquot)(struct dquot *);		/* Free memory for dquot */
	int (*acquire_dquot) (struct dquot *);		/* Quota is going to be created on disk */
	int (*release_dquot) (struct dquot *);		/* Quota is going to be deleted from disk */
	int (*mark_dirty) (struct dquot *);		/* Dquot is marked dirty */
	int (*write_info) (struct super_block *, int);	/* Write of quota "superblock" */
	/* get reserved quota for delayed alloc, value returned is managed by
	 * quota code only */
	qsize_t *(*get_reserved_space) (struct inode *);
};

struct path;

/* Operations handling requests from userspace */
struct quotactl_ops {
	int (*quota_on)(struct super_block *, int, int, struct path *);
	int (*quota_on_meta)(struct super_block *, int, int);
	int (*quota_off)(struct super_block *, int);
	int (*quota_sync)(struct super_block *, int);
	int (*get_info)(struct super_block *, int, struct if_dqinfo *);
	int (*set_info)(struct super_block *, int, struct if_dqinfo *);
	int (*get_dqblk)(struct super_block *, struct kqid, struct fs_disk_quota *);
	int (*set_dqblk)(struct super_block *, struct kqid, struct fs_disk_quota *);
	int (*get_xstate)(struct super_block *, struct fs_quota_stat *);
	int (*set_xstate)(struct super_block *, unsigned int, int);
};

struct quota_format_type {
	int qf_fmt_id;	/* Quota format id */
	const struct quota_format_ops *qf_ops;	/* Operations of format */
	struct module *qf_owner;		/* Module implementing quota format */
	struct quota_format_type *qf_next;
};

/* Quota state flags - they actually come in two flavors - for users and groups */
enum {
	_DQUOT_USAGE_ENABLED = 0,		/* Track disk usage for users */
	_DQUOT_LIMITS_ENABLED,			/* Enforce quota limits for users */
	_DQUOT_SUSPENDED,			/* User diskquotas are off, but
						 * we have necessary info in
						 * memory to turn them on */
	_DQUOT_STATE_FLAGS
};
#define DQUOT_USAGE_ENABLED	(1 << _DQUOT_USAGE_ENABLED)
#define DQUOT_LIMITS_ENABLED	(1 << _DQUOT_LIMITS_ENABLED)
#define DQUOT_SUSPENDED		(1 << _DQUOT_SUSPENDED)
#define DQUOT_STATE_FLAGS	(DQUOT_USAGE_ENABLED | DQUOT_LIMITS_ENABLED | \
				 DQUOT_SUSPENDED)
/* Other quota flags */
#define DQUOT_STATE_LAST	(_DQUOT_STATE_FLAGS * MAXQUOTAS)
#define DQUOT_QUOTA_SYS_FILE	(1 << DQUOT_STATE_LAST)
						/* Quota file is a special
						 * system file and user cannot
						 * touch it. Filesystem is
						 * responsible for setting
						 * S_NOQUOTA, S_NOATIME flags
						 */
#define DQUOT_NEGATIVE_USAGE	(1 << (DQUOT_STATE_LAST + 1))
					       /* Allow negative quota usage */

static inline unsigned int dquot_state_flag(unsigned int flags, int type)
{
	return flags << _DQUOT_STATE_FLAGS * type;
}

static inline unsigned int dquot_generic_flag(unsigned int flags, int type)
{
	return (flags >> _DQUOT_STATE_FLAGS * type) & DQUOT_STATE_FLAGS;
}

#ifdef CONFIG_QUOTA_NETLINK_INTERFACE
extern void quota_send_warning(short type, unsigned int id, dev_t dev,
			       const char warntype);
#else
static inline void quota_send_warning(short type, unsigned int id, dev_t dev,
				      const char warntype)
{
	return;
}
#endif /* CONFIG_QUOTA_NETLINK_INTERFACE */

struct quota_info {
	unsigned int flags;			/* Flags for diskquotas on this device */
	struct mutex dqio_mutex;		/* lock device while I/O in progress */
	struct mutex dqonoff_mutex;		/* Serialize quotaon & quotaoff */
	struct rw_semaphore dqptr_sem;		/* serialize ops using quota_info struct, pointers from inode to dquots */
	struct inode *files[MAXQUOTAS];		/* inodes of quotafiles */
	struct mem_dqinfo info[MAXQUOTAS];	/* Information for each quota type */
	const struct quota_format_ops *ops[MAXQUOTAS];	/* Operations for each type */
};

int register_quota_format(struct quota_format_type *fmt);
void unregister_quota_format(struct quota_format_type *fmt);

struct quota_module_name {
	int qm_fmt_id;
	char *qm_mod_name;
};

#define INIT_QUOTA_MODULE_NAMES {\
	{QFMT_VFS_OLD, "quota_v1"},\
	{QFMT_VFS_V0, "quota_v2"},\
	{0, NULL}}

#endif /* __KERNEL__ */
#endif /* _QUOTA_ */
Commit	Line	Data
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.
1da177e4 LT	31	*/
	32
	33	#ifndef _LINUX_QUOTA_
	34	#define _LINUX_QUOTA_
	35
	36	#include <linux/errno.h>
	37	#include <linux/types.h>
1da177e4	38
571b46e4	39	#define __DQUOT_VERSION__ "dquot_6.5.2"
1da177e4	40
1da177e4 LT	41	#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
5cd9d5bb JK	73	/* Quota format type IDs */
	74	#define QFMT_VFS_OLD 1
	75	#define QFMT_VFS_V0 2
30673930	76	#define QFMT_OCFS2 3
498c6015	77	#define QFMT_VFS_V1 4
5cd9d5bb	78
12095460 JK	79	/* 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
1da177e4 LT	84	/*
	85	* Quota structure used for communication with userspace via quotactl
	86	* Following flags are used to specify which fields are valid
	87	*/
4d59bce4 JK	88	enum {
	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)
1da177e4 LT	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)
	107
	108	struct 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
	129	struct if_dqinfo {
	130	__u64 dqi_bgrace;
	131	__u64 dqi_igrace;
	132	__u32 dqi_flags;
	133	__u32 dqi_valid;
	134	};
	135
8e893469 JK	136	/*
	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 */
657d3bfa JK	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 */
8e893469 JK	150
	151	enum {
	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
	158	enum {
	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
1da177e4	171	#ifdef __KERNEL__
8b91de2e	172	#include <linux/list.h>
0409d3a3	173	#include <linux/mutex.h>
8b91de2e MW	174	#include <linux/rwsem.h>
	175	#include <linux/spinlock.h>
	176	#include <linux/wait.h>
f32764bd	177	#include <linux/percpu_counter.h>
1da177e4 LT	178
	179	#include <linux/dqblk_xfs.h>
	180	#include <linux/dqblk_v1.h>
	181	#include <linux/dqblk_v2.h>
	182
60063497	183	#include <linux/atomic.h>
e8a3e471 EB	184	#include <linux/uidgid.h>
	185	#include <linux/projid.h>
	186
	187	#undef USRQUOTA
	188	#undef GRPQUOTA
	189	enum quota_type {
	190	USRQUOTA = 0, /* element used for user quotas */
	191	GRPQUOTA = 1, /* element used for group quotas */
	192	PRJQUOTA = 2, /* element used for project quotas */
	193	};
8b91de2e	194
74abb989	195	typedef __kernel_uid32_t qid_t; /* Type in which we store ids in memory */
db49d2df	196	typedef long long qsize_t; /* Type in which we store sizes */
74abb989	197
e8a3e471 EB	198	struct kqid { /* Type in which we store the quota identifier */
	199	union {
	200	kuid_t uid;
	201	kgid_t gid;
	202	kprojid_t projid;
	203	};
	204	enum quota_type type; /* USRQUOTA (uid) or GRPQUOTA (gid) or PRJQUOTA (projid) */
	205	};
	206
	207	extern bool qid_eq(struct kqid left, struct kqid right);
	208	extern bool qid_lt(struct kqid left, struct kqid right);
	209	extern qid_t from_kqid(struct user_namespace *to, struct kqid qid);
	210	extern qid_t from_kqid_munged(struct user_namespace *to, struct kqid qid);
	211	extern bool qid_valid(struct kqid qid);
	212
	213	/**
	214	* make_kqid - Map a user-namespace, type, qid tuple into a kqid.
	215	* @from: User namespace that the qid is in
	216	* @type: The type of quota
	217	* @qid: Quota identifier
	218	*
	219	* Maps a user-namespace, type qid tuple into a kernel internal
	220	* kqid, and returns that kqid.
	221	*
	222	* When there is no mapping defined for the user-namespace, type,
	223	* qid tuple an invalid kqid is returned. Callers are expected to
	224	* test for and handle handle invalid kqids being returned.
	225	* Invalid kqids may be tested for using qid_valid().
	226	*/
	227	static inline struct kqid make_kqid(struct user_namespace *from,
	228	enum quota_type type, qid_t qid)
	229	{
	230	struct kqid kqid;
	231
	232	kqid.type = type;
	233	switch (type) {
	234	case USRQUOTA:
	235	kqid.uid = make_kuid(from, qid);
	236	break;
	237	case GRPQUOTA:
	238	kqid.gid = make_kgid(from, qid);
	239	break;
	240	case PRJQUOTA:
	241	kqid.projid = make_kprojid(from, qid);
	242	break;
	243	default:
	244	BUG();
	245	}
	246	return kqid;
	247	}
	248
	249	/**
	250	* make_kqid_invalid - Explicitly make an invalid kqid
	251	* @type: The type of quota identifier
	252	*
	253	* Returns an invalid kqid with the specified type.
	254	*/
	255	static inline struct kqid make_kqid_invalid(enum quota_type type)
	256	{
	257	struct kqid kqid;
	258
	259	kqid.type = type;
	260	switch (type) {
	261	case USRQUOTA:
262	kqid.uid = INVALID_UID;
263	break;
264	case GRPQUOTA:
265	kqid.gid = INVALID_GID;
266	break;
267	case PRJQUOTA:
268	kqid.projid = INVALID_PROJID;
269	break;
270	default:
271	BUG();
272	}
273	return kqid;
274	}
275
276	/**
277	* make_kqid_uid - Make a kqid from a kuid
278	* @uid: The kuid to make the quota identifier from
279	*/
280	static inline struct kqid make_kqid_uid(kuid_t uid)
281	{
282	struct kqid kqid;
283	kqid.type = USRQUOTA;
284	kqid.uid = uid;
285	return kqid;
286	}
287
288	/**
289	* make_kqid_gid - Make a kqid from a kgid
290	* @gid: The kgid to make the quota identifier from
291	*/
292	static inline struct kqid make_kqid_gid(kgid_t gid)
293	{
294	struct kqid kqid;
295	kqid.type = GRPQUOTA;
296	kqid.gid = gid;
297	return kqid;
298	}
299
300	/**
301	* make_kqid_projid - Make a kqid from a projid
302	* @projid: The kprojid to make the quota identifier from
303	*/
304	static inline struct kqid make_kqid_projid(kprojid_t projid)
305	{
306	struct kqid kqid;
307	kqid.type = PRJQUOTA;
308	kqid.projid = projid;
309	return kqid;
310	}
311
312
acd64b73 MF	313	extern spinlock_t dq_data_lock;
acd64b73 MF	314
1da177e4	315	/* Maximal numbers of writes for quota operation (insert/delete/update)
4e5117ba JK	316	* (over VFS all formats) */
	317	#define DQUOT_INIT_ALLOC max(V1_INIT_ALLOC, V2_INIT_ALLOC)
	318	#define DQUOT_INIT_REWRITE max(V1_INIT_REWRITE, V2_INIT_REWRITE)
	319	#define DQUOT_DEL_ALLOC max(V1_DEL_ALLOC, V2_DEL_ALLOC)
	320	#define DQUOT_DEL_REWRITE max(V1_DEL_REWRITE, V2_DEL_REWRITE)
1da177e4 LT	321
	322	/*
	323	* Data for one user/group kept in memory
	324	*/
	325	struct mem_dqblk {
12095460 JK	326	qsize_t dqb_bhardlimit; /* absolute limit on disk blks alloc */
12095460 JK	327	qsize_t dqb_bsoftlimit; /* preferred limit on disk blks */
1da177e4	328	qsize_t dqb_curspace; /* current used space */
f18df228	329	qsize_t dqb_rsvspace; /* current reserved space for delalloc*/
12095460 JK	330	qsize_t dqb_ihardlimit; /* absolute limit on allocated inodes */
	331	qsize_t dqb_isoftlimit; /* preferred inode limit */
	332	qsize_t dqb_curinodes; /* current # allocated inodes */
1da177e4 LT	333	time_t dqb_btime; /* time limit for excessive disk use */
	334	time_t dqb_itime; /* time limit for excessive inode use */
	335	};
	336
	337	/*
	338	* Data for one quotafile kept in memory
	339	*/
	340	struct quota_format_type;
	341
	342	struct mem_dqinfo {
	343	struct quota_format_type *dqi_format;
0ff5af83 JK	344	int dqi_fmt_id; /* Id of the dqi_format - used when turning
0ff5af83 JK	345	* quotas on after remount RW */
1da177e4 LT	346	struct list_head dqi_dirty_list; /* List of dirty dquots */
	347	unsigned long dqi_flags;
	348	unsigned int dqi_bgrace;
	349	unsigned int dqi_igrace;
338bf9af AP	350	qsize_t dqi_maxblimit;
338bf9af AP	351	qsize_t dqi_maxilimit;
e3d4d56b	352	void *dqi_priv;
1da177e4 LT	353	};
	354
	355	struct super_block;
	356
	357	#define DQF_MASK 0xffff /* Mask for format specific flags */
46fe44ce JK	358	#define DQF_GETINFO_MASK 0x1ffff /* Mask for flags passed to userspace */
	359	#define DQF_SETINFO_MASK 0xffff /* Mask for flags modifiable from userspace */
	360	#define DQF_SYS_FILE_B 16
	361	#define DQF_SYS_FILE (1 << DQF_SYS_FILE_B) /* Quota file stored as system file */
	362	#define DQF_INFO_DIRTY_B 31
1da177e4 LT	363	#define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B) /* Is info dirty? */
	364
	365	extern void mark_info_dirty(struct super_block *sb, int type);
03b06343 JK	366	static inline int info_dirty(struct mem_dqinfo *info)
	367	{
	368	return test_bit(DQF_INFO_DIRTY_B, &info->dqi_flags);
	369	}
1da177e4	370
dde95888 DM	371	enum {
	372	DQST_LOOKUPS,
	373	DQST_DROPS,
	374	DQST_READS,
	375	DQST_WRITES,
	376	DQST_CACHE_HITS,
	377	DQST_ALLOC_DQUOTS,
	378	DQST_FREE_DQUOTS,
	379	DQST_SYNCS,
	380	_DQST_DQSTAT_LAST
	381	};
	382
1da177e4	383	struct dqstats {
dde95888	384	int stat[_DQST_DQSTAT_LAST];
f32764bd	385	struct percpu_counter counter[_DQST_DQSTAT_LAST];
1da177e4 LT	386	};
1da177e4 LT	387
dde95888	388	extern struct dqstats *dqstats_pcpu;
1da177e4 LT	389	extern struct dqstats dqstats;
1da177e4 LT	390
dde95888 DM	391	static inline void dqstats_inc(unsigned int type)
dde95888 DM	392	{
f32764bd	393	percpu_counter_inc(&dqstats.counter[type]);
dde95888 DM	394	}
	395
	396	static inline void dqstats_dec(unsigned int type)
	397	{
f32764bd	398	percpu_counter_dec(&dqstats.counter[type]);
dde95888 DM	399	}
dde95888 DM	400
1da177e4 LT	401	#define DQ_MOD_B 0 /* dquot modified since read */
	402	#define DQ_BLKS_B 1 /* uid/gid has been warned about blk limit */
	403	#define DQ_INODES_B 2 /* uid/gid has been warned about inode limit */
	404	#define DQ_FAKE_B 3 /* no limits only usage */
	405	#define DQ_READ_B 4 /* dquot was read into memory */
	406	#define DQ_ACTIVE_B 5 /* dquot is active (dquot_release not called) */
4d59bce4 JK	407	#define DQ_LASTSET_B 6 /* Following 6 bits (see QIF_) are reserved\
	408	* for the mask of entries set via SETQUOTA\
	409	* quotactl. They are set under dq_data_lock\
	410	* and the quota format handling dquot can\
	411	* clear them when it sees fit. */
1da177e4 LT	412
	413	struct dquot {
	414	struct hlist_node dq_hash; /* Hash list in memory */
	415	struct list_head dq_inuse; /* List of all quotas */
	416	struct list_head dq_free; /* Free list element */
	417	struct list_head dq_dirty; /* List of dirty dquots */
d3be915f	418	struct mutex dq_lock; /* dquot IO lock */
1da177e4 LT	419	atomic_t dq_count; /* Use count */
	420	wait_queue_head_t dq_wait_unused; /* Wait queue for dquot to become unused */
	421	struct super_block dq_sb; / superblock this applies to */
	422	unsigned int dq_id; /* ID this applies to (uid, gid) */
	423	loff_t dq_off; /* Offset of dquot on disk */
	424	unsigned long dq_flags; /* See DQ_* */
	425	short dq_type; /* Type of quota */
	426	struct mem_dqblk dq_dqb; /* Diskquota usage */
	427	};
	428
1da177e4 LT	429	/* Operations which must be implemented by each quota format */
	430	struct quota_format_ops {
	431	int (check_quota_file)(struct super_block sb, int type); /* Detect whether file is in our format */
	432	int (read_file_info)(struct super_block sb, int type); /* Read main info about file - called on quotaon() */
	433	int (write_file_info)(struct super_block sb, int type); /* Write main info about file */
	434	int (free_file_info)(struct super_block sb, int type); /* Called on quotaoff() */
	435	int (read_dqblk)(struct dquot dquot); /* Read structure for one user */
	436	int (commit_dqblk)(struct dquot dquot); /* Write structure for one user */
	437	int (release_dqblk)(struct dquot dquot); /* Called when last reference to dquot is being dropped */
	438	};
	439
	440	/* Operations working with dquots */
	441	struct dquot_operations {
1da177e4	442	int (write_dquot) (struct dquot ); /* Ordinary dquot write */
74f783af JK	443	struct dquot (alloc_dquot)(struct super_block , int); / Allocate memory for new dquot */
74f783af JK	444	void (destroy_dquot)(struct dquot ); /* Free memory for dquot */
1da177e4 LT	445	int (acquire_dquot) (struct dquot ); /* Quota is going to be created on disk */
	446	int (release_dquot) (struct dquot ); /* Quota is going to be deleted from disk */
	447	int (mark_dirty) (struct dquot ); /* Dquot is marked dirty */
	448	int (write_info) (struct super_block , int); /* Write of quota "superblock" */
fd8fbfc1 DM	449	/* get reserved quota for delayed alloc, value returned is managed by
	450	* quota code only */
	451	qsize_t (get_reserved_space) (struct inode *);
1da177e4 LT	452	};
1da177e4 LT	453
f00c9e44 JK	454	struct path;
f00c9e44 JK	455
1da177e4 LT	456	/* Operations handling requests from userspace */
1da177e4 LT	457	struct quotactl_ops {
f00c9e44 JK	458	int (quota_on)(struct super_block , int, int, struct path *);
f00c9e44 JK	459	int (quota_on_meta)(struct super_block , int, int);
307ae18a	460	int (quota_off)(struct super_block , int);
ceed1723	461	int (quota_sync)(struct super_block , int);
1da177e4 LT	462	int (get_info)(struct super_block , int, struct if_dqinfo *);
1da177e4 LT	463	int (set_info)(struct super_block , int, struct if_dqinfo *);
74a8a103 EB	464	int (get_dqblk)(struct super_block , struct kqid, struct fs_disk_quota *);
74a8a103 EB	465	int (set_dqblk)(struct super_block , struct kqid, struct fs_disk_quota *);
1da177e4 LT	466	int (get_xstate)(struct super_block , struct fs_quota_stat *);
1da177e4 LT	467	int (set_xstate)(struct super_block , unsigned int, int);
1da177e4 LT	468	};
	469
	470	struct quota_format_type {
	471	int qf_fmt_id; /* Quota format id */
1472da5f	472	const struct quota_format_ops qf_ops; / Operations of format */
1da177e4 LT	473	struct module qf_owner; / Module implementing quota format */
	474	struct quota_format_type *qf_next;
	475	};
	476
f55abc0f JK	477	/* Quota state flags - they actually come in two flavors - for users and groups */
	478	enum {
	479	_DQUOT_USAGE_ENABLED = 0, /* Track disk usage for users */
	480	_DQUOT_LIMITS_ENABLED, /* Enforce quota limits for users */
	481	_DQUOT_SUSPENDED, /* User diskquotas are off, but
0ff5af83 JK	482	* we have necessary info in
0ff5af83 JK	483	* memory to turn them on */
f55abc0f JK	484	_DQUOT_STATE_FLAGS
	485	};
	486	#define DQUOT_USAGE_ENABLED (1 << _DQUOT_USAGE_ENABLED)
	487	#define DQUOT_LIMITS_ENABLED (1 << _DQUOT_LIMITS_ENABLED)
	488	#define DQUOT_SUSPENDED (1 << _DQUOT_SUSPENDED)
	489	#define DQUOT_STATE_FLAGS (DQUOT_USAGE_ENABLED \| DQUOT_LIMITS_ENABLED \| \
	490	DQUOT_SUSPENDED)
ca785ec6	491	/* Other quota flags */
ad1e6e8d DM	492	#define DQUOT_STATE_LAST (_DQUOT_STATE_FLAGS * MAXQUOTAS)
	493	#define DQUOT_QUOTA_SYS_FILE (1 << DQUOT_STATE_LAST)
	494	/* Quota file is a special
ca785ec6 JK	495	* system file and user cannot
	496	* touch it. Filesystem is
	497	* responsible for setting
	498	* S_NOQUOTA, S_NOATIME flags
	499	*/
ad1e6e8d DM	500	#define DQUOT_NEGATIVE_USAGE (1 << (DQUOT_STATE_LAST + 1))
ad1e6e8d DM	501	/* Allow negative quota usage */
f55abc0f JK	502
	503	static inline unsigned int dquot_state_flag(unsigned int flags, int type)
	504	{
ad1e6e8d	505	return flags << _DQUOT_STATE_FLAGS * type;
f55abc0f JK	506	}
	507
	508	static inline unsigned int dquot_generic_flag(unsigned int flags, int type)
	509	{
ad1e6e8d	510	return (flags >> _DQUOT_STATE_FLAGS * type) & DQUOT_STATE_FLAGS;
f55abc0f	511	}
1da177e4	512
86e931a3 SW	513	#ifdef CONFIG_QUOTA_NETLINK_INTERFACE
	514	extern void quota_send_warning(short type, unsigned int id, dev_t dev,
	515	const char warntype);
	516	#else
	517	static inline void quota_send_warning(short type, unsigned int id, dev_t dev,
	518	const char warntype)
	519	{
	520	return;
	521	}
	522	#endif /* CONFIG_QUOTA_NETLINK_INTERFACE */
	523
1da177e4 LT	524	struct quota_info {
1da177e4 LT	525	unsigned int flags; /* Flags for diskquotas on this device */
d3be915f IM	526	struct mutex dqio_mutex; /* lock device while I/O in progress */
d3be915f IM	527	struct mutex dqonoff_mutex; /* Serialize quotaon & quotaoff */
1da177e4 LT	528	struct rw_semaphore dqptr_sem; /* serialize ops using quota_info struct, pointers from inode to dquots */
1da177e4 LT	529	struct inode files[MAXQUOTAS]; / inodes of quotafiles */
1da177e4	530	struct mem_dqinfo info[MAXQUOTAS]; /* Information for each quota type */
1472da5f	531	const struct quota_format_ops ops[MAXQUOTAS]; / Operations for each type */
1da177e4 LT	532	};
1da177e4 LT	533
1da177e4 LT	534	int register_quota_format(struct quota_format_type *fmt);
	535	void unregister_quota_format(struct quota_format_type *fmt);
	536
	537	struct quota_module_name {
	538	int qm_fmt_id;
	539	char *qm_mod_name;
	540	};
	541
	542	#define INIT_QUOTA_MODULE_NAMES {\
	543	{QFMT_VFS_OLD, "quota_v1"},\
	544	{QFMT_VFS_V0, "quota_v2"},\
	545	{0, NULL}}
	546
1da177e4 LT	547	#endif /* __KERNEL__ */
1da177e4 LT	548	#endif /* _QUOTA_ */