Existing VFIO provides group-centric user APIs for userspace. Userspace opens the /dev/vfio/$group_id first before getting device fd and hence getting access to device. This is not the desired model for iommufd. Per the conclusion of community discussion[1], iommufd provides device-centric kAPIs and requires its consumer (like VFIO) to be device-centric user APIs. Such user APIs are used to associate device with iommufd and also the I/O address spaces managed by the iommufd. This series first introduces a per device file structure to be prepared for further enhancement and refactors the kvm-vfio code to be prepared for accepting device file from userspace. After this, adds a mechanism for blocking device access before iommufd bind. Then refactors the vfio to be able to handle cdev paths (e.g. iommufd binding, no-iommufd, [de]attach ioas). This refactor includes making the device_open exclusive between the group and the cdev path, only allow single device open in cdev path; vfio-iommufd code is also refactored to support cdev. e.g. split the vfio_iommufd_bind() into two steps. Eventually, adds the cdev support for vfio device and the new ioctls, then makes group infrastructure optional as it is not needed when vfio device cdev is compiled. This series is based on some preparation works done to vfio emulated devices[2] and vfio pci hot reset enhancements[3]. Per discussion[4], this series does not support cdev for physical devices that do not have IOMMU. Such devices only have group-centric user APIs. This series is a prerequisite for iommu nesting for vfio device[5] [6]. The complete code can be found in below branch, simple tests done to the legacy group path and the cdev path. QEMU changes are in upstreaming[7] and the complete code can be found at[8] https://github.com/yiliu1765/iommufd/tree/vfio_device_cdev_v15 (config CONFIG_IOMMUFD=y CONFIG_VFIO_DEVICE_CDEV=y) base-commit: fdf0eaf11452d72945af31804e2a1048ee1b574c [1] https://lore.kernel.org/kvm/BN9PR11MB5433B1E4AE5B0480369F97178C189@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/ [2] https://lore.kernel.org/kvm/20230327093351.44505-1-yi.l.liu@xxxxxxxxx/ - merged [3] https://lore.kernel.org/kvm/20230718105542.4138-1-yi.l.liu@xxxxxxxxx/ [4] https://lore.kernel.org/kvm/20230525095939.37ddb8ce.alex.williamson@xxxxxxxxxx/ [5] https://lore.kernel.org/linux-iommu/20230511143844.22693-1-yi.l.liu@xxxxxxxxx/ [6] https://lore.kernel.org/linux-iommu/20230511145110.27707-1-yi.l.liu@xxxxxxxxx/#t [7] https://lore.kernel.org/qemu-devel/20230712072528.275577-1-zhenzhong.duan@xxxxxxxxx/ [8] https://github.com/yiliu1765/qemu/tree/zhenzhong/iommufd_rfcv4 Change log: v15: - Add Jason's r-b to patch 14, 17, 19, 21, 23, 24 and 26 of cdev v14 - Tweak the iommufd_ctx_from_fd() in patch 20 per Jason's suggestion (Jason) - Return -ENOTTY in vfio_df_ioctl_bind_iommufd() stub function (Jason) - Add t-b from Zhenzhong (wrote a selftest app to verify functions of this patchset by referencing https://github.com/awilliam/tests/) v14: https://lore.kernel.org/kvm/20230711025928.6438-1-yi.l.liu@xxxxxxxxx/ - Add Jason's r-b to patch 10, 11, 12, 13, 15, 16, 17 and 23 of cdev v12 - Refine iommufd_access_detach() (Jason) - Split the device_del() movement to be a separate patch (Jason) - Move kvm !null test into _vfio_device_get_kvm_safe() to save some lines and rename it to be vfio_device_get_kvm_safe() (Jason) - Make VFIO_DEVICE_CDEV depending on !SPAPR_TCE_IOMMU to suit the fact that SPAPR_TCE_IOMMU does not support cdev (Alex) - Add iommufd_ctx_from_fd() to replace vfio_get_iommufd_from_fd() (Jason) - Check cdev only ioctls in vfio_device_fops_unl_ioctl() (Jason) - patch 17, 19, 20 and 21 of v14 is newly added per above review comemnts. v13: https://lore.kernel.org/kvm/20230616093946.68711-1-yi.l.liu@xxxxxxxxx/ - vfio_device_first_open() and vfio_device_last_close() to be vfio_df_device_first_open() vfio_df_device_last_close() (Alex) - Define struct vfio_device_file::access_granted as u8 and also place the u32 devid to be behind this flag as this structure access is hot, so needs to avoid too much hole in the structure (Alex) - Use u8 instead bool in the struct vfio_device for the flags (Alex) - Define BIND, ATTACH, DETACH ioctl behind VFIO_DEVICE_FEATURE whose offset is 17 (Alex) - Drop patch 20, 21, 22 of v12 (Alex) - Per the patch drop, still needs to detect the physical devices that do not have IOMMU in the cdev registration as cdev does not support such devices. Per the suggestion from Jason, lift the IOMMU_CAP_CACHE_COHERENCY check to be in vfio_main.c so that it can fail the registration of such devices if only cdev is compiled. (Jason, Alex) - Refine the vfio.rst doc, highlight that the cdev device access is stil bound with iommu group. (Alex) - Reaffirm t-b from below folks: Nicolin Chen - Test nesting branch which is based on cdev v12, the test is done on ARM64 (SMMUv3) Matthew Rosato - vfio-pci, vfio-ap, vfio-ccw under container, compat and cdev mode, and nesting test on SMMUv3 and Intel. Yanting Jiang - regression tests with NIC passthrough on Intel platform v12: https://lore.kernel.org/kvm/20230602121653.80017-1-yi.l.liu@xxxxxxxxx/#r - Rename vfio_device_xx() to be vfio_df_xx() if the object is vfio_device_file (Alex) - Refine patch 10 of v11 (Alex) - Add new device ioctls from offset 18 (Alex) - Add a patch to check group->type for noiommu test, no need to check CONFIG_VFIO_NOIOMMU (Alex) - Refine the logic of vfio_device_set_noiommu() per Alex's suggestion. The noiommu taint is moved to __vfio_register_dev(), also add a check on group type before calling vfio_device_set_noiommu() as only physical device can be noiommu device. - Drop noiommu support for cdev, patch 16 of v11 is dropped, the related changes are in patch 17 - 24 of this series. v11: https://lore.kernel.org/kvm/20230513132827.39066-1-yi.l.liu@xxxxxxxxx/ - Add back the noiommu determination at vfio device registration patch and put it prior to compiling vfio_group code optionally as compiling vfio_group optionaly is the major reason for it. - Fix a typo related to SPAPR (Cédric Le Goater) - Add t-b from Shameerali Kolothum Thodi, tested on HiSilicon D06(ARM64) platform with a NIC pass-through v10: https://lore.kernel.org/kvm/20230426150321.454465-1-yi.l.liu@xxxxxxxxx/ - Drop patch 03 of v9 as vfio_file_is_group() is still needed by pci hot reset path - Drop 11 of v9 per the change of noiommu support - Move patch 18 of v9 to hot-reset series [3] - vfio_file_has_device_access() is dropped as no usage now (hot-reset does not accept device fd, hence no need for this helper) - Minor change to patch 02, mainly make it back to patch v2 of v6 which is before splitting hot-reset series - Minor change in 10 and 11 due to rebase - Functional changes in patch 19, 20 and 21 per the latest noiommu support policy. noiommu device can be bound to valid iommufd now, this is different from the prior policy in which noiommu device is not allowed to be bound to valid iommufd. So may pay more attention on the three patches, previous r-b and t-b are dropped for these three patches. v9: https://lore.kernel.org/kvm/20230401151833.124749-1-yi.l.liu@xxxxxxxxx/ - Use smp_load_acquire() in vfio_file_has_device_access() for df->access_granted (Alex) - Fix lock init in patch 16 of v8 (Jon Pan-Doh) - Split patch 20 of v8 (Alex) - Refine noiommu logic in BIND_IOMMUFD (Alex) - Remove dev_cookie in BIND_IOMMUFD ioctl (Alex, Jason) - Remove static_assert in ATTACH/DETACH ioctl handling (Alex) - Remove device->ops->bind_iommufd presence check in BIND_IOMMUFD/ATTACH/DETACH handling (Alex) - Remove VFIO dependecny for VFIO_CONTAINER as VFIO_GROUP should imply it (Alex) - Improve the documentation per suggestions from Alex on patch 24 of v8 (Alex) - Remove WARN_ON(df->group) in vfio_device_group_uses_container() of patch 11 - Add r-b from Kevin to patch 18/19 of v8 - Add r-b from Jason to patch 03/10/11 of v8 - Add t-b from Yanting Jiang and Nicolin Chen v8: https://lore.kernel.org/kvm/20230327094047.47215-1-yi.l.liu@xxxxxxxxx/ - Add patch 18 to determine noiommu device at vfio_device registration (Jason) - Add patch 19 to name noiommu device with "noiommu-" prefix to be par with group path - Add r-b from Kevin - Add t-b from Terrence v7: https://lore.kernel.org/kvm/20230316125534.17216-1-yi.l.liu@xxxxxxxxx/ - Split the vfio-pci hot reset changes to be separate patch series (Jason, Kevin) - More polish on no-iommufd support (patch 11 - 13) in cdev path (Kevin) - iommufd_access_detach() in patch 16 is added by Nic for emulated devices (Kevin, Jason) v6: https://lore.kernel.org/kvm/20230308132903.465159-1-yi.l.liu@xxxxxxxxx/#t - Add r-b from Jason on patch 01 - 08 and 13 in v5 - Based on the prerequisite mini-series which makes vfio emulated devices be prepared to cdev (Jason) - Add the approach to pass a set of device fds to do hot reset ownership check, while the zero-length array approach is also kept. (Jason, Kevin, Alex) - Drop patch 10 of v5, it is reworked by patch 13 and 17 in v6 (Jason) - Store vfio_group pointer in vfio_device_file to check if user is using legacy vfio container (Jason) - Drop the is_cdev_device flag (introduced in patch 14 of v5) as the group pointer stored in vfio_device_file can cover it. - Add iommu_group check in the cdev no-iommu path patch 24 (Kevin) - Add t-b from Terrence, Nicolin and Matthew (thanks for the help, some patches are new in this version, so I just added t-b to the patches that are also in v5 and no big change, for others would add in this version). v5: https://lore.kernel.org/kvm/20230227111135.61728-1-yi.l.liu@xxxxxxxxx/ - Add r-b from Kevin on patch 08, 13, 14, 15 and 17. - Rename patch 02 to limit the change for KVM facing kAPIs. The vfio pci hot reset path only accepts group file until patch 09. (Kevin) - Update comment around smp_load_acquire(&df->access_granted) (Yan) - Adopt Jason's suggestion on the vfio pci hot reset path, passing zero-length fd array to indicate using bound iommufd_ctx as ownership check. (Jason, Kevin) - Direct read df->access_granted value in vfio_device_cdev_close() (Kevin, Yan, Jason) - Wrap the iommufd get/put into a helper to refine the error path of vfio_device_ioctl_bind_iommufd(). (Yan) v4: https://lore.kernel.org/kvm/20230221034812.138051-1-yi.l.liu@xxxxxxxxx/ - Add r-b from Kevin on patch 09/10 - Add a line in devices/vfio.rst to emphasize user should add group/device to KVM prior to invoke open_device op which may be called in the VFIO_GROUP_GET_DEVICE_FD or VFIO_DEVICE_BIND_IOMMUFD ioctl. - Modify VFIO_GROUP/VFIO_DEVICE_CDEV Kconfig dependency (Alex) - Select VFIO_GROUP for SPAPR (Jason) - Check device fully-opened in PCI hotreset path for device fd (Jason) - Set df->access_granted in the caller of vfio_device_open() since the caller may fail in other operations, but df->access_granted does not allow a true to false change. So it should be set only when the open path is really done successfully. (Yan, Kevin) - Fix missing iommufd_ctx_put() in the cdev path (Yan) - Fix an issue found in testing exclusion between group and cdev path. vfio_device_cdev_close() should check df->access_granted before heading to other operations. - Update vfio.rst for iommufd/cdev v3: https://lore.kernel.org/kvm/20230213151348.56451-1-yi.l.liu@xxxxxxxxx/ - Add r-b from Kevin on patch 03, 06, 07, 08. - Refine the group and cdev path exclusion. Remove vfio_device:single_open; add vfio_group::cdev_device_open_cnt to achieve exlucsion between group path and cdev path (Kevin, Jason) - Fix a bug in the error handling path (Yan Zhao) - Address misc remarks from Kevin v2: https://lore.kernel.org/kvm/20230206090532.95598-1-yi.l.liu@xxxxxxxxx/ - Add r-b from Kevin and Eric on patch 01 02 04. - "Split kvm/vfio: Provide struct kvm_device_ops::release() insted of ::destroy()" from this series and got applied. (Alex, Kevin, Jason, Mathhew) - Add kvm_ref_lock to protect vfio_device_file->kvm instead of reusing dev_set->lock as dead-lock is observed with vfio-ap which would try to acquire kvm_lock. This is opposite lock order with kvm_device_release() which holds kvm_lock first and then hold dev_set->lock. (Kevin) - Use a separate ioctl for detaching IOAS. (Alex) - Rename vfio_device_file::single_open to be is_cdev_device (Kevin, Alex) - Move the vfio device cdev code into device_cdev.c and add a VFIO_DEVICE_CDEV kconfig for it. (Kevin, Jason) v1: https://lore.kernel.org/kvm/20230117134942.101112-1-yi.l.liu@xxxxxxxxx/ - Fix the circular refcount between kvm struct and device file reference. (JasonG) - Address comments from KevinT - Remained the ioctl for detach, needs to Alex's taste (https://lore.kernel.org/kvm/BN9PR11MB5276BE9F4B0613EE859317028CFF9@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/) rfc: https://lore.kernel.org/kvm/20221219084718.9342-1-yi.l.liu@xxxxxxxxx/ Thanks, Yi Liu Nicolin Chen (1): iommufd/device: Add iommufd_access_detach() API Yi Liu (25): vfio: Allocate per device file structure vfio: Refine vfio file kAPIs for KVM vfio: Accept vfio device file in the KVM facing kAPI kvm/vfio: Prepare for accepting vfio device fd kvm/vfio: Accept vfio device file from userspace vfio: Pass struct vfio_device_file * to vfio_device_open/close() vfio: Block device access via device fd until device is opened vfio: Add cdev_device_open_cnt to vfio_group vfio: Make vfio_df_open() single open for device cdev path vfio-iommufd: Move noiommu compat validation out of vfio_iommufd_bind() vfio-iommufd: Split bind/attach into two steps vfio: Record devid in vfio_device_file vfio-iommufd: Add detach_ioas support for physical VFIO devices vfio-iommufd: Add detach_ioas support for emulated VFIO devices vfio: Move vfio_device_group_unregister() to be the first operation in unregister vfio: Move device_del() before waiting for the last vfio_device registration refcount vfio: Add cdev for vfio_device vfio: Test kvm pointer in _vfio_device_get_kvm_safe() iommufd: Add iommufd_ctx_from_fd() vfio: Avoid repeated user pointer cast in vfio_device_fops_unl_ioctl() vfio: Add VFIO_DEVICE_BIND_IOMMUFD vfio: Add VFIO_DEVICE_[AT|DE]TACH_IOMMUFD_PT vfio: Move the IOMMU_CAP_CACHE_COHERENCY check in __vfio_register_dev() vfio: Compile vfio_group infrastructure optionally docs: vfio: Add vfio device cdev description Documentation/driver-api/vfio.rst | 147 ++++++++++- Documentation/virt/kvm/devices/vfio.rst | 47 ++-- drivers/gpu/drm/i915/gvt/kvmgt.c | 1 + drivers/iommu/iommufd/Kconfig | 4 +- drivers/iommu/iommufd/device.c | 74 +++++- drivers/iommu/iommufd/iommufd_private.h | 2 + drivers/iommu/iommufd/main.c | 24 ++ drivers/s390/cio/vfio_ccw_ops.c | 1 + drivers/s390/crypto/vfio_ap_ops.c | 1 + drivers/vfio/Kconfig | 27 ++ drivers/vfio/Makefile | 3 +- drivers/vfio/device_cdev.c | 228 +++++++++++++++++ drivers/vfio/fsl-mc/vfio_fsl_mc.c | 1 + drivers/vfio/group.c | 173 ++++++++----- drivers/vfio/iommufd.c | 94 ++++--- .../vfio/pci/hisilicon/hisi_acc_vfio_pci.c | 2 + drivers/vfio/pci/mlx5/main.c | 1 + drivers/vfio/pci/vfio_pci.c | 1 + drivers/vfio/platform/vfio_amba.c | 1 + drivers/vfio/platform/vfio_platform.c | 1 + drivers/vfio/vfio.h | 218 ++++++++++++++-- drivers/vfio/vfio_main.c | 239 ++++++++++++++++-- include/linux/iommufd.h | 2 + include/linux/vfio.h | 46 +++- include/uapi/linux/kvm.h | 13 +- include/uapi/linux/vfio.h | 71 ++++++ samples/vfio-mdev/mbochs.c | 1 + samples/vfio-mdev/mdpy.c | 1 + samples/vfio-mdev/mtty.c | 1 + virt/kvm/vfio.c | 137 +++++----- 30 files changed, 1318 insertions(+), 244 deletions(-) create mode 100644 drivers/vfio/device_cdev.c -- 2.34.1
