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_connectible_has_data(struct vsock_sock *vsk);
 79s64 vsock_stream_has_data(struct vsock_sock *vsk);
 80s64 vsock_stream_has_space(struct vsock_sock *vsk);
 81struct sock *vsock_create_connected(struct sock *parent);
 82void vsock_data_ready(struct sock *sk);
 
 
 
 83
 84/**** TRANSPORT ****/
 85
 86struct vsock_transport_recv_notify_data {
 87	u64 data1; /* Transport-defined. */
 88	u64 data2; /* Transport-defined. */
 89	bool notify_on_block;
 90};
 91
 92struct vsock_transport_send_notify_data {
 93	u64 data1; /* Transport-defined. */
 94	u64 data2; /* Transport-defined. */
 95};
 96
 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
104/* Transport provides local (loopback) communication */
105#define VSOCK_TRANSPORT_F_LOCAL		0x00000008
106
107struct vsock_transport {
108	struct module *module;
109
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
115	/* Cancel all pending packets sent on vsock. */
116	int (*cancel_pkt)(struct vsock_sock *vsk);
117
118	/* Connections. */
119	int (*connect)(struct vsock_sock *);
120
121	/* DGRAM. */
122	int (*dgram_bind)(struct vsock_sock *, struct sockaddr_vm *);
123	int (*dgram_dequeue)(struct vsock_sock *vsk, struct msghdr *msg,
124			     size_t len, int flags);
125	int (*dgram_enqueue)(struct vsock_sock *, struct sockaddr_vm *,
126			     struct msghdr *, size_t len);
127	bool (*dgram_allow)(u32 cid, u32 port);
128
129	/* STREAM. */
130	/* TODO: stream_bind() */
131	ssize_t (*stream_dequeue)(struct vsock_sock *, struct msghdr *,
132				  size_t len, int flags);
133	ssize_t (*stream_enqueue)(struct vsock_sock *, struct msghdr *,
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);
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	int (*notify_set_rcvlowat)(struct vsock_sock *vsk, int val);
171
172	/* SIOCOUTQ ioctl */
173	ssize_t (*unsent_bytes)(struct vsock_sock *vsk);
174
175	/* Shutdown. */
176	int (*shutdown)(struct vsock_sock *, int);
177
 
 
 
 
 
 
 
 
178	/* Addressing. */
179	u32 (*get_local_cid)(void);
180
181	/* Read a single skb */
182	int (*read_skb)(struct vsock_sock *, skb_read_actor_t);
183
184	/* Zero-copy. */
185	bool (*msgzerocopy_allow)(void);
186};
187
188/**** CORE ****/
189
190int vsock_core_register(const struct vsock_transport *t, int features);
191void vsock_core_unregister(const struct vsock_transport *t);
192
193/* The transport may downcast this to access transport-specific functions */
194const struct vsock_transport *vsock_core_get_transport(struct vsock_sock *vsk);
195
196/**** UTILS ****/
197
198/* vsock_table_lock must be held */
199static inline bool __vsock_in_bound_table(struct vsock_sock *vsk)
200{
201	return !list_empty(&vsk->bound_table);
202}
 
203
204/* vsock_table_lock must be held */
205static inline bool __vsock_in_connected_table(struct vsock_sock *vsk)
206{
207	return !list_empty(&vsk->connected_table);
208}
209
 
210void vsock_add_pending(struct sock *listener, struct sock *pending);
211void vsock_remove_pending(struct sock *listener, struct sock *pending);
212void vsock_enqueue_accept(struct sock *listener, struct sock *connected);
213void vsock_insert_connected(struct vsock_sock *vsk);
214void vsock_remove_bound(struct vsock_sock *vsk);
215void vsock_remove_connected(struct vsock_sock *vsk);
216struct sock *vsock_find_bound_socket(struct sockaddr_vm *addr);
217struct sock *vsock_find_connected_socket(struct sockaddr_vm *src,
218					 struct sockaddr_vm *dst);
219void vsock_remove_sock(struct vsock_sock *vsk);
220void vsock_for_each_connected_socket(struct vsock_transport *transport,
221				     void (*fn)(struct sock *sk));
222int vsock_assign_transport(struct vsock_sock *vsk, struct vsock_sock *psk);
223bool vsock_find_cid(unsigned int cid);
224
225/**** TAP ****/
226
227struct vsock_tap {
228	struct net_device *dev;
229	struct module *module;
230	struct list_head list;
231};
232
233int vsock_add_tap(struct vsock_tap *vt);
234int vsock_remove_tap(struct vsock_tap *vt);
235void vsock_deliver_tap(struct sk_buff *build_skb(void *opaque), void *opaque);
236int __vsock_connectible_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
237				int flags);
238int vsock_connectible_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
239			      int flags);
240int __vsock_dgram_recvmsg(struct socket *sock, struct msghdr *msg,
241			  size_t len, int flags);
242int vsock_dgram_recvmsg(struct socket *sock, struct msghdr *msg,
243			size_t len, int flags);
244
245#ifdef CONFIG_BPF_SYSCALL
246extern struct proto vsock_proto;
247int vsock_bpf_update_proto(struct sock *sk, struct sk_psock *psock, bool restore);
248void __init vsock_bpf_build_proto(void);
249#else
250static inline void __init vsock_bpf_build_proto(void)
251{}
252#endif
253
254static inline bool vsock_msgzerocopy_allow(const struct vsock_transport *t)
255{
256	return t->msgzerocopy_allow && t->msgzerocopy_allow();
257}
258#endif /* __AF_VSOCK_H__ */

 
  1/*
  2 * VMware vSockets Driver
  3 *
  4 * Copyright (C) 2007-2013 VMware, Inc. All rights reserved.
  5 *
  6 * This program is free software; you can redistribute it and/or modify it
  7 * under the terms of the GNU General Public License as published by the Free
  8 * Software Foundation version 2 and no later version.
  9 *
 10 * This program is distributed in the hope that it will be useful, but WITHOUT
 11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 12 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 13 * more details.
 14 */
 15
 16#ifndef __AF_VSOCK_H__
 17#define __AF_VSOCK_H__
 18
 19#include <linux/kernel.h>
 20#include <linux/workqueue.h>
 21#include <linux/vm_sockets.h>
 
 22
 23#include "vsock_addr.h"
 24
 25/* vsock-specific sock->sk_state constants */
 26#define VSOCK_SS_LISTEN 255
 27
 28#define LAST_RESERVED_PORT 1023
 
 
 
 29
 30#define vsock_sk(__sk)    ((struct vsock_sock *)__sk)
 31#define sk_vsock(__vsk)   (&(__vsk)->sk)
 32
 33struct vsock_sock {
 34	/* sk must be the first member. */
 35	struct sock sk;
 
 36	struct sockaddr_vm local_addr;
 37	struct sockaddr_vm remote_addr;
 38	/* Links for the global tables of bound and connected sockets. */
 39	struct list_head bound_table;
 40	struct list_head connected_table;
 41	/* Accessed without the socket lock held. This means it can never be
 42	 * modified outsided of socket create or destruct.
 43	 */
 44	bool trusted;
 45	bool cached_peer_allow_dgram;	/* Dgram communication allowed to
 46					 * cached peer?
 47					 */
 48	u32 cached_peer;  /* Context ID of last dgram destination check. */
 49	const struct cred *owner;
 50	/* Rest are SOCK_STREAM only. */
 51	long connect_timeout;
 52	/* Listening socket that this came from. */
 53	struct sock *listener;
 54	/* Used for pending list and accept queue during connection handshake.
 55	 * The listening socket is the head for both lists.  Sockets created
 56	 * for connection requests are placed in the pending list until they
 57	 * are connected, at which point they are put in the accept queue list
 58	 * so they can be accepted in accept().  If accept() cannot accept the
 59	 * connection, it is marked as rejected so the cleanup function knows
 60	 * to clean up the socket.
 61	 */
 62	struct list_head pending_links;
 63	struct list_head accept_queue;
 64	bool rejected;
 65	struct delayed_work dwork;
 
 
 
 66	u32 peer_shutdown;
 67	bool sent_request;
 68	bool ignore_connecting_rst;
 69
 
 
 
 
 
 70	/* Private to transport. */
 71	void *trans;
 72};
 73
 
 74s64 vsock_stream_has_data(struct vsock_sock *vsk);
 75s64 vsock_stream_has_space(struct vsock_sock *vsk);
 76void vsock_pending_work(struct work_struct *work);
 77struct sock *__vsock_create(struct net *net,
 78			    struct socket *sock,
 79			    struct sock *parent,
 80			    gfp_t priority, unsigned short type, int kern);
 81
 82/**** TRANSPORT ****/
 83
 84struct vsock_transport_recv_notify_data {
 85	u64 data1; /* Transport-defined. */
 86	u64 data2; /* Transport-defined. */
 87	bool notify_on_block;
 88};
 89
 90struct vsock_transport_send_notify_data {
 91	u64 data1; /* Transport-defined. */
 92	u64 data2; /* Transport-defined. */
 93};
 94
 
 
 
 
 
 
 
 
 
 
 95struct vsock_transport {
 
 
 96	/* Initialize/tear-down socket. */
 97	int (*init)(struct vsock_sock *, struct vsock_sock *);
 98	void (*destruct)(struct vsock_sock *);
 99	void (*release)(struct vsock_sock *);
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
161int __vsock_core_init(const struct vsock_transport *t, struct module *owner);
162static inline int vsock_core_init(const struct vsock_transport *t)
 
 
 
 
 
 
 
 
163{
164	return __vsock_core_init(t, THIS_MODULE);
165}
166void vsock_core_exit(void);
167
168/**** UTILS ****/
 
 
 
 
169
170void vsock_release_pending(struct sock *pending);
171void vsock_add_pending(struct sock *listener, struct sock *pending);
172void vsock_remove_pending(struct sock *listener, struct sock *pending);
173void vsock_enqueue_accept(struct sock *listener, struct sock *connected);
174void vsock_insert_connected(struct vsock_sock *vsk);
175void vsock_remove_bound(struct vsock_sock *vsk);
176void vsock_remove_connected(struct vsock_sock *vsk);
177struct sock *vsock_find_bound_socket(struct sockaddr_vm *addr);
178struct sock *vsock_find_connected_socket(struct sockaddr_vm *src,
179					 struct sockaddr_vm *dst);
180void vsock_for_each_connected_socket(void (*fn)(struct sock *sk));
 
 
 
 
 
 
 
 
 
 
 
 
181
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
182#endif /* __AF_VSOCK_H__ */