Re: [PATCH v5 1/2] drivers/net: fix buffer overflow for ptypes list

[Ferruh Yigit <ferruh.yigit@amd.com>]

On 1/22/2024 9:46 AM, Power, Ciara wrote:
> Hi Ferruh,
> 
>> -----Original Message-----
>> From: Ferruh Yigit <ferruh.yigit@amd.com>
>> Sent: Monday, January 22, 2024 9:43 AM
>> To: Power, Ciara <ciara.power@intel.com>; Sivaramakrishnan, VenkatX
>> <venkatx.sivaramakrishnan@intel.com>; Hemant Agrawal
>> <hemant.agrawal@nxp.com>; Sachin Saxena <sachin.saxena@nxp.com>; Zyta
>> Szpak <zr@semihalf.com>; Liron Himi <lironh@marvell.com>; Chaoyong He
>> <chaoyong.he@corigine.com>; Gagandeep Singh <g.singh@nxp.com>; Jerin
>> Jacob <jerinj@marvell.com>; Maciej Czekaj <mczekaj@marvell.com>
>> Cc: dev@dpdk.org; pascal.mazon@6wind.com; shreyansh.jain@nxp.com;
>> tdu@semihalf.com; qin.ke@corigine.com; jerin.jacob@caviumnetworks.com;
>> stable@dpdk.org
>> Subject: Re: [PATCH v5 1/2] drivers/net: fix buffer overflow for ptypes list
>>
>> On 1/19/2024 5:10 PM, Power, Ciara wrote:
>>> Hi Ferruh,
>>>
>>>> -----Original Message-----
>>>> From: Ferruh Yigit <ferruh.yigit@amd.com>
>>>> Sent: Friday, January 19, 2024 2:59 PM
>>>> To: Sivaramakrishnan, VenkatX <venkatx.sivaramakrishnan@intel.com>;
>>>> Hemant Agrawal <hemant.agrawal@nxp.com>; Sachin Saxena
>>>> <sachin.saxena@nxp.com>; Zyta Szpak <zr@semihalf.com>; Liron Himi
>>>> <lironh@marvell.com>; Chaoyong He <chaoyong.he@corigine.com>;
>>>> Gagandeep Singh <g.singh@nxp.com>; Jerin Jacob <jerinj@marvell.com>;
>>>> Maciej Czekaj <mczekaj@marvell.com>
>>>> Cc: dev@dpdk.org; Power, Ciara <ciara.power@intel.com>;
>>>> pascal.mazon@6wind.com; shreyansh.jain@nxp.com; tdu@semihalf.com;
>>>> qin.ke@corigine.com; jerin.jacob@caviumnetworks.com; stable@dpdk.org
>>>> Subject: Re: [PATCH v5 1/2] drivers/net: fix buffer overflow for
>>>> ptypes list
>>>>
>>>> On 1/18/2024 12:07 PM, Sivaramakrishnan Venkat wrote:
>>>>> Address Sanitizer detects a buffer overflow caused by an incorrect
>>>>> ptypes list. Missing "RTE_PTYPE_UNKNOWN" ptype causes buffer
>> overflow.
>>>>> Fix the ptypes list for drivers.
>>>>>
>>>>> Fixes: 0849ac3b6122 ("net/tap: add packet type management")
>>>>> Fixes: a7bdc3bd4244 ("net/dpaa: support packet type parsing")
>>>>> Fixes: 4ccc8d770d3b ("net/mvneta: add PMD skeleton")
>>>>> Fixes: f3f0d77db6b0 ("net/mrvl: support packet type parsing")
>>>>> Fixes: 71e8bb65046e ("net/nfp: update supported list of packet
>>>>> types")
>>>>> Fixes: 659b494d3d88 ("net/pfe: add packet types and basic
>>>>> statistics")
>>>>> Fixes: 398a1be14168 ("net/thunderx: remove generic passX
>>>>> references")
>>>>> Cc: pascal.mazon@6wind.com
>>>>> Cc: shreyansh.jain@nxp.com
>>>>> Cc: zr@semihalf.com
>>>>> Cc: tdu@semihalf.com
>>>>> Cc: qin.ke@corigine.com
>>>>> Cc: g.singh@nxp.com
>>>>> Cc: jerin.jacob@caviumnetworks.com
>>>>> Cc: stable@dpdk.org
>>>>>
>>>>> Signed-off-by: Sivaramakrishnan Venkat
>>>>> <venkatx.sivaramakrishnan@intel.com>
>>>>>
>>>>
>>>> Reviewed-by: Ferruh Yigit <ferruh.yigit@amd.com>
>>>>
>>>>
>>>> ("Cc: <email>" shouldn't be in the commit message, but not big deal I
>>>> can remove them while merging.
>>>> If you want to help, in next version please put them after '---', as
>>>> you are already doing with changelog)
>>>
>>> Thanks for the review on this one.
>>>
>>> The DPDK docs suggest adding the Fixes line + CC in the commit message
>> body - has the guidelines changed for this?
>>>
>>
>> Can you please point me the mentioned doc, let me check it?
> 
> Sure, it's in section 8.7 here: https://doc.dpdk.org/guides/contributing/patches.html 
> 
> 

Right, Cc the author of the fix added later to the 'git fixline' alias,
this is useful because 'git send-email' picks "Cc: ..." and cc the
author to the patch.
But this info is redundant in the commit log, so maintainers are
removing it from commit log while merging.

If the "Cc: ...", is after the '---', it is still picked by 'git
send-email' and removed automatically while merging, so this is better
option.

It is possible to update documentation but I am concerned to make adding
fixline more complex for new contributors. Perhaps can add a new line as
a suggestion.

But briefly, if you move after '---' it helps.