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