[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_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 list_head rx_queue;
	u32 msg_count;
};

struct virtio_vsock_pkt {
	struct virtio_vsock_hdr	hdr;
	struct list_head list;
	/* socket refcnt not held, only use for cancellation */
	struct vsock_sock *vsk;
	void *buf;
	u32 buf_len;
	u32 len;
	u32 off;
	bool reply;
	bool tap_delivered;
};

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 virtio_vsock_pkt *pkt);
};

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

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

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 virtio_vsock_pkt *pkt);
void virtio_transport_free_pkt(struct virtio_vsock_pkt *pkt);
void virtio_transport_inc_tx_pkt(struct virtio_vsock_sock *vvs, struct virtio_vsock_pkt *pkt);
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 virtio_vsock_pkt *pkt);

#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
06a8fc78 AH	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 (1024 * 64)
	13
	14	enum {
	15	VSOCK_VQ_RX = 0, /* for host to guest data */
	16	VSOCK_VQ_TX = 1, /* for guest to host data */
	17	VSOCK_VQ_EVENT = 2,
	18	VSOCK_VQ_MAX = 3,
	19	};
	20
	21	/* Per-socket state (accessed via vsk->trans) */
	22	struct virtio_vsock_sock {
	23	struct vsock_sock *vsk;
	24
06a8fc78 AH	25	spinlock_t tx_lock;
	26	spinlock_t rx_lock;
	27
	28	/* Protected by tx_lock */
	29	u32 tx_cnt;
06a8fc78 AH	30	u32 peer_fwd_cnt;
	31	u32 peer_buf_alloc;
	32
	33	/* Protected by rx_lock */
	34	u32 fwd_cnt;
b89d882d	35	u32 last_fwd_cnt;
06a8fc78	36	u32 rx_bytes;
9632e9f6	37	u32 buf_alloc;
06a8fc78	38	struct list_head rx_queue;
44931195	39	u32 msg_count;
06a8fc78 AH	40	};
	41
	42	struct virtio_vsock_pkt {
	43	struct virtio_vsock_hdr hdr;
06a8fc78	44	struct list_head list;
36d277ba PT	45	/* socket refcnt not held, only use for cancellation */
36d277ba PT	46	struct vsock_sock *vsk;
06a8fc78	47	void *buf;
473c7391	48	u32 buf_len;
06a8fc78 AH	49	u32 len;
	50	u32 off;
	51	bool reply;
a78d1639	52	bool tap_delivered;
06a8fc78 AH	53	};
	54
	55	struct virtio_vsock_pkt_info {
	56	u32 remote_cid, remote_port;
36d277ba	57	struct vsock_sock *vsk;
06a8fc78 AH	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
44931195 AK	84	ssize_t
	85	virtio_transport_seqpacket_dequeue(struct vsock_sock *vsk,
	86	struct msghdr *msg,
	87	int flags);
06a8fc78 AH	88	s64 virtio_transport_stream_has_data(struct vsock_sock *vsk);
	89	s64 virtio_transport_stream_has_space(struct vsock_sock *vsk);
	90
	91	int virtio_transport_do_socket_init(struct vsock_sock *vsk,
	92	struct vsock_sock *psk);
06a8fc78 AH	93	int
	94	virtio_transport_notify_poll_in(struct vsock_sock *vsk,
	95	size_t target,
	96	bool *data_ready_now);
	97	int
	98	virtio_transport_notify_poll_out(struct vsock_sock *vsk,
	99	size_t target,
	100	bool *space_available_now);
	101
	102	int virtio_transport_notify_recv_init(struct vsock_sock *vsk,
	103	size_t target, struct vsock_transport_recv_notify_data *data);
	104	int virtio_transport_notify_recv_pre_block(struct vsock_sock *vsk,
	105	size_t target, struct vsock_transport_recv_notify_data *data);
	106	int virtio_transport_notify_recv_pre_dequeue(struct vsock_sock *vsk,
	107	size_t target, struct vsock_transport_recv_notify_data *data);
	108	int virtio_transport_notify_recv_post_dequeue(struct vsock_sock *vsk,
	109	size_t target, ssize_t copied, bool data_read,
	110	struct vsock_transport_recv_notify_data *data);
	111	int virtio_transport_notify_send_init(struct vsock_sock *vsk,
	112	struct vsock_transport_send_notify_data *data);
	113	int virtio_transport_notify_send_pre_block(struct vsock_sock *vsk,
	114	struct vsock_transport_send_notify_data *data);
	115	int virtio_transport_notify_send_pre_enqueue(struct vsock_sock *vsk,
	116	struct vsock_transport_send_notify_data *data);
	117	int virtio_transport_notify_send_post_enqueue(struct vsock_sock *vsk,
	118	ssize_t written, struct vsock_transport_send_notify_data *data);
b9f2b0ff	119	void virtio_transport_notify_buffer_size(struct vsock_sock vsk, u64 val);
06a8fc78 AH	120
	121	u64 virtio_transport_stream_rcvhiwat(struct vsock_sock *vsk);
	122	bool virtio_transport_stream_is_active(struct vsock_sock *vsk);
	123	bool virtio_transport_stream_allow(u32 cid, u32 port);
	124	int virtio_transport_dgram_bind(struct vsock_sock *vsk,
	125	struct sockaddr_vm *addr);
	126	bool virtio_transport_dgram_allow(u32 cid, u32 port);
	127
	128	int virtio_transport_connect(struct vsock_sock *vsk);
	129
	130	int virtio_transport_shutdown(struct vsock_sock *vsk, int mode);
	131
	132	void virtio_transport_release(struct vsock_sock *vsk);
	133
	134	ssize_t
	135	virtio_transport_stream_enqueue(struct vsock_sock *vsk,
	136	struct msghdr *msg,
	137	size_t len);
	138	int
	139	virtio_transport_dgram_enqueue(struct vsock_sock *vsk,
	140	struct sockaddr_vm *remote_addr,
	141	struct msghdr *msg,
	142	size_t len);
	143
	144	void virtio_transport_destruct(struct vsock_sock *vsk);
	145
4c7246dc SG	146	void virtio_transport_recv_pkt(struct virtio_transport *t,
4c7246dc SG	147	struct virtio_vsock_pkt *pkt);
06a8fc78 AH	148	void virtio_transport_free_pkt(struct virtio_vsock_pkt *pkt);
	149	void virtio_transport_inc_tx_pkt(struct virtio_vsock_sock vvs, struct virtio_vsock_pkt pkt);
	150	u32 virtio_transport_get_credit(struct virtio_vsock_sock *vvs, u32 wanted);
	151	void virtio_transport_put_credit(struct virtio_vsock_sock *vvs, u32 credit);
82dfb540	152	void virtio_transport_deliver_tap_pkt(struct virtio_vsock_pkt *pkt);
06a8fc78 AH	153
06a8fc78 AH	154	#endif /* _LINUX_VIRTIO_VSOCK_H */