LXR linux/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#include <linux/types.h>
  21#include <asm/byteorder.h>
  22#include <linux/socket.h>
  23
  24struct tcphdr {
  25        __be16  source;
  26        __be16  dest;
  27        __be32  seq;
  28        __be32  ack_seq;
  29#if defined(__LITTLE_ENDIAN_BITFIELD)
  30        __u16   res1:4,
  31                doff:4,
  32                fin:1,
  33                syn:1,
  34                rst:1,
  35                psh:1,
  36                ack:1,
  37                urg:1,
  38                ece:1,
  39                cwr:1;
  40#elif defined(__BIG_ENDIAN_BITFIELD)
  41        __u16   doff:4,
  42                res1:4,
  43                cwr:1,
  44                ece:1,
  45                urg:1,
  46                ack:1,
  47                psh:1,
  48                rst:1,
  49                syn:1,
  50                fin:1;
  51#else
  52#error  "Adjust your <asm/byteorder.h> defines"
  53#endif  
  54        __be16  window;
  55        __sum16 check;
  56        __be16  urg_ptr;
  57};
  58
  59/*
  60 *      The union cast uses a gcc extension to avoid aliasing problems
  61 *  (union is compatible to any of its members)
  62 *  This means this part of the code is -fstrict-aliasing safe now.
  63 */
  64union tcp_word_hdr { 
  65        struct tcphdr hdr;
  66        __be32            words[5];
  67}; 
  68
  69#define tcp_flag_word(tp) ( ((union tcp_word_hdr *)(tp))->words [3]) 
  70
  71enum { 
  72        TCP_FLAG_CWR = __cpu_to_be32(0x00800000),
  73        TCP_FLAG_ECE = __cpu_to_be32(0x00400000),
  74        TCP_FLAG_URG = __cpu_to_be32(0x00200000),
  75        TCP_FLAG_ACK = __cpu_to_be32(0x00100000),
  76        TCP_FLAG_PSH = __cpu_to_be32(0x00080000),
  77        TCP_FLAG_RST = __cpu_to_be32(0x00040000),
  78        TCP_FLAG_SYN = __cpu_to_be32(0x00020000),
  79        TCP_FLAG_FIN = __cpu_to_be32(0x00010000),
  80        TCP_RESERVED_BITS = __cpu_to_be32(0x0F000000),
  81        TCP_DATA_OFFSET = __cpu_to_be32(0xF0000000)
  82}; 
  83
  84/*
  85 * TCP general constants
  86 */
  87#define TCP_MSS_DEFAULT          536U   /* IPv4 (RFC1122, RFC2581) */
  88#define TCP_MSS_DESIRED         1220U   /* IPv6 (tunneled), EDNS0 (RFC3226) */
  89
  90/* TCP socket options */
  91#define TCP_NODELAY             1       /* Turn off Nagle's algorithm. */
  92#define TCP_MAXSEG              2       /* Limit MSS */
  93#define TCP_CORK                3       /* Never send partially complete segments */
  94#define TCP_KEEPIDLE            4       /* Start keeplives after this period */
  95#define TCP_KEEPINTVL           5       /* Interval between keepalives */
  96#define TCP_KEEPCNT             6       /* Number of keepalives before death */
  97#define TCP_SYNCNT              7       /* Number of SYN retransmits */
  98#define TCP_LINGER2             8       /* Life time of orphaned FIN-WAIT-2 state */
  99#define TCP_DEFER_ACCEPT        9       /* Wake up listener only when data arrive */
 100#define TCP_WINDOW_CLAMP        10      /* Bound advertised window */
 101#define TCP_INFO                11      /* Information about this connection. */
 102#define TCP_QUICKACK            12      /* Block/reenable quick acks */
 103#define TCP_CONGESTION          13      /* Congestion control algorithm */
 104#define TCP_MD5SIG              14      /* TCP MD5 Signature (RFC2385) */
 105#define TCP_COOKIE_TRANSACTIONS 15      /* TCP Cookie Transactions */
 106#define TCP_THIN_LINEAR_TIMEOUTS 16      /* Use linear timeouts for thin streams*/
 107#define TCP_THIN_DUPACK         17      /* Fast retrans. after 1 dupack */
 108#define TCP_USER_TIMEOUT        18      /* How long for loss retry before timeout */
 109
 110/* for TCP_INFO socket option */
 111#define TCPI_OPT_TIMESTAMPS     1
 112#define TCPI_OPT_SACK           2
 113#define TCPI_OPT_WSCALE         4
 114#define TCPI_OPT_ECN            8 /* ECN was negociated at TCP session init */
 115#define TCPI_OPT_ECN_SEEN       16 /* we received at least one packet with ECT */
 116
 117enum tcp_ca_state {
 118        TCP_CA_Open = 0,
 119#define TCPF_CA_Open    (1<<TCP_CA_Open)
 120        TCP_CA_Disorder = 1,
 121#define TCPF_CA_Disorder (1<<TCP_CA_Disorder)
 122        TCP_CA_CWR = 2,
 123#define TCPF_CA_CWR     (1<<TCP_CA_CWR)
 124        TCP_CA_Recovery = 3,
 125#define TCPF_CA_Recovery (1<<TCP_CA_Recovery)
 126        TCP_CA_Loss = 4
 127#define TCPF_CA_Loss    (1<<TCP_CA_Loss)
 128};
 129
 130struct tcp_info {
 131        __u8    tcpi_state;
 132        __u8    tcpi_ca_state;
 133        __u8    tcpi_retransmits;
 134        __u8    tcpi_probes;
 135        __u8    tcpi_backoff;
 136        __u8    tcpi_options;
 137        __u8    tcpi_snd_wscale : 4, tcpi_rcv_wscale : 4;
 138
 139        __u32   tcpi_rto;
 140        __u32   tcpi_ato;
 141        __u32   tcpi_snd_mss;
 142        __u32   tcpi_rcv_mss;
 143
 144        __u32   tcpi_unacked;
 145        __u32   tcpi_sacked;
 146        __u32   tcpi_lost;
 147        __u32   tcpi_retrans;
 148        __u32   tcpi_fackets;
 149
 150        /* Times. */
 151        __u32   tcpi_last_data_sent;
 152        __u32   tcpi_last_ack_sent;     /* Not remembered, sorry. */
 153        __u32   tcpi_last_data_recv;
 154        __u32   tcpi_last_ack_recv;
 155
 156        /* Metrics. */
 157        __u32   tcpi_pmtu;
 158        __u32   tcpi_rcv_ssthresh;
 159        __u32   tcpi_rtt;
 160        __u32   tcpi_rttvar;
 161        __u32   tcpi_snd_ssthresh;
 162        __u32   tcpi_snd_cwnd;
 163        __u32   tcpi_advmss;
 164        __u32   tcpi_reordering;
 165
 166        __u32   tcpi_rcv_rtt;
 167        __u32   tcpi_rcv_space;
 168
 169        __u32   tcpi_total_retrans;
 170};
 171
 172/* for TCP_MD5SIG socket option */
 173#define TCP_MD5SIG_MAXKEYLEN    80
 174
 175struct tcp_md5sig {
 176        struct __kernel_sockaddr_storage tcpm_addr;     /* address associated */
 177        __u16   __tcpm_pad1;                            /* zero */
 178        __u16   tcpm_keylen;                            /* key length */
 179        __u32   __tcpm_pad2;                            /* zero */
 180        __u8    tcpm_key[TCP_MD5SIG_MAXKEYLEN];         /* key (binary) */
 181};
 182
 183/* for TCP_COOKIE_TRANSACTIONS (TCPCT) socket option */
 184#define TCP_COOKIE_MIN           8              /*  64-bits */
 185#define TCP_COOKIE_MAX          16              /* 128-bits */
 186#define TCP_COOKIE_PAIR_SIZE    (2*TCP_COOKIE_MAX)
 187
 188/* Flags for both getsockopt and setsockopt */
 189#define TCP_COOKIE_IN_ALWAYS    (1 << 0)        /* Discard SYN without cookie */
 190#define TCP_COOKIE_OUT_NEVER    (1 << 1)        /* Prohibit outgoing cookies,
 191                                                 * supercedes everything. */
 192
 193/* Flags for getsockopt */
 194#define TCP_S_DATA_IN           (1 << 2)        /* Was data received? */
 195#define TCP_S_DATA_OUT          (1 << 3)        /* Was data sent? */
 196
 197/* TCP_COOKIE_TRANSACTIONS data */
 198struct tcp_cookie_transactions {
 199        __u16   tcpct_flags;                    /* see above */
 200        __u8    __tcpct_pad1;                   /* zero */
 201        __u8    tcpct_cookie_desired;           /* bytes */
 202        __u16   tcpct_s_data_desired;           /* bytes of variable data */
 203        __u16   tcpct_used;                     /* bytes in value */
 204        __u8    tcpct_value[TCP_MSS_DEFAULT];
 205};
 206
 207#ifdef __KERNEL__
 208
 209#include <linux/skbuff.h>
 210#include <linux/dmaengine.h>
 211#include <net/sock.h>
 212#include <net/inet_connection_sock.h>
 213#include <net/inet_timewait_sock.h>
 214
 215static inline struct tcphdr *tcp_hdr(const struct sk_buff *skb)
 216{
 217        return (struct tcphdr *)skb_transport_header(skb);
 218}
 219
 220static inline unsigned int tcp_hdrlen(const struct sk_buff *skb)
 221{
 222        return tcp_hdr(skb)->doff * 4;
 223}
 224
 225static inline unsigned int tcp_optlen(const struct sk_buff *skb)
 226{
 227        return (tcp_hdr(skb)->doff - 5) * 4;
 228}
 229
 230/* This defines a selective acknowledgement block. */
 231struct tcp_sack_block_wire {
 232        __be32  start_seq;
 233        __be32  end_seq;
 234};
 235
 236struct tcp_sack_block {
 237        u32     start_seq;
 238        u32     end_seq;
 239};
 240
 241struct tcp_options_received {
 242/*      PAWS/RTTM data  */
 243        long    ts_recent_stamp;/* Time we stored ts_recent (for aging) */
 244        u32     ts_recent;      /* Time stamp to echo next              */
 245        u32     rcv_tsval;      /* Time stamp value                     */
 246        u32     rcv_tsecr;      /* Time stamp echo reply                */
 247        u16     saw_tstamp : 1, /* Saw TIMESTAMP on last packet         */
 248                tstamp_ok : 1,  /* TIMESTAMP seen on SYN packet         */
 249                dsack : 1,      /* D-SACK is scheduled                  */
 250                wscale_ok : 1,  /* Wscale seen on SYN packet            */
 251                sack_ok : 4,    /* SACK seen on SYN packet              */
 252                snd_wscale : 4, /* Window scaling received from sender  */
 253                rcv_wscale : 4; /* Window scaling to send to receiver   */
 254        u8      cookie_plus:6,  /* bytes in authenticator/cookie option */
 255                cookie_out_never:1,
 256                cookie_in_always:1;
 257        u8      num_sacks;      /* Number of SACK blocks                */
 258        u16     user_mss;       /* mss requested by user in ioctl       */
 259        u16     mss_clamp;      /* Maximal mss, negotiated at connection setup */
 260};
 261
 262static inline void tcp_clear_options(struct tcp_options_received *rx_opt)
 263{
 264        rx_opt->tstamp_ok = rx_opt->sack_ok = 0;
 265        rx_opt->wscale_ok = rx_opt->snd_wscale = 0;
 266        rx_opt->cookie_plus = 0;
 267}
 268
 269/* This is the max number of SACKS that we'll generate and process. It's safe
 270 * to increase this, although since:
 271 *   size = TCPOLEN_SACK_BASE_ALIGNED (4) + n * TCPOLEN_SACK_PERBLOCK (8)
 272 * only four options will fit in a standard TCP header */
 273#define TCP_NUM_SACKS 4
 274
 275struct tcp_cookie_values;
 276struct tcp_request_sock_ops;
 277
 278struct tcp_request_sock {
 279        struct inet_request_sock        req;
 280#ifdef CONFIG_TCP_MD5SIG
 281        /* Only used by TCP MD5 Signature so far. */
 282        const struct tcp_request_sock_ops *af_specific;
 283#endif
 284        u32                             rcv_isn;
 285        u32                             snt_isn;
 286        u32                             snt_synack; /* synack sent time */
 287};
 288
 289static inline struct tcp_request_sock *tcp_rsk(const struct request_sock *req)
 290{
 291        return (struct tcp_request_sock *)req;
 292}
 293
 294struct tcp_sock {
 295        /* inet_connection_sock has to be the first member of tcp_sock */
 296        struct inet_connection_sock     inet_conn;
 297        u16     tcp_header_len; /* Bytes of tcp header to send          */
 298        u16     xmit_size_goal_segs; /* Goal for segmenting output packets */
 299
 300/*
 301 *      Header prediction flags
 302 *      0x5?10 << 16 + snd_wnd in net byte order
 303 */
 304        __be32  pred_flags;
 305
 306/*
 307 *      RFC793 variables by their proper names. This means you can
 308 *      read the code and the spec side by side (and laugh ...)
 309 *      See RFC793 and RFC1122. The RFC writes these in capitals.
 310 */
 311        u32     rcv_nxt;        /* What we want to receive next         */
 312        u32     copied_seq;     /* Head of yet unread data              */
 313        u32     rcv_wup;        /* rcv_nxt on last window update sent   */
 314        u32     snd_nxt;        /* Next sequence we send                */
 315
 316        u32     snd_una;        /* First byte we want an ack for        */
 317        u32     snd_sml;        /* Last byte of the most recently transmitted small packet */
 318        u32     rcv_tstamp;     /* timestamp of last received ACK (for keepalives) */
 319        u32     lsndtime;       /* timestamp of last sent data packet (for restart window) */
 320
 321        /* Data for direct copy to user */
 322        struct {
 323                struct sk_buff_head     prequeue;
 324                struct task_struct      *task;
 325                struct iovec            *iov;
 326                int                     memory;
 327                int                     len;
 328#ifdef CONFIG_NET_DMA
 329                /* members for async copy */
 330                struct dma_chan         *dma_chan;
 331                int                     wakeup;
 332                struct dma_pinned_list  *pinned_list;
 333                dma_cookie_t            dma_cookie;
 334#endif
 335        } ucopy;
 336
 337        u32     snd_wl1;        /* Sequence for window update           */
 338        u32     snd_wnd;        /* The window we expect to receive      */
 339        u32     max_window;     /* Maximal window ever seen from peer   */
 340        u32     mss_cache;      /* Cached effective mss, not including SACKS */
 341
 342        u32     window_clamp;   /* Maximal window to advertise          */
 343        u32     rcv_ssthresh;   /* Current window clamp                 */
 344
 345        u32     frto_highmark;  /* snd_nxt when RTO occurred */
 346        u16     advmss;         /* Advertised MSS                       */
 347        u8      frto_counter;   /* Number of new acks after RTO */
 348        u8      nonagle     : 4,/* Disable Nagle algorithm?             */
 349                thin_lto    : 1,/* Use linear timeouts for thin streams */
 350                thin_dupack : 1,/* Fast retransmit on first dupack      */
 351                unused      : 2;
 352
 353/* RTT measurement */
 354        u32     srtt;           /* smoothed round trip time << 3        */
 355        u32     mdev;           /* medium deviation                     */
 356        u32     mdev_max;       /* maximal mdev for the last rtt period */
 357        u32     rttvar;         /* smoothed mdev_max                    */
 358        u32     rtt_seq;        /* sequence number to update rttvar     */
 359
 360        u32     packets_out;    /* Packets which are "in flight"        */
 361        u32     retrans_out;    /* Retransmitted packets out            */
 362
 363        u16     urg_data;       /* Saved octet of OOB data and control flags */
 364        u8      ecn_flags;      /* ECN status bits.                     */
 365        u8      reordering;     /* Packet reordering metric.            */
 366        u32     snd_up;         /* Urgent pointer               */
 367
 368        u8      keepalive_probes; /* num of allowed keep alive probes   */
 369/*
 370 *      Options received (usually on last packet, some only on SYN packets).
 371 */
 372        struct tcp_options_received rx_opt;
 373
 374/*
 375 *      Slow start and congestion control (see also Nagle, and Karn & Partridge)
 376 */
 377        u32     snd_ssthresh;   /* Slow start size threshold            */
 378        u32     snd_cwnd;       /* Sending congestion window            */
 379        u32     snd_cwnd_cnt;   /* Linear increase counter              */
 380        u32     snd_cwnd_clamp; /* Do not allow snd_cwnd to grow above this */
 381        u32     snd_cwnd_used;
 382        u32     snd_cwnd_stamp;
 383        u32     prior_cwnd;     /* Congestion window at start of Recovery. */
 384        u32     prr_delivered;  /* Number of newly delivered packets to
 385                                 * receiver in Recovery. */
 386        u32     prr_out;        /* Total number of pkts sent during Recovery. */
 387
 388        u32     rcv_wnd;        /* Current receiver window              */
 389        u32     write_seq;      /* Tail(+1) of data held in tcp send buffer */
 390        u32     pushed_seq;     /* Last pushed seq, required to talk to windows */
 391        u32     lost_out;       /* Lost packets                 */
 392        u32     sacked_out;     /* SACK'd packets                       */
 393        u32     fackets_out;    /* FACK'd packets                       */
 394        u32     tso_deferred;
 395        u32     bytes_acked;    /* Appropriate Byte Counting - RFC3465 */
 396
 397        /* from STCP, retrans queue hinting */
 398        struct sk_buff* lost_skb_hint;
 399        struct sk_buff *scoreboard_skb_hint;
 400        struct sk_buff *retransmit_skb_hint;
 401
 402        struct sk_buff_head     out_of_order_queue; /* Out of order segments go here */
 403
 404        /* SACKs data, these 2 need to be together (see tcp_build_and_update_options) */
 405        struct tcp_sack_block duplicate_sack[1]; /* D-SACK block */
 406        struct tcp_sack_block selective_acks[4]; /* The SACKS themselves*/
 407
 408        struct tcp_sack_block recv_sack_cache[4];
 409
 410        struct sk_buff *highest_sack;   /* highest skb with SACK received
 411                                         * (validity guaranteed only if
 412                                         * sacked_out > 0)
 413                                         */
 414
 415        int     lost_cnt_hint;
 416        u32     retransmit_high;        /* L-bits may be on up to this seqno */
 417
 418        u32     lost_retrans_low;       /* Sent seq after any rxmit (lowest) */
 419
 420        u32     prior_ssthresh; /* ssthresh saved at recovery start     */
 421        u32     high_seq;       /* snd_nxt at onset of congestion       */
 422
 423        u32     retrans_stamp;  /* Timestamp of the last retransmit,
 424                                 * also used in SYN-SENT to remember stamp of
 425                                 * the first SYN. */
 426        u32     undo_marker;    /* tracking retrans started here. */
 427        int     undo_retrans;   /* number of undoable retransmissions. */
 428        u32     total_retrans;  /* Total retransmits for entire connection */
 429
 430        u32     urg_seq;        /* Seq of received urgent pointer */
 431        unsigned int            keepalive_time;   /* time before keep alive takes place */
 432        unsigned int            keepalive_intvl;  /* time interval between keep alive probes */
 433
 434        int                     linger2;
 435
 436/* Receiver side RTT estimation */
 437        struct {
 438                u32     rtt;
 439                u32     seq;
 440                u32     time;
 441        } rcv_rtt_est;
 442
 443/* Receiver queue space */
 444        struct {
 445                int     space;
 446                u32     seq;
 447                u32     time;
 448        } rcvq_space;
 449
 450/* TCP-specific MTU probe information. */
 451        struct {
 452                u32               probe_seq_start;
 453                u32               probe_seq_end;
 454        } mtu_probe;
 455
 456#ifdef CONFIG_TCP_MD5SIG
 457/* TCP AF-Specific parts; only used by MD5 Signature support so far */
 458        const struct tcp_sock_af_ops    *af_specific;
 459
 460/* TCP MD5 Signature Option information */
 461        struct tcp_md5sig_info  *md5sig_info;
 462#endif
 463
 464        /* When the cookie options are generated and exchanged, then this
 465         * object holds a reference to them (cookie_values->kref).  Also
 466         * contains related tcp_cookie_transactions fields.
 467         */
 468        struct tcp_cookie_values  *cookie_values;
 469};
 470
 471static inline struct tcp_sock *tcp_sk(const struct sock *sk)
 472{
 473        return (struct tcp_sock *)sk;
 474}
 475
 476struct tcp_timewait_sock {
 477        struct inet_timewait_sock tw_sk;
 478        u32                       tw_rcv_nxt;
 479        u32                       tw_snd_nxt;
 480        u32                       tw_rcv_wnd;
 481        u32                       tw_ts_recent;
 482        long                      tw_ts_recent_stamp;
 483#ifdef CONFIG_TCP_MD5SIG
 484        u16                       tw_md5_keylen;
 485        u8                        tw_md5_key[TCP_MD5SIG_MAXKEYLEN];
 486#endif
 487        /* Few sockets in timewait have cookies; in that case, then this
 488         * object holds a reference to them (tw_cookie_values->kref).
 489         */
 490        struct tcp_cookie_values  *tw_cookie_values;
 491};
 492
 493static inline struct tcp_timewait_sock *tcp_twsk(const struct sock *sk)
 494{
 495        return (struct tcp_timewait_sock *)sk;
 496}
 497
 498#endif  /* __KERNEL__ */
 499
 500#endif  /* _LINUX_TCP_H */
 501