lib/librte_pmd_virtio/virtqueue.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   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  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _VIRTQUEUE_H_
  35 #define _VIRTQUEUE_H_
  36
  37 #include <stdint.h>
  38
  39 #include <rte_atomic.h>
  40 #include <rte_mbuf.h>
  41 #include <rte_memory.h>
  42 #include <rte_memzone.h>
  43 #include <rte_mempool.h>
  44
  45 #include "virtio_pci.h"
  46 #include "virtio_ring.h"
  47 #include "virtio_logs.h"
  48
  49 /*
  50  * Per virtio_config.h in Linux.
  51  *     For virtio_pci on SMP, we don't need to order with respect to MMIO
  52  *     accesses through relaxed memory I/O windows, so smp_mb() et al are
  53  *     sufficient.
  54  *
  55  * This driver is for virtio_pci on SMP and therefore can assume
  56  * weaker (compiler barriers)
  57  */
  58 #define virtio_mb()     rte_mb()
  59 #define virtio_rmb()    rte_compiler_barrier()
  60 #define virtio_wmb()    rte_compiler_barrier()
  61
  62 #ifdef RTE_PMD_PACKET_PREFETCH
  63 #define rte_packet_prefetch(p)  rte_prefetch1(p)
  64 #else
  65 #define rte_packet_prefetch(p)  do {} while(0)
  66 #endif
  67
  68 #define VIRTQUEUE_MAX_NAME_SZ 32
  69
  70 #define RTE_MBUF_DATA_DMA_ADDR(mb) \
  71         (uint64_t) ((mb)->buf_physaddr + (mb)->data_off)
  72
  73 #define VTNET_SQ_RQ_QUEUE_IDX 0
  74 #define VTNET_SQ_TQ_QUEUE_IDX 1
  75 #define VTNET_SQ_CQ_QUEUE_IDX 2
  76
  77 enum { VTNET_RQ = 0, VTNET_TQ = 1, VTNET_CQ = 2 };
  78 /**
  79  * The maximum virtqueue size is 2^15. Use that value as the end of
  80  * descriptor chain terminator since it will never be a valid index
  81  * in the descriptor table. This is used to verify we are correctly
  82  * handling vq_free_cnt.
  83  */
  84 #define VQ_RING_DESC_CHAIN_END 32768
  85
  86 /**
  87  * Control the RX mode, ie. promiscuous, allmulti, etc...
  88  * All commands require an "out" sg entry containing a 1 byte
  89  * state value, zero = disable, non-zero = enable.  Commands
  90  * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
  91  * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
  92  */
  93 #define VIRTIO_NET_CTRL_RX              0
  94 #define VIRTIO_NET_CTRL_RX_PROMISC      0
  95 #define VIRTIO_NET_CTRL_RX_ALLMULTI     1
  96 #define VIRTIO_NET_CTRL_RX_ALLUNI       2
  97 #define VIRTIO_NET_CTRL_RX_NOMULTI      3
  98 #define VIRTIO_NET_CTRL_RX_NOUNI        4
  99 #define VIRTIO_NET_CTRL_RX_NOBCAST      5
 100
 101 /**
 102  * Control the MAC
 103  *
 104  * The MAC filter table is managed by the hypervisor, the guest should
 105  * assume the size is infinite.  Filtering should be considered
 106  * non-perfect, ie. based on hypervisor resources, the guest may
 107  * received packets from sources not specified in the filter list.
 108  *
 109  * In addition to the class/cmd header, the TABLE_SET command requires
 110  * two out scatterlists.  Each contains a 4 byte count of entries followed
 111  * by a concatenated byte stream of the ETH_ALEN MAC addresses.  The
 112  * first sg list contains unicast addresses, the second is for multicast.
 113  * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
 114  * is available.
 115  *
 116  * The ADDR_SET command requests one out scatterlist, it contains a
 117  * 6 bytes MAC address. This functionality is present if the
 118  * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available.
 119  */
 120 struct virtio_net_ctrl_mac {
 121         uint32_t entries;
 122         uint8_t macs[][ETHER_ADDR_LEN];
 123 } __attribute__((__packed__));
 124
 125 #define VIRTIO_NET_CTRL_MAC    1
 126  #define VIRTIO_NET_CTRL_MAC_TABLE_SET        0
 127  #define VIRTIO_NET_CTRL_MAC_ADDR_SET         1
 128
 129 /**
 130  * Control VLAN filtering
 131  *
 132  * The VLAN filter table is controlled via a simple ADD/DEL interface.
 133  * VLAN IDs not added may be filtered by the hypervisor.  Del is the
 134  * opposite of add.  Both commands expect an out entry containing a 2
 135  * byte VLAN ID.  VLAN filtering is available with the
 136  * VIRTIO_NET_F_CTRL_VLAN feature bit.
 137  */
 138 #define VIRTIO_NET_CTRL_VLAN     2
 139 #define VIRTIO_NET_CTRL_VLAN_ADD 0
 140 #define VIRTIO_NET_CTRL_VLAN_DEL 1
 141
 142 struct virtio_net_ctrl_hdr {
 143         uint8_t class;
 144         uint8_t cmd;
 145 } __attribute__((packed));
 146
 147 typedef uint8_t virtio_net_ctrl_ack;
 148
 149 #define VIRTIO_NET_OK     0
 150 #define VIRTIO_NET_ERR    1
 151
 152 #define VIRTIO_MAX_CTRL_DATA 2048
 153
 154 struct virtio_pmd_ctrl {
 155         struct virtio_net_ctrl_hdr hdr;
 156         virtio_net_ctrl_ack status;
 157         uint8_t data[VIRTIO_MAX_CTRL_DATA];
 158 };
 159
 160 struct virtqueue {
 161         struct virtio_hw         *hw;     /**< virtio_hw structure pointer. */
 162         const struct rte_memzone *mz;     /**< mem zone to populate RX ring. */
 163         const struct rte_memzone *virtio_net_hdr_mz; /**< memzone to populate hdr. */
 164         struct rte_mempool       *mpool;  /**< mempool for mbuf allocation */
 165         uint16_t    queue_id;             /**< DPDK queue index. */
 166         uint8_t     port_id;              /**< Device port identifier. */
 167
 168         void        *vq_ring_virt_mem;    /**< linear address of vring*/
 169         unsigned int vq_ring_size;
 170         phys_addr_t vq_ring_mem;          /**< physical address of vring */
 171
 172         struct vring vq_ring;    /**< vring keeping desc, used and avail */
 173         uint16_t    vq_free_cnt; /**< num of desc available */
 174         uint16_t    vq_nentries; /**< vring desc numbers */
 175         uint16_t    vq_queue_index;       /**< PCI queue index */
 176         /**
 177          * Head of the free chain in the descriptor table. If
 178          * there are no free descriptors, this will be set to
 179          * VQ_RING_DESC_CHAIN_END.
 180          */
 181         uint16_t  vq_desc_head_idx;
 182         uint16_t  vq_desc_tail_idx;
 183         /**
 184          * Last consumed descriptor in the used table,
 185          * trails vq_ring.used->idx.
 186          */
 187         uint16_t vq_used_cons_idx;
 188         uint16_t vq_avail_idx;
 189         phys_addr_t virtio_net_hdr_mem; /**< hdr for each xmit packet */
 190
 191         /* Statistics */
 192         uint64_t        packets;
 193         uint64_t        bytes;
 194         uint64_t        errors;
 195
 196         struct vq_desc_extra {
 197                 void              *cookie;
 198                 uint16_t          ndescs;
 199         } vq_descx[0];
 200 };
 201
 202 /* If multiqueue is provided by host, then we suppport it. */
 203 #ifndef VIRTIO_NET_F_MQ
 204 /* Device supports Receive Flow Steering */
 205 #define VIRTIO_NET_F_MQ 0x400000
 206 #define VIRTIO_NET_CTRL_MQ   4
 207 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET        0
 208 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN        1
 209 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX        0x8000
 210 #endif
 211 #ifndef VIRTIO_NET_F_CTRL_MAC_ADDR
 212 #define VIRTIO_NET_F_CTRL_MAC_ADDR 0x800000
 213 #define VIRTIO_NET_CTRL_MAC_ADDR_SET         1
 214 #endif
 215
 216 /**
 217  * This is the first element of the scatter-gather list.  If you don't
 218  * specify GSO or CSUM features, you can simply ignore the header.
 219  */
 220 struct virtio_net_hdr {
 221 #define VIRTIO_NET_HDR_F_NEEDS_CSUM 1    /**< Use csum_start,csum_offset*/
 222         uint8_t flags;
 223 #define VIRTIO_NET_HDR_GSO_NONE     0    /**< Not a GSO frame */
 224 #define VIRTIO_NET_HDR_GSO_TCPV4    1    /**< GSO frame, IPv4 TCP (TSO) */
 225 #define VIRTIO_NET_HDR_GSO_UDP      3    /**< GSO frame, IPv4 UDP (UFO) */
 226 #define VIRTIO_NET_HDR_GSO_TCPV6    4    /**< GSO frame, IPv6 TCP */
 227 #define VIRTIO_NET_HDR_GSO_ECN      0x80 /**< TCP has ECN set */
 228         uint8_t gso_type;
 229         uint16_t hdr_len;     /**< Ethernet + IP + tcp/udp hdrs */
 230         uint16_t gso_size;    /**< Bytes to append to hdr_len per frame */
 231         uint16_t csum_start;  /**< Position to start checksumming from */
 232         uint16_t csum_offset; /**< Offset after that to place checksum */
 233 };
 234
 235 /**
 236  * This is the version of the header to use when the MRG_RXBUF
 237  * feature has been negotiated.
 238  */
 239 struct virtio_net_hdr_mrg_rxbuf {
 240         struct   virtio_net_hdr hdr;
 241         uint16_t num_buffers; /**< Number of merged rx buffers */
 242 };
 243
 244 /**
 245  * Tell the backend not to interrupt us.
 246  */
 247 void virtqueue_disable_intr(struct virtqueue *vq);
 248 /**
 249  *  Dump virtqueue internal structures, for debug purpose only.
 250  */
 251 void virtqueue_dump(struct virtqueue *vq);
 252 /**
 253  *  Get all mbufs to be freed.
 254  */
 255 struct rte_mbuf *virtqueue_detatch_unused(struct virtqueue *vq);
 256
 257 static inline int
 258 virtqueue_full(const struct virtqueue *vq)
 259 {
 260         return vq->vq_free_cnt == 0;
 261 }
 262
 263 #define VIRTQUEUE_NUSED(vq) ((uint16_t)((vq)->vq_ring.used->idx - (vq)->vq_used_cons_idx))
 264
 265 static inline void
 266 vq_update_avail_idx(struct virtqueue *vq)
 267 {
 268         virtio_wmb();
 269         vq->vq_ring.avail->idx = vq->vq_avail_idx;
 270 }
 271
 272 static inline void
 273 vq_update_avail_ring(struct virtqueue *vq, uint16_t desc_idx)
 274 {
 275         uint16_t avail_idx;
 276         /*
 277          * Place the head of the descriptor chain into the next slot and make
 278          * it usable to the host. The chain is made available now rather than
 279          * deferring to virtqueue_notify() in the hopes that if the host is
 280          * currently running on another CPU, we can keep it processing the new
 281          * descriptor.
 282          */
 283         avail_idx = (uint16_t)(vq->vq_avail_idx & (vq->vq_nentries - 1));
 284         vq->vq_ring.avail->ring[avail_idx] = desc_idx;
 285         vq->vq_avail_idx++;
 286 }
 287
 288 static inline int
 289 virtqueue_kick_prepare(struct virtqueue *vq)
 290 {
 291         return !(vq->vq_ring.used->flags & VRING_USED_F_NO_NOTIFY);
 292 }
 293
 294 static inline void
 295 virtqueue_notify(struct virtqueue *vq)
 296 {
 297         /*
 298          * Ensure updated avail->idx is visible to host.
 299          * For virtio on IA, the notificaiton is through io port operation
 300          * which is a serialization instruction itself.
 301          */
 302         VIRTIO_WRITE_REG_2(vq->hw, VIRTIO_PCI_QUEUE_NOTIFY, vq->vq_queue_index);
 303 }
 304
 305 #ifdef RTE_LIBRTE_VIRTIO_DEBUG_DUMP
 306 #define VIRTQUEUE_DUMP(vq) do { \
 307         uint16_t used_idx, nused; \
 308         used_idx = (vq)->vq_ring.used->idx; \
 309         nused = (uint16_t)(used_idx - (vq)->vq_used_cons_idx); \
 310         PMD_INIT_LOG(DEBUG, \
 311           "VQ: - size=%d; free=%d; used=%d; desc_head_idx=%d;" \
 312           " avail.idx=%d; used_cons_idx=%d; used.idx=%d;" \
 313           " avail.flags=0x%x; used.flags=0x%x", \
 314           (vq)->vq_nentries, (vq)->vq_free_cnt, nused, \
 315           (vq)->vq_desc_head_idx, (vq)->vq_ring.avail->idx, \
 316           (vq)->vq_used_cons_idx, (vq)->vq_ring.used->idx, \
 317           (vq)->vq_ring.avail->flags, (vq)->vq_ring.used->flags); \
 318 } while (0)
 319 #else
 320 #define VIRTQUEUE_DUMP(vq) do { } while (0)
 321 #endif
 322
 323 #endif /* _VIRTQUEUE_H_ */