Received-SPF: pass (google.com: domain of linux-kernel+bounces-90210-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
Message-ID: <5c20140a-79e8-4d0a-899a-d4ec5c9def42@oracle.com>
Date: Mon, 4 Mar 2024 08:34:52 +0000
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH v3 1/7] ata: libata-sata: Factor out NCQ Priority
 configuration helpers
Content-Language: en-US
To: Igor Pylypiv <ipylypiv@google.com>, Damien Le Moal <dlemoal@kernel.org>,
        Niklas Cassel <cassel@kernel.org>, Jason Yan <yanaijie@huawei.com>,
        "James E.J. Bottomley" <jejb@linux.ibm.com>,
        "Martin K. Petersen" <martin.petersen@oracle.com>,
        Jack Wang <jinpu.wang@cloud.ionos.com>, Hannes Reinecke <hare@suse.de>,
        Xiang Chen <chenxiang66@hisilicon.com>,
        Artur Paszkiewicz <artur.paszkiewicz@intel.com>,
        Bart Van Assche <bvanassche@acm.org>
Cc: TJ Adams <tadamsjr@google.com>, linux-ide@vger.kernel.org,
        linux-scsi@vger.kernel.org, linux-kernel@vger.kernel.org
References: <20240302201636.1228331-1-ipylypiv@google.com>
 <20240302201636.1228331-2-ipylypiv@google.com>
From: John Garry <john.g.garry@oracle.com>
Organization: Oracle Corporation
In-Reply-To: <20240302201636.1228331-2-ipylypiv@google.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
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?OGwyMUhPQ3dwVWl5RzMrM0xIQXBSY2ZTR1U1YnlSdndkSis5R295Wmk4dDZi?=
 =?utf-8?B?N2pXOEtxOUhDY2p0V0JjeUtUaG1QMmh4b21YT2JOTmpiY24wNG9CZjY5MlMr?=
 =?utf-8?B?UGV0a25QV0RNMTYxUy9LTkZMWFN0blFqT3FRTVJPb0tRL1kyUTdMQWgrT1gv?=
 =?utf-8?B?THB3YVZ4YmdIcmEzOTFBUXBFeTAxQjVJbUllTlhuN25JaEZXeDBLYjRWS21t?=
 =?utf-8?B?Z05aeEtNZ0VyVGhlUTN1dGJPS3BVQmlSVHZSZFByTmdwcEJzUlhXYllyU2RQ?=
 =?utf-8?B?RHhEbktGM3NVVHRPSzlTNXNpZHdSTmxZbU1LYVZwZlRyZksyY1VtUDZzRzZ3?=
 =?utf-8?B?Mk9uWTJQaXNCSHl4V0p5ZWZzMWNVTlpwbXVEeXhNMTFXc1B5bmZOcVE1azJm?=
 =?utf-8?B?cVJiUVNPY3B3OFJ0RHd3R0s5WTVzMGpnVDgwV2s4c3Y2Z0hKUE01QjdVQ3Js?=
 =?utf-8?B?dGdCNGpiYWZtTDlHbmsxR20yeDFTU3lPTlIzNWt1WUhjUXcwSWExQUhNZWFn?=
 =?utf-8?B?Z0prNldWNW5TNTdGOGFLc3YxcVZiSDNILzZDSVAxM0R5WEtSSzRrOVFsZGlu?=
 =?utf-8?B?MFB0MmI1cURsc1RnbW9vUU1NNlJuTHJNYlUrNzhkMGpHOEFlT1dheFRkZEpt?=
 =?utf-8?B?UWlkOWVxdkVIS3pOQ2tsb3lISmY5cnZSWXFJbW8vN0IwakpUd3RQUG9NQkZF?=
 =?utf-8?B?MUhZUjVSWlZjSnVGNVNIOWlvM21aRW5qc0pNMkowcWsycjNEcndVV051Ynhv?=
 =?utf-8?B?dXNWNE9DVDgwZ1BoL0pGSThJTGVHVHpQYnVlWTFhM1Q1bkJ0S21mMTUzT2Vm?=
 =?utf-8?B?Yk5Nc0RJQjhXUTlHZHlDWUxZYnZhNUtWdFZJRjZFcEpSZjh5SzIwQXNlNnYz?=
 =?utf-8?B?WnRyRDQwdzZwZ0ZobTRMNER1Tmx1cHoyQjlQVWhvNUZRUHdvVnIvM1NGY1RU?=
 =?utf-8?B?RTJxY1VaYkxVS00vcEU0R2wvWWpTWjVSbExGUEFvTTFRYmp1clg3Q0tNM25m?=
 =?utf-8?B?TzJNKzNXRmMrRHowTGJGMi9kMis5VFowM3M3dk1kNFBaTmZoN3V2VTliMFc4?=
 =?utf-8?B?YzBTSHVaT2YwZGNrMmFjQVVYbnZKSEJyZWV4N0c2eUFoRGozaTIxb3puZzd3?=
 =?utf-8?B?Q0w3em92eWFkMUFtME5qS0RnY2xuOHBoVXgwOVorWExObWJYc2hmYWpTdUgy?=
 =?utf-8?B?S0M4NktuRXhPSllaYTY0anBCZVlTZDlYM241c1Vsbnk0RjBjTXZKU2x1TGxP?=
 =?utf-8?B?UWtrbVRjYTVGV0NZblFoZFZ2bjJHU2N0VTNlcXVmVDAvNk9xb0FEZmNOWE1o?=
 =?utf-8?B?TXhCRkZVT2JCQVJLZHVybEZRN3ltVjRvZ3h0SklpOFBjSHRzOW1kWnh1RC9I?=
 =?utf-8?B?ZmM5cUtvaXVUTmM3NHAzejhOdkM2Tk1FeDdFSjV2S2VXVk9xYzljR3pFQi9J?=
 =?utf-8?B?ZGpsMGhxc1RsSyszSFk4NWFPdkxWUWhDTkQ4enoxOHR6Zng4T0dZcFYzYkMx?=
 =?utf-8?B?YkE1bmRGbVFka1k5WWtzanV4UzdlNGZjWEQ0dmt4cG9oNWlaZ0RiclBqNm1N?=
 =?utf-8?B?Lytja05qV01Ud1JkOXZXdTE1VGcvRHJBRlpiTUp5bU1CcWJGZ01KcmdGQXpO?=
 =?utf-8?B?b3JuejRjRndWMTd4UzlFNzZELytXbkpFZUkyUUQ2aEpFSy9CdFVLYVdjMjE0?=
 =?utf-8?B?MThYbTQyTk96MEw3QVBMMldOeG43RVZpSkVIQzQ4c3JXNDg2NTYzRHMvZUU4?=
 =?utf-8?B?STdpNFNvbXFlZUlLZFc4ZWVBck1VSStrZHUrUXlYQTVzZzIxYzI2cXBiMXlr?=
 =?utf-8?B?a1FVcURRVXF6d3RBaUdVUHBXWFFzNERpcDhsWjZNQitJbXExcHRobG5WZ0Nl?=
 =?utf-8?B?cWQrSVNlaFBUN0tLeUVNZnptVlRRQ3NndGNvQXRIZDZxaEpYSE54UXE2bFZP?=
 =?utf-8?B?N2pjWFRoYnppbFYwUjMydWJ4QkcxUkgvVGF3a09aeFQyc2NldExLYzdzNkxn?=
 =?utf-8?B?WFdDNzlrYStqZ1h1eGMzdHVRQVJxOEtzaFN3dHluZHR2QWU5MFB2UHZxZlp1?=
 =?utf-8?B?OE9ETENQbm04RmZyTXBtTWV1L251YWhDc0hRNVdoZmhBQ3ZmNlhTdnVjUWJw?=
 =?utf-8?B?dVh2am9HQVR3cGFXN3hUL2pLMFVJZW1FOHNDdnlXMkhUU044YjhIanRxS2dH?=
 =?utf-8?B?NFE9PQ==?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: 
	P1FsmgqssR/hRq1/FSkk2PPQCCxA+BJhjsBUHg9DBV5QKdR+XlYsRt40uRLG4KBvIWFXcWK7WG7U33ianGtTTdgixkEpEVSBIz/QAKn0yyaTxsYIyoQ1XsXxh3W6Xn7zZnLmLQ9fcsiXADPu02RA63JBzi1HBQbje8k9DNPspV8ZoXKOyC/lTuzaDruXXwO3tWDkpEw1WycDVfRw/t1UMWTYrCavFh6F8zlTxTfRHmg4KJluR/KhDo2CnLlenKf13UmOUywNKuwFA9LTE6QGJ51NLaAB6ffdEE/KP5IXEcse2kThmOCDp10H/PiJVokjtnF7pgjy1oyC1RzMWxrrrkx2B5Z2a9EDSwmiYu+1dvuZ+gE2PbtvYtTlQCl0m08TUjUmCLrXsXU5Ir+lzmuufkmkahmEuBHAM71JJ7LKpm2XJN7sRjZvEXd/qaSuGwjxIqWseVLztffrWAIdobeGSSjppptaCYX3QXeak4CDmnIPRukdx66hZdhMVASexezImssFVCzVi9TXulzUdqqOzLowCNWF53CVZqkrA6AdBVFFIUAsG+TXh/ABd6ea99WiWuDmzveCCQNjUCdsKMk+bou2wmnvHv5TBTMcJkEX47o=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: c6cedaa7-327e-4295-acd0-08dc3c25f8d8
X-MS-Exchange-CrossTenant-AuthSource: DM6PR10MB4313.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 Mar 2024 08:34:56.8098
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: tPl12xDEY1AMCXAlxbEVg5DRAia4hxWipnK+XAfVMfN0MiMrjzQ6OGeZr5+jgpIesH4SCKo0Yv/N2WmTKW1ALQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY5PR10MB6166
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.272,Aquarius:18.0.1011,Hydra:6.0.619,FMLib:17.11.176.26
 definitions=2024-03-04_04,2024-03-01_03,2023-05-22_02
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 adultscore=0 mlxlogscore=999
 spamscore=0 phishscore=0 mlxscore=0 malwarescore=0 bulkscore=0
 suspectscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2311290000 definitions=main-2403040064
X-Proofpoint-GUID: Sp1Fquwo1puRL-fVq2CkOurr8VmHeQUK
X-Proofpoint-ORIG-GUID: Sp1Fquwo1puRL-fVq2CkOurr8VmHeQUK

On 02/03/2024 20:16, Igor Pylypiv wrote:
> Export libata NCQ Priority configuration helpers to be reused
> for libsas managed SATA devices.
> 
> Signed-off-by: Igor Pylypiv <ipylypiv@google.com>

This looks ok. Some small code comments below, though.

> ---
>   drivers/ata/libata-sata.c | 139 +++++++++++++++++++++++++++-----------
>   include/linux/libata.h    |   4 ++
>   2 files changed, 103 insertions(+), 40 deletions(-)
> 
> diff --git a/drivers/ata/libata-sata.c b/drivers/ata/libata-sata.c
> index 0fb1934875f2..a8d5e36d5211 100644
> --- a/drivers/ata/libata-sata.c
> +++ b/drivers/ata/libata-sata.c
> @@ -848,29 +848,73 @@ DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
>   	    ata_scsi_lpm_show, ata_scsi_lpm_store);
>   EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
>   
> +/**
> + *	ata_ncq_prio_supported - Check if device supports NCQ Priority
> + *	@ap: ATA port of the target device
> + *	@sdev: SCSI device
> + *
> + *	Helper to check if device supports NCQ Priority feature,
> + *	usable with both libsas and libata.
> + */
> +int ata_ncq_prio_supported(struct ata_port *ap, struct scsi_device *sdev)
> +{
> +	struct ata_device *dev;
> +	unsigned long flags;
> +	int rc;
> +
> +	spin_lock_irqsave(ap->lock, flags);
> +	dev = ata_scsi_find_dev(ap, sdev);
> +	if (!dev)
> +		rc = -ENODEV;
> +	else
> +		rc = !!(dev->flags & ATA_DFLAG_NCQ_PRIO);
> +	spin_unlock_irqrestore(ap->lock, flags);
> +	return rc;
> +}

I'm not the biggest fan of functions which effectively return both a 
boolean and an error code.

I like this patten more:

int ata_ncq_prio_supported(struct ata_port *ap, struct scsi_device 
*sdev, bool *supported)
{
	...
	if (rc)
		return rc;
	*supported = true/false.
	return 0;
}

No big deal, though.

> +EXPORT_SYMBOL_GPL(ata_ncq_prio_supported);
> +
>   static ssize_t ata_ncq_prio_supported_show(struct device *device,
>   					   struct device_attribute *attr,
>   					   char *buf)
>   {
>   	struct scsi_device *sdev = to_scsi_device(device);
>   	struct ata_port *ap = ata_shost_to_port(sdev->host);
> +	int rc;
> +
> +	rc = ata_ncq_prio_supported(ap, sdev);
> +	if (rc < 0)
> +		return rc;
> +
> +	return sysfs_emit(buf, "%d\n", rc);
> +}
> +
> +DEVICE_ATTR(ncq_prio_supported, S_IRUGO, ata_ncq_prio_supported_show, NULL);
> +EXPORT_SYMBOL_GPL(dev_attr_ncq_prio_supported);
> +
> +/**
> + *	ata_ncq_prio_enabled - Check if NCQ Priority is enabled
> + *	@ap: ATA port of the target device
> + *	@sdev: SCSI device
> + *
> + *	Helper to check if NCQ Priority feature is enabled,
> + *	usable with both libsas and libata.

It's usable by anything which uses libata, really. For the moment that 
is libsas and libata.

> + */
> +int ata_ncq_prio_enabled(struct ata_port *ap, struct scsi_device *sdev)
> +{
>   	struct ata_device *dev;
> -	bool ncq_prio_supported;
> -	int rc = 0;
> +	unsigned long flags;
> +	int rc;
>   
> -	spin_lock_irq(ap->lock);
> +	spin_lock_irqsave(ap->lock, flags);
>   	dev = ata_scsi_find_dev(ap, sdev);
>   	if (!dev)
>   		rc = -ENODEV;
>   	else
> -		ncq_prio_supported = dev->flags & ATA_DFLAG_NCQ_PRIO;
> -	spin_unlock_irq(ap->lock);
> -
> -	return rc ? rc : sysfs_emit(buf, "%u\n", ncq_prio_supported);
> +		rc = !!(dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLED);
> +	spin_unlock_irqrestore(ap->lock, flags);
> +	return rc;
>   }
> -
> -DEVICE_ATTR(ncq_prio_supported, S_IRUGO, ata_ncq_prio_supported_show, NULL);
> -EXPORT_SYMBOL_GPL(dev_attr_ncq_prio_supported);
> +EXPORT_SYMBOL_GPL(ata_ncq_prio_enabled);
>   
>   static ssize_t ata_ncq_prio_enable_show(struct device *device,
>   					struct device_attribute *attr,
> @@ -878,50 +922,45 @@ static ssize_t ata_ncq_prio_enable_show(struct device *device,
>   {
>   	struct scsi_device *sdev = to_scsi_device(device);
>   	struct ata_port *ap = ata_shost_to_port(sdev->host);
> -	struct ata_device *dev;
> -	bool ncq_prio_enable;
> -	int rc = 0;
> +	int rc;
>   
> -	spin_lock_irq(ap->lock);
> -	dev = ata_scsi_find_dev(ap, sdev);
> -	if (!dev)
> -		rc = -ENODEV;
> -	else
> -		ncq_prio_enable = dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLED;
> -	spin_unlock_irq(ap->lock);
> +	rc = ata_ncq_prio_enabled(ap, sdev);
> +	if (rc < 0)
> +		return rc;
>   
> -	return rc ? rc : sysfs_emit(buf, "%u\n", ncq_prio_enable);
> +	return sysfs_emit(buf, "%d\n", rc);
>   }
>   
> -static ssize_t ata_ncq_prio_enable_store(struct device *device,
> -					 struct device_attribute *attr,
> -					 const char *buf, size_t len)
> +/**
> + *	ata_ncq_prio_enable - Enable/disable NCQ Priority
> + *	@ap: ATA port of the target device
> + *	@sdev: SCSI device
> + *	@enable: true - enable NCQ Priority, false - disable NCQ Priority
> + *
> + *	Helper to enable/disable NCQ Priority feature, usable with both
> + *	libsas and libata.
> + */
> +int ata_ncq_prio_enable(struct ata_port *ap, struct scsi_device *sdev,
> +			bool enable)
>   {
> -	struct scsi_device *sdev = to_scsi_device(device);
> -	struct ata_port *ap;
>   	struct ata_device *dev;
> -	long int input;
> +	unsigned long flags;
>   	int rc = 0;
>   
> -	rc = kstrtol(buf, 10, &input);
> -	if (rc)
> -		return rc;
> -	if ((input < 0) || (input > 1))
> -		return -EINVAL;
> +	spin_lock_irqsave(ap->lock, flags);
>   
> -	ap = ata_shost_to_port(sdev->host);
>   	dev = ata_scsi_find_dev(ap, sdev);
> -	if (unlikely(!dev))
> -		return  -ENODEV;
> -
> -	spin_lock_irq(ap->lock);
> +	if (unlikely(!dev)) {

no need for unlikely() - this is not fathpath

> +		rc = -ENODEV;
> +		goto unlock;
> +	}
>   
>   	if (!(dev->flags & ATA_DFLAG_NCQ_PRIO)) {
>   		rc = -EINVAL;
>   		goto unlock;