include/net/request_sock.h

   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>
  19 #include <linux/spinlock.h>
  20 #include <linux/types.h>
  21 #include <linux/bug.h>
  22
  23 #include <net/sock.h>
  24
  25 struct request_sock;
  26 struct sk_buff;
  27 struct dst_entry;
  28 struct proto;
  29
  30 struct request_sock_ops {
  31         int             family;
  32         int             obj_size;
  33         struct kmem_cache       *slab;
  34         char            *slab_name;
  35         int             (*rtx_syn_ack)(const struct sock *sk,
  36                                        struct request_sock *req);
  37         void            (*send_ack)(const struct sock *sk, struct sk_buff *skb,
  38                                     struct request_sock *req);
  39         void            (*send_reset)(const struct sock *sk,
  40                                       struct sk_buff *skb);
  41         void            (*destructor)(struct request_sock *req);
  42         void            (*syn_ack_timeout)(const struct request_sock *req);
  43 };
  44
  45 int inet_rtx_syn_ack(const struct sock *parent, struct request_sock *req);
  46
  47 /* struct request_sock - mini sock to represent a connection request
  48  */
  49 struct request_sock {
  50         struct sock_common              __req_common;
  51 #define rsk_refcnt                      __req_common.skc_refcnt
  52 #define rsk_hash                        __req_common.skc_hash
  53
  54         struct request_sock             *dl_next;
  55         struct sock                     *rsk_listener;
  56         u16                             mss;
  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 */
  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;
  64         struct timer_list               rsk_timer;
  65         const struct request_sock_ops   *rsk_ops;
  66         struct sock                     *sk;
  67         u32                             *saved_syn;
  68         u32                             secid;
  69         u32                             peer_secid;
  70 };
  71
  72 static inline struct request_sock *
  73 reqsk_alloc(const struct request_sock_ops *ops, struct sock *sk_listener)
  74 {
  75         struct request_sock *req = kmem_cache_alloc(ops->slab, GFP_ATOMIC);
  76
  77         if (req) {
  78                 req->rsk_ops = ops;
  79                 sock_hold(sk_listener);
  80                 req->rsk_listener = sk_listener;
  81                 req->saved_syn = NULL;
  82                 /* Following is temporary. It is coupled with debugging
  83                  * helpers in reqsk_put() & reqsk_free()
  84                  */
  85                 atomic_set(&req->rsk_refcnt, 0);
  86         }
  87         return req;
  88 }
  89
  90 static inline struct request_sock *inet_reqsk(struct sock *sk)
  91 {
  92         return (struct request_sock *)sk;
  93 }
  94
  95 static inline struct sock *req_to_sk(struct request_sock *req)
  96 {
  97         return (struct sock *)req;
  98 }
  99
 100 static inline void reqsk_free(struct request_sock *req)
 101 {
 102         /* temporary debugging */
 103         WARN_ON_ONCE(atomic_read(&req->rsk_refcnt) != 0);
 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
 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
 118 extern int sysctl_max_syn_backlog;
 119
 120 /** struct listen_sock - listen state
 121  *
 122  * @max_qlen_log - log_2 of maximal queued SYNs/REQUESTs
 123  */
 124 struct listen_sock {
 125         u32                     max_qlen_log;
 126         u32                     hash_rnd;
 127         u32                     nr_table_entries;
 128         struct request_sock     *syn_table[0];
 129 };
 130
 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
 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
 163  * @rskq_defer_accept - User waits for some data after accept()
 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  *
 169  */
 170 struct request_sock_queue {
 171         spinlock_t              rskq_lock;
 172         u8                      rskq_defer_accept;
 173         u32                     synflood_warned;
 174
 175         atomic_t                qlen;
 176         atomic_t                young;
 177
 178         struct request_sock     *rskq_accept_head;
 179         struct request_sock     *rskq_accept_tail;
 180         struct listen_sock      *listen_opt;
 181         struct fastopen_queue   fastopenq;  /* Check max_qlen != 0 to determine
 182                                              * if TFO is enabled.
 183                                              */
 184
 185         /* temporary alignment, our goal is to get rid of this lock */
 186         spinlock_t              syn_wait_lock ____cacheline_aligned_in_smp;
 187 };
 188
 189 int reqsk_queue_alloc(struct request_sock_queue *queue,
 190                       unsigned int nr_table_entries);
 191
 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);
 196
 197 static inline bool reqsk_queue_empty(const struct request_sock_queue *queue)
 198 {
 199         return queue->rskq_accept_head == NULL;
 200 }
 201
 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 {
 207         spin_lock(&queue->rskq_lock);
 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;
 218         spin_unlock(&queue->rskq_lock);
 219 }
 220
 221 static inline struct request_sock *reqsk_queue_remove(struct request_sock_queue *queue,
 222                                                       struct sock *parent)
 223 {
 224         struct request_sock *req;
 225
 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);
 235         return req;
 236 }
 237
 238 static inline void reqsk_queue_removed(struct request_sock_queue *queue,
 239                                        const struct request_sock *req)
 240 {
 241         if (req->num_timeout == 0)
 242                 atomic_dec(&queue->young);
 243         atomic_dec(&queue->qlen);
 244 }
 245
 246 static inline void reqsk_queue_added(struct request_sock_queue *queue)
 247 {
 248         atomic_inc(&queue->young);
 249         atomic_inc(&queue->qlen);
 250 }
 251
 252 static inline int reqsk_queue_len(const struct request_sock_queue *queue)
 253 {
 254         return atomic_read(&queue->qlen);
 255 }
 256
 257 static inline int reqsk_queue_len_young(const struct request_sock_queue *queue)
 258 {
 259         return atomic_read(&queue->young);
 260 }
 261
 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;
 265 }
 266
 267 void reqsk_queue_hash_req(struct request_sock_queue *queue,
 268                           u32 hash, struct request_sock *req,
 269                           unsigned long timeout);
 270
 271 #endif /* _REQUEST_SOCK_H */