DPDK  19.11.3
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_CONFIG
72 #define VHOST_USER_PROTOCOL_F_CONFIG 9
73 #endif
74 
75 #ifndef VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD
76 #define VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD 10
77 #endif
78 
79 #ifndef VHOST_USER_PROTOCOL_F_HOST_NOTIFIER
80 #define VHOST_USER_PROTOCOL_F_HOST_NOTIFIER 11
81 #endif
82 
83 #ifndef VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD
84 #define VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD 12
85 #endif
86 
88 #ifndef VHOST_USER_F_PROTOCOL_FEATURES
89 #define VHOST_USER_F_PROTOCOL_FEATURES 30
90 #endif
91 
92 
98  uint64_t guest_phys_addr;
99  uint64_t guest_user_addr;
100  uint64_t host_user_addr;
101  uint64_t size;
102  void *mmap_addr;
103  uint64_t mmap_size;
104  int fd;
105 };
106 
111  uint32_t nregions;
112  struct rte_vhost_mem_region regions[];
113 };
114 
115 struct rte_vhost_inflight_desc_split {
116  uint8_t inflight;
117  uint8_t padding[5];
118  uint16_t next;
119  uint64_t counter;
120 };
121 
122 struct rte_vhost_inflight_info_split {
123  uint64_t features;
124  uint16_t version;
125  uint16_t desc_num;
126  uint16_t last_inflight_io;
127  uint16_t used_idx;
128  struct rte_vhost_inflight_desc_split desc[0];
129 };
130 
131 struct rte_vhost_inflight_desc_packed {
132  uint8_t inflight;
133  uint8_t padding;
134  uint16_t next;
135  uint16_t last;
136  uint16_t num;
137  uint64_t counter;
138  uint16_t id;
139  uint16_t flags;
140  uint32_t len;
141  uint64_t addr;
142 };
143 
144 struct rte_vhost_inflight_info_packed {
145  uint64_t features;
146  uint16_t version;
147  uint16_t desc_num;
148  uint16_t free_head;
149  uint16_t old_free_head;
150  uint16_t used_idx;
151  uint16_t old_used_idx;
152  uint8_t used_wrap_counter;
153  uint8_t old_used_wrap_counter;
154  uint8_t padding[7];
155  struct rte_vhost_inflight_desc_packed desc[0];
156 };
157 
158 struct rte_vhost_resubmit_desc {
159  uint16_t index;
160  uint64_t counter;
161 };
162 
163 struct rte_vhost_resubmit_info {
164  struct rte_vhost_resubmit_desc *resubmit_list;
165  uint16_t resubmit_num;
166 };
167 
168 struct rte_vhost_ring_inflight {
169  union {
170  struct rte_vhost_inflight_info_split *inflight_split;
171  struct rte_vhost_inflight_info_packed *inflight_packed;
172  };
173 
174  struct rte_vhost_resubmit_info *resubmit_inflight;
175 };
176 
177 struct rte_vhost_vring {
178  union {
179  struct vring_desc *desc;
180  struct vring_packed_desc *desc_packed;
181  };
182  union {
183  struct vring_avail *avail;
184  struct vring_packed_desc_event *driver_event;
185  };
186  union {
187  struct vring_used *used;
188  struct vring_packed_desc_event *device_event;
189  };
190  uint64_t log_guest_addr;
191 
193  int callfd;
194 
195  int kickfd;
196  uint16_t size;
197 };
198 
203  /* Message handling failed */
204  RTE_VHOST_MSG_RESULT_ERR = -1,
205  /* Message handling successful */
206  RTE_VHOST_MSG_RESULT_OK = 0,
207  /* Message handling successful and reply prepared */
208  RTE_VHOST_MSG_RESULT_REPLY = 1,
209  /* Message not handled */
210  RTE_VHOST_MSG_RESULT_NOT_HANDLED,
211 };
212 
227 typedef enum rte_vhost_msg_result (*rte_vhost_msg_handle)(int vid, void *msg);
228 
233  /* Called prior to the master message handling. */
234  rte_vhost_msg_handle pre_msg_handle;
235  /* Called after the master message handling. */
236  rte_vhost_msg_handle post_msg_handle;
237 };
238 
243  int (*new_device)(int vid);
244  void (*destroy_device)(int vid);
246  int (*vring_state_changed)(int vid, uint16_t queue_id, int enable);
254  int (*features_changed)(int vid, uint64_t features);
255 
256  int (*new_connection)(int vid);
257  void (*destroy_connection)(int vid);
258 
265  void (*guest_notified)(int vid);
266 
267  void *reserved[1];
268 };
269 
285 __rte_deprecated
286 static __rte_always_inline uint64_t
287 rte_vhost_gpa_to_vva(struct rte_vhost_memory *mem, uint64_t gpa)
288 {
289  struct rte_vhost_mem_region *reg;
290  uint32_t i;
291 
292  for (i = 0; i < mem->nregions; i++) {
293  reg = &mem->regions[i];
294  if (gpa >= reg->guest_phys_addr &&
295  gpa < reg->guest_phys_addr + reg->size) {
296  return gpa - reg->guest_phys_addr +
297  reg->host_user_addr;
298  }
299  }
300 
301  return 0;
302 }
303 
320 __rte_experimental
321 static __rte_always_inline uint64_t
323  uint64_t gpa, uint64_t *len)
324 {
325  struct rte_vhost_mem_region *r;
326  uint32_t i;
327 
328  for (i = 0; i < mem->nregions; i++) {
329  r = &mem->regions[i];
330  if (gpa >= r->guest_phys_addr &&
331  gpa < r->guest_phys_addr + r->size) {
332 
333  if (unlikely(*len > r->guest_phys_addr + r->size - gpa))
334  *len = r->guest_phys_addr + r->size - gpa;
335 
336  return gpa - r->guest_phys_addr +
337  r->host_user_addr;
338  }
339  }
340  *len = 0;
341 
342  return 0;
343 }
344 
345 #define RTE_VHOST_NEED_LOG(features) ((features) & (1ULL << VHOST_F_LOG_ALL))
346 
365 void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len);
366 
385 void rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
386  uint64_t offset, uint64_t len);
387 
388 int rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable);
389 
394 int rte_vhost_driver_register(const char *path, uint64_t flags);
395 
396 /* Unregister vhost driver. This is only meaningful to vhost user. */
397 int rte_vhost_driver_unregister(const char *path);
398 
409 __rte_experimental
410 int
411 rte_vhost_driver_attach_vdpa_device(const char *path, int did);
412 
421 __rte_experimental
422 int
423 rte_vhost_driver_detach_vdpa_device(const char *path);
424 
433 __rte_experimental
434 int
435 rte_vhost_driver_get_vdpa_device_id(const char *path);
436 
447 int rte_vhost_driver_set_features(const char *path, uint64_t features);
448 
464 int rte_vhost_driver_enable_features(const char *path, uint64_t features);
465 
478 int rte_vhost_driver_disable_features(const char *path, uint64_t features);
479 
490 int rte_vhost_driver_get_features(const char *path, uint64_t *features);
491 
502 __rte_experimental
503 int
505  uint64_t protocol_features);
506 
517 __rte_experimental
518 int
520  uint64_t *protocol_features);
521 
532 __rte_experimental
533 int
534 rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num);
535 
546 int rte_vhost_get_negotiated_features(int vid, uint64_t *features);
547 
548 /* Register callbacks. */
549 int rte_vhost_driver_callback_register(const char *path,
550  struct vhost_device_ops const * const ops);
551 
563 int rte_vhost_driver_start(const char *path);
564 
578 int rte_vhost_get_mtu(int vid, uint16_t *mtu);
579 
590 int rte_vhost_get_numa_node(int vid);
591 
606 __rte_deprecated
607 uint32_t rte_vhost_get_queue_num(int vid);
608 
618 uint16_t rte_vhost_get_vring_num(int vid);
619 
634 int rte_vhost_get_ifname(int vid, char *buf, size_t len);
635 
647 uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id);
648 
649 struct rte_mbuf;
650 struct rte_mempool;
667 uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
668  struct rte_mbuf **pkts, uint16_t count);
669 
687 uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
688  struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
689 
704 int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem);
705 
718 int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
719  struct rte_vhost_vring *vring);
720 
733 __rte_experimental
734 int
735 rte_vhost_get_vhost_ring_inflight(int vid, uint16_t vring_idx,
736  struct rte_vhost_ring_inflight *vring);
737 
753 __rte_experimental
754 int
755 rte_vhost_set_inflight_desc_split(int vid, uint16_t vring_idx,
756  uint16_t idx);
757 
776 __rte_experimental
777 int
778 rte_vhost_set_inflight_desc_packed(int vid, uint16_t vring_idx,
779  uint16_t head, uint16_t last, uint16_t *inflight_entry);
780 
793 __rte_experimental
794 int
796  uint16_t vring_idx, uint16_t idx);
797 
813 __rte_experimental
814 int
816  uint16_t vring_idx, uint16_t head);
817 
832 __rte_experimental
833 int
834 rte_vhost_clr_inflight_desc_split(int vid, uint16_t vring_idx,
835  uint16_t last_used_idx, uint16_t idx);
836 
849 __rte_experimental
850 int
851 rte_vhost_clr_inflight_desc_packed(int vid, uint16_t vring_idx,
852  uint16_t head);
853 
865 int rte_vhost_vring_call(int vid, uint16_t vring_idx);
866 
877 uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid);
878 
891 __rte_experimental
892 int
893 rte_vhost_get_log_base(int vid, uint64_t *log_base, uint64_t *log_size);
894 
909 __rte_experimental
910 int
911 rte_vhost_get_vring_base(int vid, uint16_t queue_id,
912  uint16_t *last_avail_idx, uint16_t *last_used_idx);
913 
932 __rte_experimental
933 int
935  uint16_t queue_id, uint16_t *last_avail_idx, uint16_t *last_used_idx);
936 
951 __rte_experimental
952 int
953 rte_vhost_set_vring_base(int vid, uint16_t queue_id,
954  uint16_t last_avail_idx, uint16_t last_used_idx);
955 
968 __rte_experimental
969 int
971  struct rte_vhost_user_extern_ops const * const ops, void *ctx);
972 
981 __rte_experimental
982 int
984 
985 #ifdef __cplusplus
986 }
987 #endif
988 
989 #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:287
__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:153
void * reserved[1]
Definition: rte_vhost.h:267
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)
__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)
__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 rte_vhost_get_mtu(int vid, uint16_t *mtu)
void(* guest_notified)(int vid)
Definition: rte_vhost.h:265
__rte_experimental int rte_vhost_driver_set_protocol_features(const char *path, uint64_t protocol_features)
void(* destroy_device)(int vid)
Definition: rte_vhost.h:244
__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)
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:322
int(* features_changed)(int vid, uint64_t features)
Definition: rte_vhost.h:254
__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_get_vdpa_device_id(int vid)
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:202
__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_experimental int rte_vhost_driver_get_vdpa_device_id(const char *path)
uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid)
int(* new_device)(int vid)
Definition: rte_vhost.h:243
__rte_experimental int rte_vhost_driver_attach_vdpa_device(const char *path, int did)
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)
__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(* vring_state_changed)(int vid, uint16_t queue_id, int enable)
Definition: rte_vhost.h:246
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)
__rte_experimental int rte_vhost_set_inflight_desc_split(int vid, uint16_t vring_idx, uint16_t idx)
enum rte_vhost_msg_result(* rte_vhost_msg_handle)(int vid, void *msg)
Definition: rte_vhost.h:227
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)