1 // SPDX-License-Identifier: GPL-2.0-only
3 * common code for virtio vsock
5 * Copyright (C) 2013-2015 Red Hat, Inc.
6 * Author: Asias He <asias@redhat.com>
7 * Stefan Hajnoczi <stefanha@redhat.com>
9 #include <linux/spinlock.h>
10 #include <linux/module.h>
11 #include <linux/sched/signal.h>
12 #include <linux/ctype.h>
13 #include <linux/list.h>
14 #include <linux/virtio_vsock.h>
15 #include <uapi/linux/vsockmon.h>
18 #include <net/af_vsock.h>
20 #define CREATE_TRACE_POINTS
21 #include <trace/events/vsock_virtio_transport_common.h>
23 /* How long to wait for graceful shutdown of a connection */
24 #define VSOCK_CLOSE_TIMEOUT (8 * HZ)
26 /* Threshold for detecting small packets to copy */
27 #define GOOD_COPY_LEN 128
29 static const struct virtio_transport *
30 virtio_transport_get_ops(struct vsock_sock *vsk)
32 const struct vsock_transport *t = vsock_core_get_transport(vsk);
37 return container_of(t, struct virtio_transport, transport);
40 /* Returns a new packet on success, otherwise returns NULL.
42 * If NULL is returned, errp is set to a negative errno.
44 static struct sk_buff *
45 virtio_transport_alloc_skb(struct virtio_vsock_pkt_info *info,
52 const size_t skb_len = VIRTIO_VSOCK_SKB_HEADROOM + len;
53 struct virtio_vsock_hdr *hdr;
58 skb = virtio_vsock_alloc_skb(skb_len, GFP_KERNEL);
62 hdr = virtio_vsock_hdr(skb);
63 hdr->type = cpu_to_le16(info->type);
64 hdr->op = cpu_to_le16(info->op);
65 hdr->src_cid = cpu_to_le64(src_cid);
66 hdr->dst_cid = cpu_to_le64(dst_cid);
67 hdr->src_port = cpu_to_le32(src_port);
68 hdr->dst_port = cpu_to_le32(dst_port);
69 hdr->flags = cpu_to_le32(info->flags);
70 hdr->len = cpu_to_le32(len);
72 if (info->msg && len > 0) {
73 payload = skb_put(skb, len);
74 err = memcpy_from_msg(payload, info->msg, len);
78 if (msg_data_left(info->msg) == 0 &&
79 info->type == VIRTIO_VSOCK_TYPE_SEQPACKET) {
80 hdr->flags |= cpu_to_le32(VIRTIO_VSOCK_SEQ_EOM);
82 if (info->msg->msg_flags & MSG_EOR)
83 hdr->flags |= cpu_to_le32(VIRTIO_VSOCK_SEQ_EOR);
88 virtio_vsock_skb_set_reply(skb);
90 trace_virtio_transport_alloc_pkt(src_cid, src_port,
97 if (info->vsk && !skb_set_owner_sk_safe(skb, sk_vsock(info->vsk))) {
98 WARN_ONCE(1, "failed to allocate skb on vsock socket with sk_refcnt == 0\n");
110 static struct sk_buff *virtio_transport_build_skb(void *opaque)
112 struct virtio_vsock_hdr *pkt_hdr;
113 struct sk_buff *pkt = opaque;
114 struct af_vsockmon_hdr *hdr;
119 /* A packet could be split to fit the RX buffer, so we can retrieve
120 * the payload length from the header and the buffer pointer taking
121 * care of the offset in the original packet.
123 pkt_hdr = virtio_vsock_hdr(pkt);
124 payload_len = pkt->len;
125 payload_buf = pkt->data;
127 skb = alloc_skb(sizeof(*hdr) + sizeof(*pkt_hdr) + payload_len,
132 hdr = skb_put(skb, sizeof(*hdr));
134 /* pkt->hdr is little-endian so no need to byteswap here */
135 hdr->src_cid = pkt_hdr->src_cid;
136 hdr->src_port = pkt_hdr->src_port;
137 hdr->dst_cid = pkt_hdr->dst_cid;
138 hdr->dst_port = pkt_hdr->dst_port;
140 hdr->transport = cpu_to_le16(AF_VSOCK_TRANSPORT_VIRTIO);
141 hdr->len = cpu_to_le16(sizeof(*pkt_hdr));
142 memset(hdr->reserved, 0, sizeof(hdr->reserved));
144 switch (le16_to_cpu(pkt_hdr->op)) {
145 case VIRTIO_VSOCK_OP_REQUEST:
146 case VIRTIO_VSOCK_OP_RESPONSE:
147 hdr->op = cpu_to_le16(AF_VSOCK_OP_CONNECT);
149 case VIRTIO_VSOCK_OP_RST:
150 case VIRTIO_VSOCK_OP_SHUTDOWN:
151 hdr->op = cpu_to_le16(AF_VSOCK_OP_DISCONNECT);
153 case VIRTIO_VSOCK_OP_RW:
154 hdr->op = cpu_to_le16(AF_VSOCK_OP_PAYLOAD);
156 case VIRTIO_VSOCK_OP_CREDIT_UPDATE:
157 case VIRTIO_VSOCK_OP_CREDIT_REQUEST:
158 hdr->op = cpu_to_le16(AF_VSOCK_OP_CONTROL);
161 hdr->op = cpu_to_le16(AF_VSOCK_OP_UNKNOWN);
165 skb_put_data(skb, pkt_hdr, sizeof(*pkt_hdr));
168 skb_put_data(skb, payload_buf, payload_len);
174 void virtio_transport_deliver_tap_pkt(struct sk_buff *skb)
176 if (virtio_vsock_skb_tap_delivered(skb))
179 vsock_deliver_tap(virtio_transport_build_skb, skb);
180 virtio_vsock_skb_set_tap_delivered(skb);
182 EXPORT_SYMBOL_GPL(virtio_transport_deliver_tap_pkt);
184 static u16 virtio_transport_get_type(struct sock *sk)
186 if (sk->sk_type == SOCK_STREAM)
187 return VIRTIO_VSOCK_TYPE_STREAM;
189 return VIRTIO_VSOCK_TYPE_SEQPACKET;
192 /* This function can only be used on connecting/connected sockets,
193 * since a socket assigned to a transport is required.
195 * Do not use on listener sockets!
197 static int virtio_transport_send_pkt_info(struct vsock_sock *vsk,
198 struct virtio_vsock_pkt_info *info)
200 u32 src_cid, src_port, dst_cid, dst_port;
201 const struct virtio_transport *t_ops;
202 struct virtio_vsock_sock *vvs;
203 u32 pkt_len = info->pkt_len;
207 info->type = virtio_transport_get_type(sk_vsock(vsk));
209 t_ops = virtio_transport_get_ops(vsk);
210 if (unlikely(!t_ops))
213 src_cid = t_ops->transport.get_local_cid();
214 src_port = vsk->local_addr.svm_port;
215 if (!info->remote_cid) {
216 dst_cid = vsk->remote_addr.svm_cid;
217 dst_port = vsk->remote_addr.svm_port;
219 dst_cid = info->remote_cid;
220 dst_port = info->remote_port;
225 /* virtio_transport_get_credit might return less than pkt_len credit */
226 pkt_len = virtio_transport_get_credit(vvs, pkt_len);
228 /* Do not send zero length OP_RW pkt */
229 if (pkt_len == 0 && info->op == VIRTIO_VSOCK_OP_RW)
238 skb_len = min_t(u32, VIRTIO_VSOCK_MAX_PKT_BUF_SIZE, rest_len);
240 skb = virtio_transport_alloc_skb(info, skb_len,
248 virtio_transport_inc_tx_pkt(vvs, skb);
250 ret = t_ops->send_pkt(skb);
254 /* Both virtio and vhost 'send_pkt()' returns 'skb_len',
255 * but for reliability use 'ret' instead of 'skb_len'.
256 * Also if partial send happens (e.g. 'ret' != 'skb_len')
257 * somehow, we break this loop, but account such returned
258 * value in 'virtio_transport_put_credit()'.
262 if (WARN_ONCE(ret != skb_len,
263 "'send_pkt()' returns %i, but %zu expected\n",
268 virtio_transport_put_credit(vvs, rest_len);
270 /* Return number of bytes, if any data has been sent. */
271 if (rest_len != pkt_len)
272 ret = pkt_len - rest_len;
277 static bool virtio_transport_inc_rx_pkt(struct virtio_vsock_sock *vvs,
280 if (vvs->rx_bytes + len > vvs->buf_alloc)
283 vvs->rx_bytes += len;
287 static void virtio_transport_dec_rx_pkt(struct virtio_vsock_sock *vvs,
290 vvs->rx_bytes -= len;
294 void virtio_transport_inc_tx_pkt(struct virtio_vsock_sock *vvs, struct sk_buff *skb)
296 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
298 spin_lock_bh(&vvs->rx_lock);
299 vvs->last_fwd_cnt = vvs->fwd_cnt;
300 hdr->fwd_cnt = cpu_to_le32(vvs->fwd_cnt);
301 hdr->buf_alloc = cpu_to_le32(vvs->buf_alloc);
302 spin_unlock_bh(&vvs->rx_lock);
304 EXPORT_SYMBOL_GPL(virtio_transport_inc_tx_pkt);
306 u32 virtio_transport_get_credit(struct virtio_vsock_sock *vvs, u32 credit)
313 spin_lock_bh(&vvs->tx_lock);
314 ret = vvs->peer_buf_alloc - (vvs->tx_cnt - vvs->peer_fwd_cnt);
318 spin_unlock_bh(&vvs->tx_lock);
322 EXPORT_SYMBOL_GPL(virtio_transport_get_credit);
324 void virtio_transport_put_credit(struct virtio_vsock_sock *vvs, u32 credit)
329 spin_lock_bh(&vvs->tx_lock);
330 vvs->tx_cnt -= credit;
331 spin_unlock_bh(&vvs->tx_lock);
333 EXPORT_SYMBOL_GPL(virtio_transport_put_credit);
335 static int virtio_transport_send_credit_update(struct vsock_sock *vsk)
337 struct virtio_vsock_pkt_info info = {
338 .op = VIRTIO_VSOCK_OP_CREDIT_UPDATE,
342 return virtio_transport_send_pkt_info(vsk, &info);
346 virtio_transport_stream_do_peek(struct vsock_sock *vsk,
350 struct virtio_vsock_sock *vvs = vsk->trans;
351 size_t bytes, total = 0, off;
352 struct sk_buff *skb, *tmp;
355 spin_lock_bh(&vvs->rx_lock);
357 skb_queue_walk_safe(&vvs->rx_queue, skb, tmp) {
363 while (total < len && off < skb->len) {
365 if (bytes > skb->len - off)
366 bytes = skb->len - off;
368 /* sk_lock is held by caller so no one else can dequeue.
369 * Unlock rx_lock since memcpy_to_msg() may sleep.
371 spin_unlock_bh(&vvs->rx_lock);
373 err = memcpy_to_msg(msg, skb->data + off, bytes);
377 spin_lock_bh(&vvs->rx_lock);
384 spin_unlock_bh(&vvs->rx_lock);
395 virtio_transport_stream_do_dequeue(struct vsock_sock *vsk,
399 struct virtio_vsock_sock *vvs = vsk->trans;
400 size_t bytes, total = 0;
405 spin_lock_bh(&vvs->rx_lock);
407 if (WARN_ONCE(skb_queue_empty(&vvs->rx_queue) && vvs->rx_bytes,
408 "rx_queue is empty, but rx_bytes is non-zero\n")) {
409 spin_unlock_bh(&vvs->rx_lock);
413 while (total < len && !skb_queue_empty(&vvs->rx_queue)) {
414 skb = skb_peek(&vvs->rx_queue);
417 if (bytes > skb->len)
420 /* sk_lock is held by caller so no one else can dequeue.
421 * Unlock rx_lock since memcpy_to_msg() may sleep.
423 spin_unlock_bh(&vvs->rx_lock);
425 err = memcpy_to_msg(msg, skb->data, bytes);
429 spin_lock_bh(&vvs->rx_lock);
432 skb_pull(skb, bytes);
435 u32 pkt_len = le32_to_cpu(virtio_vsock_hdr(skb)->len);
437 virtio_transport_dec_rx_pkt(vvs, pkt_len);
438 __skb_unlink(skb, &vvs->rx_queue);
443 free_space = vvs->buf_alloc - (vvs->fwd_cnt - vvs->last_fwd_cnt);
445 spin_unlock_bh(&vvs->rx_lock);
447 /* To reduce the number of credit update messages,
448 * don't update credits as long as lots of space is available.
449 * Note: the limit chosen here is arbitrary. Setting the limit
450 * too high causes extra messages. Too low causes transmitter
451 * stalls. As stalls are in theory more expensive than extra
452 * messages, we set the limit to a high value. TODO: experiment
453 * with different values.
455 if (free_space < VIRTIO_VSOCK_MAX_PKT_BUF_SIZE)
456 virtio_transport_send_credit_update(vsk);
466 static int virtio_transport_seqpacket_do_dequeue(struct vsock_sock *vsk,
470 struct virtio_vsock_sock *vvs = vsk->trans;
471 int dequeued_len = 0;
472 size_t user_buf_len = msg_data_left(msg);
473 bool msg_ready = false;
476 spin_lock_bh(&vvs->rx_lock);
478 if (vvs->msg_count == 0) {
479 spin_unlock_bh(&vvs->rx_lock);
484 struct virtio_vsock_hdr *hdr;
487 skb = __skb_dequeue(&vvs->rx_queue);
490 hdr = virtio_vsock_hdr(skb);
491 pkt_len = (size_t)le32_to_cpu(hdr->len);
493 if (dequeued_len >= 0) {
494 size_t bytes_to_copy;
496 bytes_to_copy = min(user_buf_len, pkt_len);
501 /* sk_lock is held by caller so no one else can dequeue.
502 * Unlock rx_lock since memcpy_to_msg() may sleep.
504 spin_unlock_bh(&vvs->rx_lock);
506 err = memcpy_to_msg(msg, skb->data, bytes_to_copy);
508 /* Copy of message failed. Rest of
509 * fragments will be freed without copy.
513 user_buf_len -= bytes_to_copy;
516 spin_lock_bh(&vvs->rx_lock);
519 if (dequeued_len >= 0)
520 dequeued_len += pkt_len;
523 if (le32_to_cpu(hdr->flags) & VIRTIO_VSOCK_SEQ_EOM) {
527 if (le32_to_cpu(hdr->flags) & VIRTIO_VSOCK_SEQ_EOR)
528 msg->msg_flags |= MSG_EOR;
531 virtio_transport_dec_rx_pkt(vvs, pkt_len);
535 spin_unlock_bh(&vvs->rx_lock);
537 virtio_transport_send_credit_update(vsk);
543 virtio_transport_stream_dequeue(struct vsock_sock *vsk,
545 size_t len, int flags)
547 if (flags & MSG_PEEK)
548 return virtio_transport_stream_do_peek(vsk, msg, len);
550 return virtio_transport_stream_do_dequeue(vsk, msg, len);
552 EXPORT_SYMBOL_GPL(virtio_transport_stream_dequeue);
555 virtio_transport_seqpacket_dequeue(struct vsock_sock *vsk,
559 if (flags & MSG_PEEK)
562 return virtio_transport_seqpacket_do_dequeue(vsk, msg, flags);
564 EXPORT_SYMBOL_GPL(virtio_transport_seqpacket_dequeue);
567 virtio_transport_seqpacket_enqueue(struct vsock_sock *vsk,
571 struct virtio_vsock_sock *vvs = vsk->trans;
573 spin_lock_bh(&vvs->tx_lock);
575 if (len > vvs->peer_buf_alloc) {
576 spin_unlock_bh(&vvs->tx_lock);
580 spin_unlock_bh(&vvs->tx_lock);
582 return virtio_transport_stream_enqueue(vsk, msg, len);
584 EXPORT_SYMBOL_GPL(virtio_transport_seqpacket_enqueue);
587 virtio_transport_dgram_dequeue(struct vsock_sock *vsk,
589 size_t len, int flags)
593 EXPORT_SYMBOL_GPL(virtio_transport_dgram_dequeue);
595 s64 virtio_transport_stream_has_data(struct vsock_sock *vsk)
597 struct virtio_vsock_sock *vvs = vsk->trans;
600 spin_lock_bh(&vvs->rx_lock);
601 bytes = vvs->rx_bytes;
602 spin_unlock_bh(&vvs->rx_lock);
606 EXPORT_SYMBOL_GPL(virtio_transport_stream_has_data);
608 u32 virtio_transport_seqpacket_has_data(struct vsock_sock *vsk)
610 struct virtio_vsock_sock *vvs = vsk->trans;
613 spin_lock_bh(&vvs->rx_lock);
614 msg_count = vvs->msg_count;
615 spin_unlock_bh(&vvs->rx_lock);
619 EXPORT_SYMBOL_GPL(virtio_transport_seqpacket_has_data);
621 static s64 virtio_transport_has_space(struct vsock_sock *vsk)
623 struct virtio_vsock_sock *vvs = vsk->trans;
626 bytes = vvs->peer_buf_alloc - (vvs->tx_cnt - vvs->peer_fwd_cnt);
633 s64 virtio_transport_stream_has_space(struct vsock_sock *vsk)
635 struct virtio_vsock_sock *vvs = vsk->trans;
638 spin_lock_bh(&vvs->tx_lock);
639 bytes = virtio_transport_has_space(vsk);
640 spin_unlock_bh(&vvs->tx_lock);
644 EXPORT_SYMBOL_GPL(virtio_transport_stream_has_space);
646 int virtio_transport_do_socket_init(struct vsock_sock *vsk,
647 struct vsock_sock *psk)
649 struct virtio_vsock_sock *vvs;
651 vvs = kzalloc(sizeof(*vvs), GFP_KERNEL);
657 if (psk && psk->trans) {
658 struct virtio_vsock_sock *ptrans = psk->trans;
660 vvs->peer_buf_alloc = ptrans->peer_buf_alloc;
663 if (vsk->buffer_size > VIRTIO_VSOCK_MAX_BUF_SIZE)
664 vsk->buffer_size = VIRTIO_VSOCK_MAX_BUF_SIZE;
666 vvs->buf_alloc = vsk->buffer_size;
668 spin_lock_init(&vvs->rx_lock);
669 spin_lock_init(&vvs->tx_lock);
670 skb_queue_head_init(&vvs->rx_queue);
674 EXPORT_SYMBOL_GPL(virtio_transport_do_socket_init);
676 /* sk_lock held by the caller */
677 void virtio_transport_notify_buffer_size(struct vsock_sock *vsk, u64 *val)
679 struct virtio_vsock_sock *vvs = vsk->trans;
681 if (*val > VIRTIO_VSOCK_MAX_BUF_SIZE)
682 *val = VIRTIO_VSOCK_MAX_BUF_SIZE;
684 vvs->buf_alloc = *val;
686 virtio_transport_send_credit_update(vsk);
688 EXPORT_SYMBOL_GPL(virtio_transport_notify_buffer_size);
691 virtio_transport_notify_poll_in(struct vsock_sock *vsk,
693 bool *data_ready_now)
695 *data_ready_now = vsock_stream_has_data(vsk) >= target;
699 EXPORT_SYMBOL_GPL(virtio_transport_notify_poll_in);
702 virtio_transport_notify_poll_out(struct vsock_sock *vsk,
704 bool *space_avail_now)
708 free_space = vsock_stream_has_space(vsk);
710 *space_avail_now = true;
711 else if (free_space == 0)
712 *space_avail_now = false;
716 EXPORT_SYMBOL_GPL(virtio_transport_notify_poll_out);
718 int virtio_transport_notify_recv_init(struct vsock_sock *vsk,
719 size_t target, struct vsock_transport_recv_notify_data *data)
723 EXPORT_SYMBOL_GPL(virtio_transport_notify_recv_init);
725 int virtio_transport_notify_recv_pre_block(struct vsock_sock *vsk,
726 size_t target, struct vsock_transport_recv_notify_data *data)
730 EXPORT_SYMBOL_GPL(virtio_transport_notify_recv_pre_block);
732 int virtio_transport_notify_recv_pre_dequeue(struct vsock_sock *vsk,
733 size_t target, struct vsock_transport_recv_notify_data *data)
737 EXPORT_SYMBOL_GPL(virtio_transport_notify_recv_pre_dequeue);
739 int virtio_transport_notify_recv_post_dequeue(struct vsock_sock *vsk,
740 size_t target, ssize_t copied, bool data_read,
741 struct vsock_transport_recv_notify_data *data)
745 EXPORT_SYMBOL_GPL(virtio_transport_notify_recv_post_dequeue);
747 int virtio_transport_notify_send_init(struct vsock_sock *vsk,
748 struct vsock_transport_send_notify_data *data)
752 EXPORT_SYMBOL_GPL(virtio_transport_notify_send_init);
754 int virtio_transport_notify_send_pre_block(struct vsock_sock *vsk,
755 struct vsock_transport_send_notify_data *data)
759 EXPORT_SYMBOL_GPL(virtio_transport_notify_send_pre_block);
761 int virtio_transport_notify_send_pre_enqueue(struct vsock_sock *vsk,
762 struct vsock_transport_send_notify_data *data)
766 EXPORT_SYMBOL_GPL(virtio_transport_notify_send_pre_enqueue);
768 int virtio_transport_notify_send_post_enqueue(struct vsock_sock *vsk,
769 ssize_t written, struct vsock_transport_send_notify_data *data)
773 EXPORT_SYMBOL_GPL(virtio_transport_notify_send_post_enqueue);
775 u64 virtio_transport_stream_rcvhiwat(struct vsock_sock *vsk)
777 return vsk->buffer_size;
779 EXPORT_SYMBOL_GPL(virtio_transport_stream_rcvhiwat);
781 bool virtio_transport_stream_is_active(struct vsock_sock *vsk)
785 EXPORT_SYMBOL_GPL(virtio_transport_stream_is_active);
787 bool virtio_transport_stream_allow(u32 cid, u32 port)
791 EXPORT_SYMBOL_GPL(virtio_transport_stream_allow);
793 int virtio_transport_dgram_bind(struct vsock_sock *vsk,
794 struct sockaddr_vm *addr)
798 EXPORT_SYMBOL_GPL(virtio_transport_dgram_bind);
800 bool virtio_transport_dgram_allow(u32 cid, u32 port)
804 EXPORT_SYMBOL_GPL(virtio_transport_dgram_allow);
806 int virtio_transport_connect(struct vsock_sock *vsk)
808 struct virtio_vsock_pkt_info info = {
809 .op = VIRTIO_VSOCK_OP_REQUEST,
813 return virtio_transport_send_pkt_info(vsk, &info);
815 EXPORT_SYMBOL_GPL(virtio_transport_connect);
817 int virtio_transport_shutdown(struct vsock_sock *vsk, int mode)
819 struct virtio_vsock_pkt_info info = {
820 .op = VIRTIO_VSOCK_OP_SHUTDOWN,
821 .flags = (mode & RCV_SHUTDOWN ?
822 VIRTIO_VSOCK_SHUTDOWN_RCV : 0) |
823 (mode & SEND_SHUTDOWN ?
824 VIRTIO_VSOCK_SHUTDOWN_SEND : 0),
828 return virtio_transport_send_pkt_info(vsk, &info);
830 EXPORT_SYMBOL_GPL(virtio_transport_shutdown);
833 virtio_transport_dgram_enqueue(struct vsock_sock *vsk,
834 struct sockaddr_vm *remote_addr,
840 EXPORT_SYMBOL_GPL(virtio_transport_dgram_enqueue);
843 virtio_transport_stream_enqueue(struct vsock_sock *vsk,
847 struct virtio_vsock_pkt_info info = {
848 .op = VIRTIO_VSOCK_OP_RW,
854 return virtio_transport_send_pkt_info(vsk, &info);
856 EXPORT_SYMBOL_GPL(virtio_transport_stream_enqueue);
858 void virtio_transport_destruct(struct vsock_sock *vsk)
860 struct virtio_vsock_sock *vvs = vsk->trans;
864 EXPORT_SYMBOL_GPL(virtio_transport_destruct);
866 static int virtio_transport_reset(struct vsock_sock *vsk,
869 struct virtio_vsock_pkt_info info = {
870 .op = VIRTIO_VSOCK_OP_RST,
875 /* Send RST only if the original pkt is not a RST pkt */
876 if (skb && le16_to_cpu(virtio_vsock_hdr(skb)->op) == VIRTIO_VSOCK_OP_RST)
879 return virtio_transport_send_pkt_info(vsk, &info);
882 /* Normally packets are associated with a socket. There may be no socket if an
883 * attempt was made to connect to a socket that does not exist.
885 static int virtio_transport_reset_no_sock(const struct virtio_transport *t,
888 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
889 struct virtio_vsock_pkt_info info = {
890 .op = VIRTIO_VSOCK_OP_RST,
891 .type = le16_to_cpu(hdr->type),
894 struct sk_buff *reply;
896 /* Send RST only if the original pkt is not a RST pkt */
897 if (le16_to_cpu(hdr->op) == VIRTIO_VSOCK_OP_RST)
903 reply = virtio_transport_alloc_skb(&info, 0,
904 le64_to_cpu(hdr->dst_cid),
905 le32_to_cpu(hdr->dst_port),
906 le64_to_cpu(hdr->src_cid),
907 le32_to_cpu(hdr->src_port));
911 return t->send_pkt(reply);
914 /* This function should be called with sk_lock held and SOCK_DONE set */
915 static void virtio_transport_remove_sock(struct vsock_sock *vsk)
917 struct virtio_vsock_sock *vvs = vsk->trans;
919 /* We don't need to take rx_lock, as the socket is closing and we are
922 __skb_queue_purge(&vvs->rx_queue);
923 vsock_remove_sock(vsk);
926 static void virtio_transport_wait_close(struct sock *sk, long timeout)
929 DEFINE_WAIT_FUNC(wait, woken_wake_function);
931 add_wait_queue(sk_sleep(sk), &wait);
934 if (sk_wait_event(sk, &timeout,
935 sock_flag(sk, SOCK_DONE), &wait))
937 } while (!signal_pending(current) && timeout);
939 remove_wait_queue(sk_sleep(sk), &wait);
943 static void virtio_transport_do_close(struct vsock_sock *vsk,
946 struct sock *sk = sk_vsock(vsk);
948 sock_set_flag(sk, SOCK_DONE);
949 vsk->peer_shutdown = SHUTDOWN_MASK;
950 if (vsock_stream_has_data(vsk) <= 0)
951 sk->sk_state = TCP_CLOSING;
952 sk->sk_state_change(sk);
954 if (vsk->close_work_scheduled &&
955 (!cancel_timeout || cancel_delayed_work(&vsk->close_work))) {
956 vsk->close_work_scheduled = false;
958 virtio_transport_remove_sock(vsk);
960 /* Release refcnt obtained when we scheduled the timeout */
965 static void virtio_transport_close_timeout(struct work_struct *work)
967 struct vsock_sock *vsk =
968 container_of(work, struct vsock_sock, close_work.work);
969 struct sock *sk = sk_vsock(vsk);
974 if (!sock_flag(sk, SOCK_DONE)) {
975 (void)virtio_transport_reset(vsk, NULL);
977 virtio_transport_do_close(vsk, false);
980 vsk->close_work_scheduled = false;
986 /* User context, vsk->sk is locked */
987 static bool virtio_transport_close(struct vsock_sock *vsk)
989 struct sock *sk = &vsk->sk;
991 if (!(sk->sk_state == TCP_ESTABLISHED ||
992 sk->sk_state == TCP_CLOSING))
995 /* Already received SHUTDOWN from peer, reply with RST */
996 if ((vsk->peer_shutdown & SHUTDOWN_MASK) == SHUTDOWN_MASK) {
997 (void)virtio_transport_reset(vsk, NULL);
1001 if ((sk->sk_shutdown & SHUTDOWN_MASK) != SHUTDOWN_MASK)
1002 (void)virtio_transport_shutdown(vsk, SHUTDOWN_MASK);
1004 if (sock_flag(sk, SOCK_LINGER) && !(current->flags & PF_EXITING))
1005 virtio_transport_wait_close(sk, sk->sk_lingertime);
1007 if (sock_flag(sk, SOCK_DONE)) {
1012 INIT_DELAYED_WORK(&vsk->close_work,
1013 virtio_transport_close_timeout);
1014 vsk->close_work_scheduled = true;
1015 schedule_delayed_work(&vsk->close_work, VSOCK_CLOSE_TIMEOUT);
1019 void virtio_transport_release(struct vsock_sock *vsk)
1021 struct sock *sk = &vsk->sk;
1022 bool remove_sock = true;
1024 if (sk->sk_type == SOCK_STREAM || sk->sk_type == SOCK_SEQPACKET)
1025 remove_sock = virtio_transport_close(vsk);
1028 sock_set_flag(sk, SOCK_DONE);
1029 virtio_transport_remove_sock(vsk);
1032 EXPORT_SYMBOL_GPL(virtio_transport_release);
1035 virtio_transport_recv_connecting(struct sock *sk,
1036 struct sk_buff *skb)
1038 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
1039 struct vsock_sock *vsk = vsock_sk(sk);
1043 switch (le16_to_cpu(hdr->op)) {
1044 case VIRTIO_VSOCK_OP_RESPONSE:
1045 sk->sk_state = TCP_ESTABLISHED;
1046 sk->sk_socket->state = SS_CONNECTED;
1047 vsock_insert_connected(vsk);
1048 sk->sk_state_change(sk);
1050 case VIRTIO_VSOCK_OP_INVALID:
1052 case VIRTIO_VSOCK_OP_RST:
1064 virtio_transport_reset(vsk, skb);
1065 sk->sk_state = TCP_CLOSE;
1067 sk_error_report(sk);
1072 virtio_transport_recv_enqueue(struct vsock_sock *vsk,
1073 struct sk_buff *skb)
1075 struct virtio_vsock_sock *vvs = vsk->trans;
1076 bool can_enqueue, free_pkt = false;
1077 struct virtio_vsock_hdr *hdr;
1080 hdr = virtio_vsock_hdr(skb);
1081 len = le32_to_cpu(hdr->len);
1083 spin_lock_bh(&vvs->rx_lock);
1085 can_enqueue = virtio_transport_inc_rx_pkt(vvs, len);
1091 if (le32_to_cpu(hdr->flags) & VIRTIO_VSOCK_SEQ_EOM)
1094 /* Try to copy small packets into the buffer of last packet queued,
1095 * to avoid wasting memory queueing the entire buffer with a small
1098 if (len <= GOOD_COPY_LEN && !skb_queue_empty(&vvs->rx_queue)) {
1099 struct virtio_vsock_hdr *last_hdr;
1100 struct sk_buff *last_skb;
1102 last_skb = skb_peek_tail(&vvs->rx_queue);
1103 last_hdr = virtio_vsock_hdr(last_skb);
1105 /* If there is space in the last packet queued, we copy the
1106 * new packet in its buffer. We avoid this if the last packet
1107 * queued has VIRTIO_VSOCK_SEQ_EOM set, because this is
1108 * delimiter of SEQPACKET message, so 'pkt' is the first packet
1111 if (skb->len < skb_tailroom(last_skb) &&
1112 !(le32_to_cpu(last_hdr->flags) & VIRTIO_VSOCK_SEQ_EOM)) {
1113 memcpy(skb_put(last_skb, skb->len), skb->data, skb->len);
1115 last_hdr->flags |= hdr->flags;
1116 le32_add_cpu(&last_hdr->len, len);
1121 __skb_queue_tail(&vvs->rx_queue, skb);
1124 spin_unlock_bh(&vvs->rx_lock);
1130 virtio_transport_recv_connected(struct sock *sk,
1131 struct sk_buff *skb)
1133 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
1134 struct vsock_sock *vsk = vsock_sk(sk);
1137 switch (le16_to_cpu(hdr->op)) {
1138 case VIRTIO_VSOCK_OP_RW:
1139 virtio_transport_recv_enqueue(vsk, skb);
1140 vsock_data_ready(sk);
1142 case VIRTIO_VSOCK_OP_CREDIT_REQUEST:
1143 virtio_transport_send_credit_update(vsk);
1145 case VIRTIO_VSOCK_OP_CREDIT_UPDATE:
1146 sk->sk_write_space(sk);
1148 case VIRTIO_VSOCK_OP_SHUTDOWN:
1149 if (le32_to_cpu(hdr->flags) & VIRTIO_VSOCK_SHUTDOWN_RCV)
1150 vsk->peer_shutdown |= RCV_SHUTDOWN;
1151 if (le32_to_cpu(hdr->flags) & VIRTIO_VSOCK_SHUTDOWN_SEND)
1152 vsk->peer_shutdown |= SEND_SHUTDOWN;
1153 if (vsk->peer_shutdown == SHUTDOWN_MASK &&
1154 vsock_stream_has_data(vsk) <= 0 &&
1155 !sock_flag(sk, SOCK_DONE)) {
1156 (void)virtio_transport_reset(vsk, NULL);
1157 virtio_transport_do_close(vsk, true);
1159 if (le32_to_cpu(virtio_vsock_hdr(skb)->flags))
1160 sk->sk_state_change(sk);
1162 case VIRTIO_VSOCK_OP_RST:
1163 virtio_transport_do_close(vsk, true);
1175 virtio_transport_recv_disconnecting(struct sock *sk,
1176 struct sk_buff *skb)
1178 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
1179 struct vsock_sock *vsk = vsock_sk(sk);
1181 if (le16_to_cpu(hdr->op) == VIRTIO_VSOCK_OP_RST)
1182 virtio_transport_do_close(vsk, true);
1186 virtio_transport_send_response(struct vsock_sock *vsk,
1187 struct sk_buff *skb)
1189 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
1190 struct virtio_vsock_pkt_info info = {
1191 .op = VIRTIO_VSOCK_OP_RESPONSE,
1192 .remote_cid = le64_to_cpu(hdr->src_cid),
1193 .remote_port = le32_to_cpu(hdr->src_port),
1198 return virtio_transport_send_pkt_info(vsk, &info);
1201 static bool virtio_transport_space_update(struct sock *sk,
1202 struct sk_buff *skb)
1204 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
1205 struct vsock_sock *vsk = vsock_sk(sk);
1206 struct virtio_vsock_sock *vvs = vsk->trans;
1207 bool space_available;
1209 /* Listener sockets are not associated with any transport, so we are
1210 * not able to take the state to see if there is space available in the
1211 * remote peer, but since they are only used to receive requests, we
1212 * can assume that there is always space available in the other peer.
1217 /* buf_alloc and fwd_cnt is always included in the hdr */
1218 spin_lock_bh(&vvs->tx_lock);
1219 vvs->peer_buf_alloc = le32_to_cpu(hdr->buf_alloc);
1220 vvs->peer_fwd_cnt = le32_to_cpu(hdr->fwd_cnt);
1221 space_available = virtio_transport_has_space(vsk);
1222 spin_unlock_bh(&vvs->tx_lock);
1223 return space_available;
1226 /* Handle server socket */
1228 virtio_transport_recv_listen(struct sock *sk, struct sk_buff *skb,
1229 struct virtio_transport *t)
1231 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
1232 struct vsock_sock *vsk = vsock_sk(sk);
1233 struct vsock_sock *vchild;
1237 if (le16_to_cpu(hdr->op) != VIRTIO_VSOCK_OP_REQUEST) {
1238 virtio_transport_reset_no_sock(t, skb);
1242 if (sk_acceptq_is_full(sk)) {
1243 virtio_transport_reset_no_sock(t, skb);
1247 child = vsock_create_connected(sk);
1249 virtio_transport_reset_no_sock(t, skb);
1253 sk_acceptq_added(sk);
1255 lock_sock_nested(child, SINGLE_DEPTH_NESTING);
1257 child->sk_state = TCP_ESTABLISHED;
1259 vchild = vsock_sk(child);
1260 vsock_addr_init(&vchild->local_addr, le64_to_cpu(hdr->dst_cid),
1261 le32_to_cpu(hdr->dst_port));
1262 vsock_addr_init(&vchild->remote_addr, le64_to_cpu(hdr->src_cid),
1263 le32_to_cpu(hdr->src_port));
1265 ret = vsock_assign_transport(vchild, vsk);
1266 /* Transport assigned (looking at remote_addr) must be the same
1267 * where we received the request.
1269 if (ret || vchild->transport != &t->transport) {
1270 release_sock(child);
1271 virtio_transport_reset_no_sock(t, skb);
1276 if (virtio_transport_space_update(child, skb))
1277 child->sk_write_space(child);
1279 vsock_insert_connected(vchild);
1280 vsock_enqueue_accept(sk, child);
1281 virtio_transport_send_response(vchild, skb);
1283 release_sock(child);
1285 sk->sk_data_ready(sk);
1289 static bool virtio_transport_valid_type(u16 type)
1291 return (type == VIRTIO_VSOCK_TYPE_STREAM) ||
1292 (type == VIRTIO_VSOCK_TYPE_SEQPACKET);
1295 /* We are under the virtio-vsock's vsock->rx_lock or vhost-vsock's vq->mutex
1298 void virtio_transport_recv_pkt(struct virtio_transport *t,
1299 struct sk_buff *skb)
1301 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
1302 struct sockaddr_vm src, dst;
1303 struct vsock_sock *vsk;
1305 bool space_available;
1307 vsock_addr_init(&src, le64_to_cpu(hdr->src_cid),
1308 le32_to_cpu(hdr->src_port));
1309 vsock_addr_init(&dst, le64_to_cpu(hdr->dst_cid),
1310 le32_to_cpu(hdr->dst_port));
1312 trace_virtio_transport_recv_pkt(src.svm_cid, src.svm_port,
1313 dst.svm_cid, dst.svm_port,
1314 le32_to_cpu(hdr->len),
1315 le16_to_cpu(hdr->type),
1316 le16_to_cpu(hdr->op),
1317 le32_to_cpu(hdr->flags),
1318 le32_to_cpu(hdr->buf_alloc),
1319 le32_to_cpu(hdr->fwd_cnt));
1321 if (!virtio_transport_valid_type(le16_to_cpu(hdr->type))) {
1322 (void)virtio_transport_reset_no_sock(t, skb);
1326 /* The socket must be in connected or bound table
1327 * otherwise send reset back
1329 sk = vsock_find_connected_socket(&src, &dst);
1331 sk = vsock_find_bound_socket(&dst);
1333 (void)virtio_transport_reset_no_sock(t, skb);
1338 if (virtio_transport_get_type(sk) != le16_to_cpu(hdr->type)) {
1339 (void)virtio_transport_reset_no_sock(t, skb);
1344 if (!skb_set_owner_sk_safe(skb, sk)) {
1345 WARN_ONCE(1, "receiving vsock socket has sk_refcnt == 0\n");
1353 /* Check if sk has been closed before lock_sock */
1354 if (sock_flag(sk, SOCK_DONE)) {
1355 (void)virtio_transport_reset_no_sock(t, skb);
1361 space_available = virtio_transport_space_update(sk, skb);
1363 /* Update CID in case it has changed after a transport reset event */
1364 if (vsk->local_addr.svm_cid != VMADDR_CID_ANY)
1365 vsk->local_addr.svm_cid = dst.svm_cid;
1367 if (space_available)
1368 sk->sk_write_space(sk);
1370 switch (sk->sk_state) {
1372 virtio_transport_recv_listen(sk, skb, t);
1376 virtio_transport_recv_connecting(sk, skb);
1379 case TCP_ESTABLISHED:
1380 virtio_transport_recv_connected(sk, skb);
1383 virtio_transport_recv_disconnecting(sk, skb);
1387 (void)virtio_transport_reset_no_sock(t, skb);
1394 /* Release refcnt obtained when we fetched this socket out of the
1395 * bound or connected list.
1403 EXPORT_SYMBOL_GPL(virtio_transport_recv_pkt);
1405 /* Remove skbs found in a queue that have a vsk that matches.
1407 * Each skb is freed.
1409 * Returns the count of skbs that were reply packets.
1411 int virtio_transport_purge_skbs(void *vsk, struct sk_buff_head *queue)
1413 struct sk_buff_head freeme;
1414 struct sk_buff *skb, *tmp;
1417 skb_queue_head_init(&freeme);
1419 spin_lock_bh(&queue->lock);
1420 skb_queue_walk_safe(queue, skb, tmp) {
1421 if (vsock_sk(skb->sk) != vsk)
1424 __skb_unlink(skb, queue);
1425 __skb_queue_tail(&freeme, skb);
1427 if (virtio_vsock_skb_reply(skb))
1430 spin_unlock_bh(&queue->lock);
1432 __skb_queue_purge(&freeme);
1436 EXPORT_SYMBOL_GPL(virtio_transport_purge_skbs);
1438 int virtio_transport_read_skb(struct vsock_sock *vsk, skb_read_actor_t recv_actor)
1440 struct virtio_vsock_sock *vvs = vsk->trans;
1441 struct sock *sk = sk_vsock(vsk);
1442 struct sk_buff *skb;
1446 spin_lock_bh(&vvs->rx_lock);
1447 /* Use __skb_recv_datagram() for race-free handling of the receive. It
1448 * works for types other than dgrams.
1450 skb = __skb_recv_datagram(sk, &vvs->rx_queue, MSG_DONTWAIT, &off, &err);
1451 spin_unlock_bh(&vvs->rx_lock);
1456 return recv_actor(sk, skb);
1458 EXPORT_SYMBOL_GPL(virtio_transport_read_skb);
1460 MODULE_LICENSE("GPL v2");
1461 MODULE_AUTHOR("Asias He");
1462 MODULE_DESCRIPTION("common code for virtio vsock");