blob: 74f1812b03cbd2e94da4992296da5280e8d22701 [file] [log] [blame]
Dave Chinner0b61f8a2018-06-05 19:42:14 -07001// SPDX-License-Identifier: GPL-2.0
David Chinnerfe4fa4b2008-10-30 17:06:08 +11002/*
3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
David Chinnerfe4fa4b2008-10-30 17:06:08 +11005 */
6#include "xfs.h"
7#include "xfs_fs.h"
Darrick J. Wong5467b342019-06-28 19:25:35 -07008#include "xfs_shared.h"
Dave Chinner6ca1c902013-08-12 20:49:26 +10009#include "xfs_format.h"
Dave Chinner239880e2013-10-23 10:50:10 +110010#include "xfs_log_format.h"
11#include "xfs_trans_resv.h"
David Chinnerfe4fa4b2008-10-30 17:06:08 +110012#include "xfs_mount.h"
David Chinnerfe4fa4b2008-10-30 17:06:08 +110013#include "xfs_inode.h"
Dave Chinner239880e2013-10-23 10:50:10 +110014#include "xfs_trans.h"
15#include "xfs_trans_priv.h"
David Chinnerfe4fa4b2008-10-30 17:06:08 +110016#include "xfs_inode_item.h"
Christoph Hellwig7d095252009-06-08 15:33:32 +020017#include "xfs_quota.h"
Christoph Hellwig0b1b2132009-12-14 23:14:59 +000018#include "xfs_trace.h"
Dave Chinner6d8b79c2012-10-08 21:56:09 +110019#include "xfs_icache.h"
Dave Chinnerc24b5df2013-08-12 20:49:45 +100020#include "xfs_bmap_util.h"
Brian Fosterdc06f3982014-07-24 19:49:28 +100021#include "xfs_dquot_item.h"
22#include "xfs_dquot.h"
Darrick J. Wong83104d42016-10-03 09:11:46 -070023#include "xfs_reflink.h"
Christoph Hellwigbb8a66a2020-05-14 14:01:19 -070024#include "xfs_ialloc.h"
Dave Chinner9bbafc712021-06-02 10:48:24 +100025#include "xfs_ag.h"
Dave Chinner01728b42022-03-17 09:09:13 -070026#include "xfs_log_priv.h"
Darrick J. Wongbaf44fa2024-02-22 12:32:43 -080027#include "xfs_health.h"
David Chinnerfe4fa4b2008-10-30 17:06:08 +110028
Jeff Laytonf0e28282017-12-11 06:35:19 -050029#include <linux/iversion.h>
David Chinnera167b172008-10-30 17:06:18 +110030
Darrick J. Wongc809d7e2021-06-01 13:49:52 -070031/* Radix tree tags for incore inode tree. */
32
33/* inode is to be reclaimed */
34#define XFS_ICI_RECLAIM_TAG 0
35/* Inode has speculative preallocations (posteof or cow) to clean. */
36#define XFS_ICI_BLOCKGC_TAG 1
37
38/*
39 * The goal for walking incore inodes. These can correspond with incore inode
40 * radix tree tags when convenient. Avoid existing XFS_IWALK namespace.
41 */
42enum xfs_icwalk_goal {
Darrick J. Wongc809d7e2021-06-01 13:49:52 -070043 /* Goals directly associated with tagged inodes. */
44 XFS_ICWALK_BLOCKGC = XFS_ICI_BLOCKGC_TAG,
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -070045 XFS_ICWALK_RECLAIM = XFS_ICI_RECLAIM_TAG,
Darrick J. Wongc809d7e2021-06-01 13:49:52 -070046};
47
Darrick J. Wong7fdff522021-05-31 11:31:59 -070048static int xfs_icwalk(struct xfs_mount *mp,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -070049 enum xfs_icwalk_goal goal, struct xfs_icwalk *icw);
Darrick J. Wong7fdff522021-05-31 11:31:59 -070050static int xfs_icwalk_ag(struct xfs_perag *pag,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -070051 enum xfs_icwalk_goal goal, struct xfs_icwalk *icw);
Darrick J. Wongdf600192021-06-01 13:29:41 -070052
Dave Chinner33479e02012-10-08 21:56:11 +110053/*
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -070054 * Private inode cache walk flags for struct xfs_icwalk. Must not
55 * coincide with XFS_ICWALK_FLAGS_VALID.
Darrick J. Wong1ad2cfe2021-05-31 11:31:57 -070056 */
Darrick J. Wong1ad2cfe2021-05-31 11:31:57 -070057
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -070058/* Stop scanning after icw_scan_limit inodes. */
59#define XFS_ICWALK_FLAG_SCAN_LIMIT (1U << 28)
60
Darrick J. Wong94927502021-06-07 09:34:50 -070061#define XFS_ICWALK_FLAG_RECLAIM_SICK (1U << 27)
Darrick J. Wong2d53f66b2021-06-07 09:34:51 -070062#define XFS_ICWALK_FLAG_UNION (1U << 26) /* union filter algorithm */
Darrick J. Wong94927502021-06-07 09:34:50 -070063
Christoph Hellwig777eb1f2021-08-06 11:05:36 -070064#define XFS_ICWALK_PRIVATE_FLAGS (XFS_ICWALK_FLAG_SCAN_LIMIT | \
Darrick J. Wong2d53f66b2021-06-07 09:34:51 -070065 XFS_ICWALK_FLAG_RECLAIM_SICK | \
66 XFS_ICWALK_FLAG_UNION)
Darrick J. Wong1ad2cfe2021-05-31 11:31:57 -070067
Dave Chinner33479e02012-10-08 21:56:11 +110068/*
69 * Allocate and initialise an xfs_inode.
70 */
Dave Chinner638f44162013-08-30 10:23:45 +100071struct xfs_inode *
Dave Chinner33479e02012-10-08 21:56:11 +110072xfs_inode_alloc(
73 struct xfs_mount *mp,
74 xfs_ino_t ino)
75{
76 struct xfs_inode *ip;
77
78 /*
Carlos Maiolino3050bd02020-07-22 09:23:04 -070079 * XXX: If this didn't occur in transactions, we could drop GFP_NOFAIL
80 * and return NULL here on ENOMEM.
Dave Chinner33479e02012-10-08 21:56:11 +110081 */
Muchun Songfd60b282022-03-22 14:41:03 -070082 ip = alloc_inode_sb(mp->m_super, xfs_inode_cache, GFP_KERNEL | __GFP_NOFAIL);
Carlos Maiolino3050bd02020-07-22 09:23:04 -070083
Dave Chinner33479e02012-10-08 21:56:11 +110084 if (inode_init_always(mp->m_super, VFS_I(ip))) {
Darrick J. Wong182696f2021-10-12 11:09:23 -070085 kmem_cache_free(xfs_inode_cache, ip);
Dave Chinner33479e02012-10-08 21:56:11 +110086 return NULL;
87 }
88
Dave Chinnerf38a0322021-08-24 19:13:04 -070089 /* VFS doesn't initialise i_mode or i_state! */
Dave Chinnerc19b3b052016-02-09 16:54:58 +110090 VFS_I(ip)->i_mode = 0;
Dave Chinnerf38a0322021-08-24 19:13:04 -070091 VFS_I(ip)->i_state = 0;
Matthew Wilcox (Oracle)67958012021-05-19 18:38:43 -040092 mapping_set_large_folios(VFS_I(ip)->i_mapping);
Dave Chinnerc19b3b052016-02-09 16:54:58 +110093
Bill O'Donnellff6d6af2015-10-12 18:21:22 +110094 XFS_STATS_INC(mp, vn_active);
Dave Chinner33479e02012-10-08 21:56:11 +110095 ASSERT(atomic_read(&ip->i_pincount) == 0);
Dave Chinner33479e02012-10-08 21:56:11 +110096 ASSERT(ip->i_ino == 0);
97
Dave Chinner33479e02012-10-08 21:56:11 +110098 /* initialise the xfs inode */
99 ip->i_ino = ino;
100 ip->i_mount = mp;
101 memset(&ip->i_imap, 0, sizeof(struct xfs_imap));
Darrick J. Wong3993bae2016-10-03 09:11:32 -0700102 ip->i_cowfp = NULL;
Darrick J. Wong2ed5b092022-07-09 10:56:06 -0700103 memset(&ip->i_af, 0, sizeof(ip->i_af));
104 ip->i_af.if_format = XFS_DINODE_FMT_EXTENTS;
Christoph Hellwig3ba738d2018-07-17 16:51:50 -0700105 memset(&ip->i_df, 0, sizeof(ip->i_df));
Dave Chinner33479e02012-10-08 21:56:11 +1100106 ip->i_flags = 0;
107 ip->i_delayed_blks = 0;
Christoph Hellwig3e09ab82021-03-29 11:11:45 -0700108 ip->i_diflags2 = mp->m_ino_geo.new_diflags2;
Christoph Hellwig6e73a542021-03-29 11:11:40 -0700109 ip->i_nblocks = 0;
Christoph Hellwig7821ea32021-03-29 11:11:44 -0700110 ip->i_forkoff = 0;
Darrick J. Wong6772c1f2019-04-12 07:40:25 -0700111 ip->i_sick = 0;
112 ip->i_checked = 0;
Darrick J. Wongcb357bf2019-04-15 13:13:20 -0700113 INIT_WORK(&ip->i_ioend_work, xfs_end_io);
114 INIT_LIST_HEAD(&ip->i_ioend_list);
115 spin_lock_init(&ip->i_ioend_lock);
Dave Chinner2fd26cc2022-07-14 11:46:43 +1000116 ip->i_next_unlinked = NULLAGINO;
Darrick J. Wongf12b9662023-09-11 08:39:07 -0700117 ip->i_prev_unlinked = 0;
Dave Chinner33479e02012-10-08 21:56:11 +1100118
119 return ip;
120}
121
122STATIC void
123xfs_inode_free_callback(
124 struct rcu_head *head)
125{
126 struct inode *inode = container_of(head, struct inode, i_rcu);
127 struct xfs_inode *ip = XFS_I(inode);
128
Dave Chinnerc19b3b052016-02-09 16:54:58 +1100129 switch (VFS_I(ip)->i_mode & S_IFMT) {
Dave Chinner33479e02012-10-08 21:56:11 +1100130 case S_IFREG:
131 case S_IFDIR:
132 case S_IFLNK:
Christoph Hellwigef838512020-05-18 10:29:27 -0700133 xfs_idestroy_fork(&ip->i_df);
Dave Chinner33479e02012-10-08 21:56:11 +1100134 break;
135 }
136
Darrick J. Wonge45d7cb2022-07-09 10:56:06 -0700137 xfs_ifork_zap_attr(ip);
138
Christoph Hellwigef838512020-05-18 10:29:27 -0700139 if (ip->i_cowfp) {
140 xfs_idestroy_fork(ip->i_cowfp);
Darrick J. Wong182696f2021-10-12 11:09:23 -0700141 kmem_cache_free(xfs_ifork_cache, ip->i_cowfp);
Christoph Hellwigef838512020-05-18 10:29:27 -0700142 }
Dave Chinner33479e02012-10-08 21:56:11 +1100143 if (ip->i_itemp) {
Dave Chinner22525c12018-05-09 07:47:34 -0700144 ASSERT(!test_bit(XFS_LI_IN_AIL,
145 &ip->i_itemp->ili_item.li_flags));
Dave Chinner33479e02012-10-08 21:56:11 +1100146 xfs_inode_item_destroy(ip);
147 ip->i_itemp = NULL;
148 }
149
Darrick J. Wong182696f2021-10-12 11:09:23 -0700150 kmem_cache_free(xfs_inode_cache, ip);
Dave Chinner1f2dcfe2016-05-18 14:01:53 +1000151}
152
Dave Chinner8a17d7d2016-05-18 14:09:12 +1000153static void
154__xfs_inode_free(
155 struct xfs_inode *ip)
156{
157 /* asserts to verify all state is correct here */
158 ASSERT(atomic_read(&ip->i_pincount) == 0);
Dave Chinner48d55e22020-06-29 14:49:18 -0700159 ASSERT(!ip->i_itemp || list_empty(&ip->i_itemp->ili_item.li_bio_list));
Dave Chinner8a17d7d2016-05-18 14:09:12 +1000160 XFS_STATS_DEC(ip->i_mount, vn_active);
161
162 call_rcu(&VFS_I(ip)->i_rcu, xfs_inode_free_callback);
163}
164
Dave Chinner1f2dcfe2016-05-18 14:01:53 +1000165void
166xfs_inode_free(
167 struct xfs_inode *ip)
168{
Dave Chinner718ecc52020-08-17 16:41:01 -0700169 ASSERT(!xfs_iflags_test(ip, XFS_IFLUSHING));
Brian Foster98efe8a2016-11-10 08:23:22 +1100170
Dave Chinner33479e02012-10-08 21:56:11 +1100171 /*
172 * Because we use RCU freeing we need to ensure the inode always
173 * appears to be reclaimed with an invalid inode number when in the
174 * free state. The ip->i_flags_lock provides the barrier against lookup
175 * races.
176 */
177 spin_lock(&ip->i_flags_lock);
178 ip->i_flags = XFS_IRECLAIM;
179 ip->i_ino = 0;
180 spin_unlock(&ip->i_flags_lock);
181
Dave Chinner8a17d7d2016-05-18 14:09:12 +1000182 __xfs_inode_free(ip);
Dave Chinner33479e02012-10-08 21:56:11 +1100183}
184
185/*
Dave Chinner02511a52020-06-29 14:49:18 -0700186 * Queue background inode reclaim work if there are reclaimable inodes and there
187 * isn't reclaim work already scheduled or in progress.
Dave Chinnerad438c42016-05-18 14:20:08 +1000188 */
189static void
190xfs_reclaim_work_queue(
191 struct xfs_mount *mp)
192{
193
194 rcu_read_lock();
195 if (radix_tree_tagged(&mp->m_perag_tree, XFS_ICI_RECLAIM_TAG)) {
196 queue_delayed_work(mp->m_reclaim_workqueue, &mp->m_reclaim_work,
197 msecs_to_jiffies(xfs_syncd_centisecs / 6 * 10));
198 }
199 rcu_read_unlock();
200}
201
Darrick J. Wongc076ae72021-05-31 11:32:02 -0700202/*
203 * Background scanning to trim preallocated space. This is queued based on the
204 * 'speculative_prealloc_lifetime' tunable (5m by default).
205 */
206static inline void
207xfs_blockgc_queue(
Dave Chinnerad438c42016-05-18 14:20:08 +1000208 struct xfs_perag *pag)
209{
Darrick J. Wong6f649092021-08-06 11:05:42 -0700210 struct xfs_mount *mp = pag->pag_mount;
211
212 if (!xfs_is_blockgc_enabled(mp))
213 return;
214
Darrick J. Wongc076ae72021-05-31 11:32:02 -0700215 rcu_read_lock();
216 if (radix_tree_tagged(&pag->pag_ici_root, XFS_ICI_BLOCKGC_TAG))
Dave Chinnerab23a772021-08-06 11:05:39 -0700217 queue_delayed_work(pag->pag_mount->m_blockgc_wq,
Darrick J. Wongc076ae72021-05-31 11:32:02 -0700218 &pag->pag_blockgc_work,
219 msecs_to_jiffies(xfs_blockgc_secs * 1000));
220 rcu_read_unlock();
221}
222
223/* Set a tag on both the AG incore inode tree and the AG radix tree. */
224static void
225xfs_perag_set_inode_tag(
226 struct xfs_perag *pag,
227 xfs_agino_t agino,
228 unsigned int tag)
229{
230 struct xfs_mount *mp = pag->pag_mount;
231 bool was_tagged;
232
233 lockdep_assert_held(&pag->pag_ici_lock);
234
235 was_tagged = radix_tree_tagged(&pag->pag_ici_root, tag);
236 radix_tree_tag_set(&pag->pag_ici_root, agino, tag);
237
238 if (tag == XFS_ICI_RECLAIM_TAG)
239 pag->pag_ici_reclaimable++;
240
241 if (was_tagged)
242 return;
243
244 /* propagate the tag up into the perag radix tree */
245 spin_lock(&mp->m_perag_lock);
246 radix_tree_tag_set(&mp->m_perag_tree, pag->pag_agno, tag);
247 spin_unlock(&mp->m_perag_lock);
248
249 /* start background work */
250 switch (tag) {
251 case XFS_ICI_RECLAIM_TAG:
252 xfs_reclaim_work_queue(mp);
253 break;
254 case XFS_ICI_BLOCKGC_TAG:
255 xfs_blockgc_queue(pag);
256 break;
257 }
258
Dave Chinner368e2d02023-02-13 09:14:52 +1100259 trace_xfs_perag_set_inode_tag(pag, _RET_IP_);
Darrick J. Wongc076ae72021-05-31 11:32:02 -0700260}
261
262/* Clear a tag on both the AG incore inode tree and the AG radix tree. */
263static void
264xfs_perag_clear_inode_tag(
265 struct xfs_perag *pag,
266 xfs_agino_t agino,
267 unsigned int tag)
268{
Dave Chinnerad438c42016-05-18 14:20:08 +1000269 struct xfs_mount *mp = pag->pag_mount;
270
Brian Foster95989c42017-06-08 08:23:07 -0700271 lockdep_assert_held(&pag->pag_ici_lock);
Darrick J. Wongc076ae72021-05-31 11:32:02 -0700272
273 /*
274 * Reclaim can signal (with a null agino) that it cleared its own tag
275 * by removing the inode from the radix tree.
276 */
277 if (agino != NULLAGINO)
278 radix_tree_tag_clear(&pag->pag_ici_root, agino, tag);
279 else
280 ASSERT(tag == XFS_ICI_RECLAIM_TAG);
281
282 if (tag == XFS_ICI_RECLAIM_TAG)
283 pag->pag_ici_reclaimable--;
284
285 if (radix_tree_tagged(&pag->pag_ici_root, tag))
Dave Chinnerad438c42016-05-18 14:20:08 +1000286 return;
287
Darrick J. Wongc076ae72021-05-31 11:32:02 -0700288 /* clear the tag from the perag radix tree */
Dave Chinnerad438c42016-05-18 14:20:08 +1000289 spin_lock(&mp->m_perag_lock);
Darrick J. Wongc076ae72021-05-31 11:32:02 -0700290 radix_tree_tag_clear(&mp->m_perag_tree, pag->pag_agno, tag);
Dave Chinnerad438c42016-05-18 14:20:08 +1000291 spin_unlock(&mp->m_perag_lock);
292
Dave Chinner368e2d02023-02-13 09:14:52 +1100293 trace_xfs_perag_clear_inode_tag(pag, _RET_IP_);
Dave Chinnerad438c42016-05-18 14:20:08 +1000294}
295
Dave Chinnerad438c42016-05-18 14:20:08 +1000296/*
Dave Chinner50997472016-02-09 16:54:58 +1100297 * When we recycle a reclaimable inode, we need to re-initialise the VFS inode
298 * part of the structure. This is made more complex by the fact we store
299 * information about the on-disk values in the VFS inode and so we can't just
Dave Chinner83e06f22016-02-09 16:54:58 +1100300 * overwrite the values unconditionally. Hence we save the parameters we
Dave Chinner50997472016-02-09 16:54:58 +1100301 * need to retain across reinitialisation, and rewrite them into the VFS inode
Dave Chinner83e06f22016-02-09 16:54:58 +1100302 * after reinitialisation even if it fails.
Dave Chinner50997472016-02-09 16:54:58 +1100303 */
304static int
305xfs_reinit_inode(
306 struct xfs_mount *mp,
307 struct inode *inode)
308{
Darrick J. Wongff7bebe2021-06-18 11:57:05 -0700309 int error;
310 uint32_t nlink = inode->i_nlink;
311 uint32_t generation = inode->i_generation;
312 uint64_t version = inode_peek_iversion(inode);
313 umode_t mode = inode->i_mode;
314 dev_t dev = inode->i_rdev;
315 kuid_t uid = inode->i_uid;
316 kgid_t gid = inode->i_gid;
Dave Chinner50997472016-02-09 16:54:58 +1100317
318 error = inode_init_always(mp->m_super, inode);
319
Dave Chinner54d7b5c2016-02-09 16:54:58 +1100320 set_nlink(inode, nlink);
Dave Chinner9e9a2672016-02-09 16:54:58 +1100321 inode->i_generation = generation;
Jeff Laytonf0e28282017-12-11 06:35:19 -0500322 inode_set_iversion_queried(inode, version);
Dave Chinnerc19b3b052016-02-09 16:54:58 +1100323 inode->i_mode = mode;
Amir Goldsteinacd1d712018-01-26 11:24:40 -0800324 inode->i_rdev = dev;
Christoph Hellwig3d8f2822020-02-21 08:31:26 -0800325 inode->i_uid = uid;
326 inode->i_gid = gid;
Matthew Wilcox (Oracle)67958012021-05-19 18:38:43 -0400327 mapping_set_large_folios(inode->i_mapping);
Dave Chinner50997472016-02-09 16:54:58 +1100328 return error;
329}
330
331/*
Darrick J. Wongff7bebe2021-06-18 11:57:05 -0700332 * Carefully nudge an inode whose VFS state has been torn down back into a
333 * usable state. Drops the i_flags_lock and the rcu read lock.
334 */
335static int
336xfs_iget_recycle(
337 struct xfs_perag *pag,
338 struct xfs_inode *ip) __releases(&ip->i_flags_lock)
339{
340 struct xfs_mount *mp = ip->i_mount;
341 struct inode *inode = VFS_I(ip);
342 int error;
343
344 trace_xfs_iget_recycle(ip);
345
Long Li28b4b052022-11-17 13:02:56 -0800346 if (!xfs_ilock_nowait(ip, XFS_ILOCK_EXCL))
347 return -EAGAIN;
348
Darrick J. Wongff7bebe2021-06-18 11:57:05 -0700349 /*
350 * We need to make it look like the inode is being reclaimed to prevent
351 * the actual reclaim workers from stomping over us while we recycle
352 * the inode. We can't clear the radix tree tag yet as it requires
353 * pag_ici_lock to be held exclusive.
354 */
355 ip->i_flags |= XFS_IRECLAIM;
356
357 spin_unlock(&ip->i_flags_lock);
358 rcu_read_unlock();
359
360 ASSERT(!rwsem_is_locked(&inode->i_rwsem));
361 error = xfs_reinit_inode(mp, inode);
Long Li28b4b052022-11-17 13:02:56 -0800362 xfs_iunlock(ip, XFS_ILOCK_EXCL);
Darrick J. Wongff7bebe2021-06-18 11:57:05 -0700363 if (error) {
Darrick J. Wongff7bebe2021-06-18 11:57:05 -0700364 /*
365 * Re-initializing the inode failed, and we are in deep
366 * trouble. Try to re-add it to the reclaim list.
367 */
368 rcu_read_lock();
369 spin_lock(&ip->i_flags_lock);
Darrick J. Wongff7bebe2021-06-18 11:57:05 -0700370 ip->i_flags &= ~(XFS_INEW | XFS_IRECLAIM);
Darrick J. Wongff7bebe2021-06-18 11:57:05 -0700371 ASSERT(ip->i_flags & XFS_IRECLAIMABLE);
372 spin_unlock(&ip->i_flags_lock);
373 rcu_read_unlock();
374
375 trace_xfs_iget_recycle_fail(ip);
376 return error;
377 }
378
379 spin_lock(&pag->pag_ici_lock);
380 spin_lock(&ip->i_flags_lock);
381
382 /*
383 * Clear the per-lifetime state in the inode as we are now effectively
384 * a new inode and need to return to the initial state before reuse
385 * occurs.
386 */
387 ip->i_flags &= ~XFS_IRECLAIM_RESET_FLAGS;
388 ip->i_flags |= XFS_INEW;
389 xfs_perag_clear_inode_tag(pag, XFS_INO_TO_AGINO(mp, ip->i_ino),
390 XFS_ICI_RECLAIM_TAG);
391 inode->i_state = I_NEW;
392 spin_unlock(&ip->i_flags_lock);
393 spin_unlock(&pag->pag_ici_lock);
394
395 return 0;
396}
397
398/*
Dave Chinnerafca6c52018-04-17 17:17:34 -0700399 * If we are allocating a new inode, then check what was returned is
400 * actually a free, empty inode. If we are not allocating an inode,
401 * then check we didn't find a free inode.
402 *
403 * Returns:
404 * 0 if the inode free state matches the lookup context
405 * -ENOENT if the inode is free and we are not allocating
406 * -EFSCORRUPTED if there is any state mismatch at all
407 */
408static int
409xfs_iget_check_free_state(
410 struct xfs_inode *ip,
411 int flags)
412{
413 if (flags & XFS_IGET_CREATE) {
414 /* should be a free inode */
415 if (VFS_I(ip)->i_mode != 0) {
416 xfs_warn(ip->i_mount,
417"Corruption detected! Free inode 0x%llx not marked free! (mode 0x%x)",
418 ip->i_ino, VFS_I(ip)->i_mode);
Darrick J. Wongbaf44fa2024-02-22 12:32:43 -0800419 xfs_agno_mark_sick(ip->i_mount,
420 XFS_INO_TO_AGNO(ip->i_mount, ip->i_ino),
421 XFS_SICK_AG_INOBT);
Dave Chinnerafca6c52018-04-17 17:17:34 -0700422 return -EFSCORRUPTED;
423 }
424
Christoph Hellwig6e73a542021-03-29 11:11:40 -0700425 if (ip->i_nblocks != 0) {
Dave Chinnerafca6c52018-04-17 17:17:34 -0700426 xfs_warn(ip->i_mount,
427"Corruption detected! Free inode 0x%llx has blocks allocated!",
428 ip->i_ino);
Darrick J. Wongbaf44fa2024-02-22 12:32:43 -0800429 xfs_agno_mark_sick(ip->i_mount,
430 XFS_INO_TO_AGNO(ip->i_mount, ip->i_ino),
431 XFS_SICK_AG_INOBT);
Dave Chinnerafca6c52018-04-17 17:17:34 -0700432 return -EFSCORRUPTED;
433 }
434 return 0;
435 }
436
437 /* should be an allocated inode */
438 if (VFS_I(ip)->i_mode == 0)
439 return -ENOENT;
440
441 return 0;
442}
443
Dave Chinnerab23a772021-08-06 11:05:39 -0700444/* Make all pending inactivation work start immediately. */
Darrick J. Wong2254a732023-05-02 09:16:14 +1000445static bool
Dave Chinnerab23a772021-08-06 11:05:39 -0700446xfs_inodegc_queue_all(
447 struct xfs_mount *mp)
448{
449 struct xfs_inodegc *gc;
450 int cpu;
Darrick J. Wong2254a732023-05-02 09:16:14 +1000451 bool ret = false;
Dave Chinnerab23a772021-08-06 11:05:39 -0700452
Darrick J. Wong62334fa2023-09-11 08:39:03 -0700453 for_each_cpu(cpu, &mp->m_inodegc_cpumask) {
Dave Chinnerab23a772021-08-06 11:05:39 -0700454 gc = per_cpu_ptr(mp->m_inodegc, cpu);
Darrick J. Wong2254a732023-05-02 09:16:14 +1000455 if (!llist_empty(&gc->list)) {
Dave Chinner7cf2b0f2022-06-16 07:44:31 -0700456 mod_delayed_work_on(cpu, mp->m_inodegc_wq, &gc->work, 0);
Darrick J. Wong2254a732023-05-02 09:16:14 +1000457 ret = true;
458 }
Dave Chinnerab23a772021-08-06 11:05:39 -0700459 }
Darrick J. Wong2254a732023-05-02 09:16:14 +1000460
461 return ret;
Dave Chinnerab23a772021-08-06 11:05:39 -0700462}
463
Dave Chinnerd4d12c02023-06-05 14:48:15 +1000464/* Wait for all queued work and collect errors */
465static int
466xfs_inodegc_wait_all(
467 struct xfs_mount *mp)
468{
469 int cpu;
470 int error = 0;
471
472 flush_workqueue(mp->m_inodegc_wq);
Darrick J. Wong62334fa2023-09-11 08:39:03 -0700473 for_each_cpu(cpu, &mp->m_inodegc_cpumask) {
Dave Chinnerd4d12c02023-06-05 14:48:15 +1000474 struct xfs_inodegc *gc;
475
476 gc = per_cpu_ptr(mp->m_inodegc, cpu);
477 if (gc->error && !error)
478 error = gc->error;
479 gc->error = 0;
480 }
481
482 return error;
483}
484
Dave Chinnerafca6c52018-04-17 17:17:34 -0700485/*
Dave Chinner33479e02012-10-08 21:56:11 +1100486 * Check the validity of the inode we just found it the cache
487 */
488static int
489xfs_iget_cache_hit(
490 struct xfs_perag *pag,
491 struct xfs_inode *ip,
492 xfs_ino_t ino,
493 int flags,
494 int lock_flags) __releases(RCU)
495{
496 struct inode *inode = VFS_I(ip);
497 struct xfs_mount *mp = ip->i_mount;
498 int error;
499
500 /*
501 * check for re-use of an inode within an RCU grace period due to the
502 * radix tree nodes not being updated yet. We monitor for this by
503 * setting the inode number to zero before freeing the inode structure.
504 * If the inode has been reallocated and set up, then the inode number
505 * will not match, so check for that, too.
506 */
507 spin_lock(&ip->i_flags_lock);
Darrick J. Wong77b4d282021-06-18 11:57:06 -0700508 if (ip->i_ino != ino)
509 goto out_skip;
Dave Chinner33479e02012-10-08 21:56:11 +1100510
511 /*
512 * If we are racing with another cache hit that is currently
513 * instantiating this inode or currently recycling it out of
Darrick J. Wongff7bebe2021-06-18 11:57:05 -0700514 * reclaimable state, wait for the initialisation to complete
Dave Chinner33479e02012-10-08 21:56:11 +1100515 * before continuing.
516 *
Dave Chinnerab23a772021-08-06 11:05:39 -0700517 * If we're racing with the inactivation worker we also want to wait.
518 * If we're creating a new file, it's possible that the worker
519 * previously marked the inode as free on disk but hasn't finished
520 * updating the incore state yet. The AGI buffer will be dirty and
521 * locked to the icreate transaction, so a synchronous push of the
522 * inodegc workers would result in deadlock. For a regular iget, the
523 * worker is running already, so we might as well wait.
524 *
Dave Chinner33479e02012-10-08 21:56:11 +1100525 * XXX(hch): eventually we should do something equivalent to
526 * wait_on_inode to wait for these flags to be cleared
527 * instead of polling for it.
528 */
Dave Chinnerab23a772021-08-06 11:05:39 -0700529 if (ip->i_flags & (XFS_INEW | XFS_IRECLAIM | XFS_INACTIVATING))
Darrick J. Wong77b4d282021-06-18 11:57:06 -0700530 goto out_skip;
Dave Chinner33479e02012-10-08 21:56:11 +1100531
Dave Chinnerab23a772021-08-06 11:05:39 -0700532 if (ip->i_flags & XFS_NEED_INACTIVE) {
533 /* Unlinked inodes cannot be re-grabbed. */
534 if (VFS_I(ip)->i_nlink == 0) {
535 error = -ENOENT;
536 goto out_error;
537 }
538 goto out_inodegc_flush;
539 }
540
Dave Chinner33479e02012-10-08 21:56:11 +1100541 /*
Dave Chinnerafca6c52018-04-17 17:17:34 -0700542 * Check the inode free state is valid. This also detects lookup
543 * racing with unlinks.
Dave Chinner33479e02012-10-08 21:56:11 +1100544 */
Dave Chinnerafca6c52018-04-17 17:17:34 -0700545 error = xfs_iget_check_free_state(ip, flags);
546 if (error)
Dave Chinner33479e02012-10-08 21:56:11 +1100547 goto out_error;
Dave Chinner33479e02012-10-08 21:56:11 +1100548
Darrick J. Wong77b4d282021-06-18 11:57:06 -0700549 /* Skip inodes that have no vfs state. */
550 if ((flags & XFS_IGET_INCORE) &&
551 (ip->i_flags & XFS_IRECLAIMABLE))
552 goto out_skip;
Darrick J. Wong378f6812017-06-19 08:58:56 -0700553
Darrick J. Wong77b4d282021-06-18 11:57:06 -0700554 /* The inode fits the selection criteria; process it. */
555 if (ip->i_flags & XFS_IRECLAIMABLE) {
Darrick J. Wongff7bebe2021-06-18 11:57:05 -0700556 /* Drops i_flags_lock and RCU read lock. */
557 error = xfs_iget_recycle(pag, ip);
Long Li28b4b052022-11-17 13:02:56 -0800558 if (error == -EAGAIN)
559 goto out_skip;
Darrick J. Wongff7bebe2021-06-18 11:57:05 -0700560 if (error)
561 return error;
Dave Chinner33479e02012-10-08 21:56:11 +1100562 } else {
563 /* If the VFS inode is being torn down, pause and try again. */
Darrick J. Wong77b4d282021-06-18 11:57:06 -0700564 if (!igrab(inode))
565 goto out_skip;
Dave Chinner33479e02012-10-08 21:56:11 +1100566
567 /* We've got a live one. */
568 spin_unlock(&ip->i_flags_lock);
569 rcu_read_unlock();
570 trace_xfs_iget_hit(ip);
571 }
572
573 if (lock_flags != 0)
574 xfs_ilock(ip, lock_flags);
575
Darrick J. Wong378f6812017-06-19 08:58:56 -0700576 if (!(flags & XFS_IGET_INCORE))
Ira Weinydae2f8e2020-04-30 07:41:37 -0700577 xfs_iflags_clear(ip, XFS_ISTALE);
Bill O'Donnellff6d6af2015-10-12 18:21:22 +1100578 XFS_STATS_INC(mp, xs_ig_found);
Dave Chinner33479e02012-10-08 21:56:11 +1100579
580 return 0;
581
Darrick J. Wong77b4d282021-06-18 11:57:06 -0700582out_skip:
583 trace_xfs_iget_skip(ip);
584 XFS_STATS_INC(mp, xs_ig_frecycle);
585 error = -EAGAIN;
Dave Chinner33479e02012-10-08 21:56:11 +1100586out_error:
587 spin_unlock(&ip->i_flags_lock);
588 rcu_read_unlock();
589 return error;
Dave Chinnerab23a772021-08-06 11:05:39 -0700590
591out_inodegc_flush:
592 spin_unlock(&ip->i_flags_lock);
593 rcu_read_unlock();
594 /*
595 * Do not wait for the workers, because the caller could hold an AGI
596 * buffer lock. We're just going to sleep in a loop anyway.
597 */
598 if (xfs_is_inodegc_enabled(mp))
599 xfs_inodegc_queue_all(mp);
600 return -EAGAIN;
Dave Chinner33479e02012-10-08 21:56:11 +1100601}
602
Dave Chinner33479e02012-10-08 21:56:11 +1100603static int
604xfs_iget_cache_miss(
605 struct xfs_mount *mp,
606 struct xfs_perag *pag,
607 xfs_trans_t *tp,
608 xfs_ino_t ino,
609 struct xfs_inode **ipp,
610 int flags,
611 int lock_flags)
612{
613 struct xfs_inode *ip;
614 int error;
615 xfs_agino_t agino = XFS_INO_TO_AGINO(mp, ino);
616 int iflags;
617
618 ip = xfs_inode_alloc(mp, ino);
619 if (!ip)
Dave Chinner24513372014-06-25 14:58:08 +1000620 return -ENOMEM;
Dave Chinner33479e02012-10-08 21:56:11 +1100621
Dave Chinner498f0ad2023-02-13 09:14:52 +1100622 error = xfs_imap(pag, tp, ip->i_ino, &ip->i_imap, flags);
Dave Chinner33479e02012-10-08 21:56:11 +1100623 if (error)
624 goto out_destroy;
625
Christoph Hellwigbb8a66a2020-05-14 14:01:19 -0700626 /*
627 * For version 5 superblocks, if we are initialising a new inode and we
Dave Chinner0560f312021-08-18 18:46:52 -0700628 * are not utilising the XFS_FEAT_IKEEP inode cluster mode, we can
Christoph Hellwigbb8a66a2020-05-14 14:01:19 -0700629 * simply build the new inode core with a random generation number.
630 *
631 * For version 4 (and older) superblocks, log recovery is dependent on
Christoph Hellwig965e0a12021-03-29 11:11:42 -0700632 * the i_flushiter field being initialised from the current on-disk
Christoph Hellwigbb8a66a2020-05-14 14:01:19 -0700633 * value and hence we must also read the inode off disk even when
634 * initializing new inodes.
635 */
Dave Chinner38c26bf2021-08-18 18:46:37 -0700636 if (xfs_has_v3inodes(mp) &&
Dave Chinner0560f312021-08-18 18:46:52 -0700637 (flags & XFS_IGET_CREATE) && !xfs_has_ikeep(mp)) {
Jason A. Donenfelda251c172022-10-05 17:43:22 +0200638 VFS_I(ip)->i_generation = get_random_u32();
Christoph Hellwigbb8a66a2020-05-14 14:01:19 -0700639 } else {
Christoph Hellwigbb8a66a2020-05-14 14:01:19 -0700640 struct xfs_buf *bp;
641
Christoph Hellwigaf9dcdd2021-03-29 11:11:37 -0700642 error = xfs_imap_to_bp(mp, tp, &ip->i_imap, &bp);
Christoph Hellwigbb8a66a2020-05-14 14:01:19 -0700643 if (error)
644 goto out_destroy;
645
Christoph Hellwigaf9dcdd2021-03-29 11:11:37 -0700646 error = xfs_inode_from_disk(ip,
647 xfs_buf_offset(bp, ip->i_imap.im_boffset));
Christoph Hellwigbb8a66a2020-05-14 14:01:19 -0700648 if (!error)
649 xfs_buf_set_ref(bp, XFS_INO_REF);
Darrick J. Wongbaf44fa2024-02-22 12:32:43 -0800650 else
651 xfs_inode_mark_sick(ip, XFS_SICK_INO_CORE);
Christoph Hellwigbb8a66a2020-05-14 14:01:19 -0700652 xfs_trans_brelse(tp, bp);
653
654 if (error)
655 goto out_destroy;
656 }
657
Dave Chinner33479e02012-10-08 21:56:11 +1100658 trace_xfs_iget_miss(ip);
659
Dave Chinneree457002018-03-23 10:22:53 -0700660 /*
Dave Chinnerafca6c52018-04-17 17:17:34 -0700661 * Check the inode free state is valid. This also detects lookup
662 * racing with unlinks.
Dave Chinneree457002018-03-23 10:22:53 -0700663 */
Dave Chinnerafca6c52018-04-17 17:17:34 -0700664 error = xfs_iget_check_free_state(ip, flags);
665 if (error)
Dave Chinner33479e02012-10-08 21:56:11 +1100666 goto out_destroy;
Dave Chinner33479e02012-10-08 21:56:11 +1100667
668 /*
669 * Preload the radix tree so we can insert safely under the
670 * write spinlock. Note that we cannot sleep inside the preload
Dave Chinner94a69db2024-01-16 09:59:45 +1100671 * region.
Dave Chinner33479e02012-10-08 21:56:11 +1100672 */
Dave Chinner94a69db2024-01-16 09:59:45 +1100673 if (radix_tree_preload(GFP_KERNEL | __GFP_NOLOCKDEP)) {
Dave Chinner24513372014-06-25 14:58:08 +1000674 error = -EAGAIN;
Dave Chinner33479e02012-10-08 21:56:11 +1100675 goto out_destroy;
676 }
677
678 /*
679 * Because the inode hasn't been added to the radix-tree yet it can't
680 * be found by another thread, so we can do the non-sleeping lock here.
681 */
682 if (lock_flags) {
683 if (!xfs_ilock_nowait(ip, lock_flags))
684 BUG();
685 }
686
687 /*
688 * These values must be set before inserting the inode into the radix
689 * tree as the moment it is inserted a concurrent lookup (allowed by the
690 * RCU locking mechanism) can find it and that lookup must see that this
691 * is an inode currently under construction (i.e. that XFS_INEW is set).
692 * The ip->i_flags_lock that protects the XFS_INEW flag forms the
693 * memory barrier that ensures this detection works correctly at lookup
694 * time.
695 */
696 iflags = XFS_INEW;
697 if (flags & XFS_IGET_DONTCACHE)
Ira Weiny2c567af2020-04-30 07:41:37 -0700698 d_mark_dontcache(VFS_I(ip));
Chandra Seetharaman113a5682013-06-27 17:25:07 -0500699 ip->i_udquot = NULL;
700 ip->i_gdquot = NULL;
Chandra Seetharaman92f8ff72013-07-11 00:00:40 -0500701 ip->i_pdquot = NULL;
Dave Chinner33479e02012-10-08 21:56:11 +1100702 xfs_iflags_set(ip, iflags);
703
704 /* insert the new inode */
705 spin_lock(&pag->pag_ici_lock);
706 error = radix_tree_insert(&pag->pag_ici_root, agino, ip);
707 if (unlikely(error)) {
708 WARN_ON(error != -EEXIST);
Bill O'Donnellff6d6af2015-10-12 18:21:22 +1100709 XFS_STATS_INC(mp, xs_ig_dup);
Dave Chinner24513372014-06-25 14:58:08 +1000710 error = -EAGAIN;
Dave Chinner33479e02012-10-08 21:56:11 +1100711 goto out_preload_end;
712 }
713 spin_unlock(&pag->pag_ici_lock);
714 radix_tree_preload_end();
715
716 *ipp = ip;
717 return 0;
718
719out_preload_end:
720 spin_unlock(&pag->pag_ici_lock);
721 radix_tree_preload_end();
722 if (lock_flags)
723 xfs_iunlock(ip, lock_flags);
724out_destroy:
725 __destroy_inode(VFS_I(ip));
726 xfs_inode_free(ip);
727 return error;
728}
729
730/*
Dave Chinner02511a52020-06-29 14:49:18 -0700731 * Look up an inode by number in the given file system. The inode is looked up
732 * in the cache held in each AG. If the inode is found in the cache, initialise
733 * the vfs inode if necessary.
Dave Chinner33479e02012-10-08 21:56:11 +1100734 *
Dave Chinner02511a52020-06-29 14:49:18 -0700735 * If it is not in core, read it in from the file system's device, add it to the
736 * cache and initialise the vfs inode.
Dave Chinner33479e02012-10-08 21:56:11 +1100737 *
738 * The inode is locked according to the value of the lock_flags parameter.
Dave Chinner02511a52020-06-29 14:49:18 -0700739 * Inode lookup is only done during metadata operations and not as part of the
740 * data IO path. Hence we only allow locking of the XFS_ILOCK during lookup.
Dave Chinner33479e02012-10-08 21:56:11 +1100741 */
742int
743xfs_iget(
Dave Chinner02511a52020-06-29 14:49:18 -0700744 struct xfs_mount *mp,
745 struct xfs_trans *tp,
746 xfs_ino_t ino,
747 uint flags,
748 uint lock_flags,
749 struct xfs_inode **ipp)
Dave Chinner33479e02012-10-08 21:56:11 +1100750{
Dave Chinner02511a52020-06-29 14:49:18 -0700751 struct xfs_inode *ip;
752 struct xfs_perag *pag;
753 xfs_agino_t agino;
754 int error;
Dave Chinner33479e02012-10-08 21:56:11 +1100755
Dave Chinner33479e02012-10-08 21:56:11 +1100756 ASSERT((lock_flags & (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED)) == 0);
757
758 /* reject inode numbers outside existing AGs */
759 if (!ino || XFS_INO_TO_AGNO(mp, ino) >= mp->m_sb.sb_agcount)
Dave Chinner24513372014-06-25 14:58:08 +1000760 return -EINVAL;
Dave Chinner33479e02012-10-08 21:56:11 +1100761
Bill O'Donnellff6d6af2015-10-12 18:21:22 +1100762 XFS_STATS_INC(mp, xs_ig_attempts);
Lucas Stach8774cf82015-08-28 14:50:56 +1000763
Dave Chinner33479e02012-10-08 21:56:11 +1100764 /* get the perag structure and ensure that it's inode capable */
765 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ino));
766 agino = XFS_INO_TO_AGINO(mp, ino);
767
768again:
769 error = 0;
770 rcu_read_lock();
771 ip = radix_tree_lookup(&pag->pag_ici_root, agino);
772
773 if (ip) {
774 error = xfs_iget_cache_hit(pag, ip, ino, flags, lock_flags);
775 if (error)
776 goto out_error_or_again;
777 } else {
778 rcu_read_unlock();
Darrick J. Wong378f6812017-06-19 08:58:56 -0700779 if (flags & XFS_IGET_INCORE) {
Darrick J. Wonged438b42017-10-17 21:37:32 -0700780 error = -ENODATA;
Darrick J. Wong378f6812017-06-19 08:58:56 -0700781 goto out_error_or_again;
782 }
Bill O'Donnellff6d6af2015-10-12 18:21:22 +1100783 XFS_STATS_INC(mp, xs_ig_missed);
Dave Chinner33479e02012-10-08 21:56:11 +1100784
785 error = xfs_iget_cache_miss(mp, pag, tp, ino, &ip,
786 flags, lock_flags);
787 if (error)
788 goto out_error_or_again;
789 }
790 xfs_perag_put(pag);
791
792 *ipp = ip;
793
794 /*
Dave Chinner58c90472015-02-23 22:38:08 +1100795 * If we have a real type for an on-disk inode, we can setup the inode
Yang Xu132c4602021-12-21 09:38:19 -0800796 * now. If it's a new inode being created, xfs_init_new_inode will
797 * handle it.
Dave Chinner33479e02012-10-08 21:56:11 +1100798 */
Dave Chinnerc19b3b052016-02-09 16:54:58 +1100799 if (xfs_iflags_test(ip, XFS_INEW) && VFS_I(ip)->i_mode != 0)
Dave Chinner58c90472015-02-23 22:38:08 +1100800 xfs_setup_existing_inode(ip);
Dave Chinner33479e02012-10-08 21:56:11 +1100801 return 0;
802
803out_error_or_again:
Darrick J. Wong302436c2023-04-11 19:00:21 -0700804 if (!(flags & (XFS_IGET_INCORE | XFS_IGET_NORETRY)) &&
805 error == -EAGAIN) {
Dave Chinner33479e02012-10-08 21:56:11 +1100806 delay(1);
807 goto again;
808 }
809 xfs_perag_put(pag);
810 return error;
811}
812
Dave Chinner78ae5252010-09-28 12:28:19 +1000813/*
Dave Chinnere3a20c02010-09-24 19:51:50 +1000814 * Grab the inode for reclaim exclusively.
Dave Chinner50718b82020-07-01 10:21:05 -0700815 *
816 * We have found this inode via a lookup under RCU, so the inode may have
817 * already been freed, or it may be in the process of being recycled by
818 * xfs_iget(). In both cases, the inode will have XFS_IRECLAIM set. If the inode
819 * has been fully recycled by the time we get the i_flags_lock, XFS_IRECLAIMABLE
820 * will not be set. Hence we need to check for both these flag conditions to
821 * avoid inodes that are no longer reclaim candidates.
822 *
823 * Note: checking for other state flags here, under the i_flags_lock or not, is
824 * racy and should be avoided. Those races should be resolved only after we have
825 * ensured that we are able to reclaim this inode and the world can see that we
826 * are going to reclaim it.
827 *
828 * Return true if we grabbed it, false otherwise.
Dave Chinnere3a20c02010-09-24 19:51:50 +1000829 */
Dave Chinner50718b82020-07-01 10:21:05 -0700830static bool
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -0700831xfs_reclaim_igrab(
Darrick J. Wong94927502021-06-07 09:34:50 -0700832 struct xfs_inode *ip,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -0700833 struct xfs_icwalk *icw)
Dave Chinnere3a20c02010-09-24 19:51:50 +1000834{
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100835 ASSERT(rcu_read_lock_held());
836
Dave Chinnere3a20c02010-09-24 19:51:50 +1000837 spin_lock(&ip->i_flags_lock);
Dave Chinner1a3e8f32010-12-17 17:29:43 +1100838 if (!__xfs_iflags_test(ip, XFS_IRECLAIMABLE) ||
839 __xfs_iflags_test(ip, XFS_IRECLAIM)) {
840 /* not a reclaim candidate. */
Dave Chinnere3a20c02010-09-24 19:51:50 +1000841 spin_unlock(&ip->i_flags_lock);
Dave Chinner50718b82020-07-01 10:21:05 -0700842 return false;
Dave Chinnere3a20c02010-09-24 19:51:50 +1000843 }
Darrick J. Wong94927502021-06-07 09:34:50 -0700844
845 /* Don't reclaim a sick inode unless the caller asked for it. */
846 if (ip->i_sick &&
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -0700847 (!icw || !(icw->icw_flags & XFS_ICWALK_FLAG_RECLAIM_SICK))) {
Darrick J. Wong94927502021-06-07 09:34:50 -0700848 spin_unlock(&ip->i_flags_lock);
849 return false;
850 }
851
Dave Chinnere3a20c02010-09-24 19:51:50 +1000852 __xfs_iflags_set(ip, XFS_IRECLAIM);
853 spin_unlock(&ip->i_flags_lock);
Dave Chinner50718b82020-07-01 10:21:05 -0700854 return true;
Dave Chinnere3a20c02010-09-24 19:51:50 +1000855}
856
857/*
Dave Chinner02511a52020-06-29 14:49:18 -0700858 * Inode reclaim is non-blocking, so the default action if progress cannot be
859 * made is to "requeue" the inode for reclaim by unlocking it and clearing the
860 * XFS_IRECLAIM flag. If we are in a shutdown state, we don't care about
861 * blocking anymore and hence we can wait for the inode to be able to reclaim
862 * it.
Dave Chinner777df5a2010-02-06 12:37:26 +1100863 *
Dave Chinner02511a52020-06-29 14:49:18 -0700864 * We do no IO here - if callers require inodes to be cleaned they must push the
865 * AIL first to trigger writeback of dirty inodes. This enables writeback to be
866 * done in the background in a non-blocking manner, and enables memory reclaim
867 * to make progress without blocking.
Dave Chinner777df5a2010-02-06 12:37:26 +1100868 */
Dave Chinner4d0bab32020-07-01 10:21:28 -0700869static void
Dave Chinnerc8e20be2010-01-10 23:51:45 +0000870xfs_reclaim_inode(
Dave Chinner75f3cb12009-06-08 15:35:14 +0200871 struct xfs_inode *ip,
Dave Chinner50718b82020-07-01 10:21:05 -0700872 struct xfs_perag *pag)
David Chinner7a3be022008-10-30 17:37:37 +1100873{
Dave Chinner8a17d7d2016-05-18 14:09:12 +1000874 xfs_ino_t ino = ip->i_ino; /* for radix_tree_delete */
Dave Chinner777df5a2010-02-06 12:37:26 +1100875
Dave Chinner9552e142020-06-29 14:49:17 -0700876 if (!xfs_ilock_nowait(ip, XFS_ILOCK_EXCL))
Dave Chinner617825f2020-06-29 14:49:16 -0700877 goto out;
Dave Chinner718ecc52020-08-17 16:41:01 -0700878 if (xfs_iflags_test_and_set(ip, XFS_IFLUSHING))
Dave Chinner9552e142020-06-29 14:49:17 -0700879 goto out_iunlock;
Dave Chinnerc8e20be2010-01-10 23:51:45 +0000880
Dave Chinner01728b42022-03-17 09:09:13 -0700881 /*
882 * Check for log shutdown because aborting the inode can move the log
883 * tail and corrupt in memory state. This is fine if the log is shut
884 * down, but if the log is still active and only the mount is shut down
885 * then the in-memory log tail movement caused by the abort can be
886 * incorrectly propagated to disk.
887 */
888 if (xlog_is_shutdown(ip->i_mount->m_log)) {
Dave Chinner777df5a2010-02-06 12:37:26 +1100889 xfs_iunpin_wait(ip);
Dave Chinnerd2d7c042022-03-29 18:21:59 -0700890 xfs_iflush_shutdown_abort(ip);
Dave Chinner777df5a2010-02-06 12:37:26 +1100891 goto reclaim;
892 }
Dave Chinner617825f2020-06-29 14:49:16 -0700893 if (xfs_ipincount(ip))
Dave Chinner718ecc52020-08-17 16:41:01 -0700894 goto out_clear_flush;
Dave Chinner617825f2020-06-29 14:49:16 -0700895 if (!xfs_inode_clean(ip))
Dave Chinner718ecc52020-08-17 16:41:01 -0700896 goto out_clear_flush;
Christoph Hellwig8a480882012-04-23 15:58:35 +1000897
Dave Chinner718ecc52020-08-17 16:41:01 -0700898 xfs_iflags_clear(ip, XFS_IFLUSHING);
Dave Chinner777df5a2010-02-06 12:37:26 +1100899reclaim:
Dave Chinnerab23a772021-08-06 11:05:39 -0700900 trace_xfs_inode_reclaiming(ip);
Brian Foster98efe8a2016-11-10 08:23:22 +1100901
Dave Chinner8a17d7d2016-05-18 14:09:12 +1000902 /*
903 * Because we use RCU freeing we need to ensure the inode always appears
904 * to be reclaimed with an invalid inode number when in the free state.
Brian Foster98efe8a2016-11-10 08:23:22 +1100905 * We do this as early as possible under the ILOCK so that
Omar Sandovalf2e9ad22017-08-25 10:05:26 -0700906 * xfs_iflush_cluster() and xfs_ifree_cluster() can be guaranteed to
907 * detect races with us here. By doing this, we guarantee that once
908 * xfs_iflush_cluster() or xfs_ifree_cluster() has locked XFS_ILOCK that
909 * it will see either a valid inode that will serialise correctly, or it
910 * will see an invalid inode that it can skip.
Dave Chinner8a17d7d2016-05-18 14:09:12 +1000911 */
912 spin_lock(&ip->i_flags_lock);
913 ip->i_flags = XFS_IRECLAIM;
914 ip->i_ino = 0;
Darrick J. Wong255794c2021-06-07 09:34:49 -0700915 ip->i_sick = 0;
916 ip->i_checked = 0;
Dave Chinner8a17d7d2016-05-18 14:09:12 +1000917 spin_unlock(&ip->i_flags_lock);
918
Dave Chinnerfad743d2022-07-14 11:47:26 +1000919 ASSERT(!ip->i_itemp || ip->i_itemp->ili_item.li_buf == NULL);
Dave Chinnerc8e20be2010-01-10 23:51:45 +0000920 xfs_iunlock(ip, XFS_ILOCK_EXCL);
Dave Chinner2f11fea2010-07-20 17:53:25 +1000921
Bill O'Donnellff6d6af2015-10-12 18:21:22 +1100922 XFS_STATS_INC(ip->i_mount, xs_ig_reclaims);
Dave Chinner2f11fea2010-07-20 17:53:25 +1000923 /*
924 * Remove the inode from the per-AG radix tree.
925 *
926 * Because radix_tree_delete won't complain even if the item was never
927 * added to the tree assert that it's been there before to catch
928 * problems with the inode life time early on.
929 */
Dave Chinner1a427ab2010-12-16 17:08:41 +1100930 spin_lock(&pag->pag_ici_lock);
Dave Chinner2f11fea2010-07-20 17:53:25 +1000931 if (!radix_tree_delete(&pag->pag_ici_root,
Dave Chinner8a17d7d2016-05-18 14:09:12 +1000932 XFS_INO_TO_AGINO(ip->i_mount, ino)))
Dave Chinner2f11fea2010-07-20 17:53:25 +1000933 ASSERT(0);
Darrick J. Wongc076ae72021-05-31 11:32:02 -0700934 xfs_perag_clear_inode_tag(pag, NULLAGINO, XFS_ICI_RECLAIM_TAG);
Dave Chinner1a427ab2010-12-16 17:08:41 +1100935 spin_unlock(&pag->pag_ici_lock);
Dave Chinner2f11fea2010-07-20 17:53:25 +1000936
937 /*
938 * Here we do an (almost) spurious inode lock in order to coordinate
939 * with inode cache radix tree lookups. This is because the lookup
940 * can reference the inodes in the cache without taking references.
941 *
942 * We make that OK here by ensuring that we wait until the inode is
Alex Elderad637a12012-02-16 22:01:00 +0000943 * unlocked after the lookup before we go ahead and free it.
Dave Chinner2f11fea2010-07-20 17:53:25 +1000944 */
Alex Elderad637a12012-02-16 22:01:00 +0000945 xfs_ilock(ip, XFS_ILOCK_EXCL);
Darrick J. Wong3ea06d72021-05-31 11:31:57 -0700946 ASSERT(!ip->i_udquot && !ip->i_gdquot && !ip->i_pdquot);
Alex Elderad637a12012-02-16 22:01:00 +0000947 xfs_iunlock(ip, XFS_ILOCK_EXCL);
Dave Chinner96355d5a2020-06-29 14:48:45 -0700948 ASSERT(xfs_inode_clean(ip));
Dave Chinner2f11fea2010-07-20 17:53:25 +1000949
Dave Chinner8a17d7d2016-05-18 14:09:12 +1000950 __xfs_inode_free(ip);
Dave Chinner4d0bab32020-07-01 10:21:28 -0700951 return;
Christoph Hellwig8a480882012-04-23 15:58:35 +1000952
Dave Chinner718ecc52020-08-17 16:41:01 -0700953out_clear_flush:
954 xfs_iflags_clear(ip, XFS_IFLUSHING);
Dave Chinner9552e142020-06-29 14:49:17 -0700955out_iunlock:
Christoph Hellwig8a480882012-04-23 15:58:35 +1000956 xfs_iunlock(ip, XFS_ILOCK_EXCL);
Dave Chinner9552e142020-06-29 14:49:17 -0700957out:
Dave Chinner617825f2020-06-29 14:49:16 -0700958 xfs_iflags_clear(ip, XFS_IRECLAIM);
David Chinner7a3be022008-10-30 17:37:37 +1100959}
960
Darrick J. Wong94927502021-06-07 09:34:50 -0700961/* Reclaim sick inodes if we're unmounting or the fs went down. */
962static inline bool
963xfs_want_reclaim_sick(
964 struct xfs_mount *mp)
965{
Dave Chinner2e973b22021-08-18 18:46:52 -0700966 return xfs_is_unmounting(mp) || xfs_has_norecovery(mp) ||
Dave Chinner75c8c50f2021-08-18 18:46:53 -0700967 xfs_is_shutdown(mp);
Darrick J. Wong94927502021-06-07 09:34:50 -0700968}
969
Dave Chinner4d0bab32020-07-01 10:21:28 -0700970void
David Chinner1dc33182008-10-30 17:37:15 +1100971xfs_reclaim_inodes(
Dave Chinner4d0bab32020-07-01 10:21:28 -0700972 struct xfs_mount *mp)
David Chinnerfce08f22008-10-30 17:37:03 +1100973{
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -0700974 struct xfs_icwalk icw = {
975 .icw_flags = 0,
Darrick J. Wong94927502021-06-07 09:34:50 -0700976 };
977
978 if (xfs_want_reclaim_sick(mp))
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -0700979 icw.icw_flags |= XFS_ICWALK_FLAG_RECLAIM_SICK;
Darrick J. Wong94927502021-06-07 09:34:50 -0700980
Dave Chinner4d0bab32020-07-01 10:21:28 -0700981 while (radix_tree_tagged(&mp->m_perag_tree, XFS_ICI_RECLAIM_TAG)) {
Dave Chinner617825f2020-06-29 14:49:16 -0700982 xfs_ail_push_all_sync(mp->m_ail);
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -0700983 xfs_icwalk(mp, XFS_ICWALK_RECLAIM, &icw);
Zheng Bin0f4ec0f12020-09-09 09:29:16 -0700984 }
Dave Chinner9bf729c2010-04-29 09:55:50 +1000985}
986
987/*
Dave Chinner02511a52020-06-29 14:49:18 -0700988 * The shrinker infrastructure determines how many inodes we should scan for
989 * reclaim. We want as many clean inodes ready to reclaim as possible, so we
990 * push the AIL here. We also want to proactively free up memory if we can to
991 * minimise the amount of work memory reclaim has to do so we kick the
992 * background reclaim if it isn't already scheduled.
Dave Chinner9bf729c2010-04-29 09:55:50 +1000993 */
Dave Chinner0a234c62013-08-28 10:17:57 +1000994long
Dave Chinner8daaa832011-07-08 14:14:46 +1000995xfs_reclaim_inodes_nr(
996 struct xfs_mount *mp,
Darrick J. Wong10be3502021-06-18 11:57:06 -0700997 unsigned long nr_to_scan)
Dave Chinner9bf729c2010-04-29 09:55:50 +1000998{
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -0700999 struct xfs_icwalk icw = {
1000 .icw_flags = XFS_ICWALK_FLAG_SCAN_LIMIT,
Darrick J. Wong10be3502021-06-18 11:57:06 -07001001 .icw_scan_limit = min_t(unsigned long, LONG_MAX, nr_to_scan),
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -07001002 };
1003
Darrick J. Wong94927502021-06-07 09:34:50 -07001004 if (xfs_want_reclaim_sick(mp))
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001005 icw.icw_flags |= XFS_ICWALK_FLAG_RECLAIM_SICK;
Darrick J. Wong94927502021-06-07 09:34:50 -07001006
Dave Chinner8daaa832011-07-08 14:14:46 +10001007 /* kick background reclaimer and push the AIL */
Dave Chinner58896082012-10-08 21:56:05 +11001008 xfs_reclaim_work_queue(mp);
Dave Chinner8daaa832011-07-08 14:14:46 +10001009 xfs_ail_push_all(mp->m_ail);
Dave Chinner9bf729c2010-04-29 09:55:50 +10001010
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001011 xfs_icwalk(mp, XFS_ICWALK_RECLAIM, &icw);
Dave Chinner617825f2020-06-29 14:49:16 -07001012 return 0;
Dave Chinner8daaa832011-07-08 14:14:46 +10001013}
Dave Chinnera7b339f2011-04-08 12:45:07 +10001014
Dave Chinner8daaa832011-07-08 14:14:46 +10001015/*
1016 * Return the number of reclaimable inodes in the filesystem for
1017 * the shrinker to determine how much to reclaim.
1018 */
Darrick J. Wong10be3502021-06-18 11:57:06 -07001019long
Dave Chinner8daaa832011-07-08 14:14:46 +10001020xfs_reclaim_inodes_count(
1021 struct xfs_mount *mp)
1022{
1023 struct xfs_perag *pag;
1024 xfs_agnumber_t ag = 0;
Darrick J. Wong10be3502021-06-18 11:57:06 -07001025 long reclaimable = 0;
Dave Chinner9bf729c2010-04-29 09:55:50 +10001026
Dave Chinner65d0f202010-09-24 18:40:15 +10001027 while ((pag = xfs_perag_get_tag(mp, ag, XFS_ICI_RECLAIM_TAG))) {
1028 ag = pag->pag_agno + 1;
Dave Chinner70e60ce2010-07-20 08:07:02 +10001029 reclaimable += pag->pag_ici_reclaimable;
1030 xfs_perag_put(pag);
Dave Chinner9bf729c2010-04-29 09:55:50 +10001031 }
Dave Chinner9bf729c2010-04-29 09:55:50 +10001032 return reclaimable;
1033}
1034
Darrick J. Wong39b1cfd2020-05-21 13:08:49 -07001035STATIC bool
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001036xfs_icwalk_match_id(
Brian Foster3e3f9f52012-11-07 12:21:13 -05001037 struct xfs_inode *ip,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001038 struct xfs_icwalk *icw)
Brian Foster3e3f9f52012-11-07 12:21:13 -05001039{
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001040 if ((icw->icw_flags & XFS_ICWALK_FLAG_UID) &&
1041 !uid_eq(VFS_I(ip)->i_uid, icw->icw_uid))
Darrick J. Wong39b1cfd2020-05-21 13:08:49 -07001042 return false;
Brian Foster3e3f9f52012-11-07 12:21:13 -05001043
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001044 if ((icw->icw_flags & XFS_ICWALK_FLAG_GID) &&
1045 !gid_eq(VFS_I(ip)->i_gid, icw->icw_gid))
Darrick J. Wong39b1cfd2020-05-21 13:08:49 -07001046 return false;
Brian Foster1b556042012-11-06 09:50:45 -05001047
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001048 if ((icw->icw_flags & XFS_ICWALK_FLAG_PRID) &&
1049 ip->i_projid != icw->icw_prid)
Darrick J. Wong39b1cfd2020-05-21 13:08:49 -07001050 return false;
Brian Foster1b556042012-11-06 09:50:45 -05001051
Darrick J. Wong39b1cfd2020-05-21 13:08:49 -07001052 return true;
Brian Foster3e3f9f52012-11-07 12:21:13 -05001053}
1054
Brian Fosterf4526392014-07-24 19:44:28 +10001055/*
1056 * A union-based inode filtering algorithm. Process the inode if any of the
1057 * criteria match. This is for global/internal scans only.
1058 */
Darrick J. Wong39b1cfd2020-05-21 13:08:49 -07001059STATIC bool
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001060xfs_icwalk_match_id_union(
Brian Fosterf4526392014-07-24 19:44:28 +10001061 struct xfs_inode *ip,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001062 struct xfs_icwalk *icw)
Brian Fosterf4526392014-07-24 19:44:28 +10001063{
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001064 if ((icw->icw_flags & XFS_ICWALK_FLAG_UID) &&
1065 uid_eq(VFS_I(ip)->i_uid, icw->icw_uid))
Darrick J. Wong39b1cfd2020-05-21 13:08:49 -07001066 return true;
Brian Fosterf4526392014-07-24 19:44:28 +10001067
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001068 if ((icw->icw_flags & XFS_ICWALK_FLAG_GID) &&
1069 gid_eq(VFS_I(ip)->i_gid, icw->icw_gid))
Darrick J. Wong39b1cfd2020-05-21 13:08:49 -07001070 return true;
Brian Fosterf4526392014-07-24 19:44:28 +10001071
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001072 if ((icw->icw_flags & XFS_ICWALK_FLAG_PRID) &&
1073 ip->i_projid == icw->icw_prid)
Darrick J. Wong39b1cfd2020-05-21 13:08:49 -07001074 return true;
Brian Fosterf4526392014-07-24 19:44:28 +10001075
Darrick J. Wong39b1cfd2020-05-21 13:08:49 -07001076 return false;
Brian Fosterf4526392014-07-24 19:44:28 +10001077}
1078
Darrick J. Wonga91bf992020-05-21 13:08:48 -07001079/*
1080 * Is this inode @ip eligible for eof/cow block reclamation, given some
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001081 * filtering parameters @icw? The inode is eligible if @icw is null or
Darrick J. Wonga91bf992020-05-21 13:08:48 -07001082 * if the predicate functions match.
1083 */
1084static bool
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001085xfs_icwalk_match(
Darrick J. Wonga91bf992020-05-21 13:08:48 -07001086 struct xfs_inode *ip,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001087 struct xfs_icwalk *icw)
Darrick J. Wonga91bf992020-05-21 13:08:48 -07001088{
Darrick J. Wong39b1cfd2020-05-21 13:08:49 -07001089 bool match;
Darrick J. Wonga91bf992020-05-21 13:08:48 -07001090
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001091 if (!icw)
Darrick J. Wonga91bf992020-05-21 13:08:48 -07001092 return true;
1093
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001094 if (icw->icw_flags & XFS_ICWALK_FLAG_UNION)
1095 match = xfs_icwalk_match_id_union(ip, icw);
Darrick J. Wonga91bf992020-05-21 13:08:48 -07001096 else
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001097 match = xfs_icwalk_match_id(ip, icw);
Darrick J. Wonga91bf992020-05-21 13:08:48 -07001098 if (!match)
1099 return false;
1100
1101 /* skip the inode if the file size is too small */
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001102 if ((icw->icw_flags & XFS_ICWALK_FLAG_MINFILESIZE) &&
1103 XFS_ISIZE(ip) < icw->icw_min_file_size)
Darrick J. Wonga91bf992020-05-21 13:08:48 -07001104 return false;
1105
1106 return true;
1107}
1108
Dave Chinner4d0bab32020-07-01 10:21:28 -07001109/*
1110 * This is a fast pass over the inode cache to try to get reclaim moving on as
1111 * many inodes as possible in a short period of time. It kicks itself every few
1112 * seconds, as well as being kicked by the inode cache shrinker when memory
Dave Chinner02511a52020-06-29 14:49:18 -07001113 * goes low.
Dave Chinner4d0bab32020-07-01 10:21:28 -07001114 */
1115void
1116xfs_reclaim_worker(
1117 struct work_struct *work)
1118{
1119 struct xfs_mount *mp = container_of(to_delayed_work(work),
1120 struct xfs_mount, m_reclaim_work);
Dave Chinner4d0bab32020-07-01 10:21:28 -07001121
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -07001122 xfs_icwalk(mp, XFS_ICWALK_RECLAIM, NULL);
Dave Chinner4d0bab32020-07-01 10:21:28 -07001123 xfs_reclaim_work_queue(mp);
1124}
1125
Brian Foster3e3f9f52012-11-07 12:21:13 -05001126STATIC int
Brian Foster41176a62012-11-06 09:50:42 -05001127xfs_inode_free_eofblocks(
1128 struct xfs_inode *ip,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001129 struct xfs_icwalk *icw,
Darrick J. Wong0fa4a102021-01-25 21:09:49 -08001130 unsigned int *lockflags)
Brian Foster41176a62012-11-06 09:50:42 -05001131{
Darrick J. Wong390600f2020-05-21 13:08:48 -07001132 bool wait;
Darrick J. Wong390600f2020-05-21 13:08:48 -07001133
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001134 wait = icw && (icw->icw_flags & XFS_ICWALK_FLAG_SYNC);
Brian Foster5400da72014-07-24 19:40:22 +10001135
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001136 if (!xfs_iflags_test(ip, XFS_IEOFBLOCKS))
1137 return 0;
1138
Brian Foster41176a62012-11-06 09:50:42 -05001139 /*
1140 * If the mapping is dirty the operation can block and wait for some
1141 * time. Unless we are waiting, skip it.
1142 */
Darrick J. Wong390600f2020-05-21 13:08:48 -07001143 if (!wait && mapping_tagged(VFS_I(ip)->i_mapping, PAGECACHE_TAG_DIRTY))
Brian Foster41176a62012-11-06 09:50:42 -05001144 return 0;
1145
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001146 if (!xfs_icwalk_match(ip, icw))
Darrick J. Wonga91bf992020-05-21 13:08:48 -07001147 return 0;
Brian Foster3e3f9f52012-11-07 12:21:13 -05001148
Brian Fostera36b9262017-01-27 23:22:55 -08001149 /*
1150 * If the caller is waiting, return -EAGAIN to keep the background
1151 * scanner moving and revisit the inode in a subsequent pass.
1152 */
Brian Fosterc3155092017-01-27 23:22:56 -08001153 if (!xfs_ilock_nowait(ip, XFS_IOLOCK_EXCL)) {
Darrick J. Wong390600f2020-05-21 13:08:48 -07001154 if (wait)
1155 return -EAGAIN;
1156 return 0;
Brian Fostera36b9262017-01-27 23:22:55 -08001157 }
Darrick J. Wong0fa4a102021-01-25 21:09:49 -08001158 *lockflags |= XFS_IOLOCK_EXCL;
Darrick J. Wong390600f2020-05-21 13:08:48 -07001159
Darrick J. Wong2b156ff2021-03-23 16:59:31 -07001160 if (xfs_can_free_eofblocks(ip, false))
1161 return xfs_free_eofblocks(ip);
1162
1163 /* inode could be preallocated or append-only */
1164 trace_xfs_inode_free_eofblocks_invalid(ip);
1165 xfs_inode_clear_eofblocks_tag(ip);
1166 return 0;
Brian Foster41176a62012-11-06 09:50:42 -05001167}
1168
Darrick J. Wong83104d42016-10-03 09:11:46 -07001169static void
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001170xfs_blockgc_set_iflag(
1171 struct xfs_inode *ip,
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001172 unsigned long iflag)
Brian Foster27b52862012-11-06 09:50:38 -05001173{
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001174 struct xfs_mount *mp = ip->i_mount;
1175 struct xfs_perag *pag;
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001176
1177 ASSERT((iflag & ~(XFS_IEOFBLOCKS | XFS_ICOWBLOCKS)) == 0);
Brian Foster27b52862012-11-06 09:50:38 -05001178
Christoph Hellwig85a6e762016-09-19 11:09:48 +10001179 /*
1180 * Don't bother locking the AG and looking up in the radix trees
1181 * if we already know that we have the tag set.
1182 */
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001183 if (ip->i_flags & iflag)
Christoph Hellwig85a6e762016-09-19 11:09:48 +10001184 return;
1185 spin_lock(&ip->i_flags_lock);
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001186 ip->i_flags |= iflag;
Christoph Hellwig85a6e762016-09-19 11:09:48 +10001187 spin_unlock(&ip->i_flags_lock);
1188
Brian Foster27b52862012-11-06 09:50:38 -05001189 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ip->i_ino));
1190 spin_lock(&pag->pag_ici_lock);
Brian Foster27b52862012-11-06 09:50:38 -05001191
Darrick J. Wongc076ae72021-05-31 11:32:02 -07001192 xfs_perag_set_inode_tag(pag, XFS_INO_TO_AGINO(mp, ip->i_ino),
1193 XFS_ICI_BLOCKGC_TAG);
Brian Foster27b52862012-11-06 09:50:38 -05001194
1195 spin_unlock(&pag->pag_ici_lock);
1196 xfs_perag_put(pag);
1197}
1198
1199void
Darrick J. Wong83104d42016-10-03 09:11:46 -07001200xfs_inode_set_eofblocks_tag(
Brian Foster27b52862012-11-06 09:50:38 -05001201 xfs_inode_t *ip)
1202{
Darrick J. Wong83104d42016-10-03 09:11:46 -07001203 trace_xfs_inode_set_eofblocks_tag(ip);
Darrick J. Wong9669f512021-01-22 16:48:43 -08001204 return xfs_blockgc_set_iflag(ip, XFS_IEOFBLOCKS);
Darrick J. Wong83104d42016-10-03 09:11:46 -07001205}
1206
1207static void
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001208xfs_blockgc_clear_iflag(
1209 struct xfs_inode *ip,
1210 unsigned long iflag)
Darrick J. Wong83104d42016-10-03 09:11:46 -07001211{
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001212 struct xfs_mount *mp = ip->i_mount;
1213 struct xfs_perag *pag;
1214 bool clear_tag;
1215
1216 ASSERT((iflag & ~(XFS_IEOFBLOCKS | XFS_ICOWBLOCKS)) == 0);
Brian Foster27b52862012-11-06 09:50:38 -05001217
Christoph Hellwig85a6e762016-09-19 11:09:48 +10001218 spin_lock(&ip->i_flags_lock);
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001219 ip->i_flags &= ~iflag;
1220 clear_tag = (ip->i_flags & (XFS_IEOFBLOCKS | XFS_ICOWBLOCKS)) == 0;
Christoph Hellwig85a6e762016-09-19 11:09:48 +10001221 spin_unlock(&ip->i_flags_lock);
1222
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001223 if (!clear_tag)
1224 return;
1225
Brian Foster27b52862012-11-06 09:50:38 -05001226 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ip->i_ino));
1227 spin_lock(&pag->pag_ici_lock);
Brian Foster27b52862012-11-06 09:50:38 -05001228
Darrick J. Wongc076ae72021-05-31 11:32:02 -07001229 xfs_perag_clear_inode_tag(pag, XFS_INO_TO_AGINO(mp, ip->i_ino),
1230 XFS_ICI_BLOCKGC_TAG);
Brian Foster27b52862012-11-06 09:50:38 -05001231
1232 spin_unlock(&pag->pag_ici_lock);
1233 xfs_perag_put(pag);
1234}
1235
Darrick J. Wong83104d42016-10-03 09:11:46 -07001236void
1237xfs_inode_clear_eofblocks_tag(
1238 xfs_inode_t *ip)
1239{
1240 trace_xfs_inode_clear_eofblocks_tag(ip);
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001241 return xfs_blockgc_clear_iflag(ip, XFS_IEOFBLOCKS);
Darrick J. Wong83104d42016-10-03 09:11:46 -07001242}
1243
1244/*
Darrick J. Wongbe78ff02018-01-16 19:03:59 -08001245 * Set ourselves up to free CoW blocks from this file. If it's already clean
1246 * then we can bail out quickly, but otherwise we must back off if the file
1247 * is undergoing some kind of write.
1248 */
1249static bool
1250xfs_prep_free_cowblocks(
Christoph Hellwig51d62692018-07-17 16:51:51 -07001251 struct xfs_inode *ip)
Darrick J. Wongbe78ff02018-01-16 19:03:59 -08001252{
1253 /*
1254 * Just clear the tag if we have an empty cow fork or none at all. It's
1255 * possible the inode was fully unshared since it was originally tagged.
1256 */
Christoph Hellwig51d62692018-07-17 16:51:51 -07001257 if (!xfs_inode_has_cow_data(ip)) {
Darrick J. Wongbe78ff02018-01-16 19:03:59 -08001258 trace_xfs_inode_free_cowblocks_invalid(ip);
1259 xfs_inode_clear_cowblocks_tag(ip);
1260 return false;
1261 }
1262
1263 /*
1264 * If the mapping is dirty or under writeback we cannot touch the
1265 * CoW fork. Leave it alone if we're in the midst of a directio.
1266 */
1267 if ((VFS_I(ip)->i_state & I_DIRTY_PAGES) ||
1268 mapping_tagged(VFS_I(ip)->i_mapping, PAGECACHE_TAG_DIRTY) ||
1269 mapping_tagged(VFS_I(ip)->i_mapping, PAGECACHE_TAG_WRITEBACK) ||
1270 atomic_read(&VFS_I(ip)->i_dio_count))
1271 return false;
1272
1273 return true;
1274}
1275
1276/*
Darrick J. Wong83104d42016-10-03 09:11:46 -07001277 * Automatic CoW Reservation Freeing
1278 *
1279 * These functions automatically garbage collect leftover CoW reservations
1280 * that were made on behalf of a cowextsize hint when we start to run out
1281 * of quota or when the reservations sit around for too long. If the file
1282 * has dirty pages or is undergoing writeback, its CoW reservations will
1283 * be retained.
1284 *
1285 * The actual garbage collection piggybacks off the same code that runs
1286 * the speculative EOF preallocation garbage collector.
1287 */
1288STATIC int
1289xfs_inode_free_cowblocks(
1290 struct xfs_inode *ip,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001291 struct xfs_icwalk *icw,
Darrick J. Wong0fa4a102021-01-25 21:09:49 -08001292 unsigned int *lockflags)
Darrick J. Wong83104d42016-10-03 09:11:46 -07001293{
Darrick J. Wongf41a0712021-01-22 16:48:35 -08001294 bool wait;
Darrick J. Wongbe78ff02018-01-16 19:03:59 -08001295 int ret = 0;
Darrick J. Wong83104d42016-10-03 09:11:46 -07001296
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001297 wait = icw && (icw->icw_flags & XFS_ICWALK_FLAG_SYNC);
Darrick J. Wongf41a0712021-01-22 16:48:35 -08001298
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001299 if (!xfs_iflags_test(ip, XFS_ICOWBLOCKS))
1300 return 0;
1301
Christoph Hellwig51d62692018-07-17 16:51:51 -07001302 if (!xfs_prep_free_cowblocks(ip))
Darrick J. Wong83104d42016-10-03 09:11:46 -07001303 return 0;
1304
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001305 if (!xfs_icwalk_match(ip, icw))
Darrick J. Wonga91bf992020-05-21 13:08:48 -07001306 return 0;
Darrick J. Wong83104d42016-10-03 09:11:46 -07001307
Darrick J. Wongf41a0712021-01-22 16:48:35 -08001308 /*
1309 * If the caller is waiting, return -EAGAIN to keep the background
1310 * scanner moving and revisit the inode in a subsequent pass.
1311 */
Darrick J. Wong0fa4a102021-01-25 21:09:49 -08001312 if (!(*lockflags & XFS_IOLOCK_EXCL) &&
1313 !xfs_ilock_nowait(ip, XFS_IOLOCK_EXCL)) {
Darrick J. Wongf41a0712021-01-22 16:48:35 -08001314 if (wait)
1315 return -EAGAIN;
1316 return 0;
1317 }
Darrick J. Wong0fa4a102021-01-25 21:09:49 -08001318 *lockflags |= XFS_IOLOCK_EXCL;
1319
Darrick J. Wongf41a0712021-01-22 16:48:35 -08001320 if (!xfs_ilock_nowait(ip, XFS_MMAPLOCK_EXCL)) {
1321 if (wait)
Darrick J. Wong0fa4a102021-01-25 21:09:49 -08001322 return -EAGAIN;
1323 return 0;
Darrick J. Wongf41a0712021-01-22 16:48:35 -08001324 }
Darrick J. Wong0fa4a102021-01-25 21:09:49 -08001325 *lockflags |= XFS_MMAPLOCK_EXCL;
Darrick J. Wong83104d42016-10-03 09:11:46 -07001326
Darrick J. Wongbe78ff02018-01-16 19:03:59 -08001327 /*
1328 * Check again, nobody else should be able to dirty blocks or change
1329 * the reflink iflag now that we have the first two locks held.
1330 */
Christoph Hellwig51d62692018-07-17 16:51:51 -07001331 if (xfs_prep_free_cowblocks(ip))
Darrick J. Wongbe78ff02018-01-16 19:03:59 -08001332 ret = xfs_reflink_cancel_cow_range(ip, 0, NULLFILEOFF, false);
Darrick J. Wong83104d42016-10-03 09:11:46 -07001333 return ret;
1334}
1335
Darrick J. Wong83104d42016-10-03 09:11:46 -07001336void
1337xfs_inode_set_cowblocks_tag(
1338 xfs_inode_t *ip)
1339{
Brian Foster7b7381f2016-10-24 14:21:00 +11001340 trace_xfs_inode_set_cowblocks_tag(ip);
Darrick J. Wong9669f512021-01-22 16:48:43 -08001341 return xfs_blockgc_set_iflag(ip, XFS_ICOWBLOCKS);
Darrick J. Wong83104d42016-10-03 09:11:46 -07001342}
1343
1344void
1345xfs_inode_clear_cowblocks_tag(
1346 xfs_inode_t *ip)
1347{
Brian Foster7b7381f2016-10-24 14:21:00 +11001348 trace_xfs_inode_clear_cowblocks_tag(ip);
Darrick J. Wongce2d3bb2021-01-22 16:48:43 -08001349 return xfs_blockgc_clear_iflag(ip, XFS_ICOWBLOCKS);
Darrick J. Wong83104d42016-10-03 09:11:46 -07001350}
Darrick J. Wongd6b636e2018-05-09 10:03:56 -07001351
1352/* Disable post-EOF and CoW block auto-reclamation. */
1353void
Darrick J. Wongc9a65262021-01-22 16:48:44 -08001354xfs_blockgc_stop(
Darrick J. Wongd6b636e2018-05-09 10:03:56 -07001355 struct xfs_mount *mp)
1356{
Darrick J. Wong894ecac2021-01-22 16:48:44 -08001357 struct xfs_perag *pag;
1358 xfs_agnumber_t agno;
1359
Darrick J. Wong6f649092021-08-06 11:05:42 -07001360 if (!xfs_clear_blockgc_enabled(mp))
1361 return;
1362
1363 for_each_perag(mp, agno, pag)
Darrick J. Wong894ecac2021-01-22 16:48:44 -08001364 cancel_delayed_work_sync(&pag->pag_blockgc_work);
Darrick J. Wong6f649092021-08-06 11:05:42 -07001365 trace_xfs_blockgc_stop(mp, __return_address);
Darrick J. Wongd6b636e2018-05-09 10:03:56 -07001366}
1367
1368/* Enable post-EOF and CoW block auto-reclamation. */
1369void
Darrick J. Wongc9a65262021-01-22 16:48:44 -08001370xfs_blockgc_start(
Darrick J. Wongd6b636e2018-05-09 10:03:56 -07001371 struct xfs_mount *mp)
1372{
Darrick J. Wong894ecac2021-01-22 16:48:44 -08001373 struct xfs_perag *pag;
1374 xfs_agnumber_t agno;
1375
Darrick J. Wong6f649092021-08-06 11:05:42 -07001376 if (xfs_set_blockgc_enabled(mp))
1377 return;
1378
1379 trace_xfs_blockgc_start(mp, __return_address);
Darrick J. Wong894ecac2021-01-22 16:48:44 -08001380 for_each_perag_tag(mp, agno, pag, XFS_ICI_BLOCKGC_TAG)
1381 xfs_blockgc_queue(pag);
Darrick J. Wongd6b636e2018-05-09 10:03:56 -07001382}
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001383
Darrick J. Wongd20d5ed2021-06-01 23:01:44 -07001384/* Don't try to run block gc on an inode that's in any of these states. */
1385#define XFS_BLOCKGC_NOGRAB_IFLAGS (XFS_INEW | \
Dave Chinnerab23a772021-08-06 11:05:39 -07001386 XFS_NEED_INACTIVE | \
1387 XFS_INACTIVATING | \
Darrick J. Wongd20d5ed2021-06-01 23:01:44 -07001388 XFS_IRECLAIMABLE | \
1389 XFS_IRECLAIM)
Darrick J. Wongdf600192021-06-01 13:29:41 -07001390/*
Darrick J. Wongb9baaef2021-05-31 11:31:58 -07001391 * Decide if the given @ip is eligible for garbage collection of speculative
1392 * preallocations, and grab it if so. Returns true if it's ready to go or
1393 * false if we should just ignore it.
Darrick J. Wongdf600192021-06-01 13:29:41 -07001394 */
1395static bool
Darrick J. Wongb9baaef2021-05-31 11:31:58 -07001396xfs_blockgc_igrab(
Darrick J. Wong7fdff522021-05-31 11:31:59 -07001397 struct xfs_inode *ip)
Darrick J. Wongdf600192021-06-01 13:29:41 -07001398{
1399 struct inode *inode = VFS_I(ip);
Darrick J. Wongdf600192021-06-01 13:29:41 -07001400
1401 ASSERT(rcu_read_lock_held());
1402
1403 /* Check for stale RCU freed inode */
1404 spin_lock(&ip->i_flags_lock);
1405 if (!ip->i_ino)
1406 goto out_unlock_noent;
1407
Darrick J. Wongd20d5ed2021-06-01 23:01:44 -07001408 if (ip->i_flags & XFS_BLOCKGC_NOGRAB_IFLAGS)
Darrick J. Wongdf600192021-06-01 13:29:41 -07001409 goto out_unlock_noent;
1410 spin_unlock(&ip->i_flags_lock);
1411
1412 /* nothing to sync during shutdown */
Dave Chinner75c8c50f2021-08-18 18:46:53 -07001413 if (xfs_is_shutdown(ip->i_mount))
Darrick J. Wongdf600192021-06-01 13:29:41 -07001414 return false;
1415
1416 /* If we can't grab the inode, it must on it's way to reclaim. */
1417 if (!igrab(inode))
1418 return false;
1419
1420 /* inode is valid */
1421 return true;
1422
1423out_unlock_noent:
1424 spin_unlock(&ip->i_flags_lock);
1425 return false;
1426}
1427
Darrick J. Wong41956752021-01-22 16:48:43 -08001428/* Scan one incore inode for block preallocations that we can remove. */
1429static int
1430xfs_blockgc_scan_inode(
1431 struct xfs_inode *ip,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001432 struct xfs_icwalk *icw)
Darrick J. Wong85c5b272021-01-22 16:48:39 -08001433{
Darrick J. Wong0fa4a102021-01-25 21:09:49 -08001434 unsigned int lockflags = 0;
Darrick J. Wong85c5b272021-01-22 16:48:39 -08001435 int error;
1436
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001437 error = xfs_inode_free_eofblocks(ip, icw, &lockflags);
Darrick J. Wong85c5b272021-01-22 16:48:39 -08001438 if (error)
Darrick J. Wong0fa4a102021-01-25 21:09:49 -08001439 goto unlock;
Darrick J. Wong85c5b272021-01-22 16:48:39 -08001440
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001441 error = xfs_inode_free_cowblocks(ip, icw, &lockflags);
Darrick J. Wong0fa4a102021-01-25 21:09:49 -08001442unlock:
1443 if (lockflags)
1444 xfs_iunlock(ip, lockflags);
Darrick J. Wong594ab002021-05-31 11:32:00 -07001445 xfs_irele(ip);
Darrick J. Wong0fa4a102021-01-25 21:09:49 -08001446 return error;
Darrick J. Wong85c5b272021-01-22 16:48:39 -08001447}
1448
Darrick J. Wong9669f512021-01-22 16:48:43 -08001449/* Background worker that trims preallocated space. */
1450void
1451xfs_blockgc_worker(
1452 struct work_struct *work)
1453{
Darrick J. Wong894ecac2021-01-22 16:48:44 -08001454 struct xfs_perag *pag = container_of(to_delayed_work(work),
1455 struct xfs_perag, pag_blockgc_work);
1456 struct xfs_mount *mp = pag->pag_mount;
Darrick J. Wong9669f512021-01-22 16:48:43 -08001457 int error;
1458
Darrick J. Wong6f649092021-08-06 11:05:42 -07001459 trace_xfs_blockgc_worker(mp, __return_address);
1460
Darrick J. Wongf427cf52021-05-31 11:32:00 -07001461 error = xfs_icwalk_ag(pag, XFS_ICWALK_BLOCKGC, NULL);
Darrick J. Wong9669f512021-01-22 16:48:43 -08001462 if (error)
Darrick J. Wong894ecac2021-01-22 16:48:44 -08001463 xfs_info(mp, "AG %u preallocation gc worker failed, err=%d",
1464 pag->pag_agno, error);
Darrick J. Wong894ecac2021-01-22 16:48:44 -08001465 xfs_blockgc_queue(pag);
Darrick J. Wong9669f512021-01-22 16:48:43 -08001466}
1467
Darrick J. Wong85c5b272021-01-22 16:48:39 -08001468/*
Darrick J. Wong2eb66502021-08-06 11:05:41 -07001469 * Try to free space in the filesystem by purging inactive inodes, eofblocks
1470 * and cowblocks.
Darrick J. Wong85c5b272021-01-22 16:48:39 -08001471 */
1472int
1473xfs_blockgc_free_space(
1474 struct xfs_mount *mp,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001475 struct xfs_icwalk *icw)
Darrick J. Wong85c5b272021-01-22 16:48:39 -08001476{
Darrick J. Wong2eb66502021-08-06 11:05:41 -07001477 int error;
1478
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001479 trace_xfs_blockgc_free_space(mp, icw, _RET_IP_);
Darrick J. Wong85c5b272021-01-22 16:48:39 -08001480
Darrick J. Wong2eb66502021-08-06 11:05:41 -07001481 error = xfs_icwalk(mp, XFS_ICWALK_BLOCKGC, icw);
1482 if (error)
1483 return error;
1484
Dave Chinnerd4d12c02023-06-05 14:48:15 +10001485 return xfs_inodegc_flush(mp);
Darrick J. Wong85c5b272021-01-22 16:48:39 -08001486}
1487
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001488/*
Darrick J. Wonge8d04c22021-08-06 11:05:42 -07001489 * Reclaim all the free space that we can by scheduling the background blockgc
1490 * and inodegc workers immediately and waiting for them all to clear.
1491 */
Dave Chinnerd4d12c02023-06-05 14:48:15 +10001492int
Darrick J. Wonge8d04c22021-08-06 11:05:42 -07001493xfs_blockgc_flush_all(
1494 struct xfs_mount *mp)
1495{
1496 struct xfs_perag *pag;
1497 xfs_agnumber_t agno;
1498
1499 trace_xfs_blockgc_flush_all(mp, __return_address);
1500
1501 /*
1502 * For each blockgc worker, move its queue time up to now. If it
1503 * wasn't queued, it will not be requeued. Then flush whatever's
1504 * left.
1505 */
1506 for_each_perag_tag(mp, agno, pag, XFS_ICI_BLOCKGC_TAG)
1507 mod_delayed_work(pag->pag_mount->m_blockgc_wq,
1508 &pag->pag_blockgc_work, 0);
1509
1510 for_each_perag_tag(mp, agno, pag, XFS_ICI_BLOCKGC_TAG)
1511 flush_delayed_work(&pag->pag_blockgc_work);
1512
Dave Chinnerd4d12c02023-06-05 14:48:15 +10001513 return xfs_inodegc_flush(mp);
Darrick J. Wonge8d04c22021-08-06 11:05:42 -07001514}
1515
1516/*
Darrick J. Wongc237dd72021-01-22 16:48:37 -08001517 * Run cow/eofblocks scans on the supplied dquots. We don't know exactly which
1518 * quota caused an allocation failure, so we make a best effort by including
1519 * each quota under low free space conditions (less than 1% free space) in the
1520 * scan.
Darrick J. Wong111068f2021-01-22 16:48:36 -08001521 *
1522 * Callers must not hold any inode's ILOCK. If requesting a synchronous scan
Darrick J. Wong2d53f66b2021-06-07 09:34:51 -07001523 * (XFS_ICWALK_FLAG_SYNC), the caller also must not hold any inode's IOLOCK or
Darrick J. Wong111068f2021-01-22 16:48:36 -08001524 * MMAPLOCK.
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001525 */
Darrick J. Wong111068f2021-01-22 16:48:36 -08001526int
Darrick J. Wongc237dd72021-01-22 16:48:37 -08001527xfs_blockgc_free_dquots(
1528 struct xfs_mount *mp,
1529 struct xfs_dquot *udqp,
1530 struct xfs_dquot *gdqp,
1531 struct xfs_dquot *pdqp,
Darrick J. Wong2d53f66b2021-06-07 09:34:51 -07001532 unsigned int iwalk_flags)
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001533{
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001534 struct xfs_icwalk icw = {0};
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001535 bool do_work = false;
1536
Darrick J. Wongc237dd72021-01-22 16:48:37 -08001537 if (!udqp && !gdqp && !pdqp)
1538 return 0;
1539
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001540 /*
Darrick J. Wong111068f2021-01-22 16:48:36 -08001541 * Run a scan to free blocks using the union filter to cover all
1542 * applicable quotas in a single scan.
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001543 */
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001544 icw.icw_flags = XFS_ICWALK_FLAG_UNION | iwalk_flags;
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001545
Darrick J. Wongc237dd72021-01-22 16:48:37 -08001546 if (XFS_IS_UQUOTA_ENFORCED(mp) && udqp && xfs_dquot_lowsp(udqp)) {
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001547 icw.icw_uid = make_kuid(mp->m_super->s_user_ns, udqp->q_id);
1548 icw.icw_flags |= XFS_ICWALK_FLAG_UID;
Darrick J. Wongc237dd72021-01-22 16:48:37 -08001549 do_work = true;
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001550 }
1551
Darrick J. Wongc237dd72021-01-22 16:48:37 -08001552 if (XFS_IS_UQUOTA_ENFORCED(mp) && gdqp && xfs_dquot_lowsp(gdqp)) {
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001553 icw.icw_gid = make_kgid(mp->m_super->s_user_ns, gdqp->q_id);
1554 icw.icw_flags |= XFS_ICWALK_FLAG_GID;
Darrick J. Wongc237dd72021-01-22 16:48:37 -08001555 do_work = true;
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001556 }
1557
Darrick J. Wongc237dd72021-01-22 16:48:37 -08001558 if (XFS_IS_PQUOTA_ENFORCED(mp) && pdqp && xfs_dquot_lowsp(pdqp)) {
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001559 icw.icw_prid = pdqp->q_id;
1560 icw.icw_flags |= XFS_ICWALK_FLAG_PRID;
Darrick J. Wongc237dd72021-01-22 16:48:37 -08001561 do_work = true;
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001562 }
1563
1564 if (!do_work)
Darrick J. Wong111068f2021-01-22 16:48:36 -08001565 return 0;
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001566
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001567 return xfs_blockgc_free_space(mp, &icw);
Darrick J. Wongc237dd72021-01-22 16:48:37 -08001568}
1569
1570/* Run cow/eofblocks scans on the quotas attached to the inode. */
1571int
1572xfs_blockgc_free_quota(
1573 struct xfs_inode *ip,
Darrick J. Wong2d53f66b2021-06-07 09:34:51 -07001574 unsigned int iwalk_flags)
Darrick J. Wongc237dd72021-01-22 16:48:37 -08001575{
1576 return xfs_blockgc_free_dquots(ip->i_mount,
1577 xfs_inode_dquot(ip, XFS_DQTYPE_USER),
1578 xfs_inode_dquot(ip, XFS_DQTYPE_GROUP),
Darrick J. Wong2d53f66b2021-06-07 09:34:51 -07001579 xfs_inode_dquot(ip, XFS_DQTYPE_PROJ), iwalk_flags);
Darrick J. Wong3d4feec2021-01-22 16:48:36 -08001580}
Darrick J. Wongdf600192021-06-01 13:29:41 -07001581
1582/* XFS Inode Cache Walking Code */
1583
1584/*
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -07001585 * The inode lookup is done in batches to keep the amount of lock traffic and
1586 * radix tree lookups to a minimum. The batch size is a trade off between
1587 * lookup reduction and stack usage. This is in the reclaim path, so we can't
1588 * be too greedy.
1589 */
1590#define XFS_LOOKUP_BATCH 32
1591
1592
1593/*
Darrick J. Wongb9baaef2021-05-31 11:31:58 -07001594 * Decide if we want to grab this inode in anticipation of doing work towards
Darrick J. Wong594ab002021-05-31 11:32:00 -07001595 * the goal.
Darrick J. Wongb9baaef2021-05-31 11:31:58 -07001596 */
1597static inline bool
1598xfs_icwalk_igrab(
1599 enum xfs_icwalk_goal goal,
Darrick J. Wong94927502021-06-07 09:34:50 -07001600 struct xfs_inode *ip,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001601 struct xfs_icwalk *icw)
Darrick J. Wongb9baaef2021-05-31 11:31:58 -07001602{
1603 switch (goal) {
Darrick J. Wongb9baaef2021-05-31 11:31:58 -07001604 case XFS_ICWALK_BLOCKGC:
Darrick J. Wong7fdff522021-05-31 11:31:59 -07001605 return xfs_blockgc_igrab(ip);
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -07001606 case XFS_ICWALK_RECLAIM:
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001607 return xfs_reclaim_igrab(ip, icw);
Darrick J. Wongb9baaef2021-05-31 11:31:58 -07001608 default:
1609 return false;
1610 }
1611}
1612
Darrick J. Wong594ab002021-05-31 11:32:00 -07001613/*
1614 * Process an inode. Each processing function must handle any state changes
1615 * made by the icwalk igrab function. Return -EAGAIN to skip an inode.
1616 */
Darrick J. Wongf427cf52021-05-31 11:32:00 -07001617static inline int
1618xfs_icwalk_process_inode(
1619 enum xfs_icwalk_goal goal,
1620 struct xfs_inode *ip,
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -07001621 struct xfs_perag *pag,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001622 struct xfs_icwalk *icw)
Darrick J. Wongf427cf52021-05-31 11:32:00 -07001623{
Darrick J. Wong594ab002021-05-31 11:32:00 -07001624 int error = 0;
Darrick J. Wongf427cf52021-05-31 11:32:00 -07001625
1626 switch (goal) {
Darrick J. Wongf427cf52021-05-31 11:32:00 -07001627 case XFS_ICWALK_BLOCKGC:
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001628 error = xfs_blockgc_scan_inode(ip, icw);
Darrick J. Wongf427cf52021-05-31 11:32:00 -07001629 break;
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -07001630 case XFS_ICWALK_RECLAIM:
1631 xfs_reclaim_inode(ip, pag);
1632 break;
Darrick J. Wongf427cf52021-05-31 11:32:00 -07001633 }
Darrick J. Wongf427cf52021-05-31 11:32:00 -07001634 return error;
1635}
1636
Darrick J. Wongb9baaef2021-05-31 11:31:58 -07001637/*
Darrick J. Wongf427cf52021-05-31 11:32:00 -07001638 * For a given per-AG structure @pag and a goal, grab qualifying inodes and
1639 * process them in some manner.
Darrick J. Wongdf600192021-06-01 13:29:41 -07001640 */
1641static int
Darrick J. Wongc1115c02021-06-01 22:41:25 -07001642xfs_icwalk_ag(
Darrick J. Wongdf600192021-06-01 13:29:41 -07001643 struct xfs_perag *pag,
Darrick J. Wongf427cf52021-05-31 11:32:00 -07001644 enum xfs_icwalk_goal goal,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001645 struct xfs_icwalk *icw)
Darrick J. Wongdf600192021-06-01 13:29:41 -07001646{
1647 struct xfs_mount *mp = pag->pag_mount;
1648 uint32_t first_index;
1649 int last_error = 0;
1650 int skipped;
1651 bool done;
1652 int nr_found;
1653
1654restart:
1655 done = false;
1656 skipped = 0;
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -07001657 if (goal == XFS_ICWALK_RECLAIM)
1658 first_index = READ_ONCE(pag->pag_ici_reclaim_cursor);
1659 else
1660 first_index = 0;
Darrick J. Wongdf600192021-06-01 13:29:41 -07001661 nr_found = 0;
1662 do {
1663 struct xfs_inode *batch[XFS_LOOKUP_BATCH];
1664 int error = 0;
1665 int i;
1666
1667 rcu_read_lock();
1668
Christoph Hellwiga437b9b2021-08-13 09:16:52 -07001669 nr_found = radix_tree_gang_lookup_tag(&pag->pag_ici_root,
1670 (void **) batch, first_index,
1671 XFS_LOOKUP_BATCH, goal);
Darrick J. Wongdf600192021-06-01 13:29:41 -07001672 if (!nr_found) {
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -07001673 done = true;
Darrick J. Wongdf600192021-06-01 13:29:41 -07001674 rcu_read_unlock();
1675 break;
1676 }
1677
1678 /*
1679 * Grab the inodes before we drop the lock. if we found
1680 * nothing, nr == 0 and the loop will be skipped.
1681 */
1682 for (i = 0; i < nr_found; i++) {
1683 struct xfs_inode *ip = batch[i];
1684
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001685 if (done || !xfs_icwalk_igrab(goal, ip, icw))
Darrick J. Wongdf600192021-06-01 13:29:41 -07001686 batch[i] = NULL;
1687
1688 /*
1689 * Update the index for the next lookup. Catch
1690 * overflows into the next AG range which can occur if
1691 * we have inodes in the last block of the AG and we
1692 * are currently pointing to the last inode.
1693 *
1694 * Because we may see inodes that are from the wrong AG
1695 * due to RCU freeing and reallocation, only update the
1696 * index if it lies in this AG. It was a race that lead
1697 * us to see this inode, so another lookup from the
1698 * same index will not find it again.
1699 */
1700 if (XFS_INO_TO_AGNO(mp, ip->i_ino) != pag->pag_agno)
1701 continue;
1702 first_index = XFS_INO_TO_AGINO(mp, ip->i_ino + 1);
1703 if (first_index < XFS_INO_TO_AGINO(mp, ip->i_ino))
1704 done = true;
1705 }
1706
1707 /* unlock now we've grabbed the inodes. */
1708 rcu_read_unlock();
1709
1710 for (i = 0; i < nr_found; i++) {
1711 if (!batch[i])
1712 continue;
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -07001713 error = xfs_icwalk_process_inode(goal, batch[i], pag,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001714 icw);
Darrick J. Wongdf600192021-06-01 13:29:41 -07001715 if (error == -EAGAIN) {
1716 skipped++;
1717 continue;
1718 }
1719 if (error && last_error != -EFSCORRUPTED)
1720 last_error = error;
1721 }
1722
1723 /* bail out if the filesystem is corrupted. */
1724 if (error == -EFSCORRUPTED)
1725 break;
1726
1727 cond_resched();
1728
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001729 if (icw && (icw->icw_flags & XFS_ICWALK_FLAG_SCAN_LIMIT)) {
1730 icw->icw_scan_limit -= XFS_LOOKUP_BATCH;
1731 if (icw->icw_scan_limit <= 0)
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -07001732 break;
1733 }
Darrick J. Wongdf600192021-06-01 13:29:41 -07001734 } while (nr_found && !done);
1735
Darrick J. Wongf1bc5c52021-05-31 11:32:02 -07001736 if (goal == XFS_ICWALK_RECLAIM) {
1737 if (done)
1738 first_index = 0;
1739 WRITE_ONCE(pag->pag_ici_reclaim_cursor, first_index);
1740 }
1741
Darrick J. Wongdf600192021-06-01 13:29:41 -07001742 if (skipped) {
1743 delay(1);
1744 goto restart;
1745 }
1746 return last_error;
1747}
1748
Darrick J. Wongf427cf52021-05-31 11:32:00 -07001749/* Walk all incore inodes to achieve a given goal. */
Darrick J. Wongdf600192021-06-01 13:29:41 -07001750static int
Darrick J. Wongc1115c02021-06-01 22:41:25 -07001751xfs_icwalk(
Darrick J. Wongdf600192021-06-01 13:29:41 -07001752 struct xfs_mount *mp,
Darrick J. Wongf427cf52021-05-31 11:32:00 -07001753 enum xfs_icwalk_goal goal,
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001754 struct xfs_icwalk *icw)
Darrick J. Wongdf600192021-06-01 13:29:41 -07001755{
1756 struct xfs_perag *pag;
1757 int error = 0;
1758 int last_error = 0;
Christoph Hellwiga437b9b2021-08-13 09:16:52 -07001759 xfs_agnumber_t agno;
Darrick J. Wongdf600192021-06-01 13:29:41 -07001760
Christoph Hellwiga437b9b2021-08-13 09:16:52 -07001761 for_each_perag_tag(mp, agno, pag, goal) {
Darrick J. Wongb26b2bf2021-06-07 09:34:51 -07001762 error = xfs_icwalk_ag(pag, goal, icw);
Darrick J. Wongdf600192021-06-01 13:29:41 -07001763 if (error) {
1764 last_error = error;
Christoph Hellwiga437b9b2021-08-13 09:16:52 -07001765 if (error == -EFSCORRUPTED) {
Dave Chinnerc4d56602023-02-13 09:14:42 +11001766 xfs_perag_rele(pag);
Darrick J. Wongdf600192021-06-01 13:29:41 -07001767 break;
Christoph Hellwiga437b9b2021-08-13 09:16:52 -07001768 }
Darrick J. Wongdf600192021-06-01 13:29:41 -07001769 }
1770 }
1771 return last_error;
Darrick J. Wong2d53f66b2021-06-07 09:34:51 -07001772 BUILD_BUG_ON(XFS_ICWALK_PRIVATE_FLAGS & XFS_ICWALK_FLAGS_VALID);
Darrick J. Wongdf600192021-06-01 13:29:41 -07001773}
Darrick J. Wongc6c20662021-08-06 11:05:38 -07001774
1775#ifdef DEBUG
1776static void
1777xfs_check_delalloc(
1778 struct xfs_inode *ip,
1779 int whichfork)
1780{
Darrick J. Wong732436e2022-07-09 10:56:05 -07001781 struct xfs_ifork *ifp = xfs_ifork_ptr(ip, whichfork);
Darrick J. Wongc6c20662021-08-06 11:05:38 -07001782 struct xfs_bmbt_irec got;
1783 struct xfs_iext_cursor icur;
1784
1785 if (!ifp || !xfs_iext_lookup_extent(ip, ifp, 0, &icur, &got))
1786 return;
1787 do {
1788 if (isnullstartblock(got.br_startblock)) {
1789 xfs_warn(ip->i_mount,
1790 "ino %llx %s fork has delalloc extent at [0x%llx:0x%llx]",
1791 ip->i_ino,
1792 whichfork == XFS_DATA_FORK ? "data" : "cow",
1793 got.br_startoff, got.br_blockcount);
1794 }
1795 } while (xfs_iext_next_extent(ifp, &icur, &got));
1796}
1797#else
1798#define xfs_check_delalloc(ip, whichfork) do { } while (0)
1799#endif
1800
Dave Chinnerab23a772021-08-06 11:05:39 -07001801/* Schedule the inode for reclaim. */
1802static void
1803xfs_inodegc_set_reclaimable(
Darrick J. Wongc6c20662021-08-06 11:05:38 -07001804 struct xfs_inode *ip)
1805{
1806 struct xfs_mount *mp = ip->i_mount;
1807 struct xfs_perag *pag;
Darrick J. Wongc6c20662021-08-06 11:05:38 -07001808
Dave Chinner75c8c50f2021-08-18 18:46:53 -07001809 if (!xfs_is_shutdown(mp) && ip->i_delayed_blks) {
Darrick J. Wongc6c20662021-08-06 11:05:38 -07001810 xfs_check_delalloc(ip, XFS_DATA_FORK);
1811 xfs_check_delalloc(ip, XFS_COW_FORK);
1812 ASSERT(0);
1813 }
1814
Darrick J. Wongc6c20662021-08-06 11:05:38 -07001815 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ip->i_ino));
1816 spin_lock(&pag->pag_ici_lock);
1817 spin_lock(&ip->i_flags_lock);
1818
Dave Chinnerab23a772021-08-06 11:05:39 -07001819 trace_xfs_inode_set_reclaimable(ip);
1820 ip->i_flags &= ~(XFS_NEED_INACTIVE | XFS_INACTIVATING);
1821 ip->i_flags |= XFS_IRECLAIMABLE;
Darrick J. Wongc6c20662021-08-06 11:05:38 -07001822 xfs_perag_set_inode_tag(pag, XFS_INO_TO_AGINO(mp, ip->i_ino),
1823 XFS_ICI_RECLAIM_TAG);
Darrick J. Wongc6c20662021-08-06 11:05:38 -07001824
1825 spin_unlock(&ip->i_flags_lock);
1826 spin_unlock(&pag->pag_ici_lock);
1827 xfs_perag_put(pag);
1828}
Dave Chinnerab23a772021-08-06 11:05:39 -07001829
1830/*
1831 * Free all speculative preallocations and possibly even the inode itself.
1832 * This is the last chance to make changes to an otherwise unreferenced file
1833 * before incore reclamation happens.
1834 */
Dave Chinnerd4d12c02023-06-05 14:48:15 +10001835static int
Dave Chinnerab23a772021-08-06 11:05:39 -07001836xfs_inodegc_inactivate(
1837 struct xfs_inode *ip)
1838{
Dave Chinnerd4d12c02023-06-05 14:48:15 +10001839 int error;
1840
Dave Chinnerab23a772021-08-06 11:05:39 -07001841 trace_xfs_inode_inactivating(ip);
Dave Chinnerd4d12c02023-06-05 14:48:15 +10001842 error = xfs_inactive(ip);
Dave Chinnerab23a772021-08-06 11:05:39 -07001843 xfs_inodegc_set_reclaimable(ip);
Dave Chinnerd4d12c02023-06-05 14:48:15 +10001844 return error;
1845
Dave Chinnerab23a772021-08-06 11:05:39 -07001846}
1847
1848void
1849xfs_inodegc_worker(
1850 struct work_struct *work)
1851{
Dave Chinner7cf2b0f2022-06-16 07:44:31 -07001852 struct xfs_inodegc *gc = container_of(to_delayed_work(work),
1853 struct xfs_inodegc, work);
Dave Chinnerab23a772021-08-06 11:05:39 -07001854 struct llist_node *node = llist_del_all(&gc->list);
1855 struct xfs_inode *ip, *n;
Darrick J. Wong62334fa2023-09-11 08:39:03 -07001856 struct xfs_mount *mp = gc->mp;
Wu Guanghao4da11252022-12-27 09:41:30 -08001857 unsigned int nofs_flag;
Dave Chinnerab23a772021-08-06 11:05:39 -07001858
Darrick J. Wong62334fa2023-09-11 08:39:03 -07001859 /*
1860 * Clear the cpu mask bit and ensure that we have seen the latest
1861 * update of the gc structure associated with this CPU. This matches
1862 * with the release semantics used when setting the cpumask bit in
1863 * xfs_inodegc_queue.
1864 */
1865 cpumask_clear_cpu(gc->cpu, &mp->m_inodegc_cpumask);
1866 smp_mb__after_atomic();
Darrick J. Wongb37c4c82023-05-02 09:16:12 +10001867
Dave Chinnerab23a772021-08-06 11:05:39 -07001868 WRITE_ONCE(gc->items, 0);
1869
1870 if (!node)
1871 return;
1872
Wu Guanghao4da11252022-12-27 09:41:30 -08001873 /*
1874 * We can allocate memory here while doing writeback on behalf of
1875 * memory reclaim. To avoid memory allocation deadlocks set the
1876 * task-wide nofs context for the following operations.
1877 */
1878 nofs_flag = memalloc_nofs_save();
1879
Dave Chinnerab23a772021-08-06 11:05:39 -07001880 ip = llist_entry(node, struct xfs_inode, i_gclist);
Darrick J. Wong62334fa2023-09-11 08:39:03 -07001881 trace_xfs_inodegc_worker(mp, READ_ONCE(gc->shrinker_hits));
Dave Chinnerab23a772021-08-06 11:05:39 -07001882
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07001883 WRITE_ONCE(gc->shrinker_hits, 0);
Dave Chinnerab23a772021-08-06 11:05:39 -07001884 llist_for_each_entry_safe(ip, n, node, i_gclist) {
Dave Chinnerd4d12c02023-06-05 14:48:15 +10001885 int error;
1886
Dave Chinnerab23a772021-08-06 11:05:39 -07001887 xfs_iflags_set(ip, XFS_INACTIVATING);
Dave Chinnerd4d12c02023-06-05 14:48:15 +10001888 error = xfs_inodegc_inactivate(ip);
1889 if (error && !gc->error)
1890 gc->error = error;
Dave Chinnerab23a772021-08-06 11:05:39 -07001891 }
Wu Guanghao4da11252022-12-27 09:41:30 -08001892
1893 memalloc_nofs_restore(nofs_flag);
Dave Chinnerab23a772021-08-06 11:05:39 -07001894}
1895
1896/*
Dave Chinner5e672cd2022-06-16 07:44:32 -07001897 * Expedite all pending inodegc work to run immediately. This does not wait for
1898 * completion of the work.
1899 */
1900void
1901xfs_inodegc_push(
1902 struct xfs_mount *mp)
1903{
1904 if (!xfs_is_inodegc_enabled(mp))
1905 return;
1906 trace_xfs_inodegc_push(mp, __return_address);
1907 xfs_inodegc_queue_all(mp);
1908}
1909
1910/*
Brian Foster6191cf32022-01-18 11:32:35 -08001911 * Force all currently queued inode inactivation work to run immediately and
1912 * wait for the work to finish.
Dave Chinnerab23a772021-08-06 11:05:39 -07001913 */
Dave Chinnerd4d12c02023-06-05 14:48:15 +10001914int
Dave Chinnerab23a772021-08-06 11:05:39 -07001915xfs_inodegc_flush(
1916 struct xfs_mount *mp)
1917{
Dave Chinner5e672cd2022-06-16 07:44:32 -07001918 xfs_inodegc_push(mp);
Dave Chinnerab23a772021-08-06 11:05:39 -07001919 trace_xfs_inodegc_flush(mp, __return_address);
Dave Chinnerd4d12c02023-06-05 14:48:15 +10001920 return xfs_inodegc_wait_all(mp);
Dave Chinnerab23a772021-08-06 11:05:39 -07001921}
1922
1923/*
1924 * Flush all the pending work and then disable the inode inactivation background
Darrick J. Wong2254a732023-05-02 09:16:14 +10001925 * workers and wait for them to stop. Caller must hold sb->s_umount to
1926 * coordinate changes in the inodegc_enabled state.
Dave Chinnerab23a772021-08-06 11:05:39 -07001927 */
1928void
1929xfs_inodegc_stop(
1930 struct xfs_mount *mp)
1931{
Darrick J. Wong2254a732023-05-02 09:16:14 +10001932 bool rerun;
1933
Dave Chinnerab23a772021-08-06 11:05:39 -07001934 if (!xfs_clear_inodegc_enabled(mp))
1935 return;
1936
Darrick J. Wong2254a732023-05-02 09:16:14 +10001937 /*
1938 * Drain all pending inodegc work, including inodes that could be
1939 * queued by racing xfs_inodegc_queue or xfs_inodegc_shrinker_scan
1940 * threads that sample the inodegc state just prior to us clearing it.
1941 * The inodegc flag state prevents new threads from queuing more
1942 * inodes, so we queue pending work items and flush the workqueue until
1943 * all inodegc lists are empty. IOWs, we cannot use drain_workqueue
1944 * here because it does not allow other unserialized mechanisms to
1945 * reschedule inodegc work while this draining is in progress.
1946 */
Dave Chinnerab23a772021-08-06 11:05:39 -07001947 xfs_inodegc_queue_all(mp);
Darrick J. Wong2254a732023-05-02 09:16:14 +10001948 do {
1949 flush_workqueue(mp->m_inodegc_wq);
1950 rerun = xfs_inodegc_queue_all(mp);
1951 } while (rerun);
Dave Chinnerab23a772021-08-06 11:05:39 -07001952
Dave Chinnerab23a772021-08-06 11:05:39 -07001953 trace_xfs_inodegc_stop(mp, __return_address);
1954}
1955
1956/*
1957 * Enable the inode inactivation background workers and schedule deferred inode
Darrick J. Wong2254a732023-05-02 09:16:14 +10001958 * inactivation work if there is any. Caller must hold sb->s_umount to
1959 * coordinate changes in the inodegc_enabled state.
Dave Chinnerab23a772021-08-06 11:05:39 -07001960 */
1961void
1962xfs_inodegc_start(
1963 struct xfs_mount *mp)
1964{
1965 if (xfs_set_inodegc_enabled(mp))
1966 return;
1967
1968 trace_xfs_inodegc_start(mp, __return_address);
1969 xfs_inodegc_queue_all(mp);
1970}
1971
Darrick J. Wong65f03d82021-08-06 11:05:41 -07001972#ifdef CONFIG_XFS_RT
1973static inline bool
1974xfs_inodegc_want_queue_rt_file(
1975 struct xfs_inode *ip)
1976{
1977 struct xfs_mount *mp = ip->i_mount;
Darrick J. Wong65f03d82021-08-06 11:05:41 -07001978
1979 if (!XFS_IS_REALTIME_INODE(ip))
1980 return false;
1981
Darrick J. Wong22292762022-04-12 06:49:42 +10001982 if (__percpu_counter_compare(&mp->m_frextents,
1983 mp->m_low_rtexts[XFS_LOWSP_5_PCNT],
1984 XFS_FDBLOCKS_BATCH) < 0)
1985 return true;
1986
1987 return false;
Darrick J. Wong65f03d82021-08-06 11:05:41 -07001988}
1989#else
1990# define xfs_inodegc_want_queue_rt_file(ip) (false)
1991#endif /* CONFIG_XFS_RT */
1992
Dave Chinnerab23a772021-08-06 11:05:39 -07001993/*
1994 * Schedule the inactivation worker when:
1995 *
1996 * - We've accumulated more than one inode cluster buffer's worth of inodes.
Darrick J. Wong7d6f07d2021-08-06 11:05:40 -07001997 * - There is less than 5% free space left.
Darrick J. Wong108523b2021-08-06 11:05:40 -07001998 * - Any of the quotas for this inode are near an enforcement limit.
Dave Chinnerab23a772021-08-06 11:05:39 -07001999 */
2000static inline bool
2001xfs_inodegc_want_queue_work(
2002 struct xfs_inode *ip,
2003 unsigned int items)
2004{
2005 struct xfs_mount *mp = ip->i_mount;
2006
2007 if (items > mp->m_ino_geo.inodes_per_cluster)
2008 return true;
2009
Darrick J. Wong7d6f07d2021-08-06 11:05:40 -07002010 if (__percpu_counter_compare(&mp->m_fdblocks,
2011 mp->m_low_space[XFS_LOWSP_5_PCNT],
2012 XFS_FDBLOCKS_BATCH) < 0)
2013 return true;
2014
Darrick J. Wong65f03d82021-08-06 11:05:41 -07002015 if (xfs_inodegc_want_queue_rt_file(ip))
2016 return true;
2017
Darrick J. Wong108523b2021-08-06 11:05:40 -07002018 if (xfs_inode_near_dquot_enforcement(ip, XFS_DQTYPE_USER))
2019 return true;
2020
2021 if (xfs_inode_near_dquot_enforcement(ip, XFS_DQTYPE_GROUP))
2022 return true;
2023
2024 if (xfs_inode_near_dquot_enforcement(ip, XFS_DQTYPE_PROJ))
2025 return true;
2026
Dave Chinnerab23a772021-08-06 11:05:39 -07002027 return false;
2028}
2029
2030/*
2031 * Upper bound on the number of inodes in each AG that can be queued for
2032 * inactivation at any given time, to avoid monopolizing the workqueue.
2033 */
2034#define XFS_INODEGC_MAX_BACKLOG (4 * XFS_INODES_PER_CHUNK)
2035
2036/*
2037 * Make the frontend wait for inactivations when:
2038 *
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002039 * - Memory shrinkers queued the inactivation worker and it hasn't finished.
Dave Chinnerab23a772021-08-06 11:05:39 -07002040 * - The queue depth exceeds the maximum allowable percpu backlog.
2041 *
Dave Chinnerf2e812c2024-03-19 09:36:28 +11002042 * Note: If we are in a NOFS context here (e.g. current thread is running a
2043 * transaction) the we don't want to block here as inodegc progress may require
2044 * filesystem resources we hold to make progress and that could result in a
2045 * deadlock. Hence we skip out of here if we are in a scoped NOFS context.
Dave Chinnerab23a772021-08-06 11:05:39 -07002046 */
2047static inline bool
2048xfs_inodegc_want_flush_work(
2049 struct xfs_inode *ip,
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002050 unsigned int items,
2051 unsigned int shrinker_hits)
Dave Chinnerab23a772021-08-06 11:05:39 -07002052{
Dave Chinnerf2e812c2024-03-19 09:36:28 +11002053 if (current->flags & PF_MEMALLOC_NOFS)
Dave Chinnerab23a772021-08-06 11:05:39 -07002054 return false;
2055
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002056 if (shrinker_hits > 0)
2057 return true;
2058
Dave Chinnerab23a772021-08-06 11:05:39 -07002059 if (items > XFS_INODEGC_MAX_BACKLOG)
2060 return true;
2061
2062 return false;
2063}
2064
2065/*
2066 * Queue a background inactivation worker if there are inodes that need to be
2067 * inactivated and higher level xfs code hasn't disabled the background
2068 * workers.
2069 */
2070static void
2071xfs_inodegc_queue(
2072 struct xfs_inode *ip)
2073{
2074 struct xfs_mount *mp = ip->i_mount;
2075 struct xfs_inodegc *gc;
2076 int items;
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002077 unsigned int shrinker_hits;
Darrick J. Wong62334fa2023-09-11 08:39:03 -07002078 unsigned int cpu_nr;
Dave Chinner7cf2b0f2022-06-16 07:44:31 -07002079 unsigned long queue_delay = 1;
Dave Chinnerab23a772021-08-06 11:05:39 -07002080
2081 trace_xfs_inode_set_need_inactive(ip);
2082 spin_lock(&ip->i_flags_lock);
2083 ip->i_flags |= XFS_NEED_INACTIVE;
2084 spin_unlock(&ip->i_flags_lock);
2085
Darrick J. Wong62334fa2023-09-11 08:39:03 -07002086 cpu_nr = get_cpu();
2087 gc = this_cpu_ptr(mp->m_inodegc);
Dave Chinnerab23a772021-08-06 11:05:39 -07002088 llist_add(&ip->i_gclist, &gc->list);
2089 items = READ_ONCE(gc->items);
2090 WRITE_ONCE(gc->items, items + 1);
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002091 shrinker_hits = READ_ONCE(gc->shrinker_hits);
Dave Chinnerab23a772021-08-06 11:05:39 -07002092
Dave Chinner7cf2b0f2022-06-16 07:44:31 -07002093 /*
Darrick J. Wong62334fa2023-09-11 08:39:03 -07002094 * Ensure the list add is always seen by anyone who finds the cpumask
2095 * bit set. This effectively gives the cpumask bit set operation
2096 * release ordering semantics.
2097 */
2098 smp_mb__before_atomic();
2099 if (!cpumask_test_cpu(cpu_nr, &mp->m_inodegc_cpumask))
2100 cpumask_test_and_set_cpu(cpu_nr, &mp->m_inodegc_cpumask);
2101
2102 /*
Dave Chinner7cf2b0f2022-06-16 07:44:31 -07002103 * We queue the work while holding the current CPU so that the work
2104 * is scheduled to run on this CPU.
2105 */
2106 if (!xfs_is_inodegc_enabled(mp)) {
Darrick J. Wong62334fa2023-09-11 08:39:03 -07002107 put_cpu();
Dave Chinnerab23a772021-08-06 11:05:39 -07002108 return;
Dave Chinnerab23a772021-08-06 11:05:39 -07002109 }
2110
Dave Chinner7cf2b0f2022-06-16 07:44:31 -07002111 if (xfs_inodegc_want_queue_work(ip, items))
2112 queue_delay = 0;
2113
2114 trace_xfs_inodegc_queue(mp, __return_address);
Darrick J. Wong03e0add82023-05-02 09:16:05 +10002115 mod_delayed_work_on(current_cpu(), mp->m_inodegc_wq, &gc->work,
2116 queue_delay);
Darrick J. Wong62334fa2023-09-11 08:39:03 -07002117 put_cpu();
Dave Chinner7cf2b0f2022-06-16 07:44:31 -07002118
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002119 if (xfs_inodegc_want_flush_work(ip, items, shrinker_hits)) {
Dave Chinnerab23a772021-08-06 11:05:39 -07002120 trace_xfs_inodegc_throttle(mp, __return_address);
Dave Chinner7cf2b0f2022-06-16 07:44:31 -07002121 flush_delayed_work(&gc->work);
Dave Chinnerab23a772021-08-06 11:05:39 -07002122 }
2123}
2124
2125/*
Dave Chinnerab23a772021-08-06 11:05:39 -07002126 * We set the inode flag atomically with the radix tree tag. Once we get tag
2127 * lookups on the radix tree, this inode flag can go away.
2128 *
2129 * We always use background reclaim here because even if the inode is clean, it
2130 * still may be under IO and hence we have wait for IO completion to occur
2131 * before we can reclaim the inode. The background reclaim path handles this
2132 * more efficiently than we can here, so simply let background reclaim tear down
2133 * all inodes.
2134 */
2135void
2136xfs_inode_mark_reclaimable(
2137 struct xfs_inode *ip)
2138{
2139 struct xfs_mount *mp = ip->i_mount;
2140 bool need_inactive;
2141
2142 XFS_STATS_INC(mp, vn_reclaim);
2143
2144 /*
2145 * We should never get here with any of the reclaim flags already set.
2146 */
2147 ASSERT_ALWAYS(!xfs_iflags_test(ip, XFS_ALL_IRECLAIM_FLAGS));
2148
2149 need_inactive = xfs_inode_needs_inactive(ip);
2150 if (need_inactive) {
2151 xfs_inodegc_queue(ip);
2152 return;
2153 }
2154
2155 /* Going straight to reclaim, so drop the dquots. */
2156 xfs_qm_dqdetach(ip);
2157 xfs_inodegc_set_reclaimable(ip);
2158}
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002159
2160/*
2161 * Register a phony shrinker so that we can run background inodegc sooner when
2162 * there's memory pressure. Inactivation does not itself free any memory but
2163 * it does make inodes reclaimable, which eventually frees memory.
2164 *
2165 * The count function, seek value, and batch value are crafted to trigger the
2166 * scan function during the second round of scanning. Hopefully this means
2167 * that we reclaimed enough memory that initiating metadata transactions won't
2168 * make things worse.
2169 */
2170#define XFS_INODEGC_SHRINKER_COUNT (1UL << DEF_PRIORITY)
2171#define XFS_INODEGC_SHRINKER_BATCH ((XFS_INODEGC_SHRINKER_COUNT / 2) + 1)
2172
2173static unsigned long
2174xfs_inodegc_shrinker_count(
2175 struct shrinker *shrink,
2176 struct shrink_control *sc)
2177{
Qi Zheng1a86a532023-09-11 17:44:34 +08002178 struct xfs_mount *mp = shrink->private_data;
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002179 struct xfs_inodegc *gc;
2180 int cpu;
2181
2182 if (!xfs_is_inodegc_enabled(mp))
2183 return 0;
2184
Darrick J. Wong62334fa2023-09-11 08:39:03 -07002185 for_each_cpu(cpu, &mp->m_inodegc_cpumask) {
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002186 gc = per_cpu_ptr(mp->m_inodegc, cpu);
2187 if (!llist_empty(&gc->list))
2188 return XFS_INODEGC_SHRINKER_COUNT;
2189 }
2190
2191 return 0;
2192}
2193
2194static unsigned long
2195xfs_inodegc_shrinker_scan(
2196 struct shrinker *shrink,
2197 struct shrink_control *sc)
2198{
Qi Zheng1a86a532023-09-11 17:44:34 +08002199 struct xfs_mount *mp = shrink->private_data;
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002200 struct xfs_inodegc *gc;
2201 int cpu;
2202 bool no_items = true;
2203
2204 if (!xfs_is_inodegc_enabled(mp))
2205 return SHRINK_STOP;
2206
2207 trace_xfs_inodegc_shrinker_scan(mp, sc, __return_address);
2208
Darrick J. Wong62334fa2023-09-11 08:39:03 -07002209 for_each_cpu(cpu, &mp->m_inodegc_cpumask) {
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002210 gc = per_cpu_ptr(mp->m_inodegc, cpu);
2211 if (!llist_empty(&gc->list)) {
2212 unsigned int h = READ_ONCE(gc->shrinker_hits);
2213
2214 WRITE_ONCE(gc->shrinker_hits, h + 1);
Dave Chinner7cf2b0f2022-06-16 07:44:31 -07002215 mod_delayed_work_on(cpu, mp->m_inodegc_wq, &gc->work, 0);
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002216 no_items = false;
2217 }
2218 }
2219
2220 /*
2221 * If there are no inodes to inactivate, we don't want the shrinker
2222 * to think there's deferred work to call us back about.
2223 */
2224 if (no_items)
2225 return LONG_MAX;
2226
2227 return SHRINK_STOP;
2228}
2229
2230/* Register a shrinker so we can accelerate inodegc and throttle queuing. */
2231int
2232xfs_inodegc_register_shrinker(
2233 struct xfs_mount *mp)
2234{
Qi Zheng1a86a532023-09-11 17:44:34 +08002235 mp->m_inodegc_shrinker = shrinker_alloc(SHRINKER_NONSLAB,
2236 "xfs-inodegc:%s",
2237 mp->m_super->s_id);
2238 if (!mp->m_inodegc_shrinker)
2239 return -ENOMEM;
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002240
Qi Zheng1a86a532023-09-11 17:44:34 +08002241 mp->m_inodegc_shrinker->count_objects = xfs_inodegc_shrinker_count;
2242 mp->m_inodegc_shrinker->scan_objects = xfs_inodegc_shrinker_scan;
2243 mp->m_inodegc_shrinker->seeks = 0;
2244 mp->m_inodegc_shrinker->batch = XFS_INODEGC_SHRINKER_BATCH;
2245 mp->m_inodegc_shrinker->private_data = mp;
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002246
Qi Zheng1a86a532023-09-11 17:44:34 +08002247 shrinker_register(mp->m_inodegc_shrinker);
2248
2249 return 0;
Darrick J. Wong40b1de0072021-08-06 11:05:43 -07002250}