DPDK  18.02.0
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 
27 #define RTE_VHOST_USER_CLIENT (1ULL << 0)
28 #define RTE_VHOST_USER_NO_RECONNECT (1ULL << 1)
29 #define RTE_VHOST_USER_DEQUEUE_ZERO_COPY (1ULL << 2)
30 #define RTE_VHOST_USER_IOMMU_SUPPORT (1ULL << 3)
31 
37  uint64_t guest_phys_addr;
38  uint64_t guest_user_addr;
39  uint64_t host_user_addr;
40  uint64_t size;
41  void *mmap_addr;
42  uint64_t mmap_size;
43  int fd;
44 };
45 
50  uint32_t nregions;
51  struct rte_vhost_mem_region regions[];
52 };
53 
54 struct rte_vhost_vring {
55  struct vring_desc *desc;
56  struct vring_avail *avail;
57  struct vring_used *used;
58  uint64_t log_guest_addr;
59 
61  int callfd;
62 
63  int kickfd;
64  uint16_t size;
65 };
66 
71  int (*new_device)(int vid);
72  void (*destroy_device)(int vid);
74  int (*vring_state_changed)(int vid, uint16_t queue_id, int enable);
82  int (*features_changed)(int vid, uint64_t features);
83 
84  int (*new_connection)(int vid);
85  void (*destroy_connection)(int vid);
86 
87  void *reserved[2];
88 };
89 
100 static __rte_always_inline uint64_t
101 rte_vhost_gpa_to_vva(struct rte_vhost_memory *mem, uint64_t gpa)
102 {
103  struct rte_vhost_mem_region *reg;
104  uint32_t i;
105 
106  for (i = 0; i < mem->nregions; i++) {
107  reg = &mem->regions[i];
108  if (gpa >= reg->guest_phys_addr &&
109  gpa < reg->guest_phys_addr + reg->size) {
110  return gpa - reg->guest_phys_addr +
111  reg->host_user_addr;
112  }
113  }
114 
115  return 0;
116 }
117 
118 #define RTE_VHOST_NEED_LOG(features) ((features) & (1ULL << VHOST_F_LOG_ALL))
119 
138 void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len);
139 
158 void rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
159  uint64_t offset, uint64_t len);
160 
161 int rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable);
162 
167 int rte_vhost_driver_register(const char *path, uint64_t flags);
168 
169 /* Unregister vhost driver. This is only meaningful to vhost user. */
170 int rte_vhost_driver_unregister(const char *path);
171 
182 int rte_vhost_driver_set_features(const char *path, uint64_t features);
183 
199 int rte_vhost_driver_enable_features(const char *path, uint64_t features);
200 
213 int rte_vhost_driver_disable_features(const char *path, uint64_t features);
214 
225 int rte_vhost_driver_get_features(const char *path, uint64_t *features);
226 
237 int rte_vhost_get_negotiated_features(int vid, uint64_t *features);
238 
239 /* Register callbacks. */
240 int rte_vhost_driver_callback_register(const char *path,
241  struct vhost_device_ops const * const ops);
242 
254 int rte_vhost_driver_start(const char *path);
255 
269 int rte_vhost_get_mtu(int vid, uint16_t *mtu);
270 
281 int rte_vhost_get_numa_node(int vid);
282 
297 __rte_deprecated
298 uint32_t rte_vhost_get_queue_num(int vid);
299 
309 uint16_t rte_vhost_get_vring_num(int vid);
310 
325 int rte_vhost_get_ifname(int vid, char *buf, size_t len);
326 
338 uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id);
339 
340 struct rte_mbuf;
341 struct rte_mempool;
358 uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
359  struct rte_mbuf **pkts, uint16_t count);
360 
378 uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
379  struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
380 
395 int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem);
396 
409 int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
410  struct rte_vhost_vring *vring);
411 
423 int rte_vhost_vring_call(int vid, uint16_t vring_idx);
424 
435 uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid);
436 
437 #ifdef __cplusplus
438 }
439 #endif
440 
441 #endif /* _RTE_VHOST_H_ */
int rte_vhost_driver_start(const char *path)
#define __rte_always_inline
Definition: rte_common.h:110
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_vhost_get_mtu(int vid, uint16_t *mtu)
void(* destroy_device)(int vid)
Definition: rte_vhost.h:72
void * reserved[2]
Definition: rte_vhost.h:87
uint16_t rte_vhost_get_vring_num(int vid)
int rte_vhost_get_numa_node(int vid)
int(* features_changed)(int vid, uint64_t features)
Definition: rte_vhost.h:82
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(* new_device)(int vid)
Definition: rte_vhost.h:71
static __rte_always_inline uint64_t rte_vhost_gpa_to_vva(struct rte_vhost_memory *mem, uint64_t gpa)
Definition: rte_vhost.h:101
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_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:74
int rte_vhost_get_ifname(int vid, char *buf, size_t len)
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)