Received-SPF: pass (google.com: domain of linux-kernel+bounces-140324-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
Message-ID: <80d765f5-1436-4799-95fe-ba05c0681d5c@intel.com>
Date: Thu, 11 Apr 2024 13:14:04 +0200
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH] kernel-doc: fix struct_group_tagged() parsing
To: Przemek Kitszel <przemyslaw.kitszel@intel.com>
CC: Jonathan Corbet <corbet@lwn.net>, Kees Cook <keescook@chromium.org>, Jakub
 Kicinski <kuba@kernel.org>, Dan Williams <dan.j.williams@intel.com>, "Gustavo
 A. R. Silva" <gustavoars@kernel.org>, Keith Packard <keithp@keithp.com>,
	<nex.sw.ncis.osdt.itp.upstreaming@intel.com>, <linux-doc@vger.kernel.org>,
	<netdev@vger.kernel.org>, <linux-kernel@vger.kernel.org>
References: <20240411093208.2483580-1-aleksander.lobakin@intel.com>
 <b9804c32-9ba2-493b-bfb8-a6ac4f108175@intel.com>
From: Alexander Lobakin <aleksander.lobakin@intel.com>
Content-Language: en-US
In-Reply-To: <b9804c32-9ba2-493b-bfb8-a6ac4f108175@intel.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 8bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?dlNReWNPWFZTSEdFVWFicU5xTEkwTzFyVWVTVHVtZHFCV0grblB0MjBSa2R5?=
 =?utf-8?B?OUdKcUNJdWp2YUFQVTgxUnRMaDNPODlGdVE1b2lHdHphWjFCcTk1OGxERFBS?=
 =?utf-8?B?bGt1cEtjc0RTek5jZDlNSGJla2ZUZVJ0em02dWlKUTdkOVhhdUovanlRSTVq?=
 =?utf-8?B?V09kUlI4NjR5U1pMZE9tbkFlZ3NVRGpQU3R5NDh1cnZOSm51aExVVzRqWFV5?=
 =?utf-8?B?b1hOK2dmb2c5UmZtVVpiUnlST0FiWTVHcCtib0R1SDVnNDBZZjduYTBRN3l6?=
 =?utf-8?B?NDFHUGlMRDREK0dZNDdDRGhMNHJKc0l4ZGZtQ3RnR3VCc3psSVBXeUlvMmZP?=
 =?utf-8?B?aFJQb3d3WUExenZWL1pac0R3TnFLT0xRdlJtMVpxY1NTeTJNdjFadENsZjU5?=
 =?utf-8?B?N2VrdEx5dHZkWllKaXBQdTJPUmVVMkpXVzBsMWZsVjI1RklBbDhpQm1XTkcr?=
 =?utf-8?B?MUlIczM0N0dRR3g1OTlNa0lObjRaYlpMK0xpbU9NNXVWRUxhSWNZUlVHVXhO?=
 =?utf-8?B?dDNRVUpFTWxscXVscWQrZEJETFhoN0ZaWkV1YU9KRW1ycmsybW5tMjJ1Q1dN?=
 =?utf-8?B?SERpVXJub3V2VjRyWVFBTzNzSFlod1h6U05mTUtEdHJEbWpJTHpLcXF4ZGgy?=
 =?utf-8?B?UWFzOW9rOXNqT3FIZmhveGlLQS9vZVdoOTAweTBjU1BDOVhaMWZ6TTBCRDRQ?=
 =?utf-8?B?Tzk2cUV2b0UzWHFQMjdwMzFkbm5ocjVUQytxeWdhU0l1dVQ3cGFiYzM5cUhV?=
 =?utf-8?B?K2RVSkJTSXR1QkJJUHlpMjdLamdNTnF6dDkwVGpJL2J2L2p5K1NYNSt6QXpN?=
 =?utf-8?B?d0lnUWdaQThITTVhOHJRdjE4OG5ueUFzTk15aUpDVmw4R0pmZnJGYVNveHFw?=
 =?utf-8?B?b3RiME9IZHdyeVU0c2h4aVJSeFFxTmZxU3FSN1Jjc0lRc0pmL1dwelYwMGpq?=
 =?utf-8?B?UkJLNnFkUlM5Y2hRblZzRWd5TlJxWW1GMHhBN3ZIMk5PdVhsVEY5MlBtSXk4?=
 =?utf-8?B?Q0xCY1g4M3U0dkZkY2psSTUzK0crcTFmNFM0MnlTRmZPdTltRDd6ZEVoVGUv?=
 =?utf-8?B?VFJVM0EvT1UwaU8wS3NCQkNLSllLbEVDSWhiWDNNb3FncWhFMVF2YkFaaU9G?=
 =?utf-8?B?Z29SWnFnL3ozYW1DbnNqL25YeWhOcTFZeWFNNWVLMUJNRUx1VlppRGUwNmxE?=
 =?utf-8?B?elRNQUdrcy9sai92OFM0VnpiWGIzVytzaG1NMkU4SzR3Tk1IR0pmcmpRQlVZ?=
 =?utf-8?B?WTVReG9zVzcwREFmN1VKZEJWakhrdjlBZ1ZjN2F1MUEzTU5CWVB0WWpkTDdh?=
 =?utf-8?B?VG4vUmQ2NEFWalZoTllZOStRYXZuT2RmUHRPS1pGYjRndGFUa0FnZVhtWVlU?=
 =?utf-8?B?Q21BNW1xZ0dLZ3kwNlZrUmIzb3pqQ2VKZ2NJamdQSGtHeVhqcmZpbjYzUWpY?=
 =?utf-8?B?Y20wWEZPSFVpTU9lMm1JQythM0JaRVljTHFJcnE0blVTVXBFeWR5SThmL2tM?=
 =?utf-8?B?N2tkbEpqTVhxb2JCYWFZSzhMVTFEL3pFaEdLUnFrZTQvVnF3dkROSUZOVWhp?=
 =?utf-8?B?TERqbWxuTHdCZEZYSExIcnJCRlBibXhtbzFrbXN3MWRWZ1JQUzAvd202YXlZ?=
 =?utf-8?B?VXpuc3RYYnJYY3hWVjNyckRHUmxxaUNpeVFPak5JaXY2WDQ1ZGlEdjVKTUdn?=
 =?utf-8?B?NzBueGg3Y3J5eTA3UGtUS3Zkd0dJaUd4SG1INVg4YWhWZzdNYUV6QnBhRm5q?=
 =?utf-8?B?R01qOWdFR1Y1MG9HQy9RbmViV0RDN1NsN2poNVgycU9KeDJ5RDdnQjN3dW1k?=
 =?utf-8?B?bm04c3U0UHhmT040d0thbFV1eUcxQTBOOUMwYXJsK2VrQkhIM2JQd0tpQTVa?=
 =?utf-8?B?UzdkckNyVHZaYVROeklwYmdrd2ROSWZSVjJmVGh6cm1WVnRVbG5WT0pnZi9a?=
 =?utf-8?B?WW4wZHdmZnlkY09LSzBFejBJRGpUM01la2RJWUNwQUdtNFV2aTFYME1mYmJl?=
 =?utf-8?B?dG85WWhPUk8zS05oV2xNL21vVjJ2d1BhSEFmUXU4dEZ1eWdOK2ZpdGFPR0Vt?=
 =?utf-8?B?WnptS1NuV3J4ZzZqWmtKK0xNMkZjUVAxb3c0RGVSZEVlcnRuZUw2by9jaVJ4?=
 =?utf-8?B?S256blAreTMxd2NwSkJMU1QybEYwMHdSV3JIVVI3SU5OZkhWS2tMOXdGUVUv?=
 =?utf-8?B?WHc9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 3f2fe132-ece6-41d6-cc51-08dc5a18d0f8
X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB8718.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 Apr 2024 11:16:21.2342
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: x7QCavuYuixxP3GkMg+yki49cU51aycRH3zJYKuAhFeZuVY3PIZCclHAZQXRVJ3RSnYjbPfTHUc2KNVX2liDwmk51K4Tn5+oBJfBZuh0/yw=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: LV3PR11MB8507
X-OriginatorOrg: intel.com

From: Przemek Kitszel <przemyslaw.kitszel@intel.com>
Date: Thu, 11 Apr 2024 13:14:20 +0200

> On 4/11/24 11:32, Alexander Lobakin wrote:
>> From: Kees Cook <keescook@chromium.org>
>>
>> kernel-doc emits a warning on struct_group_tagged() if you describe your
>> struct group member:
>>
>> include/net/libeth/rx.h:69: warning: Excess struct member 'fp'
>> description in 'libeth_fq'
>>
>> The code:
>>
>> /**
>>   * struct libeth_fq - structure representing a buffer queue
>>   * @fp: hotpath part of the structure
>>   * @pp: &page_pool for buffer management
>> [...]
>>   */
>> struct libeth_fq {
>>     struct_group_tagged(libeth_fq_fp, fp,
>>         struct page_pool    *pp;
>> [...]
>>     );
>>
>> When a struct_group_tagged() is encountered, we need to build a
>> `struct TAG NAME;` from it, so that it will be treated as a valid
>> embedded struct.
>> Decouple the regex and do the replacement there. As far as I can see,
>> this doesn't produce any new warnings on the current mainline tree.
>>
>> Reported-by: Jakub Kicinski <kuba@kernel.org>
>> Closes: https://lore.kernel.org/netdev/20240405212513.0d189968@kernel.org
>> Fixes: 50d7bd38c3aa ("stddef: Introduce struct_group() helper macro")
>> Signed-off-by: Kees Cook <keescook@chromium.org>
>> Co-developed-by: Alexander Lobakin <aleksander.lobakin@intel.com>
>> Signed-off-by: Alexander Lobakin <aleksander.lobakin@intel.com>
>> ---
>>   scripts/kernel-doc | 3 ++-
>>   1 file changed, 2 insertions(+), 1 deletion(-)
>>
>> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
>> index 43a30f2de513..01ac8f794b30 100755
>> --- a/scripts/kernel-doc
>> +++ b/scripts/kernel-doc
>> @@ -1152,7 +1152,8 @@ sub dump_struct($$) {
>>           # - first eat non-declaration parameters and rewrite for
>> final match
>>           # - then remove macro, outer parens, and trailing semicolon
>>           $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos;
>> -        $members =~
>> s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos;
>> +        $members =~
>> s/\bstruct_group_attr\s*\(([^,]*,){2}/STRUCT_GROUP(/gos;
>> +        $members =~
>> s/\bstruct_group_tagged\s*\(([^,]*),([^,]*),/struct $1 $2;
>> STRUCT_GROUP(/gos;
>>           $members =~
>> s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos;
>>           $members =~
>> s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos;
>>   
> 
> I would complain on code that matches `[^,]*` part with 0 characters,
> meaning no tag for struct_group_tagged(), or no attrs for
> struct_group_attrs(). In such cases simpler struct_group() call should
> be suggested. However, that issue was presented prior to your patch.

Rather a subject for checkpatch, not kernel-doc?

> 
> This is clearly an improvement, so:
> Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@intel.com>

Thanks!
Olek