1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2011, Bryan Venteicher <bryanv@FreeBSD.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice unmodified, this list of conditions, and the following 12 * disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _IF_VTNETVAR_H 32 #define _IF_VTNETVAR_H 33 34 struct vtnet_softc; 35 36 struct vtnet_statistics { 37 uint64_t mbuf_alloc_failed; 38 39 uint64_t rx_frame_too_large; 40 uint64_t rx_enq_replacement_failed; 41 uint64_t rx_mergeable_failed; 42 uint64_t rx_csum_bad_ethtype; 43 uint64_t rx_csum_bad_ipproto; 44 uint64_t rx_csum_bad_offset; 45 uint64_t rx_csum_bad_proto; 46 uint64_t tx_csum_unknown_ethtype; 47 uint64_t tx_csum_proto_mismatch; 48 uint64_t tx_tso_not_tcp; 49 uint64_t tx_tso_without_csum; 50 uint64_t tx_defragged; 51 uint64_t tx_defrag_failed; 52 53 /* 54 * These are accumulated from each Rx/Tx queue. 55 */ 56 uint64_t rx_csum_failed; 57 uint64_t rx_csum_offloaded; 58 uint64_t rx_task_rescheduled; 59 uint64_t tx_csum_offloaded; 60 uint64_t tx_tso_offloaded; 61 uint64_t tx_task_rescheduled; 62 }; 63 64 struct vtnet_rxq_stats { 65 uint64_t vrxs_ipackets; /* if_ipackets */ 66 uint64_t vrxs_ibytes; /* if_ibytes */ 67 uint64_t vrxs_iqdrops; /* if_iqdrops */ 68 uint64_t vrxs_ierrors; /* if_ierrors */ 69 uint64_t vrxs_csum; 70 uint64_t vrxs_csum_failed; 71 uint64_t vrxs_rescheduled; 72 }; 73 74 struct vtnet_rxq { 75 struct mtx vtnrx_mtx; 76 struct vtnet_softc *vtnrx_sc; 77 struct virtqueue *vtnrx_vq; 78 struct sglist *vtnrx_sg; 79 int vtnrx_id; 80 struct vtnet_rxq_stats vtnrx_stats; 81 struct taskqueue *vtnrx_tq; 82 struct task vtnrx_intrtask; 83 struct lro_ctrl vtnrx_lro; 84 #ifdef DEV_NETMAP 85 uint32_t vtnrx_nm_refill; 86 struct virtio_net_hdr_mrg_rxbuf vtnrx_shrhdr; 87 #endif /* DEV_NETMAP */ 88 char vtnrx_name[16]; 89 } __aligned(CACHE_LINE_SIZE); 90 91 #define VTNET_RXQ_LOCK(_rxq) mtx_lock(&(_rxq)->vtnrx_mtx) 92 #define VTNET_RXQ_UNLOCK(_rxq) mtx_unlock(&(_rxq)->vtnrx_mtx) 93 #define VTNET_RXQ_LOCK_ASSERT(_rxq) \ 94 mtx_assert(&(_rxq)->vtnrx_mtx, MA_OWNED) 95 #define VTNET_RXQ_LOCK_ASSERT_NOTOWNED(_rxq) \ 96 mtx_assert(&(_rxq)->vtnrx_mtx, MA_NOTOWNED) 97 98 struct vtnet_txq_stats { 99 uint64_t vtxs_opackets; /* if_opackets */ 100 uint64_t vtxs_obytes; /* if_obytes */ 101 uint64_t vtxs_omcasts; /* if_omcasts */ 102 uint64_t vtxs_csum; 103 uint64_t vtxs_tso; 104 uint64_t vtxs_rescheduled; 105 }; 106 107 struct vtnet_txq { 108 struct mtx vtntx_mtx; 109 struct vtnet_softc *vtntx_sc; 110 struct virtqueue *vtntx_vq; 111 struct sglist *vtntx_sg; 112 #ifndef VTNET_LEGACY_TX 113 struct buf_ring *vtntx_br; 114 #endif 115 int vtntx_id; 116 int vtntx_watchdog; 117 int vtntx_intr_threshold; 118 struct vtnet_txq_stats vtntx_stats; 119 struct taskqueue *vtntx_tq; 120 struct task vtntx_intrtask; 121 #ifndef VTNET_LEGACY_TX 122 struct task vtntx_defrtask; 123 #endif 124 #ifdef DEV_NETMAP 125 struct virtio_net_hdr_mrg_rxbuf vtntx_shrhdr; 126 #endif /* DEV_NETMAP */ 127 char vtntx_name[16]; 128 } __aligned(CACHE_LINE_SIZE); 129 130 #define VTNET_TXQ_LOCK(_txq) mtx_lock(&(_txq)->vtntx_mtx) 131 #define VTNET_TXQ_TRYLOCK(_txq) mtx_trylock(&(_txq)->vtntx_mtx) 132 #define VTNET_TXQ_UNLOCK(_txq) mtx_unlock(&(_txq)->vtntx_mtx) 133 #define VTNET_TXQ_LOCK_ASSERT(_txq) \ 134 mtx_assert(&(_txq)->vtntx_mtx, MA_OWNED) 135 #define VTNET_TXQ_LOCK_ASSERT_NOTOWNED(_txq) \ 136 mtx_assert(&(_txq)->vtntx_mtx, MA_NOTOWNED) 137 138 struct vtnet_softc { 139 device_t vtnet_dev; 140 struct ifnet *vtnet_ifp; 141 struct vtnet_rxq *vtnet_rxqs; 142 struct vtnet_txq *vtnet_txqs; 143 pfil_head_t vtnet_pfil; 144 uint64_t vtnet_features; 145 146 uint32_t vtnet_flags; 147 #define VTNET_FLAG_MODERN 0x0001 148 #define VTNET_FLAG_MAC 0x0002 149 #define VTNET_FLAG_CTRL_VQ 0x0004 150 #define VTNET_FLAG_CTRL_RX 0x0008 151 #define VTNET_FLAG_CTRL_MAC 0x0010 152 #define VTNET_FLAG_VLAN_FILTER 0x0020 153 #define VTNET_FLAG_TSO_ECN 0x0040 154 #define VTNET_FLAG_MRG_RXBUFS 0x0080 155 #define VTNET_FLAG_LRO_NOMRG 0x0100 156 #define VTNET_FLAG_MQ 0x0200 157 #define VTNET_FLAG_INDIRECT 0x0400 158 #define VTNET_FLAG_EVENT_IDX 0x0800 159 #define VTNET_FLAG_SUSPENDED 0x1000 160 #define VTNET_FLAG_FIXUP_NEEDS_CSUM 0x2000 161 #define VTNET_FLAG_SW_LRO 0x4000 162 163 int vtnet_hdr_size; 164 int vtnet_rx_nmbufs; 165 int vtnet_rx_clustersz; 166 int vtnet_rx_nsegs; 167 int vtnet_rx_process_limit; 168 int vtnet_link_active; 169 int vtnet_act_vq_pairs; 170 int vtnet_req_vq_pairs; 171 int vtnet_max_vq_pairs; 172 int vtnet_tx_nsegs; 173 int vtnet_if_flags; 174 int vtnet_max_mtu; 175 int vtnet_lro_entry_count; 176 int vtnet_lro_mbufq_depth; 177 178 struct virtqueue *vtnet_ctrl_vq; 179 struct vtnet_mac_filter *vtnet_mac_filter; 180 uint32_t *vtnet_vlan_filter; 181 182 uint64_t vtnet_negotiated_features; 183 struct vtnet_statistics vtnet_stats; 184 struct callout vtnet_tick_ch; 185 struct ifmedia vtnet_media; 186 eventhandler_tag vtnet_vlan_attach; 187 eventhandler_tag vtnet_vlan_detach; 188 189 struct mtx vtnet_mtx; 190 char vtnet_mtx_name[16]; 191 char vtnet_hwaddr[ETHER_ADDR_LEN]; 192 }; 193 194 static bool 195 vtnet_modern(struct vtnet_softc *sc) 196 { 197 return ((sc->vtnet_flags & VTNET_FLAG_MODERN) != 0); 198 } 199 200 static bool 201 vtnet_software_lro(struct vtnet_softc *sc) 202 { 203 return ((sc->vtnet_flags & VTNET_FLAG_SW_LRO) != 0); 204 } 205 206 /* 207 * Maximum number of queue pairs we will autoconfigure to. 208 */ 209 #define VTNET_MAX_QUEUE_PAIRS 32 210 211 /* 212 * Additional completed entries can appear in a virtqueue before we can 213 * reenable interrupts. Number of times to retry before scheduling the 214 * taskqueue to process the completed entries. 215 */ 216 #define VTNET_INTR_DISABLE_RETRIES 4 217 218 /* 219 * Similarly, additional completed entries can appear in a virtqueue 220 * between when lasted checked and before notifying the host. Number 221 * of times to retry before scheduling the taskqueue to process the 222 * queue. 223 */ 224 #define VTNET_NOTIFY_RETRIES 4 225 226 /* 227 * Number of words to allocate for the VLAN shadow table. There is one 228 * bit for each VLAN. 229 */ 230 #define VTNET_VLAN_FILTER_NWORDS (4096 / 32) 231 232 /* We depend on these being the same size (and same layout). */ 233 CTASSERT(sizeof(struct virtio_net_hdr_mrg_rxbuf) == 234 sizeof(struct virtio_net_hdr_v1)); 235 236 /* 237 * In legacy VirtIO when mergeable buffers are not negotiated, this structure 238 * is placed at the beginning of the mbuf data. Use 4 bytes of pad to keep 239 * both the VirtIO header and the data non-contiguous and the frame's payload 240 * 4 byte aligned. Note this padding would not be necessary if the 241 * VIRTIO_F_ANY_LAYOUT feature was negotiated (but we don't support that yet). 242 * 243 * In modern VirtIO or when mergeable buffers are negotiated, the host puts 244 * the VirtIO header in the beginning of the first mbuf's data. 245 */ 246 #define VTNET_RX_HEADER_PAD 4 247 struct vtnet_rx_header { 248 struct virtio_net_hdr vrh_hdr; 249 char vrh_pad[VTNET_RX_HEADER_PAD]; 250 } __packed; 251 252 /* 253 * For each outgoing frame, the vtnet_tx_header below is allocated from 254 * the vtnet_tx_header_zone. 255 */ 256 struct vtnet_tx_header { 257 union { 258 struct virtio_net_hdr hdr; 259 struct virtio_net_hdr_mrg_rxbuf mhdr; 260 struct virtio_net_hdr_v1 v1hdr; 261 } vth_uhdr; 262 263 struct mbuf *vth_mbuf; 264 }; 265 266 /* 267 * The VirtIO specification does not place a limit on the number of MAC 268 * addresses the guest driver may request to be filtered. In practice, 269 * the host is constrained by available resources. To simplify this driver, 270 * impose a reasonably high limit of MAC addresses we will filter before 271 * falling back to promiscuous or all-multicast modes. 272 */ 273 #define VTNET_MAX_MAC_ENTRIES 128 274 275 /* 276 * The driver version of struct virtio_net_ctrl_mac but with our predefined 277 * number of MAC addresses allocated. This structure is shared with the host, 278 * so nentries field is in the correct VirtIO endianness. 279 */ 280 struct vtnet_mac_table { 281 uint32_t nentries; 282 uint8_t macs[VTNET_MAX_MAC_ENTRIES][ETHER_ADDR_LEN]; 283 } __packed; 284 285 struct vtnet_mac_filter { 286 struct vtnet_mac_table vmf_unicast; 287 uint32_t vmf_pad; /* Make tables non-contiguous. */ 288 struct vtnet_mac_table vmf_multicast; 289 }; 290 291 /* 292 * The MAC filter table is malloc(9)'d when needed. Ensure it will 293 * always fit in one segment. 294 */ 295 CTASSERT(sizeof(struct vtnet_mac_filter) <= PAGE_SIZE); 296 297 #define VTNET_TX_TIMEOUT 5 298 #define VTNET_CSUM_OFFLOAD (CSUM_TCP | CSUM_UDP) 299 #define VTNET_CSUM_OFFLOAD_IPV6 (CSUM_TCP_IPV6 | CSUM_UDP_IPV6) 300 301 #define VTNET_CSUM_ALL_OFFLOAD \ 302 (VTNET_CSUM_OFFLOAD | VTNET_CSUM_OFFLOAD_IPV6 | CSUM_TSO) 303 304 #define VTNET_COMMON_FEATURES \ 305 (VIRTIO_NET_F_MAC | \ 306 VIRTIO_NET_F_STATUS | \ 307 VIRTIO_NET_F_CTRL_GUEST_OFFLOADS | \ 308 VIRTIO_NET_F_MTU | \ 309 VIRTIO_NET_F_CTRL_VQ | \ 310 VIRTIO_NET_F_CTRL_RX | \ 311 VIRTIO_NET_F_CTRL_MAC_ADDR | \ 312 VIRTIO_NET_F_CTRL_VLAN | \ 313 VIRTIO_NET_F_CSUM | \ 314 VIRTIO_NET_F_HOST_TSO4 | \ 315 VIRTIO_NET_F_HOST_TSO6 | \ 316 VIRTIO_NET_F_HOST_ECN | \ 317 VIRTIO_NET_F_GUEST_CSUM | \ 318 VIRTIO_NET_F_GUEST_TSO4 | \ 319 VIRTIO_NET_F_GUEST_TSO6 | \ 320 VIRTIO_NET_F_GUEST_ECN | \ 321 VIRTIO_NET_F_MRG_RXBUF | \ 322 VIRTIO_NET_F_MQ | \ 323 VIRTIO_NET_F_SPEED_DUPLEX | \ 324 VIRTIO_RING_F_EVENT_IDX | \ 325 VIRTIO_RING_F_INDIRECT_DESC) 326 327 #define VTNET_MODERN_FEATURES (VTNET_COMMON_FEATURES) 328 #define VTNET_LEGACY_FEATURES (VTNET_COMMON_FEATURES | VIRTIO_NET_F_GSO) 329 330 /* 331 * The VIRTIO_NET_F_HOST_TSO[46] features permit us to send the host 332 * frames larger than 1514 bytes. 333 */ 334 #define VTNET_TSO_FEATURES (VIRTIO_NET_F_GSO | VIRTIO_NET_F_HOST_TSO4 | \ 335 VIRTIO_NET_F_HOST_TSO6 | VIRTIO_NET_F_HOST_ECN) 336 337 /* 338 * The VIRTIO_NET_F_GUEST_TSO[46] features permit the host to send us 339 * frames larger than 1514 bytes. 340 */ 341 #define VTNET_LRO_FEATURES (VIRTIO_NET_F_GUEST_TSO4 | \ 342 VIRTIO_NET_F_GUEST_TSO6 | VIRTIO_NET_F_GUEST_ECN) 343 344 #define VTNET_MIN_MTU 68 345 #define VTNET_MAX_MTU 65536 346 #define VTNET_MAX_RX_SIZE 65550 347 348 /* 349 * Used to preallocate the VQ indirect descriptors. Modern and mergeable 350 * buffers do not required one segment for the VirtIO header since it is 351 * placed inline at the beginning of the receive buffer. 352 */ 353 #define VTNET_RX_SEGS_HDR_INLINE 1 354 #define VTNET_RX_SEGS_HDR_SEPARATE 2 355 #define VTNET_RX_SEGS_LRO_NOMRG 34 356 #define VTNET_TX_SEGS_MIN 32 357 #define VTNET_TX_SEGS_MAX 64 358 359 CTASSERT(((VTNET_RX_SEGS_LRO_NOMRG - 1) * MCLBYTES) >= VTNET_MAX_RX_SIZE); 360 CTASSERT(((VTNET_TX_SEGS_MAX - 1) * MCLBYTES) >= VTNET_MAX_MTU); 361 362 /* 363 * Number of slots in the Tx bufrings. This value matches most other 364 * multiqueue drivers. 365 */ 366 #define VTNET_DEFAULT_BUFRING_SIZE 4096 367 368 #define VTNET_CORE_MTX(_sc) &(_sc)->vtnet_mtx 369 #define VTNET_CORE_LOCK(_sc) mtx_lock(VTNET_CORE_MTX((_sc))) 370 #define VTNET_CORE_UNLOCK(_sc) mtx_unlock(VTNET_CORE_MTX((_sc))) 371 #define VTNET_CORE_LOCK_DESTROY(_sc) mtx_destroy(VTNET_CORE_MTX((_sc))) 372 #define VTNET_CORE_LOCK_ASSERT(_sc) \ 373 mtx_assert(VTNET_CORE_MTX((_sc)), MA_OWNED) 374 #define VTNET_CORE_LOCK_ASSERT_NOTOWNED(_sc) \ 375 mtx_assert(VTNET_CORE_MTX((_sc)), MA_NOTOWNED) 376 377 #define VTNET_CORE_LOCK_INIT(_sc) do { \ 378 snprintf((_sc)->vtnet_mtx_name, sizeof((_sc)->vtnet_mtx_name), \ 379 "%s", device_get_nameunit((_sc)->vtnet_dev)); \ 380 mtx_init(VTNET_CORE_MTX((_sc)), (_sc)->vtnet_mtx_name, \ 381 "VTNET Core Lock", MTX_DEF); \ 382 } while (0) 383 384 /* 385 * Values for the init_mode argument of vtnet_init_locked(). 386 */ 387 #define VTNET_INIT_NETMAP_ENTER 1 388 #define VTNET_INIT_NETMAP_EXIT 2 389 390 #endif /* _IF_VTNETVAR_H */ 391