DPDK  19.05.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 #define RTE_VHOST_USER_POSTCOPY_SUPPORT (1ULL << 4)
32 
34 #ifndef VHOST_USER_PROTOCOL_F_MQ
35 #define VHOST_USER_PROTOCOL_F_MQ 0
36 #endif
37 
38 #ifndef VHOST_USER_PROTOCOL_F_LOG_SHMFD
39 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
40 #endif
41 
42 #ifndef VHOST_USER_PROTOCOL_F_RARP
43 #define VHOST_USER_PROTOCOL_F_RARP 2
44 #endif
45 
46 #ifndef VHOST_USER_PROTOCOL_F_REPLY_ACK
47 #define VHOST_USER_PROTOCOL_F_REPLY_ACK 3
48 #endif
49 
50 #ifndef VHOST_USER_PROTOCOL_F_NET_MTU
51 #define VHOST_USER_PROTOCOL_F_NET_MTU 4
52 #endif
53 
54 #ifndef VHOST_USER_PROTOCOL_F_SLAVE_REQ
55 #define VHOST_USER_PROTOCOL_F_SLAVE_REQ 5
56 #endif
57 
58 #ifndef VHOST_USER_PROTOCOL_F_CRYPTO_SESSION
59 #define VHOST_USER_PROTOCOL_F_CRYPTO_SESSION 7
60 #endif
61 
62 #ifndef VHOST_USER_PROTOCOL_F_PAGEFAULT
63 #define VHOST_USER_PROTOCOL_F_PAGEFAULT 8
64 #endif
65 
66 #ifndef VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD
67 #define VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD 10
68 #endif
69 
70 #ifndef VHOST_USER_PROTOCOL_F_HOST_NOTIFIER
71 #define VHOST_USER_PROTOCOL_F_HOST_NOTIFIER 11
72 #endif
73 
75 #ifndef VHOST_USER_F_PROTOCOL_FEATURES
76 #define VHOST_USER_F_PROTOCOL_FEATURES 30
77 #endif
78 
83 struct rte_vhost_mem_region {
84  uint64_t guest_phys_addr;
85  uint64_t guest_user_addr;
86  uint64_t host_user_addr;
87  uint64_t size;
88  void *mmap_addr;
89  uint64_t mmap_size;
90  int fd;
91 };
92 
96 struct rte_vhost_memory {
97  uint32_t nregions;
98  struct rte_vhost_mem_region regions[];
99 };
100 
101 struct rte_vhost_vring {
102  struct vring_desc *desc;
103  struct vring_avail *avail;
104  struct vring_used *used;
105  uint64_t log_guest_addr;
106 
108  int callfd;
109 
110  int kickfd;
111  uint16_t size;
112 };
113 
117 enum rte_vhost_msg_result {
118  /* Message handling failed */
119  RTE_VHOST_MSG_RESULT_ERR = -1,
120  /* Message handling successful */
121  RTE_VHOST_MSG_RESULT_OK = 0,
122  /* Message handling successful and reply prepared */
123  RTE_VHOST_MSG_RESULT_REPLY = 1,
124  /* Message not handled */
125  RTE_VHOST_MSG_RESULT_NOT_HANDLED,
126 };
127 
142 typedef enum rte_vhost_msg_result (*rte_vhost_msg_handle)(int vid, void *msg);
143 
147 struct rte_vhost_user_extern_ops {
148  /* Called prior to the master message handling. */
149  rte_vhost_msg_handle pre_msg_handle;
150  /* Called after the master message handling. */
151  rte_vhost_msg_handle post_msg_handle;
152 };
153 
157 struct vhost_device_ops {
158  int (*new_device)(int vid);
159  void (*destroy_device)(int vid);
161  int (*vring_state_changed)(int vid, uint16_t queue_id, int enable);
169  int (*features_changed)(int vid, uint64_t features);
170 
171  int (*new_connection)(int vid);
172  void (*destroy_connection)(int vid);
173 
174  void *reserved[2];
175 };
176 
192 __rte_deprecated
193 static __rte_always_inline uint64_t
194 rte_vhost_gpa_to_vva(struct rte_vhost_memory *mem, uint64_t gpa)
195 {
196  struct rte_vhost_mem_region *reg;
197  uint32_t i;
198 
199  for (i = 0; i < mem->nregions; i++) {
200  reg = &mem->regions[i];
201  if (gpa >= reg->guest_phys_addr &&
202  gpa < reg->guest_phys_addr + reg->size) {
203  return gpa - reg->guest_phys_addr +
204  reg->host_user_addr;
205  }
206  }
207 
208  return 0;
209 }
210 
227 static __rte_always_inline uint64_t
228 rte_vhost_va_from_guest_pa(struct rte_vhost_memory *mem,
229  uint64_t gpa, uint64_t *len)
230 {
231  struct rte_vhost_mem_region *r;
232  uint32_t i;
233 
234  for (i = 0; i < mem->nregions; i++) {
235  r = &mem->regions[i];
236  if (gpa >= r->guest_phys_addr &&
237  gpa < r->guest_phys_addr + r->size) {
238 
239  if (unlikely(*len > r->guest_phys_addr + r->size - gpa))
240  *len = r->guest_phys_addr + r->size - gpa;
241 
242  return gpa - r->guest_phys_addr +
243  r->host_user_addr;
244  }
245  }
246  *len = 0;
247 
248  return 0;
249 }
250 
251 #define RTE_VHOST_NEED_LOG(features) ((features) & (1ULL << VHOST_F_LOG_ALL))
252 
271 void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len);
272 
291 void rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
292  uint64_t offset, uint64_t len);
293 
294 int rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable);
295 
300 int rte_vhost_driver_register(const char *path, uint64_t flags);
301 
302 /* Unregister vhost driver. This is only meaningful to vhost user. */
303 int rte_vhost_driver_unregister(const char *path);
304 
315 int __rte_experimental
316 rte_vhost_driver_attach_vdpa_device(const char *path, int did);
317 
326 int __rte_experimental
327 rte_vhost_driver_detach_vdpa_device(const char *path);
328 
337 int __rte_experimental
338 rte_vhost_driver_get_vdpa_device_id(const char *path);
339 
350 int rte_vhost_driver_set_features(const char *path, uint64_t features);
351 
367 int rte_vhost_driver_enable_features(const char *path, uint64_t features);
368 
381 int rte_vhost_driver_disable_features(const char *path, uint64_t features);
382 
393 int rte_vhost_driver_get_features(const char *path, uint64_t *features);
394 
405 int __rte_experimental
406 rte_vhost_driver_set_protocol_features(const char *path,
407  uint64_t protocol_features);
408 
419 int __rte_experimental
420 rte_vhost_driver_get_protocol_features(const char *path,
421  uint64_t *protocol_features);
422 
433 int __rte_experimental
434 rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num);
435 
446 int rte_vhost_get_negotiated_features(int vid, uint64_t *features);
447 
448 /* Register callbacks. */
449 int rte_vhost_driver_callback_register(const char *path,
450  struct vhost_device_ops const * const ops);
451 
463 int rte_vhost_driver_start(const char *path);
464 
478 int rte_vhost_get_mtu(int vid, uint16_t *mtu);
479 
490 int rte_vhost_get_numa_node(int vid);
491 
506 __rte_deprecated
507 uint32_t rte_vhost_get_queue_num(int vid);
508 
518 uint16_t rte_vhost_get_vring_num(int vid);
519 
534 int rte_vhost_get_ifname(int vid, char *buf, size_t len);
535 
547 uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id);
548 
549 struct rte_mbuf;
550 struct rte_mempool;
567 uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
568  struct rte_mbuf **pkts, uint16_t count);
569 
587 uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
588  struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
589 
604 int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem);
605 
618 int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
619  struct rte_vhost_vring *vring);
620 
632 int rte_vhost_vring_call(int vid, uint16_t vring_idx);
633 
644 uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid);
645 
658 int __rte_experimental
659 rte_vhost_get_log_base(int vid, uint64_t *log_base, uint64_t *log_size);
660 
675 int __rte_experimental
676 rte_vhost_get_vring_base(int vid, uint16_t queue_id,
677  uint16_t *last_avail_idx, uint16_t *last_used_idx);
678 
693 int __rte_experimental
694 rte_vhost_set_vring_base(int vid, uint16_t queue_id,
695  uint16_t last_avail_idx, uint16_t last_used_idx);
696 
709 int __rte_experimental
710 rte_vhost_extern_callback_register(int vid,
711  struct rte_vhost_user_extern_ops const * const ops, void *ctx);
712 
721 int __rte_experimental
722 rte_vhost_get_vdpa_device_id(int vid);
723 
724 #ifdef __cplusplus
725 }
726 #endif
727 
728 #endif /* _RTE_VHOST_H_ */
Generated by   doxygen 1.8.1.2