include/linux/virtio_vsock.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #ifndef _LINUX_VIRTIO_VSOCK_H
0003 #define _LINUX_VIRTIO_VSOCK_H
0004
0005 #include <uapi/linux/virtio_vsock.h>
0006 #include <linux/socket.h>
0007 #include <net/sock.h>
0008 #include <net/af_vsock.h>
0009
0010 #define VIRTIO_VSOCK_DEFAULT_RX_BUF_SIZE    (1024 * 4)
0011 #define VIRTIO_VSOCK_MAX_BUF_SIZE       0xFFFFFFFFUL
0012 #define VIRTIO_VSOCK_MAX_PKT_BUF_SIZE       (1024 * 64)
0013
0014 enum {
0015     VSOCK_VQ_RX     = 0, /* for host to guest data */
0016     VSOCK_VQ_TX     = 1, /* for guest to host data */
0017     VSOCK_VQ_EVENT  = 2,
0018     VSOCK_VQ_MAX    = 3,
0019 };
0020
0021 /* Per-socket state (accessed via vsk->trans) */
0022 struct virtio_vsock_sock {
0023     struct vsock_sock *vsk;
0024
0025     spinlock_t tx_lock;
0026     spinlock_t rx_lock;
0027
0028     /* Protected by tx_lock */
0029     u32 tx_cnt;
0030     u32 peer_fwd_cnt;
0031     u32 peer_buf_alloc;
0032
0033     /* Protected by rx_lock */
0034     u32 fwd_cnt;
0035     u32 last_fwd_cnt;
0036     u32 rx_bytes;
0037     u32 buf_alloc;
0038     struct list_head rx_queue;
0039     u32 msg_count;
0040 };
0041
0042 struct virtio_vsock_pkt {
0043     struct virtio_vsock_hdr hdr;
0044     struct list_head list;
0045     /* socket refcnt not held, only use for cancellation */
0046     struct vsock_sock *vsk;
0047     void *buf;
0048     u32 buf_len;
0049     u32 len;
0050     u32 off;
0051     bool reply;
0052     bool tap_delivered;
0053 };
0054
0055 struct virtio_vsock_pkt_info {
0056     u32 remote_cid, remote_port;
0057     struct vsock_sock *vsk;
0058     struct msghdr *msg;
0059     u32 pkt_len;
0060     u16 type;
0061     u16 op;
0062     u32 flags;
0063     bool reply;
0064 };
0065
0066 struct virtio_transport {
0067     /* This must be the first field */
0068     struct vsock_transport transport;
0069
0070     /* Takes ownership of the packet */
0071     int (*send_pkt)(struct virtio_vsock_pkt *pkt);
0072 };
0073
0074 ssize_t
0075 virtio_transport_stream_dequeue(struct vsock_sock *vsk,
0076                 struct msghdr *msg,
0077                 size_t len,
0078                 int type);
0079 int
0080 virtio_transport_dgram_dequeue(struct vsock_sock *vsk,
0081                    struct msghdr *msg,
0082                    size_t len, int flags);
0083
0084 int
0085 virtio_transport_seqpacket_enqueue(struct vsock_sock *vsk,
0086                    struct msghdr *msg,
0087                    size_t len);
0088 ssize_t
0089 virtio_transport_seqpacket_dequeue(struct vsock_sock *vsk,
0090                    struct msghdr *msg,
0091                    int flags);
0092 s64 virtio_transport_stream_has_data(struct vsock_sock *vsk);
0093 s64 virtio_transport_stream_has_space(struct vsock_sock *vsk);
0094 u32 virtio_transport_seqpacket_has_data(struct vsock_sock *vsk);
0095
0096 int virtio_transport_do_socket_init(struct vsock_sock *vsk,
0097                  struct vsock_sock *psk);
0098 int
0099 virtio_transport_notify_poll_in(struct vsock_sock *vsk,
0100                 size_t target,
0101                 bool *data_ready_now);
0102 int
0103 virtio_transport_notify_poll_out(struct vsock_sock *vsk,
0104                  size_t target,
0105                  bool *space_available_now);
0106
0107 int virtio_transport_notify_recv_init(struct vsock_sock *vsk,
0108     size_t target, struct vsock_transport_recv_notify_data *data);
0109 int virtio_transport_notify_recv_pre_block(struct vsock_sock *vsk,
0110     size_t target, struct vsock_transport_recv_notify_data *data);
0111 int virtio_transport_notify_recv_pre_dequeue(struct vsock_sock *vsk,
0112     size_t target, struct vsock_transport_recv_notify_data *data);
0113 int virtio_transport_notify_recv_post_dequeue(struct vsock_sock *vsk,
0114     size_t target, ssize_t copied, bool data_read,
0115     struct vsock_transport_recv_notify_data *data);
0116 int virtio_transport_notify_send_init(struct vsock_sock *vsk,
0117     struct vsock_transport_send_notify_data *data);
0118 int virtio_transport_notify_send_pre_block(struct vsock_sock *vsk,
0119     struct vsock_transport_send_notify_data *data);
0120 int virtio_transport_notify_send_pre_enqueue(struct vsock_sock *vsk,
0121     struct vsock_transport_send_notify_data *data);
0122 int virtio_transport_notify_send_post_enqueue(struct vsock_sock *vsk,
0123     ssize_t written, struct vsock_transport_send_notify_data *data);
0124 void virtio_transport_notify_buffer_size(struct vsock_sock *vsk, u64 *val);
0125
0126 u64 virtio_transport_stream_rcvhiwat(struct vsock_sock *vsk);
0127 bool virtio_transport_stream_is_active(struct vsock_sock *vsk);
0128 bool virtio_transport_stream_allow(u32 cid, u32 port);
0129 int virtio_transport_dgram_bind(struct vsock_sock *vsk,
0130                 struct sockaddr_vm *addr);
0131 bool virtio_transport_dgram_allow(u32 cid, u32 port);
0132
0133 int virtio_transport_connect(struct vsock_sock *vsk);
0134
0135 int virtio_transport_shutdown(struct vsock_sock *vsk, int mode);
0136
0137 void virtio_transport_release(struct vsock_sock *vsk);
0138
0139 ssize_t
0140 virtio_transport_stream_enqueue(struct vsock_sock *vsk,
0141                 struct msghdr *msg,
0142                 size_t len);
0143 int
0144 virtio_transport_dgram_enqueue(struct vsock_sock *vsk,
0145                    struct sockaddr_vm *remote_addr,
0146                    struct msghdr *msg,
0147                    size_t len);
0148
0149 void virtio_transport_destruct(struct vsock_sock *vsk);
0150
0151 void virtio_transport_recv_pkt(struct virtio_transport *t,
0152                    struct virtio_vsock_pkt *pkt);
0153 void virtio_transport_free_pkt(struct virtio_vsock_pkt *pkt);
0154 void virtio_transport_inc_tx_pkt(struct virtio_vsock_sock *vvs, struct virtio_vsock_pkt *pkt);
0155 u32 virtio_transport_get_credit(struct virtio_vsock_sock *vvs, u32 wanted);
0156 void virtio_transport_put_credit(struct virtio_vsock_sock *vvs, u32 credit);
0157 void virtio_transport_deliver_tap_pkt(struct virtio_vsock_pkt *pkt);
0158
0159 #endif /* _LINUX_VIRTIO_VSOCK_H */