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