[mirror_ubuntu-eoan-kernel.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
 * pages.  A pagevec is a multipage container which is used for that.
 */

#ifndef _LINUX_PAGEVEC_H
#define _LINUX_PAGEVEC_H

#include <linux/xarray.h>

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

struct page;
struct address_space;

struct pagevec {
	unsigned char nr;
	bool percpu_pvec_drained;
	struct page *pages[PAGEVEC_SIZE];
};

void __pagevec_release(struct pagevec *pvec);
void __pagevec_lru_add(struct pagevec *pvec);
unsigned pagevec_lookup_entries(struct pagevec *pvec,
				struct address_space *mapping,
				pgoff_t start, unsigned nr_entries,
				pgoff_t *indices);
void pagevec_remove_exceptionals(struct pagevec *pvec);
unsigned pagevec_lookup_range(struct pagevec *pvec,
			      struct address_space *mapping,
			      pgoff_t *start, pgoff_t end);
static inline unsigned pagevec_lookup(struct pagevec *pvec,
				      struct address_space *mapping,
				      pgoff_t *start)
{
	return pagevec_lookup_range(pvec, mapping, start, (pgoff_t)-1);
}

unsigned pagevec_lookup_range_tag(struct pagevec *pvec,
		struct address_space *mapping, pgoff_t *index, pgoff_t end,
		xa_mark_t tag);
unsigned pagevec_lookup_range_nr_tag(struct pagevec *pvec,
		struct address_space *mapping, pgoff_t *index, pgoff_t end,
		xa_mark_t tag, unsigned max_pages);
static inline unsigned pagevec_lookup_tag(struct pagevec *pvec,
		struct address_space *mapping, pgoff_t *index, xa_mark_t tag)
{
	return pagevec_lookup_range_tag(pvec, mapping, index, (pgoff_t)-1, tag);
}

static inline void pagevec_init(struct pagevec *pvec)
{
	pvec->nr = 0;
	pvec->percpu_pvec_drained = false;
}

static inline void pagevec_reinit(struct pagevec *pvec)
{
	pvec->nr = 0;
}

static inline unsigned pagevec_count(struct pagevec *pvec)
{
	return pvec->nr;
}

static inline unsigned pagevec_space(struct pagevec *pvec)
{
	return PAGEVEC_SIZE - pvec->nr;
}

/*
 * Add a page to a pagevec.  Returns the number of slots still available.
 */
static inline unsigned pagevec_add(struct pagevec *pvec, struct page *page)
{
	pvec->pages[pvec->nr++] = page;
	return pagevec_space(pvec);
}

static inline void pagevec_release(struct pagevec *pvec)
{
	if (pagevec_count(pvec))
		__pagevec_release(pvec);
}

#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
	6	* pages. A pagevec is a multipage container which is used for that.
	7	*/
	8
78854014 DH	9	#ifndef _LINUX_PAGEVEC_H
	10	#define _LINUX_PAGEVEC_H
	11
10bbd235 MW	12	#include <linux/xarray.h>
10bbd235 MW	13
146500e9 MW	14	/* 15 pointers + header align the pagevec structure to a power of two */
146500e9 MW	15	#define PAGEVEC_SIZE 15
1da177e4 LT	16
	17	struct page;
	18	struct address_space;
	19
	20	struct pagevec {
146500e9	21	unsigned char nr;
7f0b5fb9	22	bool percpu_pvec_drained;
1da177e4 LT	23	struct page *pages[PAGEVEC_SIZE];
	24	};
	25
	26	void __pagevec_release(struct pagevec *pvec);
a0b8cab3	27	void __pagevec_lru_add(struct pagevec *pvec);
0cd6144a JW	28	unsigned pagevec_lookup_entries(struct pagevec *pvec,
	29	struct address_space *mapping,
	30	pgoff_t start, unsigned nr_entries,
	31	pgoff_t *indices);
	32	void pagevec_remove_exceptionals(struct pagevec *pvec);
b947cee4 JK	33	unsigned pagevec_lookup_range(struct pagevec *pvec,
b947cee4 JK	34	struct address_space *mapping,
397162ff	35	pgoff_t *start, pgoff_t end);
b947cee4 JK	36	static inline unsigned pagevec_lookup(struct pagevec *pvec,
b947cee4 JK	37	struct address_space *mapping,
397162ff	38	pgoff_t *start)
b947cee4	39	{
397162ff	40	return pagevec_lookup_range(pvec, mapping, start, (pgoff_t)-1);
b947cee4 JK	41	}
b947cee4 JK	42
72b045ae JK	43	unsigned pagevec_lookup_range_tag(struct pagevec *pvec,
72b045ae JK	44	struct address_space mapping, pgoff_t index, pgoff_t end,
10bbd235	45	xa_mark_t tag);
93d3b714 JK	46	unsigned pagevec_lookup_range_nr_tag(struct pagevec *pvec,
93d3b714 JK	47	struct address_space mapping, pgoff_t index, pgoff_t end,
10bbd235	48	xa_mark_t tag, unsigned max_pages);
72b045ae	49	static inline unsigned pagevec_lookup_tag(struct pagevec *pvec,
10bbd235	50	struct address_space mapping, pgoff_t index, xa_mark_t tag)
72b045ae	51	{
67fd707f	52	return pagevec_lookup_range_tag(pvec, mapping, index, (pgoff_t)-1, tag);
72b045ae	53	}
1da177e4	54
86679820	55	static inline void pagevec_init(struct pagevec *pvec)
1da177e4 LT	56	{
1da177e4 LT	57	pvec->nr = 0;
7f0b5fb9	58	pvec->percpu_pvec_drained = false;
1da177e4 LT	59	}
	60
	61	static inline void pagevec_reinit(struct pagevec *pvec)
	62	{
	63	pvec->nr = 0;
	64	}
	65
	66	static inline unsigned pagevec_count(struct pagevec *pvec)
	67	{
	68	return pvec->nr;
	69	}
	70
	71	static inline unsigned pagevec_space(struct pagevec *pvec)
	72	{
	73	return PAGEVEC_SIZE - pvec->nr;
	74	}
	75
	76	/*
	77	* Add a page to a pagevec. Returns the number of slots still available.
	78	*/
	79	static inline unsigned pagevec_add(struct pagevec pvec, struct page page)
	80	{
	81	pvec->pages[pvec->nr++] = page;
	82	return pagevec_space(pvec);
	83	}
	84
1da177e4 LT	85	static inline void pagevec_release(struct pagevec *pvec)
	86	{
	87	if (pagevec_count(pvec))
	88	__pagevec_release(pvec);
	89	}
	90
78854014	91	#endif /* _LINUX_PAGEVEC_H */