vfio-pci: Provide reviewers and acceptance criteria for variant drivers
Subsystems (3)
PATCH v4 1/1 vfio-pci: Provide reviewers and acceptance criteria for variant drivers
Device specific extensions for devices exposed to userspace through the vfio-pci-core library open both new functionality and new risks. Here we attempt to provided formalized requirements and expectations to ensure that future drivers both collaborate in their interaction with existing host drivers, as well as receive additional reviews from community members with experience in this area.
---
v4:
Banish the word "vendor", replace with "device specific" Minor wording changes in docs file
Add sign-offs from Kevin and Yishai
I'll drop Jason from reviewers if there's no positive approval after this round.
v3:
Relocate to Documentation/driver-api/
Include index.rst reference
Cross link from maintainer-entry-profile
Add Shameer's Ack
v2:
Added Yishai
v1:
Per the proposal here[1], I've collected those that volunteered and those that I interpreted as showing interest (alpha by last name). For those on the reviewers list below, please R-b/A-b to keep your name as a reviewer. More volunteers are still welcome, please let me know explicitly; R-b/A-b will not be used to automatically add reviewers but are of course welcome. Thanks,
Alex
[1]https://lore.kernel.org/all/[email protected]/
Documentation/driver-api/index.rst | 1 + .../vfio-pci-device-specific-driver-acceptance.rst | 35 ++++++++++++++++++++ .../maintainer/maintainer-entry-profile.rst | 1 + MAINTAINERS | 10 ++++++ 4 files changed, 47 insertions(+) create mode 100644 Documentation/driver-api/vfio-pci-device-specific-driver-acceptance.rst
Documentation/driver-api/index.rst +1 -0
@@ -103,6 +103,7 @@ available subsections can be seen below. sync_file vfio-mediated-device vfio + vfio-pci-device-specific-driver-acceptance xilinx/index xillybus zorro
Documentation/driver-api/vfio-pci-device-specific-driver-acceptance.rst new file +35 -0
@@ -0,0 +1,35 @@ +.. SPDX-License-Identifier: GPL-2.0 + +Acceptance criteria for vfio-pci device specific driver variants +================================================================ + +Overview +-------- +The vfio-pci driver exists as a device agnostic driver using the +system IOMMU and relying on the robustness of platform fault +handling to provide isolated device access to userspace. While the +vfio-pci driver does include some device specific support, further +extensions for yet more advanced device specific features are not +sustainable. The vfio-pci driver has therefore split out +vfio-pci-core as a library that may be reused to implement features +requiring device specific knowledge, ex. saving and loading device +state for the purposes of supporting migration. + +In support of such features, it's expected that some device specific +variants may interact with parent devices (ex. SR-IOV PF in support of +a user assigned VF) or other extensions that may not be otherwise +accessible via the vfio-pci base driver. Authors of such drivers +should be diligent not to create exploitable interfaces via these +interactions or allow unchecked userspace data to have an effect +beyond the scope of the assigned device. + +New driver submissions are therefore requested to have approval via +sign-off/ack/review/etc for any interactions with parent drivers. +Additionally, drivers should make an attempt to provide sufficient +documentation for reviewers to understand the device specific +extensions, for example in the case of migration data, how is the +device state composed and consumed, which portions are not otherwise +available to the user via vfio-pci, what safeguards exist to validate +the data, etc. To that extent, authors should additionally expect to +require reviews from at least one of the listed reviewers, in addition +to the overall vfio maintainer.
Documentation/maintainer/maintainer-entry-profile.rst +1 -0
@@ -103,3 +103,4 @@ to do something different in the near future. ../nvdimm/maintainer-entry-profile ../riscv/patch-acceptance ../driver-api/media/maintainer-entry-profile + ../driver-api/vfio-pci-device-specific-driver-acceptance
MAINTAINERS +10 -0
@@ -20314,6 +20314,16 @@ F: drivers/vfio/mdev/ F: include/linux/mdev.h F: samples/vfio-mdev/ +VFIO PCI DEVICE SPECIFIC DRIVERS +R: Jason Gunthorpe <[email protected]> +R: Yishai Hadas <[email protected]> +R: Shameer Kolothum <[email protected]> +R: Kevin Tian <[email protected]> +L: [email protected] +S: Maintained +P: Documentation/driver-api/vfio-pci-device-specific-driver-acceptance.rst +F: drivers/vfio/pci/*/ + VFIO PLATFORM DRIVER M: Eric Auger <[email protected]> L: [email protected]
Quoted 7 lines · Alex Williamson
Device specific extensions for devices exposed to userspace through the vfio-pci-core library open both new functionality and new risks. Here we attempt to provided formalized requirements and expectations to ensure that future drivers both collaborate in their interaction with existing host drivers, as well as receive additional reviews from community members with experience in this area.
Quoted 5 lines
Cc Jason Gunthorpe <[email protected]>Acked-by Shameer Kolothum <[email protected]>Reviewed-by Yishai Hadas <[email protected]>Acked-by Kevin Tian <[email protected]>Signed-off-by Alex Williamson <[email protected]>
[obviously modulo the missing ack]
Quoted 13 lines · Alex Williamson
Device specific extensions for devices exposed to userspace through the vfio-pci-core library open both new functionality and new risks. Here we attempt to provided formalized requirements and expectations to ensure that future drivers both collaborate in their interaction with existing host drivers, as well as receive additional reviews from community members with experience in this area.
Cc Jason Gunthorpe <[email protected]>Acked-by Shameer Kolothum <[email protected]>Reviewed-by Yishai Hadas <[email protected]>Acked-by Kevin Tian <[email protected]>Signed-off-by Alex Williamson <[email protected]>
Quoted 8 lines
v4:
Banish the word "vendor", replace with "device specific" Minor wording changes in docs file
Add sign-offs from Kevin and YishaiI'll drop Jason from reviewers if there's no positive approval after this round.
Sorry, you are looking for this?
Thanks,
Jason
Quoted 20 lines · On Tue, 15 Mar 2022 14:50:39 -0300 Jason Gunthorpe <[email protected]> wrote:
Quoted 19 lines · Alex Williamson
Device specific extensions for devices exposed to userspace through the vfio-pci-core library open both new functionality and new risks. Here we attempt to provided formalized requirements and expectations to ensure that future drivers both collaborate in their interaction with existing host drivers, as well as receive additional reviews from community members with experience in this area.
Cc Jason Gunthorpe <[email protected]>Acked-by Shameer Kolothum <[email protected]>Reviewed-by Yishai Hadas <[email protected]>Acked-by Kevin Tian <[email protected]>Signed-off-by Alex Williamson <[email protected]>v4:
Banish the word "vendor", replace with "device specific" Minor wording changes in docs file
Add sign-offs from Kevin and Yishai
Quoted 6 lines
Quoted 2 lines
I'll drop Jason from reviewers if there's no positive approval after this round.
Sorry, you are looking for this?
Acked-by Jason Gunthorpe <[email protected]>
Yup, thanks for volunteering!
Jonathan Corbet
maintainerQuoted 7 lines · Alex Williamson
Device specific extensions for devices exposed to userspace through the vfio-pci-core library open both new functionality and new risks. Here we attempt to provided formalized requirements and expectations to ensure that future drivers both collaborate in their interaction with existing host drivers, as well as receive additional reviews from community members with experience in this area.
Quoted 5 lines
Cc Jason Gunthorpe <[email protected]>Acked-by Shameer Kolothum <[email protected]>Reviewed-by Yishai Hadas <[email protected]>Acked-by Kevin Tian <[email protected]>Signed-off-by Alex Williamson <[email protected]>
So this seems fine to me. Did you want it to go through the docs tree, or did you have another path in mind for it?
Thanks,
jon
Quoted 9 lines · On Wed, 16 Mar 2022 15:10:27 -0600 Jonathan Corbet <[email protected]> wrote:
Quoted 7 lines · Alex Williamson
Device specific extensions for devices exposed to userspace through the vfio-pci-core library open both new functionality and new risks. Here we attempt to provided formalized requirements and expectations to ensure that future drivers both collaborate in their interaction with existing host drivers, as well as receive additional reviews from community members with experience in this area.
Quoted 8 lines
Quoted 5 lines
Cc Jason Gunthorpe <[email protected]>Acked-by Shameer Kolothum <[email protected]>Reviewed-by Yishai Hadas <[email protected]>Acked-by Kevin Tian <[email protected]>Signed-off-by Alex Williamson <[email protected]>So this seems fine to me. Did you want it to go through the docs tree, or did you have another path in mind for it?
Thanks, Jon. I can bring it in through the vfio tree if that works for you. Thanks,
Alex
Alex Williamson
AppliedQuoted 7 lines · On Tue, 15 Mar 2022 11:29:57 -0600 Alex Williamson…
Device specific extensions for devices exposed to userspace through the vfio-pci-core library open both new functionality and new risks. Here we attempt to provided formalized requirements and expectations to ensure that future drivers both collaborate in their interaction with existing host drivers, as well as receive additional reviews from community members with experience in this area.
Quoted 6 lines
Cc Jason Gunthorpe <[email protected]>Acked-by Shameer Kolothum <[email protected]>Reviewed-by Yishai Hadas <[email protected]>Acked-by Kevin Tian <[email protected]>Signed-off-by Alex Williamson <[email protected]>---
...>
Quoted 6 lines
Documentation/driver-api/index.rst | 1 + .../vfio-pci-device-specific-driver-acceptance.rst | 35 ++++++++++++++++++++ .../maintainer/maintainer-entry-profile.rst | 1 + MAINTAINERS | 10 ++++++ 4 files changed, 47 insertions(+) create mode 100644 Documentation/driver-api/vfio-pci-device-specific-driver-acceptance.rst
Applied to vfio next branch for v5.18 with Jason and Connie's sign-offs. Thanks,
Alex