| Message ID | 164736509088.181560.2887686123582116702.stgit@omen (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v4] vfio-pci: Provide reviewers and acceptance criteria for variant drivers | expand |
On Tue, Mar 15 2022, Alex Williamson <alex.williamson@redhat.com> wrote: > 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 <jgg@nvidia.com> > Acked-by: Shameer Kolothum <shameerali.kolothum.thodi@huawei.com> > Reviewed-by: Yishai Hadas <yishaih@nvidia.com> > Acked-by: Kevin Tian <kevin.tian@intel.com> > Signed-off-by: Alex Williamson <alex.williamson@redhat.com> Reviewed-by: Cornelia Huck <cohuck@redhat.com> [obviously modulo the missing ack]
On Tue, Mar 15, 2022 at 11:29:57AM -0600, Alex Williamson wrote: > 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 <jgg@nvidia.com> > Acked-by: Shameer Kolothum <shameerali.kolothum.thodi@huawei.com> > Reviewed-by: Yishai Hadas <yishaih@nvidia.com> > Acked-by: Kevin Tian <kevin.tian@intel.com> > Signed-off-by: Alex Williamson <alex.williamson@redhat.com> > > 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. Sorry, you are looking for this? Acked-by: Jason Gunthorpe <jgg@nvidia.com> Thanks, Jason
On Tue, 15 Mar 2022 14:50:39 -0300 Jason Gunthorpe <jgg@nvidia.com> wrote: > On Tue, Mar 15, 2022 at 11:29:57AM -0600, Alex Williamson wrote: > > 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 <jgg@nvidia.com> > > Acked-by: Shameer Kolothum <shameerali.kolothum.thodi@huawei.com> > > Reviewed-by: Yishai Hadas <yishaih@nvidia.com> > > Acked-by: Kevin Tian <kevin.tian@intel.com> > > Signed-off-by: Alex Williamson <alex.williamson@redhat.com> > > > > 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. > > Sorry, you are looking for this? > > Acked-by: Jason Gunthorpe <jgg@nvidia.com> Yup, thanks for volunteering!
Alex Williamson <alex.williamson@redhat.com> writes: > 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 <jgg@nvidia.com> > Acked-by: Shameer Kolothum <shameerali.kolothum.thodi@huawei.com> > Reviewed-by: Yishai Hadas <yishaih@nvidia.com> > Acked-by: Kevin Tian <kevin.tian@intel.com> > Signed-off-by: Alex Williamson <alex.williamson@redhat.com> 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
On Wed, 16 Mar 2022 15:10:27 -0600 Jonathan Corbet <corbet@lwn.net> wrote: > Alex Williamson <alex.williamson@redhat.com> writes: > > > 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 <jgg@nvidia.com> > > Acked-by: Shameer Kolothum <shameerali.kolothum.thodi@huawei.com> > > Reviewed-by: Yishai Hadas <yishaih@nvidia.com> > > Acked-by: Kevin Tian <kevin.tian@intel.com> > > Signed-off-by: Alex Williamson <alex.williamson@redhat.com> > > 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
On Tue, 15 Mar 2022 11:29:57 -0600 Alex Williamson <alex.williamson@redhat.com> wrote: > 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 <jgg@nvidia.com> > Acked-by: Shameer Kolothum <shameerali.kolothum.thodi@huawei.com> > Reviewed-by: Yishai Hadas <yishaih@nvidia.com> > Acked-by: Kevin Tian <kevin.tian@intel.com> > Signed-off-by: Alex Williamson <alex.williamson@redhat.com> > --- ...> > 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
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index c57c609ad2eb..a7b0223e2886 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -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 diff --git a/Documentation/driver-api/vfio-pci-device-specific-driver-acceptance.rst b/Documentation/driver-api/vfio-pci-device-specific-driver-acceptance.rst new file mode 100644 index 000000000000..b7b99b876b50 --- /dev/null +++ b/Documentation/driver-api/vfio-pci-device-specific-driver-acceptance.rst @@ -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. diff --git a/Documentation/maintainer/maintainer-entry-profile.rst b/Documentation/maintainer/maintainer-entry-profile.rst index 5d5cc3acdf85..93b2ae6c34a9 100644 --- a/Documentation/maintainer/maintainer-entry-profile.rst +++ b/Documentation/maintainer/maintainer-entry-profile.rst @@ -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 diff --git a/MAINTAINERS b/MAINTAINERS index 4322b5321891..fb71542c46d6 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -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 <jgg@nvidia.com> +R: Yishai Hadas <yishaih@nvidia.com> +R: Shameer Kolothum <shameerali.kolothum.thodi@huawei.com> +R: Kevin Tian <kevin.tian@intel.com> +L: kvm@vger.kernel.org +S: Maintained +P: Documentation/driver-api/vfio-pci-device-specific-driver-acceptance.rst +F: drivers/vfio/pci/*/ + VFIO PLATFORM DRIVER M: Eric Auger <eric.auger@redhat.com> L: kvm@vger.kernel.org