dc4d8dee77befc2b06dd3babce5884609c51d496
[dragonfly.git] / sys / netinet / tcp_var.h
1 /*
2  * Copyright (c) 2003, 2004 Jeffrey M. Hsu.  All rights reserved.
3  * Copyright (c) 2003, 2004 The DragonFly Project.  All rights reserved.
4  *
5  * This code is derived from software contributed to The DragonFly Project
6  * by Jeffrey M. Hsu.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of The DragonFly Project nor the names of its
17  *    contributors may be used to endorse or promote products derived
18  *    from this software without specific, prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
24  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
30  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33
34 /*
35  * Copyright (c) 1982, 1986, 1993, 1994, 1995
36  *      The Regents of the University of California.  All rights reserved.
37  *
38  * Redistribution and use in source and binary forms, with or without
39  * modification, are permitted provided that the following conditions
40  * are met:
41  * 1. Redistributions of source code must retain the above copyright
42  *    notice, this list of conditions and the following disclaimer.
43  * 2. Redistributions in binary form must reproduce the above copyright
44  *    notice, this list of conditions and the following disclaimer in the
45  *    documentation and/or other materials provided with the distribution.
46  * 3. All advertising materials mentioning features or use of this software
47  *    must display the following acknowledgement:
48  *      This product includes software developed by the University of
49  *      California, Berkeley and its contributors.
50  * 4. Neither the name of the University nor the names of its contributors
51  *    may be used to endorse or promote products derived from this software
52  *    without specific prior written permission.
53  *
54  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64  * SUCH DAMAGE.
65  *
66  *      @(#)tcp_var.h   8.4 (Berkeley) 5/24/95
67  * $FreeBSD: src/sys/netinet/tcp_var.h,v 1.56.2.13 2003/02/03 02:34:07 hsu Exp $
68  * $DragonFly: src/sys/netinet/tcp_var.h,v 1.42 2008/10/27 02:56:30 sephe Exp $
69  */
70
71 #ifndef _NETINET_TCP_VAR_H_
72 #define _NETINET_TCP_VAR_H_
73
74 #ifndef _NETINET_IN_PCB_H_
75 #include <netinet/in_pcb.h>             /* needed for in_conninfo, inp_gen_t */
76 #endif
77 #ifndef _NETINET_TCP_H_
78 #include <netinet/tcp.h>
79 #endif
80
81 /*
82  * Kernel variables for tcp.
83  */
84 extern int tcp_do_rfc1323;
85 extern int tcp_low_rtobase;
86 extern int tcp_do_sack;
87 extern int tcp_do_smartsack;
88 extern int tcp_do_rescuesack;
89 extern int tcp_aggressive_rescuesack;
90 extern int tcp_aggregate_acks;
91 extern int tcp_eifel_rtoinc;
92
93 /* TCP segment queue entry */
94 struct tseg_qent {
95         LIST_ENTRY(tseg_qent) tqe_q;
96         int     tqe_len;                /* TCP segment data length */
97         struct  tcphdr *tqe_th;         /* a pointer to tcp header */
98         struct  mbuf    *tqe_m;         /* mbuf contains packet */
99 };
100 LIST_HEAD(tsegqe_head, tseg_qent);
101 extern int      tcp_reass_maxseg;
102 extern int      tcp_reass_qsize;
103 #ifdef MALLOC_DECLARE
104 MALLOC_DECLARE(M_TSEGQ);
105 #endif
106
107 struct tcptemp {
108         u_char  tt_ipgen[40]; /* the size must be of max ip header, now IPv6 */
109         struct  tcphdr tt_t;
110 };
111
112 #define tcp6cb          tcpcb  /* for KAME src sync over BSD*'s */
113
114 struct raw_sackblock {                          /* covers [start, end) */
115         tcp_seq rblk_start;
116         tcp_seq rblk_end;
117 };
118
119 /* maximum number of SACK blocks that will fit in the TCP option space */
120 #define MAX_SACK_REPORT_BLOCKS  4
121
122 TAILQ_HEAD(sackblock_list, sackblock);
123
124 struct scoreboard {
125         int nblocks;
126         struct sackblock_list sackblocks;
127         tcp_seq lostseq;                        /* passed SACK lost test */
128         struct sackblock *lastfound;            /* search hint */
129         struct sackblock *freecache;            /* one slot free block cache */
130 };
131
132 struct netmsg_tcp_timer;
133
134 /*
135  * Tcp control block, one per tcp; fields:
136  * Organized for 16 byte cacheline efficiency.
137  */
138 struct tcpcb {
139         struct  tsegqe_head t_segq;
140         int     t_dupacks;              /* consecutive dup acks recd */
141         int     t_rxtthresh;            /* # dup acks to start fast rxt */
142         int     tt_cpu;                 /* sanity check the cpu */
143
144         struct  tcp_callout *tt_rexmt;  /* retransmit timer */
145         struct  tcp_callout *tt_persist;/* retransmit persistence */
146         struct  tcp_callout *tt_keep;   /* keepalive */
147         struct  tcp_callout *tt_2msl;   /* 2*msl TIME_WAIT timer */
148         struct  tcp_callout *tt_delack; /* delayed ACK timer */
149         struct  netmsg_tcp_timer *tt_msg; /* timer message */
150
151         struct  inpcb *t_inpcb;         /* back pointer to internet pcb */
152         int     t_state;                /* state of this connection */
153         u_int   t_flags;
154 #define TF_ACKNOW       0x00000001      /* ack peer immediately */
155 #define TF_DELACK       0x00000002      /* ack, but try to delay it */
156 #define TF_NODELAY      0x00000004      /* don't delay packets to coalesce */
157 #define TF_NOOPT        0x00000008      /* don't use tcp options */
158 #define TF_SENTFIN      0x00000010      /* have sent FIN */
159 #define TF_REQ_SCALE    0x00000020      /* have/will request window scaling */
160 #define TF_RCVD_SCALE   0x00000040      /* other side has requested scaling */
161 #define TF_REQ_TSTMP    0x00000080      /* have/will request timestamps */
162 #define TF_RCVD_TSTMP   0x00000100      /* a timestamp was received in SYN */
163 #define TF_SACK_PERMITTED 0x00000200    /* other side said I could SACK */
164 #define TF_NEEDSYN      0x00000400      /* send SYN (implicit state) */
165 #define TF_NEEDFIN      0x00000800      /* send FIN (implicit state) */
166 #define TF_NOPUSH       0x00001000      /* don't push */
167 #define TF_LISTEN       0x00002000      /* listen(2) has been called */
168 #define TF_SIGNATURE    0x00004000      /* require MD5 digests (RFC2385) */
169 #define TF_SACKRESCUED  0x00008000      /* sent rescue SACK recovery data */
170 #define TF_MORETOCOME   0x00010000      /* More data to be appended to sock */
171 #define TF_REBASERTO    0x00020000      /* Recalculate RTO based on new RTT */
172 #define TF_LASTIDLE     0x00040000      /* connection was previously idle */
173 #define TF_RXWIN0SENT   0x00080000      /* sent a receiver win 0 in response */
174 #define TF_FASTRECOVERY 0x00100000      /* in NewReno Fast Recovery */
175 #define TF_WASFRECOVERY 0x00200000      /* was in NewReno Fast Recovery */
176 #define TF_FIRSTACCACK  0x00400000      /* Look for 1st acceptable ACK. */
177 #define TF_FASTREXMT    0x00800000      /* Did Fast Retransmit. */
178 #define TF_EARLYREXMT   0x01000000      /* Did Early (Fast) Retransmit. */
179 #define TF_FORCE        0x02000000      /* Set if forcing out a byte */
180 #define TF_ONOUTPUTQ    0x04000000      /* on t_outputq list */
181 #define TF_DUPSEG       0x08000000      /* last seg a duplicate */
182 #define TF_ENCLOSESEG   0x10000000      /* enclosing SACK block */
183 #define TF_SACKLEFT     0x20000000      /* send SACK blocks from left side */
184 #define TF_KEEPALIVE    0x40000000      /* temporary keepalive */
185 #define TF_RXRESIZED    0x80000000      /* rcvbuf was resized */
186         tcp_seq snd_up;                 /* send urgent pointer */
187         u_long  snd_last;               /* time last data were sent */
188
189         tcp_seq snd_una;                /* send unacknowledged */
190         tcp_seq snd_recover;            /* for use with NewReno Fast Recovery */
191         tcp_seq snd_max;                /* highest sequence number sent;
192                                          * used to recognize retransmits */
193         tcp_seq snd_nxt;                /* send next */
194
195         tcp_seq snd_wl1;                /* window update seg seq number */
196         tcp_seq snd_wl2;                /* window update seg ack number */
197         tcp_seq iss;                    /* initial send sequence number */
198         tcp_seq irs;                    /* initial receive sequence number */
199
200         tcp_seq rcv_nxt;                /* receive next */
201         tcp_seq rcv_adv;                /* advertised window */
202         u_long  rcv_wnd;                /* receive window */
203         tcp_seq rcv_up;                 /* receive urgent pointer */
204
205         u_long  snd_wnd;                /* send window */
206         u_long  snd_cwnd;               /* congestion-controlled window */
207         u_long  snd_wacked;             /* bytes acked in one send window */
208         u_long  snd_ssthresh;           /* snd_cwnd size threshold for
209                                          * for slow start exponential to
210                                          * linear switch */
211
212         int     t_rxtcur;               /* current retransmit value (ticks) */
213         u_int   t_maxseg;               /* maximum segment size */
214         int     t_srtt;                 /* smoothed round-trip time */
215         int     t_rttvar;               /* variance in round-trip time */
216
217         u_int   t_maxopd;               /* mss plus options */
218
219         u_long  t_rcvtime;              /* reception inactivity time */
220         u_long  t_starttime;            /* time connection was established */
221         int     t_rtttime;              /* round trip time */
222         tcp_seq t_rtseq;                /* sequence number being timed */
223
224         int     t_rxtshift;             /* log(2) of rexmt exp. backoff */
225         u_int   t_rttmin;               /* minimum rtt allowed */
226         u_int   t_rttbest;              /* best rtt we've seen */
227         u_long  t_rttupdated;           /* number of times rtt sampled */
228         u_long  max_sndwnd;             /* largest window peer has offered */
229
230         int     t_softerror;            /* possible error not yet reported */
231 /* out-of-band data */
232         char    t_oobflags;             /* have some */
233         char    t_iobc;                 /* input character */
234 #define TCPOOB_HAVEDATA 0x01
235 #define TCPOOB_HADDATA  0x02
236
237 /* RFC 1323 variables */
238         u_char  snd_scale;              /* window scaling for send window */
239         u_char  rcv_scale;              /* window scaling for recv window */
240         u_char  request_r_scale;        /* pending window scaling */
241         u_long  ts_recent;              /* timestamp echo data */
242
243         u_long  ts_recent_age;          /* when last updated */
244         tcp_seq last_ack_sent;
245
246 /* experimental */
247         int     t_srtt_prev;            /* adjusted SRTT prior to retransmit */
248         int     t_rttvar_prev;          /* RTTVAR prior to retransmit */
249         int     t_rxtcur_prev;          /* rexmt timeout prior to retransmit */
250         tcp_seq snd_max_prev;           /* SND_MAX prior to retransmit */
251         u_long  snd_cwnd_prev;          /* cwnd prior to retransmit */
252         u_long  snd_wacked_prev;        /* prior bytes acked in send window */
253         u_long  snd_ssthresh_prev;      /* ssthresh prior to retransmit */
254         tcp_seq snd_recover_prev;       /* snd_recover prior to retransmit */
255         u_long  t_badrxtwin;            /* window for retransmit recovery */
256         u_long  t_rexmtTS;              /* timestamp of last retransmit */
257         u_char  snd_limited;            /* segments limited transmitted */
258
259         tcp_seq rexmt_high;             /* highest seq # retransmitted + 1 */
260         tcp_seq rexmt_rescue;           /* rescue SACKED sequence number */
261         tcp_seq snd_max_rexmt;          /* snd_max when rexmting snd_una */
262         struct scoreboard scb;          /* sack scoreboard */
263         struct raw_sackblock reportblk; /* incoming segment or D-SACK block */
264         struct raw_sackblock encloseblk;
265         int     nsackhistory;
266         struct raw_sackblock sackhistory[MAX_SACK_REPORT_BLOCKS]; /* reported */
267         TAILQ_ENTRY(tcpcb) t_outputq;   /* tcp_output needed list */
268
269         /* bandwith limitation */
270         u_long  snd_bandwidth;          /* calculated bandwidth or 0 */
271         u_long  snd_bwnd;               /* bandwidth-controlled window */
272         int     t_bw_rtttime;           /* used for bandwidth calculation */
273         tcp_seq t_bw_rtseq;             /* used for bandwidth calculation */
274
275 /* anti DoS counters */
276         u_long  rcv_second;             /* start of interval second */
277         u_long  rcv_pps;                /* received packets per second */
278         u_long  rcv_byps;               /* received bytes per second */
279
280         u_int32_t       rfbuf_ts;       /* recv buffer autoscaling timestamp */
281         int     rfbuf_cnt;              /* recv buffer autoscaling byte count */
282
283         int     t_keepinit;             /* time to establish connection */
284
285         int     t_keepidle;             /* time before keepalive probes begin */
286         int     t_keepintvl;            /* time between keepalive probes */
287         int     t_keepcnt;              /* maximum number of keepalive probes */
288         int     t_maxidle;              /* time to drop after starting probes */
289
290         int     t_rxtsyn;               /* time spent in SYN or SYN|ACK rexmt */
291 };
292
293 #define IN_FASTRECOVERY(tp)     (tp->t_flags & TF_FASTRECOVERY)
294 #define ENTER_FASTRECOVERY(tp)  tp->t_flags |= TF_FASTRECOVERY
295 #define EXIT_FASTRECOVERY(tp)   tp->t_flags &= ~TF_FASTRECOVERY
296
297 #ifdef TCP_SIGNATURE
298 /*
299  * Defines which are needed by the xform_tcp module and tcp_[in|out]put
300  * for SADB verification and lookup.
301  */
302 #define TCP_SIGLEN      16      /* length of computed digest in bytes */
303 #define TCP_KEYLEN_MIN  1       /* minimum length of TCP-MD5 key */
304 #define TCP_KEYLEN_MAX  80      /* maximum length of TCP-MD5 key */
305 /*
306  * Only a single SA per host may be specified at this time. An SPI is
307  * needed in order for the KEY_ALLOCSA() lookup to work.
308  */
309 #define TCP_SIG_SPI     0x1000
310 #endif /* TCP_SIGNATURE */
311
312 /*
313  * TCP statistics.
314  */
315 struct tcp_stats {
316         u_long  tcps_connattempt;       /* connections initiated */
317         u_long  tcps_accepts;           /* connections accepted */
318         u_long  tcps_connects;          /* connections established */
319         u_long  tcps_drops;             /* connections dropped */
320         u_long  tcps_conndrops;         /* embryonic connections dropped */
321         u_long  tcps_minmssdrops;       /* average minmss too low drops */
322         u_long  tcps_closed;            /* conn. closed (includes drops) */
323         u_long  tcps_segstimed;         /* segs where we tried to get rtt */
324         u_long  tcps_rttupdated;        /* times we succeeded */
325         u_long  tcps_delack;            /* delayed acks sent */
326         u_long  tcps_timeoutdrop;       /* conn. dropped in rxmt timeout */
327         u_long  tcps_rexmttimeo;        /* retransmit timeouts */
328         u_long  tcps_persisttimeo;      /* persist timeouts */
329         u_long  tcps_keeptimeo;         /* keepalive timeouts */
330         u_long  tcps_keepprobe;         /* keepalive probes sent */
331         u_long  tcps_keepdrops;         /* connections dropped in keepalive */
332
333         u_long  tcps_sndtotal;          /* total packets sent */
334         u_long  tcps_sndpack;           /* data packets sent */
335         u_long  tcps_sndbyte;           /* data bytes sent */
336         u_long  tcps_sndrexmitpack;     /* data packets retransmitted */
337         u_long  tcps_sndrexmitbyte;     /* data bytes retransmitted */
338         u_long  tcps_sndsackrtopack;    /* packets sent by SACK after RTO */
339         u_long  tcps_sndsackrtobyte;    /* bytes sent by SACK after RTO */
340         u_long  tcps_sndfastrexmit;     /* Fast Retransmissions */
341         u_long  tcps_sndearlyrexmit;    /* early Fast Retransmissions */
342         u_long  tcps_sndlimited;        /* Limited Transmit packets */
343         u_long  tcps_sndrtobad;         /* spurious RTO retransmissions */
344         u_long  tcps_sndfastrexmitbad;  /* spurious Fast Retransmissions */
345         u_long  tcps_sndearlyrexmitbad; /* spurious early Fast Retransmissions,
346                                            a subset of tcps_sndfastrexmitbad */
347         u_long  tcps_eifeldetected;     /* Eifel-detected spurious rexmits */
348         u_long  tcps_rttcantdetect;     /* Eifel but not 1/2 RTT-detectable */
349         u_long  tcps_rttdetected;       /* RTT-detected spurious RTO rexmits */
350         u_long  tcps_sndacks;           /* ack-only packets sent */
351         u_long  tcps_sndprobe;          /* window probes sent */
352         u_long  tcps_sndurg;            /* packets sent with URG only */
353         u_long  tcps_sndwinup;          /* window update-only packets sent */
354         u_long  tcps_sndctrl;           /* control (SYN|FIN|RST) packets sent */
355         u_long  tcps_sndsackpack;       /* packets sent by SACK recovery alg */
356         u_long  tcps_sndsackbyte;       /* bytes sent by SACK recovery */
357         u_long  tcps_snduna3;           /* re-retransmit snd_una on 3 new seg */
358         u_long  tcps_snduna1;           /* re-retransmit snd_una on 1 new seg */
359         u_long  tcps_sndsackopt;        /* SACK options sent */
360         u_long  tcps_snddsackopt;       /* D-SACK options sent */
361         u_long  tcps_sndidle;           /* sending idle detected */
362         u_long  tcps_sackrescue;        /* SACK rescue data packets sent */
363         u_long  tcps_sackrescue_try;    /* SACK rescues attempted */
364         u_long  tcps_eifelresponse;     /* Eifel responses */
365
366         u_long  tcps_rcvtotal;          /* total packets received */
367         u_long  tcps_rcvpack;           /* packets received in sequence */
368         u_long  tcps_rcvbyte;           /* bytes received in sequence */
369         u_long  tcps_rcvbadsum;         /* packets received with ccksum errs */
370         u_long  tcps_rcvbadoff;         /* packets received with bad offset */
371         u_long  tcps_rcvmemdrop;        /* packets dropped for lack of memory */
372         u_long  tcps_rcvshort;          /* packets received too short */
373         u_long  tcps_rcvduppack;        /* duplicate-only packets received */
374         u_long  tcps_rcvdupbyte;        /* duplicate-only bytes received */
375         u_long  tcps_rcvpartduppack;    /* packets with some duplicate data */
376         u_long  tcps_rcvpartdupbyte;    /* dup. bytes in part-dup. packets */
377         u_long  tcps_rcvoopack;         /* out-of-order packets received */
378         u_long  tcps_rcvoobyte;         /* out-of-order bytes received */
379         u_long  tcps_rcvpackafterwin;   /* packets with data after window */
380         u_long  tcps_rcvbyteafterwin;   /* bytes rcvd after window */
381         u_long  tcps_rcvafterclose;     /* packets rcvd after "close" */
382         u_long  tcps_rcvwinprobe;       /* rcvd window probe packets */
383         u_long  tcps_rcvdupack;         /* rcvd duplicate acks */
384         u_long  tcps_rcvacktoomuch;     /* rcvd acks for unsent data */
385         u_long  tcps_rcvackpack;        /* rcvd ack packets */
386         u_long  tcps_rcvackbyte;        /* bytes acked by rcvd acks */
387         u_long  tcps_rcvwinupd;         /* rcvd window update packets */
388         u_long  tcps_pawsdrop;          /* segments dropped due to PAWS */
389         u_long  tcps_predack;           /* times hdr predict ok for acks */
390         u_long  tcps_preddat;           /* times hdr predict ok for data pkts */
391         u_long  tcps_pcbcachemiss;
392         u_long  tcps_cachedrtt;         /* times cached RTT in route updated */
393         u_long  tcps_cachedrttvar;      /* times cached rttvar updated */
394         u_long  tcps_cachedssthresh;    /* times cached ssthresh updated */
395         u_long  tcps_usedrtt;           /* times RTT initialized from route */
396         u_long  tcps_usedrttvar;        /* times RTTVAR initialized from rt */
397         u_long  tcps_usedssthresh;      /* times ssthresh initialized from rt*/
398         u_long  tcps_persistdrop;       /* timeout in persist state */
399         u_long  tcps_badsyn;            /* bogus SYN, e.g. premature ACK */
400         u_long  tcps_mturesent;         /* resends due to MTU discovery */
401         u_long  tcps_listendrop;        /* listen queue overflows */
402         u_long  tcps_rcvbadsackopt;     /* rcvd illegal SACK options */
403
404         u_long  tcps_sacksbupdate;      /* times SACK scoreboard updated */
405         u_long  tcps_sacksboverflow;    /* times SACK scoreboard overflowed */
406         u_long  tcps_sacksbreused;      /* times SACK sb-block reused */
407         u_long  tcps_sacksbfailed;      /* times SACK sb update failed */
408         u_long  tcps_sacksbfast;        /* timee SACK sb-block uses cache */
409
410         u_long  tcps_sc_added;          /* entry added to syncache */
411         u_long  tcps_sc_retransmitted;  /* syncache entry was retransmitted */
412         u_long  tcps_sc_dupsyn;         /* duplicate SYN packet */
413         u_long  tcps_sc_dropped;        /* could not reply to packet */
414         u_long  tcps_sc_completed;      /* successful extraction of entry */
415         u_long  tcps_sc_bucketoverflow; /* syncache per-bucket limit hit */
416         u_long  tcps_sc_cacheoverflow;  /* syncache cache limit hit */
417         u_long  tcps_sc_reset;          /* RST removed entry from syncache */
418         u_long  tcps_sc_stale;          /* timed out or listen socket gone */
419         u_long  tcps_sc_aborted;        /* syncache entry aborted */
420         u_long  tcps_sc_badack;         /* removed due to bad ACK */
421         u_long  tcps_sc_unreach;        /* ICMP unreachable received */
422         u_long  tcps_sc_zonefail;       /* zalloc() failed */
423         u_long  tcps_sc_sendcookie;     /* SYN cookie sent */
424         u_long  tcps_sc_recvcookie;     /* SYN cookie received */
425 };
426
427 #ifdef _KERNEL
428
429 #if defined(SMP)
430 #define tcpstat tcpstats_percpu[mycpuid]
431 #else
432 #define tcpstat tcpstats_percpu[0]
433 #endif
434
435 struct sockopt;
436
437 extern struct tcp_stats         tcpstats_percpu[MAXCPU];
438
439 static const int tcprexmtthresh = 3;
440 #endif
441
442 /*
443  * Structure to hold TCP options that are only used during segment
444  * processing (in tcp_input), but not held in the tcpcb.
445  * It's basically used to reduce the number of parameters
446  * to tcp_dooptions.
447  */
448 struct tcpopt {
449         u_long          to_flags;       /* which options are present */
450 #define TOF_TS                  0x0001  /* timestamp */
451 #define TOF_MSS                 0x0010
452 #define TOF_SCALE               0x0020
453 #define TOF_SACK_PERMITTED      0x0040
454 #define TOF_SACK                0x0080
455 #define TOF_SIGNATURE           0x0100  /* signature option present */
456 #define TOF_SIGLEN              0x0200  /* signature length valid (RFC2385) */
457 #define TOF_DSACK               0x0400  /* D-SACK */
458 #define TOF_SACK_REDUNDANT      0x0800  /* all SACK blocks are known */
459         u_int32_t       to_tsval;
460         u_int32_t       to_tsecr;
461         u_int16_t       to_mss;
462         u_int8_t        to_requested_s_scale;
463         u_int8_t        to_nsackblocks;
464         struct raw_sackblock *to_sackblocks;
465 };
466
467 struct syncache {
468         inp_gen_t       sc_inp_gencnt;          /* pointer check */
469         struct          tcpcb *sc_tp;           /* tcb for listening socket */
470         struct          mbuf *sc_ipopts;        /* source route */
471         struct          in_conninfo sc_inc;     /* addresses */
472 #define sc_route        sc_inc.inc_route
473 #define sc_route6       sc_inc.inc6_route
474         u_int32_t       sc_tsrecent;
475         tcp_seq         sc_irs;                 /* seq from peer */
476         tcp_seq         sc_iss;                 /* our ISS */
477         u_long          sc_rxttime;             /* retransmit time */
478         u_int16_t       sc_rxtslot;             /* retransmit counter */
479         u_int16_t       sc_peer_mss;            /* peer's MSS */
480         u_int16_t       sc_wnd;                 /* advertised window */
481         u_int8_t        sc_requested_s_scale:4,
482                         sc_request_r_scale:4;
483         u_int8_t        sc_flags;
484 #define SCF_NOOPT               0x01            /* no TCP options */
485 #define SCF_WINSCALE            0x02            /* negotiated window scaling */
486 #define SCF_TIMESTAMP           0x04            /* negotiated timestamps */
487 #define SCF_UNUSED              0x08            /* unused */
488 #define SCF_UNREACH             0x10            /* icmp unreachable received */
489 #define SCF_SACK_PERMITTED      0x20            /* saw SACK permitted option */
490 #define SCF_SIGNATURE           0x40            /* send MD5 digests */
491 #define SCF_MARKER              0x80            /* not a real entry */
492         int             sc_rxtused;             /* time spent in SYN|ACK rxt */
493         u_long          sc_sndwnd;              /* send window */
494         TAILQ_ENTRY(syncache) sc_hash;
495         TAILQ_ENTRY(syncache) sc_timerq;
496 };
497
498 struct syncache_head {
499         TAILQ_HEAD(, syncache)  sch_bucket;
500         u_int           sch_length;
501 };
502
503 #define intotcpcb(ip)   ((struct tcpcb *)(ip)->inp_ppcb)
504 #define sototcpcb(so)   (intotcpcb(sotoinpcb(so)))
505
506 /*
507  * The smoothed round-trip time and estimated variance
508  * are stored as fixed point numbers scaled by the values below.
509  * For convenience, these scales are also used in smoothing the average
510  * (smoothed = (1/scale)sample + ((scale-1)/scale)smoothed).
511  * With these scales, srtt has 3 bits to the right of the binary point,
512  * and thus an "ALPHA" of 0.875.  rttvar has 2 bits to the right of the
513  * binary point, and is smoothed with an ALPHA of 0.75.
514  */
515 #define TCP_RTT_SCALE           32      /* multiplier for srtt; 3 bits frac. */
516 #define TCP_RTT_SHIFT           5       /* shift for srtt; 3 bits frac. */
517 #define TCP_RTTVAR_SCALE        16      /* multiplier for rttvar; 2 bits */
518 #define TCP_RTTVAR_SHIFT        4       /* shift for rttvar; 2 bits */
519 #define TCP_DELTA_SHIFT         2       /* see tcp_input.c */
520
521 /*
522  * The initial retransmission should happen at rtt + 4 * rttvar.
523  * Because of the way we do the smoothing, srtt and rttvar
524  * will each average +1/2 tick of bias.  When we compute
525  * the retransmit timer, we want 1/2 tick of rounding and
526  * 1 extra tick because of +-1/2 tick uncertainty in the
527  * firing of the timer.  The bias will give us exactly the
528  * 1.5 tick we need.  But, because the bias is
529  * statistical, we have to test that we don't drop below
530  * the minimum feasible timer (which is 2 ticks).
531  * This version of the macro adapted from a paper by Lawrence
532  * Brakmo and Larry Peterson which outlines a problem caused
533  * by insufficient precision in the original implementation,
534  * which results in inappropriately large RTO values for very
535  * fast networks.
536  */
537 #define TCP_REXMTVAL(tp) \
538         max((tp)->t_rttmin, (((tp)->t_srtt >> (TCP_RTT_SHIFT - TCP_DELTA_SHIFT))  \
539           + (tp)->t_rttvar) >> TCP_DELTA_SHIFT)
540
541 /*
542  * TCB structure exported to user-land via sysctl(3).
543  * Evil hack: declare only if in_pcb.h and sys/socketvar.h have been
544  * included.  Not all of our clients do.
545  */
546 #if defined(_NETINET_IN_PCB_H_) && defined(_SYS_SOCKETVAR_H_)
547 struct  xtcpcb {
548         size_t  xt_len;
549         struct  inpcb   xt_inp;
550         struct  tcpcb   xt_tp;
551         struct  xsocket xt_socket;
552         u_quad_t        xt_alignment_hack;
553 };
554 #endif
555
556 /*
557  * Names for TCP sysctl objects
558  */
559 #define TCPCTL_DO_RFC1323       1       /* use RFC-1323 extensions */
560 /* 2 was TCPCTL_DO_RFC1644 */
561 #define TCPCTL_MSSDFLT          3       /* MSS default */
562 #define TCPCTL_STATS            4       /* statistics (read-only) */
563 #define TCPCTL_RTTDFLT          5       /* default RTT estimate */
564 #define TCPCTL_KEEPIDLE         6       /* keepalive idle timer */
565 #define TCPCTL_KEEPINTVL        7       /* interval to send keepalives */
566 #define TCPCTL_SENDSPACE        8       /* send buffer space */
567 #define TCPCTL_RECVSPACE        9       /* receive buffer space */
568 #define TCPCTL_KEEPINIT         10      /* timeout for establishing syn */
569 #define TCPCTL_PCBLIST          11      /* list of all outstanding PCBs */
570 #define TCPCTL_DELACKTIME       12      /* time before sending delayed ACK */
571 #define TCPCTL_V6MSSDFLT        13      /* MSS default for IPv6 */
572 #define TCPCTL_MAXID            14
573
574 #define TCPCTL_NAMES { \
575         { 0, 0 }, \
576         { "rfc1323", CTLTYPE_INT }, \
577           { "reserved", CTLTYPE_INT},   /* was rfc1644 */       \
578         { "mssdflt", CTLTYPE_INT }, \
579         { "stats", CTLTYPE_STRUCT }, \
580         { "rttdflt", CTLTYPE_INT }, \
581         { "keepidle", CTLTYPE_INT }, \
582         { "keepintvl", CTLTYPE_INT }, \
583         { "sendspace", CTLTYPE_INT }, \
584         { "recvspace", CTLTYPE_INT }, \
585         { "keepinit", CTLTYPE_INT }, \
586         { "pcblist", CTLTYPE_STRUCT }, \
587         { "delacktime", CTLTYPE_INT }, \
588         { "v6mssdflt", CTLTYPE_INT }, \
589 }
590
591 #ifdef _KERNEL
592 #ifdef SYSCTL_DECL
593 SYSCTL_DECL(_net_inet_tcp);
594 #endif
595
596 #define TCP_DO_SACK(tp)         ((tp)->t_flags & TF_SACK_PERMITTED)
597 #define TCP_SACK_BLKEND(len, thflags) \
598         ((len) + (((thflags) & TH_FIN) != 0))
599
600 TAILQ_HEAD(tcpcbackqhead,tcpcb);
601
602 extern  struct inpcbinfo tcbinfo[];
603 extern  struct tcpcbackqhead tcpcbackq[];
604
605 extern  int tcp_mssdflt;        /* XXX */
606 extern  int tcp_minmss;
607 extern  int tcp_delack_enabled;
608 extern  int path_mtu_discovery;
609
610 union netmsg;
611
612 int      tcp_addrcpu(in_addr_t faddr, in_port_t fport,
613             in_addr_t laddr, in_port_t lport);
614 struct lwkt_port *
615         tcp_addrport(in_addr_t faddr, in_port_t fport,
616             in_addr_t laddr, in_port_t lport);
617 struct lwkt_port *tcp_addrport0(void);
618 void     tcp_canceltimers (struct tcpcb *);
619 struct tcpcb *
620          tcp_close (struct tcpcb *);
621 void     tcp_ctlinput(union netmsg *);
622 void     tcp_ctloutput(union netmsg *);
623 struct tcpcb *
624          tcp_drop (struct tcpcb *, int);
625 void     tcp_drain (void);
626 void     tcp_fasttimo (void);
627 void     tcp_init (void);
628 void     tcp_thread_init (void);
629 int      tcp_input (struct mbuf **, int *, int);
630 void     tcp_mss (struct tcpcb *, int);
631 int      tcp_mssopt (struct tcpcb *);
632 void     tcp_drop_syn_sent (struct inpcb *, int);
633 void     tcp_mtudisc (struct inpcb *, int);
634 struct tcpcb *
635          tcp_newtcpcb (struct inpcb *);
636 int      tcp_output (struct tcpcb *);
637 void     tcp_quench (struct inpcb *, int);
638 void     tcp_respond (struct tcpcb *, void *,
639             struct tcphdr *, struct mbuf *, tcp_seq, tcp_seq, int);
640 struct rtentry *
641          tcp_rtlookup (struct in_conninfo *);
642 int      tcp_sack_bytes_below(struct scoreboard *scb, tcp_seq seq);
643 void     tcp_sack_destroy(struct scoreboard *scb);
644 void     tcp_sack_cleanup(struct scoreboard *scb);
645 void     tcp_sack_report_cleanup(struct tcpcb *tp);
646 int      tcp_sack_ndsack_blocks(struct raw_sackblock *blocks,
647             const int numblocks, tcp_seq snd_una);
648 void     tcp_sack_fill_report(struct tcpcb *tp, u_char *opt, u_int *plen);
649 boolean_t
650          tcp_sack_has_sacked(struct scoreboard *scb, u_int amount);
651 void     tcp_sack_tcpcb_init(struct tcpcb *tp);
652 uint32_t tcp_sack_compute_pipe(struct tcpcb *tp);
653 boolean_t
654          tcp_sack_nextseg(struct tcpcb *tp, tcp_seq *nextrexmt, uint32_t *len,
655                           boolean_t *rescue);
656 #ifdef later
657 void     tcp_sack_revert_scoreboard(struct scoreboard *scb, tcp_seq snd_una,
658                                     u_int maxseg);
659 void     tcp_sack_save_scoreboard(struct scoreboard *scb);
660 #endif
661 void     tcp_sack_skip_sacked(struct scoreboard *scb, tcp_seq *prexmt);
662 void     tcp_sack_update_scoreboard(struct tcpcb *tp, struct tcpopt *to);
663 void     tcp_save_congestion_state(struct tcpcb *tp);
664 void     tcp_revert_congestion_state(struct tcpcb *tp);
665 void     tcp_setpersist (struct tcpcb *);
666 struct tcptemp *tcp_maketemplate (struct tcpcb *);
667 void     tcp_freetemplate (struct tcptemp *);
668 void     tcp_fillheaders (struct tcpcb *, void *, void *);
669 struct lwkt_port *
670          tcp_soport(struct socket *, struct sockaddr *, struct mbuf **);
671 struct lwkt_port *
672          tcp_ctlport(int, struct sockaddr *, void *);
673 struct tcpcb *
674          tcp_timers (struct tcpcb *, int);
675 void     tcp_trace (short, short, struct tcpcb *, void *, struct tcphdr *,
676                         int);
677 void     tcp_xmit_bandwidth_limit(struct tcpcb *tp, tcp_seq ack_seq);
678 u_long   tcp_initial_window(struct tcpcb *tp);
679 void     tcp_timer_keep_activity(struct tcpcb *tp, int thflags);
680 void     syncache_init(void);
681 void     syncache_unreach(struct in_conninfo *, struct tcphdr *);
682 int      syncache_expand(struct in_conninfo *, struct tcphdr *,
683              struct socket **, struct mbuf *);
684 int      syncache_add(struct in_conninfo *, struct tcpopt *,
685              struct tcphdr *, struct socket *, struct mbuf *);
686 void     syncache_chkrst(struct in_conninfo *, struct tcphdr *);
687 void     syncache_badack(struct in_conninfo *);
688 void     syncache_destroy(struct tcpcb *tp);
689
690 #ifdef TCP_SIGNATURE
691 int tcpsignature_apply(void *fstate, void *data, unsigned int len);
692 int tcpsignature_compute(struct mbuf *m, int len, int tcpoptlen,
693                 u_char *buf, u_int direction);
694 #endif /* TCP_SIGNATURE */
695
696 extern  struct pr_usrreqs tcp_usrreqs;
697 extern  u_long tcp_sendspace;
698 extern  u_long tcp_recvspace;
699 tcp_seq tcp_new_isn (struct tcpcb *);
700
701 #endif /* _KERNEL */
702
703 #endif /* _NETINET_TCP_VAR_H_ */