From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.6 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4DA4AC433E0 for ; Sun, 31 May 2020 07:03:14 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 112FE207D5 for ; Sun, 31 May 2020 07:03:13 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="HxqCyM1E" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 112FE207D5 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id 966D880007; Sun, 31 May 2020 03:03:13 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 917A08E0003; Sun, 31 May 2020 03:03:13 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 8062180007; Sun, 31 May 2020 03:03:13 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0206.hostedemail.com [216.40.44.206]) by kanga.kvack.org (Postfix) with ESMTP id 6990C8E0003 for ; Sun, 31 May 2020 03:03:13 -0400 (EDT) Received: from smtpin12.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay01.hostedemail.com (Postfix) with ESMTP id 21D8C180AD820 for ; Sun, 31 May 2020 07:03:13 +0000 (UTC) X-FDA: 76876122666.12.geese33_563ed868b2754 Received: from filter.hostedemail.com (10.5.16.251.rfc1918.com [10.5.16.251]) by smtpin12.hostedemail.com (Postfix) with ESMTP id 06E571800BE86 for ; Sun, 31 May 2020 07:03:13 +0000 (UTC) X-HE-Tag: geese33_563ed868b2754 X-Filterd-Recvd-Size: 5778 Received: from mail-lj1-f195.google.com (mail-lj1-f195.google.com [209.85.208.195]) by imf21.hostedemail.com (Postfix) with ESMTP for ; Sun, 31 May 2020 07:03:12 +0000 (UTC) Received: by mail-lj1-f195.google.com with SMTP id z6so4179734ljm.13 for ; Sun, 31 May 2020 00:03:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc:content-transfer-encoding; bh=orX/y8KZmJNFBM29Gj7r/7pgbaU1Wmo90frTAFgI1II=; b=HxqCyM1EcKPbKMqPglb23SznK7zXBoHpxAe9uB5JZW4tnTxun6GQOGDw+5tBcOaECm suvkefwQ8xbLMfVC0td4JIZo/MMBvKSj6BexhDRnxlbkIPb/scSpoVVPe143s/vDo4EC sP/LA3rn6FUKhnOs2cy+7Ln4pSfdQzUvT/GVMCO+HuBezDF+raa3MHX6WRGeIUKvbY0b /rQt0v1xJO4cQB3MVfq6unPXq/6Y7qyuavQKhIX2u0UJKEr+1qoFR2p6oCwqk1XAj1SF fukGMWUxvbvVYgv1Oau5RfuKCOLwZnXQ2O3IS8CFpnidpslrSl5qRmZuHTYhOE49Ep23 O3+A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc:content-transfer-encoding; bh=orX/y8KZmJNFBM29Gj7r/7pgbaU1Wmo90frTAFgI1II=; b=mOErWgv02WpmU/k7Ryclom9i3RZXc6tsgoDOdyarnNSJvkdX4rnxpmdeTdWDm79DdG Zn/kvBiIrssXhfW1FuNIsKgvbHSh8jjTSkWIo30sTyuQJ+pl35xBeznkzjjpPQZn/kme FF3Zjbxkzwim+Ia4oECendFq/g78IlCOt3lVli5l2n5QavCUEB+HmeU2Aect0lelL/PG 6pYk9PldCWZG6AwacbU00PH+wrpljqljFr3392KfnQ3May+fUXk1p3zX0uEekA8PuiEL aFaQFb/99qQdXLWBqL0YutWrzW8Y4+jvfiy8+UlG/e9NNW42J3pBlO+xQU0J7CjDO9Lp kqHw== X-Gm-Message-State: AOAM531AtdMUgAJ0SYvb13l8cS31EoUxh/RDjSX0UM/IQZB9E5D/nSLg 4hyAnuyGyZAQ7s1TpSH4/kK3+MB3J9jMnx/sxPcngHjpttM= X-Google-Smtp-Source: ABdhPJywHXsqBndX3laZcwix8rl6zEFIaUWSsfG6YMGcM9LSe//w5BtrRO/NuMPavCMahVKPqbWUuUk4ilCBWssYdFI= X-Received: by 2002:a2e:b5d7:: with SMTP id g23mr1384527ljn.70.1590908591076; Sun, 31 May 2020 00:03:11 -0700 (PDT) MIME-Version: 1.0 References: <20200529234309.484480-1-jhubbard@nvidia.com> <20200529234309.484480-2-jhubbard@nvidia.com> In-Reply-To: <20200529234309.484480-2-jhubbard@nvidia.com> From: Souptick Joarder Date: Sun, 31 May 2020 12:41:19 +0530 Message-ID: Subject: Re: [PATCH 1/2] docs: mm/gup: pin_user_pages.rst: add a "case 5" To: John Hubbard Cc: Andrew Morton , "Michael S . Tsirkin" , Jason Wang , Vlastimil Babka , =?UTF-8?B?SsOpcsO0bWUgR2xpc3Nl?= , Jan Kara , Dave Chinner , Jonathan Corbet , linux-doc@vger.kernel.org, linux-fsdevel , kvm@vger.kernel.org, virtualization@lists.linux-foundation.org, netdev@vger.kernel.org, LKML , Linux-MM Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Rspamd-Queue-Id: 06E571800BE86 X-Spamd-Result: default: False [0.00 / 100.00] X-Rspamd-Server: rspam05 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: On Sat, May 30, 2020 at 5:13 AM John Hubbard wrote: > > 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. > > Cc: Vlastimil Babka > Cc: Jan Kara > Cc: J=C3=A9r=C3=B4me Glisse > Cc: Dave Chinner > Cc: Jonathan Corbet > Cc: linux-doc@vger.kernel.org > Cc: linux-fsdevel@vger.kernel.org > Signed-off-by: John Hubbard > --- > Documentation/core-api/pin_user_pages.rst | 20 ++++++++++++++++++++ > 1 file changed, 20 insertions(+) > > diff --git a/Documentation/core-api/pin_user_pages.rst b/Documentation/co= re-api/pin_user_pages.rst > index 4675b04e8829..b9f2688a2c67 100644 > --- a/Documentation/core-api/pin_user_pages.rst > +++ b/Documentation/core-api/pin_user_pages.rst > @@ -171,6 +171,26 @@ If only struct page data (as opposed to the actual m= emory contents that a page > is tracking) is affected, then normal GUP calls are sufficient, and neit= her 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, > +access page's data, unpin" can cause a problem. Will it be, *"pin, access page's data, set page dirty, unpin" * ? 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 requ= ire > +FOLL_PIN, for patterns like this: > + > +Correct (uses FOLL_PIN calls): > + pin_user_pages() > + access the data within the pages > + set_page_dirty_lock() > + unpin_user_pages() > + > +INCORRECT (uses FOLL_GET calls): > + get_user_pages() > + access the data within the pages > + set_page_dirty_lock() > + put_page() > + > page_maybe_dma_pinned(): the whole point of pinning > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D > > -- > 2.26.2 >