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