[thirdparty/linux.git] / include / linux / virtio_vsock.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_VIRTIO_VSOCK_H
#define _LINUX_VIRTIO_VSOCK_H

#include <uapi/linux/virtio_vsock.h>
#include <linux/socket.h>
#include <net/sock.h>
#include <net/af_vsock.h>

#define VIRTIO_VSOCK_SKB_HEADROOM (sizeof(struct virtio_vsock_hdr))

struct virtio_vsock_skb_cb {
	bool reply;
	bool tap_delivered;
	u32 offset;
};

#define VIRTIO_VSOCK_SKB_CB(skb) ((struct virtio_vsock_skb_cb *)((skb)->cb))

static inline struct virtio_vsock_hdr *virtio_vsock_hdr(struct sk_buff *skb)
{
	return (struct virtio_vsock_hdr *)skb->head;
}

static inline bool virtio_vsock_skb_reply(struct sk_buff *skb)
{
	return VIRTIO_VSOCK_SKB_CB(skb)->reply;
}

static inline void virtio_vsock_skb_set_reply(struct sk_buff *skb)
{
	VIRTIO_VSOCK_SKB_CB(skb)->reply = true;
}

static inline bool virtio_vsock_skb_tap_delivered(struct sk_buff *skb)
{
	return VIRTIO_VSOCK_SKB_CB(skb)->tap_delivered;
}

static inline void virtio_vsock_skb_set_tap_delivered(struct sk_buff *skb)
{
	VIRTIO_VSOCK_SKB_CB(skb)->tap_delivered = true;
}

static inline void virtio_vsock_skb_clear_tap_delivered(struct sk_buff *skb)
{
	VIRTIO_VSOCK_SKB_CB(skb)->tap_delivered = false;
}

static inline void virtio_vsock_skb_rx_put(struct sk_buff *skb)
{
	u32 len;

	len = le32_to_cpu(virtio_vsock_hdr(skb)->len);

	if (len > 0)
		skb_put(skb, len);
}

static inline struct sk_buff *virtio_vsock_alloc_skb(unsigned int size, gfp_t mask)
{
	struct sk_buff *skb;

	if (size < VIRTIO_VSOCK_SKB_HEADROOM)
		return NULL;

	skb = alloc_skb(size, mask);
	if (!skb)
		return NULL;

	skb_reserve(skb, VIRTIO_VSOCK_SKB_HEADROOM);
	return skb;
}

static inline void
virtio_vsock_skb_queue_head(struct sk_buff_head *list, struct sk_buff *skb)
{
	spin_lock_bh(&list->lock);
	__skb_queue_head(list, skb);
	spin_unlock_bh(&list->lock);
}

static inline void
virtio_vsock_skb_queue_tail(struct sk_buff_head *list, struct sk_buff *skb)
{
	spin_lock_bh(&list->lock);
	__skb_queue_tail(list, skb);
	spin_unlock_bh(&list->lock);
}

static inline struct sk_buff *virtio_vsock_skb_dequeue(struct sk_buff_head *list)
{
	struct sk_buff *skb;

	spin_lock_bh(&list->lock);
	skb = __skb_dequeue(list);
	spin_unlock_bh(&list->lock);

	return skb;
}

static inline void virtio_vsock_skb_queue_purge(struct sk_buff_head *list)
{
	spin_lock_bh(&list->lock);
	__skb_queue_purge(list);
	spin_unlock_bh(&list->lock);
}

static inline size_t virtio_vsock_skb_len(struct sk_buff *skb)
{
	return (size_t)(skb_end_pointer(skb) - skb->head);
}

#define VIRTIO_VSOCK_DEFAULT_RX_BUF_SIZE	(1024 * 4)
#define VIRTIO_VSOCK_MAX_BUF_SIZE		0xFFFFFFFFUL
#define VIRTIO_VSOCK_MAX_PKT_BUF_SIZE		(1024 * 64)

enum {
	VSOCK_VQ_RX     = 0, /* for host to guest data */
	VSOCK_VQ_TX     = 1, /* for guest to host data */
	VSOCK_VQ_EVENT  = 2,
	VSOCK_VQ_MAX    = 3,
};

/* Per-socket state (accessed via vsk->trans) */
struct virtio_vsock_sock {
	struct vsock_sock *vsk;

	spinlock_t tx_lock;
	spinlock_t rx_lock;

	/* Protected by tx_lock */
	u32 tx_cnt;
	u32 peer_fwd_cnt;
	u32 peer_buf_alloc;
	size_t bytes_unsent;

	/* Protected by rx_lock */
	u32 fwd_cnt;
	u32 last_fwd_cnt;
	u32 rx_bytes;
	u32 buf_alloc;
	u32 buf_used;
	struct sk_buff_head rx_queue;
	u32 msg_count;
};

struct virtio_vsock_pkt_info {
	u32 remote_cid, remote_port;
	struct vsock_sock *vsk;
	struct msghdr *msg;
	u32 pkt_len;
	u16 type;
	u16 op;
	u32 flags;
	bool reply;
};

struct virtio_transport {
	/* This must be the first field */
	struct vsock_transport transport;

	/* Takes ownership of the packet */
	int (*send_pkt)(struct sk_buff *skb);

	/* Used in MSG_ZEROCOPY mode. Checks, that provided data
	 * (number of buffers) could be transmitted with zerocopy
	 * mode. If this callback is not implemented for the current
	 * transport - this means that this transport doesn't need
	 * extra checks and can perform zerocopy transmission by
	 * default.
	 */
	bool (*can_msgzerocopy)(int bufs_num);
};

ssize_t
virtio_transport_stream_dequeue(struct vsock_sock *vsk,
				struct msghdr *msg,
				size_t len,
				int type);
int
virtio_transport_dgram_dequeue(struct vsock_sock *vsk,
			       struct msghdr *msg,
			       size_t len, int flags);

int
virtio_transport_seqpacket_enqueue(struct vsock_sock *vsk,
				   struct msghdr *msg,
				   size_t len);
ssize_t
virtio_transport_seqpacket_dequeue(struct vsock_sock *vsk,
				   struct msghdr *msg,
				   int flags);
s64 virtio_transport_stream_has_data(struct vsock_sock *vsk);
s64 virtio_transport_stream_has_space(struct vsock_sock *vsk);
u32 virtio_transport_seqpacket_has_data(struct vsock_sock *vsk);

ssize_t virtio_transport_unsent_bytes(struct vsock_sock *vsk);

void virtio_transport_consume_skb_sent(struct sk_buff *skb,
				       bool consume);

int virtio_transport_do_socket_init(struct vsock_sock *vsk,
				 struct vsock_sock *psk);
int
virtio_transport_notify_poll_in(struct vsock_sock *vsk,
				size_t target,
				bool *data_ready_now);
int
virtio_transport_notify_poll_out(struct vsock_sock *vsk,
				 size_t target,
				 bool *space_available_now);

int virtio_transport_notify_recv_init(struct vsock_sock *vsk,
	size_t target, struct vsock_transport_recv_notify_data *data);
int virtio_transport_notify_recv_pre_block(struct vsock_sock *vsk,
	size_t target, struct vsock_transport_recv_notify_data *data);
int virtio_transport_notify_recv_pre_dequeue(struct vsock_sock *vsk,
	size_t target, struct vsock_transport_recv_notify_data *data);
int virtio_transport_notify_recv_post_dequeue(struct vsock_sock *vsk,
	size_t target, ssize_t copied, bool data_read,
	struct vsock_transport_recv_notify_data *data);
int virtio_transport_notify_send_init(struct vsock_sock *vsk,
	struct vsock_transport_send_notify_data *data);
int virtio_transport_notify_send_pre_block(struct vsock_sock *vsk,
	struct vsock_transport_send_notify_data *data);
int virtio_transport_notify_send_pre_enqueue(struct vsock_sock *vsk,
	struct vsock_transport_send_notify_data *data);
int virtio_transport_notify_send_post_enqueue(struct vsock_sock *vsk,
	ssize_t written, struct vsock_transport_send_notify_data *data);
void virtio_transport_notify_buffer_size(struct vsock_sock *vsk, u64 *val);

u64 virtio_transport_stream_rcvhiwat(struct vsock_sock *vsk);
bool virtio_transport_stream_is_active(struct vsock_sock *vsk);
bool virtio_transport_stream_allow(u32 cid, u32 port);
int virtio_transport_dgram_bind(struct vsock_sock *vsk,
				struct sockaddr_vm *addr);
bool virtio_transport_dgram_allow(u32 cid, u32 port);

int virtio_transport_connect(struct vsock_sock *vsk);

int virtio_transport_shutdown(struct vsock_sock *vsk, int mode);

void virtio_transport_release(struct vsock_sock *vsk);

ssize_t
virtio_transport_stream_enqueue(struct vsock_sock *vsk,
				struct msghdr *msg,
				size_t len);
int
virtio_transport_dgram_enqueue(struct vsock_sock *vsk,
			       struct sockaddr_vm *remote_addr,
			       struct msghdr *msg,
			       size_t len);

void virtio_transport_destruct(struct vsock_sock *vsk);

void virtio_transport_recv_pkt(struct virtio_transport *t,
			       struct sk_buff *skb);
void virtio_transport_inc_tx_pkt(struct virtio_vsock_sock *vvs, struct sk_buff *skb);
u32 virtio_transport_get_credit(struct virtio_vsock_sock *vvs, u32 wanted);
void virtio_transport_put_credit(struct virtio_vsock_sock *vvs, u32 credit);
void virtio_transport_deliver_tap_pkt(struct sk_buff *skb);
int virtio_transport_purge_skbs(void *vsk, struct sk_buff_head *list);
int virtio_transport_read_skb(struct vsock_sock *vsk, skb_read_actor_t read_actor);
int virtio_transport_notify_set_rcvlowat(struct vsock_sock *vsk, int val);
#endif /* _LINUX_VIRTIO_VSOCK_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
06a8fc78 AH	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
71dc9ec9 BE	10	#define VIRTIO_VSOCK_SKB_HEADROOM (sizeof(struct virtio_vsock_hdr))
	11
	12	struct virtio_vsock_skb_cb {
	13	bool reply;
	14	bool tap_delivered;
0df7cd3c	15	u32 offset;
71dc9ec9 BE	16	};
	17
	18	#define VIRTIO_VSOCK_SKB_CB(skb) ((struct virtio_vsock_skb_cb *)((skb)->cb))
	19
	20	static inline struct virtio_vsock_hdr virtio_vsock_hdr(struct sk_buff skb)
	21	{
	22	return (struct virtio_vsock_hdr *)skb->head;
	23	}
	24
	25	static inline bool virtio_vsock_skb_reply(struct sk_buff *skb)
	26	{
	27	return VIRTIO_VSOCK_SKB_CB(skb)->reply;
	28	}
	29
	30	static inline void virtio_vsock_skb_set_reply(struct sk_buff *skb)
	31	{
	32	VIRTIO_VSOCK_SKB_CB(skb)->reply = true;
	33	}
	34
	35	static inline bool virtio_vsock_skb_tap_delivered(struct sk_buff *skb)
	36	{
	37	return VIRTIO_VSOCK_SKB_CB(skb)->tap_delivered;
	38	}
	39
	40	static inline void virtio_vsock_skb_set_tap_delivered(struct sk_buff *skb)
	41	{
	42	VIRTIO_VSOCK_SKB_CB(skb)->tap_delivered = true;
	43	}
	44
	45	static inline void virtio_vsock_skb_clear_tap_delivered(struct sk_buff *skb)
	46	{
	47	VIRTIO_VSOCK_SKB_CB(skb)->tap_delivered = false;
	48	}
	49
	50	static inline void virtio_vsock_skb_rx_put(struct sk_buff *skb)
	51	{
	52	u32 len;
	53
	54	len = le32_to_cpu(virtio_vsock_hdr(skb)->len);
	55
	56	if (len > 0)
	57	skb_put(skb, len);
	58	}
	59
	60	static inline struct sk_buff *virtio_vsock_alloc_skb(unsigned int size, gfp_t mask)
	61	{
	62	struct sk_buff *skb;
	63
	64	if (size < VIRTIO_VSOCK_SKB_HEADROOM)
	65	return NULL;
	66
	67	skb = alloc_skb(size, mask);
	68	if (!skb)
	69	return NULL;
	70
	71	skb_reserve(skb, VIRTIO_VSOCK_SKB_HEADROOM);
	72	return skb;
	73	}
	74
	75	static inline void
	76	virtio_vsock_skb_queue_head(struct sk_buff_head list, struct sk_buff skb)
	77	{
	78	spin_lock_bh(&list->lock);
	79	__skb_queue_head(list, skb);
80	spin_unlock_bh(&list->lock);
81	}
82
83	static inline void
84	virtio_vsock_skb_queue_tail(struct sk_buff_head list, struct sk_buff skb)
85	{
86	spin_lock_bh(&list->lock);
87	__skb_queue_tail(list, skb);
88	spin_unlock_bh(&list->lock);
89	}
90
91	static inline struct sk_buff virtio_vsock_skb_dequeue(struct sk_buff_head list)
92	{
93	struct sk_buff *skb;
94
95	spin_lock_bh(&list->lock);
96	skb = __skb_dequeue(list);
97	spin_unlock_bh(&list->lock);
98
99	return skb;
100	}
101
102	static inline void virtio_vsock_skb_queue_purge(struct sk_buff_head *list)
103	{
104	spin_lock_bh(&list->lock);
105	__skb_queue_purge(list);
106	spin_unlock_bh(&list->lock);
107	}
108
109	static inline size_t virtio_vsock_skb_len(struct sk_buff *skb)
110	{
111	return (size_t)(skb_end_pointer(skb) - skb->head);
112	}
113
06a8fc78 AH	114	#define VIRTIO_VSOCK_DEFAULT_RX_BUF_SIZE (1024 * 4)
	115	#define VIRTIO_VSOCK_MAX_BUF_SIZE 0xFFFFFFFFUL
	116	#define VIRTIO_VSOCK_MAX_PKT_BUF_SIZE (1024 * 64)
	117
	118	enum {
	119	VSOCK_VQ_RX = 0, /* for host to guest data */
	120	VSOCK_VQ_TX = 1, /* for guest to host data */
	121	VSOCK_VQ_EVENT = 2,
	122	VSOCK_VQ_MAX = 3,
	123	};
	124
	125	/* Per-socket state (accessed via vsk->trans) */
	126	struct virtio_vsock_sock {
	127	struct vsock_sock *vsk;
	128
06a8fc78 AH	129	spinlock_t tx_lock;
	130	spinlock_t rx_lock;
	131
	132	/* Protected by tx_lock */
	133	u32 tx_cnt;
06a8fc78 AH	134	u32 peer_fwd_cnt;
06a8fc78 AH	135	u32 peer_buf_alloc;
e6ab4500	136	size_t bytes_unsent;
06a8fc78 AH	137
	138	/* Protected by rx_lock */
	139	u32 fwd_cnt;
b89d882d	140	u32 last_fwd_cnt;
06a8fc78	141	u32 rx_bytes;
9632e9f6	142	u32 buf_alloc;
45ca7e9f	143	u32 buf_used;
71dc9ec9	144	struct sk_buff_head rx_queue;
44931195	145	u32 msg_count;
06a8fc78 AH	146	};
06a8fc78 AH	147
06a8fc78 AH	148	struct virtio_vsock_pkt_info {
06a8fc78 AH	149	u32 remote_cid, remote_port;
36d277ba	150	struct vsock_sock *vsk;
06a8fc78 AH	151	struct msghdr *msg;
	152	u32 pkt_len;
	153	u16 type;
	154	u16 op;
	155	u32 flags;
	156	bool reply;
	157	};
	158
	159	struct virtio_transport {
	160	/* This must be the first field */
	161	struct vsock_transport transport;
	162
	163	/* Takes ownership of the packet */
71dc9ec9	164	int (send_pkt)(struct sk_buff skb);
581512a6 AK	165
	166	/* Used in MSG_ZEROCOPY mode. Checks, that provided data
	167	* (number of buffers) could be transmitted with zerocopy
	168	* mode. If this callback is not implemented for the current
	169	* transport - this means that this transport doesn't need
	170	* extra checks and can perform zerocopy transmission by
	171	* default.
	172	*/
	173	bool (*can_msgzerocopy)(int bufs_num);
06a8fc78 AH	174	};
	175
	176	ssize_t
	177	virtio_transport_stream_dequeue(struct vsock_sock *vsk,
	178	struct msghdr *msg,
	179	size_t len,
	180	int type);
	181	int
	182	virtio_transport_dgram_dequeue(struct vsock_sock *vsk,
	183	struct msghdr *msg,
	184	size_t len, int flags);
	185
9ac841f5 AK	186	int
	187	virtio_transport_seqpacket_enqueue(struct vsock_sock *vsk,
	188	struct msghdr *msg,
	189	size_t len);
44931195 AK	190	ssize_t
	191	virtio_transport_seqpacket_dequeue(struct vsock_sock *vsk,
	192	struct msghdr *msg,
	193	int flags);
06a8fc78 AH	194	s64 virtio_transport_stream_has_data(struct vsock_sock *vsk);
06a8fc78 AH	195	s64 virtio_transport_stream_has_space(struct vsock_sock *vsk);
9ac841f5	196	u32 virtio_transport_seqpacket_has_data(struct vsock_sock *vsk);
06a8fc78	197
e6ab4500 LL	198	ssize_t virtio_transport_unsent_bytes(struct vsock_sock *vsk);
	199
	200	void virtio_transport_consume_skb_sent(struct sk_buff *skb,
	201	bool consume);
	202
06a8fc78 AH	203	int virtio_transport_do_socket_init(struct vsock_sock *vsk,
06a8fc78 AH	204	struct vsock_sock *psk);
06a8fc78 AH	205	int
	206	virtio_transport_notify_poll_in(struct vsock_sock *vsk,
	207	size_t target,
	208	bool *data_ready_now);
	209	int
	210	virtio_transport_notify_poll_out(struct vsock_sock *vsk,
	211	size_t target,
	212	bool *space_available_now);
	213
	214	int virtio_transport_notify_recv_init(struct vsock_sock *vsk,
	215	size_t target, struct vsock_transport_recv_notify_data *data);
	216	int virtio_transport_notify_recv_pre_block(struct vsock_sock *vsk,
	217	size_t target, struct vsock_transport_recv_notify_data *data);
	218	int virtio_transport_notify_recv_pre_dequeue(struct vsock_sock *vsk,
	219	size_t target, struct vsock_transport_recv_notify_data *data);
	220	int virtio_transport_notify_recv_post_dequeue(struct vsock_sock *vsk,
	221	size_t target, ssize_t copied, bool data_read,
	222	struct vsock_transport_recv_notify_data *data);
	223	int virtio_transport_notify_send_init(struct vsock_sock *vsk,
	224	struct vsock_transport_send_notify_data *data);
	225	int virtio_transport_notify_send_pre_block(struct vsock_sock *vsk,
	226	struct vsock_transport_send_notify_data *data);
	227	int virtio_transport_notify_send_pre_enqueue(struct vsock_sock *vsk,
	228	struct vsock_transport_send_notify_data *data);
	229	int virtio_transport_notify_send_post_enqueue(struct vsock_sock *vsk,
	230	ssize_t written, struct vsock_transport_send_notify_data *data);
b9f2b0ff	231	void virtio_transport_notify_buffer_size(struct vsock_sock vsk, u64 val);
06a8fc78 AH	232
	233	u64 virtio_transport_stream_rcvhiwat(struct vsock_sock *vsk);
	234	bool virtio_transport_stream_is_active(struct vsock_sock *vsk);
	235	bool virtio_transport_stream_allow(u32 cid, u32 port);
	236	int virtio_transport_dgram_bind(struct vsock_sock *vsk,
	237	struct sockaddr_vm *addr);
	238	bool virtio_transport_dgram_allow(u32 cid, u32 port);
	239
	240	int virtio_transport_connect(struct vsock_sock *vsk);
	241
	242	int virtio_transport_shutdown(struct vsock_sock *vsk, int mode);
	243
	244	void virtio_transport_release(struct vsock_sock *vsk);
	245
	246	ssize_t
	247	virtio_transport_stream_enqueue(struct vsock_sock *vsk,
	248	struct msghdr *msg,
	249	size_t len);
	250	int
	251	virtio_transport_dgram_enqueue(struct vsock_sock *vsk,
	252	struct sockaddr_vm *remote_addr,
	253	struct msghdr *msg,
	254	size_t len);
	255
	256	void virtio_transport_destruct(struct vsock_sock *vsk);
	257
4c7246dc	258	void virtio_transport_recv_pkt(struct virtio_transport *t,
71dc9ec9 BE	259	struct sk_buff *skb);
71dc9ec9 BE	260	void virtio_transport_inc_tx_pkt(struct virtio_vsock_sock vvs, struct sk_buff skb);
06a8fc78 AH	261	u32 virtio_transport_get_credit(struct virtio_vsock_sock *vvs, u32 wanted);
06a8fc78 AH	262	void virtio_transport_put_credit(struct virtio_vsock_sock *vvs, u32 credit);
71dc9ec9 BE	263	void virtio_transport_deliver_tap_pkt(struct sk_buff *skb);
71dc9ec9 BE	264	int virtio_transport_purge_skbs(void vsk, struct sk_buff_head list);
634f1a71	265	int virtio_transport_read_skb(struct vsock_sock *vsk, skb_read_actor_t read_actor);
0fe17989	266	int virtio_transport_notify_set_rcvlowat(struct vsock_sock *vsk, int val);
06a8fc78	267	#endif /* _LINUX_VIRTIO_VSOCK_H */