mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2026-09-18 23:19:34 +02:00
Documentation: Update VFIO NOIOMMU mode
Document the NOIOMMU mode with newly added cdev support under iommufd. Link: https://patch.msgid.link/r/7d4a050505317a29f7f2c32d024333b7b5c7d4fd.1783360051.git.jacob.pan@linux.microsoft.com Cc: Jonathan Corbet <corbet@lwn.net> Reviewed-by: Yi Liu <yi.l.liu@intel.com> Reviewed-by: Kevin Tian <kevin.tian@intel.com> Signed-off-by: Jacob Pan <jacob.pan@linux.microsoft.com> Fixes: 2c6cf6ab1564 ("iommufd: Allow binding to a noiommu device") Reviewed-by: Alex Williamson <alex@shazbot.org> Signed-off-by: Jason Gunthorpe <jgg@nvidia.com>
This commit is contained in:
committed by
Jason Gunthorpe
parent
e8efdf02d3
commit
12f16a37f2
@@ -275,8 +275,6 @@ in a VFIO group.
|
||||
With CONFIG_VFIO_DEVICE_CDEV=y the user can now acquire a device fd
|
||||
by directly opening a character device /dev/vfio/devices/vfioX where
|
||||
"X" is the number allocated uniquely by VFIO for registered devices.
|
||||
cdev interface does not support noiommu devices, so user should use
|
||||
the legacy group interface if noiommu is wanted.
|
||||
|
||||
The cdev only works with IOMMUFD. Both VFIO drivers and applications
|
||||
must adapt to the new cdev security model which requires using
|
||||
@@ -370,6 +368,93 @@ IOMMUFD IOAS/HWPT to enable userspace DMA::
|
||||
|
||||
/* Other device operations as stated in "VFIO Usage Example" */
|
||||
|
||||
VFIO NOIOMMU mode
|
||||
-------------------------------------------------------------------------------
|
||||
VFIO also supports a no-IOMMU mode, intended for usages where unsafe DMA can
|
||||
be performed by userspace drivers w/o physical IOMMU protection. This mode
|
||||
is controlled by the parameter:
|
||||
|
||||
/sys/module/vfio/parameters/enable_unsafe_noiommu_mode
|
||||
|
||||
Upon enabling this mode, with an assigned device, the user will be presented
|
||||
with a VFIO group and device file, e.g.::
|
||||
|
||||
/dev/vfio/
|
||||
|-- devices
|
||||
| `-- noiommu-vfioX /* VFIO device cdev */
|
||||
|-- noiommu-Y /* VFIO group */
|
||||
`-- vfio
|
||||
|
||||
The capabilities vary depending on the device programming interface and kernel
|
||||
configuration used. The following table summarizes the differences ("Yes" means
|
||||
the UAPI is accessible and functional in noiommu mode, "No" means the UAPI is
|
||||
not supported):
|
||||
|
||||
+-------------------+---------------------+----------------------+
|
||||
| Feature | VFIO group | VFIO device cdev |
|
||||
+===================+=====================+======================+
|
||||
| VFIO device UAPI | Yes | Yes |
|
||||
+-------------------+---------------------+----------------------+
|
||||
| VFIO container | No | No |
|
||||
+-------------------+---------------------+----------------------+
|
||||
| IOMMUFD IOAS | No | Yes* |
|
||||
+-------------------+---------------------+----------------------+
|
||||
|
||||
Note that the VFIO container case includes IOMMUFD provided VFIO compatibility
|
||||
interfaces when either CONFIG_VFIO_CONTAINER or CONFIG_IOMMUFD_VFIO_CONTAINER is
|
||||
enabled.
|
||||
|
||||
* IOMMUFD UAPI is available for VFIO device cdev to pin and map user memory with
|
||||
the ability to retrieve physical addresses for DMA command submission.
|
||||
|
||||
Kconfig Support Matrix
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The visibility of CONFIG_VFIO_NOIOMMU depends on the combination of
|
||||
CONFIG_VFIO_GROUP, CONFIG_VFIO_DEVICE_CDEV, and whether a container backend
|
||||
(CONFIG_VFIO_CONTAINER or CONFIG_IOMMUFD_VFIO_CONTAINER) is configured. The
|
||||
Kconfig dependencies enforce the following constraints:
|
||||
|
||||
- At least one access path (group or cdev) must be available.
|
||||
- If VFIO_GROUP is enabled, a container backend is required; otherwise the
|
||||
group node would be unusable in noiommu mode.
|
||||
- The cdev noiommu path requires CONFIG_GENERIC_ATOMIC64=n because it depends
|
||||
on CONFIG_IOMMUFD_NOIOMMU.
|
||||
|
||||
The resulting support matrix:
|
||||
|
||||
+------+-------+-----------+------+---------+---------------------------+
|
||||
| Case | GROUP | Container | CDEV | NOIOMMU | Notes |
|
||||
+======+=======+===========+======+=========+===========================+
|
||||
| 1 | y | y | n | yes | Group noiommu works |
|
||||
+------+-------+-----------+------+---------+---------------------------+
|
||||
| 2 | y | n | n | no | Blocked - no container |
|
||||
+------+-------+-----------+------+---------+---------------------------+
|
||||
| 3 | y | y | y | yes | Both paths work [#cdev]_ |
|
||||
+------+-------+-----------+------+---------+---------------------------+
|
||||
| 4 | y | n | y | no | Blocked - no container |
|
||||
+------+-------+-----------+------+---------+---------------------------+
|
||||
| 5 | n | - | y | yes | Cdev-only works [#cdev]_ |
|
||||
+------+-------+-----------+------+---------+---------------------------+
|
||||
| 6 | n | - | n | no | No access path |
|
||||
+------+-------+-----------+------+---------+---------------------------+
|
||||
|
||||
Container = CONFIG_VFIO_CONTAINER or CONFIG_IOMMUFD_VFIO_CONTAINER (either
|
||||
suffices). Case 4 is intentionally blocked: allowing NOIOMMU with GROUP
|
||||
enabled but no container would create unusable group nodes. Users who want
|
||||
cdev-only noiommu should set CONFIG_VFIO_GROUP=n (case 5).
|
||||
|
||||
.. [#cdev] The cdev noiommu path requires CONFIG_GENERIC_ATOMIC64=n. When
|
||||
CONFIG_VFIO_GROUP=y, CONFIG_VFIO_DEVICE_CDEV=y, and
|
||||
CONFIG_GENERIC_ATOMIC64=y, CONFIG_VFIO_NOIOMMU remains selectable for the
|
||||
group path, but no noiommu device cdev is registered. Cdev-only noiommu is
|
||||
not selectable on those platforms.
|
||||
|
||||
A new IOMMUFD ioctl IOMMU_IOAS_NOIOMMU_GET_PA is added to retrieve the physical
|
||||
address for a given IOVA. Although there is no physical DMA remapping hardware,
|
||||
IOMMU_IOAS_MAP_FIXED_IOVA is still used to establish IOVA-to-PA mappings in the
|
||||
software page table for later IOMMU_IOAS_NOIOMMU_GET_PA lookups.
|
||||
|
||||
VFIO User API
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user