examples/vhost/main.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2017 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 _MAIN_H_
  35 #define _MAIN_H_
  36
  37 #include <sys/queue.h>
  38
  39 #include <rte_ether.h>
  40
  41 /* Macros for printing using RTE_LOG */
  42 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
  43 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER2
  44 #define RTE_LOGTYPE_VHOST_PORT   RTE_LOGTYPE_USER3
  45
  46 enum {VIRTIO_RXQ, VIRTIO_TXQ, VIRTIO_QNUM};
  47
  48 #define MAX_PKT_BURST 32                /* Max burst size for RX/TX */
  49
  50 struct device_statistics {
  51         uint64_t        tx;
  52         uint64_t        tx_total;
  53         rte_atomic64_t  rx_atomic;
  54         rte_atomic64_t  rx_total_atomic;
  55 };
  56
  57 struct vhost_queue {
  58         struct rte_vhost_vring  vr;
  59         uint16_t                last_avail_idx;
  60         uint16_t                last_used_idx;
  61 };
  62
  63 struct vhost_dev {
  64         /**< Number of memory regions for gpa to hpa translation. */
  65         uint32_t nregions_hpa;
  66         /**< Device MAC address (Obtained on first TX packet). */
  67         struct ether_addr mac_address;
  68         /**< RX VMDQ queue number. */
  69         uint16_t vmdq_rx_q;
  70         /**< Vlan tag assigned to the pool */
  71         uint32_t vlan_tag;
  72         /**< Data core that the device is added to. */
  73         uint16_t coreid;
  74         /**< A device is set as ready if the MAC address has been set. */
  75         volatile uint8_t ready;
  76         /**< Device is marked for removal from the data core. */
  77         volatile uint8_t remove;
  78
  79         int vid;
  80         uint64_t features;
  81         size_t hdr_len;
  82         uint16_t nr_vrings;
  83         struct rte_vhost_memory *mem;
  84         struct device_statistics stats;
  85         TAILQ_ENTRY(vhost_dev) global_vdev_entry;
  86         TAILQ_ENTRY(vhost_dev) lcore_vdev_entry;
  87
  88 #define MAX_QUEUE_PAIRS 4
  89         struct vhost_queue queues[MAX_QUEUE_PAIRS * 2];
  90 } __rte_cache_aligned;
  91
  92 TAILQ_HEAD(vhost_dev_tailq_list, vhost_dev);
  93
  94
  95 #define REQUEST_DEV_REMOVAL     1
  96 #define ACK_DEV_REMOVAL         0
  97
  98 /*
  99  * Structure containing data core specific information.
 100  */
 101 struct lcore_info {
 102         uint32_t                device_num;
 103
 104         /* Flag to synchronize device removal. */
 105         volatile uint8_t        dev_removal_flag;
 106
 107         struct vhost_dev_tailq_list vdev_list;
 108 };
 109
 110 /* we implement non-extra virtio net features */
 111 #define VIRTIO_NET_FEATURES     0
 112
 113 void vs_vhost_net_setup(struct vhost_dev *dev);
 114 void vs_vhost_net_remove(struct vhost_dev *dev);
 115 uint16_t vs_enqueue_pkts(struct vhost_dev *dev, uint16_t queue_id,
 116                          struct rte_mbuf **pkts, uint32_t count);
 117
 118 uint16_t vs_dequeue_pkts(struct vhost_dev *dev, uint16_t queue_id,
 119                          struct rte_mempool *mbuf_pool,
 120                          struct rte_mbuf **pkts, uint16_t count);
 121 #endif /* _MAIN_H_ */