xref: /kernel/linux/linux-5.10/fs/xfs/xfs_itable.h (revision 8c2ecf20)
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (c) 2000-2001 Silicon Graphics, Inc.  All Rights Reserved.
4 */
5#ifndef __XFS_ITABLE_H__
6#define	__XFS_ITABLE_H__
7
8/* In-memory representation of a userspace request for batch inode data. */
9struct xfs_ibulk {
10	struct xfs_mount	*mp;
11	void __user		*ubuffer; /* user output buffer */
12	xfs_ino_t		startino; /* start with this inode */
13	unsigned int		icount;   /* number of elements in ubuffer */
14	unsigned int		ocount;   /* number of records returned */
15	unsigned int		flags;    /* see XFS_IBULK_FLAG_* */
16};
17
18/* Only iterate within the same AG as startino */
19#define XFS_IBULK_SAME_AG	(XFS_IWALK_SAME_AG)
20
21/*
22 * Advance the user buffer pointer by one record of the given size.  If the
23 * buffer is now full, return the appropriate error code.
24 */
25static inline int
26xfs_ibulk_advance(
27	struct xfs_ibulk	*breq,
28	size_t			bytes)
29{
30	char __user		*b = breq->ubuffer;
31
32	breq->ubuffer = b + bytes;
33	breq->ocount++;
34	return breq->ocount == breq->icount ? -ECANCELED : 0;
35}
36
37/*
38 * Return stat information in bulk (by-inode) for the filesystem.
39 */
40
41/*
42 * Return codes for the formatter function are 0 to continue iterating, and
43 * non-zero to stop iterating.  Any non-zero value will be passed up to the
44 * bulkstat/inumbers caller.  The special value -ECANCELED can be used to stop
45 * iteration, as neither bulkstat nor inumbers will ever generate that error
46 * code on their own.
47 */
48
49typedef int (*bulkstat_one_fmt_pf)(struct xfs_ibulk *breq,
50		const struct xfs_bulkstat *bstat);
51
52int xfs_bulkstat_one(struct xfs_ibulk *breq, bulkstat_one_fmt_pf formatter);
53int xfs_bulkstat(struct xfs_ibulk *breq, bulkstat_one_fmt_pf formatter);
54void xfs_bulkstat_to_bstat(struct xfs_mount *mp, struct xfs_bstat *bs1,
55		const struct xfs_bulkstat *bstat);
56
57typedef int (*inumbers_fmt_pf)(struct xfs_ibulk *breq,
58		const struct xfs_inumbers *igrp);
59
60int xfs_inumbers(struct xfs_ibulk *breq, inumbers_fmt_pf formatter);
61void xfs_inumbers_to_inogrp(struct xfs_inogrp *ig1,
62		const struct xfs_inumbers *ig);
63
64#endif	/* __XFS_ITABLE_H__ */
65