/********************************************************************/
/**                     Microsoft LAN Manager                      **/
/**               Copyright(c) Microsoft Corp., 1990-2000          **/
/********************************************************************/
/* :ts=4 */

//** TCPRCV.H - TCP receive protocol definitions.
//
// This file contains the definitions for structures used by the receive code.
//
#pragma once

#define CONN_REQUEST_COMPLETE   0x01
#define SEND_REQUEST_COMPLETE   0x02

#define IN_RCV_COMPLETE         0x10
#define ANY_REQUEST_COMPLETE    (CONN_REQUEST_COMPLETE | SEND_REQUEST_COMPLETE)

#define trh_signature   0x20485254      // 'TRH '

typedef struct TCPRAHdr {
#if DBG
    ulong               trh_sig;        // Signature.
#endif
    struct  TCPRAHdr    *trh_next;      // Next pointer.
    SeqNum              trh_start;      // First sequence number.
    uint                trh_size;       // Size in bytes of data in this TRH.
    uint                trh_flags;      // Flags for this segment.
    uint                trh_urg;        // Urgent pointer from this seg.
    IPRcvBuf            *trh_buffer;    // Head of buffer list for this TRH.
    IPRcvBuf            *trh_end;       // End of buffer list for this TRH.

} TCPRAHdr;

//* Structure of a TCP receive request.

#define trr_signature   0x20525254      // 'TRR '

typedef struct TCPRcvReq {
#if DBG
    ulong               trr_sig;        // Signature.
#endif
    struct TCPRcvReq    *trr_next;      // Next in chain.
    CTEReqCmpltRtn      trr_rtn;        // Completion routine.
    PVOID               trr_context;    // User context.
    uint                trr_amt;        // Number of bytes currently in buffer.
    uint                trr_offset;     // Offset into first buffer on chain
                                        // at which to start copying.
    uint                trr_flags;      // Flags for this recv.
    uint                trr_size;       // Total size of buffer chain.
    ushort              *trr_uflags;    // Pointer to user specifed flags.
    PNDIS_BUFFER        trr_buffer;     // Pointer to useable NDIS buffer chain.
    int                 trr_status;     // Final completion status.
} TCPRcvReq;

#define TRR_PUSHED      0x80000000      // This buffer has been pushed.

extern void FreeRBChain(IPRcvBuf *RBChain);
extern void AdjustRcvWin(struct TCB *WinTCB);

//* Delay Queue and related receive handling definitions and functions.

extern BOOLEAN PartitionedDelayQ;

extern void TCPRcvComplete(void);
extern void DelayAction(struct TCB *DelayTCB, uint Action);
extern void ProcessTCBDelayQ(KIRQL OrigIrql, BOOLEAN ProcessAllQueues);
extern LOGICAL ProcessPerCpuTCBDelayQ(int Proc, KIRQL OrigIrql,
                                      const LARGE_INTEGER* StopTicks,
                                      ulong *ItemsProcessed);
extern void CompleteRcvs(struct TCB *CmpltTCB);


__inline void PartitionDelayQProcessing(BOOLEAN NewState) {
    if (NewState != PartitionedDelayQ) {
        InterlockedExchange(((PLONG)&(PartitionedDelayQ)), NewState);
    }
}