[linux-block.git] / include / linux / pagevec.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * include/linux/pagevec.h
 *
 * In many places it is efficient to batch an operation up against multiple
 * folios.  A folio_batch is a container which is used for that.
 */

#ifndef _LINUX_PAGEVEC_H
#define _LINUX_PAGEVEC_H

#include <linux/types.h>

/* 31 pointers + header align the folio_batch structure to a power of two */
#define PAGEVEC_SIZE	31

struct folio;

/**
 * struct folio_batch - A collection of folios.
 *
 * The folio_batch is used to amortise the cost of retrieving and
 * operating on a set of folios.  The order of folios in the batch may be
 * significant (eg delete_from_page_cache_batch()).  Some users of the
 * folio_batch store "exceptional" entries in it which can be removed
 * by calling folio_batch_remove_exceptionals().
 */
struct folio_batch {
	unsigned char nr;
	unsigned char i;
	bool percpu_pvec_drained;
	struct folio *folios[PAGEVEC_SIZE];
};

/**
 * folio_batch_init() - Initialise a batch of folios
 * @fbatch: The folio batch.
 *
 * A freshly initialised folio_batch contains zero folios.
 */
static inline void folio_batch_init(struct folio_batch *fbatch)
{
	fbatch->nr = 0;
	fbatch->i = 0;
	fbatch->percpu_pvec_drained = false;
}

static inline void folio_batch_reinit(struct folio_batch *fbatch)
{
	fbatch->nr = 0;
	fbatch->i = 0;
}

static inline unsigned int folio_batch_count(struct folio_batch *fbatch)
{
	return fbatch->nr;
}

static inline unsigned int folio_batch_space(struct folio_batch *fbatch)
{
	return PAGEVEC_SIZE - fbatch->nr;
}

/**
 * folio_batch_add() - Add a folio to a batch.
 * @fbatch: The folio batch.
 * @folio: The folio to add.
 *
 * The folio is added to the end of the batch.
 * The batch must have previously been initialised using folio_batch_init().
 *
 * Return: The number of slots still available.
 */
static inline unsigned folio_batch_add(struct folio_batch *fbatch,
		struct folio *folio)
{
	fbatch->folios[fbatch->nr++] = folio;
	return folio_batch_space(fbatch);
}

/**
 * folio_batch_next - Return the next folio to process.
 * @fbatch: The folio batch being processed.
 *
 * Use this function to implement a queue of folios.
 *
 * Return: The next folio in the queue, or NULL if the queue is empty.
 */
static inline struct folio *folio_batch_next(struct folio_batch *fbatch)
{
	if (fbatch->i == fbatch->nr)
		return NULL;
	return fbatch->folios[fbatch->i++];
}

void __folio_batch_release(struct folio_batch *pvec);

static inline void folio_batch_release(struct folio_batch *fbatch)
{
	if (folio_batch_count(fbatch))
		__folio_batch_release(fbatch);
}

void folio_batch_remove_exceptionals(struct folio_batch *fbatch);
#endif /* _LINUX_PAGEVEC_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	* include/linux/pagevec.h
	4	*
	5	* In many places it is efficient to batch an operation up against multiple
1e0877d5	6	* folios. A folio_batch is a container which is used for that.
1da177e4 LT	7	*/
1da177e4 LT	8
78854014 DH	9	#ifndef _LINUX_PAGEVEC_H
	10	#define _LINUX_PAGEVEC_H
	11
1e0877d5	12	#include <linux/types.h>
10bbd235	13
9cecde80 MWO	14	/* 31 pointers + header align the folio_batch structure to a power of two */
9cecde80 MWO	15	#define PAGEVEC_SIZE 31
1da177e4	16
10331795	17	struct folio;
1da177e4	18
10331795 MWO	19	/**
	20	* struct folio_batch - A collection of folios.
	21	*
	22	* The folio_batch is used to amortise the cost of retrieving and
	23	* operating on a set of folios. The order of folios in the batch may be
	24	* significant (eg delete_from_page_cache_batch()). Some users of the
	25	* folio_batch store "exceptional" entries in it which can be removed
	26	* by calling folio_batch_remove_exceptionals().
	27	*/
	28	struct folio_batch {
	29	unsigned char nr;
535c5d9d	30	unsigned char i;
10331795 MWO	31	bool percpu_pvec_drained;
	32	struct folio *folios[PAGEVEC_SIZE];
	33	};
	34
10331795 MWO	35	/**
	36	* folio_batch_init() - Initialise a batch of folios
	37	* @fbatch: The folio batch.
	38	*
	39	* A freshly initialised folio_batch contains zero folios.
	40	*/
	41	static inline void folio_batch_init(struct folio_batch *fbatch)
	42	{
	43	fbatch->nr = 0;
535c5d9d	44	fbatch->i = 0;
6840f909	45	fbatch->percpu_pvec_drained = false;
10331795 MWO	46	}
10331795 MWO	47
81156128 LS	48	static inline void folio_batch_reinit(struct folio_batch *fbatch)
	49	{
	50	fbatch->nr = 0;
535c5d9d	51	fbatch->i = 0;
81156128 LS	52	}
81156128 LS	53
10331795 MWO	54	static inline unsigned int folio_batch_count(struct folio_batch *fbatch)
	55	{
	56	return fbatch->nr;
	57	}
	58
ce064428	59	static inline unsigned int folio_batch_space(struct folio_batch *fbatch)
10331795 MWO	60	{
	61	return PAGEVEC_SIZE - fbatch->nr;
	62	}
	63
	64	/**
	65	* folio_batch_add() - Add a folio to a batch.
	66	* @fbatch: The folio batch.
	67	* @folio: The folio to add.
	68	*
	69	* The folio is added to the end of the batch.
	70	* The batch must have previously been initialised using folio_batch_init().
	71	*
	72	* Return: The number of slots still available.
	73	*/
	74	static inline unsigned folio_batch_add(struct folio_batch *fbatch,
	75	struct folio *folio)
	76	{
	77	fbatch->folios[fbatch->nr++] = folio;
ce064428	78	return folio_batch_space(fbatch);
10331795 MWO	79	}
10331795 MWO	80
535c5d9d MWO	81	/**
	82	* folio_batch_next - Return the next folio to process.
	83	* @fbatch: The folio batch being processed.
	84	*
	85	* Use this function to implement a queue of folios.
	86	*
	87	* Return: The next folio in the queue, or NULL if the queue is empty.
	88	*/
	89	static inline struct folio folio_batch_next(struct folio_batch fbatch)
	90	{
	91	if (fbatch->i == fbatch->nr)
	92	return NULL;
	93	return fbatch->folios[fbatch->i++];
	94	}
	95
1e0877d5	96	void __folio_batch_release(struct folio_batch *pvec);
982a7194	97
10331795 MWO	98	static inline void folio_batch_release(struct folio_batch *fbatch)
10331795 MWO	99	{
982a7194 MWO	100	if (folio_batch_count(fbatch))
982a7194 MWO	101	__folio_batch_release(fbatch);
10331795 MWO	102	}
10331795 MWO	103
1613fac9	104	void folio_batch_remove_exceptionals(struct folio_batch *fbatch);
78854014	105	#endif /* _LINUX_PAGEVEC_H */