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         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         unsigned long                   expires;
  65         const struct request_sock_ops   *rsk_ops;
  66         struct sock                     *sk;
  67         u32                             secid;
  68         u32                             peer_secid;
  69 };
  70
  71 static inline struct request_sock *
  72 reqsk_alloc(const struct request_sock_ops *ops, struct sock *sk_listener)
  73 {
  74         struct request_sock *req = kmem_cache_alloc(ops->slab, GFP_ATOMIC);
  75
  76         if (req) {
  77                 req->rsk_ops = ops;
  78                 sock_hold(sk_listener);
  79                 req->rsk_listener = sk_listener;
  80
  81                 /* Following is temporary. It is coupled with debugging
  82                  * helpers in reqsk_put() & reqsk_free()
  83                  */
  84                 atomic_set(&req->rsk_refcnt, 0);
  85         }
  86         return req;
  87 }
  88
  89 static inline struct request_sock *inet_reqsk(struct sock *sk)
  90 {
  91         return (struct request_sock *)sk;
  92 }
  93
  94 static inline struct sock *req_to_sk(struct request_sock *req)
  95 {
  96         return (struct sock *)req;
  97 }
  98
  99 static inline void reqsk_free(struct request_sock *req)
 100 {
 101         /* temporary debugging */
 102         WARN_ON_ONCE(atomic_read(&req->rsk_refcnt) != 0);
 103
 104         req->rsk_ops->destructor(req);
 105         if (req->rsk_listener)
 106                 sock_put(req->rsk_listener);
 107         kmem_cache_free(req->rsk_ops->slab, req);
 108 }
 109
 110 static inline void reqsk_put(struct request_sock *req)
 111 {
 112         /* temporary debugging, until req sock are put into ehash table */
 113         WARN_ON_ONCE(atomic_read(&req->rsk_refcnt) != 1);
 114
 115         if (atomic_dec_and_test(&req->rsk_refcnt))
 116                 reqsk_free(req);
 117 }
 118
 119 extern int sysctl_max_syn_backlog;
 120
 121 /** struct listen_sock - listen state
 122  *
 123  * @max_qlen_log - log_2 of maximal queued SYNs/REQUESTs
 124  */
 125 struct listen_sock {
 126         u8                      max_qlen_log;
 127         u8                      synflood_warned;
 128         /* 2 bytes hole, try to use */
 129         int                     qlen;
 130         int                     qlen_young;
 131         int                     clock_hand;
 132         u32                     hash_rnd;
 133         u32                     nr_table_entries;
 134         struct request_sock     *syn_table[0];
 135 };
 136
 137 /*
 138  * For a TCP Fast Open listener -
 139  *      lock - protects the access to all the reqsk, which is co-owned by
 140  *              the listener and the child socket.
 141  *      qlen - pending TFO requests (still in TCP_SYN_RECV).
 142  *      max_qlen - max TFO reqs allowed before TFO is disabled.
 143  *
 144  *      XXX (TFO) - ideally these fields can be made as part of "listen_sock"
 145  *      structure above. But there is some implementation difficulty due to
 146  *      listen_sock being part of request_sock_queue hence will be freed when
 147  *      a listener is stopped. But TFO related fields may continue to be
 148  *      accessed even after a listener is closed, until its sk_refcnt drops
 149  *      to 0 implying no more outstanding TFO reqs. One solution is to keep
 150  *      listen_opt around until sk_refcnt drops to 0. But there is some other
 151  *      complexity that needs to be resolved. E.g., a listener can be disabled
 152  *      temporarily through shutdown()->tcp_disconnect(), and re-enabled later.
 153  */
 154 struct fastopen_queue {
 155         struct request_sock     *rskq_rst_head; /* Keep track of past TFO */
 156         struct request_sock     *rskq_rst_tail; /* requests that caused RST.
 157                                                  * This is part of the defense
 158                                                  * against spoofing attack.
 159                                                  */
 160         spinlock_t      lock;
 161         int             qlen;           /* # of pending (TCP_SYN_RECV) reqs */
 162         int             max_qlen;       /* != 0 iff TFO is currently enabled */
 163 };
 164
 165 /** struct request_sock_queue - queue of request_socks
 166  *
 167  * @rskq_accept_head - FIFO head of established children
 168  * @rskq_accept_tail - FIFO tail of established children
 169  * @rskq_defer_accept - User waits for some data after accept()
 170  * @syn_wait_lock - serializer
 171  *
 172  * %syn_wait_lock is necessary only to avoid proc interface having to grab the main
 173  * lock sock while browsing the listening hash (otherwise it's deadlock prone).
 174  *
 175  * This lock is acquired in read mode only from listening_get_next() seq_file
 176  * op and it's acquired in write mode _only_ from code that is actively
 177  * changing rskq_accept_head. All readers that are holding the master sock lock
 178  * don't need to grab this lock in read mode too as rskq_accept_head. writes
 179  * are always protected from the main sock lock.
 180  */
 181 struct request_sock_queue {
 182         struct request_sock     *rskq_accept_head;
 183         struct request_sock     *rskq_accept_tail;
 184         rwlock_t                syn_wait_lock;
 185         u8                      rskq_defer_accept;
 186         /* 3 bytes hole, try to pack */
 187         struct listen_sock      *listen_opt;
 188         struct fastopen_queue   *fastopenq; /* This is non-NULL iff TFO has been
 189                                              * enabled on this listener. Check
 190                                              * max_qlen != 0 in fastopen_queue
 191                                              * to determine if TFO is enabled
 192                                              * right at this moment.
 193                                              */
 194 };
 195
 196 int reqsk_queue_alloc(struct request_sock_queue *queue,
 197                       unsigned int nr_table_entries);
 198
 199 void __reqsk_queue_destroy(struct request_sock_queue *queue);
 200 void reqsk_queue_destroy(struct request_sock_queue *queue);
 201 void reqsk_fastopen_remove(struct sock *sk, struct request_sock *req,
 202                            bool reset);
 203
 204 static inline struct request_sock *
 205         reqsk_queue_yank_acceptq(struct request_sock_queue *queue)
 206 {
 207         struct request_sock *req = queue->rskq_accept_head;
 208
 209         queue->rskq_accept_head = NULL;
 210         return req;
 211 }
 212
 213 static inline int reqsk_queue_empty(struct request_sock_queue *queue)
 214 {
 215         return queue->rskq_accept_head == NULL;
 216 }
 217
 218 static inline void reqsk_queue_unlink(struct request_sock_queue *queue,
 219                                       struct request_sock *req,
 220                                       struct request_sock **prev_req)
 221 {
 222         write_lock(&queue->syn_wait_lock);
 223         *prev_req = req->dl_next;
 224         write_unlock(&queue->syn_wait_lock);
 225 }
 226
 227 static inline void reqsk_queue_add(struct request_sock_queue *queue,
 228                                    struct request_sock *req,
 229                                    struct sock *parent,
 230                                    struct sock *child)
 231 {
 232         req->sk = child;
 233         sk_acceptq_added(parent);
 234
 235         if (queue->rskq_accept_head == NULL)
 236                 queue->rskq_accept_head = req;
 237         else
 238                 queue->rskq_accept_tail->dl_next = req;
 239
 240         queue->rskq_accept_tail = req;
 241         req->dl_next = NULL;
 242 }
 243
 244 static inline struct request_sock *reqsk_queue_remove(struct request_sock_queue *queue)
 245 {
 246         struct request_sock *req = queue->rskq_accept_head;
 247
 248         WARN_ON(req == NULL);
 249
 250         queue->rskq_accept_head = req->dl_next;
 251         if (queue->rskq_accept_head == NULL)
 252                 queue->rskq_accept_tail = NULL;
 253
 254         return req;
 255 }
 256
 257 static inline int reqsk_queue_removed(struct request_sock_queue *queue,
 258                                       struct request_sock *req)
 259 {
 260         struct listen_sock *lopt = queue->listen_opt;
 261
 262         if (req->num_timeout == 0)
 263                 --lopt->qlen_young;
 264
 265         return --lopt->qlen;
 266 }
 267
 268 static inline int reqsk_queue_added(struct request_sock_queue *queue)
 269 {
 270         struct listen_sock *lopt = queue->listen_opt;
 271         const int prev_qlen = lopt->qlen;
 272
 273         lopt->qlen_young++;
 274         lopt->qlen++;
 275         return prev_qlen;
 276 }
 277
 278 static inline int reqsk_queue_len(const struct request_sock_queue *queue)
 279 {
 280         return queue->listen_opt != NULL ? queue->listen_opt->qlen : 0;
 281 }
 282
 283 static inline int reqsk_queue_len_young(const struct request_sock_queue *queue)
 284 {
 285         return queue->listen_opt->qlen_young;
 286 }
 287
 288 static inline int reqsk_queue_is_full(const struct request_sock_queue *queue)
 289 {
 290         return queue->listen_opt->qlen >> queue->listen_opt->max_qlen_log;
 291 }
 292
 293 static inline void reqsk_queue_hash_req(struct request_sock_queue *queue,
 294                                         u32 hash, struct request_sock *req,
 295                                         unsigned long timeout)
 296 {
 297         struct listen_sock *lopt = queue->listen_opt;
 298
 299         req->expires = jiffies + timeout;
 300         req->num_retrans = 0;
 301         req->num_timeout = 0;
 302         req->sk = NULL;
 303         req->dl_next = lopt->syn_table[hash];
 304
 305         /* before letting lookups find us, make sure all req fields
 306          * are committed to memory and refcnt initialized.
 307          */
 308         smp_wmb();
 309         atomic_set(&req->rsk_refcnt, 1);
 310
 311         write_lock(&queue->syn_wait_lock);
 312         lopt->syn_table[hash] = req;
 313         write_unlock(&queue->syn_wait_lock);
 314 }
 315
 316 #endif /* _REQUEST_SOCK_H */