af_vsock.h 6.1 KB

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