fs/xfs/xfs_iwalk.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  * Copyright (C) 2019 Oracle.  All Rights Reserved.
0004  * Author: Darrick J. Wong <darrick.wong@oracle.com>
0005  */
0006 #ifndef __XFS_IWALK_H__
0007 #define __XFS_IWALK_H__
0008
0009 /*
0010  * Return codes for the inode/inobt walk function are 0 to continue iterating,
0011  * and non-zero to stop iterating.  Any non-zero value will be passed up to the
0012  * iwalk or inobt_walk caller.  The special value -ECANCELED can be used to
0013  * stop iteration, as neither iwalk nor inobt_walk will ever generate that
0014  * error code on their own.
0015  */
0016
0017 /* Walk all inodes in the filesystem starting from @startino. */
0018 typedef int (*xfs_iwalk_fn)(struct xfs_mount *mp, struct xfs_trans *tp,
0019                 xfs_ino_t ino, void *data);
0020
0021 int xfs_iwalk(struct xfs_mount *mp, struct xfs_trans *tp, xfs_ino_t startino,
0022         unsigned int flags, xfs_iwalk_fn iwalk_fn,
0023         unsigned int inode_records, void *data);
0024 int xfs_iwalk_threaded(struct xfs_mount *mp, xfs_ino_t startino,
0025         unsigned int flags, xfs_iwalk_fn iwalk_fn,
0026         unsigned int inode_records, bool poll, void *data);
0027
0028 /* Only iterate inodes within the same AG as @startino. */
0029 #define XFS_IWALK_SAME_AG   (1U << 0)
0030
0031 #define XFS_IWALK_FLAGS_ALL (XFS_IWALK_SAME_AG)
0032
0033 /* Walk all inode btree records in the filesystem starting from @startino. */
0034 typedef int (*xfs_inobt_walk_fn)(struct xfs_mount *mp, struct xfs_trans *tp,
0035                  xfs_agnumber_t agno,
0036                  const struct xfs_inobt_rec_incore *irec,
0037                  void *data);
0038
0039 int xfs_inobt_walk(struct xfs_mount *mp, struct xfs_trans *tp,
0040         xfs_ino_t startino, unsigned int flags,
0041         xfs_inobt_walk_fn inobt_walk_fn, unsigned int inobt_records,
0042         void *data);
0043
0044 /* Only iterate inobt records within the same AG as @startino. */
0045 #define XFS_INOBT_WALK_SAME_AG  (XFS_IWALK_SAME_AG)
0046
0047 #define XFS_INOBT_WALK_FLAGS_ALL (XFS_INOBT_WALK_SAME_AG)
0048
0049 #endif /* __XFS_IWALK_H__ */