examples/vhost/main.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 _MAIN_H_
  35 #define _MAIN_H_
  36
  37 /* Macros for printing using RTE_LOG */
  38 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
  39 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER2
  40 #define RTE_LOGTYPE_VHOST_PORT   RTE_LOGTYPE_USER3
  41
  42 /**
  43  * Information relating to memory regions including offsets to
  44  * addresses in host physical space.
  45  */
  46 struct virtio_memory_regions_hpa {
  47         /**< Base guest physical address of region. */
  48         uint64_t    guest_phys_address;
  49         /**< End guest physical address of region. */
  50         uint64_t    guest_phys_address_end;
  51         /**< Size of region. */
  52         uint64_t    memory_size;
  53         /**< Offset of region for gpa to hpa translation. */
  54         uint64_t    host_phys_addr_offset;
  55 };
  56
  57 /*
  58  * Device linked list structure for data path.
  59  */
  60 struct vhost_dev {
  61         /**< Pointer to device created by vhost lib. */
  62         struct virtio_net      *dev;
  63         /**< Number of memory regions for gpa to hpa translation. */
  64         uint32_t nregions_hpa;
  65         /**< Memory region information for gpa to hpa translation. */
  66         struct virtio_memory_regions_hpa *regions_hpa;
  67         /**< Device MAC address (Obtained on first TX packet). */
  68         struct ether_addr mac_address;
  69         /**< RX VMDQ queue number. */
  70         uint16_t vmdq_rx_q;
  71         /**< Vlan tag assigned to the pool */
  72         uint32_t vlan_tag;
  73         /**< Data core that the device is added to. */
  74         uint16_t coreid;
  75         /**< A device is set as ready if the MAC address has been set. */
  76         volatile uint8_t ready;
  77         /**< Device is marked for removal from the data core. */
  78         volatile uint8_t remove;
  79 } __rte_cache_aligned;
  80
  81 struct virtio_net_data_ll
  82 {
  83         struct vhost_dev                *vdev;  /* Pointer to device created by configuration core. */
  84         struct virtio_net_data_ll       *next;  /* Pointer to next device in linked list. */
  85 };
  86
  87 /*
  88  * Structure containing data core specific information.
  89  */
  90 struct lcore_ll_info
  91 {
  92         struct virtio_net_data_ll       *ll_root_free;          /* Pointer to head in free linked list. */
  93         struct virtio_net_data_ll       *ll_root_used;          /* Pointer to head of used linked list. */
  94         uint32_t                                        device_num;                     /* Number of devices on lcore. */
  95         volatile uint8_t                        dev_removal_flag;       /* Flag to synchronize device removal. */
  96 };
  97
  98 struct lcore_info
  99 {
 100         struct lcore_ll_info    *lcore_ll;      /* Pointer to data core specific lcore_ll_info struct */
 101 };
 102
 103 #endif /* _MAIN_H_ */