vhost: hide internal code
authorYuanhan Liu <yuanhan.liu@linux.intel.com>
Sat, 30 Apr 2016 05:11:19 +0000 (13:11 +0800)
committerYuanhan Liu <yuanhan.liu@linux.intel.com>
Wed, 22 Jun 2016 07:43:01 +0000 (09:43 +0200)
We are now safe to move all those internal structs/macros/functions to
vhost-net.h, to hide them from external access.

This patch also breaks long lines and removes some redundant comments.

Signed-off-by: Yuanhan Liu <yuanhan.liu@linux.intel.com>
Tested-by: Rich Lane <rich.lane@bigswitch.com>
Acked-by: Rich Lane <rich.lane@bigswitch.com>
lib/librte_vhost/rte_virtio_net.h
lib/librte_vhost/vhost-net.h
lib/librte_vhost/vhost_user/vhost-net-user.h

index 370345e..fc1d799 100644 (file)
 #include <rte_mempool.h>
 #include <rte_ether.h>
 
-struct rte_mbuf;
-
-#define VHOST_MEMORY_MAX_NREGIONS 8
-
-/* 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
-
-
 /* Enum for virtqueue management. */
 enum {VIRTIO_RXQ, VIRTIO_TXQ, VIRTIO_QNUM};
 
-#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;                  /**< Virtqueue descriptor ring. */
-       struct vring_avail      *avail;                 /**< Virtqueue available ring. */
-       struct vring_used       *used;                  /**< Virtqueue used ring. */
-       uint32_t                size;                   /**< Size of descriptor ring. */
-       int                     backend;                /**< Backend value to determine if device should started/stopped. */
-       uint16_t                vhost_hlen;             /**< Vhost header length (varies depending on RX merge buffers. */
-       volatile uint16_t       last_used_idx;          /**< Last index used on the available ring */
-       volatile uint16_t       last_used_idx_res;      /**< Used for multiple devices reserving buffers. */
-#define VIRTIO_INVALID_EVENTFD         (-1)
-#define VIRTIO_UNINITIALIZED_EVENTFD   (-2)
-       int                     callfd;                 /**< Used to notify the guest (trigger interrupt). */
-       int                     kickfd;                 /**< Currently unused as polling mode is enabled. */
-       int                     enabled;
-       uint64_t                log_guest_addr;         /**< Physical address of used ring, for logging */
-       uint64_t                reserved[15];           /**< Reserve some spaces for future extension. */
-       struct buf_vector       buf_vec[BUF_VECTOR_MAX];        /**< for scatter RX. */
-} __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 {
-       struct virtio_memory    *mem;           /**< QEMU memory and memory region information. */
-       uint64_t                features;       /**< Negotiated feature set. */
-       uint64_t                protocol_features;      /**< Negotiated protocol feature set. */
-       int                     vid;            /**< device identifier. */
-       uint32_t                flags;          /**< Device flags. Only used to check if device is running on data core. */
-#define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
-       char                    ifname[IF_NAME_SZ];     /**< Name of the tap device or socket path. */
-       uint32_t                virt_qp_nb;     /**< number of queue pair we have allocated */
-       void                    *priv;          /**< private context */
-       uint64_t                log_size;       /**< Size of log area */
-       uint64_t                log_base;       /**< Where dirty pages are logged */
-       struct ether_addr       mac;            /**< MAC address */
-       rte_atomic16_t          broadcast_rarp; /**< A flag to tell if we need broadcast rarp packet */
-       uint64_t                reserved[61];   /**< Reserve some spaces for future extension. */
-       struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];  /**< Contains all virtqueue information. */
-} __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;     /**< Base guest physical address of region. */
-       uint64_t        guest_phys_address_end; /**< End guest physical address of region. */
-       uint64_t        memory_size;            /**< Size of region. */
-       uint64_t        userspace_address;      /**< Base userspace address of region. */
-       uint64_t        address_offset;         /**< Offset of region for address translation. */
-};
-
-
-/**
- * Memory structure includes region and mapping information.
- */
-struct virtio_memory {
-       uint64_t        base_address;   /**< Base QEMU userspace address of the memory file. */
-       uint64_t        mapped_address; /**< Mapped address of memory file base in our applications memory space. */
-       uint64_t        mapped_size;    /**< Total size of memory file. */
-       uint32_t        nregions;       /**< Number of memory regions. */
-       struct virtio_memory_regions      regions[0]; /**< Memory region information. */
-};
-
 /**
  * Device and vring operations.
  *
@@ -184,29 +68,6 @@ struct virtio_net_device_ops {
        int (*vring_state_changed)(int vid, uint16_t queue_id, int enable);     /**< triggered when a vring is enabled or disabled */
 };
 
-/**
- * Function to convert guest physical addresses to vhost virtual addresses.
- * This is used to convert guest virtio buffer addresses.
- */
-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;
-
-       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;
-}
-
-
 /**
  *  Disable features in feature_mask. Returns 0 on success.
  */
index 4ed5816..3edeb92 100644 (file)
 
 #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;
+       uint16_t                vhost_hlen;
+
+       /* Last index used on the available ring */
+       volatile uint16_t       last_used_idx;
+       /* Used for multiple devices reserving buffers */
+       volatile uint16_t       last_used_idx_res;
+#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;
+       uint64_t                reserved[15];
+       struct buf_vector       buf_vec[BUF_VECTOR_MAX];
+} __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;
+#define IF_NAME_SZ (PATH_MAX > IFNAMSIZ ? PATH_MAX : IFNAMSIZ)
+       char                    ifname[IF_NAME_SZ];
+       uint32_t                virt_qp_nb;
+       void                    *priv;
+       uint64_t                log_size;
+       uint64_t                log_base;
+       struct ether_addr       mac;
+
+       /* to tell if we need broadcast rarp packet */
+       rte_atomic16_t          broadcast_rarp;
+       uint64_t                reserved[61];
+       struct vhost_virtqueue  *virtqueue[VHOST_MAX_QUEUE_PAIRS * 2];
+} __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
 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
 #endif
 
+/**
+ * Function to convert guest physical addresses to vhost virtual addresses.
+ * This is used to convert guest virtio buffer addresses.
+ */
+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;
+
+       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 vhost_new_device(void);
 void vhost_destroy_device(int);
index e3bb413..ec68b96 100644 (file)
@@ -47,6 +47,8 @@ struct vhost_server {
 
 /* refer to hw/virtio/vhost-user.c */
 
+#define VHOST_MEMORY_MAX_NREGIONS 8
+
 typedef enum VhostUserRequest {
        VHOST_USER_NONE = 0,
        VHOST_USER_GET_FEATURES = 1,