NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_devemu_virtio.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
3  *
4  * This software product is a proprietary product of NVIDIA CORPORATION &
5  * AFFILIATES (the "Company") and all right, title, and interest in and to the
6  * software product, including all associated intellectual property rights, are
7  * and shall remain exclusively with the Company.
8  *
9  * This software product is governed by the End User License Agreement
10  * provided with the software product.
11  *
12  */
13 
25 #ifndef DOCA_DEVEMU_VIRTIO_H_
26 #define DOCA_DEVEMU_VIRTIO_H_
27 
28 #include <stdint.h>
29 
30 #include <doca_error.h>
31 #include <doca_dev.h>
32 #include <doca_devemu_pci.h>
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
43 struct doca_devemu_virtio_dev;
44 
50 struct doca_devemu_virtio_type;
51 
56 struct doca_devemu_virtio_io;
57 
62 struct doca_devemu_virtio_queue_stats;
63 
64 /*********************************************************************************************************************
65  * DOCA devemu Virtio device Properties
66  *********************************************************************************************************************/
67 
80 DOCA_EXPERIMENTAL
81 doca_error_t doca_devemu_virtio_dev_get_device_features_63_0(const struct doca_devemu_virtio_dev *virtio_dev,
82  uint64_t *features);
83 
96 DOCA_EXPERIMENTAL
97 doca_error_t doca_devemu_virtio_dev_set_device_features_63_0(struct doca_devemu_virtio_dev *virtio_dev,
98  uint64_t features);
99 
112 DOCA_EXPERIMENTAL
113 doca_error_t doca_devemu_virtio_dev_get_driver_features_63_0(const struct doca_devemu_virtio_dev *virtio_dev,
114  uint64_t *features);
115 
128 DOCA_EXPERIMENTAL
129 doca_error_t doca_devemu_virtio_dev_get_config_msix_vector(const struct doca_devemu_virtio_dev *virtio_dev,
130  uint16_t *config_msix_vector);
131 
144 DOCA_EXPERIMENTAL
145 doca_error_t doca_devemu_virtio_dev_get_num_queues(const struct doca_devemu_virtio_dev *virtio_dev,
146  uint16_t *num_queues);
147 
160 DOCA_EXPERIMENTAL
161 doca_error_t doca_devemu_virtio_dev_set_num_queues(struct doca_devemu_virtio_dev *virtio_dev, uint16_t num_queues);
162 
177 DOCA_EXPERIMENTAL
178 doca_error_t doca_devemu_virtio_dev_get_num_enabled_queues(const struct doca_devemu_virtio_dev *virtio_dev,
179  uint16_t *num_queues);
180 
193 DOCA_EXPERIMENTAL
194 doca_error_t doca_devemu_virtio_dev_get_device_status(const struct doca_devemu_virtio_dev *virtio_dev,
195  uint8_t *device_status);
196 
209 DOCA_EXPERIMENTAL
210 doca_error_t doca_devemu_virtio_dev_get_config_generation(const struct doca_devemu_virtio_dev *virtio_dev,
211  uint8_t *config_generation);
212 
225 DOCA_EXPERIMENTAL
226 doca_error_t doca_devemu_virtio_dev_get_queue_size(const struct doca_devemu_virtio_dev *virtio_dev,
227  uint16_t *queue_size);
228 
241 DOCA_EXPERIMENTAL
242 doca_error_t doca_devemu_virtio_dev_set_queue_size(struct doca_devemu_virtio_dev *virtio_dev, uint16_t queue_size);
243 
258 DOCA_EXPERIMENTAL
259 doca_error_t doca_devemu_virtio_dev_get_num_required_running_virtio_io_ctxs(const struct doca_devemu_virtio_dev *virtio_dev,
260  uint32_t *num_virtio_io);
261 
276 DOCA_EXPERIMENTAL
277 doca_error_t doca_devemu_virtio_dev_set_num_required_running_virtio_io_ctxs(struct doca_devemu_virtio_dev *virtio_dev,
278  uint32_t num_virtio_io);
279 
291 DOCA_EXPERIMENTAL
292 doca_error_t doca_devemu_virtio_dev_reset_complete(struct doca_devemu_virtio_dev *virtio_dev);
293 
303 DOCA_EXPERIMENTAL
304 struct doca_ctx *doca_devemu_virtio_dev_as_ctx(struct doca_devemu_virtio_dev *virtio_dev);
305 
315 DOCA_EXPERIMENTAL
316 struct doca_devemu_pci_dev *doca_devemu_virtio_dev_as_pci_dev(struct doca_devemu_virtio_dev *virtio_dev);
317 
318 /*********************************************************************************************************************
319  * DOCA devemu Virtio device context events API
320  *********************************************************************************************************************/
321 
336 typedef void (*doca_devemu_virtio_dev_event_reset_handler_cb_t)(struct doca_devemu_virtio_dev *virtio_dev,
337  union doca_data event_user_data);
338 
358 DOCA_EXPERIMENTAL
359 doca_error_t doca_devemu_virtio_dev_event_reset_register(struct doca_devemu_virtio_dev *virtio_dev,
360  doca_devemu_virtio_dev_event_reset_handler_cb_t handler,
361  union doca_data user_data);
362 
363 /*********************************************************************************************************************
364  * DOCA devemu Virtio device statistics
365  *********************************************************************************************************************/
366 
386 DOCA_EXPERIMENTAL
387 doca_error_t doca_devemu_virtio_queue_stats_create_list(struct doca_devemu_virtio_dev *virtio_dev,
388  struct doca_devemu_virtio_queue_stats ***stats_list, uint32_t *num_stats);
389 
402 DOCA_EXPERIMENTAL
403 doca_error_t doca_devemu_virtio_queue_stats_destroy_list(struct doca_devemu_virtio_queue_stats **stats_list);
404 
415 typedef void (*doca_devemu_virtio_queue_stats_list_populate_done_cb_t)(struct doca_devemu_virtio_queue_stats **stats_list,
416  union doca_data user_data, doca_error_t err);
417 
436 DOCA_EXPERIMENTAL
437 doca_error_t doca_devemu_virtio_queue_stats_populate_list(struct doca_devemu_virtio_queue_stats **stats_list,
438  doca_devemu_virtio_queue_stats_list_populate_done_cb_t done, union doca_data user_data);
439 
454 DOCA_EXPERIMENTAL
455 doca_error_t doca_devemu_virtio_queue_stats_get_id(struct doca_devemu_virtio_queue_stats *stats, uint16_t *id);
456 
471 DOCA_EXPERIMENTAL
472 doca_error_t doca_devemu_virtio_queue_stats_get_size(struct doca_devemu_virtio_queue_stats *stats, uint16_t *size);
473 
488 DOCA_EXPERIMENTAL
489 doca_error_t doca_devemu_virtio_queue_stats_get_inflights(struct doca_devemu_virtio_queue_stats *stats,
490  uint16_t *inflights);
491 
506 DOCA_EXPERIMENTAL
507 doca_error_t doca_devemu_virtio_queue_stats_get_hw_avail_idx(struct doca_devemu_virtio_queue_stats *stats,
508  uint16_t *idx);
509 
524 DOCA_EXPERIMENTAL
525 doca_error_t doca_devemu_virtio_queue_stats_get_driver_avail_idx(struct doca_devemu_virtio_queue_stats *stats, uint16_t *idx);
526 
541 DOCA_EXPERIMENTAL
542 doca_error_t doca_devemu_virtio_queue_stats_get_hw_used_idx(struct doca_devemu_virtio_queue_stats *stats, uint16_t *idx);
543 
558 DOCA_EXPERIMENTAL
559 doca_error_t doca_devemu_virtio_queue_stats_get_driver_used_idx(struct doca_devemu_virtio_queue_stats *stats, uint16_t *idx);
560 
575 DOCA_EXPERIMENTAL
576 doca_error_t doca_devemu_virtio_queue_stats_get_enabled(struct doca_devemu_virtio_queue_stats *stats, uint8_t *enabled);
577 
578 #ifdef __cplusplus
579 }
580 #endif
581 
584 #endif /* DOCA_DEVEMU_VIRTIO_H_ */
doca_dev.h
doca_devemu_pci.h
doca_error.h
stats
static struct eth_l2_fwd_stats stats
Definition: eth_l2_fwd_core.c:71
DOCA_EXPERIMENTAL
#define DOCA_EXPERIMENTAL
To set a Symbol (or specifically a function) as experimental.
Definition: doca_compat.h:103
doca_devemu_virtio_queue_stats_get_size
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_queue_stats_get_size(struct doca_devemu_virtio_queue_stats *stats, uint16_t *size)
Retrieve the Virtio queue size (depth) from its statistics structure.
doca_devemu_virtio_queue_stats_create_list
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_queue_stats_create_list(struct doca_devemu_virtio_dev *virtio_dev, struct doca_devemu_virtio_queue_stats ***stats_list, uint32_t *num_stats)
Create an empty list of statistics for Virtio device queues.
doca_devemu_virtio_dev_get_num_queues
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_get_num_queues(const struct doca_devemu_virtio_dev *virtio_dev, uint16_t *num_queues)
Get the Virtio device num_queues register from common configuration structure according to Virtio spe...
doca_devemu_virtio_queue_stats_get_inflights
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_queue_stats_get_inflights(struct doca_devemu_virtio_queue_stats *stats, uint16_t *inflights)
Retrieve the number of in-flight requests for a Virtio queue from its statistics structure.
doca_devemu_virtio_dev_get_device_status
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_get_device_status(const struct doca_devemu_virtio_dev *virtio_dev, uint8_t *device_status)
Get the Virtio device_status register from common configuration structure according to Virtio specifi...
doca_devemu_virtio_queue_stats_get_driver_avail_idx
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_queue_stats_get_driver_avail_idx(struct doca_devemu_virtio_queue_stats *stats, uint16_t *idx)
Retrieve the available index of a Virtio queue as seen by the driver from its statistics structure.
doca_devemu_virtio_queue_stats_get_hw_avail_idx
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_queue_stats_get_hw_avail_idx(struct doca_devemu_virtio_queue_stats *stats, uint16_t *idx)
Retrieve the available index of a Virtio queue as seen by the device from its statistics structure.
doca_devemu_virtio_dev_get_device_features_63_0
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_get_device_features_63_0(const struct doca_devemu_virtio_dev *virtio_dev, uint64_t *features)
Get the Virtio device_feature bits (0-63) according to Virtio specification.
doca_devemu_virtio_dev_get_queue_size
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_get_queue_size(const struct doca_devemu_virtio_dev *virtio_dev, uint16_t *queue_size)
Get the Virtio max queue size for all Virtio queues.
doca_devemu_virtio_dev_event_reset_handler_cb_t
void(* doca_devemu_virtio_dev_event_reset_handler_cb_t)(struct doca_devemu_virtio_dev *virtio_dev, union doca_data event_user_data)
Function to be executed on Virtio device reset. The event handler will enable users to quiesce,...
Definition: doca_devemu_virtio.h:336
doca_devemu_virtio_dev_as_pci_dev
DOCA_EXPERIMENTAL struct doca_devemu_pci_dev * doca_devemu_virtio_dev_as_pci_dev(struct doca_devemu_virtio_dev *virtio_dev)
Convert DOCA Virtio device instance into DOCA devemu PCI device.
doca_devemu_virtio_queue_stats_get_hw_used_idx
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_queue_stats_get_hw_used_idx(struct doca_devemu_virtio_queue_stats *stats, uint16_t *idx)
Retrieve the used index of a Virtio queue as seen by the device from its statistics structure.
doca_devemu_virtio_dev_get_num_required_running_virtio_io_ctxs
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_get_num_required_running_virtio_io_ctxs(const struct doca_devemu_virtio_dev *virtio_dev, uint32_t *num_virtio_io)
Get the number of required running Virtio io context's to be bounded to the Virtio device context....
doca_devemu_virtio_queue_stats_list_populate_done_cb_t
void(* doca_devemu_virtio_queue_stats_list_populate_done_cb_t)(struct doca_devemu_virtio_queue_stats **stats_list, union doca_data user_data, doca_error_t err)
Function to be executed upon finishing asynchronous population of Virtio queue statistics list.
Definition: doca_devemu_virtio.h:415
doca_devemu_virtio_dev_set_num_required_running_virtio_io_ctxs
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_set_num_required_running_virtio_io_ctxs(struct doca_devemu_virtio_dev *virtio_dev, uint32_t num_virtio_io)
Set the number of required running Virtio IO context's to be bounded to the Virtio device context....
doca_devemu_virtio_dev_get_config_generation
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_get_config_generation(const struct doca_devemu_virtio_dev *virtio_dev, uint8_t *config_generation)
Get the Virtio config_generation register from common configuration structure according to Virtio spe...
doca_devemu_virtio_dev_set_queue_size
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_set_queue_size(struct doca_devemu_virtio_dev *virtio_dev, uint16_t queue_size)
Set the Virtio max queue size for all Virtio queues.
doca_devemu_virtio_queue_stats_destroy_list
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_queue_stats_destroy_list(struct doca_devemu_virtio_queue_stats **stats_list)
Destroy a list of Virtio queue statistics structures.
doca_devemu_virtio_dev_get_num_enabled_queues
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_get_num_enabled_queues(const struct doca_devemu_virtio_dev *virtio_dev, uint16_t *num_queues)
Get the number of enabled Virtio device queues by the driver. The driver enables a queue by setting t...
doca_devemu_virtio_dev_reset_complete
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_reset_complete(struct doca_devemu_virtio_dev *virtio_dev)
Complete the Virtio device reset handling. Prior to calling this function, the user must ensure that ...
doca_devemu_virtio_queue_stats_get_id
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_queue_stats_get_id(struct doca_devemu_virtio_queue_stats *stats, uint16_t *id)
Retrieve the Virtio queue index from its statistics structure.
doca_devemu_virtio_dev_as_ctx
DOCA_EXPERIMENTAL struct doca_ctx * doca_devemu_virtio_dev_as_ctx(struct doca_devemu_virtio_dev *virtio_dev)
Convert DOCA Virtio device instance into DOCA context.
doca_devemu_virtio_dev_get_driver_features_63_0
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_get_driver_features_63_0(const struct doca_devemu_virtio_dev *virtio_dev, uint64_t *features)
Get the Virtio driver_feature bits (0-63) according to Virtio specification.
doca_devemu_virtio_dev_set_device_features_63_0
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_set_device_features_63_0(struct doca_devemu_virtio_dev *virtio_dev, uint64_t features)
Set the Virtio device_feature bits (0-63) according to Virtio specification.
doca_devemu_virtio_queue_stats_populate_list
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_queue_stats_populate_list(struct doca_devemu_virtio_queue_stats **stats_list, doca_devemu_virtio_queue_stats_list_populate_done_cb_t done, union doca_data user_data)
Issue an asynchronous population of a list of Virtio queue statistics structures.
doca_devemu_virtio_dev_set_num_queues
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_set_num_queues(struct doca_devemu_virtio_dev *virtio_dev, uint16_t num_queues)
Set the Virtio device num_queues register in common configuration structure according to Virtio speci...
doca_devemu_virtio_queue_stats_get_enabled
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_queue_stats_get_enabled(struct doca_devemu_virtio_queue_stats *stats, uint8_t *enabled)
Retrieve the enabled status of a Virtio queue from its statistics structure.
doca_devemu_virtio_dev_get_config_msix_vector
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_get_config_msix_vector(const struct doca_devemu_virtio_dev *virtio_dev, uint16_t *config_msix_vector)
Get the Virtio config_msix_vector register according to Virtio specification.
doca_devemu_virtio_dev_event_reset_register
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_dev_event_reset_register(struct doca_devemu_virtio_dev *virtio_dev, doca_devemu_virtio_dev_event_reset_handler_cb_t handler, union doca_data user_data)
Register to Virtio device reset event.
doca_devemu_virtio_queue_stats_get_driver_used_idx
DOCA_EXPERIMENTAL doca_error_t doca_devemu_virtio_queue_stats_get_driver_used_idx(struct doca_devemu_virtio_queue_stats *stats, uint16_t *idx)
Retrieve the used index of a Virtio queue as seen by the driver from its statistics structure.
doca_error_t
enum doca_error doca_error_t
DOCA API return codes.
doca_data
Convenience type for representing opaque data.
Definition: doca_types.h:56