util.h

/*
 * Copyright (c) 2019 SUSE LLC
 *
 * Licensed under LGPL-2.1 (see LICENSE)
 */

#ifndef UTIL_H
#define UTIL_H 1

#include "common.h"
#include "scsi_driver_extensions.h"

VOID
DrainDeviceQueue(_In_ PWNBD_DISK_DEVICE Device,
                 _In_ BOOLEAN SubmittedRequests,
                 _In_ BOOLEAN CheckStaleConn);

VOID
CompleteRequest(_In_ PWNBD_DISK_DEVICE Device,
                _In_ PSRB_QUEUE_ELEMENT Element,
                _In_ BOOLEAN FreeElement);
BOOLEAN
HasPendingAsyncRequests(_In_ PWNBD_DISK_DEVICE Device);

VOID
WnbdCleanupAllDevices(_In_ PWNBD_EXTENSION DeviceExtension);

// Increments the device rundown protection reference count, preventing
// it from being cleaned up.
BOOLEAN
WnbdAcquireDevice(_In_ PWNBD_DISK_DEVICE Device);
// Decrements the reference count. All "WnbdAcquireDevice" calls must
// be paired with a "WnbdReleaseDevice" call.
VOID
WnbdReleaseDevice(_In_ PWNBD_DISK_DEVICE Device);
// Signals the device cleanup thread, setting the "*TerminateDevice" flags
// to avoid further processing.
VOID
WnbdDisconnectAsync(PWNBD_DISK_DEVICE Device);
// The specified device must be acquired. It will be released by
// WnbdDisconnectSync.
VOID
WnbdDisconnectSync(_In_ PWNBD_DISK_DEVICE Device);

// Device returned by WnbdFindDevice* functions must be subsequently
// relased using WnbdReleaseDevice, if "Acquire" is set.
// Unacquired device pointers must not be dereferenced.
PWNBD_DISK_DEVICE
WnbdFindDeviceByAddr(
    _In_ PWNBD_EXTENSION DeviceExtension,
    _In_ UCHAR PathId,
    _In_ UCHAR TargetId,
    _In_ UCHAR Lun,
    _In_ BOOLEAN Acquire);
PWNBD_DISK_DEVICE
WnbdFindDeviceByConnId(
    _In_ PWNBD_EXTENSION DeviceExtension,
    _In_ UINT64 ConnectionId,
    _In_ BOOLEAN Acquire);
PWNBD_DISK_DEVICE
WnbdFindDeviceByInstanceName(
    _In_ PWNBD_EXTENSION DeviceExtension,
    _In_ PCHAR InstanceName,
    _In_ BOOLEAN Acquire);

BOOLEAN
IsReadSrb(_In_ PVOID Srb);
BOOLEAN
IsPerResInSrb(_In_ PVOID Srb);

BOOLEAN ValidateScsiRequest(
    _In_ PWNBD_DISK_DEVICE Device,
    _In_ PSRB_QUEUE_ELEMENT Element);

#define LIST_FORALL_SAFE(_headPtr, _itemPtr, _nextPtr)                \
    for (_itemPtr = (_headPtr)->Flink, _nextPtr = (_itemPtr)->Flink;  \
         _itemPtr != _headPtr;                                        \
         _itemPtr = _nextPtr, _nextPtr = (_itemPtr)->Flink)

#endif

void SetSrbStatus(
    PVOID Srb,
    PWNBD_STATUS Status);

static inline int
ScsiOpToWnbdReqType(int ScsiOp)
{
    switch (ScsiOp) {
    case SCSIOP_READ6:
    case SCSIOP_READ:
    case SCSIOP_READ12:
    case SCSIOP_READ16:
        return WnbdReqTypeRead;
    case SCSIOP_WRITE6:
    case SCSIOP_WRITE:
    case SCSIOP_WRITE12:
    case SCSIOP_WRITE16:
        return WnbdReqTypeWrite;
    case SCSIOP_UNMAP:
        return WnbdReqTypeUnmap;
    case SCSIOP_SYNCHRONIZE_CACHE:
    case SCSIOP_SYNCHRONIZE_CACHE16:
        return WnbdReqTypeFlush;
    case SCSIOP_PERSISTENT_RESERVE_IN:
        return WnbdReqTypePersistResIn;
    case SCSIOP_PERSISTENT_RESERVE_OUT:
        return WnbdReqTypePersistResOut;
    default:
        return WnbdReqTypeUnknown;
    }
}

VOID WnbdSendIoctl(
    ULONG ControlCode,
    PDEVICE_OBJECT DeviceObject,
    PVOID InputBuffer,
    ULONG InputBufferLength,
    PVOID OutputBuffer,
    ULONG OutputBufferLength,
    PIO_STATUS_BLOCK IoStatus);
NTSTATUS
WnbdGetScsiAddress(
    PDEVICE_OBJECT DeviceObject,
    PSCSI_ADDRESS ScsiAddress);
NTSTATUS
WnbdGetDiskNumber(
    PDEVICE_OBJECT DeviceObject,
    PULONG DiskNumber);
NTSTATUS
WnbdGetDiskInstancePath(
    PDEVICE_OBJECT DeviceObject,
    PWSTR Buffer,
    DWORD BufferSize,
    PULONG RequiredBufferSize);

static inline NTSTATUS WstrToBool(const PWCHAR string, PBOOLEAN Value) {
    if (!_wcsicmp(string, L"1") ||
        !_wcsicmp(string, L"t") ||
        !_wcsicmp(string, L"true") ||
        !_wcsicmp(string, L"yes") ||
        !_wcsicmp(string, L"y"))
    {
        *Value = TRUE;
        return STATUS_SUCCESS;
    }
    if (!_wcsicmp(string, L"0") ||
        !_wcsicmp(string, L"f") ||
        !_wcsicmp(string, L"false") ||
        !_wcsicmp(string, L"no") ||
        !_wcsicmp(string, L"n"))
    {
        *Value = FALSE;
        return STATUS_SUCCESS;
    }
    return STATUS_INVALID_PARAMETER;
}