xref: /qemu/include/hw/virtio/vhost-backend.h (revision 41a0e54756a9ae6b60be34bb33302a7e085fdb07)
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 typedef enum VhostBackendType {
15     VHOST_BACKEND_TYPE_NONE = 0,
16     VHOST_BACKEND_TYPE_KERNEL = 1,
17     VHOST_BACKEND_TYPE_USER = 2,
18     VHOST_BACKEND_TYPE_MAX = 3,
19 } VhostBackendType;
20 
21 struct vhost_dev;
22 struct vhost_log;
23 struct vhost_memory;
24 struct vhost_vring_file;
25 struct vhost_vring_state;
26 struct vhost_vring_addr;
27 struct vhost_scsi_target;
28 
29 typedef int (*vhost_backend_init)(struct vhost_dev *dev, void *opaque);
30 typedef int (*vhost_backend_cleanup)(struct vhost_dev *dev);
31 typedef int (*vhost_backend_memslots_limit)(struct vhost_dev *dev);
32 
33 typedef int (*vhost_net_set_backend_op)(struct vhost_dev *dev,
34                                 struct vhost_vring_file *file);
35 typedef int (*vhost_net_set_mtu_op)(struct vhost_dev *dev, uint16_t mtu);
36 typedef int (*vhost_scsi_set_endpoint_op)(struct vhost_dev *dev,
37                                   struct vhost_scsi_target *target);
38 typedef int (*vhost_scsi_clear_endpoint_op)(struct vhost_dev *dev,
39                                     struct vhost_scsi_target *target);
40 typedef int (*vhost_scsi_get_abi_version_op)(struct vhost_dev *dev,
41                                              int *version);
42 typedef int (*vhost_set_log_base_op)(struct vhost_dev *dev, uint64_t base,
43                                      struct vhost_log *log);
44 typedef int (*vhost_set_mem_table_op)(struct vhost_dev *dev,
45                                       struct vhost_memory *mem);
46 typedef int (*vhost_set_vring_addr_op)(struct vhost_dev *dev,
47                                        struct vhost_vring_addr *addr);
48 typedef int (*vhost_set_vring_endian_op)(struct vhost_dev *dev,
49                                          struct vhost_vring_state *ring);
50 typedef int (*vhost_set_vring_num_op)(struct vhost_dev *dev,
51                                       struct vhost_vring_state *ring);
52 typedef int (*vhost_set_vring_base_op)(struct vhost_dev *dev,
53                                        struct vhost_vring_state *ring);
54 typedef int (*vhost_get_vring_base_op)(struct vhost_dev *dev,
55                                        struct vhost_vring_state *ring);
56 typedef int (*vhost_set_vring_kick_op)(struct vhost_dev *dev,
57                                        struct vhost_vring_file *file);
58 typedef int (*vhost_set_vring_call_op)(struct vhost_dev *dev,
59                                        struct vhost_vring_file *file);
60 typedef int (*vhost_set_vring_busyloop_timeout_op)(struct vhost_dev *dev,
61                                                    struct vhost_vring_state *r);
62 typedef int (*vhost_set_features_op)(struct vhost_dev *dev,
63                                      uint64_t features);
64 typedef int (*vhost_get_features_op)(struct vhost_dev *dev,
65                                      uint64_t *features);
66 typedef int (*vhost_set_owner_op)(struct vhost_dev *dev);
67 typedef int (*vhost_reset_device_op)(struct vhost_dev *dev);
68 typedef int (*vhost_get_vq_index_op)(struct vhost_dev *dev, int idx);
69 typedef int (*vhost_set_vring_enable_op)(struct vhost_dev *dev,
70                                          int enable);
71 typedef bool (*vhost_requires_shm_log_op)(struct vhost_dev *dev);
72 typedef int (*vhost_migration_done_op)(struct vhost_dev *dev,
73                                        char *mac_addr);
74 typedef bool (*vhost_backend_can_merge_op)(struct vhost_dev *dev,
75                                            uint64_t start1, uint64_t size1,
76                                            uint64_t start2, uint64_t size2);
77 typedef int (*vhost_vsock_set_guest_cid_op)(struct vhost_dev *dev,
78                                             uint64_t guest_cid);
79 typedef int (*vhost_vsock_set_running_op)(struct vhost_dev *dev, int start);
80 
81 typedef struct VhostOps {
82     VhostBackendType backend_type;
83     vhost_backend_init vhost_backend_init;
84     vhost_backend_cleanup vhost_backend_cleanup;
85     vhost_backend_memslots_limit vhost_backend_memslots_limit;
86     vhost_net_set_backend_op vhost_net_set_backend;
87     vhost_net_set_mtu_op vhost_net_set_mtu;
88     vhost_scsi_set_endpoint_op vhost_scsi_set_endpoint;
89     vhost_scsi_clear_endpoint_op vhost_scsi_clear_endpoint;
90     vhost_scsi_get_abi_version_op vhost_scsi_get_abi_version;
91     vhost_set_log_base_op vhost_set_log_base;
92     vhost_set_mem_table_op vhost_set_mem_table;
93     vhost_set_vring_addr_op vhost_set_vring_addr;
94     vhost_set_vring_endian_op vhost_set_vring_endian;
95     vhost_set_vring_num_op vhost_set_vring_num;
96     vhost_set_vring_base_op vhost_set_vring_base;
97     vhost_get_vring_base_op vhost_get_vring_base;
98     vhost_set_vring_kick_op vhost_set_vring_kick;
99     vhost_set_vring_call_op vhost_set_vring_call;
100     vhost_set_vring_busyloop_timeout_op vhost_set_vring_busyloop_timeout;
101     vhost_set_features_op vhost_set_features;
102     vhost_get_features_op vhost_get_features;
103     vhost_set_owner_op vhost_set_owner;
104     vhost_reset_device_op vhost_reset_device;
105     vhost_get_vq_index_op vhost_get_vq_index;
106     vhost_set_vring_enable_op vhost_set_vring_enable;
107     vhost_requires_shm_log_op vhost_requires_shm_log;
108     vhost_migration_done_op vhost_migration_done;
109     vhost_backend_can_merge_op vhost_backend_can_merge;
110     vhost_vsock_set_guest_cid_op vhost_vsock_set_guest_cid;
111     vhost_vsock_set_running_op vhost_vsock_set_running;
112 } VhostOps;
113 
114 extern const VhostOps user_ops;
115 
116 int vhost_set_backend_type(struct vhost_dev *dev,
117                            VhostBackendType backend_type);
118 
119 #endif /* VHOST_BACKEND_H */
120