xnu-792.6.76.tar.gz
[apple/xnu.git] / bsd / netinet / tcp_var.h
index afd802f6196521cd4590dca396878dfcfa9f27e8..08b897f6c6c6ea9a2c64a212c0a5e19637000f1e 100644 (file)
@@ -3,22 +3,19 @@
  *
  * @APPLE_LICENSE_HEADER_START@
  * 
- * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
+ * The contents of this file constitute Original Code as defined in and
+ * are subject to the Apple Public Source License Version 1.1 (the
+ * "License").  You may not use this file except in compliance with the
+ * License.  Please obtain a copy of the License at
+ * http://www.apple.com/publicsource and read it before using this file.
  * 
- * This file contains Original Code and/or Modifications of Original Code
- * as defined in and that are subject to the Apple Public Source License
- * Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
- * 
- * The Original Code and all software distributed under the License are
- * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * This Original Code and all software distributed under the License are
+ * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
- * Please see the License for the specific language governing rights and
- * limitations under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
+ * License for the specific language governing rights and limitations
+ * under the License.
  * 
  * @APPLE_LICENSE_HEADER_END@
  */
 #ifndef _NETINET_TCP_VAR_H_
 #define _NETINET_TCP_VAR_H_
 #include <sys/appleapiopts.h>
+#include <sys/queue.h>
+#include <netinet/in_pcb.h>
 #include <netinet/tcp_timer.h>
-#ifdef __APPLE_API_PRIVATE
+
+#ifdef KERNEL_PRIVATE
 
 #define N_TIME_WAIT_SLOTS   128                /* must be power of 2 */
 
@@ -78,6 +78,8 @@ struct tseg_qent {
        struct  mbuf    *tqe_m;         /* mbuf contains packet */
 };
 LIST_HEAD(tsegqe_head, tseg_qent);
+extern int     tcp_reass_maxseg;
+extern int     tcp_reass_qsize;
 #ifdef MALLOC_DECLARE
 MALLOC_DECLARE(M_TSEGQ);
 #endif
@@ -89,19 +91,10 @@ struct tcptemp {
 
 #define tcp6cb         tcpcb  /* for KAME src sync over BSD*'s */
 
-#ifdef __APPLE__
-#define TCP_DELACK_BITSET(hash_elem)\
-delack_bitmask[((hash_elem) >> 5)] |= 1 << ((hash_elem) & 0x1F)
-
-#define DELACK_BITMASK_ON     1
-#define DELACK_BITMASK_THRESH 300
-#endif
-
 /*
  * Tcp control block, one per tcp; fields:
  * Organized for 16 byte cacheline efficiency.
  */
-#if KERNEL
 struct tcpcb {
        struct  tsegqe_head t_segq;
        int     t_dupacks;              /* consecutive dup acks recd */
@@ -193,26 +186,109 @@ struct tcpcb {
 /* RFC 1644 variables */
        tcp_cc  cc_send;                /* send connection count */
        tcp_cc  cc_recv;                /* receive connection count */
-       tcp_seq snd_recover;            /* for use in fast recovery */
+       tcp_seq snd_recover;    /* for use in NewReno Fast Recovery */
 /* experimental */
        u_long  snd_cwnd_prev;          /* cwnd prior to retransmit */
        u_long  snd_ssthresh_prev;      /* ssthresh prior to retransmit */
        u_long  t_badrxtwin;            /* window for retransmit recovery */
 
        int     t_keepidle;             /* keepalive idle timer (override global if > 0) */
+       int     t_lastchain;            /* amount of packets chained last time around */
+
+/* 3529618 MSS overload prevention */
+       u_long  rcv_reset;
+       u_long  rcv_pps;
+       u_long  rcv_byps;
+       tcp_seq snd_high;               /* for use in NewReno Fast Recovery */
+       tcp_seq snd_high_prev;  /* snd_high prior to retransmit */
+
 };
-#else
 
-#define tcpcb otcpcb
+/*
+ * Structure to hold TCP options that are only used during segment
+ * processing (in tcp_input), but not held in the tcpcb.
+ * It's basically used to reduce the number of parameters
+ * to tcp_dooptions.
+ */
+struct tcpopt {
+       u_long  to_flag;                /* which options are present */
+#define TOF_TS         0x0001          /* timestamp */
+#define TOF_CC         0x0002          /* CC and CCnew are exclusive */
+#define TOF_CCNEW      0x0004
+#define        TOF_CCECHO      0x0008
+       u_long  to_tsval;
+       u_long  to_tsecr;
+       tcp_cc  to_cc;          /* holds CC or CCnew */
+       tcp_cc  to_ccecho;
+       u_short         reserved;               /* unused now: was to_maxseg */
+};
 
-#endif
+/*
+ * The TAO cache entry which is stored in the protocol family specific
+ * portion of the route metrics.
+ */
+struct rmxp_tao {
+       tcp_cc  tao_cc;                 /* latest CC in valid SYN */
+       tcp_cc  tao_ccsent;             /* latest CC sent to peer */
+       u_short tao_mssopt;             /* peer's cached MSS */
+#ifdef notyet
+       u_short tao_flags;              /* cache status flags */
+#define        TAOF_DONT       0x0001          /* peer doesn't understand rfc1644 */
+#define        TAOF_OK         0x0002          /* peer does understand rfc1644 */
+#define        TAOF_UNDEF      0               /* we don't know yet */
+#endif /* notyet */
+};
+#define rmx_taop(r)    ((struct rmxp_tao *)(r).rmx_filler)
+
+#define        intotcpcb(ip)   ((struct tcpcb *)(ip)->inp_ppcb)
+#define        sototcpcb(so)   (intotcpcb(sotoinpcb(so)))
 
+/*
+ * The smoothed round-trip time and estimated variance
+ * are stored as fixed point numbers scaled by the values below.
+ * For convenience, these scales are also used in smoothing the average
+ * (smoothed = (1/scale)sample + ((scale-1)/scale)smoothed).
+ * With these scales, srtt has 3 bits to the right of the binary point,
+ * and thus an "ALPHA" of 0.875.  rttvar has 2 bits to the right of the
+ * binary point, and is smoothed with an ALPHA of 0.75.
+ */
+#define        TCP_RTT_SCALE           32      /* multiplier for srtt; 3 bits frac. */
+#define        TCP_RTT_SHIFT           5       /* shift for srtt; 3 bits frac. */
+#define        TCP_RTTVAR_SCALE        16      /* multiplier for rttvar; 2 bits */
+#define        TCP_RTTVAR_SHIFT        4       /* shift for rttvar; 2 bits */
+#define        TCP_DELTA_SHIFT         2       /* see tcp_input.c */
+
+/*
+ * The initial retransmission should happen at rtt + 4 * rttvar.
+ * Because of the way we do the smoothing, srtt and rttvar
+ * will each average +1/2 tick of bias.  When we compute
+ * the retransmit timer, we want 1/2 tick of rounding and
+ * 1 extra tick because of +-1/2 tick uncertainty in the
+ * firing of the timer.  The bias will give us exactly the
+ * 1.5 tick we need.  But, because the bias is
+ * statistical, we have to test that we don't drop below
+ * the minimum feasible timer (which is 2 ticks).
+ * This version of the macro adapted from a paper by Lawrence
+ * Brakmo and Larry Peterson which outlines a problem caused
+ * by insufficient precision in the original implementation,
+ * which results in inappropriately large RTO values for very
+ * fast networks.
+ */
+#define        TCP_REXMTVAL(tp) \
+       max((tp)->t_rttmin, (((tp)->t_srtt >> (TCP_RTT_SHIFT - TCP_DELTA_SHIFT))  \
+         + (tp)->t_rttvar) >> TCP_DELTA_SHIFT)
 
 /*
  * Jaguar compatible TCP control block, for xtcpcb
  * Does not have the old fields
  */
 struct otcpcb {
+#else
+struct tseg_qent;
+LIST_HEAD(tsegqe_head, tseg_qent);
+
+struct tcpcb {
+#endif /* KERNEL_PRIVATE */
        struct  tsegqe_head t_segq;
        int     t_dupacks;              /* consecutive dup acks recd */
        struct  tcptemp *unused;        /* unused now: was t_template */
@@ -303,90 +379,13 @@ struct otcpcb {
 /* RFC 1644 variables */
        tcp_cc  cc_send;                /* send connection count */
        tcp_cc  cc_recv;                /* receive connection count */
-       tcp_seq snd_recover;            /* for use in fast recovery */
+       tcp_seq snd_recover;    /* for use in fast recovery */
 /* experimental */
        u_long  snd_cwnd_prev;          /* cwnd prior to retransmit */
        u_long  snd_ssthresh_prev;      /* ssthresh prior to retransmit */
        u_long  t_badrxtwin;            /* window for retransmit recovery */
 };
 
-
-/*
- * Structure to hold TCP options that are only used during segment
- * processing (in tcp_input), but not held in the tcpcb.
- * It's basically used to reduce the number of parameters
- * to tcp_dooptions.
- */
-struct tcpopt {
-       u_long  to_flag;                /* which options are present */
-#define TOF_TS         0x0001          /* timestamp */
-#define TOF_CC         0x0002          /* CC and CCnew are exclusive */
-#define TOF_CCNEW      0x0004
-#define        TOF_CCECHO      0x0008
-       u_long  to_tsval;
-       u_long  to_tsecr;
-       tcp_cc  to_cc;          /* holds CC or CCnew */
-       tcp_cc  to_ccecho;
-       u_short         reserved;               /* unused now: was to_maxseg */
-};
-
-/*
- * The TAO cache entry which is stored in the protocol family specific
- * portion of the route metrics.
- */
-struct rmxp_tao {
-       tcp_cc  tao_cc;                 /* latest CC in valid SYN */
-       tcp_cc  tao_ccsent;             /* latest CC sent to peer */
-       u_short tao_mssopt;             /* peer's cached MSS */
-#ifdef notyet
-       u_short tao_flags;              /* cache status flags */
-#define        TAOF_DONT       0x0001          /* peer doesn't understand rfc1644 */
-#define        TAOF_OK         0x0002          /* peer does understand rfc1644 */
-#define        TAOF_UNDEF      0               /* we don't know yet */
-#endif /* notyet */
-};
-#define rmx_taop(r)    ((struct rmxp_tao *)(r).rmx_filler)
-
-#define        intotcpcb(ip)   ((struct tcpcb *)(ip)->inp_ppcb)
-#define        sototcpcb(so)   (intotcpcb(sotoinpcb(so)))
-
-/*
- * The smoothed round-trip time and estimated variance
- * are stored as fixed point numbers scaled by the values below.
- * For convenience, these scales are also used in smoothing the average
- * (smoothed = (1/scale)sample + ((scale-1)/scale)smoothed).
- * With these scales, srtt has 3 bits to the right of the binary point,
- * and thus an "ALPHA" of 0.875.  rttvar has 2 bits to the right of the
- * binary point, and is smoothed with an ALPHA of 0.75.
- */
-#define        TCP_RTT_SCALE           32      /* multiplier for srtt; 3 bits frac. */
-#define        TCP_RTT_SHIFT           5       /* shift for srtt; 3 bits frac. */
-#define        TCP_RTTVAR_SCALE        16      /* multiplier for rttvar; 2 bits */
-#define        TCP_RTTVAR_SHIFT        4       /* shift for rttvar; 2 bits */
-#define        TCP_DELTA_SHIFT         2       /* see tcp_input.c */
-
-/*
- * The initial retransmission should happen at rtt + 4 * rttvar.
- * Because of the way we do the smoothing, srtt and rttvar
- * will each average +1/2 tick of bias.  When we compute
- * the retransmit timer, we want 1/2 tick of rounding and
- * 1 extra tick because of +-1/2 tick uncertainty in the
- * firing of the timer.  The bias will give us exactly the
- * 1.5 tick we need.  But, because the bias is
- * statistical, we have to test that we don't drop below
- * the minimum feasible timer (which is 2 ticks).
- * This version of the macro adapted from a paper by Lawrence
- * Brakmo and Larry Peterson which outlines a problem caused
- * by insufficient precision in the original implementation,
- * which results in inappropriately large RTO values for very
- * fast networks.
- */
-#define        TCP_REXMTVAL(tp) \
-       max((tp)->t_rttmin, (((tp)->t_srtt >> (TCP_RTT_SHIFT - TCP_DELTA_SHIFT))  \
-         + (tp)->t_rttvar) >> TCP_DELTA_SHIFT)
-#endif /* __APPLE_API_PRIVATE */
-
-#ifdef __APPLE_API_UNSTABLE
 /*
  * TCP statistics.
  * Many of these should be kept per connection,
@@ -457,18 +456,20 @@ struct    tcpstat {
        u_long  tcps_mturesent;         /* resends due to MTU discovery */
        u_long  tcps_listendrop;        /* listen queue overflows */
 };
-#endif /* __APPLE_API_UNSTABLE */
 
 /*
  * TCB structure exported to user-land via sysctl(3).
  * Evil hack: declare only if in_pcb.h and sys/socketvar.h have been
  * included.  Not all of our clients do.
  */
-#if defined(_NETINET_IN_PCB_H_) && defined(_SYS_SOCKETVAR_H_)
 struct xtcpcb {
        size_t  xt_len;
+#ifdef KERNEL_PRIVATE
+       struct  inpcb_compat    xt_inp;
+#else
        struct  inpcb   xt_inp;
-#if KERNEL
+#endif
+#ifdef KERNEL_PRIVATE
        struct  otcpcb  xt_tp;
 #else
        struct  tcpcb   xt_tp;
@@ -476,7 +477,6 @@ struct      xtcpcb {
        struct  xsocket xt_socket;
        u_quad_t        xt_alignment_hack;
 };
-#endif
 
 /*
  * Names for TCP sysctl objects
@@ -496,6 +496,7 @@ struct      xtcpcb {
 #define        TCPCTL_V6MSSDFLT        13      /* MSS default for IPv6 */
 #define        TCPCTL_MAXID            14
 
+#ifdef KERNEL_PRIVATE
 #define TCPCTL_NAMES { \
        { 0, 0 }, \
        { "rfc1323", CTLTYPE_INT }, \
@@ -513,67 +514,72 @@ struct    xtcpcb {
        { "v6mssdflt", CTLTYPE_INT }, \
 }
 
-#ifdef __APPLE_API_PRIVATE
-#ifdef KERNEL
 #ifdef SYSCTL_DECL
 SYSCTL_DECL(_net_inet_tcp);
-#endif
+#endif /* SYSCTL_DECL */
 
 extern struct inpcbhead tcb;           /* head of queue of active tcpcb's */
 extern struct inpcbinfo tcbinfo;
 extern struct tcpstat tcpstat; /* tcp statistics */
 extern int tcp_mssdflt;        /* XXX */
-extern int tcp_delack_enabled;
+extern int tcp_minmss;
+extern int tcp_minmssoverload;
 extern int tcp_do_newreno;
 extern int ss_fltsz;
 extern int ss_fltsz_local;
 #ifdef __APPLE__
 extern u_long tcp_now;         /* for RFC 1323 timestamps */ 
 extern int tcp_delack_enabled;
-#endif
+#endif /* __APPLE__ */
 
 
-void    tcp_canceltimers __P((struct tcpcb *));
+void    tcp_canceltimers(struct tcpcb *);
 struct tcpcb *
-        tcp_close __P((struct tcpcb *));
-void    tcp_ctlinput __P((int, struct sockaddr *, void *));
-int     tcp_ctloutput __P((struct socket *, struct sockopt *));
+        tcp_close(struct tcpcb *);
+void    tcp_ctlinput(int, struct sockaddr *, void *);
+int     tcp_ctloutput(struct socket *, struct sockopt *);
 struct tcpcb *
-        tcp_drop __P((struct tcpcb *, int));
-void    tcp_drain __P((void));
-void    tcp_fasttimo __P((void));
+        tcp_drop(struct tcpcb *, int);
+void    tcp_drain(void);
+void    tcp_fasttimo(void);
 struct rmxp_tao *
-        tcp_gettaocache __P((struct inpcb *));
-void    tcp_init __P((void));
-void    tcp_input __P((struct mbuf *, int));
-void    tcp_mss __P((struct tcpcb *, int));
-int     tcp_mssopt __P((struct tcpcb *));
-void    tcp_drop_syn_sent __P((struct inpcb *, int));
-void    tcp_mtudisc __P((struct inpcb *, int));
+        tcp_gettaocache(struct inpcb *);
+void    tcp_init(void);
+void    tcp_input(struct mbuf *, int);
+void    tcp_mss(struct tcpcb *, int);
+int     tcp_mssopt(struct tcpcb *);
+void    tcp_drop_syn_sent(struct inpcb *, int);
+void    tcp_mtudisc(struct inpcb *, int);
 struct tcpcb *
-        tcp_newtcpcb __P((struct inpcb *));
-int     tcp_output __P((struct tcpcb *));
-void    tcp_quench __P((struct inpcb *, int));
-void    tcp_respond __P((struct tcpcb *, void *,
-           struct tcphdr *, struct mbuf *, tcp_seq, tcp_seq, int));
+        tcp_newtcpcb(struct inpcb *);
+int     tcp_output(struct tcpcb *);
+void    tcp_quench(struct inpcb *, int);
+void    tcp_respond(struct tcpcb *, void *,
+           struct tcphdr *, struct mbuf *, tcp_seq, tcp_seq, int);
 struct rtentry *
-        tcp_rtlookup __P((struct inpcb *));
-void    tcp_setpersist __P((struct tcpcb *));
-void    tcp_slowtimo __P((void));
+        tcp_rtlookup(struct inpcb *);
+void    tcp_setpersist(struct tcpcb *);
+void    tcp_slowtimo(void);
 struct tcptemp *
-        tcp_maketemplate __P((struct tcpcb *));
-void    tcp_fillheaders __P((struct tcpcb *, void *, void *));
+        tcp_maketemplate(struct tcpcb *);
+void    tcp_fillheaders(struct tcpcb *, void *, void *);
 struct tcpcb *
-        tcp_timers __P((struct tcpcb *, int));
-void    tcp_trace __P((int, int, struct tcpcb *, void *, struct tcphdr *,
-                       int));
+        tcp_timers(struct tcpcb *, int);
+void    tcp_trace(int, int, struct tcpcb *, void *, struct tcphdr *, int);
+int     tcp_lock (struct socket *, int, int);
+int     tcp_unlock (struct socket *, int, int);
+#ifdef _KERN_LOCKS_H_
+lck_mtx_t *     tcp_getlock (struct socket *, int);
+#else
+void *  tcp_getlock (struct socket *, int);
+#endif
+
 
 extern struct pr_usrreqs tcp_usrreqs;
 extern u_long tcp_sendspace;
 extern u_long tcp_recvspace;
-tcp_seq tcp_new_isn __P((struct tcpcb *));
+tcp_seq tcp_new_isn(struct tcpcb *);
 
-#endif /* KERNEL */
-#endif /* __APPLE_API_PRIVATE */
+#endif /* KERNEL_RPIVATE */
 
 #endif /* _NETINET_TCP_VAR_H_ */