• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 	u32 msg_count;
41 };
42 
43 struct virtio_vsock_pkt {
44 	struct virtio_vsock_hdr	hdr;
45 	struct list_head list;
46 	/* socket refcnt not held, only use for cancellation */
47 	struct vsock_sock *vsk;
48 	void *buf;
49 	u32 buf_len;
50 	u32 len;
51 	u32 off;
52 	bool reply;
53 	bool tap_delivered;
54 };
55 
56 struct virtio_vsock_pkt_info {
57 	u32 remote_cid, remote_port;
58 	struct vsock_sock *vsk;
59 	struct msghdr *msg;
60 	u32 pkt_len;
61 	u16 type;
62 	u16 op;
63 	u32 flags;
64 	bool reply;
65 };
66 
67 struct virtio_transport {
68 	/* This must be the first field */
69 	struct vsock_transport transport;
70 
71 	/* Takes ownership of the packet */
72 	int (*send_pkt)(struct virtio_vsock_pkt *pkt);
73 };
74 
75 ssize_t
76 virtio_transport_stream_dequeue(struct vsock_sock *vsk,
77 				struct msghdr *msg,
78 				size_t len,
79 				int type);
80 int
81 virtio_transport_dgram_dequeue(struct vsock_sock *vsk,
82 			       struct msghdr *msg,
83 			       size_t len, int flags);
84 
85 int
86 virtio_transport_seqpacket_enqueue(struct vsock_sock *vsk,
87 				   struct msghdr *msg,
88 				   size_t len);
89 ssize_t
90 virtio_transport_seqpacket_dequeue(struct vsock_sock *vsk,
91 				   struct msghdr *msg,
92 				   int flags);
93 s64 virtio_transport_stream_has_data(struct vsock_sock *vsk);
94 s64 virtio_transport_stream_has_space(struct vsock_sock *vsk);
95 u32 virtio_transport_seqpacket_has_data(struct vsock_sock *vsk);
96 
97 int virtio_transport_do_socket_init(struct vsock_sock *vsk,
98 				 struct vsock_sock *psk);
99 int
100 virtio_transport_notify_poll_in(struct vsock_sock *vsk,
101 				size_t target,
102 				bool *data_ready_now);
103 int
104 virtio_transport_notify_poll_out(struct vsock_sock *vsk,
105 				 size_t target,
106 				 bool *space_available_now);
107 
108 int virtio_transport_notify_recv_init(struct vsock_sock *vsk,
109 	size_t target, struct vsock_transport_recv_notify_data *data);
110 int virtio_transport_notify_recv_pre_block(struct vsock_sock *vsk,
111 	size_t target, struct vsock_transport_recv_notify_data *data);
112 int virtio_transport_notify_recv_pre_dequeue(struct vsock_sock *vsk,
113 	size_t target, struct vsock_transport_recv_notify_data *data);
114 int virtio_transport_notify_recv_post_dequeue(struct vsock_sock *vsk,
115 	size_t target, ssize_t copied, bool data_read,
116 	struct vsock_transport_recv_notify_data *data);
117 int virtio_transport_notify_send_init(struct vsock_sock *vsk,
118 	struct vsock_transport_send_notify_data *data);
119 int virtio_transport_notify_send_pre_block(struct vsock_sock *vsk,
120 	struct vsock_transport_send_notify_data *data);
121 int virtio_transport_notify_send_pre_enqueue(struct vsock_sock *vsk,
122 	struct vsock_transport_send_notify_data *data);
123 int virtio_transport_notify_send_post_enqueue(struct vsock_sock *vsk,
124 	ssize_t written, struct vsock_transport_send_notify_data *data);
125 void virtio_transport_notify_buffer_size(struct vsock_sock *vsk, u64 *val);
126 
127 u64 virtio_transport_stream_rcvhiwat(struct vsock_sock *vsk);
128 bool virtio_transport_stream_is_active(struct vsock_sock *vsk);
129 bool virtio_transport_stream_allow(u32 cid, u32 port);
130 int virtio_transport_dgram_bind(struct vsock_sock *vsk,
131 				struct sockaddr_vm *addr);
132 bool virtio_transport_dgram_allow(u32 cid, u32 port);
133 
134 int virtio_transport_connect(struct vsock_sock *vsk);
135 
136 int virtio_transport_shutdown(struct vsock_sock *vsk, int mode);
137 
138 void virtio_transport_release(struct vsock_sock *vsk);
139 
140 ssize_t
141 virtio_transport_stream_enqueue(struct vsock_sock *vsk,
142 				struct msghdr *msg,
143 				size_t len);
144 int
145 virtio_transport_dgram_enqueue(struct vsock_sock *vsk,
146 			       struct sockaddr_vm *remote_addr,
147 			       struct msghdr *msg,
148 			       size_t len);
149 
150 void virtio_transport_destruct(struct vsock_sock *vsk);
151 
152 void virtio_transport_recv_pkt(struct virtio_transport *t,
153 			       struct virtio_vsock_pkt *pkt);
154 void virtio_transport_free_pkt(struct virtio_vsock_pkt *pkt);
155 void virtio_transport_inc_tx_pkt(struct virtio_vsock_sock *vvs, struct virtio_vsock_pkt *pkt);
156 u32 virtio_transport_get_credit(struct virtio_vsock_sock *vvs, u32 wanted);
157 void virtio_transport_put_credit(struct virtio_vsock_sock *vvs, u32 credit);
158 void virtio_transport_deliver_tap_pkt(struct virtio_vsock_pkt *pkt);
159 
160 #endif /* _LINUX_VIRTIO_VSOCK_H */
161