bsd/netinet/tcp_fsm.h

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