inline.h

Go to the documentation of this file.

/*
 * PROJECT:     ReactOS Storport Driver
 * LICENSE:     GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+)
 * PURPOSE:     Storport driver - inlined helper utilities
 * COPYRIGHT:   Copyright 2024 Wu Haotian (rigoligo03@gmail.com)
 */
 
#pragma once
 
#include "precomp.h"
#include "storport.h"
 
FORCEINLINE
VOID
StorpCompleteRequest(
    _In_ PIRP Irp,
    _In_ UCHAR SrbStatus,
    _In_ NTSTATUS IrpStatus)
{
    IoGetCurrentIrpStackLocation(Irp)->Parameters.Scsi.Srb->SrbStatus = SrbStatus;
    Irp->IoStatus.Status = IrpStatus;
    Irp->IoStatus.Information = 0;
 
    IoCompleteRequest(Irp, IO_NO_INCREMENT);
}
 
FORCEINLINE
PFDO_DEVICE_EXTENSION
StorpGetMiniportFdo(
    _In_ PVOID HwDeviceExtension
)
{
    PMINIPORT_DEVICE_EXTENSION MiniportExtension;
 
    NT_ASSERT(HwDeviceExtension);
 
    MiniportExtension = CONTAINING_RECORD(HwDeviceExtension,
                                          MINIPORT_DEVICE_EXTENSION,
                                          HwDeviceExtension);
 
    return MiniportExtension->Miniport->DeviceExtension;
}
 
/*
  Convenient counted linked list manipulation. In ReactOS Storport there are linked lists whose
  item count is kept alongside the list. This function provides a cleaner implementation to
  reduce complexity in functional code.
*/
 
FORCEINLINE
ULONG
StorpInterlockedInsertHeadListCounted(
    _In_ PKSPIN_LOCK SpinLock,
    _In_ PLIST_ENTRY ListHead,
    _In_ PLIST_ENTRY Entry,
    _In_ PULONG Counter
)
{
    KLOCK_QUEUE_HANDLE LockHandle;
 
    KeAcquireInStackQueuedSpinLock(SpinLock, &LockHandle);
    InsertHeadList(ListHead, Entry);
    ++(*Counter);
    KeReleaseInStackQueuedSpinLock(&LockHandle);
 
    return (*Counter);
}
 
FORCEINLINE
ULONG
StorpInterlockedInsertTailListCounted(
    _In_ PKSPIN_LOCK SpinLock,
    _In_ PLIST_ENTRY ListHead,
    _In_ PLIST_ENTRY Entry,
    _In_ PULONG Counter
)
{
    KLOCK_QUEUE_HANDLE LockHandle;
 
    KeAcquireInStackQueuedSpinLock(SpinLock, &LockHandle);
    InsertTailList(ListHead, Entry);
    ++(*Counter);
    KeReleaseInStackQueuedSpinLock(&LockHandle);
 
    return (*Counter);
}
 
FORCEINLINE
BOOLEAN
StorpInterlockedRemoveEntryListCounted(
    _In_ PKSPIN_LOCK SpinLock,
    _In_ PLIST_ENTRY Entry,
    _In_ PULONG Counter)
{
    KLOCK_QUEUE_HANDLE LockHandle;
    BOOLEAN Empty;
 
    KeAcquireInStackQueuedSpinLock(SpinLock, &LockHandle);
    Empty = RemoveEntryList(Entry);
    --(*Counter);
 
    NT_ASSERT(Empty == (*Counter == 0));
 
    KeReleaseInStackQueuedSpinLock(&LockHandle);
 
    return Empty;
}
 
FORCEINLINE
PLIST_ENTRY
StorpInterlockedRemoveHeadListCounted(
    _In_ PKSPIN_LOCK SpinLock,
    _In_ PLIST_ENTRY ListHead,
    _In_ PULONG Counter)
{
    KLOCK_QUEUE_HANDLE LockHandle;
    PLIST_ENTRY Entry;
 
    KeAcquireInStackQueuedSpinLock(SpinLock, &LockHandle);
 
    NT_ASSERT(IsListEmpty(ListHead) == (*Counter == 0));
 
    Entry = RemoveHeadList(ListHead);
    --(*Counter);
    KeReleaseInStackQueuedSpinLock(&LockHandle);
 
    return Entry;
}
 
FORCEINLINE
PLIST_ENTRY
StorpInterlockedRemoveTailListCounted(
    _In_ PKSPIN_LOCK SpinLock,
    _In_ PLIST_ENTRY ListHead,
    _In_ PULONG Counter)
{
    KLOCK_QUEUE_HANDLE LockHandle;
    PLIST_ENTRY Entry;
 
    KeAcquireInStackQueuedSpinLock(SpinLock, &LockHandle);
 
    NT_ASSERT(IsListEmpty(ListHead) == (*Counter == 0));
 
    Entry = RemoveTailList(ListHead);
    --(*Counter);
    KeReleaseInStackQueuedSpinLock(&LockHandle);
 
    return Entry;
}
 
 
 
#ifdef DBG
FORCEINLINE
VOID
StorpCheckFlowControl(
    _In_ PFDO_DEVICE_EXTENSION FdoExtension)
{
    KLOCK_QUEUE_HANDLE LockHandle;
    PPDO_DEVICE_EXTENSION PdoExtension;
    PFDO_IO_FLOW_CONTROL FdoFlowControl;
    PPDO_IO_FLOW_CONTROL PdoFlowControl;
    PLIST_ENTRY PdoEntry;
    ULONG PdoOutstandingSum = 0;
    ULONG PdoStrongOrderedSum = 0;
 
    FdoFlowControl = &FdoExtension->FlowControl;
 
    KeAcquireInStackQueuedSpinLock(&FdoExtension->PdoListLock, &LockHandle);
    PdoEntry = FdoExtension->PdoListHead.Flink;
 
    while (PdoEntry != &FdoExtension->PdoListHead)
    {
        /* Obtain PDO extension and flow control */
        PdoExtension = CONTAINING_RECORD(PdoEntry, PDO_DEVICE_EXTENSION, PdoListEntry);
        PdoFlowControl = &PdoExtension->FlowControl;
 
        /* Accumulate important values and compare to FDO record */
        PdoOutstandingSum += PdoFlowControl->OutstandingRequestCount;
        PdoStrongOrderedSum += PdoFlowControl->StrongOrderedCount;
 
        /* Next element */
        PdoEntry = PdoEntry->Flink;
    }
 
    UNREFERENCED_PARAMETER(PdoStrongOrderedSum); /* Don't know what to do with it */
 
    /* Compare */
    NT_ASSERT(PdoOutstandingSum == FdoFlowControl->OutstandingRequestCount);
 
    KeReleaseInStackQueuedSpinLock(&LockHandle);
}
#else
#define StorpCheckFlowControl(...)
#endif
 
 
// FORCEINLINE
// VOID
// StorpDumpRequest(
//     _In_ PQUEUED_REQUEST_REFERENCE RequestReference)
// {
//     PPDO_DEVICE_EXTENSION PdoExtension = RequestReference->PdoExtension;
//     CHAR HexBuf[50] = {0};
 
//     RequestReference->SpecialRequestId = InterlockedIncrement(&PdoExtension->SpecialRequestCounter);
 
//     DPRINT1("\n\n");
//     DPRINT1("Storport SPECIAL REQUEST %d Before Issued\n", RequestReference->SpecialRequestId);
//     DPRINT1("Bus:Target:Lun (%d:%d:%d) CDB %d\n",
//             PdoExtension->Bus,
//             PdoExtension->Target,
//             PdoExtension->Lun,
//             RequestReference->Srb->CdbLength);
//     for (int i = 0; i < RequestReference->Srb->CdbLength; i++)
//     {
//         CHAR Tmp[3];
//         sprintf(Tmp, "%02X", RequestReference->Srb->Cdb[i]);
//         strcat(HexBuf, Tmp);
//         if (i == 7 && RequestReference->Srb->CdbLength != 7)
//             strcat(HexBuf, "-");
//         else
//             strcat(HexBuf, " ");
//     }
//     DPRINT1("CDB: %s\n\n", HexBuf);
// }
 
 
// FORCEINLINE
// VOID
// StorpDumpRequestResponse(
//     _In_ PQUEUED_REQUEST_REFERENCE RequestReference)
// {
//     PPDO_DEVICE_EXTENSION PdoExtension = RequestReference->PdoExtension;
//     CHAR HexBuf[50] = {0};
//     ULONG BytesLeft = RequestReference->Srb->DataTransferLength;
//     ULONG Offset = 0;
    
//     DPRINT1("\n\n");
//     DPRINT1("Storport SPECIAL REQUEST %d Completion\n\n", RequestReference->SpecialRequestId);
//     DPRINT1("Bus:Target:Lun (%d:%d:%d) CDB %d (%02X) ReturnLength %d\n",
//             PdoExtension->Bus,
//             PdoExtension->Target,
//             PdoExtension->Lun,
//             RequestReference->Srb->CdbLength,
//             RequestReference->Srb->Cdb[0],
//             BytesLeft);
 
//     DPRINT1("Returned Data:\n");
//     while (BytesLeft)
//     {
//         /* Print in 16 byte groups */
//         ULONG BytesToPrint = (BytesLeft > 16) ? 16 : BytesLeft;
//         HexBuf[0] = '\0';
//         for (int i = 0; i < BytesToPrint; i++)
//         {
//             CHAR Tmp[3];
//             sprintf(Tmp, "%02X", ((PUCHAR)RequestReference->Srb->DataBuffer)[Offset + i]);
//             strcat(HexBuf, Tmp);
//             if (i == 7 && RequestReference->Srb->CdbLength != 7)
//                 strcat(HexBuf, "-");
//             else
//                 strcat(HexBuf, " ");
//         }
//         DPRINT1("%s\n", HexBuf);
//         BytesLeft -= BytesToPrint;
//         Offset += BytesToPrint;
//     }
//     DPRINT1("\n\n");
// }