NdisInterlockedRemoveHeadList (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.

NdisInterlockedRemoveHeadList removes an entry, usually a packet, from the head of a doubly linked list so that access to the list is synchronized in a multiprocessor-safe way.

Syntax

PLIST_ENTRY NdisInterlockedRemoveHeadList(
  _In_ PLIST_ENTRY     ListHead,
  _In_ PNDIS_SPIN_LOCK SpinLock
);

Parameters

• ListHead [in]
  Pointer to the head of the doubly linked list from which an entry is to be removed.

• SpinLock [in]
  Pointer to a caller-supplied spin lock, used to synchronize access to the list.

Return value

NdisInterlockedRemoveHeadList returns a pointer to the dequeued entry. If the list was empty, it returns NULL.

Remarks

Before calling any NdisInterlocked..List function, 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.

Before calling NdisInterlockedRemoveHeadList, entries are queued with one or more calls to the NdisInterlockedInsert..List functions.

The caller-supplied spin lock prevents any other function from accessing the driver's internal queue while NdisInterlockedRemoveHeadList is removing an entry, even when the driver is running on a multiprocessor machine.

NdisInterlockedRemoveHeadList 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 NdisInterlockedRemoveHeadList 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

See also

NdisAllocateSpinLock

NdisInitializeListHead

NdisInterlockedInsertHeadList

NdisInterlockedInsertTailList

Send comments about this topic to Microsoft