DPDK  19.11.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 
38 /* Features. */
39 #ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
40  #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
41 #endif
42 
43 #ifndef VIRTIO_NET_F_MQ
44  #define VIRTIO_NET_F_MQ 22
45 #endif
46 
47 #ifndef VIRTIO_NET_F_MTU
48  #define VIRTIO_NET_F_MTU 3
49 #endif
50 
51 #ifndef VIRTIO_F_ANY_LAYOUT
52  #define VIRTIO_F_ANY_LAYOUT 27
53 #endif
54 
56 #ifndef VHOST_USER_PROTOCOL_F_MQ
57 #define VHOST_USER_PROTOCOL_F_MQ 0
58 #endif
59 
60 #ifndef VHOST_USER_PROTOCOL_F_LOG_SHMFD
61 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
62 #endif
63 
64 #ifndef VHOST_USER_PROTOCOL_F_RARP
65 #define VHOST_USER_PROTOCOL_F_RARP 2
66 #endif
67 
68 #ifndef VHOST_USER_PROTOCOL_F_REPLY_ACK
69 #define VHOST_USER_PROTOCOL_F_REPLY_ACK 3
70 #endif
71 
72 #ifndef VHOST_USER_PROTOCOL_F_NET_MTU
73 #define VHOST_USER_PROTOCOL_F_NET_MTU 4
74 #endif
75 
76 #ifndef VHOST_USER_PROTOCOL_F_SLAVE_REQ
77 #define VHOST_USER_PROTOCOL_F_SLAVE_REQ 5
78 #endif
79 
80 #ifndef VHOST_USER_PROTOCOL_F_CRYPTO_SESSION
81 #define VHOST_USER_PROTOCOL_F_CRYPTO_SESSION 7
82 #endif
83 
84 #ifndef VHOST_USER_PROTOCOL_F_PAGEFAULT
85 #define VHOST_USER_PROTOCOL_F_PAGEFAULT 8
86 #endif
87 
88 #ifndef VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD
89 #define VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD 10
90 #endif
91 
92 #ifndef VHOST_USER_PROTOCOL_F_HOST_NOTIFIER
93 #define VHOST_USER_PROTOCOL_F_HOST_NOTIFIER 11
94 #endif
95 
96 #ifndef VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD
97 #define VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD 12
98 #endif
99 
101 #ifndef VHOST_USER_F_PROTOCOL_FEATURES
102 #define VHOST_USER_F_PROTOCOL_FEATURES 30
103 #endif
104 
105 struct rte_vdpa_device;
106 
112  uint64_t guest_phys_addr;
113  uint64_t guest_user_addr;
114  uint64_t host_user_addr;
115  uint64_t size;
116  void *mmap_addr;
117  uint64_t mmap_size;
118  int fd;
119 };
120 
125  uint32_t nregions;
126  struct rte_vhost_mem_region regions[];
127 };
128 
129 struct rte_vhost_inflight_desc_split {
130  uint8_t inflight;
131  uint8_t padding[5];
132  uint16_t next;
133  uint64_t counter;
134 };
135 
136 struct rte_vhost_inflight_info_split {
137  uint64_t features;
138  uint16_t version;
139  uint16_t desc_num;
140  uint16_t last_inflight_io;
141  uint16_t used_idx;
142  struct rte_vhost_inflight_desc_split desc[0];
143 };
144 
145 struct rte_vhost_inflight_desc_packed {
146  uint8_t inflight;
147  uint8_t padding;
148  uint16_t next;
149  uint16_t last;
150  uint16_t num;
151  uint64_t counter;
152  uint16_t id;
153  uint16_t flags;
154  uint32_t len;
155  uint64_t addr;
156 };
157 
158 struct rte_vhost_inflight_info_packed {
159  uint64_t features;
160  uint16_t version;
161  uint16_t desc_num;
162  uint16_t free_head;
163  uint16_t old_free_head;
164  uint16_t used_idx;
165  uint16_t old_used_idx;
166  uint8_t used_wrap_counter;
167  uint8_t old_used_wrap_counter;
168  uint8_t padding[7];
169  struct rte_vhost_inflight_desc_packed desc[0];
170 };
171 
172 struct rte_vhost_resubmit_desc {
173  uint16_t index;
174  uint64_t counter;
175 };
176 
177 struct rte_vhost_resubmit_info {
178  struct rte_vhost_resubmit_desc *resubmit_list;
179  uint16_t resubmit_num;
180 };
181 
182 struct rte_vhost_ring_inflight {
183  union {
184  struct rte_vhost_inflight_info_split *inflight_split;
185  struct rte_vhost_inflight_info_packed *inflight_packed;
186  };
187 
188  struct rte_vhost_resubmit_info *resubmit_inflight;
189 };
190 
191 struct rte_vhost_vring {
192  union {
193  struct vring_desc *desc;
194  struct vring_packed_desc *desc_packed;
195  };
196  union {
197  struct vring_avail *avail;
198  struct vring_packed_desc_event *driver_event;
199  };
200  union {
201  struct vring_used *used;
202  struct vring_packed_desc_event *device_event;
203  };
204  uint64_t log_guest_addr;
205 
207  int callfd;
208 
209  int kickfd;
210  uint16_t size;
211 };
212 
217  /* Message handling failed */
218  RTE_VHOST_MSG_RESULT_ERR = -1,
219  /* Message handling successful */
220  RTE_VHOST_MSG_RESULT_OK = 0,
221  /* Message handling successful and reply prepared */
222  RTE_VHOST_MSG_RESULT_REPLY = 1,
223  /* Message not handled */
224  RTE_VHOST_MSG_RESULT_NOT_HANDLED,
225 };
226 
241 typedef enum rte_vhost_msg_result (*rte_vhost_msg_handle)(int vid, void *msg);
242 
247  /* Called prior to the master message handling. */
248  rte_vhost_msg_handle pre_msg_handle;
249  /* Called after the master message handling. */
250  rte_vhost_msg_handle post_msg_handle;
251 };
252 
257  int (*new_device)(int vid);
258  void (*destroy_device)(int vid);
260  int (*vring_state_changed)(int vid, uint16_t queue_id, int enable);
268  int (*features_changed)(int vid, uint64_t features);
269 
270  int (*new_connection)(int vid);
271  void (*destroy_connection)(int vid);
272 
279  void (*guest_notified)(int vid);
280 
281  void *reserved[1];
282 };
283 
299 __rte_deprecated
300 static __rte_always_inline uint64_t
301 rte_vhost_gpa_to_vva(struct rte_vhost_memory *mem, uint64_t gpa)
302 {
303  struct rte_vhost_mem_region *reg;
304  uint32_t i;
305 
306  for (i = 0; i < mem->nregions; i++) {
307  reg = &mem->regions[i];
308  if (gpa >= reg->guest_phys_addr &&
309  gpa < reg->guest_phys_addr + reg->size) {
310  return gpa - reg->guest_phys_addr +
311  reg->host_user_addr;
312  }
313  }
314 
315  return 0;
316 }
317 
334 __rte_experimental
335 static __rte_always_inline uint64_t
337  uint64_t gpa, uint64_t *len)
338 {
339  struct rte_vhost_mem_region *r;
340  uint32_t i;
341 
342  for (i = 0; i < mem->nregions; i++) {
343  r = &mem->regions[i];
344  if (gpa >= r->guest_phys_addr &&
345  gpa < r->guest_phys_addr + r->size) {
346 
347  if (unlikely(*len > r->guest_phys_addr + r->size - gpa))
348  *len = r->guest_phys_addr + r->size - gpa;
349 
350  return gpa - r->guest_phys_addr +
351  r->host_user_addr;
352  }
353  }
354  *len = 0;
355 
356  return 0;
357 }
358 
359 #define RTE_VHOST_NEED_LOG(features) ((features) & (1ULL << VHOST_F_LOG_ALL))
360 
379 void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len);
380 
399 void rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
400  uint64_t offset, uint64_t len);
401 
402 int rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable);
403 
408 int rte_vhost_driver_register(const char *path, uint64_t flags);
409 
410 /* Unregister vhost driver. This is only meaningful to vhost user. */
411 int rte_vhost_driver_unregister(const char *path);
412 
423 __rte_experimental
424 int
425 rte_vhost_driver_attach_vdpa_device(const char *path,
426  struct rte_vdpa_device *dev);
427 
436 __rte_experimental
437 int
438 rte_vhost_driver_detach_vdpa_device(const char *path);
439 
448 __rte_experimental
449 struct rte_vdpa_device *
450 rte_vhost_driver_get_vdpa_device(const char *path);
451 
462 int rte_vhost_driver_set_features(const char *path, uint64_t features);
463 
479 int rte_vhost_driver_enable_features(const char *path, uint64_t features);
480 
493 int rte_vhost_driver_disable_features(const char *path, uint64_t features);
494 
505 int rte_vhost_driver_get_features(const char *path, uint64_t *features);
506 
517 __rte_experimental
518 int
520  uint64_t protocol_features);
521 
532 __rte_experimental
533 int
535  uint64_t *protocol_features);
536 
547 __rte_experimental
548 int
549 rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num);
550 
561 int rte_vhost_get_negotiated_features(int vid, uint64_t *features);
562 
563 /* Register callbacks. */
564 int rte_vhost_driver_callback_register(const char *path,
565  struct vhost_device_ops const * const ops);
566 
578 int rte_vhost_driver_start(const char *path);
579 
593 int rte_vhost_get_mtu(int vid, uint16_t *mtu);
594 
605 int rte_vhost_get_numa_node(int vid);
606 
621 __rte_deprecated
622 uint32_t rte_vhost_get_queue_num(int vid);
623 
633 uint16_t rte_vhost_get_vring_num(int vid);
634 
649 int rte_vhost_get_ifname(int vid, char *buf, size_t len);
650 
662 uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id);
663 
664 struct rte_mbuf;
665 struct rte_mempool;
682 uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
683  struct rte_mbuf **pkts, uint16_t count);
684 
702 uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
703  struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
704 
719 int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem);
720 
733 int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
734  struct rte_vhost_vring *vring);
735 
748 __rte_experimental
749 int
750 rte_vhost_get_vhost_ring_inflight(int vid, uint16_t vring_idx,
751  struct rte_vhost_ring_inflight *vring);
752 
768 __rte_experimental
769 int
770 rte_vhost_set_inflight_desc_split(int vid, uint16_t vring_idx,
771  uint16_t idx);
772 
791 __rte_experimental
792 int
793 rte_vhost_set_inflight_desc_packed(int vid, uint16_t vring_idx,
794  uint16_t head, uint16_t last, uint16_t *inflight_entry);
795 
808 __rte_experimental
809 int
811  uint16_t vring_idx, uint16_t idx);
812 
828 __rte_experimental
829 int
831  uint16_t vring_idx, uint16_t head);
832 
847 __rte_experimental
848 int
849 rte_vhost_clr_inflight_desc_split(int vid, uint16_t vring_idx,
850  uint16_t last_used_idx, uint16_t idx);
851 
864 __rte_experimental
865 int
866 rte_vhost_clr_inflight_desc_packed(int vid, uint16_t vring_idx,
867  uint16_t head);
868 
880 int rte_vhost_vring_call(int vid, uint16_t vring_idx);
881 
892 uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid);
893 
906 __rte_experimental
907 int
908 rte_vhost_get_log_base(int vid, uint64_t *log_base, uint64_t *log_size);
909 
924 __rte_experimental
925 int
926 rte_vhost_get_vring_base(int vid, uint16_t queue_id,
927  uint16_t *last_avail_idx, uint16_t *last_used_idx);
928 
947 __rte_experimental
948 int
950  uint16_t queue_id, uint16_t *last_avail_idx, uint16_t *last_used_idx);
951 
966 __rte_experimental
967 int
968 rte_vhost_set_vring_base(int vid, uint16_t queue_id,
969  uint16_t last_avail_idx, uint16_t last_used_idx);
970 
983 __rte_experimental
984 int
986  struct rte_vhost_user_extern_ops const * const ops, void *ctx);
987 
996 __rte_experimental
997 struct rte_vdpa_device *
999 
1000 #ifdef __cplusplus
1001 }
1002 #endif
1003 
1004 #endif /* _RTE_VHOST_H_ */
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:301
__rte_experimental int rte_vhost_set_last_inflight_io_split(int vid, uint16_t vring_idx, uint16_t idx)
int rte_vhost_driver_start(const char *path)
#define __rte_always_inline
Definition: rte_common.h:173
void * reserved[1]
Definition: rte_vhost.h:281
int rte_vhost_driver_register(const char *path, uint64_t flags)
uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id)
__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_driver_disable_features(const char *path, uint64_t features)
void rte_vhost_log_used_vring(int vid, uint16_t vring_idx, uint64_t offset, uint64_t len)
__rte_experimental int rte_vhost_extern_callback_register(int vid, struct rte_vhost_user_extern_ops const *const ops, void *ctx)
int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx, struct rte_vhost_vring *vring)
void
Definition: rte_common.h:805
__rte_experimental struct rte_vdpa_device * rte_vhost_driver_get_vdpa_device(const char *path)
__rte_experimental int rte_vhost_set_last_inflight_io_packed(int vid, uint16_t vring_idx, uint16_t head)
uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id, struct rte_mbuf **pkts, uint16_t count)
__rte_deprecated uint32_t rte_vhost_get_queue_num(int vid)
__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)
Definition: rte_vhost.h:257
__rte_experimental int rte_vhost_set_vring_base(int vid, uint16_t queue_id, uint16_t last_avail_idx, uint16_t last_used_idx)
int(* features_changed)(int vid, uint64_t features)
Definition: rte_vhost.h:268
int rte_vhost_get_mtu(int vid, uint16_t *mtu)
__rte_experimental int rte_vhost_driver_set_protocol_features(const char *path, uint64_t protocol_features)
__rte_experimental struct rte_vdpa_device * rte_vhost_get_vdpa_device(int vid)
__rte_experimental int rte_vhost_driver_detach_vdpa_device(const char *path)
#define unlikely(x)
uint16_t rte_vhost_get_vring_num(int vid)
int rte_vhost_get_numa_node(int vid)
struct rte_vdpa_dev_ops * ops
Definition: rte_vdpa_dev.h:75
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:336
__rte_experimental int rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num)
int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem)
__rte_experimental int rte_vhost_driver_attach_vdpa_device(const char *path, struct rte_vdpa_device *dev)
int rte_vhost_vring_call(int vid, uint16_t vring_idx)
int rte_vhost_get_negotiated_features(int vid, uint64_t *features)
rte_vhost_msg_result
Definition: rte_vhost.h:216
__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)
uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid)
void(* guest_notified)(int vid)
Definition: rte_vhost.h:279
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_clr_inflight_desc_packed(int vid, uint16_t vring_idx, uint16_t head)
void(* destroy_device)(int vid)
Definition: rte_vhost.h:258
int(* vring_state_changed)(int vid, uint16_t queue_id, int enable)
Definition: rte_vhost.h:260
__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)
__rte_experimental int rte_vhost_get_log_base(int vid, uint64_t *log_base, uint64_t *log_size)
int rte_vhost_driver_get_features(const char *path, uint64_t *features)
int rte_vhost_driver_set_features(const char *path, uint64_t features)
int rte_vhost_get_ifname(int vid, char *buf, size_t len)
__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)
enum rte_vhost_msg_result(* rte_vhost_msg_handle)(int vid, void *msg)
Definition: rte_vhost.h:241
__rte_experimental int rte_vhost_set_inflight_desc_split(int vid, uint16_t vring_idx, uint16_t idx)
int rte_vhost_driver_enable_features(const char *path, uint64_t features)
void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len)