[linux.git] / fs / xfs / xfs_dquot.h

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

/*
 * Dquots are structures that hold quota information about a user or a group,
 * much like inodes are for files. In fact, dquots share many characteristics
 * with inodes. However, dquots can also be a centralized resource, relative
 * to a collection of inodes. In this respect, dquots share some characteristics
 * of the superblock.
 * XFS dquots exploit both those in its algorithms. They make every attempt
 * to not be a bottleneck when quotas are on and have minimal impact, if any,
 * when quotas are off.
 */

struct xfs_mount;
struct xfs_trans;

enum {
	XFS_QLOWSP_1_PCNT = 0,
	XFS_QLOWSP_3_PCNT,
	XFS_QLOWSP_5_PCNT,
	XFS_QLOWSP_MAX
};

/*
 * The incore dquot structure
 */
typedef struct xfs_dquot {
	uint		 dq_flags;	/* various flags (XFS_DQ_*) */
	struct list_head q_lru;		/* global free list of dquots */
	struct xfs_mount*q_mount;	/* filesystem this relates to */
	uint		 q_nrefs;	/* # active refs from inodes */
	xfs_daddr_t	 q_blkno;	/* blkno of dquot buffer */
	int		 q_bufoffset;	/* off of dq in buffer (# dquots) */
	xfs_fileoff_t	 q_fileoffset;	/* offset in quotas file */

	xfs_disk_dquot_t q_core;	/* actual usage & quotas */
	xfs_dq_logitem_t q_logitem;	/* dquot log item */
	xfs_qcnt_t	 q_res_bcount;	/* total regular nblks used+reserved */
	xfs_qcnt_t	 q_res_icount;	/* total inos allocd+reserved */
	xfs_qcnt_t	 q_res_rtbcount;/* total realtime blks used+reserved */
	xfs_qcnt_t	 q_prealloc_lo_wmark;/* prealloc throttle wmark */
	xfs_qcnt_t	 q_prealloc_hi_wmark;/* prealloc disabled wmark */
	int64_t		 q_low_space[XFS_QLOWSP_MAX];
	struct mutex	 q_qlock;	/* quota lock */
	struct completion q_flush;	/* flush completion queue */
	atomic_t          q_pincount;	/* dquot pin count */
	wait_queue_head_t q_pinwait;	/* dquot pinning wait queue */
} xfs_dquot_t;

/*
 * Lock hierarchy for q_qlock:
 *	XFS_QLOCK_NORMAL is the implicit default,
 * 	XFS_QLOCK_NESTED is the dquot with the higher id in xfs_dqlock2
 */
enum {
	XFS_QLOCK_NORMAL = 0,
	XFS_QLOCK_NESTED,
};

/*
 * Manage the q_flush completion queue embedded in the dquot.  This completion
 * queue synchronizes processes attempting to flush the in-core dquot back to
 * disk.
 */
static inline void xfs_dqflock(xfs_dquot_t *dqp)
{
	wait_for_completion(&dqp->q_flush);
}

static inline bool xfs_dqflock_nowait(xfs_dquot_t *dqp)
{
	return try_wait_for_completion(&dqp->q_flush);
}

static inline void xfs_dqfunlock(xfs_dquot_t *dqp)
{
	complete(&dqp->q_flush);
}

static inline int xfs_dqlock_nowait(struct xfs_dquot *dqp)
{
	return mutex_trylock(&dqp->q_qlock);
}

static inline void xfs_dqlock(struct xfs_dquot *dqp)
{
	mutex_lock(&dqp->q_qlock);
}

static inline void xfs_dqunlock(struct xfs_dquot *dqp)
{
	mutex_unlock(&dqp->q_qlock);
}

static inline int xfs_this_quota_on(struct xfs_mount *mp, int type)
{
	switch (type & XFS_DQ_ALLTYPES) {
	case XFS_DQ_USER:
		return XFS_IS_UQUOTA_ON(mp);
	case XFS_DQ_GROUP:
		return XFS_IS_GQUOTA_ON(mp);
	case XFS_DQ_PROJ:
		return XFS_IS_PQUOTA_ON(mp);
	default:
		return 0;
	}
}

static inline xfs_dquot_t *xfs_inode_dquot(struct xfs_inode *ip, int type)
{
	switch (type & XFS_DQ_ALLTYPES) {
	case XFS_DQ_USER:
		return ip->i_udquot;
	case XFS_DQ_GROUP:
		return ip->i_gdquot;
	case XFS_DQ_PROJ:
		return ip->i_pdquot;
	default:
		return NULL;
	}
}

/*
 * Check whether a dquot is under low free space conditions. We assume the quota
 * is enabled and enforced.
 */
static inline bool xfs_dquot_lowsp(struct xfs_dquot *dqp)
{
	int64_t freesp;

	freesp = be64_to_cpu(dqp->q_core.d_blk_hardlimit) - dqp->q_res_bcount;
	if (freesp < dqp->q_low_space[XFS_QLOWSP_1_PCNT])
		return true;

	return false;
}

#define XFS_DQ_IS_LOCKED(dqp)	(mutex_is_locked(&((dqp)->q_qlock)))
#define XFS_DQ_IS_DIRTY(dqp)	((dqp)->dq_flags & XFS_DQ_DIRTY)
#define XFS_QM_ISUDQ(dqp)	((dqp)->dq_flags & XFS_DQ_USER)
#define XFS_QM_ISPDQ(dqp)	((dqp)->dq_flags & XFS_DQ_PROJ)
#define XFS_QM_ISGDQ(dqp)	((dqp)->dq_flags & XFS_DQ_GROUP)

extern void		xfs_qm_dqdestroy(xfs_dquot_t *);
extern int		xfs_qm_dqflush(struct xfs_dquot *, struct xfs_buf **);
extern void		xfs_qm_dqunpin_wait(xfs_dquot_t *);
extern void		xfs_qm_adjust_dqtimers(xfs_mount_t *,
					xfs_disk_dquot_t *);
extern void		xfs_qm_adjust_dqlimits(struct xfs_mount *,
					       struct xfs_dquot *);
extern xfs_dqid_t	xfs_qm_id_for_quotatype(struct xfs_inode *ip,
					uint type);
extern int		xfs_qm_dqget(struct xfs_mount *mp, xfs_dqid_t id,
					uint type, bool can_alloc,
					struct xfs_dquot **dqpp);
extern int		xfs_qm_dqget_inode(struct xfs_inode *ip, uint type,
					bool can_alloc,
					struct xfs_dquot **dqpp);
extern int		xfs_qm_dqget_next(struct xfs_mount *mp, xfs_dqid_t id,
					uint type, struct xfs_dquot **dqpp);
extern int		xfs_qm_dqget_uncached(struct xfs_mount *mp,
					xfs_dqid_t id, uint type,
					struct xfs_dquot **dqpp);
extern void		xfs_qm_dqput(xfs_dquot_t *);

extern void		xfs_dqlock2(struct xfs_dquot *, struct xfs_dquot *);

extern void		xfs_dquot_set_prealloc_limits(struct xfs_dquot *);

static inline struct xfs_dquot *xfs_qm_dqhold(struct xfs_dquot *dqp)
{
	xfs_dqlock(dqp);
	dqp->q_nrefs++;
	xfs_dqunlock(dqp);
	return dqp;
}

typedef int (*xfs_qm_dqiterate_fn)(struct xfs_dquot *dq, uint dqtype,
		void *priv);
int xfs_qm_dqiterate(struct xfs_mount *mp, uint dqtype,
		xfs_qm_dqiterate_fn iter_fn, void *priv);

#endif /* __XFS_DQUOT_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_DQUOT_H__
	7	#define __XFS_DQUOT_H__
	8
	9	/*
	10	* Dquots are structures that hold quota information about a user or a group,
	11	* much like inodes are for files. In fact, dquots share many characteristics
	12	* with inodes. However, dquots can also be a centralized resource, relative
	13	* to a collection of inodes. In this respect, dquots share some characteristics
	14	* of the superblock.
	15	* XFS dquots exploit both those in its algorithms. They make every attempt
	16	* to not be a bottleneck when quotas are on and have minimal impact, if any,
	17	* when quotas are off.
	18	*/
	19
1da177e4 LT	20	struct xfs_mount;
	21	struct xfs_trans;
	22
b1366451 BF	23	enum {
	24	XFS_QLOWSP_1_PCNT = 0,
	25	XFS_QLOWSP_3_PCNT,
	26	XFS_QLOWSP_5_PCNT,
	27	XFS_QLOWSP_MAX
	28	};
	29
1da177e4 LT	30	/*
	31	* The incore dquot structure
	32	*/
	33	typedef struct xfs_dquot {
74457cf4	34	uint dq_flags; /* various flags (XFS_DQ_) /
f8739c3c	35	struct list_head q_lru; /* global free list of dquots */
1da177e4	36	struct xfs_mountq_mount; / filesystem this relates to */
1da177e4 LT	37	uint q_nrefs; /* # active refs from inodes */
	38	xfs_daddr_t q_blkno; /* blkno of dquot buffer */
	39	int q_bufoffset; /* off of dq in buffer (# dquots) */
	40	xfs_fileoff_t q_fileoffset; /* offset in quotas file */
	41
1da177e4 LT	42	xfs_disk_dquot_t q_core; /* actual usage & quotas */
	43	xfs_dq_logitem_t q_logitem; /* dquot log item */
	44	xfs_qcnt_t q_res_bcount; /* total regular nblks used+reserved */
	45	xfs_qcnt_t q_res_icount; /* total inos allocd+reserved */
	46	xfs_qcnt_t q_res_rtbcount;/* total realtime blks used+reserved */
b1366451 BF	47	xfs_qcnt_t q_prealloc_lo_wmark;/* prealloc throttle wmark */
	48	xfs_qcnt_t q_prealloc_hi_wmark;/* prealloc disabled wmark */
	49	int64_t q_low_space[XFS_QLOWSP_MAX];
a0b0b8a5	50	struct mutex q_qlock; /* quota lock */
e1f49cf2	51	struct completion q_flush; /* flush completion queue */
bc3048e3 PL	52	atomic_t q_pincount; /* dquot pin count */
bc3048e3 PL	53	wait_queue_head_t q_pinwait; /* dquot pinning wait queue */
1da177e4 LT	54	} xfs_dquot_t;
1da177e4 LT	55
5bb87a33	56	/*
af901ca1	57	* Lock hierarchy for q_qlock:
5bb87a33 CH	58	* XFS_QLOCK_NORMAL is the implicit default,
	59	* XFS_QLOCK_NESTED is the dquot with the higher id in xfs_dqlock2
	60	*/
	61	enum {
	62	XFS_QLOCK_NORMAL = 0,
	63	XFS_QLOCK_NESTED,
	64	};
	65
1da177e4	66	/*
e1f49cf2 DC	67	* Manage the q_flush completion queue embedded in the dquot. This completion
	68	* queue synchronizes processes attempting to flush the in-core dquot back to
	69	* disk.
1da177e4	70	*/
e1f49cf2 DC	71	static inline void xfs_dqflock(xfs_dquot_t *dqp)
	72	{
	73	wait_for_completion(&dqp->q_flush);
	74	}
	75
43fd1fce	76	static inline bool xfs_dqflock_nowait(xfs_dquot_t *dqp)
e1f49cf2 DC	77	{
	78	return try_wait_for_completion(&dqp->q_flush);
	79	}
	80
	81	static inline void xfs_dqfunlock(xfs_dquot_t *dqp)
	82	{
	83	complete(&dqp->q_flush);
	84	}
1da177e4	85
800b484e CH	86	static inline int xfs_dqlock_nowait(struct xfs_dquot *dqp)
	87	{
	88	return mutex_trylock(&dqp->q_qlock);
	89	}
	90
	91	static inline void xfs_dqlock(struct xfs_dquot *dqp)
	92	{
	93	mutex_lock(&dqp->q_qlock);
	94	}
	95
5b03ff1b	96	static inline void xfs_dqunlock(struct xfs_dquot *dqp)
800b484e CH	97	{
	98	mutex_unlock(&dqp->q_qlock);
	99	}
	100
6967b964 CS	101	static inline int xfs_this_quota_on(struct xfs_mount *mp, int type)
	102	{
	103	switch (type & XFS_DQ_ALLTYPES) {
	104	case XFS_DQ_USER:
	105	return XFS_IS_UQUOTA_ON(mp);
	106	case XFS_DQ_GROUP:
92f8ff73	107	return XFS_IS_GQUOTA_ON(mp);
6967b964	108	case XFS_DQ_PROJ:
92f8ff73	109	return XFS_IS_PQUOTA_ON(mp);
6967b964 CS	110	default:
	111	return 0;
	112	}
	113	}
	114
36731410 CS	115	static inline xfs_dquot_t xfs_inode_dquot(struct xfs_inode ip, int type)
	116	{
	117	switch (type & XFS_DQ_ALLTYPES) {
	118	case XFS_DQ_USER:
	119	return ip->i_udquot;
	120	case XFS_DQ_GROUP:
36731410	121	return ip->i_gdquot;
92f8ff73 CS	122	case XFS_DQ_PROJ:
92f8ff73 CS	123	return ip->i_pdquot;
36731410 CS	124	default:
	125	return NULL;
	126	}
	127	}
	128
dc06f398 BF	129	/*
	130	* Check whether a dquot is under low free space conditions. We assume the quota
	131	* is enabled and enforced.
	132	*/
	133	static inline bool xfs_dquot_lowsp(struct xfs_dquot *dqp)
	134	{
	135	int64_t freesp;
	136
	137	freesp = be64_to_cpu(dqp->q_core.d_blk_hardlimit) - dqp->q_res_bcount;
	138	if (freesp < dqp->q_low_space[XFS_QLOWSP_1_PCNT])
	139	return true;
	140
	141	return false;
	142	}
	143
7201813b	144	#define XFS_DQ_IS_LOCKED(dqp) (mutex_is_locked(&((dqp)->q_qlock)))
1da177e4 LT	145	#define XFS_DQ_IS_DIRTY(dqp) ((dqp)->dq_flags & XFS_DQ_DIRTY)
1da177e4 LT	146	#define XFS_QM_ISUDQ(dqp) ((dqp)->dq_flags & XFS_DQ_USER)
c8ad20ff NS	147	#define XFS_QM_ISPDQ(dqp) ((dqp)->dq_flags & XFS_DQ_PROJ)
c8ad20ff NS	148	#define XFS_QM_ISGDQ(dqp) ((dqp)->dq_flags & XFS_DQ_GROUP)
1da177e4	149
1da177e4	150	extern void xfs_qm_dqdestroy(xfs_dquot_t *);
fe7257fd	151	extern int xfs_qm_dqflush(struct xfs_dquot , struct xfs_buf *);
1da177e4	152	extern void xfs_qm_dqunpin_wait(xfs_dquot_t *);
1da177e4 LT	153	extern void xfs_qm_adjust_dqtimers(xfs_mount_t *,
1da177e4 LT	154	xfs_disk_dquot_t *);
4b6eae2e BF	155	extern void xfs_qm_adjust_dqlimits(struct xfs_mount *,
4b6eae2e BF	156	struct xfs_dquot *);
4882c19d DW	157	extern xfs_dqid_t xfs_qm_id_for_quotatype(struct xfs_inode *ip,
	158	uint type);
	159	extern int xfs_qm_dqget(struct xfs_mount *mp, xfs_dqid_t id,
30ab2dcf	160	uint type, bool can_alloc,
4882c19d DW	161	struct xfs_dquot **dqpp);
	162	extern int xfs_qm_dqget_inode(struct xfs_inode *ip, uint type,
	163	bool can_alloc,
	164	struct xfs_dquot **dqpp);
2e330e76 DW	165	extern int xfs_qm_dqget_next(struct xfs_mount *mp, xfs_dqid_t id,
2e330e76 DW	166	uint type, struct xfs_dquot **dqpp);
114e73cc DW	167	extern int xfs_qm_dqget_uncached(struct xfs_mount *mp,
	168	xfs_dqid_t id, uint type,
	169	struct xfs_dquot **dqpp);
1da177e4	170	extern void xfs_qm_dqput(xfs_dquot_t *);
800b484e CH	171
800b484e CH	172	extern void xfs_dqlock2(struct xfs_dquot , struct xfs_dquot );
1da177e4	173
b1366451 BF	174	extern void xfs_dquot_set_prealloc_limits(struct xfs_dquot *);
b1366451 BF	175
78e55892 CH	176	static inline struct xfs_dquot xfs_qm_dqhold(struct xfs_dquot dqp)
	177	{
	178	xfs_dqlock(dqp);
	179	dqp->q_nrefs++;
	180	xfs_dqunlock(dqp);
	181	return dqp;
	182	}
	183
554ba965 DW	184	typedef int (xfs_qm_dqiterate_fn)(struct xfs_dquot dq, uint dqtype,
	185	void *priv);
	186	int xfs_qm_dqiterate(struct xfs_mount *mp, uint dqtype,
	187	xfs_qm_dqiterate_fn iter_fn, void *priv);
	188
1da177e4	189	#endif /* __XFS_DQUOT_H__ */