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> 1382a54d0eSAsias He #include <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; 3082a54d0eSAsias He struct sockaddr_vm local_addr; 3182a54d0eSAsias He struct sockaddr_vm remote_addr; 3282a54d0eSAsias He /* Links for the global tables of bound and connected sockets. */ 3382a54d0eSAsias He struct list_head bound_table; 3482a54d0eSAsias He struct list_head connected_table; 3582a54d0eSAsias He /* Accessed without the socket lock held. This means it can never be 3682a54d0eSAsias He * modified outsided of socket create or destruct. 3782a54d0eSAsias He */ 3882a54d0eSAsias He bool trusted; 3982a54d0eSAsias He bool cached_peer_allow_dgram; /* Dgram communication allowed to 4082a54d0eSAsias He * cached peer? 4182a54d0eSAsias He */ 4282a54d0eSAsias He u32 cached_peer; /* Context ID of last dgram destination check. */ 4382a54d0eSAsias He const struct cred *owner; 4482a54d0eSAsias He /* Rest are SOCK_STREAM only. */ 4582a54d0eSAsias He long connect_timeout; 4682a54d0eSAsias He /* Listening socket that this came from. */ 4782a54d0eSAsias He struct sock *listener; 4882a54d0eSAsias He /* Used for pending list and accept queue during connection handshake. 4982a54d0eSAsias He * The listening socket is the head for both lists. Sockets created 5082a54d0eSAsias He * for connection requests are placed in the pending list until they 5182a54d0eSAsias He * are connected, at which point they are put in the accept queue list 5282a54d0eSAsias He * so they can be accepted in accept(). If accept() cannot accept the 5382a54d0eSAsias He * connection, it is marked as rejected so the cleanup function knows 5482a54d0eSAsias He * to clean up the socket. 5582a54d0eSAsias He */ 5682a54d0eSAsias He struct list_head pending_links; 5782a54d0eSAsias He struct list_head accept_queue; 5882a54d0eSAsias He bool rejected; 59455f05ecSCong Wang struct delayed_work connect_work; 60455f05ecSCong Wang struct delayed_work pending_work; 6106a8fc78SAsias He struct delayed_work close_work; 6206a8fc78SAsias He bool close_work_scheduled; 6382a54d0eSAsias He u32 peer_shutdown; 6482a54d0eSAsias He bool sent_request; 6582a54d0eSAsias He bool ignore_connecting_rst; 6682a54d0eSAsias He 6782a54d0eSAsias He /* Private to transport. */ 6882a54d0eSAsias He void *trans; 6982a54d0eSAsias He }; 7082a54d0eSAsias He 7182a54d0eSAsias He s64 vsock_stream_has_data(struct vsock_sock *vsk); 7282a54d0eSAsias He s64 vsock_stream_has_space(struct vsock_sock *vsk); 7382a54d0eSAsias He struct sock *__vsock_create(struct net *net, 7482a54d0eSAsias He struct socket *sock, 7582a54d0eSAsias He struct sock *parent, 7611aa9c28SEric W. Biederman gfp_t priority, unsigned short type, int kern); 7782a54d0eSAsias He 7882a54d0eSAsias He /**** TRANSPORT ****/ 7982a54d0eSAsias He 8082a54d0eSAsias He struct vsock_transport_recv_notify_data { 8182a54d0eSAsias He u64 data1; /* Transport-defined. */ 8282a54d0eSAsias He u64 data2; /* Transport-defined. */ 8382a54d0eSAsias He bool notify_on_block; 8482a54d0eSAsias He }; 8582a54d0eSAsias He 8682a54d0eSAsias He struct vsock_transport_send_notify_data { 8782a54d0eSAsias He u64 data1; /* Transport-defined. */ 8882a54d0eSAsias He u64 data2; /* Transport-defined. */ 8982a54d0eSAsias He }; 9082a54d0eSAsias He 9182a54d0eSAsias He struct vsock_transport { 9282a54d0eSAsias He /* Initialize/tear-down socket. */ 9382a54d0eSAsias He int (*init)(struct vsock_sock *, struct vsock_sock *); 9482a54d0eSAsias He void (*destruct)(struct vsock_sock *); 9582a54d0eSAsias He void (*release)(struct vsock_sock *); 9682a54d0eSAsias He 9716320f36SPeng Tao /* Cancel all pending packets sent on vsock. */ 9816320f36SPeng Tao int (*cancel_pkt)(struct vsock_sock *vsk); 9916320f36SPeng Tao 10082a54d0eSAsias He /* Connections. */ 10182a54d0eSAsias He int (*connect)(struct vsock_sock *); 10282a54d0eSAsias He 10382a54d0eSAsias He /* DGRAM. */ 10482a54d0eSAsias He int (*dgram_bind)(struct vsock_sock *, struct sockaddr_vm *); 1051b784140SYing Xue int (*dgram_dequeue)(struct vsock_sock *vsk, struct msghdr *msg, 1061b784140SYing Xue size_t len, int flags); 10782a54d0eSAsias He int (*dgram_enqueue)(struct vsock_sock *, struct sockaddr_vm *, 1080f7db23aSAl Viro struct msghdr *, size_t len); 10982a54d0eSAsias He bool (*dgram_allow)(u32 cid, u32 port); 11082a54d0eSAsias He 11182a54d0eSAsias He /* STREAM. */ 11282a54d0eSAsias He /* TODO: stream_bind() */ 1130f7db23aSAl Viro ssize_t (*stream_dequeue)(struct vsock_sock *, struct msghdr *, 11482a54d0eSAsias He size_t len, int flags); 1150f7db23aSAl Viro ssize_t (*stream_enqueue)(struct vsock_sock *, struct msghdr *, 11682a54d0eSAsias He size_t len); 11782a54d0eSAsias He s64 (*stream_has_data)(struct vsock_sock *); 11882a54d0eSAsias He s64 (*stream_has_space)(struct vsock_sock *); 11982a54d0eSAsias He u64 (*stream_rcvhiwat)(struct vsock_sock *); 12082a54d0eSAsias He bool (*stream_is_active)(struct vsock_sock *); 12182a54d0eSAsias He bool (*stream_allow)(u32 cid, u32 port); 12282a54d0eSAsias He 12382a54d0eSAsias He /* Notification. */ 12482a54d0eSAsias He int (*notify_poll_in)(struct vsock_sock *, size_t, bool *); 12582a54d0eSAsias He int (*notify_poll_out)(struct vsock_sock *, size_t, bool *); 12682a54d0eSAsias He int (*notify_recv_init)(struct vsock_sock *, size_t, 12782a54d0eSAsias He struct vsock_transport_recv_notify_data *); 12882a54d0eSAsias He int (*notify_recv_pre_block)(struct vsock_sock *, size_t, 12982a54d0eSAsias He struct vsock_transport_recv_notify_data *); 13082a54d0eSAsias He int (*notify_recv_pre_dequeue)(struct vsock_sock *, size_t, 13182a54d0eSAsias He struct vsock_transport_recv_notify_data *); 13282a54d0eSAsias He int (*notify_recv_post_dequeue)(struct vsock_sock *, size_t, 13382a54d0eSAsias He ssize_t, bool, struct vsock_transport_recv_notify_data *); 13482a54d0eSAsias He int (*notify_send_init)(struct vsock_sock *, 13582a54d0eSAsias He struct vsock_transport_send_notify_data *); 13682a54d0eSAsias He int (*notify_send_pre_block)(struct vsock_sock *, 13782a54d0eSAsias He struct vsock_transport_send_notify_data *); 13882a54d0eSAsias He int (*notify_send_pre_enqueue)(struct vsock_sock *, 13982a54d0eSAsias He struct vsock_transport_send_notify_data *); 14082a54d0eSAsias He int (*notify_send_post_enqueue)(struct vsock_sock *, ssize_t, 14182a54d0eSAsias He struct vsock_transport_send_notify_data *); 14282a54d0eSAsias He 14382a54d0eSAsias He /* Shutdown. */ 14482a54d0eSAsias He int (*shutdown)(struct vsock_sock *, int); 14582a54d0eSAsias He 14682a54d0eSAsias He /* Buffer sizes. */ 14782a54d0eSAsias He void (*set_buffer_size)(struct vsock_sock *, u64); 14882a54d0eSAsias He void (*set_min_buffer_size)(struct vsock_sock *, u64); 14982a54d0eSAsias He void (*set_max_buffer_size)(struct vsock_sock *, u64); 15082a54d0eSAsias He u64 (*get_buffer_size)(struct vsock_sock *); 15182a54d0eSAsias He u64 (*get_min_buffer_size)(struct vsock_sock *); 15282a54d0eSAsias He u64 (*get_max_buffer_size)(struct vsock_sock *); 15382a54d0eSAsias He 15482a54d0eSAsias He /* Addressing. */ 15582a54d0eSAsias He u32 (*get_local_cid)(void); 15682a54d0eSAsias He }; 15782a54d0eSAsias He 15882a54d0eSAsias He /**** CORE ****/ 15982a54d0eSAsias He 1602c4a336eSAndy King int __vsock_core_init(const struct vsock_transport *t, struct module *owner); 1612c4a336eSAndy King static inline int vsock_core_init(const struct vsock_transport *t) 1622c4a336eSAndy King { 1632c4a336eSAndy King return __vsock_core_init(t, THIS_MODULE); 1642c4a336eSAndy King } 16582a54d0eSAsias He void vsock_core_exit(void); 16682a54d0eSAsias He 1670b01aeb3SStefan Hajnoczi /* The transport may downcast this to access transport-specific functions */ 1680b01aeb3SStefan Hajnoczi const struct vsock_transport *vsock_core_get_transport(void); 1690b01aeb3SStefan Hajnoczi 17082a54d0eSAsias He /**** UTILS ****/ 17182a54d0eSAsias He 172bf359b81SStefan Hajnoczi /* vsock_table_lock must be held */ 173bf359b81SStefan Hajnoczi static inline bool __vsock_in_bound_table(struct vsock_sock *vsk) 174bf359b81SStefan Hajnoczi { 175bf359b81SStefan Hajnoczi return !list_empty(&vsk->bound_table); 176bf359b81SStefan Hajnoczi } 177bf359b81SStefan Hajnoczi 178bf359b81SStefan Hajnoczi /* vsock_table_lock must be held */ 179bf359b81SStefan Hajnoczi static inline bool __vsock_in_connected_table(struct vsock_sock *vsk) 180bf359b81SStefan Hajnoczi { 181bf359b81SStefan Hajnoczi return !list_empty(&vsk->connected_table); 182bf359b81SStefan Hajnoczi } 183bf359b81SStefan Hajnoczi 18482a54d0eSAsias He void vsock_release_pending(struct sock *pending); 18582a54d0eSAsias He void vsock_add_pending(struct sock *listener, struct sock *pending); 18682a54d0eSAsias He void vsock_remove_pending(struct sock *listener, struct sock *pending); 18782a54d0eSAsias He void vsock_enqueue_accept(struct sock *listener, struct sock *connected); 18882a54d0eSAsias He void vsock_insert_connected(struct vsock_sock *vsk); 18982a54d0eSAsias He void vsock_remove_bound(struct vsock_sock *vsk); 19082a54d0eSAsias He void vsock_remove_connected(struct vsock_sock *vsk); 19182a54d0eSAsias He struct sock *vsock_find_bound_socket(struct sockaddr_vm *addr); 19282a54d0eSAsias He struct sock *vsock_find_connected_socket(struct sockaddr_vm *src, 19382a54d0eSAsias He struct sockaddr_vm *dst); 1946773b7dcSStefan Hajnoczi void vsock_remove_sock(struct vsock_sock *vsk); 19582a54d0eSAsias He void vsock_for_each_connected_socket(void (*fn)(struct sock *sk)); 19682a54d0eSAsias He 197531b3748SGerard Garcia /**** TAP ****/ 198531b3748SGerard Garcia 199531b3748SGerard Garcia struct vsock_tap { 200531b3748SGerard Garcia struct net_device *dev; 201531b3748SGerard Garcia struct module *module; 202531b3748SGerard Garcia struct list_head list; 203531b3748SGerard Garcia }; 204531b3748SGerard Garcia 205531b3748SGerard Garcia int vsock_init_tap(void); 206531b3748SGerard Garcia int vsock_add_tap(struct vsock_tap *vt); 207531b3748SGerard Garcia int vsock_remove_tap(struct vsock_tap *vt); 208531b3748SGerard Garcia void vsock_deliver_tap(struct sk_buff *build_skb(void *opaque), void *opaque); 209531b3748SGerard Garcia 21082a54d0eSAsias He #endif /* __AF_VSOCK_H__ */ 211