DPDK  19.11.1
rte_vhost.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2017 Intel Corporation
3  */
4 
5 #ifndef _RTE_VHOST_H_
6 #define _RTE_VHOST_H_
7 
13 #include <stdint.h>
14 #include <sys/eventfd.h>
15 
16 #include <rte_memory.h>
17 #include <rte_mempool.h>
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
23 /* These are not C++-aware. */
24 #include <linux/vhost.h>
25 #include <linux/virtio_ring.h>
26 #include <linux/virtio_net.h>
27 
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)
33 /* support mbuf with external buffer attached */
34 #define RTE_VHOST_USER_EXTBUF_SUPPORT (1ULL << 5)
35 /* support only linear buffers (no chained mbufs) */
36 #define RTE_VHOST_USER_LINEARBUF_SUPPORT (1ULL << 6)
37 
39 #ifndef VHOST_USER_PROTOCOL_F_MQ
40 #define VHOST_USER_PROTOCOL_F_MQ 0
41 #endif
42 
43 #ifndef VHOST_USER_PROTOCOL_F_LOG_SHMFD
44 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
45 #endif
46 
47 #ifndef VHOST_USER_PROTOCOL_F_RARP
48 #define VHOST_USER_PROTOCOL_F_RARP 2
49 #endif
50 
51 #ifndef VHOST_USER_PROTOCOL_F_REPLY_ACK
52 #define VHOST_USER_PROTOCOL_F_REPLY_ACK 3
53 #endif
54 
55 #ifndef VHOST_USER_PROTOCOL_F_NET_MTU
56 #define VHOST_USER_PROTOCOL_F_NET_MTU 4
57 #endif
58 
59 #ifndef VHOST_USER_PROTOCOL_F_SLAVE_REQ
60 #define VHOST_USER_PROTOCOL_F_SLAVE_REQ 5
61 #endif
62 
63 #ifndef VHOST_USER_PROTOCOL_F_CRYPTO_SESSION
64 #define VHOST_USER_PROTOCOL_F_CRYPTO_SESSION 7
65 #endif
66 
67 #ifndef VHOST_USER_PROTOCOL_F_PAGEFAULT
68 #define VHOST_USER_PROTOCOL_F_PAGEFAULT 8
69 #endif
70 
71 #ifndef VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD
72 #define VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD 10
73 #endif
74 
75 #ifndef VHOST_USER_PROTOCOL_F_HOST_NOTIFIER
76 #define VHOST_USER_PROTOCOL_F_HOST_NOTIFIER 11
77 #endif
78 
79 #ifndef VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD
80 #define VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD 12
81 #endif
82 
84 #ifndef VHOST_USER_F_PROTOCOL_FEATURES
85 #define VHOST_USER_F_PROTOCOL_FEATURES 30
86 #endif
87 
93  uint64_t guest_phys_addr;
94  uint64_t guest_user_addr;
95  uint64_t host_user_addr;
96  uint64_t size;
97  void *mmap_addr;
98  uint64_t mmap_size;
99  int fd;
100 };
101 
106  uint32_t nregions;
107  struct rte_vhost_mem_region regions[];
108 };
109 
110 struct rte_vhost_inflight_desc_split {
111  uint8_t inflight;
112  uint8_t padding[5];
113  uint16_t next;
114  uint64_t counter;
115 };
116 
117 struct rte_vhost_inflight_info_split {
118  uint64_t features;
119  uint16_t version;
120  uint16_t desc_num;
121  uint16_t last_inflight_io;
122  uint16_t used_idx;
123  struct rte_vhost_inflight_desc_split desc[0];
124 };
125 
126 struct rte_vhost_inflight_desc_packed {
127  uint8_t inflight;
128  uint8_t padding;
129  uint16_t next;
130  uint16_t last;
131  uint16_t num;
132  uint64_t counter;
133  uint16_t id;
134  uint16_t flags;
135  uint32_t len;
136  uint64_t addr;
137 };
138 
139 struct rte_vhost_inflight_info_packed {
140  uint64_t features;
141  uint16_t version;
142  uint16_t desc_num;
143  uint16_t free_head;
144  uint16_t old_free_head;
145  uint16_t used_idx;
146  uint16_t old_used_idx;
147  uint8_t used_wrap_counter;
148  uint8_t old_used_wrap_counter;
149  uint8_t padding[7];
150  struct rte_vhost_inflight_desc_packed desc[0];
151 };
152 
153 struct rte_vhost_resubmit_desc {
154  uint16_t index;
155  uint64_t counter;
156 };
157 
158 struct rte_vhost_resubmit_info {
159  struct rte_vhost_resubmit_desc *resubmit_list;
160  uint16_t resubmit_num;
161 };
162 
163 struct rte_vhost_ring_inflight {
164  union {
165  struct rte_vhost_inflight_info_split *inflight_split;
166  struct rte_vhost_inflight_info_packed *inflight_packed;
167  };
168 
169  struct rte_vhost_resubmit_info *resubmit_inflight;
170 };
171 
172 struct rte_vhost_vring {
173  union {
174  struct vring_desc *desc;
175  struct vring_packed_desc *desc_packed;
176  };
177  union {
178  struct vring_avail *avail;
179  struct vring_packed_desc_event *driver_event;
180  };
181  union {
182  struct vring_used *used;
183  struct vring_packed_desc_event *device_event;
184  };
185  uint64_t log_guest_addr;
186 
188  int callfd;
189 
190  int kickfd;
191  uint16_t size;
192 };
193 
198  /* Message handling failed */
199  RTE_VHOST_MSG_RESULT_ERR = -1,
200  /* Message handling successful */
201  RTE_VHOST_MSG_RESULT_OK = 0,
202  /* Message handling successful and reply prepared */
203  RTE_VHOST_MSG_RESULT_REPLY = 1,
204  /* Message not handled */
205  RTE_VHOST_MSG_RESULT_NOT_HANDLED,
206 };
207 
222 typedef enum rte_vhost_msg_result (*rte_vhost_msg_handle)(int vid, void *msg);
223 
228  /* Called prior to the master message handling. */
229  rte_vhost_msg_handle pre_msg_handle;
230  /* Called after the master message handling. */
231  rte_vhost_msg_handle post_msg_handle;
232 };
233 
238  int (*new_device)(int vid);
239  void (*destroy_device)(int vid);
241  int (*vring_state_changed)(int vid, uint16_t queue_id, int enable);
249  int (*features_changed)(int vid, uint64_t features);
250 
251  int (*new_connection)(int vid);
252  void (*destroy_connection)(int vid);
253 
260  void (*guest_notified)(int vid);
261 
262  void *reserved[1];
263 };
264 
280 __rte_deprecated
281 static __rte_always_inline uint64_t
282 rte_vhost_gpa_to_vva(struct rte_vhost_memory *mem, uint64_t gpa)
283 {
284  struct rte_vhost_mem_region *reg;
285  uint32_t i;
286 
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 +
292  reg->host_user_addr;
293  }
294  }
295 
296  return 0;
297 }
298 
315 __rte_experimental
316 static __rte_always_inline uint64_t
318  uint64_t gpa, uint64_t *len)
319 {
320  struct rte_vhost_mem_region *r;
321  uint32_t i;
322 
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) {
327 
328  if (unlikely(*len > r->guest_phys_addr + r->size - gpa))
329  *len = r->guest_phys_addr + r->size - gpa;
330 
331  return gpa - r->guest_phys_addr +
332  r->host_user_addr;
333  }
334  }
335  *len = 0;
336 
337  return 0;
338 }
339 
340 #define RTE_VHOST_NEED_LOG(features) ((features) & (1ULL << VHOST_F_LOG_ALL))
341 
360 void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len);
361 
380 void rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
381  uint64_t offset, uint64_t len);
382 
383 int rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable);
384 
389 int rte_vhost_driver_register(const char *path, uint64_t flags);
390 
391 /* Unregister vhost driver. This is only meaningful to vhost user. */
392 int rte_vhost_driver_unregister(const char *path);
393 
404 __rte_experimental
405 int
406 rte_vhost_driver_attach_vdpa_device(const char *path, int did);
407 
416 __rte_experimental
417 int
418 rte_vhost_driver_detach_vdpa_device(const char *path);
419 
428 __rte_experimental
429 int
430 rte_vhost_driver_get_vdpa_device_id(const char *path);
431 
442 int rte_vhost_driver_set_features(const char *path, uint64_t features);
443 
459 int rte_vhost_driver_enable_features(const char *path, uint64_t features);
460 
473 int rte_vhost_driver_disable_features(const char *path, uint64_t features);
474 
485 int rte_vhost_driver_get_features(const char *path, uint64_t *features);
486 
497 __rte_experimental
498 int
500  uint64_t protocol_features);
501 
512 __rte_experimental
513 int
515  uint64_t *protocol_features);
516 
527 __rte_experimental
528 int
529 rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num);
530 
541 int rte_vhost_get_negotiated_features(int vid, uint64_t *features);
542 
543 /* Register callbacks. */
544 int rte_vhost_driver_callback_register(const char *path,
545  struct vhost_device_ops const * const ops);
546 
558 int rte_vhost_driver_start(const char *path);
559 
573 int rte_vhost_get_mtu(int vid, uint16_t *mtu);
574 
585 int rte_vhost_get_numa_node(int vid);
586 
601 __rte_deprecated
602 uint32_t rte_vhost_get_queue_num(int vid);
603 
613 uint16_t rte_vhost_get_vring_num(int vid);
614 
629 int rte_vhost_get_ifname(int vid, char *buf, size_t len);
630 
642 uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id);
643 
644 struct rte_mbuf;
645 struct rte_mempool;
662 uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
663  struct rte_mbuf **pkts, uint16_t count);
664 
682 uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
683  struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
684 
699 int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem);
700 
713 int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
714  struct rte_vhost_vring *vring);
715 
728 __rte_experimental
729 int
730 rte_vhost_get_vhost_ring_inflight(int vid, uint16_t vring_idx,
731  struct rte_vhost_ring_inflight *vring);
732 
748 __rte_experimental
749 int
750 rte_vhost_set_inflight_desc_split(int vid, uint16_t vring_idx,
751  uint16_t idx);
752 
771 __rte_experimental
772 int
773 rte_vhost_set_inflight_desc_packed(int vid, uint16_t vring_idx,
774  uint16_t head, uint16_t last, uint16_t *inflight_entry);
775 
788 __rte_experimental
789 int
791  uint16_t vring_idx, uint16_t idx);
792 
808 __rte_experimental
809 int
811  uint16_t vring_idx, uint16_t head);
812 
827 __rte_experimental
828 int
829 rte_vhost_clr_inflight_desc_split(int vid, uint16_t vring_idx,
830  uint16_t last_used_idx, uint16_t idx);
831 
844 __rte_experimental
845 int
846 rte_vhost_clr_inflight_desc_packed(int vid, uint16_t vring_idx,
847  uint16_t head);
848 
860 int rte_vhost_vring_call(int vid, uint16_t vring_idx);
861 
872 uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid);
873 
886 __rte_experimental
887 int
888 rte_vhost_get_log_base(int vid, uint64_t *log_base, uint64_t *log_size);
889 
904 __rte_experimental
905 int
906 rte_vhost_get_vring_base(int vid, uint16_t queue_id,
907  uint16_t *last_avail_idx, uint16_t *last_used_idx);
908 
927 __rte_experimental
928 int
930  uint16_t queue_id, uint16_t *last_avail_idx, uint16_t *last_used_idx);
931 
946 __rte_experimental
947 int
948 rte_vhost_set_vring_base(int vid, uint16_t queue_id,
949  uint16_t last_avail_idx, uint16_t last_used_idx);
950 
963 __rte_experimental
964 int
966  struct rte_vhost_user_extern_ops const * const ops, void *ctx);
967 
976 __rte_experimental
977 int
979 
980 #ifdef __cplusplus
981 }
982 #endif
983 
984 #endif /* _RTE_VHOST_H_ */
rte_vhost_driver_start
int rte_vhost_driver_start(const char *path)
rte_vhost_driver_register
int rte_vhost_driver_register(const char *path, uint64_t flags)
vhost_device_ops::vring_state_changed
int(* vring_state_changed)(int vid, uint16_t queue_id, int enable)
Definition: rte_vhost.h:241
rte_vhost_clr_inflight_desc_split
__rte_experimental int rte_vhost_clr_inflight_desc_split(int vid, uint16_t vring_idx, uint16_t last_used_idx, uint16_t idx)
rte_vhost_get_mtu
int rte_vhost_get_mtu(int vid, uint16_t *mtu)
rte_vhost_msg_handle
enum rte_vhost_msg_result(* rte_vhost_msg_handle)(int vid, void *msg)
Definition: rte_vhost.h:222
rte_memory.h
unlikely
#define unlikely(x)
Definition: rte_branch_prediction.h:38
rte_vhost_driver_get_features
int rte_vhost_driver_get_features(const char *path, uint64_t *features)
vhost_device_ops::reserved
void * reserved[1]
Definition: rte_vhost.h:262
__rte_always_inline
#define __rte_always_inline
Definition: rte_common.h:153
rte_vhost_get_vring_base_from_inflight
__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_vhost_set_last_inflight_io_packed
__rte_experimental int rte_vhost_set_last_inflight_io_packed(int vid, uint16_t vring_idx, uint16_t head)
rte_vhost_dequeue_burst
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_vhost_get_vring_base
__rte_experimental int rte_vhost_get_vring_base(int vid, uint16_t queue_id, uint16_t *last_avail_idx, uint16_t *last_used_idx)
vhost_device_ops::new_device
int(* new_device)(int vid)
Definition: rte_vhost.h:238
rte_vhost_user_extern_ops
Definition: rte_vhost.h:227
rte_vhost_driver_set_features
int rte_vhost_driver_set_features(const char *path, uint64_t features)
rte_mbuf
Definition: rte_mbuf_core.h:480
rte_vhost_driver_enable_features
int rte_vhost_driver_enable_features(const char *path, uint64_t features)
rte_vhost_get_queue_num
__rte_deprecated uint32_t rte_vhost_get_queue_num(int vid)
rte_vhost_set_last_inflight_io_split
__rte_experimental int rte_vhost_set_last_inflight_io_split(int vid, uint16_t vring_idx, uint16_t idx)
rte_vhost_driver_detach_vdpa_device
__rte_experimental int rte_vhost_driver_detach_vdpa_device(const char *path)
rte_vhost_memory
Definition: rte_vhost.h:105
rte_vhost_enqueue_burst
uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id, struct rte_mbuf **pkts, uint16_t count)
rte_vhost_get_ifname
int rte_vhost_get_ifname(int vid, char *buf, size_t len)
rte_vhost_driver_attach_vdpa_device
__rte_experimental int rte_vhost_driver_attach_vdpa_device(const char *path, int did)
rte_vhost_driver_get_protocol_features
__rte_experimental int rte_vhost_driver_get_protocol_features(const char *path, uint64_t *protocol_features)
rte_vhost_get_vhost_ring_inflight
__rte_experimental int rte_vhost_get_vhost_ring_inflight(int vid, uint16_t vring_idx, struct rte_vhost_ring_inflight *vring)
rte_vhost_get_vring_num
uint16_t rte_vhost_get_vring_num(int vid)
vhost_device_ops::destroy_device
void(* destroy_device)(int vid)
Definition: rte_vhost.h:239
rte_vhost_get_numa_node
int rte_vhost_get_numa_node(int vid)
rte_vhost_log_used_vring
void rte_vhost_log_used_vring(int vid, uint16_t vring_idx, uint64_t offset, uint64_t len)
vhost_device_ops
Definition: rte_vhost.h:237
rte_vhost_vring_call
int rte_vhost_vring_call(int vid, uint16_t vring_idx)
rte_vhost_set_vring_base
__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_vhost_set_inflight_desc_packed
__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)
rte_mempool
Definition: rte_mempool.h:216
rte_vhost_get_mem_table
int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem)
rte_vhost_get_vdpa_device_id
__rte_experimental int rte_vhost_get_vdpa_device_id(int vid)
rte_vhost_gpa_to_vva
static __rte_deprecated __rte_always_inline uint64_t rte_vhost_gpa_to_vva(struct rte_vhost_memory *mem, uint64_t gpa)
Definition: rte_vhost.h:282
rte_vhost_driver_get_vdpa_device_id
__rte_experimental int rte_vhost_driver_get_vdpa_device_id(const char *path)
rte_vhost_log_write
void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len)
rte_vhost_rx_queue_count
uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid)
rte_vhost_va_from_guest_pa
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)
Definition: rte_vhost.h:317
rte_mempool.h
vhost_device_ops::features_changed
int(* features_changed)(int vid, uint64_t features)
Definition: rte_vhost.h:249
rte_vhost_driver_get_queue_num
__rte_experimental int rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num)
rte_vhost_clr_inflight_desc_packed
__rte_experimental int rte_vhost_clr_inflight_desc_packed(int vid, uint16_t vring_idx, uint16_t head)
rte_vhost_get_log_base
__rte_experimental int rte_vhost_get_log_base(int vid, uint64_t *log_base, uint64_t *log_size)
rte_vhost_avail_entries
uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id)
rte_vhost_driver_disable_features
int rte_vhost_driver_disable_features(const char *path, uint64_t features)
rte_vhost_extern_callback_register
__rte_experimental int rte_vhost_extern_callback_register(int vid, struct rte_vhost_user_extern_ops const *const ops, void *ctx)
rte_vhost_mem_region
Definition: rte_vhost.h:92
rte_vhost_msg_result
rte_vhost_msg_result
Definition: rte_vhost.h:197
rte_vhost_set_inflight_desc_split
__rte_experimental int rte_vhost_set_inflight_desc_split(int vid, uint16_t vring_idx, uint16_t idx)
rte_vhost_get_negotiated_features
int rte_vhost_get_negotiated_features(int vid, uint64_t *features)
vhost_device_ops::guest_notified
void(* guest_notified)(int vid)
Definition: rte_vhost.h:260
rte_vhost_get_vhost_vring
int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx, struct rte_vhost_vring *vring)
rte_vhost_driver_set_protocol_features
__rte_experimental int rte_vhost_driver_set_protocol_features(const char *path, uint64_t protocol_features)