drivers/network/tcpip/include/tcp.h

   1 /*
   2  * COPYRIGHT:   See COPYING in the top level directory
   3  * PROJECT:     ReactOS TCP/IP protocol driver
   4  * FILE:        include/tcp.h
   5  * PURPOSE:     Transmission Control Protocol definitions
   6  */
   7 #ifndef __TCP_H
   8 #define __TCP_H
   9
  10 typedef VOID
  11 (*PTCP_COMPLETION_ROUTINE)( PVOID Context, NTSTATUS Status, ULONG Count );
  12
  13 /* TCPv4 header structure */
  14 #include <pshpack1.h>
  15 typedef struct TCPv4_HEADER {
  16   USHORT SourcePort;        /* Source port */
  17   USHORT DestinationPort;   /* Destination port */
  18   ULONG  SequenceNumber;    /* Sequence number */
  19   ULONG  AckNumber;         /* Acknowledgement number */
  20   UCHAR  DataOffset;        /* Data offset; 32-bit words (leftmost 4 bits) */
  21   UCHAR  Flags;             /* Control bits (rightmost 6 bits) */
  22   USHORT Window;            /* Maximum acceptable receive window */
  23   USHORT Checksum;          /* Checksum of segment */
  24   USHORT Urgent;            /* Pointer to urgent data */
  25 } TCPv4_HEADER, *PTCPv4_HEADER;
  26
  27 /* TCPv4 header flags */
  28 #define TCP_URG   0x20
  29 #define TCP_ACK   0x10
  30 #define TCP_PSH   0x08
  31 #define TCP_RST   0x04
  32 #define TCP_SYN   0x02
  33 #define TCP_FIN   0x01
  34
  35
  36 #define TCPOPT_END_OF_LIST  0x0
  37 #define TCPOPT_NO_OPERATION 0x1
  38 #define TCPOPT_MAX_SEG_SIZE 0x2
  39
  40 #define TCPOPTLEN_MAX_SEG_SIZE  0x4
  41
  42 /* Data offset; 32-bit words (leftmost 4 bits); convert to bytes */
  43 #define TCP_DATA_OFFSET(DataOffset)(((DataOffset) & 0xF0) >> (4-2))
  44
  45
  46 /* TCPv4 pseudo header */
  47 typedef struct TCPv4_PSEUDO_HEADER {
  48   ULONG SourceAddress;      /* Source address */
  49   ULONG DestinationAddress; /* Destination address */
  50   UCHAR Zero;               /* Reserved */
  51   UCHAR Protocol;           /* Protocol */
  52   USHORT TCPLength;         /* Size of TCP segment */
  53 } TCPv4_PSEUDO_HEADER, *PTCPv4_PSEUDO_HEADER;
  54 #include <poppack.h>
  55
  56 typedef struct _SLEEPING_THREAD {
  57     LIST_ENTRY Entry;
  58     PVOID SleepToken;
  59     KEVENT Event;
  60 } SLEEPING_THREAD, *PSLEEPING_THREAD;
  61
  62 typedef struct _CLIENT_DATA {
  63     BOOLEAN Unlocked;
  64     KSPIN_LOCK Lock;
  65 } CLIENT_DATA, *PCLIENT_DATA;
  66
  67 /* Retransmission timeout constants */
  68
  69 /* Lower bound for retransmission timeout in TCP timer ticks */
  70 #define TCP_MIN_RETRANSMISSION_TIMEOUT    1*1000          /* 1 tick */
  71
  72 /* Upper bound for retransmission timeout in TCP timer ticks */
  73 #define TCP_MAX_RETRANSMISSION_TIMEOUT    1*60*1000       /* 1 tick */
  74
  75 /* Smoothing factor */
  76 #define TCP_ALPHA_RETRANSMISSION_TIMEOUT(x)(((x)*8)/10)   /* 0.8 */
  77
  78 /* Delay variance factor */
  79 #define TCP_BETA_RETRANSMISSION_TIMEOUT(x)(((x)*16)/10)   /* 1.6 */
  80
  81
  82 /* Datagram/segment send request flags */
  83
  84 #define SRF_URG   TCP_URG
  85 #define SRF_ACK   TCP_ACK
  86 #define SRF_PSH   TCP_PSH
  87 #define SRF_RST   TCP_RST
  88 #define SRF_SYN   TCP_SYN
  89 #define SRF_FIN   TCP_FIN
  90
  91 extern LONG TCP_IPIdentification;
  92 extern CLIENT_DATA ClientInfo;
  93
  94 /* accept.c */
  95 NTSTATUS TCPServiceListeningSocket( PCONNECTION_ENDPOINT Listener,
  96                                     PCONNECTION_ENDPOINT Connection,
  97                                     PTDI_REQUEST_KERNEL Request );
  98 NTSTATUS TCPListen( PCONNECTION_ENDPOINT Connection, UINT Backlog );
  99 BOOLEAN TCPAbortListenForSocket( PCONNECTION_ENDPOINT Listener,
 100                                  PCONNECTION_ENDPOINT Connection );
 101 NTSTATUS TCPAccept
 102 ( PTDI_REQUEST Request,
 103   PCONNECTION_ENDPOINT Listener,
 104   PCONNECTION_ENDPOINT Connection,
 105   PTCP_COMPLETION_ROUTINE Complete,
 106   PVOID Context );
 107
 108 /* tcp.c */
 109 PCONNECTION_ENDPOINT TCPAllocateConnectionEndpoint( PVOID ClientContext );
 110 VOID TCPFreeConnectionEndpoint( PCONNECTION_ENDPOINT Connection );
 111
 112 NTSTATUS TCPSocket( PCONNECTION_ENDPOINT Connection,
 113                     UINT Family, UINT Type, UINT Proto );
 114
 115 VOID HandleSignalledConnection(PCONNECTION_ENDPOINT Connection);
 116
 117 PTCP_SEGMENT TCPCreateSegment(
 118   PIP_PACKET IPPacket,
 119   PTCPv4_HEADER TCPHeader,
 120   ULONG SegmentLength);
 121
 122 VOID TCPFreeSegment(
 123   PTCP_SEGMENT Segment);
 124
 125 VOID TCPAddSegment(
 126   PCONNECTION_ENDPOINT Connection,
 127   PTCP_SEGMENT Segment,
 128   PULONG Acknowledged);
 129
 130 NTSTATUS TCPConnect(
 131   PCONNECTION_ENDPOINT Connection,
 132   PTDI_CONNECTION_INFORMATION ConnInfo,
 133   PTDI_CONNECTION_INFORMATION ReturnInfo,
 134   PTCP_COMPLETION_ROUTINE Complete,
 135   PVOID Context);
 136
 137 NTSTATUS TCPDisconnect(
 138   PCONNECTION_ENDPOINT Connection,
 139   UINT Flags,
 140   PTDI_CONNECTION_INFORMATION ConnInfo,
 141   PTDI_CONNECTION_INFORMATION ReturnInfo,
 142   PTCP_COMPLETION_ROUTINE Complete,
 143   PVOID Context);
 144
 145 NTSTATUS TCPReceiveData(
 146   PCONNECTION_ENDPOINT Connection,
 147   PNDIS_BUFFER Buffer,
 148   ULONG ReceiveLength,
 149   PULONG BytesReceived,
 150   ULONG ReceiveFlags,
 151   PTCP_COMPLETION_ROUTINE Complete,
 152   PVOID Context);
 153
 154 NTSTATUS TCPSendData(
 155   PCONNECTION_ENDPOINT Connection,
 156   PCHAR Buffer,
 157   ULONG DataSize,
 158   PULONG DataUsed,
 159   ULONG Flags,
 160   PTCP_COMPLETION_ROUTINE Complete,
 161   PVOID Context);
 162
 163 NTSTATUS TCPClose( PCONNECTION_ENDPOINT Connection );
 164
 165 NTSTATUS TCPTranslateError( int OskitError );
 166
 167 UINT TCPAllocatePort( UINT HintPort );
 168
 169 VOID TCPFreePort( UINT Port );
 170
 171 NTSTATUS TCPGetSockAddress
 172 ( PCONNECTION_ENDPOINT Connection,
 173   PTRANSPORT_ADDRESS TransportAddress,
 174   BOOLEAN RemoteAddress );
 175
 176 NTSTATUS TCPStartup(
 177   VOID);
 178
 179 NTSTATUS TCPShutdown(
 180   VOID);
 181
 182 BOOLEAN TCPRemoveIRP( PCONNECTION_ENDPOINT Connection, PIRP Irp );
 183
 184 #endif /* __TCP_H */