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