inline.h File Reference

#include "precomp.h"
#include "storport.h"

Include dependency graph for inline.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	StorpCheckFlowControl(...)

Functions
FORCEINLINE VOID	StorpCompleteRequest (_In_ PIRP Irp, _In_ UCHAR SrbStatus, _In_ NTSTATUS IrpStatus)
	Completes a request with specified SRB status and IRP status.
FORCEINLINE PFDO_DEVICE_EXTENSION	StorpGetMiniportFdo (_In_ PVOID HwDeviceExtension)
	For use in Storport API exposed to miniports; gets FDO extension with HwDeviceExtension.
FORCEINLINE ULONG	StorpInterlockedInsertHeadListCounted (_In_ PKSPIN_LOCK SpinLock, _In_ PLIST_ENTRY ListHead, _In_ PLIST_ENTRY Entry, _In_ PULONG Counter)
	InsertHeadList and increment element counter with a corresponding spin lock held.
FORCEINLINE ULONG	StorpInterlockedInsertTailListCounted (_In_ PKSPIN_LOCK SpinLock, _In_ PLIST_ENTRY ListHead, _In_ PLIST_ENTRY Entry, _In_ PULONG Counter)
	InsertTailList and increment element counter with a corresponding spin lock held.
FORCEINLINE BOOLEAN	StorpInterlockedRemoveEntryListCounted (_In_ PKSPIN_LOCK SpinLock, _In_ PLIST_ENTRY Entry, _In_ PULONG Counter)
	RemoveEntryList and decrement element counter with a corresponding spin lock held.
FORCEINLINE PLIST_ENTRY	StorpInterlockedRemoveHeadListCounted (_In_ PKSPIN_LOCK SpinLock, _In_ PLIST_ENTRY ListHead, _In_ PULONG Counter)
	RemoveHeadList and decrement element counter with a corresponding spin lock held.
FORCEINLINE PLIST_ENTRY	StorpInterlockedRemoveTailListCounted (_In_ PKSPIN_LOCK SpinLock, _In_ PLIST_ENTRY ListHead, _In_ PULONG Counter)
	RemoveTailList and decrement element counter with a corresponding spin lock held.

Macro Definition Documentation

StorpCheckFlowControl

#define StorpCheckFlowControl

(

...

)

Definition at line 252 of file inline.h.

Function Documentation

StorpCompleteRequest()

FORCEINLINE VOID StorpCompleteRequest	(	_In_ PIRP	Irp,
		_In_ UCHAR	SrbStatus,
		_In_ NTSTATUS	IrpStatus
	)

Completes a request with specified SRB status and IRP status.

Definition at line 19 of file inline.h.

{
    IoGetCurrentIrpStackLocation(Irp)->Parameters.Scsi.Srb->SrbStatus = SrbStatus;
    Irp->IoStatus.Status = IrpStatus;
    Irp->IoStatus.Information = 0;
 
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
}

Referenced by PortFlushStarvedRequests(), PortPdoScsi(), PortPdoStarveRequest(), and PortStarvedCsqCompleteCanceledIrp().

StorpGetMiniportFdo()

FORCEINLINE PFDO_DEVICE_EXTENSION StorpGetMiniportFdo

(

_In_ PVOID

HwDeviceExtension

)

For use in Storport API exposed to miniports; gets FDO extension with HwDeviceExtension.

Parameters

HwDeviceExtension

HwDeviceExtension parameter of Storport API.

Returns

PFDO_DEVICE_EXTENSION FDO Device extension.

Definition at line 39 of file inline.h.

{
    PMINIPORT_DEVICE_EXTENSION MiniportExtension;
 
    NT_ASSERT(HwDeviceExtension);
 
    MiniportExtension = CONTAINING_RECORD(HwDeviceExtension,
                                          MINIPORT_DEVICE_EXTENSION,
                                          HwDeviceExtension);
 
    return MiniportExtension->Miniport->DeviceExtension;
}

Referenced by StorPortDeviceBusy(), StorPortDeviceReady(), and StorPortSetDeviceQueueDepth().

StorpInterlockedInsertHeadListCounted()

FORCEINLINE ULONG StorpInterlockedInsertHeadListCounted	(	_In_ PKSPIN_LOCK	SpinLock,
		_In_ PLIST_ENTRY	ListHead,
		_In_ PLIST_ENTRY	Entry,
		_In_ PULONG	Counter
	)

InsertHeadList and increment element counter with a corresponding spin lock held.

Parameters

SpinLock	Spin lock for interlocked exclusive access.
ListHead	List head of the list.
Entry	List entry to be inserted.
Counter	Pointer to the list element counter ULONG value.

Returns

ULONG Number of items in the list after insertion.

Definition at line 71 of file inline.h.

{
    KLOCK_QUEUE_HANDLE LockHandle;
 
    KeAcquireInStackQueuedSpinLock(SpinLock, &LockHandle);
    InsertHeadList(ListHead, Entry);
    ++(*Counter);
    KeReleaseInStackQueuedSpinLock(&LockHandle);
 
    return (*Counter);
}

Referenced by PortAddDevice(), PortCreatePdo(), and StorPortExtendedFunction().

StorpInterlockedInsertTailListCounted()

FORCEINLINE ULONG StorpInterlockedInsertTailListCounted	(	_In_ PKSPIN_LOCK	SpinLock,
		_In_ PLIST_ENTRY	ListHead,
		_In_ PLIST_ENTRY	Entry,
		_In_ PULONG	Counter
	)

InsertTailList and increment element counter with a corresponding spin lock held.

Parameters

SpinLock	Spin lock for interlocked exclusive access.
ListHead	List head of the list.
Entry	List entry to be inserted.
Counter	Pointer to the list element counter ULONG value.

Returns

ULONG Number of items in the list after insertion.

Definition at line 99 of file inline.h.

{
    KLOCK_QUEUE_HANDLE LockHandle;
 
    KeAcquireInStackQueuedSpinLock(SpinLock, &LockHandle);
    InsertTailList(ListHead, Entry);
    ++(*Counter);
    KeReleaseInStackQueuedSpinLock(&LockHandle);
 
    return (*Counter);
}

StorpInterlockedRemoveEntryListCounted()

FORCEINLINE BOOLEAN StorpInterlockedRemoveEntryListCounted	(	_In_ PKSPIN_LOCK	SpinLock,
		_In_ PLIST_ENTRY	Entry,
		_In_ PULONG	Counter
	)

RemoveEntryList and decrement element counter with a corresponding spin lock held.

Parameters

SpinLock	Spin lock for interlocked exclusive access.
Entry	List entry to be removed.
Counter	Pointer to the list element counter ULONG value.

Returns

BOOLEAN Whether the list is empty after the removal.

Definition at line 126 of file inline.h.

{
    KLOCK_QUEUE_HANDLE LockHandle;
    BOOLEAN Empty;
 
    KeAcquireInStackQueuedSpinLock(SpinLock, &LockHandle);
    Empty = RemoveEntryList(Entry);
    --(*Counter);
 
    NT_ASSERT(Empty == (*Counter == 0));
 
    KeReleaseInStackQueuedSpinLock(&LockHandle);
 
    return Empty;
}

Referenced by PortDeletePdo().

StorpInterlockedRemoveHeadListCounted()

FORCEINLINE PLIST_ENTRY StorpInterlockedRemoveHeadListCounted	(	_In_ PKSPIN_LOCK	SpinLock,
		_In_ PLIST_ENTRY	ListHead,
		_In_ PULONG	Counter
	)

RemoveHeadList and decrement element counter with a corresponding spin lock held.

Parameters

SpinLock	Spin lock for interlocked exclusive access.
ListHead	List head to take an entry from.
Counter	Pointer to the list element counter ULONG value.

Returns

PLIST_ENTRY The element taken from the list.

Definition at line 155 of file inline.h.

{
    KLOCK_QUEUE_HANDLE LockHandle;
    PLIST_ENTRY Entry;
 
    KeAcquireInStackQueuedSpinLock(SpinLock, &LockHandle);
 
    NT_ASSERT(IsListEmpty(ListHead) == (*Counter == 0));
 
    Entry = RemoveHeadList(ListHead);
    --(*Counter);
    KeReleaseInStackQueuedSpinLock(&LockHandle);
 
    return Entry;
}

StorpInterlockedRemoveTailListCounted()

FORCEINLINE PLIST_ENTRY StorpInterlockedRemoveTailListCounted	(	_In_ PKSPIN_LOCK	SpinLock,
		_In_ PLIST_ENTRY	ListHead,
		_In_ PULONG	Counter
	)

RemoveTailList and decrement element counter with a corresponding spin lock held.

Parameters

SpinLock	Spin lock for interlocked exclusive access.
ListHead	List head to take an entry from.
Counter	Pointer to the list element counter ULONG value.

Returns

PLIST_ENTRY The element taken from the list.

Definition at line 184 of file inline.h.

{
    KLOCK_QUEUE_HANDLE LockHandle;
    PLIST_ENTRY Entry;
 
    KeAcquireInStackQueuedSpinLock(SpinLock, &LockHandle);
 
    NT_ASSERT(IsListEmpty(ListHead) == (*Counter == 0));
 
    Entry = RemoveTailList(ListHead);
    --(*Counter);
    KeReleaseInStackQueuedSpinLock(&LockHandle);
 
    return Entry;
}