reactos/reactos/drivers/net/tcpip/include/titypes.h

/*
 * COPYRIGHT:   See COPYING in the top level directory
 * PROJECT:     ReactOS TCP/IP protocol driver
 * FILE:        include/titypes.h
 * PURPOSE:     TCP/IP protocol driver types
 */
#ifndef __TITYPES_H
#define __TITYPES_H


#ifdef DBG

#define DEFINE_TAG ULONG Tag;
#define INIT_TAG(_Object, _Tag) \
  ((_Object)->Tag = (_Tag))

#define DEBUG_REFCHECK(Object) {        \
   if ((Object)->RefCount <= 0) {       \
      TI_DbgPrint(MIN_TRACE, ("Object at (0x%X) has invalid reference count (%d).\n", \
        (Object), (Object)->RefCount)); \
    }                                   \
}

/*
 * VOID ReferenceObject(
 *     PVOID Object)
 */
#define ReferenceObject(Object)      \
{                                    \
  CHAR c1, c2, c3, c4;               \
                                     \
  c1 = ((Object)->Tag >> 24) & 0xFF; \
  c2 = ((Object)->Tag >> 16) & 0xFF; \
  c3 = ((Object)->Tag >> 8) & 0xFF;  \
  c4 = ((Object)->Tag & 0xFF);       \
                                     \
  DEBUG_REFCHECK(Object);            \
  TI_DbgPrint(DEBUG_REFCOUNT, ("Referencing object of type (%c%c%c%c) at (0x%X). RefCount (%d).\n", \
    c4, c3, c2, c1, (Object), (Object)->RefCount)); \
                                                    \
  InterlockedIncrement(&((Object)->RefCount));      \
}

  /*
 * VOID DereferenceObject(
 *     PVOID Object)
 */
#define DereferenceObject(Object)    \
{                                    \
  CHAR c1, c2, c3, c4;               \
                                     \
  c1 = ((Object)->Tag >> 24) & 0xFF; \
  c2 = ((Object)->Tag >> 16) & 0xFF; \
  c3 = ((Object)->Tag >> 8) & 0xFF;  \
  c4 = ((Object)->Tag & 0xFF);       \
                                     \
  DEBUG_REFCHECK(Object);            \
  TI_DbgPrint(DEBUG_REFCOUNT, ("Dereferencing object of type (%c%c%c%c) at (0x%X). RefCount (%d).\n", \
    c4, c3, c2, c1, (Object), (Object)->RefCount));     \
                                                        \
  if (InterlockedDecrement(&((Object)->RefCount)) == 0) \
    (((Object)->Free)(Object));                         \
}

#else /* DBG */

#define DEFINE_TAG
#define INIT_TAG (Object, Tag)

/*
 * VOID ReferenceObject(
 *     PVOID Object)
 */
#define ReferenceObject(Object)                  \
{                                                \
    InterlockedIncrement(&((Object)->RefCount)); \
}

/*
 * VOID DereferenceObject(
 *     PVOID Object)
 */
#define DereferenceObject(Object)                         \
{                                                         \
    if (InterlockedDecrement(&((Object)->RefCount)) == 0) \
        (((Object)->Free)(Object));                       \
}

#endif /* DBG */


#include <ip.h>


/***************************************************
* Connection-less communication support structures *
***************************************************/

typedef NTSTATUS (*DATAGRAM_SEND_ROUTINE)(
    PTDI_REQUEST Request,
    PTDI_CONNECTION_INFORMATION ConnInfo,
    PNDIS_BUFFER Buffer,
    ULONG DataSize);

/* Datagram completion handler prototype */
typedef VOID (*DATAGRAM_COMPLETION_ROUTINE)(
    PVOID Context,
    NDIS_STATUS Status,
    ULONG Count);

typedef struct _DATAGRAM_RECEIVE_REQUEST {
    LIST_ENTRY ListEntry;                   /* Entry on list */
    PIP_ADDRESS RemoteAddress;              /* Remote address we receive from (NULL means any) */
    USHORT RemotePort;                      /* Remote port we receive from (0 means any) */
    PTDI_CONNECTION_INFORMATION ReturnInfo; /* Return information */
    PNDIS_BUFFER Buffer;                    /* Pointer to receive buffer */
    ULONG BufferSize;                       /* Size of Buffer */
    DATAGRAM_COMPLETION_ROUTINE Complete;   /* Completion routine */
    PVOID Context;                          /* Pointer to context information */
} DATAGRAM_RECEIVE_REQUEST, *PDATAGRAM_RECEIVE_REQUEST;

/* Datagram build routine prototype */
typedef NTSTATUS (*DATAGRAM_BUILD_ROUTINE)(
    PVOID Context,
    PIP_ADDRESS LocalAddress,
    USHORT LocalPort,
    PIP_PACKET *IPPacket);

typedef struct _DATAGRAM_SEND_REQUEST {
    LIST_ENTRY ListEntry;                 /* Entry on list */
    PIP_ADDRESS RemoteAddress;            /* Pointer to remote IP address */
    USHORT RemotePort;                    /* Remote port number */
    PNDIS_BUFFER Buffer;                  /* Pointer to NDIS buffer to send */
    DWORD BufferSize;                     /* Size of Buffer */
    DATAGRAM_COMPLETION_ROUTINE Complete; /* Completion routine */
    PVOID Context;                        /* Pointer to context information */
    DATAGRAM_BUILD_ROUTINE Build;         /* Datagram build routine */
    ULONG Flags;                          /* Protocol specific flags */
} DATAGRAM_SEND_REQUEST, *PDATAGRAM_SEND_REQUEST;

#define InitializeDatagramSendRequest( \
  _SendRequest, \
  _RemoteAddress, \
  _RemotePort, \
  _Buffer, \
  _BufferSize, \
  _Complete, \
  _Context, \
  _Build, \
  _Flags) { \
    (_SendRequest)->RemoteAddress = (_RemoteAddress); \
    (_SendRequest)->RemotePort = (_RemotePort); \
    (_SendRequest)->Buffer = (_Buffer); \
    (_SendRequest)->BufferSize = (_BufferSize); \
    (_SendRequest)->Complete = (_Complete); \
    (_SendRequest)->Context = (_Context); \
    (_SendRequest)->Build = (_Build); \
    (_SendRequest)->Flags = (_Flags); \
  }

/* Transport address file context structure. The FileObject->FsContext2
   field holds a pointer to this structure */
typedef struct _ADDRESS_FILE {
    DEFINE_TAG
    LIST_ENTRY ListEntry;                 /* Entry on list */
    KSPIN_LOCK Lock;                      /* Spin lock to manipulate this structure */
    ULONG RefCount;                       /* Number of references to this object */
    OBJECT_FREE_ROUTINE Free;             /* Routine to use to free resources for the object */
    USHORT Flags;                         /* Flags for address file (see below) */
    PADDRESS_ENTRY ADE;                   /* Associated address entry */
    USHORT Protocol;                      /* Protocol number */
    USHORT Port;                          /* Network port (network byte order) */
    WORK_QUEUE_ITEM WorkItem;             /* Work queue item handle */
    DATAGRAM_COMPLETION_ROUTINE Complete; /* Completion routine for delete request */
    PVOID Context;                        /* Delete request context */
    DATAGRAM_SEND_ROUTINE Send;           /* Routine to send a datagram */
    LIST_ENTRY ReceiveQueue;              /* List of outstanding receive requests */
    LIST_ENTRY TransmitQueue;             /* List of outstanding transmit requests */
    struct _CONNECTION_ENDPOINT *Connection;
                                          /* Associated connection or NULL if no
                                             associated connection exist */
    PIP_ADDRESS AddrCache;                /* One entry address cache (destination
                                             address of last packet transmitted) */

    /* The following members are used to control event notification */

    /* Connection indication handler */
    PTDI_IND_CONNECT ConnectHandler;
    PVOID ConnectHandlerContext;
    BOOL RegisteredConnectHandler;
    /* Disconnect indication handler */
    PTDI_IND_DISCONNECT DisconnectHandler;
    PVOID DisconnectHandlerContext;
    BOOL RegisteredDisconnectHandler;
    /* Error indication handler */
    PTDI_IND_ERROR ErrorHandler;
    PVOID ErrorHandlerContext;
    PVOID ErrorHandlerOwner;
    BOOL RegisteredErrorHandler;
    /* Receive indication handler */
    PTDI_IND_RECEIVE ReceiveHandler;
    PVOID ReceiveHandlerContext;
    BOOL RegisteredReceiveHandler;
    /* Receive datagram indication handler */
    PTDI_IND_RECEIVE_DATAGRAM ReceiveDatagramHandler;
    PVOID ReceiveDatagramHandlerContext;
    BOOL RegisteredReceiveDatagramHandler;
    /* Expedited receive indication handler */
    PTDI_IND_RECEIVE_EXPEDITED ExpeditedReceiveHandler;
    PVOID ExpeditedReceiveHandlerContext;
    BOOL RegisteredExpeditedReceiveHandler;
    /* Chained receive indication handler */
    PTDI_IND_CHAINED_RECEIVE ChainedReceiveHandler;
    PVOID ChainedReceiveHandlerContext;
    BOOL RegisteredChainedReceiveHandler;
    /* Chained receive datagram indication handler */
    PTDI_IND_CHAINED_RECEIVE_DATAGRAM ChainedReceiveDatagramHandler;
    PVOID ChainedReceiveDatagramHandlerContext;
    BOOL RegisteredChainedReceiveDatagramHandler;
    /* Chained expedited receive indication handler */
    PTDI_IND_CHAINED_RECEIVE_EXPEDITED ChainedReceiveExpeditedHandler;
    PVOID ChainedReceiveExpeditedHandlerContext;
    BOOL RegisteredChainedReceiveExpeditedHandler;
} ADDRESS_FILE, *PADDRESS_FILE;

/* Address File Flag constants */
#define AFF_VALID    0x0001 /* Address file object is valid for use */
#define AFF_BUSY     0x0002 /* Address file object is exclusive to someone */
#define AFF_DELETE   0x0004 /* Address file object is sheduled to be deleted */
#define AFF_SEND     0x0008 /* A send request is pending */
#define AFF_RECEIVE  0x0010 /* A receive request is pending */
#define AFF_PENDING  0x001C /* A request is pending */

/* Macros for manipulating address file object flags */

#define AF_IS_VALID(ADF)  ((ADF)->Flags & AFF_VALID)
#define AF_SET_VALID(ADF) ((ADF)->Flags |= AFF_VALID)
#define AF_CLR_VALID(ADF) ((ADF)->Flags &= ~AFF_VALID)

#define AF_IS_BUSY(ADF)  ((ADF)->Flags & AFF_BUSY)
#define AF_SET_BUSY(ADF) ((ADF)->Flags |= AFF_BUSY)
#define AF_CLR_BUSY(ADF) ((ADF)->Flags &= ~AFF_BUSY)

#define AF_IS_PENDING(ADF, X)  (ADF->Flags & X)
#define AF_SET_PENDING(ADF, X) (ADF->Flags |= X)
#define AF_CLR_PENDING(ADF, X) (ADF->Flags &= ~X)


/* Structure used to search through Address Files */
typedef struct _AF_SEARCH {
    PLIST_ENTRY Next;       /* Next address file to check */
    PIP_ADDRESS Address;    /* Pointer to address to be found */
    USHORT Port;            /* Network port */
    USHORT Protocol;        /* Protocol number */
} AF_SEARCH, *PAF_SEARCH;



/*******************************************************
* Connection-oriented communication support structures *
*******************************************************/

typedef struct _TCP_SEND_REQUEST {
  LIST_ENTRY ListEntry;                 /* Entry on list */
  DATAGRAM_COMPLETION_ROUTINE Complete; /* Completion routine */
  PVOID Context;                        /* Pointer to context information */
  PVOID ProtocolContext;                /* Protocol specific context */
  ULONG Flags;                          /* Protocol specific flags */
} TCP_SEND_REQUEST, *PTCP_SEND_REQUEST;

#define InitializeTCPSendRequest( \
  _SendRequest, \
  _Complete, \
  _Context, \
  _ProtocolContext) { \
    (_SendRequest)->Complete = (_Complete); \
    (_SendRequest)->Context = (_Context); \
    (_SendRequest)->ProtocolContext = (_ProtocolContext); \
  }


/* Connection states */
typedef enum {
  ctListen = 0,   /* Waiting for incoming connection requests */
  ctSynSent,      /* Waiting for matching connection request */
  ctSynReceived,  /* Waiting for connection request acknowledgment */
  ctEstablished,  /* Connection is open for data transfer */
  ctFinWait1,     /* Waiting for termination request or ack. for same */
  ctFinWait2,     /* Waiting for termination request from remote TCP */
  ctCloseWait,    /* Waiting for termination request from local user */
  ctClosing,      /* Waiting for termination ack. from remote TCP */
  ctLastAck,      /* Waiting for termination request ack. from remote TCP */
  ctTimeWait,     /* Waiting for enough time to pass to be sure the remote TCP
                     received the ack. of its connection termination request */
  ctClosed        /* Represents a closed connection */
} CONNECTION_STATE, *PCONNECTION_STATE;


/* Transport connection context structure A.K.A. Transmission Control Block
   (TCB) in TCP terminology. The FileObject->FsContext2 field holds a pointer
   to this structure */
typedef struct _CONNECTION_ENDPOINT {
  LIST_ENTRY ListEntry;       /* Entry on list */
  KSPIN_LOCK Lock;            /* Spin lock to protect this structure */
  ULONG RefCount;             /* Number of references to this object */
  PVOID ClientContext;        /* Pointer to client context information */
  PADDRESS_FILE AddressFile;  /* Associated address file object (NULL if none) */

  CONNECTION_STATE State;     /* Connection state */

  PIP_ADDRESS LocalAddress;   /* Pointer to local IP address */
  USHORT LocalPort;           /* Local port number (network byte order) */

  PIP_ADDRESS RemoteAddress;  /* Pointer to remote IP address */
  USHORT RemotePort;          /* Remote port number (network byte order) */

  /* Send sequence variables */
  ULONG SendUnacknowledged;   /* Highest sequence number that is acknowledged */
  ULONG SendNext;             /* Sequence number of last data block sent */
  ULONG SendWindow;           /* Maximum allowed number of octets in a segment */
  ULONG SendUrgentPointer;    /* Sequence number of start of urgent data */
  ULONG SendWL1;              /* Sequence number used for last window update */
  ULONG SendWL2;              /* Acknowledgment number used for last window update */
  ULONG SendISS;              /* Initial send sequence number */

  /* Receive sequence variables */
  ULONG RecvNext;             /* Sequence number of last data block received */
  ULONG RecvWindow;           /* Maximum allowed number of octets in a segment */
  ULONG RecvUrgentPointer;    /* Sequence number of start of urgent data */
  ULONG RecvIRS;              /* Initial receive sequence number */

  /* Statistics for computing the retransmission timeout */
  ULONG TimestampSend;        /* Timestamp when sending a segment */
  ULONG TimestampAck;         /* Timestamp when receiving acknowledgment */
} CONNECTION_ENDPOINT, *PCONNECTION_ENDPOINT;



/*************************
* TDI support structures *
*************************/

/* Transport control channel context structure. The FileObject->FsContext2
   field holds a pointer to this structure */
typedef struct _CONTROL_CHANNEL {
    LIST_ENTRY ListEntry;       /* Entry on list */
    KSPIN_LOCK Lock;            /* Spin lock to protect this structure */
    ULONG RefCount;             /* Number of references to this object */
} CONTROL_CHANNEL, *PCONTROL_CHANNEL;

/* Transport (TCP/UDP) endpoint context structure. The FileObject->FsContext
   field holds a pointer to this structure */
typedef struct _TRANSPORT_CONTEXT {
    union {
        HANDLE AddressHandle;
        CONNECTION_CONTEXT ConnectionContext;
        HANDLE ControlChannel;
    } Handle;
    ULONG RefCount;
    BOOL CancelIrps;
    KEVENT CleanupEvent;
} TRANSPORT_CONTEXT, *PTRANSPORT_CONTEXT;

typedef struct _TI_QUERY_CONTEXT {
    PIRP Irp;
    PMDL InputMdl;
    PMDL OutputMdl;
    TCP_REQUEST_QUERY_INFORMATION_EX QueryInfo;
} TI_QUERY_CONTEXT, *PTI_QUERY_CONTEXT;

#endif /* __TITYPES_H */

/* EOF */