Received-SPF: pass (google.com: domain of linux-kernel+bounces-109494-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
From: Meiyong Yu <meiyong.yu@126.com>
Precedence: bulk
Mime-Version: 1.0 (1.0)
Subject: Re: [PATCH] Documentation: coding-style: ask function-like macros to evaluate parameters
Date: Thu, 21 Mar 2024 07:37:14 +0800
Message-Id: <EFB48F08-F0B5-47C0-8C47-00A542344AC9@126.com>
References: <20240320001656.10075-1-21cnbao@gmail.com>
Cc: corbet@lwn.net, workflows@vger.kernel.org, linux-doc@vger.kernel.org,
 linux-kernel@vger.kernel.org, Barry Song <v-songbaohua@oppo.com>,
 Andrew Morton <akpm@linux-foundation.org>, Chris Zankel <chris@zankel.net>,
 Huacai Chen <chenhuacai@loongson.cn>,
 Herbert Xu <herbert@gondor.apana.org.au>,
 Guenter Roeck <linux@roeck-us.net>, Max Filippov <jcmvbkbc@gmail.com>
In-Reply-To: <20240320001656.10075-1-21cnbao@gmail.com>
To: Barry Song <21cnbao@gmail.com>


> On Mar 20, 2024, at 08:17, Barry Song <21cnbao@gmail.com> wrote:
>=20
> =EF=BB=BFFrom: Barry Song <v-songbaohua@oppo.com>
>=20
> Recent commit 77292bb8ca69c80 ("crypto: scomp - remove memcpy if
> sg_nents is 1 and pages are lowmem") leads to warnings on xtensa
> and loongarch,
>   In file included from crypto/scompress.c:12:
>   include/crypto/scatterwalk.h: In function 'scatterwalk_pagedone':
>   include/crypto/scatterwalk.h:76:30: warning: variable 'page' set but not=
 used [-Wunused-but-set-variable]
>      76 |                 struct page *page;
>         |                              ^~~~
>   crypto/scompress.c: In function 'scomp_acomp_comp_decomp':
>>> crypto/scompress.c:174:38: warning: unused variable 'dst_page' [-Wunused=
-variable]
>     174 |                         struct page *dst_page =3D sg_page(req->d=
st);
>         |
>=20
> The reason is that flush_dcache_page() is implemented as a noop
> macro on these platforms as below,
>=20
> #define flush_dcache_page(page) do { } while (0)
>=20
> The driver code, for itself, seems be quite innocent and placing
> maybe_unused seems pointless,
>=20
> struct page *dst_page =3D sg_page(req->dst);
>=20
> for (i =3D 0; i < nr_pages; i++)
>    flush_dcache_page(dst_page + i);
>=20
> And it should be independent of architectural implementation
> differences.
>=20
> Let's have a guidance in codingstyle to ask for the evaluation
> of parameters.
>=20
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: Chris Zankel <chris@zankel.net>
> Cc: Huacai Chen <chenhuacai@loongson.cn>
> Cc: Herbert Xu <herbert@gondor.apana.org.au>
> Cc: Guenter Roeck <linux@roeck-us.net>
> Suggested-by: Max Filippov <jcmvbkbc@gmail.com>
> Signed-off-by: Barry Song <v-songbaohua@oppo.com>
> ---
> Documentation/process/coding-style.rst | 7 +++++++
> 1 file changed, 7 insertions(+)
>=20
> diff --git a/Documentation/process/coding-style.rst b/Documentation/proces=
s/coding-style.rst
> index 9c7cf7347394..8065747fddff 100644
> --- a/Documentation/process/coding-style.rst
> +++ b/Documentation/process/coding-style.rst
> @@ -827,6 +827,13 @@ Macros with multiple statements should be enclosed in=
 a do - while block:
>                do_this(b, c);        \
>        } while (0)
>=20


> +Function-like macros should evaluate their parameters, for unused paramet=
ers,
I do not support this point, if the parameter is unused, why not to remove i=
t.

about the warning,  is  tool misreport,  the tool must make better

> +cast them to void:
> +
> +.. code-block:: c
> +
> +    #define macrofun(a) do { (void) (a); } while (0)
> +
> Things to avoid when using macros:
>=20
> 1) macros that affect control flow:
> --
> 2.34.1
>=20