DPDK  18.11.6
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 
35 #ifndef VHOST_USER_PROTOCOL_F_MQ
36 #define VHOST_USER_PROTOCOL_F_MQ 0
37 #endif
38 
39 #ifndef VHOST_USER_PROTOCOL_F_LOG_SHMFD
40 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
41 #endif
42 
43 #ifndef VHOST_USER_PROTOCOL_F_RARP
44 #define VHOST_USER_PROTOCOL_F_RARP 2
45 #endif
46 
47 #ifndef VHOST_USER_PROTOCOL_F_REPLY_ACK
48 #define VHOST_USER_PROTOCOL_F_REPLY_ACK 3
49 #endif
50 
51 #ifndef VHOST_USER_PROTOCOL_F_NET_MTU
52 #define VHOST_USER_PROTOCOL_F_NET_MTU 4
53 #endif
54 
55 #ifndef VHOST_USER_PROTOCOL_F_SLAVE_REQ
56 #define VHOST_USER_PROTOCOL_F_SLAVE_REQ 5
57 #endif
58 
59 #ifndef VHOST_USER_PROTOCOL_F_CRYPTO_SESSION
60 #define VHOST_USER_PROTOCOL_F_CRYPTO_SESSION 7
61 #endif
62 
63 #ifndef VHOST_USER_PROTOCOL_F_PAGEFAULT
64 #define VHOST_USER_PROTOCOL_F_PAGEFAULT 8
65 #endif
66 
67 #ifndef VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD
68 #define VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD 10
69 #endif
70 
71 #ifndef VHOST_USER_PROTOCOL_F_HOST_NOTIFIER
72 #define VHOST_USER_PROTOCOL_F_HOST_NOTIFIER 11
73 #endif
74 
76 #ifndef VHOST_USER_F_PROTOCOL_FEATURES
77 #define VHOST_USER_F_PROTOCOL_FEATURES 30
78 #endif
79 
85  uint64_t guest_phys_addr;
86  uint64_t guest_user_addr;
87  uint64_t host_user_addr;
88  uint64_t size;
89  void *mmap_addr;
90  uint64_t mmap_size;
91  int fd;
92 };
93 
98  uint32_t nregions;
99  struct rte_vhost_mem_region regions[];
100 };
101 
102 struct rte_vhost_vring {
103  struct vring_desc *desc;
104  struct vring_avail *avail;
105  struct vring_used *used;
106  uint64_t log_guest_addr;
107 
109  int callfd;
110 
111  int kickfd;
112  uint16_t size;
113 };
114 
119  int (*new_device)(int vid);
120  void (*destroy_device)(int vid);
122  int (*vring_state_changed)(int vid, uint16_t queue_id, int enable);
130  int (*features_changed)(int vid, uint64_t features);
131 
132  int (*new_connection)(int vid);
133  void (*destroy_connection)(int vid);
134 
135  void *reserved[2];
136 };
137 
153 __rte_deprecated
154 static __rte_always_inline uint64_t
155 rte_vhost_gpa_to_vva(struct rte_vhost_memory *mem, uint64_t gpa)
156 {
157  struct rte_vhost_mem_region *reg;
158  uint32_t i;
159 
160  for (i = 0; i < mem->nregions; i++) {
161  reg = &mem->regions[i];
162  if (gpa >= reg->guest_phys_addr &&
163  gpa < reg->guest_phys_addr + reg->size) {
164  return gpa - reg->guest_phys_addr +
165  reg->host_user_addr;
166  }
167  }
168 
169  return 0;
170 }
171 
188 static __rte_always_inline uint64_t
190  uint64_t gpa, uint64_t *len)
191 {
192  struct rte_vhost_mem_region *r;
193  uint32_t i;
194 
195  for (i = 0; i < mem->nregions; i++) {
196  r = &mem->regions[i];
197  if (gpa >= r->guest_phys_addr &&
198  gpa < r->guest_phys_addr + r->size) {
199 
200  if (unlikely(*len > r->guest_phys_addr + r->size - gpa))
201  *len = r->guest_phys_addr + r->size - gpa;
202 
203  return gpa - r->guest_phys_addr +
204  r->host_user_addr;
205  }
206  }
207  *len = 0;
208 
209  return 0;
210 }
211 
212 #define RTE_VHOST_NEED_LOG(features) ((features) & (1ULL << VHOST_F_LOG_ALL))
213 
232 void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len);
233 
252 void rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
253  uint64_t offset, uint64_t len);
254 
255 int rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable);
256 
261 int rte_vhost_driver_register(const char *path, uint64_t flags);
262 
263 /* Unregister vhost driver. This is only meaningful to vhost user. */
264 int rte_vhost_driver_unregister(const char *path);
265 
276 int __rte_experimental
277 rte_vhost_driver_attach_vdpa_device(const char *path, int did);
278 
287 int __rte_experimental
288 rte_vhost_driver_detach_vdpa_device(const char *path);
289 
298 int __rte_experimental
299 rte_vhost_driver_get_vdpa_device_id(const char *path);
300 
311 int rte_vhost_driver_set_features(const char *path, uint64_t features);
312 
328 int rte_vhost_driver_enable_features(const char *path, uint64_t features);
329 
342 int rte_vhost_driver_disable_features(const char *path, uint64_t features);
343 
354 int rte_vhost_driver_get_features(const char *path, uint64_t *features);
355 
366 int __rte_experimental
368  uint64_t *protocol_features);
369 
380 int __rte_experimental
381 rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num);
382 
393 int rte_vhost_get_negotiated_features(int vid, uint64_t *features);
394 
395 /* Register callbacks. */
396 int rte_vhost_driver_callback_register(const char *path,
397  struct vhost_device_ops const * const ops);
398 
410 int rte_vhost_driver_start(const char *path);
411 
425 int rte_vhost_get_mtu(int vid, uint16_t *mtu);
426 
437 int rte_vhost_get_numa_node(int vid);
438 
453 __rte_deprecated
454 uint32_t rte_vhost_get_queue_num(int vid);
455 
465 uint16_t rte_vhost_get_vring_num(int vid);
466 
481 int rte_vhost_get_ifname(int vid, char *buf, size_t len);
482 
494 uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id);
495 
496 struct rte_mbuf;
497 struct rte_mempool;
514 uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
515  struct rte_mbuf **pkts, uint16_t count);
516 
534 uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
535  struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
536 
551 int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem);
552 
565 int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
566  struct rte_vhost_vring *vring);
567 
579 int rte_vhost_vring_call(int vid, uint16_t vring_idx);
580 
591 uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid);
592 
605 int __rte_experimental
606 rte_vhost_get_log_base(int vid, uint64_t *log_base, uint64_t *log_size);
607 
622 int __rte_experimental
623 rte_vhost_get_vring_base(int vid, uint16_t queue_id,
624  uint16_t *last_avail_idx, uint16_t *last_used_idx);
625 
640 int __rte_experimental
641 rte_vhost_set_vring_base(int vid, uint16_t queue_id,
642  uint16_t last_avail_idx, uint16_t last_used_idx);
643 
652 int __rte_experimental
654 
655 #ifdef __cplusplus
656 }
657 #endif
658 
659 #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:155
int rte_vhost_driver_start(const char *path)
#define __rte_always_inline
Definition: rte_common.h:146
int rte_vhost_driver_register(const char *path, uint64_t flags)
uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id)
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)
int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx, struct rte_vhost_vring *vring)
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)
int __rte_experimental rte_vhost_get_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)
int __rte_experimental rte_vhost_set_vring_base(int vid, uint16_t queue_id, uint16_t last_avail_idx, uint16_t last_used_idx)
static __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:189
#define unlikely(x)
uint16_t rte_vhost_get_vring_num(int vid)
int rte_vhost_get_numa_node(int vid)
int __rte_experimental rte_vhost_driver_detach_vdpa_device(const char *path)
int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem)
int rte_vhost_vring_call(int vid, uint16_t vring_idx)
int rte_vhost_get_negotiated_features(int vid, uint64_t *features)
uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid)
int __rte_experimental rte_vhost_get_vdpa_device_id(int vid)
uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id, struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count)
int __rte_experimental rte_vhost_driver_get_protocol_features(const char *path, uint64_t *protocol_features)
int __rte_experimental 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_experimental rte_vhost_driver_attach_vdpa_device(const char *path, int did)
int rte_vhost_get_ifname(int vid, char *buf, size_t len)
int __rte_experimental rte_vhost_driver_get_vdpa_device_id(const char *path)
int __rte_experimental rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num)
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)