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 VFIOIOMMUOps VFIOIOMMUOps;
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 VFIOIOMMUOps *ops;
38     VFIOAddressSpace *space;
39     unsigned long pgsizes;
40     unsigned int dma_max_mappings;
41     bool dirty_pages_supported;
42     QLIST_HEAD(, VFIOGuestIOMMU) giommu_list;
43     QLIST_HEAD(, VFIORamDiscardListener) vrdl_list;
44     QLIST_ENTRY(VFIOContainerBase) next;
45     QLIST_HEAD(, VFIODevice) device_list;
46 } VFIOContainerBase;
47 
48 typedef struct VFIOGuestIOMMU {
49     VFIOContainerBase *bcontainer;
50     IOMMUMemoryRegion *iommu_mr;
51     hwaddr iommu_offset;
52     IOMMUNotifier n;
53     QLIST_ENTRY(VFIOGuestIOMMU) giommu_next;
54 } VFIOGuestIOMMU;
55 
56 typedef struct VFIORamDiscardListener {
57     VFIOContainerBase *bcontainer;
58     MemoryRegion *mr;
59     hwaddr offset_within_address_space;
60     hwaddr size;
61     uint64_t granularity;
62     RamDiscardListener listener;
63     QLIST_ENTRY(VFIORamDiscardListener) next;
64 } VFIORamDiscardListener;
65 
66 int vfio_container_dma_map(VFIOContainerBase *bcontainer,
67                            hwaddr iova, ram_addr_t size,
68                            void *vaddr, bool readonly);
69 int vfio_container_dma_unmap(VFIOContainerBase *bcontainer,
70                              hwaddr iova, ram_addr_t size,
71                              IOMMUTLBEntry *iotlb);
72 int vfio_container_set_dirty_page_tracking(VFIOContainerBase *bcontainer,
73                                            bool start);
74 int vfio_container_query_dirty_bitmap(VFIOContainerBase *bcontainer,
75                                       VFIOBitmap *vbmap,
76                                       hwaddr iova, hwaddr size);
77 
78 void vfio_container_init(VFIOContainerBase *bcontainer,
79                          VFIOAddressSpace *space,
80                          const VFIOIOMMUOps *ops);
81 void vfio_container_destroy(VFIOContainerBase *bcontainer);
82 
83 struct VFIOIOMMUOps {
84     /* basic feature */
85     int (*dma_map)(VFIOContainerBase *bcontainer,
86                    hwaddr iova, ram_addr_t size,
87                    void *vaddr, bool readonly);
88     int (*dma_unmap)(VFIOContainerBase *bcontainer,
89                      hwaddr iova, ram_addr_t size,
90                      IOMMUTLBEntry *iotlb);
91     int (*attach_device)(const char *name, VFIODevice *vbasedev,
92                          AddressSpace *as, Error **errp);
93     void (*detach_device)(VFIODevice *vbasedev);
94     /* migration feature */
95     int (*set_dirty_page_tracking)(VFIOContainerBase *bcontainer, bool start);
96     int (*query_dirty_bitmap)(VFIOContainerBase *bcontainer, VFIOBitmap *vbmap,
97                               hwaddr iova, hwaddr size);
98 };
99 #endif /* HW_VFIO_VFIO_CONTAINER_BASE_H */
100