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