aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/include/linux/pagevec.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/linux/pagevec.h')
-rw-r--r--include/linux/pagevec.h116
1 files changed, 65 insertions, 51 deletions
diff --git a/include/linux/pagevec.h b/include/linux/pagevec.h
index 081d934eda64..5d3a0cccc6bf 100644
--- a/include/linux/pagevec.h
+++ b/include/linux/pagevec.h
@@ -3,89 +3,103 @@
* 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.
+ * folios. A folio_batch is a container which is used for that.
*/
#ifndef _LINUX_PAGEVEC_H
#define _LINUX_PAGEVEC_H
-#include <linux/xarray.h>
+#include <linux/types.h>
-/* 15 pointers + header align the pagevec structure to a power of two */
-#define PAGEVEC_SIZE 15
+/* 31 pointers + header align the folio_batch structure to a power of two */
+#define PAGEVEC_SIZE 31
-struct page;
-struct address_space;
+struct folio;
-struct pagevec {
+/**
+ * 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 page *pages[PAGEVEC_SIZE];
+ struct folio *folios[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)
+/**
+ * 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)
{
- return pagevec_lookup_range_tag(pvec, mapping, index, (pgoff_t)-1, tag);
+ fbatch->nr = 0;
+ fbatch->i = 0;
+ fbatch->percpu_pvec_drained = false;
}
-static inline void pagevec_init(struct pagevec *pvec)
+static inline void folio_batch_reinit(struct folio_batch *fbatch)
{
- pvec->nr = 0;
- pvec->percpu_pvec_drained = false;
+ fbatch->nr = 0;
+ fbatch->i = 0;
}
-static inline void pagevec_reinit(struct pagevec *pvec)
+static inline unsigned int folio_batch_count(struct folio_batch *fbatch)
{
- pvec->nr = 0;
+ return fbatch->nr;
}
-static inline unsigned pagevec_count(struct pagevec *pvec)
+static inline unsigned int folio_batch_space(struct folio_batch *fbatch)
{
- return pvec->nr;
+ return PAGEVEC_SIZE - fbatch->nr;
}
-static inline unsigned pagevec_space(struct pagevec *pvec)
+/**
+ * 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)
{
- return PAGEVEC_SIZE - pvec->nr;
+ fbatch->folios[fbatch->nr++] = folio;
+ return folio_batch_space(fbatch);
}
-/*
- * Add a page to a pagevec. Returns the number of slots still available.
+/**
+ * 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 unsigned pagevec_add(struct pagevec *pvec, struct page *page)
+static inline struct folio *folio_batch_next(struct folio_batch *fbatch)
{
- pvec->pages[pvec->nr++] = page;
- return pagevec_space(pvec);
+ if (fbatch->i == fbatch->nr)
+ return NULL;
+ return fbatch->folios[fbatch->i++];
}
-static inline void pagevec_release(struct pagevec *pvec)
+void __folio_batch_release(struct folio_batch *pvec);
+
+static inline void folio_batch_release(struct folio_batch *fbatch)
{
- if (pagevec_count(pvec))
- __pagevec_release(pvec);
+ if (folio_batch_count(fbatch))
+ __folio_batch_release(fbatch);
}
+void folio_batch_remove_exceptionals(struct folio_batch *fbatch);
#endif /* _LINUX_PAGEVEC_H */