sys/dev/virtio/network/if_vtnetvar.h

   1 /*-
   2  * Copyright (c) 2011, Bryan Venteicher <bryanv@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice unmodified, this list of conditions, and the following
  10  *    disclaimer.
  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.
  14  *
  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.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _IF_VTNETVAR_H
  30 #define _IF_VTNETVAR_H
  31
  32 struct vtnet_statistics {
  33         unsigned long   mbuf_alloc_failed;
  34
  35         unsigned long   rx_frame_too_large;
  36         unsigned long   rx_enq_replacement_failed;
  37         unsigned long   rx_mergeable_failed;
  38         unsigned long   rx_csum_bad_ethtype;
  39         unsigned long   rx_csum_bad_start;
  40         unsigned long   rx_csum_bad_ipproto;
  41         unsigned long   rx_csum_bad_offset;
  42         unsigned long   rx_csum_failed;
  43         unsigned long   rx_csum_offloaded;
  44         unsigned long   rx_task_rescheduled;
  45
  46         unsigned long   tx_csum_offloaded;
  47         unsigned long   tx_tso_offloaded;
  48         unsigned long   tx_csum_bad_ethtype;
  49         unsigned long   tx_tso_bad_ethtype;
  50         unsigned long   tx_task_rescheduled;
  51 };
  52
  53 struct vtnet_softc {
  54         device_t                 vtnet_dev;
  55         struct ifnet            *vtnet_ifp;
  56         struct mtx               vtnet_mtx;
  57
  58         uint32_t                 vtnet_flags;
  59 #define VTNET_FLAG_LINK          0x0001
  60 #define VTNET_FLAG_SUSPENDED     0x0002
  61 #define VTNET_FLAG_CTRL_VQ       0x0004
  62 #define VTNET_FLAG_CTRL_RX       0x0008
  63 #define VTNET_FLAG_VLAN_FILTER   0x0010
  64 #define VTNET_FLAG_TSO_ECN       0x0020
  65 #define VTNET_FLAG_MRG_RXBUFS    0x0040
  66 #define VTNET_FLAG_LRO_NOMRG     0x0080
  67
  68         struct virtqueue        *vtnet_rx_vq;
  69         struct virtqueue        *vtnet_tx_vq;
  70         struct virtqueue        *vtnet_ctrl_vq;
  71
  72         int                      vtnet_hdr_size;
  73         int                      vtnet_tx_size;
  74         int                      vtnet_rx_size;
  75         int                      vtnet_rx_process_limit;
  76         int                      vtnet_rx_mbuf_size;
  77         int                      vtnet_rx_mbuf_count;
  78         int                      vtnet_if_flags;
  79         int                      vtnet_watchdog_timer;
  80         uint64_t                 vtnet_features;
  81
  82         struct vtnet_statistics  vtnet_stats;
  83
  84         struct callout           vtnet_tick_ch;
  85
  86         eventhandler_tag         vtnet_vlan_attach;
  87         eventhandler_tag         vtnet_vlan_detach;
  88
  89         struct ifmedia           vtnet_media;
  90         /*
  91          * Fake media type; the host does not provide us with
  92          * any real media information.
  93          */
  94 #define VTNET_MEDIATYPE          (IFM_ETHER | IFM_1000_T | IFM_FDX)
  95         char                     vtnet_hwaddr[ETHER_ADDR_LEN];
  96
  97         struct vtnet_mac_filter *vtnet_mac_filter;
  98         /*
  99          * During reset, the host's VLAN filtering table is lost. The
 100          * array below is used to restore all the VLANs configured on
 101          * this interface after a reset.
 102          */
 103 #define VTNET_VLAN_SHADOW_SIZE   (4096 / 32)
 104         int                      vtnet_nvlans;
 105         uint32_t                 vtnet_vlan_shadow[VTNET_VLAN_SHADOW_SIZE];
 106
 107         char                     vtnet_mtx_name[16];
 108 };
 109
 110 /*
 111  * When mergeable buffers are not negotiated, the vtnet_rx_header structure
 112  * below is placed at the beginning of the mbuf data. Use 4 bytes of pad to
 113  * both keep the VirtIO header and the data non-contiguous and to keep the
 114  * frame's payload 4 byte aligned.
 115  *
 116  * When mergeable buffers are negotiated, the host puts the VirtIO header in
 117  * the beginning of the first mbuf's data.
 118  */
 119 #define VTNET_RX_HEADER_PAD     4
 120 struct vtnet_rx_header {
 121         struct virtio_net_hdr   vrh_hdr;
 122         char                    vrh_pad[VTNET_RX_HEADER_PAD];
 123 } __packed;
 124
 125 /*
 126  * For each outgoing frame, the vtnet_tx_header below is allocated from
 127  * the vtnet_tx_header_zone.
 128  */
 129 struct vtnet_tx_header {
 130         union {
 131                 struct virtio_net_hdr           hdr;
 132                 struct virtio_net_hdr_mrg_rxbuf mhdr;
 133         } vth_uhdr;
 134
 135         struct mbuf *vth_mbuf;
 136 };
 137
 138 /*
 139  * The VirtIO specification does not place a limit on the number of MAC
 140  * addresses the guest driver may request to be filtered. In practice,
 141  * the host is constrained by available resources. To simplify this driver,
 142  * impose a reasonably high limit of MAC addresses we will filter before
 143  * falling back to promiscuous or all-multicast modes.
 144  */
 145 #define VTNET_MAX_MAC_ENTRIES   128
 146
 147 struct vtnet_mac_table {
 148         uint32_t        nentries;
 149         uint8_t         macs[VTNET_MAX_MAC_ENTRIES][ETHER_ADDR_LEN];
 150 } __packed;
 151
 152 struct vtnet_mac_filter {
 153         struct vtnet_mac_table  vmf_unicast;
 154         uint32_t                vmf_pad; /* Make tables non-contiguous. */
 155         struct vtnet_mac_table  vmf_multicast;
 156 };
 157
 158 /*
 159  * The MAC filter table is malloc(9)'d when needed. Ensure it will
 160  * always fit in one segment.
 161  */
 162 CTASSERT(sizeof(struct vtnet_mac_filter) <= PAGE_SIZE);
 163
 164 #define VTNET_WATCHDOG_TIMEOUT  5
 165 #define VTNET_CSUM_OFFLOAD      (CSUM_TCP | CSUM_UDP | CSUM_SCTP)
 166
 167 /* Features desired/implemented by this driver. */
 168 #define VTNET_FEATURES \
 169     (VIRTIO_NET_F_MAC                   | \
 170      VIRTIO_NET_F_STATUS                | \
 171      VIRTIO_NET_F_CTRL_VQ               | \
 172      VIRTIO_NET_F_CTRL_RX               | \
 173      VIRTIO_NET_F_CTRL_VLAN             | \
 174      VIRTIO_NET_F_CSUM                  | \
 175      VIRTIO_NET_F_HOST_TSO4             | \
 176      VIRTIO_NET_F_HOST_TSO6             | \
 177      VIRTIO_NET_F_HOST_ECN              | \
 178      VIRTIO_NET_F_GUEST_CSUM            | \
 179      VIRTIO_NET_F_GUEST_TSO4            | \
 180      VIRTIO_NET_F_GUEST_TSO6            | \
 181      VIRTIO_NET_F_GUEST_ECN             | \
 182      VIRTIO_NET_F_MRG_RXBUF             | \
 183      VIRTIO_RING_F_INDIRECT_DESC)
 184
 185 /*
 186  * The VIRTIO_NET_F_GUEST_TSO[46] features permit the host to send us
 187  * frames larger than 1514 bytes. We do not yet support software LRO
 188  * via tcp_lro_rx().
 189  */
 190 #define VTNET_LRO_FEATURES (VIRTIO_NET_F_GUEST_TSO4 | \
 191     VIRTIO_NET_F_GUEST_TSO6 | VIRTIO_NET_F_GUEST_ECN)
 192
 193 #define VTNET_MAX_MTU           65536
 194 #define VTNET_MAX_RX_SIZE       65550
 195
 196 /*
 197  * Used to preallocate the Vq indirect descriptors. The first segment
 198  * is reserved for the header.
 199  */
 200 #define VTNET_MIN_RX_SEGS       2
 201 #define VTNET_MAX_RX_SEGS       34
 202 #define VTNET_MAX_TX_SEGS       34
 203
 204 /*
 205  * Assert we can receive and transmit the maximum with regular
 206  * size clusters.
 207  */
 208 CTASSERT(((VTNET_MAX_RX_SEGS - 1) * MCLBYTES) >= VTNET_MAX_RX_SIZE);
 209 CTASSERT(((VTNET_MAX_TX_SEGS - 1) * MCLBYTES) >= VTNET_MAX_MTU);
 210
 211 /*
 212  * Determine how many mbufs are in each receive buffer. For LRO without
 213  * mergeable descriptors, we must allocate an mbuf chain large enough to
 214  * hold both the vtnet_rx_header and the maximum receivable data.
 215  */
 216 #define VTNET_NEEDED_RX_MBUFS(_sc)                                      \
 217         ((_sc)->vtnet_flags & VTNET_FLAG_LRO_NOMRG) == 0 ? 1 :          \
 218             howmany(sizeof(struct vtnet_rx_header) + VTNET_MAX_RX_SIZE, \
 219                 (_sc)->vtnet_rx_mbuf_size)
 220
 221 #define VTNET_MTX(_sc)          &(_sc)->vtnet_mtx
 222 #define VTNET_LOCK(_sc)         mtx_lock(VTNET_MTX((_sc)))
 223 #define VTNET_UNLOCK(_sc)       mtx_unlock(VTNET_MTX((_sc)))
 224 #define VTNET_LOCK_DESTROY(_sc) mtx_destroy(VTNET_MTX((_sc)))
 225 #define VTNET_LOCK_ASSERT(_sc)  mtx_assert(VTNET_MTX((_sc)), MA_OWNED)
 226 #define VTNET_LOCK_ASSERT_NOTOWNED(_sc) \
 227                                 mtx_assert(VTNET_MTX((_sc)), MA_NOTOWNED)
 228
 229 #define VTNET_LOCK_INIT(_sc) do {                                       \
 230     snprintf((_sc)->vtnet_mtx_name, sizeof((_sc)->vtnet_mtx_name),      \
 231         "%s", device_get_nameunit((_sc)->vtnet_dev));                   \
 232     mtx_init(VTNET_MTX((_sc)), (_sc)->vtnet_mtx_name,                   \
 233         "VTNET Core Lock", MTX_DEF);                                    \
 234 } while (0)
 235
 236 #endif /* _IF_VTNETVAR_H */