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)(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,
  40                                       struct sk_buff *skb);
  41         void            (*destructor)(struct request_sock *req);
  42         void            (*syn_ack_timeout)(struct sock *sk,
  43                                            struct request_sock *req);
  44 };
  45
  46 int inet_rtx_syn_ack(struct sock *parent, struct request_sock *req);
  47
  48 /* struct request_sock - mini sock to represent a connection request
  49  */
  50 struct request_sock {
  51         struct sock_common              __req_common;
  52 #define rsk_refcnt                      __req_common.skc_refcnt
  53
  54         struct request_sock             *dl_next;
  55         u16                             mss;
  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 */
  62         u32                             ts_recent;
  63         unsigned long                   expires;
  64         const struct request_sock_ops   *rsk_ops;
  65         struct sock                     *sk;
  66         u32                             secid;
  67         u32                             peer_secid;
  68 };
  69
  70 static inline struct request_sock *reqsk_alloc(const struct request_sock_ops *ops)
  71 {
  72         struct request_sock *req = kmem_cache_alloc(ops->slab, GFP_ATOMIC);
  73
  74         if (req != NULL)
  75                 req->rsk_ops = ops;
  76
  77         return req;
  78 }
  79
  80 static inline struct request_sock *inet_reqsk(struct sock *sk)
  81 {
  82         return (struct request_sock *)sk;
  83 }
  84
  85 static inline void __reqsk_free(struct request_sock *req)
  86 {
  87         kmem_cache_free(req->rsk_ops->slab, req);
  88 }
  89
  90 static inline void reqsk_free(struct request_sock *req)
  91 {
  92         req->rsk_ops->destructor(req);
  93         __reqsk_free(req);
  94 }
  95
  96 static inline void reqsk_put(struct request_sock *req)
  97 {
  98         if (atomic_dec_and_test(&req->rsk_refcnt))
  99                 reqsk_free(req);
 100 }
 101
 102 extern int sysctl_max_syn_backlog;
 103
 104 /** struct listen_sock - listen state
 105  *
 106  * @max_qlen_log - log_2 of maximal queued SYNs/REQUESTs
 107  */
 108 struct listen_sock {
 109         u8                      max_qlen_log;
 110         u8                      synflood_warned;
 111         /* 2 bytes hole, try to use */
 112         int                     qlen;
 113         int                     qlen_young;
 114         int                     clock_hand;
 115         u32                     hash_rnd;
 116         u32                     nr_table_entries;
 117         struct request_sock     *syn_table[0];
 118 };
 119
 120 /*
 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.
 126  *
 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.
 136  */
 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.
 142                                                  */
 143         spinlock_t      lock;
 144         int             qlen;           /* # of pending (TCP_SYN_RECV) reqs */
 145         int             max_qlen;       /* != 0 iff TFO is currently enabled */
 146 };
 147
 148 /** struct request_sock_queue - queue of request_socks
 149  *
 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
 154  *
 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).
 157  *
 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.
 163  */
 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.
 176                                              */
 177 };
 178
 179 int reqsk_queue_alloc(struct request_sock_queue *queue,
 180                       unsigned int nr_table_entries);
 181
 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,
 185                            bool reset);
 186
 187 static inline struct request_sock *
 188         reqsk_queue_yank_acceptq(struct request_sock_queue *queue)
 189 {
 190         struct request_sock *req = queue->rskq_accept_head;
 191
 192         queue->rskq_accept_head = NULL;
 193         return req;
 194 }
 195
 196 static inline int reqsk_queue_empty(struct request_sock_queue *queue)
 197 {
 198         return queue->rskq_accept_head == NULL;
 199 }
 200
 201 static inline void reqsk_queue_unlink(struct request_sock_queue *queue,
 202                                       struct request_sock *req,
 203                                       struct request_sock **prev_req)
 204 {
 205         write_lock(&queue->syn_wait_lock);
 206         *prev_req = req->dl_next;
 207         write_unlock(&queue->syn_wait_lock);
 208 }
 209
 210 static inline void reqsk_queue_add(struct request_sock_queue *queue,
 211                                    struct request_sock *req,
 212                                    struct sock *parent,
 213                                    struct sock *child)
 214 {
 215         req->sk = child;
 216         sk_acceptq_added(parent);
 217
 218         if (queue->rskq_accept_head == NULL)
 219                 queue->rskq_accept_head = req;
 220         else
 221                 queue->rskq_accept_tail->dl_next = req;
 222
 223         queue->rskq_accept_tail = req;
 224         req->dl_next = NULL;
 225 }
 226
 227 static inline struct request_sock *reqsk_queue_remove(struct request_sock_queue *queue)
 228 {
 229         struct request_sock *req = queue->rskq_accept_head;
 230
 231         WARN_ON(req == NULL);
 232
 233         queue->rskq_accept_head = req->dl_next;
 234         if (queue->rskq_accept_head == NULL)
 235                 queue->rskq_accept_tail = NULL;
 236
 237         return req;
 238 }
 239
 240 static inline int reqsk_queue_removed(struct request_sock_queue *queue,
 241                                       struct request_sock *req)
 242 {
 243         struct listen_sock *lopt = queue->listen_opt;
 244
 245         if (req->num_timeout == 0)
 246                 --lopt->qlen_young;
 247
 248         return --lopt->qlen;
 249 }
 250
 251 static inline int reqsk_queue_added(struct request_sock_queue *queue)
 252 {
 253         struct listen_sock *lopt = queue->listen_opt;
 254         const int prev_qlen = lopt->qlen;
 255
 256         lopt->qlen_young++;
 257         lopt->qlen++;
 258         return prev_qlen;
 259 }
 260
 261 static inline int reqsk_queue_len(const struct request_sock_queue *queue)
 262 {
 263         return queue->listen_opt != NULL ? queue->listen_opt->qlen : 0;
 264 }
 265
 266 static inline int reqsk_queue_len_young(const struct request_sock_queue *queue)
 267 {
 268         return queue->listen_opt->qlen_young;
 269 }
 270
 271 static inline int reqsk_queue_is_full(const struct request_sock_queue *queue)
 272 {
 273         return queue->listen_opt->qlen >> queue->listen_opt->max_qlen_log;
 274 }
 275
 276 static inline void reqsk_queue_hash_req(struct request_sock_queue *queue,
 277                                         u32 hash, struct request_sock *req,
 278                                         unsigned long timeout)
 279 {
 280         struct listen_sock *lopt = queue->listen_opt;
 281
 282         req->expires = jiffies + timeout;
 283         req->num_retrans = 0;
 284         req->num_timeout = 0;
 285         req->sk = NULL;
 286         req->dl_next = lopt->syn_table[hash];
 287
 288         write_lock(&queue->syn_wait_lock);
 289         lopt->syn_table[hash] = req;
 290         write_unlock(&queue->syn_wait_lock);
 291 }
 292
 293 #endif /* _REQUEST_SOCK_H */