various improvements to the GUP interface
Subsystems (8)
cover various improvements to the GUP interface
A series of fixes to simplify and improve the GUP interface with an eye to providing groundwork to future improvements:-
* __access_remote_vm() and access_remote_vm() are functionally identical, so make the former static such that in future we can potentially change the external-facing implementation details of this function.
* Extend is_valid_gup_args() to cover the missing FOLL_TOUCH case, and simplify things by defining INTERNAL_GUP_FLAGS to check against.
* Adjust __get_user_pages_locked() to explicitly treat a failure to pin any pages as an error in all circumstances other than FOLL_NOWAIT being specified, bringing it in line with the nommu implementation of this function.
* (With many thanks to Arnd who suggested this in the first instance) Update get_user_page_vma_remote() to explicitly only return a page or an error, simplifying the interface and avoiding the questionable IS_ERR_OR_NULL() pattern.
Lorenzo Stoakes (4):
mm: make __access_remote_vm() static
mm/gup: explicitly define and check internal GUP flags, disallow
FOLL_TOUCH
mm/gup: make failure to pin an error if FOLL_NOWAIT not specified mm/gup: adapt get_user_page_vma_remote() to never return NULL
arch/arm64/kernel/mte.c | 4 ++-- include/linux/mm.h | 18 +++++++++++++----- kernel/events/uprobes.c | 4 ++-- kernel/ptrace.c | 2 +- mm/gup.c | 16 +++++++++++++--- mm/internal.h | 3 +++ mm/memory.c | 7 +++---- mm/nommu.c | 4 ++-- 8 files changed, 39 insertions(+), 19 deletions(-)
Signature · 1 line
2.42.0
PATCH 1/4 mm: make __access_remote_vm() static
access_remote_vm() passes through parameters to __access_remote_vm() directly, so remove the __access_remote_vm() function from mm.h aand use access_remote_vm() in the one caller that needs it (ptrace_access_vm()).
This allows future adjustments to the GUP-internal __access_remote_vm() function while keeping the access_remote_vm() function stable.
--- include/linux/mm.h | 2 -- kernel/ptrace.c | 2 +- mm/memory.c | 4 ++-- mm/nommu.c | 4 ++-- 4 files changed, 5 insertions(+), 7 deletions(-)
include/linux/mm.h +0 -2
@@ -2415,8 +2415,6 @@ extern int access_process_vm(struct task_struct *tsk, unsigned long addr, void *buf, int len, unsigned int gup_flags);extern int access_remote_vm (struct mm_struct *mm,unsigned long addr,void *buf,int len,unsigned int gup_flags); -extern int __access_remote_vm (struct mm_struct *mm,unsigned long addr, -void *buf,int len,unsigned int gup_flags); long get_user_pages_remote(struct mm_struct *mm, unsigned long start, unsigned long nr_pages,
kernel/ptrace.c +1 -1
@@ -59,7 +59,7 @@ int ptrace_access_vm(struct task_struct *tsk, unsigned long addr,return 0 ; } - ret =__access_remote_vm (mm, addr, buf, len, gup_flags); + ret =access_remote_vm (mm, addr, buf, len, gup_flags);mmput (mm);return ret;
mm/memory.c +2 -2
@@ -5881,8 +5881,8 @@ EXPORT_SYMBOL_GPL(generic_access_phys);/* * Access another process' address space as given in mm. */ -int __access_remote_vm (struct mm_struct *mm,unsigned long addr,void *buf, -int len,unsigned int gup_flags) +static int __access_remote_vm (struct mm_struct *mm,unsigned long addr, +void *buf,int len,unsigned int gup_flags) {void *old_buf = buf;int write = gup_flags &FOLL_WRITE ;
mm/nommu.c +2 -2
@@ -1651,8 +1651,8 @@ vm_fault_t filemap_map_pages(struct vm_fault *vmf, }EXPORT_SYMBOL (filemap_map_pages); -int __access_remote_vm (struct mm_struct *mm,unsigned long addr,void *buf, -int len,unsigned int gup_flags) +static int __access_remote_vm (struct mm_struct *mm,unsigned long addr, +void *buf,int len,unsigned int gup_flags) {struct vm_area_struct *vma;int write = gup_flags &FOLL_WRITE ;
Signature · 1 line
2.42.0
Re: [PATCH 1/4] mm: make __access_remote_vm() static
Quoted 4 lines · Lorenzo Stoakes
access_remote_vm()passes through parameters to__access_remote_vm()directly, so remove the__access_remote_vm()function frommm.haand useaccess_remote_vm()in the one caller that needs it (ptrace_access_vm()).
Wondering why we even still have __access_remote_vm() in the first place, if it really should just be access_remote_vm() directly.
Signature · 3 lines
Cheers, David / dhildenb
Re: [PATCH 1/4] mm: make __access_remote_vm() static
In reply to Lorenzo StoakesQuoted 7 lines · Lorenzo Stoakes
access_remote_vm()passes through parameters to__access_remote_vm()directly, so remove the__access_remote_vm()function frommm.haand useaccess_remote_vm()in the one caller that needs it (ptrace_access_vm()).This allows future adjustments to the GUP-internal
__access_remote_vm()function while keeping theaccess_remote_vm()function stable.
Quoted 7 lines
Signed-off-by Lorenzo Stoakes <[email protected]>--- include/linux/mm.h | 2 -- kernel/ptrace.c | 2 +- mm/memory.c | 4 ++-- mm/nommu.c | 4 ++-- 4 files changed, 5 insertions(+), 7 deletions(-)
Why do we even have two versions?
Jason
PATCH 2/4 mm/gup: explicitly define and check internal GUP flags, disallow FOLL_TOUCH
In reply to Lorenzo StoakesRather than open-coding a list of internal GUP flags in is_valid_gup_args(), define which ones are internal.
In addition, we were not explicitly checking to see if the user passed in FOLL_TOUCH somehow, this patch fixes that.
--- mm/gup.c | 5 ++--- mm/internal.h | 3 +++ 2 files changed, 5 insertions(+), 3 deletions(-)
mm/gup.c +2 -3
@@ -2227,12 +2227,11 @@ static bool is_valid_gup_args(struct page **pages, int *locked,/* * These flags not allowed to be specified externally to the gup * interfaces: -* - FOLL_PIN/FOLL_TRIED/FOLL_FAST_ONLY are internal only +* - FOLL_TOUCH/FOLL_PIN/FOLL_TRIED/FOLL_FAST_ONLY are internal only * - FOLL_REMOTE is internal only and used on follow_page() * - FOLL_UNLOCKABLE is internal only and used if locked is !NULL */ -if (WARN_ON_ONCE (gup_flags & (FOLL_PIN |FOLL_TRIED |FOLL_UNLOCKABLE | -FOLL_REMOTE |FOLL_FAST_ONLY ))) +if (WARN_ON_ONCE (gup_flags &INTERNAL_GUP_FLAGS ))return false; gup_flags |= to_set;
mm/internal.h +3 -0
@@ -1018,6 +1018,9 @@ enum { FOLL_UNLOCKABLE = 1 << 21, }; +#define INTERNAL_GUP_FLAGS (FOLL_TOUCH | FOLL_TRIED | FOLL_REMOTE | FOLL_PIN | \ + FOLL_FAST_ONLY | FOLL_UNLOCKABLE) +/* * Indicates for which pages that are write-protected in the page table, * whether GUP has to trigger unsharing via FAULT_FLAG_UNSHARE such that the
Signature · 1 line
2.42.0
Re: [PATCH 2/4] mm/gup: explicitly define and check internal GUP flags, disallow FOLL_TOUCH
Quoted 36 lines · Lorenzo Stoakes
Rather than open-coding a list of internal GUP flags in
is_valid_gup_args(), define which ones are internal.In addition, we were not explicitly checking to see if the user passed in
FOLL_TOUCHsomehow, this patch fixes that.Signed-off-by Lorenzo Stoakes <[email protected]>--- mm/gup.c | 5 ++--- mm/internal.h | 3 +++ 2 files changed, 5 insertions(+), 3 deletions(-)mm/gup.c +2
-3@@ -2227,12 +2227,11 @@ static bool is_valid_gup_args(struct page **pages, int *locked,/* * These flags not allowed to be specified externally to the gup * interfaces: -* - FOLL_PIN/FOLL_TRIED/FOLL_FAST_ONLY are internal only +* - FOLL_TOUCH/FOLL_PIN/FOLL_TRIED/FOLL_FAST_ONLY are internal only * - FOLL_REMOTE is internal only and used on follow_page() * - FOLL_UNLOCKABLE is internal only and used if locked is !NULL */ -if (WARN_ON_ONCE (gup_flags & (FOLL_PIN |FOLL_TRIED |FOLL_UNLOCKABLE | -FOLL_REMOTE |FOLL_FAST_ONLY ))) +if (WARN_ON_ONCE (gup_flags &INTERNAL_GUP_FLAGS ))return false; gup_flags |= to_set;mm/internal.h +0
-0
mm/internal.h enum { · line 1026
Quoted 9 lines
mm/internal.h +3
-0@@ -1018,6 +1018,9 @@ enum { FOLL_UNLOCKABLE = 1 << 21, }; +#define INTERNAL_GUP_FLAGS (FOLL_TOUCH | FOLL_TRIED | FOLL_REMOTE | FOLL_PIN | \ + FOLL_FAST_ONLY | FOLL_UNLOCKABLE) +/* * Indicates for which pages that are write-protected in the page table, * whether GUP has to trigger unsharing via FAULT_FLAG_UNSHARE such that the
Signature · 3 lines
Cheers, David / dhildenb
Re: [PATCH 2/4] mm/gup: explicitly define and check internal GUP flags, disallow FOLL_TOUCH
In reply to Lorenzo StoakesQuoted 11 lines · Lorenzo Stoakes
Rather than open-coding a list of internal GUP flags in
is_valid_gup_args(), define which ones are internal.In addition, we were not explicitly checking to see if the user passed in
FOLL_TOUCHsomehow, this patch fixes that.Signed-off-by Lorenzo Stoakes <[email protected]>--- mm/gup.c | 5 ++--- mm/internal.h | 3 +++ 2 files changed, 5 insertions(+), 3 deletions(-)
Does gup_test still work? It uses FOLL_TOUCH?
Hmm. I guess it was broken for a while anyhow:
/* Just the flags we need, copied from mm.h: */
#define FOLL_WRITE 0x01 /* check pte is writable */
#define FOLL_TOUCH 0x02 /* mark page accessed */
Aside from that this seems OK
Jason
PATCH 3/4 mm/gup: make failure to pin an error if FOLL_NOWAIT not specified
In reply to Lorenzo StoakesThere really should be no circumstances under which a non-FOLL_NOWAIT GUP operation fails to return any pages, so make this an error.
To catch the trivial case, simply exit early if nr_pages == 0.
This brings __get_user_pages_locked() in line with the behaviour of its nommu variant.
--- mm/gup.c | 11 +++++++++++ 1 file changed, 11 insertions(+)
mm/gup.c +11 -0
@@ -1471,6 +1471,9 @@ static __always_inline long __get_user_pages_locked(struct mm_struct *mm,long ret, pages_done;bool must_unlock = false; +if (!nr_pages) +return 0 ; +/* * The internal caller expects GUP to manage the lock internally and the * lock must be released when this returns.
@@ -1595,6 +1598,14 @@ static __always_inline long __get_user_pages_locked(struct mm_struct *mm,mmap_read_unlock (mm); *locked =0 ; } + +/* +* Failing to pin anything implies something has gone wrong except when +* FOLL_NOWAIT is specified, so explicitly make this an error. +*/ +if (pages_done ==0 && !(flags &FOLL_NOWAIT )) +return -EFAULT ; +return pages_done; }
Signature · 1 line
2.42.0
Re: [PATCH 3/4] mm/gup: make failure to pin an error if FOLL_NOWAIT not specified
Quoted 18 lines · Lorenzo Stoakes
There really should be no circumstances under which a non-FOLL_NOWAIT GUP operation fails to return any pages, so make this an error.
To catch the trivial case, simply exit early if
nr_pages== 0.This brings
__get_user_pages_locked()in line with the behaviour of its nommu variant.Signed-off-by Lorenzo Stoakes <[email protected]>--- mm/gup.c | 11 +++++++++++ 1 file changed, 11 insertions(+)mm/gup.c +0
-0
mm/gup.c static __always_inline long __get_user_pages_locked(struct mm_struct *mm, · line 1476
Quoted 6 lines
mm/gup.c +3
-0@@ -1471,6 +1471,9 @@ static __always_inline long __get_user_pages_locked(struct mm_struct *mm,long ret, pages_done;bool must_unlock = false; +if (!nr_pages) +return 0 ; +
Probably unlikely() is reasonable. I even wonder if WARN_ON_ONCE() would be appropriate, but likely there are weird callers that end up calling this with nr_pages==0 ... probably they should be identified and changed. Future work.
Quoted 5 lines
mm/gup.c +0
-0/* * The internal caller expects GUP to manage the lock internally and the * lock must be released when this returns. @@ -1595,6 +1598,14 @@ static __always_inline long __get_user_pages_locked(struct mm_struct *mm,mmap_read_unlock (mm);
mm/gup.c static __always_inline long __get_user_pages_locked(struct mm_struct *mm, · line 1608
Quoted 10 lines
mm/gup.c +8
-0*locked =0 ; } + +/* +* Failing to pin anything implies something has gone wrong except when +* FOLL_NOWAIT is specified, so explicitly make this an error. +*/ +if (pages_done ==0 && !(flags &FOLL_NOWAIT )) +return -EFAULT ; +
But who would be affected by that and why do we care about adding this check?
This smells like a "if (WARN_ON_ONCE())", correct?
Signature · 3 lines
Cheers, David / dhildenb
Re: [PATCH 3/4] mm/gup: make failure to pin an error if FOLL_NOWAIT not specified
Quoted 49 lines · David Hildenbrand
Quoted 18 lines · Lorenzo Stoakes
There really should be no circumstances under which a non-FOLL_NOWAIT GUP operation fails to return any pages, so make this an error.
To catch the trivial case, simply exit early if
nr_pages== 0.This brings
__get_user_pages_locked()in line with the behaviour of its nommu variant.Signed-off-by Lorenzo Stoakes <[email protected]>--- mm/gup.c | 11 +++++++++++ 1 file changed, 11 insertions(+)mm/gup.c +0
-0mm/gup.c static __always_inline long __get_user_pages_locked(struct mm_struct *mm, · line 1475
Quoted 5 lines
mm/gup.c +3
-0@@ -1471,6 +1471,9 @@ static __always_inline long __get_user_pages_locked(struct mm_struct *mm,long ret, pages_done;bool must_unlock = false; +if (!nr_pages) +return 0 ; +Probably
unlikely()is reasonable. I even wonder ifWARN_ON_ONCE()would be appropriate, but likely there are weird callers that end up calling this with nr_pages==0 ... probably they should be identified and changed. Future work.Quoted 5 lines
mm/gup.c +0
-0/* * The internal caller expects GUP to manage the lock internally and the * lock must be released when this returns. @@ -1595,6 +1598,14 @@ static __always_inline long __get_user_pages_locked(struct mm_struct *mm,mmap_read_unlock (mm);mm/gup.c static __always_inline long __get_user_pages_locked(struct mm_struct *mm, · line 1608
Quoted 10 lines
mm/gup.c +8
-0*locked =0 ; } + +/* +* Failing to pin anything implies something has gone wrong except when +* FOLL_NOWAIT is specified, so explicitly make this an error. +*/ +if (pages_done ==0 && !(flags &FOLL_NOWAIT )) +return -EFAULT ; +But who would be affected by that and why do we care about adding this check?
Quoted 1 line
This smells like a "if (
WARN_ON_ONCE())", correct?
Sure it does somewhat, however there are 'ordinary' (maybe) scenarios where this could possibly happen - FOLL_UNLOCKABLE and __get_user_pages() returns 0, or lock retained for non-FOLL_NOWAIT scenario and __get_user_pages() 0 also.
So I think the safest option might be to leave without-WARN, however you could argue since we're making it an error now maybe we want to draw attention to it by warning.
I just want to avoid a warning that _might_ be a product of a particular faulting scenario.
Jason or John may have an opinion on this.
Actually having written all this, given we're changing this into an error now anyway and this is just not a correct or expected scenario, yeah I think WARN_ON_ONCE() would make sense, will update on v2.
Quoted 6 lines
--
Cheers,David / dhildenb
Jason Gunthorpe
reviewerRe: [PATCH 3/4] mm/gup: make failure to pin an error if FOLL_NOWAIT not specified
Quoted 42 lines · Lorenzo Stoakes
Quoted 35 lines
mm/gup.c static __always_inline long __get_user_pages_locked(struct mm_struct *mm, · line 1475
Quoted 10 lines
mm/gup.c +3
-0@@ -1471,6 +1471,9 @@ static __always_inline long __get_user_pages_locked(struct mm_struct *mm,long ret, pages_done;bool must_unlock = false; +if (!nr_pages) +return 0 ; +Probably
unlikely()is reasonable. I even wonder ifWARN_ON_ONCE()would be appropriate, but likely there are weird callers that end up calling this with nr_pages==0 ... probably they should be identified and changed. Future work.Quoted 5 lines
mm/gup.c +0
-0/* * The internal caller expects GUP to manage the lock internally and the * lock must be released when this returns. @@ -1595,6 +1598,14 @@ static __always_inline long __get_user_pages_locked(struct mm_struct *mm,mmap_read_unlock (mm);mm/gup.c static __always_inline long __get_user_pages_locked(struct mm_struct *mm, · line 1608
Quoted 10 lines
mm/gup.c +8
-0*locked =0 ; } + +/* +* Failing to pin anything implies something has gone wrong except when +* FOLL_NOWAIT is specified, so explicitly make this an error. +*/ +if (pages_done ==0 && !(flags &FOLL_NOWAIT )) +return -EFAULT ; +But who would be affected by that and why do we care about adding this check?
Quoted 1 line
This smells like a "if (
WARN_ON_ONCE())", correct?Sure it does somewhat, however there are 'ordinary' (maybe) scenarios where this could possibly happen -
FOLL_UNLOCKABLEand__get_user_pages()returns 0, or lock retained for non-FOLL_NOWAIT scenario and__get_user_pages()0 also.
Quoted 8 lines
So I think the safest option might be to leave without-WARN, however you could argue since we're making it an error now maybe we want to draw attention to it by warning.
I just want to avoid a warning that _might_ be a product of a particular faulting scenario.
Jason or John may have an opinion on this.
Ideally the subfunctions would never return 0 when they are not supposed to return zero and this would be a warn on to try to enforce that.
There should be a clear limited set of flags where the caller is expected to handle a 0 return - and those flags should have guidance what the caller should do to handle it..
Jason
PATCH 4/4 mm/gup: adapt get_user_page_vma_remote() to never return NULL
In reply to Lorenzo Stoakesget_user_pages_remote() will never return 0 except in the case of FOLL_NOWAIT being specified, which we explicitly disallow.
This simplifies error handling for the caller and avoids the awkwardness of dealing with both errors and failing to pin. Failing to pin here is an error.
--- arch/arm64/kernel/mte.c | 4 ++-- include/linux/mm.h | 16 +++++++++++++--- kernel/events/uprobes.c | 4 ++-- mm/memory.c | 3 +-- 4 files changed, 18 insertions(+), 9 deletions(-)
arch/arm64/kernel/mte.c +2 -2
@@ -411,8 +411,8 @@ static int __access_remote_tags(struct mm_struct *mm, unsigned long addr,struct page *page =get_user_page_vma_remote (mm, addr, gup_flags, &vma); -if (IS_ERR_OR_NULL (page)) { - err = page ==NULL ? -EIO :PTR_ERR (page); +if (IS_ERR (page)) { + err =PTR_ERR (page);break ; }
include/linux/mm.h +13 -3
@@ -2425,6 +2425,7 @@ long pin_user_pages_remote(struct mm_struct *mm, unsigned int gup_flags, struct page **pages, int *locked); +/* Either retrieve a single VMA and page, or an error. */ static inline struct page *get_user_page_vma_remote(struct mm_struct *mm, unsigned long addr, int gup_flags,
@@ -2432,12 +2433,21 @@ static inline struct page *get_user_page_vma_remote(struct mm_struct *mm, {struct page *page;struct vm_area_struct *vma; -int got =get_user_pages_remote (mm, addr,1 , gup_flags, &page,NULL ); +int got; + +if (unlikely (gup_flags &FOLL_NOWAIT )) +return ERR_PTR (-EINVAL ); + + got =get_user_pages_remote (mm, addr,1 , gup_flags, &page,NULL );if (got <0 )return ERR_PTR (got); -if (got ==0 ) -return NULL ; + +/* +* get_user_pages_remote() is guaranteed to not return 0 for +* non-FOLL_NOWAIT contexts, so this should never happen. +*/ +VM_WARN_ON (got ==0 ); vma =vma_lookup (mm, addr);if (WARN_ON_ONCE (!vma)) {
kernel/events/uprobes.c +2 -2
@@ -474,8 +474,8 @@ int uprobe_write_opcode(struct arch_uprobe *auprobe, struct mm_struct *mm, gup_flags |=FOLL_SPLIT_PMD ;/* Read the page with vaddr into memory */ old_page =get_user_page_vma_remote (mm, vaddr, gup_flags, &vma); -if (IS_ERR_OR_NULL (old_page)) -return old_page ?PTR_ERR (old_page) :0 ; +if (IS_ERR (old_page)) +return PTR_ERR (old_page); ret =verify_opcode (old_page, vaddr, &opcode);if (ret <=0 )
mm/memory.c +1 -2
@@ -5905,7 +5905,7 @@ static int __access_remote_vm(struct mm_struct *mm, unsigned long addr,struct page *page =get_user_page_vma_remote (mm, addr, gup_flags, &vma); -if (IS_ERR_OR_NULL (page)) { +if (IS_ERR (page)) {/* We might need to expand the stack to access it */ vma =vma_lookup (mm, addr);if (!vma) {
@@ -5919,7 +5919,6 @@ static int __access_remote_vm(struct mm_struct *mm, unsigned long addr,continue ; } -/* * Check if this is a VM_IO | VM_PFNMAP VMA, which * we can access using slightly different code.
Signature · 1 line
2.42.0
Re: [PATCH 4/4] mm/gup: adapt get_user_page_vma_remote() to never return NULL
Quoted 11 lines · Lorenzo Stoakes
get_user_pages_remote()will never return 0 except in the case ofFOLL_NOWAITbeing specified, which we explicitly disallow.This simplifies error handling for the caller and avoids the awkwardness of dealing with both errors and failing to pin. Failing to pin here is an error.
Suggested-by Arnd Bergmann <[email protected]>Signed-off-by Lorenzo Stoakes <[email protected]>--- arch/arm64/kernel/mte.c | 4 ++--
For arm64:
Re: [PATCH 4/4] mm/gup: adapt get_user_page_vma_remote() to never return NULL
In reply to Lorenzo StoakesQuoted 44 lines · Lorenzo Stoakes
get_user_pages_remote()will never return 0 except in the case ofFOLL_NOWAITbeing specified, which we explicitly disallow.This simplifies error handling for the caller and avoids the awkwardness of dealing with both errors and failing to pin. Failing to pin here is an error.
Suggested-by Arnd Bergmann <[email protected]>Signed-off-by Lorenzo Stoakes <[email protected]>--- arch/arm64/kernel/mte.c | 4 ++-- include/linux/mm.h | 16 +++++++++++++--- kernel/events/uprobes.c | 4 ++-- mm/memory.c | 3 +-- 4 files changed, 18 insertions(+), 9 deletions(-)arch/arm64/kernel/mte.c +2
-2@@ -411,8 +411,8 @@ static int __access_remote_tags(struct mm_struct *mm, unsigned long addr,struct page *page =get_user_page_vma_remote (mm, addr, gup_flags, &vma); -if (IS_ERR_OR_NULL (page)) { - err = page ==NULL ? -EIO :PTR_ERR (page); +if (IS_ERR (page)) { + err =PTR_ERR (page);break ; }include/linux/mm.h +1
-0@@ -2425,6 +2425,7 @@ long pin_user_pages_remote(struct mm_struct *mm, unsigned int gup_flags, struct page **pages, int *locked); +/* Either retrieve a single VMA and page, or an error. */ static inline struct page *get_user_page_vma_remote(struct mm_struct *mm, unsigned long addr, int gup_flags,
include/linux/mm.h static inline struct page *get_user_page_vma_remote(struct mm_struct *mm, · line 2440
Quoted 9 lines
include/linux/mm.h +5
-1@@ -2432,12 +2433,21 @@ static inline struct page *get_user_page_vma_remote(struct mm_struct *mm, {struct page *page;struct vm_area_struct *vma; -int got =get_user_pages_remote (mm, addr,1 , gup_flags, &page,NULL ); +int got; + +if (unlikely (gup_flags &FOLL_NOWAIT )) +return ERR_PTR (-EINVAL ); +
Do we have any callers or do we want to make that official (document it) and use WARN_ON_ONCE() instead?
include/linux/mm.h static inline struct page *get_user_page_vma_remote(struct mm_struct *mm, · line 2450
Quoted 12 lines
include/linux/mm.h +7
-2+ got =get_user_pages_remote (mm, addr,1 , gup_flags, &page,NULL );if (got <0 )return ERR_PTR (got); -if (got ==0 ) -return NULL ; + +/* +* get_user_pages_remote() is guaranteed to not return 0 for +* non-FOLL_NOWAIT contexts, so this should never happen. +*/ +VM_WARN_ON (got ==0 );
You should probably just drop that. Not worth the comment + code and its better checked inside get_user_pages_remote().
Ideally, just document that behavior for get_user_pages_remote() "Will never return 0 without FOLL_NOWAIT."
Signature · 3 lines
Cheers, David / dhildenb
Re: [PATCH 4/4] mm/gup: adapt get_user_page_vma_remote() to never return NULL
Quoted 46 lines · David Hildenbrand
Quoted 45 lines · Lorenzo Stoakes
get_user_pages_remote()will never return 0 except in the case ofFOLL_NOWAITbeing specified, which we explicitly disallow.This simplifies error handling for the caller and avoids the awkwardness of dealing with both errors and failing to pin. Failing to pin here is an error.
Suggested-by Arnd Bergmann <[email protected]>Signed-off-by Lorenzo Stoakes <[email protected]>--- arch/arm64/kernel/mte.c | 4 ++-- include/linux/mm.h | 16 +++++++++++++--- kernel/events/uprobes.c | 4 ++-- mm/memory.c | 3 +-- 4 files changed, 18 insertions(+), 9 deletions(-)arch/arm64/kernel/mte.c +2
-2@@ -411,8 +411,8 @@ static int __access_remote_tags(struct mm_struct *mm, unsigned long addr,struct page *page =get_user_page_vma_remote (mm, addr, gup_flags, &vma); -if (IS_ERR_OR_NULL (page)) { - err = page ==NULL ? -EIO :PTR_ERR (page); +if (IS_ERR (page)) { + err =PTR_ERR (page);break ; }include/linux/mm.h +1
-1@@ -2425,6 +2425,7 @@ long pin_user_pages_remote(struct mm_struct *mm, unsigned int gup_flags, struct page **pages, int *locked); +/* Either retrieve a single VMA and page, or an error. */ static inline struct page *get_user_page_vma_remote(struct mm_struct *mm, unsigned long addr, int gup_flags,@@ -2432,12 +2433,21 @@ static inline struct page *get_user_page_vma_remote(struct mm_struct *mm, {struct page *page;struct vm_area_struct *vma; -int got =get_user_pages_remote (mm, addr,1 , gup_flags, &page,NULL );
Quoted 8 lines
include/linux/mm.h static inline struct page *get_user_page_vma_remote(struct mm_struct *mm, · line 2440
Quoted 5 lines
include/linux/mm.h +5
-0+int got; + +if (unlikely (gup_flags &FOLL_NOWAIT )) +return ERR_PTR (-EINVAL ); +Do we have any callers or do we want to make that official (document it) and use
WARN_ON_ONCE()instead?
We have no callers who want to do that, will WARN_ON_ONCE() and update comment in v2.
Quoted 16 lines
include/linux/mm.h static inline struct page *get_user_page_vma_remote(struct mm_struct *mm, · line 2450
Quoted 12 lines
include/linux/mm.h +7
-2+ got =get_user_pages_remote (mm, addr,1 , gup_flags, &page,NULL );if (got <0 )return ERR_PTR (got); -if (got ==0 ) -return NULL ; + +/* +* get_user_pages_remote() is guaranteed to not return 0 for +* non-FOLL_NOWAIT contexts, so this should never happen. +*/ +VM_WARN_ON (got ==0 );You should probably just drop that. Not worth the comment + code and its better checked inside
get_user_pages_remote().
Quoted 2 lines
Ideally, just document that behavior for
get_user_pages_remote()"Will never return 0 withoutFOLL_NOWAIT."
Well you'd need to put it at all the other callers of __get_user_pages_locked() too :) so I think probably not worth doing that, at least in this patch series.
In any case, we have explicitly added this check there to ensure that's not possible so I think we're good, will just strip in v2.
Quoted 6 lines
--
Cheers,David / dhildenb
Re: [PATCH 4/4] mm/gup: adapt get_user_page_vma_remote() to never return NULL
In reply to Lorenzo StoakesQuoted 7 lines · Lorenzo Stoakes
get_user_pages_remote()will never return 0 except in the case ofFOLL_NOWAITbeing specified, which we explicitly disallow.This simplifies error handling for the caller and avoids the awkwardness of dealing with both errors and failing to pin. Failing to pin here is an error.
Quoted 8 lines
Suggested-by Arnd Bergmann <[email protected]>Signed-off-by Lorenzo Stoakes <[email protected]>--- arch/arm64/kernel/mte.c | 4 ++-- include/linux/mm.h | 16 +++++++++++++--- kernel/events/uprobes.c | 4 ++-- mm/memory.c | 3 +-- 4 files changed, 18 insertions(+), 9 deletions(-)
Good riddance to IS_ERR_OR_NULL
Jason
Quoted 20 lines · Lorenzo Stoakes
A series of fixes to simplify and improve the GUP interface with an eye to providing groundwork to future improvements:-
*
__access_remote_vm()andaccess_remote_vm()are functionally identical, so make the former static such that in future we can potentially change the external-facing implementation details of this function.* Extend
is_valid_gup_args()to cover the missingFOLL_TOUCHcase, and simplify things by definingINTERNAL_GUP_FLAGSto check against.* Adjust
__get_user_pages_locked()to explicitly treat a failure to pin any pages as an error in all circumstances other thanFOLL_NOWAITbeing specified, bringing it in line with the nommu implementation of this function.* (With many thanks to Arnd who suggested this in the first instance) Update
get_user_page_vma_remote()to explicitly only return a page or an error, simplifying the interface and avoiding the questionableIS_ERR_OR_NULL()pattern.
Quoted 6 lines
Lorenzo Stoakes (4):
mm: make__access_remote_vm()static
mm/gup: explicitly define and check internal GUP flags, disallow
FOLL_TOUCH
mm/gup: make failure to pin an error ifFOLL_NOWAITnot specified mm/gup: adaptget_user_page_vma_remote()to never return NULL
I don't normally review mm patches, but I had a look since it was started by my earlier feedback. It all looks good to me, very nice cleanup!