From:   "Tian, Kevin" <kevin.tian@intel.com>
To:     "Liu, Yi L" <yi.l.liu@intel.com>,
        "joro@8bytes.org" <joro@8bytes.org>,
        "alex.williamson@redhat.com" <alex.williamson@redhat.com>,
        "jgg@nvidia.com" <jgg@nvidia.com>,
        "robin.murphy@arm.com" <robin.murphy@arm.com>
CC:     "cohuck@redhat.com" <cohuck@redhat.com>,
        "eric.auger@redhat.com" <eric.auger@redhat.com>,
        "nicolinc@nvidia.com" <nicolinc@nvidia.com>,
        "kvm@vger.kernel.org" <kvm@vger.kernel.org>,
        "mjrosato@linux.ibm.com" <mjrosato@linux.ibm.com>,
        "chao.p.peng@linux.intel.com" <chao.p.peng@linux.intel.com>,
        "yi.y.sun@linux.intel.com" <yi.y.sun@linux.intel.com>,
        "peterx@redhat.com" <peterx@redhat.com>,
        "jasowang@redhat.com" <jasowang@redhat.com>,
        "shameerali.kolothum.thodi@huawei.com" 
        <shameerali.kolothum.thodi@huawei.com>,
        "lulu@redhat.com" <lulu@redhat.com>,
        "suravee.suthikulpanit@amd.com" <suravee.suthikulpanit@amd.com>,
        "iommu@lists.linux.dev" <iommu@lists.linux.dev>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        "linux-kselftest@vger.kernel.org" <linux-kselftest@vger.kernel.org>,
        "baolu.lu@linux.intel.com" <baolu.lu@linux.intel.com>
Subject: RE: [PATCH 3/6] iommufd: Add IOMMU_DEVICE_GET_INFO
Thread-Topic: [PATCH 3/6] iommufd: Add IOMMU_DEVICE_GET_INFO
Thread-Index: AQHZPD1Z97vAUws+KUSa8kZdlVER8q7Hy2Ow
Date:   Fri, 10 Feb 2023 07:55:42 +0000
Message-ID: <BN9PR11MB5276F92ABD5998FDD74D510A8CDE9@BN9PR11MB5276.namprd11.prod.outlook.com>
References: <20230209041642.9346-1-yi.l.liu@intel.com>
 <20230209041642.9346-4-yi.l.liu@intel.com>
In-Reply-To: <20230209041642.9346-4-yi.l.liu@intel.com>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-antispam-messagedata-chunkcount: 1
x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?kdyItfkweaZl6OdfDg1hId3yPXecElYSc2hK3+Sl2kXJVBPDUY6NeN3aFrb9?=
 =?us-ascii?Q?Ig2+btCjiXiS1sEUfBGJDXGRc3qUsooU0BN96zeMZPOb8lot/Y95/4SIXAdI?=
 =?us-ascii?Q?2OVzYTArlfS7K4/vBLNxtJc60UFshyEdQami33Z6l9NElxYg7ncBPlA74xKa?=
 =?us-ascii?Q?gbWtCKbA3U3GhsgSPmEgcmhGQFvfDIqWHhCP+arPXLB0Z47Y2+sjpA4xUyUR?=
 =?us-ascii?Q?vWsfOgrBBqM5In2sFP0jlh8N6UFsVtEZSN5JPgQo71CzzaOEQidflHBT4YnG?=
 =?us-ascii?Q?LZDhJR70bybAjYl+kC1Y52rUj3Orjjm8dLKzcCrmafExkSdPSEHdKcpswy3i?=
 =?us-ascii?Q?vdfAO0Ai+Jukcuwoc9hGhFv1flfdelYDgrQWtBYCpoMHn+Br+Dil1XFWyAaH?=
 =?us-ascii?Q?mcgB3DxaoPh8nDMECly0G0/c8N7+T9l5CuPv1jCeCuER2fnQoCCWdDIhpu0M?=
 =?us-ascii?Q?xbOkOBc/fam5TteF4FgMupf0DHdGW+neamJMN/LojQJuwDGb97D504FEhJjv?=
 =?us-ascii?Q?RPpgtpmstuFuqAzzBEma0lKMj+Xwq8JLStDl1mr2oQ4RIgzv96EcC7HD/Yst?=
 =?us-ascii?Q?nRQKwZoUWTg17CFUsxKJJwot8zA2DjOqV4SxfqY9NVGGcZQa1MtWzHilPZY1?=
 =?us-ascii?Q?R6Kykh9adxxyxiJhAD51n9ZgG+rLnH4uyH0c1nKU4339CP9YAIe6dEo0oRhO?=
 =?us-ascii?Q?zX/3fWTjCHORs1gp7TRjwnOQPpSqCmaRe75gC1nvn8I+n3KW9b1Pl1zrSv9Z?=
 =?us-ascii?Q?LB8/xAIdxIjBM0tQMqgQ1zIOi3DCVLbuLhKNsR28nzrwPyvaYoDVGxBZhVpS?=
 =?us-ascii?Q?H1SU8zpbssdpU3cYkEc+yVGyuoku0MH0YMfldr11lZMekoMa4EuoT+MGKZNX?=
 =?us-ascii?Q?J24r3ficGPOCL0Avft2TTjZWlRvdZ2NZL8rNbflpCGZPfIDGRcMPdDUpdmt+?=
 =?us-ascii?Q?uewFexx2cNvQIe63I/ISw3RuwPUrJH5g6KjuEhTbI8iJOm1zpR1GU8ZryiC+?=
 =?us-ascii?Q?eRy1rihXbiA0k0gMPUGAjiFSXwygOzNZIthDsjY3KAPmmAIw7e/TI6NToRpG?=
 =?us-ascii?Q?mhUulb1l+C8IvWQIlZ7kCAg6Z6PH4GhL5UF0K2ycDm9RBMYQPRj5vrySG4Z7?=
 =?us-ascii?Q?MPmN8jot82weSGYzTsrGQsfcGhG+sEBAMjPtTpDPKuUfzd3QMpUh2RPen0m0?=
 =?us-ascii?Q?gnWOU0bSc1tY1F0e5cKhaxguYfMeircfnXF7ymFl+mNQ21oPe/su8oc5j2Tc?=
 =?us-ascii?Q?UERwkmke0KDybr8e/K4qLDcm1cBt6cwIylJB6cRKE8gskpzZeQ9zPyKlh0iw?=
 =?us-ascii?Q?YXhRm7WkhTHFXgoD7pkzbQ1pMGoihHKb0ojvAUUI5DGycIlc6lOSnOXeLIxe?=
 =?us-ascii?Q?OUasc0ZTYvKE9SrWYagDlIAoe1idPtVW2Uzlvd5qWdJBnBYA53sySRDB0zXC?=
 =?us-ascii?Q?jCl3He/kCC3pniOSYgB2mUhaeBb5oNWGy1acn2BEHKLZP06omE+rIu2WeYvS?=
 =?us-ascii?Q?3KT3bC8yDCfqv4/JQTuiYR/fk6U/S5j0oc2L3awE/Xf0n0NL21qkjxiA7VIg?=
 =?us-ascii?Q?6m2WSKSOP+n9GVjnJHHhECC6Vq6cKRN/oZLccHVS?=
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: BN9PR11MB5276.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 121589e3-7730-478f-3067-08db0b3c3534
X-MS-Exchange-CrossTenant-originalarrivaltime: 10 Feb 2023 07:55:42.1300
 (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: hchj8c2G1qFwjMxVqOCDsUPsn5W2iXQP3XosL+yMF/ulMI6wTh8bzT1pAQ8Iahd60LoACzHVl07eo7xd6P/c9A==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY5PR11MB6413
X-OriginatorOrg: intel.com
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

> From: Liu, Yi L <yi.l.liu@intel.com>
> Sent: Thursday, February 9, 2023 12:17 PM
>=20
> +int iommufd_device_get_info(struct iommufd_ucmd *ucmd)
> +{
> +	struct iommu_device_info *cmd =3D ucmd->cmd;
> +	struct iommufd_object *dev_obj;
> +	struct device *dev;
> +	const struct iommu_ops *ops;
> +	void *data;
> +	unsigned int length, data_len;
> +	int rc;
> +
> +	if (cmd->flags || cmd->__reserved || !cmd->data_len)
> +		return -EOPNOTSUPP;

do we want !cmd->data_len being a way to check how many bytes are
required in a following call to get the vendor info?

> +
> +	/*
> +	 * Zero the trailing bytes for userspace if the buffer is bigger
> +	 * than the data size kernel actually has.
> +	 */

"Zero the trailing bytes if the user buffer ..."

> +
> +/**
> + * struct iommu_device_info - ioctl(IOMMU_DEVICE_GET_INFO)
> + * @size: sizeof(struct iommu_device_info)
> + * @flags: Must be 0
> + * @dev_id: The device being attached to the IOMMU

iommufd

> + * @data_len: Input the type specific data buffer length in bytes

also is an output field

> + *
> + * Query the hardware iommu capability for given device which has been
> + * bound to iommufd. @data_len is set to be the size of the buffer to
> + * type specific data and the data will be filled. Trailing bytes are

"@data_len is the size of the buffer which captures iommu type specific dat=
a"

> + * zeroed if the user buffer is larger than the data kernel has.
> + *
> + * The type specific data would be used to sync capability between the
> + * vIOMMU and the hardware IOMMU, also for the availabillity checking of
> + * iommu hardware features like dirty page tracking in I/O page table.

It's fine to report format information related to stage-1 page table
which userspace manages.

but IMHO this should not be an interface to report which capability is
supported by iommufd. Having hardware supporting dirty bit=20
doesn't mean the underlying iommu driver provides necessary support
to iommufd dirty tracking.

We either don't state this way if following what this series does which
simply dumps all raw iommu hw info to userspace, or explicitly require
iommu driver to only report information as required when a feature
is supported by iommufd.

> + *
> + * The @out_device_type will be filled if the ioctl succeeds. It would

s/will be/is/

> + * be used to decode the data filled in the buffer pointed by @data_ptr.

s/would be/is/

> + */
> +struct iommu_device_info {
> +	__u32 size;
> +	__u32 flags;
> +	__u32 dev_id;
> +	__u32 data_len;
> +	__aligned_u64 data_ptr;

moving forward iommu hw cap is not the only information reported
via this interface, e.g. it can be also used to report pasid mode.

from this angle it's better to rename above two fields to be iommu
specific, e.g.:

	__u32 iommu_data_len;
	__aligned_u64 iommu_data_ptr;

> +	__u32 out_device_type;
> +	__u32 __reserved;
> +};
> +#define IOMMU_DEVICE_GET_INFO _IO(IOMMUFD_TYPE,
> IOMMUFD_CMD_DEVICE_GET_INFO)
>  #endif
> --
> 2.34.1