xfs_qm.h

  1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
  4 * All Rights Reserved.
  5 */
  6#ifndef __XFS_QM_H__
  7#define __XFS_QM_H__
  8
  9#include "xfs_dquot_item.h"
 10#include "xfs_dquot.h"
 11
 12struct xfs_inode;
 13
 14extern struct kmem_cache	*xfs_dqtrx_cache;
 15
 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) ( \
 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 && \
 29	!dqp->q_blk.count && \
 30	!dqp->q_rtb.count && \
 31	!dqp->q_ino.count)
 32
 33struct 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 */
 37};
 38
 39/* Defaults for each quota type: time limits, warn limits, usage limits */
 40struct xfs_def_quota {
 41	struct xfs_quota_limits	blk;
 42	struct xfs_quota_limits	ino;
 43	struct xfs_quota_limits	rtb;
 44};
 45
 46/*
 47 * Various quota information for individual filesystems.
 48 * The mount structure keeps a pointer to this.
 49 */
 50struct xfs_quotainfo {
 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;
 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 */
 58	struct xfs_inode	*qi_dirip;	/* quota metadir */
 59	struct list_lru		qi_lru;
 60	uint64_t		qi_dquots;
 61	struct mutex		qi_quotaofflock;/* to serialize quotaoff */
 62	xfs_filblks_t		qi_dqchunklen;	/* # BBs in a chunk of dqs */
 63	uint			qi_dqperchunk;	/* # ondisk dq in above chunk */
 64	struct xfs_def_quota	qi_usr_default;
 65	struct xfs_def_quota	qi_grp_default;
 66	struct xfs_def_quota	qi_prj_default;
 67	struct shrinker		*qi_shrinker;
 68
 69	/* Minimum and maximum quota expiration timestamp values. */
 70	time64_t		qi_expiry_min;
 71	time64_t		qi_expiry_max;
 72
 73	/* Hook to feed quota counter updates to an active online repair. */
 74	struct xfs_hooks	qi_mod_ino_dqtrx_hooks;
 75	struct xfs_hooks	qi_apply_dqtrx_hooks;
 76};
 77
 78static inline struct radix_tree_root *
 79xfs_dquot_tree(
 80	struct xfs_quotainfo	*qi,
 81	xfs_dqtype_t		type)
 82{
 83	switch (type) {
 84	case XFS_DQTYPE_USER:
 85		return &qi->qi_uquota_tree;
 86	case XFS_DQTYPE_GROUP:
 87		return &qi->qi_gquota_tree;
 88	case XFS_DQTYPE_PROJ:
 89		return &qi->qi_pquota_tree;
 90	default:
 91		ASSERT(0);
 92	}
 93	return NULL;
 94}
 95
 96static inline struct xfs_inode *
 97xfs_quota_inode(struct xfs_mount *mp, xfs_dqtype_t type)
 98{
 99	switch (type) {
100	case XFS_DQTYPE_USER:
101		return mp->m_quotainfo->qi_uquotaip;
102	case XFS_DQTYPE_GROUP:
103		return mp->m_quotainfo->qi_gquotaip;
104	case XFS_DQTYPE_PROJ:
105		return mp->m_quotainfo->qi_pquotaip;
106	default:
107		ASSERT(0);
108	}
109	return NULL;
110}
111
112/*
113 * Parameters for tracking dqtrx changes on behalf of an inode.  The hook
114 * function arg parameter is the field being updated.
115 */
116struct xfs_mod_ino_dqtrx_params {
117	uintptr_t		tx_id;
118	xfs_ino_t		ino;
119	xfs_dqtype_t		q_type;
120	xfs_dqid_t		q_id;
121	int64_t			delta;
122};
123
124extern void	xfs_trans_mod_dquot(struct xfs_trans *tp, struct xfs_dquot *dqp,
125				    uint field, int64_t delta);
126extern void	xfs_trans_dqjoin(struct xfs_trans *, struct xfs_dquot *);
127extern void	xfs_trans_log_dquot(struct xfs_trans *, struct xfs_dquot *);
128
129/*
130 * We keep the usr, grp, and prj dquots separately so that locking will be
131 * easier 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 */
134enum {
135	XFS_QM_TRANS_USR = 0,
136	XFS_QM_TRANS_GRP,
137	XFS_QM_TRANS_PRJ,
138	XFS_QM_TRANS_DQTYPES
139};
140#define XFS_QM_TRANS_MAXDQS		5
141struct xfs_dquot_acct {
142	struct xfs_dqtrx	dqs[XFS_QM_TRANS_DQTYPES][XFS_QM_TRANS_MAXDQS];
143};
144
145/*
146 * Users are allowed to have a usage exceeding their softlimit for
147 * a period this long.
148 */
149#define XFS_QM_BTIMELIMIT	(7 * 24*60*60)          /* 1 week */
150#define XFS_QM_RTBTIMELIMIT	(7 * 24*60*60)          /* 1 week */
151#define XFS_QM_ITIMELIMIT	(7 * 24*60*60)          /* 1 week */
152
153extern void		xfs_qm_destroy_quotainfo(struct xfs_mount *);
154
155/* quota ops */
156extern int		xfs_qm_scall_trunc_qfiles(struct xfs_mount *, uint);
157extern int		xfs_qm_scall_getquota(struct xfs_mount *mp,
158					xfs_dqid_t id,
159					xfs_dqtype_t type,
160					struct qc_dqblk *dst);
161extern int		xfs_qm_scall_getquota_next(struct xfs_mount *mp,
162					xfs_dqid_t *id,
163					xfs_dqtype_t type,
164					struct qc_dqblk *dst);
165extern int		xfs_qm_scall_setqlim(struct xfs_mount *mp,
166					xfs_dqid_t id,
167					xfs_dqtype_t type,
168					struct qc_dqblk *newlim);
169extern int		xfs_qm_scall_quotaon(struct xfs_mount *, uint);
170extern int		xfs_qm_scall_quotaoff(struct xfs_mount *, uint);
171
172static inline struct xfs_def_quota *
173xfs_get_defquota(struct xfs_quotainfo *qi, xfs_dqtype_t type)
174{
175	switch (type) {
176	case XFS_DQTYPE_USER:
177		return &qi->qi_usr_default;
178	case XFS_DQTYPE_GROUP:
179		return &qi->qi_grp_default;
180	case XFS_DQTYPE_PROJ:
181		return &qi->qi_prj_default;
182	default:
183		ASSERT(0);
184		return NULL;
185	}
186}
187
188int xfs_qm_qino_load(struct xfs_mount *mp, xfs_dqtype_t type,
189		struct xfs_inode **ipp);
190
191#endif /* __XFS_QM_H__ */