request_sock.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. /*
  3. * NET Generic infrastructure for Network protocols.
  4. *
  5. * Definitions for request_sock
  6. *
  7. * Authors: Arnaldo Carvalho de Melo <[email protected]>
  8. *
  9. * From code originally in include/net/tcp.h
  10. */
  11. #ifndef _REQUEST_SOCK_H
  12. #define _REQUEST_SOCK_H
  13. #include <linux/slab.h>
  14. #include <linux/spinlock.h>
  15. #include <linux/types.h>
  16. #include <linux/bug.h>
  17. #include <linux/refcount.h>
  18. #include <net/sock.h>
  19. struct request_sock;
  20. struct sk_buff;
  21. struct dst_entry;
  22. struct proto;
  23. struct request_sock_ops {
  24. int family;
  25. unsigned int obj_size;
  26. struct kmem_cache *slab;
  27. char *slab_name;
  28. int (*rtx_syn_ack)(const struct sock *sk,
  29. struct request_sock *req);
  30. void (*send_ack)(const struct sock *sk, struct sk_buff *skb,
  31. struct request_sock *req);
  32. void (*send_reset)(const struct sock *sk,
  33. struct sk_buff *skb);
  34. void (*destructor)(struct request_sock *req);
  35. void (*syn_ack_timeout)(const struct request_sock *req);
  36. };
  37. int inet_rtx_syn_ack(const struct sock *parent, struct request_sock *req);
  38. struct saved_syn {
  39. u32 mac_hdrlen;
  40. u32 network_hdrlen;
  41. u32 tcp_hdrlen;
  42. u8 data[];
  43. };
  44. /* struct request_sock - mini sock to represent a connection request
  45. */
  46. struct request_sock {
  47. struct sock_common __req_common;
  48. #define rsk_refcnt __req_common.skc_refcnt
  49. #define rsk_hash __req_common.skc_hash
  50. #define rsk_listener __req_common.skc_listener
  51. #define rsk_window_clamp __req_common.skc_window_clamp
  52. #define rsk_rcv_wnd __req_common.skc_rcv_wnd
  53. struct request_sock *dl_next;
  54. u16 mss;
  55. u8 num_retrans; /* number of retransmits */
  56. u8 syncookie:1; /* syncookie: encode tcpopts in timestamp */
  57. u8 num_timeout:7; /* number of timeouts */
  58. u32 ts_recent;
  59. struct timer_list rsk_timer;
  60. const struct request_sock_ops *rsk_ops;
  61. struct sock *sk;
  62. struct saved_syn *saved_syn;
  63. u32 secid;
  64. u32 peer_secid;
  65. u32 timeout;
  66. };
  67. static inline struct request_sock *inet_reqsk(const struct sock *sk)
  68. {
  69. return (struct request_sock *)sk;
  70. }
  71. static inline struct sock *req_to_sk(struct request_sock *req)
  72. {
  73. return (struct sock *)req;
  74. }
  75. static inline struct request_sock *
  76. reqsk_alloc(const struct request_sock_ops *ops, struct sock *sk_listener,
  77. bool attach_listener)
  78. {
  79. struct request_sock *req;
  80. req = kmem_cache_alloc(ops->slab, GFP_ATOMIC | __GFP_NOWARN);
  81. if (!req)
  82. return NULL;
  83. req->rsk_listener = NULL;
  84. if (attach_listener) {
  85. if (unlikely(!refcount_inc_not_zero(&sk_listener->sk_refcnt))) {
  86. kmem_cache_free(ops->slab, req);
  87. return NULL;
  88. }
  89. req->rsk_listener = sk_listener;
  90. }
  91. req->rsk_ops = ops;
  92. req_to_sk(req)->sk_prot = sk_listener->sk_prot;
  93. sk_node_init(&req_to_sk(req)->sk_node);
  94. sk_tx_queue_clear(req_to_sk(req));
  95. req->saved_syn = NULL;
  96. req->timeout = 0;
  97. req->num_timeout = 0;
  98. req->num_retrans = 0;
  99. req->sk = NULL;
  100. refcount_set(&req->rsk_refcnt, 0);
  101. return req;
  102. }
  103. static inline void __reqsk_free(struct request_sock *req)
  104. {
  105. req->rsk_ops->destructor(req);
  106. if (req->rsk_listener)
  107. sock_put(req->rsk_listener);
  108. kfree(req->saved_syn);
  109. kmem_cache_free(req->rsk_ops->slab, req);
  110. }
  111. static inline void reqsk_free(struct request_sock *req)
  112. {
  113. WARN_ON_ONCE(refcount_read(&req->rsk_refcnt) != 0);
  114. __reqsk_free(req);
  115. }
  116. static inline void reqsk_put(struct request_sock *req)
  117. {
  118. if (refcount_dec_and_test(&req->rsk_refcnt))
  119. reqsk_free(req);
  120. }
  121. /*
  122. * For a TCP Fast Open listener -
  123. * lock - protects the access to all the reqsk, which is co-owned by
  124. * the listener and the child socket.
  125. * qlen - pending TFO requests (still in TCP_SYN_RECV).
  126. * max_qlen - max TFO reqs allowed before TFO is disabled.
  127. *
  128. * XXX (TFO) - ideally these fields can be made as part of "listen_sock"
  129. * structure above. But there is some implementation difficulty due to
  130. * listen_sock being part of request_sock_queue hence will be freed when
  131. * a listener is stopped. But TFO related fields may continue to be
  132. * accessed even after a listener is closed, until its sk_refcnt drops
  133. * to 0 implying no more outstanding TFO reqs. One solution is to keep
  134. * listen_opt around until sk_refcnt drops to 0. But there is some other
  135. * complexity that needs to be resolved. E.g., a listener can be disabled
  136. * temporarily through shutdown()->tcp_disconnect(), and re-enabled later.
  137. */
  138. struct fastopen_queue {
  139. struct request_sock *rskq_rst_head; /* Keep track of past TFO */
  140. struct request_sock *rskq_rst_tail; /* requests that caused RST.
  141. * This is part of the defense
  142. * against spoofing attack.
  143. */
  144. spinlock_t lock;
  145. int qlen; /* # of pending (TCP_SYN_RECV) reqs */
  146. int max_qlen; /* != 0 iff TFO is currently enabled */
  147. struct tcp_fastopen_context __rcu *ctx; /* cipher context for cookie */
  148. };
  149. /** struct request_sock_queue - queue of request_socks
  150. *
  151. * @rskq_accept_head - FIFO head of established children
  152. * @rskq_accept_tail - FIFO tail of established children
  153. * @rskq_defer_accept - User waits for some data after accept()
  154. *
  155. */
  156. struct request_sock_queue {
  157. spinlock_t rskq_lock;
  158. u8 rskq_defer_accept;
  159. u32 synflood_warned;
  160. atomic_t qlen;
  161. atomic_t young;
  162. struct request_sock *rskq_accept_head;
  163. struct request_sock *rskq_accept_tail;
  164. struct fastopen_queue fastopenq; /* Check max_qlen != 0 to determine
  165. * if TFO is enabled.
  166. */
  167. };
  168. void reqsk_queue_alloc(struct request_sock_queue *queue);
  169. void reqsk_fastopen_remove(struct sock *sk, struct request_sock *req,
  170. bool reset);
  171. static inline bool reqsk_queue_empty(const struct request_sock_queue *queue)
  172. {
  173. return READ_ONCE(queue->rskq_accept_head) == NULL;
  174. }
  175. static inline struct request_sock *reqsk_queue_remove(struct request_sock_queue *queue,
  176. struct sock *parent)
  177. {
  178. struct request_sock *req;
  179. spin_lock_bh(&queue->rskq_lock);
  180. req = queue->rskq_accept_head;
  181. if (req) {
  182. sk_acceptq_removed(parent);
  183. WRITE_ONCE(queue->rskq_accept_head, req->dl_next);
  184. if (queue->rskq_accept_head == NULL)
  185. queue->rskq_accept_tail = NULL;
  186. }
  187. spin_unlock_bh(&queue->rskq_lock);
  188. return req;
  189. }
  190. static inline void reqsk_queue_removed(struct request_sock_queue *queue,
  191. const struct request_sock *req)
  192. {
  193. if (req->num_timeout == 0)
  194. atomic_dec(&queue->young);
  195. atomic_dec(&queue->qlen);
  196. }
  197. static inline void reqsk_queue_added(struct request_sock_queue *queue)
  198. {
  199. atomic_inc(&queue->young);
  200. atomic_inc(&queue->qlen);
  201. }
  202. static inline int reqsk_queue_len(const struct request_sock_queue *queue)
  203. {
  204. return atomic_read(&queue->qlen);
  205. }
  206. static inline int reqsk_queue_len_young(const struct request_sock_queue *queue)
  207. {
  208. return atomic_read(&queue->young);
  209. }
  210. #endif /* _REQUEST_SOCK_H */