2 * VMware vSockets Driver
4 * Copyright (C) 2007-2013 VMware, Inc. All rights reserved.
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.
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
16 #ifndef __AF_VSOCK_H__
17 #define __AF_VSOCK_H__
19 #include <linux/kernel.h>
20 #include <linux/workqueue.h>
21 #include <linux/vm_sockets.h>
23 #include "vsock_addr.h"
25 #define LAST_RESERVED_PORT 1023
27 #define VSOCK_HASH_SIZE 251
28 extern struct list_head vsock_bind_table
[VSOCK_HASH_SIZE
+ 1];
29 extern struct list_head vsock_connected_table
[VSOCK_HASH_SIZE
];
30 extern spinlock_t vsock_table_lock
;
32 #define vsock_sk(__sk) ((struct vsock_sock *)__sk)
33 #define sk_vsock(__vsk) (&(__vsk)->sk)
36 /* sk must be the first member. */
38 struct sockaddr_vm local_addr
;
39 struct sockaddr_vm remote_addr
;
40 /* Links for the global tables of bound and connected sockets. */
41 struct list_head bound_table
;
42 struct list_head connected_table
;
43 /* Accessed without the socket lock held. This means it can never be
44 * modified outsided of socket create or destruct.
47 bool cached_peer_allow_dgram
; /* Dgram communication allowed to
50 u32 cached_peer
; /* Context ID of last dgram destination check. */
51 const struct cred
*owner
;
52 /* Rest are SOCK_STREAM only. */
54 /* Listening socket that this came from. */
55 struct sock
*listener
;
56 /* Used for pending list and accept queue during connection handshake.
57 * The listening socket is the head for both lists. Sockets created
58 * for connection requests are placed in the pending list until they
59 * are connected, at which point they are put in the accept queue list
60 * so they can be accepted in accept(). If accept() cannot accept the
61 * connection, it is marked as rejected so the cleanup function knows
62 * to clean up the socket.
64 struct list_head pending_links
;
65 struct list_head accept_queue
;
67 struct delayed_work dwork
;
68 struct delayed_work close_work
;
69 bool close_work_scheduled
;
72 bool ignore_connecting_rst
;
74 /* Private to transport. */
78 s64
vsock_stream_has_data(struct vsock_sock
*vsk
);
79 s64
vsock_stream_has_space(struct vsock_sock
*vsk
);
80 void vsock_pending_work(struct work_struct
*work
);
81 struct sock
*__vsock_create(struct net
*net
,
84 gfp_t priority
, unsigned short type
, int kern
);
88 struct vsock_transport_recv_notify_data
{
89 u64 data1
; /* Transport-defined. */
90 u64 data2
; /* Transport-defined. */
94 struct vsock_transport_send_notify_data
{
95 u64 data1
; /* Transport-defined. */
96 u64 data2
; /* Transport-defined. */
99 struct vsock_transport
{
100 /* Initialize/tear-down socket. */
101 int (*init
)(struct vsock_sock
*, struct vsock_sock
*);
102 void (*destruct
)(struct vsock_sock
*);
103 void (*release
)(struct vsock_sock
*);
105 /* Cancel all pending packets sent on vsock. */
106 int (*cancel_pkt
)(struct vsock_sock
*vsk
);
109 int (*connect
)(struct vsock_sock
*);
112 int (*dgram_bind
)(struct vsock_sock
*, struct sockaddr_vm
*);
113 int (*dgram_dequeue
)(struct vsock_sock
*vsk
, struct msghdr
*msg
,
114 size_t len
, int flags
);
115 int (*dgram_enqueue
)(struct vsock_sock
*, struct sockaddr_vm
*,
116 struct msghdr
*, size_t len
);
117 bool (*dgram_allow
)(u32 cid
, u32 port
);
120 /* TODO: stream_bind() */
121 ssize_t (*stream_dequeue
)(struct vsock_sock
*, struct msghdr
*,
122 size_t len
, int flags
);
123 ssize_t (*stream_enqueue
)(struct vsock_sock
*, struct msghdr
*,
125 s64 (*stream_has_data
)(struct vsock_sock
*);
126 s64 (*stream_has_space
)(struct vsock_sock
*);
127 u64 (*stream_rcvhiwat
)(struct vsock_sock
*);
128 bool (*stream_is_active
)(struct vsock_sock
*);
129 bool (*stream_allow
)(u32 cid
, u32 port
);
132 int (*notify_poll_in
)(struct vsock_sock
*, size_t, bool *);
133 int (*notify_poll_out
)(struct vsock_sock
*, size_t, bool *);
134 int (*notify_recv_init
)(struct vsock_sock
*, size_t,
135 struct vsock_transport_recv_notify_data
*);
136 int (*notify_recv_pre_block
)(struct vsock_sock
*, size_t,
137 struct vsock_transport_recv_notify_data
*);
138 int (*notify_recv_pre_dequeue
)(struct vsock_sock
*, size_t,
139 struct vsock_transport_recv_notify_data
*);
140 int (*notify_recv_post_dequeue
)(struct vsock_sock
*, size_t,
141 ssize_t
, bool, struct vsock_transport_recv_notify_data
*);
142 int (*notify_send_init
)(struct vsock_sock
*,
143 struct vsock_transport_send_notify_data
*);
144 int (*notify_send_pre_block
)(struct vsock_sock
*,
145 struct vsock_transport_send_notify_data
*);
146 int (*notify_send_pre_enqueue
)(struct vsock_sock
*,
147 struct vsock_transport_send_notify_data
*);
148 int (*notify_send_post_enqueue
)(struct vsock_sock
*, ssize_t
,
149 struct vsock_transport_send_notify_data
*);
152 int (*shutdown
)(struct vsock_sock
*, int);
155 void (*set_buffer_size
)(struct vsock_sock
*, u64
);
156 void (*set_min_buffer_size
)(struct vsock_sock
*, u64
);
157 void (*set_max_buffer_size
)(struct vsock_sock
*, u64
);
158 u64 (*get_buffer_size
)(struct vsock_sock
*);
159 u64 (*get_min_buffer_size
)(struct vsock_sock
*);
160 u64 (*get_max_buffer_size
)(struct vsock_sock
*);
163 u32 (*get_local_cid
)(void);
168 int __vsock_core_init(const struct vsock_transport
*t
, struct module
*owner
);
169 static inline int vsock_core_init(const struct vsock_transport
*t
)
171 return __vsock_core_init(t
, THIS_MODULE
);
173 void vsock_core_exit(void);
175 /* The transport may downcast this to access transport-specific functions */
176 const struct vsock_transport
*vsock_core_get_transport(void);
180 /* vsock_table_lock must be held */
181 static inline bool __vsock_in_bound_table(struct vsock_sock
*vsk
)
183 return !list_empty(&vsk
->bound_table
);
186 /* vsock_table_lock must be held */
187 static inline bool __vsock_in_connected_table(struct vsock_sock
*vsk
)
189 return !list_empty(&vsk
->connected_table
);
192 void vsock_release_pending(struct sock
*pending
);
193 void vsock_add_pending(struct sock
*listener
, struct sock
*pending
);
194 void vsock_remove_pending(struct sock
*listener
, struct sock
*pending
);
195 void vsock_enqueue_accept(struct sock
*listener
, struct sock
*connected
);
196 void vsock_insert_connected(struct vsock_sock
*vsk
);
197 void vsock_remove_bound(struct vsock_sock
*vsk
);
198 void vsock_remove_connected(struct vsock_sock
*vsk
);
199 struct sock
*vsock_find_bound_socket(struct sockaddr_vm
*addr
);
200 struct sock
*vsock_find_connected_socket(struct sockaddr_vm
*src
,
201 struct sockaddr_vm
*dst
);
202 void vsock_remove_sock(struct vsock_sock
*vsk
);
203 void vsock_for_each_connected_socket(void (*fn
)(struct sock
*sk
));
208 struct net_device
*dev
;
209 struct module
*module
;
210 struct list_head list
;
213 int vsock_init_tap(void);
214 int vsock_add_tap(struct vsock_tap
*vt
);
215 int vsock_remove_tap(struct vsock_tap
*vt
);
216 void vsock_deliver_tap(struct sk_buff
*build_skb(void *opaque
), void *opaque
);
218 #endif /* __AF_VSOCK_H__ */