remove mmap_action success, error hooks
Subsystems (4)
Lorenzo Stoakes
maintainerv3 cover 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 override 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.
v3:
* Rename error_filter -> errror_override + update commit message as per David.
v2:
* Fold fix-patch in, defaulting the vma descriptor vm_ops field to the dummy VMA operations.
* Update commit message in 1/3 to reflect this.
https://lore.kernel.org/all/[email protected]
v1:
https://lore.kernel.org/all/[email protected]
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_override
drivers/char/mem.c | 25 ++++++------------------- include/linux/mm.h | 5 +++++ include/linux/mm_types.h | 19 +++---------------- mm/util.c | 32 ++++++++++++++++++++++---------- mm/vma.c | 3 +++ tools/testing/vma/include/dup.h | 20 ++++---------------- 6 files changed, 43 insertions(+), 61 deletions(-)
--
2.54.0
Lorenzo Stoakes
maintainerPATCH v3 1/3 drivers/char/mem: eliminate unnecessary use of success_hook
/dev/zero, uniquely, marks memory mapped there as anonymous. This is currently achieved using the mmap_action->success_hook.
However this hook circumvents the abstraction of VMA initialisation so it's preferable to do things a different way.
To achieve this, this patch firstly defaults the VMA descriptor's vm_ops field to the dummy VMA operations, which is what file-backed VMAs default this field to.
That way, we can detect whether a driver sets this field to NULL in order to mark it anonymous.
We then introduce vma_desc_set_anonymous() to do this explicitly, and invoke it in mmap_zero_prepare().
This way, any driver which does not explicitly set desc->vm_ops, retains the dummy vm_ops as they would previously.
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.
--- drivers/char/mem.c | 17 +++++------------ include/linux/mm.h | 5 +++++ mm/util.c | 1 + mm/vma.c | 3 +++ tools/testing/vma/include/dup.h | 1 + 5 files changed, 15 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/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 +3 -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; }
@@ -2744,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 ;
Signature · 1 line
2.54.0
Re: [PATCH v3 1/3] drivers/char/mem: eliminate unnecessary use of success_hook
Quoted 19 lines · Lorenzo Stoakes
/dev/zero, uniquely, marks memory mapped there as anonymous. This is currently achieved using themmap_action->success_hook.However this hook circumvents the abstraction of VMA initialisation so it's preferable to do things a different way.
To achieve this, this patch firstly defaults the VMA descriptor's
vm_opsfield to the dummy VMA operations, which is what file-backed VMAs default this field to.That way, we can detect whether a driver sets this field to NULL in order to mark it anonymous.
We then introduce
vma_desc_set_anonymous()to do this explicitly, and invoke it inmmap_zero_prepare().This way, any driver which does not explicitly set
desc->vm_ops, retains the dummyvm_opsas they would previously.
Quoted 8 lines
We also update
set_vma_user_defined_fields()to make clear that we are either settingvma->vm_opsto what is provided by the driver (or defaulting todummy_vm_opsif not set), or setting the VMA anonymous.This lays the groundwork for removing the success hook.
Signed-off-by Lorenzo Stoakes <[email protected]>
Re: [PATCH v3 1/3] drivers/char/mem: eliminate unnecessary use of success_hook
In reply to Lorenzo StoakesQuoted 19 lines · Lorenzo Stoakes
/dev/zero, uniquely, marks memory mapped there as anonymous. This is currently achieved using themmap_action->success_hook.However this hook circumvents the abstraction of VMA initialisation so it's preferable to do things a different way.
To achieve this, this patch firstly defaults the VMA descriptor's
vm_opsfield to the dummy VMA operations, which is what file-backed VMAs default this field to.That way, we can detect whether a driver sets this field to NULL in order to mark it anonymous.
We then introduce
vma_desc_set_anonymous()to do this explicitly, and invoke it inmmap_zero_prepare().This way, any driver which does not explicitly set
desc->vm_ops, retains the dummyvm_opsas they would previously.
Quoted 8 lines
We also update
set_vma_user_defined_fields()to make clear that we are either settingvma->vm_opsto what is provided by the driver (or defaulting todummy_vm_opsif not set), or setting the VMA anonymous.This lays the groundwork for removing the success hook.
Signed-off-by Lorenzo Stoakes <[email protected]>
Signature · 2 lines
Oscar Salvador SUSE Labs
Lorenzo Stoakes
maintainerPATCH v3 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
@@ -1397,8 +1397,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
Re: [PATCH v3 2/3] mm/vma: remove mmap_action->success_hook
Quoted 6 lines · Lorenzo Stoakes
This 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_prepareeliminates - a pointer to the VMA.
Quoted 7 lines
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.Signed-off-by Lorenzo Stoakes <[email protected]>
Reach out if I can be of any help with the hugetlb thing :-)
Signature · 2 lines
Oscar Salvador SUSE Labs
Lorenzo Stoakes
maintainerRe: [PATCH v3 2/3] mm/vma: remove mmap_action->success_hook
Quoted 12 lines · Oscar Salvador (SUSE)
Quoted 11 lines · Lorenzo Stoakes
This 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_prepareeliminates - 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.
Quoted 4 lines
Quoted 2 lines
Signed-off-by Lorenzo Stoakes <[email protected]>Reach out if I can be of any help with the hugetlb thing :-)
Thanks :)
I will probably have a quick go at it at some point and just see what I can do, hopefully I can figure something out quick, otherwise might very well take you up on that :))
Quoted 2 lines
Reviewed-by Oscar Salvador <[email protected]>
Thanks!
Quoted 6 lines
--
Oscar Salvador
SUSE Labs
Cheers, Lorenzo
Lorenzo Stoakes
maintainerPATCH v3 3/3 mm/vma: eliminate mmap_action->error_hook, introduce error_override
In reply to Lorenzo StoakesRather than providing a hook, simplify things by providing the ability to override mmap action 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_override 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_override = -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, replace errors that arise from mmap actions with this +* value instead. Only valid error codes may be specified. */ -int (*error_hook)(int err); +int error_override;/* * This should be set in rare instances where the operation required
mm/util.c +21 -8
@@ -1414,16 +1414,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_override ?: err; }#ifdef CONFIG_MMU + +static int check_mmap_action (struct mmap_action *action) +{ +const unsigned long override = action->error_override; + +if (WARN_ON_ONCE (override && !IS_ERR_VALUE (override))) +return -EINVAL ; + +return 0 ; +} +/** * mmap_action_prepare - Perform preparatory setup for an VMA descriptor * action which need to be performed.
@@ -1433,7 +1439,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, replace errors that arise from mmap actions with this +* value instead. Only valid error codes may be specified. */ -int (*error_hook)(int err); +int error_override;/* * This should be set in rare instances where the operation required
Signature · 1 line
2.54.0
Re: [PATCH v3 3/3] mm/vma: eliminate mmap_action->error_hook, introduce error_override
Quoted 5 lines · Lorenzo Stoakes
Rather than providing a hook, simplify things by providing the ability to override mmap action 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.
Quoted 8 lines
This way, we eliminate all hooks but
mmap_prepareand 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/memlogic (the only user) to usemmap_action->error_overrideinstead.
Thanks!
Signature · 3 lines
Cheers, David
Re: [PATCH v3 3/3] mm/vma: eliminate mmap_action->error_hook, introduce error_override
In reply to Lorenzo StoakesQuoted 8 lines · Lorenzo Stoakes
Rather than providing a hook, simplify things by providing the ability to override mmap action 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_prepareand allow only mmap actions to be specified (which core mm controls).
Quoted 7 lines
This significantly improves robustness and eliminates any unnecessary code duplication in driver mmap hooks.
We also update the
/dev/memlogic (the only user) to usemmap_action->error_overrideinstead.Signed-off-by Lorenzo Stoakes <[email protected]>
Signature · 2 lines
Oscar Salvador SUSE Labs
Andrew Morton
maintainerQuoted 27 lines · On Tue, 2 Jun 2026 12:06:24 +0100 Lorenzo Stoakes <[email protected]> wrote:
The
mmap_action->success_hookwas 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/zerowhich 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_preparework.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 override 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.
Quoted 7 lines
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_actionhas no custom hooks at all, which seems rather more cromulent than before.
Updated, thanks.
Quoted 3 lines
v3:
* Renameerror_filter->errror_override+ update commit message as per David.
Here's how v3 altered mm.git:
drivers/char/mem.c | 2 +- include/linux/mm_types.h | 6 +++--- mm/util.c | 6 +++--- tools/testing/vma/include/dup.h | 6 +++--- 4 files changed, 10 insertions(+), 10 deletions(-)
drivers/char/mem.c renamed from drivers/char/mem.c~b +1 -1
@@ -357,7 +357,7 @@ static int mmap_mem_prepare(struct vm_ar/* Remap-pfn-range will mark the range with the I/O flag. */ mmap_action_remap_full (desc, desc->pgoff); - desc->action.error_filter = -EAGAIN ; + desc->action.error_override = -EAGAIN ;return 0 ; }
include/linux/mm_types.h renamed from include/linux/mm_types.h~b +3 -3
@@ -844,10 +844,10 @@ struct mmap_action {enum mmap_action_type type;/* -* If non-zero, filter errors that arise from mmap actions such that we -* return error_filter instead. Only valid error codes may be specified. +* If non-zero, replace errors that arise from mmap actions with this +* value instead. Only valid error codes may be specified. */ -int error_filter; +int error_override;/* * This should be set in rare instances where the operation required
mm/util.c renamed from mm/util.c~b +3 -3
@@ -1415,16 +1415,16 @@ static int mmap_action_finish(struct vm_ len =vma_pages (vma) <<PAGE_SHIFT ;do_munmap (current->mm, vma->vm_start, len,NULL ); -return action->error_filter ?: err; +return action->error_override ?: err; }#ifdef CONFIG_MMU static int check_mmap_action (struct mmap_action *action) { -const unsigned long filter = action->error_filter; +const unsigned long override = action->error_override; -if (WARN_ON_ONCE (filter && !IS_ERR_VALUE (filter))) +if (WARN_ON_ONCE (override && !IS_ERR_VALUE (override)))return -EINVAL ;return 0 ;
tools/testing/vma/include/dup.h renamed from tools/testing/vma/include/dup.h~b +3 -3
@@ -483,10 +483,10 @@ struct mmap_action {enum mmap_action_type type;/* -* If non-zero, filter errors that arise from mmap actions such that we -* return error_filter instead. Only valid error codes may be specified. +* If non-zero, replace errors that arise from mmap actions with this +* value instead. Only valid error codes may be specified. */ -int error_filter; +int error_override;/* * This should be set in rare instances where the operation required
_