FD.io VPP  v19.01.2-3-gf61a1a8
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 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_MRG_RXBUF, 15) \
89  _ (VIRTIO_NET_F_CTRL_VQ, 17) \
90  _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21) \
91  _ (VIRTIO_NET_F_MQ, 22) \
92  _ (VHOST_F_LOG_ALL, 26) \
93  _ (VIRTIO_F_ANY_LAYOUT, 27) \
94  _ (VIRTIO_F_INDIRECT_DESC, 28) \
95  _ (VHOST_USER_F_PROTOCOL_FEATURES, 30) \
96  _ (VIRTIO_F_VERSION_1, 32)
97 
98 typedef enum
99 {
100 #define _(f,n) FEAT_##f = (n),
102 #undef _
104 
106  const char *sock_filename, u8 is_server,
107  u32 * sw_if_index, u64 feature_mask,
108  u8 renumber, u32 custom_dev_instance, u8 * hwaddr);
110  const char *sock_filename, u8 is_server,
111  u32 sw_if_index, u64 feature_mask,
112  u8 renumber, u32 custom_dev_instance);
116 /* *INDENT-OFF* */
118 {
123 } __attribute ((packed)) vhost_user_memory_region_t;
124 
125 typedef struct vhost_user_memory
126 {
129  vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
130 } __attribute ((packed)) vhost_user_memory_t;
131 
132 typedef struct
133 {
134  u32 index, num;
135 } __attribute ((packed)) vhost_vring_state_t;
136 
137 typedef struct
138 {
139  u32 index, flags;
140  u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
141 } __attribute ((packed)) vhost_vring_addr_t;
142 
143 typedef struct vhost_user_log
144 {
147 } __attribute ((packed)) vhost_user_log_t;
148 
149 typedef enum vhost_user_req
150 {
172 
173 // vring_desc I/O buffer descriptor
174 typedef struct
175 {
176  uint64_t addr; // packet data buffer address
177  uint32_t len; // packet data buffer size
178  uint16_t flags; // (see below)
179  uint16_t next; // optional index next descriptor in chain
180 } __attribute ((packed)) vring_desc_t;
181 
182 typedef struct
183 {
184  uint16_t flags;
185  volatile uint16_t idx;
186  uint16_t ring[VHOST_VRING_MAX_SIZE];
187 } __attribute ((packed)) vring_avail_t;
188 
189 typedef struct
190 {
191  uint16_t flags;
192  uint16_t idx;
193  struct /* vring_used_elem */
194  {
195  uint32_t id;
196  uint32_t len;
197  } ring[VHOST_VRING_MAX_SIZE];
198 } __attribute ((packed)) vring_used_t;
199 
200 typedef struct
201 {
202  u8 flags;
203  u8 gso_type;
204  u16 hdr_len;
205  u16 gso_size;
206  u16 csum_start;
207  u16 csum_offset;
208 } __attribute ((packed)) virtio_net_hdr_t;
209 
210 typedef struct {
211  virtio_net_hdr_t hdr;
212  u16 num_buffers;
213 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
214 
215 typedef struct vhost_user_msg {
216  vhost_user_req_t request;
219  union
220  {
222  vhost_vring_state_t state;
223  vhost_vring_addr_t addr;
224  vhost_user_memory_t memory;
225  vhost_user_log_t log;
226  };
227 } __attribute ((packed)) vhost_user_msg_t;
228 /* *INDENT-ON* */
229 
230 typedef struct
231 {
232  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
237  vring_desc_t *desc;
238  vring_avail_t *avail;
239  vring_used_t *used;
244  //Put non-runtime in a different cache line
245  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
246  int errfd;
250 
251  /* The rx queue policy (interrupt/adaptive/polling) for this queue */
253 
254  /*
255  * It contains the device queue number. -1 if it does not. The idea is
256  * to not invoke vnet_hw_interface_assign_rx_thread and
257  * vnet_hw_interface_unassign_rx_thread more than once for the duration of
258  * the interface even if it is disconnected and reconnected.
259  */
262 
263 #define VHOST_USER_EVENT_START_TIMER 1
264 #define VHOST_USER_EVENT_STOP_TIMER 2
265 
266 typedef struct
267 {
268  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
273  char sock_filename[256];
276  u32 hw_if_index, sw_if_index;
277 
278  //Feature negotiation
282 
283  //Memory region information
285  vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
286  void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
287  u64 region_guest_addr_lo[VHOST_MEMORY_MAX_NREGIONS];
288  u64 region_guest_addr_hi[VHOST_MEMORY_MAX_NREGIONS];
290 
291  //Virtual rings
293  volatile u32 *vring_locks[VHOST_VRING_MAX_N];
294 
297 
300 
301  /* Whether to use spinlock or per_cpu_tx_qid assignment */
305 
306 typedef struct
307 {
311 } vhost_copy_t;
312 
313 typedef struct
314 {
315  u16 qid; /** The interface queue index (Not the virtio vring idx) */
316  u16 device_index; /** The device index */
317  u32 virtio_ring_flags; /** Runtime queue flags **/
318  u16 first_desc_len; /** Length of the first data descriptor **/
319  virtio_net_hdr_mrg_rxbuf_t hdr; /** Virtio header **/
320 } vhost_trace_t;
321 
322 
323 #define VHOST_USER_RX_BUFFERS_N (2 * VLIB_FRAME_SIZE + 2)
324 #define VHOST_USER_COPY_ARRAY_N (4 * VLIB_FRAME_SIZE)
325 
326 typedef struct
327 {
330 
331  virtio_net_hdr_mrg_rxbuf_t tx_headers[VLIB_FRAME_SIZE];
333 
334  /* This is here so it doesn't end-up
335  * using stack or registers. */
337 } vhost_cpu_t;
338 
339 typedef struct
340 {
348 
349  /** Per-CPU data for vhost-user */
351 
352  /** Pseudo random iterator */
354 
355  /* The number of rx interface/queue pairs in interrupt mode */
357 
358  /* logging */
361 
362 typedef struct
363 {
364  u8 if_name[64];
369  u8 sock_filename[256];
373 
375  vhost_user_intf_details_t ** out_vuids);
376 
381 
382 #endif
383 
384 /*
385  * fd.io coding-style-patch-verification: ON
386  *
387  * Local Variables:
388  * eval: (c-set-style "gnu")
389  * End:
390  */
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:1522
Definition: mhash.h:46
u32 vlib_log_class_t
Definition: log.h:21
virtio_net_feature_t
Definition: vhost_user.h:98
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
u32 flags
Definition: vhost_user.h:115
vring_desc_t * desc
Definition: vhost_user.h:237
vhost_user_log_t log
Definition: vhost_user.h:225
u32 virtio_ring_flags
The device index.
Definition: vhost_user.h:317
virtio_net_hdr_mrg_rxbuf_t hdr
Length of the first data descriptor.
Definition: vhost_user.h:319
vhost_cpu_t * cpus
Per-CPU data for vhost-user.
Definition: vhost_user.h:350
#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:1685
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:238
vnet_device_class_t vhost_user_device_class
vhost_vring_state_t state
Definition: vhost_user.h:222
#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:239
vhost_vring_addr_t addr
Definition: vhost_user.h:121
vhost_trace_t * current_trace
Definition: vhost_user.h:336
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:1244
double f64
Definition: types.h:142
u32 sw_if_index
Definition: vxlan_gbp.api:37
void * log_base_addr
Definition: vhost_user.h:298
unsigned int u32
Definition: types.h:88
#define VLIB_FRAME_SIZE
Definition: node.h:401
#define VHOST_USER_COPY_ARRAY_N
Definition: vhost_user.h:324
u32 random
Pseudo random iterator.
Definition: vhost_user.h:353
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:223
vlib_node_registration_t vhost_user_send_interrupt_node
(constructor) VLIB_REGISTER_NODE (vhost_user_send_interrupt_node)
Definition: vhost_user.c:53
vlib_log_class_t log_default
Definition: vhost_user.h:359
u8 len
Definition: ip_types.api:49
u32 * show_dev_instance_by_real_dev_instance
Definition: vhost_user.h:344
u16 device_index
The interface queue index (Not the virtio vring idx)
Definition: vhost_user.h:316
vhost_user_intf_t * vhost_user_interfaces
Definition: vhost_user.h:343
vlib_main_t * vm
Definition: buffer.c:301
vhost_user_req
Definition: vhost_user.h:149
u16 first_desc_len
Runtime queue flags.
Definition: vhost_user.h:318
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:1459
#define VHOST_USER_RX_BUFFERS_N
Definition: vhost_user.h:323
#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:341
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:328
u32 id
Definition: udp.api:45
vhost_user_memory_t memory
Definition: vhost_user.h:224
vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS]
Definition: vhost_user.h:116
vhost_user_req_t request
Definition: vhost_user.h:216
int dont_dump_vhost_user_memory
Definition: vhost_user.h:347
signed short i16
Definition: types.h:46