NdisInterlockedInsertTailList (NDIS 5.1) function
Note NDIS 5. x has been deprecated and is superseded by NDIS 6. x. For new NDIS driver development, see Network Drivers Starting with Windows Vista. For information about porting NDIS 5. x drivers to NDIS 6. x, see Porting NDIS 5.x Drivers to NDIS 6.0.
NdisInterlockedInsertTailList inserts an entry, usually a packet, at the tail of a doubly linked list so that access to the list is synchronized in a multiprocessor-safe way.
Syntax
PLIST_ENTRY NdisInterlockedInsertTailList(
_In_ PLIST_ENTRY ListHead,
_In_ PLIST_ENTRY ListEntry,
_In_ PNDIS_SPIN_LOCK SpinLock
);
Parameters
ListHead [in]
Pointer to the head of the doubly linked list into which an entry is to be inserted.ListEntry [in]
Pointer to the entry to be inserted at the end of the list.SpinLock [in]
Pointer to a caller-supplied spin lock, used to synchronize access to the list.
Return value
NdisInterlockedInsertTailList returns a pointer to the entry that was at the tail of the queue before the given entry was inserted. If the queue was empty, it returns NULL.
Remarks
Before calling NdisInterlockedInsertTailList, a driver must initialize the variable at ListHead with NdisInitializeListHead and the variable at SpinLock with NdisAllocateSpinLock. The driver also must provide resident storage for these variables and for its internal queue.
The caller-supplied spin lock prevents any other function from accessing the driver's internal queue while NdisInterlockedInsertTailList is inserting the given entry, even when the driver is running on a multiprocessor machine.
NdisInterlockedInsertTailList raises IRQL to DISPATCH_LEVEL when it acquires the given spin lock and restores the original IRQL before it returns control. Consequently, any driver function that calls NdisInterlockedInsertTailList cannot be pageable code.
To convert a returned value back to the address of the inserted entry, a driver can use the CONTAINING_RECORD macro.
Requirements
Target platform |
Universal |
Version |
|
Header |
Ndis.h (include Ndis.h) |
Library |
Ndis.lib |
IRQL |
<= DISPATCH_LEVEL |
See also