Received-SPF: pass (google.com: domain of linux-kernel+bounces-108737-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Message-ID: <058f6e5d-369e-48c7-a5ea-976eccccaafe@intel.com>
Date: Wed, 20 Mar 2024 11:10:09 +0100
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH RFC kspp-next 3/3] idpf: sprinkle __counted_by{,_le}() in
 the virtchnl2 header
Content-Language: en-US
To: Kees Cook <keescook@chromium.org>, Simon Horman <horms@kernel.org>
CC: <linux-hardening@vger.kernel.org>, "Gustavo A. R. Silva"
	<gustavoars@kernel.org>, Marco Elver <elver@google.com>, Jakub Kicinski
	<kuba@kernel.org>, <netdev@vger.kernel.org>, <linux-kernel@vger.kernel.org>
References: <20240318130354.2713265-1-aleksander.lobakin@intel.com>
 <20240318130354.2713265-4-aleksander.lobakin@intel.com>
 <20240319185718.GO185808@kernel.org> <202403191442.219F77E672@keescook>
From: Alexander Lobakin <aleksander.lobakin@intel.com>
In-Reply-To: <202403191442.219F77E672@keescook>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 7bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?Y3JBSmJTZHFQVkoxN0ZMbGdpU3h5NnFtVWtjNGxNOEp1aGNvdHQrWWJkeG9u?=
 =?utf-8?B?Y2szaVVPL1N4ZHJWK0pkY083ZXNRVzdOQjdVWUZkM0Q3bjhuN2xVamxYcEIv?=
 =?utf-8?B?UzV6bnhxK0ZNTG54V3FQbWplWm9JRzE0TyttNWhMb0ZRNkJzV21VQlNFeVcr?=
 =?utf-8?B?R3pud0dTN2kycWJCV1piNmQvUklaOWh2Tm0zNXFZVEc2U2p6SEtJWU5QdGNH?=
 =?utf-8?B?S3dSenlpc2s3WHR6anY3aEhmdWpwQ2RVenlaWUkyOFRpNkxMWlcrcXVxUk5L?=
 =?utf-8?B?VWJ0Skc1Q1ZhMUN6TjhkZmhWeU9zZmcxOWFuWmZGdU54SndMYmNIRHBGYmg0?=
 =?utf-8?B?YWJlTWNlQlBqdXYxRFB3SUUyTDlMQTBqYlB2S0ZrcU5HaFNndFpMRDVwYm9v?=
 =?utf-8?B?U1hid2p0U1lPRk9FZUVxZEp4RGszakk0dHdLbDFzMkZDcU5jTUMzT3BhMU0v?=
 =?utf-8?B?cXhra0VmVU1sejE2dDY5OVloRmRMM2EwWk52c2F1S3hRdnpFd2RpSE5Oak93?=
 =?utf-8?B?ZndVKzJueDE4L3VBbGFLZ3EzL3MxdE14UzJ6dzVGQ3o3NS9DcWFDRERhRW14?=
 =?utf-8?B?ZHY4WmRVamltYldsMFdLTXRzbXBubmtwZEI1SG03WkVBb3BlL2VTWXZMcGN1?=
 =?utf-8?B?QlBOUk4rREx2WUVCUk91OHMvRlBMUFVNdGNxT1VRek9WMWZVUEFBVE5JR2pN?=
 =?utf-8?B?VHNMcm1VdnlzVEo0aVlzVUZNUjI4TzJnWlN5b1JaaVlhUlRLQ2Vhc05qRVdv?=
 =?utf-8?B?YldEYk4vbUJwa2VQczdEOTRlU016VVB6Wmd1c1d5K0w2bmd2cE9WM3pWRWZM?=
 =?utf-8?B?Q1hWZnE2NThUT0dGU291VUcxdm1UUWN0cEdaaG50K0U3L2tIQS9CY2huWTFD?=
 =?utf-8?B?dWs0bXBmdnZ4SE45UVFwZU1zSUY0MGR3dk1iQnk3Z1p3My9ycUdFZzNSTEt5?=
 =?utf-8?B?MHN3OXlMRE0weWY5Y3I5cEsxY1k2SmF3bUQ1Y1ZxNnRob1RvZ0lEWGRUaTdw?=
 =?utf-8?B?MDFSVlNCM3JPOW42dGRrc3Fac2NDZytmODdiRU1pcHkxYmdlMHB5TkF2dzVu?=
 =?utf-8?B?MTh5MEpRc2ZtcTZJai8xWnpNZEw1Y25XMzRsWGc1R3lxalNOcU00ZUoyZG9v?=
 =?utf-8?B?U0g2L3UwbE44MEhDWGlkaUFOR1h3WGU1aGl5clVHZ3Y1bC9kRjBPb0grUDUx?=
 =?utf-8?B?SlRaWGZvWHk2YlVLU3pacVYzRkNtam9zdXZ4VVVlUUw2UDhCY3pIUW1ha1Nj?=
 =?utf-8?B?WVFvSnlNZFRnZWM5ei9LMU10ZVJQWDJ2dXVDTDVmSlNCNDVRcFBSM3c0ZVBV?=
 =?utf-8?B?bHJmL0dyalloNmxEVlk5a2ZXMnhOSkpURlRqNjQxejVYVnU5eUc5cmpsdzRh?=
 =?utf-8?B?UHVhcUh3Z0NqZXFNbnR1a0EwUU05ZXZINWpjZ2I1NlExOWltMFJlRVBZeXZN?=
 =?utf-8?B?RTdJWlhpeU0zb1dxTWpJcmpha0EzQmNJNlQwcEtid2FjMW1kQWc2dW15K2JN?=
 =?utf-8?B?QnB6ei8rTE9GZ1pxVVhRRlFoSTQwU0M2cklzQ3hmSVBpY3dMeU9nSnRFWjJK?=
 =?utf-8?B?SjVPVnk3ZEI0T3pWTE5RSSszWjJMN3RmUmxwRzZ6TngxMlkwWm52VlFFaTRB?=
 =?utf-8?B?MFVoQTJLV2xHNTIrTzY2RU5MMVRreTNaMUxZdCswbjNJcGh4RGN5Y1RodlRP?=
 =?utf-8?B?UlgxV0tVc1dUUUp3ajIvNWxkTmMrMGR5SlBIWmUzV05LRVJYRWFJajNaaTd2?=
 =?utf-8?B?eXVpelhSSE1sMFpya3MrTDc4d3BJZHU5K25EbWpyc1NNV2JjNUlGN2pjWU8w?=
 =?utf-8?B?NmVlRTErdE9GZTRLRWFPekgvSkF4b2FBVU5ydXpuSTdlV0prdE9XczFpM3Bu?=
 =?utf-8?B?R00zWDdyRjlRMmhFQ2dUcW5xSDczbEMzb2Rwank0VHp6MjVvcVJiUEhhUldy?=
 =?utf-8?B?NlV4ZzRKditKSkNKTVVZOGhOUnRxd1lTVDBNQVhGbEt4QnZhQktzNktMdkxY?=
 =?utf-8?B?dGowNmJ5Z1NhNFpUQjZvV1IxczQySFZHdnlPRW1ES3I1NGdLWXB6RHB4Yjdj?=
 =?utf-8?B?dkVReGdDVFlRaWpUVTRhN2RCUmtMUjdYTFppR05teFhCdlZJRDF2RnBrS0NU?=
 =?utf-8?B?dlZZSmU3VitkRTVOQXRub3YzLzJId3JjdFh3YXNsWFB4T2pOQzMzVFlUVEtM?=
 =?utf-8?B?bVE9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 35c30941-74e5-4006-c468-08dc48c5f005
X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB8718.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Mar 2024 10:10:15.3291
 (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: MFhaYBSf3b7JqziS7DSVHVLjpwjj5IZOFSRuYg67oCTfD1ynRtvRqd83K3WNTJSxfcRaOCAzWfSNA0rTK/NI/wNQhwZHhhqooJwA+nf1Fi8=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR11MB4982
X-OriginatorOrg: intel.com

From: Kees Cook <keescook@chromium.org>
Date: Tue, 19 Mar 2024 14:42:56 -0700

> On Tue, Mar 19, 2024 at 06:57:18PM +0000, Simon Horman wrote:
>> On Mon, Mar 18, 2024 at 02:03:54PM +0100, Alexander Lobakin wrote:
>>> Both virtchnl2.h and its consumer idpf_virtchnl.c are very error-prone.
>>> There are 10 structures with flexible arrays at the end, but 9 of them
>>> has flex member counter in Little Endian.
>>> Make the code a bit more robust by applying __counted_by_le() to those
>>> 9. LE platforms is the main target for this driver, so they would
>>> receive additional protection.
>>> While we're here, add __counted_by() to virtchnl2_ptype::proto_id, as
>>> its counter is `u8` regardless of the Endianness.
>>> Compile test on x86_64 (LE) didn't reveal any new issues after applying
>>> the attributes.
>>>
>>> Signed-off-by: Alexander Lobakin <aleksander.lobakin@intel.com>
>>
>> Hi Alexander,
>>
>> with this patch applied ./scripts/kernel-doc -none reports the following.
>> I think that this means that the kernel-doc needs to be taught
>> about __counted_by_le (and __counted_by_be).
> 
> Oh, yes, I should have remembered that need. Sorry! It should be
> addressed by adding them where __counted_by is already listed in
> Documentation/conf.py.

Oh, thanks to both of you! I'll do that before sending v1.

> 
> -Kees
> 
>>
>> .../virtchnl2.h:559: warning: Excess struct member 'chunks' description in 'virtchnl2_queue_reg_chunks'
>> .../virtchnl2.h:707: warning: Excess struct member 'qinfo' description in 'virtchnl2_config_tx_queues'
>> .../virtchnl2.h:786: warning: Excess struct member 'qinfo' description in 'virtchnl2_config_rx_queues'
>> .../virtchnl2.h:872: warning: Excess struct member 'vchunks' description in 'virtchnl2_vector_chunks'
>> .../virtchnl2.h:916: warning: Excess struct member 'lut' description in 'virtchnl2_rss_lut'
>> .../virtchnl2.h:1108: warning: Excess struct member 'key_flex' description in 'virtchnl2_rss_key'
>> .../virtchnl2.h:1199: warning: Excess struct member 'qv_maps' description in 'virtchnl2_queue_vector_maps'
>> .../virtchnl2.h:1251: warning: Excess struct member 'mac_addr_list' description in 'virtchnl2_mac_addr_list'
>>
>> ...
> 

Thanks,
Olek