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,
19 struct virtio_user_queue {
21 bool avail_wrap_counter;
22 bool used_wrap_counter;
25 struct virtio_user_dev {
26 enum virtio_user_backend_type backend_type;
27 /* for vhost_user backend */
29 int listenfd; /* listening fd */
30 bool is_server; /* server or client mode */
32 /* for vhost_kernel backend */
37 /* for both vhost_user and vhost_kernel */
38 int callfds[VIRTIO_MAX_VIRTQUEUES];
39 int kickfds[VIRTIO_MAX_VIRTQUEUES];
41 uint32_t max_queue_pairs;
44 uint64_t features; /* the negotiated features with driver,
45 * and will be sync with device
47 uint64_t device_features; /* supported features by device */
48 uint64_t frontend_features; /* enabled frontend features */
49 uint64_t unsupported_features; /* unsupported features mask */
50 uint64_t protocol_features; /* negotiated protocol features
56 uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
59 struct vring vrings[VIRTIO_MAX_VIRTQUEUES];
60 struct vring_packed packed_vrings[VIRTIO_MAX_VIRTQUEUES];
62 struct virtio_user_queue packed_queues[VIRTIO_MAX_VIRTQUEUES];
63 bool qp_enabled[VIRTIO_MAX_VIRTQUEUE_PAIRS];
65 struct virtio_user_backend_ops *ops;
66 pthread_mutex_t mutex;
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_send_status_update(struct virtio_user_dev *dev, uint8_t status);
83 int virtio_user_update_status(struct virtio_user_dev *dev);