vhost: add private context field
[dpdk.git] / lib / librte_vhost / rte_virtio_net.h
index 4d43f2c..0606143 100644 (file)
@@ -40,7 +40,6 @@
 /* Backend value set by guest. */
 #define VIRTIO_DEV_STOPPED -1
 
-#define PAGE_SIZE   4096
 
 /* Enum for virtqueue management. */
 enum {VIRTIO_RXQ, VIRTIO_TXQ, VIRTIO_QNUM};
@@ -86,17 +85,9 @@ struct virtio_net
        uint64_t                                features;                                       /* Negotiated feature set. */
        uint64_t                                device_fh;                                      /* device identifier. */
        uint32_t                                flags;                                          /* Device flags. Only used to check if device is running on data core. */
+       void                    *priv;                          /**< private context */
 } __rte_cache_aligned;
 
-/*
- * Device linked list structure for configuration.
- */
-struct virtio_net_config_ll
-{
-       struct virtio_net               dev;    /* Virtio device. */
-       struct virtio_net_config_ll     *next; /* Next entry on linked list. */
-};
-
 /*
  * Information relating to memory regions including offsets to addresses in QEMUs memory file.
  */
@@ -108,20 +99,6 @@ struct virtio_memory_regions {
        uint64_t        address_offset;                 /* Offset of region for address translation. */
 };
 
-/*
- * Information relating to memory regions including offsets to
- * addresses in host physical space.
- */
-struct virtio_memory_regions_hpa {
-       /* Base guest physical address of region. */
-       uint64_t        guest_phys_address;
-       /* End guest physical address of region. */
-       uint64_t        guest_phys_address_end;
-       /* Size of region. */
-       uint64_t        memory_size;
-       /* Offset of region for gpa to hpa translation. */
-       uint64_t        host_phys_addr_offset;
-};
 
 /*
  * Memory structure includes region and mapping information.
@@ -131,10 +108,6 @@ struct virtio_memory {
        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. */
-        /* Number of memory regions for gpa to hpa translation. */
-       uint32_t                        nregions_hpa;
-       /* Memory region information for gpa to hpa translation. */
-       struct virtio_memory_regions_hpa  *regions_hpa;
        /* Memory region information. */
        struct virtio_memory_regions      regions[0];
 };
@@ -147,9 +120,83 @@ struct virtio_net_device_ops {
        void (* destroy_device) (volatile struct virtio_net *); /* Remove device. */
 };
 
-int init_virtio_net(struct virtio_net_device_ops const * const);
-int deinit_virtio_net(void);
+static inline uint16_t __attribute__((always_inline))
+rte_vring_available_entries(struct virtio_net *dev, uint16_t queue_id)
+{
+       struct vhost_virtqueue *vq = dev->virtqueue[queue_id];
+       return *(volatile uint16_t *)&vq->avail->idx - vq->last_used_idx_res;
+}
+
+/**
+ * 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.
+ */
+int rte_vhost_feature_disable(uint64_t feature_mask);
 
-struct vhost_net_device_ops const * get_virtio_net_callbacks(void);
+/**
+ *  Enable features in feature_mask. Returns 0 on success.
+ */
+int rte_vhost_feature_enable(uint64_t feature_mask);
+
+/* Returns currently supported vhost features */
+uint64_t rte_vhost_feature_get(void);
+
+int rte_vhost_enable_guest_notification(struct virtio_net *dev, uint16_t queue_id, int enable);
+
+/* Register vhost driver. dev_name could be different for multiple instance support. */
+int rte_vhost_driver_register(const char *dev_name);
+
+/* Register callbacks. */
+int rte_vhost_driver_callback_register(struct virtio_net_device_ops const * const);
+/* Start vhost driver session blocking loop. */
+int rte_vhost_driver_session_start(void);
+
+/**
+ * This function adds buffers to the virtio devices RX virtqueue. Buffers can
+ * be received from the physical port or from another virtual device. A packet
+ * count is returned to indicate the number of packets that were succesfully
+ * added to the RX queue.
+ * @param queue_id
+ *  virtio queue index in mq case
+ * @return
+ *  num of packets enqueued
+ */
+uint16_t rte_vhost_enqueue_burst(struct virtio_net *dev, uint16_t queue_id,
+       struct rte_mbuf **pkts, uint16_t count);
+
+/**
+ * This function gets guest buffers from the virtio device TX virtqueue,
+ * construct host mbufs, copies guest buffer content to host mbufs and
+ * store them in pkts to be processed.
+ * @param mbuf_pool
+ *  mbuf_pool where host mbuf is allocated.
+ * @param queue_id
+ *  virtio queue index in mq case.
+ * @return
+ *  num of packets dequeued
+ */
+uint16_t rte_vhost_dequeue_burst(struct virtio_net *dev, uint16_t queue_id,
+       struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
 
 #endif /* _VIRTIO_NET_H_ */