# _OPEN_INSTANCE Struct Reference
[NPF structures and definitions]

Contains the state of a running instance of the NPF driver. More...

`#include <Packet.h>`

## Data Fields

PDEVICE_EXTENSION | DeviceExtension
NDIS_HANDLE | AdapterHandle
| NDIS idetifier of the adapter used by this instance.
UINT | Medium
NDIS_HANDLE | PacketPool
| Pool of NDIS_PACKET structures used to transfer the packets from and to the NIC driver.
KSPIN_LOCK | RequestSpinLock
| SpinLock used to synchronize the OID requests.
LIST_ENTRY | RequestList
| List of pending OID requests.
LIST_ENTRY | ResetIrpList
| List of pending adapter reset requests.
INTERNAL_REQUEST | Requests [MAX_REQUESTS]
| Array of structures that wrap every single OID request.
PMDL | BufferMdl
| Pointer to a Memory descriptor list (MDL) that maps the circular buffer's memory.
PKEVENT | ReadEvent
| Pointer to the event on which the read calls on this instance must wait.
PUCHAR | bpfprogram
UINT | MinToCopy
LARGE_INTEGER | TimeOut
int | mode
| Working mode of the driver. See PacketSetMode() for details.
LARGE_INTEGER | Nbytes
| Amount of bytes accepted by the filter when this instance is in statistical mode.
LARGE_INTEGER | Npackets
| Number of packets accepted by the filter when this instance is in statistical mode.
NDIS_SPIN_LOCK | CountersLock
| SpinLock that protects the statistical mode counters.
UINT | Nwrites
ULONG | Multiple_Write_Counter
| Counts the number of times a single write has already physically repeated.
NDIS_EVENT | WriteEvent
| Event used to synchronize the multiple write process.
BOOLEAN | WriteInProgress
NDIS_SPIN_LOCK | WriteLock
| SpinLock that protects the WriteInProgress variable.
NDIS_EVENT | NdisRequestEvent
| Event used to synchronize I/O requests with the callback structure of NDIS.
BOOLEAN | SkipSentPackets
| True if this instance should not capture back the packets that it transmits.
NDIS_STATUS | IOStatus
| Maintains the status of and OID request call, that will be passed to the application.
HANDLE | DumpFileHandle
| Handle of the file used in dump mode.
PFILE_OBJECT | DumpFileObject
| Pointer to the object of the file used in dump mode.
PKTHREAD | DumpThreadObject
| Pointer to the object of the thread used in dump mode.
HANDLE | DumpThreadHandle
| Handle of the thread created by dump mode to asynchronously move the buffer to disk.
NDIS_EVENT | DumpEvent
| Event used to synchronize the dump thread with the tap when the instance is in dump mode.
LARGE_INTEGER | DumpOffset
| Current offset in the dump file.
UNICODE_STRING | DumpFileName
| String containing the name of the dump file.
UINT | MaxDumpBytes
UINT | MaxDumpPacks
BOOLEAN | DumpLimitReached
NDIS_SPIN_LOCK | MachineLock
| SpinLock that protects the BPF filter and the TME engine, if in use.
UINT | MaxFrameSize
CpuPrivateData | CpuData [sizeof(KAFFINITY)*8]
| Pool of kernel buffer structures, one for each CPU.
ULONG | ReaderSN
| Sequence number of the next packet to be read from the pool of kernel buffers.
ULONG | WriterSN
ULONG | Size
| Size of each kernel buffer contained in the CpuData field.
ULONG | AdapterHandleUsageCounter
NDIS_SPIN_LOCK | AdapterHandleLock
ULONG | AdapterBindingStatus
| Specifies if NPF is still bound to the adapter used by this instance, it's unbinding or it's not bound.
NDIS_EVENT | NdisOpenCloseCompleteEvent
NDIS_EVENT | NdisWriteCompleteEvent
| Event that is signalled when all the packets have been successfully sent by NdisSend (and corresponfing sendComplete has been called).
NTSTATUS | OpenCloseStatus
ULONG | TransmitPendingPackets
| Specifies the number of packets that are pending to be transmitted, i.e. have been submitted to NdisSendXXX but the SendComplete has not been called yet.
ULONG | NumPendingIrps
BOOLEAN | ClosePending
NDIS_SPIN_LOCK | OpenInUseLock

## Detailed Description

Contains the state of a running instance of the NPF driver.

This is the most important structure of NPF: it is used by almost all the functions of the driver. An _OPEN_INSTANCE structure is associated with every user-level session, allowing concurrent access to the driver.

Definition at line 240 of file Packet.h.

## Field Documentation

ULONG AdapterBindingStatus

Specifies if NPF is still bound to the adapter used by this instance, it's unbinding or it's not bound.

Definition at line 315 of file Packet.h.

NDIS_HANDLE AdapterHandle

NDIS idetifier of the adapter used by this instance.

Definition at line 244 of file Packet.h.

NDIS_SPIN_LOCK AdapterHandleLock

Definition at line 314 of file Packet.h.

ULONG AdapterHandleUsageCounter

Definition at line 313 of file Packet.h.

PUCHAR bpfprogram

Pointer to the filtering pseudo-code associated with current instance of the driver. This code is used only in particular situations (for example when the packet received from the NIC driver is stored in two non-consecutive buffers. In normal situations the filtering routine created by the JIT compiler and pointed by the next field is used. See NPF driver internals manual for details on the filtering process.

Definition at line 254 of file Packet.h.

PMDL BufferMdl

Pointer to a Memory descriptor list (MDL) that maps the circular buffer's memory.

Definition at line 252 of file Packet.h.

BOOLEAN ClosePending

Definition at line 322 of file Packet.h.

NDIS_SPIN_LOCK CountersLock

SpinLock that protects the statistical mode counters.

Definition at line 271 of file Packet.h.

CpuPrivateData CpuData[sizeof(KAFFINITY)*8]

Pool of kernel buffer structures, one for each CPU.

Definition at line 308 of file Packet.h.

PDEVICE_EXTENSION DeviceExtension

Pointer to the _DEVICE_EXTENSION structure of the device on which the instance is bound.

Definition at line 242 of file Packet.h.

NDIS_EVENT DumpEvent

Event used to synchronize the dump thread with the tap when the instance is in dump mode.

Definition at line 286 of file Packet.h.

HANDLE DumpFileHandle

Handle of the file used in dump mode.

Definition at line 282 of file Packet.h.

UNICODE_STRING DumpFileName

String containing the name of the dump file.

Definition at line 288 of file Packet.h.

PFILE_OBJECT DumpFileObject

Pointer to the object of the file used in dump mode.

Definition at line 283 of file Packet.h.

BOOLEAN DumpLimitReached

TRUE if the maximum dimension of the dump file (MaxDumpBytes or MaxDumpPacks) is reached.

Definition at line 294 of file Packet.h.

LARGE_INTEGER DumpOffset

Current offset in the dump file.

Definition at line 287 of file Packet.h.

HANDLE DumpThreadHandle

Handle of the thread created by dump mode to asynchronously move the buffer to disk.

Definition at line 285 of file Packet.h.

PKTHREAD DumpThreadObject

Pointer to the object of the thread used in dump mode.

Definition at line 284 of file Packet.h.

NDIS_STATUS IOStatus

Maintains the status of and OID request call, that will be passed to the application.

Definition at line 281 of file Packet.h.

NDIS_SPIN_LOCK MachineLock

SpinLock that protects the BPF filter and the TME engine, if in use.

Definition at line 301 of file Packet.h.

UINT MaxDumpBytes

Maximum dimension in bytes of the dump file. If the dump file reaches this size it will be closed. A value of 0 means unlimited size.

Definition at line 289 of file Packet.h.

UINT MaxDumpPacks

Maximum number of packets that will be saved in the dump file. If this number of packets is reached the dump will be closed. A value of 0 means unlimited number of packets.

Definition at line 291 of file Packet.h.

UINT MaxFrameSize

Maximum frame size that the underlying MAC acceptes. Used to perform a check on the size of the frames sent with NPF_Write() or NPF_BufferedWrite().

Definition at line 302 of file Packet.h.

UINT Medium

Type of physical medium the underlying NDIS driver uses. See the documentation of NdisOpenAdapter in the MS DDK for details.

Definition at line 245 of file Packet.h.

UINT MinToCopy

Minimum amount of data in the circular buffer that unlocks a read. Set with the BIOCSMINTOCOPY IOCTL.

Definition at line 263 of file Packet.h.

int mode

Working mode of the driver. See PacketSetMode() for details.

Definition at line 268 of file Packet.h.

ULONG Multiple_Write_Counter

Counts the number of times a single write has already physically repeated.

Definition at line 274 of file Packet.h.

LARGE_INTEGER Nbytes

Amount of bytes accepted by the filter when this instance is in statistical mode.

Definition at line 269 of file Packet.h.

NDIS_EVENT NdisOpenCloseCompleteEvent

Definition at line 317 of file Packet.h.

NDIS_EVENT NdisRequestEvent

Event used to synchronize I/O requests with the callback structure of NDIS.

Definition at line 279 of file Packet.h.

NDIS_EVENT NdisWriteCompleteEvent

Event that is signalled when all the packets have been successfully sent by NdisSend (and corresponfing sendComplete has been called).

Definition at line 318 of file Packet.h.

LARGE_INTEGER Npackets

Number of packets accepted by the filter when this instance is in statistical mode.

Definition at line 270 of file Packet.h.

ULONG NumPendingIrps

Definition at line 321 of file Packet.h.

UINT Nwrites

Number of times a single write must be physically repeated. See NPF driver internals manual for an explanation

Definition at line 272 of file Packet.h.

NTSTATUS OpenCloseStatus

Definition at line 319 of file Packet.h.

NDIS_SPIN_LOCK OpenInUseLock

Definition at line 323 of file Packet.h.

NDIS_HANDLE PacketPool

Pool of NDIS_PACKET structures used to transfer the packets from and to the NIC driver.

Definition at line 247 of file Packet.h.

ULONG ReaderSN

Sequence number of the next packet to be read from the pool of kernel buffers.

Definition at line 309 of file Packet.h.

PKEVENT ReadEvent

Pointer to the event on which the read calls on this instance must wait.

Definition at line 253 of file Packet.h.

LIST_ENTRY RequestList

List of pending OID requests.

Definition at line 249 of file Packet.h.

INTERNAL_REQUEST Requests[MAX_REQUESTS]

Array of structures that wrap every single OID request.

Definition at line 251 of file Packet.h.

KSPIN_LOCK RequestSpinLock

SpinLock used to synchronize the OID requests.

Definition at line 248 of file Packet.h.

LIST_ENTRY ResetIrpList

List of pending adapter reset requests.

Definition at line 250 of file Packet.h.

ULONG Size

Size of each kernel buffer contained in the CpuData field.

Definition at line 312 of file Packet.h.

BOOLEAN SkipSentPackets

True if this instance should not capture back the packets that it transmits.

Definition at line 280 of file Packet.h.

LARGE_INTEGER TimeOut

Timeout after which a read is released, also if the amount of data in the buffer is less than MinToCopy. Set with the BIOCSRTIMEOUT IOCTL.

Definition at line 265 of file Packet.h.

ULONG TransmitPendingPackets

Specifies the number of packets that are pending to be transmitted, i.e. have been submitted to NdisSendXXX but the SendComplete has not been called yet.

Definition at line 320 of file Packet.h.

NDIS_EVENT WriteEvent

Event used to synchronize the multiple write process.

Definition at line 275 of file Packet.h.

BOOLEAN WriteInProgress

True if a write is currently in progress. NPF currently allows a single wite on the same open instance.

Definition at line 276 of file Packet.h.

NDIS_SPIN_LOCK WriteLock

SpinLock that protects the WriteInProgress variable.

Definition at line 278 of file Packet.h.

ULONG WriterSN

Sequence number of the next packet to be written in the pool of kernel buffers. These two sequence numbers are unique for each capture instance.

Definition at line 310 of file Packet.h.

The documentation for this struct was generated from the following file:

- Packet.h

documentation. Copyright (c) 2002-2005 Politecnico di Torino. Copyright (c) 2005-2009 CACE Technologies. All rights reserved.