Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   William Kucharski <william.kucharski@oracle.com>
To:     John Hubbard <jhubbard@nvidia.com>
CC:     Andrew Morton <akpm@linux-foundation.org>,
        Heiko Carstens <hca@linux.ibm.com>,
        Vasily Gorbik <gor@linux.ibm.com>,
        Christian Borntraeger <borntraeger@de.ibm.com>,
        LKML <linux-kernel@vger.kernel.org>,
        "linux-mm@kvack.org" <linux-mm@kvack.org>,
        "linux-s390@vger.kernel.org" <linux-s390@vger.kernel.org>,
        "linux-fsdevel@vger.kernel.org" <linux-fsdevel@vger.kernel.org>,
        Christoph Hellwig <hch@lst.de>,
        Matthew Wilcox <willy@infradead.org>
Subject: Re: [PATCH v2 3/3] mm/gup: Remove try_get_page(), call
 try_get_compound_head() directly
Thread-Topic: [PATCH v2 3/3] mm/gup: Remove try_get_page(), call
 try_get_compound_head() directly
Thread-Index: AQHXjvBecLHj6CuNF0ypEXBwDT9dtg==
Date:   Wed, 11 Aug 2021 20:35:05 +0000
Message-ID: <20FB1F52-61FB-47DB-8777-E7C880FD875E@oracle.com>
References: <20210811070542.3403116-1-jhubbard@nvidia.com>
 <20210811070542.3403116-4-jhubbard@nvidia.com>
In-Reply-To: <20210811070542.3403116-4-jhubbard@nvidia.com>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-antispam-messagedata-chunkcount: 1
x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?wE35fMa2fgF5dj+lWRxlrafURl44SN6ngEkztihNibM96IMH30RokYDm5I9W?=
 =?us-ascii?Q?DHbV45Z9fbZ1Guh9Q1dNjzyWZSHtjjQadyRE2Ovz4TklLgEcWrXMWDNNaD4o?=
 =?us-ascii?Q?erTk1A67FnSv+cFtD9+iL+O3zxoFb0mbOxxcLb7H43LJeUKsGyWY+/3vLZiz?=
 =?us-ascii?Q?5Dfm92Olt3G/+y5Hn0XEygsKzy1iCTvrM7rbP/w5TVjHMbgQxSIjLB/km/ra?=
 =?us-ascii?Q?p1ZiBx2g0ocxIyv6qgSBjKypvn0hxgHbMMnKxeEd+5jQKO6n7592vho+6/rQ?=
 =?us-ascii?Q?krJ+xMqMjrKWjTVM72GNDiQYHuXZRr4emWIWIN39rCMy5rUNXXl4Qd9sKzyh?=
 =?us-ascii?Q?C91E+gljevOctJ0xnqsX54TR+1P9hbKvGMg0g91VupewiOA3t2L6ZQRYbBsF?=
 =?us-ascii?Q?B2XOnyDlOhPNZKXtptkDf06g6VlLkgaKLV/D2d11aNSmp6cL6Dpeion2nFQv?=
 =?us-ascii?Q?4G74PXYkRflS1VTMj5+Dc/O3ZSy9zaRFWMgj++KRo3Jcft/12bOMSsx4chjp?=
 =?us-ascii?Q?ZDu9ZESqypddtQWLMh2xClzxC6k1HrsX5zHZbPl5bYtXGY9jEIeHSoUGOQaO?=
 =?us-ascii?Q?IvjEMfF23s5SUs41GiacYBZ7X+7FzqizwIeIoTA7czw5qJdRxCN3ihA35l+0?=
 =?us-ascii?Q?9Mibwveb9XnFZEcFNRe2cI4kRuc1Ewkm4ScfWZBkAtiCzwi/J5IWHXo3XcKX?=
 =?us-ascii?Q?Ke+tid57GynyHo109HhkARuab2W4zuoH5/M9JymgO5SceGavqv3KIs715AHJ?=
 =?us-ascii?Q?wJhu760J/tbDOglZ0mvOvQQwwFnJyTbBTCFyTOP96u3FOWB/Ya5b5EyQ/Fu3?=
 =?us-ascii?Q?QaJOi5Yr8szAkRTgv8AWFaDiMVOb+shD+4x2cUiO+u46BfCD1bHM+EJlP9Qx?=
 =?us-ascii?Q?9kwwf2UJ2THFiFLuir/x2pJ/dBUrZMOx9IaCyAZj4F194kJSpPeAyMCOaFrR?=
 =?us-ascii?Q?AoBaQsWL5XI8lJYZWUOt2oNCkg54/ke7T9NjpTWIRcDb3hmPQgsb2/2vbVWP?=
 =?us-ascii?Q?BwGcwSsnG1UlbuIOfwsaY+hsP7s4IUjVkka6Kt1/r9AA4GzFt7S05zHd+Z3u?=
 =?us-ascii?Q?HT0/DvniSfRLwjNk0EsgNLvT09oVTQJk01lSNDLnc5yEXq5y7abmFzwSuzBV?=
 =?us-ascii?Q?h+h+D5Iz1ns+M+W8iNhc25Yyu8QWXlpT72IS06HUIrmGGUfnJT5SkQNE99ra?=
 =?us-ascii?Q?ubmPQdnDoNS+Hq3+K+R4ecrkUU+gKolR65wpSDZYsfODPka3ydbt+9Yyjaqn?=
 =?us-ascii?Q?lJ0PO+aTD6caBGkhwZ4Njo7tSyA9IH+bWifz3qXsJ6NUalXXe/NT0W3bmseF?=
 =?us-ascii?Q?MA7ZoIqlas6bGB0mVGck9t4nDR8b8R3wUasWwOuUub1Q0ydzzvLL0cIgDD0B?=
 =?us-ascii?Q?emjOURErCF54REYahTmCxikC3+q+?=
x-ms-exchange-transport-forked: True
Content-Type: text/plain; charset="us-ascii"
Content-ID: <46A3989F798F22439104A567DE57BF0A@namprd10.prod.outlook.com>
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: CY4PR1001MB2357.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 8a92e4ef-d080-43ca-aca0-08d95d0780ec
X-MS-Exchange-CrossTenant-originalarrivaltime: 11 Aug 2021 20:35:05.7874
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: tfeJARspy+5tL75048TRSSHou29ClD2JXV/tgt2GzvqIJcErXI0FHh9LX3ykKdzCadexedW1b7HqxsxfN1kad7FDb2HKIknurv4j8KkPs1c=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR10MB1702
X-Proofpoint-Virus-Version: vendor=nai engine=6200 definitions=10073 signatures=668682
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 mlxlogscore=999 mlxscore=0
 suspectscore=0 malwarescore=0 phishscore=0 adultscore=0 spamscore=0
 bulkscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2107140000 definitions=main-2108110139
X-Proofpoint-GUID: uubmqvfjN-TfzC0r1s03azEgssFGUN9V
X-Proofpoint-ORIG-GUID: uubmqvfjN-TfzC0r1s03azEgssFGUN9V
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

I agree that try_get_page() should probably be removed entirely; is there
a reason you didn't in v2 of the patch?

I'm also curious why you changed try_get_compound_head() into a routine
from an inline.

If you want to retain try_get_page() it should be an inline as well, especi=
ally
in its current implementation.

    William Kucharski

> On Aug 11, 2021, at 1:05 AM, John Hubbard <jhubbard@nvidia.com> wrote:
>=20
> try_get_page() is very similar to try_get_compound_head(), and in fact
> try_get_page() has fallen a little behind in terms of maintenance:
> try_get_compound_head() handles speculative page references more
> thoroughly.
>=20
> There are only two try_get_page() callsites, so just call
> try_get_compound_head() directly from those, and remove try_get_page()
> entirely.
>=20
> Also, seeing as how this changes try_get_compound_head() into a
> non-static function, provide some kerneldoc documentation for it.
>=20
> Cc: Christoph Hellwig <hch@lst.de>
> Cc: Matthew Wilcox <willy@infradead.org>
> Signed-off-by: John Hubbard <jhubbard@nvidia.com>
> ---
> arch/s390/mm/fault.c |  2 +-
> fs/pipe.c            |  2 +-
> include/linux/mm.h   | 10 +---------
> mm/gup.c             | 21 +++++++++++++++++----
> 4 files changed, 20 insertions(+), 15 deletions(-)
>=20
> diff --git a/arch/s390/mm/fault.c b/arch/s390/mm/fault.c
> index 212632d57db9..fe1d2c1dbe3b 100644
> --- a/arch/s390/mm/fault.c
> +++ b/arch/s390/mm/fault.c
> @@ -822,7 +822,7 @@ void do_secure_storage_access(struct pt_regs *regs)
> 		break;
> 	case KERNEL_FAULT:
> 		page =3D phys_to_page(addr);
> -		if (unlikely(!try_get_page(page)))
> +		if (unlikely(try_get_compound_head(page, 1) =3D=3D NULL))
> 			break;
> 		rc =3D arch_make_page_accessible(page);
> 		put_page(page);
> diff --git a/fs/pipe.c b/fs/pipe.c
> index 8e6ef62aeb1c..06ba9df37410 100644
> --- a/fs/pipe.c
> +++ b/fs/pipe.c
> @@ -191,7 +191,7 @@ EXPORT_SYMBOL(generic_pipe_buf_try_steal);
>  */
> bool generic_pipe_buf_get(struct pipe_inode_info *pipe, struct pipe_buffe=
r *buf)
> {
> -	return try_get_page(buf->page);
> +	return try_get_compound_head(buf->page, 1) !=3D NULL;
> }
> EXPORT_SYMBOL(generic_pipe_buf_get);
>=20
> diff --git a/include/linux/mm.h b/include/linux/mm.h
> index ce8fc0fd6d6e..cd00d1222235 100644
> --- a/include/linux/mm.h
> +++ b/include/linux/mm.h
> @@ -1207,15 +1207,7 @@ bool __must_check try_grab_page(struct page *page,=
 unsigned int flags);
> __maybe_unused struct page *try_grab_compound_head(struct page *page, int=
 refs,
> 						   unsigned int flags);
>=20
> -
> -static inline __must_check bool try_get_page(struct page *page)
> -{
> -	page =3D compound_head(page);
> -	if (WARN_ON_ONCE(page_ref_count(page) <=3D 0))
> -		return false;
> -	page_ref_inc(page);
> -	return true;
> -}
> +struct page *try_get_compound_head(struct page *page, int refs);
>=20
> /**
>  * folio_put - Decrement the reference count on a folio.
> diff --git a/mm/gup.c b/mm/gup.c
> index 64798d6b5043..c2d19d370c99 100644
> --- a/mm/gup.c
> +++ b/mm/gup.c
> @@ -62,11 +62,24 @@ static void put_page_refs(struct page *page, int refs=
)
> 	put_page(page);
> }
>=20
> -/*
> - * Return the compound head page with ref appropriately incremented,
> - * or NULL if that failed.
> +/**
> + * try_get_compound_head() - return the compound head page with refcount
> + * appropriately incremented, or NULL if that failed.
> + *
> + * This handles potential refcount overflow correctly. It also works cor=
rectly
> + * for various lockless get_user_pages()-related callers, due to the use=
 of
> + * page_cache_add_speculative().
> + *
> + * Even though the name includes "compound_head", this function is still
> + * appropriate for callers that have a non-compound @page to get.
> + *
> + * @page:  pointer to page to be gotten
> + * @refs:  the value to add to the page's refcount
> + *
> + * Return: head page (with refcount appropriately incremented) for succe=
ss, or
> + * NULL upon failure.
>  */
> -static inline struct page *try_get_compound_head(struct page *page, int =
refs)
> +struct page *try_get_compound_head(struct page *page, int refs)
> {
> 	struct page *head =3D compound_head(page);
>=20
> --=20
> 2.32.0
>=20
>=20