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
11 #include "../virtio.h"
12 #include "../virtio_ring.h"
14 enum virtio_user_backend_type {
15 VIRTIO_USER_BACKEND_UNKNOWN,
16 VIRTIO_USER_BACKEND_VHOST_USER,
17 VIRTIO_USER_BACKEND_VHOST_KERNEL,
18 VIRTIO_USER_BACKEND_VHOST_VDPA,
21 struct virtio_user_queue {
23 bool avail_wrap_counter;
24 bool used_wrap_counter;
27 struct virtio_user_dev {
29 enum virtio_user_backend_type backend_type;
30 /* for vhost_user backend */
32 int listenfd; /* listening fd */
33 bool is_server; /* server or client mode */
35 /* for vhost_kernel backend */
40 /* for both vhost_user and vhost_kernel */
41 int callfds[VIRTIO_MAX_VIRTQUEUES];
42 int kickfds[VIRTIO_MAX_VIRTQUEUES];
44 uint32_t max_queue_pairs;
47 uint64_t features; /* the negotiated features with driver,
48 * and will be sync with device
50 uint64_t device_features; /* supported features by device */
51 uint64_t frontend_features; /* enabled frontend features */
52 uint64_t unsupported_features; /* unsupported features mask */
53 uint64_t protocol_features; /* negotiated protocol features */
57 uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
60 struct vring vrings[VIRTIO_MAX_VIRTQUEUES];
61 struct vring_packed packed_vrings[VIRTIO_MAX_VIRTQUEUES];
63 struct virtio_user_queue packed_queues[VIRTIO_MAX_VIRTQUEUES];
64 bool qp_enabled[VIRTIO_MAX_VIRTQUEUE_PAIRS];
66 struct virtio_user_backend_ops *ops;
67 pthread_mutex_t mutex;
73 int virtio_user_dev_set_features(struct virtio_user_dev *dev);
74 int virtio_user_start_device(struct virtio_user_dev *dev);
75 int virtio_user_stop_device(struct virtio_user_dev *dev);
76 int virtio_user_dev_init(struct virtio_user_dev *dev, char *path, int queues,
77 int cq, int queue_size, const char *mac, char **ifname,
78 int server, int mrg_rxbuf, int in_order,
80 enum virtio_user_backend_type backend_type);
81 void virtio_user_dev_uninit(struct virtio_user_dev *dev);
82 void virtio_user_handle_cq(struct virtio_user_dev *dev, uint16_t queue_idx);
83 void virtio_user_handle_cq_packed(struct virtio_user_dev *dev,
85 uint8_t virtio_user_handle_mq(struct virtio_user_dev *dev, uint16_t q_pairs);
86 int virtio_user_dev_set_status(struct virtio_user_dev *dev, uint8_t status);
87 int virtio_user_dev_update_status(struct virtio_user_dev *dev);
88 extern const char * const virtio_user_backend_strings[];