From: Souptick Joarder <jrdr.linux@gmail.com>
To: David Hildenbrand <david@redhat.com>
Cc: John Hubbard <jhubbard@nvidia.com>,
Andrew Morton <akpm@linux-foundation.org>,
LKML <linux-kernel@vger.kernel.org>,
Linux-MM <linux-mm@kvack.org>,
Dan Carpenter <dan.carpenter@oracle.com>, Jan Kara <jack@suse.cz>,
Vlastimil Babka <vbabka@suse.cz>
Subject: Re: [PATCH] mm/gup: documentation fix for pin_user_pages*() APIs
Date: Sun, 31 May 2020 12:21:05 +0530 [thread overview]
Message-ID: <CAFqt6za3N3gyDvEdoQb5d6_p-Ri_DGM=+eVv+wfQMadNn7g5tQ@mail.gmail.com> (raw)
In-Reply-To: <37811e3c-cf0c-eb52-0365-7980a9c0f334@redhat.com>
On Fri, May 29, 2020 at 2:41 PM David Hildenbrand <david@redhat.com> wrote:
>
> On 29.05.20 10:45, John Hubbard wrote:
> > All of the pin_user_pages*() API calls will cause pages to be
> > dma-pinned. As such, they are all suitable for either DMA, RDMA,
> > and/or Direct IO. The documentation should say so, but it was
> > instead saying that three of the API calls were only suitable for
> > Direct IO. This was discovered when a reviewer wondered why an
> > API call that specifically recommended against Case 2 (DMA/RDMA)
> > was being used in a DMA situation [1].
> >
> > Fix this by simply deleting those claims. The gup.c comments already
> > refer to the more extensive Documentation/core-api/pin_user_pages.rst,
> > which does have the correct guidance. So let's just write it once,
> > there.
> >
> > [1] https://lore.kernel.org/r/20200529074658.GM30374@kadam
> >
> > Cc: Dan Carpenter <dan.carpenter@oracle.com>
> > Cc: Jan Kara <jack@suse.cz>
> > Cc: Vlastimil Babka <vbabka@suse.cz>
> > Signed-off-by: John Hubbard <jhubbard@nvidia.com>
> > ---
> >
> > Hi,
> >
> > This applies on top of linux-next, in order to avoid a conflict with
> > Mauro Carvalho Chehab's fix to the lines right above these.
> >
> > thanks,
> > John Hubbard
> > NVIDIA
> >
> >
> > mm/gup.c | 9 ---------
> > 1 file changed, 9 deletions(-)
> >
> > diff --git a/mm/gup.c b/mm/gup.c
> > index ee039d421746d..311d0f11b35e6 100644
> > --- a/mm/gup.c
> > +++ b/mm/gup.c
> > @@ -2875,9 +2875,6 @@ EXPORT_SYMBOL_GPL(get_user_pages_fast);
> > *
> > * FOLL_PIN means that the pages must be released via unpin_user_page(). Please
> > * see Documentation/core-api/pin_user_pages.rst for further details.
> > - *
> > - * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst. It
> > - * is NOT intended for Case 2 (RDMA: long-term pins).
> > */
> > int pin_user_pages_fast(unsigned long start, int nr_pages,
> > unsigned int gup_flags, struct page **pages)
> > @@ -2951,9 +2948,6 @@ EXPORT_SYMBOL_GPL(pin_user_pages_fast_only);
> > *
> > * FOLL_PIN means that the pages must be released via unpin_user_page(). Please
> > * see Documentation/core-api/pin_user_pages.rst for details.
> > - *
> > - * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst. It
> > - * is NOT intended for Case 2 (RDMA: long-term pins).
> > */
> > long pin_user_pages_remote(struct task_struct *tsk, struct mm_struct *mm,
> > unsigned long start, unsigned long nr_pages,
> > @@ -2987,9 +2981,6 @@ EXPORT_SYMBOL(pin_user_pages_remote);
> > *
> > * FOLL_PIN means that the pages must be released via unpin_user_page(). Please
> > * see Documentation/core-api/pin_user_pages.rst for details.
> > - *
> > - * This is intended for Case 1 (DIO) in Documentation/core-api/pin_user_pages.rst. It
> > - * is NOT intended for Case 2 (RDMA: long-term pins).
> > */
> > long pin_user_pages(unsigned long start, unsigned long nr_pages,
> > unsigned int gup_flags, struct page **pages,
> >
>
> Reviewed-by: David Hildenbrand <david@redhat.com>
Acked-by : Souptick Joarder <jrdr.linux@gmail.com>
>
> --
> Thanks,
>
> David / dhildenb
>
next prev parent reply other threads:[~2020-05-31 6:43 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-29 8:45 [PATCH] mm/gup: documentation fix for pin_user_pages*() APIs John Hubbard
2020-05-29 9:11 ` David Hildenbrand
2020-05-31 6:51 ` Souptick Joarder [this message]
2020-05-31 13:00 ` Pankaj Gupta
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAFqt6za3N3gyDvEdoQb5d6_p-Ri_DGM=+eVv+wfQMadNn7g5tQ@mail.gmail.com' \
--to=jrdr.linux@gmail.com \
--cc=akpm@linux-foundation.org \
--cc=dan.carpenter@oracle.com \
--cc=david@redhat.com \
--cc=jack@suse.cz \
--cc=jhubbard@nvidia.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=vbabka@suse.cz \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).