1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
8 #include "xfs_shared.h"
9 #include "xfs_format.h"
10 #include "xfs_log_format.h"
11 #include "xfs_trans_resv.h"
12 #include "xfs_mount.h"
13 #include "xfs_inode.h"
14 #include "xfs_trans.h"
15 #include "xfs_trans_priv.h"
16 #include "xfs_inode_item.h"
17 #include "xfs_quota.h"
18 #include "xfs_trace.h"
19 #include "xfs_icache.h"
20 #include "xfs_bmap_util.h"
21 #include "xfs_dquot_item.h"
22 #include "xfs_dquot.h"
23 #include "xfs_reflink.h"
24 #include "xfs_ialloc.h"
26 #include "xfs_log_priv.h"
28 #include <linux/iversion.h>
30 /* Radix tree tags for incore inode tree. */
32 /* inode is to be reclaimed */
33 #define XFS_ICI_RECLAIM_TAG 0
34 /* Inode has speculative preallocations (posteof or cow) to clean. */
35 #define XFS_ICI_BLOCKGC_TAG 1
38 * The goal for walking incore inodes. These can correspond with incore inode
39 * radix tree tags when convenient. Avoid existing XFS_IWALK namespace.
41 enum xfs_icwalk_goal {
42 /* Goals directly associated with tagged inodes. */
43 XFS_ICWALK_BLOCKGC = XFS_ICI_BLOCKGC_TAG,
44 XFS_ICWALK_RECLAIM = XFS_ICI_RECLAIM_TAG,
47 static int xfs_icwalk(struct xfs_mount *mp,
48 enum xfs_icwalk_goal goal, struct xfs_icwalk *icw);
49 static int xfs_icwalk_ag(struct xfs_perag *pag,
50 enum xfs_icwalk_goal goal, struct xfs_icwalk *icw);
53 * Private inode cache walk flags for struct xfs_icwalk. Must not
54 * coincide with XFS_ICWALK_FLAGS_VALID.
57 /* Stop scanning after icw_scan_limit inodes. */
58 #define XFS_ICWALK_FLAG_SCAN_LIMIT (1U << 28)
60 #define XFS_ICWALK_FLAG_RECLAIM_SICK (1U << 27)
61 #define XFS_ICWALK_FLAG_UNION (1U << 26) /* union filter algorithm */
63 #define XFS_ICWALK_PRIVATE_FLAGS (XFS_ICWALK_FLAG_SCAN_LIMIT | \
64 XFS_ICWALK_FLAG_RECLAIM_SICK | \
65 XFS_ICWALK_FLAG_UNION)
68 * Allocate and initialise an xfs_inode.
78 * XXX: If this didn't occur in transactions, we could drop GFP_NOFAIL
79 * and return NULL here on ENOMEM.
81 ip = alloc_inode_sb(mp->m_super, xfs_inode_cache, GFP_KERNEL | __GFP_NOFAIL);
83 if (inode_init_always(mp->m_super, VFS_I(ip))) {
84 kmem_cache_free(xfs_inode_cache, ip);
88 /* VFS doesn't initialise i_mode or i_state! */
89 VFS_I(ip)->i_mode = 0;
90 VFS_I(ip)->i_state = 0;
91 mapping_set_large_folios(VFS_I(ip)->i_mapping);
93 XFS_STATS_INC(mp, vn_active);
94 ASSERT(atomic_read(&ip->i_pincount) == 0);
95 ASSERT(ip->i_ino == 0);
97 /* initialise the xfs inode */
100 memset(&ip->i_imap, 0, sizeof(struct xfs_imap));
102 memset(&ip->i_af, 0, sizeof(ip->i_af));
103 ip->i_af.if_format = XFS_DINODE_FMT_EXTENTS;
104 memset(&ip->i_df, 0, sizeof(ip->i_df));
106 ip->i_delayed_blks = 0;
107 ip->i_diflags2 = mp->m_ino_geo.new_diflags2;
112 INIT_WORK(&ip->i_ioend_work, xfs_end_io);
113 INIT_LIST_HEAD(&ip->i_ioend_list);
114 spin_lock_init(&ip->i_ioend_lock);
115 ip->i_next_unlinked = NULLAGINO;
116 ip->i_prev_unlinked = NULLAGINO;
122 xfs_inode_free_callback(
123 struct rcu_head *head)
125 struct inode *inode = container_of(head, struct inode, i_rcu);
126 struct xfs_inode *ip = XFS_I(inode);
128 switch (VFS_I(ip)->i_mode & S_IFMT) {
132 xfs_idestroy_fork(&ip->i_df);
136 xfs_ifork_zap_attr(ip);
139 xfs_idestroy_fork(ip->i_cowfp);
140 kmem_cache_free(xfs_ifork_cache, ip->i_cowfp);
143 ASSERT(!test_bit(XFS_LI_IN_AIL,
144 &ip->i_itemp->ili_item.li_flags));
145 xfs_inode_item_destroy(ip);
149 kmem_cache_free(xfs_inode_cache, ip);
154 struct xfs_inode *ip)
156 /* asserts to verify all state is correct here */
157 ASSERT(atomic_read(&ip->i_pincount) == 0);
158 ASSERT(!ip->i_itemp || list_empty(&ip->i_itemp->ili_item.li_bio_list));
159 XFS_STATS_DEC(ip->i_mount, vn_active);
161 call_rcu(&VFS_I(ip)->i_rcu, xfs_inode_free_callback);
166 struct xfs_inode *ip)
168 ASSERT(!xfs_iflags_test(ip, XFS_IFLUSHING));
171 * Because we use RCU freeing we need to ensure the inode always
172 * appears to be reclaimed with an invalid inode number when in the
173 * free state. The ip->i_flags_lock provides the barrier against lookup
176 spin_lock(&ip->i_flags_lock);
177 ip->i_flags = XFS_IRECLAIM;
179 spin_unlock(&ip->i_flags_lock);
181 __xfs_inode_free(ip);
185 * Queue background inode reclaim work if there are reclaimable inodes and there
186 * isn't reclaim work already scheduled or in progress.
189 xfs_reclaim_work_queue(
190 struct xfs_mount *mp)
194 if (radix_tree_tagged(&mp->m_perag_tree, XFS_ICI_RECLAIM_TAG)) {
195 queue_delayed_work(mp->m_reclaim_workqueue, &mp->m_reclaim_work,
196 msecs_to_jiffies(xfs_syncd_centisecs / 6 * 10));
202 * Background scanning to trim preallocated space. This is queued based on the
203 * 'speculative_prealloc_lifetime' tunable (5m by default).
207 struct xfs_perag *pag)
209 struct xfs_mount *mp = pag->pag_mount;
211 if (!xfs_is_blockgc_enabled(mp))
215 if (radix_tree_tagged(&pag->pag_ici_root, XFS_ICI_BLOCKGC_TAG))
216 queue_delayed_work(pag->pag_mount->m_blockgc_wq,
217 &pag->pag_blockgc_work,
218 msecs_to_jiffies(xfs_blockgc_secs * 1000));
222 /* Set a tag on both the AG incore inode tree and the AG radix tree. */
224 xfs_perag_set_inode_tag(
225 struct xfs_perag *pag,
229 struct xfs_mount *mp = pag->pag_mount;
232 lockdep_assert_held(&pag->pag_ici_lock);
234 was_tagged = radix_tree_tagged(&pag->pag_ici_root, tag);
235 radix_tree_tag_set(&pag->pag_ici_root, agino, tag);
237 if (tag == XFS_ICI_RECLAIM_TAG)
238 pag->pag_ici_reclaimable++;
243 /* propagate the tag up into the perag radix tree */
244 spin_lock(&mp->m_perag_lock);
245 radix_tree_tag_set(&mp->m_perag_tree, pag->pag_agno, tag);
246 spin_unlock(&mp->m_perag_lock);
248 /* start background work */
250 case XFS_ICI_RECLAIM_TAG:
251 xfs_reclaim_work_queue(mp);
253 case XFS_ICI_BLOCKGC_TAG:
254 xfs_blockgc_queue(pag);
258 trace_xfs_perag_set_inode_tag(pag, _RET_IP_);
261 /* Clear a tag on both the AG incore inode tree and the AG radix tree. */
263 xfs_perag_clear_inode_tag(
264 struct xfs_perag *pag,
268 struct xfs_mount *mp = pag->pag_mount;
270 lockdep_assert_held(&pag->pag_ici_lock);
273 * Reclaim can signal (with a null agino) that it cleared its own tag
274 * by removing the inode from the radix tree.
276 if (agino != NULLAGINO)
277 radix_tree_tag_clear(&pag->pag_ici_root, agino, tag);
279 ASSERT(tag == XFS_ICI_RECLAIM_TAG);
281 if (tag == XFS_ICI_RECLAIM_TAG)
282 pag->pag_ici_reclaimable--;
284 if (radix_tree_tagged(&pag->pag_ici_root, tag))
287 /* clear the tag from the perag radix tree */
288 spin_lock(&mp->m_perag_lock);
289 radix_tree_tag_clear(&mp->m_perag_tree, pag->pag_agno, tag);
290 spin_unlock(&mp->m_perag_lock);
292 trace_xfs_perag_clear_inode_tag(pag, _RET_IP_);
296 * When we recycle a reclaimable inode, we need to re-initialise the VFS inode
297 * part of the structure. This is made more complex by the fact we store
298 * information about the on-disk values in the VFS inode and so we can't just
299 * overwrite the values unconditionally. Hence we save the parameters we
300 * need to retain across reinitialisation, and rewrite them into the VFS inode
301 * after reinitialisation even if it fails.
305 struct xfs_mount *mp,
309 uint32_t nlink = inode->i_nlink;
310 uint32_t generation = inode->i_generation;
311 uint64_t version = inode_peek_iversion(inode);
312 umode_t mode = inode->i_mode;
313 dev_t dev = inode->i_rdev;
314 kuid_t uid = inode->i_uid;
315 kgid_t gid = inode->i_gid;
317 error = inode_init_always(mp->m_super, inode);
319 set_nlink(inode, nlink);
320 inode->i_generation = generation;
321 inode_set_iversion_queried(inode, version);
322 inode->i_mode = mode;
326 mapping_set_large_folios(inode->i_mapping);
331 * Carefully nudge an inode whose VFS state has been torn down back into a
332 * usable state. Drops the i_flags_lock and the rcu read lock.
336 struct xfs_perag *pag,
337 struct xfs_inode *ip) __releases(&ip->i_flags_lock)
339 struct xfs_mount *mp = ip->i_mount;
340 struct inode *inode = VFS_I(ip);
343 trace_xfs_iget_recycle(ip);
345 if (!xfs_ilock_nowait(ip, XFS_ILOCK_EXCL))
349 * We need to make it look like the inode is being reclaimed to prevent
350 * the actual reclaim workers from stomping over us while we recycle
351 * the inode. We can't clear the radix tree tag yet as it requires
352 * pag_ici_lock to be held exclusive.
354 ip->i_flags |= XFS_IRECLAIM;
356 spin_unlock(&ip->i_flags_lock);
359 ASSERT(!rwsem_is_locked(&inode->i_rwsem));
360 error = xfs_reinit_inode(mp, inode);
361 xfs_iunlock(ip, XFS_ILOCK_EXCL);
364 * Re-initializing the inode failed, and we are in deep
365 * trouble. Try to re-add it to the reclaim list.
368 spin_lock(&ip->i_flags_lock);
369 ip->i_flags &= ~(XFS_INEW | XFS_IRECLAIM);
370 ASSERT(ip->i_flags & XFS_IRECLAIMABLE);
371 spin_unlock(&ip->i_flags_lock);
374 trace_xfs_iget_recycle_fail(ip);
378 spin_lock(&pag->pag_ici_lock);
379 spin_lock(&ip->i_flags_lock);
382 * Clear the per-lifetime state in the inode as we are now effectively
383 * a new inode and need to return to the initial state before reuse
386 ip->i_flags &= ~XFS_IRECLAIM_RESET_FLAGS;
387 ip->i_flags |= XFS_INEW;
388 xfs_perag_clear_inode_tag(pag, XFS_INO_TO_AGINO(mp, ip->i_ino),
389 XFS_ICI_RECLAIM_TAG);
390 inode->i_state = I_NEW;
391 spin_unlock(&ip->i_flags_lock);
392 spin_unlock(&pag->pag_ici_lock);
398 * If we are allocating a new inode, then check what was returned is
399 * actually a free, empty inode. If we are not allocating an inode,
400 * then check we didn't find a free inode.
403 * 0 if the inode free state matches the lookup context
404 * -ENOENT if the inode is free and we are not allocating
405 * -EFSCORRUPTED if there is any state mismatch at all
408 xfs_iget_check_free_state(
409 struct xfs_inode *ip,
412 if (flags & XFS_IGET_CREATE) {
413 /* should be a free inode */
414 if (VFS_I(ip)->i_mode != 0) {
415 xfs_warn(ip->i_mount,
416 "Corruption detected! Free inode 0x%llx not marked free! (mode 0x%x)",
417 ip->i_ino, VFS_I(ip)->i_mode);
418 return -EFSCORRUPTED;
421 if (ip->i_nblocks != 0) {
422 xfs_warn(ip->i_mount,
423 "Corruption detected! Free inode 0x%llx has blocks allocated!",
425 return -EFSCORRUPTED;
430 /* should be an allocated inode */
431 if (VFS_I(ip)->i_mode == 0)
437 /* Make all pending inactivation work start immediately. */
439 xfs_inodegc_queue_all(
440 struct xfs_mount *mp)
442 struct xfs_inodegc *gc;
445 for_each_online_cpu(cpu) {
446 gc = per_cpu_ptr(mp->m_inodegc, cpu);
447 if (!llist_empty(&gc->list))
448 mod_delayed_work_on(cpu, mp->m_inodegc_wq, &gc->work, 0);
453 * Check the validity of the inode we just found it the cache
457 struct xfs_perag *pag,
458 struct xfs_inode *ip,
461 int lock_flags) __releases(RCU)
463 struct inode *inode = VFS_I(ip);
464 struct xfs_mount *mp = ip->i_mount;
468 * check for re-use of an inode within an RCU grace period due to the
469 * radix tree nodes not being updated yet. We monitor for this by
470 * setting the inode number to zero before freeing the inode structure.
471 * If the inode has been reallocated and set up, then the inode number
472 * will not match, so check for that, too.
474 spin_lock(&ip->i_flags_lock);
475 if (ip->i_ino != ino)
479 * If we are racing with another cache hit that is currently
480 * instantiating this inode or currently recycling it out of
481 * reclaimable state, wait for the initialisation to complete
484 * If we're racing with the inactivation worker we also want to wait.
485 * If we're creating a new file, it's possible that the worker
486 * previously marked the inode as free on disk but hasn't finished
487 * updating the incore state yet. The AGI buffer will be dirty and
488 * locked to the icreate transaction, so a synchronous push of the
489 * inodegc workers would result in deadlock. For a regular iget, the
490 * worker is running already, so we might as well wait.
492 * XXX(hch): eventually we should do something equivalent to
493 * wait_on_inode to wait for these flags to be cleared
494 * instead of polling for it.
496 if (ip->i_flags & (XFS_INEW | XFS_IRECLAIM | XFS_INACTIVATING))
499 if (ip->i_flags & XFS_NEED_INACTIVE) {
500 /* Unlinked inodes cannot be re-grabbed. */
501 if (VFS_I(ip)->i_nlink == 0) {
505 goto out_inodegc_flush;
509 * Check the inode free state is valid. This also detects lookup
510 * racing with unlinks.
512 error = xfs_iget_check_free_state(ip, flags);
516 /* Skip inodes that have no vfs state. */
517 if ((flags & XFS_IGET_INCORE) &&
518 (ip->i_flags & XFS_IRECLAIMABLE))
521 /* The inode fits the selection criteria; process it. */
522 if (ip->i_flags & XFS_IRECLAIMABLE) {
523 /* Drops i_flags_lock and RCU read lock. */
524 error = xfs_iget_recycle(pag, ip);
525 if (error == -EAGAIN)
530 /* If the VFS inode is being torn down, pause and try again. */
534 /* We've got a live one. */
535 spin_unlock(&ip->i_flags_lock);
537 trace_xfs_iget_hit(ip);
541 xfs_ilock(ip, lock_flags);
543 if (!(flags & XFS_IGET_INCORE))
544 xfs_iflags_clear(ip, XFS_ISTALE);
545 XFS_STATS_INC(mp, xs_ig_found);
550 trace_xfs_iget_skip(ip);
551 XFS_STATS_INC(mp, xs_ig_frecycle);
554 spin_unlock(&ip->i_flags_lock);
559 spin_unlock(&ip->i_flags_lock);
562 * Do not wait for the workers, because the caller could hold an AGI
563 * buffer lock. We're just going to sleep in a loop anyway.
565 if (xfs_is_inodegc_enabled(mp))
566 xfs_inodegc_queue_all(mp);
572 struct xfs_mount *mp,
573 struct xfs_perag *pag,
576 struct xfs_inode **ipp,
580 struct xfs_inode *ip;
582 xfs_agino_t agino = XFS_INO_TO_AGINO(mp, ino);
585 ip = xfs_inode_alloc(mp, ino);
589 error = xfs_imap(pag, tp, ip->i_ino, &ip->i_imap, flags);
594 * For version 5 superblocks, if we are initialising a new inode and we
595 * are not utilising the XFS_FEAT_IKEEP inode cluster mode, we can
596 * simply build the new inode core with a random generation number.
598 * For version 4 (and older) superblocks, log recovery is dependent on
599 * the i_flushiter field being initialised from the current on-disk
600 * value and hence we must also read the inode off disk even when
601 * initializing new inodes.
603 if (xfs_has_v3inodes(mp) &&
604 (flags & XFS_IGET_CREATE) && !xfs_has_ikeep(mp)) {
605 VFS_I(ip)->i_generation = get_random_u32();
609 error = xfs_imap_to_bp(mp, tp, &ip->i_imap, &bp);
613 error = xfs_inode_from_disk(ip,
614 xfs_buf_offset(bp, ip->i_imap.im_boffset));
616 xfs_buf_set_ref(bp, XFS_INO_REF);
617 xfs_trans_brelse(tp, bp);
623 trace_xfs_iget_miss(ip);
626 * Check the inode free state is valid. This also detects lookup
627 * racing with unlinks.
629 error = xfs_iget_check_free_state(ip, flags);
634 * Preload the radix tree so we can insert safely under the
635 * write spinlock. Note that we cannot sleep inside the preload
636 * region. Since we can be called from transaction context, don't
637 * recurse into the file system.
639 if (radix_tree_preload(GFP_NOFS)) {
645 * Because the inode hasn't been added to the radix-tree yet it can't
646 * be found by another thread, so we can do the non-sleeping lock here.
649 if (!xfs_ilock_nowait(ip, lock_flags))
654 * These values must be set before inserting the inode into the radix
655 * tree as the moment it is inserted a concurrent lookup (allowed by the
656 * RCU locking mechanism) can find it and that lookup must see that this
657 * is an inode currently under construction (i.e. that XFS_INEW is set).
658 * The ip->i_flags_lock that protects the XFS_INEW flag forms the
659 * memory barrier that ensures this detection works correctly at lookup
663 if (flags & XFS_IGET_DONTCACHE)
664 d_mark_dontcache(VFS_I(ip));
668 xfs_iflags_set(ip, iflags);
670 /* insert the new inode */
671 spin_lock(&pag->pag_ici_lock);
672 error = radix_tree_insert(&pag->pag_ici_root, agino, ip);
673 if (unlikely(error)) {
674 WARN_ON(error != -EEXIST);
675 XFS_STATS_INC(mp, xs_ig_dup);
677 goto out_preload_end;
679 spin_unlock(&pag->pag_ici_lock);
680 radix_tree_preload_end();
686 spin_unlock(&pag->pag_ici_lock);
687 radix_tree_preload_end();
689 xfs_iunlock(ip, lock_flags);
691 __destroy_inode(VFS_I(ip));
697 * Look up an inode by number in the given file system. The inode is looked up
698 * in the cache held in each AG. If the inode is found in the cache, initialise
699 * the vfs inode if necessary.
701 * If it is not in core, read it in from the file system's device, add it to the
702 * cache and initialise the vfs inode.
704 * The inode is locked according to the value of the lock_flags parameter.
705 * Inode lookup is only done during metadata operations and not as part of the
706 * data IO path. Hence we only allow locking of the XFS_ILOCK during lookup.
710 struct xfs_mount *mp,
711 struct xfs_trans *tp,
715 struct xfs_inode **ipp)
717 struct xfs_inode *ip;
718 struct xfs_perag *pag;
722 ASSERT((lock_flags & (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED)) == 0);
724 /* reject inode numbers outside existing AGs */
725 if (!ino || XFS_INO_TO_AGNO(mp, ino) >= mp->m_sb.sb_agcount)
728 XFS_STATS_INC(mp, xs_ig_attempts);
730 /* get the perag structure and ensure that it's inode capable */
731 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ino));
732 agino = XFS_INO_TO_AGINO(mp, ino);
737 ip = radix_tree_lookup(&pag->pag_ici_root, agino);
740 error = xfs_iget_cache_hit(pag, ip, ino, flags, lock_flags);
742 goto out_error_or_again;
745 if (flags & XFS_IGET_INCORE) {
747 goto out_error_or_again;
749 XFS_STATS_INC(mp, xs_ig_missed);
751 error = xfs_iget_cache_miss(mp, pag, tp, ino, &ip,
754 goto out_error_or_again;
761 * If we have a real type for an on-disk inode, we can setup the inode
762 * now. If it's a new inode being created, xfs_init_new_inode will
765 if (xfs_iflags_test(ip, XFS_INEW) && VFS_I(ip)->i_mode != 0)
766 xfs_setup_existing_inode(ip);
770 if (!(flags & (XFS_IGET_INCORE | XFS_IGET_NORETRY)) &&
780 * "Is this a cached inode that's also allocated?"
782 * Look up an inode by number in the given file system. If the inode is
783 * in cache and isn't in purgatory, return 1 if the inode is allocated
784 * and 0 if it is not. For all other cases (not in cache, being torn
785 * down, etc.), return a negative error code.
787 * The caller has to prevent inode allocation and freeing activity,
788 * presumably by locking the AGI buffer. This is to ensure that an
789 * inode cannot transition from allocated to freed until the caller is
790 * ready to allow that. If the inode is in an intermediate state (new,
791 * reclaimable, or being reclaimed), -EAGAIN will be returned; if the
792 * inode is not in the cache, -ENOENT will be returned. The caller must
793 * deal with these scenarios appropriately.
795 * This is a specialized use case for the online scrubber; if you're
796 * reading this, you probably want xfs_iget.
799 xfs_icache_inode_is_allocated(
800 struct xfs_mount *mp,
801 struct xfs_trans *tp,
805 struct xfs_inode *ip;
808 error = xfs_iget(mp, tp, ino, XFS_IGET_INCORE, 0, &ip);
812 *inuse = !!(VFS_I(ip)->i_mode);
818 * Grab the inode for reclaim exclusively.
820 * We have found this inode via a lookup under RCU, so the inode may have
821 * already been freed, or it may be in the process of being recycled by
822 * xfs_iget(). In both cases, the inode will have XFS_IRECLAIM set. If the inode
823 * has been fully recycled by the time we get the i_flags_lock, XFS_IRECLAIMABLE
824 * will not be set. Hence we need to check for both these flag conditions to
825 * avoid inodes that are no longer reclaim candidates.
827 * Note: checking for other state flags here, under the i_flags_lock or not, is
828 * racy and should be avoided. Those races should be resolved only after we have
829 * ensured that we are able to reclaim this inode and the world can see that we
830 * are going to reclaim it.
832 * Return true if we grabbed it, false otherwise.
836 struct xfs_inode *ip,
837 struct xfs_icwalk *icw)
839 ASSERT(rcu_read_lock_held());
841 spin_lock(&ip->i_flags_lock);
842 if (!__xfs_iflags_test(ip, XFS_IRECLAIMABLE) ||
843 __xfs_iflags_test(ip, XFS_IRECLAIM)) {
844 /* not a reclaim candidate. */
845 spin_unlock(&ip->i_flags_lock);
849 /* Don't reclaim a sick inode unless the caller asked for it. */
851 (!icw || !(icw->icw_flags & XFS_ICWALK_FLAG_RECLAIM_SICK))) {
852 spin_unlock(&ip->i_flags_lock);
856 __xfs_iflags_set(ip, XFS_IRECLAIM);
857 spin_unlock(&ip->i_flags_lock);
862 * Inode reclaim is non-blocking, so the default action if progress cannot be
863 * made is to "requeue" the inode for reclaim by unlocking it and clearing the
864 * XFS_IRECLAIM flag. If we are in a shutdown state, we don't care about
865 * blocking anymore and hence we can wait for the inode to be able to reclaim
868 * We do no IO here - if callers require inodes to be cleaned they must push the
869 * AIL first to trigger writeback of dirty inodes. This enables writeback to be
870 * done in the background in a non-blocking manner, and enables memory reclaim
871 * to make progress without blocking.
875 struct xfs_inode *ip,
876 struct xfs_perag *pag)
878 xfs_ino_t ino = ip->i_ino; /* for radix_tree_delete */
880 if (!xfs_ilock_nowait(ip, XFS_ILOCK_EXCL))
882 if (xfs_iflags_test_and_set(ip, XFS_IFLUSHING))
886 * Check for log shutdown because aborting the inode can move the log
887 * tail and corrupt in memory state. This is fine if the log is shut
888 * down, but if the log is still active and only the mount is shut down
889 * then the in-memory log tail movement caused by the abort can be
890 * incorrectly propagated to disk.
892 if (xlog_is_shutdown(ip->i_mount->m_log)) {
894 xfs_iflush_shutdown_abort(ip);
897 if (xfs_ipincount(ip))
898 goto out_clear_flush;
899 if (!xfs_inode_clean(ip))
900 goto out_clear_flush;
902 xfs_iflags_clear(ip, XFS_IFLUSHING);
904 trace_xfs_inode_reclaiming(ip);
907 * Because we use RCU freeing we need to ensure the inode always appears
908 * to be reclaimed with an invalid inode number when in the free state.
909 * We do this as early as possible under the ILOCK so that
910 * xfs_iflush_cluster() and xfs_ifree_cluster() can be guaranteed to
911 * detect races with us here. By doing this, we guarantee that once
912 * xfs_iflush_cluster() or xfs_ifree_cluster() has locked XFS_ILOCK that
913 * it will see either a valid inode that will serialise correctly, or it
914 * will see an invalid inode that it can skip.
916 spin_lock(&ip->i_flags_lock);
917 ip->i_flags = XFS_IRECLAIM;
921 spin_unlock(&ip->i_flags_lock);
923 ASSERT(!ip->i_itemp || ip->i_itemp->ili_item.li_buf == NULL);
924 xfs_iunlock(ip, XFS_ILOCK_EXCL);
926 XFS_STATS_INC(ip->i_mount, xs_ig_reclaims);
928 * Remove the inode from the per-AG radix tree.
930 * Because radix_tree_delete won't complain even if the item was never
931 * added to the tree assert that it's been there before to catch
932 * problems with the inode life time early on.
934 spin_lock(&pag->pag_ici_lock);
935 if (!radix_tree_delete(&pag->pag_ici_root,
936 XFS_INO_TO_AGINO(ip->i_mount, ino)))
938 xfs_perag_clear_inode_tag(pag, NULLAGINO, XFS_ICI_RECLAIM_TAG);
939 spin_unlock(&pag->pag_ici_lock);
942 * Here we do an (almost) spurious inode lock in order to coordinate
943 * with inode cache radix tree lookups. This is because the lookup
944 * can reference the inodes in the cache without taking references.
946 * We make that OK here by ensuring that we wait until the inode is
947 * unlocked after the lookup before we go ahead and free it.
949 xfs_ilock(ip, XFS_ILOCK_EXCL);
950 ASSERT(!ip->i_udquot && !ip->i_gdquot && !ip->i_pdquot);
951 xfs_iunlock(ip, XFS_ILOCK_EXCL);
952 ASSERT(xfs_inode_clean(ip));
954 __xfs_inode_free(ip);
958 xfs_iflags_clear(ip, XFS_IFLUSHING);
960 xfs_iunlock(ip, XFS_ILOCK_EXCL);
962 xfs_iflags_clear(ip, XFS_IRECLAIM);
965 /* Reclaim sick inodes if we're unmounting or the fs went down. */
967 xfs_want_reclaim_sick(
968 struct xfs_mount *mp)
970 return xfs_is_unmounting(mp) || xfs_has_norecovery(mp) ||
976 struct xfs_mount *mp)
978 struct xfs_icwalk icw = {
982 if (xfs_want_reclaim_sick(mp))
983 icw.icw_flags |= XFS_ICWALK_FLAG_RECLAIM_SICK;
985 while (radix_tree_tagged(&mp->m_perag_tree, XFS_ICI_RECLAIM_TAG)) {
986 xfs_ail_push_all_sync(mp->m_ail);
987 xfs_icwalk(mp, XFS_ICWALK_RECLAIM, &icw);
992 * The shrinker infrastructure determines how many inodes we should scan for
993 * reclaim. We want as many clean inodes ready to reclaim as possible, so we
994 * push the AIL here. We also want to proactively free up memory if we can to
995 * minimise the amount of work memory reclaim has to do so we kick the
996 * background reclaim if it isn't already scheduled.
999 xfs_reclaim_inodes_nr(
1000 struct xfs_mount *mp,
1001 unsigned long nr_to_scan)
1003 struct xfs_icwalk icw = {
1004 .icw_flags = XFS_ICWALK_FLAG_SCAN_LIMIT,
1005 .icw_scan_limit = min_t(unsigned long, LONG_MAX, nr_to_scan),
1008 if (xfs_want_reclaim_sick(mp))
1009 icw.icw_flags |= XFS_ICWALK_FLAG_RECLAIM_SICK;
1011 /* kick background reclaimer and push the AIL */
1012 xfs_reclaim_work_queue(mp);
1013 xfs_ail_push_all(mp->m_ail);
1015 xfs_icwalk(mp, XFS_ICWALK_RECLAIM, &icw);
1020 * Return the number of reclaimable inodes in the filesystem for
1021 * the shrinker to determine how much to reclaim.
1024 xfs_reclaim_inodes_count(
1025 struct xfs_mount *mp)
1027 struct xfs_perag *pag;
1028 xfs_agnumber_t ag = 0;
1029 long reclaimable = 0;
1031 while ((pag = xfs_perag_get_tag(mp, ag, XFS_ICI_RECLAIM_TAG))) {
1032 ag = pag->pag_agno + 1;
1033 reclaimable += pag->pag_ici_reclaimable;
1040 xfs_icwalk_match_id(
1041 struct xfs_inode *ip,
1042 struct xfs_icwalk *icw)
1044 if ((icw->icw_flags & XFS_ICWALK_FLAG_UID) &&
1045 !uid_eq(VFS_I(ip)->i_uid, icw->icw_uid))
1048 if ((icw->icw_flags & XFS_ICWALK_FLAG_GID) &&
1049 !gid_eq(VFS_I(ip)->i_gid, icw->icw_gid))
1052 if ((icw->icw_flags & XFS_ICWALK_FLAG_PRID) &&
1053 ip->i_projid != icw->icw_prid)
1060 * A union-based inode filtering algorithm. Process the inode if any of the
1061 * criteria match. This is for global/internal scans only.
1064 xfs_icwalk_match_id_union(
1065 struct xfs_inode *ip,
1066 struct xfs_icwalk *icw)
1068 if ((icw->icw_flags & XFS_ICWALK_FLAG_UID) &&
1069 uid_eq(VFS_I(ip)->i_uid, icw->icw_uid))
1072 if ((icw->icw_flags & XFS_ICWALK_FLAG_GID) &&
1073 gid_eq(VFS_I(ip)->i_gid, icw->icw_gid))
1076 if ((icw->icw_flags & XFS_ICWALK_FLAG_PRID) &&
1077 ip->i_projid == icw->icw_prid)
1084 * Is this inode @ip eligible for eof/cow block reclamation, given some
1085 * filtering parameters @icw? The inode is eligible if @icw is null or
1086 * if the predicate functions match.
1090 struct xfs_inode *ip,
1091 struct xfs_icwalk *icw)
1098 if (icw->icw_flags & XFS_ICWALK_FLAG_UNION)
1099 match = xfs_icwalk_match_id_union(ip, icw);
1101 match = xfs_icwalk_match_id(ip, icw);
1105 /* skip the inode if the file size is too small */
1106 if ((icw->icw_flags & XFS_ICWALK_FLAG_MINFILESIZE) &&
1107 XFS_ISIZE(ip) < icw->icw_min_file_size)
1114 * This is a fast pass over the inode cache to try to get reclaim moving on as
1115 * many inodes as possible in a short period of time. It kicks itself every few
1116 * seconds, as well as being kicked by the inode cache shrinker when memory
1121 struct work_struct *work)
1123 struct xfs_mount *mp = container_of(to_delayed_work(work),
1124 struct xfs_mount, m_reclaim_work);
1126 xfs_icwalk(mp, XFS_ICWALK_RECLAIM, NULL);
1127 xfs_reclaim_work_queue(mp);
1131 xfs_inode_free_eofblocks(
1132 struct xfs_inode *ip,
1133 struct xfs_icwalk *icw,
1134 unsigned int *lockflags)
1138 wait = icw && (icw->icw_flags & XFS_ICWALK_FLAG_SYNC);
1140 if (!xfs_iflags_test(ip, XFS_IEOFBLOCKS))
1144 * If the mapping is dirty the operation can block and wait for some
1145 * time. Unless we are waiting, skip it.
1147 if (!wait && mapping_tagged(VFS_I(ip)->i_mapping, PAGECACHE_TAG_DIRTY))
1150 if (!xfs_icwalk_match(ip, icw))
1154 * If the caller is waiting, return -EAGAIN to keep the background
1155 * scanner moving and revisit the inode in a subsequent pass.
1157 if (!xfs_ilock_nowait(ip, XFS_IOLOCK_EXCL)) {
1162 *lockflags |= XFS_IOLOCK_EXCL;
1164 if (xfs_can_free_eofblocks(ip, false))
1165 return xfs_free_eofblocks(ip);
1167 /* inode could be preallocated or append-only */
1168 trace_xfs_inode_free_eofblocks_invalid(ip);
1169 xfs_inode_clear_eofblocks_tag(ip);
1174 xfs_blockgc_set_iflag(
1175 struct xfs_inode *ip,
1176 unsigned long iflag)
1178 struct xfs_mount *mp = ip->i_mount;
1179 struct xfs_perag *pag;
1181 ASSERT((iflag & ~(XFS_IEOFBLOCKS | XFS_ICOWBLOCKS)) == 0);
1184 * Don't bother locking the AG and looking up in the radix trees
1185 * if we already know that we have the tag set.
1187 if (ip->i_flags & iflag)
1189 spin_lock(&ip->i_flags_lock);
1190 ip->i_flags |= iflag;
1191 spin_unlock(&ip->i_flags_lock);
1193 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ip->i_ino));
1194 spin_lock(&pag->pag_ici_lock);
1196 xfs_perag_set_inode_tag(pag, XFS_INO_TO_AGINO(mp, ip->i_ino),
1197 XFS_ICI_BLOCKGC_TAG);
1199 spin_unlock(&pag->pag_ici_lock);
1204 xfs_inode_set_eofblocks_tag(
1207 trace_xfs_inode_set_eofblocks_tag(ip);
1208 return xfs_blockgc_set_iflag(ip, XFS_IEOFBLOCKS);
1212 xfs_blockgc_clear_iflag(
1213 struct xfs_inode *ip,
1214 unsigned long iflag)
1216 struct xfs_mount *mp = ip->i_mount;
1217 struct xfs_perag *pag;
1220 ASSERT((iflag & ~(XFS_IEOFBLOCKS | XFS_ICOWBLOCKS)) == 0);
1222 spin_lock(&ip->i_flags_lock);
1223 ip->i_flags &= ~iflag;
1224 clear_tag = (ip->i_flags & (XFS_IEOFBLOCKS | XFS_ICOWBLOCKS)) == 0;
1225 spin_unlock(&ip->i_flags_lock);
1230 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ip->i_ino));
1231 spin_lock(&pag->pag_ici_lock);
1233 xfs_perag_clear_inode_tag(pag, XFS_INO_TO_AGINO(mp, ip->i_ino),
1234 XFS_ICI_BLOCKGC_TAG);
1236 spin_unlock(&pag->pag_ici_lock);
1241 xfs_inode_clear_eofblocks_tag(
1244 trace_xfs_inode_clear_eofblocks_tag(ip);
1245 return xfs_blockgc_clear_iflag(ip, XFS_IEOFBLOCKS);
1249 * Set ourselves up to free CoW blocks from this file. If it's already clean
1250 * then we can bail out quickly, but otherwise we must back off if the file
1251 * is undergoing some kind of write.
1254 xfs_prep_free_cowblocks(
1255 struct xfs_inode *ip)
1258 * Just clear the tag if we have an empty cow fork or none at all. It's
1259 * possible the inode was fully unshared since it was originally tagged.
1261 if (!xfs_inode_has_cow_data(ip)) {
1262 trace_xfs_inode_free_cowblocks_invalid(ip);
1263 xfs_inode_clear_cowblocks_tag(ip);
1268 * If the mapping is dirty or under writeback we cannot touch the
1269 * CoW fork. Leave it alone if we're in the midst of a directio.
1271 if ((VFS_I(ip)->i_state & I_DIRTY_PAGES) ||
1272 mapping_tagged(VFS_I(ip)->i_mapping, PAGECACHE_TAG_DIRTY) ||
1273 mapping_tagged(VFS_I(ip)->i_mapping, PAGECACHE_TAG_WRITEBACK) ||
1274 atomic_read(&VFS_I(ip)->i_dio_count))
1281 * Automatic CoW Reservation Freeing
1283 * These functions automatically garbage collect leftover CoW reservations
1284 * that were made on behalf of a cowextsize hint when we start to run out
1285 * of quota or when the reservations sit around for too long. If the file
1286 * has dirty pages or is undergoing writeback, its CoW reservations will
1289 * The actual garbage collection piggybacks off the same code that runs
1290 * the speculative EOF preallocation garbage collector.
1293 xfs_inode_free_cowblocks(
1294 struct xfs_inode *ip,
1295 struct xfs_icwalk *icw,
1296 unsigned int *lockflags)
1301 wait = icw && (icw->icw_flags & XFS_ICWALK_FLAG_SYNC);
1303 if (!xfs_iflags_test(ip, XFS_ICOWBLOCKS))
1306 if (!xfs_prep_free_cowblocks(ip))
1309 if (!xfs_icwalk_match(ip, icw))
1313 * If the caller is waiting, return -EAGAIN to keep the background
1314 * scanner moving and revisit the inode in a subsequent pass.
1316 if (!(*lockflags & XFS_IOLOCK_EXCL) &&
1317 !xfs_ilock_nowait(ip, XFS_IOLOCK_EXCL)) {
1322 *lockflags |= XFS_IOLOCK_EXCL;
1324 if (!xfs_ilock_nowait(ip, XFS_MMAPLOCK_EXCL)) {
1329 *lockflags |= XFS_MMAPLOCK_EXCL;
1332 * Check again, nobody else should be able to dirty blocks or change
1333 * the reflink iflag now that we have the first two locks held.
1335 if (xfs_prep_free_cowblocks(ip))
1336 ret = xfs_reflink_cancel_cow_range(ip, 0, NULLFILEOFF, false);
1341 xfs_inode_set_cowblocks_tag(
1344 trace_xfs_inode_set_cowblocks_tag(ip);
1345 return xfs_blockgc_set_iflag(ip, XFS_ICOWBLOCKS);
1349 xfs_inode_clear_cowblocks_tag(
1352 trace_xfs_inode_clear_cowblocks_tag(ip);
1353 return xfs_blockgc_clear_iflag(ip, XFS_ICOWBLOCKS);
1356 /* Disable post-EOF and CoW block auto-reclamation. */
1359 struct xfs_mount *mp)
1361 struct xfs_perag *pag;
1362 xfs_agnumber_t agno;
1364 if (!xfs_clear_blockgc_enabled(mp))
1367 for_each_perag(mp, agno, pag)
1368 cancel_delayed_work_sync(&pag->pag_blockgc_work);
1369 trace_xfs_blockgc_stop(mp, __return_address);
1372 /* Enable post-EOF and CoW block auto-reclamation. */
1375 struct xfs_mount *mp)
1377 struct xfs_perag *pag;
1378 xfs_agnumber_t agno;
1380 if (xfs_set_blockgc_enabled(mp))
1383 trace_xfs_blockgc_start(mp, __return_address);
1384 for_each_perag_tag(mp, agno, pag, XFS_ICI_BLOCKGC_TAG)
1385 xfs_blockgc_queue(pag);
1388 /* Don't try to run block gc on an inode that's in any of these states. */
1389 #define XFS_BLOCKGC_NOGRAB_IFLAGS (XFS_INEW | \
1390 XFS_NEED_INACTIVE | \
1391 XFS_INACTIVATING | \
1392 XFS_IRECLAIMABLE | \
1395 * Decide if the given @ip is eligible for garbage collection of speculative
1396 * preallocations, and grab it if so. Returns true if it's ready to go or
1397 * false if we should just ignore it.
1401 struct xfs_inode *ip)
1403 struct inode *inode = VFS_I(ip);
1405 ASSERT(rcu_read_lock_held());
1407 /* Check for stale RCU freed inode */
1408 spin_lock(&ip->i_flags_lock);
1410 goto out_unlock_noent;
1412 if (ip->i_flags & XFS_BLOCKGC_NOGRAB_IFLAGS)
1413 goto out_unlock_noent;
1414 spin_unlock(&ip->i_flags_lock);
1416 /* nothing to sync during shutdown */
1417 if (xfs_is_shutdown(ip->i_mount))
1420 /* If we can't grab the inode, it must on it's way to reclaim. */
1424 /* inode is valid */
1428 spin_unlock(&ip->i_flags_lock);
1432 /* Scan one incore inode for block preallocations that we can remove. */
1434 xfs_blockgc_scan_inode(
1435 struct xfs_inode *ip,
1436 struct xfs_icwalk *icw)
1438 unsigned int lockflags = 0;
1441 error = xfs_inode_free_eofblocks(ip, icw, &lockflags);
1445 error = xfs_inode_free_cowblocks(ip, icw, &lockflags);
1448 xfs_iunlock(ip, lockflags);
1453 /* Background worker that trims preallocated space. */
1456 struct work_struct *work)
1458 struct xfs_perag *pag = container_of(to_delayed_work(work),
1459 struct xfs_perag, pag_blockgc_work);
1460 struct xfs_mount *mp = pag->pag_mount;
1463 trace_xfs_blockgc_worker(mp, __return_address);
1465 error = xfs_icwalk_ag(pag, XFS_ICWALK_BLOCKGC, NULL);
1467 xfs_info(mp, "AG %u preallocation gc worker failed, err=%d",
1468 pag->pag_agno, error);
1469 xfs_blockgc_queue(pag);
1473 * Try to free space in the filesystem by purging inactive inodes, eofblocks
1477 xfs_blockgc_free_space(
1478 struct xfs_mount *mp,
1479 struct xfs_icwalk *icw)
1483 trace_xfs_blockgc_free_space(mp, icw, _RET_IP_);
1485 error = xfs_icwalk(mp, XFS_ICWALK_BLOCKGC, icw);
1489 xfs_inodegc_flush(mp);
1494 * Reclaim all the free space that we can by scheduling the background blockgc
1495 * and inodegc workers immediately and waiting for them all to clear.
1498 xfs_blockgc_flush_all(
1499 struct xfs_mount *mp)
1501 struct xfs_perag *pag;
1502 xfs_agnumber_t agno;
1504 trace_xfs_blockgc_flush_all(mp, __return_address);
1507 * For each blockgc worker, move its queue time up to now. If it
1508 * wasn't queued, it will not be requeued. Then flush whatever's
1511 for_each_perag_tag(mp, agno, pag, XFS_ICI_BLOCKGC_TAG)
1512 mod_delayed_work(pag->pag_mount->m_blockgc_wq,
1513 &pag->pag_blockgc_work, 0);
1515 for_each_perag_tag(mp, agno, pag, XFS_ICI_BLOCKGC_TAG)
1516 flush_delayed_work(&pag->pag_blockgc_work);
1518 xfs_inodegc_flush(mp);
1522 * Run cow/eofblocks scans on the supplied dquots. We don't know exactly which
1523 * quota caused an allocation failure, so we make a best effort by including
1524 * each quota under low free space conditions (less than 1% free space) in the
1527 * Callers must not hold any inode's ILOCK. If requesting a synchronous scan
1528 * (XFS_ICWALK_FLAG_SYNC), the caller also must not hold any inode's IOLOCK or
1532 xfs_blockgc_free_dquots(
1533 struct xfs_mount *mp,
1534 struct xfs_dquot *udqp,
1535 struct xfs_dquot *gdqp,
1536 struct xfs_dquot *pdqp,
1537 unsigned int iwalk_flags)
1539 struct xfs_icwalk icw = {0};
1540 bool do_work = false;
1542 if (!udqp && !gdqp && !pdqp)
1546 * Run a scan to free blocks using the union filter to cover all
1547 * applicable quotas in a single scan.
1549 icw.icw_flags = XFS_ICWALK_FLAG_UNION | iwalk_flags;
1551 if (XFS_IS_UQUOTA_ENFORCED(mp) && udqp && xfs_dquot_lowsp(udqp)) {
1552 icw.icw_uid = make_kuid(mp->m_super->s_user_ns, udqp->q_id);
1553 icw.icw_flags |= XFS_ICWALK_FLAG_UID;
1557 if (XFS_IS_UQUOTA_ENFORCED(mp) && gdqp && xfs_dquot_lowsp(gdqp)) {
1558 icw.icw_gid = make_kgid(mp->m_super->s_user_ns, gdqp->q_id);
1559 icw.icw_flags |= XFS_ICWALK_FLAG_GID;
1563 if (XFS_IS_PQUOTA_ENFORCED(mp) && pdqp && xfs_dquot_lowsp(pdqp)) {
1564 icw.icw_prid = pdqp->q_id;
1565 icw.icw_flags |= XFS_ICWALK_FLAG_PRID;
1572 return xfs_blockgc_free_space(mp, &icw);
1575 /* Run cow/eofblocks scans on the quotas attached to the inode. */
1577 xfs_blockgc_free_quota(
1578 struct xfs_inode *ip,
1579 unsigned int iwalk_flags)
1581 return xfs_blockgc_free_dquots(ip->i_mount,
1582 xfs_inode_dquot(ip, XFS_DQTYPE_USER),
1583 xfs_inode_dquot(ip, XFS_DQTYPE_GROUP),
1584 xfs_inode_dquot(ip, XFS_DQTYPE_PROJ), iwalk_flags);
1587 /* XFS Inode Cache Walking Code */
1590 * The inode lookup is done in batches to keep the amount of lock traffic and
1591 * radix tree lookups to a minimum. The batch size is a trade off between
1592 * lookup reduction and stack usage. This is in the reclaim path, so we can't
1595 #define XFS_LOOKUP_BATCH 32
1599 * Decide if we want to grab this inode in anticipation of doing work towards
1604 enum xfs_icwalk_goal goal,
1605 struct xfs_inode *ip,
1606 struct xfs_icwalk *icw)
1609 case XFS_ICWALK_BLOCKGC:
1610 return xfs_blockgc_igrab(ip);
1611 case XFS_ICWALK_RECLAIM:
1612 return xfs_reclaim_igrab(ip, icw);
1619 * Process an inode. Each processing function must handle any state changes
1620 * made by the icwalk igrab function. Return -EAGAIN to skip an inode.
1623 xfs_icwalk_process_inode(
1624 enum xfs_icwalk_goal goal,
1625 struct xfs_inode *ip,
1626 struct xfs_perag *pag,
1627 struct xfs_icwalk *icw)
1632 case XFS_ICWALK_BLOCKGC:
1633 error = xfs_blockgc_scan_inode(ip, icw);
1635 case XFS_ICWALK_RECLAIM:
1636 xfs_reclaim_inode(ip, pag);
1643 * For a given per-AG structure @pag and a goal, grab qualifying inodes and
1644 * process them in some manner.
1648 struct xfs_perag *pag,
1649 enum xfs_icwalk_goal goal,
1650 struct xfs_icwalk *icw)
1652 struct xfs_mount *mp = pag->pag_mount;
1653 uint32_t first_index;
1662 if (goal == XFS_ICWALK_RECLAIM)
1663 first_index = READ_ONCE(pag->pag_ici_reclaim_cursor);
1668 struct xfs_inode *batch[XFS_LOOKUP_BATCH];
1674 nr_found = radix_tree_gang_lookup_tag(&pag->pag_ici_root,
1675 (void **) batch, first_index,
1676 XFS_LOOKUP_BATCH, goal);
1684 * Grab the inodes before we drop the lock. if we found
1685 * nothing, nr == 0 and the loop will be skipped.
1687 for (i = 0; i < nr_found; i++) {
1688 struct xfs_inode *ip = batch[i];
1690 if (done || !xfs_icwalk_igrab(goal, ip, icw))
1694 * Update the index for the next lookup. Catch
1695 * overflows into the next AG range which can occur if
1696 * we have inodes in the last block of the AG and we
1697 * are currently pointing to the last inode.
1699 * Because we may see inodes that are from the wrong AG
1700 * due to RCU freeing and reallocation, only update the
1701 * index if it lies in this AG. It was a race that lead
1702 * us to see this inode, so another lookup from the
1703 * same index will not find it again.
1705 if (XFS_INO_TO_AGNO(mp, ip->i_ino) != pag->pag_agno)
1707 first_index = XFS_INO_TO_AGINO(mp, ip->i_ino + 1);
1708 if (first_index < XFS_INO_TO_AGINO(mp, ip->i_ino))
1712 /* unlock now we've grabbed the inodes. */
1715 for (i = 0; i < nr_found; i++) {
1718 error = xfs_icwalk_process_inode(goal, batch[i], pag,
1720 if (error == -EAGAIN) {
1724 if (error && last_error != -EFSCORRUPTED)
1728 /* bail out if the filesystem is corrupted. */
1729 if (error == -EFSCORRUPTED)
1734 if (icw && (icw->icw_flags & XFS_ICWALK_FLAG_SCAN_LIMIT)) {
1735 icw->icw_scan_limit -= XFS_LOOKUP_BATCH;
1736 if (icw->icw_scan_limit <= 0)
1739 } while (nr_found && !done);
1741 if (goal == XFS_ICWALK_RECLAIM) {
1744 WRITE_ONCE(pag->pag_ici_reclaim_cursor, first_index);
1754 /* Walk all incore inodes to achieve a given goal. */
1757 struct xfs_mount *mp,
1758 enum xfs_icwalk_goal goal,
1759 struct xfs_icwalk *icw)
1761 struct xfs_perag *pag;
1764 xfs_agnumber_t agno;
1766 for_each_perag_tag(mp, agno, pag, goal) {
1767 error = xfs_icwalk_ag(pag, goal, icw);
1770 if (error == -EFSCORRUPTED) {
1771 xfs_perag_rele(pag);
1777 BUILD_BUG_ON(XFS_ICWALK_PRIVATE_FLAGS & XFS_ICWALK_FLAGS_VALID);
1783 struct xfs_inode *ip,
1786 struct xfs_ifork *ifp = xfs_ifork_ptr(ip, whichfork);
1787 struct xfs_bmbt_irec got;
1788 struct xfs_iext_cursor icur;
1790 if (!ifp || !xfs_iext_lookup_extent(ip, ifp, 0, &icur, &got))
1793 if (isnullstartblock(got.br_startblock)) {
1794 xfs_warn(ip->i_mount,
1795 "ino %llx %s fork has delalloc extent at [0x%llx:0x%llx]",
1797 whichfork == XFS_DATA_FORK ? "data" : "cow",
1798 got.br_startoff, got.br_blockcount);
1800 } while (xfs_iext_next_extent(ifp, &icur, &got));
1803 #define xfs_check_delalloc(ip, whichfork) do { } while (0)
1806 /* Schedule the inode for reclaim. */
1808 xfs_inodegc_set_reclaimable(
1809 struct xfs_inode *ip)
1811 struct xfs_mount *mp = ip->i_mount;
1812 struct xfs_perag *pag;
1814 if (!xfs_is_shutdown(mp) && ip->i_delayed_blks) {
1815 xfs_check_delalloc(ip, XFS_DATA_FORK);
1816 xfs_check_delalloc(ip, XFS_COW_FORK);
1820 pag = xfs_perag_get(mp, XFS_INO_TO_AGNO(mp, ip->i_ino));
1821 spin_lock(&pag->pag_ici_lock);
1822 spin_lock(&ip->i_flags_lock);
1824 trace_xfs_inode_set_reclaimable(ip);
1825 ip->i_flags &= ~(XFS_NEED_INACTIVE | XFS_INACTIVATING);
1826 ip->i_flags |= XFS_IRECLAIMABLE;
1827 xfs_perag_set_inode_tag(pag, XFS_INO_TO_AGINO(mp, ip->i_ino),
1828 XFS_ICI_RECLAIM_TAG);
1830 spin_unlock(&ip->i_flags_lock);
1831 spin_unlock(&pag->pag_ici_lock);
1836 * Free all speculative preallocations and possibly even the inode itself.
1837 * This is the last chance to make changes to an otherwise unreferenced file
1838 * before incore reclamation happens.
1841 xfs_inodegc_inactivate(
1842 struct xfs_inode *ip)
1844 trace_xfs_inode_inactivating(ip);
1846 xfs_inodegc_set_reclaimable(ip);
1851 struct work_struct *work)
1853 struct xfs_inodegc *gc = container_of(to_delayed_work(work),
1854 struct xfs_inodegc, work);
1855 struct llist_node *node = llist_del_all(&gc->list);
1856 struct xfs_inode *ip, *n;
1857 unsigned int nofs_flag;
1859 ASSERT(gc->cpu == smp_processor_id());
1861 WRITE_ONCE(gc->items, 0);
1867 * We can allocate memory here while doing writeback on behalf of
1868 * memory reclaim. To avoid memory allocation deadlocks set the
1869 * task-wide nofs context for the following operations.
1871 nofs_flag = memalloc_nofs_save();
1873 ip = llist_entry(node, struct xfs_inode, i_gclist);
1874 trace_xfs_inodegc_worker(ip->i_mount, READ_ONCE(gc->shrinker_hits));
1876 WRITE_ONCE(gc->shrinker_hits, 0);
1877 llist_for_each_entry_safe(ip, n, node, i_gclist) {
1878 xfs_iflags_set(ip, XFS_INACTIVATING);
1879 xfs_inodegc_inactivate(ip);
1882 memalloc_nofs_restore(nofs_flag);
1886 * Expedite all pending inodegc work to run immediately. This does not wait for
1887 * completion of the work.
1891 struct xfs_mount *mp)
1893 if (!xfs_is_inodegc_enabled(mp))
1895 trace_xfs_inodegc_push(mp, __return_address);
1896 xfs_inodegc_queue_all(mp);
1900 * Force all currently queued inode inactivation work to run immediately and
1901 * wait for the work to finish.
1905 struct xfs_mount *mp)
1907 xfs_inodegc_push(mp);
1908 trace_xfs_inodegc_flush(mp, __return_address);
1909 flush_workqueue(mp->m_inodegc_wq);
1913 * Flush all the pending work and then disable the inode inactivation background
1914 * workers and wait for them to stop.
1918 struct xfs_mount *mp)
1920 if (!xfs_clear_inodegc_enabled(mp))
1923 xfs_inodegc_queue_all(mp);
1924 drain_workqueue(mp->m_inodegc_wq);
1926 trace_xfs_inodegc_stop(mp, __return_address);
1930 * Enable the inode inactivation background workers and schedule deferred inode
1931 * inactivation work if there is any.
1935 struct xfs_mount *mp)
1937 if (xfs_set_inodegc_enabled(mp))
1940 trace_xfs_inodegc_start(mp, __return_address);
1941 xfs_inodegc_queue_all(mp);
1944 #ifdef CONFIG_XFS_RT
1946 xfs_inodegc_want_queue_rt_file(
1947 struct xfs_inode *ip)
1949 struct xfs_mount *mp = ip->i_mount;
1951 if (!XFS_IS_REALTIME_INODE(ip))
1954 if (__percpu_counter_compare(&mp->m_frextents,
1955 mp->m_low_rtexts[XFS_LOWSP_5_PCNT],
1956 XFS_FDBLOCKS_BATCH) < 0)
1962 # define xfs_inodegc_want_queue_rt_file(ip) (false)
1963 #endif /* CONFIG_XFS_RT */
1966 * Schedule the inactivation worker when:
1968 * - We've accumulated more than one inode cluster buffer's worth of inodes.
1969 * - There is less than 5% free space left.
1970 * - Any of the quotas for this inode are near an enforcement limit.
1973 xfs_inodegc_want_queue_work(
1974 struct xfs_inode *ip,
1977 struct xfs_mount *mp = ip->i_mount;
1979 if (items > mp->m_ino_geo.inodes_per_cluster)
1982 if (__percpu_counter_compare(&mp->m_fdblocks,
1983 mp->m_low_space[XFS_LOWSP_5_PCNT],
1984 XFS_FDBLOCKS_BATCH) < 0)
1987 if (xfs_inodegc_want_queue_rt_file(ip))
1990 if (xfs_inode_near_dquot_enforcement(ip, XFS_DQTYPE_USER))
1993 if (xfs_inode_near_dquot_enforcement(ip, XFS_DQTYPE_GROUP))
1996 if (xfs_inode_near_dquot_enforcement(ip, XFS_DQTYPE_PROJ))
2003 * Upper bound on the number of inodes in each AG that can be queued for
2004 * inactivation at any given time, to avoid monopolizing the workqueue.
2006 #define XFS_INODEGC_MAX_BACKLOG (4 * XFS_INODES_PER_CHUNK)
2009 * Make the frontend wait for inactivations when:
2011 * - Memory shrinkers queued the inactivation worker and it hasn't finished.
2012 * - The queue depth exceeds the maximum allowable percpu backlog.
2014 * Note: If the current thread is running a transaction, we don't ever want to
2015 * wait for other transactions because that could introduce a deadlock.
2018 xfs_inodegc_want_flush_work(
2019 struct xfs_inode *ip,
2021 unsigned int shrinker_hits)
2023 if (current->journal_info)
2026 if (shrinker_hits > 0)
2029 if (items > XFS_INODEGC_MAX_BACKLOG)
2036 * Queue a background inactivation worker if there are inodes that need to be
2037 * inactivated and higher level xfs code hasn't disabled the background
2042 struct xfs_inode *ip)
2044 struct xfs_mount *mp = ip->i_mount;
2045 struct xfs_inodegc *gc;
2047 unsigned int shrinker_hits;
2048 unsigned long queue_delay = 1;
2050 trace_xfs_inode_set_need_inactive(ip);
2051 spin_lock(&ip->i_flags_lock);
2052 ip->i_flags |= XFS_NEED_INACTIVE;
2053 spin_unlock(&ip->i_flags_lock);
2055 gc = get_cpu_ptr(mp->m_inodegc);
2056 llist_add(&ip->i_gclist, &gc->list);
2057 items = READ_ONCE(gc->items);
2058 WRITE_ONCE(gc->items, items + 1);
2059 shrinker_hits = READ_ONCE(gc->shrinker_hits);
2062 * We queue the work while holding the current CPU so that the work
2063 * is scheduled to run on this CPU.
2065 if (!xfs_is_inodegc_enabled(mp)) {
2070 if (xfs_inodegc_want_queue_work(ip, items))
2073 trace_xfs_inodegc_queue(mp, __return_address);
2074 mod_delayed_work_on(current_cpu(), mp->m_inodegc_wq, &gc->work,
2078 if (xfs_inodegc_want_flush_work(ip, items, shrinker_hits)) {
2079 trace_xfs_inodegc_throttle(mp, __return_address);
2080 flush_delayed_work(&gc->work);
2085 * Fold the dead CPU inodegc queue into the current CPUs queue.
2088 xfs_inodegc_cpu_dead(
2089 struct xfs_mount *mp,
2090 unsigned int dead_cpu)
2092 struct xfs_inodegc *dead_gc, *gc;
2093 struct llist_node *first, *last;
2094 unsigned int count = 0;
2096 dead_gc = per_cpu_ptr(mp->m_inodegc, dead_cpu);
2097 cancel_delayed_work_sync(&dead_gc->work);
2099 if (llist_empty(&dead_gc->list))
2102 first = dead_gc->list.first;
2104 while (last->next) {
2108 dead_gc->list.first = NULL;
2111 /* Add pending work to current CPU */
2112 gc = get_cpu_ptr(mp->m_inodegc);
2113 llist_add_batch(first, last, &gc->list);
2114 count += READ_ONCE(gc->items);
2115 WRITE_ONCE(gc->items, count);
2117 if (xfs_is_inodegc_enabled(mp)) {
2118 trace_xfs_inodegc_queue(mp, __return_address);
2119 mod_delayed_work_on(current_cpu(), mp->m_inodegc_wq, &gc->work,
2126 * 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.
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
2136 xfs_inode_mark_reclaimable(
2137 struct xfs_inode *ip)
2139 struct xfs_mount *mp = ip->i_mount;
2142 XFS_STATS_INC(mp, vn_reclaim);
2145 * We should never get here with any of the reclaim flags already set.
2147 ASSERT_ALWAYS(!xfs_iflags_test(ip, XFS_ALL_IRECLAIM_FLAGS));
2149 need_inactive = xfs_inode_needs_inactive(ip);
2150 if (need_inactive) {
2151 xfs_inodegc_queue(ip);
2155 /* Going straight to reclaim, so drop the dquots. */
2156 xfs_qm_dqdetach(ip);
2157 xfs_inodegc_set_reclaimable(ip);
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.
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.
2170 #define XFS_INODEGC_SHRINKER_COUNT (1UL << DEF_PRIORITY)
2171 #define XFS_INODEGC_SHRINKER_BATCH ((XFS_INODEGC_SHRINKER_COUNT / 2) + 1)
2173 static unsigned long
2174 xfs_inodegc_shrinker_count(
2175 struct shrinker *shrink,
2176 struct shrink_control *sc)
2178 struct xfs_mount *mp = container_of(shrink, struct xfs_mount,
2179 m_inodegc_shrinker);
2180 struct xfs_inodegc *gc;
2183 if (!xfs_is_inodegc_enabled(mp))
2186 for_each_online_cpu(cpu) {
2187 gc = per_cpu_ptr(mp->m_inodegc, cpu);
2188 if (!llist_empty(&gc->list))
2189 return XFS_INODEGC_SHRINKER_COUNT;
2195 static unsigned long
2196 xfs_inodegc_shrinker_scan(
2197 struct shrinker *shrink,
2198 struct shrink_control *sc)
2200 struct xfs_mount *mp = container_of(shrink, struct xfs_mount,
2201 m_inodegc_shrinker);
2202 struct xfs_inodegc *gc;
2204 bool no_items = true;
2206 if (!xfs_is_inodegc_enabled(mp))
2209 trace_xfs_inodegc_shrinker_scan(mp, sc, __return_address);
2211 for_each_online_cpu(cpu) {
2212 gc = per_cpu_ptr(mp->m_inodegc, cpu);
2213 if (!llist_empty(&gc->list)) {
2214 unsigned int h = READ_ONCE(gc->shrinker_hits);
2216 WRITE_ONCE(gc->shrinker_hits, h + 1);
2217 mod_delayed_work_on(cpu, mp->m_inodegc_wq, &gc->work, 0);
2223 * If there are no inodes to inactivate, we don't want the shrinker
2224 * to think there's deferred work to call us back about.
2232 /* Register a shrinker so we can accelerate inodegc and throttle queuing. */
2234 xfs_inodegc_register_shrinker(
2235 struct xfs_mount *mp)
2237 struct shrinker *shrink = &mp->m_inodegc_shrinker;
2239 shrink->count_objects = xfs_inodegc_shrinker_count;
2240 shrink->scan_objects = xfs_inodegc_shrinker_scan;
2242 shrink->flags = SHRINKER_NONSLAB;
2243 shrink->batch = XFS_INODEGC_SHRINKER_BATCH;
2245 return register_shrinker(shrink, "xfs-inodegc:%s", mp->m_super->s_id);