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 foreach_virtio_net_feature \
49 _ (VIRTIO_NET_F_MRG_RXBUF, 15) \
50 _ (VIRTIO_NET_F_CTRL_VQ, 17) \
51 _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21) \
52 _ (VIRTIO_NET_F_MQ, 22) \
53 _ (VHOST_F_LOG_ALL, 26) \
54 _ (VIRTIO_F_ANY_LAYOUT, 27) \
55 _ (VIRTIO_F_INDIRECT_DESC, 28) \
56 _ (VHOST_USER_F_PROTOCOL_FEATURES, 30) \
57 _ (VIRTIO_F_VERSION_1, 32)
62 #define _(f,n) FEAT_##f = (n),
63 foreach_virtio_net_feature
65 } virtio_net_feature_t;
67 int vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
68 const char *sock_filename, u8 is_server,
69 u32 * sw_if_index, u64 feature_mask,
70 u8 renumber, u32 custom_dev_instance, u8 * hwaddr);
71 int vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
72 const char *sock_filename, u8 is_server,
73 u32 sw_if_index, u64 feature_mask,
74 u8 renumber, u32 custom_dev_instance);
75 int vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
79 typedef struct vhost_user_memory_region
85 } __attribute ((packed)) vhost_user_memory_region_t;
87 typedef struct vhost_user_memory
91 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
92 } __attribute ((packed)) vhost_user_memory_t;
97 } __attribute ((packed)) vhost_vring_state_t;
102 u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
103 } __attribute ((packed)) vhost_vring_addr_t;
105 typedef struct vhost_user_log
109 } __attribute ((packed)) vhost_user_log_t;
111 typedef enum vhost_user_req
114 VHOST_USER_GET_FEATURES = 1,
115 VHOST_USER_SET_FEATURES = 2,
116 VHOST_USER_SET_OWNER = 3,
117 VHOST_USER_RESET_OWNER = 4,
118 VHOST_USER_SET_MEM_TABLE = 5,
119 VHOST_USER_SET_LOG_BASE = 6,
120 VHOST_USER_SET_LOG_FD = 7,
121 VHOST_USER_SET_VRING_NUM = 8,
122 VHOST_USER_SET_VRING_ADDR = 9,
123 VHOST_USER_SET_VRING_BASE = 10,
124 VHOST_USER_GET_VRING_BASE = 11,
125 VHOST_USER_SET_VRING_KICK = 12,
126 VHOST_USER_SET_VRING_CALL = 13,
127 VHOST_USER_SET_VRING_ERR = 14,
128 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
129 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
130 VHOST_USER_GET_QUEUE_NUM = 17,
131 VHOST_USER_SET_VRING_ENABLE = 18,
135 // vring_desc I/O buffer descriptor
138 uint64_t addr; // packet data buffer address
139 uint32_t len; // packet data buffer size
140 uint16_t flags; // (see below)
141 uint16_t next; // optional index next descriptor in chain
142 } __attribute ((packed)) vring_desc_t;
147 volatile uint16_t idx;
148 uint16_t ring[VHOST_VRING_MAX_SIZE];
149 } __attribute ((packed)) vring_avail_t;
155 struct /* vring_used_elem */
159 } ring[VHOST_VRING_MAX_SIZE];
160 } __attribute ((packed)) vring_used_t;
170 } __attribute ((packed)) virtio_net_hdr_t;
173 virtio_net_hdr_t hdr;
175 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
177 typedef struct vhost_user_msg {
178 vhost_user_req_t request;
184 vhost_vring_state_t state;
185 vhost_vring_addr_t addr;
186 vhost_user_memory_t memory;
187 vhost_user_log_t log;
189 } __attribute ((packed)) vhost_user_msg_t;
194 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
198 u16 n_since_last_int;
200 vring_avail_t *avail;
206 //Put non-runtime in a different cache line
207 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
213 /* The rx queue policy (interrupt/adaptive/polling) for this queue */
215 } vhost_user_vring_t;
217 #define VHOST_USER_EVENT_START_TIMER 1
218 #define VHOST_USER_EVENT_STOP_TIMER 2
222 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
225 u32 unix_server_index;
227 char sock_filename[256];
230 u32 hw_if_index, sw_if_index;
232 //Feature negotiation
235 u64 protocol_features;
237 //Memory region information
239 vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
240 void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
241 u64 region_guest_addr_lo[VHOST_MEMORY_MAX_NREGIONS];
242 u64 region_guest_addr_hi[VHOST_MEMORY_MAX_NREGIONS];
243 u32 region_mmap_fd[VHOST_MEMORY_MAX_NREGIONS];
246 vhost_user_vring_t vrings[VHOST_VRING_MAX_N];
247 volatile u32 *vring_locks[VHOST_VRING_MAX_N];
249 int virtio_net_hdr_sz;
255 /* Whether to use spinlock or per_cpu_tx_qid assignment */
259 /* Vector of active rx queues for this interface */
272 u16 qid; /** The interface queue index (Not the virtio vring idx) */
273 u16 device_index; /** The device index */
274 u32 virtio_ring_flags; /** Runtime queue flags **/
275 u16 first_desc_len; /** Length of the first data descriptor **/
276 virtio_net_hdr_mrg_rxbuf_t hdr; /** Virtio header **/
280 #define VHOST_USER_RX_BUFFERS_N (2 * VLIB_FRAME_SIZE + 2)
281 #define VHOST_USER_COPY_ARRAY_N (4 * VLIB_FRAME_SIZE)
286 u32 rx_buffers[VHOST_USER_RX_BUFFERS_N];
288 virtio_net_hdr_mrg_rxbuf_t tx_headers[VLIB_FRAME_SIZE];
289 vhost_copy_t copy[VHOST_USER_COPY_ARRAY_N];
291 /* This is here so it doesn't end-up
292 * using stack or registers. */
293 vhost_trace_t *current_trace;
298 mhash_t if_index_by_sock_name;
300 vhost_user_intf_t *vhost_user_interfaces;
301 u32 *show_dev_instance_by_real_dev_instance;
304 int dont_dump_vhost_user_memory;
306 /** Per-CPU data for vhost-user */
309 /** Pseudo random iterator */
312 /* The number of rx interface/queue pairs in interrupt mode */
315 /* debug on or off */
323 u32 virtio_net_hdr_sz;
326 u8 sock_filename[256];
329 } vhost_user_intf_details_t;
331 int vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
332 vhost_user_intf_details_t ** out_vuids);
337 * fd.io coding-style-patch-verification: ON
340 * eval: (c-set-style "gnu")