bsd/netinet/tcp_fsm.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * Copyright (c) 1982, 1986, 1993
  30  *      The Regents of the University of California.  All rights reserved.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice, this list of conditions and the following disclaimer.
  37  * 2. Redistributions in binary form must reproduce the above copyright
  38  *    notice, this list of conditions and the following disclaimer in the
  39  *    documentation and/or other materials provided with the distribution.
  40  * 3. All advertising materials mentioning features or use of this software
  41  *    must display the following acknowledgement:
  42  *      This product includes software developed by the University of
  43  *      California, Berkeley and its contributors.
  44  * 4. Neither the name of the University nor the names of its contributors
  45  *    may be used to endorse or promote products derived from this software
  46  *    without specific prior written permission.
  47  *
  48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  58  * SUCH DAMAGE.
  59  *
  60  *      @(#)tcp_fsm.h   8.1 (Berkeley) 6/10/93
  61  * $FreeBSD: src/sys/netinet/tcp_fsm.h,v 1.14 1999/11/07 04:18:30 jlemon Exp $
  62  */
  63
  64 #ifndef _NETINET_TCP_FSM_H_
  65 #define _NETINET_TCP_FSM_H_
  66 #include <sys/appleapiopts.h>
  67
  68 /*
  69  * TCP FSM state definitions.
  70  * Per RFC793, September, 1981.
  71  */
  72
  73 #define TCP_NSTATES     11
  74
  75 #define TCPS_CLOSED             0       /* closed */
  76 #define TCPS_LISTEN             1       /* listening for connection */
  77 #define TCPS_SYN_SENT           2       /* active, have sent syn */
  78 #define TCPS_SYN_RECEIVED       3       /* have send and received syn */
  79 /* states < TCPS_ESTABLISHED are those where connections not established */
  80 #define TCPS_ESTABLISHED        4       /* established */
  81 #define TCPS_CLOSE_WAIT         5       /* rcvd fin, waiting for close */
  82 /* states > TCPS_CLOSE_WAIT are those where user has closed */
  83 #define TCPS_FIN_WAIT_1         6       /* have closed, sent fin */
  84 #define TCPS_CLOSING            7       /* closed xchd FIN; await FIN ACK */
  85 #define TCPS_LAST_ACK           8       /* had fin and close; await FIN ACK */
  86 /* states > TCPS_CLOSE_WAIT && < TCPS_FIN_WAIT_2 await ACK of FIN */
  87 #define TCPS_FIN_WAIT_2         9       /* have closed, fin is acked */
  88 #define TCPS_TIME_WAIT          10      /* in 2*msl quiet wait after close */
  89
  90 /* for KAME src sync over BSD*'s */
  91 #define TCP6_NSTATES            TCP_NSTATES
  92 #define TCP6S_CLOSED            TCPS_CLOSED
  93 #define TCP6S_LISTEN            TCPS_LISTEN
  94 #define TCP6S_SYN_SENT          TCPS_SYN_SENT
  95 #define TCP6S_SYN_RECEIVED      TCPS_SYN_RECEIVED
  96 #define TCP6S_ESTABLISHED       TCPS_ESTABLISHED
  97 #define TCP6S_CLOSE_WAIT        TCPS_CLOSE_WAIT
  98 #define TCP6S_FIN_WAIT_1        TCPS_FIN_WAIT_1
  99 #define TCP6S_CLOSING           TCPS_CLOSING
 100 #define TCP6S_LAST_ACK          TCPS_LAST_ACK
 101 #define TCP6S_FIN_WAIT_2        TCPS_FIN_WAIT_2
 102 #define TCP6S_TIME_WAIT         TCPS_TIME_WAIT
 103
 104 #define TCPS_HAVERCVDSYN(s)     ((s) >= TCPS_SYN_RECEIVED)
 105 #define TCPS_HAVEESTABLISHED(s) ((s) >= TCPS_ESTABLISHED)
 106 #define TCPS_HAVERCVDFIN(s)     ((s) >= TCPS_TIME_WAIT)
 107
 108 #ifdef KERNEL_PRIVATE
 109 #ifdef  TCPOUTFLAGS
 110 /*
 111  * Flags used when sending segments in tcp_output.
 112  * Basic flags (TH_RST,TH_ACK,TH_SYN,TH_FIN) are totally
 113  * determined by state, with the proviso that TH_FIN is sent only
 114  * if all data queued for output is included in the segment.
 115  */
 116 static u_char   tcp_outflags[TCP_NSTATES] = {
 117         TH_RST|TH_ACK,          /* 0, CLOSED */
 118         0,                      /* 1, LISTEN */
 119         TH_SYN,                 /* 2, SYN_SENT */
 120         TH_SYN|TH_ACK,          /* 3, SYN_RECEIVED */
 121         TH_ACK,                 /* 4, ESTABLISHED */
 122         TH_ACK,                 /* 5, CLOSE_WAIT */
 123         TH_FIN|TH_ACK,          /* 6, FIN_WAIT_1 */
 124         TH_FIN|TH_ACK,          /* 7, CLOSING */
 125         TH_FIN|TH_ACK,          /* 8, LAST_ACK */
 126         TH_ACK,                 /* 9, FIN_WAIT_2 */
 127         TH_ACK,                 /* 10, TIME_WAIT */
 128 };
 129 #endif
 130 #endif KERNEL_PRIVATE
 131
 132 #if KPROF
 133 #ifdef KERNEL_PRIVATE
 134 int     tcp_acounts[TCP_NSTATES][PRU_NREQ];
 135 #endif KERNEL_PRIVATE
 136 #endif
 137
 138 #ifdef  TCPSTATES
 139 char *tcpstates[] = {
 140         "CLOSED",       "LISTEN",       "SYN_SENT",     "SYN_RCVD",
 141         "ESTABLISHED",  "CLOSE_WAIT",   "FIN_WAIT_1",   "CLOSING",
 142         "LAST_ACK",     "FIN_WAIT_2",   "TIME_WAIT"
 143 };
 144 #endif
 145
 146 #endif