Received-SPF: pass (google.com: domain of linux-kernel+bounces-122736-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Message-ID: <ef2c96e40bcf777535c9ff2405e4dc5b3138b27e.camel@perches.com>
Subject: Re: [PATCH v4 2/2] scripts: checkpatch: check unused parameters for
 function-like macro
From: Joe Perches <joe@perches.com>
To: Barry Song <21cnbao@gmail.com>, akpm@linux-foundation.org, 
	linux-doc@vger.kernel.org
Cc: apw@canonical.com, broonie@kernel.org, chenhuacai@loongson.cn, 
 chris@zankel.net, corbet@lwn.net, dwaipayanray1@gmail.com, 
 herbert@gondor.apana.org.au, linux-kernel@vger.kernel.org,
 linux@roeck-us.net,  lukas.bulwahn@gmail.com, mac.xxn@outlook.com,
 sfr@canb.auug.org.au,  v-songbaohua@oppo.com, workflows@vger.kernel.org,
 Max Filippov <jcmvbkbc@gmail.com>
Date: Thu, 28 Mar 2024 02:57:35 -0700
In-Reply-To: <20240328022136.5789-3-21cnbao@gmail.com>
References: <20240328022136.5789-1-21cnbao@gmail.com>
	 <20240328022136.5789-3-21cnbao@gmail.com>
Content-Type: text/plain; charset="ISO-8859-1"
Content-Transfer-Encoding: quoted-printable
User-Agent: Evolution 3.48.4 (3.48.4-1.fc38) 
Precedence: bulk
MIME-Version: 1.0

On Thu, 2024-03-28 at 15:21 +1300, Barry Song wrote:
> From: Xining Xu <mac.xxn@outlook.com>
>=20
> If function-like macros do not utilize a parameter, it might result in a
> build warning.  In our coding style guidelines, we advocate for utilizing
> static inline functions to replace such macros.  This patch verifies
> compliance with the new rule.
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -6109,6 +6109,36 @@ sub process {
>  				WARN("TRAILING_SEMICOLON",
>  				     "macros should not use a trailing semicolon\n" . "$herectx");
>  			}
> +
> +			# match "\s*" rather than "\s+" after the balanced parens, as macro d=
efinition with arguments
> +			# is not required to have whitespace after arguments
> +			if ($dstat =3D~ /^\+\s*#\s*define\s+$Ident$balanced_parens\s*(\S+.*)(=
\/[\/*].*)?/) {

I think '(\/[\/*].*)?' doesn't do what you expect
perhaps '(\/[\/\*].*)?'
though I don't know why this should be capture group

> +				my $params =3D $1 || "";


> +				my $body =3D $2 || "";

Should never get the || "" as the 2nd capture group is not optional

> +
> +			    # get the individual params
> +				$params =3D~ tr/()//d;
> +				# remove leading and trailing whitespace
> +				$params =3D~ s/^\s+|\s+$//g;
> +
> +				$ctx =3D~ s/\n*$//;
> +				my $cnt =3D statement_rawlines($ctx);
> +				my $herectx =3D get_stat_here($linenr, $cnt, $here);
> +
> +				if ($params ne "") {

probably unnecessary

> +					my @paramList =3D split /,\s*/, $params;

please use split() with parentheses

> +					foreach my $param(@paramList) {

maybe
				foreach my $param (split(/,/, $params) {
					$param =3D trim($param);
					next if ($param =3D~ /\.\.\.$/);

> +						if ($param =3D~ /\.\.\.$/) {
> +							# if the param name ends with "...", skip the check
> +							next;
> +						}
> +						if ($body !~ /\b$param\b/) {
> +							WARN("UNUSED_PARAM_IN_MACRO",
> +								"Parameter '$param' is not used in function-like macro\n" . "$he=
rectx");
> +						}
> +					}

It seems this logic is a bit redundant to existing
code and might be better added in the block that starts

(line 6026)
# check if any macro arguments are reused (ignore '...' and 'type')

as that already does each param in a #define and
ignores ... and type