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__
18 #include <vnet/devices/virtio/virtio_std.h>
19 #include <vnet/devices/virtio/vhost_std.h>
21 /* vhost-user data structures */
23 #define VHOST_MEMORY_MAX_NREGIONS 8
24 #define VHOST_USER_MSG_HDR_SZ 12
25 #define VHOST_VRING_INIT_MQ_PAIR_SZ 8 //8TX + 8RX
28 * qid is one byte in size in the spec. Please see VHOST_USER_SET_VRING_CALL,
29 * VHOST_USER_SET_VRING_KICK, and VHOST_USER_SET_VRING_ERR.
30 * The max number for q pair is naturally 128.
32 #define VHOST_VRING_MAX_MQ_PAIR_SZ 128
33 #define VHOST_VRING_IDX_RX(qid) (2*qid)
34 #define VHOST_VRING_IDX_TX(qid) (2*qid + 1)
36 #define VHOST_USER_VRING_NOFD_MASK 0x100
38 #define VHOST_USER_PROTOCOL_F_MQ 0
39 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
40 #define VHOST_VRING_F_LOG 0
42 #define VHOST_USER_PROTOCOL_FEATURES ((1ULL << VHOST_USER_PROTOCOL_F_MQ) | \
43 (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD))
45 #define vu_log_debug(dev, f, ...) \
47 vlib_log(VLIB_LOG_LEVEL_DEBUG, vhost_user_main.log_default, "%U: " f, \
48 format_vnet_hw_if_index_name, vnet_get_main(), \
49 dev->hw_if_index, ##__VA_ARGS__); \
52 #define vu_log_warn(dev, f, ...) \
54 vlib_log(VLIB_LOG_LEVEL_WARNING, vhost_user_main.log_default, "%U: " f, \
55 format_vnet_hw_if_index_name, vnet_get_main(), \
56 dev->hw_if_index, ##__VA_ARGS__); \
58 #define vu_log_err(dev, f, ...) \
60 vlib_log(VLIB_LOG_LEVEL_ERR, vhost_user_main.log_default, "%U: " f, \
61 format_vnet_hw_if_index_name, vnet_get_main(), \
62 dev->hw_if_index, ##__VA_ARGS__); \
65 #define UNIX_GET_FD(unixfd_idx) ({ \
66 typeof(unixfd_idx) __unixfd_idx = (unixfd_idx); \
67 (__unixfd_idx != ~0) ? \
68 pool_elt_at_index (file_main.file_pool, \
69 __unixfd_idx)->file_descriptor : -1; })
71 #define foreach_virtio_trace_flags \
72 _ (SIMPLE_CHAINED, 0, "Simple descriptor chaining") \
73 _ (SINGLE_DESC, 1, "Single descriptor packet") \
74 _ (INDIRECT, 2, "Indirect descriptor") \
75 _ (MAP_ERROR, 4, "Memory mapping error")
79 #define _(n,i,s) VIRTIO_TRACE_F_##n,
80 foreach_virtio_trace_flags
82 } virtio_trace_flag_t;
84 #define FEATURE_VIRTIO_NET_F_HOST_TSO_FEATURE_BITS \
85 (VIRTIO_FEATURE (VIRTIO_NET_F_CSUM) | \
86 VIRTIO_FEATURE (VIRTIO_NET_F_HOST_UFO) | \
87 VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO4) | \
88 VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO6))
90 #define FEATURE_VIRTIO_NET_F_GUEST_TSO_FEATURE_BITS \
91 (VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_CSUM) | \
92 VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_UFO) | \
93 VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO4) | \
94 VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO6))
96 #define FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS \
97 (FEATURE_VIRTIO_NET_F_HOST_TSO_FEATURE_BITS | \
98 FEATURE_VIRTIO_NET_F_GUEST_TSO_FEATURE_BITS)
105 u32 custom_dev_instance;
115 } vhost_user_create_if_args_t;
117 int vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
118 vhost_user_create_if_args_t * args);
119 int vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
120 vhost_user_create_if_args_t * args);
121 int vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
125 typedef struct vhost_user_memory_region
131 } __attribute ((packed)) vhost_user_memory_region_t;
133 typedef struct vhost_user_memory
137 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
138 } __attribute ((packed)) vhost_user_memory_t;
140 typedef enum vhost_user_req
143 VHOST_USER_GET_FEATURES = 1,
144 VHOST_USER_SET_FEATURES = 2,
145 VHOST_USER_SET_OWNER = 3,
146 VHOST_USER_RESET_OWNER = 4,
147 VHOST_USER_SET_MEM_TABLE = 5,
148 VHOST_USER_SET_LOG_BASE = 6,
149 VHOST_USER_SET_LOG_FD = 7,
150 VHOST_USER_SET_VRING_NUM = 8,
151 VHOST_USER_SET_VRING_ADDR = 9,
152 VHOST_USER_SET_VRING_BASE = 10,
153 VHOST_USER_GET_VRING_BASE = 11,
154 VHOST_USER_SET_VRING_KICK = 12,
155 VHOST_USER_SET_VRING_CALL = 13,
156 VHOST_USER_SET_VRING_ERR = 14,
157 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
158 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
159 VHOST_USER_GET_QUEUE_NUM = 17,
160 VHOST_USER_SET_VRING_ENABLE = 18,
164 typedef struct vhost_user_msg {
165 vhost_user_req_t request;
171 vhost_vring_state_t state;
172 vhost_vring_addr_t addr;
173 vhost_user_memory_t memory;
174 vhost_user_log_t log;
176 } __attribute ((packed)) vhost_user_msg_t;
181 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
185 u16 n_since_last_int;
189 vring_packed_desc_t *packed_desc;
193 vring_avail_t *avail;
194 vring_desc_event_t *avail_event;
199 vring_desc_event_t *used_event;
201 uword desc_user_addr;
202 uword used_user_addr;
203 uword avail_user_addr;
208 clib_spinlock_t vring_lock;
210 //Put non-runtime in a different cache line
211 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
217 /* The rx queue policy (interrupt/adaptive/polling) for this queue */
221 * It contains the device queue number. -1 if it does not. The idea is
222 * to not invoke vnet_hw_interface_assign_rx_thread and
223 * vnet_hw_interface_unassign_rx_thread more than once for the duration of
224 * the interface even if it is disconnected and reconnected.
228 u16 used_wrap_counter;
229 u16 avail_wrap_counter;
233 } vhost_user_vring_t;
235 #define VHOST_USER_EVENT_START_TIMER 1
236 #define VHOST_USER_EVENT_STOP_TIMER 2
240 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
243 u32 unix_server_index;
245 char sock_filename[256];
248 u32 hw_if_index, sw_if_index;
250 //Feature negotiation
253 u64 protocol_features;
255 //Memory region information
257 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
258 void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
259 u64 region_guest_addr_lo[VHOST_MEMORY_MAX_NREGIONS];
260 u64 region_guest_addr_hi[VHOST_MEMORY_MAX_NREGIONS];
261 u32 region_mmap_fd[VHOST_MEMORY_MAX_NREGIONS];
264 vhost_user_vring_t *vrings;
267 * vrings is a dynamic array. It may have more elements than it is
268 * currently used. num_qid indicates the current total qid's in the
269 * vrings. For example, vec_len(vrings) = 64, num_qid = 60, so the
270 * current valid/used qid is (0, 59) in the vrings array.
274 int virtio_net_hdr_sz;
280 /* Whether to use spinlock or per_cpu_tx_qid assignment */
286 /* Packed ring configured */
301 u16 qid; /** The interface queue index (Not the virtio vring idx) */
302 u16 device_index; /** The device index */
303 u32 virtio_ring_flags; /** Runtime queue flags **/
304 u16 first_desc_len; /** Length of the first data descriptor **/
305 virtio_net_hdr_mrg_rxbuf_t hdr; /** Virtio header **/
308 #define VHOST_USER_RX_BUFFERS_N (2 * VLIB_FRAME_SIZE + 2)
309 #define VHOST_USER_COPY_ARRAY_N (4 * VLIB_FRAME_SIZE)
314 u32 rx_buffers[VHOST_USER_RX_BUFFERS_N];
316 virtio_net_hdr_mrg_rxbuf_t tx_headers[VLIB_FRAME_SIZE];
317 vhost_copy_t copy[VHOST_USER_COPY_ARRAY_N];
319 /* This is here so it doesn't end-up
320 * using stack or registers. */
321 vhost_trace_t *current_trace;
324 vlib_buffer_t **rx_buffers_pdesc;
329 mhash_t if_index_by_sock_name;
331 vhost_user_intf_t *vhost_user_interfaces;
332 u32 *show_dev_instance_by_real_dev_instance;
335 int dont_dump_vhost_user_memory;
337 /** Per-CPU data for vhost-user */
340 /** Pseudo random iterator */
343 /* The number of rx interface/queue pairs in interrupt mode */
347 vlib_log_class_t log_default;
349 /* gso interface count */
357 u32 virtio_net_hdr_sz;
360 u8 sock_filename[256];
363 } vhost_user_intf_details_t;
365 int vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
366 vhost_user_intf_details_t ** out_vuids);
368 extern vlib_node_registration_t vhost_user_send_interrupt_node;
369 extern vnet_device_class_t vhost_user_device_class;
370 extern vlib_node_registration_t vhost_user_input_node;
371 extern vhost_user_main_t vhost_user_main;
376 * fd.io coding-style-patch-verification: ON
379 * eval: (c-set-style "gnu")