rte_vhost.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2017 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _RTE_VHOST_H_
#define _RTE_VHOST_H_

#include <stdint.h>
#include <sys/eventfd.h>

#include <rte_memory.h>
#include <rte_mempool.h>

#ifdef __cplusplus
extern "C" {
#endif

/* These are not C++-aware. */
#include <linux/vhost.h>
#include <linux/virtio_ring.h>

#define RTE_VHOST_USER_CLIENT           (1ULL << 0)
#define RTE_VHOST_USER_NO_RECONNECT     (1ULL << 1)
#define RTE_VHOST_USER_DEQUEUE_ZERO_COPY        (1ULL << 2)

struct rte_vhost_mem_region {
        uint64_t guest_phys_addr;
        uint64_t guest_user_addr;
        uint64_t host_user_addr;
        uint64_t size;
        void     *mmap_addr;
        uint64_t mmap_size;
        int fd;
};

struct rte_vhost_memory {
        uint32_t nregions;
        struct rte_vhost_mem_region regions[];
};

struct rte_vhost_vring {
        struct vring_desc       *desc;
        struct vring_avail      *avail;
        struct vring_used       *used;
        uint64_t                log_guest_addr;

        int                     callfd;
        int                     kickfd;
        uint16_t                size;
};

struct vhost_device_ops {
        int (*new_device)(int vid);             
        void (*destroy_device)(int vid);        
        int (*vring_state_changed)(int vid, uint16_t queue_id, int enable);     
        int (*features_changed)(int vid, uint64_t features);

        void *reserved[4]; 
};

static inline uint64_t __attribute__((always_inline))
rte_vhost_gpa_to_vva(struct rte_vhost_memory *mem, uint64_t gpa)
{
        struct rte_vhost_mem_region *reg;
        uint32_t i;

        for (i = 0; i < mem->nregions; i++) {
                reg = &mem->regions[i];
                if (gpa >= reg->guest_phys_addr &&
                    gpa <  reg->guest_phys_addr + reg->size) {
                        return gpa - reg->guest_phys_addr +
                               reg->host_user_addr;
                }
        }

        return 0;
}

#define RTE_VHOST_NEED_LOG(features)    ((features) & (1ULL << VHOST_F_LOG_ALL))

void rte_vhost_log_write(int vid, uint64_t addr, uint64_t len);

void rte_vhost_log_used_vring(int vid, uint16_t vring_idx,
                              uint64_t offset, uint64_t len);

int rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable);

int rte_vhost_driver_register(const char *path, uint64_t flags);

/* Unregister vhost driver. This is only meaningful to vhost user. */
int rte_vhost_driver_unregister(const char *path);

int rte_vhost_driver_set_features(const char *path, uint64_t features);

int rte_vhost_driver_enable_features(const char *path, uint64_t features);

int rte_vhost_driver_disable_features(const char *path, uint64_t features);

int rte_vhost_driver_get_features(const char *path, uint64_t *features);

int rte_vhost_get_negotiated_features(int vid, uint64_t *features);

/* Register callbacks. */
int rte_vhost_driver_callback_register(const char *path,
        struct vhost_device_ops const * const ops);

int rte_vhost_driver_start(const char *path);

int rte_vhost_get_mtu(int vid, uint16_t *mtu);

int rte_vhost_get_numa_node(int vid);

__rte_deprecated
uint32_t rte_vhost_get_queue_num(int vid);

uint16_t rte_vhost_get_vring_num(int vid);

int rte_vhost_get_ifname(int vid, char *buf, size_t len);

uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id);

struct rte_mbuf;
struct rte_mempool;
uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
        struct rte_mbuf **pkts, uint16_t count);

uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
        struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);

int rte_vhost_get_mem_table(int vid, struct rte_vhost_memory **mem);

int rte_vhost_get_vhost_vring(int vid, uint16_t vring_idx,
                              struct rte_vhost_vring *vring);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_VHOST_H_ */