1 // SPDX-License-Identifier: GPL-2.0-only
3 * VMware vSockets Driver
5 * Copyright (C) 2007-2013 VMware, Inc. All rights reserved.
8 #include <linux/types.h>
9 #include <linux/bitops.h>
10 #include <linux/cred.h>
11 #include <linux/init.h>
13 #include <linux/kernel.h>
14 #include <linux/kmod.h>
15 #include <linux/list.h>
16 #include <linux/module.h>
17 #include <linux/mutex.h>
18 #include <linux/net.h>
19 #include <linux/poll.h>
20 #include <linux/skbuff.h>
21 #include <linux/smp.h>
22 #include <linux/socket.h>
23 #include <linux/stddef.h>
24 #include <linux/unistd.h>
25 #include <linux/wait.h>
26 #include <linux/workqueue.h>
28 #include <net/af_vsock.h>
30 #include "vmci_transport_notify.h"
32 static int vmci_transport_recv_dgram_cb(void *data, struct vmci_datagram *dg);
33 static int vmci_transport_recv_stream_cb(void *data, struct vmci_datagram *dg);
34 static void vmci_transport_peer_detach_cb(u32 sub_id,
35 const struct vmci_event_data *ed,
37 static void vmci_transport_recv_pkt_work(struct work_struct *work);
38 static void vmci_transport_cleanup(struct work_struct *work);
39 static int vmci_transport_recv_listen(struct sock *sk,
40 struct vmci_transport_packet *pkt);
41 static int vmci_transport_recv_connecting_server(
44 struct vmci_transport_packet *pkt);
45 static int vmci_transport_recv_connecting_client(
47 struct vmci_transport_packet *pkt);
48 static int vmci_transport_recv_connecting_client_negotiate(
50 struct vmci_transport_packet *pkt);
51 static int vmci_transport_recv_connecting_client_invalid(
53 struct vmci_transport_packet *pkt);
54 static int vmci_transport_recv_connected(struct sock *sk,
55 struct vmci_transport_packet *pkt);
56 static bool vmci_transport_old_proto_override(bool *old_pkt_proto);
57 static u16 vmci_transport_new_proto_supported_versions(void);
58 static bool vmci_transport_proto_to_notify_struct(struct sock *sk, u16 *proto,
61 struct vmci_transport_recv_pkt_info {
62 struct work_struct work;
64 struct vmci_transport_packet pkt;
67 static LIST_HEAD(vmci_transport_cleanup_list);
68 static DEFINE_SPINLOCK(vmci_transport_cleanup_lock);
69 static DECLARE_WORK(vmci_transport_cleanup_work, vmci_transport_cleanup);
71 static struct vmci_handle vmci_transport_stream_handle = { VMCI_INVALID_ID,
73 static u32 vmci_transport_qp_resumed_sub_id = VMCI_INVALID_ID;
75 static int PROTOCOL_OVERRIDE = -1;
77 #define VMCI_TRANSPORT_DEFAULT_QP_SIZE_MIN 128
78 #define VMCI_TRANSPORT_DEFAULT_QP_SIZE 262144
79 #define VMCI_TRANSPORT_DEFAULT_QP_SIZE_MAX 262144
81 /* Helper function to convert from a VMCI error code to a VSock error code. */
83 static s32 vmci_transport_error_to_vsock_error(s32 vmci_error)
86 case VMCI_ERROR_NO_MEM:
88 case VMCI_ERROR_DUPLICATE_ENTRY:
89 case VMCI_ERROR_ALREADY_EXISTS:
91 case VMCI_ERROR_NO_ACCESS:
93 case VMCI_ERROR_NO_RESOURCES:
95 case VMCI_ERROR_INVALID_RESOURCE:
97 case VMCI_ERROR_INVALID_ARGS:
104 static u32 vmci_transport_peer_rid(u32 peer_cid)
106 if (VMADDR_CID_HYPERVISOR == peer_cid)
107 return VMCI_TRANSPORT_HYPERVISOR_PACKET_RID;
109 return VMCI_TRANSPORT_PACKET_RID;
113 vmci_transport_packet_init(struct vmci_transport_packet *pkt,
114 struct sockaddr_vm *src,
115 struct sockaddr_vm *dst,
119 struct vmci_transport_waiting_info *wait,
121 struct vmci_handle handle)
123 /* We register the stream control handler as an any cid handle so we
124 * must always send from a source address of VMADDR_CID_ANY
126 pkt->dg.src = vmci_make_handle(VMADDR_CID_ANY,
127 VMCI_TRANSPORT_PACKET_RID);
128 pkt->dg.dst = vmci_make_handle(dst->svm_cid,
129 vmci_transport_peer_rid(dst->svm_cid));
130 pkt->dg.payload_size = sizeof(*pkt) - sizeof(pkt->dg);
131 pkt->version = VMCI_TRANSPORT_PACKET_VERSION;
133 pkt->src_port = src->svm_port;
134 pkt->dst_port = dst->svm_port;
135 memset(&pkt->proto, 0, sizeof(pkt->proto));
136 memset(&pkt->_reserved2, 0, sizeof(pkt->_reserved2));
139 case VMCI_TRANSPORT_PACKET_TYPE_INVALID:
143 case VMCI_TRANSPORT_PACKET_TYPE_REQUEST:
144 case VMCI_TRANSPORT_PACKET_TYPE_NEGOTIATE:
148 case VMCI_TRANSPORT_PACKET_TYPE_OFFER:
149 case VMCI_TRANSPORT_PACKET_TYPE_ATTACH:
150 pkt->u.handle = handle;
153 case VMCI_TRANSPORT_PACKET_TYPE_WROTE:
154 case VMCI_TRANSPORT_PACKET_TYPE_READ:
155 case VMCI_TRANSPORT_PACKET_TYPE_RST:
159 case VMCI_TRANSPORT_PACKET_TYPE_SHUTDOWN:
163 case VMCI_TRANSPORT_PACKET_TYPE_WAITING_READ:
164 case VMCI_TRANSPORT_PACKET_TYPE_WAITING_WRITE:
165 memcpy(&pkt->u.wait, wait, sizeof(pkt->u.wait));
168 case VMCI_TRANSPORT_PACKET_TYPE_REQUEST2:
169 case VMCI_TRANSPORT_PACKET_TYPE_NEGOTIATE2:
177 vmci_transport_packet_get_addresses(struct vmci_transport_packet *pkt,
178 struct sockaddr_vm *local,
179 struct sockaddr_vm *remote)
181 vsock_addr_init(local, pkt->dg.dst.context, pkt->dst_port);
182 vsock_addr_init(remote, pkt->dg.src.context, pkt->src_port);
186 __vmci_transport_send_control_pkt(struct vmci_transport_packet *pkt,
187 struct sockaddr_vm *src,
188 struct sockaddr_vm *dst,
189 enum vmci_transport_packet_type type,
192 struct vmci_transport_waiting_info *wait,
194 struct vmci_handle handle,
199 vmci_transport_packet_init(pkt, src, dst, type, size, mode, wait,
201 err = vmci_datagram_send(&pkt->dg);
202 if (convert_error && (err < 0))
203 return vmci_transport_error_to_vsock_error(err);
209 vmci_transport_reply_control_pkt_fast(struct vmci_transport_packet *pkt,
210 enum vmci_transport_packet_type type,
213 struct vmci_transport_waiting_info *wait,
214 struct vmci_handle handle)
216 struct vmci_transport_packet reply;
217 struct sockaddr_vm src, dst;
219 if (pkt->type == VMCI_TRANSPORT_PACKET_TYPE_RST) {
222 vmci_transport_packet_get_addresses(pkt, &src, &dst);
223 return __vmci_transport_send_control_pkt(&reply, &src, &dst,
232 vmci_transport_send_control_pkt_bh(struct sockaddr_vm *src,
233 struct sockaddr_vm *dst,
234 enum vmci_transport_packet_type type,
237 struct vmci_transport_waiting_info *wait,
238 struct vmci_handle handle)
240 /* Note that it is safe to use a single packet across all CPUs since
241 * two tasklets of the same type are guaranteed to not ever run
242 * simultaneously. If that ever changes, or VMCI stops using tasklets,
243 * we can use per-cpu packets.
245 static struct vmci_transport_packet pkt;
247 return __vmci_transport_send_control_pkt(&pkt, src, dst, type,
249 VSOCK_PROTO_INVALID, handle,
254 vmci_transport_alloc_send_control_pkt(struct sockaddr_vm *src,
255 struct sockaddr_vm *dst,
256 enum vmci_transport_packet_type type,
259 struct vmci_transport_waiting_info *wait,
261 struct vmci_handle handle)
263 struct vmci_transport_packet *pkt;
266 pkt = kmalloc(sizeof(*pkt), GFP_KERNEL);
270 err = __vmci_transport_send_control_pkt(pkt, src, dst, type, size,
271 mode, wait, proto, handle,
279 vmci_transport_send_control_pkt(struct sock *sk,
280 enum vmci_transport_packet_type type,
283 struct vmci_transport_waiting_info *wait,
285 struct vmci_handle handle)
287 struct vsock_sock *vsk;
291 if (!vsock_addr_bound(&vsk->local_addr))
294 if (!vsock_addr_bound(&vsk->remote_addr))
297 return vmci_transport_alloc_send_control_pkt(&vsk->local_addr,
300 wait, proto, handle);
303 static int vmci_transport_send_reset_bh(struct sockaddr_vm *dst,
304 struct sockaddr_vm *src,
305 struct vmci_transport_packet *pkt)
307 if (pkt->type == VMCI_TRANSPORT_PACKET_TYPE_RST)
309 return vmci_transport_send_control_pkt_bh(
311 VMCI_TRANSPORT_PACKET_TYPE_RST, 0,
312 0, NULL, VMCI_INVALID_HANDLE);
315 static int vmci_transport_send_reset(struct sock *sk,
316 struct vmci_transport_packet *pkt)
318 struct sockaddr_vm *dst_ptr;
319 struct sockaddr_vm dst;
320 struct vsock_sock *vsk;
322 if (pkt->type == VMCI_TRANSPORT_PACKET_TYPE_RST)
327 if (!vsock_addr_bound(&vsk->local_addr))
330 if (vsock_addr_bound(&vsk->remote_addr)) {
331 dst_ptr = &vsk->remote_addr;
333 vsock_addr_init(&dst, pkt->dg.src.context,
337 return vmci_transport_alloc_send_control_pkt(&vsk->local_addr, dst_ptr,
338 VMCI_TRANSPORT_PACKET_TYPE_RST,
339 0, 0, NULL, VSOCK_PROTO_INVALID,
340 VMCI_INVALID_HANDLE);
343 static int vmci_transport_send_negotiate(struct sock *sk, size_t size)
345 return vmci_transport_send_control_pkt(
347 VMCI_TRANSPORT_PACKET_TYPE_NEGOTIATE,
350 VMCI_INVALID_HANDLE);
353 static int vmci_transport_send_negotiate2(struct sock *sk, size_t size,
356 return vmci_transport_send_control_pkt(
358 VMCI_TRANSPORT_PACKET_TYPE_NEGOTIATE2,
359 size, 0, NULL, version,
360 VMCI_INVALID_HANDLE);
363 static int vmci_transport_send_qp_offer(struct sock *sk,
364 struct vmci_handle handle)
366 return vmci_transport_send_control_pkt(
367 sk, VMCI_TRANSPORT_PACKET_TYPE_OFFER, 0,
369 VSOCK_PROTO_INVALID, handle);
372 static int vmci_transport_send_attach(struct sock *sk,
373 struct vmci_handle handle)
375 return vmci_transport_send_control_pkt(
376 sk, VMCI_TRANSPORT_PACKET_TYPE_ATTACH,
377 0, 0, NULL, VSOCK_PROTO_INVALID,
381 static int vmci_transport_reply_reset(struct vmci_transport_packet *pkt)
383 return vmci_transport_reply_control_pkt_fast(
385 VMCI_TRANSPORT_PACKET_TYPE_RST,
387 VMCI_INVALID_HANDLE);
390 static int vmci_transport_send_invalid_bh(struct sockaddr_vm *dst,
391 struct sockaddr_vm *src)
393 return vmci_transport_send_control_pkt_bh(
395 VMCI_TRANSPORT_PACKET_TYPE_INVALID,
396 0, 0, NULL, VMCI_INVALID_HANDLE);
399 int vmci_transport_send_wrote_bh(struct sockaddr_vm *dst,
400 struct sockaddr_vm *src)
402 return vmci_transport_send_control_pkt_bh(
404 VMCI_TRANSPORT_PACKET_TYPE_WROTE, 0,
405 0, NULL, VMCI_INVALID_HANDLE);
408 int vmci_transport_send_read_bh(struct sockaddr_vm *dst,
409 struct sockaddr_vm *src)
411 return vmci_transport_send_control_pkt_bh(
413 VMCI_TRANSPORT_PACKET_TYPE_READ, 0,
414 0, NULL, VMCI_INVALID_HANDLE);
417 int vmci_transport_send_wrote(struct sock *sk)
419 return vmci_transport_send_control_pkt(
420 sk, VMCI_TRANSPORT_PACKET_TYPE_WROTE, 0,
421 0, NULL, VSOCK_PROTO_INVALID,
422 VMCI_INVALID_HANDLE);
425 int vmci_transport_send_read(struct sock *sk)
427 return vmci_transport_send_control_pkt(
428 sk, VMCI_TRANSPORT_PACKET_TYPE_READ, 0,
429 0, NULL, VSOCK_PROTO_INVALID,
430 VMCI_INVALID_HANDLE);
433 int vmci_transport_send_waiting_write(struct sock *sk,
434 struct vmci_transport_waiting_info *wait)
436 return vmci_transport_send_control_pkt(
437 sk, VMCI_TRANSPORT_PACKET_TYPE_WAITING_WRITE,
438 0, 0, wait, VSOCK_PROTO_INVALID,
439 VMCI_INVALID_HANDLE);
442 int vmci_transport_send_waiting_read(struct sock *sk,
443 struct vmci_transport_waiting_info *wait)
445 return vmci_transport_send_control_pkt(
446 sk, VMCI_TRANSPORT_PACKET_TYPE_WAITING_READ,
447 0, 0, wait, VSOCK_PROTO_INVALID,
448 VMCI_INVALID_HANDLE);
451 static int vmci_transport_shutdown(struct vsock_sock *vsk, int mode)
453 return vmci_transport_send_control_pkt(
455 VMCI_TRANSPORT_PACKET_TYPE_SHUTDOWN,
458 VMCI_INVALID_HANDLE);
461 static int vmci_transport_send_conn_request(struct sock *sk, size_t size)
463 return vmci_transport_send_control_pkt(sk,
464 VMCI_TRANSPORT_PACKET_TYPE_REQUEST,
467 VMCI_INVALID_HANDLE);
470 static int vmci_transport_send_conn_request2(struct sock *sk, size_t size,
473 return vmci_transport_send_control_pkt(
474 sk, VMCI_TRANSPORT_PACKET_TYPE_REQUEST2,
475 size, 0, NULL, version,
476 VMCI_INVALID_HANDLE);
479 static struct sock *vmci_transport_get_pending(
480 struct sock *listener,
481 struct vmci_transport_packet *pkt)
483 struct vsock_sock *vlistener;
484 struct vsock_sock *vpending;
485 struct sock *pending;
486 struct sockaddr_vm src;
488 vsock_addr_init(&src, pkt->dg.src.context, pkt->src_port);
490 vlistener = vsock_sk(listener);
492 list_for_each_entry(vpending, &vlistener->pending_links,
494 if (vsock_addr_equals_addr(&src, &vpending->remote_addr) &&
495 pkt->dst_port == vpending->local_addr.svm_port) {
496 pending = sk_vsock(vpending);
508 static void vmci_transport_release_pending(struct sock *pending)
513 /* We allow two kinds of sockets to communicate with a restricted VM: 1)
514 * trusted sockets 2) sockets from applications running as the same user as the
515 * VM (this is only true for the host side and only when using hosted products)
518 static bool vmci_transport_is_trusted(struct vsock_sock *vsock, u32 peer_cid)
520 return vsock->trusted ||
521 vmci_is_context_owner(peer_cid, vsock->owner->uid);
524 /* We allow sending datagrams to and receiving datagrams from a restricted VM
525 * only if it is trusted as described in vmci_transport_is_trusted.
528 static bool vmci_transport_allow_dgram(struct vsock_sock *vsock, u32 peer_cid)
530 if (VMADDR_CID_HYPERVISOR == peer_cid)
533 if (vsock->cached_peer != peer_cid) {
534 vsock->cached_peer = peer_cid;
535 if (!vmci_transport_is_trusted(vsock, peer_cid) &&
536 (vmci_context_get_priv_flags(peer_cid) &
537 VMCI_PRIVILEGE_FLAG_RESTRICTED)) {
538 vsock->cached_peer_allow_dgram = false;
540 vsock->cached_peer_allow_dgram = true;
544 return vsock->cached_peer_allow_dgram;
548 vmci_transport_queue_pair_alloc(struct vmci_qp **qpair,
549 struct vmci_handle *handle,
552 u32 peer, u32 flags, bool trusted)
557 /* Try to allocate our queue pair as trusted. This will only
558 * work if vsock is running in the host.
561 err = vmci_qpair_alloc(qpair, handle, produce_size,
564 VMCI_PRIVILEGE_FLAG_TRUSTED);
565 if (err != VMCI_ERROR_NO_ACCESS)
570 err = vmci_qpair_alloc(qpair, handle, produce_size, consume_size,
571 peer, flags, VMCI_NO_PRIVILEGE_FLAGS);
574 pr_err("Could not attach to queue pair with %d\n",
576 err = vmci_transport_error_to_vsock_error(err);
583 vmci_transport_datagram_create_hnd(u32 resource_id,
585 vmci_datagram_recv_cb recv_cb,
587 struct vmci_handle *out_handle)
591 /* Try to allocate our datagram handler as trusted. This will only work
592 * if vsock is running in the host.
595 err = vmci_datagram_create_handle_priv(resource_id, flags,
596 VMCI_PRIVILEGE_FLAG_TRUSTED,
598 client_data, out_handle);
600 if (err == VMCI_ERROR_NO_ACCESS)
601 err = vmci_datagram_create_handle(resource_id, flags,
602 recv_cb, client_data,
608 /* This is invoked as part of a tasklet that's scheduled when the VMCI
609 * interrupt fires. This is run in bottom-half context and if it ever needs to
610 * sleep it should defer that work to a work queue.
613 static int vmci_transport_recv_dgram_cb(void *data, struct vmci_datagram *dg)
618 struct vsock_sock *vsk;
620 sk = (struct sock *)data;
622 /* This handler is privileged when this module is running on the host.
623 * We will get datagrams from all endpoints (even VMs that are in a
624 * restricted context). If we get one from a restricted context then
625 * the destination socket must be trusted.
627 * NOTE: We access the socket struct without holding the lock here.
628 * This is ok because the field we are interested is never modified
629 * outside of the create and destruct socket functions.
632 if (!vmci_transport_allow_dgram(vsk, dg->src.context))
633 return VMCI_ERROR_NO_ACCESS;
635 size = VMCI_DG_SIZE(dg);
637 /* Attach the packet to the socket's receive queue as an sk_buff. */
638 skb = alloc_skb(size, GFP_ATOMIC);
640 return VMCI_ERROR_NO_MEM;
642 /* sk_receive_skb() will do a sock_put(), so hold here. */
645 memcpy(skb->data, dg, size);
646 sk_receive_skb(sk, skb, 0);
651 static bool vmci_transport_stream_allow(u32 cid, u32 port)
653 static const u32 non_socket_contexts[] = {
658 BUILD_BUG_ON(sizeof(cid) != sizeof(*non_socket_contexts));
660 for (i = 0; i < ARRAY_SIZE(non_socket_contexts); i++) {
661 if (cid == non_socket_contexts[i])
668 /* This is invoked as part of a tasklet that's scheduled when the VMCI
669 * interrupt fires. This is run in bottom-half context but it defers most of
670 * its work to the packet handling work queue.
673 static int vmci_transport_recv_stream_cb(void *data, struct vmci_datagram *dg)
676 struct sockaddr_vm dst;
677 struct sockaddr_vm src;
678 struct vmci_transport_packet *pkt;
679 struct vsock_sock *vsk;
685 bh_process_pkt = false;
687 /* Ignore incoming packets from contexts without sockets, or resources
688 * that aren't vsock implementations.
691 if (!vmci_transport_stream_allow(dg->src.context, -1)
692 || vmci_transport_peer_rid(dg->src.context) != dg->src.resource)
693 return VMCI_ERROR_NO_ACCESS;
695 if (VMCI_DG_SIZE(dg) < sizeof(*pkt))
696 /* Drop datagrams that do not contain full VSock packets. */
697 return VMCI_ERROR_INVALID_ARGS;
699 pkt = (struct vmci_transport_packet *)dg;
701 /* Find the socket that should handle this packet. First we look for a
702 * connected socket and if there is none we look for a socket bound to
703 * the destintation address.
705 vsock_addr_init(&src, pkt->dg.src.context, pkt->src_port);
706 vsock_addr_init(&dst, pkt->dg.dst.context, pkt->dst_port);
708 sk = vsock_find_connected_socket(&src, &dst);
710 sk = vsock_find_bound_socket(&dst);
712 /* We could not find a socket for this specified
713 * address. If this packet is a RST, we just drop it.
714 * If it is another packet, we send a RST. Note that
715 * we do not send a RST reply to RSTs so that we do not
716 * continually send RSTs between two endpoints.
718 * Note that since this is a reply, dst is src and src
721 if (vmci_transport_send_reset_bh(&dst, &src, pkt) < 0)
722 pr_err("unable to send reset\n");
724 err = VMCI_ERROR_NOT_FOUND;
729 /* If the received packet type is beyond all types known to this
730 * implementation, reply with an invalid message. Hopefully this will
731 * help when implementing backwards compatibility in the future.
733 if (pkt->type >= VMCI_TRANSPORT_PACKET_TYPE_MAX) {
734 vmci_transport_send_invalid_bh(&dst, &src);
735 err = VMCI_ERROR_INVALID_ARGS;
739 /* This handler is privileged when this module is running on the host.
740 * We will get datagram connect requests from all endpoints (even VMs
741 * that are in a restricted context). If we get one from a restricted
742 * context then the destination socket must be trusted.
744 * NOTE: We access the socket struct without holding the lock here.
745 * This is ok because the field we are interested is never modified
746 * outside of the create and destruct socket functions.
749 if (!vmci_transport_allow_dgram(vsk, pkt->dg.src.context)) {
750 err = VMCI_ERROR_NO_ACCESS;
754 /* We do most everything in a work queue, but let's fast path the
755 * notification of reads and writes to help data transfer performance.
756 * We can only do this if there is no process context code executing
757 * for this socket since that may change the state.
761 if (!sock_owned_by_user(sk)) {
762 /* The local context ID may be out of date, update it. */
763 vsk->local_addr.svm_cid = dst.svm_cid;
765 if (sk->sk_state == TCP_ESTABLISHED)
766 vmci_trans(vsk)->notify_ops->handle_notify_pkt(
767 sk, pkt, true, &dst, &src,
773 if (!bh_process_pkt) {
774 struct vmci_transport_recv_pkt_info *recv_pkt_info;
776 recv_pkt_info = kmalloc(sizeof(*recv_pkt_info), GFP_ATOMIC);
777 if (!recv_pkt_info) {
778 if (vmci_transport_send_reset_bh(&dst, &src, pkt) < 0)
779 pr_err("unable to send reset\n");
781 err = VMCI_ERROR_NO_MEM;
785 recv_pkt_info->sk = sk;
786 memcpy(&recv_pkt_info->pkt, pkt, sizeof(recv_pkt_info->pkt));
787 INIT_WORK(&recv_pkt_info->work, vmci_transport_recv_pkt_work);
789 schedule_work(&recv_pkt_info->work);
790 /* Clear sk so that the reference count incremented by one of
791 * the Find functions above is not decremented below. We need
792 * that reference count for the packet handler we've scheduled
805 static void vmci_transport_handle_detach(struct sock *sk)
807 struct vsock_sock *vsk;
810 if (!vmci_handle_is_invalid(vmci_trans(vsk)->qp_handle)) {
811 sock_set_flag(sk, SOCK_DONE);
813 /* On a detach the peer will not be sending or receiving
816 vsk->peer_shutdown = SHUTDOWN_MASK;
818 /* We should not be sending anymore since the peer won't be
819 * there to receive, but we can still receive if there is data
820 * left in our consume queue. If the local endpoint is a host,
821 * we can't call vsock_stream_has_data, since that may block,
822 * but a host endpoint can't read data once the VM has
823 * detached, so there is no available data in that case.
825 if (vsk->local_addr.svm_cid == VMADDR_CID_HOST ||
826 vsock_stream_has_data(vsk) <= 0) {
827 if (sk->sk_state == TCP_SYN_SENT) {
828 /* The peer may detach from a queue pair while
829 * we are still in the connecting state, i.e.,
830 * if the peer VM is killed after attaching to
831 * a queue pair, but before we complete the
832 * handshake. In that case, we treat the detach
833 * event like a reset.
836 sk->sk_state = TCP_CLOSE;
837 sk->sk_err = ECONNRESET;
838 sk->sk_error_report(sk);
841 sk->sk_state = TCP_CLOSE;
843 sk->sk_state_change(sk);
847 static void vmci_transport_peer_detach_cb(u32 sub_id,
848 const struct vmci_event_data *e_data,
851 struct vmci_transport *trans = client_data;
852 const struct vmci_event_payload_qp *e_payload;
854 e_payload = vmci_event_data_const_payload(e_data);
856 /* XXX This is lame, we should provide a way to lookup sockets by
859 if (vmci_handle_is_invalid(e_payload->handle) ||
860 !vmci_handle_is_equal(trans->qp_handle, e_payload->handle))
863 /* We don't ask for delayed CBs when we subscribe to this event (we
864 * pass 0 as flags to vmci_event_subscribe()). VMCI makes no
865 * guarantees in that case about what context we might be running in,
866 * so it could be BH or process, blockable or non-blockable. So we
867 * need to account for all possible contexts here.
869 spin_lock_bh(&trans->lock);
873 /* Apart from here, trans->lock is only grabbed as part of sk destruct,
874 * where trans->sk isn't locked.
876 bh_lock_sock(trans->sk);
878 vmci_transport_handle_detach(trans->sk);
880 bh_unlock_sock(trans->sk);
882 spin_unlock_bh(&trans->lock);
885 static void vmci_transport_qp_resumed_cb(u32 sub_id,
886 const struct vmci_event_data *e_data,
889 vsock_for_each_connected_socket(vmci_transport_handle_detach);
892 static void vmci_transport_recv_pkt_work(struct work_struct *work)
894 struct vmci_transport_recv_pkt_info *recv_pkt_info;
895 struct vmci_transport_packet *pkt;
899 container_of(work, struct vmci_transport_recv_pkt_info, work);
900 sk = recv_pkt_info->sk;
901 pkt = &recv_pkt_info->pkt;
905 /* The local context ID may be out of date. */
906 vsock_sk(sk)->local_addr.svm_cid = pkt->dg.dst.context;
908 switch (sk->sk_state) {
910 vmci_transport_recv_listen(sk, pkt);
913 /* Processing of pending connections for servers goes through
914 * the listening socket, so see vmci_transport_recv_listen()
917 vmci_transport_recv_connecting_client(sk, pkt);
919 case TCP_ESTABLISHED:
920 vmci_transport_recv_connected(sk, pkt);
923 /* Because this function does not run in the same context as
924 * vmci_transport_recv_stream_cb it is possible that the
925 * socket has closed. We need to let the other side know or it
926 * could be sitting in a connect and hang forever. Send a
927 * reset to prevent that.
929 vmci_transport_send_reset(sk, pkt);
934 kfree(recv_pkt_info);
935 /* Release reference obtained in the stream callback when we fetched
936 * this socket out of the bound or connected list.
941 static int vmci_transport_recv_listen(struct sock *sk,
942 struct vmci_transport_packet *pkt)
944 struct sock *pending;
945 struct vsock_sock *vpending;
948 bool old_request = false;
949 bool old_pkt_proto = false;
953 /* Because we are in the listen state, we could be receiving a packet
954 * for ourself or any previous connection requests that we received.
955 * If it's the latter, we try to find a socket in our list of pending
956 * connections and, if we do, call the appropriate handler for the
957 * state that that socket is in. Otherwise we try to service the
958 * connection request.
960 pending = vmci_transport_get_pending(sk, pkt);
964 /* The local context ID may be out of date. */
965 vsock_sk(pending)->local_addr.svm_cid = pkt->dg.dst.context;
967 switch (pending->sk_state) {
969 err = vmci_transport_recv_connecting_server(sk,
974 vmci_transport_send_reset(pending, pkt);
979 vsock_remove_pending(sk, pending);
981 release_sock(pending);
982 vmci_transport_release_pending(pending);
987 /* The listen state only accepts connection requests. Reply with a
988 * reset unless we received a reset.
991 if (!(pkt->type == VMCI_TRANSPORT_PACKET_TYPE_REQUEST ||
992 pkt->type == VMCI_TRANSPORT_PACKET_TYPE_REQUEST2)) {
993 vmci_transport_reply_reset(pkt);
997 if (pkt->u.size == 0) {
998 vmci_transport_reply_reset(pkt);
1002 /* If this socket can't accommodate this connection request, we send a
1003 * reset. Otherwise we create and initialize a child socket and reply
1004 * with a connection negotiation.
1006 if (sk->sk_ack_backlog >= sk->sk_max_ack_backlog) {
1007 vmci_transport_reply_reset(pkt);
1008 return -ECONNREFUSED;
1011 pending = __vsock_create(sock_net(sk), NULL, sk, GFP_KERNEL,
1014 vmci_transport_send_reset(sk, pkt);
1018 vpending = vsock_sk(pending);
1020 vsock_addr_init(&vpending->local_addr, pkt->dg.dst.context,
1022 vsock_addr_init(&vpending->remote_addr, pkt->dg.src.context,
1025 /* If the proposed size fits within our min/max, accept it. Otherwise
1026 * propose our own size.
1028 if (pkt->u.size >= vmci_trans(vpending)->queue_pair_min_size &&
1029 pkt->u.size <= vmci_trans(vpending)->queue_pair_max_size) {
1030 qp_size = pkt->u.size;
1032 qp_size = vmci_trans(vpending)->queue_pair_size;
1035 /* Figure out if we are using old or new requests based on the
1036 * overrides pkt types sent by our peer.
1038 if (vmci_transport_old_proto_override(&old_pkt_proto)) {
1039 old_request = old_pkt_proto;
1041 if (pkt->type == VMCI_TRANSPORT_PACKET_TYPE_REQUEST)
1043 else if (pkt->type == VMCI_TRANSPORT_PACKET_TYPE_REQUEST2)
1044 old_request = false;
1049 /* Handle a REQUEST (or override) */
1050 u16 version = VSOCK_PROTO_INVALID;
1051 if (vmci_transport_proto_to_notify_struct(
1052 pending, &version, true))
1053 err = vmci_transport_send_negotiate(pending, qp_size);
1058 /* Handle a REQUEST2 (or override) */
1059 int proto_int = pkt->proto;
1061 u16 active_proto_version = 0;
1063 /* The list of possible protocols is the intersection of all
1064 * protocols the client supports ... plus all the protocols we
1067 proto_int &= vmci_transport_new_proto_supported_versions();
1069 /* We choose the highest possible protocol version and use that
1072 pos = fls(proto_int);
1074 active_proto_version = (1 << (pos - 1));
1075 if (vmci_transport_proto_to_notify_struct(
1076 pending, &active_proto_version, false))
1077 err = vmci_transport_send_negotiate2(pending,
1079 active_proto_version);
1089 vmci_transport_send_reset(sk, pkt);
1091 err = vmci_transport_error_to_vsock_error(err);
1095 vsock_add_pending(sk, pending);
1096 sk_acceptq_added(sk);
1098 pending->sk_state = TCP_SYN_SENT;
1099 vmci_trans(vpending)->produce_size =
1100 vmci_trans(vpending)->consume_size = qp_size;
1101 vmci_trans(vpending)->queue_pair_size = qp_size;
1103 vmci_trans(vpending)->notify_ops->process_request(pending);
1105 /* We might never receive another message for this socket and it's not
1106 * connected to any process, so we have to ensure it gets cleaned up
1107 * ourself. Our delayed work function will take care of that. Note
1108 * that we do not ever cancel this function since we have few
1109 * guarantees about its state when calling cancel_delayed_work().
1110 * Instead we hold a reference on the socket for that function and make
1111 * it capable of handling cases where it needs to do nothing but
1112 * release that reference.
1114 vpending->listener = sk;
1117 schedule_delayed_work(&vpending->pending_work, HZ);
1124 vmci_transport_recv_connecting_server(struct sock *listener,
1125 struct sock *pending,
1126 struct vmci_transport_packet *pkt)
1128 struct vsock_sock *vpending;
1129 struct vmci_handle handle;
1130 struct vmci_qp *qpair;
1137 vpending = vsock_sk(pending);
1138 detach_sub_id = VMCI_INVALID_ID;
1140 switch (pkt->type) {
1141 case VMCI_TRANSPORT_PACKET_TYPE_OFFER:
1142 if (vmci_handle_is_invalid(pkt->u.handle)) {
1143 vmci_transport_send_reset(pending, pkt);
1150 /* Close and cleanup the connection. */
1151 vmci_transport_send_reset(pending, pkt);
1153 err = pkt->type == VMCI_TRANSPORT_PACKET_TYPE_RST ? 0 : -EINVAL;
1157 /* In order to complete the connection we need to attach to the offered
1158 * queue pair and send an attach notification. We also subscribe to the
1159 * detach event so we know when our peer goes away, and we do that
1160 * before attaching so we don't miss an event. If all this succeeds,
1161 * we update our state and wakeup anything waiting in accept() for a
1165 /* We don't care about attach since we ensure the other side has
1166 * attached by specifying the ATTACH_ONLY flag below.
1168 err = vmci_event_subscribe(VMCI_EVENT_QP_PEER_DETACH,
1169 vmci_transport_peer_detach_cb,
1170 vmci_trans(vpending), &detach_sub_id);
1171 if (err < VMCI_SUCCESS) {
1172 vmci_transport_send_reset(pending, pkt);
1173 err = vmci_transport_error_to_vsock_error(err);
1178 vmci_trans(vpending)->detach_sub_id = detach_sub_id;
1180 /* Now attach to the queue pair the client created. */
1181 handle = pkt->u.handle;
1183 /* vpending->local_addr always has a context id so we do not need to
1184 * worry about VMADDR_CID_ANY in this case.
1187 vpending->remote_addr.svm_cid == vpending->local_addr.svm_cid;
1188 flags = VMCI_QPFLAG_ATTACH_ONLY;
1189 flags |= is_local ? VMCI_QPFLAG_LOCAL : 0;
1191 err = vmci_transport_queue_pair_alloc(
1194 vmci_trans(vpending)->produce_size,
1195 vmci_trans(vpending)->consume_size,
1196 pkt->dg.src.context,
1198 vmci_transport_is_trusted(
1200 vpending->remote_addr.svm_cid));
1202 vmci_transport_send_reset(pending, pkt);
1207 vmci_trans(vpending)->qp_handle = handle;
1208 vmci_trans(vpending)->qpair = qpair;
1210 /* When we send the attach message, we must be ready to handle incoming
1211 * control messages on the newly connected socket. So we move the
1212 * pending socket to the connected state before sending the attach
1213 * message. Otherwise, an incoming packet triggered by the attach being
1214 * received by the peer may be processed concurrently with what happens
1215 * below after sending the attach message, and that incoming packet
1216 * will find the listening socket instead of the (currently) pending
1217 * socket. Note that enqueueing the socket increments the reference
1218 * count, so even if a reset comes before the connection is accepted,
1219 * the socket will be valid until it is removed from the queue.
1221 * If we fail sending the attach below, we remove the socket from the
1222 * connected list and move the socket to TCP_CLOSE before
1223 * releasing the lock, so a pending slow path processing of an incoming
1224 * packet will not see the socket in the connected state in that case.
1226 pending->sk_state = TCP_ESTABLISHED;
1228 vsock_insert_connected(vpending);
1230 /* Notify our peer of our attach. */
1231 err = vmci_transport_send_attach(pending, handle);
1233 vsock_remove_connected(vpending);
1234 pr_err("Could not send attach\n");
1235 vmci_transport_send_reset(pending, pkt);
1236 err = vmci_transport_error_to_vsock_error(err);
1241 /* We have a connection. Move the now connected socket from the
1242 * listener's pending list to the accept queue so callers of accept()
1245 vsock_remove_pending(listener, pending);
1246 vsock_enqueue_accept(listener, pending);
1248 /* Callers of accept() will be be waiting on the listening socket, not
1249 * the pending socket.
1251 listener->sk_data_ready(listener);
1256 pending->sk_err = skerr;
1257 pending->sk_state = TCP_CLOSE;
1258 /* As long as we drop our reference, all necessary cleanup will handle
1259 * when the cleanup function drops its reference and our destruct
1260 * implementation is called. Note that since the listen handler will
1261 * remove pending from the pending list upon our failure, the cleanup
1262 * function won't drop the additional reference, which is why we do it
1271 vmci_transport_recv_connecting_client(struct sock *sk,
1272 struct vmci_transport_packet *pkt)
1274 struct vsock_sock *vsk;
1280 switch (pkt->type) {
1281 case VMCI_TRANSPORT_PACKET_TYPE_ATTACH:
1282 if (vmci_handle_is_invalid(pkt->u.handle) ||
1283 !vmci_handle_is_equal(pkt->u.handle,
1284 vmci_trans(vsk)->qp_handle)) {
1290 /* Signify the socket is connected and wakeup the waiter in
1291 * connect(). Also place the socket in the connected table for
1292 * accounting (it can already be found since it's in the bound
1295 sk->sk_state = TCP_ESTABLISHED;
1296 sk->sk_socket->state = SS_CONNECTED;
1297 vsock_insert_connected(vsk);
1298 sk->sk_state_change(sk);
1301 case VMCI_TRANSPORT_PACKET_TYPE_NEGOTIATE:
1302 case VMCI_TRANSPORT_PACKET_TYPE_NEGOTIATE2:
1303 if (pkt->u.size == 0
1304 || pkt->dg.src.context != vsk->remote_addr.svm_cid
1305 || pkt->src_port != vsk->remote_addr.svm_port
1306 || !vmci_handle_is_invalid(vmci_trans(vsk)->qp_handle)
1307 || vmci_trans(vsk)->qpair
1308 || vmci_trans(vsk)->produce_size != 0
1309 || vmci_trans(vsk)->consume_size != 0
1310 || vmci_trans(vsk)->detach_sub_id != VMCI_INVALID_ID) {
1317 err = vmci_transport_recv_connecting_client_negotiate(sk, pkt);
1324 case VMCI_TRANSPORT_PACKET_TYPE_INVALID:
1325 err = vmci_transport_recv_connecting_client_invalid(sk, pkt);
1332 case VMCI_TRANSPORT_PACKET_TYPE_RST:
1333 /* Older versions of the linux code (WS 6.5 / ESX 4.0) used to
1334 * continue processing here after they sent an INVALID packet.
1335 * This meant that we got a RST after the INVALID. We ignore a
1336 * RST after an INVALID. The common code doesn't send the RST
1337 * ... so we can hang if an old version of the common code
1338 * fails between getting a REQUEST and sending an OFFER back.
1339 * Not much we can do about it... except hope that it doesn't
1342 if (vsk->ignore_connecting_rst) {
1343 vsk->ignore_connecting_rst = false;
1352 /* Close and cleanup the connection. */
1361 vmci_transport_send_reset(sk, pkt);
1363 sk->sk_state = TCP_CLOSE;
1365 sk->sk_error_report(sk);
1369 static int vmci_transport_recv_connecting_client_negotiate(
1371 struct vmci_transport_packet *pkt)
1374 struct vsock_sock *vsk;
1375 struct vmci_handle handle;
1376 struct vmci_qp *qpair;
1380 bool old_proto = true;
1385 handle = VMCI_INVALID_HANDLE;
1386 detach_sub_id = VMCI_INVALID_ID;
1388 /* If we have gotten here then we should be past the point where old
1389 * linux vsock could have sent the bogus rst.
1391 vsk->sent_request = false;
1392 vsk->ignore_connecting_rst = false;
1394 /* Verify that we're OK with the proposed queue pair size */
1395 if (pkt->u.size < vmci_trans(vsk)->queue_pair_min_size ||
1396 pkt->u.size > vmci_trans(vsk)->queue_pair_max_size) {
1401 /* At this point we know the CID the peer is using to talk to us. */
1403 if (vsk->local_addr.svm_cid == VMADDR_CID_ANY)
1404 vsk->local_addr.svm_cid = pkt->dg.dst.context;
1406 /* Setup the notify ops to be the highest supported version that both
1407 * the server and the client support.
1410 if (vmci_transport_old_proto_override(&old_pkt_proto)) {
1411 old_proto = old_pkt_proto;
1413 if (pkt->type == VMCI_TRANSPORT_PACKET_TYPE_NEGOTIATE)
1415 else if (pkt->type == VMCI_TRANSPORT_PACKET_TYPE_NEGOTIATE2)
1421 version = VSOCK_PROTO_INVALID;
1423 version = pkt->proto;
1425 if (!vmci_transport_proto_to_notify_struct(sk, &version, old_proto)) {
1430 /* Subscribe to detach events first.
1432 * XXX We attach once for each queue pair created for now so it is easy
1433 * to find the socket (it's provided), but later we should only
1434 * subscribe once and add a way to lookup sockets by queue pair handle.
1436 err = vmci_event_subscribe(VMCI_EVENT_QP_PEER_DETACH,
1437 vmci_transport_peer_detach_cb,
1438 vmci_trans(vsk), &detach_sub_id);
1439 if (err < VMCI_SUCCESS) {
1440 err = vmci_transport_error_to_vsock_error(err);
1444 /* Make VMCI select the handle for us. */
1445 handle = VMCI_INVALID_HANDLE;
1446 is_local = vsk->remote_addr.svm_cid == vsk->local_addr.svm_cid;
1447 flags = is_local ? VMCI_QPFLAG_LOCAL : 0;
1449 err = vmci_transport_queue_pair_alloc(&qpair,
1453 vsk->remote_addr.svm_cid,
1455 vmci_transport_is_trusted(
1458 remote_addr.svm_cid));
1462 err = vmci_transport_send_qp_offer(sk, handle);
1464 err = vmci_transport_error_to_vsock_error(err);
1468 vmci_trans(vsk)->qp_handle = handle;
1469 vmci_trans(vsk)->qpair = qpair;
1471 vmci_trans(vsk)->produce_size = vmci_trans(vsk)->consume_size =
1474 vmci_trans(vsk)->detach_sub_id = detach_sub_id;
1476 vmci_trans(vsk)->notify_ops->process_negotiate(sk);
1481 if (detach_sub_id != VMCI_INVALID_ID)
1482 vmci_event_unsubscribe(detach_sub_id);
1484 if (!vmci_handle_is_invalid(handle))
1485 vmci_qpair_detach(&qpair);
1491 vmci_transport_recv_connecting_client_invalid(struct sock *sk,
1492 struct vmci_transport_packet *pkt)
1495 struct vsock_sock *vsk = vsock_sk(sk);
1497 if (vsk->sent_request) {
1498 vsk->sent_request = false;
1499 vsk->ignore_connecting_rst = true;
1501 err = vmci_transport_send_conn_request(
1502 sk, vmci_trans(vsk)->queue_pair_size);
1504 err = vmci_transport_error_to_vsock_error(err);
1513 static int vmci_transport_recv_connected(struct sock *sk,
1514 struct vmci_transport_packet *pkt)
1516 struct vsock_sock *vsk;
1517 bool pkt_processed = false;
1519 /* In cases where we are closing the connection, it's sufficient to
1520 * mark the state change (and maybe error) and wake up any waiting
1521 * threads. Since this is a connected socket, it's owned by a user
1522 * process and will be cleaned up when the failure is passed back on
1523 * the current or next system call. Our system call implementations
1524 * must therefore check for error and state changes on entry and when
1527 switch (pkt->type) {
1528 case VMCI_TRANSPORT_PACKET_TYPE_SHUTDOWN:
1532 vsk->peer_shutdown |= pkt->u.mode;
1533 sk->sk_state_change(sk);
1537 case VMCI_TRANSPORT_PACKET_TYPE_RST:
1539 /* It is possible that we sent our peer a message (e.g a
1540 * WAITING_READ) right before we got notified that the peer had
1541 * detached. If that happens then we can get a RST pkt back
1542 * from our peer even though there is data available for us to
1543 * read. In that case, don't shutdown the socket completely but
1544 * instead allow the local client to finish reading data off
1545 * the queuepair. Always treat a RST pkt in connected mode like
1548 sock_set_flag(sk, SOCK_DONE);
1549 vsk->peer_shutdown = SHUTDOWN_MASK;
1550 if (vsock_stream_has_data(vsk) <= 0)
1551 sk->sk_state = TCP_CLOSING;
1553 sk->sk_state_change(sk);
1558 vmci_trans(vsk)->notify_ops->handle_notify_pkt(
1559 sk, pkt, false, NULL, NULL,
1570 static int vmci_transport_socket_init(struct vsock_sock *vsk,
1571 struct vsock_sock *psk)
1573 vsk->trans = kmalloc(sizeof(struct vmci_transport), GFP_KERNEL);
1577 vmci_trans(vsk)->dg_handle = VMCI_INVALID_HANDLE;
1578 vmci_trans(vsk)->qp_handle = VMCI_INVALID_HANDLE;
1579 vmci_trans(vsk)->qpair = NULL;
1580 vmci_trans(vsk)->produce_size = vmci_trans(vsk)->consume_size = 0;
1581 vmci_trans(vsk)->detach_sub_id = VMCI_INVALID_ID;
1582 vmci_trans(vsk)->notify_ops = NULL;
1583 INIT_LIST_HEAD(&vmci_trans(vsk)->elem);
1584 vmci_trans(vsk)->sk = &vsk->sk;
1585 spin_lock_init(&vmci_trans(vsk)->lock);
1587 vmci_trans(vsk)->queue_pair_size =
1588 vmci_trans(psk)->queue_pair_size;
1589 vmci_trans(vsk)->queue_pair_min_size =
1590 vmci_trans(psk)->queue_pair_min_size;
1591 vmci_trans(vsk)->queue_pair_max_size =
1592 vmci_trans(psk)->queue_pair_max_size;
1594 vmci_trans(vsk)->queue_pair_size =
1595 VMCI_TRANSPORT_DEFAULT_QP_SIZE;
1596 vmci_trans(vsk)->queue_pair_min_size =
1597 VMCI_TRANSPORT_DEFAULT_QP_SIZE_MIN;
1598 vmci_trans(vsk)->queue_pair_max_size =
1599 VMCI_TRANSPORT_DEFAULT_QP_SIZE_MAX;
1605 static void vmci_transport_free_resources(struct list_head *transport_list)
1607 while (!list_empty(transport_list)) {
1608 struct vmci_transport *transport =
1609 list_first_entry(transport_list, struct vmci_transport,
1611 list_del(&transport->elem);
1613 if (transport->detach_sub_id != VMCI_INVALID_ID) {
1614 vmci_event_unsubscribe(transport->detach_sub_id);
1615 transport->detach_sub_id = VMCI_INVALID_ID;
1618 if (!vmci_handle_is_invalid(transport->qp_handle)) {
1619 vmci_qpair_detach(&transport->qpair);
1620 transport->qp_handle = VMCI_INVALID_HANDLE;
1621 transport->produce_size = 0;
1622 transport->consume_size = 0;
1629 static void vmci_transport_cleanup(struct work_struct *work)
1633 spin_lock_bh(&vmci_transport_cleanup_lock);
1634 list_replace_init(&vmci_transport_cleanup_list, &pending);
1635 spin_unlock_bh(&vmci_transport_cleanup_lock);
1636 vmci_transport_free_resources(&pending);
1639 static void vmci_transport_destruct(struct vsock_sock *vsk)
1641 /* transport can be NULL if we hit a failure at init() time */
1642 if (!vmci_trans(vsk))
1645 /* Ensure that the detach callback doesn't use the sk/vsk
1646 * we are about to destruct.
1648 spin_lock_bh(&vmci_trans(vsk)->lock);
1649 vmci_trans(vsk)->sk = NULL;
1650 spin_unlock_bh(&vmci_trans(vsk)->lock);
1652 if (vmci_trans(vsk)->notify_ops)
1653 vmci_trans(vsk)->notify_ops->socket_destruct(vsk);
1655 spin_lock_bh(&vmci_transport_cleanup_lock);
1656 list_add(&vmci_trans(vsk)->elem, &vmci_transport_cleanup_list);
1657 spin_unlock_bh(&vmci_transport_cleanup_lock);
1658 schedule_work(&vmci_transport_cleanup_work);
1663 static void vmci_transport_release(struct vsock_sock *vsk)
1665 vsock_remove_sock(vsk);
1667 if (!vmci_handle_is_invalid(vmci_trans(vsk)->dg_handle)) {
1668 vmci_datagram_destroy_handle(vmci_trans(vsk)->dg_handle);
1669 vmci_trans(vsk)->dg_handle = VMCI_INVALID_HANDLE;
1673 static int vmci_transport_dgram_bind(struct vsock_sock *vsk,
1674 struct sockaddr_vm *addr)
1680 /* VMCI will select a resource ID for us if we provide
1683 port = addr->svm_port == VMADDR_PORT_ANY ?
1684 VMCI_INVALID_ID : addr->svm_port;
1686 if (port <= LAST_RESERVED_PORT && !capable(CAP_NET_BIND_SERVICE))
1689 flags = addr->svm_cid == VMADDR_CID_ANY ?
1690 VMCI_FLAG_ANYCID_DG_HND : 0;
1692 err = vmci_transport_datagram_create_hnd(port, flags,
1693 vmci_transport_recv_dgram_cb,
1695 &vmci_trans(vsk)->dg_handle);
1696 if (err < VMCI_SUCCESS)
1697 return vmci_transport_error_to_vsock_error(err);
1698 vsock_addr_init(&vsk->local_addr, addr->svm_cid,
1699 vmci_trans(vsk)->dg_handle.resource);
1704 static int vmci_transport_dgram_enqueue(
1705 struct vsock_sock *vsk,
1706 struct sockaddr_vm *remote_addr,
1711 struct vmci_datagram *dg;
1713 if (len > VMCI_MAX_DG_PAYLOAD_SIZE)
1716 if (!vmci_transport_allow_dgram(vsk, remote_addr->svm_cid))
1719 /* Allocate a buffer for the user's message and our packet header. */
1720 dg = kmalloc(len + sizeof(*dg), GFP_KERNEL);
1724 memcpy_from_msg(VMCI_DG_PAYLOAD(dg), msg, len);
1726 dg->dst = vmci_make_handle(remote_addr->svm_cid,
1727 remote_addr->svm_port);
1728 dg->src = vmci_make_handle(vsk->local_addr.svm_cid,
1729 vsk->local_addr.svm_port);
1730 dg->payload_size = len;
1732 err = vmci_datagram_send(dg);
1735 return vmci_transport_error_to_vsock_error(err);
1737 return err - sizeof(*dg);
1740 static int vmci_transport_dgram_dequeue(struct vsock_sock *vsk,
1741 struct msghdr *msg, size_t len,
1746 struct vmci_datagram *dg;
1748 struct sk_buff *skb;
1750 noblock = flags & MSG_DONTWAIT;
1752 if (flags & MSG_OOB || flags & MSG_ERRQUEUE)
1755 /* Retrieve the head sk_buff from the socket's receive queue. */
1757 skb = skb_recv_datagram(&vsk->sk, flags, noblock, &err);
1761 dg = (struct vmci_datagram *)skb->data;
1763 /* err is 0, meaning we read zero bytes. */
1766 payload_len = dg->payload_size;
1767 /* Ensure the sk_buff matches the payload size claimed in the packet. */
1768 if (payload_len != skb->len - sizeof(*dg)) {
1773 if (payload_len > len) {
1775 msg->msg_flags |= MSG_TRUNC;
1778 /* Place the datagram payload in the user's iovec. */
1779 err = skb_copy_datagram_msg(skb, sizeof(*dg), msg, payload_len);
1783 if (msg->msg_name) {
1784 /* Provide the address of the sender. */
1785 DECLARE_SOCKADDR(struct sockaddr_vm *, vm_addr, msg->msg_name);
1786 vsock_addr_init(vm_addr, dg->src.context, dg->src.resource);
1787 msg->msg_namelen = sizeof(*vm_addr);
1792 skb_free_datagram(&vsk->sk, skb);
1796 static bool vmci_transport_dgram_allow(u32 cid, u32 port)
1798 if (cid == VMADDR_CID_HYPERVISOR) {
1799 /* Registrations of PBRPC Servers do not modify VMX/Hypervisor
1800 * state and are allowed.
1802 return port == VMCI_UNITY_PBRPC_REGISTER;
1808 static int vmci_transport_connect(struct vsock_sock *vsk)
1811 bool old_pkt_proto = false;
1812 struct sock *sk = &vsk->sk;
1814 if (vmci_transport_old_proto_override(&old_pkt_proto) &&
1816 err = vmci_transport_send_conn_request(
1817 sk, vmci_trans(vsk)->queue_pair_size);
1819 sk->sk_state = TCP_CLOSE;
1823 int supported_proto_versions =
1824 vmci_transport_new_proto_supported_versions();
1825 err = vmci_transport_send_conn_request2(
1826 sk, vmci_trans(vsk)->queue_pair_size,
1827 supported_proto_versions);
1829 sk->sk_state = TCP_CLOSE;
1833 vsk->sent_request = true;
1839 static ssize_t vmci_transport_stream_dequeue(
1840 struct vsock_sock *vsk,
1845 if (flags & MSG_PEEK)
1846 return vmci_qpair_peekv(vmci_trans(vsk)->qpair, msg, len, 0);
1848 return vmci_qpair_dequev(vmci_trans(vsk)->qpair, msg, len, 0);
1851 static ssize_t vmci_transport_stream_enqueue(
1852 struct vsock_sock *vsk,
1856 return vmci_qpair_enquev(vmci_trans(vsk)->qpair, msg, len, 0);
1859 static s64 vmci_transport_stream_has_data(struct vsock_sock *vsk)
1861 return vmci_qpair_consume_buf_ready(vmci_trans(vsk)->qpair);
1864 static s64 vmci_transport_stream_has_space(struct vsock_sock *vsk)
1866 return vmci_qpair_produce_free_space(vmci_trans(vsk)->qpair);
1869 static u64 vmci_transport_stream_rcvhiwat(struct vsock_sock *vsk)
1871 return vmci_trans(vsk)->consume_size;
1874 static bool vmci_transport_stream_is_active(struct vsock_sock *vsk)
1876 return !vmci_handle_is_invalid(vmci_trans(vsk)->qp_handle);
1879 static u64 vmci_transport_get_buffer_size(struct vsock_sock *vsk)
1881 return vmci_trans(vsk)->queue_pair_size;
1884 static u64 vmci_transport_get_min_buffer_size(struct vsock_sock *vsk)
1886 return vmci_trans(vsk)->queue_pair_min_size;
1889 static u64 vmci_transport_get_max_buffer_size(struct vsock_sock *vsk)
1891 return vmci_trans(vsk)->queue_pair_max_size;
1894 static void vmci_transport_set_buffer_size(struct vsock_sock *vsk, u64 val)
1896 if (val < vmci_trans(vsk)->queue_pair_min_size)
1897 vmci_trans(vsk)->queue_pair_min_size = val;
1898 if (val > vmci_trans(vsk)->queue_pair_max_size)
1899 vmci_trans(vsk)->queue_pair_max_size = val;
1900 vmci_trans(vsk)->queue_pair_size = val;
1903 static void vmci_transport_set_min_buffer_size(struct vsock_sock *vsk,
1906 if (val > vmci_trans(vsk)->queue_pair_size)
1907 vmci_trans(vsk)->queue_pair_size = val;
1908 vmci_trans(vsk)->queue_pair_min_size = val;
1911 static void vmci_transport_set_max_buffer_size(struct vsock_sock *vsk,
1914 if (val < vmci_trans(vsk)->queue_pair_size)
1915 vmci_trans(vsk)->queue_pair_size = val;
1916 vmci_trans(vsk)->queue_pair_max_size = val;
1919 static int vmci_transport_notify_poll_in(
1920 struct vsock_sock *vsk,
1922 bool *data_ready_now)
1924 return vmci_trans(vsk)->notify_ops->poll_in(
1925 &vsk->sk, target, data_ready_now);
1928 static int vmci_transport_notify_poll_out(
1929 struct vsock_sock *vsk,
1931 bool *space_available_now)
1933 return vmci_trans(vsk)->notify_ops->poll_out(
1934 &vsk->sk, target, space_available_now);
1937 static int vmci_transport_notify_recv_init(
1938 struct vsock_sock *vsk,
1940 struct vsock_transport_recv_notify_data *data)
1942 return vmci_trans(vsk)->notify_ops->recv_init(
1944 (struct vmci_transport_recv_notify_data *)data);
1947 static int vmci_transport_notify_recv_pre_block(
1948 struct vsock_sock *vsk,
1950 struct vsock_transport_recv_notify_data *data)
1952 return vmci_trans(vsk)->notify_ops->recv_pre_block(
1954 (struct vmci_transport_recv_notify_data *)data);
1957 static int vmci_transport_notify_recv_pre_dequeue(
1958 struct vsock_sock *vsk,
1960 struct vsock_transport_recv_notify_data *data)
1962 return vmci_trans(vsk)->notify_ops->recv_pre_dequeue(
1964 (struct vmci_transport_recv_notify_data *)data);
1967 static int vmci_transport_notify_recv_post_dequeue(
1968 struct vsock_sock *vsk,
1972 struct vsock_transport_recv_notify_data *data)
1974 return vmci_trans(vsk)->notify_ops->recv_post_dequeue(
1975 &vsk->sk, target, copied, data_read,
1976 (struct vmci_transport_recv_notify_data *)data);
1979 static int vmci_transport_notify_send_init(
1980 struct vsock_sock *vsk,
1981 struct vsock_transport_send_notify_data *data)
1983 return vmci_trans(vsk)->notify_ops->send_init(
1985 (struct vmci_transport_send_notify_data *)data);
1988 static int vmci_transport_notify_send_pre_block(
1989 struct vsock_sock *vsk,
1990 struct vsock_transport_send_notify_data *data)
1992 return vmci_trans(vsk)->notify_ops->send_pre_block(
1994 (struct vmci_transport_send_notify_data *)data);
1997 static int vmci_transport_notify_send_pre_enqueue(
1998 struct vsock_sock *vsk,
1999 struct vsock_transport_send_notify_data *data)
2001 return vmci_trans(vsk)->notify_ops->send_pre_enqueue(
2003 (struct vmci_transport_send_notify_data *)data);
2006 static int vmci_transport_notify_send_post_enqueue(
2007 struct vsock_sock *vsk,
2009 struct vsock_transport_send_notify_data *data)
2011 return vmci_trans(vsk)->notify_ops->send_post_enqueue(
2013 (struct vmci_transport_send_notify_data *)data);
2016 static bool vmci_transport_old_proto_override(bool *old_pkt_proto)
2018 if (PROTOCOL_OVERRIDE != -1) {
2019 if (PROTOCOL_OVERRIDE == 0)
2020 *old_pkt_proto = true;
2022 *old_pkt_proto = false;
2024 pr_info("Proto override in use\n");
2031 static bool vmci_transport_proto_to_notify_struct(struct sock *sk,
2035 struct vsock_sock *vsk = vsock_sk(sk);
2037 if (old_pkt_proto) {
2038 if (*proto != VSOCK_PROTO_INVALID) {
2039 pr_err("Can't set both an old and new protocol\n");
2042 vmci_trans(vsk)->notify_ops = &vmci_transport_notify_pkt_ops;
2047 case VSOCK_PROTO_PKT_ON_NOTIFY:
2048 vmci_trans(vsk)->notify_ops =
2049 &vmci_transport_notify_pkt_q_state_ops;
2052 pr_err("Unknown notify protocol version\n");
2057 vmci_trans(vsk)->notify_ops->socket_init(sk);
2061 static u16 vmci_transport_new_proto_supported_versions(void)
2063 if (PROTOCOL_OVERRIDE != -1)
2064 return PROTOCOL_OVERRIDE;
2066 return VSOCK_PROTO_ALL_SUPPORTED;
2069 static u32 vmci_transport_get_local_cid(void)
2071 return vmci_get_context_id();
2074 static const struct vsock_transport vmci_transport = {
2075 .init = vmci_transport_socket_init,
2076 .destruct = vmci_transport_destruct,
2077 .release = vmci_transport_release,
2078 .connect = vmci_transport_connect,
2079 .dgram_bind = vmci_transport_dgram_bind,
2080 .dgram_dequeue = vmci_transport_dgram_dequeue,
2081 .dgram_enqueue = vmci_transport_dgram_enqueue,
2082 .dgram_allow = vmci_transport_dgram_allow,
2083 .stream_dequeue = vmci_transport_stream_dequeue,
2084 .stream_enqueue = vmci_transport_stream_enqueue,
2085 .stream_has_data = vmci_transport_stream_has_data,
2086 .stream_has_space = vmci_transport_stream_has_space,
2087 .stream_rcvhiwat = vmci_transport_stream_rcvhiwat,
2088 .stream_is_active = vmci_transport_stream_is_active,
2089 .stream_allow = vmci_transport_stream_allow,
2090 .notify_poll_in = vmci_transport_notify_poll_in,
2091 .notify_poll_out = vmci_transport_notify_poll_out,
2092 .notify_recv_init = vmci_transport_notify_recv_init,
2093 .notify_recv_pre_block = vmci_transport_notify_recv_pre_block,
2094 .notify_recv_pre_dequeue = vmci_transport_notify_recv_pre_dequeue,
2095 .notify_recv_post_dequeue = vmci_transport_notify_recv_post_dequeue,
2096 .notify_send_init = vmci_transport_notify_send_init,
2097 .notify_send_pre_block = vmci_transport_notify_send_pre_block,
2098 .notify_send_pre_enqueue = vmci_transport_notify_send_pre_enqueue,
2099 .notify_send_post_enqueue = vmci_transport_notify_send_post_enqueue,
2100 .shutdown = vmci_transport_shutdown,
2101 .set_buffer_size = vmci_transport_set_buffer_size,
2102 .set_min_buffer_size = vmci_transport_set_min_buffer_size,
2103 .set_max_buffer_size = vmci_transport_set_max_buffer_size,
2104 .get_buffer_size = vmci_transport_get_buffer_size,
2105 .get_min_buffer_size = vmci_transport_get_min_buffer_size,
2106 .get_max_buffer_size = vmci_transport_get_max_buffer_size,
2107 .get_local_cid = vmci_transport_get_local_cid,
2110 static int __init vmci_transport_init(void)
2114 /* Create the datagram handle that we will use to send and receive all
2115 * VSocket control messages for this context.
2117 err = vmci_transport_datagram_create_hnd(VMCI_TRANSPORT_PACKET_RID,
2118 VMCI_FLAG_ANYCID_DG_HND,
2119 vmci_transport_recv_stream_cb,
2121 &vmci_transport_stream_handle);
2122 if (err < VMCI_SUCCESS) {
2123 pr_err("Unable to create datagram handle. (%d)\n", err);
2124 return vmci_transport_error_to_vsock_error(err);
2127 err = vmci_event_subscribe(VMCI_EVENT_QP_RESUMED,
2128 vmci_transport_qp_resumed_cb,
2129 NULL, &vmci_transport_qp_resumed_sub_id);
2130 if (err < VMCI_SUCCESS) {
2131 pr_err("Unable to subscribe to resumed event. (%d)\n", err);
2132 err = vmci_transport_error_to_vsock_error(err);
2133 vmci_transport_qp_resumed_sub_id = VMCI_INVALID_ID;
2134 goto err_destroy_stream_handle;
2137 err = vsock_core_init(&vmci_transport);
2139 goto err_unsubscribe;
2144 vmci_event_unsubscribe(vmci_transport_qp_resumed_sub_id);
2145 err_destroy_stream_handle:
2146 vmci_datagram_destroy_handle(vmci_transport_stream_handle);
2149 module_init(vmci_transport_init);
2151 static void __exit vmci_transport_exit(void)
2153 cancel_work_sync(&vmci_transport_cleanup_work);
2154 vmci_transport_free_resources(&vmci_transport_cleanup_list);
2156 if (!vmci_handle_is_invalid(vmci_transport_stream_handle)) {
2157 if (vmci_datagram_destroy_handle(
2158 vmci_transport_stream_handle) != VMCI_SUCCESS)
2159 pr_err("Couldn't destroy datagram handle\n");
2160 vmci_transport_stream_handle = VMCI_INVALID_HANDLE;
2163 if (vmci_transport_qp_resumed_sub_id != VMCI_INVALID_ID) {
2164 vmci_event_unsubscribe(vmci_transport_qp_resumed_sub_id);
2165 vmci_transport_qp_resumed_sub_id = VMCI_INVALID_ID;
2170 module_exit(vmci_transport_exit);
2172 MODULE_AUTHOR("VMware, Inc.");
2173 MODULE_DESCRIPTION("VMCI transport for Virtual Sockets");
2174 MODULE_VERSION("1.0.5.0-k");
2175 MODULE_LICENSE("GPL v2");
2176 MODULE_ALIAS("vmware_vsock");
2177 MODULE_ALIAS_NETPROTO(PF_VSOCK);