Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) client-ip=23.128.96.38;
Message-ID: <2a0f3c2a-71fe-4c79-8827-e53088bf3761@intel.com>
Date:   Wed, 6 Dec 2023 13:40:07 +0100
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH v4 iwl-next] i40e: Use correct buffer size in
 i40e_dbg_command_read
Content-Language: en-US
To:     Kunwu Chan <chentao@kylinos.cn>
CC:     <jesse.brandeburg@intel.com>, <anthony.l.nguyen@intel.com>,
        <davem@davemloft.net>, <edumazet@google.com>, <kuba@kernel.org>,
        <pabeni@redhat.com>, <jeffrey.t.kirsher@intel.com>,
        <shannon.nelson@amd.com>, <kunwu.chan@hotmail.com>,
        <netdev@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
        Simon Horman <horms@kernel.org>
References: <20231205095844.2532859-1-chentao@kylinos.cn>
From:   Alexander Lobakin <aleksander.lobakin@intel.com>
In-Reply-To: <20231205095844.2532859-1-chentao@kylinos.cn>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?ZEllYncxZ05RNEhJbStoNjVmQ0VybDFiU1UyMU1QMko4dGg5T0tnc0EzcW9W?=
 =?utf-8?B?aURGOGhSQXJRMld2aXA0QmVoTGtEdjU5bTNkcmJvdFd1elErdWpZaFcvQUl1?=
 =?utf-8?B?UVRTS3p3eWFtdllSUmJscjN3TFR2Z0RRVlQ0QkgrNXhWKy9wNGlhV3IrdzZr?=
 =?utf-8?B?djMyekMweGE4cmNkSzdld0w2REwwT0t1WktqUHNqdzY3eGhTZUp6U0dBYmdP?=
 =?utf-8?B?ODRWZEw3L1lOK0pHbFhMSjl6TStPTnB1Vks4RkdUcGx6WXJDaFgyR0wvMDR1?=
 =?utf-8?B?a3VDNytBRGVVUDlQT3ZnVEl5WmY0MzI5WGdRL3d5WkZxb2I4Ni9vR1QwdkZC?=
 =?utf-8?B?S3JzYjYrUG1ta3lGQ0tOUGhPTStQazZxM0JMU3l5cFVPYld5VWJiUlVLNkto?=
 =?utf-8?B?R1pDcjhRZ2ZMYTlNeHBDMjlRb2s5SVlhZUJ5ODZBbE9FOGhLZDNOZmJEWWZS?=
 =?utf-8?B?TDdwK1BlREhSV29wbWdqaW9EV0loNll3OTA5WCtsaHZnWWhucloreHNFelZn?=
 =?utf-8?B?MTJSYzlhZjBLQTZuTGM1VndGUyt0ZCtDb1JUOFFiNTZ3ZERMKzBrdndLbkxH?=
 =?utf-8?B?MXpBZXBJcExYcGFLTjFvZEtGeWw4TUpzZVdrU3VHd2JjeW0xWXVnSnFXU1Zp?=
 =?utf-8?B?UU1YeGd1b1JZOHV3ZjZLSWZoaHJJZkRqNWthZlJuTG9TUmFDOENPZk5XOElN?=
 =?utf-8?B?NkcwaGFzQUI5cXZkOWd1ZWpDVzdRU1loaWhWTis0VisrM0hYNHVnSDRVUUc0?=
 =?utf-8?B?azZGSW0yVXNUYmpkNVdxRGhhOUJGb0ZLd2MwM1RDUVBtaW1UdkRNT214bko4?=
 =?utf-8?B?QVRvUGNyaThZQ3lNTFhFREF1bmloUTMvVWwxSDU3amxqSGUxdGtsM0dQV3pW?=
 =?utf-8?B?TTlLd2JxR3pQKzExNzVOdXUycWFWZ1M2OHNlbmxETmYzejFOQWt5RDg5N0xO?=
 =?utf-8?B?MzJCYk5pVUpWcksxVTBETFBHdGJwNGJhdk1EZDh1amw4akR2VTRlcFdhdndz?=
 =?utf-8?B?MFFCdTluOXFXQzhjcHVpdXYzNzNnTTNaSlNOR2VMWkU4U21nWlgzVkZkYlcx?=
 =?utf-8?B?cG9xSTB3ZzNpUU0vVWFxZkxNblFlaE9abnFOQ2ZUTEdOYktwMUo4cEc5LzAw?=
 =?utf-8?B?Z2tPbU11SUxTRnRmNTNaV0lNcittcXhVcVlxSExyWENlS3VwV09Qam5KbEQ4?=
 =?utf-8?B?ek82M0hDRHVjQ0tzVW1OMDI5djhFU3crZW9RNkVzK3BhZ0hTeEpJYjdvRzFV?=
 =?utf-8?B?ZXlFUzV2eHFRWjNoZmpzZTM2ZFpCZ09yTmVvWHdsQkRPSGxRcGZ1VEhveisx?=
 =?utf-8?B?ZGM5enIza3poTllnY0Z2aHV2QjZoMmJJLzRrbnhJdUNURXdleXVya1JRbzhq?=
 =?utf-8?B?WlgxT1czNHRvVVhBenJiSmFVU1FIMmdMMlhwN2Y3ZlFMOXhCY0dxTVFwU0d6?=
 =?utf-8?B?aVM3YXE2MXdPbmhTVk9xNDhNUGJZSTdSd21xblNWblBjNnI4WnFLbmMzL1dS?=
 =?utf-8?B?YkFXcGJJUUFTc2dqbkk4eE9jM2RaLzA1VmNNNDMxWDBlN1I1RlFrQWEva2N1?=
 =?utf-8?B?aDZuK2ZkcTR3a01sT0d1VEkxa0ZMdWtYUVh6K1BUaEpZc2VhdzhZSnJ5WFNa?=
 =?utf-8?B?ZzNQSXJ2dnM1dDZuZHhrY3NQelU2WmM2UEgweWVzcGx6WXF3MEFZc0RTUXlr?=
 =?utf-8?B?QUhNT0ZOK056U09TRDhNeTM3RFlKN25pN0dSdGpRZEdBV3ozU2RJY2VGZk11?=
 =?utf-8?B?RkRTazNOb2ZVWTE4QW50blZnWnh5YTdKQ3BidDlGYnNLWFU3SGtWdXY5TWo3?=
 =?utf-8?B?clBZN2U3SDZaYmNIVmEwV1JkNThrUkpxaG9TU3FrREpJYXVSdnM1UXhERCtS?=
 =?utf-8?B?c1pPNFlFSEJ0cjFZbENpUjdseHdCMklranNZaUkxVm94OWsvOEcwU0tEMkU2?=
 =?utf-8?B?eUZOVmEyWkw0SkU3YlJJSS9qK1pXL1ZaeFhVMlN6MFNiZnZvVFoxOFFPOThl?=
 =?utf-8?B?UTF2YmhCYVZ4Vi90b2VuSFEvYWNXSVB2VXdMbUd1VGVzaFVRUXN0cDNWR0RJ?=
 =?utf-8?B?MVlCTlJNK0srVXZHcFFZZzBuRGFzSk00ZHVaVHlRUGpzSUJqd2FobHczUzgw?=
 =?utf-8?B?d01NbG8yUTR4M1d3VUdReTk0T01XTzBKMVRkZHltb0oxTTdWbW04RUVBOGcr?=
 =?utf-8?B?OGc9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 1e03a9c3-6fde-4716-fd19-08dbf658b54e
X-MS-Exchange-CrossTenant-AuthSource: DM6PR11MB3625.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Dec 2023 12:41:46.4758
 (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: Ufn/FARhyFmLevttqrC2W7WjakehojcDtvTNf//FKu5Fb3TgFipK9Y8W+YdJ4vxcBSEL4Buo1MpvvDGnUEZbj/ftgJYa/X8qxnB9XD3f6o8=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ0PR11MB5771
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE
	autolearn=unavailable autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on fry.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (fry.vger.email [0.0.0.0]); Wed, 06 Dec 2023 04:42:06 -0800 (PST)

From: Kunwu Chan <chentao@kylinos.cn>
Date: Tue, 5 Dec 2023 17:58:44 +0800

> The size of "i40e_dbg_command_buf" is 256, the size of "name"
> depends on "IFNAMSIZ", plus a null character and format size,
> the total size is more than 256.
> 
> Improve readability and maintainability by replacing a hardcoded string
> allocation and formatting by the use of the kasprintf() helper.
> 
> Fixes: 02e9c290814c ("i40e: debugfs interface")
> Signed-off-by: Kunwu Chan <chentao@kylinos.cn>
> Suggested-by: Simon Horman <horms@kernel.org>
> Suggested-by: Alexander Lobakin <aleksander.lobakin@intel.com>

Your Signed-off-by must be the last tag in the block.
Perhaps the maintainer could fix it when taking, so that you wouldn't
need to send a new version only due to that.

> ---
> v2
>    - Update the size calculation with IFNAMSIZ and sizeof(i40e_dbg_command_buf)
> v3
>    - Use kasprintf to improve readability and maintainability
> v4
>    - Fix memory leak in error path
> ---
>  .../net/ethernet/intel/i40e/i40e_debugfs.c    | 20 ++++++++++---------
>  1 file changed, 11 insertions(+), 9 deletions(-)
> 
> diff --git a/drivers/net/ethernet/intel/i40e/i40e_debugfs.c b/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
> index 88240571721a..78a7200211b2 100644
> --- a/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
> +++ b/drivers/net/ethernet/intel/i40e/i40e_debugfs.c
> @@ -72,29 +72,31 @@ static ssize_t i40e_dbg_command_read(struct file *filp, char __user *buffer,
>  {
>  	struct i40e_pf *pf = filp->private_data;
>  	int bytes_not_copied;
> -	int buf_size = 256;
>  	char *buf;
>  	int len;
>  
>  	/* don't allow partial reads */
>  	if (*ppos != 0)
>  		return 0;
> -	if (count < buf_size)
> -		return -ENOSPC;
>  
> -	buf = kzalloc(buf_size, GFP_KERNEL);
> +	buf = kasprintf(GFP_KERNEL, "%s: %s\n",
> +			pf->vsi[pf->lan_vsi]->netdev->name,
> +			i40e_dbg_command_buf);
>  	if (!buf)
>  		return -ENOSPC;
>  
> -	len = snprintf(buf, buf_size, "%s: %s\n",
> -		       pf->vsi[pf->lan_vsi]->netdev->name,
> -		       i40e_dbg_command_buf);
> +	len = strlen(buf) + 1;
> +	if (count < len)
> +		bytes_not_copied = -ENOSPC;
> +	else if (copy_to_user(buffer, buf, len))
> +		bytes_not_copied = -EFAULT;
> +	else
> +		bytes_not_copied = 0;
>  
> -	bytes_not_copied = copy_to_user(buffer, buf, len);
>  	kfree(buf);
>  
>  	if (bytes_not_copied)
> -		return -EFAULT;
> +		return bytes_not_copied;
>  
>  	*ppos = len;
>  	return len;

For the code:

Reviewed-by: Alexander Lobakin <aleksander.lobakin@intel.com>

Thanks,
Olek