X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_vhost%2Frte_vdpa.h;h=1437f400bf8d175ffb4b7097b425893f36ffb536;hb=2b9a66e1b606d3813d72dd81c626949e09706e27;hp=3c400ee79bc9de48b9c849c069ff128d0fb0c022;hpb=0265a1980f7b2752b0cba9c476eb6c670b8ad778;p=dpdk.git diff --git a/lib/librte_vhost/rte_vdpa.h b/lib/librte_vhost/rte_vdpa.h index 3c400ee79b..1437f400bf 100644 --- a/lib/librte_vhost/rte_vdpa.h +++ b/lib/librte_vhost/rte_vdpa.h @@ -11,193 +11,176 @@ * Device specific vhost lib */ -#include +#include -#include -#include "rte_vhost.h" +/** Maximum name length for statistics counters */ +#define RTE_VDPA_STATS_NAME_SIZE 64 -#define MAX_VDPA_NAME_LEN 128 - -enum vdpa_addr_type { - VDPA_ADDR_PCI, - VDPA_ADDR_MAX -}; +struct rte_vdpa_device; /** - * vdpa device address + * A vDPA device statistic structure + * + * This structure is used by rte_vdpa_stats_get() to provide + * statistics from the HW vDPA device. + * + * It maps a name id, corresponding to an index in the array returned + * by rte_vdpa_get_stats_names, to a statistic value. */ -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; - }; +struct rte_vdpa_stat { + uint64_t id; /**< The index in stats name array */ + uint64_t value; /**< The statistic counter value */ }; /** - * vdpa device operations + * A name element for statistics + * + * An array of this structure is returned by rte_vdpa_get_stats_names + * It lists the names of extended statistics for a PMD. The rte_vdpa_stat + * structure references these names by their array index */ -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); - - /** Reserved for future extension */ - void *reserved[5]; +struct rte_vdpa_stat_name { + char name[RTE_VDPA_STATS_NAME_SIZE]; /**< The statistic name */ }; /** - * vdpa device structure includes device address and device operations. + * Find the device id of a vdpa device from its name + * + * @param name + * the vdpa device name + * @return + * vDPA device pointer on success, NULL on failure */ -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; +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 * - * Register a vdpa device + * @param vdpa_dev + * the vdpa device pointer + * @return + * generic device pointer on success, NULL on failure + */ +struct rte_device * +rte_vdpa_get_rte_device(struct rte_vdpa_device *vdpa_dev); + +/** + * Get number of queue pairs supported by the vDPA device * - * @param addr - * the vdpa device address - * @param ops - * the vdpa device operations + * @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_register_device(struct rte_vdpa_dev_addr *addr, - struct rte_vdpa_dev_ops *ops); +rte_vdpa_get_queue_num(struct rte_vdpa_device *dev, uint32_t *queue_num); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * - * Unregister a vdpa device + * Get the Virtio features supported by the vDPA device * - * @param did - * vdpa device id + * @param dev + * vDP device pointer + * @param features + * pointer on where the supported features are stored * @return - * device id on success, -1 on failure + * 0 on success, -1 on failure */ -__rte_experimental int -rte_vdpa_unregister_device(int did); +rte_vdpa_get_features(struct rte_vdpa_device *dev, uint64_t *features); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * - * Find the device id of a vdpa device + * Get the Vhost-user protocol features supported by the vDPA device * - * @param addr - * the vdpa device address + * @param dev + * vDP device pointer + * @param features + * pointer on where the supported protocol features are 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_protocol_features(struct rte_vdpa_device *dev, uint64_t *features); /** - * @warning - * @b EXPERIMENTAL: this API may change without prior notice - * - * Find a vdpa device based on device id + * 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. * - * @param did - * device id + * @param vid + * vhost device id + * @param qid + * vhost queue id + * @param vring_m + * mediated virtio ring pointer * @return - * rte_vdpa_device on success, NULL on failure + * number of synced used entries on success, -1 on failure */ -__rte_experimental -struct rte_vdpa_device * -rte_vdpa_get_device(int did); +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. * - * Get current available vdpa device number + * There is an assumption that 'stat_names' and 'stats' arrays are matched + * by array index: stats_names[i].name => stats[i].value * + * And the array index is same with id field of 'struct rte_vdpa_stat': + * stats[i].id == i + * + * @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. + * @param size + * The number of elements in stats_names array. * @return - * available vdpa device number + * A negative value on error, otherwise the number of entries filled in the + * stats name array. */ -__rte_experimental int -rte_vdpa_get_device_num(void); +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. * - * Enable/Disable host notifier mapping for a vdpa port. + * There is an assumption that 'stat_names' and 'stats' arrays are matched + * by array index: stats_names[i].name => stats[i].value * - * @param vid - * vhost device id - * @param enable - * true for host notifier map, false for host notifier unmap + * And the array index is same with id field of 'struct rte_vdpa_stat': + * stats[i].id == i + * + * @param dev + * vDPA device pointer + * @param qid + * queue id + * @param stats + * A pointer to a table of structure of type rte_vdpa_stat to be filled with + * device statistics ids and values. + * @param n + * The number of elements in stats array. * @return - * 0 on success, -1 on failure + * A negative value on error, otherwise the number of entries filled in the + * stats table. */ -__rte_experimental int -rte_vhost_host_notifier_ctrl(int vid, bool enable); - +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 - * - * 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. + * Reset statistics of a vDPA device. * - * @param vid - * vhost device id + * @param dev + * vDPA device pointer * @param qid - * vhost queue id - * @param vring_m - * mediated virtio ring pointer + * queue id * @return - * number of synced used entries on success, -1 on failure + * 0 on success, a negative value on error. */ -__rte_experimental int -rte_vdpa_relay_vring_used(int vid, uint16_t qid, void *vring_m); +rte_vdpa_reset_stats(struct rte_vdpa_device *dev, uint16_t qid); #endif /* _RTE_VDPA_H_ */