[linux.git] / fs / xfs / xfs_itable.h

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2000-2001 Silicon Graphics, Inc.  All Rights Reserved.
 */
#ifndef __XFS_ITABLE_H__
#define	__XFS_ITABLE_H__

/* In-memory representation of a userspace request for batch inode data. */
struct xfs_ibulk {
	struct xfs_mount	*mp;
	void __user		*ubuffer; /* user output buffer */
	xfs_ino_t		startino; /* start with this inode */
	unsigned int		icount;   /* number of elements in ubuffer */
	unsigned int		ocount;   /* number of records returned */
	unsigned int		flags;    /* see XFS_IBULK_FLAG_* */
};

/* Only iterate within the same AG as startino */
#define XFS_IBULK_SAME_AG	(XFS_IWALK_SAME_AG)

/*
 * Advance the user buffer pointer by one record of the given size.  If the
 * buffer is now full, return the appropriate error code.
 */
static inline int
xfs_ibulk_advance(
	struct xfs_ibulk	*breq,
	size_t			bytes)
{
	char __user		*b = breq->ubuffer;

	breq->ubuffer = b + bytes;
	breq->ocount++;
	return breq->ocount == breq->icount ? -ECANCELED : 0;
}

/*
 * Return stat information in bulk (by-inode) for the filesystem.
 */

/*
 * Return codes for the formatter function are 0 to continue iterating, and
 * non-zero to stop iterating.  Any non-zero value will be passed up to the
 * bulkstat/inumbers caller.  The special value -ECANCELED can be used to stop
 * iteration, as neither bulkstat nor inumbers will ever generate that error
 * code on their own.
 */

typedef int (*bulkstat_one_fmt_pf)(struct xfs_ibulk *breq,
		const struct xfs_bulkstat *bstat);

int xfs_bulkstat_one(struct xfs_ibulk *breq, bulkstat_one_fmt_pf formatter);
int xfs_bulkstat(struct xfs_ibulk *breq, bulkstat_one_fmt_pf formatter);
void xfs_bulkstat_to_bstat(struct xfs_mount *mp, struct xfs_bstat *bs1,
		const struct xfs_bulkstat *bstat);

typedef int (*inumbers_fmt_pf)(struct xfs_ibulk *breq,
		const struct xfs_inumbers *igrp);

int xfs_inumbers(struct xfs_ibulk *breq, inumbers_fmt_pf formatter);
void xfs_inumbers_to_inogrp(struct xfs_inogrp *ig1,
		const struct xfs_inumbers *ig);

#endif	/* __XFS_ITABLE_H__ */
Commit	Line	Data
0b61f8a4	1	// SPDX-License-Identifier: GPL-2.0
1da177e4 LT	2	/*
1da177e4 LT	3	* Copyright (c) 2000-2001 Silicon Graphics, Inc. All Rights Reserved.
1da177e4 LT	4	*/
	5	#ifndef __XFS_ITABLE_H__
	6	#define __XFS_ITABLE_H__
	7
2810bd68 DW	8	/* In-memory representation of a userspace request for batch inode data. */
	9	struct 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 */
13d59a2a	15	unsigned int flags; /* see XFS_IBULK_FLAG_* */
2810bd68 DW	16	};
2810bd68 DW	17
13d59a2a DW	18	/* Only iterate within the same AG as startino */
	19	#define XFS_IBULK_SAME_AG (XFS_IWALK_SAME_AG)
	20
1da177e4	21	/*
2810bd68 DW	22	* Advance the user buffer pointer by one record of the given size. If the
2810bd68 DW	23	* buffer is now full, return the appropriate error code.
1da177e4	24	*/
2810bd68 DW	25	static inline int
	26	xfs_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++;
e7ee96df	34	return breq->ocount == breq->icount ? -ECANCELED : 0;
2810bd68	35	}
1da177e4	36
1da177e4 LT	37	/*
	38	* Return stat information in bulk (by-inode) for the filesystem.
	39	*/
faa63e95	40
e7ee96df DW	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
2810bd68	49	typedef int (bulkstat_one_fmt_pf)(struct xfs_ibulk breq,
7035f972	50	const struct xfs_bulkstat *bstat);
2ee4fa5c	51
2810bd68 DW	52	int xfs_bulkstat_one(struct xfs_ibulk *breq, bulkstat_one_fmt_pf formatter);
2810bd68 DW	53	int xfs_bulkstat(struct xfs_ibulk *breq, bulkstat_one_fmt_pf formatter);
7035f972 DW	54	void xfs_bulkstat_to_bstat(struct xfs_mount mp, struct xfs_bstat bs1,
7035f972 DW	55	const struct xfs_bulkstat *bstat);
1da177e4	56
677717fb	57	typedef int (inumbers_fmt_pf)(struct xfs_ibulk breq,
5f19c7fc	58	const struct xfs_inumbers *igrp);
faa63e95	59
677717fb	60	int xfs_inumbers(struct xfs_ibulk *breq, inumbers_fmt_pf formatter);
5f19c7fc DW	61	void xfs_inumbers_to_inogrp(struct xfs_inogrp *ig1,
5f19c7fc DW	62	const struct xfs_inumbers *ig);
1da177e4 LT	63
1da177e4 LT	64	#endif /* __XFS_ITABLE_H__ */