vhost: remove sub-directory
[dpdk.git] / lib / librte_vhost / vhost-net.h
index 03a5c57..38593a2 100644 (file)
 
 #include <rte_log.h>
 
+#include "rte_virtio_net.h"
+
+/* Used to indicate that the device is running on a data core */
+#define VIRTIO_DEV_RUNNING 1
+
+/* Backend value set by guest. */
+#define VIRTIO_DEV_STOPPED -1
+
+#define BUF_VECTOR_MAX 256
+
+/**
+ * Structure contains buffer address, length and descriptor index
+ * from vring to do scatter RX.
+ */
+struct buf_vector {
+       uint64_t buf_addr;
+       uint32_t buf_len;
+       uint32_t desc_idx;
+};
+
+/**
+ * Structure contains variables relevant to RX/TX virtqueues.
+ */
+struct vhost_virtqueue {
+       struct vring_desc       *desc;
+       struct vring_avail      *avail;
+       struct vring_used       *used;
+       uint32_t                size;
+
+       /* Last index used on the available ring */
+       volatile uint16_t       last_used_idx;
+#define VIRTIO_INVALID_EVENTFD         (-1)
+#define VIRTIO_UNINITIALIZED_EVENTFD   (-2)
+
+       /* Backend value to determine if device should started/stopped */
+       int                     backend;
+       /* Used to notify the guest (trigger interrupt) */
+       int                     callfd;
+       /* Currently unused as polling mode is enabled */
+       int                     kickfd;
+       int                     enabled;
+
+       /* Physical address of used ring, for logging */
+       uint64_t                log_guest_addr;
+} __rte_cache_aligned;
+
+/* Old kernels have no such macro defined */
+#ifndef VIRTIO_NET_F_GUEST_ANNOUNCE
+ #define VIRTIO_NET_F_GUEST_ANNOUNCE 21
+#endif
+
+
+/*
+ * Make an extra wrapper for VIRTIO_NET_F_MQ and
+ * VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX as they are
+ * introduced since kernel v3.8. This makes our
+ * code buildable for older kernel.
+ */
+#ifdef VIRTIO_NET_F_MQ
+ #define VHOST_MAX_QUEUE_PAIRS VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX
+ #define VHOST_SUPPORTS_MQ     (1ULL << VIRTIO_NET_F_MQ)
+#else
+ #define VHOST_MAX_QUEUE_PAIRS 1
+ #define VHOST_SUPPORTS_MQ     0
+#endif
+
+/*
+ * Define virtio 1.0 for older kernels
+ */
+#ifndef VIRTIO_F_VERSION_1
+ #define VIRTIO_F_VERSION_1 32
+#endif
+
+/**
+ * Device structure contains all configuration information relating
+ * to the device.
+ */
+struct virtio_net {
+       /* Frontend (QEMU) memory and memory region information */
+       struct virtio_memory    *mem;
+       uint64_t                features;
+       uint64_t                protocol_features;
+       int                     vid;
+       uint32_t                flags;
+       uint16_t                vhost_hlen;
+       /* to tell if we need broadcast rarp packet */
+       rte_atomic16_t          broadcast_rarp;
+       uint32_t                virt_qp_nb;
+       struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
+#define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
+       char                    ifname[IF_NAME_SZ];
+       uint64_t                log_size;
+       uint64_t                log_base;
+       uint64_t                log_addr;
+       struct ether_addr       mac;
+
+} __rte_cache_aligned;
+
+/**
+ * Information relating to memory regions including offsets to
+ * addresses in QEMUs memory file.
+ */
+struct virtio_memory_regions {
+       uint64_t guest_phys_address;
+       uint64_t guest_phys_address_end;
+       uint64_t memory_size;
+       uint64_t userspace_address;
+       uint64_t address_offset;
+};
+
+
+/**
+ * Memory structure includes region and mapping information.
+ */
+struct virtio_memory {
+       /* Base QEMU userspace address of the memory file. */
+       uint64_t base_address;
+       uint64_t mapped_address;
+       uint64_t mapped_size;
+       uint32_t nregions;
+       struct virtio_memory_regions regions[0];
+};
+
+
 /* Macros for printing using RTE_LOG */
 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
 #define RTE_LOGTYPE_VHOST_DATA   RTE_LOGTYPE_USER1
        char packet[VHOST_MAX_PRINT_BUFF]; \
        \
        if ((header)) \
-               snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%"PRIu64") Header size %d: ", (device->device_fh), (size)); \
+               snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Header size %d: ", (device->vid), (size)); \
        else \
-               snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%"PRIu64") Packet size %d: ", (device->device_fh), (size)); \
+               snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%d) Packet size %d: ", (device->vid), (size)); \
        for (index = 0; index < (size); index++) { \
                snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
                        "%02hhx ", pkt_addr[index]); \
 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
 #endif
 
-
-/*
- * Structure used to identify device context.
+/**
+ * Function to convert guest physical addresses to vhost virtual addresses.
+ * This is used to convert guest virtio buffer addresses.
  */
-struct vhost_device_ctx {
-       pid_t           pid;    /* PID of process calling the IOCTL. */
-       uint64_t        fh;     /* Populated with fi->fh to track the device index. */
-};
+static inline uint64_t __attribute__((always_inline))
+gpa_to_vva(struct virtio_net *dev, uint64_t guest_pa)
+{
+       struct virtio_memory_regions *region;
+       uint32_t regionidx;
+       uint64_t vhost_va = 0;
 
-/*
- * Structure contains function pointers to be defined in virtio-net.c. These
- * functions are called in CUSE context and are used to configure devices.
- */
-struct vhost_net_device_ops {
-       int (*new_device)(struct vhost_device_ctx);
-       void (*destroy_device)(struct vhost_device_ctx);
+       for (regionidx = 0; regionidx < dev->mem->nregions; regionidx++) {
+               region = &dev->mem->regions[regionidx];
+               if ((guest_pa >= region->guest_phys_address) &&
+                       (guest_pa <= region->guest_phys_address_end)) {
+                       vhost_va = region->address_offset + guest_pa;
+                       break;
+               }
+       }
+       return vhost_va;
+}
 
-       int (*get_features)(struct vhost_device_ctx, uint64_t *);
-       int (*set_features)(struct vhost_device_ctx, uint64_t *);
+struct virtio_net_device_ops const *notify_ops;
+struct virtio_net *get_device(int vid);
 
-       int (*set_mem_table)(struct vhost_device_ctx, const void *, uint32_t);
+int vhost_new_device(void);
+void vhost_destroy_device(int);
 
-       int (*set_vring_num)(struct vhost_device_ctx, struct vhost_vring_state *);
-       int (*set_vring_addr)(struct vhost_device_ctx, struct vhost_vring_addr *);
-       int (*set_vring_base)(struct vhost_device_ctx, struct vhost_vring_state *);
-       int (*get_vring_base)(struct vhost_device_ctx, uint32_t, struct vhost_vring_state *);
+void vhost_set_ifname(int, const char *if_name, unsigned int if_len);
 
-       int (*set_vring_kick)(struct vhost_device_ctx, struct vhost_vring_file *);
-       int (*set_vring_call)(struct vhost_device_ctx, struct vhost_vring_file *);
+int vhost_get_features(int, uint64_t *);
+int vhost_set_features(int, uint64_t *);
 
-       int (*set_backend)(struct vhost_device_ctx, struct vhost_vring_file *);
+int vhost_set_vring_num(int, struct vhost_vring_state *);
+int vhost_set_vring_addr(int, struct vhost_vring_addr *);
+int vhost_set_vring_base(int, struct vhost_vring_state *);
+int vhost_get_vring_base(int, uint32_t, struct vhost_vring_state *);
 
-       int (*set_owner)(struct vhost_device_ctx);
-       int (*reset_owner)(struct vhost_device_ctx);
-};
+int vhost_set_vring_kick(int, struct vhost_vring_file *);
+int vhost_set_vring_call(int, struct vhost_vring_file *);
+
+int vhost_set_backend(int, struct vhost_vring_file *);
+
+int vhost_set_owner(int);
+int vhost_reset_owner(int);
 
+/*
+ * Backend-specific cleanup. Defined by vhost-cuse and vhost-user.
+ */
+void vhost_backend_cleanup(struct virtio_net *dev);
 
-struct vhost_net_device_ops const *get_virtio_net_callbacks(void);
 #endif /* _VHOST_NET_CDEV_H_ */