1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * Copyright (C) 2019 Oracle.  All Rights Reserved.
4 * Author: Darrick J. Wong <darrick.wong@oracle.com>
5 */
6#ifndef __XFS_IWALK_H__
7#define __XFS_IWALK_H__
8
9/*
10 * Return codes for the inode/inobt walk function are 0 to continue iterating,
11 * and non-zero to stop iterating.  Any non-zero value will be passed up to the
12 * iwalk or inobt_walk caller.  The special value -ECANCELED can be used to
13 * stop iteration, as neither iwalk nor inobt_walk will ever generate that
14 * error code on their own.
15 */
16
17/* Walk all inodes in the filesystem starting from @startino. */
18typedef int (*xfs_iwalk_fn)(struct xfs_mount *mp, struct xfs_trans *tp,
19			    xfs_ino_t ino, void *data);
20
21int xfs_iwalk(struct xfs_mount *mp, struct xfs_trans *tp, xfs_ino_t startino,
22		unsigned int flags, xfs_iwalk_fn iwalk_fn,
23		unsigned int inode_records, void *data);
24int xfs_iwalk_threaded(struct xfs_mount *mp, xfs_ino_t startino,
25		unsigned int flags, xfs_iwalk_fn iwalk_fn,
26		unsigned int inode_records, bool poll, void *data);
27
28/* Only iterate inodes within the same AG as @startino. */
29#define XFS_IWALK_SAME_AG	(1U << 0)
30
31#define XFS_IWALK_FLAGS_ALL	(XFS_IWALK_SAME_AG)
32
33/* Walk all inode btree records in the filesystem starting from @startino. */
34typedef int (*xfs_inobt_walk_fn)(struct xfs_mount *mp, struct xfs_trans *tp,
35				 xfs_agnumber_t agno,
36				 const struct xfs_inobt_rec_incore *irec,
37				 void *data);
38
39int xfs_inobt_walk(struct xfs_mount *mp, struct xfs_trans *tp,
40		xfs_ino_t startino, unsigned int flags,
41		xfs_inobt_walk_fn inobt_walk_fn, unsigned int inobt_records,
42		void *data);
43
44/* Only iterate inobt records within the same AG as @startino. */
45#define XFS_INOBT_WALK_SAME_AG	(XFS_IWALK_SAME_AG)
46
47#define XFS_INOBT_WALK_FLAGS_ALL (XFS_INOBT_WALK_SAME_AG)
48
49#endif /* __XFS_IWALK_H__ */
50