xref: /openbmc/qemu/include/hw/virtio/vhost-backend.h (revision d43e967f)
1 /*
2  * vhost-backend
3  *
4  * Copyright (c) 2013 Virtual Open Systems Sarl.
5  *
6  * This work is licensed under the terms of the GNU GPL, version 2 or later.
7  * See the COPYING file in the top-level directory.
8  *
9  */
10 
11 #ifndef VHOST_BACKEND_H
12 #define VHOST_BACKEND_H
13 
14 #include "exec/memory.h"
15 
16 typedef enum VhostBackendType {
17     VHOST_BACKEND_TYPE_NONE = 0,
18     VHOST_BACKEND_TYPE_KERNEL = 1,
19     VHOST_BACKEND_TYPE_USER = 2,
20     VHOST_BACKEND_TYPE_VDPA = 3,
21     VHOST_BACKEND_TYPE_MAX = 4,
22 } VhostBackendType;
23 
24 typedef enum VhostSetConfigType {
25     VHOST_SET_CONFIG_TYPE_FRONTEND = 0,
26     VHOST_SET_CONFIG_TYPE_MIGRATION = 1,
27 } VhostSetConfigType;
28 
29 struct vhost_inflight;
30 struct vhost_dev;
31 struct vhost_log;
32 struct vhost_memory;
33 struct vhost_vring_file;
34 struct vhost_vring_state;
35 struct vhost_vring_addr;
36 struct vhost_scsi_target;
37 struct vhost_iotlb_msg;
38 struct vhost_virtqueue;
39 
40 typedef int (*vhost_backend_init)(struct vhost_dev *dev, void *opaque,
41                                   Error **errp);
42 typedef int (*vhost_backend_cleanup)(struct vhost_dev *dev);
43 typedef int (*vhost_backend_memslots_limit)(struct vhost_dev *dev);
44 
45 typedef int (*vhost_net_set_backend_op)(struct vhost_dev *dev,
46                                 struct vhost_vring_file *file);
47 typedef int (*vhost_net_set_mtu_op)(struct vhost_dev *dev, uint16_t mtu);
48 typedef int (*vhost_scsi_set_endpoint_op)(struct vhost_dev *dev,
49                                   struct vhost_scsi_target *target);
50 typedef int (*vhost_scsi_clear_endpoint_op)(struct vhost_dev *dev,
51                                     struct vhost_scsi_target *target);
52 typedef int (*vhost_scsi_get_abi_version_op)(struct vhost_dev *dev,
53                                              int *version);
54 typedef int (*vhost_set_log_base_op)(struct vhost_dev *dev, uint64_t base,
55                                      struct vhost_log *log);
56 typedef int (*vhost_set_mem_table_op)(struct vhost_dev *dev,
57                                       struct vhost_memory *mem);
58 typedef int (*vhost_set_vring_addr_op)(struct vhost_dev *dev,
59                                        struct vhost_vring_addr *addr);
60 typedef int (*vhost_set_vring_endian_op)(struct vhost_dev *dev,
61                                          struct vhost_vring_state *ring);
62 typedef int (*vhost_set_vring_num_op)(struct vhost_dev *dev,
63                                       struct vhost_vring_state *ring);
64 typedef int (*vhost_set_vring_base_op)(struct vhost_dev *dev,
65                                        struct vhost_vring_state *ring);
66 typedef int (*vhost_get_vring_base_op)(struct vhost_dev *dev,
67                                        struct vhost_vring_state *ring);
68 typedef int (*vhost_set_vring_kick_op)(struct vhost_dev *dev,
69                                        struct vhost_vring_file *file);
70 typedef int (*vhost_set_vring_call_op)(struct vhost_dev *dev,
71                                        struct vhost_vring_file *file);
72 typedef int (*vhost_set_vring_err_op)(struct vhost_dev *dev,
73                                       struct vhost_vring_file *file);
74 typedef int (*vhost_set_vring_busyloop_timeout_op)(struct vhost_dev *dev,
75                                                    struct vhost_vring_state *r);
76 typedef int (*vhost_set_features_op)(struct vhost_dev *dev,
77                                      uint64_t features);
78 typedef int (*vhost_get_features_op)(struct vhost_dev *dev,
79                                      uint64_t *features);
80 typedef int (*vhost_set_backend_cap_op)(struct vhost_dev *dev);
81 typedef int (*vhost_set_owner_op)(struct vhost_dev *dev);
82 typedef int (*vhost_reset_device_op)(struct vhost_dev *dev);
83 typedef int (*vhost_get_vq_index_op)(struct vhost_dev *dev, int idx);
84 typedef int (*vhost_set_vring_enable_op)(struct vhost_dev *dev,
85                                          int enable);
86 typedef bool (*vhost_requires_shm_log_op)(struct vhost_dev *dev);
87 typedef int (*vhost_migration_done_op)(struct vhost_dev *dev,
88                                        char *mac_addr);
89 typedef bool (*vhost_backend_can_merge_op)(struct vhost_dev *dev,
90                                            uint64_t start1, uint64_t size1,
91                                            uint64_t start2, uint64_t size2);
92 typedef int (*vhost_vsock_set_guest_cid_op)(struct vhost_dev *dev,
93                                             uint64_t guest_cid);
94 typedef int (*vhost_vsock_set_running_op)(struct vhost_dev *dev, int start);
95 typedef void (*vhost_set_iotlb_callback_op)(struct vhost_dev *dev,
96                                            int enabled);
97 typedef int (*vhost_send_device_iotlb_msg_op)(struct vhost_dev *dev,
98                                               struct vhost_iotlb_msg *imsg);
99 typedef int (*vhost_set_config_op)(struct vhost_dev *dev, const uint8_t *data,
100                                    uint32_t offset, uint32_t size,
101                                    uint32_t flags);
102 typedef int (*vhost_get_config_op)(struct vhost_dev *dev, uint8_t *config,
103                                    uint32_t config_len, Error **errp);
104 
105 typedef int (*vhost_crypto_create_session_op)(struct vhost_dev *dev,
106                                               void *session_info,
107                                               uint64_t *session_id);
108 typedef int (*vhost_crypto_close_session_op)(struct vhost_dev *dev,
109                                              uint64_t session_id);
110 
111 typedef bool (*vhost_backend_mem_section_filter_op)(struct vhost_dev *dev,
112                                                 MemoryRegionSection *section);
113 
114 typedef int (*vhost_get_inflight_fd_op)(struct vhost_dev *dev,
115                                         uint16_t queue_size,
116                                         struct vhost_inflight *inflight);
117 
118 typedef int (*vhost_set_inflight_fd_op)(struct vhost_dev *dev,
119                                         struct vhost_inflight *inflight);
120 
121 typedef int (*vhost_dev_start_op)(struct vhost_dev *dev, bool started);
122 
123 typedef int (*vhost_vq_get_addr_op)(struct vhost_dev *dev,
124                     struct vhost_vring_addr *addr,
125                     struct vhost_virtqueue *vq);
126 
127 typedef int (*vhost_get_device_id_op)(struct vhost_dev *dev, uint32_t *dev_id);
128 
129 typedef bool (*vhost_force_iommu_op)(struct vhost_dev *dev);
130 
131 typedef int (*vhost_set_config_call_op)(struct vhost_dev *dev,
132                                        int fd);
133 
134 typedef void (*vhost_reset_status_op)(struct vhost_dev *dev);
135 
136 typedef struct VhostOps {
137     VhostBackendType backend_type;
138     vhost_backend_init vhost_backend_init;
139     vhost_backend_cleanup vhost_backend_cleanup;
140     vhost_backend_memslots_limit vhost_backend_memslots_limit;
141     vhost_net_set_backend_op vhost_net_set_backend;
142     vhost_net_set_mtu_op vhost_net_set_mtu;
143     vhost_scsi_set_endpoint_op vhost_scsi_set_endpoint;
144     vhost_scsi_clear_endpoint_op vhost_scsi_clear_endpoint;
145     vhost_scsi_get_abi_version_op vhost_scsi_get_abi_version;
146     vhost_set_log_base_op vhost_set_log_base;
147     vhost_set_mem_table_op vhost_set_mem_table;
148     vhost_set_vring_addr_op vhost_set_vring_addr;
149     vhost_set_vring_endian_op vhost_set_vring_endian;
150     vhost_set_vring_num_op vhost_set_vring_num;
151     vhost_set_vring_base_op vhost_set_vring_base;
152     vhost_get_vring_base_op vhost_get_vring_base;
153     vhost_set_vring_kick_op vhost_set_vring_kick;
154     vhost_set_vring_call_op vhost_set_vring_call;
155     vhost_set_vring_err_op vhost_set_vring_err;
156     vhost_set_vring_busyloop_timeout_op vhost_set_vring_busyloop_timeout;
157     vhost_set_features_op vhost_set_features;
158     vhost_get_features_op vhost_get_features;
159     vhost_set_backend_cap_op vhost_set_backend_cap;
160     vhost_set_owner_op vhost_set_owner;
161     vhost_reset_device_op vhost_reset_device;
162     vhost_get_vq_index_op vhost_get_vq_index;
163     vhost_set_vring_enable_op vhost_set_vring_enable;
164     vhost_requires_shm_log_op vhost_requires_shm_log;
165     vhost_migration_done_op vhost_migration_done;
166     vhost_backend_can_merge_op vhost_backend_can_merge;
167     vhost_vsock_set_guest_cid_op vhost_vsock_set_guest_cid;
168     vhost_vsock_set_running_op vhost_vsock_set_running;
169     vhost_set_iotlb_callback_op vhost_set_iotlb_callback;
170     vhost_send_device_iotlb_msg_op vhost_send_device_iotlb_msg;
171     vhost_get_config_op vhost_get_config;
172     vhost_set_config_op vhost_set_config;
173     vhost_crypto_create_session_op vhost_crypto_create_session;
174     vhost_crypto_close_session_op vhost_crypto_close_session;
175     vhost_backend_mem_section_filter_op vhost_backend_mem_section_filter;
176     vhost_get_inflight_fd_op vhost_get_inflight_fd;
177     vhost_set_inflight_fd_op vhost_set_inflight_fd;
178     vhost_dev_start_op vhost_dev_start;
179     vhost_vq_get_addr_op  vhost_vq_get_addr;
180     vhost_get_device_id_op vhost_get_device_id;
181     vhost_force_iommu_op vhost_force_iommu;
182     vhost_set_config_call_op vhost_set_config_call;
183     vhost_reset_status_op vhost_reset_status;
184 } VhostOps;
185 
186 int vhost_backend_update_device_iotlb(struct vhost_dev *dev,
187                                              uint64_t iova, uint64_t uaddr,
188                                              uint64_t len,
189                                              IOMMUAccessFlags perm);
190 
191 int vhost_backend_invalidate_device_iotlb(struct vhost_dev *dev,
192                                                  uint64_t iova, uint64_t len);
193 
194 int vhost_backend_handle_iotlb_msg(struct vhost_dev *dev,
195                                           struct vhost_iotlb_msg *imsg);
196 
197 int vhost_user_gpu_set_socket(struct vhost_dev *dev, int fd);
198 
199 int vhost_user_get_shared_object(struct vhost_dev *dev, unsigned char *uuid,
200                                         int *dmabuf_fd);
201 
202 #endif /* VHOST_BACKEND_H */
203