FD.io VPP  v20.01-46-g7006026de
Vector Packet Processing
vhost_user.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #ifndef __VIRTIO_VHOST_USER_H__
16 #define __VIRTIO_VHOST_USER_H__
17 /* vhost-user data structures */
18 
19 #define VHOST_MEMORY_MAX_NREGIONS 8
20 #define VHOST_USER_MSG_HDR_SZ 12
21 #define VHOST_VRING_MAX_SIZE 32768
22 #define VHOST_VRING_MAX_N 16 //8TX + 8RX
23 #define VHOST_VRING_IDX_RX(qid) (2*qid)
24 #define VHOST_VRING_IDX_TX(qid) (2*qid + 1)
25 
26 #define VHOST_USER_VRING_NOFD_MASK 0x100
27 #define VIRTQ_DESC_F_NEXT 1
28 #define VIRTQ_DESC_F_INDIRECT 4
29 #define VHOST_USER_REPLY_MASK (0x1 << 2)
30 
31 #define VHOST_USER_PROTOCOL_F_MQ 0
32 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
33 #define VHOST_VRING_F_LOG 0
34 
35 #define VHOST_USER_F_PROTOCOL_FEATURES 30
36 #define VHOST_USER_PROTOCOL_FEATURES ((1ULL << VHOST_USER_PROTOCOL_F_MQ) | \
37  (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD))
38 
39 /* If multiqueue is provided by host, then we support it. */
40 #define VIRTIO_NET_CTRL_MQ 4
41 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0
42 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1
43 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000
44 
45 #define VRING_USED_F_NO_NOTIFY 1
46 #define VRING_AVAIL_F_NO_INTERRUPT 1
47 
48 #define vu_log_debug(dev, f, ...) \
49 { \
50  vlib_log(VLIB_LOG_LEVEL_DEBUG, vhost_user_main.log_default, "%U: " f, \
51  format_vnet_hw_if_index_name, vnet_get_main(), \
52  dev->hw_if_index, ##__VA_ARGS__); \
53 };
54 
55 #define vu_log_warn(dev, f, ...) \
56 { \
57  vlib_log(VLIB_LOG_LEVEL_WARNING, vhost_user_main.log_default, "%U: " f, \
58  format_vnet_hw_if_index_name, vnet_get_main(), \
59  dev->hw_if_index, ##__VA_ARGS__); \
60 };
61 #define vu_log_err(dev, f, ...) \
62 { \
63  vlib_log(VLIB_LOG_LEVEL_ERR, vhost_user_main.log_default, "%U: " f, \
64  format_vnet_hw_if_index_name, vnet_get_main(), \
65  dev->hw_if_index, ##__VA_ARGS__); \
66 };
67 
68 #define UNIX_GET_FD(unixfd_idx) ({ \
69  typeof(unixfd_idx) __unixfd_idx = (unixfd_idx); \
70  (__unixfd_idx != ~0) ? \
71  pool_elt_at_index (file_main.file_pool, \
72  __unixfd_idx)->file_descriptor : -1; })
73 
74 #define foreach_virtio_trace_flags \
75  _ (SIMPLE_CHAINED, 0, "Simple descriptor chaining") \
76  _ (SINGLE_DESC, 1, "Single descriptor packet") \
77  _ (INDIRECT, 2, "Indirect descriptor") \
78  _ (MAP_ERROR, 4, "Memory mapping error")
79 
80 typedef enum
81 {
82 #define _(n,i,s) VIRTIO_TRACE_F_##n,
84 #undef _
86 
87 #define foreach_virtio_net_feature \
88  _ (VIRTIO_NET_F_CSUM, 0) \
89  _ (VIRTIO_NET_F_GUEST_CSUM, 1) \
90  _ (VIRTIO_NET_F_GUEST_TSO4, 7) \
91  _ (VIRTIO_NET_F_GUEST_TSO6, 8) \
92  _ (VIRTIO_NET_F_GUEST_UFO, 10) \
93  _ (VIRTIO_NET_F_HOST_TSO4, 11) \
94  _ (VIRTIO_NET_F_HOST_TSO6, 12) \
95  _ (VIRTIO_NET_F_HOST_UFO, 14) \
96  _ (VIRTIO_NET_F_MRG_RXBUF, 15) \
97  _ (VIRTIO_NET_F_CTRL_VQ, 17) \
98  _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21) \
99  _ (VIRTIO_NET_F_MQ, 22) \
100  _ (VHOST_F_LOG_ALL, 26) \
101  _ (VIRTIO_F_ANY_LAYOUT, 27) \
102  _ (VIRTIO_F_INDIRECT_DESC, 28) \
103  _ (VHOST_USER_F_PROTOCOL_FEATURES, 30) \
104  _ (VIRTIO_F_VERSION_1, 32)
105 
106 typedef enum
107 {
108 #define _(f,n) FEAT_##f = (n),
110 #undef _
112 
113 #define FEATURE_VIRTIO_NET_F_HOST_TSO_FEATURE_BITS \
114  ((1ULL << FEAT_VIRTIO_NET_F_CSUM) | \
115  (1ULL << FEAT_VIRTIO_NET_F_HOST_UFO) | \
116  (1ULL << FEAT_VIRTIO_NET_F_HOST_TSO4) | \
117  (1ULL << FEAT_VIRTIO_NET_F_HOST_TSO6))
118 
119 #define FEATURE_VIRTIO_NET_F_GUEST_TSO_FEATURE_BITS \
120  ((1ULL << FEAT_VIRTIO_NET_F_GUEST_CSUM) | \
121  (1ULL << FEAT_VIRTIO_NET_F_GUEST_UFO) | \
122  (1ULL << FEAT_VIRTIO_NET_F_GUEST_TSO4) | \
123  (1ULL << FEAT_VIRTIO_NET_F_GUEST_TSO6))
124 
125 #define FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS \
126  (FEATURE_VIRTIO_NET_F_HOST_TSO_FEATURE_BITS | \
127  FEATURE_VIRTIO_NET_F_GUEST_TSO_FEATURE_BITS)
128 
130  const char *sock_filename, u8 is_server,
131  u32 * sw_if_index, u64 feature_mask,
132  u8 renumber, u32 custom_dev_instance, u8 * hwaddr,
133  u8 enable_gso);
135  const char *sock_filename, u8 is_server,
136  u32 sw_if_index, u64 feature_mask,
137  u8 renumber, u32 custom_dev_instance,
138  u8 enable_gso);
142 /* *INDENT-OFF* */
144 {
149 } __attribute ((packed)) vhost_user_memory_region_t;
150 
151 typedef struct vhost_user_memory
152 {
155  vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
156 } __attribute ((packed)) vhost_user_memory_t;
157 
158 typedef struct
159 {
160  u32 index, num;
161 } __attribute ((packed)) vhost_vring_state_t;
162 
163 typedef struct
164 {
165  u32 index, flags;
166  u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
167 } __attribute ((packed)) vhost_vring_addr_t;
168 
169 typedef struct vhost_user_log
170 {
173 } __attribute ((packed)) vhost_user_log_t;
174 
175 typedef enum vhost_user_req
176 {
198 
199 // vring_desc I/O buffer descriptor
200 typedef struct
201 {
202  uint64_t addr; // packet data buffer address
203  uint32_t len; // packet data buffer size
204  uint16_t flags; // (see below)
205  uint16_t next; // optional index next descriptor in chain
206 } __attribute ((packed)) vring_desc_t;
207 
208 typedef struct
209 {
210  uint16_t flags;
211  volatile uint16_t idx;
212  uint16_t ring[VHOST_VRING_MAX_SIZE];
213 } __attribute ((packed)) vring_avail_t;
214 
215 typedef struct
216 {
217  uint16_t flags;
218  uint16_t idx;
219  struct /* vring_used_elem */
220  {
221  uint32_t id;
222  uint32_t len;
223  } ring[VHOST_VRING_MAX_SIZE];
224 } __attribute ((packed)) vring_used_t;
225 
226 typedef struct
227 {
228  u8 flags;
229  u8 gso_type;
230  u16 hdr_len;
231  u16 gso_size;
232  u16 csum_start;
233  u16 csum_offset;
234 } __attribute ((packed)) virtio_net_hdr_t;
235 
236 typedef struct {
237  virtio_net_hdr_t hdr;
238  u16 num_buffers;
239 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
240 
241 typedef struct vhost_user_msg {
242  vhost_user_req_t request;
245  union
246  {
248  vhost_vring_state_t state;
249  vhost_vring_addr_t addr;
250  vhost_user_memory_t memory;
251  vhost_user_log_t log;
252  };
253 } __attribute ((packed)) vhost_user_msg_t;
254 /* *INDENT-ON* */
255 
256 typedef struct
257 {
258  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
273  //Put non-runtime in a different cache line
274  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
275  int errfd;
279 
280  /* The rx queue policy (interrupt/adaptive/polling) for this queue */
282 
283  /*
284  * It contains the device queue number. -1 if it does not. The idea is
285  * to not invoke vnet_hw_interface_assign_rx_thread and
286  * vnet_hw_interface_unassign_rx_thread more than once for the duration of
287  * the interface even if it is disconnected and reconnected.
288  */
291 
292 #define VHOST_USER_EVENT_START_TIMER 1
293 #define VHOST_USER_EVENT_STOP_TIMER 2
294 
295 typedef struct
296 {
297  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
302  char sock_filename[256];
305  u32 hw_if_index, sw_if_index;
306 
307  //Feature negotiation
311 
312  //Memory region information
314  vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
315  void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
316  u64 region_guest_addr_lo[VHOST_MEMORY_MAX_NREGIONS];
317  u64 region_guest_addr_hi[VHOST_MEMORY_MAX_NREGIONS];
319 
320  //Virtual rings
322  volatile u32 *vring_locks[VHOST_VRING_MAX_N];
323 
326 
329 
330  /* Whether to use spinlock or per_cpu_tx_qid assignment */
333 
336 
337 typedef struct
338 {
342 } vhost_copy_t;
343 
344 typedef struct
345 {
346  u16 qid; /** The interface queue index (Not the virtio vring idx) */
347  u16 device_index; /** The device index */
348  u32 virtio_ring_flags; /** Runtime queue flags **/
349  u16 first_desc_len; /** Length of the first data descriptor **/
350  virtio_net_hdr_mrg_rxbuf_t hdr; /** Virtio header **/
351 } vhost_trace_t;
352 
353 
354 #define VHOST_USER_RX_BUFFERS_N (2 * VLIB_FRAME_SIZE + 2)
355 #define VHOST_USER_COPY_ARRAY_N (4 * VLIB_FRAME_SIZE)
356 
357 typedef struct
358 {
361 
362  virtio_net_hdr_mrg_rxbuf_t tx_headers[VLIB_FRAME_SIZE];
364 
365  /* This is here so it doesn't end-up
366  * using stack or registers. */
368 } vhost_cpu_t;
369 
370 typedef struct
371 {
379 
380  /** Per-CPU data for vhost-user */
382 
383  /** Pseudo random iterator */
385 
386  /* The number of rx interface/queue pairs in interrupt mode */
388 
389  /* logging */
391 
392  /* gso interface count */
395 
396 typedef struct
397 {
398  u8 if_name[64];
403  u8 sock_filename[256];
407 
409  vhost_user_intf_details_t ** out_vuids);
410 
415 
416 #endif
417 
418 /*
419  * fd.io coding-style-patch-verification: ON
420  *
421  * Local Variables:
422  * eval: (c-set-style "gnu")
423  * End:
424  */
Definition: mhash.h:46
int vhost_user_modify_if(vnet_main_t *vnm, vlib_main_t *vm, const char *sock_filename, u8 is_server, u32 sw_if_index, u64 feature_mask, u8 renumber, u32 custom_dev_instance, u8 enable_gso)
Definition: vhost_user.c:1580
virtio_net_feature_t
Definition: vhost_user.h:106
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
vring_desc_t * desc
Definition: vhost_user.h:263
vhost_user_log_t log
Definition: vhost_user.h:251
u32 virtio_ring_flags
The device index.
Definition: vhost_user.h:348
virtio_net_hdr_mrg_rxbuf_t hdr
Length of the first data descriptor.
Definition: vhost_user.h:350
vhost_cpu_t * cpus
Per-CPU data for vhost-user.
Definition: vhost_user.h:381
#define VHOST_VRING_MAX_SIZE
Definition: vhost_user.h:21
int vhost_user_dump_ifs(vnet_main_t *vnm, vlib_main_t *vm, vhost_user_intf_details_t **out_vuids)
Definition: vhost_user.c:1752
unsigned long u64
Definition: types.h:89
#define VHOST_VRING_MAX_N
Definition: vhost_user.h:22
enum vhost_user_req vhost_user_req_t
vring_avail_t * avail
Definition: vhost_user.h:264
vnet_device_class_t vhost_user_device_class
vhost_vring_state_t state
Definition: vhost_user.h:248
#define foreach_virtio_trace_flags
Definition: vhost_user.h:74
struct _vnet_device_class vnet_device_class_t
vring_used_t * used
Definition: vhost_user.h:265
vhost_vring_addr_t addr
Definition: vhost_user.h:147
vhost_trace_t * current_trace
Definition: vhost_user.h:367
unsigned char u8
Definition: types.h:56
int vhost_user_delete_if(vnet_main_t *vnm, vlib_main_t *vm, u32 sw_if_index)
Definition: vhost_user.c:1282
u8 id[64]
Definition: dhcp.api:160
double f64
Definition: types.h:142
u32 vlib_log_class_t
Definition: vlib.h:51
vl_api_interface_index_t sw_if_index
Definition: gre.api:59
void * log_base_addr
Definition: vhost_user.h:327
unsigned int u32
Definition: types.h:88
#define VLIB_FRAME_SIZE
Definition: node.h:378
#define VHOST_USER_COPY_ARRAY_N
Definition: vhost_user.h:355
u32 random
Pseudo random iterator.
Definition: vhost_user.h:384
vlib_node_registration_t vhost_user_input_node
(constructor) VLIB_REGISTER_NODE (vhost_user_input_node)
unsigned short u16
Definition: types.h:57
virtio_trace_flag_t
Definition: vhost_user.h:80
vhost_vring_addr_t addr
Definition: vhost_user.h:249
vlib_node_registration_t vhost_user_send_interrupt_node
(constructor) VLIB_REGISTER_NODE (vhost_user_send_interrupt_node)
Definition: vhost_user.c:53
vlib_main_t * vm
Definition: in2out_ed.c:1810
vlib_log_class_t log_default
Definition: vhost_user.h:390
u8 len
Definition: ip_types.api:91
u32 * show_dev_instance_by_real_dev_instance
Definition: vhost_user.h:375
u16 device_index
The interface queue index (Not the virtio vring idx)
Definition: vhost_user.h:347
vhost_user_intf_t * vhost_user_interfaces
Definition: vhost_user.h:374
u32 flags
Definition: vhost_user.h:141
vhost_user_req
Definition: vhost_user.h:175
u16 first_desc_len
Runtime queue flags.
Definition: vhost_user.h:349
int vhost_user_create_if(vnet_main_t *vnm, vlib_main_t *vm, const char *sock_filename, u8 is_server, u32 *sw_if_index, u64 feature_mask, u8 renumber, u32 custom_dev_instance, u8 *hwaddr, u8 enable_gso)
Definition: vhost_user.c:1516
#define VHOST_USER_RX_BUFFERS_N
Definition: vhost_user.h:354
#define foreach_virtio_net_feature
Definition: vhost_user.h:87
vhost_user_main_t vhost_user_main
Definition: vhost_user.c:56
mhash_t if_index_by_sock_name
Definition: vhost_user.h:372
struct _vlib_node_registration vlib_node_registration_t
u64 uword
Definition: types.h:112
#define VHOST_MEMORY_MAX_NREGIONS
Definition: vhost_user.h:19
u32 rx_buffers_len
Definition: vhost_user.h:359
vhost_user_memory_t memory
Definition: vhost_user.h:250
vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS]
Definition: vhost_user.h:142
vhost_user_req_t request
Definition: vhost_user.h:242
int dont_dump_vhost_user_memory
Definition: vhost_user.h:378
signed short i16
Definition: types.h:46