[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;
};

#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;

	/* Protected by rx_lock */
	u32 fwd_cnt;
	u32 last_fwd_cnt;
	u32 rx_bytes;
	u32 buf_alloc;
	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);
};

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);

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