2 *------------------------------------------------------------------
3 * Copyright (c) 2017 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
18 #ifndef _VNET_DEVICES_VIRTIO_VIRTIO_H_
19 #define _VNET_DEVICES_VIRTIO_VIRTIO_H_
21 #include <linux/virtio_config.h>
22 #include <linux/virtio_net.h>
23 #include <linux/virtio_pci.h>
24 #include <linux/virtio_ring.h>
26 #define foreach_virtio_net_features \
27 _ (VIRTIO_NET_F_CSUM, 0) /* Host handles pkts w/ partial csum */ \
28 _ (VIRTIO_NET_F_GUEST_CSUM, 1) /* Guest handles pkts w/ partial csum */ \
29 _ (VIRTIO_NET_F_CTRL_GUEST_OFFLOADS, 2) /* Dynamic offload configuration. */ \
30 _ (VIRTIO_NET_F_MTU, 3) /* Initial MTU advice. */ \
31 _ (VIRTIO_NET_F_MAC, 5) /* Host has given MAC address. */ \
32 _ (VIRTIO_NET_F_GSO, 6) /* Host handles pkts w/ any GSO. */ \
33 _ (VIRTIO_NET_F_GUEST_TSO4, 7) /* Guest can handle TSOv4 in. */ \
34 _ (VIRTIO_NET_F_GUEST_TSO6, 8) /* Guest can handle TSOv6 in. */ \
35 _ (VIRTIO_NET_F_GUEST_ECN, 9) /* Guest can handle TSO[6] w/ ECN in. */ \
36 _ (VIRTIO_NET_F_GUEST_UFO, 10) /* Guest can handle UFO in. */ \
37 _ (VIRTIO_NET_F_HOST_TSO4, 11) /* Host can handle TSOv4 in. */ \
38 _ (VIRTIO_NET_F_HOST_TSO6, 12) /* Host can handle TSOv6 in. */ \
39 _ (VIRTIO_NET_F_HOST_ECN, 13) /* Host can handle TSO[6] w/ ECN in. */ \
40 _ (VIRTIO_NET_F_HOST_UFO, 14) /* Host can handle UFO in. */ \
41 _ (VIRTIO_NET_F_MRG_RXBUF, 15) /* Host can merge receive buffers. */ \
42 _ (VIRTIO_NET_F_STATUS, 16) /* virtio_net_config.status available */ \
43 _ (VIRTIO_NET_F_CTRL_VQ, 17) /* Control channel available */ \
44 _ (VIRTIO_NET_F_CTRL_RX, 18) /* Control channel RX mode support */ \
45 _ (VIRTIO_NET_F_CTRL_VLAN, 19) /* Control channel VLAN filtering */ \
46 _ (VIRTIO_NET_F_CTRL_RX_EXTRA, 20) /* Extra RX mode control support */ \
47 _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21) /* Guest can announce device on the network */ \
48 _ (VIRTIO_NET_F_MQ, 22) /* Device supports Receive Flow Steering */ \
49 _ (VIRTIO_NET_F_CTRL_MAC_ADDR, 23) /* Set MAC address */ \
50 _ (VIRTIO_F_NOTIFY_ON_EMPTY, 24) \
51 _ (VHOST_F_LOG_ALL, 26) /* Log all write descriptors */ \
52 _ (VIRTIO_F_ANY_LAYOUT, 27) /* Can the device handle any descriptor layout */ \
53 _ (VIRTIO_RING_F_INDIRECT_DESC, 28) /* Support indirect buffer descriptors */ \
54 _ (VIRTIO_RING_F_EVENT_IDX, 29) /* The Guest publishes the used index for which it expects an interrupt \
55 * at the end of the avail ring. Host should ignore the avail->flags field. */ \
56 /* The Host publishes the avail index for which it expects a kick \
57 * at the end of the used ring. Guest should ignore the used->flags field. */ \
58 _ (VHOST_USER_F_PROTOCOL_FEATURES, 30) \
59 _ (VIRTIO_F_VERSION_1, 32)
62 #define foreach_virtio_if_flag \
63 _(0, ADMIN_UP, "admin-up") \
64 _(1, DELETING, "deleting")
68 #define _(a, b, c) VIRTIO_IF_FLAG_##b = (1 << a),
69 foreach_virtio_if_flag
73 #define VIRTIO_NUM_RX_DESC 256
74 #define VIRTIO_NUM_TX_DESC 256
76 #define VIRTIO_FEATURE(X) (1ULL << X)
78 #define TX_QUEUE(X) ((X*2) + 1)
79 #define RX_QUEUE(X) (X*2)
80 #define TX_QUEUE_ACCESS(X) (X/2)
81 #define RX_QUEUE_ACCESS(X) (X/2)
83 #define foreach_virtio_if_types \
90 #define _(a, b) VIRTIO_IF_TYPE_##a = (1 << b),
91 foreach_virtio_if_types
93 VIRTIO_IF_N_TYPES = (1 << 4),
101 u16 max_virtqueue_pairs;
103 } virtio_net_config_t;
105 #define VIRTIO_RING_FLAG_MASK_INT 1
109 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
110 struct vring_desc *desc;
111 struct vring_used *used;
112 struct vring_avail *avail;
113 clib_spinlock_t lockp;
118 u8 buffer_pool_index;
121 #define VRING_TX_OUT_OF_ORDER 1
126 u16 last_kick_avail_idx;
143 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
150 u16 virtio_net_hdr_sz;
151 virtio_if_type_t type;
157 u32 per_interface_next_index;
162 virtio_vring_t *rxq_vrings;
163 virtio_vring_t *txq_vrings;
164 u64 features, remote_features;
168 u8 support_int_mode; /* support interrupt mode */
178 ip4_address_t host_ip4_addr;
179 u8 host_ip4_prefix_len;
180 ip6_address_t host_ip6_addr;
181 u8 host_ip6_prefix_len;
184 int csum_offload_enabled;
186 virtio_vring_t *cxq_vring;
192 vlib_log_class_t log_default;
194 virtio_if_t *interfaces;
197 extern virtio_main_t virtio_main;
198 extern vnet_device_class_t virtio_device_class;
199 extern vlib_node_registration_t virtio_input_node;
201 clib_error_t *virtio_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 idx,
203 clib_error_t *virtio_vring_free_rx (vlib_main_t * vm, virtio_if_t * vif,
205 clib_error_t *virtio_vring_free_tx (vlib_main_t * vm, virtio_if_t * vif,
207 void virtio_vring_set_numa_node (vlib_main_t * vm, virtio_if_t * vif,
209 extern void virtio_free_used_desc (vlib_main_t * vm, virtio_vring_t * vring);
210 extern void virtio_free_rx_buffers (vlib_main_t * vm, virtio_vring_t * vring);
211 extern void virtio_set_net_hdr_size (virtio_if_t * vif);
212 extern void virtio_show (vlib_main_t * vm, u32 * hw_if_indices, u8 show_descr,
214 extern void virtio_pci_legacy_notify_queue (vlib_main_t * vm,
215 virtio_if_t * vif, u16 queue_id);
216 format_function_t format_virtio_device_name;
217 format_function_t format_virtio_log_name;
219 static_always_inline void
220 virtio_kick (vlib_main_t * vm, virtio_vring_t * vring, virtio_if_t * vif)
222 if (vif->type == VIRTIO_IF_TYPE_PCI)
223 virtio_pci_legacy_notify_queue (vm, vif, vring->queue_id);
229 r = write (vring->kick_fd, &x, sizeof (x));
230 vring->last_kick_avail_idx = vring->avail->idx;
235 #define virtio_log_debug(vif, f, ...) \
237 vlib_log(VLIB_LOG_LEVEL_DEBUG, virtio_main.log_default, \
238 "%U: " f, format_virtio_log_name, vif, \
242 #define virtio_log_warning(vif, f, ...) \
244 vlib_log(VLIB_LOG_LEVEL_WARNING, virtio_main.log_default, \
245 "%U: " f, format_virtio_log_name, vif, \
249 #define virtio_log_error(vif, f, ...) \
251 vlib_log(VLIB_LOG_LEVEL_ERR, virtio_main.log_default, \
252 "%U: " f, format_virtio_log_name, vif, \
256 #endif /* _VNET_DEVICES_VIRTIO_VIRTIO_H_ */
259 * fd.io coding-style-patch-verification: ON
262 * eval: (c-set-style "gnu")