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