DPDK 21.11.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 <stdbool.h>
14#include <stdint.h>
15#include <sys/eventfd.h>
16
17#include <rte_memory.h>
18#include <rte_mempool.h>
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
24/* These are not C++-aware. */
25#include <linux/vhost.h>
26#include <linux/virtio_ring.h>
27#include <linux/virtio_net.h>
28
29#define RTE_VHOST_USER_CLIENT (1ULL << 0)
30#define RTE_VHOST_USER_NO_RECONNECT (1ULL << 1)
31#define RTE_VHOST_USER_RESERVED_1 (1ULL << 2)
32#define RTE_VHOST_USER_IOMMU_SUPPORT (1ULL << 3)
33#define RTE_VHOST_USER_POSTCOPY_SUPPORT (1ULL << 4)
34/* support mbuf with external buffer attached */
35#define RTE_VHOST_USER_EXTBUF_SUPPORT (1ULL << 5)
36/* support only linear buffers (no chained mbufs) */
37#define RTE_VHOST_USER_LINEARBUF_SUPPORT (1ULL << 6)
38#define RTE_VHOST_USER_ASYNC_COPY (1ULL << 7)
39#define RTE_VHOST_USER_NET_COMPLIANT_OL_FLAGS (1ULL << 8)
40
41/* Features. */
42#ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
43 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
44#endif
45
46#ifndef VIRTIO_NET_F_MQ
47 #define VIRTIO_NET_F_MQ 22
48#endif
49
50#ifndef VIRTIO_NET_F_MTU
51 #define VIRTIO_NET_F_MTU 3
52#endif
53
54#ifndef VIRTIO_F_ANY_LAYOUT
55 #define VIRTIO_F_ANY_LAYOUT 27
56#endif
57
59#ifndef VHOST_USER_PROTOCOL_F_MQ
60#define VHOST_USER_PROTOCOL_F_MQ 0
61#endif
62
63#ifndef VHOST_USER_PROTOCOL_F_LOG_SHMFD
64#define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
65#endif
66
67#ifndef VHOST_USER_PROTOCOL_F_RARP
68#define VHOST_USER_PROTOCOL_F_RARP 2
69#endif
70
71#ifndef VHOST_USER_PROTOCOL_F_REPLY_ACK
72#define VHOST_USER_PROTOCOL_F_REPLY_ACK 3
73#endif
74
75#ifndef VHOST_USER_PROTOCOL_F_NET_MTU
76#define VHOST_USER_PROTOCOL_F_NET_MTU 4
77#endif
78
79#ifndef VHOST_USER_PROTOCOL_F_SLAVE_REQ
80#define VHOST_USER_PROTOCOL_F_SLAVE_REQ 5
81#endif
82
83#ifndef VHOST_USER_PROTOCOL_F_CRYPTO_SESSION
84#define VHOST_USER_PROTOCOL_F_CRYPTO_SESSION 7
85#endif
86
87#ifndef VHOST_USER_PROTOCOL_F_PAGEFAULT
88#define VHOST_USER_PROTOCOL_F_PAGEFAULT 8
89#endif
90
91#ifndef VHOST_USER_PROTOCOL_F_CONFIG
92#define VHOST_USER_PROTOCOL_F_CONFIG 9
93#endif
94
95#ifndef VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD
96#define VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD 10
97#endif
98
99#ifndef VHOST_USER_PROTOCOL_F_HOST_NOTIFIER
100#define VHOST_USER_PROTOCOL_F_HOST_NOTIFIER 11
101#endif
102
103#ifndef VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD
104#define VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD 12
105#endif
106
107#ifndef VHOST_USER_PROTOCOL_F_STATUS
108#define VHOST_USER_PROTOCOL_F_STATUS 16
109#endif
110
112#ifndef VHOST_USER_F_PROTOCOL_FEATURES
113#define VHOST_USER_F_PROTOCOL_FEATURES 30
114#endif
115
116struct rte_vdpa_device;
117
123 uint64_t guest_phys_addr;
124 uint64_t guest_user_addr;
125 uint64_t host_user_addr;
126 uint64_t size;
127 void *mmap_addr;
128 uint64_t mmap_size;
129 int fd;
130};
131
136 uint32_t nregions;
137 struct rte_vhost_mem_region regions[];
138};
139
140struct rte_vhost_inflight_desc_split {
141 uint8_t inflight;
142 uint8_t padding[5];
143 uint16_t next;
144 uint64_t counter;
145};
146
147struct rte_vhost_inflight_info_split {
148 uint64_t features;
149 uint16_t version;
150 uint16_t desc_num;
151 uint16_t last_inflight_io;
152 uint16_t used_idx;
153 struct rte_vhost_inflight_desc_split desc[0];
154};
155
156struct rte_vhost_inflight_desc_packed {
157 uint8_t inflight;
158 uint8_t padding;
159 uint16_t next;
160 uint16_t last;
161 uint16_t num;
162 uint64_t counter;
163 uint16_t id;
164 uint16_t flags;
165 uint32_t len;
166 uint64_t addr;
167};
168
169struct rte_vhost_inflight_info_packed {
170 uint64_t features;
171 uint16_t version;
172 uint16_t desc_num;
173 uint16_t free_head;
174 uint16_t old_free_head;
175 uint16_t used_idx;
176 uint16_t old_used_idx;
177 uint8_t used_wrap_counter;
178 uint8_t old_used_wrap_counter;
179 uint8_t padding[7];
180 struct rte_vhost_inflight_desc_packed desc[0];
181};
182
183struct rte_vhost_resubmit_desc {
184 uint16_t index;
185 uint64_t counter;
186};
187
188struct rte_vhost_resubmit_info {
189 struct rte_vhost_resubmit_desc *resubmit_list;
190 uint16_t resubmit_num;
191};
192
193struct rte_vhost_ring_inflight {
194 union {
195 struct rte_vhost_inflight_info_split *inflight_split;
196 struct rte_vhost_inflight_info_packed *inflight_packed;
197 };
198
199 struct rte_vhost_resubmit_info *resubmit_inflight;
200};
201
202struct rte_vhost_vring {
203 union {
204 struct vring_desc *desc;
205 struct vring_packed_desc *desc_packed;
206 };
207 union {
208 struct vring_avail *avail;
209 struct vring_packed_desc_event *driver_event;
210 };
211 union {
212 struct vring_used *used;
213 struct vring_packed_desc_event *device_event;
214 };
215 uint64_t log_guest_addr;
216
218 int callfd;
219
220 int kickfd;
221 uint16_t size;
222};
223
228 /* Message handling failed */
229 RTE_VHOST_MSG_RESULT_ERR = -1,
230 /* Message handling successful */
231 RTE_VHOST_MSG_RESULT_OK = 0,
232 /* Message handling successful and reply prepared */
233 RTE_VHOST_MSG_RESULT_REPLY = 1,
234 /* Message not handled */
235 RTE_VHOST_MSG_RESULT_NOT_HANDLED,
236};
237
252typedef enum rte_vhost_msg_result (*rte_vhost_msg_handle)(int vid, void *msg);
253
258 /* Called prior to the master message handling. */
259 rte_vhost_msg_handle pre_msg_handle;
260 /* Called after the master message handling. */
261 rte_vhost_msg_handle post_msg_handle;
262};
263
268 int (*new_device)(int vid);
269 void (*destroy_device)(int vid);
271 int (*vring_state_changed)(int vid, uint16_t queue_id, int enable);
279 int (*features_changed)(int vid, uint64_t features);
280
281 int (*new_connection)(int vid);
282 void (*destroy_connection)(int vid);
283
290 void (*guest_notified)(int vid);
291
292 void *reserved[1];
293};
294
300 volatile void *addr;
305 uint64_t val;
307 uint64_t mask;
311 uint8_t size;
317 uint8_t match;
318};
319
335__rte_deprecated
336static __rte_always_inline uint64_t
337rte_vhost_gpa_to_vva(struct rte_vhost_memory *mem, uint64_t gpa)
338{
339 struct rte_vhost_mem_region *reg;
340 uint32_t i;
341
342 for (i = 0; i < mem->nregions; i++) {
343 reg = &mem->regions[i];
344 if (gpa >= reg->guest_phys_addr &&
345 gpa < reg->guest_phys_addr + reg->size) {
346 return gpa - reg->guest_phys_addr +
347 reg->host_user_addr;
348 }
349 }
350
351 return 0;
352}
353
370static __rte_always_inline uint64_t
372 uint64_t gpa, uint64_t *len)
373{
374 struct rte_vhost_mem_region *r;
375 uint32_t i;
376
377 for (i = 0; i < mem->nregions; i++) {
378 r = &mem->regions[i];
379 if (gpa >= r->guest_phys_addr &&
380 gpa < r->guest_phys_addr + r->size) {
381
382 if (unlikely(*len > r->guest_phys_addr + r->size - gpa))
383 *len = r->guest_phys_addr + r->size - gpa;
384
385 return gpa - r->guest_phys_addr +
386 r->host_user_addr;
387 }
388 }
389 *len = 0;
390
391 return 0;
392}
393
394#define RTE_VHOST_NEED_LOG(features) ((features) & (1ULL << VHOST_F_LOG_ALL))
395
414void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len);
415
434void rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
435 uint64_t offset, uint64_t len);
436
437int rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable);
438
443int rte_vhost_driver_register(const char *path, uint64_t flags);
444
445/* Unregister vhost driver. This is only meaningful to vhost user. */
446int rte_vhost_driver_unregister(const char *path);
447
458int
460 struct rte_vdpa_device *dev);
461
470int
472
481struct rte_vdpa_device *
483
494int rte_vhost_driver_set_features(const char *path, uint64_t features);
495
511int rte_vhost_driver_enable_features(const char *path, uint64_t features);
512
525int rte_vhost_driver_disable_features(const char *path, uint64_t features);
526
537int rte_vhost_driver_get_features(const char *path, uint64_t *features);
538
549int
551 uint64_t protocol_features);
552
563int
565 uint64_t *protocol_features);
566
577int
578rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num);
579
590int rte_vhost_get_negotiated_features(int vid, uint64_t *features);
591
602__rte_experimental
603int
605 uint64_t *protocol_features);
606
607/* Register callbacks. */
608int rte_vhost_driver_callback_register(const char *path,
609 struct rte_vhost_device_ops const * const ops);
610
622int rte_vhost_driver_start(const char *path);
623
637int rte_vhost_get_mtu(int vid, uint16_t *mtu);
638
650
665__rte_deprecated
666uint32_t rte_vhost_get_queue_num(int vid);
667
677uint16_t rte_vhost_get_vring_num(int vid);
678
693int rte_vhost_get_ifname(int vid, char *buf, size_t len);
694
706uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id);
707
708struct rte_mbuf;
709struct rte_mempool;
726uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
727 struct rte_mbuf **pkts, uint16_t count);
728
746uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
747 struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
748
763int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem);
764
777int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
778 struct rte_vhost_vring *vring);
779
792int
793rte_vhost_get_vhost_ring_inflight(int vid, uint16_t vring_idx,
794 struct rte_vhost_ring_inflight *vring);
795
811int
812rte_vhost_set_inflight_desc_split(int vid, uint16_t vring_idx,
813 uint16_t idx);
814
833int
834rte_vhost_set_inflight_desc_packed(int vid, uint16_t vring_idx,
835 uint16_t head, uint16_t last, uint16_t *inflight_entry);
836
849int
851 uint16_t vring_idx, uint16_t idx);
852
868int
870 uint16_t vring_idx, uint16_t head);
871
886int
887rte_vhost_clr_inflight_desc_split(int vid, uint16_t vring_idx,
888 uint16_t last_used_idx, uint16_t idx);
889
902int
903rte_vhost_clr_inflight_desc_packed(int vid, uint16_t vring_idx,
904 uint16_t head);
905
917int rte_vhost_vring_call(int vid, uint16_t vring_idx);
918
929uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid);
930
943__rte_experimental
944int
945rte_vhost_get_monitor_addr(int vid, uint16_t queue_id,
946 struct rte_vhost_power_monitor_cond *pmc);
947
960int
961rte_vhost_get_log_base(int vid, uint64_t *log_base, uint64_t *log_size);
962
977int
978rte_vhost_get_vring_base(int vid, uint16_t queue_id,
979 uint16_t *last_avail_idx, uint16_t *last_used_idx);
980
999int
1001 uint16_t queue_id, uint16_t *last_avail_idx, uint16_t *last_used_idx);
1002
1017int
1018rte_vhost_set_vring_base(int vid, uint16_t queue_id,
1019 uint16_t last_avail_idx, uint16_t last_used_idx);
1020
1033int
1035 struct rte_vhost_user_extern_ops const * const ops, void *ctx);
1036
1045struct rte_vdpa_device *
1047
1058__rte_experimental
1059int
1060rte_vhost_slave_config_change(int vid, bool need_reply);
1061
1062#ifdef __cplusplus
1063}
1064#endif
1065
1066#endif /* _RTE_VHOST_H_ */
#define unlikely(x)
#define __rte_always_inline
Definition: rte_common.h:228
int rte_vhost_get_vhost_ring_inflight(int vid, uint16_t vring_idx, struct rte_vhost_ring_inflight *vring)
uint16_t rte_vhost_get_vring_num(int vid)
__rte_experimental int rte_vhost_slave_config_change(int vid, bool need_reply)
uint32_t rte_vhost_rx_queue_count(int vid, uint16_t qid)
rte_vhost_msg_result
Definition: rte_vhost.h:227
int rte_vhost_get_ifname(int vid, char *buf, size_t len)
int rte_vhost_set_inflight_desc_split(int vid, uint16_t vring_idx, uint16_t idx)
int rte_vhost_get_negotiated_features(int vid, uint64_t *features)
int rte_vhost_get_mtu(int vid, uint16_t *mtu)
__rte_experimental int rte_vhost_get_monitor_addr(int vid, uint16_t queue_id, struct rte_vhost_power_monitor_cond *pmc)
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_get_mem_table(int vid, struct rte_vhost_memory **mem)
__rte_experimental int rte_vhost_get_negotiated_protocol_features(int vid, uint64_t *protocol_features)
int rte_vhost_get_vring_base(int vid, uint16_t queue_id, uint16_t *last_avail_idx, uint16_t *last_used_idx)
int rte_vhost_driver_set_features(const char *path, uint64_t features)
uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id)
int rte_vhost_driver_set_protocol_features(const char *path, uint64_t protocol_features)
int rte_vhost_set_last_inflight_io_split(int vid, uint16_t vring_idx, uint16_t idx)
int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx, struct rte_vhost_vring *vring)
struct rte_vdpa_device * rte_vhost_get_vdpa_device(int vid)
int rte_vhost_driver_attach_vdpa_device(const char *path, struct rte_vdpa_device *dev)
void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len)
int rte_vhost_get_numa_node(int vid)
int rte_vhost_driver_start(const char *path)
int rte_vhost_driver_register(const char *path, uint64_t flags)
enum rte_vhost_msg_result(* rte_vhost_msg_handle)(int vid, void *msg)
Definition: rte_vhost.h:252
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_driver_get_protocol_features(const char *path, uint64_t *protocol_features)
int rte_vhost_vring_call(int vid, uint16_t vring_idx)
__rte_deprecated uint32_t rte_vhost_get_queue_num(int vid)
struct rte_vdpa_device * rte_vhost_driver_get_vdpa_device(const char *path)
uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id, struct rte_mbuf **pkts, uint16_t count)
int rte_vhost_driver_enable_features(const char *path, uint64_t features)
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:337
int rte_vhost_set_inflight_desc_packed(int vid, uint16_t vring_idx, uint16_t head, uint16_t last, uint16_t *inflight_entry)
void rte_vhost_log_used_vring(int vid, uint16_t vring_idx, uint64_t offset, uint64_t len)
int rte_vhost_set_last_inflight_io_packed(int vid, uint16_t vring_idx, uint16_t head)
int rte_vhost_get_vring_base_from_inflight(int vid, uint16_t queue_id, uint16_t *last_avail_idx, uint16_t *last_used_idx)
int rte_vhost_clr_inflight_desc_packed(int vid, uint16_t vring_idx, uint16_t head)
int rte_vhost_driver_get_features(const char *path, uint64_t *features)
int rte_vhost_get_log_base(int vid, uint64_t *log_base, uint64_t *log_size)
int rte_vhost_extern_callback_register(int vid, struct rte_vhost_user_extern_ops const *const ops, void *ctx)
int rte_vhost_driver_detach_vdpa_device(const char *path)
int rte_vhost_driver_get_queue_num(const char *path, uint32_t *queue_num)
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:371
int rte_vhost_driver_disable_features(const char *path, uint64_t features)
int rte_vhost_clr_inflight_desc_split(int vid, uint16_t vring_idx, uint16_t last_used_idx, uint16_t idx)
int(* vring_state_changed)(int vid, uint16_t queue_id, int enable)
Definition: rte_vhost.h:271
int(* new_device)(int vid)
Definition: rte_vhost.h:268
void * reserved[1]
Definition: rte_vhost.h:292
int(* features_changed)(int vid, uint64_t features)
Definition: rte_vhost.h:279
void(* destroy_device)(int vid)
Definition: rte_vhost.h:269
void(* guest_notified)(int vid)
Definition: rte_vhost.h:290