Commit | Line | Data |
---|---|---|
2e6599cb ACM |
1 | /* |
2 | * NET Generic infrastructure for Network protocols. | |
3 | * | |
4 | * Definitions for request_sock | |
5 | * | |
6 | * Authors: Arnaldo Carvalho de Melo <acme@conectiva.com.br> | |
7 | * | |
8 | * From code originally in include/net/tcp.h | |
9 | * | |
10 | * This program is free software; you can redistribute it and/or | |
11 | * modify it under the terms of the GNU General Public License | |
12 | * as published by the Free Software Foundation; either version | |
13 | * 2 of the License, or (at your option) any later version. | |
14 | */ | |
15 | #ifndef _REQUEST_SOCK_H | |
16 | #define _REQUEST_SOCK_H | |
17 | ||
18 | #include <linux/slab.h> | |
0e87506f | 19 | #include <linux/spinlock.h> |
2e6599cb | 20 | #include <linux/types.h> |
547b792c | 21 | #include <linux/bug.h> |
0e87506f | 22 | |
2e6599cb ACM |
23 | #include <net/sock.h> |
24 | ||
60236fdd | 25 | struct request_sock; |
2e6599cb ACM |
26 | struct sk_buff; |
27 | struct dst_entry; | |
28 | struct proto; | |
29 | ||
60236fdd | 30 | struct request_sock_ops { |
2e6599cb | 31 | int family; |
2e6599cb | 32 | int obj_size; |
e18b890b | 33 | struct kmem_cache *slab; |
7e56b5d6 | 34 | char *slab_name; |
ea3bea3a | 35 | int (*rtx_syn_ack)(const struct sock *sk, |
1a2c6181 | 36 | struct request_sock *req); |
a00e7444 | 37 | void (*send_ack)(const struct sock *sk, struct sk_buff *skb, |
60236fdd | 38 | struct request_sock *req); |
a00e7444 | 39 | void (*send_reset)(const struct sock *sk, |
cfb6eeb4 | 40 | struct sk_buff *skb); |
60236fdd | 41 | void (*destructor)(struct request_sock *req); |
42cb80a2 | 42 | void (*syn_ack_timeout)(const struct request_sock *req); |
2e6599cb ACM |
43 | }; |
44 | ||
1b70e977 | 45 | int inet_rtx_syn_ack(const struct sock *parent, struct request_sock *req); |
e6c022a4 | 46 | |
60236fdd | 47 | /* struct request_sock - mini sock to represent a connection request |
2e6599cb | 48 | */ |
60236fdd | 49 | struct request_sock { |
634fb979 | 50 | struct sock_common __req_common; |
1e2e0117 | 51 | #define rsk_refcnt __req_common.skc_refcnt |
52452c54 | 52 | #define rsk_hash __req_common.skc_hash |
1e2e0117 | 53 | |
3fb62c5d | 54 | struct request_sock *dl_next; |
4e9a578e | 55 | struct sock *rsk_listener; |
2e6599cb | 56 | u16 mss; |
e6c022a4 ED |
57 | u8 num_retrans; /* number of retransmits */ |
58 | u8 cookie_ts:1; /* syncookie: encode tcpopts in timestamp */ | |
59 | u8 num_timeout:7; /* number of timeouts */ | |
2e6599cb ACM |
60 | /* The following two fields can be easily recomputed I think -AK */ |
61 | u32 window_clamp; /* window clamp at creation time */ | |
62 | u32 rcv_wnd; /* rcv_wnd offered first time */ | |
63 | u32 ts_recent; | |
fa76ce73 | 64 | struct timer_list rsk_timer; |
72a3effa | 65 | const struct request_sock_ops *rsk_ops; |
2e6599cb | 66 | struct sock *sk; |
cd8ae852 | 67 | u32 *saved_syn; |
4237c75c | 68 | u32 secid; |
6b877699 | 69 | u32 peer_secid; |
2e6599cb ACM |
70 | }; |
71 | ||
4e9a578e ED |
72 | static inline struct request_sock * |
73 | reqsk_alloc(const struct request_sock_ops *ops, struct sock *sk_listener) | |
2e6599cb | 74 | { |
54e6ecb2 | 75 | struct request_sock *req = kmem_cache_alloc(ops->slab, GFP_ATOMIC); |
2e6599cb | 76 | |
4e9a578e | 77 | if (req) { |
60236fdd | 78 | req->rsk_ops = ops; |
4e9a578e ED |
79 | sock_hold(sk_listener); |
80 | req->rsk_listener = sk_listener; | |
cd8ae852 | 81 | req->saved_syn = NULL; |
0470c8ca ED |
82 | /* Following is temporary. It is coupled with debugging |
83 | * helpers in reqsk_put() & reqsk_free() | |
84 | */ | |
85 | atomic_set(&req->rsk_refcnt, 0); | |
4e9a578e | 86 | } |
2e6599cb ACM |
87 | return req; |
88 | } | |
89 | ||
41b822c5 ED |
90 | static inline struct request_sock *inet_reqsk(struct sock *sk) |
91 | { | |
92 | return (struct request_sock *)sk; | |
93 | } | |
94 | ||
08d2cc3b ED |
95 | static inline struct sock *req_to_sk(struct request_sock *req) |
96 | { | |
97 | return (struct sock *)req; | |
98 | } | |
99 | ||
60236fdd | 100 | static inline void reqsk_free(struct request_sock *req) |
2e6599cb | 101 | { |
13854e5a ED |
102 | /* temporary debugging */ |
103 | WARN_ON_ONCE(atomic_read(&req->rsk_refcnt) != 0); | |
104 | ||
60236fdd | 105 | req->rsk_ops->destructor(req); |
4e9a578e ED |
106 | if (req->rsk_listener) |
107 | sock_put(req->rsk_listener); | |
cd8ae852 | 108 | kfree(req->saved_syn); |
13854e5a | 109 | kmem_cache_free(req->rsk_ops->slab, req); |
2e6599cb ACM |
110 | } |
111 | ||
1e2e0117 ED |
112 | static inline void reqsk_put(struct request_sock *req) |
113 | { | |
114 | if (atomic_dec_and_test(&req->rsk_refcnt)) | |
115 | reqsk_free(req); | |
116 | } | |
117 | ||
0e87506f ACM |
118 | extern int sysctl_max_syn_backlog; |
119 | ||
2ad69c55 | 120 | /** struct listen_sock - listen state |
0e87506f ACM |
121 | * |
122 | * @max_qlen_log - log_2 of maximal queued SYNs/REQUESTs | |
123 | */ | |
2ad69c55 | 124 | struct listen_sock { |
aac065c5 | 125 | u32 max_qlen_log; |
0e87506f | 126 | u32 hash_rnd; |
83e3609e | 127 | u32 nr_table_entries; |
0e87506f ACM |
128 | struct request_sock *syn_table[0]; |
129 | }; | |
130 | ||
10467163 JC |
131 | /* |
132 | * For a TCP Fast Open listener - | |
133 | * lock - protects the access to all the reqsk, which is co-owned by | |
134 | * the listener and the child socket. | |
135 | * qlen - pending TFO requests (still in TCP_SYN_RECV). | |
136 | * max_qlen - max TFO reqs allowed before TFO is disabled. | |
137 | * | |
138 | * XXX (TFO) - ideally these fields can be made as part of "listen_sock" | |
139 | * structure above. But there is some implementation difficulty due to | |
140 | * listen_sock being part of request_sock_queue hence will be freed when | |
141 | * a listener is stopped. But TFO related fields may continue to be | |
142 | * accessed even after a listener is closed, until its sk_refcnt drops | |
143 | * to 0 implying no more outstanding TFO reqs. One solution is to keep | |
144 | * listen_opt around until sk_refcnt drops to 0. But there is some other | |
145 | * complexity that needs to be resolved. E.g., a listener can be disabled | |
146 | * temporarily through shutdown()->tcp_disconnect(), and re-enabled later. | |
147 | */ | |
148 | struct fastopen_queue { | |
149 | struct request_sock *rskq_rst_head; /* Keep track of past TFO */ | |
150 | struct request_sock *rskq_rst_tail; /* requests that caused RST. | |
151 | * This is part of the defense | |
152 | * against spoofing attack. | |
153 | */ | |
154 | spinlock_t lock; | |
155 | int qlen; /* # of pending (TCP_SYN_RECV) reqs */ | |
156 | int max_qlen; /* != 0 iff TFO is currently enabled */ | |
157 | }; | |
158 | ||
0e87506f ACM |
159 | /** struct request_sock_queue - queue of request_socks |
160 | * | |
161 | * @rskq_accept_head - FIFO head of established children | |
162 | * @rskq_accept_tail - FIFO tail of established children | |
295f7324 | 163 | * @rskq_defer_accept - User waits for some data after accept() |
0e87506f ACM |
164 | * @syn_wait_lock - serializer |
165 | * | |
166 | * %syn_wait_lock is necessary only to avoid proc interface having to grab the main | |
167 | * lock sock while browsing the listening hash (otherwise it's deadlock prone). | |
168 | * | |
0e87506f ACM |
169 | */ |
170 | struct request_sock_queue { | |
fff1f300 ED |
171 | spinlock_t rskq_lock; |
172 | u8 rskq_defer_accept; | |
8d2675f1 | 173 | u32 synflood_warned; |
fff1f300 | 174 | |
aac065c5 ED |
175 | atomic_t qlen; |
176 | atomic_t young; | |
177 | ||
0e87506f ACM |
178 | struct request_sock *rskq_accept_head; |
179 | struct request_sock *rskq_accept_tail; | |
2ad69c55 | 180 | struct listen_sock *listen_opt; |
0536fcc0 ED |
181 | struct fastopen_queue fastopenq; /* Check max_qlen != 0 to determine |
182 | * if TFO is enabled. | |
10467163 | 183 | */ |
fa76ce73 ED |
184 | |
185 | /* temporary alignment, our goal is to get rid of this lock */ | |
b2827053 | 186 | spinlock_t syn_wait_lock ____cacheline_aligned_in_smp; |
0e87506f ACM |
187 | }; |
188 | ||
c0f4502a JP |
189 | int reqsk_queue_alloc(struct request_sock_queue *queue, |
190 | unsigned int nr_table_entries); | |
0e87506f | 191 | |
c0f4502a JP |
192 | void __reqsk_queue_destroy(struct request_sock_queue *queue); |
193 | void reqsk_queue_destroy(struct request_sock_queue *queue); | |
194 | void reqsk_fastopen_remove(struct sock *sk, struct request_sock *req, | |
195 | bool reset); | |
83e3609e | 196 | |
fff1f300 | 197 | static inline bool reqsk_queue_empty(const struct request_sock_queue *queue) |
0e87506f ACM |
198 | { |
199 | return queue->rskq_accept_head == NULL; | |
200 | } | |
201 | ||
0e87506f ACM |
202 | static inline void reqsk_queue_add(struct request_sock_queue *queue, |
203 | struct request_sock *req, | |
204 | struct sock *parent, | |
205 | struct sock *child) | |
206 | { | |
fff1f300 | 207 | spin_lock(&queue->rskq_lock); |
0e87506f ACM |
208 | req->sk = child; |
209 | sk_acceptq_added(parent); | |
210 | ||
211 | if (queue->rskq_accept_head == NULL) | |
212 | queue->rskq_accept_head = req; | |
213 | else | |
214 | queue->rskq_accept_tail->dl_next = req; | |
215 | ||
216 | queue->rskq_accept_tail = req; | |
217 | req->dl_next = NULL; | |
fff1f300 | 218 | spin_unlock(&queue->rskq_lock); |
0e87506f ACM |
219 | } |
220 | ||
fff1f300 ED |
221 | static inline struct request_sock *reqsk_queue_remove(struct request_sock_queue *queue, |
222 | struct sock *parent) | |
0e87506f | 223 | { |
fff1f300 | 224 | struct request_sock *req; |
0e87506f | 225 | |
fff1f300 ED |
226 | spin_lock_bh(&queue->rskq_lock); |
227 | req = queue->rskq_accept_head; | |
228 | if (req) { | |
229 | sk_acceptq_removed(parent); | |
230 | queue->rskq_accept_head = req->dl_next; | |
231 | if (queue->rskq_accept_head == NULL) | |
232 | queue->rskq_accept_tail = NULL; | |
233 | } | |
234 | spin_unlock_bh(&queue->rskq_lock); | |
0e87506f ACM |
235 | return req; |
236 | } | |
237 | ||
fa76ce73 ED |
238 | static inline void reqsk_queue_removed(struct request_sock_queue *queue, |
239 | const struct request_sock *req) | |
0e87506f | 240 | { |
e6c022a4 | 241 | if (req->num_timeout == 0) |
aac065c5 ED |
242 | atomic_dec(&queue->young); |
243 | atomic_dec(&queue->qlen); | |
0e87506f ACM |
244 | } |
245 | ||
fa76ce73 | 246 | static inline void reqsk_queue_added(struct request_sock_queue *queue) |
0e87506f | 247 | { |
aac065c5 ED |
248 | atomic_inc(&queue->young); |
249 | atomic_inc(&queue->qlen); | |
0e87506f ACM |
250 | } |
251 | ||
fa76ce73 | 252 | static inline int reqsk_queue_len(const struct request_sock_queue *queue) |
0e87506f | 253 | { |
aac065c5 | 254 | return atomic_read(&queue->qlen); |
0e87506f ACM |
255 | } |
256 | ||
fa76ce73 | 257 | static inline int reqsk_queue_len_young(const struct request_sock_queue *queue) |
0e87506f | 258 | { |
aac065c5 | 259 | return atomic_read(&queue->young); |
fa76ce73 | 260 | } |
0470c8ca | 261 | |
fa76ce73 ED |
262 | static inline int reqsk_queue_is_full(const struct request_sock_queue *queue) |
263 | { | |
264 | return reqsk_queue_len(queue) >> queue->listen_opt->max_qlen_log; | |
0e87506f ACM |
265 | } |
266 | ||
fa76ce73 ED |
267 | void reqsk_queue_hash_req(struct request_sock_queue *queue, |
268 | u32 hash, struct request_sock *req, | |
269 | unsigned long timeout); | |
270 | ||
2e6599cb | 271 | #endif /* _REQUEST_SOCK_H */ |