include/net/af_vsock.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * VMware vSockets Driver
   4  *
   5  * Copyright (C) 2007-2013 VMware, Inc. All rights reserved.
   6  */
   7
   8 #ifndef __AF_VSOCK_H__
   9 #define __AF_VSOCK_H__
  10
  11 #include <linux/kernel.h>
  12 #include <linux/workqueue.h>
  13 #include <net/sock.h>
  14 #include <uapi/linux/vm_sockets.h>
  15
  16 #include "vsock_addr.h"
  17
  18 #define LAST_RESERVED_PORT 1023
  19
  20 #define VSOCK_HASH_SIZE         251
  21 extern struct list_head vsock_bind_table[VSOCK_HASH_SIZE + 1];
  22 extern struct list_head vsock_connected_table[VSOCK_HASH_SIZE];
  23 extern spinlock_t vsock_table_lock;
  24
  25 #define vsock_sk(__sk)    ((struct vsock_sock *)__sk)
  26 #define sk_vsock(__vsk)   (&(__vsk)->sk)
  27
  28 struct vsock_sock {
  29         /* sk must be the first member. */
  30         struct sock sk;
  31         const struct vsock_transport *transport;
  32         struct sockaddr_vm local_addr;
  33         struct sockaddr_vm remote_addr;
  34         /* Links for the global tables of bound and connected sockets. */
  35         struct list_head bound_table;
  36         struct list_head connected_table;
  37         /* Accessed without the socket lock held. This means it can never be
  38          * modified outsided of socket create or destruct.
  39          */
  40         bool trusted;
  41         bool cached_peer_allow_dgram;   /* Dgram communication allowed to
  42                                          * cached peer?
  43                                          */
  44         u32 cached_peer;  /* Context ID of last dgram destination check. */
  45         const struct cred *owner;
  46         /* Rest are SOCK_STREAM only. */
  47         long connect_timeout;
  48         /* Listening socket that this came from. */
  49         struct sock *listener;
  50         /* Used for pending list and accept queue during connection handshake.
  51          * The listening socket is the head for both lists.  Sockets created
  52          * for connection requests are placed in the pending list until they
  53          * are connected, at which point they are put in the accept queue list
  54          * so they can be accepted in accept().  If accept() cannot accept the
  55          * connection, it is marked as rejected so the cleanup function knows
  56          * to clean up the socket.
  57          */
  58         struct list_head pending_links;
  59         struct list_head accept_queue;
  60         bool rejected;
  61         struct delayed_work connect_work;
  62         struct delayed_work pending_work;
  63         struct delayed_work close_work;
  64         bool close_work_scheduled;
  65         u32 peer_shutdown;
  66         bool sent_request;
  67         bool ignore_connecting_rst;
  68
  69         /* Protected by lock_sock(sk) */
  70         u64 buffer_size;
  71         u64 buffer_min_size;
  72         u64 buffer_max_size;
  73
  74         /* Private to transport. */
  75         void *trans;
  76 };
  77
  78 s64 vsock_stream_has_data(struct vsock_sock *vsk);
  79 s64 vsock_stream_has_space(struct vsock_sock *vsk);
  80 struct sock *vsock_create_connected(struct sock *parent);
  81
  82 /**** TRANSPORT ****/
  83
  84 struct vsock_transport_recv_notify_data {
  85         u64 data1; /* Transport-defined. */
  86         u64 data2; /* Transport-defined. */
  87         bool notify_on_block;
  88 };
  89
  90 struct vsock_transport_send_notify_data {
  91         u64 data1; /* Transport-defined. */
  92         u64 data2; /* Transport-defined. */
  93 };
  94
  95 /* Transport features flags */
  96 /* Transport provides host->guest communication */
  97 #define VSOCK_TRANSPORT_F_H2G           0x00000001
  98 /* Transport provides guest->host communication */
  99 #define VSOCK_TRANSPORT_F_G2H           0x00000002
 100 /* Transport provides DGRAM communication */
 101 #define VSOCK_TRANSPORT_F_DGRAM         0x00000004
 102 /* Transport provides local (loopback) communication */
 103 #define VSOCK_TRANSPORT_F_LOCAL         0x00000008
 104
 105 struct vsock_transport {
 106         struct module *module;
 107
 108         /* Initialize/tear-down socket. */
 109         int (*init)(struct vsock_sock *, struct vsock_sock *);
 110         void (*destruct)(struct vsock_sock *);
 111         void (*release)(struct vsock_sock *);
 112
 113         /* Cancel all pending packets sent on vsock. */
 114         int (*cancel_pkt)(struct vsock_sock *vsk);
 115
 116         /* Connections. */
 117         int (*connect)(struct vsock_sock *);
 118
 119         /* DGRAM. */
 120         int (*dgram_bind)(struct vsock_sock *, struct sockaddr_vm *);
 121         int (*dgram_dequeue)(struct vsock_sock *vsk, struct msghdr *msg,
 122                              size_t len, int flags);
 123         int (*dgram_enqueue)(struct vsock_sock *, struct sockaddr_vm *,
 124                              struct msghdr *, size_t len);
 125         bool (*dgram_allow)(u32 cid, u32 port);
 126
 127         /* STREAM. */
 128         /* TODO: stream_bind() */
 129         ssize_t (*stream_dequeue)(struct vsock_sock *, struct msghdr *,
 130                                   size_t len, int flags);
 131         ssize_t (*stream_enqueue)(struct vsock_sock *, struct msghdr *,
 132                                   size_t len);
 133         s64 (*stream_has_data)(struct vsock_sock *);
 134         s64 (*stream_has_space)(struct vsock_sock *);
 135         u64 (*stream_rcvhiwat)(struct vsock_sock *);
 136         bool (*stream_is_active)(struct vsock_sock *);
 137         bool (*stream_allow)(u32 cid, u32 port);
 138
 139         /* SEQ_PACKET. */
 140         ssize_t (*seqpacket_dequeue)(struct vsock_sock *vsk, struct msghdr *msg,
 141                                      int flags);
 142         int (*seqpacket_enqueue)(struct vsock_sock *vsk, struct msghdr *msg,
 143                                  size_t len);
 144         bool (*seqpacket_allow)(u32 remote_cid);
 145         u32 (*seqpacket_has_data)(struct vsock_sock *vsk);
 146
 147         /* Notification. */
 148         int (*notify_poll_in)(struct vsock_sock *, size_t, bool *);
 149         int (*notify_poll_out)(struct vsock_sock *, size_t, bool *);
 150         int (*notify_recv_init)(struct vsock_sock *, size_t,
 151                 struct vsock_transport_recv_notify_data *);
 152         int (*notify_recv_pre_block)(struct vsock_sock *, size_t,
 153                 struct vsock_transport_recv_notify_data *);
 154         int (*notify_recv_pre_dequeue)(struct vsock_sock *, size_t,
 155                 struct vsock_transport_recv_notify_data *);
 156         int (*notify_recv_post_dequeue)(struct vsock_sock *, size_t,
 157                 ssize_t, bool, struct vsock_transport_recv_notify_data *);
 158         int (*notify_send_init)(struct vsock_sock *,
 159                 struct vsock_transport_send_notify_data *);
 160         int (*notify_send_pre_block)(struct vsock_sock *,
 161                 struct vsock_transport_send_notify_data *);
 162         int (*notify_send_pre_enqueue)(struct vsock_sock *,
 163                 struct vsock_transport_send_notify_data *);
 164         int (*notify_send_post_enqueue)(struct vsock_sock *, ssize_t,
 165                 struct vsock_transport_send_notify_data *);
 166         /* sk_lock held by the caller */
 167         void (*notify_buffer_size)(struct vsock_sock *, u64 *);
 168
 169         /* Shutdown. */
 170         int (*shutdown)(struct vsock_sock *, int);
 171
 172         /* Addressing. */
 173         u32 (*get_local_cid)(void);
 174 };
 175
 176 /**** CORE ****/
 177
 178 int vsock_core_register(const struct vsock_transport *t, int features);
 179 void vsock_core_unregister(const struct vsock_transport *t);
 180
 181 /* The transport may downcast this to access transport-specific functions */
 182 const struct vsock_transport *vsock_core_get_transport(struct vsock_sock *vsk);
 183
 184 /**** UTILS ****/
 185
 186 /* vsock_table_lock must be held */
 187 static inline bool __vsock_in_bound_table(struct vsock_sock *vsk)
 188 {
 189         return !list_empty(&vsk->bound_table);
 190 }
 191
 192 /* vsock_table_lock must be held */
 193 static inline bool __vsock_in_connected_table(struct vsock_sock *vsk)
 194 {
 195         return !list_empty(&vsk->connected_table);
 196 }
 197
 198 void vsock_release_pending(struct sock *pending);
 199 void vsock_add_pending(struct sock *listener, struct sock *pending);
 200 void vsock_remove_pending(struct sock *listener, struct sock *pending);
 201 void vsock_enqueue_accept(struct sock *listener, struct sock *connected);
 202 void vsock_insert_connected(struct vsock_sock *vsk);
 203 void vsock_remove_bound(struct vsock_sock *vsk);
 204 void vsock_remove_connected(struct vsock_sock *vsk);
 205 struct sock *vsock_find_bound_socket(struct sockaddr_vm *addr);
 206 struct sock *vsock_find_connected_socket(struct sockaddr_vm *src,
 207                                          struct sockaddr_vm *dst);
 208 void vsock_remove_sock(struct vsock_sock *vsk);
 209 void vsock_for_each_connected_socket(struct vsock_transport *transport,
 210                                      void (*fn)(struct sock *sk));
 211 int vsock_assign_transport(struct vsock_sock *vsk, struct vsock_sock *psk);
 212 bool vsock_find_cid(unsigned int cid);
 213
 214 /**** TAP ****/
 215
 216 struct vsock_tap {
 217         struct net_device *dev;
 218         struct module *module;
 219         struct list_head list;
 220 };
 221
 222 int vsock_init_tap(void);
 223 int vsock_add_tap(struct vsock_tap *vt);
 224 int vsock_remove_tap(struct vsock_tap *vt);
 225 void vsock_deliver_tap(struct sk_buff *build_skb(void *opaque), void *opaque);
 226
 227 #endif /* __AF_VSOCK_H__ */