remove mmap_action success, error hooks
Subsystems (4)
Lorenzo Stoakes
maintainercover remove mmap_action success, error hooks
The mmap_action->success_hook was a strange beast added to enable code which appeared to absolutely require access to a VMA pointer to work correctly.
Primarily this was for hugetlb, however a different approach will be taken there, as clearly more work is required to figure out a sensible way of converting hugetlb to use mmap_prepare.
The other user was the memory char driver, specifically /dev/zero which has the unusual property of explicitly setting file-backed VMAs anonymous.
Providing the success hook was always foolish, as it allowed drivers a way to workaround the restriction that they should not access a pointer to a not-yet-correctly-initialised VMA - which defeats the purpose of the mmap_prepare work.
We can achieve the same thing in memory char driver without needing the success hook, so this series removes that, then removes the success hook altogether.
The error hook is also unnecessary - the motivation for this was for functions which need to filter the error code when performing an mmap action in order to avoid breaking userspace.
We can achieve this by just providing a field for the error code. Doing this means we don't have to worry about the hook doing anything odd.
We also add a check to ensure the error code is in fact valid.
Again the memory char driver is the only current user of this, so this series updates it to use that.
After this change mmap_action has no custom hooks at all, which seems rather more cromulent than before.
Lorenzo Stoakes (3):
drivers/char/mem: eliminate unnecessary use of success_hook mm/vma: remove mmap_action->success_hook
mm/vma: eliminate mmap_action->error_hook, introduce error_filter
drivers/char/mem.c | 25 ++++++------------------- include/linux/mm.h | 5 +++++ include/linux/mm_types.h | 19 +++---------------- mm/util.c | 31 +++++++++++++++++++++---------- mm/vma.c | 2 ++ tools/testing/vma/include/dup.h | 19 +++---------------- 6 files changed, 40 insertions(+), 61 deletions(-)
--
2.54.0
Lorenzo Stoakes
maintainerPATCH 1/3 drivers/char/mem: eliminate unnecessary use of success_hook
Introduce vma_desc_set_anonymous() and invoke it from mmap_zero_prepare() in order to eliminate the use of the mmap_action->success_hook.
Note that file-backed VMAs default to vma->vm_ops == dummy_vm_ops, so if an mmap or mmap_prepare hook does not set desc->vm_ops, the VMA will remain file-backed.
We also update set_vma_user_defined_fields() to make clear that we are either setting vma->vm_ops to what is provided by the driver (or defaulting to dummy_vm_ops if not set), or setting the VMA anonymous.
This lays the groundwork for removing the success hook, which was provided as a workaround for drivers (mostly, hugetlb) that still absolutely seemed to rely upon having access to a VMA pointer.
However, for the transition to be useful, we really must eliminate this and make no exceptions, otherwise drivers can simply work around it.
--- drivers/char/mem.c | 17 +++++------------ include/linux/mm.h | 5 +++++ mm/vma.c | 2 ++ 3 files changed, 12 insertions(+), 12 deletions(-)
drivers/char/mem.c +5 -12
@@ -504,17 +504,6 @@ static ssize_t read_zero(struct file *file, char __user *buf,return cleared; } -static int mmap_zero_private_success (const struct vm_area_struct *vma) -{ -/* -* This is a highly unique situation where we mark a MAP_PRIVATE mapping -* of /dev/zero anonymous, despite it not being. -*/ -vma_set_anonymous ((struct vm_area_struct *)vma); - -return 0 ; -} -static int mmap_zero_prepare (struct vm_area_desc *desc) {#ifndef CONFIG_MMU
@@ -523,7 +512,11 @@ static int mmap_zero_prepare(struct vm_area_desc *desc)if (vma_desc_test (desc,VMA_SHARED_BIT ))return shmem_zero_setup_desc (desc); - desc->action.success_hook = mmap_zero_private_success; +/* +* This is a highly unique situation where we mark a MAP_PRIVATE mapping +* of /dev/zero anonymous, despite it not being. +*/ +vma_desc_set_anonymous (desc);return 0 ; }
include/linux/mm.h +5 -0
@@ -1489,6 +1489,11 @@ static inline void vma_set_anonymous(struct vm_area_struct *vma) vma->vm_ops =NULL ; } +static inline void vma_desc_set_anonymous (struct vm_area_desc *desc) +{ + desc->vm_ops =NULL ; +} +static inline bool vma_is_anonymous (struct vm_area_struct *vma) {return !vma->vm_ops;
mm/vma.c +2 -0
@@ -2697,6 +2697,8 @@ static void set_vma_user_defined_fields(struct vm_area_struct *vma, {if (map->vm_ops) vma->vm_ops = map->vm_ops; +else /* Only /dev/zero should do this. */ +vma_set_anonymous (vma); vma->vm_private_data = map->vm_private_data; }
Signature · 1 line
2.54.0
Lorenzo Stoakes
maintainerPATCH 2/3 mm/vma: remove mmap_action->success_hook
In reply to Lorenzo StoakesThis hook was introduced to work around code that seemed to absolutely require access to a VMA pointer upon mmap().
However, providing this hook leaves a backdoor to drivers getting access to the very thing mmap_prepare eliminates - a pointer to the VMA.
Let's solve this contradiction by removing it. The key intended user was hugetlb, however it seems that the best course now is to avoid allowing all drivers the ability to work around mmap_prepare, and find a different solution there.
--- include/linux/mm_types.h | 10 ---------- mm/util.c | 2 -- tools/testing/vma/include/dup.h | 10 ---------- 3 files changed, 22 deletions(-)
include/linux/mm_types.h +0 -10
@@ -843,16 +843,6 @@ struct mmap_action { };enum mmap_action_type type; -/* -* If specified, this hook is invoked after the selected action has been -* successfully completed. Note that the VMA write lock still held. -* -* The absolute minimum ought to be done here. -* -* Returns 0 on success, or an error code. -*/ -int (*success_hook)(const struct vm_area_struct *vma); -/* * If specified, this hook is invoked when an error occurred when * attempting the selected action.
mm/util.c +0 -2
@@ -1396,8 +1396,6 @@ static int mmap_action_finish(struct vm_area_struct *vma,if (!err) err =call_vma_mapped (vma); -if (!err && action->success_hook) - err = action->success_hook (vma);/* do_munmap() might take rmap lock, so release if held. */ maybe_rmap_unlock_action (vma, action);
tools/testing/vma/include/dup.h +0 -10
@@ -482,16 +482,6 @@ struct mmap_action { };enum mmap_action_type type; -/* -* If specified, this hook is invoked after the selected action has been -* successfully completed. Note that the VMA write lock still held. -* -* The absolute minimum ought to be done here. -* -* Returns 0 on success, or an error code. -*/ -int (*success_hook)(const struct vm_area_struct *vma); -/* * If specified, this hook is invoked when an error occurred when * attempting the selection action.
Signature · 1 line
2.54.0
Lorenzo Stoakes
maintainerPATCH 3/3 mm/vma: eliminate mmap_action->error_hook, introduce error_filter
In reply to Lorenzo StoakesRather than providing a hook, simplify things by providing the ability to filter errors. This allows us to more carefully validate the value provided and thus ensure only a valid error code is specified, and simplifies the interface.
This way, we eliminate all hooks but mmap_prepare and allow only mmap actions to be specified (which core mm controls).
This significantly improves robustness and eliminates any unnecessary code duplication in driver mmap hooks.
We also update the /dev/mem logic (the only user) to use mmap_action->error_filter instead.
--- drivers/char/mem.c | 8 +------- include/linux/mm_types.h | 9 +++------ mm/util.c | 29 +++++++++++++++++++++-------- tools/testing/vma/include/dup.h | 9 +++------ 4 files changed, 28 insertions(+), 27 deletions(-)
drivers/char/mem.c +1 -7
@@ -322,11 +322,6 @@ static const struct vm_operations_struct mmap_mem_ops = {#endif }; -static int mmap_filter_error (int err) -{ -return -EAGAIN ; -} -static int mmap_mem_prepare (struct vm_area_desc *desc) {struct file *file = desc->file;
@@ -362,8 +357,7 @@ static int mmap_mem_prepare(struct vm_area_desc *desc)/* Remap-pfn-range will mark the range with the I/O flag. */ mmap_action_remap_full (desc, desc->pgoff); -/* We filter remap errors to -EAGAIN. */ - desc->action.error_hook = mmap_filter_error; + desc->action.error_filter = -EAGAIN ;return 0 ; }
include/linux/mm_types.h +3 -6
@@ -844,13 +844,10 @@ struct mmap_action {enum mmap_action_type type;/* -* If specified, this hook is invoked when an error occurred when -* attempting the selected action. -* -* The hook can return an error code in order to filter the error, but -* it is not valid to clear the error here. +* If non-zero, filter errors that arise from mmap actions such that we +* return error_filter instead. Only valid error codes may be specified. */ -int (*error_hook)(int err); +int error_filter;/* * This should be set in rare instances where the operation required
mm/util.c +21 -8
@@ -1413,16 +1413,22 @@ static int mmap_action_finish(struct vm_area_struct *vma,*/ len =vma_pages (vma) <<PAGE_SHIFT ;do_munmap (current->mm, vma->vm_start, len,NULL ); -if (action->error_hook) { -/* We may want to filter the error. */ - err = action->error_hook (err); -/* The caller should not clear the error. */ -VM_WARN_ON_ONCE (!err); - } -return err; + +return action->error_filter ?: err; }#ifdef CONFIG_MMU + +static int check_mmap_action (struct mmap_action *action) +{ +const unsigned long filter = action->error_filter; + +if (WARN_ON_ONCE (filter && !IS_ERR_VALUE (filter))) +return -EINVAL ; + +return 0 ; +} +/** * mmap_action_prepare - Perform preparatory setup for an VMA descriptor * action which need to be performed.
@@ -1432,7 +1438,14 @@ static int mmap_action_finish(struct vm_area_struct *vma,*/ int mmap_action_prepare (struct vm_area_desc *desc) { -switch (desc->action.type) { +struct mmap_action *action = &desc->action; +int err; + + err =check_mmap_action (action); +if (err) +return err; + +switch (action->type) {case MMAP_NOTHING :return 0 ;case MMAP_REMAP_PFN :
tools/testing/vma/include/dup.h +3 -6
@@ -483,13 +483,10 @@ struct mmap_action {enum mmap_action_type type;/* -* If specified, this hook is invoked when an error occurred when -* attempting the selection action. -* -* The hook can return an error code in order to filter the error, but -* it is not valid to clear the error here. +* If non-zero, filter errors that arise from mmap actions such that we +* return error_filter instead. Only valid error codes may be specified. */ -int (*error_hook)(int err); +int error_filter;/* * This should be set in rare instances where the operation required
Signature · 1 line
2.54.0
Lorenzo Stoakes
maintainerRe: [PATCH 1/3] drivers/char/mem: eliminate unnecessary use of success_hook
In reply to Lorenzo StoakesHi Andrew,
Ugh sorry, case of the hit send + realise silly mistake situation :)
Fix-patch below, can respin tomorrow if easier.
And my local AI review didn't find this :(
Cheers, Lorenzo
----8<----
From 1910fc9aa03dd49983cfe7605698f33c57b0923e Mon Sep 17 00:00:00 2001
From: Lorenzo Stoakes <[email protected]>
Date: Thu, 21 May 2026 18:10:42 +0100
Subject: [PATCH] default descriptor vm_ops to dummy vm_ops
We need to default the VMA descriptor's VMA operations to vma_dummy_vm_ops so we can correctly detect the case where the VMA is made anonymous.
This is what a new file-backed VMA's vm_ops defaults to, so if an mmap_prepare hook does not specify VMA operations this is what it expects.
Previously we treated NULL as 'not set' but now we want to explicitly treat it as meaning 'make anon' as per /dev/zero.
We also update compat_set_desc_from_vma() and the VMA tests to reflect this.
--- mm/util.c | 1 + mm/vma.c | 1 + tools/testing/vma/include/dup.h | 1 + 3 files changed, 3 insertions(+)
mm/util.c +1 -0
@@ -1192,6 +1192,7 @@ void compat_set_desc_from_vma(struct vm_area_desc *desc, desc->vm_file = vma->vm_file; desc->vma_flags = vma->flags; desc->page_prot = vma->vm_page_prot; + desc->vm_ops = vma->vm_ops;/* Default. */ desc->action.type =MMAP_NOTHING ;
mm/vma.c +1 -0
@@ -2746,6 +2746,7 @@ static unsigned long __mmap_region(struct file *file, unsigned long addr, .action = { .type = MMAP_NOTHING, /* Default to no further action. */ }, + .vm_ops = &vma_dummy_vm_ops, };bool allocated_new = false;int error;
tools/testing/vma/include/dup.h +1 -0
@@ -1303,6 +1303,7 @@ static inline void compat_set_desc_from_vma(struct vm_area_desc *desc, desc->vm_file = vma->vm_file; desc->vma_flags = vma->flags; desc->page_prot = vma->vm_page_prot; + desc->vm_ops = vma->vm_ops;/* Default. */ desc->action.type =MMAP_NOTHING ;
--
2.54.0