Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1:18;
Message-ID: <0ba3d469-58af-64d3-514c-6d33c483f8fb@nvidia.com>
Date:   Thu, 5 May 2022 15:10:43 +0530
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101
 Thunderbird/91.9.0
Subject: Re: [PATCH v3 6/8] vfio: Invoke runtime PM API for IOCTL request
Content-Language: en-US
To:     Alex Williamson <alex.williamson@redhat.com>
Cc:     Cornelia Huck <cohuck@redhat.com>,
        Yishai Hadas <yishaih@nvidia.com>,
        Jason Gunthorpe <jgg@nvidia.com>,
        Shameer Kolothum <shameerali.kolothum.thodi@huawei.com>,
        Kevin Tian <kevin.tian@intel.com>,
        "Rafael J . Wysocki" <rafael@kernel.org>,
        Max Gurtovoy <mgurtovoy@nvidia.com>,
        Bjorn Helgaas <bhelgaas@google.com>,
        linux-kernel@vger.kernel.org, kvm@vger.kernel.org,
        linux-pm@vger.kernel.org, linux-pci@vger.kernel.org
References: <20220425092615.10133-1-abhsahu@nvidia.com>
 <20220425092615.10133-7-abhsahu@nvidia.com>
 <20220504134257.1ecb245b.alex.williamson@redhat.com>
From:   Abhishek Sahu <abhsahu@nvidia.com>
In-Reply-To: <20220504134257.1ecb245b.alex.williamson@redhat.com>
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?TDhNV1VEbzVVOEsvS1hZcm1ucXUxbVIyTnFsRStGNGlRUHJJTUk0Yi9OdXVB?=
 =?utf-8?B?ZTMrODBaYXovdXdXUU43M2JMdjU4YTlvMVNid2pGcUY4WXBhRysxMWhodWJi?=
 =?utf-8?B?aVRRM1BnYWNCTGE3MUk3dVExdCtBcGN2VFhuZyt1QTZ1S0h4ZnpkRmtKcDNX?=
 =?utf-8?B?VjZqaGkrVlJtVDNUUGJBQjBrNHpiUGhZQlJoZjM1M2NpQkRqN01OL21lcTJi?=
 =?utf-8?B?U3dVV3R1ODdBUk5CUXVsT2Qza3BZY3ArNGxJT0Z6bXdDMzhZL1YycjNNRVFq?=
 =?utf-8?B?ZDRMU2gvczMvMGIvWUZCaW9velkraXJiUVo1VWh0Ykd0c3lBemdOWXZtanpk?=
 =?utf-8?B?SHU1NktpclVjd284TU9lTzUwRE41V3VDSFBkdWVkUS8xN0p3WlBSRE8vZHFp?=
 =?utf-8?B?V2VrKzZON2Y2TlZMeXc1SDVNWDF5VExPbVVDODJyVnE4cXZBV1JIR054UXVC?=
 =?utf-8?B?QmdCdG1WelVna0k1MEdacm5QTnl5eStKQmdxL3FJZmplaTFvUmRaUzBZellN?=
 =?utf-8?B?d3hwTC9JLzFPQ1lRWjhaaG05aDNKczB6SHNSdmYvcVlNQ0orekQ4clVJRys1?=
 =?utf-8?B?NXdLQjZ2TTEvVGRpY05wbmd0VGNDWlNqUzI0dHpLZ3hZVUw4ZXFta0ZTNlNj?=
 =?utf-8?B?aWJPc0ZvQlhrRXRDUGUwbzRTZGRDWVFzZmVCNmNDMUc2aSs0RXJuYkZQR0Q1?=
 =?utf-8?B?ZCtZVlpVMlpCTTZEeVcwa3ZXVzNwMXFwMmJwSWgwRjNSMVQrQlFCSnh4aC9N?=
 =?utf-8?B?YVlGR3lXSXJKZ0hleExlYzVodk9JbXl5YUp6elA3SXE1dmJTaGc0UFBoL0w0?=
 =?utf-8?B?U01WVVk0YWpCelJRVnRJMXVZeUszNFJnTERMeFJ6akJJdXJxbk5tbWVxYUdN?=
 =?utf-8?B?bTNaQkxFeTFJelM0RDVXZUE0a3lSUzVDdW9MY1BmT0QvZHFHMHYzUlA0dWo1?=
 =?utf-8?B?NGZ2RFZpNXFZYXpKaTc4eHNPb1FiaFVvNTlmL20rUWgrOHNmTkRDYlczbUxa?=
 =?utf-8?B?ZStYOVFLWjJyRndKTWE3bXpFM3ZNaHNjeTBxd3FQTHZXMC9GeTJXVmorcG0x?=
 =?utf-8?B?T1RUUzJFWUZJOXpFRDQyWDRGSkorbjZ3MUdZQk9ycXFoM1lVbXdsUExLTzRm?=
 =?utf-8?B?UDg5WkYwSmNKNUxSMjFtUXI0K242eGp3ZEdyeDBIamVqcUpkR2dpSGpDeEdu?=
 =?utf-8?B?bmpDR0hLeTBoQnZjc1JzVStKTXY5ZkQ2ZE9pUlR1bE45L285SG0zMjRHSW5Q?=
 =?utf-8?B?Q1VxS0JNTG16YW96c0ltWS9wSGU5dVJBRkw5NnhWc2R0N0NPSGlGbFlCa2FY?=
 =?utf-8?B?aUp6TjZ0a2FqT2hXVEVwZU45WnhXcXVMSTJYOHg3R1Z3aEN3ampCME8wbXFJ?=
 =?utf-8?B?MkVjV29nb2g5bkVINkUvSWNYSWN1K3Zzc0RtS2tWQ25EYkUyMUYwS1Q1M2dz?=
 =?utf-8?B?REhxQ002Q0JzUVVWRmxpcEg1Y2RCMDBCUXBTbDduWFpUU25hZGlkMUtUUys4?=
 =?utf-8?B?RkltTThodkx2YWNGSllqTnY3aTFtYTI5VEJXbDZLcWlnRHg3M203aU5OakE5?=
 =?utf-8?B?TFdZMVFaTmZoMm41WkR0MTNZZitLZzhwcE9qaUFHeFp3QlRFZmtHSGY2WStp?=
 =?utf-8?B?TDhhK1hQUElaeFBoT01YMjFhQkQ1ZXZremNrOFBTSGZnc2pCNCtBYzNsd1FJ?=
 =?utf-8?B?MU9tSkJwRW5JOTBZZ1BmTVNSYjFRdVBOSXVPWkdMTzRPN000YUZIWXFUeFlp?=
 =?utf-8?B?MWYvSlBTZ3RIUGxjRFlqMGc1SmhjVC9pMzVtb1o0TmM1VmUrMjJrRHY5WG54?=
 =?utf-8?B?RTZQTjgwN204TkNwN3d1djBZSFBVOVNDNDdPWVFvdFhRejBpbmYzb3hTT2Zk?=
 =?utf-8?B?MmNWdnNyNldmWXNjdHQ4amg1Q2Y3YTBIZnFTNjhwaGZPRmlnb1lNbnVsVVdu?=
 =?utf-8?B?ekIvMk8vSTdrN2RuaWNqM1VyY2NWbGNYMFJ3cE1YL1djQWhNQkJ2SjRSdGVm?=
 =?utf-8?B?WjduUHJuOXFLNFB6b081SHRibTFCOXRsVnc5NE40dW8vbkRWdHlSTnRRcnY5?=
 =?utf-8?B?UnNjeDJ1SVdCeEN6dG02RUZOdWRqNXpwMk9wazVvNmdXU2t5WTZGYm1tMGNG?=
 =?utf-8?B?ckVPS0w3a1lFUERaSkNwc0hQNVdvODh4OFBtOVNyOXpzaGtZL3NGUmVUSHZv?=
 =?utf-8?B?bDlGeVlWTjBvSHRwWG9YWDhzTFdrTCtzMFVBeUpoczRmaXhFVU9tTFVybENv?=
 =?utf-8?B?QUhCL2xPWXRSSkw1akRMRndqYkdoM0V0L0FEeUJOeVMrV0FCUDlsSzd6U1BC?=
 =?utf-8?B?ak1GU2oyK29LbVUyL2RZOUh4Y1J0QTBFN1FXbkk0UGxKN1Awbm9iZz09?=
X-OriginatorOrg: Nvidia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 419c216e-f2c9-4b8c-e84d-08da2e7b5a84
X-MS-Exchange-CrossTenant-AuthSource: BL1PR12MB5304.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 May 2022 09:40:56.4611
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: MNsCFocP3oSm8wNRr1qP9Fgf4afmMfSRoJQkdm37VMmhGmDP2S7k7suXZRZhr5Fm5bnH9c2Rw3X6sGKNoEJVOg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR12MB1245
X-Spam-Status: No, score=-4.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
	DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,NICE_REPLY_A,RDNS_NONE,SPF_HELO_NONE,
	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
	lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On 5/5/2022 1:12 AM, Alex Williamson wrote:
> On Mon, 25 Apr 2022 14:56:13 +0530
> Abhishek Sahu <abhsahu@nvidia.com> wrote:
> 
>> The vfio/pci driver will have runtime power management support where the
>> user can put the device low power state and then PCI devices can go into
>> the D3cold state. If the device is in low power state and user issues any
>> IOCTL, then the device should be moved out of low power state first. Once
>> the IOCTL is serviced, then it can go into low power state again. The
>> runtime PM framework manages this with help of usage count. One option
>> was to add the runtime PM related API's inside vfio/pci driver but some
>> IOCTL (like VFIO_DEVICE_FEATURE) can follow a different path and more
>> IOCTL can be added in the future. Also, the runtime PM will be
>> added for vfio/pci based drivers variant currently but the other vfio
>> based drivers can use the same in the future. So, this patch adds the
>> runtime calls runtime related API in the top level IOCTL function itself.
>>
>> For the vfio drivers which do not have runtime power management support
>> currently, the runtime PM API's won't be invoked. Only for vfio/pci
>> based drivers currently, the runtime PM API's will be invoked to increment
>> and decrement the usage count. Taking this usage count incremented while
>> servicing IOCTL will make sure that user won't put the device into low
>> power state when any other IOCTL is being serviced in parallel.
>>
>> Signed-off-by: Abhishek Sahu <abhsahu@nvidia.com>
>> ---
>>  drivers/vfio/vfio.c | 44 +++++++++++++++++++++++++++++++++++++++++---
>>  1 file changed, 41 insertions(+), 3 deletions(-)
>>
>> diff --git a/drivers/vfio/vfio.c b/drivers/vfio/vfio.c
>> index a4555014bd1e..4e65a127744e 100644
>> --- a/drivers/vfio/vfio.c
>> +++ b/drivers/vfio/vfio.c
>> @@ -32,6 +32,7 @@
>>  #include <linux/vfio.h>
>>  #include <linux/wait.h>
>>  #include <linux/sched/signal.h>
>> +#include <linux/pm_runtime.h>
>>  #include "vfio.h"
>>  
>>  #define DRIVER_VERSION	"0.3"
>> @@ -1536,6 +1537,30 @@ static const struct file_operations vfio_group_fops = {
>>  	.release	= vfio_group_fops_release,
>>  };
>>  
>> +/*
>> + * Wrapper around pm_runtime_resume_and_get().
>> + * Return 0, if driver power management callbacks are not present i.e. the driver is not
> 
> Mind the gratuitous long comment line here.
> 
 
 Thanks Alex.
 
 That was a miss. I will fix this.
 
>> + * using runtime power management.
>> + * Return 1 upon success, otherwise -errno
> 
> Changing semantics vs the thing we're wrapping, why not provide a
> wrapper for the `put` as well to avoid?  The only cases where we return
> zero are just as easy to detect on the other side.
> 

 Yes. Using wrapper function for put is better option.
 I will make the changes.

>> + */
>> +static inline int vfio_device_pm_runtime_get(struct device *dev)
> 
> Given some of Jason's recent series, this should probably just accept a
> vfio_device.
> 

 Sorry. I didn't get this part.

 Do I need to change it to

 static inline int vfio_device_pm_runtime_get(struct vfio_device *device)
 {
    struct device *dev = device->dev;
    ...
 }

>> +{
>> +#ifdef CONFIG_PM
>> +	int ret;
>> +
>> +	if (!dev->driver || !dev->driver->pm)
>> +		return 0;
>> +
>> +	ret = pm_runtime_resume_and_get(dev);
>> +	if (ret < 0)
>> +		return ret;
>> +
>> +	return 1;
>> +#else
>> +	return 0;
>> +#endif
>> +}
>> +
>>  /*
>>   * VFIO Device fd
>>   */
>> @@ -1845,15 +1870,28 @@ static long vfio_device_fops_unl_ioctl(struct file *filep,
>>  				       unsigned int cmd, unsigned long arg)
>>  {
>>  	struct vfio_device *device = filep->private_data;
>> +	int pm_ret, ret = 0;
>> +
>> +	pm_ret = vfio_device_pm_runtime_get(device->dev);
>> +	if (pm_ret < 0)
>> +		return pm_ret;
> 
> I wonder if we might simply want to mask pm errors behind -EIO, maybe
> with a rate limited dev_info().  My concern would be that we might mask
> errnos that userspace has come to expect for certain ioctls.  Thanks,
> 
> Alex
> 

  I need to do something like following. Correct ?

  ret = vfio_device_pm_runtime_get(device);
  if (ret < 0) {
     dev_info_ratelimited(device->dev, "vfio: runtime resume failed %d\n", ret);
     return -EIO;
  }
  
  Regards,
  Abhishek
 
>>  
>>  	switch (cmd) {
>>  	case VFIO_DEVICE_FEATURE:
>> -		return vfio_ioctl_device_feature(device, (void __user *)arg);
>> +		ret = vfio_ioctl_device_feature(device, (void __user *)arg);
>> +		break;
>>  	default:
>>  		if (unlikely(!device->ops->ioctl))
>> -			return -EINVAL;
>> -		return device->ops->ioctl(device, cmd, arg);
>> +			ret = -EINVAL;
>> +		else
>> +			ret = device->ops->ioctl(device, cmd, arg);
>> +		break;
>>  	}
>> +
>> +	if (pm_ret)
>> +		pm_runtime_put(device->dev);
>> +
>> +	return ret;
>>  }
>>  
>>  static ssize_t vfio_device_fops_read(struct file *filep, char __user *buf,
>