include/net/inet_connection_sock.h

   1 /*
   2  * NET          Generic infrastructure for INET connection oriented protocols.
   3  *
   4  *              Definitions for inet_connection_sock
   5  *
   6  * Authors:     Many people, see the TCP sources
   7  *
   8  *              From code originally in TCP
   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 _INET_CONNECTION_SOCK_H
  16 #define _INET_CONNECTION_SOCK_H
  17
  18 #include <linux/compiler.h>
  19 #include <linux/string.h>
  20 #include <linux/timer.h>
  21 #include <linux/poll.h>
  22
  23 #include <net/inet_sock.h>
  24 #include <net/request_sock.h>
  25
  26 #define INET_CSK_DEBUG 1
  27
  28 /* Cancel timers, when they are not required. */
  29 #undef INET_CSK_CLEAR_TIMERS
  30
  31 struct inet_bind_bucket;
  32 struct tcp_congestion_ops;
  33
  34 /*
  35  * Pointers to address related TCP functions
  36  * (i.e. things that depend on the address family)
  37  */
  38 struct inet_connection_sock_af_ops {
  39         int         (*queue_xmit)(struct sock *sk, struct sk_buff *skb, struct flowi *fl);
  40         void        (*send_check)(struct sock *sk, struct sk_buff *skb);
  41         int         (*rebuild_header)(struct sock *sk);
  42         void        (*sk_rx_dst_set)(struct sock *sk, const struct sk_buff *skb);
  43         int         (*conn_request)(struct sock *sk, struct sk_buff *skb);
  44         struct sock *(*syn_recv_sock)(const struct sock *sk, struct sk_buff *skb,
  45                                       struct request_sock *req,
  46                                       struct dst_entry *dst,
  47                                       struct request_sock *req_unhash,
  48                                       bool *own_req);
  49         u16         net_header_len;
  50         u16         net_frag_header_len;
  51         u16         sockaddr_len;
  52         int         (*setsockopt)(struct sock *sk, int level, int optname,
  53                                   char __user *optval, unsigned int optlen);
  54         int         (*getsockopt)(struct sock *sk, int level, int optname,
  55                                   char __user *optval, int __user *optlen);
  56 #ifdef CONFIG_COMPAT
  57         int         (*compat_setsockopt)(struct sock *sk,
  58                                 int level, int optname,
  59                                 char __user *optval, unsigned int optlen);
  60         int         (*compat_getsockopt)(struct sock *sk,
  61                                 int level, int optname,
  62                                 char __user *optval, int __user *optlen);
  63 #endif
  64         void        (*addr2sockaddr)(struct sock *sk, struct sockaddr *);
  65         void        (*mtu_reduced)(struct sock *sk);
  66 };
  67
  68 /** inet_connection_sock - INET connection oriented sock
  69  *
  70  * @icsk_accept_queue:     FIFO of established children
  71  * @icsk_bind_hash:        Bind node
  72  * @icsk_timeout:          Timeout
  73  * @icsk_retransmit_timer: Resend (no ack)
  74  * @icsk_rto:              Retransmit timeout
  75  * @icsk_pmtu_cookie       Last pmtu seen by socket
  76  * @icsk_ca_ops            Pluggable congestion control hook
  77  * @icsk_af_ops            Operations which are AF_INET{4,6} specific
  78  * @icsk_ulp_ops           Pluggable ULP control hook
  79  * @icsk_ulp_data          ULP private data
  80  * @icsk_listen_portaddr_node   hash to the portaddr listener hashtable
  81  * @icsk_ca_state:         Congestion control state
  82  * @icsk_retransmits:      Number of unrecovered [RTO] timeouts
  83  * @icsk_pending:          Scheduled timer event
  84  * @icsk_backoff:          Backoff
  85  * @icsk_syn_retries:      Number of allowed SYN (or equivalent) retries
  86  * @icsk_probes_out:       unanswered 0 window probes
  87  * @icsk_ext_hdr_len:      Network protocol overhead (IP/IPv6 options)
  88  * @icsk_ack:              Delayed ACK control data
  89  * @icsk_mtup;             MTU probing control data
  90  */
  91 struct inet_connection_sock {
  92         /* inet_sock has to be the first member! */
  93         struct inet_sock          icsk_inet;
  94         struct request_sock_queue icsk_accept_queue;
  95         struct inet_bind_bucket   *icsk_bind_hash;
  96         unsigned long             icsk_timeout;
  97         struct timer_list         icsk_retransmit_timer;
  98         struct timer_list         icsk_delack_timer;
  99         __u32                     icsk_rto;
 100         __u32                     icsk_pmtu_cookie;
 101         const struct tcp_congestion_ops *icsk_ca_ops;
 102         const struct inet_connection_sock_af_ops *icsk_af_ops;
 103         const struct tcp_ulp_ops  *icsk_ulp_ops;
 104         void                      *icsk_ulp_data;
 105         struct hlist_node         icsk_listen_portaddr_node;
 106         unsigned int              (*icsk_sync_mss)(struct sock *sk, u32 pmtu);
 107         __u8                      icsk_ca_state:6,
 108                                   icsk_ca_setsockopt:1,
 109                                   icsk_ca_dst_locked:1;
 110         __u8                      icsk_retransmits;
 111         __u8                      icsk_pending;
 112         __u8                      icsk_backoff;
 113         __u8                      icsk_syn_retries;
 114         __u8                      icsk_probes_out;
 115         __u16                     icsk_ext_hdr_len;
 116         struct {
 117                 __u8              pending;       /* ACK is pending                         */
 118                 __u8              quick;         /* Scheduled number of quick acks         */
 119                 __u8              pingpong;      /* The session is interactive             */
 120                 __u8              blocked;       /* Delayed ACK was blocked by socket lock */
 121                 __u32             ato;           /* Predicted tick of soft clock           */
 122                 unsigned long     timeout;       /* Currently scheduled timeout            */
 123                 __u32             lrcvtime;      /* timestamp of last received data packet */
 124                 __u16             last_seg_size; /* Size of last incoming segment          */
 125                 __u16             rcv_mss;       /* MSS used for delayed ACK decisions     */
 126         } icsk_ack;
 127         struct {
 128                 int               enabled;
 129
 130                 /* Range of MTUs to search */
 131                 int               search_high;
 132                 int               search_low;
 133
 134                 /* Information on the current probe. */
 135                 int               probe_size;
 136
 137                 u32               probe_timestamp;
 138         } icsk_mtup;
 139         u32                       icsk_user_timeout;
 140
 141         u64                       icsk_ca_priv[88 / sizeof(u64)];
 142 #define ICSK_CA_PRIV_SIZE      (11 * sizeof(u64))
 143 };
 144
 145 #define ICSK_TIME_RETRANS       1       /* Retransmit timer */
 146 #define ICSK_TIME_DACK          2       /* Delayed ack timer */
 147 #define ICSK_TIME_PROBE0        3       /* Zero window probe timer */
 148 #define ICSK_TIME_EARLY_RETRANS 4       /* Early retransmit timer */
 149 #define ICSK_TIME_LOSS_PROBE    5       /* Tail loss probe timer */
 150 #define ICSK_TIME_REO_TIMEOUT   6       /* Reordering timer */
 151
 152 static inline struct inet_connection_sock *inet_csk(const struct sock *sk)
 153 {
 154         return (struct inet_connection_sock *)sk;
 155 }
 156
 157 static inline void *inet_csk_ca(const struct sock *sk)
 158 {
 159         return (void *)inet_csk(sk)->icsk_ca_priv;
 160 }
 161
 162 struct sock *inet_csk_clone_lock(const struct sock *sk,
 163                                  const struct request_sock *req,
 164                                  const gfp_t priority);
 165
 166 enum inet_csk_ack_state_t {
 167         ICSK_ACK_SCHED  = 1,
 168         ICSK_ACK_TIMER  = 2,
 169         ICSK_ACK_PUSHED = 4,
 170         ICSK_ACK_PUSHED2 = 8
 171 };
 172
 173 void inet_csk_init_xmit_timers(struct sock *sk,
 174                                void (*retransmit_handler)(struct timer_list *),
 175                                void (*delack_handler)(struct timer_list *),
 176                                void (*keepalive_handler)(struct timer_list *));
 177 void inet_csk_clear_xmit_timers(struct sock *sk);
 178
 179 static inline void inet_csk_schedule_ack(struct sock *sk)
 180 {
 181         inet_csk(sk)->icsk_ack.pending |= ICSK_ACK_SCHED;
 182 }
 183
 184 static inline int inet_csk_ack_scheduled(const struct sock *sk)
 185 {
 186         return inet_csk(sk)->icsk_ack.pending & ICSK_ACK_SCHED;
 187 }
 188
 189 static inline void inet_csk_delack_init(struct sock *sk)
 190 {
 191         memset(&inet_csk(sk)->icsk_ack, 0, sizeof(inet_csk(sk)->icsk_ack));
 192 }
 193
 194 void inet_csk_delete_keepalive_timer(struct sock *sk);
 195 void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long timeout);
 196
 197 #ifdef INET_CSK_DEBUG
 198 extern const char inet_csk_timer_bug_msg[];
 199 #endif
 200
 201 static inline void inet_csk_clear_xmit_timer(struct sock *sk, const int what)
 202 {
 203         struct inet_connection_sock *icsk = inet_csk(sk);
 204
 205         if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
 206                 icsk->icsk_pending = 0;
 207 #ifdef INET_CSK_CLEAR_TIMERS
 208                 sk_stop_timer(sk, &icsk->icsk_retransmit_timer);
 209 #endif
 210         } else if (what == ICSK_TIME_DACK) {
 211                 icsk->icsk_ack.blocked = icsk->icsk_ack.pending = 0;
 212 #ifdef INET_CSK_CLEAR_TIMERS
 213                 sk_stop_timer(sk, &icsk->icsk_delack_timer);
 214 #endif
 215         }
 216 #ifdef INET_CSK_DEBUG
 217         else {
 218                 pr_debug("%s", inet_csk_timer_bug_msg);
 219         }
 220 #endif
 221 }
 222
 223 /*
 224  *      Reset the retransmission timer
 225  */
 226 static inline void inet_csk_reset_xmit_timer(struct sock *sk, const int what,
 227                                              unsigned long when,
 228                                              const unsigned long max_when)
 229 {
 230         struct inet_connection_sock *icsk = inet_csk(sk);
 231
 232         if (when > max_when) {
 233 #ifdef INET_CSK_DEBUG
 234                 pr_debug("reset_xmit_timer: sk=%p %d when=0x%lx, caller=%p\n",
 235                          sk, what, when, current_text_addr());
 236 #endif
 237                 when = max_when;
 238         }
 239
 240         if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0 ||
 241             what == ICSK_TIME_EARLY_RETRANS || what == ICSK_TIME_LOSS_PROBE ||
 242             what == ICSK_TIME_REO_TIMEOUT) {
 243                 icsk->icsk_pending = what;
 244                 icsk->icsk_timeout = jiffies + when;
 245                 sk_reset_timer(sk, &icsk->icsk_retransmit_timer, icsk->icsk_timeout);
 246         } else if (what == ICSK_TIME_DACK) {
 247                 icsk->icsk_ack.pending |= ICSK_ACK_TIMER;
 248                 icsk->icsk_ack.timeout = jiffies + when;
 249                 sk_reset_timer(sk, &icsk->icsk_delack_timer, icsk->icsk_ack.timeout);
 250         }
 251 #ifdef INET_CSK_DEBUG
 252         else {
 253                 pr_debug("%s", inet_csk_timer_bug_msg);
 254         }
 255 #endif
 256 }
 257
 258 static inline unsigned long
 259 inet_csk_rto_backoff(const struct inet_connection_sock *icsk,
 260                      unsigned long max_when)
 261 {
 262         u64 when = (u64)icsk->icsk_rto << icsk->icsk_backoff;
 263
 264         return (unsigned long)min_t(u64, when, max_when);
 265 }
 266
 267 struct sock *inet_csk_accept(struct sock *sk, int flags, int *err, bool kern);
 268
 269 int inet_csk_get_port(struct sock *sk, unsigned short snum);
 270
 271 struct dst_entry *inet_csk_route_req(const struct sock *sk, struct flowi4 *fl4,
 272                                      const struct request_sock *req);
 273 struct dst_entry *inet_csk_route_child_sock(const struct sock *sk,
 274                                             struct sock *newsk,
 275                                             const struct request_sock *req);
 276
 277 struct sock *inet_csk_reqsk_queue_add(struct sock *sk,
 278                                       struct request_sock *req,
 279                                       struct sock *child);
 280 void inet_csk_reqsk_queue_hash_add(struct sock *sk, struct request_sock *req,
 281                                    unsigned long timeout);
 282 struct sock *inet_csk_complete_hashdance(struct sock *sk, struct sock *child,
 283                                          struct request_sock *req,
 284                                          bool own_req);
 285
 286 static inline void inet_csk_reqsk_queue_added(struct sock *sk)
 287 {
 288         reqsk_queue_added(&inet_csk(sk)->icsk_accept_queue);
 289 }
 290
 291 static inline int inet_csk_reqsk_queue_len(const struct sock *sk)
 292 {
 293         return reqsk_queue_len(&inet_csk(sk)->icsk_accept_queue);
 294 }
 295
 296 static inline int inet_csk_reqsk_queue_is_full(const struct sock *sk)
 297 {
 298         return inet_csk_reqsk_queue_len(sk) >= sk->sk_max_ack_backlog;
 299 }
 300
 301 void inet_csk_reqsk_queue_drop(struct sock *sk, struct request_sock *req);
 302 void inet_csk_reqsk_queue_drop_and_put(struct sock *sk, struct request_sock *req);
 303
 304 void inet_csk_destroy_sock(struct sock *sk);
 305 void inet_csk_prepare_forced_close(struct sock *sk);
 306
 307 /*
 308  * LISTEN is a special case for poll..
 309  */
 310 static inline __poll_t inet_csk_listen_poll(const struct sock *sk)
 311 {
 312         return !reqsk_queue_empty(&inet_csk(sk)->icsk_accept_queue) ?
 313                         (EPOLLIN | EPOLLRDNORM) : 0;
 314 }
 315
 316 int inet_csk_listen_start(struct sock *sk, int backlog);
 317 void inet_csk_listen_stop(struct sock *sk);
 318
 319 void inet_csk_addr2sockaddr(struct sock *sk, struct sockaddr *uaddr);
 320
 321 int inet_csk_compat_getsockopt(struct sock *sk, int level, int optname,
 322                                char __user *optval, int __user *optlen);
 323 int inet_csk_compat_setsockopt(struct sock *sk, int level, int optname,
 324                                char __user *optval, unsigned int optlen);
 325
 326 struct dst_entry *inet_csk_update_pmtu(struct sock *sk, u32 mtu);
 327 #endif /* _INET_CONNECTION_SOCK_H */