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 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
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_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)
100 #define _(f,n) FEAT_##f = (n),
101 foreach_virtio_net_feature
103 } virtio_net_feature_t;
105 int vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
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);
109 int vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
110 const char *sock_filename, u8 is_server,
111 u32 sw_if_index, u64 feature_mask,
112 u8 renumber, u32 custom_dev_instance);
113 int vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
117 typedef struct vhost_user_memory_region
123 } __attribute ((packed)) vhost_user_memory_region_t;
125 typedef struct vhost_user_memory
129 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
130 } __attribute ((packed)) vhost_user_memory_t;
135 } __attribute ((packed)) vhost_vring_state_t;
140 u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
141 } __attribute ((packed)) vhost_vring_addr_t;
143 typedef struct vhost_user_log
147 } __attribute ((packed)) vhost_user_log_t;
149 typedef enum vhost_user_req
152 VHOST_USER_GET_FEATURES = 1,
153 VHOST_USER_SET_FEATURES = 2,
154 VHOST_USER_SET_OWNER = 3,
155 VHOST_USER_RESET_OWNER = 4,
156 VHOST_USER_SET_MEM_TABLE = 5,
157 VHOST_USER_SET_LOG_BASE = 6,
158 VHOST_USER_SET_LOG_FD = 7,
159 VHOST_USER_SET_VRING_NUM = 8,
160 VHOST_USER_SET_VRING_ADDR = 9,
161 VHOST_USER_SET_VRING_BASE = 10,
162 VHOST_USER_GET_VRING_BASE = 11,
163 VHOST_USER_SET_VRING_KICK = 12,
164 VHOST_USER_SET_VRING_CALL = 13,
165 VHOST_USER_SET_VRING_ERR = 14,
166 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
167 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
168 VHOST_USER_GET_QUEUE_NUM = 17,
169 VHOST_USER_SET_VRING_ENABLE = 18,
173 // vring_desc I/O buffer descriptor
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;
185 volatile uint16_t idx;
186 uint16_t ring[VHOST_VRING_MAX_SIZE];
187 } __attribute ((packed)) vring_avail_t;
193 struct /* vring_used_elem */
197 } ring[VHOST_VRING_MAX_SIZE];
198 } __attribute ((packed)) vring_used_t;
208 } __attribute ((packed)) virtio_net_hdr_t;
211 virtio_net_hdr_t hdr;
213 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
215 typedef struct vhost_user_msg {
216 vhost_user_req_t request;
222 vhost_vring_state_t state;
223 vhost_vring_addr_t addr;
224 vhost_user_memory_t memory;
225 vhost_user_log_t log;
227 } __attribute ((packed)) vhost_user_msg_t;
232 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
236 u16 n_since_last_int;
238 vring_avail_t *avail;
244 //Put non-runtime in a different cache line
245 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
251 /* The rx queue policy (interrupt/adaptive/polling) for this queue */
253 } vhost_user_vring_t;
255 #define VHOST_USER_EVENT_START_TIMER 1
256 #define VHOST_USER_EVENT_STOP_TIMER 2
260 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
263 u32 unix_server_index;
265 char sock_filename[256];
268 u32 hw_if_index, sw_if_index;
270 //Feature negotiation
273 u64 protocol_features;
275 //Memory region information
277 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
278 void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
279 u64 region_guest_addr_lo[VHOST_MEMORY_MAX_NREGIONS];
280 u64 region_guest_addr_hi[VHOST_MEMORY_MAX_NREGIONS];
281 u32 region_mmap_fd[VHOST_MEMORY_MAX_NREGIONS];
284 vhost_user_vring_t vrings[VHOST_VRING_MAX_N];
285 volatile u32 *vring_locks[VHOST_VRING_MAX_N];
287 int virtio_net_hdr_sz;
293 /* Whether to use spinlock or per_cpu_tx_qid assignment */
297 /* Vector of active rx queues for this interface */
310 u16 qid; /** The interface queue index (Not the virtio vring idx) */
311 u16 device_index; /** The device index */
312 u32 virtio_ring_flags; /** Runtime queue flags **/
313 u16 first_desc_len; /** Length of the first data descriptor **/
314 virtio_net_hdr_mrg_rxbuf_t hdr; /** Virtio header **/
318 #define VHOST_USER_RX_BUFFERS_N (2 * VLIB_FRAME_SIZE + 2)
319 #define VHOST_USER_COPY_ARRAY_N (4 * VLIB_FRAME_SIZE)
324 u32 rx_buffers[VHOST_USER_RX_BUFFERS_N];
326 virtio_net_hdr_mrg_rxbuf_t tx_headers[VLIB_FRAME_SIZE];
327 vhost_copy_t copy[VHOST_USER_COPY_ARRAY_N];
329 /* This is here so it doesn't end-up
330 * using stack or registers. */
331 vhost_trace_t *current_trace;
336 mhash_t if_index_by_sock_name;
338 vhost_user_intf_t *vhost_user_interfaces;
339 u32 *show_dev_instance_by_real_dev_instance;
342 int dont_dump_vhost_user_memory;
344 /** Per-CPU data for vhost-user */
347 /** Pseudo random iterator */
350 /* The number of rx interface/queue pairs in interrupt mode */
354 vlib_log_class_t log_default;
361 u32 virtio_net_hdr_sz;
364 u8 sock_filename[256];
367 } vhost_user_intf_details_t;
369 int vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
370 vhost_user_intf_details_t ** out_vuids);
372 extern vlib_node_registration_t vhost_user_send_interrupt_node;
373 extern vnet_device_class_t vhost_user_device_class;
374 extern vlib_node_registration_t vhost_user_input_node;
375 extern vhost_user_main_t vhost_user_main;
380 * fd.io coding-style-patch-verification: ON
383 * eval: (c-set-style "gnu")