Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 <net/sock.h>
14#include <uapi/linux/vm_sockets.h>
15
16#include "vsock_addr.h"
17
18#define LAST_RESERVED_PORT 1023
19
20#define VSOCK_HASH_SIZE 251
21extern struct list_head vsock_bind_table[VSOCK_HASH_SIZE + 1];
22extern struct list_head vsock_connected_table[VSOCK_HASH_SIZE];
23extern spinlock_t vsock_table_lock;
24
25#define vsock_sk(__sk) ((struct vsock_sock *)__sk)
26#define sk_vsock(__vsk) (&(__vsk)->sk)
27
28struct vsock_sock {
29 /* sk must be the first member. */
30 struct sock sk;
31 const struct vsock_transport *transport;
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;
61 struct delayed_work connect_work;
62 struct delayed_work pending_work;
63 struct delayed_work close_work;
64 bool close_work_scheduled;
65 u32 peer_shutdown;
66 bool sent_request;
67 bool ignore_connecting_rst;
68
69 /* Protected by lock_sock(sk) */
70 u64 buffer_size;
71 u64 buffer_min_size;
72 u64 buffer_max_size;
73
74 /* Private to transport. */
75 void *trans;
76};
77
78s64 vsock_stream_has_data(struct vsock_sock *vsk);
79s64 vsock_stream_has_space(struct vsock_sock *vsk);
80struct sock *vsock_create_connected(struct sock *parent);
81void vsock_data_ready(struct sock *sk);
82
83/**** TRANSPORT ****/
84
85struct vsock_transport_recv_notify_data {
86 u64 data1; /* Transport-defined. */
87 u64 data2; /* Transport-defined. */
88 bool notify_on_block;
89};
90
91struct vsock_transport_send_notify_data {
92 u64 data1; /* Transport-defined. */
93 u64 data2; /* Transport-defined. */
94};
95
96/* Transport features flags */
97/* Transport provides host->guest communication */
98#define VSOCK_TRANSPORT_F_H2G 0x00000001
99/* Transport provides guest->host communication */
100#define VSOCK_TRANSPORT_F_G2H 0x00000002
101/* Transport provides DGRAM communication */
102#define VSOCK_TRANSPORT_F_DGRAM 0x00000004
103/* Transport provides local (loopback) communication */
104#define VSOCK_TRANSPORT_F_LOCAL 0x00000008
105
106struct vsock_transport {
107 struct module *module;
108
109 /* Initialize/tear-down socket. */
110 int (*init)(struct vsock_sock *, struct vsock_sock *);
111 void (*destruct)(struct vsock_sock *);
112 void (*release)(struct vsock_sock *);
113
114 /* Cancel all pending packets sent on vsock. */
115 int (*cancel_pkt)(struct vsock_sock *vsk);
116
117 /* Connections. */
118 int (*connect)(struct vsock_sock *);
119
120 /* DGRAM. */
121 int (*dgram_bind)(struct vsock_sock *, struct sockaddr_vm *);
122 int (*dgram_dequeue)(struct vsock_sock *vsk, struct msghdr *msg,
123 size_t len, int flags);
124 int (*dgram_enqueue)(struct vsock_sock *, struct sockaddr_vm *,
125 struct msghdr *, size_t len);
126 bool (*dgram_allow)(u32 cid, u32 port);
127
128 /* STREAM. */
129 /* TODO: stream_bind() */
130 ssize_t (*stream_dequeue)(struct vsock_sock *, struct msghdr *,
131 size_t len, int flags);
132 ssize_t (*stream_enqueue)(struct vsock_sock *, struct msghdr *,
133 size_t len);
134 s64 (*stream_has_data)(struct vsock_sock *);
135 s64 (*stream_has_space)(struct vsock_sock *);
136 u64 (*stream_rcvhiwat)(struct vsock_sock *);
137 bool (*stream_is_active)(struct vsock_sock *);
138 bool (*stream_allow)(u32 cid, u32 port);
139 int (*set_rcvlowat)(struct vsock_sock *vsk, int val);
140
141 /* SEQ_PACKET. */
142 ssize_t (*seqpacket_dequeue)(struct vsock_sock *vsk, struct msghdr *msg,
143 int flags);
144 int (*seqpacket_enqueue)(struct vsock_sock *vsk, struct msghdr *msg,
145 size_t len);
146 bool (*seqpacket_allow)(u32 remote_cid);
147 u32 (*seqpacket_has_data)(struct vsock_sock *vsk);
148
149 /* Notification. */
150 int (*notify_poll_in)(struct vsock_sock *, size_t, bool *);
151 int (*notify_poll_out)(struct vsock_sock *, size_t, bool *);
152 int (*notify_recv_init)(struct vsock_sock *, size_t,
153 struct vsock_transport_recv_notify_data *);
154 int (*notify_recv_pre_block)(struct vsock_sock *, size_t,
155 struct vsock_transport_recv_notify_data *);
156 int (*notify_recv_pre_dequeue)(struct vsock_sock *, size_t,
157 struct vsock_transport_recv_notify_data *);
158 int (*notify_recv_post_dequeue)(struct vsock_sock *, size_t,
159 ssize_t, bool, struct vsock_transport_recv_notify_data *);
160 int (*notify_send_init)(struct vsock_sock *,
161 struct vsock_transport_send_notify_data *);
162 int (*notify_send_pre_block)(struct vsock_sock *,
163 struct vsock_transport_send_notify_data *);
164 int (*notify_send_pre_enqueue)(struct vsock_sock *,
165 struct vsock_transport_send_notify_data *);
166 int (*notify_send_post_enqueue)(struct vsock_sock *, ssize_t,
167 struct vsock_transport_send_notify_data *);
168 /* sk_lock held by the caller */
169 void (*notify_buffer_size)(struct vsock_sock *, u64 *);
170
171 /* Shutdown. */
172 int (*shutdown)(struct vsock_sock *, int);
173
174 /* Addressing. */
175 u32 (*get_local_cid)(void);
176};
177
178/**** CORE ****/
179
180int vsock_core_register(const struct vsock_transport *t, int features);
181void vsock_core_unregister(const struct vsock_transport *t);
182
183/* The transport may downcast this to access transport-specific functions */
184const struct vsock_transport *vsock_core_get_transport(struct vsock_sock *vsk);
185
186/**** UTILS ****/
187
188/* vsock_table_lock must be held */
189static inline bool __vsock_in_bound_table(struct vsock_sock *vsk)
190{
191 return !list_empty(&vsk->bound_table);
192}
193
194/* vsock_table_lock must be held */
195static inline bool __vsock_in_connected_table(struct vsock_sock *vsk)
196{
197 return !list_empty(&vsk->connected_table);
198}
199
200void vsock_release_pending(struct sock *pending);
201void vsock_add_pending(struct sock *listener, struct sock *pending);
202void vsock_remove_pending(struct sock *listener, struct sock *pending);
203void vsock_enqueue_accept(struct sock *listener, struct sock *connected);
204void vsock_insert_connected(struct vsock_sock *vsk);
205void vsock_remove_bound(struct vsock_sock *vsk);
206void vsock_remove_connected(struct vsock_sock *vsk);
207struct sock *vsock_find_bound_socket(struct sockaddr_vm *addr);
208struct sock *vsock_find_connected_socket(struct sockaddr_vm *src,
209 struct sockaddr_vm *dst);
210void vsock_remove_sock(struct vsock_sock *vsk);
211void vsock_for_each_connected_socket(struct vsock_transport *transport,
212 void (*fn)(struct sock *sk));
213int vsock_assign_transport(struct vsock_sock *vsk, struct vsock_sock *psk);
214bool vsock_find_cid(unsigned int cid);
215
216/**** TAP ****/
217
218struct vsock_tap {
219 struct net_device *dev;
220 struct module *module;
221 struct list_head list;
222};
223
224int vsock_init_tap(void);
225int vsock_add_tap(struct vsock_tap *vt);
226int vsock_remove_tap(struct vsock_tap *vt);
227void vsock_deliver_tap(struct sk_buff *build_skb(void *opaque), void *opaque);
228
229#endif /* __AF_VSOCK_H__ */