FD.io VPP  v18.11-rc0-18-g2a3fb1a
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 suppport 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 DBG_SOCK(args...) \
49  { \
50  vhost_user_main_t *_vum = &vhost_user_main; \
51  if (_vum->debug) \
52  clib_warning(args); \
53  };
54 
55 #define VHOST_DEBUG_VQ 0
56 
57 #if VHOST_DEBUG_VQ == 1
58 #define DBG_VQ(args...) clib_warning(args);
59 #else
60 #define DBG_VQ(args...)
61 #endif
62 
63 #define UNIX_GET_FD(unixfd_idx) ({ \
64  typeof(unixfd_idx) __unixfd_idx = (unixfd_idx); \
65  (__unixfd_idx != ~0) ? \
66  pool_elt_at_index (file_main.file_pool, \
67  __unixfd_idx)->file_descriptor : -1; })
68 
69 #define foreach_virtio_trace_flags \
70  _ (SIMPLE_CHAINED, 0, "Simple descriptor chaining") \
71  _ (SINGLE_DESC, 1, "Single descriptor packet") \
72  _ (INDIRECT, 2, "Indirect descriptor") \
73  _ (MAP_ERROR, 4, "Memory mapping error")
74 
75 typedef enum
76 {
77 #define _(n,i,s) VIRTIO_TRACE_F_##n,
79 #undef _
81 
82 #define foreach_virtio_net_feature \
83  _ (VIRTIO_NET_F_MRG_RXBUF, 15) \
84  _ (VIRTIO_NET_F_CTRL_VQ, 17) \
85  _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21) \
86  _ (VIRTIO_NET_F_MQ, 22) \
87  _ (VHOST_F_LOG_ALL, 26) \
88  _ (VIRTIO_F_ANY_LAYOUT, 27) \
89  _ (VIRTIO_F_INDIRECT_DESC, 28) \
90  _ (VHOST_USER_F_PROTOCOL_FEATURES, 30) \
91  _ (VIRTIO_F_VERSION_1, 32)
92 
93 typedef enum
94 {
95 #define _(f,n) FEAT_##f = (n),
97 #undef _
99 
101  const char *sock_filename, u8 is_server,
102  u32 * sw_if_index, u64 feature_mask,
103  u8 renumber, u32 custom_dev_instance, u8 * hwaddr);
105  const char *sock_filename, u8 is_server,
106  u32 sw_if_index, u64 feature_mask,
107  u8 renumber, u32 custom_dev_instance);
109  u32 sw_if_index);
111 /* *INDENT-OFF* */
113 {
118 } __attribute ((packed)) vhost_user_memory_region_t;
119 
120 typedef struct vhost_user_memory
121 {
124  vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
125 } __attribute ((packed)) vhost_user_memory_t;
126 
127 typedef struct
128 {
129  u32 index, num;
130 } __attribute ((packed)) vhost_vring_state_t;
131 
132 typedef struct
133 {
134  u32 index, flags;
135  u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
136 } __attribute ((packed)) vhost_vring_addr_t;
137 
138 typedef struct vhost_user_log
139 {
142 } __attribute ((packed)) vhost_user_log_t;
143 
144 typedef enum vhost_user_req
145 {
167 
168 // vring_desc I/O buffer descriptor
169 typedef struct
170 {
171  uint64_t addr; // packet data buffer address
172  uint32_t len; // packet data buffer size
173  uint16_t flags; // (see below)
174  uint16_t next; // optional index next descriptor in chain
175 } __attribute ((packed)) vring_desc_t;
176 
177 typedef struct
178 {
179  uint16_t flags;
180  volatile uint16_t idx;
181  uint16_t ring[VHOST_VRING_MAX_SIZE];
182 } __attribute ((packed)) vring_avail_t;
183 
184 typedef struct
185 {
186  uint16_t flags;
187  uint16_t idx;
188  struct /* vring_used_elem */
189  {
190  uint32_t id;
191  uint32_t len;
192  } ring[VHOST_VRING_MAX_SIZE];
193 } __attribute ((packed)) vring_used_t;
194 
195 typedef struct
196 {
197  u8 flags;
198  u8 gso_type;
199  u16 hdr_len;
200  u16 gso_size;
201  u16 csum_start;
202  u16 csum_offset;
203 } __attribute ((packed)) virtio_net_hdr_t;
204 
205 typedef struct {
206  virtio_net_hdr_t hdr;
207  u16 num_buffers;
208 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
209 
210 typedef struct vhost_user_msg {
211  vhost_user_req_t request;
214  union
215  {
217  vhost_vring_state_t state;
218  vhost_vring_addr_t addr;
219  vhost_user_memory_t memory;
220  vhost_user_log_t log;
221  };
222 } __attribute ((packed)) vhost_user_msg_t;
223 /* *INDENT-ON* */
224 
225 typedef struct
226 {
227  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
232  vring_desc_t *desc;
233  vring_avail_t *avail;
234  vring_used_t *used;
239  //Put non-runtime in a different cache line
240  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
241  int errfd;
245 
246  /* The rx queue policy (interrupt/adaptive/polling) for this queue */
249 
250 #define VHOST_USER_EVENT_START_TIMER 1
251 #define VHOST_USER_EVENT_STOP_TIMER 2
252 
253 typedef struct
254 {
255  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
260  char sock_filename[256];
263  u32 hw_if_index, sw_if_index;
264 
265  //Feature negotiation
269 
270  //Memory region information
272  vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
273  void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
274  u64 region_guest_addr_lo[VHOST_MEMORY_MAX_NREGIONS];
275  u64 region_guest_addr_hi[VHOST_MEMORY_MAX_NREGIONS];
277 
278  //Virtual rings
280  volatile u32 *vring_locks[VHOST_VRING_MAX_N];
281 
284 
287 
288  /* Whether to use spinlock or per_cpu_tx_qid assignment */
291 
292  /* Vector of active rx queues for this interface */
295 
296 typedef struct
297 {
301 } vhost_copy_t;
302 
303 typedef struct
304 {
305  u16 qid; /** The interface queue index (Not the virtio vring idx) */
306  u16 device_index; /** The device index */
307  u32 virtio_ring_flags; /** Runtime queue flags **/
308  u16 first_desc_len; /** Length of the first data descriptor **/
309  virtio_net_hdr_mrg_rxbuf_t hdr; /** Virtio header **/
310 } vhost_trace_t;
311 
312 
313 #define VHOST_USER_RX_BUFFERS_N (2 * VLIB_FRAME_SIZE + 2)
314 #define VHOST_USER_COPY_ARRAY_N (4 * VLIB_FRAME_SIZE)
315 
316 typedef struct
317 {
320 
321  virtio_net_hdr_mrg_rxbuf_t tx_headers[VLIB_FRAME_SIZE];
323 
324  /* This is here so it doesn't end-up
325  * using stack or registers. */
327 } vhost_cpu_t;
328 
329 typedef struct
330 {
338 
339  /** Per-CPU data for vhost-user */
341 
342  /** Pseudo random iterator */
344 
345  /* The number of rx interface/queue pairs in interrupt mode */
347 
348  /* debug on or off */
351 
352 typedef struct
353 {
354  u8 if_name[64];
359  u8 sock_filename[256];
363 
365  vhost_user_intf_details_t ** out_vuids);
366 
371 
372 #endif
373 
374 /*
375  * fd.io coding-style-patch-verification: ON
376  *
377  * Local Variables:
378  * eval: (c-set-style "gnu")
379  * End:
380  */
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)
Definition: vhost_user.c:1478
Definition: mhash.h:46
virtio_net_feature_t
Definition: vhost_user.h:93
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:63
vring_desc_t * desc
Definition: vhost_user.h:232
vhost_user_log_t log
Definition: vhost_user.h:220
u32 virtio_ring_flags
The device index.
Definition: vhost_user.h:307
virtio_net_hdr_mrg_rxbuf_t hdr
Length of the first data descriptor.
Definition: vhost_user.h:309
vhost_cpu_t * cpus
Per-CPU data for vhost-user.
Definition: vhost_user.h:340
#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:1641
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:233
vnet_device_class_t vhost_user_device_class
vhost_vring_state_t state
Definition: vhost_user.h:217
#define foreach_virtio_trace_flags
Definition: vhost_user.h:69
struct _vnet_device_class vnet_device_class_t
vring_used_t * used
Definition: vhost_user.h:234
vhost_vring_addr_t addr
Definition: vhost_user.h:116
vhost_trace_t * current_trace
Definition: vhost_user.h:326
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:1204
double f64
Definition: types.h:142
void * log_base_addr
Definition: vhost_user.h:285
unsigned int u32
Definition: types.h:88
#define VLIB_FRAME_SIZE
Definition: node.h:364
#define VHOST_USER_COPY_ARRAY_N
Definition: vhost_user.h:314
u32 random
Pseudo random iterator.
Definition: vhost_user.h:343
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:75
vhost_vring_addr_t addr
Definition: vhost_user.h:218
vlib_node_registration_t vhost_user_send_interrupt_node
(constructor) VLIB_REGISTER_NODE (vhost_user_send_interrupt_node)
Definition: vhost_user.c:53
u32 flags
Definition: vhost_user.h:110
u32 * show_dev_instance_by_real_dev_instance
Definition: vhost_user.h:334
u16 device_index
The interface queue index (Not the virtio vring idx)
Definition: vhost_user.h:306
vhost_user_intf_t * vhost_user_interfaces
Definition: vhost_user.h:333
vlib_main_t * vm
Definition: buffer.c:294
vhost_user_req
Definition: vhost_user.h:144
u16 first_desc_len
Runtime queue flags.
Definition: vhost_user.h:308
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)
Definition: vhost_user.c:1420
#define VHOST_USER_RX_BUFFERS_N
Definition: vhost_user.h:313
#define foreach_virtio_net_feature
Definition: vhost_user.h:82
vhost_user_main_t vhost_user_main
Definition: vhost_user.c:56
mhash_t if_index_by_sock_name
Definition: vhost_user.h:331
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:318
vhost_user_memory_t memory
Definition: vhost_user.h:219
vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS]
Definition: vhost_user.h:111
vhost_user_req_t request
Definition: vhost_user.h:211
int dont_dump_vhost_user_memory
Definition: vhost_user.h:337