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 #define mb()  rte_mb()
  50 #define wmb() rte_wmb()
  51 #define rmb() rte_rmb()
  52
  53 #ifdef RTE_PMD_PACKET_PREFETCH
  54 #define rte_packet_prefetch(p)  rte_prefetch1(p)
  55 #else
  56 #define rte_packet_prefetch(p)  do {} while(0)
  57 #endif
  58
  59 #define VIRTQUEUE_MAX_NAME_SZ 32
  60
  61 #define RTE_MBUF_DATA_DMA_ADDR(mb) \
  62         (uint64_t) ((mb)->buf_physaddr + (uint64_t)((char *)((mb)->pkt.data) - \
  63         (char *)(mb)->buf_addr))
  64
  65 #define VTNET_SQ_RQ_QUEUE_IDX 0
  66 #define VTNET_SQ_TQ_QUEUE_IDX 1
  67 #define VTNET_SQ_CQ_QUEUE_IDX 2
  68
  69 enum { VTNET_RQ = 0, VTNET_TQ = 1, VTNET_CQ = 2 };
  70 /**
  71  * The maximum virtqueue size is 2^15. Use that value as the end of
  72  * descriptor chain terminator since it will never be a valid index
  73  * in the descriptor table. This is used to verify we are correctly
  74  * handling vq_free_cnt.
  75  */
  76 #define VQ_RING_DESC_CHAIN_END 32768
  77
  78 /**
  79  * Control the RX mode, ie. promiscuous, allmulti, etc...
  80  * All commands require an "out" sg entry containing a 1 byte
  81  * state value, zero = disable, non-zero = enable.  Commands
  82  * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
  83  * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
  84  */
  85 #define VIRTIO_NET_CTRL_RX              0
  86 #define VIRTIO_NET_CTRL_RX_PROMISC      0
  87 #define VIRTIO_NET_CTRL_RX_ALLMULTI     1
  88 #define VIRTIO_NET_CTRL_RX_ALLUNI       2
  89 #define VIRTIO_NET_CTRL_RX_NOMULTI      3
  90 #define VIRTIO_NET_CTRL_RX_NOUNI        4
  91 #define VIRTIO_NET_CTRL_RX_NOBCAST      5
  92
  93 /**
  94  * Control VLAN filtering
  95  *
  96  * The VLAN filter table is controlled via a simple ADD/DEL interface.
  97  * VLAN IDs not added may be filtered by the hypervisor.  Del is the
  98  * opposite of add.  Both commands expect an out entry containing a 2
  99  * byte VLAN ID.  VLAN filtering is available with the
 100  * VIRTIO_NET_F_CTRL_VLAN feature bit.
 101  */
 102 #define VIRTIO_NET_CTRL_VLAN     2
 103 #define VIRTIO_NET_CTRL_VLAN_ADD 0
 104 #define VIRTIO_NET_CTRL_VLAN_DEL 1
 105
 106 struct virtio_net_ctrl_hdr {
 107         uint8_t class;
 108         uint8_t cmd;
 109 } __attribute__((packed));
 110
 111 typedef uint8_t virtio_net_ctrl_ack;
 112
 113 #define VIRTIO_NET_OK     0
 114 #define VIRTIO_NET_ERR    1
 115
 116 #define VIRTIO_MAX_CTRL_DATA 128
 117
 118 struct virtio_pmd_ctrl {
 119         struct virtio_net_ctrl_hdr hdr;
 120         virtio_net_ctrl_ack status;
 121         uint8_t data[VIRTIO_MAX_CTRL_DATA];
 122 };
 123
 124 struct virtqueue {
 125         char        vq_name[VIRTQUEUE_MAX_NAME_SZ];
 126         struct virtio_hw         *hw;     /**< virtio_hw structure pointer. */
 127         const struct rte_memzone *mz;     /**< mem zone to populate RX ring. */
 128         const struct rte_memzone *virtio_net_hdr_mz; /**< memzone to populate hdr. */
 129         struct rte_mempool       *mpool;  /**< mempool for mbuf allocation */
 130         uint16_t    queue_id;             /**< DPDK queue index. */
 131         uint8_t     port_id;              /**< Device port identifier. */
 132
 133         void        *vq_ring_virt_mem;    /**< linear address of vring*/
 134         int         vq_alignment;
 135         int         vq_ring_size;
 136         phys_addr_t vq_ring_mem;          /**< physical address of vring */
 137
 138         struct vring vq_ring;    /**< vring keeping desc, used and avail */
 139         uint16_t    vq_free_cnt; /**< num of desc available */
 140         uint16_t    vq_nentries; /**< vring desc numbers */
 141         uint16_t    vq_queue_index;       /**< PCI queue index */
 142         /**
 143          * Head of the free chain in the descriptor table. If
 144          * there are no free descriptors, this will be set to
 145          * VQ_RING_DESC_CHAIN_END.
 146          */
 147         uint16_t  vq_desc_head_idx;
 148         uint16_t  vq_desc_tail_idx;
 149         /**
 150          * Last consumed descriptor in the used table,
 151          * trails vq_ring.used->idx.
 152          */
 153         uint16_t vq_used_cons_idx;
 154         uint16_t vq_avail_idx;
 155         phys_addr_t virtio_net_hdr_mem; /**< hdr for each xmit packet */
 156
 157         /* Statistics */
 158         uint64_t        packets;
 159         uint64_t        bytes;
 160         uint64_t        errors;
 161
 162         struct vq_desc_extra {
 163                 void              *cookie;
 164                 uint16_t          ndescs;
 165         } vq_descx[0];
 166 };
 167
 168 /* If multiqueue is provided by host, then we suppport it. */
 169 #ifndef VIRTIO_NET_F_MQ
 170 /* Device supports Receive Flow Steering */
 171 #define VIRTIO_NET_F_MQ 0x400000
 172 #define VIRTIO_NET_CTRL_MQ   4
 173 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET        0
 174 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN        1
 175 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX        0x8000
 176 #endif
 177
 178 /**
 179  * This is the first element of the scatter-gather list.  If you don't
 180  * specify GSO or CSUM features, you can simply ignore the header.
 181  */
 182 struct virtio_net_hdr {
 183 #define VIRTIO_NET_HDR_F_NEEDS_CSUM 1    /**< Use csum_start,csum_offset*/
 184         uint8_t flags;
 185 #define VIRTIO_NET_HDR_GSO_NONE     0    /**< Not a GSO frame */
 186 #define VIRTIO_NET_HDR_GSO_TCPV4    1    /**< GSO frame, IPv4 TCP (TSO) */
 187 #define VIRTIO_NET_HDR_GSO_UDP      3    /**< GSO frame, IPv4 UDP (UFO) */
 188 #define VIRTIO_NET_HDR_GSO_TCPV6    4    /**< GSO frame, IPv6 TCP */
 189 #define VIRTIO_NET_HDR_GSO_ECN      0x80 /**< TCP has ECN set */
 190         uint8_t gso_type;
 191         uint16_t hdr_len;     /**< Ethernet + IP + tcp/udp hdrs */
 192         uint16_t gso_size;    /**< Bytes to append to hdr_len per frame */
 193         uint16_t csum_start;  /**< Position to start checksumming from */
 194         uint16_t csum_offset; /**< Offset after that to place checksum */
 195 };
 196
 197 /**
 198  * This is the version of the header to use when the MRG_RXBUF
 199  * feature has been negotiated.
 200  */
 201 struct virtio_net_hdr_mrg_rxbuf {
 202         struct   virtio_net_hdr hdr;
 203         uint16_t num_buffers; /**< Number of merged rx buffers */
 204 };
 205
 206 /**
 207  * Tell the backend not to interrupt us.
 208  */
 209 void virtqueue_disable_intr(struct virtqueue *vq);
 210 /**
 211  *  Dump virtqueue internal structures, for debug purpose only.
 212  */
 213 void virtqueue_dump(struct virtqueue *vq);
 214 /**
 215  *  Get all mbufs to be freed.
 216  */
 217 struct rte_mbuf *virtqueue_detatch_unused(struct virtqueue *vq);
 218
 219 static inline int
 220 virtqueue_full(const struct virtqueue *vq)
 221 {
 222         return vq->vq_free_cnt == 0;
 223 }
 224
 225 #define VIRTQUEUE_NUSED(vq) ((uint16_t)((vq)->vq_ring.used->idx - (vq)->vq_used_cons_idx))
 226
 227 static inline void
 228 vq_update_avail_idx(struct virtqueue *vq)
 229 {
 230         rte_compiler_barrier();
 231         vq->vq_ring.avail->idx = vq->vq_avail_idx;
 232 }
 233
 234 static inline void
 235 vq_update_avail_ring(struct virtqueue *vq, uint16_t desc_idx)
 236 {
 237         uint16_t avail_idx;
 238         /*
 239          * Place the head of the descriptor chain into the next slot and make
 240          * it usable to the host. The chain is made available now rather than
 241          * deferring to virtqueue_notify() in the hopes that if the host is
 242          * currently running on another CPU, we can keep it processing the new
 243          * descriptor.
 244          */
 245         avail_idx = (uint16_t)(vq->vq_avail_idx & (vq->vq_nentries - 1));
 246         vq->vq_ring.avail->ring[avail_idx] = desc_idx;
 247         vq->vq_avail_idx++;
 248 }
 249
 250 static inline int
 251 virtqueue_kick_prepare(struct virtqueue *vq)
 252 {
 253         return !(vq->vq_ring.used->flags & VRING_USED_F_NO_NOTIFY);
 254 }
 255
 256 static inline void
 257 virtqueue_notify(struct virtqueue *vq)
 258 {
 259         /*
 260          * Ensure updated avail->idx is visible to host. mb() necessary?
 261          * For virtio on IA, the notificaiton is through io port operation
 262          * which is a serialization instruction itself.
 263          */
 264         VIRTIO_WRITE_REG_2(vq->hw, VIRTIO_PCI_QUEUE_NOTIFY, vq->vq_queue_index);
 265 }
 266
 267 #ifdef RTE_LIBRTE_VIRTIO_DEBUG_DUMP
 268 #define VIRTQUEUE_DUMP(vq) do { \
 269         uint16_t used_idx, nused; \
 270         used_idx = (vq)->vq_ring.used->idx; \
 271         nused = (uint16_t)(used_idx - (vq)->vq_used_cons_idx); \
 272         PMD_INIT_LOG(DEBUG, \
 273           "VQ: %s - size=%d; free=%d; used=%d; desc_head_idx=%d;" \
 274           " avail.idx=%d; used_cons_idx=%d; used.idx=%d;" \
 275           " avail.flags=0x%x; used.flags=0x%x", \
 276           (vq)->vq_name, (vq)->vq_nentries, (vq)->vq_free_cnt, nused, \
 277           (vq)->vq_desc_head_idx, (vq)->vq_ring.avail->idx, \
 278           (vq)->vq_used_cons_idx, (vq)->vq_ring.used->idx, \
 279           (vq)->vq_ring.avail->flags, (vq)->vq_ring.used->flags); \
 280 } while (0)
 281 #else
 282 #define VIRTQUEUE_DUMP(vq) do { } while (0)
 283 #endif
 284
 285 #endif /* _VIRTQUEUE_H_ */