Commit | Line | Data |
---|---|---|
685a6bf8 | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
d021c344 AK |
2 | /* |
3 | * VMware vSockets Driver | |
4 | * | |
5 | * Copyright (C) 2007-2013 VMware, Inc. All rights reserved. | |
d021c344 AK |
6 | */ |
7 | ||
8 | #ifndef __AF_VSOCK_H__ | |
9 | #define __AF_VSOCK_H__ | |
10 | ||
11 | #include <linux/kernel.h> | |
12 | #include <linux/workqueue.h> | |
949d6b40 | 13 | #include <net/sock.h> |
3603a2e9 | 14 | #include <uapi/linux/vm_sockets.h> |
d021c344 AK |
15 | |
16 | #include "vsock_addr.h" | |
17 | ||
18 | #define LAST_RESERVED_PORT 1023 | |
44f20980 SH |
19 | |
20 | #define VSOCK_HASH_SIZE 251 | |
21 | extern struct list_head vsock_bind_table[VSOCK_HASH_SIZE + 1]; | |
22 | extern struct list_head vsock_connected_table[VSOCK_HASH_SIZE]; | |
23 | extern spinlock_t vsock_table_lock; | |
d021c344 AK |
24 | |
25 | #define vsock_sk(__sk) ((struct vsock_sock *)__sk) | |
26 | #define sk_vsock(__vsk) (&(__vsk)->sk) | |
27 | ||
28 | struct vsock_sock { | |
29 | /* sk must be the first member. */ | |
30 | struct sock sk; | |
fe502c4a | 31 | const struct vsock_transport *transport; |
d021c344 AK |
32 | struct sockaddr_vm local_addr; |
33 | struct sockaddr_vm remote_addr; | |
34 | /* Links for the global tables of bound and connected sockets. */ | |
35 | struct list_head bound_table; | |
36 | struct list_head connected_table; | |
37 | /* Accessed without the socket lock held. This means it can never be | |
38 | * modified outsided of socket create or destruct. | |
39 | */ | |
40 | bool trusted; | |
41 | bool cached_peer_allow_dgram; /* Dgram communication allowed to | |
42 | * cached peer? | |
43 | */ | |
44 | u32 cached_peer; /* Context ID of last dgram destination check. */ | |
45 | const struct cred *owner; | |
46 | /* Rest are SOCK_STREAM only. */ | |
47 | long connect_timeout; | |
48 | /* Listening socket that this came from. */ | |
49 | struct sock *listener; | |
50 | /* Used for pending list and accept queue during connection handshake. | |
51 | * The listening socket is the head for both lists. Sockets created | |
52 | * for connection requests are placed in the pending list until they | |
53 | * are connected, at which point they are put in the accept queue list | |
54 | * so they can be accepted in accept(). If accept() cannot accept the | |
55 | * connection, it is marked as rejected so the cleanup function knows | |
56 | * to clean up the socket. | |
57 | */ | |
58 | struct list_head pending_links; | |
59 | struct list_head accept_queue; | |
60 | bool rejected; | |
455f05ec CW |
61 | struct delayed_work connect_work; |
62 | struct delayed_work pending_work; | |
06a8fc78 AH |
63 | struct delayed_work close_work; |
64 | bool close_work_scheduled; | |
d021c344 AK |
65 | u32 peer_shutdown; |
66 | bool sent_request; | |
67 | bool ignore_connecting_rst; | |
68 | ||
b9f2b0ff SG |
69 | /* Protected by lock_sock(sk) */ |
70 | u64 buffer_size; | |
71 | u64 buffer_min_size; | |
72 | u64 buffer_max_size; | |
73 | ||
d021c344 AK |
74 | /* Private to transport. */ |
75 | void *trans; | |
76 | }; | |
77 | ||
634f1a71 | 78 | s64 vsock_connectible_has_data(struct vsock_sock *vsk); |
d021c344 AK |
79 | s64 vsock_stream_has_data(struct vsock_sock *vsk); |
80 | s64 vsock_stream_has_space(struct vsock_sock *vsk); | |
b9ca2f5f | 81 | struct sock *vsock_create_connected(struct sock *parent); |
f2fdcf67 | 82 | void vsock_data_ready(struct sock *sk); |
d021c344 AK |
83 | |
84 | /**** TRANSPORT ****/ | |
85 | ||
86 | struct vsock_transport_recv_notify_data { | |
87 | u64 data1; /* Transport-defined. */ | |
88 | u64 data2; /* Transport-defined. */ | |
89 | bool notify_on_block; | |
90 | }; | |
91 | ||
92 | struct vsock_transport_send_notify_data { | |
93 | u64 data1; /* Transport-defined. */ | |
94 | u64 data2; /* Transport-defined. */ | |
95 | }; | |
96 | ||
c0cfa2d8 SG |
97 | /* Transport features flags */ |
98 | /* Transport provides host->guest communication */ | |
99 | #define VSOCK_TRANSPORT_F_H2G 0x00000001 | |
100 | /* Transport provides guest->host communication */ | |
101 | #define VSOCK_TRANSPORT_F_G2H 0x00000002 | |
102 | /* Transport provides DGRAM communication */ | |
103 | #define VSOCK_TRANSPORT_F_DGRAM 0x00000004 | |
0e121905 SG |
104 | /* Transport provides local (loopback) communication */ |
105 | #define VSOCK_TRANSPORT_F_LOCAL 0x00000008 | |
c0cfa2d8 | 106 | |
d021c344 | 107 | struct vsock_transport { |
6a2c0962 SG |
108 | struct module *module; |
109 | ||
d021c344 AK |
110 | /* Initialize/tear-down socket. */ |
111 | int (*init)(struct vsock_sock *, struct vsock_sock *); | |
112 | void (*destruct)(struct vsock_sock *); | |
113 | void (*release)(struct vsock_sock *); | |
114 | ||
16320f36 PT |
115 | /* Cancel all pending packets sent on vsock. */ |
116 | int (*cancel_pkt)(struct vsock_sock *vsk); | |
117 | ||
d021c344 AK |
118 | /* Connections. */ |
119 | int (*connect)(struct vsock_sock *); | |
120 | ||
121 | /* DGRAM. */ | |
122 | int (*dgram_bind)(struct vsock_sock *, struct sockaddr_vm *); | |
1b784140 YX |
123 | int (*dgram_dequeue)(struct vsock_sock *vsk, struct msghdr *msg, |
124 | size_t len, int flags); | |
d021c344 | 125 | int (*dgram_enqueue)(struct vsock_sock *, struct sockaddr_vm *, |
0f7db23a | 126 | struct msghdr *, size_t len); |
d021c344 AK |
127 | bool (*dgram_allow)(u32 cid, u32 port); |
128 | ||
129 | /* STREAM. */ | |
130 | /* TODO: stream_bind() */ | |
0f7db23a | 131 | ssize_t (*stream_dequeue)(struct vsock_sock *, struct msghdr *, |
d021c344 | 132 | size_t len, int flags); |
0f7db23a | 133 | ssize_t (*stream_enqueue)(struct vsock_sock *, struct msghdr *, |
d021c344 AK |
134 | size_t len); |
135 | s64 (*stream_has_data)(struct vsock_sock *); | |
136 | s64 (*stream_has_space)(struct vsock_sock *); | |
137 | u64 (*stream_rcvhiwat)(struct vsock_sock *); | |
138 | bool (*stream_is_active)(struct vsock_sock *); | |
139 | bool (*stream_allow)(u32 cid, u32 port); | |
e38f22c8 | 140 | int (*set_rcvlowat)(struct vsock_sock *vsk, int val); |
d021c344 | 141 | |
9942c192 AK |
142 | /* SEQ_PACKET. */ |
143 | ssize_t (*seqpacket_dequeue)(struct vsock_sock *vsk, struct msghdr *msg, | |
144 | int flags); | |
fbe70c48 AK |
145 | int (*seqpacket_enqueue)(struct vsock_sock *vsk, struct msghdr *msg, |
146 | size_t len); | |
0798e78b AK |
147 | bool (*seqpacket_allow)(u32 remote_cid); |
148 | u32 (*seqpacket_has_data)(struct vsock_sock *vsk); | |
9942c192 | 149 | |
d021c344 AK |
150 | /* Notification. */ |
151 | int (*notify_poll_in)(struct vsock_sock *, size_t, bool *); | |
152 | int (*notify_poll_out)(struct vsock_sock *, size_t, bool *); | |
153 | int (*notify_recv_init)(struct vsock_sock *, size_t, | |
154 | struct vsock_transport_recv_notify_data *); | |
155 | int (*notify_recv_pre_block)(struct vsock_sock *, size_t, | |
156 | struct vsock_transport_recv_notify_data *); | |
157 | int (*notify_recv_pre_dequeue)(struct vsock_sock *, size_t, | |
158 | struct vsock_transport_recv_notify_data *); | |
159 | int (*notify_recv_post_dequeue)(struct vsock_sock *, size_t, | |
160 | ssize_t, bool, struct vsock_transport_recv_notify_data *); | |
161 | int (*notify_send_init)(struct vsock_sock *, | |
162 | struct vsock_transport_send_notify_data *); | |
163 | int (*notify_send_pre_block)(struct vsock_sock *, | |
164 | struct vsock_transport_send_notify_data *); | |
165 | int (*notify_send_pre_enqueue)(struct vsock_sock *, | |
166 | struct vsock_transport_send_notify_data *); | |
167 | int (*notify_send_post_enqueue)(struct vsock_sock *, ssize_t, | |
168 | struct vsock_transport_send_notify_data *); | |
b9f2b0ff SG |
169 | /* sk_lock held by the caller */ |
170 | void (*notify_buffer_size)(struct vsock_sock *, u64 *); | |
d021c344 AK |
171 | |
172 | /* Shutdown. */ | |
173 | int (*shutdown)(struct vsock_sock *, int); | |
174 | ||
d021c344 AK |
175 | /* Addressing. */ |
176 | u32 (*get_local_cid)(void); | |
634f1a71 BE |
177 | |
178 | /* Read a single skb */ | |
179 | int (*read_skb)(struct vsock_sock *, skb_read_actor_t); | |
d021c344 AK |
180 | }; |
181 | ||
182 | /**** CORE ****/ | |
183 | ||
c0cfa2d8 SG |
184 | int vsock_core_register(const struct vsock_transport *t, int features); |
185 | void vsock_core_unregister(const struct vsock_transport *t); | |
d021c344 | 186 | |
0b01aeb3 | 187 | /* The transport may downcast this to access transport-specific functions */ |
daabfbca | 188 | const struct vsock_transport *vsock_core_get_transport(struct vsock_sock *vsk); |
0b01aeb3 | 189 | |
d021c344 AK |
190 | /**** UTILS ****/ |
191 | ||
bf359b81 SH |
192 | /* vsock_table_lock must be held */ |
193 | static inline bool __vsock_in_bound_table(struct vsock_sock *vsk) | |
194 | { | |
195 | return !list_empty(&vsk->bound_table); | |
196 | } | |
197 | ||
198 | /* vsock_table_lock must be held */ | |
199 | static inline bool __vsock_in_connected_table(struct vsock_sock *vsk) | |
200 | { | |
201 | return !list_empty(&vsk->connected_table); | |
202 | } | |
203 | ||
d021c344 AK |
204 | void vsock_release_pending(struct sock *pending); |
205 | void vsock_add_pending(struct sock *listener, struct sock *pending); | |
206 | void vsock_remove_pending(struct sock *listener, struct sock *pending); | |
207 | void vsock_enqueue_accept(struct sock *listener, struct sock *connected); | |
208 | void vsock_insert_connected(struct vsock_sock *vsk); | |
209 | void vsock_remove_bound(struct vsock_sock *vsk); | |
210 | void vsock_remove_connected(struct vsock_sock *vsk); | |
211 | struct sock *vsock_find_bound_socket(struct sockaddr_vm *addr); | |
212 | struct sock *vsock_find_connected_socket(struct sockaddr_vm *src, | |
213 | struct sockaddr_vm *dst); | |
6773b7dc | 214 | void vsock_remove_sock(struct vsock_sock *vsk); |
8e6ed963 JP |
215 | void vsock_for_each_connected_socket(struct vsock_transport *transport, |
216 | void (*fn)(struct sock *sk)); | |
c0cfa2d8 SG |
217 | int vsock_assign_transport(struct vsock_sock *vsk, struct vsock_sock *psk); |
218 | bool vsock_find_cid(unsigned int cid); | |
d021c344 | 219 | |
531b3748 GG |
220 | /**** TAP ****/ |
221 | ||
222 | struct vsock_tap { | |
223 | struct net_device *dev; | |
224 | struct module *module; | |
225 | struct list_head list; | |
226 | }; | |
227 | ||
228 | int vsock_init_tap(void); | |
229 | int vsock_add_tap(struct vsock_tap *vt); | |
230 | int vsock_remove_tap(struct vsock_tap *vt); | |
231 | void vsock_deliver_tap(struct sk_buff *build_skb(void *opaque), void *opaque); | |
634f1a71 BE |
232 | int vsock_connectible_recvmsg(struct socket *sock, struct msghdr *msg, size_t len, |
233 | int flags); | |
234 | int vsock_dgram_recvmsg(struct socket *sock, struct msghdr *msg, | |
235 | size_t len, int flags); | |
236 | ||
237 | #ifdef CONFIG_BPF_SYSCALL | |
238 | extern struct proto vsock_proto; | |
239 | int vsock_bpf_update_proto(struct sock *sk, struct sk_psock *psock, bool restore); | |
240 | void __init vsock_bpf_build_proto(void); | |
241 | #else | |
242 | static inline void __init vsock_bpf_build_proto(void) | |
243 | {} | |
244 | #endif | |
531b3748 | 245 | |
d021c344 | 246 | #endif /* __AF_VSOCK_H__ */ |