1685a6bf8SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */ 282a54d0eSAsias He /* 382a54d0eSAsias He * VMware vSockets Driver 482a54d0eSAsias He * 582a54d0eSAsias He * Copyright (C) 2007-2013 VMware, Inc. All rights reserved. 682a54d0eSAsias He */ 782a54d0eSAsias He 882a54d0eSAsias He #ifndef __AF_VSOCK_H__ 982a54d0eSAsias He #define __AF_VSOCK_H__ 1082a54d0eSAsias He 1182a54d0eSAsias He #include <linux/kernel.h> 1282a54d0eSAsias He #include <linux/workqueue.h> 133603a2e9SStefano Garzarella #include <uapi/linux/vm_sockets.h> 1482a54d0eSAsias He 1582a54d0eSAsias He #include "vsock_addr.h" 1682a54d0eSAsias He 1782a54d0eSAsias He #define LAST_RESERVED_PORT 1023 1882a54d0eSAsias He 1944f20980SStefan Hajnoczi #define VSOCK_HASH_SIZE 251 2044f20980SStefan Hajnoczi extern struct list_head vsock_bind_table[VSOCK_HASH_SIZE + 1]; 2144f20980SStefan Hajnoczi extern struct list_head vsock_connected_table[VSOCK_HASH_SIZE]; 2244f20980SStefan Hajnoczi extern spinlock_t vsock_table_lock; 2344f20980SStefan Hajnoczi 2482a54d0eSAsias He #define vsock_sk(__sk) ((struct vsock_sock *)__sk) 2582a54d0eSAsias He #define sk_vsock(__vsk) (&(__vsk)->sk) 2682a54d0eSAsias He 2782a54d0eSAsias He struct vsock_sock { 2882a54d0eSAsias He /* sk must be the first member. */ 2982a54d0eSAsias He struct sock sk; 30fe502c4aSStefano Garzarella const struct vsock_transport *transport; 3182a54d0eSAsias He struct sockaddr_vm local_addr; 3282a54d0eSAsias He struct sockaddr_vm remote_addr; 3382a54d0eSAsias He /* Links for the global tables of bound and connected sockets. */ 3482a54d0eSAsias He struct list_head bound_table; 3582a54d0eSAsias He struct list_head connected_table; 3682a54d0eSAsias He /* Accessed without the socket lock held. This means it can never be 3782a54d0eSAsias He * modified outsided of socket create or destruct. 3882a54d0eSAsias He */ 3982a54d0eSAsias He bool trusted; 4082a54d0eSAsias He bool cached_peer_allow_dgram; /* Dgram communication allowed to 4182a54d0eSAsias He * cached peer? 4282a54d0eSAsias He */ 4382a54d0eSAsias He u32 cached_peer; /* Context ID of last dgram destination check. */ 4482a54d0eSAsias He const struct cred *owner; 4582a54d0eSAsias He /* Rest are SOCK_STREAM only. */ 4682a54d0eSAsias He long connect_timeout; 4782a54d0eSAsias He /* Listening socket that this came from. */ 4882a54d0eSAsias He struct sock *listener; 4982a54d0eSAsias He /* Used for pending list and accept queue during connection handshake. 5082a54d0eSAsias He * The listening socket is the head for both lists. Sockets created 5182a54d0eSAsias He * for connection requests are placed in the pending list until they 5282a54d0eSAsias He * are connected, at which point they are put in the accept queue list 5382a54d0eSAsias He * so they can be accepted in accept(). If accept() cannot accept the 5482a54d0eSAsias He * connection, it is marked as rejected so the cleanup function knows 5582a54d0eSAsias He * to clean up the socket. 5682a54d0eSAsias He */ 5782a54d0eSAsias He struct list_head pending_links; 5882a54d0eSAsias He struct list_head accept_queue; 5982a54d0eSAsias He bool rejected; 60455f05ecSCong Wang struct delayed_work connect_work; 61455f05ecSCong Wang struct delayed_work pending_work; 6206a8fc78SAsias He struct delayed_work close_work; 6306a8fc78SAsias He bool close_work_scheduled; 6482a54d0eSAsias He u32 peer_shutdown; 6582a54d0eSAsias He bool sent_request; 6682a54d0eSAsias He bool ignore_connecting_rst; 6782a54d0eSAsias He 68b9f2b0ffSStefano Garzarella /* Protected by lock_sock(sk) */ 69b9f2b0ffSStefano Garzarella u64 buffer_size; 70b9f2b0ffSStefano Garzarella u64 buffer_min_size; 71b9f2b0ffSStefano Garzarella u64 buffer_max_size; 72b9f2b0ffSStefano Garzarella 7382a54d0eSAsias He /* Private to transport. */ 7482a54d0eSAsias He void *trans; 7582a54d0eSAsias He }; 7682a54d0eSAsias He 7782a54d0eSAsias He s64 vsock_stream_has_data(struct vsock_sock *vsk); 7882a54d0eSAsias He s64 vsock_stream_has_space(struct vsock_sock *vsk); 79b9ca2f5fSStefano Garzarella struct sock *vsock_create_connected(struct sock *parent); 8082a54d0eSAsias He 8182a54d0eSAsias He /**** TRANSPORT ****/ 8282a54d0eSAsias He 8382a54d0eSAsias He struct vsock_transport_recv_notify_data { 8482a54d0eSAsias He u64 data1; /* Transport-defined. */ 8582a54d0eSAsias He u64 data2; /* Transport-defined. */ 8682a54d0eSAsias He bool notify_on_block; 8782a54d0eSAsias He }; 8882a54d0eSAsias He 8982a54d0eSAsias He struct vsock_transport_send_notify_data { 9082a54d0eSAsias He u64 data1; /* Transport-defined. */ 9182a54d0eSAsias He u64 data2; /* Transport-defined. */ 9282a54d0eSAsias He }; 9382a54d0eSAsias He 94c0cfa2d8SStefano Garzarella /* Transport features flags */ 95c0cfa2d8SStefano Garzarella /* Transport provides host->guest communication */ 96c0cfa2d8SStefano Garzarella #define VSOCK_TRANSPORT_F_H2G 0x00000001 97c0cfa2d8SStefano Garzarella /* Transport provides guest->host communication */ 98c0cfa2d8SStefano Garzarella #define VSOCK_TRANSPORT_F_G2H 0x00000002 99c0cfa2d8SStefano Garzarella /* Transport provides DGRAM communication */ 100c0cfa2d8SStefano Garzarella #define VSOCK_TRANSPORT_F_DGRAM 0x00000004 1010e121905SStefano Garzarella /* Transport provides local (loopback) communication */ 1020e121905SStefano Garzarella #define VSOCK_TRANSPORT_F_LOCAL 0x00000008 103c0cfa2d8SStefano Garzarella 10482a54d0eSAsias He struct vsock_transport { 1056a2c0962SStefano Garzarella struct module *module; 1066a2c0962SStefano Garzarella 10782a54d0eSAsias He /* Initialize/tear-down socket. */ 10882a54d0eSAsias He int (*init)(struct vsock_sock *, struct vsock_sock *); 10982a54d0eSAsias He void (*destruct)(struct vsock_sock *); 11082a54d0eSAsias He void (*release)(struct vsock_sock *); 11182a54d0eSAsias He 11216320f36SPeng Tao /* Cancel all pending packets sent on vsock. */ 11316320f36SPeng Tao int (*cancel_pkt)(struct vsock_sock *vsk); 11416320f36SPeng Tao 11582a54d0eSAsias He /* Connections. */ 11682a54d0eSAsias He int (*connect)(struct vsock_sock *); 11782a54d0eSAsias He 11882a54d0eSAsias He /* DGRAM. */ 11982a54d0eSAsias He int (*dgram_bind)(struct vsock_sock *, struct sockaddr_vm *); 1201b784140SYing Xue int (*dgram_dequeue)(struct vsock_sock *vsk, struct msghdr *msg, 1211b784140SYing Xue size_t len, int flags); 12282a54d0eSAsias He int (*dgram_enqueue)(struct vsock_sock *, struct sockaddr_vm *, 1230f7db23aSAl Viro struct msghdr *, size_t len); 12482a54d0eSAsias He bool (*dgram_allow)(u32 cid, u32 port); 12582a54d0eSAsias He 12682a54d0eSAsias He /* STREAM. */ 12782a54d0eSAsias He /* TODO: stream_bind() */ 1280f7db23aSAl Viro ssize_t (*stream_dequeue)(struct vsock_sock *, struct msghdr *, 12982a54d0eSAsias He size_t len, int flags); 1300f7db23aSAl Viro ssize_t (*stream_enqueue)(struct vsock_sock *, struct msghdr *, 13182a54d0eSAsias He size_t len); 13282a54d0eSAsias He s64 (*stream_has_data)(struct vsock_sock *); 13382a54d0eSAsias He s64 (*stream_has_space)(struct vsock_sock *); 13482a54d0eSAsias He u64 (*stream_rcvhiwat)(struct vsock_sock *); 13582a54d0eSAsias He bool (*stream_is_active)(struct vsock_sock *); 13682a54d0eSAsias He bool (*stream_allow)(u32 cid, u32 port); 13782a54d0eSAsias He 1389942c192SArseny Krasnov /* SEQ_PACKET. */ 1399942c192SArseny Krasnov ssize_t (*seqpacket_dequeue)(struct vsock_sock *vsk, struct msghdr *msg, 1409942c192SArseny Krasnov int flags); 141fbe70c48SArseny Krasnov int (*seqpacket_enqueue)(struct vsock_sock *vsk, struct msghdr *msg, 142fbe70c48SArseny Krasnov size_t len); 143*0798e78bSArseny Krasnov bool (*seqpacket_allow)(u32 remote_cid); 144*0798e78bSArseny Krasnov u32 (*seqpacket_has_data)(struct vsock_sock *vsk); 1459942c192SArseny Krasnov 14682a54d0eSAsias He /* Notification. */ 14782a54d0eSAsias He int (*notify_poll_in)(struct vsock_sock *, size_t, bool *); 14882a54d0eSAsias He int (*notify_poll_out)(struct vsock_sock *, size_t, bool *); 14982a54d0eSAsias He int (*notify_recv_init)(struct vsock_sock *, size_t, 15082a54d0eSAsias He struct vsock_transport_recv_notify_data *); 15182a54d0eSAsias He int (*notify_recv_pre_block)(struct vsock_sock *, size_t, 15282a54d0eSAsias He struct vsock_transport_recv_notify_data *); 15382a54d0eSAsias He int (*notify_recv_pre_dequeue)(struct vsock_sock *, size_t, 15482a54d0eSAsias He struct vsock_transport_recv_notify_data *); 15582a54d0eSAsias He int (*notify_recv_post_dequeue)(struct vsock_sock *, size_t, 15682a54d0eSAsias He ssize_t, bool, struct vsock_transport_recv_notify_data *); 15782a54d0eSAsias He int (*notify_send_init)(struct vsock_sock *, 15882a54d0eSAsias He struct vsock_transport_send_notify_data *); 15982a54d0eSAsias He int (*notify_send_pre_block)(struct vsock_sock *, 16082a54d0eSAsias He struct vsock_transport_send_notify_data *); 16182a54d0eSAsias He int (*notify_send_pre_enqueue)(struct vsock_sock *, 16282a54d0eSAsias He struct vsock_transport_send_notify_data *); 16382a54d0eSAsias He int (*notify_send_post_enqueue)(struct vsock_sock *, ssize_t, 16482a54d0eSAsias He struct vsock_transport_send_notify_data *); 165b9f2b0ffSStefano Garzarella /* sk_lock held by the caller */ 166b9f2b0ffSStefano Garzarella void (*notify_buffer_size)(struct vsock_sock *, u64 *); 16782a54d0eSAsias He 16882a54d0eSAsias He /* Shutdown. */ 16982a54d0eSAsias He int (*shutdown)(struct vsock_sock *, int); 17082a54d0eSAsias He 17182a54d0eSAsias He /* Addressing. */ 17282a54d0eSAsias He u32 (*get_local_cid)(void); 17382a54d0eSAsias He }; 17482a54d0eSAsias He 17582a54d0eSAsias He /**** CORE ****/ 17682a54d0eSAsias He 177c0cfa2d8SStefano Garzarella int vsock_core_register(const struct vsock_transport *t, int features); 178c0cfa2d8SStefano Garzarella void vsock_core_unregister(const struct vsock_transport *t); 17982a54d0eSAsias He 1800b01aeb3SStefan Hajnoczi /* The transport may downcast this to access transport-specific functions */ 181daabfbcaSStefano Garzarella const struct vsock_transport *vsock_core_get_transport(struct vsock_sock *vsk); 1820b01aeb3SStefan Hajnoczi 18382a54d0eSAsias He /**** UTILS ****/ 18482a54d0eSAsias He 185bf359b81SStefan Hajnoczi /* vsock_table_lock must be held */ 186bf359b81SStefan Hajnoczi static inline bool __vsock_in_bound_table(struct vsock_sock *vsk) 187bf359b81SStefan Hajnoczi { 188bf359b81SStefan Hajnoczi return !list_empty(&vsk->bound_table); 189bf359b81SStefan Hajnoczi } 190bf359b81SStefan Hajnoczi 191bf359b81SStefan Hajnoczi /* vsock_table_lock must be held */ 192bf359b81SStefan Hajnoczi static inline bool __vsock_in_connected_table(struct vsock_sock *vsk) 193bf359b81SStefan Hajnoczi { 194bf359b81SStefan Hajnoczi return !list_empty(&vsk->connected_table); 195bf359b81SStefan Hajnoczi } 196bf359b81SStefan Hajnoczi 19782a54d0eSAsias He void vsock_release_pending(struct sock *pending); 19882a54d0eSAsias He void vsock_add_pending(struct sock *listener, struct sock *pending); 19982a54d0eSAsias He void vsock_remove_pending(struct sock *listener, struct sock *pending); 20082a54d0eSAsias He void vsock_enqueue_accept(struct sock *listener, struct sock *connected); 20182a54d0eSAsias He void vsock_insert_connected(struct vsock_sock *vsk); 20282a54d0eSAsias He void vsock_remove_bound(struct vsock_sock *vsk); 20382a54d0eSAsias He void vsock_remove_connected(struct vsock_sock *vsk); 20482a54d0eSAsias He struct sock *vsock_find_bound_socket(struct sockaddr_vm *addr); 20582a54d0eSAsias He struct sock *vsock_find_connected_socket(struct sockaddr_vm *src, 20682a54d0eSAsias He struct sockaddr_vm *dst); 2076773b7dcSStefan Hajnoczi void vsock_remove_sock(struct vsock_sock *vsk); 20882a54d0eSAsias He void vsock_for_each_connected_socket(void (*fn)(struct sock *sk)); 209c0cfa2d8SStefano Garzarella int vsock_assign_transport(struct vsock_sock *vsk, struct vsock_sock *psk); 210c0cfa2d8SStefano Garzarella bool vsock_find_cid(unsigned int cid); 21182a54d0eSAsias He 212531b3748SGerard Garcia /**** TAP ****/ 213531b3748SGerard Garcia 214531b3748SGerard Garcia struct vsock_tap { 215531b3748SGerard Garcia struct net_device *dev; 216531b3748SGerard Garcia struct module *module; 217531b3748SGerard Garcia struct list_head list; 218531b3748SGerard Garcia }; 219531b3748SGerard Garcia 220531b3748SGerard Garcia int vsock_init_tap(void); 221531b3748SGerard Garcia int vsock_add_tap(struct vsock_tap *vt); 222531b3748SGerard Garcia int vsock_remove_tap(struct vsock_tap *vt); 223531b3748SGerard Garcia void vsock_deliver_tap(struct sk_buff *build_skb(void *opaque), void *opaque); 224531b3748SGerard Garcia 22582a54d0eSAsias He #endif /* __AF_VSOCK_H__ */ 226