vhost, docs: convert to pin_user_pages(), new "case 5"
Subsystems (8)
v2 cover vhost, docs: convert to pin_user_pages(), new "case 5"
This is based on Linux 5.7, plus one prerequisite patch:
"mm/gup: update pin_user_pages.rst for "case 3" (mmu notifiers)" [1]
Changes since v1: removed references to set_page_dirty*(), in response to Souptick Joarder's review (thanks!).
Cover letter for v1, edited/updated slightly:
It recently became clear to me that there are some get_user_pages*() callers that don't fit neatly into any of the four cases that are so far listed in pin_user_pages.rst. vhost.c is one of those.
Add a Case 5 to the documentation, and refer to that when converting vhost.c.
Thanks to Jan Kara for helping me (again) in understanding the interaction between get_user_pages() and page writeback [2].
Note that I have only compile-tested the vhost.c patch, although that does also include cross-compiling for a few other arches. Any run-time testing would be greatly appreciated.
[1] https://lore.kernel.org/r/[email protected]
[2] https://lore.kernel.org/r/[email protected]
John Hubbard (2):
docs: mm/gup: pin_user_pages.rst: add a "case 5"
vhost: convert get_user_pages() --> pin_user_pages()
Documentation/core-api/pin_user_pages.rst | 18 ++++++++++++++++++ drivers/vhost/vhost.c | 5 ++--- 2 files changed, 20 insertions(+), 3 deletions(-)
base-commit: 3d77e6a8804abcc0504c904bd6e5cdf3a5cf8162
Signature · 1 line
2.26.2
PATCH v2 1/2 docs: mm/gup: pin_user_pages.rst: add a "case 5"
There are four cases listed in pin_user_pages.rst. These are intended to help developers figure out whether to use get_user_pages*(), or pin_user_pages*(). However, the four cases do not cover all the situations. For example, drivers/vhost/vhost.c has a "pin, write to page, set page dirty, unpin" case.
Add a fifth case, to help explain that there is a general pattern that requires pin_user_pages*() API calls.
--- Documentation/core-api/pin_user_pages.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+)
Documentation/core-api/pin_user_pages.rst +18 -0
@@ -171,6 +171,24 @@ If only struct page data (as opposed to the actual memory contents that a page is tracking) is affected, then normal GUP calls are sufficient, and neither flag needs to be set. +CASE 5: Pinning in order to write to the data within the page +------------------------------------------------------------- +Even though neither DMA nor Direct IO is involved, just a simple case of "pin, +write to a page's data, unpin" can cause a problem. Case 5 may be considered a +superset of Case 1, plus Case 2, plus anything that invokes that pattern. In +other words, if the code is neither Case 1 nor Case 2, it may still require +FOLL_PIN, for patterns like this: + +Correct (uses FOLL_PIN calls): + pin_user_pages() + write to the data within the pages + unpin_user_pages() + +INCORRECT (uses FOLL_GET calls): + get_user_pages() + write to the data within the pages + put_page() + page_maybe_dma_pinned(): the whole point of pinning ===================================================
Signature · 1 line
2.26.2
Re: [PATCH v2 1/2] docs: mm/gup: pin_user_pages.rst: add a "case 5"
Quoted 9 lines · John Hubbard
There are four cases listed in
pin_user_pages.rst. These are intended to help developers figure out whether to use get_user_pages*(), or pin_user_pages*(). However, the four cases do not cover all the situations. For example,drivers/vhost/vhost.chas a "pin, write to page, set page dirty, unpin" case.Add a fifth case, to help explain that there is a general pattern that requires pin_user_pages*() API calls.
Quoted 8 lines
Cc Vlastimil Babka <[email protected]>Cc Jan Kara <[email protected]>Cc Jérôme Glisse <[email protected]>Cc Dave Chinner <[email protected]>Cc Jonathan Corbet <[email protected]>Signed-off-by John Hubbard <[email protected]>
Looks good to me. You can add:
Honza
Quoted 36 lines
--- Documentation/core-api/pin_user_pages.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+)Documentation/core-api/pin_user_pages.rst +18
-0@@ -171,6 +171,24 @@ If only struct page data (as opposed to the actual memory contents that a page is tracking) is affected, then normal GUP calls are sufficient, and neither flag needs to be set. +CASE 5: Pinning in order to write to the data within the page +------------------------------------------------------------- +Even though neither DMA nor Direct IO is involved, just a simple case of "pin, +write to a page's data, unpin" can cause a problem. Case 5 may be considered a +superset of Case 1, plus Case 2, plus anything that invokes that pattern. In +other words, if the code is neither Case 1 nor Case 2, it may still require +FOLL_PIN, for patterns like this: + +Correct (uses FOLL_PIN calls): + pin_user_pages() + write to the data within the pages + unpin_user_pages() + +INCORRECT (uses FOLL_GET calls): + get_user_pages() + write to the data within the pages + put_page() + page_maybe_dma_pinned(): the whole point of pinning ===================================================Signature · 1 line
2.26.2
Signature · 2 lines
Jan Kara <[email protected]> SUSE Labs, CR
PATCH v2 2/2 vhost: convert get_user_pages() --> pin_user_pages()
In reply to John HubbardThis code was using get_user_pages*(), in approximately a "Case 5" scenario (accessing the data within a page), using the categorization from [1]. That means that it's time to convert the get_user_pages*() + put_page() calls to pin_user_pages*() + unpin_user_pages() calls.
There is some helpful background in [2]: basically, this is a small part of fixing a long-standing disconnect between pinning pages, and file systems' use of those pages.
[1] Documentation/core-api/pin_user_pages.rst
[2] "Explicit pinning of user-space pages":
https://lwn.net/Articles/807108/
--- drivers/vhost/vhost.c | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)
drivers/vhost/vhost.c +2 -3
@@ -1762,15 +1762,14 @@ static int set_bit_to_user(int nr, void __user *addr)int bit = nr + (log %PAGE_SIZE ) *8 ;int r; - r =get_user_pages_fast (log,1 ,FOLL_WRITE , &page); + r =pin_user_pages_fast (log,1 ,FOLL_WRITE , &page);if (r <0 )return r;BUG_ON (r !=1 ); base =kmap_atomic (page);set_bit (bit, base);kunmap_atomic (base); -set_page_dirty_lock (page); -put_page (page); +unpin_user_pages_dirty_lock (&page,1 , true);return 0 ; }
Signature · 1 line
2.26.2
Re: [PATCH v2 2/2] vhost: convert get_user_pages() --> pin_user_pages()
Quoted 35 lines
This code was using get_user_pages*(), in approximately a "Case 5" scenario (accessing the data within a page), using the categorization from [1]. That means that it's time to convert the get_user_pages*() +
put_page()calls to pin_user_pages*() +unpin_user_pages()calls.There is some helpful background in [2]: basically, this is a small part of fixing a long-standing disconnect between pinning pages, and file systems' use of those pages.
[1]
Documentation/core-api/pin_user_pages.rst[2] "Explicit pinning of user-space pages":
https://lwn.net/Articles/807108/Cc Michael S. Tsirkin <[email protected]>Cc Jason Wang <[email protected]>Signed-off-by John Hubbard <[email protected]>--- drivers/vhost/vhost.c | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)drivers/vhost/vhost.c +1
-1@@ -1762,15 +1762,14 @@ static int set_bit_to_user(int nr, void __user *addr)int bit = nr + (log %PAGE_SIZE ) *8 ;int r; - r =get_user_pages_fast (log,1 ,FOLL_WRITE , &page); + r =pin_user_pages_fast (log,1 ,FOLL_WRITE , &page);if (r <0 )
drivers/vhost/vhost.c static int set_bit_to_user(int nr, void __user *addr) · line 1774
Quoted 10 lines
drivers/vhost/vhost.c +1
-2return r;BUG_ON (r !=1 ); base =kmap_atomic (page);set_bit (bit, base);kunmap_atomic (base); -set_page_dirty_lock (page); -put_page (page); +unpin_user_pages_dirty_lock (&page,1 , true);return 0 ; }