1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2016 Intel Corporation
5 #ifndef _VIRTIO_USER_DEV_H
6 #define _VIRTIO_USER_DEV_H
10 #include "../virtio_pci.h"
11 #include "../virtio_ring.h"
13 enum virtio_user_backend_type {
14 VIRTIO_USER_BACKEND_UNKNOWN,
15 VIRTIO_USER_BACKEND_VHOST_USER,
16 VIRTIO_USER_BACKEND_VHOST_KERNEL,
17 VIRTIO_USER_BACKEND_VHOST_VDPA,
20 struct virtio_user_queue {
22 bool avail_wrap_counter;
23 bool used_wrap_counter;
26 struct virtio_user_dev {
27 enum virtio_user_backend_type backend_type;
28 /* for vhost_user backend */
30 int listenfd; /* listening fd */
31 bool is_server; /* server or client mode */
33 /* for vhost_kernel backend */
38 /* for both vhost_user and vhost_kernel */
39 int callfds[VIRTIO_MAX_VIRTQUEUES];
40 int kickfds[VIRTIO_MAX_VIRTQUEUES];
42 uint32_t max_queue_pairs;
45 uint64_t features; /* the negotiated features with driver,
46 * and will be sync with device
48 uint64_t device_features; /* supported features by device */
49 uint64_t frontend_features; /* enabled frontend features */
50 uint64_t unsupported_features; /* unsupported features mask */
51 uint64_t protocol_features; /* negotiated protocol features */
55 uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
58 struct vring vrings[VIRTIO_MAX_VIRTQUEUES];
59 struct vring_packed packed_vrings[VIRTIO_MAX_VIRTQUEUES];
61 struct virtio_user_queue packed_queues[VIRTIO_MAX_VIRTQUEUES];
62 bool qp_enabled[VIRTIO_MAX_VIRTQUEUE_PAIRS];
64 struct virtio_user_backend_ops *ops;
65 pthread_mutex_t mutex;
69 int virtio_user_dev_set_features(struct virtio_user_dev *dev);
70 int virtio_user_start_device(struct virtio_user_dev *dev);
71 int virtio_user_stop_device(struct virtio_user_dev *dev);
72 int virtio_user_dev_init(struct virtio_user_dev *dev, char *path, int queues,
73 int cq, int queue_size, const char *mac, char **ifname,
74 int server, int mrg_rxbuf, int in_order,
76 enum virtio_user_backend_type backend_type);
77 void virtio_user_dev_uninit(struct virtio_user_dev *dev);
78 void virtio_user_handle_cq(struct virtio_user_dev *dev, uint16_t queue_idx);
79 void virtio_user_handle_cq_packed(struct virtio_user_dev *dev,
81 uint8_t virtio_user_handle_mq(struct virtio_user_dev *dev, uint16_t q_pairs);
82 int virtio_user_dev_set_status(struct virtio_user_dev *dev, uint8_t status);
83 int virtio_user_dev_update_status(struct virtio_user_dev *dev);
84 extern const char * const virtio_user_backend_strings[];