2023-11-02 10:12:27 +03:00
|
|
|
/*
|
|
|
|
* VFIO BASE CONTAINER
|
|
|
|
*
|
|
|
|
* Copyright (C) 2023 Intel Corporation.
|
|
|
|
* Copyright Red Hat, Inc. 2023
|
|
|
|
*
|
|
|
|
* Authors: Yi Liu <yi.l.liu@intel.com>
|
|
|
|
* Eric Auger <eric.auger@redhat.com>
|
|
|
|
*
|
|
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef HW_VFIO_VFIO_CONTAINER_BASE_H
|
|
|
|
#define HW_VFIO_VFIO_CONTAINER_BASE_H
|
|
|
|
|
|
|
|
#include "exec/memory.h"
|
|
|
|
|
|
|
|
typedef struct VFIODevice VFIODevice;
|
2023-12-19 09:58:19 +03:00
|
|
|
typedef struct VFIOIOMMUClass VFIOIOMMUClass;
|
2023-11-02 10:12:27 +03:00
|
|
|
|
|
|
|
typedef struct {
|
|
|
|
unsigned long *bitmap;
|
|
|
|
hwaddr size;
|
|
|
|
hwaddr pages;
|
|
|
|
} VFIOBitmap;
|
|
|
|
|
2023-11-02 10:12:32 +03:00
|
|
|
typedef struct VFIOAddressSpace {
|
|
|
|
AddressSpace *as;
|
|
|
|
QLIST_HEAD(, VFIOContainerBase) containers;
|
|
|
|
QLIST_ENTRY(VFIOAddressSpace) list;
|
|
|
|
} VFIOAddressSpace;
|
|
|
|
|
2023-11-02 10:12:27 +03:00
|
|
|
/*
|
|
|
|
* This is the base object for vfio container backends
|
|
|
|
*/
|
|
|
|
typedef struct VFIOContainerBase {
|
2024-06-17 09:34:03 +03:00
|
|
|
Object parent;
|
2023-11-02 10:12:32 +03:00
|
|
|
VFIOAddressSpace *space;
|
2023-11-02 10:12:38 +03:00
|
|
|
MemoryListener listener;
|
|
|
|
Error *error;
|
|
|
|
bool initialized;
|
2023-11-02 10:12:39 +03:00
|
|
|
uint64_t dirty_pgsizes;
|
|
|
|
uint64_t max_dirty_bitmap_size;
|
2023-11-02 10:12:36 +03:00
|
|
|
unsigned long pgsizes;
|
|
|
|
unsigned int dma_max_mappings;
|
2023-11-02 10:12:33 +03:00
|
|
|
bool dirty_pages_supported;
|
2023-11-02 10:12:31 +03:00
|
|
|
QLIST_HEAD(, VFIOGuestIOMMU) giommu_list;
|
2023-11-02 10:12:37 +03:00
|
|
|
QLIST_HEAD(, VFIORamDiscardListener) vrdl_list;
|
2023-11-02 10:12:32 +03:00
|
|
|
QLIST_ENTRY(VFIOContainerBase) next;
|
2023-11-02 10:12:34 +03:00
|
|
|
QLIST_HEAD(, VFIODevice) device_list;
|
2023-11-02 10:12:40 +03:00
|
|
|
GList *iova_ranges;
|
2024-02-22 20:28:38 +03:00
|
|
|
NotifierWithReturn cpr_reboot_notifier;
|
2023-11-02 10:12:27 +03:00
|
|
|
} VFIOContainerBase;
|
|
|
|
|
2023-11-02 10:12:31 +03:00
|
|
|
typedef struct VFIOGuestIOMMU {
|
|
|
|
VFIOContainerBase *bcontainer;
|
|
|
|
IOMMUMemoryRegion *iommu_mr;
|
|
|
|
hwaddr iommu_offset;
|
|
|
|
IOMMUNotifier n;
|
|
|
|
QLIST_ENTRY(VFIOGuestIOMMU) giommu_next;
|
|
|
|
} VFIOGuestIOMMU;
|
|
|
|
|
2023-11-02 10:12:37 +03:00
|
|
|
typedef struct VFIORamDiscardListener {
|
|
|
|
VFIOContainerBase *bcontainer;
|
|
|
|
MemoryRegion *mr;
|
|
|
|
hwaddr offset_within_address_space;
|
|
|
|
hwaddr size;
|
|
|
|
uint64_t granularity;
|
|
|
|
RamDiscardListener listener;
|
|
|
|
QLIST_ENTRY(VFIORamDiscardListener) next;
|
|
|
|
} VFIORamDiscardListener;
|
|
|
|
|
2023-11-02 10:12:29 +03:00
|
|
|
int vfio_container_dma_map(VFIOContainerBase *bcontainer,
|
|
|
|
hwaddr iova, ram_addr_t size,
|
|
|
|
void *vaddr, bool readonly);
|
|
|
|
int vfio_container_dma_unmap(VFIOContainerBase *bcontainer,
|
|
|
|
hwaddr iova, ram_addr_t size,
|
|
|
|
IOMMUTLBEntry *iotlb);
|
2024-05-07 09:42:46 +03:00
|
|
|
bool vfio_container_add_section_window(VFIOContainerBase *bcontainer,
|
|
|
|
MemoryRegionSection *section,
|
|
|
|
Error **errp);
|
2023-11-02 10:12:43 +03:00
|
|
|
void vfio_container_del_section_window(VFIOContainerBase *bcontainer,
|
|
|
|
MemoryRegionSection *section);
|
2023-11-02 10:12:33 +03:00
|
|
|
int vfio_container_set_dirty_page_tracking(VFIOContainerBase *bcontainer,
|
2024-05-16 15:46:50 +03:00
|
|
|
bool start, Error **errp);
|
2023-11-21 11:44:17 +03:00
|
|
|
int vfio_container_query_dirty_bitmap(const VFIOContainerBase *bcontainer,
|
2024-05-16 15:46:57 +03:00
|
|
|
VFIOBitmap *vbmap, hwaddr iova, hwaddr size, Error **errp);
|
2023-11-02 10:12:29 +03:00
|
|
|
|
2024-07-01 11:48:54 +03:00
|
|
|
GList *vfio_container_get_iova_ranges(const VFIOContainerBase *bcontainer);
|
|
|
|
|
2024-07-01 11:48:56 +03:00
|
|
|
static inline uint64_t
|
|
|
|
vfio_container_get_page_size_mask(const VFIOContainerBase *bcontainer)
|
|
|
|
{
|
|
|
|
assert(bcontainer);
|
|
|
|
return bcontainer->pgsizes;
|
|
|
|
}
|
|
|
|
|
2023-12-19 09:58:19 +03:00
|
|
|
#define TYPE_VFIO_IOMMU "vfio-iommu"
|
2023-12-19 09:58:20 +03:00
|
|
|
#define TYPE_VFIO_IOMMU_LEGACY TYPE_VFIO_IOMMU "-legacy"
|
2023-12-19 09:58:22 +03:00
|
|
|
#define TYPE_VFIO_IOMMU_SPAPR TYPE_VFIO_IOMMU "-spapr"
|
2023-12-19 09:58:23 +03:00
|
|
|
#define TYPE_VFIO_IOMMU_IOMMUFD TYPE_VFIO_IOMMU "-iommufd"
|
2023-12-19 09:58:19 +03:00
|
|
|
|
2024-06-17 09:34:03 +03:00
|
|
|
OBJECT_DECLARE_TYPE(VFIOContainerBase, VFIOIOMMUClass, VFIO_IOMMU)
|
2023-12-19 09:58:19 +03:00
|
|
|
|
|
|
|
struct VFIOIOMMUClass {
|
2024-06-17 09:34:03 +03:00
|
|
|
ObjectClass parent_class;
|
2023-12-19 09:58:19 +03:00
|
|
|
|
2024-06-05 11:30:37 +03:00
|
|
|
/* Properties */
|
|
|
|
const char *hiod_typename;
|
|
|
|
|
2023-11-02 10:12:27 +03:00
|
|
|
/* basic feature */
|
2024-05-07 09:42:45 +03:00
|
|
|
bool (*setup)(VFIOContainerBase *bcontainer, Error **errp);
|
2023-11-21 11:44:17 +03:00
|
|
|
int (*dma_map)(const VFIOContainerBase *bcontainer,
|
2023-11-02 10:12:27 +03:00
|
|
|
hwaddr iova, ram_addr_t size,
|
|
|
|
void *vaddr, bool readonly);
|
2023-11-21 11:44:17 +03:00
|
|
|
int (*dma_unmap)(const VFIOContainerBase *bcontainer,
|
2023-11-02 10:12:27 +03:00
|
|
|
hwaddr iova, ram_addr_t size,
|
|
|
|
IOMMUTLBEntry *iotlb);
|
2024-05-07 09:42:44 +03:00
|
|
|
bool (*attach_device)(const char *name, VFIODevice *vbasedev,
|
|
|
|
AddressSpace *as, Error **errp);
|
2023-11-02 10:12:27 +03:00
|
|
|
void (*detach_device)(VFIODevice *vbasedev);
|
2024-05-16 15:46:50 +03:00
|
|
|
|
2023-11-02 10:12:27 +03:00
|
|
|
/* migration feature */
|
2024-05-16 15:46:50 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @set_dirty_page_tracking
|
|
|
|
*
|
|
|
|
* Start or stop dirty pages tracking on VFIO container
|
|
|
|
*
|
|
|
|
* @bcontainer: #VFIOContainerBase on which to de/activate dirty
|
|
|
|
* page tracking
|
|
|
|
* @start: indicates whether to start or stop dirty pages tracking
|
|
|
|
* @errp: pointer to Error*, to store an error if it happens.
|
|
|
|
*
|
|
|
|
* Returns zero to indicate success and negative for error
|
|
|
|
*/
|
2023-11-21 11:44:17 +03:00
|
|
|
int (*set_dirty_page_tracking)(const VFIOContainerBase *bcontainer,
|
2024-05-16 15:46:50 +03:00
|
|
|
bool start, Error **errp);
|
2024-05-16 15:46:57 +03:00
|
|
|
/**
|
|
|
|
* @query_dirty_bitmap
|
|
|
|
*
|
|
|
|
* Get bitmap of dirty pages from container
|
|
|
|
*
|
|
|
|
* @bcontainer: #VFIOContainerBase from which to get dirty pages
|
|
|
|
* @vbmap: #VFIOBitmap internal bitmap structure
|
|
|
|
* @iova: iova base address
|
|
|
|
* @size: size of iova range
|
|
|
|
* @errp: pointer to Error*, to store an error if it happens.
|
|
|
|
*
|
|
|
|
* Returns zero to indicate success and negative for error
|
|
|
|
*/
|
2023-11-21 11:44:17 +03:00
|
|
|
int (*query_dirty_bitmap)(const VFIOContainerBase *bcontainer,
|
2024-05-16 15:46:57 +03:00
|
|
|
VFIOBitmap *vbmap, hwaddr iova, hwaddr size, Error **errp);
|
2023-11-21 11:44:07 +03:00
|
|
|
/* PCI specific */
|
|
|
|
int (*pci_hot_reset)(VFIODevice *vbasedev, bool single);
|
|
|
|
|
2023-11-02 10:12:42 +03:00
|
|
|
/* SPAPR specific */
|
2024-05-07 09:42:46 +03:00
|
|
|
bool (*add_window)(VFIOContainerBase *bcontainer,
|
|
|
|
MemoryRegionSection *section,
|
|
|
|
Error **errp);
|
2023-11-02 10:12:42 +03:00
|
|
|
void (*del_window)(VFIOContainerBase *bcontainer,
|
|
|
|
MemoryRegionSection *section);
|
2023-12-19 09:58:16 +03:00
|
|
|
void (*release)(VFIOContainerBase *bcontainer);
|
2023-11-02 10:12:27 +03:00
|
|
|
};
|
|
|
|
#endif /* HW_VFIO_VFIO_CONTAINER_BASE_H */
|