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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef __VIRTIO_VHOST_USER_H__
16 #define __VIRTIO_VHOST_USER_H__
17 /* vhost-user data structures */
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)
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)
31 #define VHOST_USER_PROTOCOL_F_MQ 0
32 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
33 #define VHOST_VRING_F_LOG 0
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))
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
45 #define VRING_USED_F_NO_NOTIFY 1
46 #define VRING_AVAIL_F_NO_INTERRUPT 1
48 #define vu_log_debug(dev, f, ...) \
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__); \
55 #define vu_log_warn(dev, f, ...) \
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__); \
61 #define vu_log_err(dev, f, ...) \
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__); \
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; })
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")
82 #define _(n,i,s) VIRTIO_TRACE_F_##n,
83 foreach_virtio_trace_flags
85 } virtio_trace_flag_t;
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)
108 #define _(f,n) FEAT_##f = (n),
109 foreach_virtio_net_feature
111 } virtio_net_feature_t;
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))
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))
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)
129 int vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
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,
134 int vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
135 const char *sock_filename, u8 is_server,
136 u32 sw_if_index, u64 feature_mask,
137 u8 renumber, u32 custom_dev_instance,
139 int vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
143 typedef struct vhost_user_memory_region
149 } __attribute ((packed)) vhost_user_memory_region_t;
151 typedef struct vhost_user_memory
155 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
156 } __attribute ((packed)) vhost_user_memory_t;
161 } __attribute ((packed)) vhost_vring_state_t;
166 u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
167 } __attribute ((packed)) vhost_vring_addr_t;
169 typedef struct vhost_user_log
173 } __attribute ((packed)) vhost_user_log_t;
175 typedef enum vhost_user_req
178 VHOST_USER_GET_FEATURES = 1,
179 VHOST_USER_SET_FEATURES = 2,
180 VHOST_USER_SET_OWNER = 3,
181 VHOST_USER_RESET_OWNER = 4,
182 VHOST_USER_SET_MEM_TABLE = 5,
183 VHOST_USER_SET_LOG_BASE = 6,
184 VHOST_USER_SET_LOG_FD = 7,
185 VHOST_USER_SET_VRING_NUM = 8,
186 VHOST_USER_SET_VRING_ADDR = 9,
187 VHOST_USER_SET_VRING_BASE = 10,
188 VHOST_USER_GET_VRING_BASE = 11,
189 VHOST_USER_SET_VRING_KICK = 12,
190 VHOST_USER_SET_VRING_CALL = 13,
191 VHOST_USER_SET_VRING_ERR = 14,
192 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
193 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
194 VHOST_USER_GET_QUEUE_NUM = 17,
195 VHOST_USER_SET_VRING_ENABLE = 18,
199 // vring_desc I/O buffer descriptor
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;
211 volatile uint16_t idx;
212 uint16_t ring[VHOST_VRING_MAX_SIZE];
213 } __attribute ((packed)) vring_avail_t;
219 struct /* vring_used_elem */
223 } ring[VHOST_VRING_MAX_SIZE];
224 } __attribute ((packed)) vring_used_t;
234 } __attribute ((packed)) virtio_net_hdr_t;
237 virtio_net_hdr_t hdr;
239 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
241 typedef struct vhost_user_msg {
242 vhost_user_req_t request;
248 vhost_vring_state_t state;
249 vhost_vring_addr_t addr;
250 vhost_user_memory_t memory;
251 vhost_user_log_t log;
253 } __attribute ((packed)) vhost_user_msg_t;
258 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
262 u16 n_since_last_int;
264 vring_avail_t *avail;
266 uword desc_user_addr;
267 uword used_user_addr;
268 uword avail_user_addr;
273 //Put non-runtime in a different cache line
274 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
280 /* The rx queue policy (interrupt/adaptive/polling) for this queue */
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.
290 } vhost_user_vring_t;
292 #define VHOST_USER_EVENT_START_TIMER 1
293 #define VHOST_USER_EVENT_STOP_TIMER 2
297 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
300 u32 unix_server_index;
302 char sock_filename[256];
305 u32 hw_if_index, sw_if_index;
307 //Feature negotiation
310 u64 protocol_features;
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];
318 u32 region_mmap_fd[VHOST_MEMORY_MAX_NREGIONS];
321 vhost_user_vring_t vrings[VHOST_VRING_MAX_N];
322 volatile u32 *vring_locks[VHOST_VRING_MAX_N];
324 int virtio_net_hdr_sz;
330 /* Whether to use spinlock or per_cpu_tx_qid assignment */
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 **/
354 #define VHOST_USER_RX_BUFFERS_N (2 * VLIB_FRAME_SIZE + 2)
355 #define VHOST_USER_COPY_ARRAY_N (4 * VLIB_FRAME_SIZE)
360 u32 rx_buffers[VHOST_USER_RX_BUFFERS_N];
362 virtio_net_hdr_mrg_rxbuf_t tx_headers[VLIB_FRAME_SIZE];
363 vhost_copy_t copy[VHOST_USER_COPY_ARRAY_N];
365 /* This is here so it doesn't end-up
366 * using stack or registers. */
367 vhost_trace_t *current_trace;
372 mhash_t if_index_by_sock_name;
374 vhost_user_intf_t *vhost_user_interfaces;
375 u32 *show_dev_instance_by_real_dev_instance;
378 int dont_dump_vhost_user_memory;
380 /** Per-CPU data for vhost-user */
383 /** Pseudo random iterator */
386 /* The number of rx interface/queue pairs in interrupt mode */
390 vlib_log_class_t log_default;
392 /* gso interface count */
400 u32 virtio_net_hdr_sz;
403 u8 sock_filename[256];
406 } vhost_user_intf_details_t;
408 int vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
409 vhost_user_intf_details_t ** out_vuids);
411 extern vlib_node_registration_t vhost_user_send_interrupt_node;
412 extern vnet_device_class_t vhost_user_device_class;
413 extern vlib_node_registration_t vhost_user_input_node;
414 extern vhost_user_main_t vhost_user_main;
419 * fd.io coding-style-patch-verification: ON
422 * eval: (c-set-style "gnu")