lib/librte_vhost/rte_vdpa.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2018 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_VDPA_H_
   6 #define _RTE_VDPA_H_
   7
   8 /**
   9  * @file
  10  *
  11  * Device specific vhost lib
  12  */
  13
  14 #include <stdbool.h>
  15
  16 #include <rte_pci.h>
  17 #include "rte_vhost.h"
  18
  19 #define MAX_VDPA_NAME_LEN 128
  20
  21 /** Maximum name length for statistics counters */
  22 #define RTE_VDPA_STATS_NAME_SIZE 64
  23
  24 struct rte_vdpa_device;
  25
  26 /**
  27  * A vDPA device statistic structure
  28  *
  29  * This structure is used by rte_vdpa_stats_get() to provide
  30  * statistics from the HW vDPA device.
  31  *
  32  * It maps a name id, corresponding to an index in the array returned
  33  * by rte_vdpa_get_stats_names, to a statistic value.
  34  */
  35 struct rte_vdpa_stat {
  36         uint64_t id;        /**< The index in stats name array */
  37         uint64_t value;     /**< The statistic counter value */
  38 };
  39
  40 /**
  41  * A name element for statistics
  42  *
  43  * An array of this structure is returned by rte_vdpa_get_stats_names
  44  * It lists the names of extended statistics for a PMD. The rte_vdpa_stat
  45  * structure references these names by their array index
  46  */
  47 struct rte_vdpa_stat_name {
  48         char name[RTE_VDPA_STATS_NAME_SIZE]; /**< The statistic name */
  49 };
  50
  51 /**
  52  * vdpa device operations
  53  */
  54 struct rte_vdpa_dev_ops {
  55         /** Get capabilities of this device */
  56         int (*get_queue_num)(struct rte_vdpa_device *dev, uint32_t *queue_num);
  57
  58         /** Get supported features of this device */
  59         int (*get_features)(struct rte_vdpa_device *dev, uint64_t *features);
  60
  61         /** Get supported protocol features of this device */
  62         int (*get_protocol_features)(struct rte_vdpa_device *dev,
  63                         uint64_t *protocol_features);
  64
  65         /** Driver configure/close the device */
  66         int (*dev_conf)(int vid);
  67         int (*dev_close)(int vid);
  68
  69         /** Enable/disable this vring */
  70         int (*set_vring_state)(int vid, int vring, int state);
  71
  72         /** Set features when changed */
  73         int (*set_features)(int vid);
  74
  75         /** Destination operations when migration done */
  76         int (*migration_done)(int vid);
  77
  78         /** Get the vfio group fd */
  79         int (*get_vfio_group_fd)(int vid);
  80
  81         /** Get the vfio device fd */
  82         int (*get_vfio_device_fd)(int vid);
  83
  84         /** Get the notify area info of the queue */
  85         int (*get_notify_area)(int vid, int qid,
  86                         uint64_t *offset, uint64_t *size);
  87
  88         /** Get statistics name */
  89         int (*get_stats_names)(struct rte_vdpa_device *dev,
  90                         struct rte_vdpa_stat_name *stats_names,
  91                         unsigned int size);
  92
  93         /** Get statistics of the queue */
  94         int (*get_stats)(struct rte_vdpa_device *dev, int qid,
  95                         struct rte_vdpa_stat *stats, unsigned int n);
  96
  97         /** Reset statistics of the queue */
  98         int (*reset_stats)(struct rte_vdpa_device *dev, int qid);
  99
 100         /** Reserved for future extension */
 101         void *reserved[2];
 102 };
 103
 104 /**
 105  * vdpa device structure includes device address and device operations.
 106  */
 107 struct rte_vdpa_device {
 108         /** Generic device information */
 109         struct rte_device *device;
 110         /** vdpa device operations */
 111         struct rte_vdpa_dev_ops *ops;
 112 } __rte_cache_aligned;
 113
 114 /**
 115  * @warning
 116  * @b EXPERIMENTAL: this API may change without prior notice
 117  *
 118  * Register a vdpa device
 119  *
 120  * @param addr
 121  *  the vdpa device address
 122  * @param ops
 123  *  the vdpa device operations
 124  * @return
 125  *  vDPA device pointer on success, NULL on failure
 126  */
 127 __rte_experimental
 128 struct rte_vdpa_device *
 129 rte_vdpa_register_device(struct rte_device *rte_dev,
 130                 struct rte_vdpa_dev_ops *ops);
 131
 132 /**
 133  * @warning
 134  * @b EXPERIMENTAL: this API may change without prior notice
 135  *
 136  * Unregister a vdpa device
 137  *
 138  * @param did
 139  *  vDPA device pointer
 140  * @return
 141  *  device id on success, -1 on failure
 142  */
 143 __rte_experimental
 144 int
 145 rte_vdpa_unregister_device(struct rte_vdpa_device *);
 146
 147 /**
 148  * @warning
 149  * @b EXPERIMENTAL: this API may change without prior notice
 150  *
 151  * Find the device id of a vdpa device from its name
 152  *
 153  * @param name
 154  *  the vdpa device name
 155  * @return
 156  *  device id on success, -1 on failure
 157  */
 158 __rte_experimental
 159 int
 160 rte_vdpa_find_device_id_by_name(const char *name);
 161
 162 /**
 163  * @warning
 164  * @b EXPERIMENTAL: this API may change without prior notice
 165  *
 166  * Find the device id of a vdpa device
 167  *
 168  * @param addr
 169  *  the vdpa device address
 170  * @return
 171  *  device id on success, -1 on failure
 172  */
 173 __rte_experimental
 174 int
 175 rte_vdpa_find_device_id(struct rte_vdpa_device *dev);
 176
 177 /**
 178  * @warning
 179  * @b EXPERIMENTAL: this API may change without prior notice
 180  *
 181  * Find a vdpa device based on device id
 182  *
 183  * @param did
 184  *  device id
 185  * @return
 186  *  rte_vdpa_device on success, NULL on failure
 187  */
 188 __rte_experimental
 189 struct rte_vdpa_device *
 190 rte_vdpa_get_device(int did);
 191
 192 /**
 193  * @warning
 194  * @b EXPERIMENTAL: this API may change without prior notice
 195  *
 196  * Get current available vdpa device number
 197  *
 198  * @return
 199  *  available vdpa device number
 200  */
 201 __rte_experimental
 202 int
 203 rte_vdpa_get_device_num(void);
 204
 205 /**
 206  * @warning
 207  * @b EXPERIMENTAL: this API may change without prior notice
 208  *
 209  * Enable/Disable host notifier mapping for a vdpa port.
 210  *
 211  * @param vid
 212  *  vhost device id
 213  * @param enable
 214  *  true for host notifier map, false for host notifier unmap
 215  * @return
 216  *  0 on success, -1 on failure
 217  */
 218 __rte_experimental
 219 int
 220 rte_vhost_host_notifier_ctrl(int vid, bool enable);
 221
 222 /**
 223  * @warning
 224  * @b EXPERIMENTAL: this API may change without prior notice
 225  *
 226  * Synchronize the used ring from mediated ring to guest, log dirty
 227  * page for each writeable buffer, caller should handle the used
 228  * ring logging before device stop.
 229  *
 230  * @param vid
 231  *  vhost device id
 232  * @param qid
 233  *  vhost queue id
 234  * @param vring_m
 235  *  mediated virtio ring pointer
 236  * @return
 237  *  number of synced used entries on success, -1 on failure
 238  */
 239 __rte_experimental
 240 int
 241 rte_vdpa_relay_vring_used(int vid, uint16_t qid, void *vring_m);
 242
 243 /**
 244  * @warning
 245  * @b EXPERIMENTAL: this API may change without prior notice
 246  *
 247  * Retrieve names of statistics of a vDPA device.
 248  *
 249  * There is an assumption that 'stat_names' and 'stats' arrays are matched
 250  * by array index: stats_names[i].name => stats[i].value
 251  *
 252  * And the array index is same with id field of 'struct rte_vdpa_stat':
 253  * stats[i].id == i
 254  *
 255  * @param did
 256  *  device id
 257  * @param stats_names
 258  *   array of at least size elements to be filled.
 259  *   If set to NULL, the function returns the required number of elements.
 260  * @param size
 261  *   The number of elements in stats_names array.
 262  * @return
 263  *   A negative value on error, otherwise the number of entries filled in the
 264  *   stats name array.
 265  */
 266 __rte_experimental
 267 int
 268 rte_vdpa_get_stats_names(int did, struct rte_vdpa_stat_name *stats_names,
 269                          unsigned int size);
 270
 271 /**
 272  * @warning
 273  * @b EXPERIMENTAL: this API may change without prior notice
 274  *
 275  * Retrieve statistics of a vDPA device.
 276  *
 277  * There is an assumption that 'stat_names' and 'stats' arrays are matched
 278  * by array index: stats_names[i].name => stats[i].value
 279  *
 280  * And the array index is same with id field of 'struct rte_vdpa_stat':
 281  * stats[i].id == i
 282  *
 283  * @param did
 284  *  device id
 285  * @param qid
 286  *  queue id
 287  * @param stats
 288  *   A pointer to a table of structure of type rte_vdpa_stat to be filled with
 289  *   device statistics ids and values.
 290  * @param n
 291  *   The number of elements in stats array.
 292  * @return
 293  *   A negative value on error, otherwise the number of entries filled in the
 294  *   stats table.
 295  */
 296 __rte_experimental
 297 int
 298 rte_vdpa_get_stats(int did, uint16_t qid, struct rte_vdpa_stat *stats,
 299                    unsigned int n);
 300 /**
 301  * @warning
 302  * @b EXPERIMENTAL: this API may change without prior notice
 303  *
 304  * Reset statistics of a vDPA device.
 305  *
 306  * @param did
 307  *  device id
 308  * @param qid
 309  *  queue id
 310  * @return
 311  *   0 on success, a negative value on error.
 312  */
 313 __rte_experimental
 314 int
 315 rte_vdpa_reset_stats(int did, uint16_t qid);
 316 #endif /* _RTE_VDPA_H_ */