1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 #ifndef _LINUX_VHOST_TYPES_H
3 #define _LINUX_VHOST_TYPES_H
4 /* Userspace interface for in-kernel virtio accelerators. */
5
6 /* vhost is used to reduce the number of system calls involved in virtio.
7 *
8 * Existing virtio net code is used in the guest without modification.
9 *
10 * This header includes interface used by userspace hypervisor for
11 * device configuration.
12 */
13
14 #include <linux/types.h>
15 #include <linux/compiler.h>
16 #include <linux/virtio_config.h>
17 #include <linux/virtio_ring.h>
18
19 struct vhost_vring_state {
20 unsigned int index;
21 unsigned int num;
22 };
23
24 struct vhost_vring_file {
25 unsigned int index;
26 int fd; /* Pass -1 to unbind from file. */
27
28 };
29
30 struct vhost_vring_addr {
31 unsigned int index;
32 /* Option flags. */
33 unsigned int flags;
34 /* Flag values: */
35 /* Whether log address is valid. If set enables logging. */
36 #define VHOST_VRING_F_LOG 0
37
38 /* Start of array of descriptors (virtually contiguous) */
39 __u64 desc_user_addr;
40 /* Used structure address. Must be 32 bit aligned */
41 __u64 used_user_addr;
42 /* Available structure address. Must be 16 bit aligned */
43 __u64 avail_user_addr;
44 /* Logging support. */
45 /* Log writes to used structure, at offset calculated from specified
46 * address. Address must be 32 bit aligned. */
47 __u64 log_guest_addr;
48 };
49
50 /* no alignment requirement */
51 struct vhost_iotlb_msg {
52 __u64 iova;
53 __u64 size;
54 __u64 uaddr;
55 #define VHOST_ACCESS_RO 0x1
56 #define VHOST_ACCESS_WO 0x2
57 #define VHOST_ACCESS_RW 0x3
58 __u8 perm;
59 #define VHOST_IOTLB_MISS 1
60 #define VHOST_IOTLB_UPDATE 2
61 #define VHOST_IOTLB_INVALIDATE 3
62 #define VHOST_IOTLB_ACCESS_FAIL 4
63 __u8 type;
64 };
65
66 #define VHOST_IOTLB_MSG 0x1
67 #define VHOST_IOTLB_MSG_V2 0x2
68
69 struct vhost_msg {
70 int type;
71 union {
72 struct vhost_iotlb_msg iotlb;
73 __u8 padding[64];
74 };
75 };
76
77 struct vhost_msg_v2 {
78 __u32 type;
79 __u32 reserved;
80 union {
81 struct vhost_iotlb_msg iotlb;
82 __u8 padding[64];
83 };
84 };
85
86 struct vhost_memory_region {
87 __u64 guest_phys_addr;
88 __u64 memory_size; /* bytes */
89 __u64 userspace_addr;
90 __u64 flags_padding; /* No flags are currently specified. */
91 };
92
93 /* All region addresses and sizes must be 4K aligned. */
94 #define VHOST_PAGE_SIZE 0x1000
95
96 struct vhost_memory {
97 __u32 nregions;
98 __u32 padding;
99 struct vhost_memory_region regions[0];
100 };
101
102 /* VHOST_SCSI specific definitions */
103
104 /*
105 * Used by QEMU userspace to ensure a consistent vhost-scsi ABI.
106 *
107 * ABI Rev 0: July 2012 version starting point for v3.6-rc merge candidate +
108 * RFC-v2 vhost-scsi userspace. Add GET_ABI_VERSION ioctl usage
109 * ABI Rev 1: January 2013. Ignore vhost_tpgt field in struct vhost_scsi_target.
110 * All the targets under vhost_wwpn can be seen and used by guset.
111 */
112
113 #define VHOST_SCSI_ABI_VERSION 1
114
115 struct vhost_scsi_target {
116 int abi_version;
117 char vhost_wwpn[224]; /* TRANSPORT_IQN_LEN */
118 unsigned short vhost_tpgt;
119 unsigned short reserved;
120 };
121
122 /* Feature bits */
123 /* Log all write descriptors. Can be changed while device is active. */
124 #define VHOST_F_LOG_ALL 26
125 /* vhost-net should add virtio_net_hdr for RX, and strip for TX packets. */
126 #define VHOST_NET_F_VIRTIO_NET_HDR 27
127
128 #endif