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,
105 static struct sk_buff *virtio_transport_build_skb(void *opaque)
107 struct virtio_vsock_hdr *pkt_hdr;
108 struct sk_buff *pkt = opaque;
109 struct af_vsockmon_hdr *hdr;
114 /* A packet could be split to fit the RX buffer, so we can retrieve
115 * the payload length from the header and the buffer pointer taking
116 * care of the offset in the original packet.
118 pkt_hdr = virtio_vsock_hdr(pkt);
119 payload_len = pkt->len;
120 payload_buf = pkt->data;
122 skb = alloc_skb(sizeof(*hdr) + sizeof(*pkt_hdr) + payload_len,
127 hdr = skb_put(skb, sizeof(*hdr));
129 /* pkt->hdr is little-endian so no need to byteswap here */
130 hdr->src_cid = pkt_hdr->src_cid;
131 hdr->src_port = pkt_hdr->src_port;
132 hdr->dst_cid = pkt_hdr->dst_cid;
133 hdr->dst_port = pkt_hdr->dst_port;
135 hdr->transport = cpu_to_le16(AF_VSOCK_TRANSPORT_VIRTIO);
136 hdr->len = cpu_to_le16(sizeof(*pkt_hdr));
137 memset(hdr->reserved, 0, sizeof(hdr->reserved));
139 switch (le16_to_cpu(pkt_hdr->op)) {
140 case VIRTIO_VSOCK_OP_REQUEST:
141 case VIRTIO_VSOCK_OP_RESPONSE:
142 hdr->op = cpu_to_le16(AF_VSOCK_OP_CONNECT);
144 case VIRTIO_VSOCK_OP_RST:
145 case VIRTIO_VSOCK_OP_SHUTDOWN:
146 hdr->op = cpu_to_le16(AF_VSOCK_OP_DISCONNECT);
148 case VIRTIO_VSOCK_OP_RW:
149 hdr->op = cpu_to_le16(AF_VSOCK_OP_PAYLOAD);
151 case VIRTIO_VSOCK_OP_CREDIT_UPDATE:
152 case VIRTIO_VSOCK_OP_CREDIT_REQUEST:
153 hdr->op = cpu_to_le16(AF_VSOCK_OP_CONTROL);
156 hdr->op = cpu_to_le16(AF_VSOCK_OP_UNKNOWN);
160 skb_put_data(skb, pkt_hdr, sizeof(*pkt_hdr));
163 skb_put_data(skb, payload_buf, payload_len);
169 void virtio_transport_deliver_tap_pkt(struct sk_buff *skb)
171 if (virtio_vsock_skb_tap_delivered(skb))
174 vsock_deliver_tap(virtio_transport_build_skb, skb);
175 virtio_vsock_skb_set_tap_delivered(skb);
177 EXPORT_SYMBOL_GPL(virtio_transport_deliver_tap_pkt);
179 static u16 virtio_transport_get_type(struct sock *sk)
181 if (sk->sk_type == SOCK_STREAM)
182 return VIRTIO_VSOCK_TYPE_STREAM;
184 return VIRTIO_VSOCK_TYPE_SEQPACKET;
187 /* This function can only be used on connecting/connected sockets,
188 * since a socket assigned to a transport is required.
190 * Do not use on listener sockets!
192 static int virtio_transport_send_pkt_info(struct vsock_sock *vsk,
193 struct virtio_vsock_pkt_info *info)
195 u32 src_cid, src_port, dst_cid, dst_port;
196 const struct virtio_transport *t_ops;
197 struct virtio_vsock_sock *vvs;
198 u32 pkt_len = info->pkt_len;
201 info->type = virtio_transport_get_type(sk_vsock(vsk));
203 t_ops = virtio_transport_get_ops(vsk);
204 if (unlikely(!t_ops))
207 src_cid = t_ops->transport.get_local_cid();
208 src_port = vsk->local_addr.svm_port;
209 if (!info->remote_cid) {
210 dst_cid = vsk->remote_addr.svm_cid;
211 dst_port = vsk->remote_addr.svm_port;
213 dst_cid = info->remote_cid;
214 dst_port = info->remote_port;
219 /* we can send less than pkt_len bytes */
220 if (pkt_len > VIRTIO_VSOCK_MAX_PKT_BUF_SIZE)
221 pkt_len = VIRTIO_VSOCK_MAX_PKT_BUF_SIZE;
223 /* virtio_transport_get_credit might return less than pkt_len credit */
224 pkt_len = virtio_transport_get_credit(vvs, pkt_len);
226 /* Do not send zero length OP_RW pkt */
227 if (pkt_len == 0 && info->op == VIRTIO_VSOCK_OP_RW)
230 skb = virtio_transport_alloc_skb(info, pkt_len,
234 virtio_transport_put_credit(vvs, pkt_len);
238 virtio_transport_inc_tx_pkt(vvs, skb);
240 return t_ops->send_pkt(skb);
243 static bool virtio_transport_inc_rx_pkt(struct virtio_vsock_sock *vvs,
246 if (vvs->rx_bytes + len > vvs->buf_alloc)
249 vvs->rx_bytes += len;
253 static void virtio_transport_dec_rx_pkt(struct virtio_vsock_sock *vvs,
256 vvs->rx_bytes -= len;
260 void virtio_transport_inc_tx_pkt(struct virtio_vsock_sock *vvs, struct sk_buff *skb)
262 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
264 spin_lock_bh(&vvs->rx_lock);
265 vvs->last_fwd_cnt = vvs->fwd_cnt;
266 hdr->fwd_cnt = cpu_to_le32(vvs->fwd_cnt);
267 hdr->buf_alloc = cpu_to_le32(vvs->buf_alloc);
268 spin_unlock_bh(&vvs->rx_lock);
270 EXPORT_SYMBOL_GPL(virtio_transport_inc_tx_pkt);
272 u32 virtio_transport_get_credit(struct virtio_vsock_sock *vvs, u32 credit)
276 spin_lock_bh(&vvs->tx_lock);
277 ret = vvs->peer_buf_alloc - (vvs->tx_cnt - vvs->peer_fwd_cnt);
281 spin_unlock_bh(&vvs->tx_lock);
285 EXPORT_SYMBOL_GPL(virtio_transport_get_credit);
287 void virtio_transport_put_credit(struct virtio_vsock_sock *vvs, u32 credit)
289 spin_lock_bh(&vvs->tx_lock);
290 vvs->tx_cnt -= credit;
291 spin_unlock_bh(&vvs->tx_lock);
293 EXPORT_SYMBOL_GPL(virtio_transport_put_credit);
295 static int virtio_transport_send_credit_update(struct vsock_sock *vsk)
297 struct virtio_vsock_pkt_info info = {
298 .op = VIRTIO_VSOCK_OP_CREDIT_UPDATE,
302 return virtio_transport_send_pkt_info(vsk, &info);
306 virtio_transport_stream_do_peek(struct vsock_sock *vsk,
310 struct virtio_vsock_sock *vvs = vsk->trans;
311 size_t bytes, total = 0, off;
312 struct sk_buff *skb, *tmp;
315 spin_lock_bh(&vvs->rx_lock);
317 skb_queue_walk_safe(&vvs->rx_queue, skb, tmp) {
323 while (total < len && off < skb->len) {
325 if (bytes > skb->len - off)
326 bytes = skb->len - off;
328 /* sk_lock is held by caller so no one else can dequeue.
329 * Unlock rx_lock since memcpy_to_msg() may sleep.
331 spin_unlock_bh(&vvs->rx_lock);
333 err = memcpy_to_msg(msg, skb->data + off, bytes);
337 spin_lock_bh(&vvs->rx_lock);
344 spin_unlock_bh(&vvs->rx_lock);
355 virtio_transport_stream_do_dequeue(struct vsock_sock *vsk,
359 struct virtio_vsock_sock *vvs = vsk->trans;
360 size_t bytes, total = 0;
365 spin_lock_bh(&vvs->rx_lock);
366 while (total < len && !skb_queue_empty(&vvs->rx_queue)) {
367 skb = skb_peek(&vvs->rx_queue);
370 if (bytes > skb->len)
373 /* sk_lock is held by caller so no one else can dequeue.
374 * Unlock rx_lock since memcpy_to_msg() may sleep.
376 spin_unlock_bh(&vvs->rx_lock);
378 err = memcpy_to_msg(msg, skb->data, bytes);
382 spin_lock_bh(&vvs->rx_lock);
385 skb_pull(skb, bytes);
388 u32 pkt_len = le32_to_cpu(virtio_vsock_hdr(skb)->len);
390 virtio_transport_dec_rx_pkt(vvs, pkt_len);
391 __skb_unlink(skb, &vvs->rx_queue);
396 free_space = vvs->buf_alloc - (vvs->fwd_cnt - vvs->last_fwd_cnt);
398 spin_unlock_bh(&vvs->rx_lock);
400 /* To reduce the number of credit update messages,
401 * don't update credits as long as lots of space is available.
402 * Note: the limit chosen here is arbitrary. Setting the limit
403 * too high causes extra messages. Too low causes transmitter
404 * stalls. As stalls are in theory more expensive than extra
405 * messages, we set the limit to a high value. TODO: experiment
406 * with different values.
408 if (free_space < VIRTIO_VSOCK_MAX_PKT_BUF_SIZE)
409 virtio_transport_send_credit_update(vsk);
419 static int virtio_transport_seqpacket_do_dequeue(struct vsock_sock *vsk,
423 struct virtio_vsock_sock *vvs = vsk->trans;
424 int dequeued_len = 0;
425 size_t user_buf_len = msg_data_left(msg);
426 bool msg_ready = false;
429 spin_lock_bh(&vvs->rx_lock);
431 if (vvs->msg_count == 0) {
432 spin_unlock_bh(&vvs->rx_lock);
437 struct virtio_vsock_hdr *hdr;
440 skb = __skb_dequeue(&vvs->rx_queue);
443 hdr = virtio_vsock_hdr(skb);
444 pkt_len = (size_t)le32_to_cpu(hdr->len);
446 if (dequeued_len >= 0) {
447 size_t bytes_to_copy;
449 bytes_to_copy = min(user_buf_len, pkt_len);
454 /* sk_lock is held by caller so no one else can dequeue.
455 * Unlock rx_lock since memcpy_to_msg() may sleep.
457 spin_unlock_bh(&vvs->rx_lock);
459 err = memcpy_to_msg(msg, skb->data, bytes_to_copy);
461 /* Copy of message failed. Rest of
462 * fragments will be freed without copy.
466 user_buf_len -= bytes_to_copy;
469 spin_lock_bh(&vvs->rx_lock);
472 if (dequeued_len >= 0)
473 dequeued_len += pkt_len;
476 if (le32_to_cpu(hdr->flags) & VIRTIO_VSOCK_SEQ_EOM) {
480 if (le32_to_cpu(hdr->flags) & VIRTIO_VSOCK_SEQ_EOR)
481 msg->msg_flags |= MSG_EOR;
484 virtio_transport_dec_rx_pkt(vvs, pkt_len);
488 spin_unlock_bh(&vvs->rx_lock);
490 virtio_transport_send_credit_update(vsk);
496 virtio_transport_stream_dequeue(struct vsock_sock *vsk,
498 size_t len, int flags)
500 if (flags & MSG_PEEK)
501 return virtio_transport_stream_do_peek(vsk, msg, len);
503 return virtio_transport_stream_do_dequeue(vsk, msg, len);
505 EXPORT_SYMBOL_GPL(virtio_transport_stream_dequeue);
508 virtio_transport_seqpacket_dequeue(struct vsock_sock *vsk,
512 if (flags & MSG_PEEK)
515 return virtio_transport_seqpacket_do_dequeue(vsk, msg, flags);
517 EXPORT_SYMBOL_GPL(virtio_transport_seqpacket_dequeue);
520 virtio_transport_seqpacket_enqueue(struct vsock_sock *vsk,
524 struct virtio_vsock_sock *vvs = vsk->trans;
526 spin_lock_bh(&vvs->tx_lock);
528 if (len > vvs->peer_buf_alloc) {
529 spin_unlock_bh(&vvs->tx_lock);
533 spin_unlock_bh(&vvs->tx_lock);
535 return virtio_transport_stream_enqueue(vsk, msg, len);
537 EXPORT_SYMBOL_GPL(virtio_transport_seqpacket_enqueue);
540 virtio_transport_dgram_dequeue(struct vsock_sock *vsk,
542 size_t len, int flags)
546 EXPORT_SYMBOL_GPL(virtio_transport_dgram_dequeue);
548 s64 virtio_transport_stream_has_data(struct vsock_sock *vsk)
550 struct virtio_vsock_sock *vvs = vsk->trans;
553 spin_lock_bh(&vvs->rx_lock);
554 bytes = vvs->rx_bytes;
555 spin_unlock_bh(&vvs->rx_lock);
559 EXPORT_SYMBOL_GPL(virtio_transport_stream_has_data);
561 u32 virtio_transport_seqpacket_has_data(struct vsock_sock *vsk)
563 struct virtio_vsock_sock *vvs = vsk->trans;
566 spin_lock_bh(&vvs->rx_lock);
567 msg_count = vvs->msg_count;
568 spin_unlock_bh(&vvs->rx_lock);
572 EXPORT_SYMBOL_GPL(virtio_transport_seqpacket_has_data);
574 static s64 virtio_transport_has_space(struct vsock_sock *vsk)
576 struct virtio_vsock_sock *vvs = vsk->trans;
579 bytes = vvs->peer_buf_alloc - (vvs->tx_cnt - vvs->peer_fwd_cnt);
586 s64 virtio_transport_stream_has_space(struct vsock_sock *vsk)
588 struct virtio_vsock_sock *vvs = vsk->trans;
591 spin_lock_bh(&vvs->tx_lock);
592 bytes = virtio_transport_has_space(vsk);
593 spin_unlock_bh(&vvs->tx_lock);
597 EXPORT_SYMBOL_GPL(virtio_transport_stream_has_space);
599 int virtio_transport_do_socket_init(struct vsock_sock *vsk,
600 struct vsock_sock *psk)
602 struct virtio_vsock_sock *vvs;
604 vvs = kzalloc(sizeof(*vvs), GFP_KERNEL);
610 if (psk && psk->trans) {
611 struct virtio_vsock_sock *ptrans = psk->trans;
613 vvs->peer_buf_alloc = ptrans->peer_buf_alloc;
616 if (vsk->buffer_size > VIRTIO_VSOCK_MAX_BUF_SIZE)
617 vsk->buffer_size = VIRTIO_VSOCK_MAX_BUF_SIZE;
619 vvs->buf_alloc = vsk->buffer_size;
621 spin_lock_init(&vvs->rx_lock);
622 spin_lock_init(&vvs->tx_lock);
623 skb_queue_head_init(&vvs->rx_queue);
627 EXPORT_SYMBOL_GPL(virtio_transport_do_socket_init);
629 /* sk_lock held by the caller */
630 void virtio_transport_notify_buffer_size(struct vsock_sock *vsk, u64 *val)
632 struct virtio_vsock_sock *vvs = vsk->trans;
634 if (*val > VIRTIO_VSOCK_MAX_BUF_SIZE)
635 *val = VIRTIO_VSOCK_MAX_BUF_SIZE;
637 vvs->buf_alloc = *val;
639 virtio_transport_send_credit_update(vsk);
641 EXPORT_SYMBOL_GPL(virtio_transport_notify_buffer_size);
644 virtio_transport_notify_poll_in(struct vsock_sock *vsk,
646 bool *data_ready_now)
648 *data_ready_now = vsock_stream_has_data(vsk) >= target;
652 EXPORT_SYMBOL_GPL(virtio_transport_notify_poll_in);
655 virtio_transport_notify_poll_out(struct vsock_sock *vsk,
657 bool *space_avail_now)
661 free_space = vsock_stream_has_space(vsk);
663 *space_avail_now = true;
664 else if (free_space == 0)
665 *space_avail_now = false;
669 EXPORT_SYMBOL_GPL(virtio_transport_notify_poll_out);
671 int virtio_transport_notify_recv_init(struct vsock_sock *vsk,
672 size_t target, struct vsock_transport_recv_notify_data *data)
676 EXPORT_SYMBOL_GPL(virtio_transport_notify_recv_init);
678 int virtio_transport_notify_recv_pre_block(struct vsock_sock *vsk,
679 size_t target, struct vsock_transport_recv_notify_data *data)
683 EXPORT_SYMBOL_GPL(virtio_transport_notify_recv_pre_block);
685 int virtio_transport_notify_recv_pre_dequeue(struct vsock_sock *vsk,
686 size_t target, struct vsock_transport_recv_notify_data *data)
690 EXPORT_SYMBOL_GPL(virtio_transport_notify_recv_pre_dequeue);
692 int virtio_transport_notify_recv_post_dequeue(struct vsock_sock *vsk,
693 size_t target, ssize_t copied, bool data_read,
694 struct vsock_transport_recv_notify_data *data)
698 EXPORT_SYMBOL_GPL(virtio_transport_notify_recv_post_dequeue);
700 int virtio_transport_notify_send_init(struct vsock_sock *vsk,
701 struct vsock_transport_send_notify_data *data)
705 EXPORT_SYMBOL_GPL(virtio_transport_notify_send_init);
707 int virtio_transport_notify_send_pre_block(struct vsock_sock *vsk,
708 struct vsock_transport_send_notify_data *data)
712 EXPORT_SYMBOL_GPL(virtio_transport_notify_send_pre_block);
714 int virtio_transport_notify_send_pre_enqueue(struct vsock_sock *vsk,
715 struct vsock_transport_send_notify_data *data)
719 EXPORT_SYMBOL_GPL(virtio_transport_notify_send_pre_enqueue);
721 int virtio_transport_notify_send_post_enqueue(struct vsock_sock *vsk,
722 ssize_t written, struct vsock_transport_send_notify_data *data)
726 EXPORT_SYMBOL_GPL(virtio_transport_notify_send_post_enqueue);
728 u64 virtio_transport_stream_rcvhiwat(struct vsock_sock *vsk)
730 return vsk->buffer_size;
732 EXPORT_SYMBOL_GPL(virtio_transport_stream_rcvhiwat);
734 bool virtio_transport_stream_is_active(struct vsock_sock *vsk)
738 EXPORT_SYMBOL_GPL(virtio_transport_stream_is_active);
740 bool virtio_transport_stream_allow(u32 cid, u32 port)
744 EXPORT_SYMBOL_GPL(virtio_transport_stream_allow);
746 int virtio_transport_dgram_bind(struct vsock_sock *vsk,
747 struct sockaddr_vm *addr)
751 EXPORT_SYMBOL_GPL(virtio_transport_dgram_bind);
753 bool virtio_transport_dgram_allow(u32 cid, u32 port)
757 EXPORT_SYMBOL_GPL(virtio_transport_dgram_allow);
759 int virtio_transport_connect(struct vsock_sock *vsk)
761 struct virtio_vsock_pkt_info info = {
762 .op = VIRTIO_VSOCK_OP_REQUEST,
766 return virtio_transport_send_pkt_info(vsk, &info);
768 EXPORT_SYMBOL_GPL(virtio_transport_connect);
770 int virtio_transport_shutdown(struct vsock_sock *vsk, int mode)
772 struct virtio_vsock_pkt_info info = {
773 .op = VIRTIO_VSOCK_OP_SHUTDOWN,
774 .flags = (mode & RCV_SHUTDOWN ?
775 VIRTIO_VSOCK_SHUTDOWN_RCV : 0) |
776 (mode & SEND_SHUTDOWN ?
777 VIRTIO_VSOCK_SHUTDOWN_SEND : 0),
781 return virtio_transport_send_pkt_info(vsk, &info);
783 EXPORT_SYMBOL_GPL(virtio_transport_shutdown);
786 virtio_transport_dgram_enqueue(struct vsock_sock *vsk,
787 struct sockaddr_vm *remote_addr,
793 EXPORT_SYMBOL_GPL(virtio_transport_dgram_enqueue);
796 virtio_transport_stream_enqueue(struct vsock_sock *vsk,
800 struct virtio_vsock_pkt_info info = {
801 .op = VIRTIO_VSOCK_OP_RW,
807 return virtio_transport_send_pkt_info(vsk, &info);
809 EXPORT_SYMBOL_GPL(virtio_transport_stream_enqueue);
811 void virtio_transport_destruct(struct vsock_sock *vsk)
813 struct virtio_vsock_sock *vvs = vsk->trans;
817 EXPORT_SYMBOL_GPL(virtio_transport_destruct);
819 static int virtio_transport_reset(struct vsock_sock *vsk,
822 struct virtio_vsock_pkt_info info = {
823 .op = VIRTIO_VSOCK_OP_RST,
828 /* Send RST only if the original pkt is not a RST pkt */
829 if (skb && le16_to_cpu(virtio_vsock_hdr(skb)->op) == VIRTIO_VSOCK_OP_RST)
832 return virtio_transport_send_pkt_info(vsk, &info);
835 /* Normally packets are associated with a socket. There may be no socket if an
836 * attempt was made to connect to a socket that does not exist.
838 static int virtio_transport_reset_no_sock(const struct virtio_transport *t,
841 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
842 struct virtio_vsock_pkt_info info = {
843 .op = VIRTIO_VSOCK_OP_RST,
844 .type = le16_to_cpu(hdr->type),
847 struct sk_buff *reply;
849 /* Send RST only if the original pkt is not a RST pkt */
850 if (le16_to_cpu(hdr->op) == VIRTIO_VSOCK_OP_RST)
853 reply = virtio_transport_alloc_skb(&info, 0,
854 le64_to_cpu(hdr->dst_cid),
855 le32_to_cpu(hdr->dst_port),
856 le64_to_cpu(hdr->src_cid),
857 le32_to_cpu(hdr->src_port));
866 return t->send_pkt(reply);
869 /* This function should be called with sk_lock held and SOCK_DONE set */
870 static void virtio_transport_remove_sock(struct vsock_sock *vsk)
872 struct virtio_vsock_sock *vvs = vsk->trans;
874 /* We don't need to take rx_lock, as the socket is closing and we are
877 __skb_queue_purge(&vvs->rx_queue);
878 vsock_remove_sock(vsk);
881 static void virtio_transport_wait_close(struct sock *sk, long timeout)
884 DEFINE_WAIT_FUNC(wait, woken_wake_function);
886 add_wait_queue(sk_sleep(sk), &wait);
889 if (sk_wait_event(sk, &timeout,
890 sock_flag(sk, SOCK_DONE), &wait))
892 } while (!signal_pending(current) && timeout);
894 remove_wait_queue(sk_sleep(sk), &wait);
898 static void virtio_transport_do_close(struct vsock_sock *vsk,
901 struct sock *sk = sk_vsock(vsk);
903 sock_set_flag(sk, SOCK_DONE);
904 vsk->peer_shutdown = SHUTDOWN_MASK;
905 if (vsock_stream_has_data(vsk) <= 0)
906 sk->sk_state = TCP_CLOSING;
907 sk->sk_state_change(sk);
909 if (vsk->close_work_scheduled &&
910 (!cancel_timeout || cancel_delayed_work(&vsk->close_work))) {
911 vsk->close_work_scheduled = false;
913 virtio_transport_remove_sock(vsk);
915 /* Release refcnt obtained when we scheduled the timeout */
920 static void virtio_transport_close_timeout(struct work_struct *work)
922 struct vsock_sock *vsk =
923 container_of(work, struct vsock_sock, close_work.work);
924 struct sock *sk = sk_vsock(vsk);
929 if (!sock_flag(sk, SOCK_DONE)) {
930 (void)virtio_transport_reset(vsk, NULL);
932 virtio_transport_do_close(vsk, false);
935 vsk->close_work_scheduled = false;
941 /* User context, vsk->sk is locked */
942 static bool virtio_transport_close(struct vsock_sock *vsk)
944 struct sock *sk = &vsk->sk;
946 if (!(sk->sk_state == TCP_ESTABLISHED ||
947 sk->sk_state == TCP_CLOSING))
950 /* Already received SHUTDOWN from peer, reply with RST */
951 if ((vsk->peer_shutdown & SHUTDOWN_MASK) == SHUTDOWN_MASK) {
952 (void)virtio_transport_reset(vsk, NULL);
956 if ((sk->sk_shutdown & SHUTDOWN_MASK) != SHUTDOWN_MASK)
957 (void)virtio_transport_shutdown(vsk, SHUTDOWN_MASK);
959 if (sock_flag(sk, SOCK_LINGER) && !(current->flags & PF_EXITING))
960 virtio_transport_wait_close(sk, sk->sk_lingertime);
962 if (sock_flag(sk, SOCK_DONE)) {
967 INIT_DELAYED_WORK(&vsk->close_work,
968 virtio_transport_close_timeout);
969 vsk->close_work_scheduled = true;
970 schedule_delayed_work(&vsk->close_work, VSOCK_CLOSE_TIMEOUT);
974 void virtio_transport_release(struct vsock_sock *vsk)
976 struct sock *sk = &vsk->sk;
977 bool remove_sock = true;
979 if (sk->sk_type == SOCK_STREAM || sk->sk_type == SOCK_SEQPACKET)
980 remove_sock = virtio_transport_close(vsk);
983 sock_set_flag(sk, SOCK_DONE);
984 virtio_transport_remove_sock(vsk);
987 EXPORT_SYMBOL_GPL(virtio_transport_release);
990 virtio_transport_recv_connecting(struct sock *sk,
993 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
994 struct vsock_sock *vsk = vsock_sk(sk);
998 switch (le16_to_cpu(hdr->op)) {
999 case VIRTIO_VSOCK_OP_RESPONSE:
1000 sk->sk_state = TCP_ESTABLISHED;
1001 sk->sk_socket->state = SS_CONNECTED;
1002 vsock_insert_connected(vsk);
1003 sk->sk_state_change(sk);
1005 case VIRTIO_VSOCK_OP_INVALID:
1007 case VIRTIO_VSOCK_OP_RST:
1019 virtio_transport_reset(vsk, skb);
1020 sk->sk_state = TCP_CLOSE;
1022 sk_error_report(sk);
1027 virtio_transport_recv_enqueue(struct vsock_sock *vsk,
1028 struct sk_buff *skb)
1030 struct virtio_vsock_sock *vvs = vsk->trans;
1031 bool can_enqueue, free_pkt = false;
1032 struct virtio_vsock_hdr *hdr;
1035 hdr = virtio_vsock_hdr(skb);
1036 len = le32_to_cpu(hdr->len);
1038 spin_lock_bh(&vvs->rx_lock);
1040 can_enqueue = virtio_transport_inc_rx_pkt(vvs, len);
1046 if (le32_to_cpu(hdr->flags) & VIRTIO_VSOCK_SEQ_EOM)
1049 /* Try to copy small packets into the buffer of last packet queued,
1050 * to avoid wasting memory queueing the entire buffer with a small
1053 if (len <= GOOD_COPY_LEN && !skb_queue_empty(&vvs->rx_queue)) {
1054 struct virtio_vsock_hdr *last_hdr;
1055 struct sk_buff *last_skb;
1057 last_skb = skb_peek_tail(&vvs->rx_queue);
1058 last_hdr = virtio_vsock_hdr(last_skb);
1060 /* If there is space in the last packet queued, we copy the
1061 * new packet in its buffer. We avoid this if the last packet
1062 * queued has VIRTIO_VSOCK_SEQ_EOM set, because this is
1063 * delimiter of SEQPACKET message, so 'pkt' is the first packet
1066 if (skb->len < skb_tailroom(last_skb) &&
1067 !(le32_to_cpu(last_hdr->flags) & VIRTIO_VSOCK_SEQ_EOM)) {
1068 memcpy(skb_put(last_skb, skb->len), skb->data, skb->len);
1070 last_hdr->flags |= hdr->flags;
1071 le32_add_cpu(&last_hdr->len, len);
1076 __skb_queue_tail(&vvs->rx_queue, skb);
1079 spin_unlock_bh(&vvs->rx_lock);
1085 virtio_transport_recv_connected(struct sock *sk,
1086 struct sk_buff *skb)
1088 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
1089 struct vsock_sock *vsk = vsock_sk(sk);
1092 switch (le16_to_cpu(hdr->op)) {
1093 case VIRTIO_VSOCK_OP_RW:
1094 virtio_transport_recv_enqueue(vsk, skb);
1095 vsock_data_ready(sk);
1097 case VIRTIO_VSOCK_OP_CREDIT_REQUEST:
1098 virtio_transport_send_credit_update(vsk);
1100 case VIRTIO_VSOCK_OP_CREDIT_UPDATE:
1101 sk->sk_write_space(sk);
1103 case VIRTIO_VSOCK_OP_SHUTDOWN:
1104 if (le32_to_cpu(hdr->flags) & VIRTIO_VSOCK_SHUTDOWN_RCV)
1105 vsk->peer_shutdown |= RCV_SHUTDOWN;
1106 if (le32_to_cpu(hdr->flags) & VIRTIO_VSOCK_SHUTDOWN_SEND)
1107 vsk->peer_shutdown |= SEND_SHUTDOWN;
1108 if (vsk->peer_shutdown == SHUTDOWN_MASK &&
1109 vsock_stream_has_data(vsk) <= 0 &&
1110 !sock_flag(sk, SOCK_DONE)) {
1111 (void)virtio_transport_reset(vsk, NULL);
1112 virtio_transport_do_close(vsk, true);
1114 if (le32_to_cpu(virtio_vsock_hdr(skb)->flags))
1115 sk->sk_state_change(sk);
1117 case VIRTIO_VSOCK_OP_RST:
1118 virtio_transport_do_close(vsk, true);
1130 virtio_transport_recv_disconnecting(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);
1136 if (le16_to_cpu(hdr->op) == VIRTIO_VSOCK_OP_RST)
1137 virtio_transport_do_close(vsk, true);
1141 virtio_transport_send_response(struct vsock_sock *vsk,
1142 struct sk_buff *skb)
1144 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
1145 struct virtio_vsock_pkt_info info = {
1146 .op = VIRTIO_VSOCK_OP_RESPONSE,
1147 .remote_cid = le64_to_cpu(hdr->src_cid),
1148 .remote_port = le32_to_cpu(hdr->src_port),
1153 return virtio_transport_send_pkt_info(vsk, &info);
1156 static bool virtio_transport_space_update(struct sock *sk,
1157 struct sk_buff *skb)
1159 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
1160 struct vsock_sock *vsk = vsock_sk(sk);
1161 struct virtio_vsock_sock *vvs = vsk->trans;
1162 bool space_available;
1164 /* Listener sockets are not associated with any transport, so we are
1165 * not able to take the state to see if there is space available in the
1166 * remote peer, but since they are only used to receive requests, we
1167 * can assume that there is always space available in the other peer.
1172 /* buf_alloc and fwd_cnt is always included in the hdr */
1173 spin_lock_bh(&vvs->tx_lock);
1174 vvs->peer_buf_alloc = le32_to_cpu(hdr->buf_alloc);
1175 vvs->peer_fwd_cnt = le32_to_cpu(hdr->fwd_cnt);
1176 space_available = virtio_transport_has_space(vsk);
1177 spin_unlock_bh(&vvs->tx_lock);
1178 return space_available;
1181 /* Handle server socket */
1183 virtio_transport_recv_listen(struct sock *sk, struct sk_buff *skb,
1184 struct virtio_transport *t)
1186 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
1187 struct vsock_sock *vsk = vsock_sk(sk);
1188 struct vsock_sock *vchild;
1192 if (le16_to_cpu(hdr->op) != VIRTIO_VSOCK_OP_REQUEST) {
1193 virtio_transport_reset_no_sock(t, skb);
1197 if (sk_acceptq_is_full(sk)) {
1198 virtio_transport_reset_no_sock(t, skb);
1202 child = vsock_create_connected(sk);
1204 virtio_transport_reset_no_sock(t, skb);
1208 sk_acceptq_added(sk);
1210 lock_sock_nested(child, SINGLE_DEPTH_NESTING);
1212 child->sk_state = TCP_ESTABLISHED;
1214 vchild = vsock_sk(child);
1215 vsock_addr_init(&vchild->local_addr, le64_to_cpu(hdr->dst_cid),
1216 le32_to_cpu(hdr->dst_port));
1217 vsock_addr_init(&vchild->remote_addr, le64_to_cpu(hdr->src_cid),
1218 le32_to_cpu(hdr->src_port));
1220 ret = vsock_assign_transport(vchild, vsk);
1221 /* Transport assigned (looking at remote_addr) must be the same
1222 * where we received the request.
1224 if (ret || vchild->transport != &t->transport) {
1225 release_sock(child);
1226 virtio_transport_reset_no_sock(t, skb);
1231 if (virtio_transport_space_update(child, skb))
1232 child->sk_write_space(child);
1234 vsock_insert_connected(vchild);
1235 vsock_enqueue_accept(sk, child);
1236 virtio_transport_send_response(vchild, skb);
1238 release_sock(child);
1240 sk->sk_data_ready(sk);
1244 static bool virtio_transport_valid_type(u16 type)
1246 return (type == VIRTIO_VSOCK_TYPE_STREAM) ||
1247 (type == VIRTIO_VSOCK_TYPE_SEQPACKET);
1250 /* We are under the virtio-vsock's vsock->rx_lock or vhost-vsock's vq->mutex
1253 void virtio_transport_recv_pkt(struct virtio_transport *t,
1254 struct sk_buff *skb)
1256 struct virtio_vsock_hdr *hdr = virtio_vsock_hdr(skb);
1257 struct sockaddr_vm src, dst;
1258 struct vsock_sock *vsk;
1260 bool space_available;
1262 vsock_addr_init(&src, le64_to_cpu(hdr->src_cid),
1263 le32_to_cpu(hdr->src_port));
1264 vsock_addr_init(&dst, le64_to_cpu(hdr->dst_cid),
1265 le32_to_cpu(hdr->dst_port));
1267 trace_virtio_transport_recv_pkt(src.svm_cid, src.svm_port,
1268 dst.svm_cid, dst.svm_port,
1269 le32_to_cpu(hdr->len),
1270 le16_to_cpu(hdr->type),
1271 le16_to_cpu(hdr->op),
1272 le32_to_cpu(hdr->flags),
1273 le32_to_cpu(hdr->buf_alloc),
1274 le32_to_cpu(hdr->fwd_cnt));
1276 if (!virtio_transport_valid_type(le16_to_cpu(hdr->type))) {
1277 (void)virtio_transport_reset_no_sock(t, skb);
1281 /* The socket must be in connected or bound table
1282 * otherwise send reset back
1284 sk = vsock_find_connected_socket(&src, &dst);
1286 sk = vsock_find_bound_socket(&dst);
1288 (void)virtio_transport_reset_no_sock(t, skb);
1293 if (virtio_transport_get_type(sk) != le16_to_cpu(hdr->type)) {
1294 (void)virtio_transport_reset_no_sock(t, skb);
1303 /* Check if sk has been closed before lock_sock */
1304 if (sock_flag(sk, SOCK_DONE)) {
1305 (void)virtio_transport_reset_no_sock(t, skb);
1311 space_available = virtio_transport_space_update(sk, skb);
1313 /* Update CID in case it has changed after a transport reset event */
1314 if (vsk->local_addr.svm_cid != VMADDR_CID_ANY)
1315 vsk->local_addr.svm_cid = dst.svm_cid;
1317 if (space_available)
1318 sk->sk_write_space(sk);
1320 switch (sk->sk_state) {
1322 virtio_transport_recv_listen(sk, skb, t);
1326 virtio_transport_recv_connecting(sk, skb);
1329 case TCP_ESTABLISHED:
1330 virtio_transport_recv_connected(sk, skb);
1333 virtio_transport_recv_disconnecting(sk, skb);
1337 (void)virtio_transport_reset_no_sock(t, skb);
1344 /* Release refcnt obtained when we fetched this socket out of the
1345 * bound or connected list.
1353 EXPORT_SYMBOL_GPL(virtio_transport_recv_pkt);
1355 /* Remove skbs found in a queue that have a vsk that matches.
1357 * Each skb is freed.
1359 * Returns the count of skbs that were reply packets.
1361 int virtio_transport_purge_skbs(void *vsk, struct sk_buff_head *queue)
1363 struct sk_buff_head freeme;
1364 struct sk_buff *skb, *tmp;
1367 skb_queue_head_init(&freeme);
1369 spin_lock_bh(&queue->lock);
1370 skb_queue_walk_safe(queue, skb, tmp) {
1371 if (vsock_sk(skb->sk) != vsk)
1374 __skb_unlink(skb, queue);
1375 __skb_queue_tail(&freeme, skb);
1377 if (virtio_vsock_skb_reply(skb))
1380 spin_unlock_bh(&queue->lock);
1382 __skb_queue_purge(&freeme);
1386 EXPORT_SYMBOL_GPL(virtio_transport_purge_skbs);
1388 MODULE_LICENSE("GPL v2");
1389 MODULE_AUTHOR("Asias He");
1390 MODULE_DESCRIPTION("common code for virtio vsock");