xref: /dpdk/drivers/net/virtio/virtio_user/vhost.h (revision 0fd2782660c88075ed05ce5297c7c25af6d4b432)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2016 Intel Corporation
3  */
4 
5 #ifndef _VIRTIO_USER_VHOST_H
6 #define _VIRTIO_USER_VHOST_H
7 
8 #include <stdint.h>
9 #include <linux/types.h>
10 #include <linux/ioctl.h>
11 
12 #include <rte_errno.h>
13 
14 #include "../virtio.h"
15 #include "../virtio_logs.h"
16 #include "../virtqueue.h"
17 
18 struct vhost_vring_state {
19 	unsigned int index;
20 	unsigned int num;
21 };
22 
23 struct vhost_vring_file {
24 	unsigned int index;
25 	int fd;
26 };
27 
28 struct vhost_vring_addr {
29 	unsigned int index;
30 	/* Option flags. */
31 	unsigned int flags;
32 	/* Flag values: */
33 	/* Whether log address is valid. If set enables logging. */
34 #define VHOST_VRING_F_LOG 0
35 
36 	/* Start of array of descriptors (virtually contiguous) */
37 	uint64_t desc_user_addr;
38 	/* Used structure address. Must be 32 bit aligned */
39 	uint64_t used_user_addr;
40 	/* Available structure address. Must be 16 bit aligned */
41 	uint64_t avail_user_addr;
42 	/* Logging support. */
43 	/* Log writes to used structure, at offset calculated from specified
44 	 * address. Address must be 32 bit aligned.
45 	 */
46 	uint64_t log_guest_addr;
47 };
48 
49 #ifndef VHOST_BACKEND_F_IOTLB_MSG_V2
50 #define VHOST_BACKEND_F_IOTLB_MSG_V2 1
51 #endif
52 
53 #ifndef VHOST_BACKEND_F_IOTLB_BATCH
54 #define VHOST_BACKEND_F_IOTLB_BATCH 2
55 #endif
56 
57 struct vhost_memory_region {
58 	uint64_t guest_phys_addr;
59 	uint64_t memory_size; /* bytes */
60 	uint64_t userspace_addr;
61 	uint64_t mmap_offset;
62 };
63 
64 struct virtio_user_dev;
65 
66 struct virtio_user_backend_ops {
67 	int (*setup)(struct virtio_user_dev *dev);
68 	int (*destroy)(struct virtio_user_dev *dev);
69 	int (*get_backend_features)(uint64_t *features);
70 	int (*set_owner)(struct virtio_user_dev *dev);
71 	int (*get_features)(struct virtio_user_dev *dev, uint64_t *features);
72 	int (*set_features)(struct virtio_user_dev *dev, uint64_t features);
73 	int (*set_memory_table)(struct virtio_user_dev *dev);
74 	int (*set_vring_num)(struct virtio_user_dev *dev, struct vhost_vring_state *state);
75 	int (*set_vring_base)(struct virtio_user_dev *dev, struct vhost_vring_state *state);
76 	int (*get_vring_base)(struct virtio_user_dev *dev, struct vhost_vring_state *state);
77 	int (*set_vring_call)(struct virtio_user_dev *dev, struct vhost_vring_file *file);
78 	int (*set_vring_kick)(struct virtio_user_dev *dev, struct vhost_vring_file *file);
79 	int (*set_vring_addr)(struct virtio_user_dev *dev, struct vhost_vring_addr *addr);
80 	int (*get_status)(struct virtio_user_dev *dev, uint8_t *status);
81 	int (*set_status)(struct virtio_user_dev *dev, uint8_t status);
82 	int (*get_config)(struct virtio_user_dev *dev, uint8_t *data, uint32_t off, uint32_t len);
83 	int (*set_config)(struct virtio_user_dev *dev, const uint8_t *data, uint32_t off,
84 			uint32_t len);
85 	int (*cvq_enable)(struct virtio_user_dev *dev, int enable);
86 	int (*enable_qp)(struct virtio_user_dev *dev, uint16_t pair_idx, int enable);
87 	int (*dma_map)(struct virtio_user_dev *dev, void *addr, uint64_t iova, size_t len);
88 	int (*dma_unmap)(struct virtio_user_dev *dev, void *addr, uint64_t iova, size_t len);
89 	int (*update_link_state)(struct virtio_user_dev *dev);
90 	int (*server_disconnect)(struct virtio_user_dev *dev);
91 	int (*server_reconnect)(struct virtio_user_dev *dev);
92 	int (*get_intr_fd)(struct virtio_user_dev *dev);
93 	int (*map_notification_area)(struct virtio_user_dev *dev);
94 	int (*unmap_notification_area)(struct virtio_user_dev *dev);
95 };
96 
97 extern struct virtio_user_backend_ops virtio_ops_user;
98 extern struct virtio_user_backend_ops virtio_ops_kernel;
99 extern struct virtio_user_backend_ops virtio_ops_vdpa;
100 
101 #endif
102