xref: /linux-6.15/include/linux/pagevec.h (revision d9ed0d08)
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 /* 14 pointers + two long's align the pagevec structure to a power of two */
13 #define PAGEVEC_SIZE	14
14 
15 struct page;
16 struct address_space;
17 
18 struct pagevec {
19 	unsigned long nr;
20 	bool cold;
21 	bool drained;
22 	struct page *pages[PAGEVEC_SIZE];
23 };
24 
25 void __pagevec_release(struct pagevec *pvec);
26 void __pagevec_lru_add(struct pagevec *pvec);
27 unsigned pagevec_lookup_entries(struct pagevec *pvec,
28 				struct address_space *mapping,
29 				pgoff_t start, unsigned nr_entries,
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 		int tag);
45 unsigned pagevec_lookup_range_nr_tag(struct pagevec *pvec,
46 		struct address_space *mapping, pgoff_t *index, pgoff_t end,
47 		int tag, unsigned max_pages);
48 static inline unsigned pagevec_lookup_tag(struct pagevec *pvec,
49 		struct address_space *mapping, pgoff_t *index, int tag)
50 {
51 	return pagevec_lookup_range_tag(pvec, mapping, index, (pgoff_t)-1, tag);
52 }
53 
54 static inline void pagevec_init(struct pagevec *pvec, int cold)
55 {
56 	pvec->nr = 0;
57 	pvec->cold = cold;
58 	pvec->drained = false;
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 
85 static inline void pagevec_release(struct pagevec *pvec)
86 {
87 	if (pagevec_count(pvec))
88 		__pagevec_release(pvec);
89 }
90 
91 #endif /* _LINUX_PAGEVEC_H */
92