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