1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * VMware vSockets Driver 4 * 5 * Copyright (C) 2007-2013 VMware, Inc. All rights reserved. 6 */ 7 8 #ifndef __AF_VSOCK_H__ 9 #define __AF_VSOCK_H__ 10 11 #include <linux/kernel.h> 12 #include <linux/workqueue.h> 13 #include <uapi/linux/vm_sockets.h> 14 15 #include "vsock_addr.h" 16 17 #define LAST_RESERVED_PORT 1023 18 19 #define VSOCK_HASH_SIZE 251 20 extern struct list_head vsock_bind_table[VSOCK_HASH_SIZE + 1]; 21 extern struct list_head vsock_connected_table[VSOCK_HASH_SIZE]; 22 extern spinlock_t vsock_table_lock; 23 24 #define vsock_sk(__sk) ((struct vsock_sock *)__sk) 25 #define sk_vsock(__vsk) (&(__vsk)->sk) 26 27 struct vsock_sock { 28 /* sk must be the first member. */ 29 struct sock sk; 30 const struct vsock_transport *transport; 31 struct sockaddr_vm local_addr; 32 struct sockaddr_vm remote_addr; 33 /* Links for the global tables of bound and connected sockets. */ 34 struct list_head bound_table; 35 struct list_head connected_table; 36 /* Accessed without the socket lock held. This means it can never be 37 * modified outsided of socket create or destruct. 38 */ 39 bool trusted; 40 bool cached_peer_allow_dgram; /* Dgram communication allowed to 41 * cached peer? 42 */ 43 u32 cached_peer; /* Context ID of last dgram destination check. */ 44 const struct cred *owner; 45 /* Rest are SOCK_STREAM only. */ 46 long connect_timeout; 47 /* Listening socket that this came from. */ 48 struct sock *listener; 49 /* Used for pending list and accept queue during connection handshake. 50 * The listening socket is the head for both lists. Sockets created 51 * for connection requests are placed in the pending list until they 52 * are connected, at which point they are put in the accept queue list 53 * so they can be accepted in accept(). If accept() cannot accept the 54 * connection, it is marked as rejected so the cleanup function knows 55 * to clean up the socket. 56 */ 57 struct list_head pending_links; 58 struct list_head accept_queue; 59 bool rejected; 60 struct delayed_work connect_work; 61 struct delayed_work pending_work; 62 struct delayed_work close_work; 63 bool close_work_scheduled; 64 u32 peer_shutdown; 65 bool sent_request; 66 bool ignore_connecting_rst; 67 68 /* Private to transport. */ 69 void *trans; 70 }; 71 72 s64 vsock_stream_has_data(struct vsock_sock *vsk); 73 s64 vsock_stream_has_space(struct vsock_sock *vsk); 74 struct sock *__vsock_create(struct net *net, 75 struct socket *sock, 76 struct sock *parent, 77 gfp_t priority, unsigned short type, int kern); 78 79 /**** TRANSPORT ****/ 80 81 struct vsock_transport_recv_notify_data { 82 u64 data1; /* Transport-defined. */ 83 u64 data2; /* Transport-defined. */ 84 bool notify_on_block; 85 }; 86 87 struct vsock_transport_send_notify_data { 88 u64 data1; /* Transport-defined. */ 89 u64 data2; /* Transport-defined. */ 90 }; 91 92 struct vsock_transport { 93 /* Initialize/tear-down socket. */ 94 int (*init)(struct vsock_sock *, struct vsock_sock *); 95 void (*destruct)(struct vsock_sock *); 96 void (*release)(struct vsock_sock *); 97 98 /* Cancel all pending packets sent on vsock. */ 99 int (*cancel_pkt)(struct vsock_sock *vsk); 100 101 /* Connections. */ 102 int (*connect)(struct vsock_sock *); 103 104 /* DGRAM. */ 105 int (*dgram_bind)(struct vsock_sock *, struct sockaddr_vm *); 106 int (*dgram_dequeue)(struct vsock_sock *vsk, struct msghdr *msg, 107 size_t len, int flags); 108 int (*dgram_enqueue)(struct vsock_sock *, struct sockaddr_vm *, 109 struct msghdr *, size_t len); 110 bool (*dgram_allow)(u32 cid, u32 port); 111 112 /* STREAM. */ 113 /* TODO: stream_bind() */ 114 ssize_t (*stream_dequeue)(struct vsock_sock *, struct msghdr *, 115 size_t len, int flags); 116 ssize_t (*stream_enqueue)(struct vsock_sock *, struct msghdr *, 117 size_t len); 118 s64 (*stream_has_data)(struct vsock_sock *); 119 s64 (*stream_has_space)(struct vsock_sock *); 120 u64 (*stream_rcvhiwat)(struct vsock_sock *); 121 bool (*stream_is_active)(struct vsock_sock *); 122 bool (*stream_allow)(u32 cid, u32 port); 123 124 /* Notification. */ 125 int (*notify_poll_in)(struct vsock_sock *, size_t, bool *); 126 int (*notify_poll_out)(struct vsock_sock *, size_t, bool *); 127 int (*notify_recv_init)(struct vsock_sock *, size_t, 128 struct vsock_transport_recv_notify_data *); 129 int (*notify_recv_pre_block)(struct vsock_sock *, size_t, 130 struct vsock_transport_recv_notify_data *); 131 int (*notify_recv_pre_dequeue)(struct vsock_sock *, size_t, 132 struct vsock_transport_recv_notify_data *); 133 int (*notify_recv_post_dequeue)(struct vsock_sock *, size_t, 134 ssize_t, bool, struct vsock_transport_recv_notify_data *); 135 int (*notify_send_init)(struct vsock_sock *, 136 struct vsock_transport_send_notify_data *); 137 int (*notify_send_pre_block)(struct vsock_sock *, 138 struct vsock_transport_send_notify_data *); 139 int (*notify_send_pre_enqueue)(struct vsock_sock *, 140 struct vsock_transport_send_notify_data *); 141 int (*notify_send_post_enqueue)(struct vsock_sock *, ssize_t, 142 struct vsock_transport_send_notify_data *); 143 144 /* Shutdown. */ 145 int (*shutdown)(struct vsock_sock *, int); 146 147 /* Buffer sizes. */ 148 void (*set_buffer_size)(struct vsock_sock *, u64); 149 void (*set_min_buffer_size)(struct vsock_sock *, u64); 150 void (*set_max_buffer_size)(struct vsock_sock *, u64); 151 u64 (*get_buffer_size)(struct vsock_sock *); 152 u64 (*get_min_buffer_size)(struct vsock_sock *); 153 u64 (*get_max_buffer_size)(struct vsock_sock *); 154 155 /* Addressing. */ 156 u32 (*get_local_cid)(void); 157 }; 158 159 /**** CORE ****/ 160 161 int __vsock_core_init(const struct vsock_transport *t, struct module *owner); 162 static inline int vsock_core_init(const struct vsock_transport *t) 163 { 164 return __vsock_core_init(t, THIS_MODULE); 165 } 166 void vsock_core_exit(void); 167 168 /* The transport may downcast this to access transport-specific functions */ 169 const struct vsock_transport *vsock_core_get_transport(void); 170 171 /**** UTILS ****/ 172 173 /* vsock_table_lock must be held */ 174 static inline bool __vsock_in_bound_table(struct vsock_sock *vsk) 175 { 176 return !list_empty(&vsk->bound_table); 177 } 178 179 /* vsock_table_lock must be held */ 180 static inline bool __vsock_in_connected_table(struct vsock_sock *vsk) 181 { 182 return !list_empty(&vsk->connected_table); 183 } 184 185 void vsock_release_pending(struct sock *pending); 186 void vsock_add_pending(struct sock *listener, struct sock *pending); 187 void vsock_remove_pending(struct sock *listener, struct sock *pending); 188 void vsock_enqueue_accept(struct sock *listener, struct sock *connected); 189 void vsock_insert_connected(struct vsock_sock *vsk); 190 void vsock_remove_bound(struct vsock_sock *vsk); 191 void vsock_remove_connected(struct vsock_sock *vsk); 192 struct sock *vsock_find_bound_socket(struct sockaddr_vm *addr); 193 struct sock *vsock_find_connected_socket(struct sockaddr_vm *src, 194 struct sockaddr_vm *dst); 195 void vsock_remove_sock(struct vsock_sock *vsk); 196 void vsock_for_each_connected_socket(void (*fn)(struct sock *sk)); 197 198 /**** TAP ****/ 199 200 struct vsock_tap { 201 struct net_device *dev; 202 struct module *module; 203 struct list_head list; 204 }; 205 206 int vsock_init_tap(void); 207 int vsock_add_tap(struct vsock_tap *vt); 208 int vsock_remove_tap(struct vsock_tap *vt); 209 void vsock_deliver_tap(struct sk_buff *build_skb(void *opaque), void *opaque); 210 211 #endif /* __AF_VSOCK_H__ */ 212