[mirror_ubuntu-bionic-kernel.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/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>
#include <uapi/linux/quota.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 */
};

/* Masks for quota types when used as a bitmask */
#define QTYPE_MASK_USR (1 << USRQUOTA)
#define QTYPE_MASK_GRP (1 << GRPQUOTA)
#define QTYPE_MASK_PRJ (1 << PRJQUOTA)

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;

/* Mask for flags passed to userspace */
#define DQF_GETINFO_MASK (DQF_ROOT_SQUASH | DQF_SYS_FILE)
/* Mask for flags modifiable from userspace */
#define DQF_SETINFO_MASK DQF_ROOT_SQUASH

enum {
	DQF_INFO_DIRTY_B = DQF_PRIVATE,
};
#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 */
	struct kqid dq_id;		/* ID this applies to (uid, gid, projid) */
	loff_t dq_off;			/* Offset of dquot on disk */
	unsigned long dq_flags;		/* See DQ_* */
	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;

/* Structure for communicating via ->get_dqblk() & ->set_dqblk() */
struct qc_dqblk {
	int d_fieldmask;	/* mask of fields to change in ->set_dqblk() */
	u64 d_spc_hardlimit;	/* absolute limit on used space */
	u64 d_spc_softlimit;	/* preferred limit on used space */
	u64 d_ino_hardlimit;	/* maximum # allocated inodes */
	u64 d_ino_softlimit;	/* preferred inode limit */
	u64 d_space;		/* Space owned by the user */
	u64 d_ino_count;	/* # inodes owned by the user */
	s64 d_ino_timer;	/* zero if within inode limits */
				/* if not, we refuse service */
	s64 d_spc_timer;	/* similar to above; for space */
	int d_ino_warns;	/* # warnings issued wrt num inodes */
	int d_spc_warns;	/* # warnings issued wrt used space */
	u64 d_rt_spc_hardlimit;	/* absolute limit on realtime space */
	u64 d_rt_spc_softlimit;	/* preferred limit on RT space */
	u64 d_rt_space;		/* realtime space owned */
	s64 d_rt_spc_timer;	/* similar to above; for RT space */
	int d_rt_spc_warns;	/* # warnings issued wrt RT space */
};

/* Field specifiers for ->set_dqblk() in struct qc_dqblk */
#define	QC_INO_SOFT	(1<<0)
#define	QC_INO_HARD	(1<<1)
#define	QC_SPC_SOFT	(1<<2)
#define	QC_SPC_HARD	(1<<3)
#define	QC_RT_SPC_SOFT	(1<<4)
#define	QC_RT_SPC_HARD	(1<<5)
#define QC_LIMIT_MASK (QC_INO_SOFT | QC_INO_HARD | QC_SPC_SOFT | QC_SPC_HARD | \
		       QC_RT_SPC_SOFT | QC_RT_SPC_HARD)
#define	QC_SPC_TIMER	(1<<6)
#define	QC_INO_TIMER	(1<<7)
#define	QC_RT_SPC_TIMER	(1<<8)
#define QC_TIMER_MASK (QC_SPC_TIMER | QC_INO_TIMER | QC_RT_SPC_TIMER)
#define	QC_SPC_WARNS	(1<<9)
#define	QC_INO_WARNS	(1<<10)
#define	QC_RT_SPC_WARNS	(1<<11)
#define QC_WARNS_MASK (QC_SPC_WARNS | QC_INO_WARNS | QC_RT_SPC_WARNS)
#define	QC_SPACE	(1<<12)
#define	QC_INO_COUNT	(1<<13)
#define	QC_RT_SPACE	(1<<14)
#define QC_ACCT_MASK (QC_SPACE | QC_INO_COUNT | QC_RT_SPACE)

/* Operations handling requests from userspace */
struct quotactl_ops {
	int (*quota_on)(struct super_block *, int, int, struct path *);
	int (*quota_off)(struct super_block *, int);
	int (*quota_enable)(struct super_block *, unsigned int);
	int (*quota_disable)(struct super_block *, unsigned 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 qc_dqblk *);
	int (*set_dqblk)(struct super_block *, struct kqid, struct qc_dqblk *);
	int (*get_xstate)(struct super_block *, struct fs_quota_stat *);
	int (*get_xstatev)(struct super_block *, struct fs_quota_statv *);
	int (*rm_xquota)(struct super_block *, unsigned 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(struct kqid qid, dev_t dev,
			       const char warntype);
#else
static inline void quota_send_warning(struct kqid qid, 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 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"},\
	{QFMT_VFS_V1, "quota_v2"},\
	{0, NULL}}

#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	31	*/
1da177e4 LT	32	#ifndef _LINUX_QUOTA_
	33	#define _LINUX_QUOTA_
	34
8b91de2e	35	#include <linux/list.h>
0409d3a3	36	#include <linux/mutex.h>
8b91de2e MW	37	#include <linux/rwsem.h>
	38	#include <linux/spinlock.h>
	39	#include <linux/wait.h>
f32764bd	40	#include <linux/percpu_counter.h>
1da177e4 LT	41
	42	#include <linux/dqblk_xfs.h>
	43	#include <linux/dqblk_v1.h>
	44	#include <linux/dqblk_v2.h>
	45
60063497	46	#include <linux/atomic.h>
e8a3e471 EB	47	#include <linux/uidgid.h>
e8a3e471 EB	48	#include <linux/projid.h>
607ca46e	49	#include <uapi/linux/quota.h>
e8a3e471 EB	50
	51	#undef USRQUOTA
	52	#undef GRPQUOTA
	53	enum quota_type {
	54	USRQUOTA = 0, /* element used for user quotas */
	55	GRPQUOTA = 1, /* element used for group quotas */
	56	PRJQUOTA = 2, /* element used for project quotas */
	57	};
8b91de2e	58
2c5f648a JK	59	/* Masks for quota types when used as a bitmask */
	60	#define QTYPE_MASK_USR (1 << USRQUOTA)
	61	#define QTYPE_MASK_GRP (1 << GRPQUOTA)
	62	#define QTYPE_MASK_PRJ (1 << PRJQUOTA)
	63
74abb989	64	typedef __kernel_uid32_t qid_t; /* Type in which we store ids in memory */
db49d2df	65	typedef long long qsize_t; /* Type in which we store sizes */
74abb989	66
e8a3e471 EB	67	struct kqid { /* Type in which we store the quota identifier */
	68	union {
	69	kuid_t uid;
	70	kgid_t gid;
	71	kprojid_t projid;
	72	};
	73	enum quota_type type; /* USRQUOTA (uid) or GRPQUOTA (gid) or PRJQUOTA (projid) */
	74	};
	75
	76	extern bool qid_eq(struct kqid left, struct kqid right);
	77	extern bool qid_lt(struct kqid left, struct kqid right);
	78	extern qid_t from_kqid(struct user_namespace *to, struct kqid qid);
	79	extern qid_t from_kqid_munged(struct user_namespace *to, struct kqid qid);
	80	extern bool qid_valid(struct kqid qid);
	81
	82	/**
	83	* make_kqid - Map a user-namespace, type, qid tuple into a kqid.
	84	* @from: User namespace that the qid is in
	85	* @type: The type of quota
	86	* @qid: Quota identifier
	87	*
	88	* Maps a user-namespace, type qid tuple into a kernel internal
	89	* kqid, and returns that kqid.
	90	*
	91	* When there is no mapping defined for the user-namespace, type,
	92	* qid tuple an invalid kqid is returned. Callers are expected to
	93	* test for and handle handle invalid kqids being returned.
	94	* Invalid kqids may be tested for using qid_valid().
	95	*/
	96	static inline struct kqid make_kqid(struct user_namespace *from,
	97	enum quota_type type, qid_t qid)
	98	{
	99	struct kqid kqid;
	100
	101	kqid.type = type;
	102	switch (type) {
	103	case USRQUOTA:
	104	kqid.uid = make_kuid(from, qid);
	105	break;
	106	case GRPQUOTA:
	107	kqid.gid = make_kgid(from, qid);
	108	break;
	109	case PRJQUOTA:
	110	kqid.projid = make_kprojid(from, qid);
	111	break;
	112	default:
	113	BUG();
	114	}
	115	return kqid;
	116	}
	117
	118	/**
	119	* make_kqid_invalid - Explicitly make an invalid kqid
	120	* @type: The type of quota identifier
	121	*
	122	* Returns an invalid kqid with the specified type.
	123	*/
	124	static inline struct kqid make_kqid_invalid(enum quota_type type)
	125	{
	126	struct kqid kqid;
	127
	128	kqid.type = type;
	129	switch (type) {
	130	case USRQUOTA:
131	kqid.uid = INVALID_UID;
132	break;
133	case GRPQUOTA:
134	kqid.gid = INVALID_GID;
135	break;
136	case PRJQUOTA:
137	kqid.projid = INVALID_PROJID;
138	break;
139	default:
140	BUG();
141	}
142	return kqid;
143	}
144
145	/**
146	* make_kqid_uid - Make a kqid from a kuid
147	* @uid: The kuid to make the quota identifier from
148	*/
149	static inline struct kqid make_kqid_uid(kuid_t uid)
150	{
151	struct kqid kqid;
152	kqid.type = USRQUOTA;
153	kqid.uid = uid;
154	return kqid;
155	}
156
157	/**
158	* make_kqid_gid - Make a kqid from a kgid
159	* @gid: The kgid to make the quota identifier from
160	*/
161	static inline struct kqid make_kqid_gid(kgid_t gid)
162	{
163	struct kqid kqid;
164	kqid.type = GRPQUOTA;
165	kqid.gid = gid;
166	return kqid;
167	}
168
169	/**
170	* make_kqid_projid - Make a kqid from a projid
171	* @projid: The kprojid to make the quota identifier from
172	*/
173	static inline struct kqid make_kqid_projid(kprojid_t projid)
174	{
175	struct kqid kqid;
176	kqid.type = PRJQUOTA;
177	kqid.projid = projid;
178	return kqid;
179	}
180
181
acd64b73 MF	182	extern spinlock_t dq_data_lock;
acd64b73 MF	183
1da177e4	184	/* Maximal numbers of writes for quota operation (insert/delete/update)
4e5117ba JK	185	* (over VFS all formats) */
	186	#define DQUOT_INIT_ALLOC max(V1_INIT_ALLOC, V2_INIT_ALLOC)
	187	#define DQUOT_INIT_REWRITE max(V1_INIT_REWRITE, V2_INIT_REWRITE)
	188	#define DQUOT_DEL_ALLOC max(V1_DEL_ALLOC, V2_DEL_ALLOC)
	189	#define DQUOT_DEL_REWRITE max(V1_DEL_REWRITE, V2_DEL_REWRITE)
1da177e4 LT	190
	191	/*
	192	* Data for one user/group kept in memory
	193	*/
	194	struct mem_dqblk {
12095460 JK	195	qsize_t dqb_bhardlimit; /* absolute limit on disk blks alloc */
12095460 JK	196	qsize_t dqb_bsoftlimit; /* preferred limit on disk blks */
1da177e4	197	qsize_t dqb_curspace; /* current used space */
f18df228	198	qsize_t dqb_rsvspace; /* current reserved space for delalloc*/
12095460 JK	199	qsize_t dqb_ihardlimit; /* absolute limit on allocated inodes */
	200	qsize_t dqb_isoftlimit; /* preferred inode limit */
	201	qsize_t dqb_curinodes; /* current # allocated inodes */
1da177e4 LT	202	time_t dqb_btime; /* time limit for excessive disk use */
	203	time_t dqb_itime; /* time limit for excessive inode use */
	204	};
	205
	206	/*
	207	* Data for one quotafile kept in memory
	208	*/
	209	struct quota_format_type;
	210
	211	struct mem_dqinfo {
	212	struct quota_format_type *dqi_format;
0ff5af83 JK	213	int dqi_fmt_id; /* Id of the dqi_format - used when turning
0ff5af83 JK	214	* quotas on after remount RW */
1da177e4 LT	215	struct list_head dqi_dirty_list; /* List of dirty dquots */
	216	unsigned long dqi_flags;
	217	unsigned int dqi_bgrace;
	218	unsigned int dqi_igrace;
338bf9af AP	219	qsize_t dqi_maxblimit;
338bf9af AP	220	qsize_t dqi_maxilimit;
e3d4d56b	221	void *dqi_priv;
1da177e4 LT	222	};
	223
	224	struct super_block;
	225
9c45101e JK	226	/* Mask for flags passed to userspace */
	227	#define DQF_GETINFO_MASK (DQF_ROOT_SQUASH \| DQF_SYS_FILE)
	228	/* Mask for flags modifiable from userspace */
	229	#define DQF_SETINFO_MASK DQF_ROOT_SQUASH
	230
	231	enum {
	232	DQF_INFO_DIRTY_B = DQF_PRIVATE,
	233	};
1da177e4 LT	234	#define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B) /* Is info dirty? */
	235
	236	extern void mark_info_dirty(struct super_block *sb, int type);
03b06343 JK	237	static inline int info_dirty(struct mem_dqinfo *info)
	238	{
	239	return test_bit(DQF_INFO_DIRTY_B, &info->dqi_flags);
	240	}
1da177e4	241
dde95888 DM	242	enum {
	243	DQST_LOOKUPS,
	244	DQST_DROPS,
	245	DQST_READS,
	246	DQST_WRITES,
	247	DQST_CACHE_HITS,
	248	DQST_ALLOC_DQUOTS,
	249	DQST_FREE_DQUOTS,
	250	DQST_SYNCS,
	251	_DQST_DQSTAT_LAST
	252	};
	253
1da177e4	254	struct dqstats {
dde95888	255	int stat[_DQST_DQSTAT_LAST];
f32764bd	256	struct percpu_counter counter[_DQST_DQSTAT_LAST];
1da177e4 LT	257	};
1da177e4 LT	258
dde95888	259	extern struct dqstats *dqstats_pcpu;
1da177e4 LT	260	extern struct dqstats dqstats;
1da177e4 LT	261
dde95888 DM	262	static inline void dqstats_inc(unsigned int type)
dde95888 DM	263	{
f32764bd	264	percpu_counter_inc(&dqstats.counter[type]);
dde95888 DM	265	}
	266
	267	static inline void dqstats_dec(unsigned int type)
	268	{
f32764bd	269	percpu_counter_dec(&dqstats.counter[type]);
dde95888 DM	270	}
dde95888 DM	271
1da177e4 LT	272	#define DQ_MOD_B 0 /* dquot modified since read */
	273	#define DQ_BLKS_B 1 /* uid/gid has been warned about blk limit */
	274	#define DQ_INODES_B 2 /* uid/gid has been warned about inode limit */
	275	#define DQ_FAKE_B 3 /* no limits only usage */
	276	#define DQ_READ_B 4 /* dquot was read into memory */
	277	#define DQ_ACTIVE_B 5 /* dquot is active (dquot_release not called) */
4d59bce4 JK	278	#define DQ_LASTSET_B 6 /* Following 6 bits (see QIF_) are reserved\
	279	* for the mask of entries set via SETQUOTA\
	280	* quotactl. They are set under dq_data_lock\
	281	* and the quota format handling dquot can\
	282	* clear them when it sees fit. */
1da177e4 LT	283
	284	struct dquot {
	285	struct hlist_node dq_hash; /* Hash list in memory */
	286	struct list_head dq_inuse; /* List of all quotas */
	287	struct list_head dq_free; /* Free list element */
	288	struct list_head dq_dirty; /* List of dirty dquots */
d3be915f	289	struct mutex dq_lock; /* dquot IO lock */
1da177e4 LT	290	atomic_t dq_count; /* Use count */
	291	wait_queue_head_t dq_wait_unused; /* Wait queue for dquot to become unused */
	292	struct super_block dq_sb; / superblock this applies to */
4c376dca	293	struct kqid dq_id; /* ID this applies to (uid, gid, projid) */
1da177e4 LT	294	loff_t dq_off; /* Offset of dquot on disk */
1da177e4 LT	295	unsigned long dq_flags; /* See DQ_* */
1da177e4 LT	296	struct mem_dqblk dq_dqb; /* Diskquota usage */
	297	};
	298
1da177e4 LT	299	/* Operations which must be implemented by each quota format */
	300	struct quota_format_ops {
	301	int (check_quota_file)(struct super_block sb, int type); /* Detect whether file is in our format */
	302	int (read_file_info)(struct super_block sb, int type); /* Read main info about file - called on quotaon() */
	303	int (write_file_info)(struct super_block sb, int type); /* Write main info about file */
	304	int (free_file_info)(struct super_block sb, int type); /* Called on quotaoff() */
	305	int (read_dqblk)(struct dquot dquot); /* Read structure for one user */
	306	int (commit_dqblk)(struct dquot dquot); /* Write structure for one user */
	307	int (release_dqblk)(struct dquot dquot); /* Called when last reference to dquot is being dropped */
	308	};
	309
	310	/* Operations working with dquots */
	311	struct dquot_operations {
1da177e4	312	int (write_dquot) (struct dquot ); /* Ordinary dquot write */
74f783af JK	313	struct dquot (alloc_dquot)(struct super_block , int); / Allocate memory for new dquot */
74f783af JK	314	void (destroy_dquot)(struct dquot ); /* Free memory for dquot */
1da177e4 LT	315	int (acquire_dquot) (struct dquot ); /* Quota is going to be created on disk */
	316	int (release_dquot) (struct dquot ); /* Quota is going to be deleted from disk */
	317	int (mark_dirty) (struct dquot ); /* Dquot is marked dirty */
	318	int (write_info) (struct super_block , int); /* Write of quota "superblock" */
fd8fbfc1 DM	319	/* get reserved quota for delayed alloc, value returned is managed by
	320	* quota code only */
	321	qsize_t (get_reserved_space) (struct inode *);
1da177e4 LT	322	};
1da177e4 LT	323
f00c9e44 JK	324	struct path;
f00c9e44 JK	325
14bf61ff JK	326	/* Structure for communicating via ->get_dqblk() & ->set_dqblk() */
	327	struct qc_dqblk {
	328	int d_fieldmask; /* mask of fields to change in ->set_dqblk() */
	329	u64 d_spc_hardlimit; /* absolute limit on used space */
	330	u64 d_spc_softlimit; /* preferred limit on used space */
	331	u64 d_ino_hardlimit; /* maximum # allocated inodes */
	332	u64 d_ino_softlimit; /* preferred inode limit */
	333	u64 d_space; /* Space owned by the user */
	334	u64 d_ino_count; /* # inodes owned by the user */
	335	s64 d_ino_timer; /* zero if within inode limits */
	336	/* if not, we refuse service */
	337	s64 d_spc_timer; /* similar to above; for space */
	338	int d_ino_warns; /* # warnings issued wrt num inodes */
	339	int d_spc_warns; /* # warnings issued wrt used space */
	340	u64 d_rt_spc_hardlimit; /* absolute limit on realtime space */
	341	u64 d_rt_spc_softlimit; /* preferred limit on RT space */
	342	u64 d_rt_space; /* realtime space owned */
	343	s64 d_rt_spc_timer; /* similar to above; for RT space */
	344	int d_rt_spc_warns; /* # warnings issued wrt RT space */
	345	};
	346
	347	/* Field specifiers for ->set_dqblk() in struct qc_dqblk */
	348	#define QC_INO_SOFT (1<<0)
	349	#define QC_INO_HARD (1<<1)
	350	#define QC_SPC_SOFT (1<<2)
	351	#define QC_SPC_HARD (1<<3)
	352	#define QC_RT_SPC_SOFT (1<<4)
	353	#define QC_RT_SPC_HARD (1<<5)
	354	#define QC_LIMIT_MASK (QC_INO_SOFT \| QC_INO_HARD \| QC_SPC_SOFT \| QC_SPC_HARD \| \
	355	QC_RT_SPC_SOFT \| QC_RT_SPC_HARD)
	356	#define QC_SPC_TIMER (1<<6)
	357	#define QC_INO_TIMER (1<<7)
	358	#define QC_RT_SPC_TIMER (1<<8)
	359	#define QC_TIMER_MASK (QC_SPC_TIMER \| QC_INO_TIMER \| QC_RT_SPC_TIMER)
	360	#define QC_SPC_WARNS (1<<9)
	361	#define QC_INO_WARNS (1<<10)
	362	#define QC_RT_SPC_WARNS (1<<11)
	363	#define QC_WARNS_MASK (QC_SPC_WARNS \| QC_INO_WARNS \| QC_RT_SPC_WARNS)
	364	#define QC_SPACE (1<<12)
	365	#define QC_INO_COUNT (1<<13)
	366	#define QC_RT_SPACE (1<<14)
	367	#define QC_ACCT_MASK (QC_SPACE \| QC_INO_COUNT \| QC_RT_SPACE)
	368
1da177e4 LT	369	/* Operations handling requests from userspace */
1da177e4 LT	370	struct quotactl_ops {
f00c9e44	371	int (quota_on)(struct super_block , int, int, struct path *);
307ae18a	372	int (quota_off)(struct super_block , int);
38e478c4 JK	373	int (quota_enable)(struct super_block , unsigned int);
38e478c4 JK	374	int (quota_disable)(struct super_block , unsigned int);
ceed1723	375	int (quota_sync)(struct super_block , int);
1da177e4 LT	376	int (get_info)(struct super_block , int, struct if_dqinfo *);
1da177e4 LT	377	int (set_info)(struct super_block , int, struct if_dqinfo *);
14bf61ff JK	378	int (get_dqblk)(struct super_block , struct kqid, struct qc_dqblk *);
14bf61ff JK	379	int (set_dqblk)(struct super_block , struct kqid, struct qc_dqblk *);
1da177e4	380	int (get_xstate)(struct super_block , struct fs_quota_stat *);
af30cb44	381	int (get_xstatev)(struct super_block , struct fs_quota_statv *);
9da93f9b	382	int (rm_xquota)(struct super_block , unsigned int);
1da177e4 LT	383	};
	384
	385	struct quota_format_type {
	386	int qf_fmt_id; /* Quota format id */
1472da5f	387	const struct quota_format_ops qf_ops; / Operations of format */
1da177e4 LT	388	struct module qf_owner; / Module implementing quota format */
	389	struct quota_format_type *qf_next;
	390	};
	391
f55abc0f JK	392	/* Quota state flags - they actually come in two flavors - for users and groups */
	393	enum {
	394	_DQUOT_USAGE_ENABLED = 0, /* Track disk usage for users */
	395	_DQUOT_LIMITS_ENABLED, /* Enforce quota limits for users */
	396	_DQUOT_SUSPENDED, /* User diskquotas are off, but
0ff5af83 JK	397	* we have necessary info in
0ff5af83 JK	398	* memory to turn them on */
f55abc0f JK	399	_DQUOT_STATE_FLAGS
	400	};
	401	#define DQUOT_USAGE_ENABLED (1 << _DQUOT_USAGE_ENABLED)
	402	#define DQUOT_LIMITS_ENABLED (1 << _DQUOT_LIMITS_ENABLED)
	403	#define DQUOT_SUSPENDED (1 << _DQUOT_SUSPENDED)
	404	#define DQUOT_STATE_FLAGS (DQUOT_USAGE_ENABLED \| DQUOT_LIMITS_ENABLED \| \
	405	DQUOT_SUSPENDED)
ca785ec6	406	/* Other quota flags */
ad1e6e8d DM	407	#define DQUOT_STATE_LAST (_DQUOT_STATE_FLAGS * MAXQUOTAS)
	408	#define DQUOT_QUOTA_SYS_FILE (1 << DQUOT_STATE_LAST)
	409	/* Quota file is a special
ca785ec6 JK	410	* system file and user cannot
	411	* touch it. Filesystem is
	412	* responsible for setting
	413	* S_NOQUOTA, S_NOATIME flags
	414	*/
ad1e6e8d DM	415	#define DQUOT_NEGATIVE_USAGE (1 << (DQUOT_STATE_LAST + 1))
ad1e6e8d DM	416	/* Allow negative quota usage */
f55abc0f JK	417
	418	static inline unsigned int dquot_state_flag(unsigned int flags, int type)
	419	{
ad1e6e8d	420	return flags << _DQUOT_STATE_FLAGS * type;
f55abc0f JK	421	}
	422
	423	static inline unsigned int dquot_generic_flag(unsigned int flags, int type)
	424	{
ad1e6e8d	425	return (flags >> _DQUOT_STATE_FLAGS * type) & DQUOT_STATE_FLAGS;
f55abc0f	426	}
1da177e4	427
86e931a3	428	#ifdef CONFIG_QUOTA_NETLINK_INTERFACE
431f1974	429	extern void quota_send_warning(struct kqid qid, dev_t dev,
86e931a3 SW	430	const char warntype);
86e931a3 SW	431	#else
431f1974	432	static inline void quota_send_warning(struct kqid qid, dev_t dev,
86e931a3 SW	433	const char warntype)
	434	{
	435	return;
	436	}
	437	#endif /* CONFIG_QUOTA_NETLINK_INTERFACE */
	438
1da177e4 LT	439	struct quota_info {
1da177e4 LT	440	unsigned int flags; /* Flags for diskquotas on this device */
d3be915f IM	441	struct mutex dqio_mutex; /* lock device while I/O in progress */
d3be915f IM	442	struct mutex dqonoff_mutex; /* Serialize quotaon & quotaoff */
1da177e4	443	struct inode files[MAXQUOTAS]; / inodes of quotafiles */
1da177e4	444	struct mem_dqinfo info[MAXQUOTAS]; /* Information for each quota type */
1472da5f	445	const struct quota_format_ops ops[MAXQUOTAS]; / Operations for each type */
1da177e4 LT	446	};
1da177e4 LT	447
1da177e4 LT	448	int register_quota_format(struct quota_format_type *fmt);
	449	void unregister_quota_format(struct quota_format_type *fmt);
	450
	451	struct quota_module_name {
	452	int qm_fmt_id;
	453	char *qm_mod_name;
	454	};
	455
	456	#define INIT_QUOTA_MODULE_NAMES {\
	457	{QFMT_VFS_OLD, "quota_v1"},\
	458	{QFMT_VFS_V0, "quota_v2"},\
c3ad83d9	459	{QFMT_VFS_V1, "quota_v2"},\
1da177e4 LT	460	{0, NULL}}
1da177e4 LT	461
1da177e4	462	#endif /* _QUOTA_ */