DPDK  18.11.9
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_CONFIG
68 #define VHOST_USER_PROTOCOL_F_CONFIG 9
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 
80 #ifndef VHOST_USER_F_PROTOCOL_FEATURES
81 #define VHOST_USER_F_PROTOCOL_FEATURES 30
82 #endif
83 
84 
90  uint64_t guest_phys_addr;
91  uint64_t guest_user_addr;
92  uint64_t host_user_addr;
93  uint64_t size;
94  void *mmap_addr;
95  uint64_t mmap_size;
96  int fd;
97 };
98 
103  uint32_t nregions;
104  struct rte_vhost_mem_region regions[];
105 };
106 
107 struct rte_vhost_vring {
108  struct vring_desc *desc;
109  struct vring_avail *avail;
110  struct vring_used *used;
111  uint64_t log_guest_addr;
112 
114  int callfd;
115 
116  int kickfd;
117  uint16_t size;
118 };
119 
124  int (*new_device)(int vid);
125  void (*destroy_device)(int vid);
127  int (*vring_state_changed)(int vid, uint16_t queue_id, int enable);
135  int (*features_changed)(int vid, uint64_t features);
136 
137  int (*new_connection)(int vid);
138  void (*destroy_connection)(int vid);
139 
140  void *reserved[2];
141 };
142 
158 __rte_deprecated
159 static __rte_always_inline uint64_t
160 rte_vhost_gpa_to_vva(struct rte_vhost_memory *mem, uint64_t gpa)
161 {
162  struct rte_vhost_mem_region *reg;
163  uint32_t i;
164 
165  for (i = 0; i < mem->nregions; i++) {
166  reg = &mem->regions[i];
167  if (gpa >= reg->guest_phys_addr &&
168  gpa < reg->guest_phys_addr + reg->size) {
169  return gpa - reg->guest_phys_addr +
170  reg->host_user_addr;
171  }
172  }
173 
174  return 0;
175 }
176 
193 static __rte_always_inline uint64_t
195  uint64_t gpa, uint64_t *len)
196 {
197  struct rte_vhost_mem_region *r;
198  uint32_t i;
199 
200  for (i = 0; i < mem->nregions; i++) {
201  r = &mem->regions[i];
202  if (gpa >= r->guest_phys_addr &&
203  gpa < r->guest_phys_addr + r->size) {
204 
205  if (unlikely(*len > r->guest_phys_addr + r->size - gpa))
206  *len = r->guest_phys_addr + r->size - gpa;
207 
208  return gpa - r->guest_phys_addr +
209  r->host_user_addr;
210  }
211  }
212  *len = 0;
213 
214  return 0;
215 }
216 
217 #define RTE_VHOST_NEED_LOG(features) ((features) & (1ULL << VHOST_F_LOG_ALL))
218 
237 void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len);
238 
257 void rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
258  uint64_t offset, uint64_t len);
259 
260 int rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable);
261 
266 int rte_vhost_driver_register(const char *path, uint64_t flags);
267 
268 /* Unregister vhost driver. This is only meaningful to vhost user. */
269 int rte_vhost_driver_unregister(const char *path);
270 
281 int __rte_experimental
282 rte_vhost_driver_attach_vdpa_device(const char *path, int did);
283 
292 int __rte_experimental
293 rte_vhost_driver_detach_vdpa_device(const char *path);
294 
303 int __rte_experimental
304 rte_vhost_driver_get_vdpa_device_id(const char *path);
305 
316 int rte_vhost_driver_set_features(const char *path, uint64_t features);
317 
333 int rte_vhost_driver_enable_features(const char *path, uint64_t features);
334 
347 int rte_vhost_driver_disable_features(const char *path, uint64_t features);
348 
359 int rte_vhost_driver_get_features(const char *path, uint64_t *features);
360 
371 int __rte_experimental
373  uint64_t *protocol_features);
374 
385 int __rte_experimental
386 rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num);
387 
398 int rte_vhost_get_negotiated_features(int vid, uint64_t *features);
399 
400 /* Register callbacks. */
401 int rte_vhost_driver_callback_register(const char *path,
402  struct vhost_device_ops const * const ops);
403 
415 int rte_vhost_driver_start(const char *path);
416 
430 int rte_vhost_get_mtu(int vid, uint16_t *mtu);
431 
442 int rte_vhost_get_numa_node(int vid);
443 
458 __rte_deprecated
459 uint32_t rte_vhost_get_queue_num(int vid);
460 
470 uint16_t rte_vhost_get_vring_num(int vid);
471 
486 int rte_vhost_get_ifname(int vid, char *buf, size_t len);
487 
499 uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id);
500 
501 struct rte_mbuf;
502 struct rte_mempool;
519 uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
520  struct rte_mbuf **pkts, uint16_t count);
521 
539 uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
540  struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
541 
556 int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem);
557 
570 int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
571  struct rte_vhost_vring *vring);
572 
584 int rte_vhost_vring_call(int vid, uint16_t vring_idx);
585 
596 uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid);
597 
610 int __rte_experimental
611 rte_vhost_get_log_base(int vid, uint64_t *log_base, uint64_t *log_size);
612 
627 int __rte_experimental
628 rte_vhost_get_vring_base(int vid, uint16_t queue_id,
629  uint16_t *last_avail_idx, uint16_t *last_used_idx);
630 
645 int __rte_experimental
646 rte_vhost_set_vring_base(int vid, uint16_t queue_id,
647  uint16_t last_avail_idx, uint16_t last_used_idx);
648 
657 int __rte_experimental
659 
660 #ifdef __cplusplus
661 }
662 #endif
663 
664 #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:160
int rte_vhost_driver_start(const char *path)
#define __rte_always_inline
Definition: rte_common.h:159
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)
void(* destroy_device)(int vid)
Definition: rte_vhost.h:125
int __rte_experimental rte_vhost_set_vring_base(int vid, uint16_t queue_id, uint16_t last_avail_idx, uint16_t last_used_idx)
void * reserved[2]
Definition: rte_vhost.h:140
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:194
#define unlikely(x)
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:135
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(* new_device)(int vid)
Definition: rte_vhost.h:124
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(* vring_state_changed)(int vid, uint16_t queue_id, int enable)
Definition: rte_vhost.h:127
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)