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 VIRTQ_DESC_F_NEXT 1
27 #define VIRTQ_DESC_F_INDIRECT 4
28 #define VHOST_USER_REPLY_MASK (0x1 << 2)
30 #define VHOST_USER_PROTOCOL_F_MQ 0
31 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
32 #define VHOST_VRING_F_LOG 0
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))
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
44 #define VRING_USED_F_NO_NOTIFY 1
45 #define VRING_AVAIL_F_NO_INTERRUPT 1
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)
61 #define _(f,n) FEAT_##f = (n),
62 foreach_virtio_net_feature
64 } virtio_net_feature_t;
66 int vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
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 int vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
71 const char *sock_filename, u8 is_server,
72 u32 sw_if_index, u64 feature_mask,
73 u8 renumber, u32 custom_dev_instance);
74 int vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
78 typedef struct vhost_user_memory_region
84 } __attribute ((packed)) vhost_user_memory_region_t;
86 typedef struct vhost_user_memory
90 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
91 } __attribute ((packed)) vhost_user_memory_t;
96 } __attribute ((packed)) vhost_vring_state_t;
101 u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
102 } __attribute ((packed)) vhost_vring_addr_t;
104 typedef struct vhost_user_log
108 } __attribute ((packed)) vhost_user_log_t;
110 typedef enum vhost_user_req
113 VHOST_USER_GET_FEATURES = 1,
114 VHOST_USER_SET_FEATURES = 2,
115 VHOST_USER_SET_OWNER = 3,
116 VHOST_USER_RESET_OWNER = 4,
117 VHOST_USER_SET_MEM_TABLE = 5,
118 VHOST_USER_SET_LOG_BASE = 6,
119 VHOST_USER_SET_LOG_FD = 7,
120 VHOST_USER_SET_VRING_NUM = 8,
121 VHOST_USER_SET_VRING_ADDR = 9,
122 VHOST_USER_SET_VRING_BASE = 10,
123 VHOST_USER_GET_VRING_BASE = 11,
124 VHOST_USER_SET_VRING_KICK = 12,
125 VHOST_USER_SET_VRING_CALL = 13,
126 VHOST_USER_SET_VRING_ERR = 14,
127 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
128 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
129 VHOST_USER_GET_QUEUE_NUM = 17,
130 VHOST_USER_SET_VRING_ENABLE = 18,
134 // vring_desc I/O buffer descriptor
137 uint64_t addr; // packet data buffer address
138 uint32_t len; // packet data buffer size
139 uint16_t flags; // (see below)
140 uint16_t next; // optional index next descriptor in chain
141 } __attribute ((packed)) vring_desc_t;
146 volatile uint16_t idx;
147 uint16_t ring[VHOST_VRING_MAX_SIZE];
148 } __attribute ((packed)) vring_avail_t;
154 struct /* vring_used_elem */
158 } ring[VHOST_VRING_MAX_SIZE];
159 } __attribute ((packed)) vring_used_t;
169 } __attribute ((packed)) virtio_net_hdr_t;
172 virtio_net_hdr_t hdr;
174 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
176 typedef struct vhost_user_msg {
177 vhost_user_req_t request;
183 vhost_vring_state_t state;
184 vhost_vring_addr_t addr;
185 vhost_user_memory_t memory;
186 vhost_user_log_t log;
188 } __attribute ((packed)) vhost_user_msg_t;
193 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
197 u16 n_since_last_int;
199 vring_avail_t *avail;
205 //Put non-runtime in a different cache line
206 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
212 /* The rx queue policy (interrupt/adaptive/polling) for this queue */
214 } vhost_user_vring_t;
216 #define VHOST_USER_EVENT_START_TIMER 1
217 #define VHOST_USER_EVENT_STOP_TIMER 2
221 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
224 u32 unix_server_index;
226 char sock_filename[256];
229 u32 hw_if_index, sw_if_index;
231 //Feature negotiation
234 u64 protocol_features;
236 //Memory region information
238 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
239 void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
240 u64 region_guest_addr_lo[VHOST_MEMORY_MAX_NREGIONS];
241 u64 region_guest_addr_hi[VHOST_MEMORY_MAX_NREGIONS];
242 u32 region_mmap_fd[VHOST_MEMORY_MAX_NREGIONS];
245 vhost_user_vring_t vrings[VHOST_VRING_MAX_N];
246 volatile u32 *vring_locks[VHOST_VRING_MAX_N];
248 int virtio_net_hdr_sz;
254 /* Whether to use spinlock or per_cpu_tx_qid assignment */
258 /* Vector of active rx queues for this interface */
271 u16 qid; /** The interface queue index (Not the virtio vring idx) */
272 u16 device_index; /** The device index */
273 u32 virtio_ring_flags; /** Runtime queue flags **/
274 u16 first_desc_len; /** Length of the first data descriptor **/
275 virtio_net_hdr_mrg_rxbuf_t hdr; /** Virtio header **/
279 #define VHOST_USER_RX_BUFFERS_N (2 * VLIB_FRAME_SIZE + 2)
280 #define VHOST_USER_COPY_ARRAY_N (4 * VLIB_FRAME_SIZE)
285 u32 rx_buffers[VHOST_USER_RX_BUFFERS_N];
287 virtio_net_hdr_mrg_rxbuf_t tx_headers[VLIB_FRAME_SIZE];
288 vhost_copy_t copy[VHOST_USER_COPY_ARRAY_N];
290 /* This is here so it doesn't end-up
291 * using stack or registers. */
292 vhost_trace_t *current_trace;
297 mhash_t if_index_by_sock_name;
299 vhost_user_intf_t *vhost_user_interfaces;
300 u32 *show_dev_instance_by_real_dev_instance;
303 int dont_dump_vhost_user_memory;
305 /** Per-CPU data for vhost-user */
308 /** Pseudo random iterator */
311 /* The number of rx interface/queue pairs in interrupt mode */
319 u32 virtio_net_hdr_sz;
322 u8 sock_filename[256];
325 } vhost_user_intf_details_t;
327 int vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
328 vhost_user_intf_details_t ** out_vuids);
333 * fd.io coding-style-patch-verification: ON
336 * eval: (c-set-style "gnu")