LXR linux/net/vmw_vsock/af

   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
  30struct 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 dwork;
  63        u32 peer_shutdown;
  64        bool sent_request;
  65        bool ignore_connecting_rst;
  66
  67        /* Private to transport. */
  68        void *trans;
  69};
  70
  71s64 vsock_stream_has_data(struct vsock_sock *vsk);
  72s64 vsock_stream_has_space(struct vsock_sock *vsk);
  73void vsock_pending_work(struct work_struct *work);
  74struct sock *__vsock_create(struct net *net,
  75                            struct socket *sock,
  76                            struct sock *parent,
  77                            gfp_t priority, unsigned short type);
  78
  79/**** TRANSPORT ****/
  80
  81struct vsock_transport_recv_notify_data {
  82        u64 data1; /* Transport-defined. */
  83        u64 data2; /* Transport-defined. */
  84        bool notify_on_block;
  85};
  86
  87struct vsock_transport_send_notify_data {
  88        u64 data1; /* Transport-defined. */
  89        u64 data2; /* Transport-defined. */
  90};
  91
  92struct vsock_transport {
  93        /* Initialize/tear-down socket. */
  94        int (*init)(struct vsock_sock *, struct vsock_sock *);
  95        void (*destruct)(struct vsock_sock *);
  96        void (*release)(struct vsock_sock *);
  97
  98        /* Connections. */
  99        int (*connect)(struct vsock_sock *);
 100
 101        /* DGRAM. */
 102        int (*dgram_bind)(struct vsock_sock *, struct sockaddr_vm *);
 103        int (*dgram_dequeue)(struct kiocb *kiocb, struct vsock_sock *vsk,
 104                             struct msghdr *msg, size_t len, int flags);
 105        int (*dgram_enqueue)(struct vsock_sock *, struct sockaddr_vm *,
 106                             struct iovec *, size_t len);
 107        bool (*dgram_allow)(u32 cid, u32 port);
 108
 109        /* STREAM. */
 110        /* TODO: stream_bind() */
 111        ssize_t (*stream_dequeue)(struct vsock_sock *, struct iovec *,
 112                                  size_t len, int flags);
 113        ssize_t (*stream_enqueue)(struct vsock_sock *, struct iovec *,
 114                                  size_t len);
 115        s64 (*stream_has_data)(struct vsock_sock *);
 116        s64 (*stream_has_space)(struct vsock_sock *);
 117        u64 (*stream_rcvhiwat)(struct vsock_sock *);
 118        bool (*stream_is_active)(struct vsock_sock *);
 119        bool (*stream_allow)(u32 cid, u32 port);
 120
 121        /* Notification. */
 122        int (*notify_poll_in)(struct vsock_sock *, size_t, bool *);
 123        int (*notify_poll_out)(struct vsock_sock *, size_t, bool *);
 124        int (*notify_recv_init)(struct vsock_sock *, size_t,
 125                struct vsock_transport_recv_notify_data *);
 126        int (*notify_recv_pre_block)(struct vsock_sock *, size_t,
 127                struct vsock_transport_recv_notify_data *);
 128        int (*notify_recv_pre_dequeue)(struct vsock_sock *, size_t,
 129                struct vsock_transport_recv_notify_data *);
 130        int (*notify_recv_post_dequeue)(struct vsock_sock *, size_t,
 131                ssize_t, bool, struct vsock_transport_recv_notify_data *);
 132        int (*notify_send_init)(struct vsock_sock *,
 133                struct vsock_transport_send_notify_data *);
 134        int (*notify_send_pre_block)(struct vsock_sock *,
 135                struct vsock_transport_send_notify_data *);
 136        int (*notify_send_pre_enqueue)(struct vsock_sock *,
 137                struct vsock_transport_send_notify_data *);
 138        int (*notify_send_post_enqueue)(struct vsock_sock *, ssize_t,
 139                struct vsock_transport_send_notify_data *);
 140
 141        /* Shutdown. */
 142        int (*shutdown)(struct vsock_sock *, int);
 143
 144        /* Buffer sizes. */
 145        void (*set_buffer_size)(struct vsock_sock *, u64);
 146        void (*set_min_buffer_size)(struct vsock_sock *, u64);
 147        void (*set_max_buffer_size)(struct vsock_sock *, u64);
 148        u64 (*get_buffer_size)(struct vsock_sock *);
 149        u64 (*get_min_buffer_size)(struct vsock_sock *);
 150        u64 (*get_max_buffer_size)(struct vsock_sock *);
 151
 152        /* Addressing. */
 153        u32 (*get_local_cid)(void);
 154};
 155
 156/**** CORE ****/
 157
 158int vsock_core_init(const struct vsock_transport *t);
 159void vsock_core_exit(void);
 160
 161/**** UTILS ****/
 162
 163void vsock_release_pending(struct sock *pending);
 164void vsock_add_pending(struct sock *listener, struct sock *pending);
 165void vsock_remove_pending(struct sock *listener, struct sock *pending);
 166void vsock_enqueue_accept(struct sock *listener, struct sock *connected);
 167void vsock_insert_connected(struct vsock_sock *vsk);
 168void vsock_remove_bound(struct vsock_sock *vsk);
 169void vsock_remove_connected(struct vsock_sock *vsk);
 170struct sock *vsock_find_bound_socket(struct sockaddr_vm *addr);
 171struct sock *vsock_find_connected_socket(struct sockaddr_vm *src,
 172                                         struct sockaddr_vm *dst);
 173void vsock_for_each_connected_socket(void (*fn)(struct sock *sk));
 174
 175#endif /* __AF_VSOCK_H__ */
 176