2 * NET Generic infrastructure for Network protocols.
4 * Definitions for request_sock
6 * Authors: Arnaldo Carvalho de Melo <acme@conectiva.com.br>
8 * From code originally in include/net/tcp.h
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.
15 #ifndef _REQUEST_SOCK_H
16 #define _REQUEST_SOCK_H
18 #include <linux/slab.h>
19 #include <linux/spinlock.h>
20 #include <linux/types.h>
21 #include <linux/bug.h>
30 struct request_sock_ops {
33 struct kmem_cache *slab;
35 int (*rtx_syn_ack)(struct sock *sk,
36 struct request_sock *req);
37 void (*send_ack)(struct sock *sk, struct sk_buff *skb,
38 struct request_sock *req);
39 void (*send_reset)(struct sock *sk,
41 void (*destructor)(struct request_sock *req);
42 void (*syn_ack_timeout)(struct sock *sk,
43 struct request_sock *req);
46 int inet_rtx_syn_ack(struct sock *parent, struct request_sock *req);
48 /* struct request_sock - mini sock to represent a connection request
51 struct sock_common __req_common;
52 #define rsk_refcnt __req_common.skc_refcnt
54 struct request_sock *dl_next;
56 u8 num_retrans; /* number of retransmits */
57 u8 cookie_ts:1; /* syncookie: encode tcpopts in timestamp */
58 u8 num_timeout:7; /* number of timeouts */
59 /* The following two fields can be easily recomputed I think -AK */
60 u32 window_clamp; /* window clamp at creation time */
61 u32 rcv_wnd; /* rcv_wnd offered first time */
63 unsigned long expires;
64 const struct request_sock_ops *rsk_ops;
70 static inline struct request_sock *reqsk_alloc(const struct request_sock_ops *ops)
72 struct request_sock *req = kmem_cache_alloc(ops->slab, GFP_ATOMIC);
80 static inline struct request_sock *inet_reqsk(struct sock *sk)
82 return (struct request_sock *)sk;
85 static inline void __reqsk_free(struct request_sock *req)
87 kmem_cache_free(req->rsk_ops->slab, req);
90 static inline void reqsk_free(struct request_sock *req)
92 req->rsk_ops->destructor(req);
96 static inline void reqsk_put(struct request_sock *req)
98 if (atomic_dec_and_test(&req->rsk_refcnt))
102 extern int sysctl_max_syn_backlog;
104 /** struct listen_sock - listen state
106 * @max_qlen_log - log_2 of maximal queued SYNs/REQUESTs
111 /* 2 bytes hole, try to use */
116 u32 nr_table_entries;
117 struct request_sock *syn_table[0];
121 * For a TCP Fast Open listener -
122 * lock - protects the access to all the reqsk, which is co-owned by
123 * the listener and the child socket.
124 * qlen - pending TFO requests (still in TCP_SYN_RECV).
125 * max_qlen - max TFO reqs allowed before TFO is disabled.
127 * XXX (TFO) - ideally these fields can be made as part of "listen_sock"
128 * structure above. But there is some implementation difficulty due to
129 * listen_sock being part of request_sock_queue hence will be freed when
130 * a listener is stopped. But TFO related fields may continue to be
131 * accessed even after a listener is closed, until its sk_refcnt drops
132 * to 0 implying no more outstanding TFO reqs. One solution is to keep
133 * listen_opt around until sk_refcnt drops to 0. But there is some other
134 * complexity that needs to be resolved. E.g., a listener can be disabled
135 * temporarily through shutdown()->tcp_disconnect(), and re-enabled later.
137 struct fastopen_queue {
138 struct request_sock *rskq_rst_head; /* Keep track of past TFO */
139 struct request_sock *rskq_rst_tail; /* requests that caused RST.
140 * This is part of the defense
141 * against spoofing attack.
144 int qlen; /* # of pending (TCP_SYN_RECV) reqs */
145 int max_qlen; /* != 0 iff TFO is currently enabled */
148 /** struct request_sock_queue - queue of request_socks
150 * @rskq_accept_head - FIFO head of established children
151 * @rskq_accept_tail - FIFO tail of established children
152 * @rskq_defer_accept - User waits for some data after accept()
153 * @syn_wait_lock - serializer
155 * %syn_wait_lock is necessary only to avoid proc interface having to grab the main
156 * lock sock while browsing the listening hash (otherwise it's deadlock prone).
158 * This lock is acquired in read mode only from listening_get_next() seq_file
159 * op and it's acquired in write mode _only_ from code that is actively
160 * changing rskq_accept_head. All readers that are holding the master sock lock
161 * don't need to grab this lock in read mode too as rskq_accept_head. writes
162 * are always protected from the main sock lock.
164 struct request_sock_queue {
165 struct request_sock *rskq_accept_head;
166 struct request_sock *rskq_accept_tail;
167 rwlock_t syn_wait_lock;
168 u8 rskq_defer_accept;
169 /* 3 bytes hole, try to pack */
170 struct listen_sock *listen_opt;
171 struct fastopen_queue *fastopenq; /* This is non-NULL iff TFO has been
172 * enabled on this listener. Check
173 * max_qlen != 0 in fastopen_queue
174 * to determine if TFO is enabled
175 * right at this moment.
179 int reqsk_queue_alloc(struct request_sock_queue *queue,
180 unsigned int nr_table_entries);
182 void __reqsk_queue_destroy(struct request_sock_queue *queue);
183 void reqsk_queue_destroy(struct request_sock_queue *queue);
184 void reqsk_fastopen_remove(struct sock *sk, struct request_sock *req,
187 static inline struct request_sock *
188 reqsk_queue_yank_acceptq(struct request_sock_queue *queue)
190 struct request_sock *req = queue->rskq_accept_head;
192 queue->rskq_accept_head = NULL;
196 static inline int reqsk_queue_empty(struct request_sock_queue *queue)
198 return queue->rskq_accept_head == NULL;
201 static inline void reqsk_queue_unlink(struct request_sock_queue *queue,
202 struct request_sock *req,
203 struct request_sock **prev_req)
205 write_lock(&queue->syn_wait_lock);
206 *prev_req = req->dl_next;
207 write_unlock(&queue->syn_wait_lock);
210 static inline void reqsk_queue_add(struct request_sock_queue *queue,
211 struct request_sock *req,
216 sk_acceptq_added(parent);
218 if (queue->rskq_accept_head == NULL)
219 queue->rskq_accept_head = req;
221 queue->rskq_accept_tail->dl_next = req;
223 queue->rskq_accept_tail = req;
227 static inline struct request_sock *reqsk_queue_remove(struct request_sock_queue *queue)
229 struct request_sock *req = queue->rskq_accept_head;
231 WARN_ON(req == NULL);
233 queue->rskq_accept_head = req->dl_next;
234 if (queue->rskq_accept_head == NULL)
235 queue->rskq_accept_tail = NULL;
240 static inline int reqsk_queue_removed(struct request_sock_queue *queue,
241 struct request_sock *req)
243 struct listen_sock *lopt = queue->listen_opt;
245 if (req->num_timeout == 0)
251 static inline int reqsk_queue_added(struct request_sock_queue *queue)
253 struct listen_sock *lopt = queue->listen_opt;
254 const int prev_qlen = lopt->qlen;
261 static inline int reqsk_queue_len(const struct request_sock_queue *queue)
263 return queue->listen_opt != NULL ? queue->listen_opt->qlen : 0;
266 static inline int reqsk_queue_len_young(const struct request_sock_queue *queue)
268 return queue->listen_opt->qlen_young;
271 static inline int reqsk_queue_is_full(const struct request_sock_queue *queue)
273 return queue->listen_opt->qlen >> queue->listen_opt->max_qlen_log;
276 static inline void reqsk_queue_hash_req(struct request_sock_queue *queue,
277 u32 hash, struct request_sock *req,
278 unsigned long timeout)
280 struct listen_sock *lopt = queue->listen_opt;
282 req->expires = jiffies + timeout;
283 req->num_retrans = 0;
284 req->num_timeout = 0;
286 req->dl_next = lopt->syn_table[hash];
288 write_lock(&queue->syn_wait_lock);
289 lopt->syn_table[hash] = req;
290 write_unlock(&queue->syn_wait_lock);
293 #endif /* _REQUEST_SOCK_H */