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