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