Loading...
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_DQUOT_H__
19#define __XFS_DQUOT_H__
20
21/*
22 * Dquots are structures that hold quota information about a user or a group,
23 * much like inodes are for files. In fact, dquots share many characteristics
24 * with inodes. However, dquots can also be a centralized resource, relative
25 * to a collection of inodes. In this respect, dquots share some characteristics
26 * of the superblock.
27 * XFS dquots exploit both those in its algorithms. They make every attempt
28 * to not be a bottleneck when quotas are on and have minimal impact, if any,
29 * when quotas are off.
30 */
31
32/*
33 * The hash chain headers (hash buckets)
34 */
35typedef struct xfs_dqhash {
36 struct list_head qh_list;
37 struct mutex qh_lock;
38 uint qh_version; /* ever increasing version */
39 uint qh_nelems; /* number of dquots on the list */
40} xfs_dqhash_t;
41
42struct xfs_mount;
43struct xfs_trans;
44
45/*
46 * The incore dquot structure
47 */
48typedef struct xfs_dquot {
49 uint dq_flags; /* various flags (XFS_DQ_*) */
50 struct list_head q_freelist; /* global free list of dquots */
51 struct list_head q_mplist; /* mount's list of dquots */
52 struct list_head q_hashlist; /* gloabl hash list of dquots */
53 xfs_dqhash_t *q_hash; /* the hashchain header */
54 struct xfs_mount*q_mount; /* filesystem this relates to */
55 struct xfs_trans*q_transp; /* trans this belongs to currently */
56 uint q_nrefs; /* # active refs from inodes */
57 xfs_daddr_t q_blkno; /* blkno of dquot buffer */
58 int q_bufoffset; /* off of dq in buffer (# dquots) */
59 xfs_fileoff_t q_fileoffset; /* offset in quotas file */
60
61 struct xfs_dquot*q_gdquot; /* group dquot, hint only */
62 xfs_disk_dquot_t q_core; /* actual usage & quotas */
63 xfs_dq_logitem_t q_logitem; /* dquot log item */
64 xfs_qcnt_t q_res_bcount; /* total regular nblks used+reserved */
65 xfs_qcnt_t q_res_icount; /* total inos allocd+reserved */
66 xfs_qcnt_t q_res_rtbcount;/* total realtime blks used+reserved */
67 struct mutex q_qlock; /* quota lock */
68 struct completion q_flush; /* flush completion queue */
69 atomic_t q_pincount; /* dquot pin count */
70 wait_queue_head_t q_pinwait; /* dquot pinning wait queue */
71} xfs_dquot_t;
72
73/*
74 * Lock hierarchy for q_qlock:
75 * XFS_QLOCK_NORMAL is the implicit default,
76 * XFS_QLOCK_NESTED is the dquot with the higher id in xfs_dqlock2
77 */
78enum {
79 XFS_QLOCK_NORMAL = 0,
80 XFS_QLOCK_NESTED,
81};
82
83#define XFS_DQHOLD(dqp) ((dqp)->q_nrefs++)
84
85/*
86 * Manage the q_flush completion queue embedded in the dquot. This completion
87 * queue synchronizes processes attempting to flush the in-core dquot back to
88 * disk.
89 */
90static inline void xfs_dqflock(xfs_dquot_t *dqp)
91{
92 wait_for_completion(&dqp->q_flush);
93}
94
95static inline int xfs_dqflock_nowait(xfs_dquot_t *dqp)
96{
97 return try_wait_for_completion(&dqp->q_flush);
98}
99
100static inline void xfs_dqfunlock(xfs_dquot_t *dqp)
101{
102 complete(&dqp->q_flush);
103}
104
105#define XFS_DQ_IS_LOCKED(dqp) (mutex_is_locked(&((dqp)->q_qlock)))
106#define XFS_DQ_IS_DIRTY(dqp) ((dqp)->dq_flags & XFS_DQ_DIRTY)
107#define XFS_QM_ISUDQ(dqp) ((dqp)->dq_flags & XFS_DQ_USER)
108#define XFS_QM_ISPDQ(dqp) ((dqp)->dq_flags & XFS_DQ_PROJ)
109#define XFS_QM_ISGDQ(dqp) ((dqp)->dq_flags & XFS_DQ_GROUP)
110#define XFS_DQ_TO_QINF(dqp) ((dqp)->q_mount->m_quotainfo)
111#define XFS_DQ_TO_QIP(dqp) (XFS_QM_ISUDQ(dqp) ? \
112 XFS_DQ_TO_QINF(dqp)->qi_uquotaip : \
113 XFS_DQ_TO_QINF(dqp)->qi_gquotaip)
114
115#define XFS_IS_THIS_QUOTA_OFF(d) (! (XFS_QM_ISUDQ(d) ? \
116 (XFS_IS_UQUOTA_ON((d)->q_mount)) : \
117 (XFS_IS_OQUOTA_ON((d)->q_mount))))
118
119extern void xfs_qm_dqdestroy(xfs_dquot_t *);
120extern int xfs_qm_dqflush(xfs_dquot_t *, uint);
121extern int xfs_qm_dqpurge(xfs_dquot_t *);
122extern void xfs_qm_dqunpin_wait(xfs_dquot_t *);
123extern int xfs_qm_dqlock_nowait(xfs_dquot_t *);
124extern void xfs_qm_dqflock_pushbuf_wait(xfs_dquot_t *dqp);
125extern void xfs_qm_adjust_dqtimers(xfs_mount_t *,
126 xfs_disk_dquot_t *);
127extern void xfs_qm_adjust_dqlimits(xfs_mount_t *,
128 xfs_disk_dquot_t *);
129extern int xfs_qm_dqget(xfs_mount_t *, xfs_inode_t *,
130 xfs_dqid_t, uint, uint, xfs_dquot_t **);
131extern void xfs_qm_dqput(xfs_dquot_t *);
132extern void xfs_dqlock(xfs_dquot_t *);
133extern void xfs_dqlock2(xfs_dquot_t *, xfs_dquot_t *);
134extern void xfs_dqunlock(xfs_dquot_t *);
135extern void xfs_dqunlock_nonotify(xfs_dquot_t *);
136
137#endif /* __XFS_DQUOT_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_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
20struct xfs_mount;
21struct xfs_trans;
22
23enum {
24 XFS_QLOWSP_1_PCNT = 0,
25 XFS_QLOWSP_3_PCNT,
26 XFS_QLOWSP_5_PCNT,
27 XFS_QLOWSP_MAX
28};
29
30/*
31 * The incore dquot structure
32 */
33typedef struct xfs_dquot {
34 uint dq_flags; /* various flags (XFS_DQ_*) */
35 struct list_head q_lru; /* global free list of dquots */
36 struct xfs_mount*q_mount; /* filesystem this relates to */
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
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 */
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];
50 struct mutex q_qlock; /* quota lock */
51 struct completion q_flush; /* flush completion queue */
52 atomic_t q_pincount; /* dquot pin count */
53 wait_queue_head_t q_pinwait; /* dquot pinning wait queue */
54} xfs_dquot_t;
55
56/*
57 * Lock hierarchy for q_qlock:
58 * XFS_QLOCK_NORMAL is the implicit default,
59 * XFS_QLOCK_NESTED is the dquot with the higher id in xfs_dqlock2
60 */
61enum {
62 XFS_QLOCK_NORMAL = 0,
63 XFS_QLOCK_NESTED,
64};
65
66/*
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.
70 */
71static inline void xfs_dqflock(xfs_dquot_t *dqp)
72{
73 wait_for_completion(&dqp->q_flush);
74}
75
76static inline bool xfs_dqflock_nowait(xfs_dquot_t *dqp)
77{
78 return try_wait_for_completion(&dqp->q_flush);
79}
80
81static inline void xfs_dqfunlock(xfs_dquot_t *dqp)
82{
83 complete(&dqp->q_flush);
84}
85
86static inline int xfs_dqlock_nowait(struct xfs_dquot *dqp)
87{
88 return mutex_trylock(&dqp->q_qlock);
89}
90
91static inline void xfs_dqlock(struct xfs_dquot *dqp)
92{
93 mutex_lock(&dqp->q_qlock);
94}
95
96static inline void xfs_dqunlock(struct xfs_dquot *dqp)
97{
98 mutex_unlock(&dqp->q_qlock);
99}
100
101static 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:
107 return XFS_IS_GQUOTA_ON(mp);
108 case XFS_DQ_PROJ:
109 return XFS_IS_PQUOTA_ON(mp);
110 default:
111 return 0;
112 }
113}
114
115static 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:
121 return ip->i_gdquot;
122 case XFS_DQ_PROJ:
123 return ip->i_pdquot;
124 default:
125 return NULL;
126 }
127}
128
129/*
130 * Check whether a dquot is under low free space conditions. We assume the quota
131 * is enabled and enforced.
132 */
133static 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
144#define XFS_DQ_IS_LOCKED(dqp) (mutex_is_locked(&((dqp)->q_qlock)))
145#define XFS_DQ_IS_DIRTY(dqp) ((dqp)->dq_flags & XFS_DQ_DIRTY)
146#define XFS_QM_ISUDQ(dqp) ((dqp)->dq_flags & XFS_DQ_USER)
147#define XFS_QM_ISPDQ(dqp) ((dqp)->dq_flags & XFS_DQ_PROJ)
148#define XFS_QM_ISGDQ(dqp) ((dqp)->dq_flags & XFS_DQ_GROUP)
149
150extern void xfs_qm_dqdestroy(xfs_dquot_t *);
151extern int xfs_qm_dqflush(struct xfs_dquot *, struct xfs_buf **);
152extern void xfs_qm_dqunpin_wait(xfs_dquot_t *);
153extern void xfs_qm_adjust_dqtimers(xfs_mount_t *,
154 xfs_disk_dquot_t *);
155extern void xfs_qm_adjust_dqlimits(struct xfs_mount *,
156 struct xfs_dquot *);
157extern xfs_dqid_t xfs_qm_id_for_quotatype(struct xfs_inode *ip,
158 uint type);
159extern int xfs_qm_dqget(struct xfs_mount *mp, xfs_dqid_t id,
160 uint type, bool can_alloc,
161 struct xfs_dquot **dqpp);
162extern int xfs_qm_dqget_inode(struct xfs_inode *ip, uint type,
163 bool can_alloc,
164 struct xfs_dquot **dqpp);
165extern int xfs_qm_dqget_next(struct xfs_mount *mp, xfs_dqid_t id,
166 uint type, struct xfs_dquot **dqpp);
167extern int xfs_qm_dqget_uncached(struct xfs_mount *mp,
168 xfs_dqid_t id, uint type,
169 struct xfs_dquot **dqpp);
170extern void xfs_qm_dqput(xfs_dquot_t *);
171
172extern void xfs_dqlock2(struct xfs_dquot *, struct xfs_dquot *);
173
174extern void xfs_dquot_set_prealloc_limits(struct xfs_dquot *);
175
176static 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
184typedef int (*xfs_qm_dqiterate_fn)(struct xfs_dquot *dq, uint dqtype,
185 void *priv);
186int xfs_qm_dqiterate(struct xfs_mount *mp, uint dqtype,
187 xfs_qm_dqiterate_fn iter_fn, void *priv);
188
189#endif /* __XFS_DQUOT_H__ */