reactos/drivers/network/afd/include/afd.h

   1 /* $Id$
   2  *
   3  * COPYRIGHT:        See COPYING in the top level directory
   4  * PROJECT:          ReactOS kernel
   5  * FILE:             drivers/net/afd/include/afd.h
   6  * PURPOSE:          Ancillary functions driver -- constants and structures
   7  * PROGRAMMER:       Art Yerkes (ayerkes@speakeasy.net)
   8  * UPDATE HISTORY:
   9  * 20040630 Created
  10  */
  11
  12 #ifndef _AFD_H
  13 #define _AFD_H
  14
  15 #include <ntddk.h>
  16 #include <ntifs.h>
  17 #include <ndk/obtypes.h>
  18 #include <ndk/obfuncs.h>
  19 #include <ndk/mmtypes.h>
  20 #include <ndk/mmfuncs.h>
  21 #include <tdi.h>
  22 #include <tdikrnl.h>
  23 #include <tdiinfo.h>
  24 #include <string.h>
  25 #define _WINBASE_
  26 #define _WINDOWS_H
  27 #define _INC_WINDOWS
  28 #include <windef.h>
  29 #include <winsock2.h>
  30 #include <afd/shared.h>
  31
  32 #ifndef MIN
  33 #define MIN(x,y) (((x)<(y))?(x):(y))
  34 #endif
  35
  36 #define IOCTL_TCP_QUERY_INFORMATION_EX \
  37         CTL_CODE(FILE_DEVICE_NETWORK, 0, METHOD_NEITHER, FILE_ANY_ACCESS)
  38
  39 #define TL_INSTANCE 0
  40 #define IP_MIB_STATS_ID 1
  41 #define IP_MIB_ADDRTABLE_ENTRY_ID 0x102
  42
  43 typedef struct IPSNMP_INFO {
  44         ULONG Forwarding;
  45         ULONG DefaultTTL;
  46         ULONG InReceives;
  47         ULONG InHdrErrors;
  48         ULONG InAddrErrors;
  49         ULONG ForwDatagrams;
  50         ULONG InUnknownProtos;
  51         ULONG InDiscards;
  52         ULONG InDelivers;
  53         ULONG OutRequests;
  54         ULONG RoutingDiscards;
  55         ULONG OutDiscards;
  56         ULONG OutNoRoutes;
  57         ULONG ReasmTimeout;
  58         ULONG ReasmReqds;
  59         ULONG ReasmOks;
  60         ULONG ReasmFails;
  61         ULONG FragOks;
  62         ULONG FragFails;
  63         ULONG FragCreates;
  64         ULONG NumIf;
  65         ULONG NumAddr;
  66         ULONG NumRoutes;
  67 } IPSNMP_INFO, *PIPSNMP_INFO;
  68
  69 typedef struct IPADDR_ENTRY {
  70         ULONG  Addr;
  71         ULONG  Index;
  72         ULONG  Mask;
  73         ULONG  BcastAddr;
  74         ULONG  ReasmSize;
  75         USHORT Context;
  76         USHORT Pad;
  77 } IPADDR_ENTRY, *PIPADDR_ENTRY;
  78
  79 #define DN2H(dw) \
  80     ((((dw) & 0xFF000000L) >> 24) | \
  81          (((dw) & 0x00FF0000L) >> 8) | \
  82          (((dw) & 0x0000FF00L) << 8) | \
  83          (((dw) & 0x000000FFL) << 24))
  84
  85 #define SOCKET_STATE_INVALID_TRANSITION ((DWORD)-1)
  86 #define SOCKET_STATE_CREATED            0
  87 #define SOCKET_STATE_BOUND              1
  88 #define SOCKET_STATE_CONNECTING         2
  89 #define SOCKET_STATE_CONNECTED          3
  90 #define SOCKET_STATE_LISTENING          4
  91 #define SOCKET_STATE_MASK               0x0000ffff
  92 #define SOCKET_STATE_EOF_READ           0x20000000
  93 #define SOCKET_STATE_LOCKED             0x40000000
  94 #define SOCKET_STATE_NEW                0x80000000
  95 #define SOCKET_STATE_CLOSED             0x00000100
  96
  97 #define FUNCTION_CONNECT                0
  98 #define FUNCTION_RECV                   1
  99 #define FUNCTION_SEND                   2
 100 #define FUNCTION_PREACCEPT              3
 101 #define FUNCTION_ACCEPT                 4
 102 #define FUNCTION_CLOSE                  5
 103 #define MAX_FUNCTIONS                   6
 104
 105 #define IN_FLIGHT_REQUESTS              4
 106
 107 #define EXTRA_LOCK_BUFFERS              2 /* Number of extra buffers needed
 108                                            * for ancillary data on packet
 109                                            * requests. */
 110
 111 #define DEFAULT_SEND_WINDOW_SIZE        16384
 112 #define DEFAULT_RECEIVE_WINDOW_SIZE     16384
 113
 114 #define SGID_CONNECTIONLESS             1 /* XXX Find this flag */
 115
 116 /* XXX This is a hack we should clean up later
 117  * We do this in order to get some storage for the locked handle table
 118  * Maybe I'll use some tail item in the irp instead */
 119 #define AFD_HANDLES(x) ((PAFD_HANDLE)(x)->Exclusive)
 120 #define SET_AFD_HANDLES(x,y) (((x)->Exclusive) = (ULONG_PTR)(y))
 121
 122 typedef struct _AFD_MAPBUF {
 123     PVOID BufferAddress;
 124     PMDL  Mdl;
 125 } AFD_MAPBUF, *PAFD_MAPBUF;
 126
 127 typedef struct _AFD_DEVICE_EXTENSION {
 128     PDEVICE_OBJECT DeviceObject;
 129     LIST_ENTRY Polls;
 130     KSPIN_LOCK Lock;
 131 } AFD_DEVICE_EXTENSION, *PAFD_DEVICE_EXTENSION;
 132
 133 typedef struct _AFD_ACTIVE_POLL {
 134     LIST_ENTRY ListEntry;
 135     PIRP Irp;
 136     PAFD_DEVICE_EXTENSION DeviceExt;
 137     KDPC TimeoutDpc;
 138     KTIMER Timer;
 139     PKEVENT EventObject;
 140     BOOLEAN Exclusive;
 141 } AFD_ACTIVE_POLL, *PAFD_ACTIVE_POLL;
 142
 143 typedef struct _IRP_LIST {
 144     LIST_ENTRY ListEntry;
 145     PIRP Irp;
 146 } IRP_LIST, *PIRP_LIST;
 147
 148 typedef struct _AFD_TDI_OBJECT {
 149     PFILE_OBJECT Object;
 150     HANDLE Handle;
 151 } AFD_TDI_OBJECT, *PAFD_TDI_OBJECT;
 152
 153 typedef struct _AFD_TDI_OBJECT_QELT {
 154     LIST_ENTRY ListEntry;
 155     UINT Seq;
 156     PTDI_CONNECTION_INFORMATION ConnInfo;
 157     AFD_TDI_OBJECT Object;
 158 } AFD_TDI_OBJECT_QELT, *PAFD_TDI_OBJECT_QELT;
 159
 160 typedef struct _AFD_IN_FLIGHT_REQUEST {
 161     PIRP InFlightRequest;
 162     IO_STATUS_BLOCK Iosb;
 163     PTDI_CONNECTION_INFORMATION ConnectionCallInfo;
 164     PTDI_CONNECTION_INFORMATION ConnectionReturnInfo;
 165 } AFD_IN_FLIGHT_REQUEST, *PAFD_IN_FLIGHT_REQUEST;
 166
 167 typedef struct _AFD_DATA_WINDOW {
 168     PCHAR Window;
 169     UINT BytesUsed, Size, Content;
 170 } AFD_DATA_WINDOW, *PAFD_DATA_WINDOW;
 171
 172 typedef struct _AFD_STORED_DATAGRAM {
 173     LIST_ENTRY ListEntry;
 174     UINT Len;
 175     PTRANSPORT_ADDRESS Address;
 176     CHAR Buffer[1];
 177 } AFD_STORED_DATAGRAM, *PAFD_STORED_DATAGRAM;
 178
 179 typedef struct _AFD_FCB {
 180     BOOLEAN Locked, Critical, Overread;
 181     UINT State, Flags;
 182     KIRQL OldIrql;
 183     UINT LockCount;
 184     PVOID CurrentThread;
 185     KSPIN_LOCK SpinLock;
 186     PFILE_OBJECT FileObject;
 187     PAFD_DEVICE_EXTENSION DeviceExt;
 188     BOOLEAN DelayedAccept, NeedsNewListen;
 189     UINT ConnSeq;
 190     PTRANSPORT_ADDRESS LocalAddress, RemoteAddress;
 191     PTDI_CONNECTION_INFORMATION AddressFrom;
 192     AFD_TDI_OBJECT AddressFile, Connection;
 193     AFD_IN_FLIGHT_REQUEST ConnectIrp, ListenIrp, ReceiveIrp, SendIrp;
 194     AFD_DATA_WINDOW Send, Recv;
 195     FAST_MUTEX Mutex;
 196     KEVENT StateLockedEvent;
 197     PKEVENT EventSelect;
 198     DWORD EventSelectTriggers;
 199     DWORD EventsFired;
 200     UNICODE_STRING TdiDeviceName;
 201     PVOID Context;
 202     DWORD PollState;
 203     UINT ContextSize;
 204     LIST_ENTRY PendingIrpList[MAX_FUNCTIONS];
 205     LIST_ENTRY DatagramList;
 206     LIST_ENTRY PendingConnections;
 207 } AFD_FCB, *PAFD_FCB;
 208
 209 /* bind.c */
 210
 211 NTSTATUS WarmSocketForBind( PAFD_FCB FCB );
 212 NTSTATUS NTAPI
 213 AfdBindSocket(PDEVICE_OBJECT DeviceObject, PIRP Irp,
 214               PIO_STACK_LOCATION IrpSp);
 215
 216 /* connect.c */
 217
 218 NTSTATUS MakeSocketIntoConnection( PAFD_FCB FCB );
 219 NTSTATUS WarmSocketForConnection( PAFD_FCB FCB );
 220 NTSTATUS NTAPI
 221 AfdStreamSocketConnect(PDEVICE_OBJECT DeviceObject, PIRP Irp,
 222                        PIO_STACK_LOCATION IrpSp);
 223
 224 /* context.c */
 225
 226 NTSTATUS NTAPI
 227 AfdGetContext( PDEVICE_OBJECT DeviceObject, PIRP Irp,
 228                PIO_STACK_LOCATION IrpSp );
 229 NTSTATUS NTAPI
 230 AfdSetContext( PDEVICE_OBJECT DeviceObject, PIRP Irp,
 231                PIO_STACK_LOCATION IrpSp );
 232
 233 /* info.c */
 234
 235 NTSTATUS NTAPI
 236 AfdGetInfo( PDEVICE_OBJECT DeviceObject, PIRP Irp,
 237             PIO_STACK_LOCATION IrpSp );
 238
 239 NTSTATUS NTAPI
 240 AfdGetSockOrPeerName( PDEVICE_OBJECT DeviceObject, PIRP Irp,
 241                       PIO_STACK_LOCATION IrpSp, BOOLEAN Local );
 242
 243 /* listen.c */
 244 NTSTATUS AfdWaitForListen( PDEVICE_OBJECT DeviceObject, PIRP Irp,
 245                            PIO_STACK_LOCATION IrpSp );
 246
 247 NTSTATUS AfdListenSocket(PDEVICE_OBJECT DeviceObject, PIRP Irp,
 248                          PIO_STACK_LOCATION IrpSp);
 249
 250 NTSTATUS AfdAccept( PDEVICE_OBJECT DeviceObject, PIRP Irp,
 251                     PIO_STACK_LOCATION IrpSp );
 252
 253 /* lock.c */
 254
 255 PAFD_WSABUF LockBuffers( PAFD_WSABUF Buf, UINT Count,
 256                          PVOID AddressBuf, PINT AddressLen,
 257                          BOOLEAN Write, BOOLEAN LockAddress );
 258 VOID UnlockBuffers( PAFD_WSABUF Buf, UINT Count, BOOL Address );
 259 UINT SocketAcquireStateLock( PAFD_FCB FCB );
 260 NTSTATUS NTAPI UnlockAndMaybeComplete
 261 ( PAFD_FCB FCB, NTSTATUS Status, PIRP Irp,
 262   UINT Information,
 263   PIO_COMPLETION_ROUTINE Completion );
 264 VOID SocketStateUnlock( PAFD_FCB FCB );
 265 NTSTATUS LostSocket( PIRP Irp );
 266 PAFD_HANDLE LockHandles( PAFD_HANDLE HandleArray, UINT HandleCount );
 267 VOID UnlockHandles( PAFD_HANDLE HandleArray, UINT HandleCount );
 268 PVOID LockRequest( PIRP Irp, PIO_STACK_LOCATION IrpSp );
 269 VOID UnlockRequest( PIRP Irp, PIO_STACK_LOCATION IrpSp );
 270 VOID SocketCalloutEnter( PAFD_FCB FCB );
 271 VOID SocketCalloutLeave( PAFD_FCB FCB );
 272
 273 /* main.c */
 274
 275 VOID OskitDumpBuffer( PCHAR Buffer, UINT Len );
 276 NTSTATUS LeaveIrpUntilLater( PAFD_FCB FCB, PIRP Irp, UINT Function );
 277 VOID DestroySocket( PAFD_FCB FCB );
 278
 279 /* read.c */
 280
 281 NTSTATUS NTAPI ReceiveComplete
 282 ( PDEVICE_OBJECT DeviceObject,
 283   PIRP Irp,
 284   PVOID Context );
 285
 286 NTSTATUS NTAPI PacketSocketRecvComplete
 287 ( PDEVICE_OBJECT DeviceObject,
 288   PIRP Irp,
 289   PVOID Context );
 290
 291 NTSTATUS NTAPI
 292 AfdConnectedSocketReadData(PDEVICE_OBJECT DeviceObject, PIRP Irp,
 293                            PIO_STACK_LOCATION IrpSp, BOOLEAN Short);
 294 NTSTATUS NTAPI
 295 AfdPacketSocketReadData(PDEVICE_OBJECT DeviceObject, PIRP Irp,
 296                         PIO_STACK_LOCATION IrpSp );
 297
 298 /* select.c */
 299
 300 NTSTATUS NTAPI
 301 AfdSelect( PDEVICE_OBJECT DeviceObject, PIRP Irp,
 302            PIO_STACK_LOCATION IrpSp );
 303 NTSTATUS NTAPI
 304 AfdEventSelect( PDEVICE_OBJECT DeviceObject, PIRP Irp,
 305                 PIO_STACK_LOCATION IrpSp );
 306 NTSTATUS NTAPI
 307 AfdEnumEvents( PDEVICE_OBJECT DeviceObject, PIRP Irp,
 308                PIO_STACK_LOCATION IrpSp );
 309 VOID PollReeval( PAFD_DEVICE_EXTENSION DeviceObject, PFILE_OBJECT FileObject );
 310 VOID KillSelectsForFCB( PAFD_DEVICE_EXTENSION DeviceExt,
 311                         PFILE_OBJECT FileObject, BOOLEAN ExclusiveOnly );
 312
 313 /* tdi.c */
 314
 315 NTSTATUS TdiOpenAddressFile(
 316     PUNICODE_STRING DeviceName,
 317     PTRANSPORT_ADDRESS Name,
 318     PHANDLE AddressHandle,
 319     PFILE_OBJECT *AddressObject);
 320
 321 NTSTATUS TdiAssociateAddressFile(
 322   HANDLE AddressHandle,
 323   PFILE_OBJECT ConnectionObject);
 324
 325 NTSTATUS TdiListen
 326 ( PIRP *Irp,
 327   PFILE_OBJECT ConnectionObject,
 328   PTDI_CONNECTION_INFORMATION *RequestConnectionInfo,
 329   PTDI_CONNECTION_INFORMATION *ReturnConnectionInfo,
 330   PIO_STATUS_BLOCK Iosb,
 331   PIO_COMPLETION_ROUTINE  CompletionRoutine,
 332   PVOID CompletionContext);
 333
 334 NTSTATUS TdiReceive
 335 ( PIRP *Irp,
 336   PFILE_OBJECT ConnectionObject,
 337   USHORT Flags,
 338   PCHAR Buffer,
 339   UINT BufferLength,
 340   PIO_STATUS_BLOCK Iosb,
 341   PIO_COMPLETION_ROUTINE  CompletionRoutine,
 342   PVOID CompletionContext);
 343
 344 NTSTATUS TdiSend
 345 ( PIRP *Irp,
 346   PFILE_OBJECT ConnectionObject,
 347   USHORT Flags,
 348   PCHAR Buffer,
 349   UINT BufferLength,
 350   PIO_STATUS_BLOCK Iosb,
 351   PIO_COMPLETION_ROUTINE  CompletionRoutine,
 352   PVOID CompletionContext);
 353
 354 NTSTATUS TdiReceiveDatagram(
 355     PIRP *Irp,
 356     PFILE_OBJECT TransportObject,
 357     USHORT Flags,
 358     PCHAR Buffer,
 359     UINT BufferLength,
 360     PTDI_CONNECTION_INFORMATION From,
 361     PIO_STATUS_BLOCK Iosb,
 362     PIO_COMPLETION_ROUTINE CompletionRoutine,
 363     PVOID CompletionContext);
 364
 365 NTSTATUS TdiSendDatagram(
 366     PIRP *Irp,
 367     PFILE_OBJECT TransportObject,
 368     PCHAR Buffer,
 369     UINT BufferLength,
 370     PTDI_CONNECTION_INFORMATION To,
 371     PIO_STATUS_BLOCK Iosb,
 372     PIO_COMPLETION_ROUTINE CompletionRoutine,
 373     PVOID CompletionContext);
 374
 375 /* write.c */
 376
 377 NTSTATUS NTAPI
 378 AfdConnectedSocketWriteData(PDEVICE_OBJECT DeviceObject, PIRP Irp,
 379                             PIO_STACK_LOCATION IrpSp, BOOLEAN Short);
 380 NTSTATUS NTAPI
 381 AfdPacketSocketWriteData(PDEVICE_OBJECT DeviceObject, PIRP Irp,
 382                          PIO_STACK_LOCATION IrpSp);
 383
 384 #endif/*_AFD_H*/