xref: /OK3568_Linux_fs/kernel/include/linux/virtio_vsock.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_VIRTIO_VSOCK_H
3 #define _LINUX_VIRTIO_VSOCK_H
4 
5 #include <uapi/linux/virtio_vsock.h>
6 #include <linux/socket.h>
7 #include <net/sock.h>
8 #include <net/af_vsock.h>
9 
10 #define VIRTIO_VSOCK_DEFAULT_RX_BUF_SIZE	(1024 * 4)
11 #define VIRTIO_VSOCK_MAX_BUF_SIZE		0xFFFFFFFFUL
12 #define VIRTIO_VSOCK_MAX_PKT_BUF_SIZE		virtio_transport_max_vsock_pkt_buf_size
13 extern uint virtio_transport_max_vsock_pkt_buf_size;
14 
15 enum {
16 	VSOCK_VQ_RX     = 0, /* for host to guest data */
17 	VSOCK_VQ_TX     = 1, /* for guest to host data */
18 	VSOCK_VQ_EVENT  = 2,
19 	VSOCK_VQ_MAX    = 3,
20 };
21 
22 /* Per-socket state (accessed via vsk->trans) */
23 struct virtio_vsock_sock {
24 	struct vsock_sock *vsk;
25 
26 	spinlock_t tx_lock;
27 	spinlock_t rx_lock;
28 
29 	/* Protected by tx_lock */
30 	u32 tx_cnt;
31 	u32 peer_fwd_cnt;
32 	u32 peer_buf_alloc;
33 
34 	/* Protected by rx_lock */
35 	u32 fwd_cnt;
36 	u32 last_fwd_cnt;
37 	u32 rx_bytes;
38 	u32 buf_alloc;
39 	struct list_head rx_queue;
40 };
41 
42 struct virtio_vsock_pkt {
43 	struct virtio_vsock_hdr	hdr;
44 	struct list_head list;
45 	/* socket refcnt not held, only use for cancellation */
46 	struct vsock_sock *vsk;
47 	void *buf;
48 	u32 buf_len;
49 	u32 len;
50 	u32 off;
51 	bool reply;
52 	bool tap_delivered;
53 };
54 
55 struct virtio_vsock_pkt_info {
56 	u32 remote_cid, remote_port;
57 	struct vsock_sock *vsk;
58 	struct msghdr *msg;
59 	u32 pkt_len;
60 	u16 type;
61 	u16 op;
62 	u32 flags;
63 	bool reply;
64 };
65 
66 struct virtio_transport {
67 	/* This must be the first field */
68 	struct vsock_transport transport;
69 
70 	/* Takes ownership of the packet */
71 	int (*send_pkt)(struct virtio_vsock_pkt *pkt);
72 };
73 
74 ssize_t
75 virtio_transport_stream_dequeue(struct vsock_sock *vsk,
76 				struct msghdr *msg,
77 				size_t len,
78 				int type);
79 int
80 virtio_transport_dgram_dequeue(struct vsock_sock *vsk,
81 			       struct msghdr *msg,
82 			       size_t len, int flags);
83 
84 s64 virtio_transport_stream_has_data(struct vsock_sock *vsk);
85 s64 virtio_transport_stream_has_space(struct vsock_sock *vsk);
86 
87 int virtio_transport_do_socket_init(struct vsock_sock *vsk,
88 				 struct vsock_sock *psk);
89 int
90 virtio_transport_notify_poll_in(struct vsock_sock *vsk,
91 				size_t target,
92 				bool *data_ready_now);
93 int
94 virtio_transport_notify_poll_out(struct vsock_sock *vsk,
95 				 size_t target,
96 				 bool *space_available_now);
97 
98 int virtio_transport_notify_recv_init(struct vsock_sock *vsk,
99 	size_t target, struct vsock_transport_recv_notify_data *data);
100 int virtio_transport_notify_recv_pre_block(struct vsock_sock *vsk,
101 	size_t target, struct vsock_transport_recv_notify_data *data);
102 int virtio_transport_notify_recv_pre_dequeue(struct vsock_sock *vsk,
103 	size_t target, struct vsock_transport_recv_notify_data *data);
104 int virtio_transport_notify_recv_post_dequeue(struct vsock_sock *vsk,
105 	size_t target, ssize_t copied, bool data_read,
106 	struct vsock_transport_recv_notify_data *data);
107 int virtio_transport_notify_send_init(struct vsock_sock *vsk,
108 	struct vsock_transport_send_notify_data *data);
109 int virtio_transport_notify_send_pre_block(struct vsock_sock *vsk,
110 	struct vsock_transport_send_notify_data *data);
111 int virtio_transport_notify_send_pre_enqueue(struct vsock_sock *vsk,
112 	struct vsock_transport_send_notify_data *data);
113 int virtio_transport_notify_send_post_enqueue(struct vsock_sock *vsk,
114 	ssize_t written, struct vsock_transport_send_notify_data *data);
115 void virtio_transport_notify_buffer_size(struct vsock_sock *vsk, u64 *val);
116 
117 u64 virtio_transport_stream_rcvhiwat(struct vsock_sock *vsk);
118 bool virtio_transport_stream_is_active(struct vsock_sock *vsk);
119 bool virtio_transport_stream_allow(u32 cid, u32 port);
120 int virtio_transport_dgram_bind(struct vsock_sock *vsk,
121 				struct sockaddr_vm *addr);
122 bool virtio_transport_dgram_allow(u32 cid, u32 port);
123 
124 int virtio_transport_connect(struct vsock_sock *vsk);
125 
126 int virtio_transport_shutdown(struct vsock_sock *vsk, int mode);
127 
128 void virtio_transport_release(struct vsock_sock *vsk);
129 
130 ssize_t
131 virtio_transport_stream_enqueue(struct vsock_sock *vsk,
132 				struct msghdr *msg,
133 				size_t len);
134 int
135 virtio_transport_dgram_enqueue(struct vsock_sock *vsk,
136 			       struct sockaddr_vm *remote_addr,
137 			       struct msghdr *msg,
138 			       size_t len);
139 
140 void virtio_transport_destruct(struct vsock_sock *vsk);
141 
142 void virtio_transport_recv_pkt(struct virtio_transport *t,
143 			       struct virtio_vsock_pkt *pkt);
144 void virtio_transport_free_pkt(struct virtio_vsock_pkt *pkt);
145 void virtio_transport_inc_tx_pkt(struct virtio_vsock_sock *vvs, struct virtio_vsock_pkt *pkt);
146 u32 virtio_transport_get_credit(struct virtio_vsock_sock *vvs, u32 wanted);
147 void virtio_transport_put_credit(struct virtio_vsock_sock *vvs, u32 credit);
148 void virtio_transport_deliver_tap_pkt(struct virtio_vsock_pkt *pkt);
149 
150 #endif /* _LINUX_VIRTIO_VSOCK_H */
151