182a54d0eSAsias He /* 282a54d0eSAsias He * VMware vSockets Driver 382a54d0eSAsias He * 482a54d0eSAsias He * Copyright (C) 2007-2013 VMware, Inc. All rights reserved. 582a54d0eSAsias He * 682a54d0eSAsias He * This program is free software; you can redistribute it and/or modify it 782a54d0eSAsias He * under the terms of the GNU General Public License as published by the Free 882a54d0eSAsias He * Software Foundation version 2 and no later version. 982a54d0eSAsias He * 1082a54d0eSAsias He * This program is distributed in the hope that it will be useful, but WITHOUT 1182a54d0eSAsias He * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1282a54d0eSAsias He * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 1382a54d0eSAsias He * more details. 1482a54d0eSAsias He */ 1582a54d0eSAsias He 1682a54d0eSAsias He #ifndef __AF_VSOCK_H__ 1782a54d0eSAsias He #define __AF_VSOCK_H__ 1882a54d0eSAsias He 1982a54d0eSAsias He #include <linux/kernel.h> 2082a54d0eSAsias He #include <linux/workqueue.h> 2182a54d0eSAsias He #include <linux/vm_sockets.h> 2282a54d0eSAsias He 2382a54d0eSAsias He #include "vsock_addr.h" 2482a54d0eSAsias He 25ea3803c1SStefan Hajnoczi /* vsock-specific sock->sk_state constants */ 26ea3803c1SStefan Hajnoczi #define VSOCK_SS_LISTEN 255 27ea3803c1SStefan Hajnoczi 2882a54d0eSAsias He #define LAST_RESERVED_PORT 1023 2982a54d0eSAsias He 3044f20980SStefan Hajnoczi #define VSOCK_HASH_SIZE 251 3144f20980SStefan Hajnoczi extern struct list_head vsock_bind_table[VSOCK_HASH_SIZE + 1]; 3244f20980SStefan Hajnoczi extern struct list_head vsock_connected_table[VSOCK_HASH_SIZE]; 3344f20980SStefan Hajnoczi extern spinlock_t vsock_table_lock; 3444f20980SStefan Hajnoczi 3582a54d0eSAsias He #define vsock_sk(__sk) ((struct vsock_sock *)__sk) 3682a54d0eSAsias He #define sk_vsock(__vsk) (&(__vsk)->sk) 3782a54d0eSAsias He 3882a54d0eSAsias He struct vsock_sock { 3982a54d0eSAsias He /* sk must be the first member. */ 4082a54d0eSAsias He struct sock sk; 4182a54d0eSAsias He struct sockaddr_vm local_addr; 4282a54d0eSAsias He struct sockaddr_vm remote_addr; 4382a54d0eSAsias He /* Links for the global tables of bound and connected sockets. */ 4482a54d0eSAsias He struct list_head bound_table; 4582a54d0eSAsias He struct list_head connected_table; 4682a54d0eSAsias He /* Accessed without the socket lock held. This means it can never be 4782a54d0eSAsias He * modified outsided of socket create or destruct. 4882a54d0eSAsias He */ 4982a54d0eSAsias He bool trusted; 5082a54d0eSAsias He bool cached_peer_allow_dgram; /* Dgram communication allowed to 5182a54d0eSAsias He * cached peer? 5282a54d0eSAsias He */ 5382a54d0eSAsias He u32 cached_peer; /* Context ID of last dgram destination check. */ 5482a54d0eSAsias He const struct cred *owner; 5582a54d0eSAsias He /* Rest are SOCK_STREAM only. */ 5682a54d0eSAsias He long connect_timeout; 5782a54d0eSAsias He /* Listening socket that this came from. */ 5882a54d0eSAsias He struct sock *listener; 5982a54d0eSAsias He /* Used for pending list and accept queue during connection handshake. 6082a54d0eSAsias He * The listening socket is the head for both lists. Sockets created 6182a54d0eSAsias He * for connection requests are placed in the pending list until they 6282a54d0eSAsias He * are connected, at which point they are put in the accept queue list 6382a54d0eSAsias He * so they can be accepted in accept(). If accept() cannot accept the 6482a54d0eSAsias He * connection, it is marked as rejected so the cleanup function knows 6582a54d0eSAsias He * to clean up the socket. 6682a54d0eSAsias He */ 6782a54d0eSAsias He struct list_head pending_links; 6882a54d0eSAsias He struct list_head accept_queue; 6982a54d0eSAsias He bool rejected; 7082a54d0eSAsias He struct delayed_work dwork; 7106a8fc78SAsias He struct delayed_work close_work; 7206a8fc78SAsias He bool close_work_scheduled; 7382a54d0eSAsias He u32 peer_shutdown; 7482a54d0eSAsias He bool sent_request; 7582a54d0eSAsias He bool ignore_connecting_rst; 7682a54d0eSAsias He 7782a54d0eSAsias He /* Private to transport. */ 7882a54d0eSAsias He void *trans; 7982a54d0eSAsias He }; 8082a54d0eSAsias He 8182a54d0eSAsias He s64 vsock_stream_has_data(struct vsock_sock *vsk); 8282a54d0eSAsias He s64 vsock_stream_has_space(struct vsock_sock *vsk); 8382a54d0eSAsias He void vsock_pending_work(struct work_struct *work); 8482a54d0eSAsias He struct sock *__vsock_create(struct net *net, 8582a54d0eSAsias He struct socket *sock, 8682a54d0eSAsias He struct sock *parent, 8711aa9c28SEric W. Biederman gfp_t priority, unsigned short type, int kern); 8882a54d0eSAsias He 8982a54d0eSAsias He /**** TRANSPORT ****/ 9082a54d0eSAsias He 9182a54d0eSAsias He struct vsock_transport_recv_notify_data { 9282a54d0eSAsias He u64 data1; /* Transport-defined. */ 9382a54d0eSAsias He u64 data2; /* Transport-defined. */ 9482a54d0eSAsias He bool notify_on_block; 9582a54d0eSAsias He }; 9682a54d0eSAsias He 9782a54d0eSAsias He struct vsock_transport_send_notify_data { 9882a54d0eSAsias He u64 data1; /* Transport-defined. */ 9982a54d0eSAsias He u64 data2; /* Transport-defined. */ 10082a54d0eSAsias He }; 10182a54d0eSAsias He 10282a54d0eSAsias He struct vsock_transport { 10382a54d0eSAsias He /* Initialize/tear-down socket. */ 10482a54d0eSAsias He int (*init)(struct vsock_sock *, struct vsock_sock *); 10582a54d0eSAsias He void (*destruct)(struct vsock_sock *); 10682a54d0eSAsias He void (*release)(struct vsock_sock *); 10782a54d0eSAsias He 10816320f36SPeng Tao /* Cancel all pending packets sent on vsock. */ 10916320f36SPeng Tao int (*cancel_pkt)(struct vsock_sock *vsk); 11016320f36SPeng Tao 11182a54d0eSAsias He /* Connections. */ 11282a54d0eSAsias He int (*connect)(struct vsock_sock *); 11382a54d0eSAsias He 11482a54d0eSAsias He /* DGRAM. */ 11582a54d0eSAsias He int (*dgram_bind)(struct vsock_sock *, struct sockaddr_vm *); 1161b784140SYing Xue int (*dgram_dequeue)(struct vsock_sock *vsk, struct msghdr *msg, 1171b784140SYing Xue size_t len, int flags); 11882a54d0eSAsias He int (*dgram_enqueue)(struct vsock_sock *, struct sockaddr_vm *, 1190f7db23aSAl Viro struct msghdr *, size_t len); 12082a54d0eSAsias He bool (*dgram_allow)(u32 cid, u32 port); 12182a54d0eSAsias He 12282a54d0eSAsias He /* STREAM. */ 12382a54d0eSAsias He /* TODO: stream_bind() */ 1240f7db23aSAl Viro ssize_t (*stream_dequeue)(struct vsock_sock *, struct msghdr *, 12582a54d0eSAsias He size_t len, int flags); 1260f7db23aSAl Viro ssize_t (*stream_enqueue)(struct vsock_sock *, struct msghdr *, 12782a54d0eSAsias He size_t len); 12882a54d0eSAsias He s64 (*stream_has_data)(struct vsock_sock *); 12982a54d0eSAsias He s64 (*stream_has_space)(struct vsock_sock *); 13082a54d0eSAsias He u64 (*stream_rcvhiwat)(struct vsock_sock *); 13182a54d0eSAsias He bool (*stream_is_active)(struct vsock_sock *); 13282a54d0eSAsias He bool (*stream_allow)(u32 cid, u32 port); 13382a54d0eSAsias He 13482a54d0eSAsias He /* Notification. */ 13582a54d0eSAsias He int (*notify_poll_in)(struct vsock_sock *, size_t, bool *); 13682a54d0eSAsias He int (*notify_poll_out)(struct vsock_sock *, size_t, bool *); 13782a54d0eSAsias He int (*notify_recv_init)(struct vsock_sock *, size_t, 13882a54d0eSAsias He struct vsock_transport_recv_notify_data *); 13982a54d0eSAsias He int (*notify_recv_pre_block)(struct vsock_sock *, size_t, 14082a54d0eSAsias He struct vsock_transport_recv_notify_data *); 14182a54d0eSAsias He int (*notify_recv_pre_dequeue)(struct vsock_sock *, size_t, 14282a54d0eSAsias He struct vsock_transport_recv_notify_data *); 14382a54d0eSAsias He int (*notify_recv_post_dequeue)(struct vsock_sock *, size_t, 14482a54d0eSAsias He ssize_t, bool, struct vsock_transport_recv_notify_data *); 14582a54d0eSAsias He int (*notify_send_init)(struct vsock_sock *, 14682a54d0eSAsias He struct vsock_transport_send_notify_data *); 14782a54d0eSAsias He int (*notify_send_pre_block)(struct vsock_sock *, 14882a54d0eSAsias He struct vsock_transport_send_notify_data *); 14982a54d0eSAsias He int (*notify_send_pre_enqueue)(struct vsock_sock *, 15082a54d0eSAsias He struct vsock_transport_send_notify_data *); 15182a54d0eSAsias He int (*notify_send_post_enqueue)(struct vsock_sock *, ssize_t, 15282a54d0eSAsias He struct vsock_transport_send_notify_data *); 15382a54d0eSAsias He 15482a54d0eSAsias He /* Shutdown. */ 15582a54d0eSAsias He int (*shutdown)(struct vsock_sock *, int); 15682a54d0eSAsias He 15782a54d0eSAsias He /* Buffer sizes. */ 15882a54d0eSAsias He void (*set_buffer_size)(struct vsock_sock *, u64); 15982a54d0eSAsias He void (*set_min_buffer_size)(struct vsock_sock *, u64); 16082a54d0eSAsias He void (*set_max_buffer_size)(struct vsock_sock *, u64); 16182a54d0eSAsias He u64 (*get_buffer_size)(struct vsock_sock *); 16282a54d0eSAsias He u64 (*get_min_buffer_size)(struct vsock_sock *); 16382a54d0eSAsias He u64 (*get_max_buffer_size)(struct vsock_sock *); 16482a54d0eSAsias He 16582a54d0eSAsias He /* Addressing. */ 16682a54d0eSAsias He u32 (*get_local_cid)(void); 16782a54d0eSAsias He }; 16882a54d0eSAsias He 16982a54d0eSAsias He /**** CORE ****/ 17082a54d0eSAsias He 1712c4a336eSAndy King int __vsock_core_init(const struct vsock_transport *t, struct module *owner); 1722c4a336eSAndy King static inline int vsock_core_init(const struct vsock_transport *t) 1732c4a336eSAndy King { 1742c4a336eSAndy King return __vsock_core_init(t, THIS_MODULE); 1752c4a336eSAndy King } 17682a54d0eSAsias He void vsock_core_exit(void); 17782a54d0eSAsias He 1780b01aeb3SStefan Hajnoczi /* The transport may downcast this to access transport-specific functions */ 1790b01aeb3SStefan Hajnoczi const struct vsock_transport *vsock_core_get_transport(void); 1800b01aeb3SStefan Hajnoczi 18182a54d0eSAsias He /**** UTILS ****/ 18282a54d0eSAsias He 18382a54d0eSAsias He void vsock_release_pending(struct sock *pending); 18482a54d0eSAsias He void vsock_add_pending(struct sock *listener, struct sock *pending); 18582a54d0eSAsias He void vsock_remove_pending(struct sock *listener, struct sock *pending); 18682a54d0eSAsias He void vsock_enqueue_accept(struct sock *listener, struct sock *connected); 18782a54d0eSAsias He void vsock_insert_connected(struct vsock_sock *vsk); 18882a54d0eSAsias He void vsock_remove_bound(struct vsock_sock *vsk); 18982a54d0eSAsias He void vsock_remove_connected(struct vsock_sock *vsk); 19082a54d0eSAsias He struct sock *vsock_find_bound_socket(struct sockaddr_vm *addr); 19182a54d0eSAsias He struct sock *vsock_find_connected_socket(struct sockaddr_vm *src, 19282a54d0eSAsias He struct sockaddr_vm *dst); 1936773b7dcSStefan Hajnoczi void vsock_remove_sock(struct vsock_sock *vsk); 19482a54d0eSAsias He void vsock_for_each_connected_socket(void (*fn)(struct sock *sk)); 19582a54d0eSAsias He 196531b3748SGerard Garcia /**** TAP ****/ 197531b3748SGerard Garcia 198531b3748SGerard Garcia struct vsock_tap { 199531b3748SGerard Garcia struct net_device *dev; 200531b3748SGerard Garcia struct module *module; 201531b3748SGerard Garcia struct list_head list; 202531b3748SGerard Garcia }; 203531b3748SGerard Garcia 204531b3748SGerard Garcia int vsock_init_tap(void); 205531b3748SGerard Garcia int vsock_add_tap(struct vsock_tap *vt); 206531b3748SGerard Garcia int vsock_remove_tap(struct vsock_tap *vt); 207531b3748SGerard Garcia void vsock_deliver_tap(struct sk_buff *build_skb(void *opaque), void *opaque); 208531b3748SGerard Garcia 20982a54d0eSAsias He #endif /* __AF_VSOCK_H__ */ 210