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     const VFIOIOMMUClass *ops;
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     QLIST_HEAD(, VFIOGuestIOMMU) giommu_list;
48     QLIST_HEAD(, VFIORamDiscardListener) vrdl_list;
49     QLIST_ENTRY(VFIOContainerBase) next;
50     QLIST_HEAD(, VFIODevice) device_list;
51     GList *iova_ranges;
52     NotifierWithReturn cpr_reboot_notifier;
53 } VFIOContainerBase;
54 
55 typedef struct VFIOGuestIOMMU {
56     VFIOContainerBase *bcontainer;
57     IOMMUMemoryRegion *iommu_mr;
58     hwaddr iommu_offset;
59     IOMMUNotifier n;
60     QLIST_ENTRY(VFIOGuestIOMMU) giommu_next;
61 } VFIOGuestIOMMU;
62 
63 typedef struct VFIORamDiscardListener {
64     VFIOContainerBase *bcontainer;
65     MemoryRegion *mr;
66     hwaddr offset_within_address_space;
67     hwaddr size;
68     uint64_t granularity;
69     RamDiscardListener listener;
70     QLIST_ENTRY(VFIORamDiscardListener) next;
71 } VFIORamDiscardListener;
72 
73 int vfio_container_dma_map(VFIOContainerBase *bcontainer,
74                            hwaddr iova, ram_addr_t size,
75                            void *vaddr, bool readonly);
76 int vfio_container_dma_unmap(VFIOContainerBase *bcontainer,
77                              hwaddr iova, ram_addr_t size,
78                              IOMMUTLBEntry *iotlb);
79 int vfio_container_add_section_window(VFIOContainerBase *bcontainer,
80                                       MemoryRegionSection *section,
81                                       Error **errp);
82 void vfio_container_del_section_window(VFIOContainerBase *bcontainer,
83                                        MemoryRegionSection *section);
84 int vfio_container_set_dirty_page_tracking(VFIOContainerBase *bcontainer,
85                                            bool start);
86 int vfio_container_query_dirty_bitmap(const VFIOContainerBase *bcontainer,
87                                       VFIOBitmap *vbmap,
88                                       hwaddr iova, hwaddr size);
89 
90 void vfio_container_init(VFIOContainerBase *bcontainer,
91                          VFIOAddressSpace *space,
92                          const VFIOIOMMUClass *ops);
93 void vfio_container_destroy(VFIOContainerBase *bcontainer);
94 
95 
96 #define TYPE_VFIO_IOMMU "vfio-iommu"
97 #define TYPE_VFIO_IOMMU_LEGACY TYPE_VFIO_IOMMU "-legacy"
98 #define TYPE_VFIO_IOMMU_SPAPR TYPE_VFIO_IOMMU "-spapr"
99 #define TYPE_VFIO_IOMMU_IOMMUFD TYPE_VFIO_IOMMU "-iommufd"
100 
101 /*
102  * VFIOContainerBase is not an abstract QOM object because it felt
103  * unnecessary to expose all the IOMMU backends to the QEMU machine
104  * and human interface. However, we can still abstract the IOMMU
105  * backend handlers using a QOM interface class. This provides more
106  * flexibility when referencing the various implementations.
107  */
108 DECLARE_CLASS_CHECKERS(VFIOIOMMUClass, VFIO_IOMMU, TYPE_VFIO_IOMMU)
109 
110 struct VFIOIOMMUClass {
111     InterfaceClass parent_class;
112 
113     /* basic feature */
114     int (*setup)(VFIOContainerBase *bcontainer, Error **errp);
115     int (*dma_map)(const VFIOContainerBase *bcontainer,
116                    hwaddr iova, ram_addr_t size,
117                    void *vaddr, bool readonly);
118     int (*dma_unmap)(const VFIOContainerBase *bcontainer,
119                      hwaddr iova, ram_addr_t size,
120                      IOMMUTLBEntry *iotlb);
121     int (*attach_device)(const char *name, VFIODevice *vbasedev,
122                          AddressSpace *as, Error **errp);
123     void (*detach_device)(VFIODevice *vbasedev);
124     /* migration feature */
125     int (*set_dirty_page_tracking)(const VFIOContainerBase *bcontainer,
126                                    bool start);
127     int (*query_dirty_bitmap)(const VFIOContainerBase *bcontainer,
128                               VFIOBitmap *vbmap,
129                               hwaddr iova, hwaddr size);
130     /* PCI specific */
131     int (*pci_hot_reset)(VFIODevice *vbasedev, bool single);
132 
133     /* SPAPR specific */
134     int (*add_window)(VFIOContainerBase *bcontainer,
135                       MemoryRegionSection *section,
136                       Error **errp);
137     void (*del_window)(VFIOContainerBase *bcontainer,
138                        MemoryRegionSection *section);
139     void (*release)(VFIOContainerBase *bcontainer);
140 };
141 #endif /* HW_VFIO_VFIO_CONTAINER_BASE_H */
142