X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_vhost%2Frte_vdpa.h;h=f074ec0c4a6f96be5520849e12950fda8d8e630f;hb=8fc9eaaac7181bdfc024230a63a89d550c625dd0;hp=ecb3d911d060d6e6b394cca7eead1d5cab6870dc;hpb=1cb44157518a68f3f829e476ea2cb2040dcc0dd5;p=dpdk.git diff --git a/lib/librte_vhost/rte_vdpa.h b/lib/librte_vhost/rte_vdpa.h index ecb3d911d0..f074ec0c4a 100644 --- a/lib/librte_vhost/rte_vdpa.h +++ b/lib/librte_vhost/rte_vdpa.h @@ -11,35 +11,11 @@ * Device specific vhost lib */ -#include - -#include -#include "rte_vhost.h" - -#define MAX_VDPA_NAME_LEN 128 - -enum vdpa_addr_type { - VDPA_ADDR_PCI, - VDPA_ADDR_MAX -}; - -/** - * vdpa device address - */ -struct rte_vdpa_dev_addr { - /** vdpa address type */ - enum vdpa_addr_type type; - - /** vdpa pci address */ - union { - uint8_t __dummy[64]; - struct rte_pci_addr pci_addr; - }; -}; - /** Maximum name length for statistics counters */ #define RTE_VDPA_STATS_NAME_SIZE 64 +struct rte_vdpa_device; + /** * A vDPA device statistic structure * @@ -66,163 +42,67 @@ struct rte_vdpa_stat_name { }; /** - * vdpa device operations - */ -struct rte_vdpa_dev_ops { - /** Get capabilities of this device */ - int (*get_queue_num)(int did, uint32_t *queue_num); - - /** Get supported features of this device */ - int (*get_features)(int did, uint64_t *features); - - /** Get supported protocol features of this device */ - int (*get_protocol_features)(int did, uint64_t *protocol_features); - - /** Driver configure/close the device */ - int (*dev_conf)(int vid); - int (*dev_close)(int vid); - - /** Enable/disable this vring */ - int (*set_vring_state)(int vid, int vring, int state); - - /** Set features when changed */ - int (*set_features)(int vid); - - /** Destination operations when migration done */ - int (*migration_done)(int vid); - - /** Get the vfio group fd */ - int (*get_vfio_group_fd)(int vid); - - /** Get the vfio device fd */ - int (*get_vfio_device_fd)(int vid); - - /** Get the notify area info of the queue */ - int (*get_notify_area)(int vid, int qid, - uint64_t *offset, uint64_t *size); - - /** Get statistics name */ - int (*get_stats_names)(int did, struct rte_vdpa_stat_name *stats_names, - unsigned int size); - - /** Get statistics of the queue */ - int (*get_stats)(int did, int qid, struct rte_vdpa_stat *stats, - unsigned int n); - - /** Reset statistics of the queue */ - int (*reset_stats)(int did, int qid); - - /** Reserved for future extension */ - void *reserved[2]; -}; - -/** - * vdpa device structure includes device address and device operations. - */ -struct rte_vdpa_device { - /** vdpa device address */ - struct rte_vdpa_dev_addr addr; - /** vdpa device operations */ - struct rte_vdpa_dev_ops *ops; -} __rte_cache_aligned; - -/** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice + * Find the device id of a vdpa device from its name * - * Register a vdpa device - * - * @param addr - * the vdpa device address - * @param ops - * the vdpa device operations + * @param name + * the vdpa device name * @return - * device id on success, -1 on failure + * vDPA device pointer on success, NULL on failure */ -__rte_experimental -int -rte_vdpa_register_device(struct rte_vdpa_dev_addr *addr, - struct rte_vdpa_dev_ops *ops); +struct rte_vdpa_device * +rte_vdpa_find_device_by_name(const char *name); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice + * Get the generic device from the vdpa device * - * Unregister a vdpa device - * - * @param did - * vdpa device id + * @param vdpa_dev + * the vdpa device pointer * @return - * device id on success, -1 on failure + * generic device pointer on success, NULL on failure */ -__rte_experimental -int -rte_vdpa_unregister_device(int did); +struct rte_device * +rte_vdpa_get_rte_device(struct rte_vdpa_device *vdpa_dev); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice + * Get number of queue pairs supported by the vDPA device * - * Find the device id of a vdpa device - * - * @param addr - * the vdpa device address + * @param dev + * vDP device pointer + * @param queue_num + * pointer on where the number of queue is stored * @return - * device id on success, -1 on failure + * 0 on success, -1 on failure */ -__rte_experimental int -rte_vdpa_find_device_id(struct rte_vdpa_dev_addr *addr); +rte_vdpa_get_queue_num(struct rte_vdpa_device *dev, uint32_t *queue_num); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice + * Get the Virtio features supported by the vDPA device * - * Find a vdpa device based on device id - * - * @param did - * device id + * @param dev + * vDP device pointer + * @param features + * pointer on where the supported features are stored * @return - * rte_vdpa_device on success, NULL on failure - */ -__rte_experimental -struct rte_vdpa_device * -rte_vdpa_get_device(int did); - -/** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * - * Get current available vdpa device number - * - * @return - * available vdpa device number + * 0 on success, -1 on failure */ -__rte_experimental int -rte_vdpa_get_device_num(void); +rte_vdpa_get_features(struct rte_vdpa_device *dev, uint64_t *features); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * - * Enable/Disable host notifier mapping for a vdpa port. + * Get the Vhost-user protocol features supported by the vDPA device * - * @param vid - * vhost device id - * @param enable - * true for host notifier map, false for host notifier unmap + * @param dev + * vDP device pointer + * @param features + * pointer on where the supported protocol features are stored * @return * 0 on success, -1 on failure */ -__rte_experimental int -rte_vhost_host_notifier_ctrl(int vid, bool enable); +rte_vdpa_get_protocol_features(struct rte_vdpa_device *dev, uint64_t *features); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Synchronize the used ring from mediated ring to guest, log dirty * page for each writeable buffer, caller should handle the used * ring logging before device stop. @@ -236,14 +116,10 @@ rte_vhost_host_notifier_ctrl(int vid, bool enable); * @return * number of synced used entries on success, -1 on failure */ -__rte_experimental int rte_vdpa_relay_vring_used(int vid, uint16_t qid, void *vring_m); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Retrieve names of statistics of a vDPA device. * * There is an assumption that 'stat_names' and 'stats' arrays are matched @@ -252,8 +128,8 @@ rte_vdpa_relay_vring_used(int vid, uint16_t qid, void *vring_m); * And the array index is same with id field of 'struct rte_vdpa_stat': * stats[i].id == i * - * @param did - * device id + * @param dev + * vDPA device pointer * @param stats_names * array of at least size elements to be filled. * If set to NULL, the function returns the required number of elements. @@ -263,15 +139,12 @@ rte_vdpa_relay_vring_used(int vid, uint16_t qid, void *vring_m); * A negative value on error, otherwise the number of entries filled in the * stats name array. */ -__rte_experimental int -rte_vdpa_get_stats_names(int did, struct rte_vdpa_stat_name *stats_names, - unsigned int size); +rte_vdpa_get_stats_names(struct rte_vdpa_device *dev, + struct rte_vdpa_stat_name *stats_names, + unsigned int size); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Retrieve statistics of a vDPA device. * * There is an assumption that 'stat_names' and 'stats' arrays are matched @@ -280,8 +153,8 @@ rte_vdpa_get_stats_names(int did, struct rte_vdpa_stat_name *stats_names, * And the array index is same with id field of 'struct rte_vdpa_stat': * stats[i].id == i * - * @param did - * device id + * @param dev + * vDPA device pointer * @param qid * queue id * @param stats @@ -293,24 +166,19 @@ rte_vdpa_get_stats_names(int did, struct rte_vdpa_stat_name *stats_names, * A negative value on error, otherwise the number of entries filled in the * stats table. */ -__rte_experimental int -rte_vdpa_get_stats(int did, uint16_t qid, struct rte_vdpa_stat *stats, - unsigned int n); +rte_vdpa_get_stats(struct rte_vdpa_device *dev, uint16_t qid, + struct rte_vdpa_stat *stats, unsigned int n); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * * Reset statistics of a vDPA device. * - * @param did - * device id + * @param dev + * vDPA device pointer * @param qid * queue id * @return * 0 on success, a negative value on error. */ -__rte_experimental int -rte_vdpa_reset_stats(int did, uint16_t qid); +rte_vdpa_reset_stats(struct rte_vdpa_device *dev, uint16_t qid); #endif /* _RTE_VDPA_H_ */