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 Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4018FCD3448 for ; Tue, 3 Sep 2024 16:10:42 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id AD3BA8D01A3; Tue, 3 Sep 2024 12:10:41 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id A83DD8D018A; Tue, 3 Sep 2024 12:10:41 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 925378D01A3; Tue, 3 Sep 2024 12:10:41 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0015.hostedemail.com [216.40.44.15]) by kanga.kvack.org (Postfix) with ESMTP id 72F258D018A for ; Tue, 3 Sep 2024 12:10:41 -0400 (EDT) Received: from smtpin19.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id 2223D4063D for ; Tue, 3 Sep 2024 16:10:41 +0000 (UTC) X-FDA: 82523915082.19.2059657 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf19.hostedemail.com (Postfix) with ESMTP id 5849F1A001D for ; Tue, 3 Sep 2024 16:10:39 +0000 (UTC) Authentication-Results: imf19.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=IA5U16DO; spf=pass (imf19.hostedemail.com: domain of jarkko@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=jarkko@kernel.org; dmarc=pass (policy=quarantine) header.from=kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1725379764; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=8Jy8mh2BPJkT89ih2uFUxfgvbOKfzu6CzX/8hM5kIXY=; b=8cPk4z1XI0/LbZEd5jLlx7Bq0XIGxSx6xWdrbwiV9vVeMw+MbebhlbB0betnDGRIFna53p d0xJvOeUPThwlSJkMwQ1YTXBlIMyJSRJ9Sh+Rtpr7nEMGsRbbXgmaQOfjj5jEwZaFB45yb DRgddFdJqXHpkETgUoVt0//o1xyvPJk= ARC-Authentication-Results: i=1; imf19.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=IA5U16DO; spf=pass (imf19.hostedemail.com: domain of jarkko@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=jarkko@kernel.org; dmarc=pass (policy=quarantine) header.from=kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1725379764; a=rsa-sha256; cv=none; b=NsIaBDAz2JyhUqo5jB1N/1OEV16u3IGMRlLIHC3PyLKWPlHSXSAF8X8DXKfkKztCvxbld8 nruRkjcQJagXB+chRfhLwRZUSYx1JaLjerMvfPuSo3bPkIMK3vBl9xpNcw3HcYU/6DGWsn 5Wv89SVaUjYCesF8+fRpS3w+KG99EsE= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id 0F6495C59F8; Tue, 3 Sep 2024 16:10:35 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 9DA66C4CEC4; Tue, 3 Sep 2024 16:10:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1725379838; bh=xex94DES95vi44hvW2E+tvA/zSdqkC8n+EuRP566ZLE=; h=Date:Subject:From:To:Cc:References:In-Reply-To:From; b=IA5U16DOtLR6DbrDi1P5qpGMi5ooAiZQRplmIii4n4vbRax6vGy+wFArnwd1ZjJUb ZHS6G4UDnyyVfDVgqwoBRglWfd+0wdrs6rq3FjniF+5bzDRdAyDWSdYErvIq3tLRrC ZQ95U4BqBbOblMTd/mRPtWz+QKb0tbNkGwwwmPpKUAQIPxbyfp4LWbojukrsIapA25 1I4gJ6he/rDTUCA30WigqyOXrCsI92cARsoxPw73N+BamQ1RLjiq4e5dXXOcProWEo NOt1ivbA0Qgk+GBWVBaN82dKIFQdA4c23tVVHIfISgNM+FpCrAAaPFi0mYB/ttNpUh GF+7o1P09u0Yw== Mime-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=UTF-8 Date: Tue, 03 Sep 2024 19:10:34 +0300 Message-Id: Subject: Re: [PATCH v12 2/3] mm: memory-failure: move return value documentation to function declaration From: "Jarkko Sakkinen" To: "Shuai Xue" , , , , , , , , , , , , Cc: , , , , , , , , , , , , , , , , , , , X-Mailer: aerc 0.18.2 References: <20221027042445.60108-1-xueshuai@linux.alibaba.com> <20240902030034.67152-3-xueshuai@linux.alibaba.com> In-Reply-To: <20240902030034.67152-3-xueshuai@linux.alibaba.com> X-Stat-Signature: he6bx5gxzcrsw4u348jh31g1wf666wrp X-Rspam-User: X-Rspamd-Queue-Id: 5849F1A001D X-Rspamd-Server: rspam02 X-HE-Tag: 1725379839-294379 X-HE-Meta: U2FsdGVkX19P9w5i0dnk/18Zf+TcsCd9igFKa4jIJZw0RHEnWjx5ugQIymtLm8lj0qDUhLYyH1ojbGn0dL+HAPiY3knv88o9QJrPhesgcqq8yBF4tUAgsJWAJ4REhZFkIYL0Uq1lMCbYP1wqS7BKH8g9lqzGIMzaPZr47CVdTNKkkd9uijit64ERmZahuuRlJ/uilvgo8yTKSiqvPbN37glsKg9UVplgv4+tJ7Vrz4z83GTXvELJ66OX3V9ZpRxYChdypPBi1Zmf4Vp4E08v8YOafhUgg4i61UY00xOVyR8cgVIELf6Cj2lzusn1yPWoG7vSb7k6Cs3HNkzYwHJycWK0OqCMqzZC6OOE/9sNbH9F2BMCwgsD/FtJHTcaejXW/FnJdVn9NjK1rDxaQwnfWPx0TJgzREdX75WR7zy1Tj2IGZvM6JoSPyMbFUp2CWH98sCebPUXsNHbN49xVgS1eKuQQUN3UmS5zlu7JVQ0LVqJvXXQenk/ImsZMM1RjMP5dT8Kuk3JGUVGXtm+zebGh7Ow3gQVRLQNVbz/4nRhVft5gp4ozc/ZQVjiVycQ2tPLkO+uTaaZ49QYQO4aGONMRL+Fhp8NU+ztSLWvgyk7UCZgxJTrHnprfueCEZ01Ry9bXvVnVKV86jwaTXcNkIYLsOCaKCbfdfGd/lwTncJ7UG0aNjYup/pPbf2Gm3df7nrt2v9asYVLjTl/CDnRRMC2v/y9YHuIdBuM6RsbgtrALewoNZneX+vL1LnxhzoFzaxT4ZoUrAwwV/o++5lwCvMO1WHSmGukwanx0zkFcUomVucn1XeCNXzD5ThpuhrkrolxcsHCXkPouNZZMxOqLpE/rXrvpRlVrzfRut+Vf/UWLpieH4Okel/AKpb7sum+NZZTrTjglPnqRrGPK1ElSvDaJxF2iZVGo4Xl7oo1tIEZeEIYcKTfyeXhSARQr8JWGEn1jSm2+us+6iADIk6Bd3k FlMWklQ1 EjQlRgZgVpfHSRnkukdLL7ah3ZJyWIMi9FNv5flucwVd+pyVF+EwDsA6e5it8qviZD4ksv0C1YjGKgIQR2mJ4hUVahSbDfLeGV3sOIykFkJTG47sSvOaVFgJFn0SM1dntn2kqBqClPbBljssyFBvHigAeInE+MKZKTvA+eCpVtz8Ugxk2dA8roFXeMtemhI4tiWRZKgvvXRjYdVXlsE4vw5UhaXJ2aRu9ysT5jehn4/cGilXXhz5a/79JwfNzpdhcoPWY2w60dEVoHcD/64jHULcYyNmexBErOK16MeMvvEwsRiA= 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: List-Subscribe: List-Unsubscribe: On Mon Sep 2, 2024 at 6:00 AM EEST, Shuai Xue wrote: > Part of return value comments for memory_failure() were originally > documented at the call site. Move those comments to the function > declaration to improve code readability and to provide developers with > immediate access to function usage and return information. > > Signed-off-by: Shuai Xue > --- > arch/x86/kernel/cpu/mce/core.c | 7 ------- > mm/memory-failure.c | 9 ++++++--- > 2 files changed, 6 insertions(+), 10 deletions(-) > > diff --git a/arch/x86/kernel/cpu/mce/core.c b/arch/x86/kernel/cpu/mce/cor= e.c > index b85ec7a4ec9e..66693b6dd1cd 100644 > --- a/arch/x86/kernel/cpu/mce/core.c > +++ b/arch/x86/kernel/cpu/mce/core.c > @@ -1361,13 +1361,6 @@ static void kill_me_maybe(struct callback_head *cb= ) > return; > } > =20 > - /* > - * -EHWPOISON from memory_failure() means that it already sent SIGBUS > - * to the current process with the proper error info, > - * -EOPNOTSUPP means hwpoison_filter() filtered the error event, > - * > - * In both cases, no further processing is required. > - */ > if (ret =3D=3D -EHWPOISON || ret =3D=3D -EOPNOTSUPP) > return; > =20 > diff --git a/mm/memory-failure.c b/mm/memory-failure.c > index 7066fc84f351..df26e2ff5e06 100644 > --- a/mm/memory-failure.c > +++ b/mm/memory-failure.c > @@ -2199,9 +2199,12 @@ static void kill_procs_now(struct page *p, unsigne= d long pfn, int flags, > * Must run in process context (e.g. a work queue) with interrupts > * enabled and no spinlocks held. > * > - * Return: 0 for successfully handled the memory error, > - * -EOPNOTSUPP for hwpoison_filter() filtered the error event, > - * < 0(except -EOPNOTSUPP) on failure. > + * Return values: s/Return values/Return:/=20 https://www.kernel.org/doc/Documentation/kernel-doc-nano-HOWTO.txt > + * 0 - success, > + * -EOPNOTSUPP - hwpoison_filter() filtered the error event, > + * -EHWPOISON - the page was already poisoned, potentially > + * kill process, > + * other negative values - failure. > */ > int memory_failure(unsigned long pfn, int flags) > { BR, Jarkko