Go to the documentation of this file.
14 #include <sys/eventfd.h>
24 #include <linux/vhost.h>
25 #include <linux/virtio_ring.h>
26 #include <linux/virtio_net.h>
28 #define RTE_VHOST_USER_CLIENT (1ULL << 0)
29 #define RTE_VHOST_USER_NO_RECONNECT (1ULL << 1)
30 #define RTE_VHOST_USER_DEQUEUE_ZERO_COPY (1ULL << 2)
31 #define RTE_VHOST_USER_IOMMU_SUPPORT (1ULL << 3)
32 #define RTE_VHOST_USER_POSTCOPY_SUPPORT (1ULL << 4)
34 #define RTE_VHOST_USER_EXTBUF_SUPPORT (1ULL << 5)
36 #define RTE_VHOST_USER_LINEARBUF_SUPPORT (1ULL << 6)
39 #ifndef VHOST_USER_PROTOCOL_F_MQ
40 #define VHOST_USER_PROTOCOL_F_MQ 0
43 #ifndef VHOST_USER_PROTOCOL_F_LOG_SHMFD
44 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
47 #ifndef VHOST_USER_PROTOCOL_F_RARP
48 #define VHOST_USER_PROTOCOL_F_RARP 2
51 #ifndef VHOST_USER_PROTOCOL_F_REPLY_ACK
52 #define VHOST_USER_PROTOCOL_F_REPLY_ACK 3
55 #ifndef VHOST_USER_PROTOCOL_F_NET_MTU
56 #define VHOST_USER_PROTOCOL_F_NET_MTU 4
59 #ifndef VHOST_USER_PROTOCOL_F_SLAVE_REQ
60 #define VHOST_USER_PROTOCOL_F_SLAVE_REQ 5
63 #ifndef VHOST_USER_PROTOCOL_F_CRYPTO_SESSION
64 #define VHOST_USER_PROTOCOL_F_CRYPTO_SESSION 7
67 #ifndef VHOST_USER_PROTOCOL_F_PAGEFAULT
68 #define VHOST_USER_PROTOCOL_F_PAGEFAULT 8
71 #ifndef VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD
72 #define VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD 10
75 #ifndef VHOST_USER_PROTOCOL_F_HOST_NOTIFIER
76 #define VHOST_USER_PROTOCOL_F_HOST_NOTIFIER 11
79 #ifndef VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD
80 #define VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD 12
84 #ifndef VHOST_USER_F_PROTOCOL_FEATURES
85 #define VHOST_USER_F_PROTOCOL_FEATURES 30
93 uint64_t guest_phys_addr;
94 uint64_t guest_user_addr;
95 uint64_t host_user_addr;
110 struct rte_vhost_inflight_desc_split {
117 struct rte_vhost_inflight_info_split {
121 uint16_t last_inflight_io;
123 struct rte_vhost_inflight_desc_split desc[0];
126 struct rte_vhost_inflight_desc_packed {
139 struct rte_vhost_inflight_info_packed {
144 uint16_t old_free_head;
146 uint16_t old_used_idx;
147 uint8_t used_wrap_counter;
148 uint8_t old_used_wrap_counter;
150 struct rte_vhost_inflight_desc_packed desc[0];
153 struct rte_vhost_resubmit_desc {
158 struct rte_vhost_resubmit_info {
159 struct rte_vhost_resubmit_desc *resubmit_list;
160 uint16_t resubmit_num;
163 struct rte_vhost_ring_inflight {
165 struct rte_vhost_inflight_info_split *inflight_split;
166 struct rte_vhost_inflight_info_packed *inflight_packed;
169 struct rte_vhost_resubmit_info *resubmit_inflight;
172 struct rte_vhost_vring {
174 struct vring_desc *desc;
175 struct vring_packed_desc *desc_packed;
178 struct vring_avail *avail;
179 struct vring_packed_desc_event *driver_event;
182 struct vring_used *used;
183 struct vring_packed_desc_event *device_event;
185 uint64_t log_guest_addr;
199 RTE_VHOST_MSG_RESULT_ERR = -1,
201 RTE_VHOST_MSG_RESULT_OK = 0,
203 RTE_VHOST_MSG_RESULT_REPLY = 1,
205 RTE_VHOST_MSG_RESULT_NOT_HANDLED,
251 int (*new_connection)(
int vid);
252 void (*destroy_connection)(
int vid);
287 for (i = 0; i < mem->nregions; i++) {
288 reg = &mem->regions[i];
289 if (gpa >= reg->guest_phys_addr &&
290 gpa < reg->guest_phys_addr + reg->size) {
291 return gpa - reg->guest_phys_addr +
318 uint64_t gpa, uint64_t *len)
323 for (i = 0; i < mem->nregions; i++) {
324 r = &mem->regions[i];
325 if (gpa >= r->guest_phys_addr &&
326 gpa < r->guest_phys_addr + r->size) {
328 if (
unlikely(*len > r->guest_phys_addr + r->size - gpa))
329 *len = r->guest_phys_addr + r->size - gpa;
331 return gpa - r->guest_phys_addr +
340 #define RTE_VHOST_NEED_LOG(features) ((features) & (1ULL << VHOST_F_LOG_ALL))
381 uint64_t offset, uint64_t len);
383 int rte_vhost_enable_guest_notification(
int vid, uint16_t queue_id,
int enable);
392 int rte_vhost_driver_unregister(
const char *path);
500 uint64_t protocol_features);
515 uint64_t *protocol_features);
544 int rte_vhost_driver_callback_register(
const char *path,
663 struct rte_mbuf **pkts, uint16_t count);
714 struct rte_vhost_vring *vring);
731 struct rte_vhost_ring_inflight *vring);
774 uint16_t head, uint16_t last, uint16_t *inflight_entry);
791 uint16_t vring_idx, uint16_t idx);
811 uint16_t vring_idx, uint16_t head);
830 uint16_t last_used_idx, uint16_t idx);
907 uint16_t *last_avail_idx, uint16_t *last_used_idx);
930 uint16_t queue_id, uint16_t *last_avail_idx, uint16_t *last_used_idx);
949 uint16_t last_avail_idx, uint16_t last_used_idx);
int rte_vhost_driver_start(const char *path)
int rte_vhost_driver_register(const char *path, uint64_t flags)
int(* vring_state_changed)(int vid, uint16_t queue_id, int enable)
__rte_experimental int rte_vhost_clr_inflight_desc_split(int vid, uint16_t vring_idx, uint16_t last_used_idx, uint16_t idx)
int rte_vhost_get_mtu(int vid, uint16_t *mtu)
enum rte_vhost_msg_result(* rte_vhost_msg_handle)(int vid, void *msg)
int rte_vhost_driver_get_features(const char *path, uint64_t *features)
#define __rte_always_inline
__rte_experimental int rte_vhost_get_vring_base_from_inflight(int vid, uint16_t queue_id, uint16_t *last_avail_idx, uint16_t *last_used_idx)
__rte_experimental int rte_vhost_set_last_inflight_io_packed(int vid, uint16_t vring_idx, uint16_t head)
uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id, struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count)
__rte_experimental int rte_vhost_get_vring_base(int vid, uint16_t queue_id, uint16_t *last_avail_idx, uint16_t *last_used_idx)
int(* new_device)(int vid)
int rte_vhost_driver_set_features(const char *path, uint64_t features)
int rte_vhost_driver_enable_features(const char *path, uint64_t features)
__rte_deprecated uint32_t rte_vhost_get_queue_num(int vid)
__rte_experimental int rte_vhost_set_last_inflight_io_split(int vid, uint16_t vring_idx, uint16_t idx)
__rte_experimental int rte_vhost_driver_detach_vdpa_device(const char *path)
uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id, struct rte_mbuf **pkts, uint16_t count)
int rte_vhost_get_ifname(int vid, char *buf, size_t len)
__rte_experimental int rte_vhost_driver_attach_vdpa_device(const char *path, int did)
__rte_experimental int rte_vhost_driver_get_protocol_features(const char *path, uint64_t *protocol_features)
__rte_experimental int rte_vhost_get_vhost_ring_inflight(int vid, uint16_t vring_idx, struct rte_vhost_ring_inflight *vring)
uint16_t rte_vhost_get_vring_num(int vid)
void(* destroy_device)(int vid)
int rte_vhost_get_numa_node(int vid)
void rte_vhost_log_used_vring(int vid, uint16_t vring_idx, uint64_t offset, uint64_t len)
int rte_vhost_vring_call(int vid, uint16_t vring_idx)
__rte_experimental int rte_vhost_set_vring_base(int vid, uint16_t queue_id, uint16_t last_avail_idx, uint16_t last_used_idx)
__rte_experimental int rte_vhost_set_inflight_desc_packed(int vid, uint16_t vring_idx, uint16_t head, uint16_t last, uint16_t *inflight_entry)
int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem)
__rte_experimental int rte_vhost_get_vdpa_device_id(int vid)
static __rte_deprecated __rte_always_inline uint64_t rte_vhost_gpa_to_vva(struct rte_vhost_memory *mem, uint64_t gpa)
__rte_experimental int rte_vhost_driver_get_vdpa_device_id(const char *path)
void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len)
uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid)
static __rte_experimental __rte_always_inline uint64_t rte_vhost_va_from_guest_pa(struct rte_vhost_memory *mem, uint64_t gpa, uint64_t *len)
int(* features_changed)(int vid, uint64_t features)
__rte_experimental int rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num)
__rte_experimental int rte_vhost_clr_inflight_desc_packed(int vid, uint16_t vring_idx, uint16_t head)
__rte_experimental int rte_vhost_get_log_base(int vid, uint64_t *log_base, uint64_t *log_size)
uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id)
int rte_vhost_driver_disable_features(const char *path, uint64_t features)
__rte_experimental int rte_vhost_extern_callback_register(int vid, struct rte_vhost_user_extern_ops const *const ops, void *ctx)
__rte_experimental int rte_vhost_set_inflight_desc_split(int vid, uint16_t vring_idx, uint16_t idx)
int rte_vhost_get_negotiated_features(int vid, uint64_t *features)
void(* guest_notified)(int vid)
int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx, struct rte_vhost_vring *vring)
__rte_experimental int rte_vhost_driver_set_protocol_features(const char *path, uint64_t protocol_features)