[linux-2.6-block.git] / fs / xfs / xfs_qm.h

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 */
#ifndef __XFS_QM_H__
#define __XFS_QM_H__

#include "xfs_dquot_item.h"
#include "xfs_dquot.h"

struct xfs_inode;

extern struct kmem_cache	*xfs_dqtrx_cache;

/*
 * Number of bmaps that we ask from bmapi when doing a quotacheck.
 * We make this restriction to keep the memory usage to a minimum.
 */
#define XFS_DQITER_MAP_SIZE	10

#define XFS_IS_DQUOT_UNINITIALIZED(dqp) ( \
	!dqp->q_blk.hardlimit && \
	!dqp->q_blk.softlimit && \
	!dqp->q_rtb.hardlimit && \
	!dqp->q_rtb.softlimit && \
	!dqp->q_ino.hardlimit && \
	!dqp->q_ino.softlimit && \
	!dqp->q_blk.count && \
	!dqp->q_rtb.count && \
	!dqp->q_ino.count)

struct xfs_quota_limits {
	xfs_qcnt_t		hard;	/* default hard limit */
	xfs_qcnt_t		soft;	/* default soft limit */
	time64_t		time;	/* limit for timers */
};

/* Defaults for each quota type: time limits, warn limits, usage limits */
struct xfs_def_quota {
	struct xfs_quota_limits	blk;
	struct xfs_quota_limits	ino;
	struct xfs_quota_limits	rtb;
};

/*
 * Various quota information for individual filesystems.
 * The mount structure keeps a pointer to this.
 */
struct xfs_quotainfo {
	struct radix_tree_root	qi_uquota_tree;
	struct radix_tree_root	qi_gquota_tree;
	struct radix_tree_root	qi_pquota_tree;
	struct mutex		qi_tree_lock;
	struct xfs_inode	*qi_uquotaip;	/* user quota inode */
	struct xfs_inode	*qi_gquotaip;	/* group quota inode */
	struct xfs_inode	*qi_pquotaip;	/* project quota inode */
	struct list_lru		qi_lru;
	int			qi_dquots;
	struct mutex		qi_quotaofflock;/* to serialize quotaoff */
	xfs_filblks_t		qi_dqchunklen;	/* # BBs in a chunk of dqs */
	uint			qi_dqperchunk;	/* # ondisk dq in above chunk */
	struct xfs_def_quota	qi_usr_default;
	struct xfs_def_quota	qi_grp_default;
	struct xfs_def_quota	qi_prj_default;
	struct shrinker		*qi_shrinker;

	/* Minimum and maximum quota expiration timestamp values. */
	time64_t		qi_expiry_min;
	time64_t		qi_expiry_max;

	/* Hook to feed quota counter updates to an active online repair. */
	struct xfs_hooks	qi_mod_ino_dqtrx_hooks;
	struct xfs_hooks	qi_apply_dqtrx_hooks;
};

static inline struct radix_tree_root *
xfs_dquot_tree(
	struct xfs_quotainfo	*qi,
	xfs_dqtype_t		type)
{
	switch (type) {
	case XFS_DQTYPE_USER:
		return &qi->qi_uquota_tree;
	case XFS_DQTYPE_GROUP:
		return &qi->qi_gquota_tree;
	case XFS_DQTYPE_PROJ:
		return &qi->qi_pquota_tree;
	default:
		ASSERT(0);
	}
	return NULL;
}

static inline struct xfs_inode *
xfs_quota_inode(struct xfs_mount *mp, xfs_dqtype_t type)
{
	switch (type) {
	case XFS_DQTYPE_USER:
		return mp->m_quotainfo->qi_uquotaip;
	case XFS_DQTYPE_GROUP:
		return mp->m_quotainfo->qi_gquotaip;
	case XFS_DQTYPE_PROJ:
		return mp->m_quotainfo->qi_pquotaip;
	default:
		ASSERT(0);
	}
	return NULL;
}

/*
 * Parameters for tracking dqtrx changes on behalf of an inode.  The hook
 * function arg parameter is the field being updated.
 */
struct xfs_mod_ino_dqtrx_params {
	uintptr_t		tx_id;
	xfs_ino_t		ino;
	xfs_dqtype_t		q_type;
	xfs_dqid_t		q_id;
	int64_t			delta;
};

extern void	xfs_trans_mod_dquot(struct xfs_trans *tp, struct xfs_dquot *dqp,
				    uint field, int64_t delta);
extern void	xfs_trans_dqjoin(struct xfs_trans *, struct xfs_dquot *);
extern void	xfs_trans_log_dquot(struct xfs_trans *, struct xfs_dquot *);

/*
 * We keep the usr, grp, and prj dquots separately so that locking will be
 * easier to do at commit time. All transactions that we know of at this point
 * affect no more than two dquots of one type. Hence, the TRANS_MAXDQS value.
 */
enum {
	XFS_QM_TRANS_USR = 0,
	XFS_QM_TRANS_GRP,
	XFS_QM_TRANS_PRJ,
	XFS_QM_TRANS_DQTYPES
};
#define XFS_QM_TRANS_MAXDQS		5
struct xfs_dquot_acct {
	struct xfs_dqtrx	dqs[XFS_QM_TRANS_DQTYPES][XFS_QM_TRANS_MAXDQS];
};

/*
 * Users are allowed to have a usage exceeding their softlimit for
 * a period this long.
 */
#define XFS_QM_BTIMELIMIT	(7 * 24*60*60)          /* 1 week */
#define XFS_QM_RTBTIMELIMIT	(7 * 24*60*60)          /* 1 week */
#define XFS_QM_ITIMELIMIT	(7 * 24*60*60)          /* 1 week */

extern void		xfs_qm_destroy_quotainfo(struct xfs_mount *);

/* quota ops */
extern int		xfs_qm_scall_trunc_qfiles(struct xfs_mount *, uint);
extern int		xfs_qm_scall_getquota(struct xfs_mount *mp,
					xfs_dqid_t id,
					xfs_dqtype_t type,
					struct qc_dqblk *dst);
extern int		xfs_qm_scall_getquota_next(struct xfs_mount *mp,
					xfs_dqid_t *id,
					xfs_dqtype_t type,
					struct qc_dqblk *dst);
extern int		xfs_qm_scall_setqlim(struct xfs_mount *mp,
					xfs_dqid_t id,
					xfs_dqtype_t type,
					struct qc_dqblk *newlim);
extern int		xfs_qm_scall_quotaon(struct xfs_mount *, uint);
extern int		xfs_qm_scall_quotaoff(struct xfs_mount *, uint);

static inline struct xfs_def_quota *
xfs_get_defquota(struct xfs_quotainfo *qi, xfs_dqtype_t type)
{
	switch (type) {
	case XFS_DQTYPE_USER:
		return &qi->qi_usr_default;
	case XFS_DQTYPE_GROUP:
		return &qi->qi_grp_default;
	case XFS_DQTYPE_PROJ:
		return &qi->qi_prj_default;
	default:
		ASSERT(0);
		return NULL;
	}
}

#endif /* __XFS_QM_H__ */
Commit	Line	Data
0b61f8a4	1	// SPDX-License-Identifier: GPL-2.0
1da177e4	2	/*
4ce3121f NS	3	* Copyright (c) 2000-2005 Silicon Graphics, Inc.
4ce3121f NS	4	* All Rights Reserved.
1da177e4 LT	5	*/
	6	#ifndef __XFS_QM_H__
	7	#define __XFS_QM_H__
	8
	9	#include "xfs_dquot_item.h"
	10	#include "xfs_dquot.h"
1da177e4	11
1da177e4 LT	12	struct xfs_inode;
1da177e4 LT	13
182696fb	14	extern struct kmem_cache *xfs_dqtrx_cache;
1da177e4	15
afbd123d JL	16	/*
	17	* Number of bmaps that we ask from bmapi when doing a quotacheck.
	18	* We make this restriction to keep the memory usage to a minimum.
	19	*/
	20	#define XFS_DQITER_MAP_SIZE 10
	21
	22	#define XFS_IS_DQUOT_UNINITIALIZED(dqp) ( \
d3537cf9 DW	23	!dqp->q_blk.hardlimit && \
	24	!dqp->q_blk.softlimit && \
	25	!dqp->q_rtb.hardlimit && \
	26	!dqp->q_rtb.softlimit && \
	27	!dqp->q_ino.hardlimit && \
	28	!dqp->q_ino.softlimit && \
be37d40c DW	29	!dqp->q_blk.count && \
	30	!dqp->q_rtb.count && \
	31	!dqp->q_ino.count)
afbd123d	32
438769e3 DW	33	struct xfs_quota_limits {
	34	xfs_qcnt_t hard; /* default hard limit */
	35	xfs_qcnt_t soft; /* default soft limit */
	36	time64_t time; /* limit for timers */
438769e3 DW	37	};
438769e3 DW	38
e850301f	39	/* Defaults for each quota type: time limits, warn limits, usage limits */
be607946	40	struct xfs_def_quota {
438769e3 DW	41	struct xfs_quota_limits blk;
	42	struct xfs_quota_limits ino;
	43	struct xfs_quota_limits rtb;
be607946 CM	44	};
be607946 CM	45
1da177e4 LT	46	/*
	47	* Various quota information for individual filesystems.
	48	* The mount structure keeps a pointer to this.
	49	*/
c072fbef	50	struct xfs_quotainfo {
8d077f5b ES	51	struct radix_tree_root qi_uquota_tree;
	52	struct radix_tree_root qi_gquota_tree;
	53	struct radix_tree_root qi_pquota_tree;
	54	struct mutex qi_tree_lock;
92f8ff73 CS	55	struct xfs_inode qi_uquotaip; / user quota inode */
	56	struct xfs_inode qi_gquotaip; / group quota inode */
	57	struct xfs_inode qi_pquotaip; / project quota inode */
8d077f5b ES	58	struct list_lru qi_lru;
8d077f5b ES	59	int qi_dquots;
8d077f5b ES	60	struct mutex qi_quotaofflock;/* to serialize quotaoff */
	61	xfs_filblks_t qi_dqchunklen; /* # BBs in a chunk of dqs */
	62	uint qi_dqperchunk; /* # ondisk dq in above chunk */
be607946 CM	63	struct xfs_def_quota qi_usr_default;
	64	struct xfs_def_quota qi_grp_default;
	65	struct xfs_def_quota qi_prj_default;
fe885278	66	struct shrinker *qi_shrinker;
11d8a919 DW	67
	68	/* Minimum and maximum quota expiration timestamp values. */
	69	time64_t qi_expiry_min;
	70	time64_t qi_expiry_max;
20049187 DW	71
	72	/* Hook to feed quota counter updates to an active online repair. */
	73	struct xfs_hooks qi_mod_ino_dqtrx_hooks;
	74	struct xfs_hooks qi_apply_dqtrx_hooks;
c072fbef	75	};
1da177e4	76
329e0875 CS	77	static inline struct radix_tree_root *
	78	xfs_dquot_tree(
	79	struct xfs_quotainfo *qi,
1a7ed271	80	xfs_dqtype_t type)
329e0875 CS	81	{
329e0875 CS	82	switch (type) {
8cd4901d	83	case XFS_DQTYPE_USER:
329e0875	84	return &qi->qi_uquota_tree;
8cd4901d	85	case XFS_DQTYPE_GROUP:
329e0875	86	return &qi->qi_gquota_tree;
8cd4901d	87	case XFS_DQTYPE_PROJ:
92f8ff73	88	return &qi->qi_pquota_tree;
329e0875 CS	89	default:
	90	ASSERT(0);
	91	}
	92	return NULL;
	93	}
995961c4 CS	94
995961c4 CS	95	static inline struct xfs_inode *
1a7ed271	96	xfs_quota_inode(struct xfs_mount *mp, xfs_dqtype_t type)
995961c4	97	{
1a7ed271	98	switch (type) {
8cd4901d	99	case XFS_DQTYPE_USER:
4d4d9523	100	return mp->m_quotainfo->qi_uquotaip;
8cd4901d	101	case XFS_DQTYPE_GROUP:
4d4d9523	102	return mp->m_quotainfo->qi_gquotaip;
8cd4901d	103	case XFS_DQTYPE_PROJ:
4d4d9523	104	return mp->m_quotainfo->qi_pquotaip;
995961c4 CS	105	default:
	106	ASSERT(0);
	107	}
	108	return NULL;
	109	}
	110
20049187 DW	111	/*
	112	* Parameters for tracking dqtrx changes on behalf of an inode. The hook
	113	* function arg parameter is the field being updated.
	114	*/
	115	struct xfs_mod_ino_dqtrx_params {
	116	uintptr_t tx_id;
	117	xfs_ino_t ino;
	118	xfs_dqtype_t q_type;
	119	xfs_dqid_t q_id;
	120	int64_t delta;
	121	};
	122
903b1fc2 DW	123	extern void xfs_trans_mod_dquot(struct xfs_trans tp, struct xfs_dquot dqp,
903b1fc2 DW	124	uint field, int64_t delta);
113a5683 CS	125	extern void xfs_trans_dqjoin(struct xfs_trans , struct xfs_dquot );
113a5683 CS	126	extern void xfs_trans_log_dquot(struct xfs_trans , struct xfs_dquot );
1da177e4 LT	127
1da177e4 LT	128	/*
92f8ff73 CS	129	* We keep the usr, grp, and prj dquots separately so that locking will be
92f8ff73 CS	130	* easier to do at commit time. All transactions that we know of at this point
1da177e4 LT	131	* affect no more than two dquots of one type. Hence, the TRANS_MAXDQS value.
1da177e4 LT	132	*/
0e6436d9 CS	133	enum {
	134	XFS_QM_TRANS_USR = 0,
	135	XFS_QM_TRANS_GRP,
92f8ff73	136	XFS_QM_TRANS_PRJ,
0e6436d9 CS	137	XFS_QM_TRANS_DQTYPES
0e6436d9 CS	138	};
f103df76	139	#define XFS_QM_TRANS_MAXDQS 5
0e6436d9 CS	140	struct xfs_dquot_acct {
	141	struct xfs_dqtrx dqs[XFS_QM_TRANS_DQTYPES][XFS_QM_TRANS_MAXDQS];
	142	};
1da177e4 LT	143
	144	/*
	145	* Users are allowed to have a usage exceeding their softlimit for
	146	* a period this long.
	147	*/
	148	#define XFS_QM_BTIMELIMIT (7 * 246060) /* 1 week */
	149	#define XFS_QM_RTBTIMELIMIT (7 * 246060) /* 1 week */
	150	#define XFS_QM_ITIMELIMIT (7 * 246060) /* 1 week */
	151
113a5683	152	extern void xfs_qm_destroy_quotainfo(struct xfs_mount *);
1da177e4	153
fcafb71b	154	/* quota ops */
113a5683	155	extern int xfs_qm_scall_trunc_qfiles(struct xfs_mount *, uint);
1a7ed271 DW	156	extern int xfs_qm_scall_getquota(struct xfs_mount *mp,
	157	xfs_dqid_t id,
	158	xfs_dqtype_t type,
	159	struct qc_dqblk *dst);
	160	extern int xfs_qm_scall_getquota_next(struct xfs_mount *mp,
	161	xfs_dqid_t *id,
	162	xfs_dqtype_t type,
	163	struct qc_dqblk *dst);
	164	extern int xfs_qm_scall_setqlim(struct xfs_mount *mp,
	165	xfs_dqid_t id,
	166	xfs_dqtype_t type,
	167	struct qc_dqblk *newlim);
113a5683 CS	168	extern int xfs_qm_scall_quotaon(struct xfs_mount *, uint);
113a5683 CS	169	extern int xfs_qm_scall_quotaoff(struct xfs_mount *, uint);
fcafb71b	170
be607946	171	static inline struct xfs_def_quota *
1a7ed271	172	xfs_get_defquota(struct xfs_quotainfo *qi, xfs_dqtype_t type)
be607946	173	{
ce6e7e79	174	switch (type) {
8cd4901d	175	case XFS_DQTYPE_USER:
ce6e7e79	176	return &qi->qi_usr_default;
8cd4901d	177	case XFS_DQTYPE_GROUP:
ce6e7e79	178	return &qi->qi_grp_default;
8cd4901d	179	case XFS_DQTYPE_PROJ:
ce6e7e79 ES	180	return &qi->qi_prj_default;
	181	default:
	182	ASSERT(0);
	183	return NULL;
be607946	184	}
be607946 CM	185	}
be607946 CM	186
1da177e4	187	#endif /* __XFS_QM_H__ */