lib/librte_vhost/rte_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 /**
  38  * @file
  39  * Interface to vhost net
  40  */
  41
  42 #include <stdint.h>
  43 #include <linux/vhost.h>
  44 #include <linux/virtio_ring.h>
  45 #include <linux/virtio_net.h>
  46 #include <sys/eventfd.h>
  47 #include <sys/socket.h>
  48 #include <linux/if.h>
  49
  50 #include <rte_memory.h>
  51 #include <rte_mempool.h>
  52 #include <rte_ether.h>
  53
  54 #define RTE_VHOST_USER_CLIENT           (1ULL << 0)
  55
  56 /* Enum for virtqueue management. */
  57 enum {VIRTIO_RXQ, VIRTIO_TXQ, VIRTIO_QNUM};
  58
  59 /**
  60  * Device and vring operations.
  61  *
  62  * Make sure to set VIRTIO_DEV_RUNNING to the device flags in new_device and
  63  * remove it in destroy_device.
  64  *
  65  */
  66 struct virtio_net_device_ops {
  67         int (*new_device)(int vid);             /**< Add device. */
  68         void (*destroy_device)(int vid);        /**< Remove device. */
  69
  70         int (*vring_state_changed)(int vid, uint16_t queue_id, int enable);     /**< triggered when a vring is enabled or disabled */
  71
  72         void *reserved[5]; /**< Reserved for future extension */
  73 };
  74
  75 /**
  76  *  Disable features in feature_mask. Returns 0 on success.
  77  */
  78 int rte_vhost_feature_disable(uint64_t feature_mask);
  79
  80 /**
  81  *  Enable features in feature_mask. Returns 0 on success.
  82  */
  83 int rte_vhost_feature_enable(uint64_t feature_mask);
  84
  85 /* Returns currently supported vhost features */
  86 uint64_t rte_vhost_feature_get(void);
  87
  88 int rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable);
  89
  90 /**
  91  * Register vhost driver. path could be different for multiple
  92  * instance support.
  93  */
  94 int rte_vhost_driver_register(const char *path, uint64_t flags);
  95
  96 /* Unregister vhost driver. This is only meaningful to vhost user. */
  97 int rte_vhost_driver_unregister(const char *path);
  98
  99 /* Register callbacks. */
 100 int rte_vhost_driver_callback_register(struct virtio_net_device_ops const * const);
 101 /* Start vhost driver session blocking loop. */
 102 int rte_vhost_driver_session_start(void);
 103
 104 /**
 105  * Get the numa node from which the virtio net device's memory
 106  * is allocated.
 107  *
 108  * @param vid
 109  *  virtio-net device ID
 110  *
 111  * @return
 112  *  The numa node, -1 on failure
 113  */
 114 int rte_vhost_get_numa_node(int vid);
 115
 116 /**
 117  * Get the number of queues the device supports.
 118  *
 119  * @param vid
 120  *  virtio-net device ID
 121  *
 122  * @return
 123  *  The number of queues, 0 on failure
 124  */
 125 uint32_t rte_vhost_get_queue_num(int vid);
 126
 127 /**
 128  * Get the virtio net device's ifname. For vhost-cuse, ifname is the
 129  * path of the char device. For vhost-user, ifname is the vhost-user
 130  * socket file path.
 131  *
 132  * @param vid
 133  *  virtio-net device ID
 134  * @param buf
 135  *  The buffer to stored the queried ifname
 136  * @param len
 137  *  The length of buf
 138  *
 139  * @return
 140  *  0 on success, -1 on failure
 141  */
 142 int rte_vhost_get_ifname(int vid, char *buf, size_t len);
 143
 144 /**
 145  * Get how many avail entries are left in the queue
 146  *
 147  * @param vid
 148  *  virtio-net device ID
 149  * @param queue_id
 150  *  virtio queue index
 151  *
 152  * @return
 153  *  num of avail entires left
 154  */
 155 uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id);
 156
 157 /**
 158  * This function adds buffers to the virtio devices RX virtqueue. Buffers can
 159  * be received from the physical port or from another virtual device. A packet
 160  * count is returned to indicate the number of packets that were succesfully
 161  * added to the RX queue.
 162  * @param vid
 163  *  virtio-net device ID
 164  * @param queue_id
 165  *  virtio queue index in mq case
 166  * @param pkts
 167  *  array to contain packets to be enqueued
 168  * @param count
 169  *  packets num to be enqueued
 170  * @return
 171  *  num of packets enqueued
 172  */
 173 uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
 174         struct rte_mbuf **pkts, uint16_t count);
 175
 176 /**
 177  * This function gets guest buffers from the virtio device TX virtqueue,
 178  * construct host mbufs, copies guest buffer content to host mbufs and
 179  * store them in pkts to be processed.
 180  * @param vid
 181  *  virtio-net device
 182  * @param queue_id
 183  *  virtio queue index in mq case
 184  * @param mbuf_pool
 185  *  mbuf_pool where host mbuf is allocated.
 186  * @param pkts
 187  *  array to contain packets to be dequeued
 188  * @param count
 189  *  packets num to be dequeued
 190  * @return
 191  *  num of packets dequeued
 192  */
 193 uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
 194         struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
 195
 196 #endif /* _VIRTIO_NET_H_ */