include/linux/virtio_vsock.h

   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_MIN_BUF_SIZE       128
  11 #define VIRTIO_VSOCK_DEFAULT_BUF_SIZE           (1024 * 256)
  12 #define VIRTIO_VSOCK_DEFAULT_MAX_BUF_SIZE       (1024 * 256)
  13 #define VIRTIO_VSOCK_DEFAULT_RX_BUF_SIZE        (1024 * 4)
  14 #define VIRTIO_VSOCK_MAX_BUF_SIZE               0xFFFFFFFFUL
  15 #define VIRTIO_VSOCK_MAX_PKT_BUF_SIZE           (1024 * 64)
  16
  17 enum {
  18         VSOCK_VQ_RX     = 0, /* for host to guest data */
  19         VSOCK_VQ_TX     = 1, /* for guest to host data */
  20         VSOCK_VQ_EVENT  = 2,
  21         VSOCK_VQ_MAX    = 3,
  22 };
  23
  24 /* Per-socket state (accessed via vsk->trans) */
  25 struct virtio_vsock_sock {
  26         struct vsock_sock *vsk;
  27
  28         /* Protected by lock_sock(sk_vsock(trans->vsk)) */
  29         u32 buf_size;
  30         u32 buf_size_min;
  31         u32 buf_size_max;
  32
  33         spinlock_t tx_lock;
  34         spinlock_t rx_lock;
  35
  36         /* Protected by tx_lock */
  37         u32 tx_cnt;
  38         u32 peer_fwd_cnt;
  39         u32 peer_buf_alloc;
  40
  41         /* Protected by rx_lock */
  42         u32 fwd_cnt;
  43         u32 last_fwd_cnt;
  44         u32 rx_bytes;
  45         u32 buf_alloc;
  46         struct list_head rx_queue;
  47 };
  48
  49 struct virtio_vsock_pkt {
  50         struct virtio_vsock_hdr hdr;
  51         struct list_head list;
  52         /* socket refcnt not held, only use for cancellation */
  53         struct vsock_sock *vsk;
  54         void *buf;
  55         u32 buf_len;
  56         u32 len;
  57         u32 off;
  58         bool reply;
  59 };
  60
  61 struct virtio_vsock_pkt_info {
  62         u32 remote_cid, remote_port;
  63         struct vsock_sock *vsk;
  64         struct msghdr *msg;
  65         u32 pkt_len;
  66         u16 type;
  67         u16 op;
  68         u32 flags;
  69         bool reply;
  70 };
  71
  72 struct virtio_transport {
  73         /* This must be the first field */
  74         struct vsock_transport transport;
  75
  76         /* Takes ownership of the packet */
  77         int (*send_pkt)(struct virtio_vsock_pkt *pkt);
  78 };
  79
  80 ssize_t
  81 virtio_transport_stream_dequeue(struct vsock_sock *vsk,
  82                                 struct msghdr *msg,
  83                                 size_t len,
  84                                 int type);
  85 int
  86 virtio_transport_dgram_dequeue(struct vsock_sock *vsk,
  87                                struct msghdr *msg,
  88                                size_t len, int flags);
  89
  90 s64 virtio_transport_stream_has_data(struct vsock_sock *vsk);
  91 s64 virtio_transport_stream_has_space(struct vsock_sock *vsk);
  92
  93 int virtio_transport_do_socket_init(struct vsock_sock *vsk,
  94                                  struct vsock_sock *psk);
  95 u64 virtio_transport_get_buffer_size(struct vsock_sock *vsk);
  96 u64 virtio_transport_get_min_buffer_size(struct vsock_sock *vsk);
  97 u64 virtio_transport_get_max_buffer_size(struct vsock_sock *vsk);
  98 void virtio_transport_set_buffer_size(struct vsock_sock *vsk, u64 val);
  99 void virtio_transport_set_min_buffer_size(struct vsock_sock *vsk, u64 val);
 100 void virtio_transport_set_max_buffer_size(struct vsock_sock *vs, u64 val);
 101 int
 102 virtio_transport_notify_poll_in(struct vsock_sock *vsk,
 103                                 size_t target,
 104                                 bool *data_ready_now);
 105 int
 106 virtio_transport_notify_poll_out(struct vsock_sock *vsk,
 107                                  size_t target,
 108                                  bool *space_available_now);
 109
 110 int virtio_transport_notify_recv_init(struct vsock_sock *vsk,
 111         size_t target, struct vsock_transport_recv_notify_data *data);
 112 int virtio_transport_notify_recv_pre_block(struct vsock_sock *vsk,
 113         size_t target, struct vsock_transport_recv_notify_data *data);
 114 int virtio_transport_notify_recv_pre_dequeue(struct vsock_sock *vsk,
 115         size_t target, struct vsock_transport_recv_notify_data *data);
 116 int virtio_transport_notify_recv_post_dequeue(struct vsock_sock *vsk,
 117         size_t target, ssize_t copied, bool data_read,
 118         struct vsock_transport_recv_notify_data *data);
 119 int virtio_transport_notify_send_init(struct vsock_sock *vsk,
 120         struct vsock_transport_send_notify_data *data);
 121 int virtio_transport_notify_send_pre_block(struct vsock_sock *vsk,
 122         struct vsock_transport_send_notify_data *data);
 123 int virtio_transport_notify_send_pre_enqueue(struct vsock_sock *vsk,
 124         struct vsock_transport_send_notify_data *data);
 125 int virtio_transport_notify_send_post_enqueue(struct vsock_sock *vsk,
 126         ssize_t written, struct vsock_transport_send_notify_data *data);
 127
 128 u64 virtio_transport_stream_rcvhiwat(struct vsock_sock *vsk);
 129 bool virtio_transport_stream_is_active(struct vsock_sock *vsk);
 130 bool virtio_transport_stream_allow(u32 cid, u32 port);
 131 int virtio_transport_dgram_bind(struct vsock_sock *vsk,
 132                                 struct sockaddr_vm *addr);
 133 bool virtio_transport_dgram_allow(u32 cid, u32 port);
 134
 135 int virtio_transport_connect(struct vsock_sock *vsk);
 136
 137 int virtio_transport_shutdown(struct vsock_sock *vsk, int mode);
 138
 139 void virtio_transport_release(struct vsock_sock *vsk);
 140
 141 ssize_t
 142 virtio_transport_stream_enqueue(struct vsock_sock *vsk,
 143                                 struct msghdr *msg,
 144                                 size_t len);
 145 int
 146 virtio_transport_dgram_enqueue(struct vsock_sock *vsk,
 147                                struct sockaddr_vm *remote_addr,
 148                                struct msghdr *msg,
 149                                size_t len);
 150
 151 void virtio_transport_destruct(struct vsock_sock *vsk);
 152
 153 void virtio_transport_recv_pkt(struct virtio_transport *t,
 154                                struct virtio_vsock_pkt *pkt);
 155 void virtio_transport_free_pkt(struct virtio_vsock_pkt *pkt);
 156 void virtio_transport_inc_tx_pkt(struct virtio_vsock_sock *vvs, struct virtio_vsock_pkt *pkt);
 157 u32 virtio_transport_get_credit(struct virtio_vsock_sock *vvs, u32 wanted);
 158 void virtio_transport_put_credit(struct virtio_vsock_sock *vvs, u32 credit);
 159 void virtio_transport_deliver_tap_pkt(struct virtio_vsock_pkt *pkt);
 160
 161 #endif /* _LINUX_VIRTIO_VSOCK_H */