2019-08-28 10:19:53 -04:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
|
|
|
#ifndef _LINUX_PAGEWALK_H
|
|
|
|
#define _LINUX_PAGEWALK_H
|
|
|
|
|
|
|
|
#include <linux/mm.h>
|
|
|
|
|
2019-08-28 10:19:54 -04:00
|
|
|
struct mm_walk;
|
|
|
|
|
2023-08-04 11:27:19 -04:00
|
|
|
/* Locking requirement during a page walk. */
|
|
|
|
enum page_walk_lock {
|
|
|
|
/* mmap_lock should be locked for read to stabilize the vma tree */
|
|
|
|
PGWALK_RDLOCK = 0,
|
|
|
|
/* vma will be write-locked during the walk */
|
|
|
|
PGWALK_WRLOCK = 1,
|
|
|
|
/* vma is expected to be already write-locked during the walk */
|
|
|
|
PGWALK_WRLOCK_VERIFY = 2,
|
|
|
|
};
|
|
|
|
|
2019-08-28 10:19:53 -04:00
|
|
|
/**
|
2021-04-30 01:59:40 -04:00
|
|
|
* struct mm_walk_ops - callbacks for walk_page_range
|
2020-02-03 20:35:45 -05:00
|
|
|
* @pgd_entry: if set, called for each non-empty PGD (top-level) entry
|
|
|
|
* @p4d_entry: if set, called for each non-empty P4D entry
|
|
|
|
* @pud_entry: if set, called for each non-empty PUD entry
|
|
|
|
* @pmd_entry: if set, called for each non-empty PMD entry
|
2019-08-28 10:19:54 -04:00
|
|
|
* this handler is required to be able to handle
|
|
|
|
* pmd_trans_huge() pmds. They may simply choose to
|
|
|
|
* split_huge_page() instead of handling it explicitly.
|
2022-08-22 09:01:32 -04:00
|
|
|
* @pte_entry: if set, called for each PTE (lowest-level) entry,
|
|
|
|
* including empty ones
|
2020-02-03 20:36:03 -05:00
|
|
|
* @pte_hole: if set, called for each hole at all levels,
|
2022-08-22 09:01:32 -04:00
|
|
|
* depth is -1 if not known, 0:PGD, 1:P4D, 2:PUD, 3:PMD.
|
|
|
|
* Any folded depths (where PTRS_PER_P?D is equal to 1)
|
|
|
|
* are skipped.
|
2022-12-16 10:52:26 -05:00
|
|
|
* @hugetlb_entry: if set, called for each hugetlb entry. This hook
|
|
|
|
* function is called with the vma lock held, in order to
|
|
|
|
* protect against a concurrent freeing of the pte_t* or
|
|
|
|
* the ptl. In some cases, the hook function needs to drop
|
|
|
|
* and retake the vma lock in order to avoid deadlocks
|
|
|
|
* while calling other functions. In such cases the hook
|
|
|
|
* function must either refrain from accessing the pte or
|
|
|
|
* ptl after dropping the vma lock, or else revalidate
|
|
|
|
* those items after re-acquiring the vma lock and before
|
|
|
|
* accessing them.
|
2019-08-28 10:19:54 -04:00
|
|
|
* @test_walk: caller specific callback function to determine whether
|
|
|
|
* we walk over the current vma or not. Returning 0 means
|
|
|
|
* "do page table walk over the current vma", returning
|
|
|
|
* a negative value means "abort current page table walk
|
|
|
|
* right now" and returning 1 means "skip the current vma"
|
2022-10-21 06:11:38 -04:00
|
|
|
* Note that this callback is not called when the caller
|
|
|
|
* passes in a single VMA as for walk_page_vma().
|
2019-10-01 05:17:34 -04:00
|
|
|
* @pre_vma: if set, called before starting walk on a non-null vma.
|
|
|
|
* @post_vma: if set, called after a walk on a non-null vma, provided
|
|
|
|
* that @pre_vma and the vma walk succeeded.
|
2020-02-03 20:35:45 -05:00
|
|
|
*
|
|
|
|
* p?d_entry callbacks are called even if those levels are folded on a
|
|
|
|
* particular architecture/configuration.
|
2019-08-28 10:19:53 -04:00
|
|
|
*/
|
2019-08-28 10:19:54 -04:00
|
|
|
struct mm_walk_ops {
|
2020-02-03 20:35:45 -05:00
|
|
|
int (*pgd_entry)(pgd_t *pgd, unsigned long addr,
|
|
|
|
unsigned long next, struct mm_walk *walk);
|
|
|
|
int (*p4d_entry)(p4d_t *p4d, unsigned long addr,
|
|
|
|
unsigned long next, struct mm_walk *walk);
|
2019-08-28 10:19:53 -04:00
|
|
|
int (*pud_entry)(pud_t *pud, unsigned long addr,
|
|
|
|
unsigned long next, struct mm_walk *walk);
|
|
|
|
int (*pmd_entry)(pmd_t *pmd, unsigned long addr,
|
|
|
|
unsigned long next, struct mm_walk *walk);
|
|
|
|
int (*pte_entry)(pte_t *pte, unsigned long addr,
|
|
|
|
unsigned long next, struct mm_walk *walk);
|
|
|
|
int (*pte_hole)(unsigned long addr, unsigned long next,
|
2020-02-03 20:36:03 -05:00
|
|
|
int depth, struct mm_walk *walk);
|
2019-08-28 10:19:53 -04:00
|
|
|
int (*hugetlb_entry)(pte_t *pte, unsigned long hmask,
|
|
|
|
unsigned long addr, unsigned long next,
|
|
|
|
struct mm_walk *walk);
|
|
|
|
int (*test_walk)(unsigned long addr, unsigned long next,
|
|
|
|
struct mm_walk *walk);
|
2019-10-01 05:17:34 -04:00
|
|
|
int (*pre_vma)(unsigned long start, unsigned long end,
|
|
|
|
struct mm_walk *walk);
|
|
|
|
void (*post_vma)(struct mm_walk *walk);
|
2023-08-04 11:27:19 -04:00
|
|
|
enum page_walk_lock walk_lock;
|
2019-08-28 10:19:54 -04:00
|
|
|
};
|
|
|
|
|
2020-02-03 20:35:45 -05:00
|
|
|
/*
|
|
|
|
* Action for pud_entry / pmd_entry callbacks.
|
|
|
|
* ACTION_SUBTREE is the default
|
|
|
|
*/
|
|
|
|
enum page_walk_action {
|
|
|
|
/* Descend to next level, splitting huge pages if needed and possible */
|
|
|
|
ACTION_SUBTREE = 0,
|
|
|
|
/* Continue to next entry at this level (ignoring any subtree) */
|
|
|
|
ACTION_CONTINUE = 1,
|
|
|
|
/* Call again for this entry */
|
|
|
|
ACTION_AGAIN = 2
|
|
|
|
};
|
|
|
|
|
2019-08-28 10:19:54 -04:00
|
|
|
/**
|
2021-04-30 01:59:40 -04:00
|
|
|
* struct mm_walk - walk_page_range data
|
2019-08-28 10:19:54 -04:00
|
|
|
* @ops: operation to call during the walk
|
|
|
|
* @mm: mm_struct representing the target process of page table walk
|
2020-02-03 20:36:42 -05:00
|
|
|
* @pgd: pointer to PGD; only valid with no_vma (otherwise set to NULL)
|
2019-08-28 10:19:54 -04:00
|
|
|
* @vma: vma currently walked (NULL if walking outside vmas)
|
2020-02-03 20:35:45 -05:00
|
|
|
* @action: next action to perform (see enum page_walk_action)
|
2020-02-03 20:35:50 -05:00
|
|
|
* @no_vma: walk ignoring vmas (vma will always be NULL)
|
2019-08-28 10:19:54 -04:00
|
|
|
* @private: private data for callbacks' usage
|
|
|
|
*
|
|
|
|
* (see the comment on walk_page_range() for more details)
|
|
|
|
*/
|
|
|
|
struct mm_walk {
|
|
|
|
const struct mm_walk_ops *ops;
|
2019-08-28 10:19:53 -04:00
|
|
|
struct mm_struct *mm;
|
2020-02-03 20:36:42 -05:00
|
|
|
pgd_t *pgd;
|
2019-08-28 10:19:53 -04:00
|
|
|
struct vm_area_struct *vma;
|
2020-02-03 20:35:45 -05:00
|
|
|
enum page_walk_action action;
|
2020-02-03 20:35:50 -05:00
|
|
|
bool no_vma;
|
2019-08-28 10:19:53 -04:00
|
|
|
void *private;
|
|
|
|
};
|
|
|
|
|
2019-08-28 10:19:54 -04:00
|
|
|
int walk_page_range(struct mm_struct *mm, unsigned long start,
|
|
|
|
unsigned long end, const struct mm_walk_ops *ops,
|
|
|
|
void *private);
|
2020-02-03 20:35:50 -05:00
|
|
|
int walk_page_range_novma(struct mm_struct *mm, unsigned long start,
|
|
|
|
unsigned long end, const struct mm_walk_ops *ops,
|
2020-02-03 20:36:42 -05:00
|
|
|
pgd_t *pgd,
|
2020-02-03 20:35:50 -05:00
|
|
|
void *private);
|
2022-10-21 06:11:39 -04:00
|
|
|
int walk_page_range_vma(struct vm_area_struct *vma, unsigned long start,
|
|
|
|
unsigned long end, const struct mm_walk_ops *ops,
|
|
|
|
void *private);
|
2019-08-28 10:19:54 -04:00
|
|
|
int walk_page_vma(struct vm_area_struct *vma, const struct mm_walk_ops *ops,
|
|
|
|
void *private);
|
2019-10-01 05:17:34 -04:00
|
|
|
int walk_page_mapping(struct address_space *mapping, pgoff_t first_index,
|
|
|
|
pgoff_t nr, const struct mm_walk_ops *ops,
|
|
|
|
void *private);
|
2019-08-28 10:19:53 -04:00
|
|
|
|
|
|
|
#endif /* _LINUX_PAGEWALK_H */
|