drivers/network/tcpip/include/titypes.h

   1 /*
   2  * COPYRIGHT:   See COPYING in the top level directory
   3  * PROJECT:     ReactOS TCP/IP protocol driver
   4  * FILE:        include/titypes.h
   5  * PURPOSE:     TCP/IP protocol driver types
   6  */
   7
   8 #pragma once
   9
  10 /*
  11  * VOID ReferenceObject(
  12  *     PVOID Object)
  13  */
  14 #define ReferenceObject(Object)                            \
  15 {                                                          \
  16     ASSERT((Object)->RefCount);                            \
  17     InterlockedIncrement(&((Object)->RefCount));           \
  18 }
  19
  20 /*
  21  * VOID DereferenceObject(
  22  *     PVOID Object)
  23  */
  24 #define DereferenceObject(Object)                           \
  25 {                                                           \
  26     ASSERT((Object)->RefCount);                             \
  27     if (InterlockedDecrement(&((Object)->RefCount)) == 0)   \
  28         (((Object)->Free)(Object));                         \
  29 }
  30
  31 /*
  32  * VOID LockObject(PVOID Object, PKIRQL OldIrql)
  33  */
  34 #define LockObject(Object, Irql)                         \
  35 {                                                        \
  36     ReferenceObject(Object);                             \
  37     KeAcquireSpinLock(&((Object)->Lock), Irql);          \
  38     memcpy(&(Object)->OldIrql, Irql, sizeof(KIRQL));     \
  39 }
  40
  41 /*
  42  * VOID LockObjectAtDpcLevel(PVOID Object)
  43  */
  44 #define LockObjectAtDpcLevel(Object)                     \
  45 {                                                        \
  46     ReferenceObject(Object);                             \
  47     KeAcquireSpinLockAtDpcLevel(&((Object)->Lock));      \
  48     (Object)->OldIrql = DISPATCH_LEVEL;                  \
  49 }
  50
  51 /*
  52  * VOID UnlockObject(PVOID Object, KIRQL OldIrql)
  53  */
  54 #define UnlockObject(Object, OldIrql)                       \
  55 {                                                           \
  56     KeReleaseSpinLock(&((Object)->Lock), OldIrql);          \
  57     DereferenceObject(Object);                              \
  58 }
  59
  60 /*
  61  * VOID UnlockObjectFromDpcLevel(PVOID Object)
  62  */
  63 #define UnlockObjectFromDpcLevel(Object)                    \
  64 {                                                           \
  65     KeReleaseSpinLockFromDpcLevel(&((Object)->Lock));       \
  66     DereferenceObject(Object);                              \
  67 }
  68
  69
  70
  71 #include <ip.h>
  72
  73 struct _ADDRESS_FILE;
  74
  75 /***************************************************
  76 * Connection-less communication support structures *
  77 ***************************************************/
  78
  79 typedef NTSTATUS (*DATAGRAM_SEND_ROUTINE)(
  80     struct _ADDRESS_FILE *AddrFile,
  81     PTDI_CONNECTION_INFORMATION ConnInfo,
  82     PCHAR Buffer,
  83     ULONG DataSize,
  84     PULONG DataUsed);
  85
  86 /* Datagram completion handler prototype */
  87 typedef VOID (*DATAGRAM_COMPLETION_ROUTINE)(
  88     PVOID Context,
  89     NDIS_STATUS Status,
  90     ULONG Count);
  91
  92 typedef DATAGRAM_COMPLETION_ROUTINE PDATAGRAM_COMPLETION_ROUTINE;
  93
  94 typedef struct _DATAGRAM_RECEIVE_REQUEST {
  95     struct _ADDRESS_FILE *AddressFile;     /* AddressFile on behalf of */
  96     LIST_ENTRY ListEntry;                  /* Entry on list */
  97     IP_ADDRESS RemoteAddress;              /* Remote address we receive from (NULL means any) */
  98     USHORT RemotePort;                     /* Remote port we receive from (0 means any) */
  99     PTDI_CONNECTION_INFORMATION ReturnInfo;/* Return information */
 100     PCHAR Buffer;                          /* Pointer to receive buffer */
 101     ULONG BufferSize;                      /* Size of Buffer */
 102     DATAGRAM_COMPLETION_ROUTINE Complete;  /* Completion routine */
 103     PVOID Context;                         /* Pointer to context information */
 104     DATAGRAM_COMPLETION_ROUTINE UserComplete;   /* Completion routine */
 105     PVOID UserContext;                     /* Pointer to context information */
 106     PIRP Irp;                              /* IRP on behalf of */
 107 } DATAGRAM_RECEIVE_REQUEST, *PDATAGRAM_RECEIVE_REQUEST;
 108
 109 /* Datagram build routine prototype */
 110 typedef NTSTATUS (*DATAGRAM_BUILD_ROUTINE)(
 111     PVOID Context,
 112     PIP_ADDRESS LocalAddress,
 113     USHORT LocalPort,
 114     PIP_PACKET *IPPacket);
 115
 116 typedef struct _DATAGRAM_SEND_REQUEST {
 117     LIST_ENTRY ListEntry;
 118     PNDIS_PACKET PacketToSend;
 119     DATAGRAM_COMPLETION_ROUTINE Complete; /* Completion routine */
 120     PVOID Context;                        /* Pointer to context information */
 121     IP_PACKET Packet;
 122     UINT BufferSize;
 123     IP_ADDRESS RemoteAddress;
 124     USHORT RemotePort;
 125     ULONG Flags;                          /* Protocol specific flags */
 126 } DATAGRAM_SEND_REQUEST, *PDATAGRAM_SEND_REQUEST;
 127
 128 /* Transport address file context structure. The FileObject->FsContext2
 129    field holds a pointer to this structure */
 130 typedef struct _ADDRESS_FILE {
 131     LIST_ENTRY ListEntry;                 /* Entry on list */
 132     LONG RefCount;                        /* Reference count */
 133     OBJECT_FREE_ROUTINE Free;             /* Routine to use to free resources for the object */
 134     KSPIN_LOCK Lock;                      /* Spin lock to manipulate this structure */
 135     KIRQL OldIrql;                        /* Currently not used */
 136     IP_ADDRESS Address;                   /* Address of this address file */
 137     USHORT Family;                        /* Address family */
 138     USHORT Protocol;                      /* Protocol number */
 139     USHORT Port;                          /* Network port (network byte order) */
 140     LONG Sharers;                         /* Number of file objects with this addr file */
 141     UCHAR TTL;                            /* Time to live stored in packets sent from this address file */
 142     UINT DF;                              /* Don't fragment */
 143     UINT BCast;                           /* Receive broadcast packets */
 144     UINT HeaderIncl;                      /* Include header in RawIP packets */
 145     WORK_QUEUE_ITEM WorkItem;             /* Work queue item handle */
 146     DATAGRAM_COMPLETION_ROUTINE Complete; /* Completion routine for delete request */
 147     PVOID Context;                        /* Delete request context */
 148     DATAGRAM_SEND_ROUTINE Send;           /* Routine to send a datagram */
 149     LIST_ENTRY ReceiveQueue;              /* List of outstanding receive requests */
 150     LIST_ENTRY TransmitQueue;             /* List of outstanding transmit requests */
 151     struct _CONNECTION_ENDPOINT *Connection;
 152     /* Associated connection or NULL if no associated connection exist */
 153     struct _CONNECTION_ENDPOINT *Listener;
 154     /* Associated listener (see transport/tcp/accept.c) */
 155     IP_ADDRESS AddrCache;                 /* One entry address cache (destination
 156                                              address of last packet transmitted) */
 157
 158     /* The following members are used to control event notification */
 159
 160     /* Connection indication handler */
 161     PTDI_IND_CONNECT ConnectHandler;
 162     PVOID ConnectHandlerContext;
 163     BOOLEAN RegisteredConnectHandler;
 164     /* Disconnect indication handler */
 165     PTDI_IND_DISCONNECT DisconnectHandler;
 166     PVOID DisconnectHandlerContext;
 167     BOOLEAN RegisteredDisconnectHandler;
 168     /* Error indication handler */
 169     PTDI_IND_ERROR ErrorHandler;
 170     PVOID ErrorHandlerContext;
 171     PVOID ErrorHandlerOwner;
 172     BOOLEAN RegisteredErrorHandler;
 173     /* Receive indication handler */
 174     PTDI_IND_RECEIVE ReceiveHandler;
 175     PVOID ReceiveHandlerContext;
 176     BOOLEAN RegisteredReceiveHandler;
 177     /* Receive datagram indication handler */
 178     PTDI_IND_RECEIVE_DATAGRAM ReceiveDatagramHandler;
 179     PVOID ReceiveDatagramHandlerContext;
 180     BOOLEAN RegisteredReceiveDatagramHandler;
 181     /* Expedited receive indication handler */
 182     PTDI_IND_RECEIVE_EXPEDITED ExpeditedReceiveHandler;
 183     PVOID ExpeditedReceiveHandlerContext;
 184     BOOLEAN RegisteredExpeditedReceiveHandler;
 185     /* Chained receive indication handler */
 186     PTDI_IND_CHAINED_RECEIVE ChainedReceiveHandler;
 187     PVOID ChainedReceiveHandlerContext;
 188     BOOLEAN RegisteredChainedReceiveHandler;
 189     /* Chained receive datagram indication handler */
 190     PTDI_IND_CHAINED_RECEIVE_DATAGRAM ChainedReceiveDatagramHandler;
 191     PVOID ChainedReceiveDatagramHandlerContext;
 192     BOOLEAN RegisteredChainedReceiveDatagramHandler;
 193     /* Chained expedited receive indication handler */
 194     PTDI_IND_CHAINED_RECEIVE_EXPEDITED ChainedReceiveExpeditedHandler;
 195     PVOID ChainedReceiveExpeditedHandlerContext;
 196     BOOLEAN RegisteredChainedReceiveExpeditedHandler;
 197 } ADDRESS_FILE, *PADDRESS_FILE;
 198
 199 /* Structure used to search through Address Files */
 200 typedef struct _AF_SEARCH {
 201     PLIST_ENTRY Next;       /* Next address file to check */
 202     PIP_ADDRESS Address;    /* Pointer to address to be found */
 203     USHORT Port;            /* Network port */
 204     USHORT Protocol;        /* Protocol number */
 205 } AF_SEARCH, *PAF_SEARCH;
 206
 207 /*******************************************************
 208 * Connection-oriented communication support structures *
 209 *******************************************************/
 210
 211 typedef struct _TCP_RECEIVE_REQUEST {
 212   LIST_ENTRY ListEntry;                 /* Entry on list */
 213   PNDIS_BUFFER Buffer;                  /* Pointer to receive buffer */
 214   ULONG BufferSize;                     /* Size of Buffer */
 215   DATAGRAM_COMPLETION_ROUTINE Complete; /* Completion routine */
 216   PVOID Context;                        /* Pointer to context information */
 217 } TCP_RECEIVE_REQUEST, *PTCP_RECEIVE_REQUEST;
 218
 219 /* Connection states */
 220 typedef enum {
 221   ctListen = 0,   /* Waiting for incoming connection requests */
 222   ctSynSent,      /* Waiting for matching connection request */
 223   ctSynReceived,  /* Waiting for connection request acknowledgment */
 224   ctEstablished,  /* Connection is open for data transfer */
 225   ctFinWait1,     /* Waiting for termination request or ack. for same */
 226   ctFinWait2,     /* Waiting for termination request from remote TCP */
 227   ctCloseWait,    /* Waiting for termination request from local user */
 228   ctClosing,      /* Waiting for termination ack. from remote TCP */
 229   ctLastAck,      /* Waiting for termination request ack. from remote TCP */
 230   ctTimeWait,     /* Waiting for enough time to pass to be sure the remote TCP
 231                      received the ack. of its connection termination request */
 232   ctClosed        /* Represents a closed connection */
 233 } CONNECTION_STATE, *PCONNECTION_STATE;
 234
 235
 236 /* Structure for an TCP segment */
 237 typedef struct _TCP_SEGMENT {
 238   LIST_ENTRY ListEntry;
 239   PIP_PACKET IPPacket;        /* Pointer to IP packet */
 240   PVOID SegmentData;          /* Pointer to segment data */
 241   ULONG SequenceNumber;       /* Sequence number of first byte in segment */
 242   ULONG Length;               /* Number of bytes in segment */
 243   ULONG BytesDelivered;       /* Number of bytes already delivered to the client */
 244 } TCP_SEGMENT, *PTCP_SEGMENT;
 245
 246 typedef struct _TDI_BUCKET {
 247     LIST_ENTRY Entry;
 248     struct _CONNECTION_ENDPOINT *AssociatedEndpoint;
 249     TDI_REQUEST Request;
 250     NTSTATUS Status;
 251     ULONG Information;
 252 } TDI_BUCKET, *PTDI_BUCKET;
 253
 254 /* Transport connection context structure A.K.A. Transmission Control Block
 255    (TCB) in TCP terminology. The FileObject->FsContext2 field holds a pointer
 256    to this structure */
 257 typedef struct _CONNECTION_ENDPOINT {
 258     PVOID SocketContext;        /* Context for lower layer (MUST be first member in struct) */
 259     LIST_ENTRY ListEntry;       /* Entry on list */
 260     LONG RefCount;              /* Reference count */
 261     OBJECT_FREE_ROUTINE Free;   /* Routine to use to free resources for the object */
 262     KSPIN_LOCK Lock;            /* Spin lock to protect this structure */
 263     KIRQL OldIrql;              /* The old irql is stored here for use in HandleSignalledConnection */
 264     PVOID ClientContext;        /* Pointer to client context information */
 265     PADDRESS_FILE AddressFile;  /* Associated address file object (NULL if none) */
 266
 267     /* Requests */
 268     LIST_ENTRY ConnectRequest; /* Queued connect rqueusts */
 269     LIST_ENTRY ListenRequest;  /* Queued listen requests */
 270     LIST_ENTRY ReceiveRequest; /* Queued receive requests */
 271     LIST_ENTRY SendRequest;    /* Queued send requests */
 272     LIST_ENTRY ShutdownRequest;/* Queued shutdown requests */
 273
 274     LIST_ENTRY PacketQueue;    /* Queued received packets waiting to be processed */
 275
 276     /* Disconnect Timer */
 277     KTIMER DisconnectTimer;
 278     KDPC DisconnectDpc;
 279
 280     /* Socket state */
 281     BOOLEAN SendShutdown;
 282     BOOLEAN ReceiveShutdown;
 283     NTSTATUS ReceiveShutdownStatus;
 284     BOOLEAN Closing;
 285
 286     struct _CONNECTION_ENDPOINT *Next; /* Next connection in address file list */
 287 } CONNECTION_ENDPOINT, *PCONNECTION_ENDPOINT;
 288
 289
 290
 291 /*************************
 292 * TDI support structures *
 293 *************************/
 294
 295 /* Transport control channel context structure. The FileObject->FsContext2
 296    field holds a pointer to this structure */
 297 typedef struct _CONTROL_CHANNEL {
 298     LIST_ENTRY ListEntry;       /* Entry on list */
 299     LONG RefCount;              /* Reference count */
 300     OBJECT_FREE_ROUTINE Free;   /* Routine to use to free resources for the object */
 301     KSPIN_LOCK Lock;            /* Spin lock to protect this structure */
 302 } CONTROL_CHANNEL, *PCONTROL_CHANNEL;
 303
 304 /* Transport (TCP/UDP) endpoint context structure. The FileObject->FsContext
 305    field holds a pointer to this structure */
 306 typedef struct _TRANSPORT_CONTEXT {
 307     union {
 308         HANDLE AddressHandle;
 309         CONNECTION_CONTEXT ConnectionContext;
 310         HANDLE ControlChannel;
 311     } Handle;
 312     BOOLEAN CancelIrps;
 313     KEVENT CleanupEvent;
 314 } TRANSPORT_CONTEXT, *PTRANSPORT_CONTEXT;
 315
 316 typedef struct _TI_QUERY_CONTEXT {
 317     PIRP Irp;
 318     PMDL InputMdl;
 319     PMDL OutputMdl;
 320     TCP_REQUEST_QUERY_INFORMATION_EX QueryInfo;
 321 } TI_QUERY_CONTEXT, *PTI_QUERY_CONTEXT;
 322
 323 /* EOF */