2 * Copyright (c) 2011, Bryan Venteicher <bryanv@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice unmodified, this list of conditions, and the following
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 #ifndef _IF_VTNETVAR_H
30 #define _IF_VTNETVAR_H
34 struct vtnet_statistics {
35 uint64_t mbuf_alloc_failed;
37 uint64_t rx_frame_too_large;
38 uint64_t rx_enq_replacement_failed;
39 uint64_t rx_mergeable_failed;
40 uint64_t rx_csum_bad_ethtype;
41 uint64_t rx_csum_bad_ipproto;
42 uint64_t rx_csum_bad_offset;
43 uint64_t rx_csum_bad_proto;
44 uint64_t tx_csum_bad_ethtype;
45 uint64_t tx_tso_bad_ethtype;
46 uint64_t tx_tso_not_tcp;
47 uint64_t tx_defragged;
48 uint64_t tx_defrag_failed;
51 * These are accumulated from each Rx/Tx queue.
53 uint64_t rx_csum_failed;
54 uint64_t rx_csum_offloaded;
55 uint64_t rx_task_rescheduled;
56 uint64_t tx_csum_offloaded;
57 uint64_t tx_tso_offloaded;
58 uint64_t tx_task_rescheduled;
61 struct vtnet_rxq_stats {
62 uint64_t vrxs_ipackets; /* if_ipackets */
63 uint64_t vrxs_ibytes; /* if_ibytes */
64 uint64_t vrxs_iqdrops; /* if_iqdrops */
65 uint64_t vrxs_ierrors; /* if_ierrors */
67 uint64_t vrxs_csum_failed;
68 uint64_t vrxs_rescheduled;
73 struct vtnet_softc *vtnrx_sc;
74 struct virtqueue *vtnrx_vq;
75 struct sglist *vtnrx_sg;
77 struct vtnet_rxq_stats vtnrx_stats;
78 struct taskqueue *vtnrx_tq;
79 struct task vtnrx_intrtask;
81 } __aligned(CACHE_LINE_SIZE);
83 #define VTNET_RXQ_LOCK(_rxq) mtx_lock(&(_rxq)->vtnrx_mtx)
84 #define VTNET_RXQ_UNLOCK(_rxq) mtx_unlock(&(_rxq)->vtnrx_mtx)
85 #define VTNET_RXQ_LOCK_ASSERT(_rxq) \
86 mtx_assert(&(_rxq)->vtnrx_mtx, MA_OWNED)
87 #define VTNET_RXQ_LOCK_ASSERT_NOTOWNED(_rxq) \
88 mtx_assert(&(_rxq)->vtnrx_mtx, MA_NOTOWNED)
90 struct vtnet_txq_stats {
91 uint64_t vtxs_opackets; /* if_opackets */
92 uint64_t vtxs_obytes; /* if_obytes */
93 uint64_t vtxs_omcasts; /* if_omcasts */
96 uint64_t vtxs_rescheduled;
100 struct mtx vtntx_mtx;
101 struct vtnet_softc *vtntx_sc;
102 struct virtqueue *vtntx_vq;
103 struct sglist *vtntx_sg;
104 #ifndef VTNET_LEGACY_TX
105 struct buf_ring *vtntx_br;
109 struct vtnet_txq_stats vtntx_stats;
110 struct taskqueue *vtntx_tq;
111 struct task vtntx_intrtask;
112 #ifndef VTNET_LEGACY_TX
113 struct task vtntx_defrtask;
116 } __aligned(CACHE_LINE_SIZE);
118 #define VTNET_TXQ_LOCK(_txq) mtx_lock(&(_txq)->vtntx_mtx)
119 #define VTNET_TXQ_TRYLOCK(_txq) mtx_trylock(&(_txq)->vtntx_mtx)
120 #define VTNET_TXQ_UNLOCK(_txq) mtx_unlock(&(_txq)->vtntx_mtx)
121 #define VTNET_TXQ_LOCK_ASSERT(_txq) \
122 mtx_assert(&(_txq)->vtntx_mtx, MA_OWNED)
123 #define VTNET_TXQ_LOCK_ASSERT_NOTOWNED(_txq) \
124 mtx_assert(&(_txq)->vtntx_mtx, MA_NOTOWNED)
128 struct ifnet *vtnet_ifp;
129 struct vtnet_rxq *vtnet_rxqs;
130 struct vtnet_txq *vtnet_txqs;
132 uint32_t vtnet_flags;
133 #define VTNET_FLAG_SUSPENDED 0x0001
134 #define VTNET_FLAG_MAC 0x0002
135 #define VTNET_FLAG_CTRL_VQ 0x0004
136 #define VTNET_FLAG_CTRL_RX 0x0008
137 #define VTNET_FLAG_CTRL_MAC 0x0010
138 #define VTNET_FLAG_VLAN_FILTER 0x0020
139 #define VTNET_FLAG_TSO_ECN 0x0040
140 #define VTNET_FLAG_MRG_RXBUFS 0x0080
141 #define VTNET_FLAG_LRO_NOMRG 0x0100
142 #define VTNET_FLAG_MULTIQ 0x0200
143 #define VTNET_FLAG_EVENT_IDX 0x0400
145 int vtnet_link_active;
147 int vtnet_rx_process_limit;
151 int vtnet_rx_new_clsize;
152 int vtnet_tx_intr_thresh;
155 int vtnet_act_vq_pairs;
156 int vtnet_max_vq_pairs;
158 struct virtqueue *vtnet_ctrl_vq;
159 struct vtnet_mac_filter *vtnet_mac_filter;
160 uint32_t *vtnet_vlan_filter;
162 uint64_t vtnet_features;
163 struct vtnet_statistics vtnet_stats;
164 struct callout vtnet_tick_ch;
165 struct ifmedia vtnet_media;
166 eventhandler_tag vtnet_vlan_attach;
167 eventhandler_tag vtnet_vlan_detach;
169 struct mtx vtnet_mtx;
170 char vtnet_mtx_name[16];
171 char vtnet_hwaddr[ETHER_ADDR_LEN];
175 * Maximum number of queue pairs we will autoconfigure to.
177 #define VTNET_MAX_QUEUE_PAIRS 8
180 * Additional completed entries can appear in a virtqueue before we can
181 * reenable interrupts. Number of times to retry before scheduling the
182 * taskqueue to process the completed entries.
184 #define VTNET_INTR_DISABLE_RETRIES 4
187 * Similarly, additional completed entries can appear in a virtqueue
188 * between when lasted checked and before notifying the host. Number
189 * of times to retry before scheduling the taskqueue to process the
192 #define VTNET_NOTIFY_RETRIES 4
195 * Fake the media type. The host does not provide us with any real media
198 #define VTNET_MEDIATYPE (IFM_ETHER | IFM_10G_T | IFM_FDX)
201 * Number of words to allocate for the VLAN shadow table. There is one
204 #define VTNET_VLAN_FILTER_NWORDS (4096 / 32)
207 * When mergeable buffers are not negotiated, the vtnet_rx_header structure
208 * below is placed at the beginning of the mbuf data. Use 4 bytes of pad to
209 * both keep the VirtIO header and the data non-contiguous and to keep the
210 * frame's payload 4 byte aligned.
212 * When mergeable buffers are negotiated, the host puts the VirtIO header in
213 * the beginning of the first mbuf's data.
215 #define VTNET_RX_HEADER_PAD 4
216 struct vtnet_rx_header {
217 struct virtio_net_hdr vrh_hdr;
218 char vrh_pad[VTNET_RX_HEADER_PAD];
222 * For each outgoing frame, the vtnet_tx_header below is allocated from
223 * the vtnet_tx_header_zone.
225 struct vtnet_tx_header {
227 struct virtio_net_hdr hdr;
228 struct virtio_net_hdr_mrg_rxbuf mhdr;
231 struct mbuf *vth_mbuf;
235 * The VirtIO specification does not place a limit on the number of MAC
236 * addresses the guest driver may request to be filtered. In practice,
237 * the host is constrained by available resources. To simplify this driver,
238 * impose a reasonably high limit of MAC addresses we will filter before
239 * falling back to promiscuous or all-multicast modes.
241 #define VTNET_MAX_MAC_ENTRIES 128
243 struct vtnet_mac_table {
245 uint8_t macs[VTNET_MAX_MAC_ENTRIES][ETHER_ADDR_LEN];
248 struct vtnet_mac_filter {
249 struct vtnet_mac_table vmf_unicast;
250 uint32_t vmf_pad; /* Make tables non-contiguous. */
251 struct vtnet_mac_table vmf_multicast;
255 * The MAC filter table is malloc(9)'d when needed. Ensure it will
256 * always fit in one segment.
258 CTASSERT(sizeof(struct vtnet_mac_filter) <= PAGE_SIZE);
260 #define VTNET_TX_TIMEOUT 5
261 #define VTNET_CSUM_OFFLOAD (CSUM_TCP | CSUM_UDP | CSUM_SCTP)
262 #define VTNET_CSUM_OFFLOAD_IPV6 (CSUM_TCP_IPV6 | CSUM_UDP_IPV6 | CSUM_SCTP_IPV6)
264 #define VTNET_CSUM_ALL_OFFLOAD \
265 (VTNET_CSUM_OFFLOAD | VTNET_CSUM_OFFLOAD_IPV6 | CSUM_TSO)
267 /* Features desired/implemented by this driver. */
268 #define VTNET_FEATURES \
269 (VIRTIO_NET_F_MAC | \
270 VIRTIO_NET_F_STATUS | \
271 VIRTIO_NET_F_CTRL_VQ | \
272 VIRTIO_NET_F_CTRL_RX | \
273 VIRTIO_NET_F_CTRL_MAC_ADDR | \
274 VIRTIO_NET_F_CTRL_VLAN | \
275 VIRTIO_NET_F_CSUM | \
277 VIRTIO_NET_F_HOST_TSO4 | \
278 VIRTIO_NET_F_HOST_TSO6 | \
279 VIRTIO_NET_F_HOST_ECN | \
280 VIRTIO_NET_F_GUEST_CSUM | \
281 VIRTIO_NET_F_GUEST_TSO4 | \
282 VIRTIO_NET_F_GUEST_TSO6 | \
283 VIRTIO_NET_F_GUEST_ECN | \
284 VIRTIO_NET_F_MRG_RXBUF | \
286 VIRTIO_RING_F_EVENT_IDX | \
287 VIRTIO_RING_F_INDIRECT_DESC)
290 * The VIRTIO_NET_F_HOST_TSO[46] features permit us to send the host
291 * frames larger than 1514 bytes.
293 #define VTNET_TSO_FEATURES (VIRTIO_NET_F_GSO | VIRTIO_NET_F_HOST_TSO4 | \
294 VIRTIO_NET_F_HOST_TSO6 | VIRTIO_NET_F_HOST_ECN)
297 * The VIRTIO_NET_F_GUEST_TSO[46] features permit the host to send us
298 * frames larger than 1514 bytes. We do not yet support software LRO
301 #define VTNET_LRO_FEATURES (VIRTIO_NET_F_GUEST_TSO4 | \
302 VIRTIO_NET_F_GUEST_TSO6 | VIRTIO_NET_F_GUEST_ECN)
304 #define VTNET_MAX_MTU 65536
305 #define VTNET_MAX_RX_SIZE 65550
308 * Used to preallocate the Vq indirect descriptors. The first segment
309 * is reserved for the header, except for mergeable buffers since the
310 * header is placed inline with the data.
312 #define VTNET_MRG_RX_SEGS 1
313 #define VTNET_MIN_RX_SEGS 2
314 #define VTNET_MAX_RX_SEGS 34
315 #define VTNET_MIN_TX_SEGS 4
316 #define VTNET_MAX_TX_SEGS 64
319 * Assert we can receive and transmit the maximum with regular
322 CTASSERT(((VTNET_MAX_RX_SEGS - 1) * MCLBYTES) >= VTNET_MAX_RX_SIZE);
323 CTASSERT(((VTNET_MAX_TX_SEGS - 1) * MCLBYTES) >= VTNET_MAX_MTU);
326 * Number of slots in the Tx bufrings. This value matches most other
327 * multiqueue drivers.
329 #define VTNET_DEFAULT_BUFRING_SIZE 4096
332 * Determine how many mbufs are in each receive buffer. For LRO without
333 * mergeable buffers, we must allocate an mbuf chain large enough to
334 * hold both the vtnet_rx_header and the maximum receivable data.
336 #define VTNET_NEEDED_RX_MBUFS(_sc, _clsize) \
337 ((_sc)->vtnet_flags & VTNET_FLAG_LRO_NOMRG) == 0 ? 1 : \
338 howmany(sizeof(struct vtnet_rx_header) + VTNET_MAX_RX_SIZE, \
341 #define VTNET_CORE_MTX(_sc) &(_sc)->vtnet_mtx
342 #define VTNET_CORE_LOCK(_sc) mtx_lock(VTNET_CORE_MTX((_sc)))
343 #define VTNET_CORE_UNLOCK(_sc) mtx_unlock(VTNET_CORE_MTX((_sc)))
344 #define VTNET_CORE_LOCK_DESTROY(_sc) mtx_destroy(VTNET_CORE_MTX((_sc)))
345 #define VTNET_CORE_LOCK_ASSERT(_sc) \
346 mtx_assert(VTNET_CORE_MTX((_sc)), MA_OWNED)
347 #define VTNET_CORE_LOCK_ASSERT_NOTOWNED(_sc) \
348 mtx_assert(VTNET_CORE_MTX((_sc)), MA_NOTOWNED)
350 #define VTNET_CORE_LOCK_INIT(_sc) do { \
351 snprintf((_sc)->vtnet_mtx_name, sizeof((_sc)->vtnet_mtx_name), \
352 "%s", device_get_nameunit((_sc)->vtnet_dev)); \
353 mtx_init(VTNET_CORE_MTX((_sc)), (_sc)->vtnet_mtx_name, \
354 "VTNET Core Lock", MTX_DEF); \
357 #endif /* _IF_VTNETVAR_H */