xref: /linux-6.15/include/linux/pagevec.h (revision 38cefeb3)
1 /* SPDX-License-Identifier: GPL-2.0 */
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 
9 #ifndef _LINUX_PAGEVEC_H
10 #define _LINUX_PAGEVEC_H
11 
12 #include <linux/xarray.h>
13 
14 /* 15 pointers + header align the pagevec structure to a power of two */
15 #define PAGEVEC_SIZE	15
16 
17 struct page;
18 struct address_space;
19 
20 struct pagevec {
21 	unsigned char nr;
22 	bool percpu_pvec_drained;
23 	struct page *pages[PAGEVEC_SIZE];
24 };
25 
26 void __pagevec_release(struct pagevec *pvec);
27 void __pagevec_lru_add(struct pagevec *pvec);
28 unsigned pagevec_lookup_entries(struct pagevec *pvec,
29 		struct address_space *mapping, pgoff_t start, pgoff_t end,
30 		pgoff_t *indices);
31 void pagevec_remove_exceptionals(struct pagevec *pvec);
32 unsigned pagevec_lookup_range(struct pagevec *pvec,
33 			      struct address_space *mapping,
34 			      pgoff_t *start, pgoff_t end);
35 static inline unsigned pagevec_lookup(struct pagevec *pvec,
36 				      struct address_space *mapping,
37 				      pgoff_t *start)
38 {
39 	return pagevec_lookup_range(pvec, mapping, start, (pgoff_t)-1);
40 }
41 
42 unsigned pagevec_lookup_range_tag(struct pagevec *pvec,
43 		struct address_space *mapping, pgoff_t *index, pgoff_t end,
44 		xa_mark_t tag);
45 static inline unsigned pagevec_lookup_tag(struct pagevec *pvec,
46 		struct address_space *mapping, pgoff_t *index, xa_mark_t tag)
47 {
48 	return pagevec_lookup_range_tag(pvec, mapping, index, (pgoff_t)-1, tag);
49 }
50 
51 static inline void pagevec_init(struct pagevec *pvec)
52 {
53 	pvec->nr = 0;
54 	pvec->percpu_pvec_drained = false;
55 }
56 
57 static inline void pagevec_reinit(struct pagevec *pvec)
58 {
59 	pvec->nr = 0;
60 }
61 
62 static inline unsigned pagevec_count(struct pagevec *pvec)
63 {
64 	return pvec->nr;
65 }
66 
67 static inline unsigned pagevec_space(struct pagevec *pvec)
68 {
69 	return PAGEVEC_SIZE - pvec->nr;
70 }
71 
72 /*
73  * Add a page to a pagevec.  Returns the number of slots still available.
74  */
75 static inline unsigned pagevec_add(struct pagevec *pvec, struct page *page)
76 {
77 	pvec->pages[pvec->nr++] = page;
78 	return pagevec_space(pvec);
79 }
80 
81 static inline void pagevec_release(struct pagevec *pvec)
82 {
83 	if (pagevec_count(pvec))
84 		__pagevec_release(pvec);
85 }
86 
87 #endif /* _LINUX_PAGEVEC_H */
88