1 // SPDX-License-Identifier: GPL-2.0-only
3 * VMware vSockets Driver
5 * Copyright (C) 2007-2013 VMware, Inc. All rights reserved.
8 /* Implementation notes:
10 * - There are two kinds of sockets: those created by user action (such as
11 * calling socket(2)) and those created by incoming connection request packets.
13 * - There are two "global" tables, one for bound sockets (sockets that have
14 * specified an address that they are responsible for) and one for connected
15 * sockets (sockets that have established a connection with another socket).
16 * These tables are "global" in that all sockets on the system are placed
17 * within them. - Note, though, that the bound table contains an extra entry
18 * for a list of unbound sockets and SOCK_DGRAM sockets will always remain in
19 * that list. The bound table is used solely for lookup of sockets when packets
20 * are received and that's not necessary for SOCK_DGRAM sockets since we create
21 * a datagram handle for each and need not perform a lookup. Keeping SOCK_DGRAM
22 * sockets out of the bound hash buckets will reduce the chance of collisions
23 * when looking for SOCK_STREAM sockets and prevents us from having to check the
24 * socket type in the hash table lookups.
26 * - Sockets created by user action will either be "client" sockets that
27 * initiate a connection or "server" sockets that listen for connections; we do
28 * not support simultaneous connects (two "client" sockets connecting).
30 * - "Server" sockets are referred to as listener sockets throughout this
31 * implementation because they are in the TCP_LISTEN state. When a
32 * connection request is received (the second kind of socket mentioned above),
33 * we create a new socket and refer to it as a pending socket. These pending
34 * sockets are placed on the pending connection list of the listener socket.
35 * When future packets are received for the address the listener socket is
36 * bound to, we check if the source of the packet is from one that has an
37 * existing pending connection. If it does, we process the packet for the
38 * pending socket. When that socket reaches the connected state, it is removed
39 * from the listener socket's pending list and enqueued in the listener
40 * socket's accept queue. Callers of accept(2) will accept connected sockets
41 * from the listener socket's accept queue. If the socket cannot be accepted
42 * for some reason then it is marked rejected. Once the connection is
43 * accepted, it is owned by the user process and the responsibility for cleanup
44 * falls with that user process.
46 * - It is possible that these pending sockets will never reach the connected
47 * state; in fact, we may never receive another packet after the connection
48 * request. Because of this, we must schedule a cleanup function to run in the
49 * future, after some amount of time passes where a connection should have been
50 * established. This function ensures that the socket is off all lists so it
51 * cannot be retrieved, then drops all references to the socket so it is cleaned
52 * up (sock_put() -> sk_free() -> our sk_destruct implementation). Note this
53 * function will also cleanup rejected sockets, those that reach the connected
54 * state but leave it before they have been accepted.
56 * - Lock ordering for pending or accept queue sockets is:
58 * lock_sock(listener);
59 * lock_sock_nested(pending, SINGLE_DEPTH_NESTING);
61 * Using explicit nested locking keeps lockdep happy since normally only one
62 * lock of a given class may be taken at a time.
64 * - Sockets created by user action will be cleaned up when the user process
65 * calls close(2), causing our release implementation to be called. Our release
66 * implementation will perform some cleanup then drop the last reference so our
67 * sk_destruct implementation is invoked. Our sk_destruct implementation will
68 * perform additional cleanup that's common for both types of sockets.
70 * - A socket's reference count is what ensures that the structure won't be
71 * freed. Each entry in a list (such as the "global" bound and connected tables
72 * and the listener socket's pending list and connected queue) ensures a
73 * reference. When we defer work until process context and pass a socket as our
74 * argument, we must ensure the reference count is increased to ensure the
75 * socket isn't freed before the function is run; the deferred function will
76 * then drop the reference.
78 * - sk->sk_state uses the TCP state constants because they are widely used by
79 * other address families and exposed to userspace tools like ss(8):
81 * TCP_CLOSE - unconnected
82 * TCP_SYN_SENT - connecting
83 * TCP_ESTABLISHED - connected
84 * TCP_CLOSING - disconnecting
85 * TCP_LISTEN - listening
88 #include <linux/compat.h>
89 #include <linux/types.h>
90 #include <linux/bitops.h>
91 #include <linux/cred.h>
92 #include <linux/errqueue.h>
93 #include <linux/init.h>
95 #include <linux/kernel.h>
96 #include <linux/sched/signal.h>
97 #include <linux/kmod.h>
98 #include <linux/list.h>
99 #include <linux/miscdevice.h>
100 #include <linux/module.h>
101 #include <linux/mutex.h>
102 #include <linux/net.h>
103 #include <linux/poll.h>
104 #include <linux/random.h>
105 #include <linux/skbuff.h>
106 #include <linux/smp.h>
107 #include <linux/socket.h>
108 #include <linux/stddef.h>
109 #include <linux/unistd.h>
110 #include <linux/wait.h>
111 #include <linux/workqueue.h>
112 #include <net/sock.h>
113 #include <net/af_vsock.h>
114 #include <uapi/linux/vm_sockets.h>
116 static int __vsock_bind(struct sock *sk, struct sockaddr_vm *addr);
117 static void vsock_sk_destruct(struct sock *sk);
118 static int vsock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
120 /* Protocol family. */
121 static struct proto vsock_proto = {
123 .owner = THIS_MODULE,
124 .obj_size = sizeof(struct vsock_sock),
127 /* The default peer timeout indicates how long we will wait for a peer response
128 * to a control message.
130 #define VSOCK_DEFAULT_CONNECT_TIMEOUT (2 * HZ)
132 #define VSOCK_DEFAULT_BUFFER_SIZE (1024 * 256)
133 #define VSOCK_DEFAULT_BUFFER_MAX_SIZE (1024 * 256)
134 #define VSOCK_DEFAULT_BUFFER_MIN_SIZE 128
136 /* Transport used for host->guest communication */
137 static const struct vsock_transport *transport_h2g;
138 /* Transport used for guest->host communication */
139 static const struct vsock_transport *transport_g2h;
140 /* Transport used for DGRAM communication */
141 static const struct vsock_transport *transport_dgram;
142 /* Transport used for local communication */
143 static const struct vsock_transport *transport_local;
144 static DEFINE_MUTEX(vsock_register_mutex);
148 /* Each bound VSocket is stored in the bind hash table and each connected
149 * VSocket is stored in the connected hash table.
151 * Unbound sockets are all put on the same list attached to the end of the hash
152 * table (vsock_unbound_sockets). Bound sockets are added to the hash table in
153 * the bucket that their local address hashes to (vsock_bound_sockets(addr)
154 * represents the list that addr hashes to).
156 * Specifically, we initialize the vsock_bind_table array to a size of
157 * VSOCK_HASH_SIZE + 1 so that vsock_bind_table[0] through
158 * vsock_bind_table[VSOCK_HASH_SIZE - 1] are for bound sockets and
159 * vsock_bind_table[VSOCK_HASH_SIZE] is for unbound sockets. The hash function
160 * mods with VSOCK_HASH_SIZE to ensure this.
162 #define MAX_PORT_RETRIES 24
164 #define VSOCK_HASH(addr) ((addr)->svm_port % VSOCK_HASH_SIZE)
165 #define vsock_bound_sockets(addr) (&vsock_bind_table[VSOCK_HASH(addr)])
166 #define vsock_unbound_sockets (&vsock_bind_table[VSOCK_HASH_SIZE])
168 /* XXX This can probably be implemented in a better way. */
169 #define VSOCK_CONN_HASH(src, dst) \
170 (((src)->svm_cid ^ (dst)->svm_port) % VSOCK_HASH_SIZE)
171 #define vsock_connected_sockets(src, dst) \
172 (&vsock_connected_table[VSOCK_CONN_HASH(src, dst)])
173 #define vsock_connected_sockets_vsk(vsk) \
174 vsock_connected_sockets(&(vsk)->remote_addr, &(vsk)->local_addr)
176 struct list_head vsock_bind_table[VSOCK_HASH_SIZE + 1];
177 EXPORT_SYMBOL_GPL(vsock_bind_table);
178 struct list_head vsock_connected_table[VSOCK_HASH_SIZE];
179 EXPORT_SYMBOL_GPL(vsock_connected_table);
180 DEFINE_SPINLOCK(vsock_table_lock);
181 EXPORT_SYMBOL_GPL(vsock_table_lock);
183 /* Autobind this socket to the local address if necessary. */
184 static int vsock_auto_bind(struct vsock_sock *vsk)
186 struct sock *sk = sk_vsock(vsk);
187 struct sockaddr_vm local_addr;
189 if (vsock_addr_bound(&vsk->local_addr))
191 vsock_addr_init(&local_addr, VMADDR_CID_ANY, VMADDR_PORT_ANY);
192 return __vsock_bind(sk, &local_addr);
195 static void vsock_init_tables(void)
199 for (i = 0; i < ARRAY_SIZE(vsock_bind_table); i++)
200 INIT_LIST_HEAD(&vsock_bind_table[i]);
202 for (i = 0; i < ARRAY_SIZE(vsock_connected_table); i++)
203 INIT_LIST_HEAD(&vsock_connected_table[i]);
206 static void __vsock_insert_bound(struct list_head *list,
207 struct vsock_sock *vsk)
210 list_add(&vsk->bound_table, list);
213 static void __vsock_insert_connected(struct list_head *list,
214 struct vsock_sock *vsk)
217 list_add(&vsk->connected_table, list);
220 static void __vsock_remove_bound(struct vsock_sock *vsk)
222 list_del_init(&vsk->bound_table);
226 static void __vsock_remove_connected(struct vsock_sock *vsk)
228 list_del_init(&vsk->connected_table);
232 static struct sock *__vsock_find_bound_socket(struct sockaddr_vm *addr)
234 struct vsock_sock *vsk;
236 list_for_each_entry(vsk, vsock_bound_sockets(addr), bound_table) {
237 if (vsock_addr_equals_addr(addr, &vsk->local_addr))
238 return sk_vsock(vsk);
240 if (addr->svm_port == vsk->local_addr.svm_port &&
241 (vsk->local_addr.svm_cid == VMADDR_CID_ANY ||
242 addr->svm_cid == VMADDR_CID_ANY))
243 return sk_vsock(vsk);
249 static struct sock *__vsock_find_connected_socket(struct sockaddr_vm *src,
250 struct sockaddr_vm *dst)
252 struct vsock_sock *vsk;
254 list_for_each_entry(vsk, vsock_connected_sockets(src, dst),
256 if (vsock_addr_equals_addr(src, &vsk->remote_addr) &&
257 dst->svm_port == vsk->local_addr.svm_port) {
258 return sk_vsock(vsk);
265 static void vsock_insert_unbound(struct vsock_sock *vsk)
267 spin_lock_bh(&vsock_table_lock);
268 __vsock_insert_bound(vsock_unbound_sockets, vsk);
269 spin_unlock_bh(&vsock_table_lock);
272 void vsock_insert_connected(struct vsock_sock *vsk)
274 struct list_head *list = vsock_connected_sockets(
275 &vsk->remote_addr, &vsk->local_addr);
277 spin_lock_bh(&vsock_table_lock);
278 __vsock_insert_connected(list, vsk);
279 spin_unlock_bh(&vsock_table_lock);
281 EXPORT_SYMBOL_GPL(vsock_insert_connected);
283 void vsock_remove_bound(struct vsock_sock *vsk)
285 spin_lock_bh(&vsock_table_lock);
286 if (__vsock_in_bound_table(vsk))
287 __vsock_remove_bound(vsk);
288 spin_unlock_bh(&vsock_table_lock);
290 EXPORT_SYMBOL_GPL(vsock_remove_bound);
292 void vsock_remove_connected(struct vsock_sock *vsk)
294 spin_lock_bh(&vsock_table_lock);
295 if (__vsock_in_connected_table(vsk))
296 __vsock_remove_connected(vsk);
297 spin_unlock_bh(&vsock_table_lock);
299 EXPORT_SYMBOL_GPL(vsock_remove_connected);
301 struct sock *vsock_find_bound_socket(struct sockaddr_vm *addr)
305 spin_lock_bh(&vsock_table_lock);
306 sk = __vsock_find_bound_socket(addr);
310 spin_unlock_bh(&vsock_table_lock);
314 EXPORT_SYMBOL_GPL(vsock_find_bound_socket);
316 struct sock *vsock_find_connected_socket(struct sockaddr_vm *src,
317 struct sockaddr_vm *dst)
321 spin_lock_bh(&vsock_table_lock);
322 sk = __vsock_find_connected_socket(src, dst);
326 spin_unlock_bh(&vsock_table_lock);
330 EXPORT_SYMBOL_GPL(vsock_find_connected_socket);
332 void vsock_remove_sock(struct vsock_sock *vsk)
334 vsock_remove_bound(vsk);
335 vsock_remove_connected(vsk);
337 EXPORT_SYMBOL_GPL(vsock_remove_sock);
339 void vsock_for_each_connected_socket(struct vsock_transport *transport,
340 void (*fn)(struct sock *sk))
344 spin_lock_bh(&vsock_table_lock);
346 for (i = 0; i < ARRAY_SIZE(vsock_connected_table); i++) {
347 struct vsock_sock *vsk;
348 list_for_each_entry(vsk, &vsock_connected_table[i],
350 if (vsk->transport != transport)
357 spin_unlock_bh(&vsock_table_lock);
359 EXPORT_SYMBOL_GPL(vsock_for_each_connected_socket);
361 void vsock_add_pending(struct sock *listener, struct sock *pending)
363 struct vsock_sock *vlistener;
364 struct vsock_sock *vpending;
366 vlistener = vsock_sk(listener);
367 vpending = vsock_sk(pending);
371 list_add_tail(&vpending->pending_links, &vlistener->pending_links);
373 EXPORT_SYMBOL_GPL(vsock_add_pending);
375 void vsock_remove_pending(struct sock *listener, struct sock *pending)
377 struct vsock_sock *vpending = vsock_sk(pending);
379 list_del_init(&vpending->pending_links);
383 EXPORT_SYMBOL_GPL(vsock_remove_pending);
385 void vsock_enqueue_accept(struct sock *listener, struct sock *connected)
387 struct vsock_sock *vlistener;
388 struct vsock_sock *vconnected;
390 vlistener = vsock_sk(listener);
391 vconnected = vsock_sk(connected);
393 sock_hold(connected);
395 list_add_tail(&vconnected->accept_queue, &vlistener->accept_queue);
397 EXPORT_SYMBOL_GPL(vsock_enqueue_accept);
399 static bool vsock_use_local_transport(unsigned int remote_cid)
401 if (!transport_local)
404 if (remote_cid == VMADDR_CID_LOCAL)
408 return remote_cid == transport_g2h->get_local_cid();
410 return remote_cid == VMADDR_CID_HOST;
414 static void vsock_deassign_transport(struct vsock_sock *vsk)
419 vsk->transport->destruct(vsk);
420 module_put(vsk->transport->module);
421 vsk->transport = NULL;
424 /* Assign a transport to a socket and call the .init transport callback.
426 * Note: for connection oriented socket this must be called when vsk->remote_addr
427 * is set (e.g. during the connect() or when a connection request on a listener
428 * socket is received).
429 * The vsk->remote_addr is used to decide which transport to use:
430 * - remote CID == VMADDR_CID_LOCAL or g2h->local_cid or VMADDR_CID_HOST if
431 * g2h is not loaded, will use local transport;
432 * - remote CID <= VMADDR_CID_HOST or h2g is not loaded or remote flags field
433 * includes VMADDR_FLAG_TO_HOST flag value, will use guest->host transport;
434 * - remote CID > VMADDR_CID_HOST will use host->guest transport;
436 int vsock_assign_transport(struct vsock_sock *vsk, struct vsock_sock *psk)
438 const struct vsock_transport *new_transport;
439 struct sock *sk = sk_vsock(vsk);
440 unsigned int remote_cid = vsk->remote_addr.svm_cid;
444 /* If the packet is coming with the source and destination CIDs higher
445 * than VMADDR_CID_HOST, then a vsock channel where all the packets are
446 * forwarded to the host should be established. Then the host will
447 * need to forward the packets to the guest.
449 * The flag is set on the (listen) receive path (psk is not NULL). On
450 * the connect path the flag can be set by the user space application.
452 if (psk && vsk->local_addr.svm_cid > VMADDR_CID_HOST &&
453 vsk->remote_addr.svm_cid > VMADDR_CID_HOST)
454 vsk->remote_addr.svm_flags |= VMADDR_FLAG_TO_HOST;
456 remote_flags = vsk->remote_addr.svm_flags;
458 switch (sk->sk_type) {
460 new_transport = transport_dgram;
464 if (vsock_use_local_transport(remote_cid))
465 new_transport = transport_local;
466 else if (remote_cid <= VMADDR_CID_HOST || !transport_h2g ||
467 (remote_flags & VMADDR_FLAG_TO_HOST))
468 new_transport = transport_g2h;
470 new_transport = transport_h2g;
473 return -ESOCKTNOSUPPORT;
476 if (vsk->transport) {
477 if (vsk->transport == new_transport)
480 /* transport->release() must be called with sock lock acquired.
481 * This path can only be taken during vsock_connect(), where we
482 * have already held the sock lock. In the other cases, this
483 * function is called on a new socket which is not assigned to
486 vsk->transport->release(vsk);
487 vsock_deassign_transport(vsk);
490 /* We increase the module refcnt to prevent the transport unloading
491 * while there are open sockets assigned to it.
493 if (!new_transport || !try_module_get(new_transport->module))
496 if (sk->sk_type == SOCK_SEQPACKET) {
497 if (!new_transport->seqpacket_allow ||
498 !new_transport->seqpacket_allow(remote_cid)) {
499 module_put(new_transport->module);
500 return -ESOCKTNOSUPPORT;
504 ret = new_transport->init(vsk, psk);
506 module_put(new_transport->module);
510 vsk->transport = new_transport;
514 EXPORT_SYMBOL_GPL(vsock_assign_transport);
516 bool vsock_find_cid(unsigned int cid)
518 if (transport_g2h && cid == transport_g2h->get_local_cid())
521 if (transport_h2g && cid == VMADDR_CID_HOST)
524 if (transport_local && cid == VMADDR_CID_LOCAL)
529 EXPORT_SYMBOL_GPL(vsock_find_cid);
531 static struct sock *vsock_dequeue_accept(struct sock *listener)
533 struct vsock_sock *vlistener;
534 struct vsock_sock *vconnected;
536 vlistener = vsock_sk(listener);
538 if (list_empty(&vlistener->accept_queue))
541 vconnected = list_entry(vlistener->accept_queue.next,
542 struct vsock_sock, accept_queue);
544 list_del_init(&vconnected->accept_queue);
546 /* The caller will need a reference on the connected socket so we let
547 * it call sock_put().
550 return sk_vsock(vconnected);
553 static bool vsock_is_accept_queue_empty(struct sock *sk)
555 struct vsock_sock *vsk = vsock_sk(sk);
556 return list_empty(&vsk->accept_queue);
559 static bool vsock_is_pending(struct sock *sk)
561 struct vsock_sock *vsk = vsock_sk(sk);
562 return !list_empty(&vsk->pending_links);
565 static int vsock_send_shutdown(struct sock *sk, int mode)
567 struct vsock_sock *vsk = vsock_sk(sk);
572 return vsk->transport->shutdown(vsk, mode);
575 static void vsock_pending_work(struct work_struct *work)
578 struct sock *listener;
579 struct vsock_sock *vsk;
582 vsk = container_of(work, struct vsock_sock, pending_work.work);
584 listener = vsk->listener;
588 lock_sock_nested(sk, SINGLE_DEPTH_NESTING);
590 if (vsock_is_pending(sk)) {
591 vsock_remove_pending(listener, sk);
593 sk_acceptq_removed(listener);
594 } else if (!vsk->rejected) {
595 /* We are not on the pending list and accept() did not reject
596 * us, so we must have been accepted by our user process. We
597 * just need to drop our references to the sockets and be on
604 /* We need to remove ourself from the global connected sockets list so
605 * incoming packets can't find this socket, and to reduce the reference
608 vsock_remove_connected(vsk);
610 sk->sk_state = TCP_CLOSE;
614 release_sock(listener);
622 /**** SOCKET OPERATIONS ****/
624 static int __vsock_bind_connectible(struct vsock_sock *vsk,
625 struct sockaddr_vm *addr)
628 struct sockaddr_vm new_addr;
631 port = LAST_RESERVED_PORT + 1 +
632 prandom_u32_max(U32_MAX - LAST_RESERVED_PORT);
634 vsock_addr_init(&new_addr, addr->svm_cid, addr->svm_port);
636 if (addr->svm_port == VMADDR_PORT_ANY) {
640 for (i = 0; i < MAX_PORT_RETRIES; i++) {
641 if (port <= LAST_RESERVED_PORT)
642 port = LAST_RESERVED_PORT + 1;
644 new_addr.svm_port = port++;
646 if (!__vsock_find_bound_socket(&new_addr)) {
653 return -EADDRNOTAVAIL;
655 /* If port is in reserved range, ensure caller
656 * has necessary privileges.
658 if (addr->svm_port <= LAST_RESERVED_PORT &&
659 !capable(CAP_NET_BIND_SERVICE)) {
663 if (__vsock_find_bound_socket(&new_addr))
667 vsock_addr_init(&vsk->local_addr, new_addr.svm_cid, new_addr.svm_port);
669 /* Remove connection oriented sockets from the unbound list and add them
670 * to the hash table for easy lookup by its address. The unbound list
671 * is simply an extra entry at the end of the hash table, a trick used
674 __vsock_remove_bound(vsk);
675 __vsock_insert_bound(vsock_bound_sockets(&vsk->local_addr), vsk);
680 static int __vsock_bind_dgram(struct vsock_sock *vsk,
681 struct sockaddr_vm *addr)
683 return vsk->transport->dgram_bind(vsk, addr);
686 static int __vsock_bind(struct sock *sk, struct sockaddr_vm *addr)
688 struct vsock_sock *vsk = vsock_sk(sk);
691 /* First ensure this socket isn't already bound. */
692 if (vsock_addr_bound(&vsk->local_addr))
695 /* Now bind to the provided address or select appropriate values if
696 * none are provided (VMADDR_CID_ANY and VMADDR_PORT_ANY). Note that
697 * like AF_INET prevents binding to a non-local IP address (in most
698 * cases), we only allow binding to a local CID.
700 if (addr->svm_cid != VMADDR_CID_ANY && !vsock_find_cid(addr->svm_cid))
701 return -EADDRNOTAVAIL;
703 switch (sk->sk_socket->type) {
706 spin_lock_bh(&vsock_table_lock);
707 retval = __vsock_bind_connectible(vsk, addr);
708 spin_unlock_bh(&vsock_table_lock);
712 retval = __vsock_bind_dgram(vsk, addr);
723 static void vsock_connect_timeout(struct work_struct *work);
725 static struct sock *__vsock_create(struct net *net,
733 struct vsock_sock *psk;
734 struct vsock_sock *vsk;
736 sk = sk_alloc(net, AF_VSOCK, priority, &vsock_proto, kern);
740 sock_init_data(sock, sk);
742 /* sk->sk_type is normally set in sock_init_data, but only if sock is
743 * non-NULL. We make sure that our sockets always have a type by
744 * setting it here if needed.
750 vsock_addr_init(&vsk->local_addr, VMADDR_CID_ANY, VMADDR_PORT_ANY);
751 vsock_addr_init(&vsk->remote_addr, VMADDR_CID_ANY, VMADDR_PORT_ANY);
753 sk->sk_destruct = vsock_sk_destruct;
754 sk->sk_backlog_rcv = vsock_queue_rcv_skb;
755 sock_reset_flag(sk, SOCK_DONE);
757 INIT_LIST_HEAD(&vsk->bound_table);
758 INIT_LIST_HEAD(&vsk->connected_table);
759 vsk->listener = NULL;
760 INIT_LIST_HEAD(&vsk->pending_links);
761 INIT_LIST_HEAD(&vsk->accept_queue);
762 vsk->rejected = false;
763 vsk->sent_request = false;
764 vsk->ignore_connecting_rst = false;
765 vsk->peer_shutdown = 0;
766 INIT_DELAYED_WORK(&vsk->connect_work, vsock_connect_timeout);
767 INIT_DELAYED_WORK(&vsk->pending_work, vsock_pending_work);
769 psk = parent ? vsock_sk(parent) : NULL;
771 vsk->trusted = psk->trusted;
772 vsk->owner = get_cred(psk->owner);
773 vsk->connect_timeout = psk->connect_timeout;
774 vsk->buffer_size = psk->buffer_size;
775 vsk->buffer_min_size = psk->buffer_min_size;
776 vsk->buffer_max_size = psk->buffer_max_size;
777 security_sk_clone(parent, sk);
779 vsk->trusted = ns_capable_noaudit(&init_user_ns, CAP_NET_ADMIN);
780 vsk->owner = get_current_cred();
781 vsk->connect_timeout = VSOCK_DEFAULT_CONNECT_TIMEOUT;
782 vsk->buffer_size = VSOCK_DEFAULT_BUFFER_SIZE;
783 vsk->buffer_min_size = VSOCK_DEFAULT_BUFFER_MIN_SIZE;
784 vsk->buffer_max_size = VSOCK_DEFAULT_BUFFER_MAX_SIZE;
790 static bool sock_type_connectible(u16 type)
792 return (type == SOCK_STREAM) || (type == SOCK_SEQPACKET);
795 static void __vsock_release(struct sock *sk, int level)
798 struct sock *pending;
799 struct vsock_sock *vsk;
802 pending = NULL; /* Compiler warning. */
804 /* When "level" is SINGLE_DEPTH_NESTING, use the nested
805 * version to avoid the warning "possible recursive locking
806 * detected". When "level" is 0, lock_sock_nested(sk, level)
807 * is the same as lock_sock(sk).
809 lock_sock_nested(sk, level);
812 vsk->transport->release(vsk);
813 else if (sock_type_connectible(sk->sk_type))
814 vsock_remove_sock(vsk);
817 sk->sk_shutdown = SHUTDOWN_MASK;
819 skb_queue_purge(&sk->sk_receive_queue);
821 /* Clean up any sockets that never were accepted. */
822 while ((pending = vsock_dequeue_accept(sk)) != NULL) {
823 __vsock_release(pending, SINGLE_DEPTH_NESTING);
832 static void vsock_sk_destruct(struct sock *sk)
834 struct vsock_sock *vsk = vsock_sk(sk);
836 vsock_deassign_transport(vsk);
838 /* When clearing these addresses, there's no need to set the family and
839 * possibly register the address family with the kernel.
841 vsock_addr_init(&vsk->local_addr, VMADDR_CID_ANY, VMADDR_PORT_ANY);
842 vsock_addr_init(&vsk->remote_addr, VMADDR_CID_ANY, VMADDR_PORT_ANY);
844 put_cred(vsk->owner);
847 static int vsock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb)
851 err = sock_queue_rcv_skb(sk, skb);
858 struct sock *vsock_create_connected(struct sock *parent)
860 return __vsock_create(sock_net(parent), NULL, parent, GFP_KERNEL,
863 EXPORT_SYMBOL_GPL(vsock_create_connected);
865 s64 vsock_stream_has_data(struct vsock_sock *vsk)
867 return vsk->transport->stream_has_data(vsk);
869 EXPORT_SYMBOL_GPL(vsock_stream_has_data);
871 static s64 vsock_connectible_has_data(struct vsock_sock *vsk)
873 struct sock *sk = sk_vsock(vsk);
875 if (sk->sk_type == SOCK_SEQPACKET)
876 return vsk->transport->seqpacket_has_data(vsk);
878 return vsock_stream_has_data(vsk);
881 s64 vsock_stream_has_space(struct vsock_sock *vsk)
883 return vsk->transport->stream_has_space(vsk);
885 EXPORT_SYMBOL_GPL(vsock_stream_has_space);
887 void vsock_data_ready(struct sock *sk)
889 struct vsock_sock *vsk = vsock_sk(sk);
891 if (vsock_stream_has_data(vsk) >= sk->sk_rcvlowat ||
892 sock_flag(sk, SOCK_DONE))
893 sk->sk_data_ready(sk);
895 EXPORT_SYMBOL_GPL(vsock_data_ready);
897 static int vsock_release(struct socket *sock)
899 __vsock_release(sock->sk, 0);
901 sock->state = SS_FREE;
907 vsock_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
911 struct sockaddr_vm *vm_addr;
915 if (vsock_addr_cast(addr, addr_len, &vm_addr) != 0)
919 err = __vsock_bind(sk, vm_addr);
925 static int vsock_getname(struct socket *sock,
926 struct sockaddr *addr, int peer)
930 struct vsock_sock *vsk;
931 struct sockaddr_vm *vm_addr;
940 if (sock->state != SS_CONNECTED) {
944 vm_addr = &vsk->remote_addr;
946 vm_addr = &vsk->local_addr;
954 /* sys_getsockname() and sys_getpeername() pass us a
955 * MAX_SOCK_ADDR-sized buffer and don't set addr_len. Unfortunately
956 * that macro is defined in socket.c instead of .h, so we hardcode its
959 BUILD_BUG_ON(sizeof(*vm_addr) > 128);
960 memcpy(addr, vm_addr, sizeof(*vm_addr));
961 err = sizeof(*vm_addr);
968 static int vsock_shutdown(struct socket *sock, int mode)
973 /* User level uses SHUT_RD (0) and SHUT_WR (1), but the kernel uses
974 * RCV_SHUTDOWN (1) and SEND_SHUTDOWN (2), so we must increment mode
975 * here like the other address families do. Note also that the
976 * increment makes SHUT_RDWR (2) into RCV_SHUTDOWN | SEND_SHUTDOWN (3),
977 * which is what we want.
981 if ((mode & ~SHUTDOWN_MASK) || !mode)
984 /* If this is a connection oriented socket and it is not connected then
985 * bail out immediately. If it is a DGRAM socket then we must first
986 * kick the socket so that it wakes up from any sleeping calls, for
987 * example recv(), and then afterwards return the error.
993 if (sock->state == SS_UNCONNECTED) {
995 if (sock_type_connectible(sk->sk_type))
998 sock->state = SS_DISCONNECTING;
1002 /* Receive and send shutdowns are treated alike. */
1003 mode = mode & (RCV_SHUTDOWN | SEND_SHUTDOWN);
1005 sk->sk_shutdown |= mode;
1006 sk->sk_state_change(sk);
1008 if (sock_type_connectible(sk->sk_type)) {
1009 sock_reset_flag(sk, SOCK_DONE);
1010 vsock_send_shutdown(sk, mode);
1019 static __poll_t vsock_poll(struct file *file, struct socket *sock,
1024 struct vsock_sock *vsk;
1029 poll_wait(file, sk_sleep(sk), wait);
1033 /* Signify that there has been an error on this socket. */
1036 /* INET sockets treat local write shutdown and peer write shutdown as a
1037 * case of EPOLLHUP set.
1039 if ((sk->sk_shutdown == SHUTDOWN_MASK) ||
1040 ((sk->sk_shutdown & SEND_SHUTDOWN) &&
1041 (vsk->peer_shutdown & SEND_SHUTDOWN))) {
1045 if (sk->sk_shutdown & RCV_SHUTDOWN ||
1046 vsk->peer_shutdown & SEND_SHUTDOWN) {
1050 if (sock->type == SOCK_DGRAM) {
1051 /* For datagram sockets we can read if there is something in
1052 * the queue and write as long as the socket isn't shutdown for
1055 if (!skb_queue_empty_lockless(&sk->sk_receive_queue) ||
1056 (sk->sk_shutdown & RCV_SHUTDOWN)) {
1057 mask |= EPOLLIN | EPOLLRDNORM;
1060 if (!(sk->sk_shutdown & SEND_SHUTDOWN))
1061 mask |= EPOLLOUT | EPOLLWRNORM | EPOLLWRBAND;
1063 } else if (sock_type_connectible(sk->sk_type)) {
1064 const struct vsock_transport *transport;
1068 transport = vsk->transport;
1070 /* Listening sockets that have connections in their accept
1071 * queue can be read.
1073 if (sk->sk_state == TCP_LISTEN
1074 && !vsock_is_accept_queue_empty(sk))
1075 mask |= EPOLLIN | EPOLLRDNORM;
1077 /* If there is something in the queue then we can read. */
1078 if (transport && transport->stream_is_active(vsk) &&
1079 !(sk->sk_shutdown & RCV_SHUTDOWN)) {
1080 bool data_ready_now = false;
1081 int target = sock_rcvlowat(sk, 0, INT_MAX);
1082 int ret = transport->notify_poll_in(
1083 vsk, target, &data_ready_now);
1088 mask |= EPOLLIN | EPOLLRDNORM;
1093 /* Sockets whose connections have been closed, reset, or
1094 * terminated should also be considered read, and we check the
1095 * shutdown flag for that.
1097 if (sk->sk_shutdown & RCV_SHUTDOWN ||
1098 vsk->peer_shutdown & SEND_SHUTDOWN) {
1099 mask |= EPOLLIN | EPOLLRDNORM;
1102 /* Connected sockets that can produce data can be written. */
1103 if (transport && sk->sk_state == TCP_ESTABLISHED) {
1104 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1105 bool space_avail_now = false;
1106 int ret = transport->notify_poll_out(
1107 vsk, 1, &space_avail_now);
1111 if (space_avail_now)
1112 /* Remove EPOLLWRBAND since INET
1113 * sockets are not setting it.
1115 mask |= EPOLLOUT | EPOLLWRNORM;
1121 /* Simulate INET socket poll behaviors, which sets
1122 * EPOLLOUT|EPOLLWRNORM when peer is closed and nothing to read,
1123 * but local send is not shutdown.
1125 if (sk->sk_state == TCP_CLOSE || sk->sk_state == TCP_CLOSING) {
1126 if (!(sk->sk_shutdown & SEND_SHUTDOWN))
1127 mask |= EPOLLOUT | EPOLLWRNORM;
1137 static int vsock_dgram_sendmsg(struct socket *sock, struct msghdr *msg,
1142 struct vsock_sock *vsk;
1143 struct sockaddr_vm *remote_addr;
1144 const struct vsock_transport *transport;
1146 if (msg->msg_flags & MSG_OOB)
1149 /* For now, MSG_DONTWAIT is always assumed... */
1156 transport = vsk->transport;
1158 err = vsock_auto_bind(vsk);
1163 /* If the provided message contains an address, use that. Otherwise
1164 * fall back on the socket's remote handle (if it has been connected).
1166 if (msg->msg_name &&
1167 vsock_addr_cast(msg->msg_name, msg->msg_namelen,
1168 &remote_addr) == 0) {
1169 /* Ensure this address is of the right type and is a valid
1173 if (remote_addr->svm_cid == VMADDR_CID_ANY)
1174 remote_addr->svm_cid = transport->get_local_cid();
1176 if (!vsock_addr_bound(remote_addr)) {
1180 } else if (sock->state == SS_CONNECTED) {
1181 remote_addr = &vsk->remote_addr;
1183 if (remote_addr->svm_cid == VMADDR_CID_ANY)
1184 remote_addr->svm_cid = transport->get_local_cid();
1186 /* XXX Should connect() or this function ensure remote_addr is
1189 if (!vsock_addr_bound(&vsk->remote_addr)) {
1198 if (!transport->dgram_allow(remote_addr->svm_cid,
1199 remote_addr->svm_port)) {
1204 err = transport->dgram_enqueue(vsk, remote_addr, msg, len);
1211 static int vsock_dgram_connect(struct socket *sock,
1212 struct sockaddr *addr, int addr_len, int flags)
1216 struct vsock_sock *vsk;
1217 struct sockaddr_vm *remote_addr;
1222 err = vsock_addr_cast(addr, addr_len, &remote_addr);
1223 if (err == -EAFNOSUPPORT && remote_addr->svm_family == AF_UNSPEC) {
1225 vsock_addr_init(&vsk->remote_addr, VMADDR_CID_ANY,
1227 sock->state = SS_UNCONNECTED;
1230 } else if (err != 0)
1235 err = vsock_auto_bind(vsk);
1239 if (!vsk->transport->dgram_allow(remote_addr->svm_cid,
1240 remote_addr->svm_port)) {
1245 memcpy(&vsk->remote_addr, remote_addr, sizeof(vsk->remote_addr));
1246 sock->state = SS_CONNECTED;
1253 static int vsock_dgram_recvmsg(struct socket *sock, struct msghdr *msg,
1254 size_t len, int flags)
1256 struct vsock_sock *vsk = vsock_sk(sock->sk);
1258 return vsk->transport->dgram_dequeue(vsk, msg, len, flags);
1261 static const struct proto_ops vsock_dgram_ops = {
1263 .owner = THIS_MODULE,
1264 .release = vsock_release,
1266 .connect = vsock_dgram_connect,
1267 .socketpair = sock_no_socketpair,
1268 .accept = sock_no_accept,
1269 .getname = vsock_getname,
1271 .ioctl = sock_no_ioctl,
1272 .listen = sock_no_listen,
1273 .shutdown = vsock_shutdown,
1274 .sendmsg = vsock_dgram_sendmsg,
1275 .recvmsg = vsock_dgram_recvmsg,
1276 .mmap = sock_no_mmap,
1277 .sendpage = sock_no_sendpage,
1280 static int vsock_transport_cancel_pkt(struct vsock_sock *vsk)
1282 const struct vsock_transport *transport = vsk->transport;
1284 if (!transport || !transport->cancel_pkt)
1287 return transport->cancel_pkt(vsk);
1290 static void vsock_connect_timeout(struct work_struct *work)
1293 struct vsock_sock *vsk;
1295 vsk = container_of(work, struct vsock_sock, connect_work.work);
1299 if (sk->sk_state == TCP_SYN_SENT &&
1300 (sk->sk_shutdown != SHUTDOWN_MASK)) {
1301 sk->sk_state = TCP_CLOSE;
1302 sk->sk_socket->state = SS_UNCONNECTED;
1303 sk->sk_err = ETIMEDOUT;
1304 sk_error_report(sk);
1305 vsock_transport_cancel_pkt(vsk);
1312 static int vsock_connect(struct socket *sock, struct sockaddr *addr,
1313 int addr_len, int flags)
1317 struct vsock_sock *vsk;
1318 const struct vsock_transport *transport;
1319 struct sockaddr_vm *remote_addr;
1329 /* XXX AF_UNSPEC should make us disconnect like AF_INET. */
1330 switch (sock->state) {
1334 case SS_DISCONNECTING:
1338 /* This continues on so we can move sock into the SS_CONNECTED
1339 * state once the connection has completed (at which point err
1340 * will be set to zero also). Otherwise, we will either wait
1341 * for the connection or return -EALREADY should this be a
1342 * non-blocking call.
1345 if (flags & O_NONBLOCK)
1349 if ((sk->sk_state == TCP_LISTEN) ||
1350 vsock_addr_cast(addr, addr_len, &remote_addr) != 0) {
1355 /* Set the remote address that we are connecting to. */
1356 memcpy(&vsk->remote_addr, remote_addr,
1357 sizeof(vsk->remote_addr));
1359 err = vsock_assign_transport(vsk, NULL);
1363 transport = vsk->transport;
1365 /* The hypervisor and well-known contexts do not have socket
1369 !transport->stream_allow(remote_addr->svm_cid,
1370 remote_addr->svm_port)) {
1375 err = vsock_auto_bind(vsk);
1379 sk->sk_state = TCP_SYN_SENT;
1381 err = transport->connect(vsk);
1385 /* Mark sock as connecting and set the error code to in
1386 * progress in case this is a non-blocking connect.
1388 sock->state = SS_CONNECTING;
1392 /* The receive path will handle all communication until we are able to
1393 * enter the connected state. Here we wait for the connection to be
1394 * completed or a notification of an error.
1396 timeout = vsk->connect_timeout;
1397 prepare_to_wait(sk_sleep(sk), &wait, TASK_INTERRUPTIBLE);
1399 while (sk->sk_state != TCP_ESTABLISHED && sk->sk_err == 0) {
1400 if (flags & O_NONBLOCK) {
1401 /* If we're not going to block, we schedule a timeout
1402 * function to generate a timeout on the connection
1403 * attempt, in case the peer doesn't respond in a
1404 * timely manner. We hold on to the socket until the
1409 /* If the timeout function is already scheduled,
1410 * reschedule it, then ungrab the socket refcount to
1413 if (mod_delayed_work(system_wq, &vsk->connect_work,
1417 /* Skip ahead to preserve error code set above. */
1422 timeout = schedule_timeout(timeout);
1425 if (signal_pending(current)) {
1426 err = sock_intr_errno(timeout);
1427 sk->sk_state = sk->sk_state == TCP_ESTABLISHED ? TCP_CLOSING : TCP_CLOSE;
1428 sock->state = SS_UNCONNECTED;
1429 vsock_transport_cancel_pkt(vsk);
1430 vsock_remove_connected(vsk);
1432 } else if ((sk->sk_state != TCP_ESTABLISHED) && (timeout == 0)) {
1434 sk->sk_state = TCP_CLOSE;
1435 sock->state = SS_UNCONNECTED;
1436 vsock_transport_cancel_pkt(vsk);
1440 prepare_to_wait(sk_sleep(sk), &wait, TASK_INTERRUPTIBLE);
1445 sk->sk_state = TCP_CLOSE;
1446 sock->state = SS_UNCONNECTED;
1452 finish_wait(sk_sleep(sk), &wait);
1458 static int vsock_accept(struct socket *sock, struct socket *newsock, int flags,
1461 struct sock *listener;
1463 struct sock *connected;
1464 struct vsock_sock *vconnected;
1469 listener = sock->sk;
1471 lock_sock(listener);
1473 if (!sock_type_connectible(sock->type)) {
1478 if (listener->sk_state != TCP_LISTEN) {
1483 /* Wait for children sockets to appear; these are the new sockets
1484 * created upon connection establishment.
1486 timeout = sock_rcvtimeo(listener, flags & O_NONBLOCK);
1487 prepare_to_wait(sk_sleep(listener), &wait, TASK_INTERRUPTIBLE);
1489 while ((connected = vsock_dequeue_accept(listener)) == NULL &&
1490 listener->sk_err == 0) {
1491 release_sock(listener);
1492 timeout = schedule_timeout(timeout);
1493 finish_wait(sk_sleep(listener), &wait);
1494 lock_sock(listener);
1496 if (signal_pending(current)) {
1497 err = sock_intr_errno(timeout);
1499 } else if (timeout == 0) {
1504 prepare_to_wait(sk_sleep(listener), &wait, TASK_INTERRUPTIBLE);
1506 finish_wait(sk_sleep(listener), &wait);
1508 if (listener->sk_err)
1509 err = -listener->sk_err;
1512 sk_acceptq_removed(listener);
1514 lock_sock_nested(connected, SINGLE_DEPTH_NESTING);
1515 vconnected = vsock_sk(connected);
1517 /* If the listener socket has received an error, then we should
1518 * reject this socket and return. Note that we simply mark the
1519 * socket rejected, drop our reference, and let the cleanup
1520 * function handle the cleanup; the fact that we found it in
1521 * the listener's accept queue guarantees that the cleanup
1522 * function hasn't run yet.
1525 vconnected->rejected = true;
1527 newsock->state = SS_CONNECTED;
1528 sock_graft(connected, newsock);
1531 release_sock(connected);
1532 sock_put(connected);
1536 release_sock(listener);
1540 static int vsock_listen(struct socket *sock, int backlog)
1544 struct vsock_sock *vsk;
1550 if (!sock_type_connectible(sk->sk_type)) {
1555 if (sock->state != SS_UNCONNECTED) {
1562 if (!vsock_addr_bound(&vsk->local_addr)) {
1567 sk->sk_max_ack_backlog = backlog;
1568 sk->sk_state = TCP_LISTEN;
1577 static void vsock_update_buffer_size(struct vsock_sock *vsk,
1578 const struct vsock_transport *transport,
1581 if (val > vsk->buffer_max_size)
1582 val = vsk->buffer_max_size;
1584 if (val < vsk->buffer_min_size)
1585 val = vsk->buffer_min_size;
1587 if (val != vsk->buffer_size &&
1588 transport && transport->notify_buffer_size)
1589 transport->notify_buffer_size(vsk, &val);
1591 vsk->buffer_size = val;
1594 static int vsock_connectible_setsockopt(struct socket *sock,
1598 unsigned int optlen)
1602 struct vsock_sock *vsk;
1603 const struct vsock_transport *transport;
1606 if (level != AF_VSOCK)
1607 return -ENOPROTOOPT;
1609 #define COPY_IN(_v) \
1611 if (optlen < sizeof(_v)) { \
1615 if (copy_from_sockptr(&_v, optval, sizeof(_v)) != 0) { \
1627 transport = vsk->transport;
1630 case SO_VM_SOCKETS_BUFFER_SIZE:
1632 vsock_update_buffer_size(vsk, transport, val);
1635 case SO_VM_SOCKETS_BUFFER_MAX_SIZE:
1637 vsk->buffer_max_size = val;
1638 vsock_update_buffer_size(vsk, transport, vsk->buffer_size);
1641 case SO_VM_SOCKETS_BUFFER_MIN_SIZE:
1643 vsk->buffer_min_size = val;
1644 vsock_update_buffer_size(vsk, transport, vsk->buffer_size);
1647 case SO_VM_SOCKETS_CONNECT_TIMEOUT_NEW:
1648 case SO_VM_SOCKETS_CONNECT_TIMEOUT_OLD: {
1649 struct __kernel_sock_timeval tv;
1651 err = sock_copy_user_timeval(&tv, optval, optlen,
1652 optname == SO_VM_SOCKETS_CONNECT_TIMEOUT_OLD);
1655 if (tv.tv_sec >= 0 && tv.tv_usec < USEC_PER_SEC &&
1656 tv.tv_sec < (MAX_SCHEDULE_TIMEOUT / HZ - 1)) {
1657 vsk->connect_timeout = tv.tv_sec * HZ +
1658 DIV_ROUND_UP((unsigned long)tv.tv_usec, (USEC_PER_SEC / HZ));
1659 if (vsk->connect_timeout == 0)
1660 vsk->connect_timeout =
1661 VSOCK_DEFAULT_CONNECT_TIMEOUT;
1681 static int vsock_connectible_getsockopt(struct socket *sock,
1682 int level, int optname,
1683 char __user *optval,
1686 struct sock *sk = sock->sk;
1687 struct vsock_sock *vsk = vsock_sk(sk);
1691 struct old_timeval32 tm32;
1692 struct __kernel_old_timeval tm;
1693 struct __kernel_sock_timeval stm;
1696 int lv = sizeof(v.val64);
1699 if (level != AF_VSOCK)
1700 return -ENOPROTOOPT;
1702 if (get_user(len, optlen))
1705 memset(&v, 0, sizeof(v));
1708 case SO_VM_SOCKETS_BUFFER_SIZE:
1709 v.val64 = vsk->buffer_size;
1712 case SO_VM_SOCKETS_BUFFER_MAX_SIZE:
1713 v.val64 = vsk->buffer_max_size;
1716 case SO_VM_SOCKETS_BUFFER_MIN_SIZE:
1717 v.val64 = vsk->buffer_min_size;
1720 case SO_VM_SOCKETS_CONNECT_TIMEOUT_NEW:
1721 case SO_VM_SOCKETS_CONNECT_TIMEOUT_OLD:
1722 lv = sock_get_timeout(vsk->connect_timeout, &v,
1723 optname == SO_VM_SOCKETS_CONNECT_TIMEOUT_OLD);
1727 return -ENOPROTOOPT;
1734 if (copy_to_user(optval, &v, len))
1737 if (put_user(len, optlen))
1743 static int vsock_connectible_sendmsg(struct socket *sock, struct msghdr *msg,
1747 struct vsock_sock *vsk;
1748 const struct vsock_transport *transport;
1749 ssize_t total_written;
1752 struct vsock_transport_send_notify_data send_data;
1753 DEFINE_WAIT_FUNC(wait, woken_wake_function);
1760 if (msg->msg_flags & MSG_OOB)
1765 transport = vsk->transport;
1767 /* Callers should not provide a destination with connection oriented
1770 if (msg->msg_namelen) {
1771 err = sk->sk_state == TCP_ESTABLISHED ? -EISCONN : -EOPNOTSUPP;
1775 /* Send data only if both sides are not shutdown in the direction. */
1776 if (sk->sk_shutdown & SEND_SHUTDOWN ||
1777 vsk->peer_shutdown & RCV_SHUTDOWN) {
1782 if (!transport || sk->sk_state != TCP_ESTABLISHED ||
1783 !vsock_addr_bound(&vsk->local_addr)) {
1788 if (!vsock_addr_bound(&vsk->remote_addr)) {
1789 err = -EDESTADDRREQ;
1793 /* Wait for room in the produce queue to enqueue our user's data. */
1794 timeout = sock_sndtimeo(sk, msg->msg_flags & MSG_DONTWAIT);
1796 err = transport->notify_send_init(vsk, &send_data);
1800 while (total_written < len) {
1803 add_wait_queue(sk_sleep(sk), &wait);
1804 while (vsock_stream_has_space(vsk) == 0 &&
1806 !(sk->sk_shutdown & SEND_SHUTDOWN) &&
1807 !(vsk->peer_shutdown & RCV_SHUTDOWN)) {
1809 /* Don't wait for non-blocking sockets. */
1812 remove_wait_queue(sk_sleep(sk), &wait);
1816 err = transport->notify_send_pre_block(vsk, &send_data);
1818 remove_wait_queue(sk_sleep(sk), &wait);
1823 timeout = wait_woken(&wait, TASK_INTERRUPTIBLE, timeout);
1825 if (signal_pending(current)) {
1826 err = sock_intr_errno(timeout);
1827 remove_wait_queue(sk_sleep(sk), &wait);
1829 } else if (timeout == 0) {
1831 remove_wait_queue(sk_sleep(sk), &wait);
1835 remove_wait_queue(sk_sleep(sk), &wait);
1837 /* These checks occur both as part of and after the loop
1838 * conditional since we need to check before and after
1844 } else if ((sk->sk_shutdown & SEND_SHUTDOWN) ||
1845 (vsk->peer_shutdown & RCV_SHUTDOWN)) {
1850 err = transport->notify_send_pre_enqueue(vsk, &send_data);
1854 /* Note that enqueue will only write as many bytes as are free
1855 * in the produce queue, so we don't need to ensure len is
1856 * smaller than the queue size. It is the caller's
1857 * responsibility to check how many bytes we were able to send.
1860 if (sk->sk_type == SOCK_SEQPACKET) {
1861 written = transport->seqpacket_enqueue(vsk,
1862 msg, len - total_written);
1864 written = transport->stream_enqueue(vsk,
1865 msg, len - total_written);
1872 total_written += written;
1874 err = transport->notify_send_post_enqueue(
1875 vsk, written, &send_data);
1882 if (total_written > 0) {
1883 /* Return number of written bytes only if:
1884 * 1) SOCK_STREAM socket.
1885 * 2) SOCK_SEQPACKET socket when whole buffer is sent.
1887 if (sk->sk_type == SOCK_STREAM || total_written == len)
1888 err = total_written;
1895 static int vsock_connectible_wait_data(struct sock *sk,
1896 struct wait_queue_entry *wait,
1898 struct vsock_transport_recv_notify_data *recv_data,
1901 const struct vsock_transport *transport;
1902 struct vsock_sock *vsk;
1908 transport = vsk->transport;
1911 prepare_to_wait(sk_sleep(sk), wait, TASK_INTERRUPTIBLE);
1912 data = vsock_connectible_has_data(vsk);
1916 if (sk->sk_err != 0 ||
1917 (sk->sk_shutdown & RCV_SHUTDOWN) ||
1918 (vsk->peer_shutdown & SEND_SHUTDOWN)) {
1922 /* Don't wait for non-blocking sockets. */
1929 err = transport->notify_recv_pre_block(vsk, target, recv_data);
1935 timeout = schedule_timeout(timeout);
1938 if (signal_pending(current)) {
1939 err = sock_intr_errno(timeout);
1941 } else if (timeout == 0) {
1947 finish_wait(sk_sleep(sk), wait);
1952 /* Internal transport error when checking for available
1953 * data. XXX This should be changed to a connection
1954 * reset in a later change.
1962 static int __vsock_stream_recvmsg(struct sock *sk, struct msghdr *msg,
1963 size_t len, int flags)
1965 struct vsock_transport_recv_notify_data recv_data;
1966 const struct vsock_transport *transport;
1967 struct vsock_sock *vsk;
1976 transport = vsk->transport;
1978 /* We must not copy less than target bytes into the user's buffer
1979 * before returning successfully, so we wait for the consume queue to
1980 * have that much data to consume before dequeueing. Note that this
1981 * makes it impossible to handle cases where target is greater than the
1984 target = sock_rcvlowat(sk, flags & MSG_WAITALL, len);
1985 if (target >= transport->stream_rcvhiwat(vsk)) {
1989 timeout = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
1992 err = transport->notify_recv_init(vsk, target, &recv_data);
2000 err = vsock_connectible_wait_data(sk, &wait, timeout,
2001 &recv_data, target);
2005 err = transport->notify_recv_pre_dequeue(vsk, target,
2010 read = transport->stream_dequeue(vsk, msg, len - copied, flags);
2018 err = transport->notify_recv_post_dequeue(vsk, target, read,
2019 !(flags & MSG_PEEK), &recv_data);
2023 if (read >= target || flags & MSG_PEEK)
2031 else if (sk->sk_shutdown & RCV_SHUTDOWN)
2041 static int __vsock_seqpacket_recvmsg(struct sock *sk, struct msghdr *msg,
2042 size_t len, int flags)
2044 const struct vsock_transport *transport;
2045 struct vsock_sock *vsk;
2052 transport = vsk->transport;
2054 timeout = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
2056 err = vsock_connectible_wait_data(sk, &wait, timeout, NULL, 0);
2060 msg_len = transport->seqpacket_dequeue(vsk, msg, flags);
2069 } else if (sk->sk_shutdown & RCV_SHUTDOWN) {
2072 /* User sets MSG_TRUNC, so return real length of
2075 if (flags & MSG_TRUNC)
2078 err = len - msg_data_left(msg);
2080 /* Always set MSG_TRUNC if real length of packet is
2081 * bigger than user's buffer.
2084 msg->msg_flags |= MSG_TRUNC;
2092 vsock_connectible_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
2096 struct vsock_sock *vsk;
2097 const struct vsock_transport *transport;
2102 if (unlikely(flags & MSG_ERRQUEUE))
2103 return sock_recv_errqueue(sk, msg, len, SOL_VSOCK, VSOCK_RECVERR);
2110 transport = vsk->transport;
2112 if (!transport || sk->sk_state != TCP_ESTABLISHED) {
2113 /* Recvmsg is supposed to return 0 if a peer performs an
2114 * orderly shutdown. Differentiate between that case and when a
2115 * peer has not connected or a local shutdown occurred with the
2118 if (sock_flag(sk, SOCK_DONE))
2126 if (flags & MSG_OOB) {
2131 /* We don't check peer_shutdown flag here since peer may actually shut
2132 * down, but there can be data in the queue that a local socket can
2135 if (sk->sk_shutdown & RCV_SHUTDOWN) {
2140 /* It is valid on Linux to pass in a zero-length receive buffer. This
2141 * is not an error. We may as well bail out now.
2148 if (sk->sk_type == SOCK_STREAM)
2149 err = __vsock_stream_recvmsg(sk, msg, len, flags);
2151 err = __vsock_seqpacket_recvmsg(sk, msg, len, flags);
2158 static int vsock_set_rcvlowat(struct sock *sk, int val)
2160 const struct vsock_transport *transport;
2161 struct vsock_sock *vsk;
2165 if (val > vsk->buffer_size)
2168 transport = vsk->transport;
2170 if (transport && transport->set_rcvlowat)
2171 return transport->set_rcvlowat(vsk, val);
2173 WRITE_ONCE(sk->sk_rcvlowat, val ? : 1);
2177 static const struct proto_ops vsock_stream_ops = {
2179 .owner = THIS_MODULE,
2180 .release = vsock_release,
2182 .connect = vsock_connect,
2183 .socketpair = sock_no_socketpair,
2184 .accept = vsock_accept,
2185 .getname = vsock_getname,
2187 .ioctl = sock_no_ioctl,
2188 .listen = vsock_listen,
2189 .shutdown = vsock_shutdown,
2190 .setsockopt = vsock_connectible_setsockopt,
2191 .getsockopt = vsock_connectible_getsockopt,
2192 .sendmsg = vsock_connectible_sendmsg,
2193 .recvmsg = vsock_connectible_recvmsg,
2194 .mmap = sock_no_mmap,
2195 .sendpage = sock_no_sendpage,
2196 .set_rcvlowat = vsock_set_rcvlowat,
2199 static const struct proto_ops vsock_seqpacket_ops = {
2201 .owner = THIS_MODULE,
2202 .release = vsock_release,
2204 .connect = vsock_connect,
2205 .socketpair = sock_no_socketpair,
2206 .accept = vsock_accept,
2207 .getname = vsock_getname,
2209 .ioctl = sock_no_ioctl,
2210 .listen = vsock_listen,
2211 .shutdown = vsock_shutdown,
2212 .setsockopt = vsock_connectible_setsockopt,
2213 .getsockopt = vsock_connectible_getsockopt,
2214 .sendmsg = vsock_connectible_sendmsg,
2215 .recvmsg = vsock_connectible_recvmsg,
2216 .mmap = sock_no_mmap,
2217 .sendpage = sock_no_sendpage,
2220 static int vsock_create(struct net *net, struct socket *sock,
2221 int protocol, int kern)
2223 struct vsock_sock *vsk;
2230 if (protocol && protocol != PF_VSOCK)
2231 return -EPROTONOSUPPORT;
2233 switch (sock->type) {
2235 sock->ops = &vsock_dgram_ops;
2238 sock->ops = &vsock_stream_ops;
2240 case SOCK_SEQPACKET:
2241 sock->ops = &vsock_seqpacket_ops;
2244 return -ESOCKTNOSUPPORT;
2247 sock->state = SS_UNCONNECTED;
2249 sk = __vsock_create(net, sock, NULL, GFP_KERNEL, 0, kern);
2255 if (sock->type == SOCK_DGRAM) {
2256 ret = vsock_assign_transport(vsk, NULL);
2263 vsock_insert_unbound(vsk);
2268 static const struct net_proto_family vsock_family_ops = {
2270 .create = vsock_create,
2271 .owner = THIS_MODULE,
2274 static long vsock_dev_do_ioctl(struct file *filp,
2275 unsigned int cmd, void __user *ptr)
2277 u32 __user *p = ptr;
2278 u32 cid = VMADDR_CID_ANY;
2282 case IOCTL_VM_SOCKETS_GET_LOCAL_CID:
2283 /* To be compatible with the VMCI behavior, we prioritize the
2284 * guest CID instead of well-know host CID (VMADDR_CID_HOST).
2287 cid = transport_g2h->get_local_cid();
2288 else if (transport_h2g)
2289 cid = transport_h2g->get_local_cid();
2291 if (put_user(cid, p) != 0)
2296 retval = -ENOIOCTLCMD;
2302 static long vsock_dev_ioctl(struct file *filp,
2303 unsigned int cmd, unsigned long arg)
2305 return vsock_dev_do_ioctl(filp, cmd, (void __user *)arg);
2308 #ifdef CONFIG_COMPAT
2309 static long vsock_dev_compat_ioctl(struct file *filp,
2310 unsigned int cmd, unsigned long arg)
2312 return vsock_dev_do_ioctl(filp, cmd, compat_ptr(arg));
2316 static const struct file_operations vsock_device_ops = {
2317 .owner = THIS_MODULE,
2318 .unlocked_ioctl = vsock_dev_ioctl,
2319 #ifdef CONFIG_COMPAT
2320 .compat_ioctl = vsock_dev_compat_ioctl,
2322 .open = nonseekable_open,
2325 static struct miscdevice vsock_device = {
2327 .fops = &vsock_device_ops,
2330 static int __init vsock_init(void)
2334 vsock_init_tables();
2336 vsock_proto.owner = THIS_MODULE;
2337 vsock_device.minor = MISC_DYNAMIC_MINOR;
2338 err = misc_register(&vsock_device);
2340 pr_err("Failed to register misc device\n");
2341 goto err_reset_transport;
2344 err = proto_register(&vsock_proto, 1); /* we want our slab */
2346 pr_err("Cannot register vsock protocol\n");
2347 goto err_deregister_misc;
2350 err = sock_register(&vsock_family_ops);
2352 pr_err("could not register af_vsock (%d) address family: %d\n",
2354 goto err_unregister_proto;
2359 err_unregister_proto:
2360 proto_unregister(&vsock_proto);
2361 err_deregister_misc:
2362 misc_deregister(&vsock_device);
2363 err_reset_transport:
2367 static void __exit vsock_exit(void)
2369 misc_deregister(&vsock_device);
2370 sock_unregister(AF_VSOCK);
2371 proto_unregister(&vsock_proto);
2374 const struct vsock_transport *vsock_core_get_transport(struct vsock_sock *vsk)
2376 return vsk->transport;
2378 EXPORT_SYMBOL_GPL(vsock_core_get_transport);
2380 int vsock_core_register(const struct vsock_transport *t, int features)
2382 const struct vsock_transport *t_h2g, *t_g2h, *t_dgram, *t_local;
2383 int err = mutex_lock_interruptible(&vsock_register_mutex);
2388 t_h2g = transport_h2g;
2389 t_g2h = transport_g2h;
2390 t_dgram = transport_dgram;
2391 t_local = transport_local;
2393 if (features & VSOCK_TRANSPORT_F_H2G) {
2401 if (features & VSOCK_TRANSPORT_F_G2H) {
2409 if (features & VSOCK_TRANSPORT_F_DGRAM) {
2417 if (features & VSOCK_TRANSPORT_F_LOCAL) {
2425 transport_h2g = t_h2g;
2426 transport_g2h = t_g2h;
2427 transport_dgram = t_dgram;
2428 transport_local = t_local;
2431 mutex_unlock(&vsock_register_mutex);
2434 EXPORT_SYMBOL_GPL(vsock_core_register);
2436 void vsock_core_unregister(const struct vsock_transport *t)
2438 mutex_lock(&vsock_register_mutex);
2440 if (transport_h2g == t)
2441 transport_h2g = NULL;
2443 if (transport_g2h == t)
2444 transport_g2h = NULL;
2446 if (transport_dgram == t)
2447 transport_dgram = NULL;
2449 if (transport_local == t)
2450 transport_local = NULL;
2452 mutex_unlock(&vsock_register_mutex);
2454 EXPORT_SYMBOL_GPL(vsock_core_unregister);
2456 module_init(vsock_init);
2457 module_exit(vsock_exit);
2459 MODULE_AUTHOR("VMware, Inc.");
2460 MODULE_DESCRIPTION("VMware Virtual Socket Family");
2461 MODULE_VERSION("1.0.2.0-k");
2462 MODULE_LICENSE("GPL v2");