[mirror_ubuntu-bionic-kernel.git] / fs / xfs / xfs_qm.h

/*
 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it would be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef __XFS_QM_H__
#define __XFS_QM_H__

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

struct xfs_inode;

extern struct kmem_zone	*xfs_qm_dqtrxzone;

/*
 * This defines the unit of allocation of dquots.
 * Currently, it is just one file system block, and a 4K blk contains 30
 * (136 * 30 = 4080) dquots. It's probably not worth trying to make
 * this more dynamic.
 * XXXsup However, if this number is changed, we have to make sure that we don't
 * implicitly assume that we do allocations in chunks of a single filesystem
 * block in the dquot/xqm code.
 */
#define XFS_DQUOT_CLUSTER_SIZE_FSB	(xfs_filblks_t)1

/*
 * Various quota information for individual filesystems.
 * The mount structure keeps a pointer to this.
 */
typedef 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;
	time_t		 qi_btimelimit;	 /* limit for blks timer */
	time_t		 qi_itimelimit;	 /* limit for inodes timer */
	time_t		 qi_rtbtimelimit;/* limit for rt blks timer */
	xfs_qwarncnt_t	 qi_bwarnlimit;	 /* limit for blks warnings */
	xfs_qwarncnt_t	 qi_iwarnlimit;	 /* limit for inodes warnings */
	xfs_qwarncnt_t	 qi_rtbwarnlimit;/* limit for rt blks warnings */
	struct mutex	 qi_quotaofflock;/* to serialize quotaoff */
	xfs_filblks_t	 qi_dqchunklen;	 /* # BBs in a chunk of dqs */
	uint		 qi_dqperchunk;	 /* # ondisk dqs in above chunk */
	xfs_qcnt_t	 qi_bhardlimit;	 /* default data blk hard limit */
	xfs_qcnt_t	 qi_bsoftlimit;	 /* default data blk soft limit */
	xfs_qcnt_t	 qi_ihardlimit;	 /* default inode count hard limit */
	xfs_qcnt_t	 qi_isoftlimit;	 /* default inode count soft limit */
	xfs_qcnt_t	 qi_rtbhardlimit;/* default realtime blk hard limit */
	xfs_qcnt_t	 qi_rtbsoftlimit;/* default realtime blk soft limit */
	struct shrinker  qi_shrinker;
} xfs_quotainfo_t;

static inline struct radix_tree_root *
xfs_dquot_tree(
	struct xfs_quotainfo	*qi,
	int			type)
{
	switch (type) {
	case XFS_DQ_USER:
		return &qi->qi_uquota_tree;
	case XFS_DQ_GROUP:
		return &qi->qi_gquota_tree;
	case XFS_DQ_PROJ:
		return &qi->qi_pquota_tree;
	default:
		ASSERT(0);
	}
	return NULL;
}

static inline struct xfs_inode *
xfs_dq_to_quota_inode(struct xfs_dquot *dqp)
{
	switch (dqp->dq_flags & XFS_DQ_ALLTYPES) {
	case XFS_DQ_USER:
		return dqp->q_mount->m_quotainfo->qi_uquotaip;
	case XFS_DQ_GROUP:
		return dqp->q_mount->m_quotainfo->qi_gquotaip;
	case XFS_DQ_PROJ:
		return dqp->q_mount->m_quotainfo->qi_pquotaip;
	default:
		ASSERT(0);
	}
	return NULL;
}

extern int	xfs_qm_calc_dquots_per_chunk(struct xfs_mount *mp,
					     unsigned int nbblks);
extern void	xfs_trans_mod_dquot(struct xfs_trans *,
					struct xfs_dquot *, uint, long);
extern int	xfs_trans_reserve_quota_bydquots(struct xfs_trans *,
			struct xfs_mount *, struct xfs_dquot *,
			struct xfs_dquot *, struct xfs_dquot *,
			long, long, uint);
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		2
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 */

#define XFS_QM_BWARNLIMIT	5
#define XFS_QM_IWARNLIMIT	5
#define XFS_QM_RTBWARNLIMIT	5

extern void		xfs_qm_destroy_quotainfo(struct xfs_mount *);
extern int		xfs_qm_quotacheck(struct xfs_mount *);
extern int		xfs_qm_write_sb_changes(struct xfs_mount *, __int64_t);

/* dquot stuff */
extern void		xfs_qm_dqpurge_all(struct xfs_mount *, uint);
extern void		xfs_qm_dqrele_all_inodes(struct xfs_mount *, uint);

/* quota ops */
extern int		xfs_qm_scall_trunc_qfiles(struct xfs_mount *, uint);
extern int		xfs_qm_scall_getquota(struct xfs_mount *, xfs_dqid_t,
					uint, struct fs_disk_quota *);
extern int		xfs_qm_scall_setqlim(struct xfs_mount *, xfs_dqid_t, uint,
					struct fs_disk_quota *);
extern int		xfs_qm_scall_getqstat(struct xfs_mount *,
					struct fs_quota_stat *);
extern int		xfs_qm_scall_getqstatv(struct xfs_mount *,
					struct fs_quota_statv *);
extern int		xfs_qm_scall_quotaon(struct xfs_mount *, uint);
extern int		xfs_qm_scall_quotaoff(struct xfs_mount *, uint);

#endif /* __XFS_QM_H__ */
Commit	Line	Data
1da177e4	1	/*
4ce3121f NS	2	* Copyright (c) 2000-2005 Silicon Graphics, Inc.
4ce3121f NS	3	* All Rights Reserved.
1da177e4	4	*
4ce3121f NS	5	* This program is free software; you can redistribute it and/or
4ce3121f NS	6	* modify it under the terms of the GNU General Public License as
1da177e4 LT	7	* published by the Free Software Foundation.
1da177e4 LT	8	*
4ce3121f NS	9	* This program is distributed in the hope that it would be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
1da177e4	13	*
4ce3121f NS	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write the Free Software Foundation,
	16	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
1da177e4 LT	17	*/
	18	#ifndef __XFS_QM_H__
	19	#define __XFS_QM_H__
	20
	21	#include "xfs_dquot_item.h"
	22	#include "xfs_dquot.h"
	23	#include "xfs_quota_priv.h"
1da177e4	24
1da177e4 LT	25	struct xfs_inode;
1da177e4 LT	26
a05931ce	27	extern struct kmem_zone *xfs_qm_dqtrxzone;
1da177e4	28
1da177e4 LT	29	/*
	30	* This defines the unit of allocation of dquots.
	31	* Currently, it is just one file system block, and a 4K blk contains 30
	32	* (136 * 30 = 4080) dquots. It's probably not worth trying to make
	33	* this more dynamic.
	34	* XXXsup However, if this number is changed, we have to make sure that we don't
	35	* implicitly assume that we do allocations in chunks of a single filesystem
	36	* block in the dquot/xqm code.
	37	*/
	38	#define XFS_DQUOT_CLUSTER_SIZE_FSB (xfs_filblks_t)1
1da177e4	39
1da177e4 LT	40	/*
	41	* Various quota information for individual filesystems.
	42	* The mount structure keeps a pointer to this.
	43	*/
	44	typedef struct xfs_quotainfo {
9f920f11 CH	45	struct radix_tree_root qi_uquota_tree;
9f920f11 CH	46	struct radix_tree_root qi_gquota_tree;
92f8ff73	47	struct radix_tree_root qi_pquota_tree;
9f920f11	48	struct mutex qi_tree_lock;
92f8ff73 CS	49	struct xfs_inode qi_uquotaip; / user quota inode */
	50	struct xfs_inode qi_gquotaip; / group quota inode */
	51	struct xfs_inode qi_pquotaip; / project quota inode */
cd56a39a	52	struct list_lru qi_lru;
3a25404b	53	int qi_dquots;
1da177e4 LT	54	time_t qi_btimelimit; /* limit for blks timer */
	55	time_t qi_itimelimit; /* limit for inodes timer */
	56	time_t qi_rtbtimelimit;/* limit for rt blks timer */
06d10dd9 NS	57	xfs_qwarncnt_t qi_bwarnlimit; /* limit for blks warnings */
	58	xfs_qwarncnt_t qi_iwarnlimit; /* limit for inodes warnings */
	59	xfs_qwarncnt_t qi_rtbwarnlimit;/* limit for rt blks warnings */
a0b0b8a5	60	struct mutex qi_quotaofflock;/* to serialize quotaoff */
1da177e4 LT	61	xfs_filblks_t qi_dqchunklen; /* # BBs in a chunk of dqs */
	62	uint qi_dqperchunk; /* # ondisk dqs in above chunk */
	63	xfs_qcnt_t qi_bhardlimit; /* default data blk hard limit */
	64	xfs_qcnt_t qi_bsoftlimit; /* default data blk soft limit */
	65	xfs_qcnt_t qi_ihardlimit; /* default inode count hard limit */
	66	xfs_qcnt_t qi_isoftlimit; /* default inode count soft limit */
	67	xfs_qcnt_t qi_rtbhardlimit;/* default realtime blk hard limit */
	68	xfs_qcnt_t qi_rtbsoftlimit;/* default realtime blk soft limit */
f8739c3c	69	struct shrinker qi_shrinker;
1da177e4 LT	70	} xfs_quotainfo_t;
1da177e4 LT	71
329e0875 CS	72	static inline struct radix_tree_root *
	73	xfs_dquot_tree(
	74	struct xfs_quotainfo *qi,
	75	int type)
	76	{
	77	switch (type) {
	78	case XFS_DQ_USER:
	79	return &qi->qi_uquota_tree;
	80	case XFS_DQ_GROUP:
329e0875	81	return &qi->qi_gquota_tree;
92f8ff73 CS	82	case XFS_DQ_PROJ:
92f8ff73 CS	83	return &qi->qi_pquota_tree;
329e0875 CS	84	default:
	85	ASSERT(0);
	86	}
	87	return NULL;
	88	}
995961c4 CS	89
	90	static inline struct xfs_inode *
	91	xfs_dq_to_quota_inode(struct xfs_dquot *dqp)
	92	{
	93	switch (dqp->dq_flags & XFS_DQ_ALLTYPES) {
	94	case XFS_DQ_USER:
	95	return dqp->q_mount->m_quotainfo->qi_uquotaip;
	96	case XFS_DQ_GROUP:
995961c4	97	return dqp->q_mount->m_quotainfo->qi_gquotaip;
92f8ff73 CS	98	case XFS_DQ_PROJ:
92f8ff73 CS	99	return dqp->q_mount->m_quotainfo->qi_pquotaip;
995961c4 CS	100	default:
	101	ASSERT(0);
	102	}
	103	return NULL;
	104	}
	105
3fe58f30 CH	106	extern int xfs_qm_calc_dquots_per_chunk(struct xfs_mount *mp,
3fe58f30 CH	107	unsigned int nbblks);
113a5683 CS	108	extern void xfs_trans_mod_dquot(struct xfs_trans *,
	109	struct xfs_dquot *, uint, long);
	110	extern int xfs_trans_reserve_quota_bydquots(struct xfs_trans *,
	111	struct xfs_mount , struct xfs_dquot ,
92f8ff73 CS	112	struct xfs_dquot , struct xfs_dquot ,
92f8ff73 CS	113	long, long, uint);
113a5683 CS	114	extern void xfs_trans_dqjoin(struct xfs_trans , struct xfs_dquot );
113a5683 CS	115	extern void xfs_trans_log_dquot(struct xfs_trans , struct xfs_dquot );
1da177e4 LT	116
1da177e4 LT	117	/*
92f8ff73 CS	118	* We keep the usr, grp, and prj dquots separately so that locking will be
92f8ff73 CS	119	* easier to do at commit time. All transactions that we know of at this point
1da177e4 LT	120	* affect no more than two dquots of one type. Hence, the TRANS_MAXDQS value.
1da177e4 LT	121	*/
0e6436d9 CS	122	enum {
	123	XFS_QM_TRANS_USR = 0,
	124	XFS_QM_TRANS_GRP,
92f8ff73	125	XFS_QM_TRANS_PRJ,
0e6436d9 CS	126	XFS_QM_TRANS_DQTYPES
0e6436d9 CS	127	};
1da177e4	128	#define XFS_QM_TRANS_MAXDQS 2
0e6436d9 CS	129	struct xfs_dquot_acct {
	130	struct xfs_dqtrx dqs[XFS_QM_TRANS_DQTYPES][XFS_QM_TRANS_MAXDQS];
	131	};
1da177e4 LT	132
	133	/*
	134	* Users are allowed to have a usage exceeding their softlimit for
	135	* a period this long.
	136	*/
	137	#define XFS_QM_BTIMELIMIT (7 * 246060) /* 1 week */
	138	#define XFS_QM_RTBTIMELIMIT (7 * 246060) /* 1 week */
	139	#define XFS_QM_ITIMELIMIT (7 * 246060) /* 1 week */
	140
	141	#define XFS_QM_BWARNLIMIT 5
	142	#define XFS_QM_IWARNLIMIT 5
06d10dd9	143	#define XFS_QM_RTBWARNLIMIT 5
1da177e4	144
113a5683 CS	145	extern void xfs_qm_destroy_quotainfo(struct xfs_mount *);
	146	extern int xfs_qm_quotacheck(struct xfs_mount *);
	147	extern int xfs_qm_write_sb_changes(struct xfs_mount *, __int64_t);
1da177e4 LT	148
1da177e4 LT	149	/* dquot stuff */
113a5683 CS	150	extern void xfs_qm_dqpurge_all(struct xfs_mount *, uint);
113a5683 CS	151	extern void xfs_qm_dqrele_all_inodes(struct xfs_mount *, uint);
1da177e4	152
fcafb71b	153	/* quota ops */
113a5683 CS	154	extern int xfs_qm_scall_trunc_qfiles(struct xfs_mount *, uint);
	155	extern int xfs_qm_scall_getquota(struct xfs_mount *, xfs_dqid_t,
	156	uint, struct fs_disk_quota *);
b1366451	157	extern int xfs_qm_scall_setqlim(struct xfs_mount *, xfs_dqid_t, uint,
113a5683 CS	158	struct fs_disk_quota *);
	159	extern int xfs_qm_scall_getqstat(struct xfs_mount *,
	160	struct fs_quota_stat *);
5d5e3d57 CS	161	extern int xfs_qm_scall_getqstatv(struct xfs_mount *,
5d5e3d57 CS	162	struct fs_quota_statv *);
113a5683 CS	163	extern int xfs_qm_scall_quotaon(struct xfs_mount *, uint);
113a5683 CS	164	extern int xfs_qm_scall_quotaoff(struct xfs_mount *, uint);
fcafb71b	165
1da177e4	166	#endif /* __XFS_QM_H__ */