Few bug fixes and Convert to pin_user_pages*()
v2 cover Few bug fixes and Convert to pin_user_pages*()
This series contains few clean up, minor bug fixes and Convert get_user_pages() to pin_user_pages().
I'm compile tested this, but unable to run-time test, so any testing help is much appriciated.
v2:
Addressed few review comments and compile issue. Patch[1/2] from v1 split into 2 in v2.
Souptick Joarder (3):
xen/privcmd: Corrected error handling path xen/privcmd: Mark pages as dirty
xen/privcmd: Convert get_user_pages*() to pin_user_pages*()
drivers/xen/privcmd.c | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-)
Signature · 1 line
1.9.1
PATCH v2 1/3 xen/privcmd: Corrected error handling path
Previously, if lock_pages() end up partially mapping pages, it used to return -ERRNO due to which unlock_pages() have to go through each pages[i] till *nr_pages* to validate them. This can be avoided by passing correct number of partially mapped pages & -ERRNO separately, while returning from lock_pages() due to error.
With this fix unlock_pages() doesn't need to validate pages[i] till *nr_pages* for error scenario and few condition checks can be ignored.
--- drivers/xen/privcmd.c | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-)
drivers/xen/privcmd.c +15 -16
@@ -580,13 +580,13 @@ static long privcmd_ioctl_mmap_batch(static int lock_pages (struct privcmd_dm_op_buf kbufs[],unsigned int num, -struct page *pages[],unsigned int nr_pages) +struct page *pages[],unsigned int nr_pages,unsigned int *pinned) {unsigned int i; +int page_count =0 ;for (i =0 ; i < num; i++) {unsigned int requested; -int pinned; requested = DIV_ROUND_UP( offset_in_page(kbufs[i].uptr) + kbufs[i].size,
@@ -594,14 +594,15 @@ static int lock_pages(if (requested > nr_pages)return -ENOSPC ; - pinned =get_user_pages_fast ( + page_count =get_user_pages_fast ( (unsigned long ) kbufs[i].uptr, requested,FOLL_WRITE , pages); -if (pinned <0 ) -return pinned; +if (page_count <0 ) +return page_count; - nr_pages -= pinned; - pages += pinned; + *pinned += page_count; + nr_pages -= page_count; + pages += page_count; }return 0 ;
@@ -611,13 +612,8 @@ static void unlock_pages(struct page *pages[], unsigned int nr_pages) {unsigned int i; -if (!pages) -return ; - -for (i =0 ; i < nr_pages; i++) { -if (pages[i]) -put_page (pages[i]); - } +for (i =0 ; i < nr_pages; i++) +put_page (pages[i]); }static long privcmd_ioctl_dm_op (struct file *file,void __user *udata)
@@ -630,6 +626,7 @@ static long privcmd_ioctl_dm_op(struct file *file, void __user *udata)struct xen_dm_op_buf *xbufs =NULL ;unsigned int i;long rc; +unsigned int pinned =0 ;if (copy_from_user (&kdata, udata,sizeof (kdata)))return -EFAULT ;
@@ -683,9 +680,11 @@ static long privcmd_ioctl_dm_op(struct file *file, void __user *udata) goto out; } - rc =lock_pages (kbufs, kdata.num, pages, nr_pages); -if (rc) + rc =lock_pages (kbufs, kdata.num, pages, nr_pages, &pinned); +if (rc <0 ) { + nr_pages = pinned; goto out; + }for (i =0 ; i < kdata.num; i++) {set_xen_guest_handle (xbufs[i].h, kbufs[i].uptr);
Signature · 1 line
1.9.1
Re: [PATCH v2 1/3] xen/privcmd: Corrected error handling path
Quoted 22 lines · Souptick Joarder
Previously, if
lock_pages()end up partially mapping pages, it used to return-ERRNOdue to whichunlock_pages()have to go through each pages[i] till *nr_pages* to validate them. This can be avoided by passing correct number of partially mapped pages &-ERRNOseparately, while returning fromlock_pages()due to error.With this fix
unlock_pages()doesn't need to validate pages[i] till *nr_pages* for error scenario and few condition checks can be ignored.Signed-off-by Souptick Joarder <[email protected]>Cc John Hubbard <[email protected]>Cc Boris Ostrovsky <[email protected]>Cc Paul Durrant <[email protected]>--- drivers/xen/privcmd.c | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-)drivers/xen/privcmd.c +0
-0
drivers/xen/privcmd.c static long privcmd_ioctl_mmap_batch( · line 586
Quoted 8 lines
drivers/xen/privcmd.c +2
-1@@ -580,13 +580,13 @@ static long privcmd_ioctl_mmap_batch(static int lock_pages (struct privcmd_dm_op_buf kbufs[],unsigned int num, -struct page *pages[],unsigned int nr_pages) +struct page *pages[],unsigned int nr_pages,unsigned int *pinned) {unsigned int i; +int page_count =0 ;
Initial value shouldn't be needed, and ...
drivers/xen/privcmd.c static long privcmd_ioctl_mmap_batch( · line 589
Quoted 4 lines
drivers/xen/privcmd.c +0
-1for (i =0 ; i < num; i++) {unsigned int requested; -int pinned;
... you could move the declaration here.
With that done you can add my
Juergen
Re: [PATCH v2 1/3] xen/privcmd: Corrected error handling path
Quoted 40 lines · Jürgen Groß
Quoted 22 lines · Souptick Joarder
Previously, if
lock_pages()end up partially mapping pages, it used to return-ERRNOdue to whichunlock_pages()have to go through each pages[i] till *nr_pages* to validate them. This can be avoided by passing correct number of partially mapped pages &-ERRNOseparately, while returning fromlock_pages()due to error.With this fix
unlock_pages()doesn't need to validate pages[i] till *nr_pages* for error scenario and few condition checks can be ignored.Signed-off-by Souptick Joarder <[email protected]>Cc John Hubbard <[email protected]>Cc Boris Ostrovsky <[email protected]>Cc Paul Durrant <[email protected]>--- drivers/xen/privcmd.c | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-)drivers/xen/privcmd.c +0
-0drivers/xen/privcmd.c static long privcmd_ioctl_mmap_batch( · line 586
Quoted 8 lines
drivers/xen/privcmd.c +2
-1@@ -580,13 +580,13 @@ static long privcmd_ioctl_mmap_batch(static int lock_pages (struct privcmd_dm_op_buf kbufs[],unsigned int num, -struct page *pages[],unsigned int nr_pages) +struct page *pages[],unsigned int nr_pages,unsigned int *pinned) {unsigned int i; +int page_count =0 ;Initial value shouldn't be needed, and ...
drivers/xen/privcmd.c static long privcmd_ioctl_mmap_batch( · line 589
Quoted 4 lines
drivers/xen/privcmd.c +0
-1for (i =0 ; i < num; i++) {unsigned int requested; -int pinned;
Quoted 5 lines
... you could move the declaration here.
With that done you can add my
Reviewed-by Juergen Gross <[email protected]>
Ok. But does it going make any difference other than limiting scope ?
Quoted 3 lines
Juergen
Jürgen Groß
maintainerRe: [PATCH v2 1/3] xen/privcmd: Corrected error handling path
Quoted 41 lines · Souptick Joarder
Quoted 40 lines · Jürgen Groß
Quoted 22 lines · Souptick Joarder
Previously, if
lock_pages()end up partially mapping pages, it used to return-ERRNOdue to whichunlock_pages()have to go through each pages[i] till *nr_pages* to validate them. This can be avoided by passing correct number of partially mapped pages &-ERRNOseparately, while returning fromlock_pages()due to error.With this fix
unlock_pages()doesn't need to validate pages[i] till *nr_pages* for error scenario and few condition checks can be ignored.Signed-off-by Souptick Joarder <[email protected]>Cc John Hubbard <[email protected]>Cc Boris Ostrovsky <[email protected]>Cc Paul Durrant <[email protected]>--- drivers/xen/privcmd.c | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-)drivers/xen/privcmd.c +0
-0drivers/xen/privcmd.c static long privcmd_ioctl_mmap_batch( · line 586
Quoted 8 lines
drivers/xen/privcmd.c +2
-1@@ -580,13 +580,13 @@ static long privcmd_ioctl_mmap_batch(static int lock_pages (struct privcmd_dm_op_buf kbufs[],unsigned int num, -struct page *pages[],unsigned int nr_pages) +struct page *pages[],unsigned int nr_pages,unsigned int *pinned) {unsigned int i; +int page_count =0 ;Initial value shouldn't be needed, and ...
Quoted 4 lines
drivers/xen/privcmd.c +0
-1for (i =0 ; i < num; i++) {unsigned int requested; -int pinned;
Quoted 7 lines
Quoted 5 lines
... you could move the declaration here.
With that done you can add my
Reviewed-by Juergen Gross <[email protected]>Ok. But does it going make any difference other than limiting scope ?
Dropping the initializer surely does, and in the end page_count just replaces the former pinned variable, so why would we want to widen the scope with this patch?
Juergen
Re: [PATCH v2 1/3] xen/privcmd: Corrected error handling path
Quoted 47 lines · Jürgen Groß
Quoted 45 lines · Souptick Joarder
Quoted 44 lines · Jürgen Groß
Quoted 22 lines · Souptick Joarder
Previously, if
lock_pages()end up partially mapping pages, it used to return-ERRNOdue to whichunlock_pages()have to go through each pages[i] till *nr_pages* to validate them. This can be avoided by passing correct number of partially mapped pages &-ERRNOseparately, while returning fromlock_pages()due to error.With this fix
unlock_pages()doesn't need to validate pages[i] till *nr_pages* for error scenario and few condition checks can be ignored.Signed-off-by Souptick Joarder <[email protected]>Cc John Hubbard <[email protected]>Cc Boris Ostrovsky <[email protected]>Cc Paul Durrant <[email protected]>--- drivers/xen/privcmd.c | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-)drivers/xen/privcmd.c +0
-0drivers/xen/privcmd.c static long privcmd_ioctl_mmap_batch( · line 586
Quoted 8 lines
drivers/xen/privcmd.c +2
-1@@ -580,13 +580,13 @@ static long privcmd_ioctl_mmap_batch(static int lock_pages (struct privcmd_dm_op_buf kbufs[],unsigned int num, -struct page *pages[],unsigned int nr_pages) +struct page *pages[],unsigned int nr_pages,unsigned int *pinned) {unsigned int i; +int page_count =0 ;Initial value shouldn't be needed, and ...
drivers/xen/privcmd.c static long privcmd_ioctl_mmap_batch( · line 589
Quoted 4 lines
drivers/xen/privcmd.c +0
-1for (i =0 ; i < num; i++) {unsigned int requested; -int pinned;... you could move the declaration here.
With that done you can add my
Quoted 7 lines
Quoted 3 lines
Quoted 1 line
Reviewed-by Juergen Gross <[email protected]>Ok. But does it going make any difference other than limiting scope ?
Dropping the initializer surely does, and in the end
page_countjust replaces the former pinned variable, so why would we want to widen the scope with this patch?
Agree, no reason to move it up. Will change it in v3.
Quoted 3 lines
Juergen
PATCH v2 2/3 xen/privcmd: Mark pages as dirty
In reply to Souptick Joarderpages need to be marked as dirty before unpinned it in unlock_pages() which was oversight. This is fixed now.
--- drivers/xen/privcmd.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/xen/privcmd.c +4 -1
@@ -612,8 +612,11 @@ static void unlock_pages(struct page *pages[], unsigned int nr_pages) {unsigned int i; -for (i =0 ; i < nr_pages; i++) +for (i =0 ; i < nr_pages; i++) { +if (!PageDirty (pages[i])) +set_page_dirty_lock (pages[i]);put_page (pages[i]); + } }static long privcmd_ioctl_dm_op (struct file *file,void __user *udata)
Signature · 1 line
1.9.1
Jürgen Groß
maintainerRe: [PATCH v2 2/3] xen/privcmd: Mark pages as dirty
Quoted 17 lines · Souptick Joarder
pages need to be marked as dirty before unpinned it in
unlock_pages()which was oversight. This is fixed now.Signed-off-by Souptick Joarder <[email protected]>Suggested-by John Hubbard <[email protected]>Cc John Hubbard <[email protected]>Cc Boris Ostrovsky <[email protected]>Cc Paul Durrant <[email protected]>--- drivers/xen/privcmd.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)drivers/xen/privcmd.c +0
-0
drivers/xen/privcmd.c static void unlock_pages(struct page *pages[], unsigned int nr_pages) · line 617
Quoted 7 lines
drivers/xen/privcmd.c +3
-1@@ -612,8 +612,11 @@ static void unlock_pages(struct page *pages[], unsigned int nr_pages) {unsigned int i; -for (i =0 ; i < nr_pages; i++) +for (i =0 ; i < nr_pages; i++) { +if (!PageDirty (pages[i])) +set_page_dirty_lock (pages[i]);
With put_page() directly following I think you should be able to use set_page_dirty() instead, as there is obviously a reference to the page existing.
drivers/xen/privcmd.c static void unlock_pages(struct page *pages[], unsigned int nr_pages) · line 622
Quoted 6 lines
drivers/xen/privcmd.c +1
-0put_page (pages[i]); + } }static long privcmd_ioctl_dm_op (struct file *file,void __user *udata)
Juergen
Re: [PATCH v2 2/3] xen/privcmd: Mark pages as dirty
Quoted 22 lines · Jürgen Groß
Quoted 20 lines · Souptick Joarder
pages need to be marked as dirty before unpinned it in
unlock_pages()which was oversight. This is fixed now.Signed-off-by Souptick Joarder <[email protected]>Suggested-by John Hubbard <[email protected]>Cc John Hubbard <[email protected]>Cc Boris Ostrovsky <[email protected]>Cc Paul Durrant <[email protected]>--- drivers/xen/privcmd.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)drivers/xen/privcmd.c +0
-0@@ -612,8 +612,11 @@ static void unlock_pages(struct page *pages[], unsigned int nr_pages) {unsigned int i;
Quoted 8 lines
drivers/xen/privcmd.c static void unlock_pages(struct page *pages[], unsigned int nr_pages) · line 617
Quoted 4 lines
drivers/xen/privcmd.c +3
-1-for (i =0 ; i < nr_pages; i++) +for (i =0 ; i < nr_pages; i++) { +if (!PageDirty (pages[i])) +set_page_dirty_lock (pages[i]);With
put_page()directly following I think you should be able to useset_page_dirty()instead, as there is obviously a reference to the page existing.
Patch [3/3] will convert above codes to use unpin_user_pages_dirty_lock() which internally do the same check. So I thought to keep linux-stable and linux-next code in sync. John had a similar concern [1] and later agreed to keep this check.
Shall I keep this check ? No ?
[1] https://lore.kernel.org/xen-devel/[email protected]/
Quoted 9 lines
drivers/xen/privcmd.c static void unlock_pages(struct page *pages[], unsigned int nr_pages) · line 622
Quoted 7 lines
drivers/xen/privcmd.c +1
-0put_page (pages[i]); + } }static long privcmd_ioctl_dm_op (struct file *file,void __user *udata)Juergen
Jürgen Groß
maintainerRe: [PATCH v2 2/3] xen/privcmd: Mark pages as dirty
Quoted 32 lines · Souptick Joarder
Quoted 22 lines · Jürgen Groß
Quoted 20 lines · Souptick Joarder
pages need to be marked as dirty before unpinned it in
unlock_pages()which was oversight. This is fixed now.Signed-off-by Souptick Joarder <[email protected]>Suggested-by John Hubbard <[email protected]>Cc John Hubbard <[email protected]>Cc Boris Ostrovsky <[email protected]>Cc Paul Durrant <[email protected]>--- drivers/xen/privcmd.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)drivers/xen/privcmd.c +0
-0@@ -612,8 +612,11 @@ static void unlock_pages(struct page *pages[], unsigned int nr_pages) {unsigned int i;Quoted 8 lines
drivers/xen/privcmd.c static void unlock_pages(struct page *pages[], unsigned int nr_pages) · line 617
Quoted 4 lines
drivers/xen/privcmd.c +3
-1-for (i =0 ; i < nr_pages; i++) +for (i =0 ; i < nr_pages; i++) { +if (!PageDirty (pages[i])) +set_page_dirty_lock (pages[i]);With
put_page()directly following I think you should be able to useset_page_dirty()instead, as there is obviously a reference to the page existing.
Quoted 8 lines
Patch [3/3] will convert above codes to use
unpin_user_pages_dirty_lock()which internally do the same check. So I thought to keep linux-stable and linux-next code in sync. John had a similar concern [1] and later agreed to keep this check.Shall I keep this check ? No ?
I wasn't referring to checking PageDirty(), but to the use of set_page_dirty_lock().
Looking at the comment just before the implementation of set_page_dirty_lock() suggests that it is fine to use set_page_dirty() instead (so not calling lock_page()).
Only the transition from get_user_pages_fast() to pin_user_pages_fast() requires to use the locked version IMO.
Juergen
Re: [PATCH v2 2/3] xen/privcmd: Mark pages as dirty
Quoted 2 lines · Jürgen Groß
Quoted 1 line · Souptick Joarder
On Tue, Jul 7, 2020 at 3:08 PM Jürgen Groß <[email protected]> wrote:
...
Quoted 17 lines
Quoted 17 lines
Quoted 16 lines
drivers/xen/privcmd.c static void unlock_pages(struct page *pages[], unsigned int nr_pages) · line 617
Quoted 12 lines
drivers/xen/privcmd.c +3
-1@@ -612,8 +612,11 @@ static void unlock_pages(struct page *pages[], unsigned int nr_pages) { unsigned int i; - for (i = 0; i < nr_pages; i++) + for (i = 0; i < nr_pages; i++) { + if (!PageDirty(pages[i])) + set_page_dirty_lock(pages[i]);With
put_page()directly following I think you should be able to useset_page_dirty()instead, as there is obviously a reference to the page existing.
Quoted 6 lines
Quoted 6 lines
Patch [3/3] will convert above codes to use
unpin_user_pages_dirty_lock()which internally do the same check. So I thought to keep linux-stable and linux-next code in sync. John had a similar concern [1] and later agreed to keep this check.Shall I keep this check ? No ?
It doesn't matter *too* much, because patch 3/3 fixes up everything by changing it all to unpin_user_pages_dirty_lock(). However, there is something to be said for having correct interim patches, too. :) Details:
Quoted 9 lines
Quoted 2 lines
I wasn't referring to checking
PageDirty(), but to the use ofset_page_dirty_lock().Looking at the comment just before the implementation of
set_page_dirty_lock()suggests that it is fine to useset_page_dirty()instead (so not callinglock_page()).
no no, that's a misreading of the comment. Unless this xen/privcmd code has somehow taken a reference on page->mapping->host (which I do *not* think is the case), then it is still racy to call set_page_dirty() here. Instead, set_page_dirty_lock() should be used.
Quoted 4 lines
Only the transition from
get_user_pages_fast()topin_user_pages_fast()requires to use the locked version IMO.
That's a different misunderstanding. :) pin_user_pages*() APIs are meant to be functionally drop-in replacements for get_user_pages*(). Internally, pin_user_pages*() functions do some additional tracking, but from a caller's perspective, it should look the same. In other words, there is nothing about pin_user_pages_fast() that requires set_page_dirty_lock() upon release. The reason set_page_dirty_lock() was chosen is that there are very few (none at all?) call sites that need to release and dirty a page, that also meet the requirements to safely call set_page_dirty().
That's why there is a unpin_user_pages_dirty_lock(), but there is not a corresponding unpin_user_pages_dirty() call: the latter has not been required so far, even though the call site conversions are nearly done.
thanks,
Signature · 2 lines
John Hubbard NVIDIA
Re: [PATCH v2 2/3] xen/privcmd: Mark pages as dirty
Quoted 45 lines · John Hubbard
Quoted 2 lines · Jürgen Groß
Quoted 1 line · Souptick Joarder
On Tue, Jul 7, 2020 at 3:08 PM Jürgen Groß <[email protected]> wrote:
...
Quoted 18 lines
Quoted 18 lines
Quoted 17 lines
drivers/xen/privcmd.c static void unlock_pages(struct page *pages[], · line 618
Quoted 13 lines
drivers/xen/privcmd.c +3
-1@@ -612,8 +612,11 @@ static void unlock_pages(struct page *pages[], unsigned int nr_pages) { unsigned int i; - for (i = 0; i < nr_pages; i++) + for (i = 0; i < nr_pages; i++) { + if (!PageDirty(pages[i])) + set_page_dirty_lock(pages[i]);With
put_page()directly following I think you should be able to useset_page_dirty()instead, as there is obviously a reference to the page existing.Quoted 6 lines
Quoted 6 lines
Patch [3/3] will convert above codes to use
unpin_user_pages_dirty_lock()which internally do the same check. So I thought to keep linux-stable and linux-next code in sync. John had a similar concern [1] and later agreed to keep this check.Shall I keep this check ? No ?
It doesn't matter *too* much, because patch 3/3 fixes up everything by changing it all to
unpin_user_pages_dirty_lock(). However, there is something to be said for having correct interim patches, too. :) Details:Quoted 10 lines
Quoted 3 lines
I wasn't referring to checking
PageDirty(), but to the use ofset_page_dirty_lock().Looking at the comment just before the implementation of
set_page_dirty_lock()suggests that it is fine to useset_page_dirty()instead (so not callinglock_page()).
Quoted 4 lines
no no, that's a misreading of the comment. Unless this xen/privcmd code has somehow taken a reference on
page->mapping->host(which I do *not* think is the case), then it is still racy to callset_page_dirty()here. Instead,set_page_dirty_lock()should be used.
Ah, okay. Thanks for the clarification.
So you can add my
Juergen
PATCH v2 3/3 xen/privcmd: Convert get_user_pages*() to pin_user_pages*()
In reply to Souptick JoarderIn 2019, we introduced pin_user_pages*() and now we are converting get_user_pages*() to the new API as appropriate. [1] & [2] could be referred for more information. This is case 5 as per document [1].
[1] Documentation/core-api/pin_user_pages.rst
[2] "Explicit pinning of user-space pages":
https://lwn.net/Articles/807108/
--- drivers/xen/privcmd.c | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-)
drivers/xen/privcmd.c +2 -8
@@ -594,7 +594,7 @@ static int lock_pages(if (requested > nr_pages)return -ENOSPC ; - page_count =get_user_pages_fast ( + page_count =pin_user_pages_fast ( (unsigned long ) kbufs[i].uptr, requested,FOLL_WRITE , pages);if (page_count <0 )
@@ -610,13 +610,7 @@ static int lock_pages(static void unlock_pages (struct page *pages[],unsigned int nr_pages) { -unsigned int i; - -for (i =0 ; i < nr_pages; i++) { -if (!PageDirty (pages[i])) -set_page_dirty_lock (pages[i]); -put_page (pages[i]); - } +unpin_user_pages_dirty_lock (pages, nr_pages, true); }static long privcmd_ioctl_dm_op (struct file *file,void __user *udata)
Signature · 1 line
1.9.1
Re: [PATCH v2 3/3] xen/privcmd: Convert get_user_pages*() to pin_user_pages*()
Quoted 6 lines · Souptick Joarder
In 2019, we introduced pin_user_pages*() and now we are converting get_user_pages*() to the new API as appropriate. [1] & [2] could be referred for more information. This is case 5 as per document [1].
[1]
Documentation/core-api/pin_user_pages.rst
Quoted 7 lines
[2] "Explicit pinning of user-space pages":
https://lwn.net/Articles/807108/Signed-off-by Souptick Joarder <[email protected]>Cc John Hubbard <[email protected]>Cc Boris Ostrovsky <[email protected]>Cc Paul Durrant <[email protected]>
Juergen