FD.io VPP  v17.01-9-ge7dcee4
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 VIRTQ_DESC_F_NEXT 1
27 #define VIRTQ_DESC_F_INDIRECT 4
28 #define VHOST_USER_REPLY_MASK (0x1 << 2)
29 
30 #define VHOST_USER_PROTOCOL_F_MQ 0
31 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
32 #define VHOST_VRING_F_LOG 0
33 
34 #define VHOST_USER_F_PROTOCOL_FEATURES 30
35 #define VHOST_USER_PROTOCOL_FEATURES ((1ULL << VHOST_USER_PROTOCOL_F_MQ) | \
36  (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD))
37 
38 /* If multiqueue is provided by host, then we suppport it. */
39 #define VIRTIO_NET_CTRL_MQ 4
40 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET 0
41 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN 1
42 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX 0x8000
43 
44 #define VRING_USED_F_NO_NOTIFY 1
45 
46 #define foreach_virtio_net_feature \
47  _ (VIRTIO_NET_F_MRG_RXBUF, 15) \
48  _ (VIRTIO_NET_F_CTRL_VQ, 17) \
49  _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21) \
50  _ (VIRTIO_NET_F_MQ, 22) \
51  _ (VHOST_F_LOG_ALL, 26) \
52  _ (VIRTIO_F_ANY_LAYOUT, 27) \
53  _ (VIRTIO_F_INDIRECT_DESC, 28) \
54  _ (VHOST_USER_F_PROTOCOL_FEATURES, 30) \
55  _ (VIRTIO_F_VERSION_1, 32)
56 
57 
58 typedef enum
59 {
60 #define _(f,n) FEAT_##f = (n),
62 #undef _
64 
66  const char *sock_filename, u8 is_server,
67  u32 * sw_if_index, u64 feature_mask,
68  u8 renumber, u32 custom_dev_instance, u8 * hwaddr);
70  const char *sock_filename, u8 is_server,
71  u32 sw_if_index, u64 feature_mask,
72  u8 renumber, u32 custom_dev_instance);
74  u32 sw_if_index);
75 
76 /* *INDENT-OFF* */
78 {
83 } __attribute ((packed)) vhost_user_memory_region_t;
84 
85 typedef struct vhost_user_memory
86 {
89  vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
90 } __attribute ((packed)) vhost_user_memory_t;
91 
92 typedef struct
93 {
94  u32 index, num;
95 } __attribute ((packed)) vhost_vring_state_t;
96 
97 typedef struct
98 {
99  u32 index, flags;
100  u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
101 } __attribute ((packed)) vhost_vring_addr_t;
102 
103 typedef struct vhost_user_log
104 {
107 } __attribute ((packed)) vhost_user_log_t;
108 
109 typedef enum vhost_user_req
110 {
132 
133 // vring_desc I/O buffer descriptor
134 typedef struct
135 {
136  uint64_t addr; // packet data buffer address
137  uint32_t len; // packet data buffer size
138  uint16_t flags; // (see below)
139  uint16_t next; // optional index next descriptor in chain
140 } __attribute ((packed)) vring_desc_t;
141 
142 typedef struct
143 {
144  uint16_t flags;
145  volatile uint16_t idx;
146  uint16_t ring[VHOST_VRING_MAX_SIZE];
147 } __attribute ((packed)) vring_avail_t;
148 
149 typedef struct
150 {
151  uint16_t flags;
152  uint16_t idx;
153  struct /* vring_used_elem */
154  {
155  uint32_t id;
156  uint32_t len;
157  } ring[VHOST_VRING_MAX_SIZE];
158 } __attribute ((packed)) vring_used_t;
159 
160 typedef struct
161 {
162  u8 flags;
163  u8 gso_type;
164  u16 hdr_len;
165  u16 gso_size;
166  u16 csum_start;
167  u16 csum_offset;
168 } __attribute ((packed)) virtio_net_hdr_t;
169 
170 typedef struct {
171  virtio_net_hdr_t hdr;
172  u16 num_buffers;
173 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
174 
175 typedef struct vhost_user_msg {
176  vhost_user_req_t request;
179  union
180  {
182  vhost_vring_state_t state;
183  vhost_vring_addr_t addr;
184  vhost_user_memory_t memory;
185  vhost_user_log_t log;
186  };
187 } __attribute ((packed)) vhost_user_msg_t;
188 /* *INDENT-ON* */
189 
190 typedef struct
191 {
192  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
197  vring_desc_t *desc;
198  vring_avail_t *avail;
199  vring_used_t *used;
204  //Put non-runtime in a different cache line
205  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
206  int errfd;
211 
212 typedef struct
213 {
214  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
219  char sock_filename[256];
221  u32 hw_if_index, sw_if_index;
222 
223  //Feature negotiation
227 
228  //Memory region information
230  vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
231  void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
232  u64 region_guest_addr_lo[VHOST_MEMORY_MAX_NREGIONS];
233  u64 region_guest_addr_hi[VHOST_MEMORY_MAX_NREGIONS];
235 
236  //Virtual rings
238  volatile u32 *vring_locks[VHOST_VRING_MAX_N];
239 
242 
245 
246  /* Whether to use spinlock or per_cpu_tx_qid assignment */
249 
250  /* Vector of workers for this interface */
253 
254 typedef struct
255 {
259 
260 typedef struct
261 {
265 } vhost_copy_t;
266 
267 typedef struct
268 {
269  u16 qid; /** The interface queue index (Not the virtio vring idx) */
270  u16 device_index; /** The device index */
271  u32 virtio_ring_flags; /** Runtime queue flags **/
272  u16 first_desc_len; /** Length of the first data descriptor **/
273  virtio_net_hdr_mrg_rxbuf_t hdr; /** Virtio header **/
274 } vhost_trace_t;
275 
276 
277 #define VHOST_USER_RX_BUFFERS_N (2 * VLIB_FRAME_SIZE + 2)
278 #define VHOST_USER_COPY_ARRAY_N (4 * VLIB_FRAME_SIZE)
279 
280 typedef struct
281 {
285 
286  virtio_net_hdr_mrg_rxbuf_t tx_headers[VLIB_FRAME_SIZE];
288 
289  /* This is here so it doesn't end-up
290  * using stack or registers. */
292 } vhost_cpu_t;
293 
294 typedef struct
295 {
302 
303  /** first cpu index */
305 
306  /** total cpu count */
308 
309  /** Per-CPU data for vhost-user */
311 
312  /** Pseudo random iterator */
315 
316 typedef struct
317 {
318  u8 if_name[64];
323  u8 sock_filename[256];
327 
329  vhost_user_intf_details_t ** out_vuids);
330 
331 // CLI commands to be used from dpdk
333  unformat_input_t * input,
334  vlib_cli_command_t * cmd);
336  unformat_input_t * input,
337  vlib_cli_command_t * cmd);
339  unformat_input_t * input,
340  vlib_cli_command_t * cmd);
341 
342 #endif
343 
344 /*
345  * fd.io coding-style-patch-verification: ON
346  *
347  * Local Variables:
348  * eval: (c-set-style "gnu")
349  * End:
350  */
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:68
vring_desc_t * desc
Definition: vhost-user.h:197
vhost_user_log_t log
Definition: vhost-user.h:185
u32 virtio_ring_flags
The device index.
Definition: vhost-user.h:271
virtio_net_hdr_mrg_rxbuf_t hdr
Length of the first data descriptor.
Definition: vhost-user.h:273
vhost_cpu_t * cpus
Per-CPU data for vhost-user.
Definition: vhost-user.h:310
virtio_net_feature_t
Definition: vhost-user.h:58
clib_error_t * vhost_user_connect_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: vhost-user.c:2654
enum vhost_user_req vhost_user_req_t
vring_avail_t * avail
Definition: vhost-user.h:198
vhost_vring_state_t state
Definition: vhost-user.h:182
vring_used_t * used
Definition: vhost-user.h:199
vhost_trace_t * current_trace
Definition: vhost-user.h:291
clib_error_t * show_vhost_user_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: vhost-user.c:2798
vhost_user_req
Definition: vhost-user.h:109
void * log_base_addr
Definition: vhost-user.h:243
unsigned long u64
Definition: types.h:89
vhost_iface_and_queue_t * rx_queues
Definition: vhost-user.h:282
#define VHOST_VRING_MAX_SIZE
Definition: vhost-user.h:21
#define foreach_virtio_net_feature
Definition: vhost-user.h:46
u32 random
Pseudo random iterator.
Definition: vhost-user.h:313
#define VLIB_FRAME_SIZE
Definition: node.h:328
vhost_vring_addr_t addr
Definition: vhost-user.h:183
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:2616
u32 * show_dev_instance_by_real_dev_instance
Definition: vhost-user.h:298
u16 device_index
The interface queue index (Not the virtio vring idx)
Definition: vhost-user.h:270
vhost_user_intf_t * vhost_user_interfaces
Definition: vhost-user.h:297
#define VHOST_USER_COPY_ARRAY_N
Definition: vhost-user.h:278
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:2577
#define VHOST_MEMORY_MAX_NREGIONS
Definition: vhost-user.h:19
u16 first_desc_len
Runtime queue flags.
Definition: vhost-user.h:272
vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS]
Definition: vhost-user.h:76
clib_error_t * vhost_user_delete_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: vhost-user.c:2712
int vhost_user_delete_if(vnet_main_t *vnm, vlib_main_t *vm, u32 sw_if_index)
Definition: vhost-user.c:2410
unsigned int u32
Definition: types.h:88
u64 uword
Definition: types.h:112
unsigned short u16
Definition: types.h:57
u32 input_cpu_count
total cpu count
Definition: vhost-user.h:307
double f64
Definition: types.h:142
#define VHOST_USER_RX_BUFFERS_N
Definition: vhost-user.h:277
unsigned char u8
Definition: types.h:56
u32 input_cpu_first_index
first cpu index
Definition: vhost-user.h:304
#define VHOST_VRING_MAX_N
Definition: vhost-user.h:22
u32 rx_buffers_len
Definition: vhost-user.h:283
vhost_vring_addr_t addr
Definition: vhost-user.h:81
struct _unformat_input_t unformat_input_t
int vhost_user_dump_ifs(vnet_main_t *vnm, vlib_main_t *vm, vhost_user_intf_details_t **out_vuids)
Definition: vhost-user.c:2748
u32 flags
Definition: vhost-user.h:75
vhost_user_memory_t memory
Definition: vhost-user.h:184
vhost_user_req_t request
Definition: vhost-user.h:176
int dont_dump_vhost_user_memory
Definition: vhost-user.h:301