tcp_var.h revision 1.137 1 /* $NetBSD: tcp_var.h,v 1.137 2006/09/05 00:29:36 rpaulo Exp $ */
2
3 /*
4 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the project nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32 /*
33 * @(#)COPYRIGHT 1.1 (NRL) 17 January 1995
34 *
35 * NRL grants permission for redistribution and use in source and binary
36 * forms, with or without modification, of the software and documentation
37 * created at NRL provided that the following conditions are met:
38 *
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
44 * 3. All advertising materials mentioning features or use of this software
45 * must display the following acknowledgements:
46 * This product includes software developed by the University of
47 * California, Berkeley and its contributors.
48 * This product includes software developed at the Information
49 * Technology Division, US Naval Research Laboratory.
50 * 4. Neither the name of the NRL 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 * THE SOFTWARE PROVIDED BY NRL IS PROVIDED BY NRL AND CONTRIBUTORS ``AS
55 * IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
56 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
57 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NRL OR
58 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
59 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
60 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
61 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
62 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
63 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
64 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
65 *
66 * The views and conclusions contained in the software and documentation
67 * are those of the authors and should not be interpreted as representing
68 * official policies, either expressed or implied, of the US Naval
69 * Research Laboratory (NRL).
70 */
71
72 /*-
73 * Copyright (c) 1997, 1998, 1999, 2001, 2005 The NetBSD Foundation, Inc.
74 * All rights reserved.
75 *
76 * This code is derived from software contributed to The NetBSD Foundation
77 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
78 * NASA Ames Research Center.
79 * This code is derived from software contributed to The NetBSD Foundation
80 * by Charles M. Hannum.
81 *
82 * Redistribution and use in source and binary forms, with or without
83 * modification, are permitted provided that the following conditions
84 * are met:
85 * 1. Redistributions of source code must retain the above copyright
86 * notice, this list of conditions and the following disclaimer.
87 * 2. Redistributions in binary form must reproduce the above copyright
88 * notice, this list of conditions and the following disclaimer in the
89 * documentation and/or other materials provided with the distribution.
90 * 3. All advertising materials mentioning features or use of this software
91 * must display the following acknowledgement:
92 * This product includes software developed by the NetBSD
93 * Foundation, Inc. and its contributors.
94 * 4. Neither the name of The NetBSD Foundation nor the names of its
95 * contributors may be used to endorse or promote products derived
96 * from this software without specific prior written permission.
97 *
98 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
99 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
100 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
101 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
102 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
103 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
104 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
105 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
106 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
107 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
108 * POSSIBILITY OF SUCH DAMAGE.
109 */
110
111 /*
112 * Copyright (c) 1982, 1986, 1993, 1994, 1995
113 * The Regents of the University of California. All rights reserved.
114 *
115 * Redistribution and use in source and binary forms, with or without
116 * modification, are permitted provided that the following conditions
117 * are met:
118 * 1. Redistributions of source code must retain the above copyright
119 * notice, this list of conditions and the following disclaimer.
120 * 2. Redistributions in binary form must reproduce the above copyright
121 * notice, this list of conditions and the following disclaimer in the
122 * documentation and/or other materials provided with the distribution.
123 * 3. Neither the name of the University nor the names of its contributors
124 * may be used to endorse or promote products derived from this software
125 * without specific prior written permission.
126 *
127 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
128 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
129 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
130 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
131 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
132 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
133 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
134 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
135 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
136 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
137 * SUCH DAMAGE.
138 *
139 * @(#)tcp_var.h 8.4 (Berkeley) 5/24/95
140 */
141
142 #ifndef _NETINET_TCP_VAR_H_
143 #define _NETINET_TCP_VAR_H_
144
145 #if defined(_KERNEL_OPT)
146 #include "opt_inet.h"
147 #include "opt_mbuftrace.h"
148 #endif
149
150 /*
151 * Kernel variables for tcp.
152 */
153
154 #include <sys/callout.h>
155
156 #ifdef TCP_SIGNATURE
157 /*
158 * Defines which are needed by the xform_tcp module and tcp_[in|out]put
159 * for SADB verification and lookup.
160 */
161 #define TCP_SIGLEN 16 /* length of computed digest in bytes */
162 #define TCP_KEYLEN_MIN 1 /* minimum length of TCP-MD5 key */
163 #define TCP_KEYLEN_MAX 80 /* maximum length of TCP-MD5 key */
164 /*
165 * Only a single SA per host may be specified at this time. An SPI is
166 * needed in order for the KEY_ALLOCSA() lookup to work.
167 */
168 #define TCP_SIG_SPI 0x1000
169 #endif /* TCP_SIGNATURE */
170
171 /*
172 * SACK option block.
173 */
174 struct sackblk {
175 tcp_seq left; /* Left edge of sack block. */
176 tcp_seq right; /* Right edge of sack block. */
177 };
178
179 TAILQ_HEAD(sackhead, sackhole);
180 struct sackhole {
181 tcp_seq start;
182 tcp_seq end;
183 tcp_seq rxmit;
184
185 TAILQ_ENTRY(sackhole) sackhole_q;
186 };
187
188 /*
189 * Tcp control block, one per tcp; fields:
190 */
191 struct tcpcb {
192 int t_family; /* address family on the wire */
193 struct ipqehead segq; /* sequencing queue */
194 int t_segqlen; /* length of the above */
195 struct callout t_timer[TCPT_NTIMERS];/* tcp timers */
196 short t_state; /* state of this connection */
197 short t_rxtshift; /* log(2) of rexmt exp. backoff */
198 uint32_t t_rxtcur; /* current retransmit value */
199 short t_dupacks; /* consecutive dup acks recd */
200 short t_partialacks; /* partials acks during fast rexmit */
201 u_short t_peermss; /* peer's maximum segment size */
202 u_short t_ourmss; /* our's maximum segment size */
203 u_short t_segsz; /* current segment size in use */
204 char t_force; /* 1 if forcing out a byte */
205 u_int t_flags;
206 #define TF_ACKNOW 0x0001 /* ack peer immediately */
207 #define TF_DELACK 0x0002 /* ack, but try to delay it */
208 #define TF_NODELAY 0x0004 /* don't delay packets to coalesce */
209 #define TF_NOOPT 0x0008 /* don't use tcp options */
210 #define TF_REQ_SCALE 0x0020 /* have/will request window scaling */
211 #define TF_RCVD_SCALE 0x0040 /* other side has requested scaling */
212 #define TF_REQ_TSTMP 0x0080 /* have/will request timestamps */
213 #define TF_RCVD_TSTMP 0x0100 /* a timestamp was received in SYN */
214 #define TF_SACK_PERMIT 0x0200 /* other side said I could SACK */
215 #define TF_SYN_REXMT 0x0400 /* rexmit timer fired on SYN */
216 #define TF_WILL_SACK 0x0800 /* try to use SACK */
217 #define TF_REASSEMBLING 0x1000 /* we're busy reassembling */
218 #define TF_DEAD 0x2000 /* dead and to-be-released */
219 #define TF_PMTUD_PEND 0x4000 /* Path MTU Discovery pending */
220 #define TF_ECN_PERMIT 0x10000 /* other side said is ECN-ready */
221 #define TF_ECN_SND_CWR 0x20000 /* ECN CWR in queue */
222 #define TF_ECN_SND_ECE 0x40000 /* ECN ECE in queue */
223 #define TF_SIGNATURE 0x400000 /* require MD5 digests (RFC2385) */
224
225
226 struct mbuf *t_template; /* skeletal packet for transmit */
227 struct inpcb *t_inpcb; /* back pointer to internet pcb */
228 struct in6pcb *t_in6pcb; /* back pointer to internet pcb */
229 struct callout t_delack_ch; /* delayed ACK callout */
230 /*
231 * The following fields are used as in the protocol specification.
232 * See RFC793, Dec. 1981, page 21.
233 */
234 /* send sequence variables */
235 tcp_seq snd_una; /* send unacknowledged */
236 tcp_seq snd_nxt; /* send next */
237 tcp_seq snd_up; /* send urgent pointer */
238 tcp_seq snd_wl1; /* window update seg seq number */
239 tcp_seq snd_wl2; /* window update seg ack number */
240 tcp_seq iss; /* initial send sequence number */
241 u_long snd_wnd; /* send window */
242 tcp_seq snd_recover; /* for use in fast recovery */
243 tcp_seq snd_high; /* NewReno false fast rexmit seq */
244 /* receive sequence variables */
245 u_long rcv_wnd; /* receive window */
246 tcp_seq rcv_nxt; /* receive next */
247 tcp_seq rcv_up; /* receive urgent pointer */
248 tcp_seq irs; /* initial receive sequence number */
249 /*
250 * Additional variables for this implementation.
251 */
252 /* receive variables */
253 tcp_seq rcv_adv; /* advertised window */
254 /* retransmit variables */
255 tcp_seq snd_max; /* highest sequence number sent;
256 * used to recognize retransmits
257 */
258 /* congestion control (for slow start, source quench, retransmit after loss) */
259 u_long snd_cwnd; /* congestion-controlled window */
260 u_long snd_ssthresh; /* snd_cwnd size threshhold for
261 * for slow start exponential to
262 * linear switch
263 */
264 /*
265 * transmit timing stuff. See below for scale of srtt and rttvar.
266 * "Variance" is actually smoothed difference.
267 */
268 uint32_t t_rcvtime; /* time last segment received */
269 uint32_t t_rtttime; /* time we started measuring rtt */
270 tcp_seq t_rtseq; /* sequence number being timed */
271 int32_t t_srtt; /* smoothed round-trip time */
272 int32_t t_rttvar; /* variance in round-trip time */
273 uint32_t t_rttmin; /* minimum rtt allowed */
274 u_long max_sndwnd; /* largest window peer has offered */
275
276 /* out-of-band data */
277 char t_oobflags; /* have some */
278 char t_iobc; /* input character */
279 #define TCPOOB_HAVEDATA 0x01
280 #define TCPOOB_HADDATA 0x02
281 short t_softerror; /* possible error not yet reported */
282
283 /* RFC 1323 variables */
284 u_char snd_scale; /* window scaling for send window */
285 u_char rcv_scale; /* window scaling for recv window */
286 u_char request_r_scale; /* pending window scaling */
287 u_char requested_s_scale;
288 u_int32_t ts_recent; /* timestamp echo data */
289 u_int32_t ts_recent_age; /* when last updated */
290 u_int32_t ts_timebase; /* our timebase */
291 tcp_seq last_ack_sent;
292
293 /* SACK stuff */
294 #define TCP_SACK_MAX 3
295 #define TCPSACK_NONE 0
296 #define TCPSACK_HAVED 1
297 u_char rcv_sack_flags; /* SACK flags. */
298 struct sackblk rcv_dsack_block; /* RX D-SACK block. */
299 struct ipqehead timeq; /* time sequenced queue. */
300 struct sackhead snd_holes; /* TX SACK holes. */
301 int snd_numholes; /* Number of TX SACK holes. */
302 tcp_seq rcv_lastsack; /* last seq number(+1) sack'd by rcv'r*/
303 tcp_seq sack_newdata; /* New data xmitted in this recovery
304 episode starts at this seq number*/
305 tcp_seq snd_fack; /* FACK TCP. Forward-most data held by
306 peer. */
307
308 /* pointer for syn cache entries*/
309 LIST_HEAD(, syn_cache) t_sc; /* list of entries by this tcb */
310
311 /* prediction of next mbuf when using large window sizes */
312 struct mbuf *t_lastm; /* last mbuf that data was sent from */
313 int t_inoff; /* data offset in previous mbuf */
314 int t_lastoff; /* last data address in mbuf chain */
315 int t_lastlen; /* last length read from mbuf chain */
316
317 /* Path-MTU discovery blackhole detection */
318 int t_mtudisc; /* perform mtudisc for this tcb */
319 /* Path-MTU Discovery Information */
320 u_int t_pmtud_mss_acked; /* MSS acked, lower bound for MTU */
321 u_int t_pmtud_mtu_sent; /* MTU used, upper bound for MTU */
322 tcp_seq t_pmtud_th_seq; /* TCP SEQ from ICMP payload */
323 u_int t_pmtud_nextmtu; /* Advertised Next-Hop MTU from ICMP */
324 u_short t_pmtud_ip_len; /* IP length from ICMP payload */
325 u_short t_pmtud_ip_hl; /* IP header length from ICMP payload */
326
327 uint8_t t_ecn_retries; /* # of ECN setup retries */
328 };
329
330 /*
331 * Macros to aid ECN TCP.
332 */
333 #define TCP_ECN_ALLOWED(tp) (tp->t_flags & TF_ECN_PERMIT)
334
335 /*
336 * Macros to aid SACK/FACK TCP.
337 */
338 #define TCP_SACK_ENABLED(tp) (tp->t_flags & TF_WILL_SACK)
339 #define TCP_FACK_FASTRECOV(tp) \
340 (TCP_SACK_ENABLED(tp) && \
341 (SEQ_GT(tp->snd_fack, tp->snd_una + tcprexmtthresh * tp->t_segsz)))
342
343 #ifdef _KERNEL
344 /*
345 * TCP reassembly queue locks.
346 */
347 static __inline int tcp_reass_lock_try (struct tcpcb *)
348 __attribute__((__unused__));
349 static __inline void tcp_reass_unlock (struct tcpcb *)
350 __attribute__((__unused__));
351
352 static __inline int
353 tcp_reass_lock_try(tp)
354 struct tcpcb *tp;
355 {
356 int s;
357
358 /*
359 * Use splvm() -- we're blocking things that would cause
360 * mbuf allocation.
361 */
362 s = splvm();
363 if (tp->t_flags & TF_REASSEMBLING) {
364 splx(s);
365 return (0);
366 }
367 tp->t_flags |= TF_REASSEMBLING;
368 splx(s);
369 return (1);
370 }
371
372 static __inline void
373 tcp_reass_unlock(tp)
374 struct tcpcb *tp;
375 {
376 int s;
377
378 s = splvm();
379 tp->t_flags &= ~TF_REASSEMBLING;
380 splx(s);
381 }
382
383 #ifdef DIAGNOSTIC
384 #define TCP_REASS_LOCK(tp) \
385 do { \
386 if (tcp_reass_lock_try(tp) == 0) { \
387 printf("%s:%d: tcpcb %p reass already locked\n", \
388 __FILE__, __LINE__, tp); \
389 panic("tcp_reass_lock"); \
390 } \
391 } while (/*CONSTCOND*/ 0)
392 #define TCP_REASS_LOCK_CHECK(tp) \
393 do { \
394 if (((tp)->t_flags & TF_REASSEMBLING) == 0) { \
395 printf("%s:%d: tcpcb %p reass lock not held\n", \
396 __FILE__, __LINE__, tp); \
397 panic("tcp reass lock check"); \
398 } \
399 } while (/*CONSTCOND*/ 0)
400 #else
401 #define TCP_REASS_LOCK(tp) (void) tcp_reass_lock_try((tp))
402 #define TCP_REASS_LOCK_CHECK(tp) /* nothing */
403 #endif
404
405 #define TCP_REASS_UNLOCK(tp) tcp_reass_unlock((tp))
406 #endif /* _KERNEL */
407
408 /*
409 * Queue for delayed ACK processing.
410 */
411 #ifdef _KERNEL
412 extern int tcp_delack_ticks;
413 void tcp_delack(void *);
414
415 #define TCP_RESTART_DELACK(tp) \
416 callout_reset(&(tp)->t_delack_ch, tcp_delack_ticks, \
417 tcp_delack, tp)
418
419 #define TCP_SET_DELACK(tp) \
420 do { \
421 if (((tp)->t_flags & TF_DELACK) == 0) { \
422 (tp)->t_flags |= TF_DELACK; \
423 TCP_RESTART_DELACK(tp); \
424 } \
425 } while (/*CONSTCOND*/0)
426
427 #define TCP_CLEAR_DELACK(tp) \
428 do { \
429 if ((tp)->t_flags & TF_DELACK) { \
430 (tp)->t_flags &= ~TF_DELACK; \
431 callout_stop(&(tp)->t_delack_ch); \
432 } \
433 } while (/*CONSTCOND*/0)
434 #endif /* _KERNEL */
435
436 /*
437 * Compute the current timestamp for a connection.
438 */
439 #define TCP_TIMESTAMP(tp) (tcp_now - (tp)->ts_timebase)
440
441 /*
442 * Handy way of passing around TCP option info.
443 */
444 struct tcp_opt_info {
445 int ts_present;
446 u_int32_t ts_val;
447 u_int32_t ts_ecr;
448 u_int16_t maxseg;
449 };
450
451 #define TOF_SIGNATURE 0x0040 /* signature option present */
452 #define TOF_SIGLEN 0x0080 /* sigature length valid (RFC2385) */
453
454 /*
455 * Data for the TCP compressed state engine.
456 */
457 union syn_cache_sa {
458 struct sockaddr sa;
459 struct sockaddr_in sin;
460 #if 1 /*def INET6*/
461 struct sockaddr_in6 sin6;
462 #endif
463 };
464
465 struct syn_cache {
466 TAILQ_ENTRY(syn_cache) sc_bucketq; /* link on bucket list */
467 struct callout sc_timer; /* rexmt timer */
468 union { /* cached route */
469 struct route route4;
470 #ifdef INET6
471 struct route_in6 route6;
472 #endif
473 } sc_route_u;
474 #define sc_route4 sc_route_u.route4
475 #ifdef INET6
476 #define sc_route6 sc_route_u.route6
477 #endif
478 long sc_win; /* advertised window */
479 int sc_bucketidx; /* our bucket index */
480 u_int32_t sc_hash;
481 u_int32_t sc_timestamp; /* timestamp from SYN */
482 u_int32_t sc_timebase; /* our local timebase */
483 union syn_cache_sa sc_src;
484 union syn_cache_sa sc_dst;
485 tcp_seq sc_irs;
486 tcp_seq sc_iss;
487 u_int sc_rxtcur; /* current rxt timeout */
488 u_int sc_rxttot; /* total time spend on queues */
489 u_short sc_rxtshift; /* for computing backoff */
490 u_short sc_flags;
491
492 #define SCF_UNREACH 0x0001 /* we've had an unreach error */
493 #define SCF_TIMESTAMP 0x0002 /* peer will do timestamps */
494 #define SCF_DEAD 0x0004 /* this entry to be released */
495 #define SCF_SACK_PERMIT 0x0008 /* peer will do SACK */
496 #define SCF_ECN_PERMIT 0x0010 /* peer will do ECN */
497 #define SCF_SIGNATURE 0x40 /* send MD5 digests */
498
499 struct mbuf *sc_ipopts; /* IP options */
500 u_int16_t sc_peermaxseg;
501 u_int16_t sc_ourmaxseg;
502 u_int8_t sc_request_r_scale : 4,
503 sc_requested_s_scale : 4;
504
505 struct tcpcb *sc_tp; /* tcb for listening socket */
506 LIST_ENTRY(syn_cache) sc_tpq; /* list of entries by same tp */
507 };
508
509 struct syn_cache_head {
510 TAILQ_HEAD(, syn_cache) sch_bucket; /* bucket entries */
511 u_short sch_length; /* # entries in bucket */
512 };
513
514 #define intotcpcb(ip) ((struct tcpcb *)(ip)->inp_ppcb)
515 #ifdef INET6
516 #define in6totcpcb(ip) ((struct tcpcb *)(ip)->in6p_ppcb)
517 #endif
518 #ifndef INET6
519 #define sototcpcb(so) (intotcpcb(sotoinpcb(so)))
520 #else
521 #define sototcpcb(so) (((so)->so_proto->pr_domain->dom_family == AF_INET) \
522 ? intotcpcb(sotoinpcb(so)) \
523 : in6totcpcb(sotoin6pcb(so)))
524 #endif
525
526 /*
527 * The smoothed round-trip time and estimated variance
528 * are stored as fixed point numbers scaled by the values below.
529 * For convenience, these scales are also used in smoothing the average
530 * (smoothed = (1/scale)sample + ((scale-1)/scale)smoothed).
531 * With these scales, srtt has 3 bits to the right of the binary point,
532 * and thus an "ALPHA" of 0.875. rttvar has 2 bits to the right of the
533 * binary point, and is smoothed with an ALPHA of 0.75.
534 */
535 #define TCP_RTT_SHIFT 3 /* shift for srtt; 3 bits frac. */
536 #define TCP_RTTVAR_SHIFT 2 /* multiplier for rttvar; 2 bits */
537
538 /*
539 * The initial retransmission should happen at rtt + 4 * rttvar.
540 * Because of the way we do the smoothing, srtt and rttvar
541 * will each average +1/2 tick of bias. When we compute
542 * the retransmit timer, we want 1/2 tick of rounding and
543 * 1 extra tick because of +-1/2 tick uncertainty in the
544 * firing of the timer. The bias will give us exactly the
545 * 1.5 tick we need. But, because the bias is
546 * statistical, we have to test that we don't drop below
547 * the minimum feasible timer (which is 2 ticks).
548 * This macro assumes that the value of 1<<TCP_RTTVAR_SHIFT
549 * is the same as the multiplier for rttvar.
550 */
551 #define TCP_REXMTVAL(tp) \
552 ((((tp)->t_srtt >> TCP_RTT_SHIFT) + (tp)->t_rttvar) >> 2)
553
554 /*
555 * Compute the initial window for slow start.
556 */
557 #define TCP_INITIAL_WINDOW(iw, segsz) \
558 (((iw) == 0) ? (min(4 * (segsz), max(2 * (segsz), 4380))) : \
559 ((segsz) * (iw)))
560
561 /*
562 * TCP statistics.
563 * Many of these should be kept per connection,
564 * but that's inconvenient at the moment.
565 */
566 struct tcpstat {
567 u_quad_t tcps_connattempt; /* connections initiated */
568 u_quad_t tcps_accepts; /* connections accepted */
569 u_quad_t tcps_connects; /* connections established */
570 u_quad_t tcps_drops; /* connections dropped */
571 u_quad_t tcps_conndrops; /* embryonic connections dropped */
572 u_quad_t tcps_closed; /* conn. closed (includes drops) */
573 u_quad_t tcps_segstimed; /* segs where we tried to get rtt */
574 u_quad_t tcps_rttupdated; /* times we succeeded */
575 u_quad_t tcps_delack; /* delayed acks sent */
576 u_quad_t tcps_timeoutdrop; /* conn. dropped in rxmt timeout */
577 u_quad_t tcps_rexmttimeo; /* retransmit timeouts */
578 u_quad_t tcps_persisttimeo; /* persist timeouts */
579 u_quad_t tcps_keeptimeo; /* keepalive timeouts */
580 u_quad_t tcps_keepprobe; /* keepalive probes sent */
581 u_quad_t tcps_keepdrops; /* connections dropped in keepalive */
582 u_quad_t tcps_persistdrops; /* connections dropped in persist */
583 u_quad_t tcps_connsdrained; /* connections drained due to memory
584 shortage */
585 u_quad_t tcps_pmtublackhole; /* PMTUD blackhole detected */
586
587 u_quad_t tcps_sndtotal; /* total packets sent */
588 u_quad_t tcps_sndpack; /* data packets sent */
589 u_quad_t tcps_sndbyte; /* data bytes sent */
590 u_quad_t tcps_sndrexmitpack; /* data packets retransmitted */
591 u_quad_t tcps_sndrexmitbyte; /* data bytes retransmitted */
592 u_quad_t tcps_sndacks; /* ack-only packets sent */
593 u_quad_t tcps_sndprobe; /* window probes sent */
594 u_quad_t tcps_sndurg; /* packets sent with URG only */
595 u_quad_t tcps_sndwinup; /* window update-only packets sent */
596 u_quad_t tcps_sndctrl; /* control (SYN|FIN|RST) packets sent */
597
598 u_quad_t tcps_rcvtotal; /* total packets received */
599 u_quad_t tcps_rcvpack; /* packets received in sequence */
600 u_quad_t tcps_rcvbyte; /* bytes received in sequence */
601 u_quad_t tcps_rcvbadsum; /* packets received with ccksum errs */
602 u_quad_t tcps_rcvbadoff; /* packets received with bad offset */
603 u_quad_t tcps_rcvmemdrop; /* packets dropped for lack of memory */
604 u_quad_t tcps_rcvshort; /* packets received too short */
605 u_quad_t tcps_rcvduppack; /* duplicate-only packets received */
606 u_quad_t tcps_rcvdupbyte; /* duplicate-only bytes received */
607 u_quad_t tcps_rcvpartduppack; /* packets with some duplicate data */
608 u_quad_t tcps_rcvpartdupbyte; /* dup. bytes in part-dup. packets */
609 u_quad_t tcps_rcvoopack; /* out-of-order packets received */
610 u_quad_t tcps_rcvoobyte; /* out-of-order bytes received */
611 u_quad_t tcps_rcvpackafterwin; /* packets with data after window */
612 u_quad_t tcps_rcvbyteafterwin; /* bytes rcvd after window */
613 u_quad_t tcps_rcvafterclose; /* packets rcvd after "close" */
614 u_quad_t tcps_rcvwinprobe; /* rcvd window probe packets */
615 u_quad_t tcps_rcvdupack; /* rcvd duplicate acks */
616 u_quad_t tcps_rcvacktoomuch; /* rcvd acks for unsent data */
617 u_quad_t tcps_rcvackpack; /* rcvd ack packets */
618 u_quad_t tcps_rcvackbyte; /* bytes acked by rcvd acks */
619 u_quad_t tcps_rcvwinupd; /* rcvd window update packets */
620 u_quad_t tcps_pawsdrop; /* segments dropped due to PAWS */
621 u_quad_t tcps_predack; /* times hdr predict ok for acks */
622 u_quad_t tcps_preddat; /* times hdr predict ok for data pkts */
623
624 u_quad_t tcps_pcbhashmiss; /* input packets missing pcb hash */
625 u_quad_t tcps_noport; /* no socket on port */
626 u_quad_t tcps_badsyn; /* received ack for which we have
627 no SYN in compressed state */
628 u_quad_t tcps_delayed_free; /* delayed pool_put() of tcpcb */
629
630 /* These statistics deal with the SYN cache. */
631 u_quad_t tcps_sc_added; /* # of entries added */
632 u_quad_t tcps_sc_completed; /* # of connections completed */
633 u_quad_t tcps_sc_timed_out; /* # of entries timed out */
634 u_quad_t tcps_sc_overflowed; /* # dropped due to overflow */
635 u_quad_t tcps_sc_reset; /* # dropped due to RST */
636 u_quad_t tcps_sc_unreach; /* # dropped due to ICMP unreach */
637 u_quad_t tcps_sc_bucketoverflow;/* # dropped due to bucket overflow */
638 u_quad_t tcps_sc_aborted; /* # of entries aborted (no mem) */
639 u_quad_t tcps_sc_dupesyn; /* # of duplicate SYNs received */
640 u_quad_t tcps_sc_dropped; /* # of SYNs dropped (no route/mem) */
641 u_quad_t tcps_sc_collisions; /* # of hash collisions */
642 u_quad_t tcps_sc_retransmitted; /* # of retransmissions */
643 u_quad_t tcps_sc_delayed_free; /* # of delayed pool_put()s */
644
645 u_quad_t tcps_selfquench; /* # of ENOBUFS we get on output */
646 u_quad_t tcps_badsig; /* # of drops due to bad signature */
647 u_quad_t tcps_goodsig; /* # of packets with good signature */
648
649 u_quad_t tcps_ecn_shs; /* # of sucessful ECN handshakes */
650 u_quad_t tcps_ecn_ce; /* # of packets with CE bit */
651 u_quad_t tcps_ecn_ect; /* # of packets with ECT(0) bit */
652 };
653
654 /*
655 * Names for TCP sysctl objects.
656 */
657 #define TCPCTL_RFC1323 1 /* RFC1323 timestamps/scaling */
658 #define TCPCTL_SENDSPACE 2 /* default send buffer */
659 #define TCPCTL_RECVSPACE 3 /* default recv buffer */
660 #define TCPCTL_MSSDFLT 4 /* default seg size */
661 #define TCPCTL_SYN_CACHE_LIMIT 5 /* max size of comp. state engine */
662 #define TCPCTL_SYN_BUCKET_LIMIT 6 /* max size of hash bucket */
663 #if 0 /*obsoleted*/
664 #define TCPCTL_SYN_CACHE_INTER 7 /* interval of comp. state timer */
665 #endif
666 #define TCPCTL_INIT_WIN 8 /* initial window */
667 #define TCPCTL_MSS_IFMTU 9 /* mss from interface, not in_maxmtu */
668 #define TCPCTL_SACK 10 /* RFC2018 selective acknowledgement */
669 #define TCPCTL_WSCALE 11 /* RFC1323 window scaling */
670 #define TCPCTL_TSTAMP 12 /* RFC1323 timestamps */
671 #define TCPCTL_COMPAT_42 13 /* 4.2BSD TCP bug work-arounds */
672 #define TCPCTL_CWM 14 /* Congestion Window Monitoring */
673 #define TCPCTL_CWM_BURSTSIZE 15 /* burst size allowed by CWM */
674 #define TCPCTL_ACK_ON_PUSH 16 /* ACK immediately on PUSH */
675 #define TCPCTL_KEEPIDLE 17 /* keepalive idle time */
676 #define TCPCTL_KEEPINTVL 18 /* keepalive probe interval */
677 #define TCPCTL_KEEPCNT 19 /* keepalive count */
678 #define TCPCTL_SLOWHZ 20 /* PR_SLOWHZ (read-only) */
679 #define TCPCTL_NEWRENO 21 /* NewReno Congestion Control */
680 #define TCPCTL_LOG_REFUSED 22 /* Log refused connections */
681 #if 0 /*obsoleted*/
682 #define TCPCTL_RSTRATELIMIT 23 /* RST rate limit */
683 #endif
684 #define TCPCTL_RSTPPSLIMIT 24 /* RST pps limit */
685 #define TCPCTL_DELACK_TICKS 25 /* # ticks to delay ACK */
686 #define TCPCTL_INIT_WIN_LOCAL 26 /* initial window for local nets */
687 #define TCPCTL_IDENT 27 /* rfc 931 identd */
688 #define TCPCTL_ACKDROPRATELIMIT 28 /* SYN/RST -> ACK rate limit */
689 #define TCPCTL_LOOPBACKCKSUM 29 /* do TCP checksum on loopback */
690 #define TCPCTL_STATS 30 /* TCP statistics */
691 #define TCPCTL_DEBUG 31 /* TCP debug sockets */
692 #define TCPCTL_DEBX 32 /* # of tcp debug sockets */
693 #define TCPCTL_MAXID 33
694
695 #define TCPCTL_NAMES { \
696 { 0, 0 }, \
697 { "rfc1323", CTLTYPE_INT }, \
698 { "sendspace", CTLTYPE_INT }, \
699 { "recvspace", CTLTYPE_INT }, \
700 { "mssdflt", CTLTYPE_INT }, \
701 { "syn_cache_limit", CTLTYPE_INT }, \
702 { "syn_bucket_limit", CTLTYPE_INT }, \
703 { 0, 0 },\
704 { "init_win", CTLTYPE_INT }, \
705 { "mss_ifmtu", CTLTYPE_INT }, \
706 { "sack", CTLTYPE_INT }, \
707 { "win_scale", CTLTYPE_INT }, \
708 { "timestamps", CTLTYPE_INT }, \
709 { "compat_42", CTLTYPE_INT }, \
710 { "cwm", CTLTYPE_INT }, \
711 { "cwm_burstsize", CTLTYPE_INT }, \
712 { "ack_on_push", CTLTYPE_INT }, \
713 { "keepidle", CTLTYPE_INT }, \
714 { "keepintvl", CTLTYPE_INT }, \
715 { "keepcnt", CTLTYPE_INT }, \
716 { "slowhz", CTLTYPE_INT }, \
717 { "newreno", CTLTYPE_INT }, \
718 { "log_refused",CTLTYPE_INT }, \
719 { 0, 0 }, \
720 { "rstppslimit", CTLTYPE_INT }, \
721 { "delack_ticks", CTLTYPE_INT }, \
722 { "init_win_local", CTLTYPE_INT }, \
723 { "ident", CTLTYPE_STRUCT }, \
724 { "ackdropppslimit", CTLTYPE_INT }, \
725 { "do_loopback_cksum", CTLTYPE_INT }, \
726 { "stats", CTLTYPE_STRUCT }, \
727 { "debug", CTLTYPE_STRUCT }, \
728 { "debx", CTLTYPE_INT }, \
729 }
730
731 #ifdef _KERNEL
732 extern struct inpcbtable tcbtable; /* head of queue of active tcpcb's */
733 extern struct tcpstat tcpstat; /* tcp statistics */
734 extern u_int32_t tcp_now; /* for RFC 1323 timestamps */
735 extern int tcp_do_rfc1323; /* enabled/disabled? */
736 extern int tcp_do_sack; /* SACK enabled/disabled? */
737 extern int tcp_do_win_scale; /* RFC1323 window scaling enabled/disabled? */
738 extern int tcp_do_timestamps; /* RFC1323 timestamps enabled/disabled? */
739 extern int tcp_do_newreno; /* Use the New Reno algorithms */
740 extern int tcp_mssdflt; /* default seg size */
741 extern int tcp_init_win; /* initial window */
742 extern int tcp_init_win_local; /* initial window for local nets */
743 extern int tcp_mss_ifmtu; /* take MSS from interface, not in_maxmtu */
744 extern int tcp_compat_42; /* work around ancient broken TCP peers */
745 extern int tcp_cwm; /* enable Congestion Window Monitoring */
746 extern int tcp_cwm_burstsize; /* burst size allowed by CWM */
747 extern int tcp_ack_on_push; /* ACK immediately on PUSH */
748 extern int tcp_syn_cache_limit; /* max entries for compressed state engine */
749 extern int tcp_syn_bucket_limit;/* max entries per hash bucket */
750 extern int tcp_log_refused; /* log refused connections */
751 extern int tcp_do_ecn; /* TCP ECN enabled/disabled? */
752 extern int tcp_ecn_maxretries; /* Max ECN setup retries */
753 extern int tcp_sack_tp_maxholes; /* Max holes per connection. */
754 extern int tcp_sack_globalmaxholes; /* Max holes per system. */
755 extern int tcp_sack_globalholes; /* Number of holes present. */
756
757 extern int tcp_rst_ppslim;
758 extern int tcp_ackdrop_ppslim;
759
760 extern int tcp_syn_cache_size;
761 extern struct syn_cache_head tcp_syn_cache[];
762 extern u_long syn_cache_count;
763
764 #ifdef MBUFTRACE
765 extern struct mowner tcp_rx_mowner;
766 extern struct mowner tcp_tx_mowner;
767 extern struct mowner tcp_mowner;
768 #endif
769
770 #define TCPCTL_VARIABLES { \
771 { 0 }, \
772 { 1, 0, &tcp_do_rfc1323 }, \
773 { 1, 0, &tcp_sendspace }, \
774 { 1, 0, &tcp_recvspace }, \
775 { 1, 0, &tcp_mssdflt }, \
776 { 1, 0, &tcp_syn_cache_limit }, \
777 { 1, 0, &tcp_syn_bucket_limit }, \
778 { 0 }, \
779 { 1, 0, &tcp_init_win }, \
780 { 1, 0, &tcp_mss_ifmtu }, \
781 { 1, 0, &tcp_do_sack }, \
782 { 1, 0, &tcp_do_win_scale }, \
783 { 1, 0, &tcp_do_timestamps }, \
784 { 1, 0, &tcp_compat_42 }, \
785 { 1, 0, &tcp_cwm }, \
786 { 1, 0, &tcp_cwm_burstsize }, \
787 { 1, 0, &tcp_ack_on_push }, \
788 { 1, 0, &tcp_keepidle }, \
789 { 1, 0, &tcp_keepintvl }, \
790 { 1, 0, &tcp_keepcnt }, \
791 { 1, 1, 0, PR_SLOWHZ }, \
792 { 1, 0, &tcp_do_newreno }, \
793 { 1, 0, &tcp_log_refused }, \
794 { 0 }, \
795 { 1, 0, &tcp_rst_ppslim }, \
796 { 1, 0, &tcp_delack_ticks }, \
797 { 1, 0, &tcp_init_win_local }, \
798 { 1, 0, &tcp_ackdrop_ppslim }, \
799 }
800
801 #ifdef __NO_STRICT_ALIGNMENT
802 #define TCP_HDR_ALIGNED_P(th) 1
803 #else
804 #define TCP_HDR_ALIGNED_P(th) ((((vaddr_t)(th)) & 3) == 0)
805 #endif
806
807 struct secasvar;
808
809 int tcp_attach(struct socket *);
810 void tcp_canceltimers(struct tcpcb *);
811 int tcp_timers_invoking(struct tcpcb*);
812 struct tcpcb *
813 tcp_close(struct tcpcb *);
814 int tcp_isdead(struct tcpcb *);
815 #ifdef INET6
816 void tcp6_ctlinput(int, struct sockaddr *, void *);
817 #endif
818 void *tcp_ctlinput(int, struct sockaddr *, void *);
819 int tcp_ctloutput(int, struct socket *, int, int, struct mbuf **);
820 struct tcpcb *
821 tcp_disconnect(struct tcpcb *);
822 struct tcpcb *
823 tcp_drop(struct tcpcb *, int);
824 #ifdef TCP_SIGNATURE
825 int tcp_signature_apply(void *, caddr_t, u_int);
826 struct secasvar *tcp_signature_getsav(struct mbuf *, struct tcphdr *);
827 int tcp_signature(struct mbuf *, struct tcphdr *, int, struct secasvar *,
828 char *);
829 #endif
830 int tcp_dooptions(struct tcpcb *, u_char *, int, struct tcphdr *,
831 struct mbuf *, int, struct tcp_opt_info *);
832 void tcp_drain(void);
833 void tcp_established(struct tcpcb *);
834 void tcp_init(void);
835 #ifdef INET6
836 int tcp6_input(struct mbuf **, int *, int);
837 #endif
838 void tcp_input(struct mbuf *, ...);
839 u_int tcp_hdrsz(struct tcpcb *);
840 u_long tcp_mss_to_advertise(const struct ifnet *, int);
841 void tcp_mss_from_peer(struct tcpcb *, int);
842 void tcp_tcpcb_template(void);
843 struct tcpcb *
844 tcp_newtcpcb(int, void *);
845 void tcp_notify(struct inpcb *, int);
846 #ifdef INET6
847 void tcp6_notify(struct in6pcb *, int);
848 #endif
849 u_int tcp_optlen(struct tcpcb *);
850 int tcp_output(struct tcpcb *);
851 void tcp_pulloutofband(struct socket *,
852 struct tcphdr *, struct mbuf *, int);
853 void tcp_quench(struct inpcb *, int);
854 #ifdef INET6
855 void tcp6_quench(struct in6pcb *, int);
856 #endif
857 void tcp_mtudisc(struct inpcb *, int);
858
859 struct ipqent *tcpipqent_alloc(void);
860 void tcpipqent_free(struct ipqent *);
861
862 int tcp_reass(struct tcpcb *, struct tcphdr *, struct mbuf *, int *);
863 int tcp_respond(struct tcpcb *, struct mbuf *, struct mbuf *,
864 struct tcphdr *, tcp_seq, tcp_seq, int);
865 void tcp_rmx_rtt(struct tcpcb *);
866 void tcp_setpersist(struct tcpcb *);
867 #ifdef TCP_SIGNATURE
868 int tcp_signature_compute(struct mbuf *, struct tcphdr *, int, int,
869 int, u_char *, u_int);
870 #endif
871 void tcp_slowtimo(void);
872 struct mbuf *
873 tcp_template(struct tcpcb *);
874 void tcp_trace(short, short, struct tcpcb *, struct mbuf *, int);
875 struct tcpcb *
876 tcp_usrclosed(struct tcpcb *);
877 int tcp_usrreq(struct socket *,
878 int, struct mbuf *, struct mbuf *, struct mbuf *, struct lwp *);
879 void tcp_xmit_timer(struct tcpcb *, uint32_t);
880 tcp_seq tcp_new_iss(struct tcpcb *, tcp_seq);
881 tcp_seq tcp_new_iss1(void *, void *, u_int16_t, u_int16_t, size_t,
882 tcp_seq);
883
884 void tcp_new_dsack(struct tcpcb *, tcp_seq, u_int32_t);
885 void tcp_sack_option(struct tcpcb *, struct tcphdr *, u_char *, int);
886 void tcp_del_sackholes(struct tcpcb *, struct tcphdr *);
887 void tcp_free_sackholes(struct tcpcb *);
888 void tcp_sack_adjust(struct tcpcb *tp);
889 struct sackhole *tcp_sack_output(struct tcpcb *tp, int *sack_bytes_rexmt);
890 void tcp_sack_newack(struct tcpcb *, struct tcphdr *);
891 int tcp_sack_numblks(const struct tcpcb *);
892 #define TCP_SACK_OPTLEN(nblks) ((nblks) * 8 + 2 + 2)
893
894 int syn_cache_add(struct sockaddr *, struct sockaddr *,
895 struct tcphdr *, unsigned int, struct socket *,
896 struct mbuf *, u_char *, int, struct tcp_opt_info *);
897 void syn_cache_unreach(const struct sockaddr *, const struct sockaddr *,
898 struct tcphdr *);
899 struct socket *syn_cache_get(struct sockaddr *, struct sockaddr *,
900 struct tcphdr *, unsigned int, unsigned int,
901 struct socket *so, struct mbuf *);
902 void syn_cache_init(void);
903 void syn_cache_insert(struct syn_cache *, struct tcpcb *);
904 struct syn_cache *syn_cache_lookup(const struct sockaddr *, const struct sockaddr *,
905 struct syn_cache_head **);
906 void syn_cache_reset(struct sockaddr *, struct sockaddr *,
907 struct tcphdr *);
908 int syn_cache_respond(struct syn_cache *, struct mbuf *);
909 void syn_cache_timer(void *);
910 void syn_cache_cleanup(struct tcpcb *);
911
912 void tcp_reno_newack(struct tcpcb *, struct tcphdr *);
913 void tcp_newreno_newack(struct tcpcb *, struct tcphdr *);
914
915 int tcp_input_checksum(int, struct mbuf *, const struct tcphdr *, int, int,
916 int);
917 #endif
918
919 #endif /* !_NETINET_TCP_VAR_H_ */
920