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
30 struct 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 connect_work;
63 struct delayed_work pending_work;
64 struct delayed_work close_work;
65 bool close_work_scheduled;
66 u32 peer_shutdown;
67 bool sent_request;
68 bool ignore_connecting_rst;
69
70 /* Private to transport. */
71 void *trans;
72 };
73
74 s64 vsock_stream_has_data(struct vsock_sock *vsk);
75 s64 vsock_stream_has_space(struct vsock_sock *vsk);
76 struct sock *__vsock_create(struct net *net,
77 struct socket *sock,
78 struct sock *parent,
79 gfp_t priority, unsigned short type, int kern);
80
81 /**** TRANSPORT ****/
82
83 struct vsock_transport_recv_notify_data {
84 u64 data1; /* Transport-defined. */
85 u64 data2; /* Transport-defined. */
86 bool notify_on_block;
87 };
88
89 struct vsock_transport_send_notify_data {
90 u64 data1; /* Transport-defined. */
91 u64 data2; /* Transport-defined. */
92 };
93
94 struct vsock_transport {
95 /* Initialize/tear-down socket. */
96 int (*init)(struct vsock_sock *, struct vsock_sock *);
97 void (*destruct)(struct vsock_sock *);
98 void (*release)(struct vsock_sock *);
99
100 /* Cancel all pending packets sent on vsock. */
101 int (*cancel_pkt)(struct vsock_sock *vsk);
102
103 /* Connections. */
104 int (*connect)(struct vsock_sock *);
105
106 /* DGRAM. */
107 int (*dgram_bind)(struct vsock_sock *, struct sockaddr_vm *);
108 int (*dgram_dequeue)(struct vsock_sock *vsk, struct msghdr *msg,
109 size_t len, int flags);
110 int (*dgram_enqueue)(struct vsock_sock *, struct sockaddr_vm *,
111 struct msghdr *, size_t len);
112 bool (*dgram_allow)(u32 cid, u32 port);
113
114 /* STREAM. */
115 /* TODO: stream_bind() */
116 ssize_t (*stream_dequeue)(struct vsock_sock *, struct msghdr *,
117 size_t len, int flags);
118 ssize_t (*stream_enqueue)(struct vsock_sock *, struct msghdr *,
119 size_t len);
120 s64 (*stream_has_data)(struct vsock_sock *);
121 s64 (*stream_has_space)(struct vsock_sock *);
122 u64 (*stream_rcvhiwat)(struct vsock_sock *);
123 bool (*stream_is_active)(struct vsock_sock *);
124 bool (*stream_allow)(u32 cid, u32 port);
125
126 /* Notification. */
127 int (*notify_poll_in)(struct vsock_sock *, size_t, bool *);
128 int (*notify_poll_out)(struct vsock_sock *, size_t, bool *);
129 int (*notify_recv_init)(struct vsock_sock *, size_t,
130 struct vsock_transport_recv_notify_data *);
131 int (*notify_recv_pre_block)(struct vsock_sock *, size_t,
132 struct vsock_transport_recv_notify_data *);
133 int (*notify_recv_pre_dequeue)(struct vsock_sock *, size_t,
134 struct vsock_transport_recv_notify_data *);
135 int (*notify_recv_post_dequeue)(struct vsock_sock *, size_t,
136 ssize_t, bool, struct vsock_transport_recv_notify_data *);
137 int (*notify_send_init)(struct vsock_sock *,
138 struct vsock_transport_send_notify_data *);
139 int (*notify_send_pre_block)(struct vsock_sock *,
140 struct vsock_transport_send_notify_data *);
141 int (*notify_send_pre_enqueue)(struct vsock_sock *,
142 struct vsock_transport_send_notify_data *);
143 int (*notify_send_post_enqueue)(struct vsock_sock *, ssize_t,
144 struct vsock_transport_send_notify_data *);
145
146 /* Shutdown. */
147 int (*shutdown)(struct vsock_sock *, int);
148
149 /* Buffer sizes. */
150 void (*set_buffer_size)(struct vsock_sock *, u64);
151 void (*set_min_buffer_size)(struct vsock_sock *, u64);
152 void (*set_max_buffer_size)(struct vsock_sock *, u64);
153 u64 (*get_buffer_size)(struct vsock_sock *);
154 u64 (*get_min_buffer_size)(struct vsock_sock *);
155 u64 (*get_max_buffer_size)(struct vsock_sock *);
156
157 /* Addressing. */
158 u32 (*get_local_cid)(void);
159 };
160
161 /**** CORE ****/
162
163 int __vsock_core_init(const struct vsock_transport *t, struct module *owner);
vsock_core_init(const struct vsock_transport * t)164 static inline int vsock_core_init(const struct vsock_transport *t)
165 {
166 return __vsock_core_init(t, THIS_MODULE);
167 }
168 void vsock_core_exit(void);
169
170 /* The transport may downcast this to access transport-specific functions */
171 const struct vsock_transport *vsock_core_get_transport(void);
172
173 /**** UTILS ****/
174
175 void vsock_release_pending(struct sock *pending);
176 void vsock_add_pending(struct sock *listener, struct sock *pending);
177 void vsock_remove_pending(struct sock *listener, struct sock *pending);
178 void vsock_enqueue_accept(struct sock *listener, struct sock *connected);
179 void vsock_insert_connected(struct vsock_sock *vsk);
180 void vsock_remove_bound(struct vsock_sock *vsk);
181 void vsock_remove_connected(struct vsock_sock *vsk);
182 struct sock *vsock_find_bound_socket(struct sockaddr_vm *addr);
183 struct sock *vsock_find_connected_socket(struct sockaddr_vm *src,
184 struct sockaddr_vm *dst);
185 void vsock_remove_sock(struct vsock_sock *vsk);
186 void vsock_for_each_connected_socket(void (*fn)(struct sock *sk));
187
188 /**** TAP ****/
189
190 struct vsock_tap {
191 struct net_device *dev;
192 struct module *module;
193 struct list_head list;
194 };
195
196 int vsock_init_tap(void);
197 int vsock_add_tap(struct vsock_tap *vt);
198 int vsock_remove_tap(struct vsock_tap *vt);
199 void vsock_deliver_tap(struct sk_buff *build_skb(void *opaque), void *opaque);
200
201 #endif /* __AF_VSOCK_H__ */
202