FD.io VPP  v17.04-9-g99c0734
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 #define VRING_AVAIL_F_NO_INTERRUPT 1
46 
47 #define foreach_virtio_net_feature \
48  _ (VIRTIO_NET_F_MRG_RXBUF, 15) \
49  _ (VIRTIO_NET_F_CTRL_VQ, 17) \
50  _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21) \
51  _ (VIRTIO_NET_F_MQ, 22) \
52  _ (VHOST_F_LOG_ALL, 26) \
53  _ (VIRTIO_F_ANY_LAYOUT, 27) \
54  _ (VIRTIO_F_INDIRECT_DESC, 28) \
55  _ (VHOST_USER_F_PROTOCOL_FEATURES, 30) \
56  _ (VIRTIO_F_VERSION_1, 32)
57 
58 
59 typedef enum
60 {
61 #define _(f,n) FEAT_##f = (n),
63 #undef _
65 
67  const char *sock_filename, u8 is_server,
68  u32 * sw_if_index, u64 feature_mask,
69  u8 renumber, u32 custom_dev_instance, u8 * hwaddr,
70  u8 operation_mode);
72  const char *sock_filename, u8 is_server,
73  u32 sw_if_index, u64 feature_mask,
74  u8 renumber, u32 custom_dev_instance,
75  u8 operation_mode);
77  u32 sw_if_index);
78 
79 /* *INDENT-OFF* */
81 {
86 } __attribute ((packed)) vhost_user_memory_region_t;
87 
88 typedef struct vhost_user_memory
89 {
92  vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
93 } __attribute ((packed)) vhost_user_memory_t;
94 
95 typedef struct
96 {
97  u32 index, num;
98 } __attribute ((packed)) vhost_vring_state_t;
99 
100 typedef struct
101 {
102  u32 index, flags;
103  u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
104 } __attribute ((packed)) vhost_vring_addr_t;
105 
106 typedef struct vhost_user_log
107 {
110 } __attribute ((packed)) vhost_user_log_t;
111 
112 typedef enum vhost_user_req
113 {
135 
136 // vring_desc I/O buffer descriptor
137 typedef struct
138 {
139  uint64_t addr; // packet data buffer address
140  uint32_t len; // packet data buffer size
141  uint16_t flags; // (see below)
142  uint16_t next; // optional index next descriptor in chain
143 } __attribute ((packed)) vring_desc_t;
144 
145 typedef struct
146 {
147  uint16_t flags;
148  volatile uint16_t idx;
149  uint16_t ring[VHOST_VRING_MAX_SIZE];
150 } __attribute ((packed)) vring_avail_t;
151 
152 typedef struct
153 {
154  uint16_t flags;
155  uint16_t idx;
156  struct /* vring_used_elem */
157  {
158  uint32_t id;
159  uint32_t len;
160  } ring[VHOST_VRING_MAX_SIZE];
161 } __attribute ((packed)) vring_used_t;
162 
163 typedef struct
164 {
165  u8 flags;
166  u8 gso_type;
167  u16 hdr_len;
168  u16 gso_size;
169  u16 csum_start;
170  u16 csum_offset;
171 } __attribute ((packed)) virtio_net_hdr_t;
172 
173 typedef struct {
174  virtio_net_hdr_t hdr;
175  u16 num_buffers;
176 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
177 
178 typedef struct vhost_user_msg {
179  vhost_user_req_t request;
182  union
183  {
185  vhost_vring_state_t state;
186  vhost_vring_addr_t addr;
187  vhost_user_memory_t memory;
188  vhost_user_log_t log;
189  };
190 } __attribute ((packed)) vhost_user_msg_t;
191 /* *INDENT-ON* */
192 
193 typedef struct
194 {
195  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
200  vring_desc_t *desc;
201  vring_avail_t *avail;
202  vring_used_t *used;
207  //Put non-runtime in a different cache line
208  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
209  int errfd;
214 
215 #define VHOST_USER_POLLING_MODE 0
216 #define VHOST_USER_INTERRUPT_MODE 1
217 #define VHOST_USER_ADAPTIVE_MODE 2
218 
219 #define VHOST_USER_EVENT_START_TIMER 1
220 
221 typedef struct
222 {
223  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
228  char sock_filename[256];
230  u32 hw_if_index, sw_if_index;
231 
232  //Feature negotiation
236 
237  //Memory region information
239  vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
240  void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
241  u64 region_guest_addr_lo[VHOST_MEMORY_MAX_NREGIONS];
242  u64 region_guest_addr_hi[VHOST_MEMORY_MAX_NREGIONS];
244 
245  //Virtual rings
247  volatile u32 *vring_locks[VHOST_VRING_MAX_N];
248 
251 
254 
255  /* Whether to use spinlock or per_cpu_tx_qid assignment */
258 
259  /* Vector of workers for this interface */
261 
264 
265 typedef struct
266 {
270 
271 typedef struct
272 {
276 } vhost_copy_t;
277 
278 typedef struct
279 {
280  u16 qid; /** The interface queue index (Not the virtio vring idx) */
281  u16 device_index; /** The device index */
282  u32 virtio_ring_flags; /** Runtime queue flags **/
283  u16 first_desc_len; /** Length of the first data descriptor **/
284  virtio_net_hdr_mrg_rxbuf_t hdr; /** Virtio header **/
285 } vhost_trace_t;
286 
287 
288 #define VHOST_USER_RX_BUFFERS_N (2 * VLIB_FRAME_SIZE + 2)
289 #define VHOST_USER_COPY_ARRAY_N (4 * VLIB_FRAME_SIZE)
290 
291 typedef struct
292 {
296 
297  virtio_net_hdr_mrg_rxbuf_t tx_headers[VLIB_FRAME_SIZE];
299 
300  /* This is here so it doesn't end-up
301  * using stack or registers. */
303 
304  /* bitmap of pending rx interfaces */
306 
307  /* The operation mode computed per cpu based on interface setting */
309 } vhost_cpu_t;
310 
311 typedef struct
312 {
319 
320  /** first cpu index */
322 
323  /** total cpu count */
325 
326  /** Per-CPU data for vhost-user */
328 
329  /** Pseudo random iterator */
331 
332  /* Node is in interrupt mode */
335 
336 typedef struct
337 {
338  u8 if_name[64];
343  u8 sock_filename[256];
348 
350  vhost_user_intf_details_t ** out_vuids);
351 
352 #endif
353 
354 /*
355  * fd.io coding-style-patch-verification: ON
356  *
357  * Local Variables:
358  * eval: (c-set-style "gnu")
359  * End:
360  */
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:68
vring_desc_t * desc
Definition: vhost-user.h:200
vhost_user_log_t log
Definition: vhost-user.h:188
u32 virtio_ring_flags
The device index.
Definition: vhost-user.h:282
virtio_net_hdr_mrg_rxbuf_t hdr
Length of the first data descriptor.
Definition: vhost-user.h:284
vhost_cpu_t * cpus
Per-CPU data for vhost-user.
Definition: vhost-user.h:327
virtio_net_feature_t
Definition: vhost-user.h:59
enum vhost_user_req vhost_user_req_t
u8 operation_mode
Definition: vhost-user.h:308
vring_avail_t * avail
Definition: vhost-user.h:201
uword * pending_input_bitmap
Definition: vhost-user.h:305
vhost_vring_state_t state
Definition: vhost-user.h:185
vring_used_t * used
Definition: vhost-user.h:202
vhost_trace_t * current_trace
Definition: vhost-user.h:302
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 operation_mode)
Definition: vhost-user.c:2875
vhost_user_req
Definition: vhost-user.h:112
void * log_base_addr
Definition: vhost-user.h:252
unsigned long u64
Definition: types.h:89
vhost_iface_and_queue_t * rx_queues
Definition: vhost-user.h:293
#define VHOST_VRING_MAX_SIZE
Definition: vhost-user.h:21
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 operation_mode)
Definition: vhost-user.c:2816
#define foreach_virtio_net_feature
Definition: vhost-user.h:47
u32 random
Pseudo random iterator.
Definition: vhost-user.h:330
#define VLIB_FRAME_SIZE
Definition: node.h:328
vhost_vring_addr_t addr
Definition: vhost-user.h:186
u32 * show_dev_instance_by_real_dev_instance
Definition: vhost-user.h:315
u16 device_index
The interface queue index (Not the virtio vring idx)
Definition: vhost-user.h:281
vhost_user_intf_t * vhost_user_interfaces
Definition: vhost-user.h:314
vlib_main_t * vm
Definition: buffer.c:276
#define VHOST_USER_COPY_ARRAY_N
Definition: vhost-user.h:289
#define VHOST_MEMORY_MAX_NREGIONS
Definition: vhost-user.h:19
u16 first_desc_len
Runtime queue flags.
Definition: vhost-user.h:283
vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS]
Definition: vhost-user.h:79
int vhost_user_delete_if(vnet_main_t *vnm, vlib_main_t *vm, u32 sw_if_index)
Definition: vhost-user.c:2558
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:324
double f64
Definition: types.h:142
#define VHOST_USER_RX_BUFFERS_N
Definition: vhost-user.h:288
unsigned char u8
Definition: types.h:56
u32 input_cpu_first_index
first cpu index
Definition: vhost-user.h:321
#define VHOST_VRING_MAX_N
Definition: vhost-user.h:22
u32 rx_buffers_len
Definition: vhost-user.h:294
vhost_vring_addr_t addr
Definition: vhost-user.h:84
int vhost_user_dump_ifs(vnet_main_t *vnm, vlib_main_t *vm, vhost_user_intf_details_t **out_vuids)
Definition: vhost-user.c:3060
u32 flags
Definition: vhost-user.h:78
vhost_user_memory_t memory
Definition: vhost-user.h:187
vhost_user_req_t request
Definition: vhost-user.h:179
int dont_dump_vhost_user_memory
Definition: vhost-user.h:318