1/*
2 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation.
8 *
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.
13 *
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
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
26struct xfs_qm;
27struct xfs_inode;
28
29extern uint		ndquot;
30extern mutex_t		xfs_Gqm_lock;
31extern struct xfs_qm	*xfs_Gqm;
32extern kmem_zone_t	*qm_dqzone;
33extern 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 */
55#define XFS_QM_HASHSIZE_LOW		(NBPP / sizeof(xfs_dqhash_t))
56#define XFS_QM_HASHSIZE_HIGH		((NBPP * 4) / sizeof(xfs_dqhash_t))
57
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
74typedef xfs_dqhash_t	xfs_dqlist_t;
75/*
76 * The freelist head. The first two fields match the first two in the
77 * xfs_dquot_t structure (in xfs_dqmarker_t)
78 */
79typedef struct xfs_frlist {
80       struct xfs_dquot *qh_next;
81       struct xfs_dquot *qh_prev;
82       mutex_t		 qh_lock;
83       uint		 qh_version;
84       uint		 qh_nelems;
85} xfs_frlist_t;
86
87/*
88 * Quota Manager (global) structure. Lives only in core.
89 */
90typedef struct xfs_qm {
91	xfs_dqlist_t	*qm_usr_dqhtable;/* udquot hash table */
92	xfs_dqlist_t	*qm_grp_dqhtable;/* gdquot hash table */
93	uint		 qm_dqhashmask;	 /* # buckets in dq hashtab - 1 */
94	xfs_frlist_t	 qm_dqfreelist;	 /* freelist of dquots */
95	atomic_t	 qm_totaldquots; /* total incore dquots */
96	uint		 qm_nrefs;	 /* file systems with quota on */
97	int		 qm_dqfree_ratio;/* ratio of free to inuse dquots */
98	kmem_zone_t	*qm_dqzone;	 /* dquot mem-alloc zone */
99	kmem_zone_t	*qm_dqtrxzone;	 /* t_dqinfo of transactions */
100} xfs_qm_t;
101
102/*
103 * Various quota information for individual filesystems.
104 * The mount structure keeps a pointer to this.
105 */
106typedef struct xfs_quotainfo {
107	xfs_inode_t	*qi_uquotaip;	 /* user quota inode */
108	xfs_inode_t	*qi_gquotaip;	 /* group quota inode */
109	lock_t		 qi_pinlock;	 /* dquot pinning mutex */
110	xfs_dqlist_t	 qi_dqlist;	 /* all dquots in filesys */
111	int		 qi_dqreclaims;	 /* a change here indicates
112					    a removal in the dqlist */
113	time_t		 qi_btimelimit;	 /* limit for blks timer */
114	time_t		 qi_itimelimit;	 /* limit for inodes timer */
115	time_t		 qi_rtbtimelimit;/* limit for rt blks timer */
116	xfs_qwarncnt_t	 qi_bwarnlimit;	 /* limit for blks warnings */
117	xfs_qwarncnt_t	 qi_iwarnlimit;	 /* limit for inodes warnings */
118	xfs_qwarncnt_t	 qi_rtbwarnlimit;/* limit for rt blks warnings */
119	mutex_t		 qi_quotaofflock;/* to serialize quotaoff */
120	xfs_filblks_t	 qi_dqchunklen;	 /* # BBs in a chunk of dqs */
121	uint		 qi_dqperchunk;	 /* # ondisk dqs in above chunk */
122	xfs_qcnt_t	 qi_bhardlimit;	 /* default data blk hard limit */
123	xfs_qcnt_t	 qi_bsoftlimit;	 /* default data blk soft limit */
124	xfs_qcnt_t	 qi_ihardlimit;	 /* default inode count hard limit */
125	xfs_qcnt_t	 qi_isoftlimit;	 /* default inode count soft limit */
126	xfs_qcnt_t	 qi_rtbhardlimit;/* default realtime blk hard limit */
127	xfs_qcnt_t	 qi_rtbsoftlimit;/* default realtime blk soft limit */
128} xfs_quotainfo_t;
129
130
131extern xfs_dqtrxops_t	xfs_trans_dquot_ops;
132
133extern void	xfs_trans_mod_dquot(xfs_trans_t *, xfs_dquot_t *, uint, long);
134extern int	xfs_trans_reserve_quota_bydquots(xfs_trans_t *, xfs_mount_t *,
135			xfs_dquot_t *, xfs_dquot_t *, long, long, uint);
136extern void	xfs_trans_dqjoin(xfs_trans_t *, xfs_dquot_t *);
137extern void	xfs_trans_log_dquot(xfs_trans_t *, xfs_dquot_t *);
138
139/*
140 * We keep the usr and grp dquots separately so that locking will be easier
141 * to do at commit time. All transactions that we know of at this point
142 * affect no more than two dquots of one type. Hence, the TRANS_MAXDQS value.
143 */
144#define XFS_QM_TRANS_MAXDQS		2
145typedef struct xfs_dquot_acct {
146	xfs_dqtrx_t	dqa_usrdquots[XFS_QM_TRANS_MAXDQS];
147	xfs_dqtrx_t	dqa_grpdquots[XFS_QM_TRANS_MAXDQS];
148} xfs_dquot_acct_t;
149
150/*
151 * Users are allowed to have a usage exceeding their softlimit for
152 * a period this long.
153 */
154#define XFS_QM_BTIMELIMIT	(7 * 24*60*60)          /* 1 week */
155#define XFS_QM_RTBTIMELIMIT	(7 * 24*60*60)          /* 1 week */
156#define XFS_QM_ITIMELIMIT	(7 * 24*60*60)          /* 1 week */
157
158#define XFS_QM_BWARNLIMIT	5
159#define XFS_QM_IWARNLIMIT	5
160#define XFS_QM_RTBWARNLIMIT	5
161
162#define XFS_QM_LOCK(xqm)	(mutex_lock(&xqm##_lock))
163#define XFS_QM_UNLOCK(xqm)	(mutex_unlock(&xqm##_lock))
164#define XFS_QM_HOLD(xqm)	((xqm)->qm_nrefs++)
165#define XFS_QM_RELE(xqm)	((xqm)->qm_nrefs--)
166
167extern void		xfs_qm_destroy_quotainfo(xfs_mount_t *);
168extern int		xfs_qm_mount_quotas(xfs_mount_t *, int);
169extern void		xfs_qm_mount_quotainit(xfs_mount_t *, uint);
170extern int		xfs_qm_quotacheck(xfs_mount_t *);
171extern void		xfs_qm_unmount_quotadestroy(xfs_mount_t *);
172extern int		xfs_qm_unmount_quotas(xfs_mount_t *);
173extern int		xfs_qm_write_sb_changes(xfs_mount_t *, __int64_t);
174extern int		xfs_qm_sync(xfs_mount_t *, short);
175
176/* dquot stuff */
177extern boolean_t	xfs_qm_dqalloc_incore(xfs_dquot_t **);
178extern int		xfs_qm_dqattach(xfs_inode_t *, uint);
179extern void		xfs_qm_dqdetach(xfs_inode_t *);
180extern int		xfs_qm_dqpurge_all(xfs_mount_t *, uint);
181extern void		xfs_qm_dqrele_all_inodes(xfs_mount_t *, uint);
182
183/* vop stuff */
184extern int		xfs_qm_vop_dqalloc(xfs_mount_t *, xfs_inode_t *,
185					uid_t, gid_t, prid_t, uint,
186					xfs_dquot_t **, xfs_dquot_t **);
187extern void		xfs_qm_vop_dqattach_and_dqmod_newinode(
188					xfs_trans_t *, xfs_inode_t *,
189					xfs_dquot_t *, xfs_dquot_t *);
190extern int		xfs_qm_vop_rename_dqattach(xfs_inode_t **);
191extern xfs_dquot_t *	xfs_qm_vop_chown(xfs_trans_t *, xfs_inode_t *,
192					xfs_dquot_t **, xfs_dquot_t *);
193extern int		xfs_qm_vop_chown_reserve(xfs_trans_t *, xfs_inode_t *,
194					xfs_dquot_t *, xfs_dquot_t *, uint);
195
196/* list stuff */
197extern void		xfs_qm_freelist_append(xfs_frlist_t *, xfs_dquot_t *);
198extern void		xfs_qm_freelist_unlink(xfs_dquot_t *);
199extern int		xfs_qm_freelist_lock_nowait(xfs_qm_t *);
200
201/* system call interface */
202extern int		xfs_qm_quotactl(bhv_desc_t *, int, int, xfs_caddr_t);
203
204#ifdef DEBUG
205extern int		xfs_qm_internalqcheck(xfs_mount_t *);
206#else
207#define xfs_qm_internalqcheck(mp)	(0)
208#endif
209
210#endif /* __XFS_QM_H__ */
211