mm/mmap: refactor mlock_future_check()
Subsystems (4)
PATCH 1/1 mm/mmap: refactor mlock_future_check()
In all but one instance, mlock_future_check() is treated as a boolean function despite returning an error code. In one instance, this error code is ignored and replaced with -ENOMEM.
This is confusing, and the inversion of true -> failure, false -> success is not warranted. Convert the function to a bool, lightly refactor and return true if the check passes, false if not.
--- mm/internal.h | 4 ++-- mm/mmap.c | 33 +++++++++++++++++---------------- mm/mremap.c | 2 +- mm/secretmem.c | 2 +- 4 files changed, 21 insertions(+), 20 deletions(-)
mm/internal.h +2 -2
@@ -576,8 +576,8 @@ extern long populate_vma_page_range(struct vm_area_struct *vma,extern long faultin_vma_page_range (struct vm_area_struct *vma,unsigned long start,unsigned long end,bool write,int *locked); -extern int mlock_future_check (struct mm_struct *mm,unsigned long flags, -unsigned long len); +extern bool mlock_future_check (struct mm_struct *mm,unsigned long flags, +unsigned long bytes);/* * mlock_vma_folio() and munlock_vma_folio(): * should be called with vma's mmap_lock held for read or write,
mm/mmap.c +17 -16
@@ -182,7 +182,8 @@ static int check_brk_limits(unsigned long addr, unsigned long len)if (IS_ERR_VALUE (mapped_addr))return mapped_addr; -return mlock_future_check (current->mm, current->mm->def_flags, len); +return mlock_future_check (current->mm, current->mm->def_flags, len) + ?0 : -EAGAIN ; }static int do_brk_flags (struct vma_iterator *vmi,struct vm_area_struct *brkvma,unsigned long addr,unsigned long request,unsigned long flags);
@@ -1148,21 +1149,21 @@ static inline unsigned long round_hint_to_min(unsigned long hint)return hint; } -int mlock_future_check (struct mm_struct *mm,unsigned long flags, -unsigned long len) +bool mlock_future_check (struct mm_struct *mm,unsigned long flags, +unsigned long bytes) { -unsigned long locked, lock_limit; +unsigned long locked_pages, limit_pages; -/* mlock MCL_FUTURE? */ -if (flags &VM_LOCKED ) { - locked = len >>PAGE_SHIFT ; - locked += mm->locked_vm; - lock_limit =rlimit (RLIMIT_MEMLOCK ); - lock_limit >>=PAGE_SHIFT ; -if (locked > lock_limit && !capable (CAP_IPC_LOCK )) -return -EAGAIN ; - } -return 0 ; +if (!(flags &VM_LOCKED ) ||capable (CAP_IPC_LOCK )) +return true; + + locked_pages = bytes >>PAGE_SHIFT ; + locked_pages += mm->locked_vm; + + limit_pages =rlimit (RLIMIT_MEMLOCK ); + limit_pages >>=PAGE_SHIFT ; + +return locked_pages <= limit_pages; }static inline u64 file_mmap_size_max (struct file *file,struct inode *inode)
@@ -1274,7 +1275,7 @@ unsigned long do_mmap(struct file *file, unsigned long addr,if (!can_do_mlock ())return -EPERM ; -if (mlock_future_check (mm, vm_flags, len)) +if (!mlock_future_check (mm, vm_flags, len))return -EAGAIN ;if (file) {
@@ -1926,7 +1927,7 @@ static int acct_stack_growth(struct vm_area_struct *vma,return -ENOMEM ;/* mlock limit tests */ -if (mlock_future_check (mm, vma->vm_flags, grow <<PAGE_SHIFT )) +if (!mlock_future_check (mm, vma->vm_flags, grow <<PAGE_SHIFT ))return -ENOMEM ;/* Check to ensure the stack will not grow into a hugetlb-only region */
mm/mremap.c +1 -1
@@ -775,7 +775,7 @@ static struct vm_area_struct *vma_to_resize(unsigned long addr,if (vma->vm_flags & (VM_DONTEXPAND |VM_PFNMAP ))return ERR_PTR (-EFAULT ); -if (mlock_future_check (mm, vma->vm_flags, new_len - old_len)) +if (!mlock_future_check (mm, vma->vm_flags, new_len - old_len))return ERR_PTR (-EAGAIN ); if (!may_expand_vm(mm, vma->vm_flags,
mm/secretmem.c +1 -1
@@ -125,7 +125,7 @@ static int secretmem_mmap(struct file *file, struct vm_area_struct *vma)if ((vma->vm_flags & (VM_SHARED |VM_MAYSHARE )) ==0 )return -EINVAL ; -if (mlock_future_check (vma->vm_mm, vma->vm_flags |VM_LOCKED , len)) +if (!mlock_future_check (vma->vm_mm, vma->vm_flags |VM_LOCKED , len))return -EAGAIN ;vm_flags_set (vma,VM_LOCKED |VM_DONTDUMP );
Signature · 1 line
2.40.1
Andrew Morton
maintainerQuoted 7 lines · On Mon, 22 May 2023 09:24:12 +0100 Lorenzo Stoakes <[email protected]> wrote:
In all but one instance,
mlock_future_check()is treated as a boolean function despite returning an error code. In one instance, this error code is ignored and replaced with-ENOMEM.This is confusing, and the inversion of true -> failure, false -> success is not warranted. Convert the function to a bool, lightly refactor and return true if the check passes, false if not.
Yup.
I don't think the name does a good job of conveying the function's use.
mm/mmap.c unsigned long do_mmap(struct file *file, unsigned long addr, · line 1279
Quoted 3 lines
mm/mmap.c +1
-1-if (mlock_future_check (mm, vm_flags, len)) +if (!mlock_future_check (mm, vm_flags, len))return -EAGAIN ;
if (!may_mlock_future(...))
or
if (!mlock_future_ok(...))
?
Quoted 21 lines · Andrew Morton
Quoted 7 lines · On Mon, 22 May 2023 09:24:12 +0100 Lorenzo Stoakes <[email protected]> wrote:
In all but one instance,
mlock_future_check()is treated as a boolean function despite returning an error code. In one instance, this error code is ignored and replaced with-ENOMEM.This is confusing, and the inversion of true -> failure, false -> success is not warranted. Convert the function to a bool, lightly refactor and return true if the check passes, false if not.
Yup.
I don't think the name does a good job of conveying the function's use.
mm/mmap.c unsigned long do_mmap(struct file *file, unsigned long addr, · line 1279
Quoted 3 lines
mm/mmap.c +1
-1-if (mlock_future_check (mm, vm_flags, len)) +if (!mlock_future_check (mm, vm_flags, len))return -EAGAIN ;if (!may_mlock_future(...))
Quoted 7 lines
or
if (!mlock_future_ok(...))?
Yeah I struggled with this, because the check only triggers if VM_LOCKED. I was originally toying with can_mlock_future() but of course, it also returns true if !VM_LOCKED...
I think your suggestion of mlock_future_ok() works well, could you change it to that? Thanks!
Andrew Morton
maintainerQuoted 30 lines · On Mon, 22 May 2023 21:34:31 +0100 Lorenzo Stoakes <[email protected]> wrote:
Quoted 21 lines · Andrew Morton
Quoted 7 lines · On Mon, 22 May 2023 09:24:12 +0100 Lorenzo Stoakes <[email protected]> wrote:
In all but one instance,
mlock_future_check()is treated as a boolean function despite returning an error code. In one instance, this error code is ignored and replaced with-ENOMEM.This is confusing, and the inversion of true -> failure, false -> success is not warranted. Convert the function to a bool, lightly refactor and return true if the check passes, false if not.
Yup.
I don't think the name does a good job of conveying the function's use.
Review
Quoted 3 lines
(quoted diff) +1
-1- if (mlock_future_check(mm, vm_flags, len)) + if (!mlock_future_check(mm, vm_flags, len)) return -EAGAIN;if (!may_mlock_future(...))Quoted 7 lines
or
if (!mlock_future_ok(...))?
Quoted 6 lines
Yeah I struggled with this, because the check only triggers if
VM_LOCKED. I was originally toying withcan_mlock_future()but of course, it also returns true if !VM_LOCKED...I think your suggestion of
mlock_future_ok()works well, could you change it to that? Thanks!
Sure. I'll make it a separate patch.
From: Andrew Morton <[email protected]>
Subject: mm/mlock: rename mlock_future_check() to mlock_future_ok()
Date: Mon May 22 01:52:10 PM PDT 2023
It is felt that the name mlock_future_check() is vague - it doesn't particularly convey the function's operation. mlock_future_ok() is a clearer name for a predicate function.
---
mm/internal.h | 2 +- mm/mmap.c | 8 ++++---- mm/mremap.c | 2 +- mm/secretmem.c | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-)
mm/internal.h renamed from mm/internal.h~mm-mlock-rename-mlock_future_check-to-mlock_future_ok +1 -1
@@ -576,7 +576,7 @@ extern long populate_vma_page_range(struextern long faultin_vma_page_range (struct vm_area_struct *vma,unsigned long start,unsigned long end,bool write,int *locked); -extern bool mlock_future_check (struct mm_struct *mm,unsigned long flags, +extern bool mlock_future_ok (struct mm_struct *mm,unsigned long flags,unsigned long bytes);/* * mlock_vma_folio() and munlock_vma_folio():
mm/mmap.c renamed from mm/mmap.c~mm-mlock-rename-mlock_future_check-to-mlock_future_ok +4 -4
@@ -182,7 +182,7 @@ static int check_brk_limits(unsigned lonif (IS_ERR_VALUE (mapped_addr))return mapped_addr; -return mlock_future_check (current->mm, current->mm->def_flags, len) +return mlock_future_ok (current->mm, current->mm->def_flags, len) ?0 : -EAGAIN ; } static int do_brk_flags(struct vma_iterator *vmi, struct vm_area_struct *brkvma,
@@ -1149,7 +1149,7 @@ static inline unsigned long round_hint_treturn hint; } -bool mlock_future_check (struct mm_struct *mm,unsigned long flags, +bool mlock_future_ok (struct mm_struct *mm,unsigned long flags,unsigned long bytes) {unsigned long locked_pages, limit_pages;
@@ -1275,7 +1275,7 @@ unsigned long do_mmap(struct file *file,if (!can_do_mlock ())return -EPERM ; -if (!mlock_future_check (mm, vm_flags, len)) +if (!mlock_future_ok (mm, vm_flags, len))return -EAGAIN ;if (file) {
@@ -1927,7 +1927,7 @@ static int acct_stack_growth(struct vm_areturn -ENOMEM ;/* mlock limit tests */ -if (!mlock_future_check (mm, vma->vm_flags, grow <<PAGE_SHIFT )) +if (!mlock_future_ok (mm, vma->vm_flags, grow <<PAGE_SHIFT ))return -ENOMEM ;/* Check to ensure the stack will not grow into a hugetlb-only region */
mm/mremap.c renamed from mm/mremap.c~mm-mlock-rename-mlock_future_check-to-mlock_future_ok +1 -1
@@ -775,7 +775,7 @@ static struct vm_area_struct *vma_to_resif (vma->vm_flags & (VM_DONTEXPAND |VM_PFNMAP ))return ERR_PTR (-EFAULT ); -if (!mlock_future_check (mm, vma->vm_flags, new_len - old_len)) +if (!mlock_future_ok (mm, vma->vm_flags, new_len - old_len))return ERR_PTR (-EAGAIN ); if (!may_expand_vm(mm, vma->vm_flags,
mm/secretmem.c renamed from mm/secretmem.c~mm-mlock-rename-mlock_future_check-to-mlock_future_ok +1 -1
@@ -125,7 +125,7 @@ static int secretmem_mmap(struct file *fif ((vma->vm_flags & (VM_SHARED |VM_MAYSHARE )) ==0 )return -EINVAL ; -if (!mlock_future_check (vma->vm_mm, vma->vm_flags |VM_LOCKED , len)) +if (!mlock_future_ok (vma->vm_mm, vma->vm_flags |VM_LOCKED , len))return -EAGAIN ;vm_flags_set (vma,VM_LOCKED |VM_DONTDUMP );
_
Quoted 9 lines · Lorenzo Stoakes
In all but one instance,
mlock_future_check()is treated as a boolean function despite returning an error code. In one instance, this error code is ignored and replaced with-ENOMEM.This is confusing, and the inversion of true -> failure, false -> success is not warranted. Convert the function to a bool, lightly refactor and return true if the check passes, false if not.
Signed-off-by Lorenzo Stoakes <[email protected]>
Quoted 12 lines
--- mm/internal.h | 4 ++-- mm/mmap.c | 33 +++++++++++++++++---------------- mm/mremap.c | 2 +- mm/secretmem.c | 2 +- 4 files changed, 21 insertions(+), 20 deletions(-)mm/internal.h +0
-0
mm/internal.h extern long populate_vma_page_range(struct vm_area_struct *vma, · line 580
Quoted 7 lines
mm/internal.h +2
-2@@ -576,8 +576,8 @@ extern long populate_vma_page_range(struct vm_area_struct *vma,extern long faultin_vma_page_range (struct vm_area_struct *vma,unsigned long start,unsigned long end,bool write,int *locked); -extern int mlock_future_check (struct mm_struct *mm,unsigned long flags, -unsigned long len); +extern bool mlock_future_check (struct mm_struct *mm,unsigned long flags, +unsigned long bytes);
This would have been good opportunity to drop the extern.