Add UAPIs to support migration for VFIO devices
Subsystems (2)
v19 cover Add UAPIs to support migration for VFIO devices
Hi,
This patch set adds:
* IOCTL VFIO_IOMMU_DIRTY_PAGES to get dirty pages bitmap with respect to IOMMU container rather than per device. All pages pinned by vendor driver through vfio_pin_pages external API has to be marked as dirty during migration. When IOMMU capable device is present in the container and all pages are pinned and mapped, then all pages are marked dirty.
When there are CPU writes, CPU dirty page tracking can identify dirtied pages, but any page pinned by vendor driver can also be written by device. As of now there is no device which has hardware support for dirty page tracking. So all pages which are pinned should be considered as dirty.
This ioctl is also used to start/stop dirty pages tracking for pinned and unpinned pages while migration is active.
* Updated IOCTL VFIO_IOMMU_UNMAP_DMA to get dirty pages bitmap before unmapping IO virtual address range.
With vIOMMU, during pre-copy phase of migration, while CPUs are still running, IO virtual address unmap can happen while device still keeping reference of guest pfns. Those pages should be reported as dirty before unmap, so that VFIO user space application can copy content of those pages from source to destination.
* Patch 8 detect if IOMMU capable device driver is smart to report pages to be marked dirty by pinning pages using vfio_pin_pages() API.
Yet TODO:
Since there is no device which has hardware support for system memmory dirty bitmap tracking, right now there is no other API from vendor driver to VFIO IOMMU module to report dirty pages. In future, when such hardware support will be implemented, an API will be required such that vendor driver could report dirty pages to VFIO module during migration phases.
Adding revision history from previous QEMU patch set to understand KABI changes done till now
v18 -> v19
- Updated migration capability with supported page sizes bitmap for dirty page tracking and maximum bitmap size supported by kernel module.
- Added patch to calculate and cache pgsize_bitmap when iommu->domain_list is updated.
- Removed extra buffers added in previous version for bitmap manipulation and optimised the code.
v17 -> v18
- Add migration capability to the capability chain for VFIO_IOMMU_GET_INFO ioctl
- Updated UMAP_DMA ioctl to return bitmap of multiple vfio_dma
v16 -> v17
- Fixed errors reported by kbuild test robot <[email protected]> on i386
v15 -> v16
- Minor edits and nit picks (Auger Eric)
- On copying bitmap to user, re-populated bitmap only for pinned pages, excluding unmapped pages and CPU dirtied pages.
- Patches are on tag: next-20200318 and 1-3 patches from Yan's series
https://lkml.org/lkml/2020/3/12/1255
v14 -> v15
- Minor edits and nit picks.
- In the verification of user allocated bitmap memory, added check of maximum size.
- Patches are on tag: next-20200318 and 1-3 patches from Yan's series
https://lkml.org/lkml/2020/3/12/1255
v13 -> v14
- Added struct vfio_bitmap to kabi. updated structure vfio_iommu_type1_dirty_bitmap_get and vfio_iommu_type1_dma_unmap.
- All small changes suggested by Alex.
- Patches are on tag: next-20200318 and 1-3 patches from Yan's series
https://lkml.org/lkml/2020/3/12/1255
v12 -> v13
- Changed bitmap allocation in vfio_iommu_type1 to per vfio_dma
- Changed VFIO_IOMMU_DIRTY_PAGES ioctl behaviour to be per vfio_dma range.
- Changed vfio_iommu_type1_dirty_bitmap structure to have separate data field.
v11 -> v12
- Changed bitmap allocation in vfio_iommu_type1.
- Remove atomicity of ref_count.
- Updated comments for migration device state structure about error reporting.
- Nit picks from v11 reviews
v10 -> v11
- Fix pin pages API to free vpfn if it is marked as unpinned tracking page.
- Added proposal to detect if IOMMU capable device calls external pin pages API to mark pages dirty.
- Nit picks from v10 reviews
v9 -> v10:
- Updated existing VFIO_IOMMU_UNMAP_DMA ioctl to get dirty pages bitmap during unmap while migration is active
- Added flag in VFIO_IOMMU_GET_INFO to indicate driver support dirty page tracking.
- If iommu_mapped, mark all pages dirty.
- Added unpinned pages tracking while migration is active.
- Updated comments for migration device state structure with bit combination table and state transition details.
v8 -> v9:
- Split patch set in 2 sets, Kernel and QEMU.
- Dirty pages bitmap is queried from IOMMU container rather than from vendor driver for per device. Added 2 ioctls to achieve this.
v7 -> v8:
- Updated comments for KABI
- Added BAR address validation check during PCI device's config space load as suggested by Dr. David Alan Gilbert.
- Changed vfio_migration_set_state() to set or clear device state flags.
- Some nit fixes.
v6 -> v7:
- Fix build failures.
v5 -> v6:
- Fix build failure.
v4 -> v5:
- Added decriptive comment about the sequence of access of members of structure vfio_device_migration_info to be followed based on Alex's suggestion
- Updated get dirty pages sequence.
- As per Cornelia Huck's suggestion, added callbacks to VFIODeviceOps to get_object, save_config and load_config.
- Fixed multiple nit picks.
- Tested live migration with multiple vfio device assigned to a VM.
v3 -> v4:
- Added one more bit for _RESUMING flag to be set explicitly.
- data_offset field is read-only for user space application.
- data_size is read for every iteration before reading data from migration, that is removed assumption that data will be till end of migration region.
- If vendor driver supports mappable sparsed region, map those region during setup state of save/load, similarly unmap those from cleanup routines.
- Handles race condition that causes data corruption in migration region during save device state by adding mutex and serialiaing save_buffer and get_dirty_pages routines.
- Skip called get_dirty_pages routine for mapped MMIO region of device.
- Added trace events.
- Split into multiple functional patches.
v2 -> v3:
- Removed enum of VFIO device states. Defined VFIO device state with 2 bits.
- Re-structured vfio_device_migration_info to keep it minimal and defined action on read and write access on its members.
v1 -> v2:
- Defined MIGRATION region type and sub-type which should be used with region type capability.
- Re-structured vfio_device_migration_info. This structure will be placed at 0th offset of migration region.
- Replaced ioctl with read/write for trapped part of migration region.
- Added both type of access support, trapped or mmapped, for data section of the region.
- Moved PCI device functions to pci file.
- Added iteration to get dirty page bitmap until bitmap for all requested pages are copied.
Thanks,
Kirti
Kirti Wankhede (8):
vfio: UAPI for migration interface for device state
vfio iommu: Remove atomicity of ref_count of pinned pages vfio iommu: Cache pgsize_bitmap in struct vfio_iommu
vfio iommu: Add ioctl definition for dirty pages tracking. vfio iommu: Implementation of ioctl for dirty pages tracking vfio iommu: Update UNMAP_DMA ioctl to get dirty bitmap before unmap vfio iommu: Add migration capability to report supported features
vfio: Selective dirty page tracking if IOMMU backed device pins pages
drivers/vfio/vfio.c | 13 +- drivers/vfio/vfio_iommu_type1.c | 570 ++++++++++++++++++++++++++++++++++++---- include/linux/vfio.h | 4 +- include/uapi/linux/vfio.h | 315 ++++++++++++++++++++++ 4 files changed, 842 insertions(+), 60 deletions(-)
Signature · 1 line
2.7.0
PATCH v19 1/8 vfio: UAPI for migration interface for device state
- Defined MIGRATION region type and sub-type.
- Defined vfio_device_migration_info structure which will be placed at the 0th offset of migration region to get/set VFIO device related information. Defined members of structure and usage on read/write access.
- Defined device states and state transition details.
- Defined sequence to be followed while saving and resuming VFIO device.
--- include/uapi/linux/vfio.h | 228 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 228 insertions(+)
include/uapi/linux/vfio.h +228 -0
@@ -305,6 +305,7 @@ struct vfio_region_info_cap_type {#define VFIO_REGION_TYPE_PCI_VENDOR_MASK (0xffff)#define VFIO_REGION_TYPE_GFX (1)#define VFIO_REGION_TYPE_CCW (2) +#define VFIO_REGION_TYPE_MIGRATION (3)/* sub-types for VFIO_REGION_TYPE_PCI_* */
@@ -379,6 +380,233 @@ struct vfio_region_gfx_edid {/* sub-types for VFIO_REGION_TYPE_CCW */ #define VFIO_REGION_SUBTYPE_CCW_ASYNC_CMD (1) +/* sub-types for VFIO_REGION_TYPE_MIGRATION */ +#define VFIO_REGION_SUBTYPE_MIGRATION (1) + +/* +* The structure vfio_device_migration_info is placed at the 0th offset of +* the VFIO_REGION_SUBTYPE_MIGRATION region to get and set VFIO device related +* migration information. Field accesses from this structure are only supported +* at their native width and alignment. Otherwise, the result is undefined and +* vendor drivers should return an error. +* +* device_state: (read/write) +* - The user application writes to this field to inform the vendor driver +* about the device state to be transitioned to. +* - The vendor driver should take the necessary actions to change the +* device state. After successful transition to a given state, the +* vendor driver should return success on write(device_state, state) +* system call. If the device state transition fails, the vendor driver +* should return an appropriate -errno for the fault condition. +* - On the user application side, if the device state transition fails, +* that is, if write(device_state, state) returns an error, read +* device_state again to determine the current state of the device from +* the vendor driver. +* - The vendor driver should return previous state of the device unless +* the vendor driver has encountered an internal error, in which case +* the vendor driver may report the device_state VFIO_DEVICE_STATE_ERROR. +* - The user application must use the device reset ioctl to recover the +* device from VFIO_DEVICE_STATE_ERROR state. If the device is +* indicated to be in a valid device state by reading device_state, the +* user application may attempt to transition the device to any valid +* state reachable from the current state or terminate itself. +* +* device_state consists of 3 bits: +* - If bit 0 is set, it indicates the _RUNNING state. If bit 0 is clear, +* it indicates the _STOP state. When the device state is changed to +* _STOP, driver should stop the device before write() returns. +* - If bit 1 is set, it indicates the _SAVING state, which means that the +* driver should start gathering device state information that will be +* provided to the VFIO user application to save the device's state. +* - If bit 2 is set, it indicates the _RESUMING state, which means that +* the driver should prepare to resume the device. Data provided through +* the migration region should be used to resume the device. +* Bits 3 - 31 are reserved for future use. To preserve them, the user +* application should perform a read-modify-write operation on this +* field when modifying the specified bits. +* +* +------- _RESUMING +* |+------ _SAVING +* ||+----- _RUNNING +* ||| +* 000b => Device Stopped, not saving or resuming +* 001b => Device running, which is the default state +* 010b => Stop the device & save the device state, stop-and-copy state +* 011b => Device running and save the device state, pre-copy state +* 100b => Device stopped and the device state is resuming +* 101b => Invalid state +* 110b => Error state +* 111b => Invalid state +* +* State transitions: +* +* _RESUMING _RUNNING Pre-copy Stop-and-copy _STOP +* (100b) (001b) (011b) (010b) (000b) +* 0. Running or default state +* | +* +* 1. Normal Shutdown (optional) +* |------------------------------------->| +* +* 2. Save the state or suspend +* |------------------------->|---------->| +* +* 3. Save the state during live migration +* |----------->|------------>|---------->| +* +* 4. Resuming +* |<---------| +* +* 5. Resumed +* |--------->| +* +* 0. Default state of VFIO device is _RUNNNG when the user application starts. +* 1. During normal shutdown of the user application, the user application may +* optionally change the VFIO device state from _RUNNING to _STOP. This +* transition is optional. The vendor driver must support this transition but +* must not require it. +* 2. When the user application saves state or suspends the application, the +* device state transitions from _RUNNING to stop-and-copy and then to _STOP. +* On state transition from _RUNNING to stop-and-copy, driver must stop the +* device, save the device state and send it to the application through the +* migration region. The sequence to be followed for such transition is given +* below. +* 3. In live migration of user application, the state transitions from _RUNNING +* to pre-copy, to stop-and-copy, and to _STOP. +* On state transition from _RUNNING to pre-copy, the driver should start +* gathering the device state while the application is still running and send +* the device state data to application through the migration region. +* On state transition from pre-copy to stop-and-copy, the driver must stop +* the device, save the device state and send it to the user application +* through the migration region. +* Vendor drivers must support the pre-copy state even for implementations +* where no data is provided to the user before the stop-and-copy state. The +* user must not be required to consume all migration data before the device +* transitions to a new state, including the stop-and-copy state. +* The sequence to be followed for above two transitions is given below. +* 4. To start the resuming phase, the device state should be transitioned from +* the _RUNNING to the _RESUMING state. +* In the _RESUMING state, the driver should use the device state data +* received through the migration region to resume the device. +* 5. After providing saved device data to the driver, the application should +* change the state from _RESUMING to _RUNNING. +* +* reserved: +* Reads on this field return zero and writes are ignored. +* +* pending_bytes: (read only) +* The number of pending bytes still to be migrated from the vendor driver. +* +* data_offset: (read only) +* The user application should read data_offset field from the migration +* region. The user application should read the device data from this +* offset within the migration region during the _SAVING state or write +* the device data during the _RESUMING state. See below for details of +* sequence to be followed. +* +* data_size: (read/write) +* The user application should read data_size to get the size in bytes of +* the data copied in the migration region during the _SAVING state and +* write the size in bytes of the data copied in the migration region +* during the _RESUMING state. +* +* The format of the migration region is as follows: +* ------------------------------------------------------------------ +* |vfio_device_migration_info| data section | +* | | /////////////////////////////// | +* ------------------------------------------------------------------ +* ^ ^ +* offset 0-trapped part data_offset +* +* The structure vfio_device_migration_info is always followed by the data +* section in the region, so data_offset will always be nonzero. The offset +* from where the data is copied is decided by the kernel driver. The data +* section can be trapped, mmapped, or partitioned, depending on how the kernel +* driver defines the data section. The data section partition can be defined +* as mapped by the sparse mmap capability. If mmapped, data_offset must be +* page aligned, whereas initial section which contains the +* vfio_device_migration_info structure, might not end at the offset, which is +* page aligned. The user is not required to access through mmap regardless +* of the capabilities of the region mmap. +* The vendor driver should determine whether and how to partition the data +* section. The vendor driver should return data_offset accordingly. +* +* The sequence to be followed while in pre-copy state and stop-and-copy state +* is as follows: +* a. Read pending_bytes, indicating the start of a new iteration to get device +* data. Repeated read on pending_bytes at this stage should have no side +* effects. +* If pending_bytes == 0, the user application should not iterate to get data +* for that device. +* If pending_bytes > 0, perform the following steps. +* b. Read data_offset, indicating that the vendor driver should make data +* available through the data section. The vendor driver should return this +* read operation only after data is available from (region + data_offset) +* to (region + data_offset + data_size). +* c. Read data_size, which is the amount of data in bytes available through +* the migration region. +* Read on data_offset and data_size should return the offset and size of +* the current buffer if the user application reads data_offset and +* data_size more than once here. +* d. Read data_size bytes of data from (region + data_offset) from the +* migration region. +* e. Process the data. +* f. Read pending_bytes, which indicates that the data from the previous +* iteration has been read. If pending_bytes > 0, go to step b. +* +* The user application can transition from the _SAVING|_RUNNING +* (pre-copy state) to the _SAVING (stop-and-copy) state regardless of the +* number of pending bytes. The user application should iterate in _SAVING +* (stop-and-copy) until pending_bytes is 0. +* +* The sequence to be followed while _RESUMING device state is as follows: +* While data for this device is available, repeat the following steps: +* a. Read data_offset from where the user application should write data. +* b. Write migration data starting at the migration region + data_offset for +* the length determined by data_size from the migration source. +* c. Write data_size, which indicates to the vendor driver that data is +* written in the migration region. Vendor driver must return this write +* operations on consuming data. Vendor driver should apply the +* user-provided migration region data to the device resume state. +* +* If an error occurs during the above sequences, the vendor driver can return +* an error code for next read() or write() operation, which will terminate the +* loop. The user application should then take the next necessary action, for +* example, failing migration or terminating the user application. +* +* For the user application, data is opaque. The user application should write +* data in the same order as the data is received and the data should be of +* same transaction size at the source. +*/ + +struct vfio_device_migration_info { +__u32 device_state;/* VFIO device state */ +#define VFIO_DEVICE_STATE_STOP (0) +#define VFIO_DEVICE_STATE_RUNNING (1 << 0) +#define VFIO_DEVICE_STATE_SAVING (1 << 1) +#define VFIO_DEVICE_STATE_RESUMING (1 << 2) +#define VFIO_DEVICE_STATE_MASK (VFIO_DEVICE_STATE_RUNNING | \ + VFIO_DEVICE_STATE_SAVING | \ + VFIO_DEVICE_STATE_RESUMING) + +#define VFIO_DEVICE_STATE_VALID (state) \ + (state & VFIO_DEVICE_STATE_RESUMING ? \ + (state & VFIO_DEVICE_STATE_MASK) == VFIO_DEVICE_STATE_RESUMING : 1) + +#define VFIO_DEVICE_STATE_IS_ERROR (state) \ + ((state & VFIO_DEVICE_STATE_MASK) == (VFIO_DEVICE_STATE_SAVING | \ + VFIO_DEVICE_STATE_RESUMING)) + +#define VFIO_DEVICE_STATE_SET_ERROR (state) \ + ((state & ~VFIO_DEVICE_STATE_MASK) | VFIO_DEVICE_SATE_SAVING | \ + VFIO_DEVICE_STATE_RESUMING) + +__u32 reserved; +__u64 pending_bytes; +__u64 data_offset; +__u64 data_size; +}; +/* * The MSIX mappable capability informs that MSIX data of a BAR can be mmapped * which allows direct access to non-MSIX registers which happened to be within
Signature · 1 line
2.7.0
PATCH v19 2/8 vfio iommu: Remove atomicity of ref_count of pinned pages
In reply to Kirti Wankhedevfio_pfn.ref_count is always updated while holding iommu->lock, using atomic variable is overkill.
--- drivers/vfio/vfio_iommu_type1.c | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-)
drivers/vfio/vfio_iommu_type1.c +5 -4
@@ -112,7 +112,7 @@ struct vfio_pfn {struct rb_node node;dma_addr_t iova;/* Device address */ unsigned long pfn;/* Host pfn */ -atomic_t ref_count; +unsigned int ref_count; };struct vfio_regions {
@@ -233,7 +233,7 @@ static int vfio_add_to_pfn_list(struct vfio_dma *dma, dma_addr_t iova, vpfn->iova = iova; vpfn->pfn = pfn; -atomic_set (&vpfn->ref_count,1 ); + vpfn->ref_count =1 ;vfio_link_pfn (dma, vpfn);return 0 ; }
@@ -251,7 +251,7 @@ static struct vfio_pfn *vfio_iova_get_vfio_pfn(struct vfio_dma *dma,struct vfio_pfn *vpfn =vfio_find_vpfn (dma, iova);if (vpfn) -atomic_inc (&vpfn->ref_count); + vpfn->ref_count++;return vpfn; }
@@ -259,7 +259,8 @@ static int vfio_iova_put_vfio_pfn(struct vfio_dma *dma, struct vfio_pfn *vpfn) {int ret =0 ; -if (atomic_dec_and_test (&vpfn->ref_count)) { + vpfn->ref_count--; +if (!vpfn->ref_count) { ret =put_pfn (vpfn->pfn, dma->prot);vfio_remove_from_pfn_list (dma, vpfn); }
Signature · 1 line
2.7.0
PATCH v19 3/8 vfio iommu: Cache pgsize_bitmap in struct vfio_iommu
In reply to Kirti WankhedeCalculate and cache pgsize_bitmap when iommu->domain_list is updated. Add iommu->lock protection when cached pgsize_bitmap is accessed.
--- drivers/vfio/vfio_iommu_type1.c | 87 +++++++++++++++++++++++------------------ 1 file changed, 48 insertions(+), 39 deletions(-)
drivers/vfio/vfio_iommu_type1.c +48 -39
@@ -69,6 +69,7 @@ struct vfio_iommu {struct rb_root dma_list;struct blocking_notifier_head notifier;unsigned int dma_avail; +uint64_t pgsize_bitmap;bool v2;bool nesting; };
@@ -805,15 +806,14 @@ static void vfio_remove_dma(struct vfio_iommu *iommu, struct vfio_dma *dma) iommu->dma_avail++; } -static unsigned long vfio_pgsize_bitmap (struct vfio_iommu *iommu) +static void vfio_pgsize_bitmap (struct vfio_iommu *iommu) {struct vfio_domain *domain; -unsigned long bitmap =ULONG_MAX ; -mutex_lock (&iommu->lock); + iommu->pgsize_bitmap =ULONG_MAX ; +list_for_each_entry (domain, &iommu->domain_list, next) - bitmap &= domain->domain->pgsize_bitmap; -mutex_unlock (&iommu->lock); + iommu->pgsize_bitmap &= domain->domain->pgsize_bitmap;/* * In case the IOMMU supports page sizes smaller than PAGE_SIZE
@@ -823,12 +823,10 @@ static unsigned long vfio_pgsize_bitmap(struct vfio_iommu *iommu)* granularity while iommu driver can use the sub-PAGE_SIZE size * to map the buffer. */ -if (bitmap & ~PAGE_MASK ) { - bitmap &=PAGE_MASK ; - bitmap |=PAGE_SIZE ; +if (iommu->pgsize_bitmap & ~PAGE_MASK ) { + iommu->pgsize_bitmap &=PAGE_MASK ; + iommu->pgsize_bitmap |=PAGE_SIZE ; } - -return bitmap; } static int vfio_dma_do_unmap(struct vfio_iommu *iommu,
@@ -839,19 +837,28 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu,size_t unmapped =0 ;int ret =0 , retries =0 ; - mask = ((uint64_t )1 <<__ffs (vfio_pgsize_bitmap (iommu))) -1 ; +mutex_lock (&iommu->lock); + + mask = ((uint64_t )1 <<__ffs (iommu->pgsize_bitmap)) -1 ; + +if (unmap->iova & mask) { + ret = -EINVAL ; + goto unlock; + } + +if (!unmap->size || unmap->size & mask) { + ret = -EINVAL ; + goto unlock; + } -if (unmap->iova & mask) -return -EINVAL ; -if (!unmap->size || unmap->size & mask) -return -EINVAL ;if (unmap->iova + unmap->size -1 < unmap->iova || - unmap->size >SIZE_MAX ) -return -EINVAL ; + unmap->size >SIZE_MAX ) { + ret = -EINVAL ; + goto unlock; + }WARN_ON (mask &PAGE_MASK ); again: -mutex_lock (&iommu->lock);/* * vfio-iommu-type1 (v1) - User mappings were coalesced together to
@@ -930,6 +937,7 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu,blocking_notifier_call_chain (&iommu->notifier,VFIO_IOMMU_NOTIFY_DMA_UNMAP , &nb_unmap); +mutex_lock (&iommu->lock); goto again; } unmapped += dma->size;
@@ -1045,24 +1053,28 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,if (map->size != size || map->vaddr != vaddr || map->iova != iova)return -EINVAL ; - mask = ((uint64_t )1 <<__ffs (vfio_pgsize_bitmap (iommu))) -1 ; - -WARN_ON (mask &PAGE_MASK ); -/* READ/WRITE from device perspective */ if (map->flags &VFIO_DMA_MAP_FLAG_WRITE ) prot |=IOMMU_WRITE ;if (map->flags &VFIO_DMA_MAP_FLAG_READ ) prot |=IOMMU_READ ; -if (!prot || !size || (size | iova | vaddr) & mask) -return -EINVAL ; +mutex_lock (&iommu->lock); -/* Don't allow IOVA or virtual address wrap */ -if (iova + size -1 < iova || vaddr + size -1 < vaddr) -return -EINVAL ; + mask = ((uint64_t )1 <<__ffs (iommu->pgsize_bitmap)) -1 ; -mutex_lock (&iommu->lock); +WARN_ON (mask &PAGE_MASK ); + +if (!prot || !size || (size | iova | vaddr) & mask) { + ret = -EINVAL ; + goto out_unlock; + } + +/* Don't allow IOVA or virtual address wrap */ +if (iova + size -1 < iova || vaddr + size -1 < vaddr) { + ret = -EINVAL ; + goto out_unlock; + }if (vfio_find_dma (iommu, iova, size)) { ret = -EEXIST ;
@@ -1793,6 +1805,7 @@ static int vfio_iommu_type1_attach_group(void *iommu_data, }list_add (&domain->next, &iommu->domain_list); +vfio_pgsize_bitmap (iommu); done:/* Delete the old one and insert new iova list */ vfio_iommu_iova_insert_copy (iommu, &iova_copy);
@@ -2004,6 +2017,7 @@ static void vfio_iommu_type1_detach_group(void *iommu_data,list_del (&domain->next);kfree (domain);vfio_iommu_aper_expand (iommu, &iova_copy); +vfio_pgsize_bitmap (iommu); }break ; }
@@ -2136,8 +2150,6 @@ static int vfio_iommu_iova_build_caps(struct vfio_iommu *iommu,size_t size;int iovas =0 , i =0 , ret; -mutex_lock (&iommu->lock); -list_for_each_entry (iova, &iommu->iova_list, list) iovas++;
@@ -2146,17 +2158,14 @@ static int vfio_iommu_iova_build_caps(struct vfio_iommu *iommu,* Return 0 as a container with a single mdev device * will have an empty list */ - ret =0 ; - goto out_unlock; +return 0 ; } size =sizeof (*cap_iovas) + (iovas *sizeof (*cap_iovas->iova_ranges)); cap_iovas =kzalloc (size,GFP_KERNEL ); -if (!cap_iovas) { - ret = -ENOMEM ; - goto out_unlock; - } +if (!cap_iovas) +return -ENOMEM ; cap_iovas->nr_iovas = iovas;
@@ -2169,8 +2178,6 @@ static int vfio_iommu_iova_build_caps(struct vfio_iommu *iommu, ret =vfio_iommu_iova_add_cap (caps, cap_iovas, size);kfree (cap_iovas); -out_unlock: -mutex_unlock (&iommu->lock);return ret; }
@@ -2215,11 +2222,13 @@ static long vfio_iommu_type1_ioctl(void *iommu_data, info.cap_offset =0 ;/* output, no-recopy necessary */ } +mutex_lock (&iommu->lock); info.flags =VFIO_IOMMU_INFO_PGSIZES ; - info.iova_pgsizes =vfio_pgsize_bitmap (iommu); + info.iova_pgsizes = iommu->pgsize_bitmap; ret =vfio_iommu_iova_build_caps (iommu, &caps); +mutex_unlock (&iommu->lock);if (ret)return ret;
Signature · 1 line
2.7.0
PATCH v19 4/8 vfio iommu: Add ioctl definition for dirty pages tracking.
In reply to Kirti WankhedeIOMMU container maintains a list of all pages pinned by vfio_pin_pages API. All pages pinned by vendor driver through this API should be considered as dirty during migration. When container consists of IOMMU capable device and all pages are pinned and mapped, then all pages are marked dirty. Added support to start/stop dirtied pages tracking and to get bitmap of all dirtied pages for requested IO virtual address range.
--- include/uapi/linux/vfio.h | 56 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+)
include/uapi/linux/vfio.h +56 -0
@@ -1033,6 +1033,12 @@ struct vfio_iommu_type1_dma_map {#define VFIO_IOMMU_MAP_DMA _IO(VFIO_TYPE, VFIO_BASE + 13) +struct vfio_bitmap { +__u64 pgsize;/* page size for bitmap in bytes */ +__u64 size;/* in bytes */ +__u64 __user *data;/* one bit per page */ +}; +/** * VFIO_IOMMU_UNMAP_DMA - _IOWR(VFIO_TYPE, VFIO_BASE + 14, * struct vfio_dma_unmap)
@@ -1059,6 +1065,56 @@ struct vfio_iommu_type1_dma_unmap {#define VFIO_IOMMU_ENABLE _IO(VFIO_TYPE, VFIO_BASE + 15)#define VFIO_IOMMU_DISABLE _IO(VFIO_TYPE, VFIO_BASE + 16) +/** +* VFIO_IOMMU_DIRTY_PAGES - _IOWR(VFIO_TYPE, VFIO_BASE + 17, +* struct vfio_iommu_type1_dirty_bitmap) +* IOCTL is used for dirty pages tracking. +* Caller should set flag depending on which operation to perform, details as +* below: +* +* When IOCTL is called with VFIO_IOMMU_DIRTY_PAGES_FLAG_START set, indicates +* migration is active and IOMMU module should track pages which are dirtied or +* potentially dirtied by device. +* Dirty pages are tracked until tracking is stopped by user application by +* setting VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP flag. +* +* When IOCTL is called with VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP set, indicates +* IOMMU should stop tracking dirtied pages. +* +* When IOCTL is called with VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP flag set, +* IOCTL returns dirty pages bitmap for IOMMU container during migration for +* given IOVA range. User must provide data[] as the structure +* vfio_iommu_type1_dirty_bitmap_get through which user provides IOVA range and +* pgsize. IOVA range must match to that used in original mapping call. This +* interface supports to get bitmap of smallest supported pgsize only and can +* be modified in future to get bitmap of specified pgsize. +* User must allocate memory for bitmap and set size of allocated memory in +* bitmap.size field. One bit is used to represent one page consecutively +* starting from iova offset. User should provide page size in bitmap.pgsize +* field. Bit set in bitmap indicates page at that offset from iova is +* dirty. Caller must set argsz including size of structure +* vfio_iommu_type1_dirty_bitmap_get. +* +* Only one of the flags _START, STOP and _GET may be specified at a time. +* +*/ +struct vfio_iommu_type1_dirty_bitmap { +__u32 argsz; +__u32 flags; +#define VFIO_IOMMU_DIRTY_PAGES_FLAG_START (1 << 0) +#define VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP (1 << 1) +#define VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP (1 << 2) +__u8 data[]; +}; + +struct vfio_iommu_type1_dirty_bitmap_get { +__u64 iova;/* IO virtual address */ +__u64 size;/* Size of iova range */ +struct vfio_bitmap bitmap; +}; + +#define VFIO_IOMMU_DIRTY_PAGES _IO(VFIO_TYPE, VFIO_BASE + 17) +/* -------- Additional API for SPAPR TCE (Server POWERPC) IOMMU -------- */ /*
Signature · 1 line
2.7.0
PATCH v19 5/8 vfio iommu: Implementation of ioctl for dirty pages tracking
In reply to Kirti WankhedeVFIO_IOMMU_DIRTY_PAGES ioctl performs three operations:
- Start dirty pages tracking while migration is active
- Stop dirty pages tracking.
- Get dirty pages bitmap. Its user space application's responsibility to copy content of dirty pages from source to destination during migration.
To prevent DoS attack, memory for bitmap is allocated per vfio_dma structure. Bitmap size is calculated considering smallest supported page size. Bitmap is allocated for all vfio_dmas when dirty logging is enabled
Bitmap is populated for already pinned pages when bitmap is allocated for a vfio_dma with the smallest supported page size. Update bitmap from pinning functions when tracking is enabled. When user application queries bitmap, check if requested page size is same as page size used to populated bitmap. If it is equal, copy bitmap, but if not equal, return error.
Fixed error reported by build bot by changing pgsize type from uint64_t to size_t.
--- drivers/vfio/vfio_iommu_type1.c | 274 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 268 insertions(+), 6 deletions(-)
drivers/vfio/vfio_iommu_type1.c +268 -6
@@ -72,6 +72,7 @@ struct vfio_iommu {uint64_t pgsize_bitmap;bool v2;bool nesting; +bool dirty_page_tracking; };struct vfio_domain {
@@ -92,6 +93,7 @@ struct vfio_dma {bool lock_cap;/* capable(CAP_IPC_LOCK) */ struct task_struct *task;struct rb_root pfn_list;/* Ex-user pinned pfn list */ +unsigned long *bitmap; };struct vfio_group {
@@ -126,6 +128,19 @@ struct vfio_regions {#define IS_IOMMU_CAP_DOMAIN_IN_CONTAINER (iommu) \ (!list_empty(&iommu->domain_list)) +#define DIRTY_BITMAP_BYTES (n) (ALIGN(n, BITS_PER_TYPE(u64)) / BITS_PER_BYTE) + +/* +* Input argument of number of bits to bitmap_set() is unsigned integer, which +* further casts to signed integer for unaligned multi-bit operation, +* __bitmap_set(). +* Then maximum bitmap size supported is 2^31 bits divided by 2^3 bits/byte, +* that is 2^28 (256 MB) which maps to 2^31 * 2^12 = 2^43 (8TB) on 4K page +* system. +*/ +#define DIRTY_BITMAP_PAGES_MAX ((u64)INT_MAX) +#define DIRTY_BITMAP_SIZE_MAX DIRTY_BITMAP_BYTES(DIRTY_BITMAP_PAGES_MAX) +static int put_pfn (unsigned long pfn,int prot);/*
@@ -176,6 +191,77 @@ static void vfio_unlink_dma(struct vfio_iommu *iommu, struct vfio_dma *old)rb_erase (&old->node, &iommu->dma_list); } + +static int vfio_dma_bitmap_alloc (struct vfio_dma *dma,size_t pgsize) +{ +uint64_t npages = dma->size / pgsize; + +if (npages >DIRTY_BITMAP_PAGES_MAX ) +return -EINVAL ; + + dma->bitmap =kvzalloc (DIRTY_BITMAP_BYTES (npages),GFP_KERNEL ); +if (!dma->bitmap) +return -ENOMEM ; + +return 0 ; +} + +static void vfio_dma_bitmap_free (struct vfio_dma *dma) +{ +kfree (dma->bitmap); + dma->bitmap =NULL ; +} + +static void vfio_dma_populate_bitmap (struct vfio_dma *dma,size_t pgsize) +{ +struct rb_node *p; + +if (RB_EMPTY_ROOT (&dma->pfn_list)) +return ; + +for (p =rb_first (&dma->pfn_list); p; p =rb_next (p)) { + struct vfio_pfn *vpfn = rb_entry(p, struct vfio_pfn, node); + +bitmap_set (dma->bitmap, (vpfn->iova - dma->iova) / pgsize,1 ); + } +} + +static int vfio_dma_bitmap_alloc_all (struct vfio_iommu *iommu,size_t pgsize) +{ +struct rb_node *n =rb_first (&iommu->dma_list); + +for (; n; n =rb_next (n)) { + struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node); +int ret; + + ret =vfio_dma_bitmap_alloc (dma, pgsize); +if (ret) { +struct rb_node *p =rb_prev (n); + +for (; p; p =rb_prev (p)) { +struct vfio_dma *dma =rb_entry (n, + struct vfio_dma, node); + +vfio_dma_bitmap_free (dma); + } +return ret; + } +vfio_dma_populate_bitmap (dma, pgsize); + } +return 0 ; +} + +static void vfio_dma_bitmap_free_all (struct vfio_iommu *iommu) +{ +struct rb_node *n =rb_first (&iommu->dma_list); + +for (; n; n =rb_next (n)) { + struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node); + +vfio_dma_bitmap_free (dma); + } +} +/* * Helper Functions for host iova-pfn list */
@@ -568,6 +654,17 @@ static int vfio_iommu_type1_pin_pages(void *iommu_data,vfio_unpin_page_external (dma, iova, do_accounting); goto pin_unwind; } + +if (iommu->dirty_page_tracking) { +unsigned long pgshift =__ffs (iommu->pgsize_bitmap); + +/* +* Bitmap populated with the smallest supported page +* size +*/ +bitmap_set (dma->bitmap, + (vpfn->iova - dma->iova) >> pgshift,1 ); + } } ret = i;
@@ -802,6 +899,7 @@ static void vfio_remove_dma(struct vfio_iommu *iommu, struct vfio_dma *dma)vfio_unmap_unpin (iommu, dma, true);vfio_unlink_dma (iommu, dma);put_task_struct (dma->task); +vfio_dma_bitmap_free (dma);kfree (dma); iommu->dma_avail++; }
@@ -829,6 +927,57 @@ static void vfio_pgsize_bitmap(struct vfio_iommu *iommu) } } +static int vfio_iova_dirty_bitmap (struct vfio_iommu *iommu,dma_addr_t iova, +size_t size,size_t pgsize, +u64 __user *bitmap) +{ +struct vfio_dma *dma; +unsigned long pgshift =__ffs (pgsize); +unsigned int npages, bitmap_size; + + dma =vfio_find_dma (iommu, iova,1 ); + +if (!dma) +return -EINVAL ; + +if (dma->iova != iova || dma->size != size) +return -EINVAL ; + + npages = dma->size >> pgshift; + bitmap_size =DIRTY_BITMAP_BYTES (npages); + +/* mark all pages dirty if all pages are pinned and mapped. */ +if (dma->iommu_mapped) +bitmap_set (dma->bitmap,0 , npages); + +if (copy_to_user ((void __user *)bitmap, dma->bitmap, bitmap_size)) +return -EFAULT ; + +/* +* Re-populate bitmap to include all pinned pages which are considered +* as dirty but exclude pages which are unpinned and pages which are +* marked dirty by vfio_dma_rw() +*/ +bitmap_clear (dma->bitmap,0 , npages); +vfio_dma_populate_bitmap (dma, pgsize); +return 0 ; +} + +static int verify_bitmap_size (uint64_t npages,uint64_t bitmap_size) +{ +uint64_t bsize; + +if (!npages || !bitmap_size || (bitmap_size >DIRTY_BITMAP_SIZE_MAX )) +return -EINVAL ; + + bsize =DIRTY_BITMAP_BYTES (npages); + +if (bitmap_size < bsize) +return -EINVAL ; + +return 0 ; +} +static int vfio_dma_do_unmap (struct vfio_iommu *iommu,struct vfio_iommu_type1_dma_unmap *unmap) {
@@ -1046,7 +1195,7 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,unsigned long vaddr = map->vaddr;size_t size = map->size;int ret =0 , prot =0 ; -uint64_t mask; +size_t pgsize;struct vfio_dma *dma;/* Verify that none of our __u64 fields overflow */
@@ -1061,11 +1210,11 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,mutex_lock (&iommu->lock); - mask = ((uint64_t )1 <<__ffs (iommu->pgsize_bitmap)) -1 ; + pgsize = (size_t )1 <<__ffs (iommu->pgsize_bitmap); -WARN_ON (mask &PAGE_MASK ); +WARN_ON ((pgsize -1 ) &PAGE_MASK ); -if (!prot || !size || (size | iova | vaddr) & mask) { +if (!prot || !size || (size | iova | vaddr) & (pgsize -1 )) { ret = -EINVAL ; goto out_unlock; }
@@ -1142,6 +1291,12 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,else ret =vfio_pin_map_dma (iommu, dma, size); +if (!ret && iommu->dirty_page_tracking) { + ret =vfio_dma_bitmap_alloc (dma, pgsize); +if (ret) +vfio_remove_dma (iommu, dma); + } + out_unlock:mutex_unlock (&iommu->lock);return ret;
@@ -2287,6 +2442,104 @@ static long vfio_iommu_type1_ioctl(void *iommu_data,return copy_to_user ((void __user *)arg, &unmap, minsz) ? -EFAULT :0 ; + }else if (cmd ==VFIO_IOMMU_DIRTY_PAGES ) { +struct vfio_iommu_type1_dirty_bitmap dirty; +uint32_t mask =VFIO_IOMMU_DIRTY_PAGES_FLAG_START | +VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP | +VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP ; +int ret =0 ; + +if (!iommu->v2) +return -EACCES ; + + minsz = offsetofend(struct vfio_iommu_type1_dirty_bitmap, + flags); + +if (copy_from_user (&dirty, (void __user *)arg, minsz)) +return -EFAULT ; + +if (dirty.argsz < minsz || dirty.flags & ~mask) +return -EINVAL ; + +/* only one flag should be set at a time */ +if (__ffs (dirty.flags) !=__fls (dirty.flags)) +return -EINVAL ; + +if (dirty.flags &VFIO_IOMMU_DIRTY_PAGES_FLAG_START ) { +size_t pgsize; + +mutex_lock (&iommu->lock); + pgsize =1 <<__ffs (iommu->pgsize_bitmap); +if (!iommu->dirty_page_tracking) { + ret =vfio_dma_bitmap_alloc_all (iommu, pgsize); +if (!ret) + iommu->dirty_page_tracking = true; + } +mutex_unlock (&iommu->lock); +return ret; + }else if (dirty.flags &VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP ) { +mutex_lock (&iommu->lock); +if (iommu->dirty_page_tracking) { + iommu->dirty_page_tracking = false; +vfio_dma_bitmap_free_all (iommu); + } +mutex_unlock (&iommu->lock); +return 0 ; + }else if (dirty.flags & +VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP ) { +struct vfio_iommu_type1_dirty_bitmap_get range; +unsigned long pgshift; +size_t data_size = dirty.argsz - minsz; +size_t iommu_pgsize; + +if (!data_size || data_size <sizeof (range)) +return -EINVAL ; + +if (copy_from_user (&range, (void __user *)(arg + minsz), +sizeof (range))) +return -EFAULT ; + +if (range.iova + range.size < range.iova) +return -EINVAL ; +if (!access_ok ((void __user *)range.bitmap.data, + range.bitmap.size)) +return -EINVAL ; + + pgshift =__ffs (range.bitmap.pgsize); + ret =verify_bitmap_size (range.size >> pgshift, + range.bitmap.size); +if (ret) +return ret; + +mutex_lock (&iommu->lock); + + iommu_pgsize = (size_t )1 <<__ffs (iommu->pgsize_bitmap); + +/* allow only smallest supported pgsize */ +if (range.bitmap.pgsize != iommu_pgsize) { + ret = -EINVAL ; + goto out_unlock; + } +if (range.iova & (iommu_pgsize -1 )) { + ret = -EINVAL ; + goto out_unlock; + } +if (!range.size || range.size & (iommu_pgsize -1 )) { + ret = -EINVAL ; + goto out_unlock; + } + +if (iommu->dirty_page_tracking) + ret =vfio_iova_dirty_bitmap (iommu, range.iova, + range.size, range.bitmap.pgsize, + range.bitmap.data); +else + ret = -EINVAL ; +out_unlock: +mutex_unlock (&iommu->lock); + +return ret; + } }return -ENOTTY ;
@@ -2354,10 +2607,19 @@ static int vfio_iommu_type1_dma_rw_chunk(struct vfio_iommu *iommu, vaddr = dma->vaddr + offset; -if (write) +if (write) { *copied =copy_to_user ((void __user *)vaddr, data, count) ?0 : count; -else +if (*copied && iommu->dirty_page_tracking) { +unsigned long pgshift =__ffs (iommu->pgsize_bitmap); +/* +* Bitmap populated with the smallest supported page +* size +*/ +bitmap_set (dma->bitmap, offset >> pgshift, + *copied >> pgshift); + } + }else *copied =copy_from_user (data, (void __user *)vaddr, count) ?0 : count;if (kthread)
Signature · 1 line
2.7.0
Re: [PATCH Kernel v19 5/8] vfio iommu: Implementation of ioctl for dirty pages tracking
Quoted 88 lines · On Thu, 14 May 2020 01:34:36 +0530 Kirti Wankhede <[email protected]> wrote:
VFIO_IOMMU_DIRTY_PAGESioctl performs three operations:
- Start dirty pages tracking while migration is active
- Stop dirty pages tracking.
- Get dirty pages bitmap. Its user space application's responsibility to copy content of dirty pages from source to destination during migration.To prevent DoS attack, memory for bitmap is allocated per
vfio_dmastructure. Bitmap size is calculated considering smallest supported page size. Bitmap is allocated for allvfio_dmaswhen dirty logging is enabledBitmap is populated for already pinned pages when bitmap is allocated for a
vfio_dmawith the smallest supported page size. Update bitmap from pinning functions when tracking is enabled. When user application queries bitmap, check if requested page size is same as page size used to populated bitmap. If it is equal, copy bitmap, but if not equal, return error.Signed-off-by Kirti Wankhede <[email protected]>Reviewed-by Neo Jia <[email protected]>Fixed error reported by build bot by changing pgsize type from
uint64_ttosize_t.Reported-by kbuild test robot <[email protected]>--- drivers/vfio/vfio_iommu_type1.c | 274 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 268 insertions(+), 6 deletions(-)drivers/vfio/vfio_iommu_type1.c +32
-0@@ -72,6 +72,7 @@ struct vfio_iommu {uint64_t pgsize_bitmap;bool v2;bool nesting; +bool dirty_page_tracking; };struct vfio_domain {@@ -92,6 +93,7 @@ struct vfio_dma {bool lock_cap;/* capable(CAP_IPC_LOCK) */ struct task_struct *task;struct rb_root pfn_list;/* Ex-user pinned pfn list */ +unsigned long *bitmap; };struct vfio_group {@@ -126,6 +128,19 @@ struct vfio_regions {#define IS_IOMMU_CAP_DOMAIN_IN_CONTAINER (iommu) \ (!list_empty(&iommu->domain_list)) +#define DIRTY_BITMAP_BYTES (n) (ALIGN(n, BITS_PER_TYPE(u64)) / BITS_PER_BYTE) + +/* +* Input argument of number of bits to bitmap_set() is unsigned integer, which +* further casts to signed integer for unaligned multi-bit operation, +* __bitmap_set(). +* Then maximum bitmap size supported is 2^31 bits divided by 2^3 bits/byte, +* that is 2^28 (256 MB) which maps to 2^31 * 2^12 = 2^43 (8TB) on 4K page +* system. +*/ +#define DIRTY_BITMAP_PAGES_MAX ((u64)INT_MAX) +#define DIRTY_BITMAP_SIZE_MAX DIRTY_BITMAP_BYTES(DIRTY_BITMAP_PAGES_MAX) +static int put_pfn (unsigned long pfn,int prot);/* @@ -176,6 +191,77 @@ static void vfio_unlink_dma(struct vfio_iommu *iommu, struct vfio_dma *old)rb_erase (&old->node, &iommu->dma_list); } + +static int vfio_dma_bitmap_alloc (struct vfio_dma *dma,size_t pgsize) +{ +uint64_t npages = dma->size / pgsize; + +if (npages >DIRTY_BITMAP_PAGES_MAX ) +return -EINVAL ; + + dma->bitmap =kvzalloc (DIRTY_BITMAP_BYTES (npages),GFP_KERNEL ); +if (!dma->bitmap) +return -ENOMEM ; + +return 0 ; +} + +static void vfio_dma_bitmap_free (struct vfio_dma *dma) +{
drivers/vfio/vfio_iommu_type1.c static void vfio_unlink_dma(struct vfio_iommu *iommu, struct vfio_dma *old) · line 220
Quoted 10 lines
drivers/vfio/vfio_iommu_type1.c +10
-0+kfree (dma->bitmap); + dma->bitmap =NULL ; +} + +static void vfio_dma_populate_bitmap (struct vfio_dma *dma,size_t pgsize) +{ +struct rb_node *p; + +if (RB_EMPTY_ROOT (&dma->pfn_list)) +return ;
I don't think this is optimizing anything:
#define RB_EMPTY_ROOT(root) (READ_ONCE((root)->rb_node) == NULL)
struct rb_node *rb_first(const struct rb_root *root)
{
struct rb_node *n;
n = root->rb_node;
if (!n)
return NULL;So the loop below won't be entered if the tree is empty.
Quoted 82 lines
drivers/vfio/vfio_iommu_type1.c +61
-0+ +for (p =rb_first (&dma->pfn_list); p; p =rb_next (p)) { + struct vfio_pfn *vpfn = rb_entry(p, struct vfio_pfn, node); + +bitmap_set (dma->bitmap, (vpfn->iova - dma->iova) / pgsize,1 ); + } +} + +static int vfio_dma_bitmap_alloc_all (struct vfio_iommu *iommu,size_t pgsize) +{ +struct rb_node *n =rb_first (&iommu->dma_list); + +for (; n; n =rb_next (n)) { + struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node); +int ret; + + ret =vfio_dma_bitmap_alloc (dma, pgsize); +if (ret) { +struct rb_node *p =rb_prev (n); + +for (; p; p =rb_prev (p)) { +struct vfio_dma *dma =rb_entry (n, + struct vfio_dma, node); + +vfio_dma_bitmap_free (dma); + } +return ret; + } +vfio_dma_populate_bitmap (dma, pgsize); + } +return 0 ; +} + +static void vfio_dma_bitmap_free_all (struct vfio_iommu *iommu) +{ +struct rb_node *n =rb_first (&iommu->dma_list); + +for (; n; n =rb_next (n)) { + struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node); + +vfio_dma_bitmap_free (dma); + } +} +/* * Helper Functions for host iova-pfn list */ @@ -568,6 +654,17 @@ static int vfio_iommu_type1_pin_pages(void *iommu_data,vfio_unpin_page_external (dma, iova, do_accounting); goto pin_unwind; } + +if (iommu->dirty_page_tracking) { +unsigned long pgshift =__ffs (iommu->pgsize_bitmap); + +/* +* Bitmap populated with the smallest supported page +* size +*/ +bitmap_set (dma->bitmap, + (vpfn->iova - dma->iova) >> pgshift,1 ); + } } ret = i;@@ -802,6 +899,7 @@ static void vfio_remove_dma(struct vfio_iommu *iommu, struct vfio_dma *dma)vfio_unmap_unpin (iommu, dma, true);vfio_unlink_dma (iommu, dma);put_task_struct (dma->task); +vfio_dma_bitmap_free (dma);kfree (dma); iommu->dma_avail++; }@@ -829,6 +927,57 @@ static void vfio_pgsize_bitmap(struct vfio_iommu *iommu) } } +static int vfio_iova_dirty_bitmap (struct vfio_iommu *iommu,dma_addr_t iova, +size_t size,size_t pgsize, +u64 __user *bitmap) +{ +struct vfio_dma *dma;
drivers/vfio/vfio_iommu_type1.c static void vfio_pgsize_bitmap(struct vfio_iommu *iommu) · line 944
Quoted 10 lines
drivers/vfio/vfio_iommu_type1.c +10
-0+unsigned long pgshift =__ffs (pgsize); +unsigned int npages, bitmap_size; + + dma =vfio_find_dma (iommu, iova,1 ); + +if (!dma) +return -EINVAL ; + +if (dma->iova != iova || dma->size != size) +return -EINVAL ;
Minor cleanup:
if (!dma || dma->iova != iova || dma->size != size) return -EINVAL;
Quoted 22 lines
drivers/vfio/vfio_iommu_type1.c +22
-0+ + npages = dma->size >> pgshift; + bitmap_size =DIRTY_BITMAP_BYTES (npages); + +/* mark all pages dirty if all pages are pinned and mapped. */ +if (dma->iommu_mapped) +bitmap_set (dma->bitmap,0 , npages); + +if (copy_to_user ((void __user *)bitmap, dma->bitmap, bitmap_size)) +return -EFAULT ; + +/* +* Re-populate bitmap to include all pinned pages which are considered +* as dirty but exclude pages which are unpinned and pages which are +* marked dirty by vfio_dma_rw() +*/ +bitmap_clear (dma->bitmap,0 , npages); +vfio_dma_populate_bitmap (dma, pgsize); +return 0 ; +} + +static int verify_bitmap_size (uint64_t npages,uint64_t bitmap_size)
drivers/vfio/vfio_iommu_type1.c static void vfio_pgsize_bitmap(struct vfio_iommu *iommu) · line 976
Quoted 10 lines
drivers/vfio/vfio_iommu_type1.c +10
-0+{ +uint64_t bsize; + +if (!npages || !bitmap_size || (bitmap_size >DIRTY_BITMAP_SIZE_MAX )) +return -EINVAL ; + + bsize =DIRTY_BITMAP_BYTES (npages); + +if (bitmap_size < bsize) +return -EINVAL ;
Another minor cleanup:
if (!npages || !bitmap_size || bitmap_size > DIRTY_BITMAP_SIZE_MAX || bitmap_size < DIRTY_BITMAP_BYTES(npages)) return -EINVAL;
Quoted 129 lines
drivers/vfio/vfio_iommu_type1.c +95
-4+ +return 0 ; +} +static int vfio_dma_do_unmap (struct vfio_iommu *iommu,struct vfio_iommu_type1_dma_unmap *unmap) {@@ -1046,7 +1195,7 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,unsigned long vaddr = map->vaddr;size_t size = map->size;int ret =0 , prot =0 ; -uint64_t mask; +size_t pgsize;struct vfio_dma *dma;/* Verify that none of our __u64 fields overflow */ @@ -1061,11 +1210,11 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,mutex_lock (&iommu->lock); - mask = ((uint64_t )1 <<__ffs (iommu->pgsize_bitmap)) -1 ; + pgsize = (size_t )1 <<__ffs (iommu->pgsize_bitmap); -WARN_ON (mask &PAGE_MASK ); +WARN_ON ((pgsize -1 ) &PAGE_MASK ); -if (!prot || !size || (size | iova | vaddr) & mask) { +if (!prot || !size || (size | iova | vaddr) & (pgsize -1 )) { ret = -EINVAL ; goto out_unlock; }@@ -1142,6 +1291,12 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,else ret =vfio_pin_map_dma (iommu, dma, size); +if (!ret && iommu->dirty_page_tracking) { + ret =vfio_dma_bitmap_alloc (dma, pgsize); +if (ret) +vfio_remove_dma (iommu, dma); + } + out_unlock:mutex_unlock (&iommu->lock);return ret;@@ -2287,6 +2442,104 @@ static long vfio_iommu_type1_ioctl(void *iommu_data,return copy_to_user ((void __user *)arg, &unmap, minsz) ? -EFAULT :0 ; + }else if (cmd ==VFIO_IOMMU_DIRTY_PAGES ) { +struct vfio_iommu_type1_dirty_bitmap dirty; +uint32_t mask =VFIO_IOMMU_DIRTY_PAGES_FLAG_START | +VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP | +VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP ; +int ret =0 ; + +if (!iommu->v2) +return -EACCES ; + + minsz = offsetofend(struct vfio_iommu_type1_dirty_bitmap, + flags); + +if (copy_from_user (&dirty, (void __user *)arg, minsz)) +return -EFAULT ; + +if (dirty.argsz < minsz || dirty.flags & ~mask) +return -EINVAL ; + +/* only one flag should be set at a time */ +if (__ffs (dirty.flags) !=__fls (dirty.flags)) +return -EINVAL ; + +if (dirty.flags &VFIO_IOMMU_DIRTY_PAGES_FLAG_START ) { +size_t pgsize; + +mutex_lock (&iommu->lock); + pgsize =1 <<__ffs (iommu->pgsize_bitmap); +if (!iommu->dirty_page_tracking) { + ret =vfio_dma_bitmap_alloc_all (iommu, pgsize); +if (!ret) + iommu->dirty_page_tracking = true; + } +mutex_unlock (&iommu->lock); +return ret; + }else if (dirty.flags &VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP ) { +mutex_lock (&iommu->lock); +if (iommu->dirty_page_tracking) { + iommu->dirty_page_tracking = false; +vfio_dma_bitmap_free_all (iommu); + } +mutex_unlock (&iommu->lock); +return 0 ; + }else if (dirty.flags & +VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP ) { +struct vfio_iommu_type1_dirty_bitmap_get range; +unsigned long pgshift; +size_t data_size = dirty.argsz - minsz; +size_t iommu_pgsize; + +if (!data_size || data_size <sizeof (range)) +return -EINVAL ; + +if (copy_from_user (&range, (void __user *)(arg + minsz), +sizeof (range))) +return -EFAULT ; + +if (range.iova + range.size < range.iova) +return -EINVAL ; +if (!access_ok ((void __user *)range.bitmap.data, + range.bitmap.size)) +return -EINVAL ; + + pgshift =__ffs (range.bitmap.pgsize); + ret =verify_bitmap_size (range.size >> pgshift, + range.bitmap.size); +if (ret) +return ret; + +mutex_lock (&iommu->lock); + + iommu_pgsize = (size_t )1 <<__ffs (iommu->pgsize_bitmap); + +/* allow only smallest supported pgsize */ +if (range.bitmap.pgsize != iommu_pgsize) { + ret = -EINVAL ; + goto out_unlock; + } +if (range.iova & (iommu_pgsize -1 )) { + ret = -EINVAL ; + goto out_unlock;
drivers/vfio/vfio_iommu_type1.c static long vfio_iommu_type1_ioctl(void *iommu_data, · line 2535
Quoted 10 lines
drivers/vfio/vfio_iommu_type1.c +10
-0+ } +if (!range.size || range.size & (iommu_pgsize -1 )) { + ret = -EINVAL ; + goto out_unlock; + } + +if (iommu->dirty_page_tracking) + ret =vfio_iova_dirty_bitmap (iommu, range.iova, + range.size, range.bitmap.pgsize, + range.bitmap.data);
Why does the unmap with dirty bitmap collection now support ranges covering multiple vfio_dmas, but this interface does not? Thanks,
Alex
Quoted 32 lines
drivers/vfio/vfio_iommu_type1.c +18
-2+else + ret = -EINVAL ; +out_unlock: +mutex_unlock (&iommu->lock); + +return ret; + } }return -ENOTTY ;@@ -2354,10 +2607,19 @@ static int vfio_iommu_type1_dma_rw_chunk(struct vfio_iommu *iommu, vaddr = dma->vaddr + offset; -if (write) +if (write) { *copied =copy_to_user ((void __user *)vaddr, data, count) ?0 : count; -else +if (*copied && iommu->dirty_page_tracking) { +unsigned long pgshift =__ffs (iommu->pgsize_bitmap); +/* +* Bitmap populated with the smallest supported page +* size +*/ +bitmap_set (dma->bitmap, offset >> pgshift, + *copied >> pgshift); + } + }else *copied =copy_from_user (data, (void __user *)vaddr, count) ?0 : count;if (kthread)
Re: [PATCH Kernel v19 5/8] vfio iommu: Implementation of ioctl for dirty pages tracking
Quoted 107 lines · Alex Williamson
Quoted 88 lines · On Thu, 14 May 2020 01:34:36 +0530 Kirti Wankhede <[email protected]> wrote:
VFIO_IOMMU_DIRTY_PAGESioctl performs three operations:
- Start dirty pages tracking while migration is active
- Stop dirty pages tracking.
- Get dirty pages bitmap. Its user space application's responsibility to copy content of dirty pages from source to destination during migration.To prevent DoS attack, memory for bitmap is allocated per
vfio_dmastructure. Bitmap size is calculated considering smallest supported page size. Bitmap is allocated for allvfio_dmaswhen dirty logging is enabledBitmap is populated for already pinned pages when bitmap is allocated for a
vfio_dmawith the smallest supported page size. Update bitmap from pinning functions when tracking is enabled. When user application queries bitmap, check if requested page size is same as page size used to populated bitmap. If it is equal, copy bitmap, but if not equal, return error.Signed-off-by Kirti Wankhede <[email protected]>Reviewed-by Neo Jia <[email protected]>Fixed error reported by build bot by changing pgsize type from
uint64_ttosize_t.Reported-by kbuild test robot <[email protected]>--- drivers/vfio/vfio_iommu_type1.c | 274 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 268 insertions(+), 6 deletions(-)drivers/vfio/vfio_iommu_type1.c +32
-0@@ -72,6 +72,7 @@ struct vfio_iommu {uint64_t pgsize_bitmap;bool v2;bool nesting; +bool dirty_page_tracking; };struct vfio_domain {@@ -92,6 +93,7 @@ struct vfio_dma {bool lock_cap;/* capable(CAP_IPC_LOCK) */ struct task_struct *task;struct rb_root pfn_list;/* Ex-user pinned pfn list */ +unsigned long *bitmap; };struct vfio_group {@@ -126,6 +128,19 @@ struct vfio_regions {#define IS_IOMMU_CAP_DOMAIN_IN_CONTAINER (iommu) \ (!list_empty(&iommu->domain_list)) +#define DIRTY_BITMAP_BYTES (n) (ALIGN(n, BITS_PER_TYPE(u64)) / BITS_PER_BYTE) + +/* +* Input argument of number of bits to bitmap_set() is unsigned integer, which +* further casts to signed integer for unaligned multi-bit operation, +* __bitmap_set(). +* Then maximum bitmap size supported is 2^31 bits divided by 2^3 bits/byte, +* that is 2^28 (256 MB) which maps to 2^31 * 2^12 = 2^43 (8TB) on 4K page +* system. +*/ +#define DIRTY_BITMAP_PAGES_MAX ((u64)INT_MAX) +#define DIRTY_BITMAP_SIZE_MAX DIRTY_BITMAP_BYTES(DIRTY_BITMAP_PAGES_MAX) +static int put_pfn (unsigned long pfn,int prot);/* @@ -176,6 +191,77 @@ static void vfio_unlink_dma(struct vfio_iommu *iommu, struct vfio_dma *old)rb_erase (&old->node, &iommu->dma_list); } + +static int vfio_dma_bitmap_alloc (struct vfio_dma *dma,size_t pgsize) +{ +uint64_t npages = dma->size / pgsize; + +if (npages >DIRTY_BITMAP_PAGES_MAX ) +return -EINVAL ; + + dma->bitmap =kvzalloc (DIRTY_BITMAP_BYTES (npages),GFP_KERNEL ); +if (!dma->bitmap) +return -ENOMEM ; + +return 0 ; +} + +static void vfio_dma_bitmap_free (struct vfio_dma *dma) +{drivers/vfio/vfio_iommu_type1.c static void vfio_unlink_dma(struct vfio_iommu *iommu, struct vfio_dma *old) · line 220
Quoted 10 lines
drivers/vfio/vfio_iommu_type1.c +10
-0+kfree (dma->bitmap); + dma->bitmap =NULL ; +} + +static void vfio_dma_populate_bitmap (struct vfio_dma *dma,size_t pgsize) +{ +struct rb_node *p; + +if (RB_EMPTY_ROOT (&dma->pfn_list)) +return ;I don't think this is optimizing anything:
#define
RB_EMPTY_ROOT(root)(READ_ONCE((root)->rb_node) == NULL)struct
rb_node*rb_first(const structrb_root*root)
Quoted 9 lines
{ struct rb_node *n; n = root->rb_node; if (!n) return NULL;So the loop below won't be entered if the tree is empty.
Removing empty check.
Quoted 272 lines
Quoted 82 lines
drivers/vfio/vfio_iommu_type1.c +61
-0+ +for (p =rb_first (&dma->pfn_list); p; p =rb_next (p)) { + struct vfio_pfn *vpfn = rb_entry(p, struct vfio_pfn, node); + +bitmap_set (dma->bitmap, (vpfn->iova - dma->iova) / pgsize,1 ); + } +} + +static int vfio_dma_bitmap_alloc_all (struct vfio_iommu *iommu,size_t pgsize) +{ +struct rb_node *n =rb_first (&iommu->dma_list); + +for (; n; n =rb_next (n)) { + struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node); +int ret; + + ret =vfio_dma_bitmap_alloc (dma, pgsize); +if (ret) { +struct rb_node *p =rb_prev (n); + +for (; p; p =rb_prev (p)) { +struct vfio_dma *dma =rb_entry (n, + struct vfio_dma, node); + +vfio_dma_bitmap_free (dma); + } +return ret; + } +vfio_dma_populate_bitmap (dma, pgsize); + } +return 0 ; +} + +static void vfio_dma_bitmap_free_all (struct vfio_iommu *iommu) +{ +struct rb_node *n =rb_first (&iommu->dma_list); + +for (; n; n =rb_next (n)) { + struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node); + +vfio_dma_bitmap_free (dma); + } +} +/* * Helper Functions for host iova-pfn list */ @@ -568,6 +654,17 @@ static int vfio_iommu_type1_pin_pages(void *iommu_data,vfio_unpin_page_external (dma, iova, do_accounting); goto pin_unwind; } + +if (iommu->dirty_page_tracking) { +unsigned long pgshift =__ffs (iommu->pgsize_bitmap); + +/* +* Bitmap populated with the smallest supported page +* size +*/ +bitmap_set (dma->bitmap, + (vpfn->iova - dma->iova) >> pgshift,1 ); + } } ret = i;@@ -802,6 +899,7 @@ static void vfio_remove_dma(struct vfio_iommu *iommu, struct vfio_dma *dma)vfio_unmap_unpin (iommu, dma, true);vfio_unlink_dma (iommu, dma);put_task_struct (dma->task); +vfio_dma_bitmap_free (dma);kfree (dma); iommu->dma_avail++; }@@ -829,6 +927,57 @@ static void vfio_pgsize_bitmap(struct vfio_iommu *iommu) } } +static int vfio_iova_dirty_bitmap (struct vfio_iommu *iommu,dma_addr_t iova, +size_t size,size_t pgsize, +u64 __user *bitmap) +{ +struct vfio_dma *dma;drivers/vfio/vfio_iommu_type1.c static void vfio_pgsize_bitmap(struct vfio_iommu *iommu) · line 944
Quoted 10 lines
drivers/vfio/vfio_iommu_type1.c +10
-0+unsigned long pgshift =__ffs (pgsize); +unsigned int npages, bitmap_size; + + dma =vfio_find_dma (iommu, iova,1 ); + +if (!dma) +return -EINVAL ; + +if (dma->iova != iova || dma->size != size) +return -EINVAL ;Minor cleanup:
if (!dma || dma->iova != iova || dma->size != size) return -EINVAL;Quoted 22 lines
drivers/vfio/vfio_iommu_type1.c +22
-0+ + npages = dma->size >> pgshift; + bitmap_size =DIRTY_BITMAP_BYTES (npages); + +/* mark all pages dirty if all pages are pinned and mapped. */ +if (dma->iommu_mapped) +bitmap_set (dma->bitmap,0 , npages); + +if (copy_to_user ((void __user *)bitmap, dma->bitmap, bitmap_size)) +return -EFAULT ; + +/* +* Re-populate bitmap to include all pinned pages which are considered +* as dirty but exclude pages which are unpinned and pages which are +* marked dirty by vfio_dma_rw() +*/ +bitmap_clear (dma->bitmap,0 , npages); +vfio_dma_populate_bitmap (dma, pgsize); +return 0 ; +} + +static int verify_bitmap_size (uint64_t npages,uint64_t bitmap_size)drivers/vfio/vfio_iommu_type1.c static void vfio_pgsize_bitmap(struct vfio_iommu *iommu) · line 976
Quoted 10 lines
drivers/vfio/vfio_iommu_type1.c +10
-0+{ +uint64_t bsize; + +if (!npages || !bitmap_size || (bitmap_size >DIRTY_BITMAP_SIZE_MAX )) +return -EINVAL ; + + bsize =DIRTY_BITMAP_BYTES (npages); + +if (bitmap_size < bsize) +return -EINVAL ;Another minor cleanup:
if (!npages || !bitmap_size || bitmap_size > DIRTY_BITMAP_SIZE_MAX || bitmap_size < DIRTY_BITMAP_BYTES(npages)) return -EINVAL;Quoted 135 lines
drivers/vfio/vfio_iommu_type1.c +101
-4+ +return 0 ; +} +static int vfio_dma_do_unmap (struct vfio_iommu *iommu,struct vfio_iommu_type1_dma_unmap *unmap) {@@ -1046,7 +1195,7 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,unsigned long vaddr = map->vaddr;size_t size = map->size;int ret =0 , prot =0 ; -uint64_t mask; +size_t pgsize;struct vfio_dma *dma;/* Verify that none of our __u64 fields overflow */ @@ -1061,11 +1210,11 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,mutex_lock (&iommu->lock); - mask = ((uint64_t )1 <<__ffs (iommu->pgsize_bitmap)) -1 ; + pgsize = (size_t )1 <<__ffs (iommu->pgsize_bitmap); -WARN_ON (mask &PAGE_MASK ); +WARN_ON ((pgsize -1 ) &PAGE_MASK ); -if (!prot || !size || (size | iova | vaddr) & mask) { +if (!prot || !size || (size | iova | vaddr) & (pgsize -1 )) { ret = -EINVAL ; goto out_unlock; }@@ -1142,6 +1291,12 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,else ret =vfio_pin_map_dma (iommu, dma, size); +if (!ret && iommu->dirty_page_tracking) { + ret =vfio_dma_bitmap_alloc (dma, pgsize); +if (ret) +vfio_remove_dma (iommu, dma); + } + out_unlock:mutex_unlock (&iommu->lock);return ret;@@ -2287,6 +2442,104 @@ static long vfio_iommu_type1_ioctl(void *iommu_data,return copy_to_user ((void __user *)arg, &unmap, minsz) ? -EFAULT :0 ; + }else if (cmd ==VFIO_IOMMU_DIRTY_PAGES ) { +struct vfio_iommu_type1_dirty_bitmap dirty; +uint32_t mask =VFIO_IOMMU_DIRTY_PAGES_FLAG_START | +VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP | +VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP ; +int ret =0 ; + +if (!iommu->v2) +return -EACCES ; + + minsz = offsetofend(struct vfio_iommu_type1_dirty_bitmap, + flags); + +if (copy_from_user (&dirty, (void __user *)arg, minsz)) +return -EFAULT ; + +if (dirty.argsz < minsz || dirty.flags & ~mask) +return -EINVAL ; + +/* only one flag should be set at a time */ +if (__ffs (dirty.flags) !=__fls (dirty.flags)) +return -EINVAL ; + +if (dirty.flags &VFIO_IOMMU_DIRTY_PAGES_FLAG_START ) { +size_t pgsize; + +mutex_lock (&iommu->lock); + pgsize =1 <<__ffs (iommu->pgsize_bitmap); +if (!iommu->dirty_page_tracking) { + ret =vfio_dma_bitmap_alloc_all (iommu, pgsize); +if (!ret) + iommu->dirty_page_tracking = true; + } +mutex_unlock (&iommu->lock); +return ret; + }else if (dirty.flags &VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP ) { +mutex_lock (&iommu->lock); +if (iommu->dirty_page_tracking) { + iommu->dirty_page_tracking = false; +vfio_dma_bitmap_free_all (iommu); + } +mutex_unlock (&iommu->lock); +return 0 ; + }else if (dirty.flags & +VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP ) { +struct vfio_iommu_type1_dirty_bitmap_get range; +unsigned long pgshift; +size_t data_size = dirty.argsz - minsz; +size_t iommu_pgsize; + +if (!data_size || data_size <sizeof (range)) +return -EINVAL ; + +if (copy_from_user (&range, (void __user *)(arg + minsz), +sizeof (range))) +return -EFAULT ; + +if (range.iova + range.size < range.iova) +return -EINVAL ; +if (!access_ok ((void __user *)range.bitmap.data, + range.bitmap.size)) +return -EINVAL ; + + pgshift =__ffs (range.bitmap.pgsize); + ret =verify_bitmap_size (range.size >> pgshift, + range.bitmap.size); +if (ret) +return ret; + +mutex_lock (&iommu->lock); + + iommu_pgsize = (size_t )1 <<__ffs (iommu->pgsize_bitmap); + +/* allow only smallest supported pgsize */ +if (range.bitmap.pgsize != iommu_pgsize) { + ret = -EINVAL ; + goto out_unlock; + } +if (range.iova & (iommu_pgsize -1 )) { + ret = -EINVAL ; + goto out_unlock; + } +if (!range.size || range.size & (iommu_pgsize -1 )) { + ret = -EINVAL ; + goto out_unlock; + } +
Quoted 9 lines
drivers/vfio/vfio_iommu_type1.c static long vfio_iommu_type1_ioctl(void *iommu_data, · line 2535
Quoted 4 lines
drivers/vfio/vfio_iommu_type1.c +4
-0+if (iommu->dirty_page_tracking) + ret =vfio_iova_dirty_bitmap (iommu, range.iova, + range.size, range.bitmap.pgsize, + range.bitmap.data);Why does the unmap with dirty bitmap collection now support ranges covering multiple
vfio_dmas, but this interface does not? Thanks,
I tried that in v12 version with get_user()-put_user() combination.
After lots of back and forth and brainstroming we finally reached to the conclusion of keeping this interface to cover single vfio_dma. I would like to stick to that for now. As optimization we can think of doing it in future.
Infact looking at the complication in unmap ioctl, I'm rethinking of backing off that change for this patch-set. We can definitely add it later, but atleast for now get basic working framework ready.
Thanks,
Kirti
Quoted 36 lines
Alex
Quoted 32 lines
drivers/vfio/vfio_iommu_type1.c +18
-2+else + ret = -EINVAL ; +out_unlock: +mutex_unlock (&iommu->lock); + +return ret; + } }return -ENOTTY ;@@ -2354,10 +2607,19 @@ static int vfio_iommu_type1_dma_rw_chunk(struct vfio_iommu *iommu, vaddr = dma->vaddr + offset; -if (write) +if (write) { *copied =copy_to_user ((void __user *)vaddr, data, count) ?0 : count; -else +if (*copied && iommu->dirty_page_tracking) { +unsigned long pgshift =__ffs (iommu->pgsize_bitmap); +/* +* Bitmap populated with the smallest supported page +* size +*/ +bitmap_set (dma->bitmap, offset >> pgshift, + *copied >> pgshift); + } + }else *copied =copy_from_user (data, (void __user *)vaddr, count) ?0 : count;if (kthread)
Re: [PATCH Kernel v19 5/8] vfio iommu: Implementation of ioctl for dirty pages tracking
Quoted 408 lines · On Thu, 14 May 2020 18:03:29 +0530 Kirti Wankhede <[email protected]> wrote:
Quoted 107 lines · Alex Williamson
Quoted 88 lines · On Thu, 14 May 2020 01:34:36 +0530 Kirti Wankhede <[email protected]> wrote:
VFIO_IOMMU_DIRTY_PAGESioctl performs three operations:
- Start dirty pages tracking while migration is active
- Stop dirty pages tracking.
- Get dirty pages bitmap. Its user space application's responsibility to copy content of dirty pages from source to destination during migration.To prevent DoS attack, memory for bitmap is allocated per
vfio_dmastructure. Bitmap size is calculated considering smallest supported page size. Bitmap is allocated for allvfio_dmaswhen dirty logging is enabledBitmap is populated for already pinned pages when bitmap is allocated for a
vfio_dmawith the smallest supported page size. Update bitmap from pinning functions when tracking is enabled. When user application queries bitmap, check if requested page size is same as page size used to populated bitmap. If it is equal, copy bitmap, but if not equal, return error.Signed-off-by Kirti Wankhede <[email protected]>Reviewed-by Neo Jia <[email protected]>Fixed error reported by build bot by changing pgsize type from
uint64_ttosize_t.Reported-by kbuild test robot <[email protected]>--- drivers/vfio/vfio_iommu_type1.c | 274 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 268 insertions(+), 6 deletions(-)drivers/vfio/vfio_iommu_type1.c +32
-0@@ -72,6 +72,7 @@ struct vfio_iommu {uint64_t pgsize_bitmap;bool v2;bool nesting; +bool dirty_page_tracking; };struct vfio_domain {@@ -92,6 +93,7 @@ struct vfio_dma {bool lock_cap;/* capable(CAP_IPC_LOCK) */ struct task_struct *task;struct rb_root pfn_list;/* Ex-user pinned pfn list */ +unsigned long *bitmap; };struct vfio_group {@@ -126,6 +128,19 @@ struct vfio_regions {#define IS_IOMMU_CAP_DOMAIN_IN_CONTAINER (iommu) \ (!list_empty(&iommu->domain_list)) +#define DIRTY_BITMAP_BYTES (n) (ALIGN(n, BITS_PER_TYPE(u64)) / BITS_PER_BYTE) + +/* +* Input argument of number of bits to bitmap_set() is unsigned integer, which +* further casts to signed integer for unaligned multi-bit operation, +* __bitmap_set(). +* Then maximum bitmap size supported is 2^31 bits divided by 2^3 bits/byte, +* that is 2^28 (256 MB) which maps to 2^31 * 2^12 = 2^43 (8TB) on 4K page +* system. +*/ +#define DIRTY_BITMAP_PAGES_MAX ((u64)INT_MAX) +#define DIRTY_BITMAP_SIZE_MAX DIRTY_BITMAP_BYTES(DIRTY_BITMAP_PAGES_MAX) +static int put_pfn (unsigned long pfn,int prot);/* @@ -176,6 +191,77 @@ static void vfio_unlink_dma(struct vfio_iommu *iommu, struct vfio_dma *old)rb_erase (&old->node, &iommu->dma_list); } + +static int vfio_dma_bitmap_alloc (struct vfio_dma *dma,size_t pgsize) +{ +uint64_t npages = dma->size / pgsize; + +if (npages >DIRTY_BITMAP_PAGES_MAX ) +return -EINVAL ; + + dma->bitmap =kvzalloc (DIRTY_BITMAP_BYTES (npages),GFP_KERNEL ); +if (!dma->bitmap) +return -ENOMEM ; + +return 0 ; +} + +static void vfio_dma_bitmap_free (struct vfio_dma *dma) +{drivers/vfio/vfio_iommu_type1.c static void vfio_unlink_dma(struct vfio_iommu *iommu, struct vfio_dma *old) · line 220
Quoted 10 lines
drivers/vfio/vfio_iommu_type1.c +10
-0+kfree (dma->bitmap); + dma->bitmap =NULL ; +} + +static void vfio_dma_populate_bitmap (struct vfio_dma *dma,size_t pgsize) +{ +struct rb_node *p; + +if (RB_EMPTY_ROOT (&dma->pfn_list)) +return ;I don't think this is optimizing anything:
#define
RB_EMPTY_ROOT(root)(READ_ONCE((root)->rb_node) == NULL)struct
rb_node*rb_first(const structrb_root*root)Quoted 9 lines
{ struct rb_node *n; n = root->rb_node; if (!n) return NULL;So the loop below won't be entered if the tree is empty.
Removing empty check.
Quoted 272 lines
Quoted 82 lines
drivers/vfio/vfio_iommu_type1.c +61
-0+ +for (p =rb_first (&dma->pfn_list); p; p =rb_next (p)) { + struct vfio_pfn *vpfn = rb_entry(p, struct vfio_pfn, node); + +bitmap_set (dma->bitmap, (vpfn->iova - dma->iova) / pgsize,1 ); + } +} + +static int vfio_dma_bitmap_alloc_all (struct vfio_iommu *iommu,size_t pgsize) +{ +struct rb_node *n =rb_first (&iommu->dma_list); + +for (; n; n =rb_next (n)) { + struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node); +int ret; + + ret =vfio_dma_bitmap_alloc (dma, pgsize); +if (ret) { +struct rb_node *p =rb_prev (n); + +for (; p; p =rb_prev (p)) { +struct vfio_dma *dma =rb_entry (n, + struct vfio_dma, node); + +vfio_dma_bitmap_free (dma); + } +return ret; + } +vfio_dma_populate_bitmap (dma, pgsize); + } +return 0 ; +} + +static void vfio_dma_bitmap_free_all (struct vfio_iommu *iommu) +{ +struct rb_node *n =rb_first (&iommu->dma_list); + +for (; n; n =rb_next (n)) { + struct vfio_dma *dma = rb_entry(n, struct vfio_dma, node); + +vfio_dma_bitmap_free (dma); + } +} +/* * Helper Functions for host iova-pfn list */ @@ -568,6 +654,17 @@ static int vfio_iommu_type1_pin_pages(void *iommu_data,vfio_unpin_page_external (dma, iova, do_accounting); goto pin_unwind; } + +if (iommu->dirty_page_tracking) { +unsigned long pgshift =__ffs (iommu->pgsize_bitmap); + +/* +* Bitmap populated with the smallest supported page +* size +*/ +bitmap_set (dma->bitmap, + (vpfn->iova - dma->iova) >> pgshift,1 ); + } } ret = i;@@ -802,6 +899,7 @@ static void vfio_remove_dma(struct vfio_iommu *iommu, struct vfio_dma *dma)vfio_unmap_unpin (iommu, dma, true);vfio_unlink_dma (iommu, dma);put_task_struct (dma->task); +vfio_dma_bitmap_free (dma);kfree (dma); iommu->dma_avail++; }@@ -829,6 +927,57 @@ static void vfio_pgsize_bitmap(struct vfio_iommu *iommu) } } +static int vfio_iova_dirty_bitmap (struct vfio_iommu *iommu,dma_addr_t iova, +size_t size,size_t pgsize, +u64 __user *bitmap) +{ +struct vfio_dma *dma;drivers/vfio/vfio_iommu_type1.c static void vfio_pgsize_bitmap(struct vfio_iommu *iommu) · line 944
Quoted 10 lines
drivers/vfio/vfio_iommu_type1.c +10
-0+unsigned long pgshift =__ffs (pgsize); +unsigned int npages, bitmap_size; + + dma =vfio_find_dma (iommu, iova,1 ); + +if (!dma) +return -EINVAL ; + +if (dma->iova != iova || dma->size != size) +return -EINVAL ;Minor cleanup:
if (!dma || dma->iova != iova || dma->size != size) return -EINVAL;Quoted 22 lines
drivers/vfio/vfio_iommu_type1.c +22
-0+ + npages = dma->size >> pgshift; + bitmap_size =DIRTY_BITMAP_BYTES (npages); + +/* mark all pages dirty if all pages are pinned and mapped. */ +if (dma->iommu_mapped) +bitmap_set (dma->bitmap,0 , npages); + +if (copy_to_user ((void __user *)bitmap, dma->bitmap, bitmap_size)) +return -EFAULT ; + +/* +* Re-populate bitmap to include all pinned pages which are considered +* as dirty but exclude pages which are unpinned and pages which are +* marked dirty by vfio_dma_rw() +*/ +bitmap_clear (dma->bitmap,0 , npages); +vfio_dma_populate_bitmap (dma, pgsize); +return 0 ; +} + +static int verify_bitmap_size (uint64_t npages,uint64_t bitmap_size)drivers/vfio/vfio_iommu_type1.c static void vfio_pgsize_bitmap(struct vfio_iommu *iommu) · line 976
Quoted 10 lines
drivers/vfio/vfio_iommu_type1.c +10
-0+{ +uint64_t bsize; + +if (!npages || !bitmap_size || (bitmap_size >DIRTY_BITMAP_SIZE_MAX )) +return -EINVAL ; + + bsize =DIRTY_BITMAP_BYTES (npages); + +if (bitmap_size < bsize) +return -EINVAL ;Another minor cleanup:
if (!npages || !bitmap_size || bitmap_size > DIRTY_BITMAP_SIZE_MAX || bitmap_size < DIRTY_BITMAP_BYTES(npages)) return -EINVAL;Quoted 135 lines
drivers/vfio/vfio_iommu_type1.c +101
-4+ +return 0 ; +} +static int vfio_dma_do_unmap (struct vfio_iommu *iommu,struct vfio_iommu_type1_dma_unmap *unmap) {@@ -1046,7 +1195,7 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,unsigned long vaddr = map->vaddr;size_t size = map->size;int ret =0 , prot =0 ; -uint64_t mask; +size_t pgsize;struct vfio_dma *dma;/* Verify that none of our __u64 fields overflow */ @@ -1061,11 +1210,11 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,mutex_lock (&iommu->lock); - mask = ((uint64_t )1 <<__ffs (iommu->pgsize_bitmap)) -1 ; + pgsize = (size_t )1 <<__ffs (iommu->pgsize_bitmap); -WARN_ON (mask &PAGE_MASK ); +WARN_ON ((pgsize -1 ) &PAGE_MASK ); -if (!prot || !size || (size | iova | vaddr) & mask) { +if (!prot || !size || (size | iova | vaddr) & (pgsize -1 )) { ret = -EINVAL ; goto out_unlock; }@@ -1142,6 +1291,12 @@ static int vfio_dma_do_map(struct vfio_iommu *iommu,else ret =vfio_pin_map_dma (iommu, dma, size); +if (!ret && iommu->dirty_page_tracking) { + ret =vfio_dma_bitmap_alloc (dma, pgsize); +if (ret) +vfio_remove_dma (iommu, dma); + } + out_unlock:mutex_unlock (&iommu->lock);return ret;@@ -2287,6 +2442,104 @@ static long vfio_iommu_type1_ioctl(void *iommu_data,return copy_to_user ((void __user *)arg, &unmap, minsz) ? -EFAULT :0 ; + }else if (cmd ==VFIO_IOMMU_DIRTY_PAGES ) { +struct vfio_iommu_type1_dirty_bitmap dirty; +uint32_t mask =VFIO_IOMMU_DIRTY_PAGES_FLAG_START | +VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP | +VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP ; +int ret =0 ; + +if (!iommu->v2) +return -EACCES ; + + minsz = offsetofend(struct vfio_iommu_type1_dirty_bitmap, + flags); + +if (copy_from_user (&dirty, (void __user *)arg, minsz)) +return -EFAULT ; + +if (dirty.argsz < minsz || dirty.flags & ~mask) +return -EINVAL ; + +/* only one flag should be set at a time */ +if (__ffs (dirty.flags) !=__fls (dirty.flags)) +return -EINVAL ; + +if (dirty.flags &VFIO_IOMMU_DIRTY_PAGES_FLAG_START ) { +size_t pgsize; + +mutex_lock (&iommu->lock); + pgsize =1 <<__ffs (iommu->pgsize_bitmap); +if (!iommu->dirty_page_tracking) { + ret =vfio_dma_bitmap_alloc_all (iommu, pgsize); +if (!ret) + iommu->dirty_page_tracking = true; + } +mutex_unlock (&iommu->lock); +return ret; + }else if (dirty.flags &VFIO_IOMMU_DIRTY_PAGES_FLAG_STOP ) { +mutex_lock (&iommu->lock); +if (iommu->dirty_page_tracking) { + iommu->dirty_page_tracking = false; +vfio_dma_bitmap_free_all (iommu); + } +mutex_unlock (&iommu->lock); +return 0 ; + }else if (dirty.flags & +VFIO_IOMMU_DIRTY_PAGES_FLAG_GET_BITMAP ) { +struct vfio_iommu_type1_dirty_bitmap_get range; +unsigned long pgshift; +size_t data_size = dirty.argsz - minsz; +size_t iommu_pgsize; + +if (!data_size || data_size <sizeof (range)) +return -EINVAL ; + +if (copy_from_user (&range, (void __user *)(arg + minsz), +sizeof (range))) +return -EFAULT ; + +if (range.iova + range.size < range.iova) +return -EINVAL ; +if (!access_ok ((void __user *)range.bitmap.data, + range.bitmap.size)) +return -EINVAL ; + + pgshift =__ffs (range.bitmap.pgsize); + ret =verify_bitmap_size (range.size >> pgshift, + range.bitmap.size); +if (ret) +return ret; + +mutex_lock (&iommu->lock); + + iommu_pgsize = (size_t )1 <<__ffs (iommu->pgsize_bitmap); + +/* allow only smallest supported pgsize */ +if (range.bitmap.pgsize != iommu_pgsize) { + ret = -EINVAL ; + goto out_unlock; + } +if (range.iova & (iommu_pgsize -1 )) { + ret = -EINVAL ; + goto out_unlock; + } +if (!range.size || range.size & (iommu_pgsize -1 )) { + ret = -EINVAL ; + goto out_unlock; + } +Quoted 9 lines
drivers/vfio/vfio_iommu_type1.c static long vfio_iommu_type1_ioctl(void *iommu_data, · line 2535
Quoted 4 lines
drivers/vfio/vfio_iommu_type1.c +4
-0+if (iommu->dirty_page_tracking) + ret =vfio_iova_dirty_bitmap (iommu, range.iova, + range.size, range.bitmap.pgsize, + range.bitmap.data);Why does the unmap with dirty bitmap collection now support ranges covering multiple
vfio_dmas, but this interface does not? Thanks,I tried that in v12 version with get_user()-put_user() combination. After lots of back and forth and brainstroming we finally reached to the conclusion of keeping this interface to cover single
vfio_dma. I would like to stick to that for now. As optimization we can think of doing it in future.
Quoted 3 lines
Infact looking at the complication in unmap ioctl, I'm rethinking of backing off that change for this patch-set. We can definitely add it later, but atleast for now get basic working framework ready.
At that time we decided to have the interface cover a single vfio_dma I think we thought that was sufficient for now, but that's since been shown incorrect or at least fatally inefficient. Now we're on the verge of having that working, so it should be implemented consistently for all interfaces. If we pull that back rather than complete it, I think we're at the same point we were previously, where the interface becomes unacceptable for some use cases and the usage restrictions need to be expressed via the uapi, so then we need to decide how we're going to describe those limitations rather than just carry through and implement them. Obviously I'd rather spend the time removing the restriction rather than inventing throw-away uapi to describe the restriction. Thanks,
Alex
Quoted 34 lines
Quoted 33 lines
Quoted 32 lines
drivers/vfio/vfio_iommu_type1.c +18
-2+else + ret = -EINVAL ; +out_unlock: +mutex_unlock (&iommu->lock); + +return ret; + } }return -ENOTTY ;@@ -2354,10 +2607,19 @@ static int vfio_iommu_type1_dma_rw_chunk(struct vfio_iommu *iommu, vaddr = dma->vaddr + offset; -if (write) +if (write) { *copied =copy_to_user ((void __user *)vaddr, data, count) ?0 : count; -else +if (*copied && iommu->dirty_page_tracking) { +unsigned long pgshift =__ffs (iommu->pgsize_bitmap); +/* +* Bitmap populated with the smallest supported page +* size +*/ +bitmap_set (dma->bitmap, offset >> pgshift, + *copied >> pgshift); + } + }else *copied =copy_from_user (data, (void __user *)vaddr, count) ?0 : count;if (kthread)
PATCH v19 6/8 vfio iommu: Update UNMAP_DMA ioctl to get dirty bitmap before unmap
In reply to Kirti WankhedeDMA mapped pages, including those pinned by mdev vendor drivers, might get unpinned and unmapped while migration is active and device is still running. For example, in pre-copy phase while guest driver could access those pages, host device or vendor driver can dirty these mapped pages. Such pages should be marked dirty so as to maintain memory consistency for a user making use of dirty page tracking.
To get bitmap during unmap, user should allocate memory for bitmap, set size of allocated memory, set page size to be considered for bitmap and set flag VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP.
--- drivers/vfio/vfio_iommu_type1.c | 102 +++++++++++++++++++++++++++++++++++----- include/uapi/linux/vfio.h | 10 ++++ 2 files changed, 99 insertions(+), 13 deletions(-)
drivers/vfio/vfio_iommu_type1.c +89 -13
@@ -195,11 +195,15 @@ static void vfio_unlink_dma(struct vfio_iommu *iommu, struct vfio_dma *old)static int vfio_dma_bitmap_alloc (struct vfio_dma *dma,size_t pgsize) {uint64_t npages = dma->size / pgsize; +size_t bitmap_size;if (npages >DIRTY_BITMAP_PAGES_MAX )return -EINVAL ; - dma->bitmap =kvzalloc (DIRTY_BITMAP_BYTES (npages),GFP_KERNEL ); +/* Allocate extra 64 bits which are used for bitmap manipulation */ + bitmap_size =DIRTY_BITMAP_BYTES (npages) +sizeof (u64); + + dma->bitmap =kvzalloc (bitmap_size,GFP_KERNEL );if (!dma->bitmap)return -ENOMEM ;
@@ -979,23 +983,25 @@ static int verify_bitmap_size(uint64_t npages, uint64_t bitmap_size) }static int vfio_dma_do_unmap (struct vfio_iommu *iommu, -struct vfio_iommu_type1_dma_unmap *unmap) +struct vfio_iommu_type1_dma_unmap *unmap, +struct vfio_bitmap *bitmap) { -uint64_t mask;struct vfio_dma *dma, *dma_last =NULL ; -size_t unmapped =0 ; -int ret =0 , retries =0 ; +size_t unmapped =0 , pgsize; +int ret =0 , retries =0 , cnt =0 ; +unsigned long pgshift, shift =0 , leftover;mutex_lock (&iommu->lock); - mask = ((uint64_t )1 <<__ffs (iommu->pgsize_bitmap)) -1 ; + pgshift =__ffs (iommu->pgsize_bitmap); + pgsize = (size_t )1 << pgshift; -if (unmap->iova & mask) { +if (unmap->iova & (pgsize -1 )) { ret = -EINVAL ; goto unlock; } -if (!unmap->size || unmap->size & mask) { +if (!unmap->size || unmap->size & (pgsize -1 )) { ret = -EINVAL ; goto unlock; }
@@ -1006,9 +1012,15 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu, goto unlock; } -WARN_ON (mask &PAGE_MASK ); -again: +/* When dirty tracking is enabled, allow only min supported pgsize */ +if ((unmap->flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) && + (!iommu->dirty_page_tracking || (bitmap->pgsize != pgsize))) { + ret = -EINVAL ; + goto unlock; + } +WARN_ON ((pgsize -1 ) &PAGE_MASK ); +again:/* * vfio-iommu-type1 (v1) - User mappings were coalesced together to * avoid tracking individual mappings. This means that the granularity
@@ -1046,6 +1058,7 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu, ret = -EINVAL ; goto unlock; } + dma =vfio_find_dma (iommu, unmap->iova + unmap->size -1 ,0 );if (dma && dma->iova + dma->size != unmap->iova + unmap->size) { ret = -EINVAL ;
@@ -1063,6 +1076,39 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu,if (dma->task->mm != current->mm)break ; +if ((unmap->flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) && + (dma_last != dma)) { +unsigned int nbits = dma->size >> pgshift; +int curr_lcnt = nbits /BITS_PER_LONG ; + +/* +* mark all pages dirty if all pages are pinned and +* mapped. +*/ +if (dma->iommu_mapped) +bitmap_set (dma->bitmap,0 , nbits); + +if (shift) { +bitmap_shift_left (dma->bitmap, dma->bitmap, + shift, nbits + shift); +bitmap_or (dma->bitmap, dma->bitmap, &leftover, + shift); + nbits += shift; + curr_lcnt = nbits /BITS_PER_LONG ; + } + +if (copy_to_user ((void __user *)bitmap->data + cnt, + dma->bitmap, curr_lcnt *sizeof (u64))) { + ret = -EFAULT ; +break ; + } + + shift = nbits %BITS_PER_LONG ; +if (shift) + leftover = *(u64 *)(dma->bitmap + curr_lcnt); + cnt += curr_lcnt; + } +if (!RB_EMPTY_ROOT (&dma->pfn_list)) {struct vfio_iommu_type1_dma_unmap nb_unmap;
@@ -1093,6 +1139,13 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu,vfio_remove_dma (iommu, dma); } +if (!ret && (unmap->flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) && + shift) { +if (copy_to_user ((void __user *)bitmap->data + cnt, &leftover, +sizeof (leftover))) + ret = -EFAULT ; + } + unlock:mutex_unlock (&iommu->lock);
@@ -2426,17 +2479,40 @@ static long vfio_iommu_type1_ioctl(void *iommu_data, }else if (cmd ==VFIO_IOMMU_UNMAP_DMA ) {struct vfio_iommu_type1_dma_unmap unmap; -long ret; +struct vfio_bitmap bitmap = {0 }; +int ret; minsz = offsetofend(struct vfio_iommu_type1_dma_unmap, size);if (copy_from_user (&unmap, (void __user *)arg, minsz))return -EFAULT ; -if (unmap.argsz < minsz || unmap.flags) +if (unmap.argsz < minsz || + unmap.flags & ~VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP )return -EINVAL ; - ret =vfio_dma_do_unmap (iommu, &unmap); +if (unmap.flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) { +unsigned long pgshift; + +if (unmap.argsz < (minsz +sizeof (bitmap))) +return -EINVAL ; + +if (copy_from_user (&bitmap, + (void __user *)(arg + minsz), +sizeof (bitmap))) +return -EFAULT ; + +if (!access_ok ((void __user *)bitmap.data, bitmap.size)) +return -EINVAL ; + + pgshift =__ffs (bitmap.pgsize); + ret =verify_bitmap_size (unmap.size >> pgshift, + bitmap.size); +if (ret) +return ret; + } + + ret =vfio_dma_do_unmap (iommu, &unmap, &bitmap);if (ret)return ret;
include/uapi/linux/vfio.h +10 -0
@@ -1048,12 +1048,22 @@ struct vfio_bitmap {* field. No guarantee is made to the user that arbitrary unmaps of iova * or size different from those used in the original mapping call will * succeed. +* VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP should be set to get dirty bitmap +* before unmapping IO virtual addresses. When this flag is set, user must +* provide data[] as structure vfio_bitmap. User must allocate memory to get +* bitmap and must set size of allocated memory in vfio_bitmap.size field. +* A bit in bitmap represents one page of user provided page size in 'pgsize', +* consecutively starting from iova offset. Bit set indicates page at that +* offset from iova is dirty. Bitmap of pages in the range of unmapped size is +* returned in vfio_bitmap.data */ struct vfio_iommu_type1_dma_unmap {__u32 argsz;__u32 flags; +#define VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP (1 << 0)__u64 iova;/* IO virtual address */ __u64 size;/* Size of mapping (bytes) */ +__u8 data[]; };#define VFIO_IOMMU_UNMAP_DMA _IO(VFIO_TYPE, VFIO_BASE + 14)
Signature · 1 line
2.7.0
Re: [PATCH Kernel v19 6/8] vfio iommu: Update UNMAP_DMA ioctl to get dirty bitmap before unmap
Quoted 124 lines · On Thu, 14 May 2020 01:34:37 +0530 Kirti Wankhede <[email protected]> wrote:
DMA mapped pages, including those pinned by mdev vendor drivers, might get unpinned and unmapped while migration is active and device is still running. For example, in pre-copy phase while guest driver could access those pages, host device or vendor driver can dirty these mapped pages. Such pages should be marked dirty so as to maintain memory consistency for a user making use of dirty page tracking.
To get bitmap during unmap, user should allocate memory for bitmap, set size of allocated memory, set page size to be considered for bitmap and set flag
VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP.Signed-off-by Kirti Wankhede <[email protected]>Reviewed-by Neo Jia <[email protected]>--- drivers/vfio/vfio_iommu_type1.c | 102 +++++++++++++++++++++++++++++++++++----- include/uapi/linux/vfio.h | 10 ++++ 2 files changed, 99 insertions(+), 13 deletions(-)drivers/vfio/vfio_iommu_type1.c +45
-10@@ -195,11 +195,15 @@ static void vfio_unlink_dma(struct vfio_iommu *iommu, struct vfio_dma *old)static int vfio_dma_bitmap_alloc (struct vfio_dma *dma,size_t pgsize) {uint64_t npages = dma->size / pgsize; +size_t bitmap_size;if (npages >DIRTY_BITMAP_PAGES_MAX )return -EINVAL ; - dma->bitmap =kvzalloc (DIRTY_BITMAP_BYTES (npages),GFP_KERNEL ); +/* Allocate extra 64 bits which are used for bitmap manipulation */ + bitmap_size =DIRTY_BITMAP_BYTES (npages) +sizeof (u64); + + dma->bitmap =kvzalloc (bitmap_size,GFP_KERNEL );if (!dma->bitmap)return -ENOMEM ;@@ -979,23 +983,25 @@ static int verify_bitmap_size(uint64_t npages, uint64_t bitmap_size) }static int vfio_dma_do_unmap (struct vfio_iommu *iommu, -struct vfio_iommu_type1_dma_unmap *unmap) +struct vfio_iommu_type1_dma_unmap *unmap, +struct vfio_bitmap *bitmap) { -uint64_t mask;struct vfio_dma *dma, *dma_last =NULL ; -size_t unmapped =0 ; -int ret =0 , retries =0 ; +size_t unmapped =0 , pgsize; +int ret =0 , retries =0 , cnt =0 ; +unsigned long pgshift, shift =0 , leftover;mutex_lock (&iommu->lock); - mask = ((uint64_t )1 <<__ffs (iommu->pgsize_bitmap)) -1 ; + pgshift =__ffs (iommu->pgsize_bitmap); + pgsize = (size_t )1 << pgshift; -if (unmap->iova & mask) { +if (unmap->iova & (pgsize -1 )) { ret = -EINVAL ; goto unlock; } -if (!unmap->size || unmap->size & mask) { +if (!unmap->size || unmap->size & (pgsize -1 )) { ret = -EINVAL ; goto unlock; }@@ -1006,9 +1012,15 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu, goto unlock; } -WARN_ON (mask &PAGE_MASK ); -again: +/* When dirty tracking is enabled, allow only min supported pgsize */ +if ((unmap->flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) && + (!iommu->dirty_page_tracking || (bitmap->pgsize != pgsize))) { + ret = -EINVAL ; + goto unlock; + } +WARN_ON ((pgsize -1 ) &PAGE_MASK ); +again:/* * vfio-iommu-type1 (v1) - User mappings were coalesced together to * avoid tracking individual mappings. This means that the granularity @@ -1046,6 +1058,7 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu, ret = -EINVAL ; goto unlock; } + dma =vfio_find_dma (iommu, unmap->iova + unmap->size -1 ,0 );if (dma && dma->iova + dma->size != unmap->iova + unmap->size) { ret = -EINVAL ;@@ -1063,6 +1076,39 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu,if (dma->task->mm != current->mm)break ; +if ((unmap->flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) && + (dma_last != dma)) { +unsigned int nbits = dma->size >> pgshift; +int curr_lcnt = nbits /BITS_PER_LONG ; + +/* +* mark all pages dirty if all pages are pinned and +* mapped. +*/ +if (dma->iommu_mapped) +bitmap_set (dma->bitmap,0 , nbits); + +if (shift) { +bitmap_shift_left (dma->bitmap, dma->bitmap, + shift, nbits + shift); +bitmap_or (dma->bitmap, dma->bitmap, &leftover, + shift); + nbits += shift; + curr_lcnt = nbits /BITS_PER_LONG ; + } + + if (copy_to_user((void __user *)bitmap->data + cnt,
drivers/vfio/vfio_iommu_type1.c static int vfio_dma_do_unmap(struct vfio_iommu *iommu, · line 1110
Quoted 10 lines
drivers/vfio/vfio_iommu_type1.c +10
-0+ dma->bitmap, curr_lcnt * sizeof(u64))) { + ret = -EFAULT ; +break ; + } + + shift = nbits %BITS_PER_LONG ; +if (shift) + leftover = *(u64 *)(dma->bitmap + curr_lcnt); + cnt += curr_lcnt; + }
I don't think this works. Let's say for example we have separate single page mappings at 4K and 12K (both dirty) and the user asked to unmap the range 0 - 16K. We find the mapping at 4K, shift is zero, cnt is zero, so we copy the bitmap with the zero bit set to the user buffer. We're already wrong because we've just indicated the page at zero is dirty and there isn't a page at zero. shift now becomes 1 and leftover is a bitmap with bit zero set.
We move on to the next page @12K. We shift this bitmap by 1. We OR in our leftover and again copy out to the user buffer. We end up with a user bitmap with bits zero and one set, when we should have had bits 1 and 3 set, we're essentially coalescing the mappings.
As I see it, shift needs to be calculated as the offset from the start of the user requested unmap buffer and I think an easier approach to handle the leftover bits preceding the shift is to copy it back out of the user buffer.
For example, shift should be:
((dma->iova - unmap->iova) >> pgshift) % BITS_PER_LONG
This would give us a shift of 1 and 3 respectively for our mappings, which is correct.
Since our shifts are non-zero, we then need to collect the preceding leftovers, which is always going to be:
copy_from_user(&leftover, bitmap->data +
((dma->iova - unmap->iova) >> pgshift) / BITS_PER_LONG, sizeof(leftover));
I don't think the curr_lcnt calculation for the copy-out is correct either, mappings are not required to be a multiple of BITS_PER_LONG pages, so we're truncating the size.
So we have:
bit_offset = (dma->iova - unmap->iova) >> pgshift; copy_offset = bit_offset / BITS_PER_LONG; shift = bit_offset % BITS_PER_LONG;
if (shift) {
bitmap_shift_left(dma->bitmap, dma->bitmap, shift, nbits + shift);
if (copy_from_user(&leftover, bitmap->data + copy_offset, sizeof(leftover))) {
ret = -EFAULT;
break;
}
bitmap_or(dma->bitmap, dma->bitmap, &leftover, shift);
}if (copy_to_user(bitmap->data + copy_offset, dma->bitmap,
roundup(nbits + shift, BITS_PER_LONG)/BITS_PER_BYTE)) {
ret = -EFAULT;
break;
}Also this all needs to come after the below check of the pfn_list and call to the blocking notifier or else we're just wasting time because we'll need to do it all again anyway.
Quoted 5 lines
drivers/vfio/vfio_iommu_type1.c +1
-0+if (!RB_EMPTY_ROOT (&dma->pfn_list)) {struct vfio_iommu_type1_dma_unmap nb_unmap;
drivers/vfio/vfio_iommu_type1.c static int vfio_dma_do_unmap(struct vfio_iommu *iommu, · line 1147
Quoted 9 lines
drivers/vfio/vfio_iommu_type1.c +6
-0@@ -1093,6 +1139,13 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu,vfio_remove_dma (iommu, dma); } +if (!ret && (unmap->flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) && + shift) { +if (copy_to_user ((void __user *)bitmap->data + cnt, &leftover, +sizeof (leftover))) + ret = -EFAULT ; + }
This is unnecessary with the algorithm I propose.
Quoted 54 lines
drivers/vfio/vfio_iommu_type1.c +27
-3+ unlock:mutex_unlock (&iommu->lock);@@ -2426,17 +2479,40 @@ static long vfio_iommu_type1_ioctl(void *iommu_data, }else if (cmd ==VFIO_IOMMU_UNMAP_DMA ) {struct vfio_iommu_type1_dma_unmap unmap; -long ret; +struct vfio_bitmap bitmap = {0 }; +int ret; minsz = offsetofend(struct vfio_iommu_type1_dma_unmap, size);if (copy_from_user (&unmap, (void __user *)arg, minsz))return -EFAULT ; -if (unmap.argsz < minsz || unmap.flags) +if (unmap.argsz < minsz || + unmap.flags & ~VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP )return -EINVAL ; - ret =vfio_dma_do_unmap (iommu, &unmap); +if (unmap.flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) { +unsigned long pgshift; + +if (unmap.argsz < (minsz +sizeof (bitmap))) +return -EINVAL ; + +if (copy_from_user (&bitmap, + (void __user *)(arg + minsz), +sizeof (bitmap))) +return -EFAULT ; + +if (!access_ok ((void __user *)bitmap.data, bitmap.size)) +return -EINVAL ; + + pgshift =__ffs (bitmap.pgsize); + ret =verify_bitmap_size (unmap.size >> pgshift, + bitmap.size); +if (ret) +return ret; + } + + ret =vfio_dma_do_unmap (iommu, &unmap, &bitmap);if (ret)return ret;include/uapi/linux/vfio.h +0
-0@@ -1048,12 +1048,22 @@ struct vfio_bitmap {* field. No guarantee is made to the user that arbitrary unmaps of iova
include/uapi/linux/vfio.h struct vfio_bitmap { · line 1058
Quoted 10 lines
include/uapi/linux/vfio.h +8
-0* or size different from those used in the original mapping call will * succeed. +* VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP should be set to get dirty bitmap +* before unmapping IO virtual addresses. When this flag is set, user must +* provide data[] as structure vfio_bitmap. User must allocate memory to get +* bitmap and must set size of allocated memory in vfio_bitmap.size field. +* A bit in bitmap represents one page of user provided page size in 'pgsize', +* consecutively starting from iova offset. Bit set indicates page at that +* offset from iova is dirty. Bitmap of pages in the range of unmapped size is +* returned in vfio_bitmap.data
This needs to specify a user zero'd bitmap if we're only going to fill it sparsely. Thanks,
Alex
Quoted 11 lines
include/uapi/linux/vfio.h +2
-0*/ struct vfio_iommu_type1_dma_unmap {__u32 argsz;__u32 flags; +#define VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP (1 << 0)__u64 iova;/* IO virtual address */ __u64 size;/* Size of mapping (bytes) */ +__u8 data[]; };#define VFIO_IOMMU_UNMAP_DMA _IO(VFIO_TYPE, VFIO_BASE + 14)
Re: [PATCH Kernel v19 6/8] vfio iommu: Update UNMAP_DMA ioctl to get dirty bitmap before unmap
Quoted 133 lines · Alex Williamson
Quoted 130 lines · On Thu, 14 May 2020 01:34:37 +0530 Kirti Wankhede <[email protected]> wrote:
DMA mapped pages, including those pinned by mdev vendor drivers, might get unpinned and unmapped while migration is active and device is still running. For example, in pre-copy phase while guest driver could access those pages, host device or vendor driver can dirty these mapped pages. Such pages should be marked dirty so as to maintain memory consistency for a user making use of dirty page tracking.
To get bitmap during unmap, user should allocate memory for bitmap, set size of allocated memory, set page size to be considered for bitmap and set flag
VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP.Signed-off-by Kirti Wankhede <[email protected]>Reviewed-by Neo Jia <[email protected]>--- drivers/vfio/vfio_iommu_type1.c | 102 +++++++++++++++++++++++++++++++++++----- include/uapi/linux/vfio.h | 10 ++++ 2 files changed, 99 insertions(+), 13 deletions(-)drivers/vfio/vfio_iommu_type1.c +51
-10@@ -195,11 +195,15 @@ static void vfio_unlink_dma(struct vfio_iommu *iommu, struct vfio_dma *old)static int vfio_dma_bitmap_alloc (struct vfio_dma *dma,size_t pgsize) {uint64_t npages = dma->size / pgsize; +size_t bitmap_size;if (npages >DIRTY_BITMAP_PAGES_MAX )return -EINVAL ; - dma->bitmap =kvzalloc (DIRTY_BITMAP_BYTES (npages),GFP_KERNEL ); +/* Allocate extra 64 bits which are used for bitmap manipulation */ + bitmap_size =DIRTY_BITMAP_BYTES (npages) +sizeof (u64); + + dma->bitmap =kvzalloc (bitmap_size,GFP_KERNEL );if (!dma->bitmap)return -ENOMEM ;@@ -979,23 +983,25 @@ static int verify_bitmap_size(uint64_t npages, uint64_t bitmap_size) }static int vfio_dma_do_unmap (struct vfio_iommu *iommu, -struct vfio_iommu_type1_dma_unmap *unmap) +struct vfio_iommu_type1_dma_unmap *unmap, +struct vfio_bitmap *bitmap) { -uint64_t mask;struct vfio_dma *dma, *dma_last =NULL ; -size_t unmapped =0 ; -int ret =0 , retries =0 ; +size_t unmapped =0 , pgsize; +int ret =0 , retries =0 , cnt =0 ; +unsigned long pgshift, shift =0 , leftover;mutex_lock (&iommu->lock); - mask = ((uint64_t )1 <<__ffs (iommu->pgsize_bitmap)) -1 ; + pgshift =__ffs (iommu->pgsize_bitmap); + pgsize = (size_t )1 << pgshift; -if (unmap->iova & mask) { +if (unmap->iova & (pgsize -1 )) { ret = -EINVAL ; goto unlock; } -if (!unmap->size || unmap->size & mask) { +if (!unmap->size || unmap->size & (pgsize -1 )) { ret = -EINVAL ; goto unlock; }@@ -1006,9 +1012,15 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu, goto unlock; } -WARN_ON (mask &PAGE_MASK ); -again: +/* When dirty tracking is enabled, allow only min supported pgsize */ +if ((unmap->flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) && + (!iommu->dirty_page_tracking || (bitmap->pgsize != pgsize))) { + ret = -EINVAL ; + goto unlock; + } +WARN_ON ((pgsize -1 ) &PAGE_MASK ); +again:/* * vfio-iommu-type1 (v1) - User mappings were coalesced together to * avoid tracking individual mappings. This means that the granularity @@ -1046,6 +1058,7 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu, ret = -EINVAL ; goto unlock; } + dma =vfio_find_dma (iommu, unmap->iova + unmap->size -1 ,0 );if (dma && dma->iova + dma->size != unmap->iova + unmap->size) { ret = -EINVAL ;@@ -1063,6 +1076,39 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu,if (dma->task->mm != current->mm)break ; +if ((unmap->flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) && + (dma_last != dma)) { +unsigned int nbits = dma->size >> pgshift; +int curr_lcnt = nbits /BITS_PER_LONG ; + +/* +* mark all pages dirty if all pages are pinned and +* mapped. +*/ +if (dma->iommu_mapped) +bitmap_set (dma->bitmap,0 , nbits); + +if (shift) { +bitmap_shift_left (dma->bitmap, dma->bitmap, + shift, nbits + shift); +bitmap_or (dma->bitmap, dma->bitmap, &leftover, + shift); + nbits += shift; + curr_lcnt = nbits /BITS_PER_LONG ; + } + +if (copy_to_user ((void __user *)bitmap->data + cnt, + dma->bitmap, curr_lcnt *sizeof (u64))) { + ret = -EFAULT ; +break ; + } + + shift = nbits %BITS_PER_LONG ;
Quoted 8 lines
drivers/vfio/vfio_iommu_type1.c static int vfio_dma_do_unmap(struct vfio_iommu *iommu, · line 1110
Quoted 4 lines
drivers/vfio/vfio_iommu_type1.c +4
-0+if (shift) + leftover = *(u64 *)(dma->bitmap + curr_lcnt); + cnt += curr_lcnt; + }I don't think this works. Let's say for example we have separate single page mappings at 4K and 12K (both dirty) and the user asked to unmap the range 0 - 16K.
Unmap range should include adjacent mapped ranges, right?
In your example, if user asks for range 0-16k but mapping at 0 wasn't done, then this unmap would fail before even reaching control here.
There is a check which makes sure that mapping for start of range exist:
dma = vfio_find_dma(iommu, unmap->iova, 1);
if (dma && dma->iova != unmap->iova) {
ret = -EINVAL;
goto unlock;
}There is a check which makes sure that mapping for last address of range exist:
dma = vfio_find_dma(iommu, unmap->iova + unmap->size - 1, 0);
if (dma && dma->iova + dma->size != unmap->iova + unmap->size) {
ret = -EINVAL;
goto unlock;
}Then current implementation should work.
Thanks,
Kirti
Quoted 159 lines
We find the mapping at 4K, shift is zero, cnt
is zero, so we copy the bitmap with the zero bit set to the user buffer. We're already wrong because we've just indicated the page at zero is dirty and there isn't a page at zero. shift now becomes 1 and leftover is a bitmap with bit zero set.We move on to the next page @12K. We shift this bitmap by 1. We OR in our leftover and again copy out to the user buffer. We end up with a user bitmap with bits zero and one set, when we should have had bits 1 and 3 set, we're essentially coalescing the mappings.
As I see it, shift needs to be calculated as the offset from the start of the user requested unmap buffer and I think an easier approach to handle the leftover bits preceding the shift is to copy it back out of the user buffer.
For example, shift should be:
((
dma->iova-unmap->iova) >> pgshift) %BITS_PER_LONGThis would give us a shift of 1 and 3 respectively for our mappings, which is correct.
Since our shifts are non-zero, we then need to collect the preceding leftovers, which is always going to be:
copy_from_user(&leftover,
bitmap->data+((dma->iova - unmap->iova) >> pgshift) / BITS_PER_LONG, sizeof(leftover));I don't think the
curr_lcntcalculation for the copy-out is correct either, mappings are not required to be a multiple ofBITS_PER_LONGpages, so we're truncating the size.So we have:
bit_offset= (dma->iova-unmap->iova) >> pgshift;copy_offset=bit_offset/BITS_PER_LONG; shift =bit_offset%BITS_PER_LONG;if (shift) { bitmap_shift_left(dma->bitmap, dma->bitmap, shift, nbits + shift); if (copy_from_user(&leftover, bitmap->data + copy_offset, sizeof(leftover))) { ret = -EFAULT; break; } bitmap_or(dma->bitmap, dma->bitmap, &leftover, shift); }if (copy_to_user(bitmap->data +
copy_offset,dma->bitmap,roundup(nbits + shift, BITS_PER_LONG)/BITS_PER_BYTE)) { ret = -EFAULT; break; }Also this all needs to come after the below check of the
pfn_listand call to the blocking notifier or else we're just wasting time because we'll need to do it all again anyway.Quoted 5 lines
drivers/vfio/vfio_iommu_type1.c +1
-0+if (!RB_EMPTY_ROOT (&dma->pfn_list)) {struct vfio_iommu_type1_dma_unmap nb_unmap;drivers/vfio/vfio_iommu_type1.c static int vfio_dma_do_unmap(struct vfio_iommu *iommu, · line 1147
Quoted 9 lines
drivers/vfio/vfio_iommu_type1.c +6
-0@@ -1093,6 +1139,13 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu,vfio_remove_dma (iommu, dma); } +if (!ret && (unmap->flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) && + shift) { +if (copy_to_user ((void __user *)bitmap->data + cnt, &leftover, +sizeof (leftover))) + ret = -EFAULT ; + }This is unnecessary with the algorithm I propose.
Quoted 54 lines
drivers/vfio/vfio_iommu_type1.c +27
-3+ unlock:mutex_unlock (&iommu->lock);@@ -2426,17 +2479,40 @@ static long vfio_iommu_type1_ioctl(void *iommu_data, }else if (cmd ==VFIO_IOMMU_UNMAP_DMA ) {struct vfio_iommu_type1_dma_unmap unmap; -long ret; +struct vfio_bitmap bitmap = {0 }; +int ret; minsz = offsetofend(struct vfio_iommu_type1_dma_unmap, size);if (copy_from_user (&unmap, (void __user *)arg, minsz))return -EFAULT ; -if (unmap.argsz < minsz || unmap.flags) +if (unmap.argsz < minsz || + unmap.flags & ~VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP )return -EINVAL ; - ret =vfio_dma_do_unmap (iommu, &unmap); +if (unmap.flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) { +unsigned long pgshift; + +if (unmap.argsz < (minsz +sizeof (bitmap))) +return -EINVAL ; + +if (copy_from_user (&bitmap, + (void __user *)(arg + minsz), +sizeof (bitmap))) +return -EFAULT ; + +if (!access_ok ((void __user *)bitmap.data, bitmap.size)) +return -EINVAL ; + + pgshift =__ffs (bitmap.pgsize); + ret =verify_bitmap_size (unmap.size >> pgshift, + bitmap.size); +if (ret) +return ret; + } + + ret =vfio_dma_do_unmap (iommu, &unmap, &bitmap);if (ret)return ret;include/uapi/linux/vfio.h +0
-0@@ -1048,12 +1048,22 @@ struct vfio_bitmap {* field. No guarantee is made to the user that arbitrary unmaps of iova include/uapi/linux/vfio.h struct vfio_bitmap { · line 1058
Quoted 10 lines
include/uapi/linux/vfio.h +8
-0* or size different from those used in the original mapping call will * succeed. +* VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP should be set to get dirty bitmap +* before unmapping IO virtual addresses. When this flag is set, user must +* provide data[] as structure vfio_bitmap. User must allocate memory to get +* bitmap and must set size of allocated memory in vfio_bitmap.size field. +* A bit in bitmap represents one page of user provided page size in 'pgsize', +* consecutively starting from iova offset. Bit set indicates page at that +* offset from iova is dirty. Bitmap of pages in the range of unmapped size is +* returned in vfio_bitmap.data This needs to specify a user zero'd bitmap if we're only going to fill it sparsely. Thanks,
Alex
Quoted 11 lines
include/uapi/linux/vfio.h +2
-0*/ struct vfio_iommu_type1_dma_unmap {__u32 argsz;__u32 flags; +#define VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP (1 << 0)__u64 iova;/* IO virtual address */ __u64 size;/* Size of mapping (bytes) */ +__u8 data[]; };#define VFIO_IOMMU_UNMAP_DMA _IO(VFIO_TYPE, VFIO_BASE + 14)
Re: [PATCH Kernel v19 6/8] vfio iommu: Update UNMAP_DMA ioctl to get dirty bitmap before unmap
Quoted 143 lines · On Thu, 14 May 2020 11:02:33 +0530 Kirti Wankhede <[email protected]> wrote:
Quoted 133 lines · Alex Williamson
Quoted 130 lines · On Thu, 14 May 2020 01:34:37 +0530 Kirti Wankhede <[email protected]> wrote:
DMA mapped pages, including those pinned by mdev vendor drivers, might get unpinned and unmapped while migration is active and device is still running. For example, in pre-copy phase while guest driver could access those pages, host device or vendor driver can dirty these mapped pages. Such pages should be marked dirty so as to maintain memory consistency for a user making use of dirty page tracking.
To get bitmap during unmap, user should allocate memory for bitmap, set size of allocated memory, set page size to be considered for bitmap and set flag
VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP.Signed-off-by Kirti Wankhede <[email protected]>Reviewed-by Neo Jia <[email protected]>--- drivers/vfio/vfio_iommu_type1.c | 102 +++++++++++++++++++++++++++++++++++----- include/uapi/linux/vfio.h | 10 ++++ 2 files changed, 99 insertions(+), 13 deletions(-)drivers/vfio/vfio_iommu_type1.c +51
-10@@ -195,11 +195,15 @@ static void vfio_unlink_dma(struct vfio_iommu *iommu, struct vfio_dma *old)static int vfio_dma_bitmap_alloc (struct vfio_dma *dma,size_t pgsize) {uint64_t npages = dma->size / pgsize; +size_t bitmap_size;if (npages >DIRTY_BITMAP_PAGES_MAX )return -EINVAL ; - dma->bitmap =kvzalloc (DIRTY_BITMAP_BYTES (npages),GFP_KERNEL ); +/* Allocate extra 64 bits which are used for bitmap manipulation */ + bitmap_size =DIRTY_BITMAP_BYTES (npages) +sizeof (u64); + + dma->bitmap =kvzalloc (bitmap_size,GFP_KERNEL );if (!dma->bitmap)return -ENOMEM ;@@ -979,23 +983,25 @@ static int verify_bitmap_size(uint64_t npages, uint64_t bitmap_size) }static int vfio_dma_do_unmap (struct vfio_iommu *iommu, -struct vfio_iommu_type1_dma_unmap *unmap) +struct vfio_iommu_type1_dma_unmap *unmap, +struct vfio_bitmap *bitmap) { -uint64_t mask;struct vfio_dma *dma, *dma_last =NULL ; -size_t unmapped =0 ; -int ret =0 , retries =0 ; +size_t unmapped =0 , pgsize; +int ret =0 , retries =0 , cnt =0 ; +unsigned long pgshift, shift =0 , leftover;mutex_lock (&iommu->lock); - mask = ((uint64_t )1 <<__ffs (iommu->pgsize_bitmap)) -1 ; + pgshift =__ffs (iommu->pgsize_bitmap); + pgsize = (size_t )1 << pgshift; -if (unmap->iova & mask) { +if (unmap->iova & (pgsize -1 )) { ret = -EINVAL ; goto unlock; } -if (!unmap->size || unmap->size & mask) { +if (!unmap->size || unmap->size & (pgsize -1 )) { ret = -EINVAL ; goto unlock; }@@ -1006,9 +1012,15 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu, goto unlock; } -WARN_ON (mask &PAGE_MASK ); -again: +/* When dirty tracking is enabled, allow only min supported pgsize */ +if ((unmap->flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) && + (!iommu->dirty_page_tracking || (bitmap->pgsize != pgsize))) { + ret = -EINVAL ; + goto unlock; + } +WARN_ON ((pgsize -1 ) &PAGE_MASK ); +again:/* * vfio-iommu-type1 (v1) - User mappings were coalesced together to * avoid tracking individual mappings. This means that the granularity @@ -1046,6 +1058,7 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu, ret = -EINVAL ; goto unlock; } + dma =vfio_find_dma (iommu, unmap->iova + unmap->size -1 ,0 );if (dma && dma->iova + dma->size != unmap->iova + unmap->size) { ret = -EINVAL ;@@ -1063,6 +1076,39 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu,if (dma->task->mm != current->mm)break ; +if ((unmap->flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) && + (dma_last != dma)) { +unsigned int nbits = dma->size >> pgshift; +int curr_lcnt = nbits /BITS_PER_LONG ; + +/* +* mark all pages dirty if all pages are pinned and +* mapped. +*/ +if (dma->iommu_mapped) +bitmap_set (dma->bitmap,0 , nbits); + +if (shift) { +bitmap_shift_left (dma->bitmap, dma->bitmap, + shift, nbits + shift); +bitmap_or (dma->bitmap, dma->bitmap, &leftover, + shift); + nbits += shift; + curr_lcnt = nbits /BITS_PER_LONG ; + } + +if (copy_to_user ((void __user *)bitmap->data + cnt, + dma->bitmap, curr_lcnt *sizeof (u64))) { + ret = -EFAULT ; +break ; + } + + shift = nbits %BITS_PER_LONG ;Quoted 8 lines
drivers/vfio/vfio_iommu_type1.c static int vfio_dma_do_unmap(struct vfio_iommu *iommu, · line 1110
Quoted 4 lines
drivers/vfio/vfio_iommu_type1.c +4
-0+if (shift) + leftover = *(u64 *)(dma->bitmap + curr_lcnt); + cnt += curr_lcnt; + }I don't think this works. Let's say for example we have separate single page mappings at 4K and 12K (both dirty) and the user asked to unmap the range 0 - 16K.
Quoted 1 line
Unmap range should include adjacent mapped ranges, right?
Not required.
Quoted 2 lines
In your example, if user asks for range 0-16k but mapping at 0 wasn't done, then this unmap would fail before even reaching control here.
Nope, that's supported.
Quoted 7 lines
There is a check which makes sure that mapping for start of range exist:
dma = vfio_find_dma(iommu, unmap->iova, 1); if (dma && dma->iova != unmap->iova) { ret = -EINVAL; goto unlock; }
if (dma && ...
Quoted 7 lines
There is a check which makes sure that mapping for last address of range exist:
dma = vfio_find_dma(iommu, unmap->iova + unmap->size - 1, 0); if (dma && dma->iova + dma->size != unmap->iova + unmap->size) { ret = -EINVAL; goto unlock; }
if (dma && ...
These are the tests that require an unmap request not _bisect_ a mapping, both tests are preceded by a check of if we found a mapping at that address, not a requirement that there be a mapping at that address, nor a requirement that mappings are consecutive across the unmap range. A user can absolutely call unmap with iova = 0, size = S64_MAX to clear a massive chunk of the address space.
Quoted 1 line
Then current implementation should work.
Even if I change my example that the user requested an unmap of 4K-16K with 4K mappings at 4K and 12K, the bitmap returned would have bits 0 & 1 set rather than bits 0 & 2, which is still incorrect. Thanks,
Alex
Quoted 160 lines
Quoted 159 lines
We find the mapping at 4K, shift is zero, cnt
is zero, so we copy the bitmap with the zero bit set to the user buffer. We're already wrong because we've just indicated the page at zero is dirty and there isn't a page at zero. shift now becomes 1 and leftover is a bitmap with bit zero set.We move on to the next page @12K. We shift this bitmap by 1. We OR in our leftover and again copy out to the user buffer. We end up with a user bitmap with bits zero and one set, when we should have had bits 1 and 3 set, we're essentially coalescing the mappings.
As I see it, shift needs to be calculated as the offset from the start of the user requested unmap buffer and I think an easier approach to handle the leftover bits preceding the shift is to copy it back out of the user buffer.
For example, shift should be:
((
dma->iova-unmap->iova) >> pgshift) %BITS_PER_LONGThis would give us a shift of 1 and 3 respectively for our mappings, which is correct.
Since our shifts are non-zero, we then need to collect the preceding leftovers, which is always going to be:
copy_from_user(&leftover,
bitmap->data+((dma->iova - unmap->iova) >> pgshift) / BITS_PER_LONG, sizeof(leftover));I don't think the
curr_lcntcalculation for the copy-out is correct either, mappings are not required to be a multiple ofBITS_PER_LONGpages, so we're truncating the size.So we have:
bit_offset= (dma->iova-unmap->iova) >> pgshift;copy_offset=bit_offset/BITS_PER_LONG; shift =bit_offset%BITS_PER_LONG;if (shift) { bitmap_shift_left(dma->bitmap, dma->bitmap, shift, nbits + shift); if (copy_from_user(&leftover, bitmap->data + copy_offset, sizeof(leftover))) { ret = -EFAULT; break; } bitmap_or(dma->bitmap, dma->bitmap, &leftover, shift); }if (copy_to_user(bitmap->data +
copy_offset,dma->bitmap,roundup(nbits + shift, BITS_PER_LONG)/BITS_PER_BYTE)) { ret = -EFAULT; break; }Also this all needs to come after the below check of the
pfn_listand call to the blocking notifier or else we're just wasting time because we'll need to do it all again anyway.Quoted 5 lines
drivers/vfio/vfio_iommu_type1.c +1
-0+if (!RB_EMPTY_ROOT (&dma->pfn_list)) {struct vfio_iommu_type1_dma_unmap nb_unmap;drivers/vfio/vfio_iommu_type1.c static int vfio_dma_do_unmap(struct vfio_iommu *iommu, · line 1147
Quoted 9 lines
drivers/vfio/vfio_iommu_type1.c +6
-0@@ -1093,6 +1139,13 @@ static int vfio_dma_do_unmap(struct vfio_iommu *iommu,vfio_remove_dma (iommu, dma); } +if (!ret && (unmap->flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) && + shift) { +if (copy_to_user ((void __user *)bitmap->data + cnt, &leftover, +sizeof (leftover))) + ret = -EFAULT ; + }This is unnecessary with the algorithm I propose.
Quoted 54 lines
drivers/vfio/vfio_iommu_type1.c +27
-3+ unlock:mutex_unlock (&iommu->lock);@@ -2426,17 +2479,40 @@ static long vfio_iommu_type1_ioctl(void *iommu_data, }else if (cmd ==VFIO_IOMMU_UNMAP_DMA ) {struct vfio_iommu_type1_dma_unmap unmap; -long ret; +struct vfio_bitmap bitmap = {0 }; +int ret; minsz = offsetofend(struct vfio_iommu_type1_dma_unmap, size);if (copy_from_user (&unmap, (void __user *)arg, minsz))return -EFAULT ; -if (unmap.argsz < minsz || unmap.flags) +if (unmap.argsz < minsz || + unmap.flags & ~VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP )return -EINVAL ; - ret =vfio_dma_do_unmap (iommu, &unmap); +if (unmap.flags &VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP ) { +unsigned long pgshift; + +if (unmap.argsz < (minsz +sizeof (bitmap))) +return -EINVAL ; + +if (copy_from_user (&bitmap, + (void __user *)(arg + minsz), +sizeof (bitmap))) +return -EFAULT ; + +if (!access_ok ((void __user *)bitmap.data, bitmap.size)) +return -EINVAL ; + + pgshift =__ffs (bitmap.pgsize); + ret =verify_bitmap_size (unmap.size >> pgshift, + bitmap.size); +if (ret) +return ret; + } + + ret =vfio_dma_do_unmap (iommu, &unmap, &bitmap);if (ret)return ret;include/uapi/linux/vfio.h +0
-0@@ -1048,12 +1048,22 @@ struct vfio_bitmap {* field. No guarantee is made to the user that arbitrary unmaps of iova include/uapi/linux/vfio.h struct vfio_bitmap { · line 1058
Quoted 10 lines
include/uapi/linux/vfio.h +8
-0* or size different from those used in the original mapping call will * succeed. +* VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP should be set to get dirty bitmap +* before unmapping IO virtual addresses. When this flag is set, user must +* provide data[] as structure vfio_bitmap. User must allocate memory to get +* bitmap and must set size of allocated memory in vfio_bitmap.size field. +* A bit in bitmap represents one page of user provided page size in 'pgsize', +* consecutively starting from iova offset. Bit set indicates page at that +* offset from iova is dirty. Bitmap of pages in the range of unmapped size is +* returned in vfio_bitmap.data This needs to specify a user zero'd bitmap if we're only going to fill it sparsely. Thanks,
Alex
Quoted 11 lines
include/uapi/linux/vfio.h +2
-0*/ struct vfio_iommu_type1_dma_unmap {__u32 argsz;__u32 flags; +#define VFIO_DMA_UNMAP_FLAG_GET_DIRTY_BITMAP (1 << 0)__u64 iova;/* IO virtual address */ __u64 size;/* Size of mapping (bytes) */ +__u8 data[]; };#define VFIO_IOMMU_UNMAP_DMA _IO(VFIO_TYPE, VFIO_BASE + 14)
PATCH v19 7/8 vfio iommu: Add migration capability to report supported features
In reply to Kirti WankhedeAdded migration capability in IOMMU info chain.
User application should check IOMMU info chain for migration capability to use dirty page tracking feature provided by kernel module. User application must check page sizes supported and maximum dirty bitmap size returned by this capability structure for ioctls used to get dirty bitmap.
--- drivers/vfio/vfio_iommu_type1.c | 24 +++++++++++++++++++++++- include/uapi/linux/vfio.h | 21 +++++++++++++++++++++ 2 files changed, 44 insertions(+), 1 deletion(-)
drivers/vfio/vfio_iommu_type1.c +23 -1
@@ -2389,6 +2389,22 @@ static int vfio_iommu_iova_build_caps(struct vfio_iommu *iommu,return ret; } +static int vfio_iommu_migration_build_caps (struct vfio_iommu *iommu, +struct vfio_info_cap *caps) +{ +struct vfio_iommu_type1_info_cap_migration cap_mig; + + cap_mig.header.id =VFIO_IOMMU_TYPE1_INFO_CAP_MIGRATION ; + cap_mig.header.version =1 ; + cap_mig.flags =VFIO_IOMMU_INFO_CAPS_MIGRATION_DIRTY_PAGE_TRACK ; + +/* support minimum pgsize */ + cap_mig.pgsize_bitmap = (size_t )1 <<__ffs (iommu->pgsize_bitmap); + cap_mig.max_dirty_bitmap_size =DIRTY_BITMAP_SIZE_MAX ; + +return vfio_info_add_capability (caps, &cap_mig.header,sizeof (cap_mig)); +} +static long vfio_iommu_type1_ioctl (void *iommu_data,unsigned int cmd,unsigned long arg) {
@@ -2433,10 +2449,16 @@ static long vfio_iommu_type1_ioctl(void *iommu_data,mutex_lock (&iommu->lock); info.flags =VFIO_IOMMU_INFO_PGSIZES ; +vfio_pgsize_bitmap (iommu); info.iova_pgsizes = iommu->pgsize_bitmap; - ret =vfio_iommu_iova_build_caps (iommu, &caps); + ret =vfio_iommu_migration_build_caps (iommu, &caps); + +if (!ret) + ret =vfio_iommu_iova_build_caps (iommu, &caps); +mutex_unlock (&iommu->lock); +if (ret)return ret;
include/uapi/linux/vfio.h +21 -0
@@ -1013,6 +1013,27 @@ struct vfio_iommu_type1_info_cap_iova_range {struct vfio_iova_range iova_ranges[]; }; +/* +* The migration capability allows to report supported features for migration. +* +* The structures below define version 1 of this capability. +* +* pgsize_bitmap: Kernel driver returns supported page sizes bitmap for dirty +* page tracking. +* max_dirty_bitmap_size: Kernel driver returns maximum supported dirty bitmap +* size in bytes to be used by user application for ioctls to get dirty bitmap. +*/ +#define VFIO_IOMMU_TYPE1_INFO_CAP_MIGRATION 1 + +struct vfio_iommu_type1_info_cap_migration { +struct vfio_info_cap_header header; +__u32 flags; +/* supports dirty page tracking */ +#define VFIO_IOMMU_INFO_CAPS_MIGRATION_DIRTY_PAGE_TRACK (1 << 0) +__u64 pgsize_bitmap; +__u64 max_dirty_bitmap_size;/* in bytes */ +}; +#define VFIO_IOMMU_GET_INFO _IO(VFIO_TYPE, VFIO_BASE + 12)/**
Signature · 1 line
2.7.0
Re: [PATCH Kernel v19 7/8] vfio iommu: Add migration capability to report supported features
Quoted 41 lines · On Thu, 14 May 2020 01:34:38 +0530 Kirti Wankhede <[email protected]> wrote:
Added migration capability in IOMMU info chain.
User application should check IOMMU info chain for migration capability to use dirty page tracking feature provided by kernel module. User application must check page sizes supported and maximum dirty bitmap size returned by this capability structure for ioctls used to get dirty bitmap.Signed-off-by Kirti Wankhede <[email protected]>--- drivers/vfio/vfio_iommu_type1.c | 24 +++++++++++++++++++++++- include/uapi/linux/vfio.h | 21 +++++++++++++++++++++ 2 files changed, 44 insertions(+), 1 deletion(-)drivers/vfio/vfio_iommu_type1.c +16
-0@@ -2389,6 +2389,22 @@ static int vfio_iommu_iova_build_caps(struct vfio_iommu *iommu,return ret; } +static int vfio_iommu_migration_build_caps (struct vfio_iommu *iommu, +struct vfio_info_cap *caps) +{ +struct vfio_iommu_type1_info_cap_migration cap_mig; + + cap_mig.header.id =VFIO_IOMMU_TYPE1_INFO_CAP_MIGRATION ; + cap_mig.header.version =1 ; + cap_mig.flags =VFIO_IOMMU_INFO_CAPS_MIGRATION_DIRTY_PAGE_TRACK ; + +/* support minimum pgsize */ + cap_mig.pgsize_bitmap = (size_t )1 <<__ffs (iommu->pgsize_bitmap); + cap_mig.max_dirty_bitmap_size =DIRTY_BITMAP_SIZE_MAX ; + +return vfio_info_add_capability (caps, &cap_mig.header,sizeof (cap_mig)); +} +static long vfio_iommu_type1_ioctl (void *iommu_data,unsigned int cmd,unsigned long arg) {
drivers/vfio/vfio_iommu_type1.c static long vfio_iommu_type1_ioctl(void *iommu_data, · line 2452
Quoted 4 lines
drivers/vfio/vfio_iommu_type1.c +1
-0@@ -2433,10 +2449,16 @@ static long vfio_iommu_type1_ioctl(void *iommu_data,mutex_lock (&iommu->lock); info.flags =VFIO_IOMMU_INFO_PGSIZES ; +vfio_pgsize_bitmap (iommu);
Why is it necessary to rebuild the bitmap here? The user can't get to this ioctl until they've added a group to the container and set the IOMMU model.
Quoted 28 lines
drivers/vfio/vfio_iommu_type1.c +6
-1info.iova_pgsizes = iommu->pgsize_bitmap; - ret =vfio_iommu_iova_build_caps (iommu, &caps); + ret =vfio_iommu_migration_build_caps (iommu, &caps); + +if (!ret) + ret =vfio_iommu_iova_build_caps (iommu, &caps); +mutex_unlock (&iommu->lock); +if (ret)return ret;include/uapi/linux/vfio.h +7
-0@@ -1013,6 +1013,27 @@ struct vfio_iommu_type1_info_cap_iova_range {struct vfio_iova_range iova_ranges[]; }; +/* +* The migration capability allows to report supported features for migration. +* +* The structures below define version 1 of this capability. +* +* pgsize_bitmap: Kernel driver returns supported page sizes bitmap for dirty +* page tracking.
include/uapi/linux/vfio.h struct vfio_iommu_type1_info_cap_iova_range { · line 1032
Quoted 10 lines
include/uapi/linux/vfio.h +10
-0+* max_dirty_bitmap_size: Kernel driver returns maximum supported dirty bitmap +* size in bytes to be used by user application for ioctls to get dirty bitmap. +*/ +#define VFIO_IOMMU_TYPE1_INFO_CAP_MIGRATION 1 + +struct vfio_iommu_type1_info_cap_migration { +struct vfio_info_cap_header header; +__u32 flags; +/* supports dirty page tracking */ +#define VFIO_IOMMU_INFO_CAPS_MIGRATION_DIRTY_PAGE_TRACK (1 << 0)
This flag is a bit redundant to the purpose of this capability, isn't it? I think exposing the capability itself is indicating support for dirty page tracking. We should probably be explicit in the comment about exactly what interface this capability implies. Thanks,
Alex
Quoted 7 lines
include/uapi/linux/vfio.h +4
-0+__u64 pgsize_bitmap; +__u64 max_dirty_bitmap_size;/* in bytes */ +}; +#define VFIO_IOMMU_GET_INFO _IO(VFIO_TYPE, VFIO_BASE + 12)/**
Re: [PATCH Kernel v19 7/8] vfio iommu: Add migration capability to report supported features
Quoted 47 lines · Alex Williamson
Quoted 44 lines · On Thu, 14 May 2020 01:34:38 +0530 Kirti Wankhede <[email protected]> wrote:
Added migration capability in IOMMU info chain.
User application should check IOMMU info chain for migration capability to use dirty page tracking feature provided by kernel module. User application must check page sizes supported and maximum dirty bitmap size returned by this capability structure for ioctls used to get dirty bitmap.Signed-off-by Kirti Wankhede <[email protected]>--- drivers/vfio/vfio_iommu_type1.c | 24 +++++++++++++++++++++++- include/uapi/linux/vfio.h | 21 +++++++++++++++++++++ 2 files changed, 44 insertions(+), 1 deletion(-)drivers/vfio/vfio_iommu_type1.c +16
-0@@ -2389,6 +2389,22 @@ static int vfio_iommu_iova_build_caps(struct vfio_iommu *iommu,return ret; } +static int vfio_iommu_migration_build_caps (struct vfio_iommu *iommu, +struct vfio_info_cap *caps) +{ +struct vfio_iommu_type1_info_cap_migration cap_mig; + + cap_mig.header.id =VFIO_IOMMU_TYPE1_INFO_CAP_MIGRATION ; + cap_mig.header.version =1 ; + cap_mig.flags =VFIO_IOMMU_INFO_CAPS_MIGRATION_DIRTY_PAGE_TRACK ; + +/* support minimum pgsize */ + cap_mig.pgsize_bitmap = (size_t )1 <<__ffs (iommu->pgsize_bitmap); + cap_mig.max_dirty_bitmap_size =DIRTY_BITMAP_SIZE_MAX ; + +return vfio_info_add_capability (caps, &cap_mig.header,sizeof (cap_mig)); +} +static long vfio_iommu_type1_ioctl (void *iommu_data,unsigned int cmd,unsigned long arg) {@@ -2433,10 +2449,16 @@ static long vfio_iommu_type1_ioctl(void *iommu_data,mutex_lock (&iommu->lock); info.flags =VFIO_IOMMU_INFO_PGSIZES ;
Quoted 8 lines
drivers/vfio/vfio_iommu_type1.c static long vfio_iommu_type1_ioctl(void *iommu_data, · line 2452
Quoted 1 line
drivers/vfio/vfio_iommu_type1.c +1
-0+vfio_pgsize_bitmap (iommu);Why is it necessary to rebuild the bitmap here? The user can't get to this ioctl until they've added a group to the container and set the IOMMU model.
For mdev device, domain is not added to domain_list so vfio_pgsize_bitmap() doesn't get called when there is only mdev device attached.
Your concern is right though, vfio_pgsize_bitmap() should get populated with attach_group,so fixing it by calling vfio_pgsize_bitmap() for mdev device when iommu->external_domain is set.
Quoted 35 lines
Quoted 35 lines
drivers/vfio/vfio_iommu_type1.c +6
-1info.iova_pgsizes = iommu->pgsize_bitmap; - ret =vfio_iommu_iova_build_caps (iommu, &caps); + ret =vfio_iommu_migration_build_caps (iommu, &caps); + +if (!ret) + ret =vfio_iommu_iova_build_caps (iommu, &caps); +mutex_unlock (&iommu->lock); +if (ret)return ret;include/uapi/linux/vfio.h +14
-0@@ -1013,6 +1013,27 @@ struct vfio_iommu_type1_info_cap_iova_range {struct vfio_iova_range iova_ranges[]; }; +/* +* The migration capability allows to report supported features for migration. +* +* The structures below define version 1 of this capability. +* +* pgsize_bitmap: Kernel driver returns supported page sizes bitmap for dirty +* page tracking. +* max_dirty_bitmap_size: Kernel driver returns maximum supported dirty bitmap +* size in bytes to be used by user application for ioctls to get dirty bitmap. +*/ +#define VFIO_IOMMU_TYPE1_INFO_CAP_MIGRATION 1 + +struct vfio_iommu_type1_info_cap_migration { +struct vfio_info_cap_header header;
Quoted 9 lines
include/uapi/linux/vfio.h struct vfio_iommu_type1_info_cap_iova_range { · line 1032
Quoted 3 lines
include/uapi/linux/vfio.h +3
-0+__u32 flags; +/* supports dirty page tracking */ +#define VFIO_IOMMU_INFO_CAPS_MIGRATION_DIRTY_PAGE_TRACK (1 << 0)This flag is a bit redundant to the purpose of this capability, isn't it? I think exposing the capability itself is indicating support for dirty page tracking. We should probably be explicit in the comment about exactly what interface this capability implies. Thanks,
Capability is added to provide provision for feature flags that kernel driver support, that's where we started right?
Later added pgsize_bitmap and max supported bitmap size as you suggested.
I'm confused now, should I keep this flag here?
Even if the flag is removed, 'flags' field is still required so that whenever new feature is added, new flag will be added. That's the whole purpose we added this capability. Can we add a field which is not used? and we don't know when it will be used in future?
Thanks,
Kirti
Quoted 10 lines
Alex
Quoted 7 lines
include/uapi/linux/vfio.h +4
-0+__u64 pgsize_bitmap; +__u64 max_dirty_bitmap_size;/* in bytes */ +}; +#define VFIO_IOMMU_GET_INFO _IO(VFIO_TYPE, VFIO_BASE + 12)/**
Re: [PATCH Kernel v19 7/8] vfio iommu: Add migration capability to report supported features
Quoted 108 lines · On Thu, 14 May 2020 17:25:10 +0530 Kirti Wankhede <[email protected]> wrote:
Quoted 47 lines · Alex Williamson
Quoted 44 lines · On Thu, 14 May 2020 01:34:38 +0530 Kirti Wankhede <[email protected]> wrote:
Added migration capability in IOMMU info chain.
User application should check IOMMU info chain for migration capability to use dirty page tracking feature provided by kernel module. User application must check page sizes supported and maximum dirty bitmap size returned by this capability structure for ioctls used to get dirty bitmap.Signed-off-by Kirti Wankhede <[email protected]>--- drivers/vfio/vfio_iommu_type1.c | 24 +++++++++++++++++++++++- include/uapi/linux/vfio.h | 21 +++++++++++++++++++++ 2 files changed, 44 insertions(+), 1 deletion(-)drivers/vfio/vfio_iommu_type1.c +16
-0@@ -2389,6 +2389,22 @@ static int vfio_iommu_iova_build_caps(struct vfio_iommu *iommu,return ret; } +static int vfio_iommu_migration_build_caps (struct vfio_iommu *iommu, +struct vfio_info_cap *caps) +{ +struct vfio_iommu_type1_info_cap_migration cap_mig; + + cap_mig.header.id =VFIO_IOMMU_TYPE1_INFO_CAP_MIGRATION ; + cap_mig.header.version =1 ; + cap_mig.flags =VFIO_IOMMU_INFO_CAPS_MIGRATION_DIRTY_PAGE_TRACK ; + +/* support minimum pgsize */ + cap_mig.pgsize_bitmap = (size_t )1 <<__ffs (iommu->pgsize_bitmap); + cap_mig.max_dirty_bitmap_size =DIRTY_BITMAP_SIZE_MAX ; + +return vfio_info_add_capability (caps, &cap_mig.header,sizeof (cap_mig)); +} +static long vfio_iommu_type1_ioctl (void *iommu_data,unsigned int cmd,unsigned long arg) {@@ -2433,10 +2449,16 @@ static long vfio_iommu_type1_ioctl(void *iommu_data,mutex_lock (&iommu->lock); info.flags =VFIO_IOMMU_INFO_PGSIZES ;Quoted 8 lines
drivers/vfio/vfio_iommu_type1.c static long vfio_iommu_type1_ioctl(void *iommu_data, · line 2452
Quoted 1 line
drivers/vfio/vfio_iommu_type1.c +1
-0+vfio_pgsize_bitmap (iommu);Why is it necessary to rebuild the bitmap here? The user can't get to this ioctl until they've added a group to the container and set the IOMMU model.
For mdev device, domain is not added to
domain_listsovfio_pgsize_bitmap()doesn't get called when there is only mdev device attached.
Your concern is right though,vfio_pgsize_bitmap()should get populated with attach_group,so fixing it by callingvfio_pgsize_bitmap()for mdev device wheniommu->external_domainis set.Quoted 35 lines
Quoted 35 lines
drivers/vfio/vfio_iommu_type1.c +6
-1info.iova_pgsizes = iommu->pgsize_bitmap; - ret =vfio_iommu_iova_build_caps (iommu, &caps); + ret =vfio_iommu_migration_build_caps (iommu, &caps); + +if (!ret) + ret =vfio_iommu_iova_build_caps (iommu, &caps); +mutex_unlock (&iommu->lock); +if (ret)return ret;include/uapi/linux/vfio.h +14
-0@@ -1013,6 +1013,27 @@ struct vfio_iommu_type1_info_cap_iova_range {struct vfio_iova_range iova_ranges[]; }; +/* +* The migration capability allows to report supported features for migration. +* +* The structures below define version 1 of this capability. +* +* pgsize_bitmap: Kernel driver returns supported page sizes bitmap for dirty +* page tracking. +* max_dirty_bitmap_size: Kernel driver returns maximum supported dirty bitmap +* size in bytes to be used by user application for ioctls to get dirty bitmap. +*/ +#define VFIO_IOMMU_TYPE1_INFO_CAP_MIGRATION 1 + +struct vfio_iommu_type1_info_cap_migration { +struct vfio_info_cap_header header;Quoted 9 lines
include/uapi/linux/vfio.h struct vfio_iommu_type1_info_cap_iova_range { · line 1032
Quoted 3 lines
include/uapi/linux/vfio.h +3
-0+__u32 flags; +/* supports dirty page tracking */ +#define VFIO_IOMMU_INFO_CAPS_MIGRATION_DIRTY_PAGE_TRACK (1 << 0)This flag is a bit redundant to the purpose of this capability, isn't it? I think exposing the capability itself is indicating support for dirty page tracking. We should probably be explicit in the comment about exactly what interface this capability implies. Thanks,
Quoted 8 lines
Capability is added to provide provision for feature flags that kernel driver support, that's where we started right?
Later addedpgsize_bitmapand max supported bitmap size as you suggested. I'm confused now, should I keep this flag here?
Even if the flag is removed, 'flags' field is still required so that whenever new feature is added, new flag will be added. That's the whole purpose we added this capability. Can we add a field which is not used? and we don't know when it will be used in future?
We have empty flags fields all over the uapi. When I look at this capability, I wonder what it means if it were to be implemented without VFIO_IOMMU_INFO_CAPS_MIGRATION_DIRTY_PAGE_TRACK set. For example, what migration feature would an IOMMU be exposing if it didn't have dirty page tracking. All of the extensions we're implementing to support migration in the IOMMU are related to dirty page tracking. Therefore it seems that the existence of the capability itself is expressing the support for dirty page tracking, right? Thanks,
Alex
Quoted 9 lines
Quoted 8 lines
Quoted 7 lines
include/uapi/linux/vfio.h +4
-0+__u64 pgsize_bitmap; +__u64 max_dirty_bitmap_size;/* in bytes */ +}; +#define VFIO_IOMMU_GET_INFO _IO(VFIO_TYPE, VFIO_BASE + 12)/**
PATCH v19 8/8 vfio: Selective dirty page tracking if IOMMU backed device pins pages
In reply to Kirti WankhedeAdded a check such that only singleton IOMMU groups can pin pages. From the point when vendor driver pins any pages, consider IOMMU group dirty page scope to be limited to pinned pages.
To optimize to avoid walking list often, added flag pinned_page_dirty_scope to indicate if all of the vfio_groups for each vfio_domain in the domain_list dirty page scope is limited to pinned pages. This flag is updated on first pinned pages request for that IOMMU group and on attaching/detaching group.
--- drivers/vfio/vfio.c | 13 ++++-- drivers/vfio/vfio_iommu_type1.c | 94 +++++++++++++++++++++++++++++++++++++++-- include/linux/vfio.h | 4 +- 3 files changed, 104 insertions(+), 7 deletions(-)
drivers/vfio/vfio.c +10 -3
@@ -85,6 +85,7 @@ struct vfio_group {atomic_t opened;wait_queue_head_t container_q;bool noiommu; +unsigned int dev_counter;struct kvm *kvm;struct blocking_notifier_head notifier; };
@@ -555,6 +556,7 @@ struct vfio_device *vfio_group_create_device(struct vfio_group *group,mutex_lock (&group->device_lock);list_add (&device->group_next, &group->device_list); + group->dev_counter++;mutex_unlock (&group->device_lock);return device;
@@ -567,6 +569,7 @@ static void vfio_device_release(struct kref *kref)struct vfio_group *group = device->group;list_del (&device->group_next); + group->dev_counter--;mutex_unlock (&group->device_lock);dev_set_drvdata (device->dev,NULL );
@@ -1945,6 +1948,9 @@ int vfio_pin_pages(struct device *dev, unsigned long *user_pfn, int npage,if (!group)return -ENODEV ; +if (group->dev_counter >1 ) +return -EINVAL ; + ret =vfio_group_add_container_user (group);if (ret) goto err_pin_pages;
@@ -1952,7 +1958,8 @@ int vfio_pin_pages(struct device *dev, unsigned long *user_pfn, int npage, container = group->container; driver = container->iommu_driver;if (likely (driver && driver->ops->pin_pages)) - ret = driver->ops->pin_pages (container->iommu_data, user_pfn, + ret = driver->ops->pin_pages (container->iommu_data, + group->iommu_group, user_pfn, npage, prot, phys_pfn);else ret = -ENOTTY ;
@@ -2050,8 +2057,8 @@ int vfio_group_pin_pages(struct vfio_group *group, driver = container->iommu_driver;if (likely (driver && driver->ops->pin_pages)) ret = driver->ops->pin_pages (container->iommu_data, - user_iova_pfn, npage, - prot, phys_pfn); + group->iommu_group, user_iova_pfn, + npage, prot, phys_pfn);else ret = -ENOTTY ;
drivers/vfio/vfio_iommu_type1.c +91 -3
178 lines not on this page · raw message
include/linux/vfio.h +3 -1
@@ -76,7 +76,9 @@ struct vfio_iommu_driver_ops { struct iommu_group *group);void (*detach_group)(void *iommu_data,struct iommu_group *group); -int (*pin_pages)(void *iommu_data,unsigned long *user_pfn, +int (*pin_pages)(void *iommu_data, +struct iommu_group *group, +unsigned long *user_pfn,int npage,int prot,unsigned long *phys_pfn); int (*unpin_pages)(void *iommu_data,
Signature · 1 line
2.7.0