1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2019 Oracle. All Rights Reserved.
4 * Author: Darrick J. Wong <darrick.wong@oracle.com>
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_btree.h"
15 #include "xfs_ialloc.h"
16 #include "xfs_ialloc_btree.h"
17 #include "xfs_iwalk.h"
18 #include "xfs_error.h"
19 #include "xfs_trace.h"
20 #include "xfs_icache.h"
21 #include "xfs_health.h"
22 #include "xfs_trans.h"
23 #include "xfs_pwork.h"
28 * Walking Inodes in the Filesystem
29 * ================================
31 * This iterator function walks a subset of filesystem inodes in increasing
32 * order from @startino until there are no more inodes. For each allocated
33 * inode it finds, it calls a walk function with the relevant inode number and
34 * a pointer to caller-provided data. The walk function can return the usual
35 * negative error code to stop the iteration; 0 to continue the iteration; or
36 * -ECANCELED to stop the iteration. This return value is returned to the
39 * Internally, we allow the walk function to do anything, which means that we
40 * cannot maintain the inobt cursor or our lock on the AGI buffer. We
41 * therefore cache the inobt records in kernel memory and only call the walk
42 * function when our memory buffer is full. @nr_recs is the number of records
43 * that we've cached, and @sz_recs is the size of our cache.
45 * It is the responsibility of the walk function to ensure it accesses
46 * allocated inodes, as the inobt records may be stale by the time they are
51 /* parallel work control data; will be null if single threaded */
52 struct xfs_pwork pwork
;
56 struct xfs_perag
*pag
;
58 /* Where do we start the traversal? */
61 /* What was the last inode number we saw when iterating the inobt? */
64 /* Array of inobt records we cache. */
65 struct xfs_inobt_rec_incore
*recs
;
67 /* Number of entries allocated for the @recs array. */
70 /* Number of entries in the @recs array that are in use. */
73 /* Inode walk function and data pointer. */
74 xfs_iwalk_fn iwalk_fn
;
75 xfs_inobt_walk_fn inobt_walk_fn
;
79 * Make it look like the inodes up to startino are free so that
80 * bulkstat can start its inode iteration at the correct place without
81 * needing to special case everywhere.
83 unsigned int trim_start
:1;
85 /* Skip empty inobt records? */
86 unsigned int skip_empty
:1;
88 /* Drop the (hopefully empty) transaction when calling iwalk_fn. */
89 unsigned int drop_trans
:1;
93 * Loop over all clusters in a chunk for a given incore inode allocation btree
94 * record. Do a readahead if there are any allocated inodes in that cluster.
99 struct xfs_perag
*pag
,
100 struct xfs_inobt_rec_incore
*irec
)
102 struct xfs_ino_geometry
*igeo
= M_IGEO(mp
);
103 xfs_agnumber_t agno
= pag
->pag_agno
;
105 struct blk_plug plug
;
106 int i
; /* inode chunk index */
108 agbno
= XFS_AGINO_TO_AGBNO(mp
, irec
->ir_startino
);
110 blk_start_plug(&plug
);
111 for (i
= 0; i
< XFS_INODES_PER_CHUNK
; i
+= igeo
->inodes_per_cluster
) {
114 imask
= xfs_inobt_maskn(i
, igeo
->inodes_per_cluster
);
115 if (imask
& ~irec
->ir_free
) {
116 xfs_buf_readahead(mp
->m_ddev_targp
,
117 XFS_AGB_TO_DADDR(mp
, agno
, agbno
),
118 igeo
->blocks_per_cluster
* mp
->m_bsize
,
121 agbno
+= igeo
->blocks_per_cluster
;
123 blk_finish_plug(&plug
);
127 * Set the bits in @irec's free mask that correspond to the inodes before
128 * @agino so that we skip them. This is how we restart an inode walk that was
129 * interrupted in the middle of an inode record.
132 xfs_iwalk_adjust_start(
133 xfs_agino_t agino
, /* starting inode of chunk */
134 struct xfs_inobt_rec_incore
*irec
) /* btree record */
136 int idx
; /* index into inode chunk */
138 idx
= agino
- irec
->ir_startino
;
140 irec
->ir_free
|= xfs_inobt_maskn(0, idx
);
141 irec
->ir_freecount
= hweight64(irec
->ir_free
);
144 /* Allocate memory for a walk. */
147 struct xfs_iwalk_ag
*iwag
)
151 ASSERT(iwag
->recs
== NULL
);
154 /* Allocate a prefetch buffer for inobt records. */
155 size
= iwag
->sz_recs
* sizeof(struct xfs_inobt_rec_incore
);
156 iwag
->recs
= kmalloc(size
, GFP_KERNEL
| __GFP_RETRY_MAYFAIL
);
157 if (iwag
->recs
== NULL
)
163 /* Free memory we allocated for a walk. */
166 struct xfs_iwalk_ag
*iwag
)
172 /* For each inuse inode in each cached inobt record, call our function. */
175 struct xfs_iwalk_ag
*iwag
)
177 struct xfs_mount
*mp
= iwag
->mp
;
178 struct xfs_trans
*tp
= iwag
->tp
;
179 struct xfs_perag
*pag
= iwag
->pag
;
184 for (i
= 0; i
< iwag
->nr_recs
; i
++) {
185 struct xfs_inobt_rec_incore
*irec
= &iwag
->recs
[i
];
187 trace_xfs_iwalk_ag_rec(mp
, pag
->pag_agno
, irec
);
189 if (xfs_pwork_want_abort(&iwag
->pwork
))
192 if (iwag
->inobt_walk_fn
) {
193 error
= iwag
->inobt_walk_fn(mp
, tp
, pag
->pag_agno
, irec
,
202 for (j
= 0; j
< XFS_INODES_PER_CHUNK
; j
++) {
203 if (xfs_pwork_want_abort(&iwag
->pwork
))
206 /* Skip if this inode is free */
207 if (XFS_INOBT_MASK(j
) & irec
->ir_free
)
210 /* Otherwise call our function. */
211 ino
= XFS_AGINO_TO_INO(mp
, pag
->pag_agno
,
212 irec
->ir_startino
+ j
);
213 error
= iwag
->iwalk_fn(mp
, tp
, ino
, iwag
->data
);
222 /* Delete cursor and let go of AGI. */
225 struct xfs_trans
*tp
,
226 struct xfs_btree_cur
**curpp
,
227 struct xfs_buf
**agi_bpp
,
231 xfs_btree_del_cursor(*curpp
, error
);
235 xfs_trans_brelse(tp
, *agi_bpp
);
241 * Set ourselves up for walking inobt records starting from a given point in
244 * If caller passed in a nonzero start inode number, load the record from the
245 * inobt and make the record look like all the inodes before agino are free so
246 * that we skip them, and then move the cursor to the next inobt record. This
247 * is how we support starting an iwalk in the middle of an inode chunk.
249 * If the caller passed in a start number of zero, move the cursor to the first
252 * The caller is responsible for cleaning up the cursor and buffer pointer
253 * regardless of the error status.
257 struct xfs_iwalk_ag
*iwag
,
259 struct xfs_btree_cur
**curpp
,
260 struct xfs_buf
**agi_bpp
,
263 struct xfs_mount
*mp
= iwag
->mp
;
264 struct xfs_trans
*tp
= iwag
->tp
;
265 struct xfs_perag
*pag
= iwag
->pag
;
266 struct xfs_inobt_rec_incore
*irec
;
269 /* Set up a fresh cursor and empty the inobt cache. */
271 error
= xfs_ialloc_read_agi(pag
, tp
, 0, agi_bpp
);
274 *curpp
= xfs_inobt_init_cursor(pag
, tp
, *agi_bpp
);
276 /* Starting at the beginning of the AG? That's easy! */
278 return xfs_inobt_lookup(*curpp
, 0, XFS_LOOKUP_GE
, has_more
);
281 * Otherwise, we have to grab the inobt record where we left off, stuff
282 * the record into our cache, and then see if there are more records.
283 * We require a lookup cache of at least two elements so that the
284 * caller doesn't have to deal with tearing down the cursor to walk the
287 error
= xfs_inobt_lookup(*curpp
, agino
, XFS_LOOKUP_LE
, has_more
);
292 * If the LE lookup at @agino yields no records, jump ahead to the
293 * inobt cursor increment to see if there are more records to process.
298 /* Get the record, should always work */
299 irec
= &iwag
->recs
[iwag
->nr_recs
];
300 error
= xfs_inobt_get_rec(*curpp
, irec
, has_more
);
303 if (XFS_IS_CORRUPT(mp
, *has_more
!= 1)) {
304 xfs_btree_mark_sick(*curpp
);
305 return -EFSCORRUPTED
;
308 iwag
->lastino
= XFS_AGINO_TO_INO(mp
, pag
->pag_agno
,
309 irec
->ir_startino
+ XFS_INODES_PER_CHUNK
- 1);
312 * If the LE lookup yielded an inobt record before the cursor position,
313 * skip it and see if there's another one after it.
315 if (irec
->ir_startino
+ XFS_INODES_PER_CHUNK
<= agino
)
319 * If agino fell in the middle of the inode record, make it look like
320 * the inodes up to agino are free so that we don't return them again.
322 if (iwag
->trim_start
)
323 xfs_iwalk_adjust_start(agino
, irec
);
326 * The prefetch calculation is supposed to give us a large enough inobt
327 * record cache that grab_ichunk can stage a partial first record and
328 * the loop body can cache a record without having to check for cache
329 * space until after it reads an inobt record.
332 ASSERT(iwag
->nr_recs
< iwag
->sz_recs
);
335 return xfs_btree_increment(*curpp
, 0, has_more
);
339 * The inobt record cache is full, so preserve the inobt cursor state and
340 * run callbacks on the cached inobt records. When we're done, restore the
341 * cursor state to wherever the cursor would have been had the cache not been
342 * full (and therefore we could've just incremented the cursor) if *@has_more
343 * is true. On exit, *@has_more will indicate whether or not the caller should
344 * try for more inode records.
347 xfs_iwalk_run_callbacks(
348 struct xfs_iwalk_ag
*iwag
,
349 struct xfs_btree_cur
**curpp
,
350 struct xfs_buf
**agi_bpp
,
353 struct xfs_mount
*mp
= iwag
->mp
;
354 xfs_agino_t next_agino
;
357 next_agino
= XFS_INO_TO_AGINO(mp
, iwag
->lastino
) + 1;
359 ASSERT(iwag
->nr_recs
> 0);
361 /* Delete cursor but remember the last record we cached... */
362 xfs_iwalk_del_inobt(iwag
->tp
, curpp
, agi_bpp
, 0);
363 ASSERT(next_agino
>= iwag
->recs
[iwag
->nr_recs
- 1].ir_startino
+
364 XFS_INODES_PER_CHUNK
);
366 if (iwag
->drop_trans
) {
367 xfs_trans_cancel(iwag
->tp
);
371 error
= xfs_iwalk_ag_recs(iwag
);
375 /* ...empty the cache... */
381 if (iwag
->drop_trans
) {
382 error
= xfs_trans_alloc_empty(mp
, &iwag
->tp
);
387 /* ...and recreate the cursor just past where we left off. */
388 error
= xfs_ialloc_read_agi(iwag
->pag
, iwag
->tp
, 0, agi_bpp
);
391 *curpp
= xfs_inobt_init_cursor(iwag
->pag
, iwag
->tp
, *agi_bpp
);
392 return xfs_inobt_lookup(*curpp
, next_agino
, XFS_LOOKUP_GE
, has_more
);
395 /* Walk all inodes in a single AG, from @iwag->startino to the end of the AG. */
398 struct xfs_iwalk_ag
*iwag
)
400 struct xfs_mount
*mp
= iwag
->mp
;
401 struct xfs_perag
*pag
= iwag
->pag
;
402 struct xfs_buf
*agi_bp
= NULL
;
403 struct xfs_btree_cur
*cur
= NULL
;
408 /* Set up our cursor at the right place in the inode btree. */
409 ASSERT(pag
->pag_agno
== XFS_INO_TO_AGNO(mp
, iwag
->startino
));
410 agino
= XFS_INO_TO_AGINO(mp
, iwag
->startino
);
411 error
= xfs_iwalk_ag_start(iwag
, agino
, &cur
, &agi_bp
, &has_more
);
413 while (!error
&& has_more
) {
414 struct xfs_inobt_rec_incore
*irec
;
418 if (xfs_pwork_want_abort(&iwag
->pwork
))
421 /* Fetch the inobt record. */
422 irec
= &iwag
->recs
[iwag
->nr_recs
];
423 error
= xfs_inobt_get_rec(cur
, irec
, &has_more
);
424 if (error
|| !has_more
)
427 /* Make sure that we always move forward. */
428 rec_fsino
= XFS_AGINO_TO_INO(mp
, pag
->pag_agno
, irec
->ir_startino
);
429 if (iwag
->lastino
!= NULLFSINO
&&
430 XFS_IS_CORRUPT(mp
, iwag
->lastino
>= rec_fsino
)) {
431 xfs_btree_mark_sick(cur
);
432 error
= -EFSCORRUPTED
;
435 iwag
->lastino
= rec_fsino
+ XFS_INODES_PER_CHUNK
- 1;
437 /* No allocated inodes in this chunk; skip it. */
438 if (iwag
->skip_empty
&& irec
->ir_freecount
== irec
->ir_count
) {
439 error
= xfs_btree_increment(cur
, 0, &has_more
);
446 * Start readahead for this inode chunk in anticipation of
447 * walking the inodes.
450 xfs_iwalk_ichunk_ra(mp
, pag
, irec
);
453 * If there's space in the buffer for more records, increment
454 * the btree cursor and grab more.
456 if (++iwag
->nr_recs
< iwag
->sz_recs
) {
457 error
= xfs_btree_increment(cur
, 0, &has_more
);
458 if (error
|| !has_more
)
464 * Otherwise, we need to save cursor state and run the callback
465 * function on the cached records. The run_callbacks function
466 * is supposed to return a cursor pointing to the record where
467 * we would be if we had been able to increment like above.
470 error
= xfs_iwalk_run_callbacks(iwag
, &cur
, &agi_bp
, &has_more
);
473 if (iwag
->nr_recs
== 0 || error
)
476 /* Walk the unprocessed records in the cache. */
477 error
= xfs_iwalk_run_callbacks(iwag
, &cur
, &agi_bp
, &has_more
);
480 xfs_iwalk_del_inobt(iwag
->tp
, &cur
, &agi_bp
, error
);
485 * We experimentally determined that the reduction in ioctl call overhead
486 * diminishes when userspace asks for more than 2048 inodes, so we'll cap
487 * prefetch at this point.
489 #define IWALK_MAX_INODE_PREFETCH (2048U)
492 * Given the number of inodes to prefetch, set the number of inobt records that
493 * we cache in memory, which controls the number of inodes we try to read
494 * ahead. Set the maximum if @inodes == 0.
496 static inline unsigned int
500 unsigned int inobt_records
;
503 * If the caller didn't tell us the number of inodes they wanted,
504 * assume the maximum prefetch possible for best performance.
505 * Otherwise, cap prefetch at that maximum so that we don't start an
506 * absurd amount of prefetch.
509 inodes
= IWALK_MAX_INODE_PREFETCH
;
510 inodes
= min(inodes
, IWALK_MAX_INODE_PREFETCH
);
512 /* Round the inode count up to a full chunk. */
513 inodes
= round_up(inodes
, XFS_INODES_PER_CHUNK
);
516 * In order to convert the number of inodes to prefetch into an
517 * estimate of the number of inobt records to cache, we require a
518 * conversion factor that reflects our expectations of the average
519 * loading factor of an inode chunk. Based on data gathered, most
520 * (but not all) filesystems manage to keep the inode chunks totally
521 * full, so we'll underestimate slightly so that our readahead will
522 * still deliver the performance we want on aging filesystems:
524 * inobt = inodes / (INODES_PER_CHUNK * (4 / 5));
526 * The funny math is to avoid integer division.
528 inobt_records
= (inodes
* 5) / (4 * XFS_INODES_PER_CHUNK
);
531 * Allocate enough space to prefetch at least two inobt records so that
532 * we can cache both the record where the iwalk started and the next
533 * record. This simplifies the AG inode walk loop setup code.
535 return max(inobt_records
, 2U);
539 * Walk all inodes in the filesystem starting from @startino. The @iwalk_fn
540 * will be called for each allocated inode, being passed the inode's number and
541 * @data. @max_prefetch controls how many inobt records' worth of inodes we
546 struct xfs_mount
*mp
,
547 struct xfs_trans
*tp
,
550 xfs_iwalk_fn iwalk_fn
,
551 unsigned int inode_records
,
554 struct xfs_iwalk_ag iwag
= {
557 .iwalk_fn
= iwalk_fn
,
559 .startino
= startino
,
560 .sz_recs
= xfs_iwalk_prefetch(inode_records
),
563 .pwork
= XFS_PWORK_SINGLE_THREADED
,
564 .lastino
= NULLFSINO
,
566 struct xfs_perag
*pag
;
567 xfs_agnumber_t agno
= XFS_INO_TO_AGNO(mp
, startino
);
570 ASSERT(agno
< mp
->m_sb
.sb_agcount
);
571 ASSERT(!(flags
& ~XFS_IWALK_FLAGS_ALL
));
573 error
= xfs_iwalk_alloc(&iwag
);
577 for_each_perag_from(mp
, agno
, pag
) {
579 error
= xfs_iwalk_ag(&iwag
);
582 iwag
.startino
= XFS_AGINO_TO_INO(mp
, agno
+ 1, 0);
583 if (flags
& XFS_INOBT_WALK_SAME_AG
)
590 xfs_iwalk_free(&iwag
);
594 /* Run per-thread iwalk work. */
597 struct xfs_mount
*mp
,
598 struct xfs_pwork
*pwork
)
600 struct xfs_iwalk_ag
*iwag
;
603 iwag
= container_of(pwork
, struct xfs_iwalk_ag
, pwork
);
604 if (xfs_pwork_want_abort(pwork
))
607 error
= xfs_iwalk_alloc(iwag
);
611 * Grab an empty transaction so that we can use its recursive buffer
612 * locking abilities to detect cycles in the inobt without deadlocking.
614 error
= xfs_trans_alloc_empty(mp
, &iwag
->tp
);
617 iwag
->drop_trans
= 1;
619 error
= xfs_iwalk_ag(iwag
);
621 xfs_trans_cancel(iwag
->tp
);
622 xfs_iwalk_free(iwag
);
624 xfs_perag_put(iwag
->pag
);
630 * Walk all the inodes in the filesystem using multiple threads to process each
635 struct xfs_mount
*mp
,
638 xfs_iwalk_fn iwalk_fn
,
639 unsigned int inode_records
,
643 struct xfs_pwork_ctl pctl
;
644 struct xfs_perag
*pag
;
645 xfs_agnumber_t agno
= XFS_INO_TO_AGNO(mp
, startino
);
648 ASSERT(agno
< mp
->m_sb
.sb_agcount
);
649 ASSERT(!(flags
& ~XFS_IWALK_FLAGS_ALL
));
651 error
= xfs_pwork_init(mp
, &pctl
, xfs_iwalk_ag_work
, "xfs_iwalk");
655 for_each_perag_from(mp
, agno
, pag
) {
656 struct xfs_iwalk_ag
*iwag
;
658 if (xfs_pwork_ctl_want_abort(&pctl
))
661 iwag
= kzalloc(sizeof(struct xfs_iwalk_ag
),
662 GFP_KERNEL
| __GFP_NOFAIL
);
666 * perag is being handed off to async work, so take a passive
667 * reference for the async work to release.
669 iwag
->pag
= xfs_perag_hold(pag
);
670 iwag
->iwalk_fn
= iwalk_fn
;
672 iwag
->startino
= startino
;
673 iwag
->sz_recs
= xfs_iwalk_prefetch(inode_records
);
674 iwag
->lastino
= NULLFSINO
;
675 xfs_pwork_queue(&pctl
, &iwag
->pwork
);
676 startino
= XFS_AGINO_TO_INO(mp
, pag
->pag_agno
+ 1, 0);
677 if (flags
& XFS_INOBT_WALK_SAME_AG
)
683 xfs_pwork_poll(&pctl
);
684 return xfs_pwork_destroy(&pctl
);
688 * Allow callers to cache up to a page's worth of inobt records. This reflects
689 * the existing inumbers prefetching behavior. Since the inobt walk does not
690 * itself do anything with the inobt records, we can set a fairly high limit
693 #define MAX_INOBT_WALK_PREFETCH \
694 (PAGE_SIZE / sizeof(struct xfs_inobt_rec_incore))
697 * Given the number of records that the user wanted, set the number of inobt
698 * records that we buffer in memory. Set the maximum if @inobt_records == 0.
700 static inline unsigned int
701 xfs_inobt_walk_prefetch(
702 unsigned int inobt_records
)
705 * If the caller didn't tell us the number of inobt records they
706 * wanted, assume the maximum prefetch possible for best performance.
708 if (inobt_records
== 0)
709 inobt_records
= MAX_INOBT_WALK_PREFETCH
;
712 * Allocate enough space to prefetch at least two inobt records so that
713 * we can cache both the record where the iwalk started and the next
714 * record. This simplifies the AG inode walk loop setup code.
716 inobt_records
= max(inobt_records
, 2U);
719 * Cap prefetch at that maximum so that we don't use an absurd amount
722 return min_t(unsigned int, inobt_records
, MAX_INOBT_WALK_PREFETCH
);
726 * Walk all inode btree records in the filesystem starting from @startino. The
727 * @inobt_walk_fn will be called for each btree record, being passed the incore
728 * record and @data. @max_prefetch controls how many inobt records we try to
729 * cache ahead of time.
733 struct xfs_mount
*mp
,
734 struct xfs_trans
*tp
,
737 xfs_inobt_walk_fn inobt_walk_fn
,
738 unsigned int inobt_records
,
741 struct xfs_iwalk_ag iwag
= {
744 .inobt_walk_fn
= inobt_walk_fn
,
746 .startino
= startino
,
747 .sz_recs
= xfs_inobt_walk_prefetch(inobt_records
),
748 .pwork
= XFS_PWORK_SINGLE_THREADED
,
749 .lastino
= NULLFSINO
,
751 struct xfs_perag
*pag
;
752 xfs_agnumber_t agno
= XFS_INO_TO_AGNO(mp
, startino
);
755 ASSERT(agno
< mp
->m_sb
.sb_agcount
);
756 ASSERT(!(flags
& ~XFS_INOBT_WALK_FLAGS_ALL
));
758 error
= xfs_iwalk_alloc(&iwag
);
762 for_each_perag_from(mp
, agno
, pag
) {
764 error
= xfs_iwalk_ag(&iwag
);
767 iwag
.startino
= XFS_AGINO_TO_INO(mp
, pag
->pag_agno
+ 1, 0);
768 if (flags
& XFS_INOBT_WALK_SAME_AG
)
775 xfs_iwalk_free(&iwag
);