examples/vhost/virtio-net.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 _VIRTIO_NET_H_
  35 #define _VIRTIO_NET_H_
  36
  37 /* Used to indicate that the device is running on a data core */
  38 #define VIRTIO_DEV_RUNNING 1
  39
  40 /* Backend value set by guest. */
  41 #define VIRTIO_DEV_STOPPED -1
  42
  43
  44 /* Enum for virtqueue management. */
  45 enum {VIRTIO_RXQ, VIRTIO_TXQ, VIRTIO_QNUM};
  46
  47 /*
  48  * Structure contains variables relevant to TX/RX virtqueues.
  49  */
  50 struct vhost_virtqueue
  51 {
  52         struct vring_desc       *desc;                          /* Virtqueue descriptor ring. */
  53         struct vring_avail      *avail;                         /* Virtqueue available ring. */
  54         struct vring_used       *used;                          /* Virtqueue used ring. */
  55         uint32_t                        size;                           /* Size of descriptor ring. */
  56         uint32_t                        backend;                        /* Backend value to determine if device should started/stopped. */
  57         uint16_t                        vhost_hlen;                     /* Vhost header length (varies depending on RX merge buffers. */
  58         volatile uint16_t       last_used_idx;          /* Last index used on the available ring */
  59         volatile uint16_t       last_used_idx_res;      /* Used for multiple devices reserving buffers. */
  60         eventfd_t                       callfd;                         /* Currently unused as polling mode is enabled. */
  61         eventfd_t                       kickfd;                         /* Used to notify the guest (trigger interrupt). */
  62 } __rte_cache_aligned;
  63
  64 /*
  65  * Device structure contains all configuration information relating to the device.
  66  */
  67 struct virtio_net
  68 {
  69         struct vhost_virtqueue  *virtqueue[VIRTIO_QNUM];        /* Contains all virtqueue information. */
  70         struct virtio_memory    *mem;                                           /* QEMU memory and memory region information. */
  71         struct ether_addr               mac_address;                            /* Device MAC address (Obtained on first TX packet). */
  72         uint64_t                                features;                                       /* Negotiated feature set. */
  73         uint64_t                                device_fh;                                      /* device identifier. */
  74         uint32_t                                vmdq_rx_q;                                      /* RX VMDQ queue number. */
  75         uint32_t                                flags;                                          /* Device flags. Only used to check if device is running on data core. */
  76         uint32_t                                vlan_tag;                                       /* Vlan tag for device. Currently set to device_id (0-63). */
  77         uint16_t                                coreid;                                         /* Data core that the device is added to. */
  78         volatile uint8_t                ready;                                          /* A device is set as ready if the MAC address has been set. */
  79         volatile uint8_t                remove;                                         /* Device is marked for removal from the data core. */
  80 } __rte_cache_aligned;
  81
  82 /*
  83  * Device linked list structure for configuration.
  84  */
  85 struct virtio_net_config_ll
  86 {
  87         struct virtio_net               dev;    /* Virtio device. */
  88         struct virtio_net_config_ll     *next; /* Next entry on linked list. */
  89 };
  90
  91 /*
  92  * Information relating to memory regions including offsets to addresses in QEMUs memory file.
  93  */
  94 struct virtio_memory_regions {
  95         uint64_t        guest_phys_address;             /* Base guest physical address of region. */
  96         uint64_t        guest_phys_address_end; /* End guest physical address of region. */
  97         uint64_t        memory_size;                    /* Size of region. */
  98         uint64_t        userspace_address;              /* Base userspace address of region. */
  99         uint64_t        address_offset;                 /* Offset of region for address translation. */
 100 };
 101
 102 /*
 103  * Memory structure includes region and mapping information.
 104  */
 105 struct virtio_memory {
 106         uint64_t                        base_address;                   /* Base QEMU userspace address of the memory file. */
 107         uint64_t                        mapped_address;                 /* Mapped address of memory file base in our applications memory space. */
 108         uint64_t                        mapped_size;                    /* Total size of memory file. */
 109         uint32_t                        nregions;                               /* Number of memory regions. */
 110         struct virtio_memory_regions    regions[0];     /* Memory region information. */
 111 };
 112
 113 /*
 114  * Device operations to add/remove device.
 115  */
 116 struct virtio_net_device_ops {
 117         int (* new_device)              (struct virtio_net *);  /* Add device. */
 118         void (* destroy_device) (volatile struct virtio_net *); /* Remove device. */
 119 };
 120
 121 int init_virtio_net(struct virtio_net_device_ops const * const);
 122 int deinit_virtio_net(void);
 123
 124 struct vhost_net_device_ops const * get_virtio_net_callbacks(void);
 125
 126 #endif /* _VIRTIO_NET_H_ */