1 /*
2 * VFIO BASE CONTAINER
3 *
4 * Copyright (C) 2023 Intel Corporation.
5 * Copyright Red Hat, Inc. 2023
6 *
7 * Authors: Yi Liu <yi.l.liu@intel.com>
8 * Eric Auger <eric.auger@redhat.com>
9 *
10 * SPDX-License-Identifier: GPL-2.0-or-later
11 */
12
13 #ifndef HW_VFIO_VFIO_CONTAINER_BASE_H
14 #define HW_VFIO_VFIO_CONTAINER_BASE_H
15
16 #include "exec/memory.h"
17
18 typedef struct VFIODevice VFIODevice;
19 typedef struct VFIOIOMMUClass VFIOIOMMUClass;
20
21 typedef struct {
22 unsigned long *bitmap;
23 hwaddr size;
24 hwaddr pages;
25 } VFIOBitmap;
26
27 typedef struct VFIOAddressSpace {
28 AddressSpace *as;
29 QLIST_HEAD(, VFIOContainerBase) containers;
30 QLIST_ENTRY(VFIOAddressSpace) list;
31 } VFIOAddressSpace;
32
33 /*
34 * This is the base object for vfio container backends
35 */
36 typedef struct VFIOContainerBase {
37 Object parent;
38 VFIOAddressSpace *space;
39 MemoryListener listener;
40 Error *error;
41 bool initialized;
42 uint64_t dirty_pgsizes;
43 uint64_t max_dirty_bitmap_size;
44 unsigned long pgsizes;
45 unsigned int dma_max_mappings;
46 bool dirty_pages_supported;
47 bool dirty_pages_started; /* Protected by BQL */
48 QLIST_HEAD(, VFIOGuestIOMMU) giommu_list;
49 QLIST_HEAD(, VFIORamDiscardListener) vrdl_list;
50 QLIST_ENTRY(VFIOContainerBase) next;
51 QLIST_HEAD(, VFIODevice) device_list;
52 GList *iova_ranges;
53 NotifierWithReturn cpr_reboot_notifier;
54 } VFIOContainerBase;
55
56 typedef struct VFIOGuestIOMMU {
57 VFIOContainerBase *bcontainer;
58 IOMMUMemoryRegion *iommu_mr;
59 hwaddr iommu_offset;
60 IOMMUNotifier n;
61 QLIST_ENTRY(VFIOGuestIOMMU) giommu_next;
62 } VFIOGuestIOMMU;
63
64 typedef struct VFIORamDiscardListener {
65 VFIOContainerBase *bcontainer;
66 MemoryRegion *mr;
67 hwaddr offset_within_address_space;
68 hwaddr size;
69 uint64_t granularity;
70 RamDiscardListener listener;
71 QLIST_ENTRY(VFIORamDiscardListener) next;
72 } VFIORamDiscardListener;
73
74 int vfio_container_dma_map(VFIOContainerBase *bcontainer,
75 hwaddr iova, ram_addr_t size,
76 void *vaddr, bool readonly);
77 int vfio_container_dma_unmap(VFIOContainerBase *bcontainer,
78 hwaddr iova, ram_addr_t size,
79 IOMMUTLBEntry *iotlb);
80 bool vfio_container_add_section_window(VFIOContainerBase *bcontainer,
81 MemoryRegionSection *section,
82 Error **errp);
83 void vfio_container_del_section_window(VFIOContainerBase *bcontainer,
84 MemoryRegionSection *section);
85 int vfio_container_set_dirty_page_tracking(VFIOContainerBase *bcontainer,
86 bool start, Error **errp);
87 int vfio_container_query_dirty_bitmap(const VFIOContainerBase *bcontainer,
88 VFIOBitmap *vbmap, hwaddr iova, hwaddr size, Error **errp);
89
90 GList *vfio_container_get_iova_ranges(const VFIOContainerBase *bcontainer);
91
92 static inline uint64_t
vfio_container_get_page_size_mask(const VFIOContainerBase * bcontainer)93 vfio_container_get_page_size_mask(const VFIOContainerBase *bcontainer)
94 {
95 assert(bcontainer);
96 return bcontainer->pgsizes;
97 }
98
99 #define TYPE_VFIO_IOMMU "vfio-iommu"
100 #define TYPE_VFIO_IOMMU_LEGACY TYPE_VFIO_IOMMU "-legacy"
101 #define TYPE_VFIO_IOMMU_SPAPR TYPE_VFIO_IOMMU "-spapr"
102 #define TYPE_VFIO_IOMMU_IOMMUFD TYPE_VFIO_IOMMU "-iommufd"
103
104 OBJECT_DECLARE_TYPE(VFIOContainerBase, VFIOIOMMUClass, VFIO_IOMMU)
105
106 struct VFIOIOMMUClass {
107 ObjectClass parent_class;
108
109 /* Properties */
110 const char *hiod_typename;
111
112 /* basic feature */
113 bool (*setup)(VFIOContainerBase *bcontainer, Error **errp);
114 int (*dma_map)(const VFIOContainerBase *bcontainer,
115 hwaddr iova, ram_addr_t size,
116 void *vaddr, bool readonly);
117 int (*dma_unmap)(const VFIOContainerBase *bcontainer,
118 hwaddr iova, ram_addr_t size,
119 IOMMUTLBEntry *iotlb);
120 bool (*attach_device)(const char *name, VFIODevice *vbasedev,
121 AddressSpace *as, Error **errp);
122 void (*detach_device)(VFIODevice *vbasedev);
123
124 /* migration feature */
125
126 /**
127 * @set_dirty_page_tracking
128 *
129 * Start or stop dirty pages tracking on VFIO container
130 *
131 * @bcontainer: #VFIOContainerBase on which to de/activate dirty
132 * page tracking
133 * @start: indicates whether to start or stop dirty pages tracking
134 * @errp: pointer to Error*, to store an error if it happens.
135 *
136 * Returns zero to indicate success and negative for error
137 */
138 int (*set_dirty_page_tracking)(const VFIOContainerBase *bcontainer,
139 bool start, Error **errp);
140 /**
141 * @query_dirty_bitmap
142 *
143 * Get bitmap of dirty pages from container
144 *
145 * @bcontainer: #VFIOContainerBase from which to get dirty pages
146 * @vbmap: #VFIOBitmap internal bitmap structure
147 * @iova: iova base address
148 * @size: size of iova range
149 * @errp: pointer to Error*, to store an error if it happens.
150 *
151 * Returns zero to indicate success and negative for error
152 */
153 int (*query_dirty_bitmap)(const VFIOContainerBase *bcontainer,
154 VFIOBitmap *vbmap, hwaddr iova, hwaddr size, Error **errp);
155 /* PCI specific */
156 int (*pci_hot_reset)(VFIODevice *vbasedev, bool single);
157
158 /* SPAPR specific */
159 bool (*add_window)(VFIOContainerBase *bcontainer,
160 MemoryRegionSection *section,
161 Error **errp);
162 void (*del_window)(VFIOContainerBase *bcontainer,
163 MemoryRegionSection *section);
164 void (*release)(VFIOContainerBase *bcontainer);
165 };
166 #endif /* HW_VFIO_VFIO_CONTAINER_BASE_H */
167