include/linux/tcp.h

   1 /*
   2  * INET         An implementation of the TCP/IP protocol suite for the LINUX
   3  *              operating system.  INET is implemented using the  BSD Socket
   4  *              interface as the means of communication with the user level.
   5  *
   6  *              Definitions for the TCP protocol.
   7  *
   8  * Version:     @(#)tcp.h       1.0.2   04/28/93
   9  *
  10  * Author:      Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
  11  *
  12  *              This program is free software; you can redistribute it and/or
  13  *              modify it under the terms of the GNU General Public License
  14  *              as published by the Free Software Foundation; either version
  15  *              2 of the License, or (at your option) any later version.
  16  */
  17 #ifndef _LINUX_TCP_H
  18 #define _LINUX_TCP_H
  19
  20
  21 #include <linux/skbuff.h>
  22 #include <linux/dmaengine.h>
  23 #include <net/sock.h>
  24 #include <net/inet_connection_sock.h>
  25 #include <net/inet_timewait_sock.h>
  26 #include <uapi/linux/tcp.h>
  27
  28 static inline struct tcphdr *tcp_hdr(const struct sk_buff *skb)
  29 {
  30         return (struct tcphdr *)skb_transport_header(skb);
  31 }
  32
  33 static inline unsigned int tcp_hdrlen(const struct sk_buff *skb)
  34 {
  35         return tcp_hdr(skb)->doff * 4;
  36 }
  37
  38 static inline struct tcphdr *inner_tcp_hdr(const struct sk_buff *skb)
  39 {
  40         return (struct tcphdr *)skb_inner_transport_header(skb);
  41 }
  42
  43 static inline unsigned int inner_tcp_hdrlen(const struct sk_buff *skb)
  44 {
  45         return inner_tcp_hdr(skb)->doff * 4;
  46 }
  47
  48 static inline unsigned int tcp_optlen(const struct sk_buff *skb)
  49 {
  50         return (tcp_hdr(skb)->doff - 5) * 4;
  51 }
  52
  53 /* TCP Fast Open */
  54 #define TCP_FASTOPEN_COOKIE_MIN 4       /* Min Fast Open Cookie size in bytes */
  55 #define TCP_FASTOPEN_COOKIE_MAX 16      /* Max Fast Open Cookie size in bytes */
  56 #define TCP_FASTOPEN_COOKIE_SIZE 8      /* the size employed by this impl. */
  57
  58 /* TCP Fast Open Cookie as stored in memory */
  59 struct tcp_fastopen_cookie {
  60         union {
  61                 u8      val[TCP_FASTOPEN_COOKIE_MAX];
  62 #if IS_ENABLED(CONFIG_IPV6)
  63                 struct in6_addr addr;
  64 #endif
  65         };
  66         s8      len;
  67 };
  68
  69 /* This defines a selective acknowledgement block. */
  70 struct tcp_sack_block_wire {
  71         __be32  start_seq;
  72         __be32  end_seq;
  73 };
  74
  75 struct tcp_sack_block {
  76         u32     start_seq;
  77         u32     end_seq;
  78 };
  79
  80 /*These are used to set the sack_ok field in struct tcp_options_received */
  81 #define TCP_SACK_SEEN     (1 << 0)   /*1 = peer is SACK capable, */
  82 #define TCP_FACK_ENABLED  (1 << 1)   /*1 = FACK is enabled locally*/
  83 #define TCP_DSACK_SEEN    (1 << 2)   /*1 = DSACK was received from peer*/
  84
  85 struct tcp_options_received {
  86 /*      PAWS/RTTM data  */
  87         long    ts_recent_stamp;/* Time we stored ts_recent (for aging) */
  88         u32     ts_recent;      /* Time stamp to echo next              */
  89         u32     rcv_tsval;      /* Time stamp value                     */
  90         u32     rcv_tsecr;      /* Time stamp echo reply                */
  91         u16     saw_tstamp : 1, /* Saw TIMESTAMP on last packet         */
  92                 tstamp_ok : 1,  /* TIMESTAMP seen on SYN packet         */
  93                 dsack : 1,      /* D-SACK is scheduled                  */
  94                 wscale_ok : 1,  /* Wscale seen on SYN packet            */
  95                 sack_ok : 4,    /* SACK seen on SYN packet              */
  96                 snd_wscale : 4, /* Window scaling received from sender  */
  97                 rcv_wscale : 4; /* Window scaling to send to receiver   */
  98         u8      num_sacks;      /* Number of SACK blocks                */
  99         u16     user_mss;       /* mss requested by user in ioctl       */
 100         u16     mss_clamp;      /* Maximal mss, negotiated at connection setup */
 101 };
 102
 103 static inline void tcp_clear_options(struct tcp_options_received *rx_opt)
 104 {
 105         rx_opt->tstamp_ok = rx_opt->sack_ok = 0;
 106         rx_opt->wscale_ok = rx_opt->snd_wscale = 0;
 107 }
 108
 109 /* This is the max number of SACKS that we'll generate and process. It's safe
 110  * to increase this, although since:
 111  *   size = TCPOLEN_SACK_BASE_ALIGNED (4) + n * TCPOLEN_SACK_PERBLOCK (8)
 112  * only four options will fit in a standard TCP header */
 113 #define TCP_NUM_SACKS 4
 114
 115 struct tcp_request_sock_ops;
 116
 117 struct tcp_request_sock {
 118         struct inet_request_sock        req;
 119 #ifdef CONFIG_TCP_MD5SIG
 120         /* Only used by TCP MD5 Signature so far. */
 121         const struct tcp_request_sock_ops *af_specific;
 122 #endif
 123         struct sock                     *listener; /* needed for TFO */
 124         u32                             rcv_isn;
 125         u32                             snt_isn;
 126         u32                             snt_synack; /* synack sent time */
 127         u32                             rcv_nxt; /* the ack # by SYNACK. For
 128                                                   * FastOpen it's the seq#
 129                                                   * after data-in-SYN.
 130                                                   */
 131 };
 132
 133 static inline struct tcp_request_sock *tcp_rsk(const struct request_sock *req)
 134 {
 135         return (struct tcp_request_sock *)req;
 136 }
 137
 138 struct tcp_sock {
 139         /* inet_connection_sock has to be the first member of tcp_sock */
 140         struct inet_connection_sock     inet_conn;
 141         u16     tcp_header_len; /* Bytes of tcp header to send          */
 142         u16     xmit_size_goal_segs; /* Goal for segmenting output packets */
 143
 144 /*
 145  *      Header prediction flags
 146  *      0x5?10 << 16 + snd_wnd in net byte order
 147  */
 148         __be32  pred_flags;
 149
 150 /*
 151  *      RFC793 variables by their proper names. This means you can
 152  *      read the code and the spec side by side (and laugh ...)
 153  *      See RFC793 and RFC1122. The RFC writes these in capitals.
 154  */
 155         u32     rcv_nxt;        /* What we want to receive next         */
 156         u32     copied_seq;     /* Head of yet unread data              */
 157         u32     rcv_wup;        /* rcv_nxt on last window update sent   */
 158         u32     snd_nxt;        /* Next sequence we send                */
 159
 160         u32     snd_una;        /* First byte we want an ack for        */
 161         u32     snd_sml;        /* Last byte of the most recently transmitted small packet */
 162         u32     rcv_tstamp;     /* timestamp of last received ACK (for keepalives) */
 163         u32     lsndtime;       /* timestamp of last sent data packet (for restart window) */
 164
 165         u32     tsoffset;       /* timestamp offset */
 166
 167         struct list_head tsq_node; /* anchor in tsq_tasklet.head list */
 168         unsigned long   tsq_flags;
 169
 170         /* Data for direct copy to user */
 171         struct {
 172                 struct sk_buff_head     prequeue;
 173                 struct task_struct      *task;
 174                 struct iovec            *iov;
 175                 int                     memory;
 176                 int                     len;
 177 #ifdef CONFIG_NET_DMA
 178                 /* members for async copy */
 179                 struct dma_chan         *dma_chan;
 180                 int                     wakeup;
 181                 struct dma_pinned_list  *pinned_list;
 182                 dma_cookie_t            dma_cookie;
 183 #endif
 184         } ucopy;
 185
 186         u32     snd_wl1;        /* Sequence for window update           */
 187         u32     snd_wnd;        /* The window we expect to receive      */
 188         u32     max_window;     /* Maximal window ever seen from peer   */
 189         u32     mss_cache;      /* Cached effective mss, not including SACKS */
 190
 191         u32     window_clamp;   /* Maximal window to advertise          */
 192         u32     rcv_ssthresh;   /* Current window clamp                 */
 193
 194         u16     advmss;         /* Advertised MSS                       */
 195         u8      unused;
 196         u8      nonagle     : 4,/* Disable Nagle algorithm?             */
 197                 thin_lto    : 1,/* Use linear timeouts for thin streams */
 198                 thin_dupack : 1,/* Fast retransmit on first dupack      */
 199                 repair      : 1,
 200                 frto        : 1;/* F-RTO (RFC5682) activated in CA_Loss */
 201         u8      repair_queue;
 202         u8      do_early_retrans:1,/* Enable RFC5827 early-retransmit  */
 203                 syn_data:1,     /* SYN includes data */
 204                 syn_fastopen:1, /* SYN includes Fast Open option */
 205                 syn_data_acked:1,/* data in SYN is acked by SYN-ACK */
 206                 is_cwnd_limited:1;/* forward progress limited by snd_cwnd? */
 207         u32     tlp_high_seq;   /* snd_nxt at the time of TLP retransmit. */
 208
 209 /* RTT measurement */
 210         u32     srtt_us;        /* smoothed round trip time << 3 in usecs */
 211         u32     mdev_us;        /* medium deviation                     */
 212         u32     mdev_max_us;    /* maximal mdev for the last rtt period */
 213         u32     rttvar_us;      /* smoothed mdev_max                    */
 214         u32     rtt_seq;        /* sequence number to update rttvar     */
 215
 216         u32     packets_out;    /* Packets which are "in flight"        */
 217         u32     retrans_out;    /* Retransmitted packets out            */
 218         u32     max_packets_out;  /* max packets_out in last window */
 219         u32     max_packets_seq;  /* right edge of max_packets_out flight */
 220
 221         u16     urg_data;       /* Saved octet of OOB data and control flags */
 222         u8      ecn_flags;      /* ECN status bits.                     */
 223         u8      reordering;     /* Packet reordering metric.            */
 224         u32     snd_up;         /* Urgent pointer               */
 225
 226         u8      keepalive_probes; /* num of allowed keep alive probes   */
 227 /*
 228  *      Options received (usually on last packet, some only on SYN packets).
 229  */
 230         struct tcp_options_received rx_opt;
 231
 232 /*
 233  *      Slow start and congestion control (see also Nagle, and Karn & Partridge)
 234  */
 235         u32     snd_ssthresh;   /* Slow start size threshold            */
 236         u32     snd_cwnd;       /* Sending congestion window            */
 237         u32     snd_cwnd_cnt;   /* Linear increase counter              */
 238         u32     snd_cwnd_clamp; /* Do not allow snd_cwnd to grow above this */
 239         u32     snd_cwnd_used;
 240         u32     snd_cwnd_stamp;
 241         u32     prior_cwnd;     /* Congestion window at start of Recovery. */
 242         u32     prr_delivered;  /* Number of newly delivered packets to
 243                                  * receiver in Recovery. */
 244         u32     prr_out;        /* Total number of pkts sent during Recovery. */
 245
 246         u32     rcv_wnd;        /* Current receiver window              */
 247         u32     write_seq;      /* Tail(+1) of data held in tcp send buffer */
 248         u32     notsent_lowat;  /* TCP_NOTSENT_LOWAT */
 249         u32     pushed_seq;     /* Last pushed seq, required to talk to windows */
 250         u32     lost_out;       /* Lost packets                 */
 251         u32     sacked_out;     /* SACK'd packets                       */
 252         u32     fackets_out;    /* FACK'd packets                       */
 253         u32     tso_deferred;
 254
 255         /* from STCP, retrans queue hinting */
 256         struct sk_buff* lost_skb_hint;
 257         struct sk_buff *retransmit_skb_hint;
 258
 259         /* OOO segments go in this list. Note that socket lock must be held,
 260          * as we do not use sk_buff_head lock.
 261          */
 262         struct sk_buff_head     out_of_order_queue;
 263
 264         /* SACKs data, these 2 need to be together (see tcp_options_write) */
 265         struct tcp_sack_block duplicate_sack[1]; /* D-SACK block */
 266         struct tcp_sack_block selective_acks[4]; /* The SACKS themselves*/
 267
 268         struct tcp_sack_block recv_sack_cache[4];
 269
 270         struct sk_buff *highest_sack;   /* skb just after the highest
 271                                          * skb with SACKed bit set
 272                                          * (validity guaranteed only if
 273                                          * sacked_out > 0)
 274                                          */
 275
 276         int     lost_cnt_hint;
 277         u32     retransmit_high;        /* L-bits may be on up to this seqno */
 278
 279         u32     lost_retrans_low;       /* Sent seq after any rxmit (lowest) */
 280
 281         u32     prior_ssthresh; /* ssthresh saved at recovery start     */
 282         u32     high_seq;       /* snd_nxt at onset of congestion       */
 283
 284         u32     retrans_stamp;  /* Timestamp of the last retransmit,
 285                                  * also used in SYN-SENT to remember stamp of
 286                                  * the first SYN. */
 287         u32     undo_marker;    /* tracking retrans started here. */
 288         int     undo_retrans;   /* number of undoable retransmissions. */
 289         u32     total_retrans;  /* Total retransmits for entire connection */
 290
 291         u32     urg_seq;        /* Seq of received urgent pointer */
 292         unsigned int            keepalive_time;   /* time before keep alive takes place */
 293         unsigned int            keepalive_intvl;  /* time interval between keep alive probes */
 294
 295         int                     linger2;
 296
 297 /* Receiver side RTT estimation */
 298         struct {
 299                 u32     rtt;
 300                 u32     seq;
 301                 u32     time;
 302         } rcv_rtt_est;
 303
 304 /* Receiver queue space */
 305         struct {
 306                 int     space;
 307                 u32     seq;
 308                 u32     time;
 309         } rcvq_space;
 310
 311 /* TCP-specific MTU probe information. */
 312         struct {
 313                 u32               probe_seq_start;
 314                 u32               probe_seq_end;
 315         } mtu_probe;
 316         u32     mtu_info; /* We received an ICMP_FRAG_NEEDED / ICMPV6_PKT_TOOBIG
 317                            * while socket was owned by user.
 318                            */
 319
 320 #ifdef CONFIG_TCP_MD5SIG
 321 /* TCP AF-Specific parts; only used by MD5 Signature support so far */
 322         const struct tcp_sock_af_ops    *af_specific;
 323
 324 /* TCP MD5 Signature Option information */
 325         struct tcp_md5sig_info  __rcu *md5sig_info;
 326 #endif
 327
 328 /* TCP fastopen related information */
 329         struct tcp_fastopen_request *fastopen_req;
 330         /* fastopen_rsk points to request_sock that resulted in this big
 331          * socket. Used to retransmit SYNACKs etc.
 332          */
 333         struct request_sock *fastopen_rsk;
 334 };
 335
 336 enum tsq_flags {
 337         TSQ_THROTTLED,
 338         TSQ_QUEUED,
 339         TCP_TSQ_DEFERRED,          /* tcp_tasklet_func() found socket was owned */
 340         TCP_WRITE_TIMER_DEFERRED,  /* tcp_write_timer() found socket was owned */
 341         TCP_DELACK_TIMER_DEFERRED, /* tcp_delack_timer() found socket was owned */
 342         TCP_MTU_REDUCED_DEFERRED,  /* tcp_v{4|6}_err() could not call
 343                                     * tcp_v{4|6}_mtu_reduced()
 344                                     */
 345 };
 346
 347 static inline struct tcp_sock *tcp_sk(const struct sock *sk)
 348 {
 349         return (struct tcp_sock *)sk;
 350 }
 351
 352 struct tcp_timewait_sock {
 353         struct inet_timewait_sock tw_sk;
 354         u32                       tw_rcv_nxt;
 355         u32                       tw_snd_nxt;
 356         u32                       tw_rcv_wnd;
 357         u32                       tw_ts_offset;
 358         u32                       tw_ts_recent;
 359         long                      tw_ts_recent_stamp;
 360 #ifdef CONFIG_TCP_MD5SIG
 361         struct tcp_md5sig_key     *tw_md5_key;
 362 #endif
 363 };
 364
 365 static inline struct tcp_timewait_sock *tcp_twsk(const struct sock *sk)
 366 {
 367         return (struct tcp_timewait_sock *)sk;
 368 }
 369
 370 static inline bool tcp_passive_fastopen(const struct sock *sk)
 371 {
 372         return (sk->sk_state == TCP_SYN_RECV &&
 373                 tcp_sk(sk)->fastopen_rsk != NULL);
 374 }
 375
 376 extern void tcp_sock_destruct(struct sock *sk);
 377
 378 static inline int fastopen_init_queue(struct sock *sk, int backlog)
 379 {
 380         struct request_sock_queue *queue =
 381             &inet_csk(sk)->icsk_accept_queue;
 382
 383         if (queue->fastopenq == NULL) {
 384                 queue->fastopenq = kzalloc(
 385                     sizeof(struct fastopen_queue),
 386                     sk->sk_allocation);
 387                 if (queue->fastopenq == NULL)
 388                         return -ENOMEM;
 389
 390                 sk->sk_destruct = tcp_sock_destruct;
 391                 spin_lock_init(&queue->fastopenq->lock);
 392         }
 393         queue->fastopenq->max_qlen = backlog;
 394         return 0;
 395 }
 396
 397 int tcp_skb_shift(struct sk_buff *to, struct sk_buff *from, int pcount,
 398                   int shiftlen);
 399
 400 #endif  /* _LINUX_TCP_H */