[linux.git] / fs / xfs / quota / 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"
#include "xfs_qm_stats.h"

struct xfs_qm;
struct xfs_inode;

extern uint		ndquot;
extern struct mutex	xfs_Gqm_lock;
extern struct xfs_qm	*xfs_Gqm;
extern kmem_zone_t	*qm_dqzone;
extern kmem_zone_t	*qm_dqtrxzone;

/*
 * Used in xfs_qm_sync called by xfs_sync to count the max times that it can
 * iterate over the mountpt's dquot list in one call.
 */
#define XFS_QM_SYNC_MAX_RESTARTS	7

/*
 * Ditto, for xfs_qm_dqreclaim_one.
 */
#define XFS_QM_RECLAIM_MAX_RESTARTS	4

/*
 * Ideal ratio of free to in use dquots. Quota manager makes an attempt
 * to keep this balance.
 */
#define XFS_QM_DQFREE_RATIO		2

/*
 * Dquot hashtable constants/threshold values.
 */
#define XFS_QM_HASHSIZE_LOW		(PAGE_SIZE / sizeof(xfs_dqhash_t))
#define XFS_QM_HASHSIZE_HIGH		((PAGE_SIZE * 4) / sizeof(xfs_dqhash_t))

/*
 * 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
/*
 * When doing a quotacheck, we log dquot clusters of this many FSBs at most
 * in a single transaction. We don't want to ask for too huge a log reservation.
 */
#define XFS_QM_MAX_DQCLUSTER_LOGSZ	3

typedef xfs_dqhash_t	xfs_dqlist_t;

/*
 * Quota Manager (global) structure. Lives only in core.
 */
typedef struct xfs_qm {
	xfs_dqlist_t	*qm_usr_dqhtable;/* udquot hash table */
	xfs_dqlist_t	*qm_grp_dqhtable;/* gdquot hash table */
	uint		 qm_dqhashmask;	 /* # buckets in dq hashtab - 1 */
	struct list_head qm_dqfrlist;	 /* freelist of dquots */
	struct mutex	 qm_dqfrlist_lock;
	int		 qm_dqfrlist_cnt;
	atomic_t	 qm_totaldquots; /* total incore dquots */
	uint		 qm_nrefs;	 /* file systems with quota on */
	int		 qm_dqfree_ratio;/* ratio of free to inuse dquots */
	kmem_zone_t	*qm_dqzone;	 /* dquot mem-alloc zone */
	kmem_zone_t	*qm_dqtrxzone;	 /* t_dqinfo of transactions */
} xfs_qm_t;

/*
 * Various quota information for individual filesystems.
 * The mount structure keeps a pointer to this.
 */
typedef struct xfs_quotainfo {
	xfs_inode_t	*qi_uquotaip;	 /* user quota inode */
	xfs_inode_t	*qi_gquotaip;	 /* group quota inode */
	struct list_head qi_dqlist;	 /* all dquots in filesys */
	struct mutex	 qi_dqlist_lock;
	int		 qi_dquots;
	int		 qi_dqreclaims;	 /* a change here indicates
					    a removal in the dqlist */
	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 */
} xfs_quotainfo_t;


extern void	xfs_trans_mod_dquot(xfs_trans_t *, xfs_dquot_t *, uint, long);
extern int	xfs_trans_reserve_quota_bydquots(xfs_trans_t *, xfs_mount_t *,
			xfs_dquot_t *, xfs_dquot_t *, long, long, uint);
extern void	xfs_trans_dqjoin(xfs_trans_t *, xfs_dquot_t *);
extern void	xfs_trans_log_dquot(xfs_trans_t *, xfs_dquot_t *);

/*
 * We keep the usr and grp 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.
 */
#define XFS_QM_TRANS_MAXDQS		2
typedef struct xfs_dquot_acct {
	xfs_dqtrx_t	dqa_usrdquots[XFS_QM_TRANS_MAXDQS];
	xfs_dqtrx_t	dqa_grpdquots[XFS_QM_TRANS_MAXDQS];
} xfs_dquot_acct_t;

/*
 * 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(xfs_mount_t *);
extern int		xfs_qm_quotacheck(xfs_mount_t *);
extern int		xfs_qm_write_sb_changes(xfs_mount_t *, __int64_t);

/* dquot stuff */
extern boolean_t	xfs_qm_dqalloc_incore(xfs_dquot_t **);
extern int		xfs_qm_dqpurge_all(xfs_mount_t *, uint);
extern void		xfs_qm_dqrele_all_inodes(xfs_mount_t *, uint);

/* quota ops */
extern int		xfs_qm_scall_trunc_qfiles(xfs_mount_t *, uint);
extern int		xfs_qm_scall_getquota(xfs_mount_t *, xfs_dqid_t, uint,
					fs_disk_quota_t *);
extern int		xfs_qm_scall_setqlim(xfs_mount_t *, xfs_dqid_t, uint,
					fs_disk_quota_t *);
extern int		xfs_qm_scall_getqstat(xfs_mount_t *, fs_quota_stat_t *);
extern int		xfs_qm_scall_quotaon(xfs_mount_t *, uint);
extern int		xfs_qm_scall_quotaoff(xfs_mount_t *, uint);

#ifdef DEBUG
extern int		xfs_qm_internalqcheck(xfs_mount_t *);
#else
#define xfs_qm_internalqcheck(mp)	(0)
#endif

#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"
	24	#include "xfs_qm_stats.h"
	25
	26	struct xfs_qm;
	27	struct xfs_inode;
	28
6b3f6b5b	29	extern uint ndquot;
a0b0b8a5	30	extern struct mutex xfs_Gqm_lock;
1da177e4 LT	31	extern struct xfs_qm *xfs_Gqm;
	32	extern kmem_zone_t *qm_dqzone;
	33	extern kmem_zone_t *qm_dqtrxzone;
	34
	35	/*
	36	* Used in xfs_qm_sync called by xfs_sync to count the max times that it can
	37	* iterate over the mountpt's dquot list in one call.
	38	*/
	39	#define XFS_QM_SYNC_MAX_RESTARTS 7
	40
	41	/*
	42	* Ditto, for xfs_qm_dqreclaim_one.
	43	*/
	44	#define XFS_QM_RECLAIM_MAX_RESTARTS 4
	45
	46	/*
	47	* Ideal ratio of free to in use dquots. Quota manager makes an attempt
	48	* to keep this balance.
	49	*/
	50	#define XFS_QM_DQFREE_RATIO 2
	51
	52	/*
	53	* Dquot hashtable constants/threshold values.
	54	*/
e6a4b37f TS	55	#define XFS_QM_HASHSIZE_LOW (PAGE_SIZE / sizeof(xfs_dqhash_t))
e6a4b37f TS	56	#define XFS_QM_HASHSIZE_HIGH ((PAGE_SIZE * 4) / sizeof(xfs_dqhash_t))
1da177e4	57
1da177e4 LT	58	/*
	59	* This defines the unit of allocation of dquots.
	60	* Currently, it is just one file system block, and a 4K blk contains 30
	61	* (136 * 30 = 4080) dquots. It's probably not worth trying to make
	62	* this more dynamic.
	63	* XXXsup However, if this number is changed, we have to make sure that we don't
	64	* implicitly assume that we do allocations in chunks of a single filesystem
	65	* block in the dquot/xqm code.
	66	*/
	67	#define XFS_DQUOT_CLUSTER_SIZE_FSB (xfs_filblks_t)1
	68	/*
	69	* When doing a quotacheck, we log dquot clusters of this many FSBs at most
	70	* in a single transaction. We don't want to ask for too huge a log reservation.
	71	*/
	72	#define XFS_QM_MAX_DQCLUSTER_LOGSZ 3
	73
	74	typedef xfs_dqhash_t xfs_dqlist_t;
1da177e4 LT	75
	76	/*
	77	* Quota Manager (global) structure. Lives only in core.
	78	*/
	79	typedef struct xfs_qm {
	80	xfs_dqlist_t qm_usr_dqhtable;/ udquot hash table */
	81	xfs_dqlist_t qm_grp_dqhtable;/ gdquot hash table */
	82	uint qm_dqhashmask; /* # buckets in dq hashtab - 1 */
3a8406f6 DC	83	struct list_head qm_dqfrlist; /* freelist of dquots */
	84	struct mutex qm_dqfrlist_lock;
	85	int qm_dqfrlist_cnt;
1da177e4 LT	86	atomic_t qm_totaldquots; /* total incore dquots */
	87	uint qm_nrefs; /* file systems with quota on */
	88	int qm_dqfree_ratio;/* ratio of free to inuse dquots */
	89	kmem_zone_t qm_dqzone; / dquot mem-alloc zone */
	90	kmem_zone_t qm_dqtrxzone; / t_dqinfo of transactions */
	91	} xfs_qm_t;
	92
	93	/*
	94	* Various quota information for individual filesystems.
	95	* The mount structure keeps a pointer to this.
	96	*/
	97	typedef struct xfs_quotainfo {
	98	xfs_inode_t qi_uquotaip; / user quota inode */
	99	xfs_inode_t qi_gquotaip; / group quota inode */
3a25404b DC	100	struct list_head qi_dqlist; /* all dquots in filesys */
	101	struct mutex qi_dqlist_lock;
	102	int qi_dquots;
1da177e4 LT	103	int qi_dqreclaims; /* a change here indicates
	104	a removal in the dqlist */
	105	time_t qi_btimelimit; /* limit for blks timer */
	106	time_t qi_itimelimit; /* limit for inodes timer */
	107	time_t qi_rtbtimelimit;/* limit for rt blks timer */
06d10dd9 NS	108	xfs_qwarncnt_t qi_bwarnlimit; /* limit for blks warnings */
	109	xfs_qwarncnt_t qi_iwarnlimit; /* limit for inodes warnings */
	110	xfs_qwarncnt_t qi_rtbwarnlimit;/* limit for rt blks warnings */
a0b0b8a5	111	struct mutex qi_quotaofflock;/* to serialize quotaoff */
1da177e4 LT	112	xfs_filblks_t qi_dqchunklen; /* # BBs in a chunk of dqs */
	113	uint qi_dqperchunk; /* # ondisk dqs in above chunk */
	114	xfs_qcnt_t qi_bhardlimit; /* default data blk hard limit */
	115	xfs_qcnt_t qi_bsoftlimit; /* default data blk soft limit */
	116	xfs_qcnt_t qi_ihardlimit; /* default inode count hard limit */
	117	xfs_qcnt_t qi_isoftlimit; /* default inode count soft limit */
	118	xfs_qcnt_t qi_rtbhardlimit;/* default realtime blk hard limit */
	119	xfs_qcnt_t qi_rtbsoftlimit;/* default realtime blk soft limit */
	120	} xfs_quotainfo_t;
	121
	122
1da177e4 LT	123	extern void xfs_trans_mod_dquot(xfs_trans_t , xfs_dquot_t , uint, long);
	124	extern int xfs_trans_reserve_quota_bydquots(xfs_trans_t , xfs_mount_t ,
	125	xfs_dquot_t , xfs_dquot_t , long, long, uint);
	126	extern void xfs_trans_dqjoin(xfs_trans_t , xfs_dquot_t );
	127	extern void xfs_trans_log_dquot(xfs_trans_t , xfs_dquot_t );
	128
	129	/*
	130	* We keep the usr and grp dquots separately so that locking will be easier
	131	* to do at commit time. All transactions that we know of at this point
	132	* affect no more than two dquots of one type. Hence, the TRANS_MAXDQS value.
	133	*/
	134	#define XFS_QM_TRANS_MAXDQS 2
	135	typedef struct xfs_dquot_acct {
	136	xfs_dqtrx_t dqa_usrdquots[XFS_QM_TRANS_MAXDQS];
	137	xfs_dqtrx_t dqa_grpdquots[XFS_QM_TRANS_MAXDQS];
	138	} xfs_dquot_acct_t;
	139
	140	/*
	141	* Users are allowed to have a usage exceeding their softlimit for
	142	* a period this long.
	143	*/
	144	#define XFS_QM_BTIMELIMIT (7 * 246060) /* 1 week */
	145	#define XFS_QM_RTBTIMELIMIT (7 * 246060) /* 1 week */
	146	#define XFS_QM_ITIMELIMIT (7 * 246060) /* 1 week */
	147
	148	#define XFS_QM_BWARNLIMIT 5
	149	#define XFS_QM_IWARNLIMIT 5
06d10dd9	150	#define XFS_QM_RTBWARNLIMIT 5
1da177e4	151
1da177e4	152	extern void xfs_qm_destroy_quotainfo(xfs_mount_t *);
1da177e4	153	extern int xfs_qm_quotacheck(xfs_mount_t *);
1da177e4	154	extern int xfs_qm_write_sb_changes(xfs_mount_t *, __int64_t);
1da177e4 LT	155
	156	/* dquot stuff */
	157	extern boolean_t xfs_qm_dqalloc_incore(xfs_dquot_t **);
1da177e4 LT	158	extern int xfs_qm_dqpurge_all(xfs_mount_t *, uint);
	159	extern void xfs_qm_dqrele_all_inodes(xfs_mount_t *, uint);
	160
fcafb71b CH	161	/* quota ops */
	162	extern int xfs_qm_scall_trunc_qfiles(xfs_mount_t *, uint);
	163	extern int xfs_qm_scall_getquota(xfs_mount_t *, xfs_dqid_t, uint,
	164	fs_disk_quota_t *);
	165	extern int xfs_qm_scall_setqlim(xfs_mount_t *, xfs_dqid_t, uint,
	166	fs_disk_quota_t *);
	167	extern int xfs_qm_scall_getqstat(xfs_mount_t , fs_quota_stat_t );
	168	extern int xfs_qm_scall_quotaon(xfs_mount_t *, uint);
	169	extern int xfs_qm_scall_quotaoff(xfs_mount_t *, uint);
	170
1da177e4 LT	171	#ifdef DEBUG
	172	extern int xfs_qm_internalqcheck(xfs_mount_t *);
	173	#else
	174	#define xfs_qm_internalqcheck(mp) (0)
	175	#endif
	176
	177	#endif /* __XFS_QM_H__ */