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