Ros-diffs

ros-diffs@reactos.org

81390 discussions

[reactos] 02/02: [SETUPLIB] Code re-organization in bootsup.c and fsutil.c.
by Hermès Bélusca-Maïto 18 Oct '20

18 Oct '20

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=593bcce9991d56de97e6e… commit 593bcce9991d56de97e6e34c8acbf0b1bc1fa0cc Author: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> AuthorDate: Sat Oct 17 20:29:47 2020 +0200 Commit: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> CommitDate: Sun Oct 18 20:56:16 2020 +0200 [SETUPLIB] Code re-organization in bootsup.c and fsutil.c. - Move the actual VBR bootcode installation helpers into fsutil.c (they depend on the selected filesystem). - Introduce InstallBootCodeToDisk() and InstallBootCodeToFile() and bootcode.c helpers, in order to replace the several functions that were duplicating the same code. --- base/setup/lib/CMakeLists.txt | 1 + base/setup/lib/bootcode.c | 116 ++++ base/setup/lib/bootcode.h | 37 + base/setup/lib/bootsup.c | 1535 ++++++----------------------------------- base/setup/lib/fsutil.c | 380 +++++++++- base/setup/lib/fsutil.h | 38 +- base/setup/lib/setuplib.h | 5 +- 7 files changed, 792 insertions(+), 1320 deletions(-) diff --git a/base/setup/lib/CMakeLists.txt b/base/setup/lib/CMakeLists.txt index ff23bc57d16..68b00922b14 100644 --- a/base/setup/lib/CMakeLists.txt +++ b/base/setup/lib/CMakeLists.txt @@ -16,6 +16,7 @@ list(APPEND SOURCE utils/osdetect.c utils/partlist.c utils/regutil.c + bootcode.c bootsup.c fsutil.c install.c diff --git a/base/setup/lib/bootcode.c b/base/setup/lib/bootcode.c new file mode 100644 index 00000000000..b72ac1fab42 --- /dev/null +++ b/base/setup/lib/bootcode.c @@ -0,0 +1,116 @@ +/* + * PROJECT: ReactOS Setup Library + * LICENSE: GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+) + * PURPOSE: BootCode support functions. + * COPYRIGHT: Copyright 2020 Hermes Belusca-Maito + */ + +/* INCLUDES *****************************************************************/ + +#include "precomp.h" + +#include "bootcode.h" + +#define NDEBUG +#include <debug.h> + + +/* FUNCTIONS ****************************************************************/ + +NTSTATUS +ReadBootCodeByHandle( + IN OUT PBOOTCODE BootCodeInfo, + IN HANDLE FileHandle, + IN ULONG Length OPTIONAL) +{ + NTSTATUS Status; + PVOID BootCode; + IO_STATUS_BLOCK IoStatusBlock; + LARGE_INTEGER FileOffset; + + ASSERT(BootCodeInfo); + + /* Normalize the bootcode length */ + if (Length == 0 || Length == (ULONG)-1) + Length = SECTORSIZE; + + /* Allocate a buffer for the bootcode */ + BootCode = RtlAllocateHeap(ProcessHeap, HEAP_ZERO_MEMORY, Length); + if (BootCode == NULL) + return STATUS_INSUFFICIENT_RESOURCES; + + /* Read the bootcode from the file into the buffer */ + FileOffset.QuadPart = 0ULL; + Status = NtReadFile(FileHandle, + NULL, + NULL, + NULL, + &IoStatusBlock, + BootCode, + Length, + &FileOffset, + NULL); + if (!NT_SUCCESS(Status)) + { + RtlFreeHeap(ProcessHeap, 0, BootCode); + return Status; + } + + /* Update the bootcode information */ + if (BootCodeInfo->BootCode) + RtlFreeHeap(ProcessHeap, 0, BootCodeInfo->BootCode); + BootCodeInfo->BootCode = BootCode; + /**/ BootCodeInfo->Length = Length; /**/ + + return STATUS_SUCCESS; +} + +NTSTATUS +ReadBootCodeFromFile( + IN OUT PBOOTCODE BootCodeInfo, + IN PUNICODE_STRING FilePath, + IN ULONG Length OPTIONAL) +{ + NTSTATUS Status; + OBJECT_ATTRIBUTES ObjectAttributes; + IO_STATUS_BLOCK IoStatusBlock; + HANDLE FileHandle; + + ASSERT(BootCodeInfo); + + /* Open the file */ + InitializeObjectAttributes(&ObjectAttributes, + FilePath, + OBJ_CASE_INSENSITIVE, + NULL, + NULL); + Status = NtOpenFile(&FileHandle, + GENERIC_READ | SYNCHRONIZE, + &ObjectAttributes, + &IoStatusBlock, + FILE_SHARE_READ | FILE_SHARE_WRITE, // Is FILE_SHARE_WRITE necessary? + FILE_SYNCHRONOUS_IO_NONALERT); + if (!NT_SUCCESS(Status)) + return Status; + + Status = ReadBootCodeByHandle(BootCodeInfo, FileHandle, Length); + + /* Close the file and return */ + NtClose(FileHandle); + return Status; +} + +VOID +FreeBootCode( + IN OUT PBOOTCODE BootCodeInfo) +{ + ASSERT(BootCodeInfo); + + /* Update the bootcode information */ + if (BootCodeInfo->BootCode) + RtlFreeHeap(ProcessHeap, 0, BootCodeInfo->BootCode); + BootCodeInfo->BootCode = NULL; + /**/ BootCodeInfo->Length = 0; /**/ +} + +/* EOF */ diff --git a/base/setup/lib/bootcode.h b/base/setup/lib/bootcode.h new file mode 100644 index 00000000000..cd8c8269e21 --- /dev/null +++ b/base/setup/lib/bootcode.h @@ -0,0 +1,37 @@ +/* + * PROJECT: ReactOS Setup Library + * LICENSE: GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+) + * PURPOSE: BootCode support functions. + * COPYRIGHT: Copyright 2020 Hermes Belusca-Maito + */ + +#pragma once + +#ifdef SECTORSIZE +#undef SECTORSIZE +#endif +#define SECTORSIZE 512 + +typedef struct _BOOTCODE +{ + PVOID BootCode; + ULONG Length; +} BOOTCODE, *PBOOTCODE; + +NTSTATUS +ReadBootCodeByHandle( + IN OUT PBOOTCODE BootCodeInfo, + IN HANDLE FileHandle, + IN ULONG Length OPTIONAL); + +NTSTATUS +ReadBootCodeFromFile( + IN OUT PBOOTCODE BootCodeInfo, + IN PUNICODE_STRING FilePath, + IN ULONG Length OPTIONAL); + +VOID +FreeBootCode( + IN OUT PBOOTCODE BootCodeInfo); + +/* EOF */ diff --git a/base/setup/lib/bootsup.c b/base/setup/lib/bootsup.c index ec9a1a4cf56..c7462403630 100644 --- a/base/setup/lib/bootsup.c +++ b/base/setup/lib/bootsup.c @@ -13,8 +13,9 @@ #include "bldrsup.h" #include "filesup.h" -#include "fsutil.h" #include "partlist.h" +#include "bootcode.h" +#include "fsutil.h" #include "setuplib.h" // HAXX for IsUnattendedSetup!! @@ -23,108 +24,17 @@ #define NDEBUG #include <debug.h> - -/* TYPEDEFS *****************************************************************/ - /* * BIG FIXME!! * =========== * - * All that stuff *MUST* go into the fsutil.c module. - * Indeed, all that relates to filesystem formatting details and as such - * *MUST* be abstracted out from this module (bootsup.c). - * However, bootsup.c can still deal with MBR code (actually it'll have - * at some point to share or give it to partlist.c, because when we'll - * support GPT disks, things will change a bit). - * And, bootsup.c can still manage initializing / adding boot entries - * into NTLDR and FREELDR, and installing the latter, and saving the old - * MBR / boot sectors in files. + * bootsup.c can deal with MBR code (actually it'll have at some point + * to share or give it to partlist.c, because when we'll support GPT disks, + * things will change a bit). + * And, bootsup.c can manage initializing / adding boot entries into NTLDR + * and FREELDR, and installing the latter, and saving the old MBR / boot + * sectors in files. */ -#define SECTORSIZE 512 - -#include <pshpack1.h> -typedef struct _FAT_BOOTSECTOR -{ - UCHAR JumpBoot[3]; // Jump instruction to boot code - CHAR OemName[8]; // "MSWIN4.1" for MS formatted volumes - USHORT BytesPerSector; // Bytes per sector - UCHAR SectorsPerCluster; // Number of sectors in a cluster - USHORT ReservedSectors; // Reserved sectors, usually 1 (the bootsector) - UCHAR NumberOfFats; // Number of FAT tables - USHORT RootDirEntries; // Number of root directory entries (fat12/16) - USHORT TotalSectors; // Number of total sectors on the drive, 16-bit - UCHAR MediaDescriptor; // Media descriptor byte - USHORT SectorsPerFat; // Sectors per FAT table (fat12/16) - USHORT SectorsPerTrack; // Number of sectors in a track - USHORT NumberOfHeads; // Number of heads on the disk - ULONG HiddenSectors; // Hidden sectors (sectors before the partition start like the partition table) - ULONG TotalSectorsBig; // This field is the new 32-bit total count of sectors on the volume - UCHAR DriveNumber; // Int 0x13 drive number (e.g. 0x80) - UCHAR Reserved1; // Reserved (used by Windows NT). Code that formats FAT volumes should always set this byte to 0. - UCHAR BootSignature; // Extended boot signature (0x29). This is a signature byte that indicates that the following three fields in the boot sector are present. - ULONG VolumeSerialNumber; // Volume serial number - CHAR VolumeLabel[11]; // Volume label. This field matches the 11-byte volume label recorded in the root directory - CHAR FileSystemType[8]; // One of the strings "FAT12 ", "FAT16 ", or "FAT " - - UCHAR BootCodeAndData[448]; // The remainder of the boot sector - - USHORT BootSectorMagic; // 0xAA55 - -} FAT_BOOTSECTOR, *PFAT_BOOTSECTOR; - -typedef struct _FAT32_BOOTSECTOR -{ - UCHAR JumpBoot[3]; // Jump instruction to boot code - CHAR OemName[8]; // "MSWIN4.1" for MS formatted volumes - USHORT BytesPerSector; // Bytes per sector - UCHAR SectorsPerCluster; // Number of sectors in a cluster - USHORT ReservedSectors; // Reserved sectors, usually 1 (the bootsector) - UCHAR NumberOfFats; // Number of FAT tables - USHORT RootDirEntries; // Number of root directory entries (fat12/16) - USHORT TotalSectors; // Number of total sectors on the drive, 16-bit - UCHAR MediaDescriptor; // Media descriptor byte - USHORT SectorsPerFat; // Sectors per FAT table (fat12/16) - USHORT SectorsPerTrack; // Number of sectors in a track - USHORT NumberOfHeads; // Number of heads on the disk - ULONG HiddenSectors; // Hidden sectors (sectors before the partition start like the partition table) - ULONG TotalSectorsBig; // This field is the new 32-bit total count of sectors on the volume - ULONG SectorsPerFatBig; // This field is the FAT32 32-bit count of sectors occupied by ONE FAT. BPB_FATSz16 must be 0 - USHORT ExtendedFlags; // Extended flags (fat32) - USHORT FileSystemVersion; // File system version (fat32) - ULONG RootDirStartCluster; // Starting cluster of the root directory (fat32) - USHORT FsInfo; // Sector number of FSINFO structure in the reserved area of the FAT32 volume. Usually 1. - USHORT BackupBootSector; // If non-zero, indicates the sector number in the reserved area of the volume of a copy of the boot record. Usually 6. - UCHAR Reserved[12]; // Reserved for future expansion - UCHAR DriveNumber; // Int 0x13 drive number (e.g. 0x80) - UCHAR Reserved1; // Reserved (used by Windows NT). Code that formats FAT volumes should always set this byte to 0. - UCHAR BootSignature; // Extended boot signature (0x29). This is a signature byte that indicates that the following three fields in the boot sector are present. - ULONG VolumeSerialNumber; // Volume serial number - CHAR VolumeLabel[11]; // Volume label. This field matches the 11-byte volume label recorded in the root directory - CHAR FileSystemType[8]; // Always set to the string "FAT32 " - - UCHAR BootCodeAndData[420]; // The remainder of the boot sector - - USHORT BootSectorMagic; // 0xAA55 - -} FAT32_BOOTSECTOR, *PFAT32_BOOTSECTOR; - -typedef struct _BTRFS_BOOTSECTOR -{ - UCHAR JumpBoot[3]; - UCHAR ChunkMapSize; - UCHAR BootDrive; - ULONGLONG PartitionStartLBA; - UCHAR Fill[1521]; // 1536 - 15 - USHORT BootSectorMagic; -} BTRFS_BOOTSECTOR, *PBTRFS_BOOTSECTOR; -C_ASSERT(sizeof(BTRFS_BOOTSECTOR) == 3 * 512); - -// TODO: Add more bootsector structures! - -#include <poppack.h> - -/* End of BIG FIXME!! */ - /* FUNCTIONS ****************************************************************/ @@ -550,63 +460,26 @@ IsThereAValidBootSector( BOOLEAN IsValid = FALSE; NTSTATUS Status; UNICODE_STRING RootPartition; - OBJECT_ATTRIBUTES ObjectAttributes; - IO_STATUS_BLOCK IoStatusBlock; - HANDLE FileHandle; - LARGE_INTEGER FileOffset; - PUCHAR BootSector; + BOOTCODE BootSector = {0}; - /* Allocate buffer for bootsector */ - BootSector = RtlAllocateHeap(ProcessHeap, 0, SECTORSIZE); - if (BootSector == NULL) - return FALSE; // STATUS_INSUFFICIENT_RESOURCES; - RtlZeroMemory(BootSector, SECTORSIZE); - - /* Open the root partition - Remove any trailing backslash if needed */ + /* Allocate and read the root partition bootsector. + * Remove any trailing backslash if needed. */ RtlInitUnicodeString(&RootPartition, RootPath); TrimTrailingPathSeparators_UStr(&RootPartition); - - InitializeObjectAttributes(&ObjectAttributes, - &RootPartition, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtOpenFile(&FileHandle, - GENERIC_READ | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - FILE_SYNCHRONOUS_IO_NONALERT); - if (!NT_SUCCESS(Status)) - goto Quit; - - /* Read current boot sector into buffer */ - FileOffset.QuadPart = 0ULL; - Status = NtReadFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - BootSector, - SECTORSIZE, - &FileOffset, - NULL); - NtClose(FileHandle); + Status = ReadBootCodeFromFile(&BootSector, &RootPartition, SECTORSIZE); if (!NT_SUCCESS(Status)) - goto Quit; + return FALSE; /* Check for the existence of the bootsector signature */ - IsValid = (*(PUSHORT)(BootSector + 0x1FE) == 0xAA55); + IsValid = (*(PUSHORT)((PUCHAR)BootSector.BootCode + 0x1FE) == 0xAA55); if (IsValid) { /* Check for the first instruction encoded on three bytes */ - IsValid = (((*(PULONG)BootSector) & 0x00FFFFFF) != 0x00000000); + IsValid = (((*(PULONG)BootSector.BootCode) & 0x00FFFFFF) != 0x00000000); } -Quit: - /* Free the boot sector */ - RtlFreeHeap(ProcessHeap, 0, BootSector); + /* Free the bootsector and return */ + FreeBootCode(&BootSector); return IsValid; } @@ -622,55 +495,18 @@ SaveBootSector( OBJECT_ATTRIBUTES ObjectAttributes; IO_STATUS_BLOCK IoStatusBlock; HANDLE FileHandle; - LARGE_INTEGER FileOffset; - PUCHAR BootSector; - - /* Allocate buffer for bootsector */ - BootSector = RtlAllocateHeap(ProcessHeap, 0, Length); - if (BootSector == NULL) - return STATUS_INSUFFICIENT_RESOURCES; + // LARGE_INTEGER FileOffset; + BOOTCODE BootSector = {0}; - /* Open the root partition - Remove any trailing backslash if needed */ + /* Allocate and read the root partition bootsector. + * Remove any trailing backslash if needed. */ RtlInitUnicodeString(&Name, RootPath); TrimTrailingPathSeparators_UStr(&Name); - - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtOpenFile(&FileHandle, - GENERIC_READ | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - FILE_SYNCHRONOUS_IO_NONALERT); - if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, BootSector); - return Status; - } - - /* Read current boot sector into buffer */ - FileOffset.QuadPart = 0ULL; - Status = NtReadFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - BootSector, - Length, - &FileOffset, - NULL); - NtClose(FileHandle); + Status = ReadBootCodeFromFile(&BootSector, &Name, Length); if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, BootSector); return Status; - } - /* Write bootsector to DstPath */ + /* Write the bootsector to DstPath */ RtlInitUnicodeString(&Name, DstPath); InitializeObjectAttributes(&ObjectAttributes, &Name, @@ -691,7 +527,7 @@ SaveBootSector( 0); if (!NT_SUCCESS(Status)) { - RtlFreeHeap(ProcessHeap, 0, BootSector); + FreeBootCode(&BootSector); return Status; } @@ -700,40 +536,36 @@ SaveBootSector( NULL, NULL, &IoStatusBlock, - BootSector, - Length, + BootSector.BootCode, + BootSector.Length, NULL, NULL); NtClose(FileHandle); - /* Free the boot sector */ - RtlFreeHeap(ProcessHeap, 0, BootSector); - + /* Free the bootsector and return */ + FreeBootCode(&BootSector); return Status; } static NTSTATUS -InstallMbrBootCodeToDiskHelper( +InstallBootCodeToDisk( IN PCWSTR SrcPath, - IN PCWSTR RootPath) + IN PCWSTR RootPath, + IN PFS_INSTALL_BOOTCODE InstallBootCode) { NTSTATUS Status; UNICODE_STRING Name; OBJECT_ATTRIBUTES ObjectAttributes; IO_STATUS_BLOCK IoStatusBlock; - HANDLE FileHandle; - LARGE_INTEGER FileOffset; - PPARTITION_SECTOR OrigBootSector; - PPARTITION_SECTOR NewBootSector; - - /* Allocate buffer for original bootsector */ - OrigBootSector = RtlAllocateHeap(ProcessHeap, 0, sizeof(PARTITION_SECTOR)); - if (OrigBootSector == NULL) - return STATUS_INSUFFICIENT_RESOURCES; + HANDLE PartitionHandle; - /* Open the root partition - Remove any trailing backslash if needed */ + /* + * Open the root partition from which the bootcode (MBR, VBR) parameters + * will be obtained; this is also where we will write the updated bootcode. + * Remove any trailing backslash if needed. + */ RtlInitUnicodeString(&Name, RootPath); TrimTrailingPathSeparators_UStr(&Name); @@ -743,132 +575,164 @@ InstallMbrBootCodeToDiskHelper( NULL, NULL); - Status = NtOpenFile(&FileHandle, - GENERIC_READ | SYNCHRONIZE, + Status = NtOpenFile(&PartitionHandle, + GENERIC_READ | GENERIC_WRITE | SYNCHRONIZE, &ObjectAttributes, &IoStatusBlock, FILE_SHARE_READ | FILE_SHARE_WRITE, - FILE_SYNCHRONOUS_IO_NONALERT); + FILE_SYNCHRONOUS_IO_NONALERT /* | FILE_SEQUENTIAL_ONLY */); if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); return Status; - } - /* Read current boot sector into buffer */ - FileOffset.QuadPart = 0ULL; - Status = NtReadFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - OrigBootSector, - sizeof(PARTITION_SECTOR), - &FileOffset, - NULL); - NtClose(FileHandle); - if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - return Status; - } + /* Install the bootcode (MBR, VBR) */ + Status = InstallBootCode(SrcPath, PartitionHandle, PartitionHandle); - /* Allocate buffer for new bootsector */ - NewBootSector = RtlAllocateHeap(ProcessHeap, 0, sizeof(PARTITION_SECTOR)); - if (NewBootSector == NULL) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - return STATUS_INSUFFICIENT_RESOURCES; - } + /* Close the partition */ + NtClose(PartitionHandle); + + return Status; +} + +static +NTSTATUS +InstallBootCodeToFile( + IN PCWSTR SrcPath, + IN PCWSTR DstPath, + IN PCWSTR RootPath, + IN PFS_INSTALL_BOOTCODE InstallBootCode) +{ + NTSTATUS Status; + UNICODE_STRING Name; + OBJECT_ATTRIBUTES ObjectAttributes; + IO_STATUS_BLOCK IoStatusBlock; + HANDLE PartitionHandle, FileHandle; + + /* + * Open the root partition from which the bootcode (MBR, VBR) + * parameters will be obtained. + * + * FIXME? It might be possible that we need to also open it for writing + * access in case we really need to still write the second portion of + * the boot sector ???? + * + * Remove any trailing backslash if needed. + */ + RtlInitUnicodeString(&Name, RootPath); + TrimTrailingPathSeparators_UStr(&Name); - /* Read new bootsector from SrcPath */ - RtlInitUnicodeString(&Name, SrcPath); InitializeObjectAttributes(&ObjectAttributes, &Name, OBJ_CASE_INSENSITIVE, NULL, NULL); - Status = NtOpenFile(&FileHandle, + Status = NtOpenFile(&PartitionHandle, GENERIC_READ | SYNCHRONIZE, &ObjectAttributes, &IoStatusBlock, - FILE_SHARE_READ, - FILE_SYNCHRONOUS_IO_NONALERT); + FILE_SHARE_READ | FILE_SHARE_WRITE, + FILE_SYNCHRONOUS_IO_NONALERT /* | FILE_SEQUENTIAL_ONLY */); if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); return Status; - } - Status = NtReadFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - NewBootSector, - sizeof(PARTITION_SECTOR), - NULL, - NULL); - NtClose(FileHandle); + /* Open or create the file where the new bootsector will be saved */ + RtlInitUnicodeString(&Name, DstPath); + InitializeObjectAttributes(&ObjectAttributes, + &Name, + OBJ_CASE_INSENSITIVE, + NULL, + NULL); + + Status = NtCreateFile(&FileHandle, + GENERIC_WRITE | SYNCHRONIZE, + &ObjectAttributes, + &IoStatusBlock, + NULL, + FILE_ATTRIBUTE_NORMAL, + 0, + FILE_SUPERSEDE, // FILE_OVERWRITE_IF + FILE_SYNCHRONOUS_IO_NONALERT | FILE_SEQUENTIAL_ONLY, + NULL, + 0); if (!NT_SUCCESS(Status)) { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); + DPRINT1("NtCreateFile() failed (Status %lx)\n", Status); + NtClose(PartitionHandle); return Status; } - /* - * Copy the disk signature, the reserved fields and - * the partition table from the old MBR to the new one. - */ - RtlCopyMemory(&NewBootSector->Signature, - &OrigBootSector->Signature, - sizeof(PARTITION_SECTOR) - offsetof(PARTITION_SECTOR, Signature) - /* Length of partition table */); + /* Install the bootcode (MBR, VBR) */ + Status = InstallBootCode(SrcPath, FileHandle, PartitionHandle); - /* Free the original boot sector */ - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); + /* Close the file and the partition */ + NtClose(FileHandle); + NtClose(PartitionHandle); - /* Open the root partition - Remove any trailing backslash if needed */ - RtlInitUnicodeString(&Name, RootPath); - TrimTrailingPathSeparators_UStr(&Name); + return Status; +} - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - Status = NtOpenFile(&FileHandle, - GENERIC_WRITE | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - FILE_SYNCHRONOUS_IO_NONALERT | FILE_SEQUENTIAL_ONLY); +static +NTSTATUS +InstallMbrBootCode( + IN PCWSTR SrcPath, // MBR source file (on the installation medium) + IN HANDLE DstPath, // Where to save the bootsector built from the source + disk information + IN HANDLE DiskHandle) // Disk holding the (old) MBR information +{ + NTSTATUS Status; + UNICODE_STRING Name; + IO_STATUS_BLOCK IoStatusBlock; + LARGE_INTEGER FileOffset; + BOOTCODE OrigBootSector = {0}; + BOOTCODE NewBootSector = {0}; + +C_ASSERT(sizeof(PARTITION_SECTOR) == SECTORSIZE); + + /* Allocate and read the current original MBR bootsector */ + Status = ReadBootCodeByHandle(&OrigBootSector, + DiskHandle, + sizeof(PARTITION_SECTOR)); + if (!NT_SUCCESS(Status)) + return Status; + + /* Allocate and read the new bootsector from SrcPath */ + RtlInitUnicodeString(&Name, SrcPath); + Status = ReadBootCodeFromFile(&NewBootSector, + &Name, + sizeof(PARTITION_SECTOR)); if (!NT_SUCCESS(Status)) { - DPRINT1("NtOpenFile() failed (Status %lx)\n", Status); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); + FreeBootCode(&OrigBootSector); return Status; } - /* Write new bootsector to RootPath */ + /* + * Copy the disk signature, the reserved fields and + * the partition table from the old MBR to the new one. + */ + RtlCopyMemory(&((PPARTITION_SECTOR)NewBootSector.BootCode)->Signature, + &((PPARTITION_SECTOR)OrigBootSector.BootCode)->Signature, + sizeof(PARTITION_SECTOR) - + FIELD_OFFSET(PARTITION_SECTOR, Signature) + /* Length of partition table */); + + /* Free the original bootsector */ + FreeBootCode(&OrigBootSector); + + /* Write the new bootsector to DstPath */ FileOffset.QuadPart = 0ULL; - Status = NtWriteFile(FileHandle, + Status = NtWriteFile(DstPath, NULL, NULL, NULL, &IoStatusBlock, - NewBootSector, - sizeof(PARTITION_SECTOR), + NewBootSector.BootCode, + NewBootSector.Length, &FileOffset, NULL); - NtClose(FileHandle); - /* Free the new boot sector */ - RtlFreeHeap(ProcessHeap, 0, NewBootSector); + /* Free the new bootsector */ + FreeBootCode(&NewBootSector); return Status; } @@ -917,1023 +781,65 @@ InstallMbrBootCodeToDisk( DPRINT1("Install MBR bootcode: %S ==> %S\n", SourceMbrPathBuffer, DestinationDevicePathBuffer); - return InstallMbrBootCodeToDiskHelper(SourceMbrPathBuffer, - DestinationDevicePathBuffer); + /* Install the MBR */ + return InstallBootCodeToDisk(SourceMbrPathBuffer, + DestinationDevicePathBuffer, + InstallMbrBootCode); } static NTSTATUS -InstallFat12BootCodeToFloppy( - IN PCWSTR SrcPath, - IN PCWSTR RootPath) +InstallFatBootcodeToPartition( + IN PUNICODE_STRING SystemRootPath, + IN PUNICODE_STRING SourceRootPath, + IN PUNICODE_STRING DestinationArcPath, + IN UCHAR PartitionType) { NTSTATUS Status; - UNICODE_STRING Name; - OBJECT_ATTRIBUTES ObjectAttributes; - IO_STATUS_BLOCK IoStatusBlock; - HANDLE FileHandle; - LARGE_INTEGER FileOffset; - PFAT_BOOTSECTOR OrigBootSector; - PFAT_BOOTSECTOR NewBootSector; - - /* Allocate buffer for original bootsector */ - OrigBootSector = RtlAllocateHeap(ProcessHeap, 0, SECTORSIZE); - if (OrigBootSector == NULL) - return STATUS_INSUFFICIENT_RESOURCES; - - /* Open the root partition - Remove any trailing backslash if needed */ - RtlInitUnicodeString(&Name, RootPath); - TrimTrailingPathSeparators_UStr(&Name); + BOOLEAN DoesFreeLdrExist; + WCHAR SrcPath[MAX_PATH]; + WCHAR DstPath[MAX_PATH]; - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); + /* FAT or FAT32 partition */ + DPRINT("System path: '%wZ'\n", SystemRootPath); - Status = NtOpenFile(&FileHandle, - GENERIC_READ | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - FILE_SYNCHRONOUS_IO_NONALERT); - if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - return Status; - } + /* Copy FreeLoader to the system partition, always overwriting the older version */ + CombinePaths(SrcPath, ARRAYSIZE(SrcPath), 2, SourceRootPath->Buffer, L"\\loader\\freeldr.sys"); + CombinePaths(DstPath, ARRAYSIZE(DstPath), 2, SystemRootPath->Buffer, L"freeldr.sys"); - /* Read current boot sector into buffer */ - FileOffset.QuadPart = 0ULL; - Status = NtReadFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - OrigBootSector, - SECTORSIZE, - &FileOffset, - NULL); - NtClose(FileHandle); + DPRINT("Copy: %S ==> %S\n", SrcPath, DstPath); + Status = SetupCopyFile(SrcPath, DstPath, FALSE); if (!NT_SUCCESS(Status)) { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); + DPRINT1("SetupCopyFile() failed (Status %lx)\n", Status); return Status; } - /* Allocate buffer for new bootsector */ - NewBootSector = RtlAllocateHeap(ProcessHeap, - 0, - SECTORSIZE); - if (NewBootSector == NULL) + /* Prepare for possibly updating 'freeldr.ini' */ + DoesFreeLdrExist = DoesFileExist_2(SystemRootPath->Buffer, L"freeldr.ini"); + if (DoesFreeLdrExist) { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - return STATUS_INSUFFICIENT_RESOURCES; + /* Update existing 'freeldr.ini' */ + DPRINT1("Update existing 'freeldr.ini'\n"); + Status = UpdateFreeLoaderIni(SystemRootPath->Buffer, DestinationArcPath->Buffer); + if (!NT_SUCCESS(Status)) + { + DPRINT1("UpdateFreeLoaderIni() failed (Status %lx)\n", Status); + return Status; + } } - /* Read new bootsector from SrcPath */ - RtlInitUnicodeString(&Name, SrcPath); - - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); + /* Check for NT and other bootloaders */ - Status = NtOpenFile(&FileHandle, - GENERIC_READ | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ, - FILE_SYNCHRONOUS_IO_NONALERT); - if (!NT_SUCCESS(Status)) + // FIXME: Check for Vista+ bootloader! + /*** Status = FindBootStore(PartitionHandle, NtLdr, &Version); ***/ + /*** Status = FindBootStore(PartitionHandle, BootMgr, &Version); ***/ + if (DoesFileExist_2(SystemRootPath->Buffer, L"NTLDR") == TRUE || + DoesFileExist_2(SystemRootPath->Buffer, L"BOOT.INI") == TRUE) { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - return Status; - } - - Status = NtReadFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - NewBootSector, - SECTORSIZE, - NULL, - NULL); - NtClose(FileHandle); - if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - return Status; - } - - /* Adjust bootsector (copy a part of the FAT16 BPB) */ - memcpy(&NewBootSector->OemName, - &OrigBootSector->OemName, - FIELD_OFFSET(FAT_BOOTSECTOR, BootCodeAndData) - - FIELD_OFFSET(FAT_BOOTSECTOR, OemName)); - - /* Free the original boot sector */ - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - - /* Open the root partition - Remove any trailing backslash if needed */ - RtlInitUnicodeString(&Name, RootPath); - TrimTrailingPathSeparators_UStr(&Name); - - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtOpenFile(&FileHandle, - GENERIC_WRITE | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - FILE_SYNCHRONOUS_IO_NONALERT | FILE_SEQUENTIAL_ONLY); - if (!NT_SUCCESS(Status)) - { - DPRINT1("NtOpenFile() failed (Status %lx)\n", Status); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - return Status; - } - - /* Write new bootsector to RootPath */ - FileOffset.QuadPart = 0ULL; - Status = NtWriteFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - NewBootSector, - SECTORSIZE, - &FileOffset, - NULL); - NtClose(FileHandle); - - /* Free the new boot sector */ - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - - return Status; -} - -static -NTSTATUS -InstallFat16BootCode( - IN PCWSTR SrcPath, // FAT16 bootsector source file (on the installation medium) - IN HANDLE DstPath, // Where to save the bootsector built from the source + partition information - IN HANDLE RootPartition) // Partition holding the (old) FAT16 information -{ - NTSTATUS Status; - UNICODE_STRING Name; - OBJECT_ATTRIBUTES ObjectAttributes; - IO_STATUS_BLOCK IoStatusBlock; - HANDLE FileHandle; - LARGE_INTEGER FileOffset; - PFAT_BOOTSECTOR OrigBootSector; - PFAT_BOOTSECTOR NewBootSector; - - /* Allocate a buffer for the original bootsector */ - OrigBootSector = RtlAllocateHeap(ProcessHeap, 0, SECTORSIZE); - if (OrigBootSector == NULL) - return STATUS_INSUFFICIENT_RESOURCES; - - /* Read the current partition boot sector into the buffer */ - FileOffset.QuadPart = 0ULL; - Status = NtReadFile(RootPartition, - NULL, - NULL, - NULL, - &IoStatusBlock, - OrigBootSector, - SECTORSIZE, - &FileOffset, - NULL); - if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - return Status; - } - - /* Allocate a buffer for the new bootsector */ - NewBootSector = RtlAllocateHeap(ProcessHeap, 0, SECTORSIZE); - if (NewBootSector == NULL) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - return STATUS_INSUFFICIENT_RESOURCES; - } - - /* Read the new bootsector from SrcPath */ - RtlInitUnicodeString(&Name, SrcPath); - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtOpenFile(&FileHandle, - GENERIC_READ | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ, - FILE_SYNCHRONOUS_IO_NONALERT); - if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - return Status; - } - - FileOffset.QuadPart = 0ULL; - Status = NtReadFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - NewBootSector, - SECTORSIZE, - &FileOffset, - NULL); - NtClose(FileHandle); - if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - return Status; - } - - /* Adjust the bootsector (copy a part of the FAT16 BPB) */ - memcpy(&NewBootSector->OemName, - &OrigBootSector->OemName, - FIELD_OFFSET(FAT_BOOTSECTOR, BootCodeAndData) - - FIELD_OFFSET(FAT_BOOTSECTOR, OemName)); - - /* Free the original boot sector */ - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - - /* Write the new bootsector to DstPath */ - FileOffset.QuadPart = 0ULL; - Status = NtWriteFile(DstPath, - NULL, - NULL, - NULL, - &IoStatusBlock, - NewBootSector, - SECTORSIZE, - &FileOffset, - NULL); - - /* Free the new boot sector */ - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - - return Status; -} - -static -NTSTATUS -InstallFat16BootCodeToFile( - IN PCWSTR SrcPath, - IN PCWSTR DstPath, - IN PCWSTR RootPath) -{ - NTSTATUS Status; - UNICODE_STRING Name; - OBJECT_ATTRIBUTES ObjectAttributes; - IO_STATUS_BLOCK IoStatusBlock; - HANDLE PartitionHandle, FileHandle; - - /* - * Open the root partition from which the boot sector - * parameters will be obtained. - * Remove any trailing backslash if needed. - */ - RtlInitUnicodeString(&Name, RootPath); - TrimTrailingPathSeparators_UStr(&Name); - - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtOpenFile(&PartitionHandle, - GENERIC_READ | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - FILE_SYNCHRONOUS_IO_NONALERT /* | FILE_SEQUENTIAL_ONLY */); - if (!NT_SUCCESS(Status)) - return Status; - - /* Open or create the file where the new bootsector will be saved */ - RtlInitUnicodeString(&Name, DstPath); - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtCreateFile(&FileHandle, - GENERIC_WRITE | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - NULL, - FILE_ATTRIBUTE_NORMAL, - 0, - FILE_OVERWRITE_IF, - FILE_SYNCHRONOUS_IO_NONALERT | FILE_SEQUENTIAL_ONLY, - NULL, - 0); - if (!NT_SUCCESS(Status)) - { - DPRINT1("NtCreateFile() failed (Status %lx)\n", Status); - NtClose(PartitionHandle); - return Status; - } - - /* Install the FAT16 boot sector */ - Status = InstallFat16BootCode(SrcPath, FileHandle, PartitionHandle); - - /* Close the file and the partition */ - NtClose(FileHandle); - NtClose(PartitionHandle); - - return Status; -} - -static -NTSTATUS -InstallFat16BootCodeToDisk( - IN PCWSTR SrcPath, - IN PCWSTR RootPath) -{ - NTSTATUS Status; - UNICODE_STRING Name; - OBJECT_ATTRIBUTES ObjectAttributes; - IO_STATUS_BLOCK IoStatusBlock; - HANDLE PartitionHandle; - - /* - * Open the root partition from which the boot sector parameters will be - * obtained; this is also where we will write the updated boot sector. - * Remove any trailing backslash if needed. - */ - RtlInitUnicodeString(&Name, RootPath); - TrimTrailingPathSeparators_UStr(&Name); - - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtOpenFile(&PartitionHandle, - GENERIC_READ | GENERIC_WRITE | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - FILE_SYNCHRONOUS_IO_NONALERT | FILE_SEQUENTIAL_ONLY); - if (!NT_SUCCESS(Status)) - return Status; - - /* Install the FAT16 boot sector */ - Status = InstallFat16BootCode(SrcPath, PartitionHandle, PartitionHandle); - - /* Close the partition */ - NtClose(PartitionHandle); - - return Status; -} - - -static -NTSTATUS -InstallFat32BootCode( - IN PCWSTR SrcPath, // FAT32 bootsector source file (on the installation medium) - IN HANDLE DstPath, // Where to save the bootsector built from the source + partition information - IN HANDLE RootPartition) // Partition holding the (old) FAT32 information -{ - NTSTATUS Status; - UNICODE_STRING Name; - OBJECT_ATTRIBUTES ObjectAttributes; - IO_STATUS_BLOCK IoStatusBlock; - HANDLE FileHandle; - LARGE_INTEGER FileOffset; - PFAT32_BOOTSECTOR OrigBootSector; - PFAT32_BOOTSECTOR NewBootSector; - USHORT BackupBootSector; - - /* Allocate a buffer for the original bootsector */ - OrigBootSector = RtlAllocateHeap(ProcessHeap, 0, SECTORSIZE); - if (OrigBootSector == NULL) - return STATUS_INSUFFICIENT_RESOURCES; - - /* Read the current boot sector into the buffer */ - FileOffset.QuadPart = 0ULL; - Status = NtReadFile(RootPartition, - NULL, - NULL, - NULL, - &IoStatusBlock, - OrigBootSector, - SECTORSIZE, - &FileOffset, - NULL); - if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - return Status; - } - - /* Allocate a buffer for the new bootsector (2 sectors) */ - NewBootSector = RtlAllocateHeap(ProcessHeap, 0, 2 * SECTORSIZE); - if (NewBootSector == NULL) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - return STATUS_INSUFFICIENT_RESOURCES; - } - - /* Read the new bootsector from SrcPath */ - RtlInitUnicodeString(&Name, SrcPath); - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtOpenFile(&FileHandle, - GENERIC_READ | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ, - FILE_SYNCHRONOUS_IO_NONALERT); - if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - return Status; - } - - FileOffset.QuadPart = 0ULL; - Status = NtReadFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - NewBootSector, - 2 * SECTORSIZE, - &FileOffset, - NULL); - NtClose(FileHandle); - if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - return Status; - } - - /* Adjust the bootsector (copy a part of the FAT32 BPB) */ - memcpy(&NewBootSector->OemName, - &OrigBootSector->OemName, - FIELD_OFFSET(FAT32_BOOTSECTOR, BootCodeAndData) - - FIELD_OFFSET(FAT32_BOOTSECTOR, OemName)); - - /* - * We know we copy the boot code to a file only when DstPath != RootPartition, - * otherwise the boot code is copied to the specified root partition. - */ - if (DstPath != RootPartition) - { - /* Copy to a file: Disable the backup boot sector */ - NewBootSector->BackupBootSector = 0; - } - else - { - /* Copy to a disk: Get the location of the backup boot sector */ - BackupBootSector = OrigBootSector->BackupBootSector; - } - - /* Free the original boot sector */ - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - - /* Write the first sector of the new bootcode to DstPath sector 0 */ - FileOffset.QuadPart = 0ULL; - Status = NtWriteFile(DstPath, - NULL, - NULL, - NULL, - &IoStatusBlock, - NewBootSector, - SECTORSIZE, - &FileOffset, - NULL); - if (!NT_SUCCESS(Status)) - { - DPRINT1("NtWriteFile() failed (Status %lx)\n", Status); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - return Status; - } - - if (DstPath == RootPartition) - { - /* Copy to a disk: Write the backup boot sector */ - if ((BackupBootSector != 0x0000) && (BackupBootSector != 0xFFFF)) - { - FileOffset.QuadPart = (ULONGLONG)((ULONG)BackupBootSector * SECTORSIZE); - Status = NtWriteFile(DstPath, - NULL, - NULL, - NULL, - &IoStatusBlock, - NewBootSector, - SECTORSIZE, - &FileOffset, - NULL); - if (!NT_SUCCESS(Status)) - { - DPRINT1("NtWriteFile() failed (Status %lx)\n", Status); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - return Status; - } - } - } - - /* Write the second sector of the new bootcode to boot disk sector 14 */ - // FileOffset.QuadPart = (ULONGLONG)(14 * SECTORSIZE); - FileOffset.QuadPart = 14 * SECTORSIZE; - Status = NtWriteFile(DstPath, // or really RootPartition ??? - NULL, - NULL, - NULL, - &IoStatusBlock, - ((PUCHAR)NewBootSector + SECTORSIZE), - SECTORSIZE, - &FileOffset, - NULL); - if (!NT_SUCCESS(Status)) - { - DPRINT1("NtWriteFile() failed (Status %lx)\n", Status); - } - - /* Free the new boot sector */ - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - - return Status; -} - -static -NTSTATUS -InstallFat32BootCodeToFile( - IN PCWSTR SrcPath, - IN PCWSTR DstPath, - IN PCWSTR RootPath) -{ - NTSTATUS Status; - UNICODE_STRING Name; - OBJECT_ATTRIBUTES ObjectAttributes; - IO_STATUS_BLOCK IoStatusBlock; - HANDLE PartitionHandle, FileHandle; - - /* - * Open the root partition from which the boot sector parameters - * will be obtained. - * FIXME? It might be possible that we need to also open it for writing - * access in case we really need to still write the second portion of - * the boot sector ???? - * - * Remove any trailing backslash if needed. - */ - RtlInitUnicodeString(&Name, RootPath); - TrimTrailingPathSeparators_UStr(&Name); - - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtOpenFile(&PartitionHandle, - GENERIC_READ | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - FILE_SYNCHRONOUS_IO_NONALERT /* | FILE_SEQUENTIAL_ONLY */); - if (!NT_SUCCESS(Status)) - return Status; - - /* Open or create the file where (the first sector of ????) the new bootsector will be saved */ - RtlInitUnicodeString(&Name, DstPath); - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtCreateFile(&FileHandle, - GENERIC_WRITE | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - NULL, - FILE_ATTRIBUTE_NORMAL, - 0, - FILE_SUPERSEDE, // FILE_OVERWRITE_IF, <- is used for FAT16 - FILE_SYNCHRONOUS_IO_NONALERT | FILE_SEQUENTIAL_ONLY, - NULL, - 0); - if (!NT_SUCCESS(Status)) - { - DPRINT1("NtCreateFile() failed (Status %lx)\n", Status); - NtClose(PartitionHandle); - return Status; - } - - /* Install the FAT32 boot sector */ - Status = InstallFat32BootCode(SrcPath, FileHandle, PartitionHandle); - - /* Close the file and the partition */ - NtClose(FileHandle); - NtClose(PartitionHandle); - - return Status; -} - -static -NTSTATUS -InstallFat32BootCodeToDisk( - IN PCWSTR SrcPath, - IN PCWSTR RootPath) -{ - NTSTATUS Status; - UNICODE_STRING Name; - OBJECT_ATTRIBUTES ObjectAttributes; - IO_STATUS_BLOCK IoStatusBlock; - HANDLE PartitionHandle; - - /* - * Open the root partition from which the boot sector parameters will be - * obtained; this is also where we will write the updated boot sector. - * Remove any trailing backslash if needed. - */ - RtlInitUnicodeString(&Name, RootPath); - TrimTrailingPathSeparators_UStr(&Name); - - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtOpenFile(&PartitionHandle, - GENERIC_READ | GENERIC_WRITE | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - FILE_SYNCHRONOUS_IO_NONALERT /* | FILE_SEQUENTIAL_ONLY */); - if (!NT_SUCCESS(Status)) - return Status; - - /* Install the FAT32 boot sector */ - Status = InstallFat32BootCode(SrcPath, PartitionHandle, PartitionHandle); - - /* Close the partition */ - NtClose(PartitionHandle); - - return Status; -} - -static -NTSTATUS -InstallBtrfsBootCodeToDisk( - IN PCWSTR SrcPath, - IN PCWSTR RootPath) -{ - NTSTATUS Status; - NTSTATUS LockStatus; - UNICODE_STRING Name; - OBJECT_ATTRIBUTES ObjectAttributes; - IO_STATUS_BLOCK IoStatusBlock; - HANDLE FileHandle; - LARGE_INTEGER FileOffset; -// PEXT2_BOOTSECTOR OrigBootSector; - PBTRFS_BOOTSECTOR NewBootSector; - // USHORT BackupBootSector; - PARTITION_INFORMATION_EX PartInfo; - -#if 0 - /* Allocate buffer for original bootsector */ - OrigBootSector = RtlAllocateHeap(ProcessHeap, 0, SECTORSIZE); - if (OrigBootSector == NULL) - return STATUS_INSUFFICIENT_RESOURCES; - - /* Open the root partition - Remove any trailing backslash if needed */ - RtlInitUnicodeString(&Name, RootPath); - TrimTrailingPathSeparators_UStr(&Name); - - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtOpenFile(&FileHandle, - GENERIC_READ | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - FILE_SYNCHRONOUS_IO_NONALERT); - if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - return Status; - } - - /* Read current boot sector into buffer */ - FileOffset.QuadPart = 0ULL; - Status = NtReadFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - OrigBootSector, - SECTORSIZE, - &FileOffset, - NULL); - NtClose(FileHandle); - if (!NT_SUCCESS(Status)) - { - RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - return Status; - } -#endif - - /* Allocate buffer for new bootsector */ - NewBootSector = RtlAllocateHeap(ProcessHeap, 0, sizeof(BTRFS_BOOTSECTOR)); - if (NewBootSector == NULL) - { - // RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - return STATUS_INSUFFICIENT_RESOURCES; - } - - /* Read new bootsector from SrcPath */ - RtlInitUnicodeString(&Name, SrcPath); - - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtOpenFile(&FileHandle, - GENERIC_READ | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ, - FILE_SYNCHRONOUS_IO_NONALERT); - if (!NT_SUCCESS(Status)) - { - // RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - return Status; - } - - Status = NtReadFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - NewBootSector, - sizeof(BTRFS_BOOTSECTOR), - NULL, - NULL); - NtClose(FileHandle); - if (!NT_SUCCESS(Status)) - { - // RtlFreeHeap(ProcessHeap, 0, OrigBootSector); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - return Status; - } - -#if 0 - /* Adjust bootsector (copy a part of the FAT32 BPB) */ - memcpy(&NewBootSector->OemName, - &OrigBootSector->OemName, - FIELD_OFFSET(FAT32_BOOTSECTOR, BootCodeAndData) - - FIELD_OFFSET(FAT32_BOOTSECTOR, OemName)); - - /* Get the location of the backup boot sector */ - BackupBootSector = OrigBootSector->BackupBootSector; - - /* Free the original boot sector */ - // RtlFreeHeap(ProcessHeap, 0, OrigBootSector); -#endif - - /* Open the root partition - Remove any trailing backslash if needed */ - RtlInitUnicodeString(&Name, RootPath); - TrimTrailingPathSeparators_UStr(&Name); - - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = NtOpenFile(&FileHandle, - GENERIC_WRITE | SYNCHRONIZE, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - FILE_SYNCHRONOUS_IO_NONALERT | FILE_SEQUENTIAL_ONLY); - if (!NT_SUCCESS(Status)) - { - DPRINT1("NtOpenFile() failed (Status %lx)\n", Status); - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - return Status; - } - - /* - * The BTRFS driver requires the volume to be locked in order to modify - * the first sectors of the partition, even though they are outside the - * file-system space / in the reserved area (they are situated before - * the super-block at 0x1000) and is in principle allowed by the NT - * storage stack. - * So we lock here in order to write the bootsector at sector 0. - * If locking fails, we ignore and continue nonetheless. - */ - LockStatus = NtFsControlFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - FSCTL_LOCK_VOLUME, - NULL, - 0, - NULL, - 0); - if (!NT_SUCCESS(LockStatus)) - { - DPRINT1("WARNING: Failed to lock BTRFS volume for writing bootsector! Operations may fail! (Status 0x%lx)\n", LockStatus); - } - - /* Obtaining partition info and writing it to bootsector */ - Status = NtDeviceIoControlFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - IOCTL_DISK_GET_PARTITION_INFO_EX, - NULL, - 0, - &PartInfo, - sizeof(PartInfo)); - if (!NT_SUCCESS(Status)) - { - DPRINT1("IOCTL_DISK_GET_PARTITION_INFO_EX failed (Status %lx)\n", Status); - goto Quit; - } - - /* Write new bootsector to RootPath */ - - NewBootSector->PartitionStartLBA = PartInfo.StartingOffset.QuadPart / SECTORSIZE; - - /* Write sector 0 */ - FileOffset.QuadPart = 0ULL; - Status = NtWriteFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - NewBootSector, - sizeof(BTRFS_BOOTSECTOR), - &FileOffset, - NULL); - if (!NT_SUCCESS(Status)) - { - DPRINT1("NtWriteFile() failed (Status %lx)\n", Status); - goto Quit; - } - -#if 0 - /* Write backup boot sector */ - if ((BackupBootSector != 0x0000) && (BackupBootSector != 0xFFFF)) - { - FileOffset.QuadPart = (ULONGLONG)((ULONG)BackupBootSector * SECTORSIZE); - Status = NtWriteFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - NewBootSector, - SECTORSIZE, - &FileOffset, - NULL); - if (!NT_SUCCESS(Status)) - { - DPRINT1("NtWriteFile() failed (Status %lx)\n", Status); - goto Quit; - } - } - - /* Write sector 14 */ - FileOffset.QuadPart = 14 * SECTORSIZE; - Status = NtWriteFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - ((PUCHAR)NewBootSector + SECTORSIZE), - SECTORSIZE, - &FileOffset, - NULL); - if (!NT_SUCCESS(Status)) - { - DPRINT1("NtWriteFile() failed (Status %lx)\n", Status); - } -#endif - -Quit: - /* Unlock the volume */ - LockStatus = NtFsControlFile(FileHandle, - NULL, - NULL, - NULL, - &IoStatusBlock, - FSCTL_UNLOCK_VOLUME, - NULL, - 0, - NULL, - 0); - if (!NT_SUCCESS(LockStatus)) - { - DPRINT1("Failed to unlock BTRFS volume (Status 0x%lx)\n", LockStatus); - } - - /* Close the volume */ - NtClose(FileHandle); - - /* Free the new boot sector */ - RtlFreeHeap(ProcessHeap, 0, NewBootSector); - - return Status; -} - - -static -NTSTATUS -InstallFatBootcodeToPartition( - IN PUNICODE_STRING SystemRootPath, - IN PUNICODE_STRING SourceRootPath, - IN PUNICODE_STRING DestinationArcPath, - IN UCHAR PartitionType) -{ - NTSTATUS Status; - BOOLEAN DoesFreeLdrExist; - WCHAR SrcPath[MAX_PATH]; - WCHAR DstPath[MAX_PATH]; - - /* FAT or FAT32 partition */ - DPRINT("System path: '%wZ'\n", SystemRootPath); - - /* Copy FreeLoader to the system partition, always overwriting the older version */ - CombinePaths(SrcPath, ARRAYSIZE(SrcPath), 2, SourceRootPath->Buffer, L"\\loader\\freeldr.sys"); - CombinePaths(DstPath, ARRAYSIZE(DstPath), 2, SystemRootPath->Buffer, L"freeldr.sys"); - - DPRINT("Copy: %S ==> %S\n", SrcPath, DstPath); - Status = SetupCopyFile(SrcPath, DstPath, FALSE); - if (!NT_SUCCESS(Status)) - { - DPRINT1("SetupCopyFile() failed (Status %lx)\n", Status); - return Status; - } - - /* Prepare for possibly updating 'freeldr.ini' */ - DoesFreeLdrExist = DoesFileExist_2(SystemRootPath->Buffer, L"freeldr.ini"); - if (DoesFreeLdrExist) - { - /* Update existing 'freeldr.ini' */ - DPRINT1("Update existing 'freeldr.ini'\n"); - Status = UpdateFreeLoaderIni(SystemRootPath->Buffer, DestinationArcPath->Buffer); - if (!NT_SUCCESS(Status)) - { - DPRINT1("UpdateFreeLoaderIni() failed (Status %lx)\n", Status); - return Status; - } - } - - /* Check for NT and other bootloaders */ - - // FIXME: Check for Vista+ bootloader! - /*** Status = FindBootStore(PartitionHandle, NtLdr, &Version); ***/ - /*** Status = FindBootStore(PartitionHandle, BootMgr, &Version); ***/ - if (DoesFileExist_2(SystemRootPath->Buffer, L"NTLDR") == TRUE || - DoesFileExist_2(SystemRootPath->Buffer, L"BOOT.INI") == TRUE) - { - /* Search root directory for 'NTLDR' and 'BOOT.INI' */ - DPRINT1("Found Microsoft Windows NT/2000/XP boot loader\n"); + /* Search root directory for 'NTLDR' and 'BOOT.INI' */ + DPRINT1("Found Microsoft Windows NT/2000/XP boot loader\n"); /* Create or update 'freeldr.ini' */ if (DoesFreeLdrExist == FALSE) @@ -1957,11 +863,12 @@ InstallFatBootcodeToPartition( CombinePaths(SrcPath, ARRAYSIZE(SrcPath), 2, SourceRootPath->Buffer, L"\\loader\\fat32.bin"); DPRINT1("Install FAT32 bootcode: %S ==> %S\n", SrcPath, DstPath); - Status = InstallFat32BootCodeToFile(SrcPath, DstPath, - SystemRootPath->Buffer); + Status = InstallBootCodeToFile(SrcPath, DstPath, + SystemRootPath->Buffer, + InstallFat32BootCode); if (!NT_SUCCESS(Status)) { - DPRINT1("InstallFat32BootCodeToFile() failed (Status %lx)\n", Status); + DPRINT1("InstallBootCodeToFile(FAT32) failed (Status %lx)\n", Status); return Status; } } @@ -1970,12 +877,13 @@ InstallFatBootcodeToPartition( /* Install FAT16 bootcode */ CombinePaths(SrcPath, ARRAYSIZE(SrcPath), 2, SourceRootPath->Buffer, L"\\loader\\fat.bin"); - DPRINT1("Install FAT bootcode: %S ==> %S\n", SrcPath, DstPath); - Status = InstallFat16BootCodeToFile(SrcPath, DstPath, - SystemRootPath->Buffer); + DPRINT1("Install FAT16 bootcode: %S ==> %S\n", SrcPath, DstPath); + Status = InstallBootCodeToFile(SrcPath, DstPath, + SystemRootPath->Buffer, + InstallFat16BootCode); if (!NT_SUCCESS(Status)) { - DPRINT1("InstallFat16BootCodeToFile() failed (Status %lx)\n", Status); + DPRINT1("InstallBootCodeToFile(FAT16) failed (Status %lx)\n", Status); return Status; } } @@ -2169,10 +1077,10 @@ InstallFatBootcodeToPartition( CombinePaths(SrcPath, ARRAYSIZE(SrcPath), 2, SourceRootPath->Buffer, L"\\loader\\fat32.bin"); DPRINT1("Install FAT32 bootcode: %S ==> %S\n", SrcPath, SystemRootPath->Buffer); - Status = InstallFat32BootCodeToDisk(SrcPath, SystemRootPath->Buffer); + Status = InstallBootCodeToDisk(SrcPath, SystemRootPath->Buffer, InstallFat32BootCode); if (!NT_SUCCESS(Status)) { - DPRINT1("InstallFat32BootCodeToDisk() failed (Status %lx)\n", Status); + DPRINT1("InstallBootCodeToDisk(FAT32) failed (Status %lx)\n", Status); return Status; } } @@ -2182,10 +1090,10 @@ InstallFatBootcodeToPartition( CombinePaths(SrcPath, ARRAYSIZE(SrcPath), 2, SourceRootPath->Buffer, L"\\loader\\fat.bin"); DPRINT1("Install FAT16 bootcode: %S ==> %S\n", SrcPath, SystemRootPath->Buffer); - Status = InstallFat16BootCodeToDisk(SrcPath, SystemRootPath->Buffer); + Status = InstallBootCodeToDisk(SrcPath, SystemRootPath->Buffer, InstallFat16BootCode); if (!NT_SUCCESS(Status)) { - DPRINT1("InstallFat16BootCodeToDisk() failed (Status %lx)\n", Status); + DPRINT1("InstallBootCodeToDisk(FAT16) failed (Status %lx)\n", Status); return Status; } } @@ -2200,8 +1108,7 @@ NTSTATUS InstallBtrfsBootcodeToPartition( IN PUNICODE_STRING SystemRootPath, IN PUNICODE_STRING SourceRootPath, - IN PUNICODE_STRING DestinationArcPath, - IN UCHAR PartitionType) + IN PUNICODE_STRING DestinationArcPath) { NTSTATUS Status; BOOLEAN DoesFreeLdrExist; @@ -2266,7 +1173,7 @@ InstallBtrfsBootcodeToPartition( CombinePaths(DstPath, ARRAYSIZE(DstPath), 2, SystemRootPath->Buffer, BootSector); DPRINT1("Save bootsector: %S ==> %S\n", SystemRootPath->Buffer, DstPath); - Status = SaveBootSector(SystemRootPath->Buffer, DstPath, sizeof(BTRFS_BOOTSECTOR)); + Status = SaveBootSector(SystemRootPath->Buffer, DstPath, BTRFS_BOOTSECTOR_SIZE); if (!NT_SUCCESS(Status)) { DPRINT1("SaveBootSector() failed (Status %lx)\n", Status); @@ -2284,18 +1191,15 @@ InstallBtrfsBootcodeToPartition( } /* Install new bootsector on the disk */ - // if (PartitionType == PARTITION_EXT2) - { - /* Install BTRFS bootcode */ - CombinePaths(SrcPath, ARRAYSIZE(SrcPath), 2, SourceRootPath->Buffer, L"\\loader\\btrfs.bin"); + /* Install BTRFS bootcode */ + CombinePaths(SrcPath, ARRAYSIZE(SrcPath), 2, SourceRootPath->Buffer, L"\\loader\\btrfs.bin"); - DPRINT1("Install BTRFS bootcode: %S ==> %S\n", SrcPath, SystemRootPath->Buffer); - Status = InstallBtrfsBootCodeToDisk(SrcPath, SystemRootPath->Buffer); - if (!NT_SUCCESS(Status)) - { - DPRINT1("InstallBtrfsBootCodeToDisk() failed (Status %lx)\n", Status); - return Status; - } + DPRINT1("Install BTRFS bootcode: %S ==> %S\n", SrcPath, SystemRootPath->Buffer); + Status = InstallBootCodeToDisk(SrcPath, SystemRootPath->Buffer, InstallBtrfsBootCode); + if (!NT_SUCCESS(Status)) + { + DPRINT1("InstallBootCodeToDisk(BTRFS) failed (Status %lx)\n", Status); + return Status; } } @@ -2329,8 +1233,7 @@ InstallVBRToPartition( { return InstallBtrfsBootcodeToPartition(SystemRootPath, SourceRootPath, - DestinationArcPath, - PartitionType); + DestinationArcPath); } case PARTITION_IFS: @@ -2405,11 +1308,11 @@ InstallFatBootcodeToFloppy( CombinePaths(SrcPath, ARRAYSIZE(SrcPath), 2, SourceRootPath->Buffer, L"\\loader\\fat.bin"); CombinePaths(DstPath, ARRAYSIZE(DstPath), 1, FloppyDevice); - DPRINT("Install FAT bootcode: %S ==> %S\n", SrcPath, DstPath); - Status = InstallFat12BootCodeToFloppy(SrcPath, DstPath); + DPRINT("Install FAT12 bootcode: %S ==> %S\n", SrcPath, DstPath); + Status = InstallBootCodeToDisk(SrcPath, DstPath, InstallFat12BootCode); if (!NT_SUCCESS(Status)) { - DPRINT1("InstallFat12BootCodeToFloppy() failed (Status %lx)\n", Status); + DPRINT1("InstallBootCodeToDisk(FAT12) failed (Status %lx)\n", Status); return Status; } diff --git a/base/setup/lib/fsutil.c b/base/setup/lib/fsutil.c index 2abe8e4c7a8..9bd0aee4c2a 100644 --- a/base/setup/lib/fsutil.c +++ b/base/setup/lib/fsutil.c @@ -3,7 +3,7 @@ * LICENSE: GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+) * PURPOSE: Filesystem support functions * COPYRIGHT: Copyright 2003-2019 Casper S. Hornstrup (chorns(a)users.sourceforge.net) - * Copyright 2017-2019 Hermes Belusca-Maito + * Copyright 2017-2020 Hermes Belusca-Maito */ // @@ -18,6 +18,7 @@ #include "partlist.h" #include "fsrec.h" +#include "bootcode.h" #include "fsutil.h" #include <fslib/vfatlib.h> @@ -29,6 +30,92 @@ #include <debug.h> +/* TYPEDEFS *****************************************************************/ + +#include <pshpack1.h> +typedef struct _FAT_BOOTSECTOR +{ + UCHAR JumpBoot[3]; // Jump instruction to boot code + CHAR OemName[8]; // "MSWIN4.1" for MS formatted volumes + USHORT BytesPerSector; // Bytes per sector + UCHAR SectorsPerCluster; // Number of sectors in a cluster + USHORT ReservedSectors; // Reserved sectors, usually 1 (the bootsector) + UCHAR NumberOfFats; // Number of FAT tables + USHORT RootDirEntries; // Number of root directory entries (fat12/16) + USHORT TotalSectors; // Number of total sectors on the drive, 16-bit + UCHAR MediaDescriptor; // Media descriptor byte + USHORT SectorsPerFat; // Sectors per FAT table (fat12/16) + USHORT SectorsPerTrack; // Number of sectors in a track + USHORT NumberOfHeads; // Number of heads on the disk + ULONG HiddenSectors; // Hidden sectors (sectors before the partition start like the partition table) + ULONG TotalSectorsBig; // This field is the new 32-bit total count of sectors on the volume + UCHAR DriveNumber; // Int 0x13 drive number (e.g. 0x80) + UCHAR Reserved1; // Reserved (used by Windows NT). Code that formats FAT volumes should always set this byte to 0. + UCHAR BootSignature; // Extended boot signature (0x29). This is a signature byte that indicates that the following three fields in the boot sector are present. + ULONG VolumeSerialNumber; // Volume serial number + CHAR VolumeLabel[11]; // Volume label. This field matches the 11-byte volume label recorded in the root directory + CHAR FileSystemType[8]; // One of the strings "FAT12 ", "FAT16 ", or "FAT " + + UCHAR BootCodeAndData[448]; // The remainder of the boot sector + + USHORT BootSectorMagic; // 0xAA55 + +} FAT_BOOTSECTOR, *PFAT_BOOTSECTOR; +C_ASSERT(sizeof(FAT_BOOTSECTOR) == FAT_BOOTSECTOR_SIZE); + +typedef struct _FAT32_BOOTSECTOR +{ + UCHAR JumpBoot[3]; // Jump instruction to boot code + CHAR OemName[8]; // "MSWIN4.1" for MS formatted volumes + USHORT BytesPerSector; // Bytes per sector + UCHAR SectorsPerCluster; // Number of sectors in a cluster + USHORT ReservedSectors; // Reserved sectors, usually 1 (the bootsector) + UCHAR NumberOfFats; // Number of FAT tables + USHORT RootDirEntries; // Number of root directory entries (fat12/16) + USHORT TotalSectors; // Number of total sectors on the drive, 16-bit + UCHAR MediaDescriptor; // Media descriptor byte + USHORT SectorsPerFat; // Sectors per FAT table (fat12/16) + USHORT SectorsPerTrack; // Number of sectors in a track + USHORT NumberOfHeads; // Number of heads on the disk + ULONG HiddenSectors; // Hidden sectors (sectors before the partition start like the partition table) + ULONG TotalSectorsBig; // This field is the new 32-bit total count of sectors on the volume + ULONG SectorsPerFatBig; // This field is the FAT32 32-bit count of sectors occupied by ONE FAT. BPB_FATSz16 must be 0 + USHORT ExtendedFlags; // Extended flags (fat32) + USHORT FileSystemVersion; // File system version (fat32) + ULONG RootDirStartCluster; // Starting cluster of the root directory (fat32) + USHORT FsInfo; // Sector number of FSINFO structure in the reserved area of the FAT32 volume. Usually 1. + USHORT BackupBootSector; // If non-zero, indicates the sector number in the reserved area of the volume of a copy of the boot record. Usually 6. + UCHAR Reserved[12]; // Reserved for future expansion + UCHAR DriveNumber; // Int 0x13 drive number (e.g. 0x80) + UCHAR Reserved1; // Reserved (used by Windows NT). Code that formats FAT volumes should always set this byte to 0. + UCHAR BootSignature; // Extended boot signature (0x29). This is a signature byte that indicates that the following three fields in the boot sector are present. + ULONG VolumeSerialNumber; // Volume serial number + CHAR VolumeLabel[11]; // Volume label. This field matches the 11-byte volume label recorded in the root directory + CHAR FileSystemType[8]; // Always set to the string "FAT32 " + + UCHAR BootCodeAndData[420]; // The remainder of the boot sector + + USHORT BootSectorMagic; // 0xAA55 + +} FAT32_BOOTSECTOR, *PFAT32_BOOTSECTOR; +C_ASSERT(sizeof(FAT32_BOOTSECTOR) == FAT32_BOOTSECTOR_SIZE); + +typedef struct _BTRFS_BOOTSECTOR +{ + UCHAR JumpBoot[3]; + UCHAR ChunkMapSize; + UCHAR BootDrive; + ULONGLONG PartitionStartLBA; + UCHAR Fill[1521]; // 1536 - 15 + USHORT BootSectorMagic; +} BTRFS_BOOTSECTOR, *PBTRFS_BOOTSECTOR; +C_ASSERT(sizeof(BTRFS_BOOTSECTOR) == BTRFS_BOOTSECTOR_SIZE); + +// TODO: Add more bootsector structures! + +#include <poppack.h> + + /* LOCALS *******************************************************************/ /** IFS_PROVIDER **/ @@ -238,6 +325,297 @@ FormatFileSystem( } +// +// Bootsector routines +// + +NTSTATUS +InstallFat1216BootCode( + IN PCWSTR SrcPath, // FAT12/16 bootsector source file (on the installation medium) + IN HANDLE DstPath, // Where to save the bootsector built from the source + partition information + IN HANDLE RootPartition) // Partition holding the (old) FAT12/16 information +{ + NTSTATUS Status; + UNICODE_STRING Name; + IO_STATUS_BLOCK IoStatusBlock; + LARGE_INTEGER FileOffset; + BOOTCODE OrigBootSector = {0}; + BOOTCODE NewBootSector = {0}; + + /* Allocate and read the current original partition bootsector */ + Status = ReadBootCodeByHandle(&OrigBootSector, + RootPartition, + FAT_BOOTSECTOR_SIZE); + if (!NT_SUCCESS(Status)) + return Status; + + /* Allocate and read the new bootsector from SrcPath */ + RtlInitUnicodeString(&Name, SrcPath); + Status = ReadBootCodeFromFile(&NewBootSector, + &Name, + FAT_BOOTSECTOR_SIZE); + if (!NT_SUCCESS(Status)) + { + FreeBootCode(&OrigBootSector); + return Status; + } + + /* Adjust the bootsector (copy a part of the FAT12/16 BPB) */ + RtlCopyMemory(&((PFAT_BOOTSECTOR)NewBootSector.BootCode)->OemName, + &((PFAT_BOOTSECTOR)OrigBootSector.BootCode)->OemName, + FIELD_OFFSET(FAT_BOOTSECTOR, BootCodeAndData) - + FIELD_OFFSET(FAT_BOOTSECTOR, OemName)); + + /* Free the original bootsector */ + FreeBootCode(&OrigBootSector); + + /* Write the new bootsector to DstPath */ + FileOffset.QuadPart = 0ULL; + Status = NtWriteFile(DstPath, + NULL, + NULL, + NULL, + &IoStatusBlock, + NewBootSector.BootCode, + NewBootSector.Length, + &FileOffset, + NULL); + + /* Free the new bootsector */ + FreeBootCode(&NewBootSector); + + return Status; +} + +NTSTATUS +InstallFat32BootCode( + IN PCWSTR SrcPath, // FAT32 bootsector source file (on the installation medium) + IN HANDLE DstPath, // Where to save the bootsector built from the source + partition information + IN HANDLE RootPartition) // Partition holding the (old) FAT32 information +{ + NTSTATUS Status; + UNICODE_STRING Name; + IO_STATUS_BLOCK IoStatusBlock; + LARGE_INTEGER FileOffset; + USHORT BackupBootSector = 0; + BOOTCODE OrigBootSector = {0}; + BOOTCODE NewBootSector = {0}; + + /* Allocate and read the current original partition bootsector */ + Status = ReadBootCodeByHandle(&OrigBootSector, + RootPartition, + FAT32_BOOTSECTOR_SIZE); + if (!NT_SUCCESS(Status)) + return Status; + + /* Allocate and read the new bootsector (2 sectors) from SrcPath */ + RtlInitUnicodeString(&Name, SrcPath); + Status = ReadBootCodeFromFile(&NewBootSector, + &Name, + 2 * FAT32_BOOTSECTOR_SIZE); + if (!NT_SUCCESS(Status)) + { + FreeBootCode(&OrigBootSector); + return Status; + } + + /* Adjust the bootsector (copy a part of the FAT32 BPB) */ + RtlCopyMemory(&((PFAT32_BOOTSECTOR)NewBootSector.BootCode)->OemName, + &((PFAT32_BOOTSECTOR)OrigBootSector.BootCode)->OemName, + FIELD_OFFSET(FAT32_BOOTSECTOR, BootCodeAndData) - + FIELD_OFFSET(FAT32_BOOTSECTOR, OemName)); + + /* + * We know we copy the boot code to a file only when DstPath != RootPartition, + * otherwise the boot code is copied to the specified root partition. + */ + if (DstPath != RootPartition) + { + /* Copy to a file: Disable the backup bootsector */ + ((PFAT32_BOOTSECTOR)NewBootSector.BootCode)->BackupBootSector = 0; + } + else + { + /* Copy to a disk: Get the location of the backup bootsector */ + BackupBootSector = ((PFAT32_BOOTSECTOR)OrigBootSector.BootCode)->BackupBootSector; + } + + /* Free the original bootsector */ + FreeBootCode(&OrigBootSector); + + /* Write the first sector of the new bootcode to DstPath sector 0 */ + FileOffset.QuadPart = 0ULL; + Status = NtWriteFile(DstPath, + NULL, + NULL, + NULL, + &IoStatusBlock, + NewBootSector.BootCode, + FAT32_BOOTSECTOR_SIZE, + &FileOffset, + NULL); + if (!NT_SUCCESS(Status)) + { + DPRINT1("NtWriteFile() failed (Status %lx)\n", Status); + FreeBootCode(&NewBootSector); + return Status; + } + + if (DstPath == RootPartition) + { + /* Copy to a disk: Write the backup bootsector */ + if ((BackupBootSector != 0x0000) && (BackupBootSector != 0xFFFF)) + { + FileOffset.QuadPart = (ULONGLONG)((ULONG)BackupBootSector * FAT32_BOOTSECTOR_SIZE); + Status = NtWriteFile(DstPath, + NULL, + NULL, + NULL, + &IoStatusBlock, + NewBootSector.BootCode, + FAT32_BOOTSECTOR_SIZE, + &FileOffset, + NULL); + if (!NT_SUCCESS(Status)) + { + DPRINT1("NtWriteFile() failed (Status %lx)\n", Status); + FreeBootCode(&NewBootSector); + return Status; + } + } + } + + /* Write the second sector of the new bootcode to boot disk sector 14 */ + // FileOffset.QuadPart = (ULONGLONG)(14 * FAT32_BOOTSECTOR_SIZE); + FileOffset.QuadPart = 14 * FAT32_BOOTSECTOR_SIZE; + Status = NtWriteFile(DstPath, // or really RootPartition ??? + NULL, + NULL, + NULL, + &IoStatusBlock, + ((PUCHAR)NewBootSector.BootCode + FAT32_BOOTSECTOR_SIZE), + FAT32_BOOTSECTOR_SIZE, + &FileOffset, + NULL); + if (!NT_SUCCESS(Status)) + { + DPRINT1("NtWriteFile() failed (Status %lx)\n", Status); + } + + /* Free the new bootsector */ + FreeBootCode(&NewBootSector); + + return Status; +} + +NTSTATUS +InstallBtrfsBootCode( + IN PCWSTR SrcPath, // BTRFS bootsector source file (on the installation medium) + IN HANDLE DstPath, // Where to save the bootsector built from the source + partition information + IN HANDLE RootPartition) // Partition holding the (old) BTRFS information +{ + NTSTATUS Status; + NTSTATUS LockStatus; + UNICODE_STRING Name; + IO_STATUS_BLOCK IoStatusBlock; + LARGE_INTEGER FileOffset; + PARTITION_INFORMATION_EX PartInfo; + BOOTCODE NewBootSector = {0}; + + /* Allocate and read the new bootsector from SrcPath */ + RtlInitUnicodeString(&Name, SrcPath); + Status = ReadBootCodeFromFile(&NewBootSector, + &Name, + BTRFS_BOOTSECTOR_SIZE); + if (!NT_SUCCESS(Status)) + return Status; + + /* + * The BTRFS driver requires the volume to be locked in order to modify + * the first sectors of the partition, even though they are outside the + * file-system space / in the reserved area (they are situated before + * the super-block at 0x1000) and is in principle allowed by the NT + * storage stack. + * So we lock here in order to write the bootsector at sector 0. + * If locking fails, we ignore and continue nonetheless. + */ + LockStatus = NtFsControlFile(DstPath, + NULL, + NULL, + NULL, + &IoStatusBlock, + FSCTL_LOCK_VOLUME, + NULL, + 0, + NULL, + 0); + if (!NT_SUCCESS(LockStatus)) + { + DPRINT1("WARNING: Failed to lock BTRFS volume for writing bootsector! Operations may fail! (Status 0x%lx)\n", LockStatus); + } + + /* Obtain partition info and write it to the bootsector */ + Status = NtDeviceIoControlFile(RootPartition, + NULL, + NULL, + NULL, + &IoStatusBlock, + IOCTL_DISK_GET_PARTITION_INFO_EX, + NULL, + 0, + &PartInfo, + sizeof(PartInfo)); + if (!NT_SUCCESS(Status)) + { + DPRINT1("IOCTL_DISK_GET_PARTITION_INFO_EX failed (Status %lx)\n", Status); + goto Quit; + } + + /* Write new bootsector to RootPath */ + ((PBTRFS_BOOTSECTOR)NewBootSector.BootCode)->PartitionStartLBA = + PartInfo.StartingOffset.QuadPart / SECTORSIZE; + + /* Write sector 0 */ + FileOffset.QuadPart = 0ULL; + Status = NtWriteFile(DstPath, + NULL, + NULL, + NULL, + &IoStatusBlock, + NewBootSector.BootCode, + NewBootSector.Length, + &FileOffset, + NULL); + if (!NT_SUCCESS(Status)) + { + DPRINT1("NtWriteFile() failed (Status %lx)\n", Status); + goto Quit; + } + +Quit: + /* Unlock the volume */ + LockStatus = NtFsControlFile(DstPath, + NULL, + NULL, + NULL, + &IoStatusBlock, + FSCTL_UNLOCK_VOLUME, + NULL, + 0, + NULL, + 0); + if (!NT_SUCCESS(LockStatus)) + { + DPRINT1("Failed to unlock BTRFS volume (Status 0x%lx)\n", LockStatus); + } + + /* Free the new bootsector */ + FreeBootCode(&NewBootSector); + + return Status; +} + + // // Formatting routines // diff --git a/base/setup/lib/fsutil.h b/base/setup/lib/fsutil.h index dd2fb3e5964..d4518885b9f 100644 --- a/base/setup/lib/fsutil.h +++ b/base/setup/lib/fsutil.h @@ -3,7 +3,7 @@ * LICENSE: GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+) * PURPOSE: Filesystem support functions * COPYRIGHT: Copyright 2003-2019 Casper S. Hornstrup (chorns(a)users.sourceforge.net) - * Copyright 2017-2019 Hermes Belusca-Maito + * Copyright 2017-2020 Hermes Belusca-Maito */ #pragma once @@ -61,6 +61,42 @@ FormatFileSystem( IN PFMIFSCALLBACK Callback); +// +// Bootsector routines +// + +#define FAT_BOOTSECTOR_SIZE (1 * SECTORSIZE) +#define FAT32_BOOTSECTOR_SIZE (1 * SECTORSIZE) // Counts only the primary sector. +#define BTRFS_BOOTSECTOR_SIZE (3 * SECTORSIZE) + +typedef NTSTATUS +(/*NTAPI*/ *PFS_INSTALL_BOOTCODE)( + IN PCWSTR SrcPath, // Bootsector source file (on the installation medium) + IN HANDLE DstPath, // Where to save the bootsector built from the source + partition information + IN HANDLE RootPartition); // Partition holding the (old) bootsector data information + +NTSTATUS +InstallFat1216BootCode( + IN PCWSTR SrcPath, + IN HANDLE DstPath, + IN HANDLE RootPartition); + +#define InstallFat12BootCode InstallFat1216BootCode +#define InstallFat16BootCode InstallFat1216BootCode + +NTSTATUS +InstallFat32BootCode( + IN PCWSTR SrcPath, + IN HANDLE DstPath, + IN HANDLE RootPartition); + +NTSTATUS +InstallBtrfsBootCode( + IN PCWSTR SrcPath, + IN HANDLE DstPath, + IN HANDLE RootPartition); + + // // Formatting routines // diff --git a/base/setup/lib/setuplib.h b/base/setup/lib/setuplib.h index 15358f24885..2dcb349f369 100644 --- a/base/setup/lib/setuplib.h +++ b/base/setup/lib/setuplib.h @@ -31,16 +31,17 @@ extern HANDLE ProcessHeap; #include "utils/ntverrsrc.h" // #include "utils/arcname.h" #include "utils/bldrsup.h" -#include "bootsup.h" #include "utils/filesup.h" #include "utils/fsrec.h" -#include "fsutil.h" #include "utils/genlist.h" #include "utils/inicache.h" #include "utils/partlist.h" #include "utils/arcname.h" #include "utils/osdetect.h" #include "utils/regutil.h" +#include "bootcode.h" +#include "fsutil.h" +#include "bootsup.h" #include "registry.h" #include "mui.h" #include "settings.h"

1 0

[reactos] 01/02: [SETUPLIB] Move the filesystem recognition helpers to their own file.
by Hermès Bélusca-Maïto 18 Oct '20

18 Oct '20

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=b51b8ee2d527b7a7f640e… commit b51b8ee2d527b7a7f640e4a4a740738ce7d34d93 Author: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> AuthorDate: Sun Oct 11 23:42:02 2020 +0200 Commit: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> CommitDate: Sun Oct 18 20:56:16 2020 +0200 [SETUPLIB] Move the filesystem recognition helpers to their own file. --- base/setup/lib/CMakeLists.txt | 1 + base/setup/lib/fsutil.c | 294 +---------------------------- base/setup/lib/fsutil.h | 39 ---- base/setup/lib/setuplib.h | 1 + base/setup/lib/{fsutil.c => utils/fsrec.c} | 272 +------------------------- base/setup/lib/utils/fsrec.h | 49 +++++ base/setup/lib/utils/partlist.c | 2 +- 7 files changed, 58 insertions(+), 600 deletions(-) diff --git a/base/setup/lib/CMakeLists.txt b/base/setup/lib/CMakeLists.txt index 0d2f3a8aeb5..ff23bc57d16 100644 --- a/base/setup/lib/CMakeLists.txt +++ b/base/setup/lib/CMakeLists.txt @@ -9,6 +9,7 @@ list(APPEND SOURCE utils/arcname.c utils/bldrsup.c utils/filesup.c + utils/fsrec.c utils/genlist.c utils/inicache.c utils/ntverrsrc.c diff --git a/base/setup/lib/fsutil.c b/base/setup/lib/fsutil.c index 89555184650..2abe8e4c7a8 100644 --- a/base/setup/lib/fsutil.c +++ b/base/setup/lib/fsutil.c @@ -16,8 +16,9 @@ #include "precomp.h" -#include "fsutil.h" #include "partlist.h" +#include "fsrec.h" +#include "fsutil.h" #include <fslib/vfatlib.h> #include <fslib/btrfslib.h> @@ -128,222 +129,6 @@ GetFileSystemByName( } -// -// FileSystem recognition, using NT OS functionality -// - -/* NOTE: Ripped & adapted from base/system/autochk/autochk.c */ -NTSTATUS -GetFileSystemNameByHandle( - IN HANDLE PartitionHandle, - IN OUT PWSTR FileSystemName, - IN SIZE_T FileSystemNameSize) -{ - NTSTATUS Status; - IO_STATUS_BLOCK IoStatusBlock; - UCHAR Buffer[sizeof(FILE_FS_ATTRIBUTE_INFORMATION) + MAX_PATH * sizeof(WCHAR)]; - PFILE_FS_ATTRIBUTE_INFORMATION FileFsAttribute = (PFILE_FS_ATTRIBUTE_INFORMATION)Buffer; - - /* Retrieve the FS attributes */ - Status = NtQueryVolumeInformationFile(PartitionHandle, - &IoStatusBlock, - FileFsAttribute, - sizeof(Buffer), - FileFsAttributeInformation); - if (!NT_SUCCESS(Status)) - { - DPRINT1("NtQueryVolumeInformationFile failed, Status 0x%08lx\n", Status); - return Status; - } - - if (FileSystemNameSize < FileFsAttribute->FileSystemNameLength + sizeof(WCHAR)) - return STATUS_BUFFER_TOO_SMALL; - - return RtlStringCbCopyNW(FileSystemName, FileSystemNameSize, - FileFsAttribute->FileSystemName, - FileFsAttribute->FileSystemNameLength); -} - -NTSTATUS -GetFileSystemName_UStr( - IN PUNICODE_STRING PartitionPath, - IN OUT PWSTR FileSystemName, - IN SIZE_T FileSystemNameSize) -{ - NTSTATUS Status; - OBJECT_ATTRIBUTES ObjectAttributes; - HANDLE PartitionHandle; - IO_STATUS_BLOCK IoStatusBlock; - - /* Open the partition */ - InitializeObjectAttributes(&ObjectAttributes, - PartitionPath, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - Status = NtOpenFile(&PartitionHandle, - FILE_GENERIC_READ /* | SYNCHRONIZE */, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - 0 /* FILE_SYNCHRONOUS_IO_NONALERT */); - if (!NT_SUCCESS(Status)) - { - DPRINT1("Failed to open partition '%wZ', Status 0x%08lx\n", PartitionPath, Status); - return Status; - } - - /* Retrieve the FS attributes */ - Status = GetFileSystemNameByHandle(PartitionHandle, FileSystemName, FileSystemNameSize); - if (!NT_SUCCESS(Status)) - { - DPRINT1("GetFileSystemNameByHandle() failed for partition '%wZ', Status 0x%08lx\n", - PartitionPath, Status); - } - - /* Close the partition */ - NtClose(PartitionHandle); - - return Status; -} - -NTSTATUS -GetFileSystemName( - IN PCWSTR Partition, - IN OUT PWSTR FileSystemName, - IN SIZE_T FileSystemNameSize) -{ - UNICODE_STRING PartitionPath; - - RtlInitUnicodeString(&PartitionPath, Partition); - return GetFileSystemName_UStr(&PartitionPath, - FileSystemName, - FileSystemNameSize); -} - -NTSTATUS -InferFileSystemByHandle( - IN HANDLE PartitionHandle, - IN UCHAR PartitionType, - IN OUT PWSTR FileSystemName, - IN SIZE_T FileSystemNameSize) -{ - NTSTATUS Status; - - if (FileSystemNameSize < sizeof(WCHAR)) - return STATUS_BUFFER_TOO_SMALL; - - *FileSystemName = L'\0'; - - /* Try to infer a file system using NT file system recognition */ - Status = GetFileSystemNameByHandle(PartitionHandle, - FileSystemName, - FileSystemNameSize); - if (NT_SUCCESS(Status) && *FileSystemName) - { - goto Quit; - } - - /* - * Try to infer a preferred file system for this partition, given its ID. - * - * WARNING: This is partly a hack, since partitions with the same ID can - * be formatted with different file systems: for example, usual Linux - * partitions that are formatted in EXT2/3/4, ReiserFS, etc... have the - * same partition ID 0x83. - * - * The proper fix is to make a function that detects the existing FS - * from a given partition (not based on the partition ID). - * On the contrary, for unformatted partitions with a given ID, the - * following code is OK. - */ - if ((PartitionType == PARTITION_FAT_12) || - (PartitionType == PARTITION_FAT_16) || - (PartitionType == PARTITION_HUGE ) || - (PartitionType == PARTITION_XINT13)) - { - /* FAT12 or FAT16 */ - Status = RtlStringCbCopyW(FileSystemName, FileSystemNameSize, L"FAT"); - } - else if ((PartitionType == PARTITION_FAT32) || - (PartitionType == PARTITION_FAT32_XINT13)) - { - Status = RtlStringCbCopyW(FileSystemName, FileSystemNameSize, L"FAT32"); - } - else if (PartitionType == PARTITION_LINUX) - { - // WARNING: See the warning above. - /* Could also be EXT2/3/4, ReiserFS, ... */ - Status = RtlStringCbCopyW(FileSystemName, FileSystemNameSize, L"BTRFS"); - } - else if (PartitionType == PARTITION_IFS) - { - // WARNING: See the warning above. - /* Could also be HPFS */ - Status = RtlStringCbCopyW(FileSystemName, FileSystemNameSize, L"NTFS"); - } - -Quit: - if (*FileSystemName) - { - // WARNING: We cannot write on this FS yet! - if (PartitionType == PARTITION_IFS) - { - DPRINT1("Recognized file system '%S' that doesn't have write support yet!\n", - FileSystemName); - } - } - - DPRINT1("InferFileSystem -- PartitionType: 0x%02X ; FileSystem (guessed): %S\n", - PartitionType, *FileSystemName ? FileSystemName : L"None"); - - return Status; -} - -NTSTATUS -InferFileSystem( - IN PCWSTR Partition, - IN UCHAR PartitionType, - IN OUT PWSTR FileSystemName, - IN SIZE_T FileSystemNameSize) -{ - NTSTATUS Status; - UNICODE_STRING PartitionPath; - OBJECT_ATTRIBUTES ObjectAttributes; - HANDLE PartitionHandle; - IO_STATUS_BLOCK IoStatusBlock; - - /* Open the partition */ - RtlInitUnicodeString(&PartitionPath, Partition); - InitializeObjectAttributes(&ObjectAttributes, - &PartitionPath, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - Status = NtOpenFile(&PartitionHandle, - FILE_GENERIC_READ /* | SYNCHRONIZE */, - &ObjectAttributes, - &IoStatusBlock, - FILE_SHARE_READ | FILE_SHARE_WRITE, - 0 /* FILE_SYNCHRONOUS_IO_NONALERT */); - if (!NT_SUCCESS(Status)) - { - DPRINT1("Failed to open partition '%wZ', Status 0x%08lx\n", &PartitionPath, Status); - return Status; - } - - /* Retrieve the FS */ - Status = InferFileSystemByHandle(PartitionHandle, - PartitionType, - FileSystemName, - FileSystemNameSize); - - /* Close the partition */ - NtClose(PartitionHandle); - - return Status; -} - /** ChkdskEx() **/ NTSTATUS ChkdskFileSystem_UStr( @@ -453,81 +238,6 @@ FormatFileSystem( } -UCHAR -FileSystemToPartitionType( - IN PCWSTR FileSystem, - IN PULARGE_INTEGER StartSector, - IN PULARGE_INTEGER SectorCount) -{ - ASSERT(FileSystem && StartSector && SectorCount); - - if (wcsicmp(FileSystem, L"FAT") == 0 || - wcsicmp(FileSystem, L"FAT32") == 0 || - wcsicmp(FileSystem, L"RAW") == 0) - { - if (SectorCount->QuadPart < 8192) - { - /* FAT12 CHS partition (disk is smaller than 4.1MB) */ - return PARTITION_FAT_12; - } - else if (StartSector->QuadPart < 1450560) - { - /* Partition starts below the 8.4GB boundary ==> CHS partition */ - - if (SectorCount->QuadPart < 65536) - { - /* FAT16 CHS partition (partition size < 32MB) */ - return PARTITION_FAT_16; - } - else if (SectorCount->QuadPart < 1048576) - { - /* FAT16 CHS partition (partition size < 512MB) */ - return PARTITION_HUGE; - } - else - { - /* FAT32 CHS partition (partition size >= 512MB) */ - return PARTITION_FAT32; - } - } - else - { - /* Partition starts above the 8.4GB boundary ==> LBA partition */ - - if (SectorCount->QuadPart < 1048576) - { - /* FAT16 LBA partition (partition size < 512MB) */ - return PARTITION_XINT13; - } - else - { - /* FAT32 LBA partition (partition size >= 512MB) */ - return PARTITION_FAT32_XINT13; - } - } - } - else if (wcsicmp(FileSystem, L"NTFS") == 0) - { - return PARTITION_IFS; - } - else if (wcsicmp(FileSystem, L"BTRFS") == 0 || - wcsicmp(FileSystem, L"EXT2") == 0 || - wcsicmp(FileSystem, L"EXT3") == 0 || - wcsicmp(FileSystem, L"EXT4") == 0 || - wcsicmp(FileSystem, L"FFS") == 0 || - wcsicmp(FileSystem, L"REISERFS") == 0) - { - return PARTITION_LINUX; - } - else - { - /* Unknown file system */ - DPRINT1("Unknown file system '%S'\n", FileSystem); - return PARTITION_ENTRY_UNUSED; - } -} - - // // Formatting routines // diff --git a/base/setup/lib/fsutil.h b/base/setup/lib/fsutil.h index f6c83e953f7..dd2fb3e5964 100644 --- a/base/setup/lib/fsutil.h +++ b/base/setup/lib/fsutil.h @@ -16,38 +16,6 @@ GetRegisteredFileSystems( IN ULONG Index, OUT PCWSTR* FileSystemName); -NTSTATUS -GetFileSystemNameByHandle( - IN HANDLE PartitionHandle, - IN OUT PWSTR FileSystemName, - IN SIZE_T FileSystemNameSize); - -NTSTATUS -GetFileSystemName_UStr( - IN PUNICODE_STRING PartitionPath, - IN OUT PWSTR FileSystemName, - IN SIZE_T FileSystemNameSize); - -NTSTATUS -GetFileSystemName( - IN PCWSTR Partition, - IN OUT PWSTR FileSystemName, - IN SIZE_T FileSystemNameSize); - -NTSTATUS -InferFileSystemByHandle( - IN HANDLE PartitionHandle, - IN UCHAR PartitionType, - IN OUT PWSTR FileSystemName, - IN SIZE_T FileSystemNameSize); - -NTSTATUS -InferFileSystem( - IN PCWSTR Partition, - IN UCHAR PartitionType, - IN OUT PWSTR FileSystemName, - IN SIZE_T FileSystemNameSize); - /** ChkdskEx() **/ NTSTATUS @@ -93,13 +61,6 @@ FormatFileSystem( IN PFMIFSCALLBACK Callback); -UCHAR -FileSystemToPartitionType( - IN PCWSTR FileSystem, - IN PULARGE_INTEGER StartSector, - IN PULARGE_INTEGER SectorCount); - - // // Formatting routines // diff --git a/base/setup/lib/setuplib.h b/base/setup/lib/setuplib.h index 7149d1ffb31..15358f24885 100644 --- a/base/setup/lib/setuplib.h +++ b/base/setup/lib/setuplib.h @@ -33,6 +33,7 @@ extern HANDLE ProcessHeap; #include "utils/bldrsup.h" #include "bootsup.h" #include "utils/filesup.h" +#include "utils/fsrec.h" #include "fsutil.h" #include "utils/genlist.h" #include "utils/inicache.h" diff --git a/base/setup/lib/fsutil.c b/base/setup/lib/utils/fsrec.c similarity index 56% copy from base/setup/lib/fsutil.c copy to base/setup/lib/utils/fsrec.c index 89555184650..918e2fb69a3 100644 --- a/base/setup/lib/fsutil.c +++ b/base/setup/lib/utils/fsrec.c @@ -1,137 +1,23 @@ /* * PROJECT: ReactOS Setup Library * LICENSE: GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+) - * PURPOSE: Filesystem support functions - * COPYRIGHT: Copyright 2003-2019 Casper S. Hornstrup (chorns(a)users.sourceforge.net) - * Copyright 2017-2019 Hermes Belusca-Maito + * PURPOSE: Filesystem Recognition support functions, + * using NT OS functionality. + * COPYRIGHT: Copyright 2017-2020 Hermes Belusca-Maito */ -// -// See also: https://git.reactos.org/?p=reactos.git;a=blob;f=reactos/dll/win32/fmifs/ini… -// for how to get FS providers in a dynamic way. In the (near) future we may -// consider merging some of this code with us into a fmifs / fsutil / fslib library... -// - /* INCLUDES *****************************************************************/ #include "precomp.h" -#include "fsutil.h" -#include "partlist.h" - -#include <fslib/vfatlib.h> -#include <fslib/btrfslib.h> -// #include <fslib/ext2lib.h> -// #include <fslib/ntfslib.h> +#include "fsrec.h" #define NDEBUG #include <debug.h> -/* LOCALS *******************************************************************/ - -/** IFS_PROVIDER **/ -typedef struct _FILE_SYSTEM -{ - PCWSTR FileSystemName; - FORMATEX FormatFunc; - CHKDSKEX ChkdskFunc; -} FILE_SYSTEM, *PFILE_SYSTEM; - -/* The list of file systems on which we can install ReactOS */ -static FILE_SYSTEM RegisteredFileSystems[] = -{ - /* NOTE: The FAT formatter automatically determines - * whether it will use FAT-16 or FAT-32. */ - { L"FAT" , VfatFormat, VfatChkdsk }, -#if 0 - { L"FAT32", VfatFormat, VfatChkdsk }, // Do we support specific FAT sub-formats specifications? - { L"FATX" , VfatxFormat, VfatxChkdsk }, - { L"NTFS" , NtfsFormat, NtfsChkdsk }, -#endif - { L"BTRFS", BtrfsFormatEx, BtrfsChkdskEx }, -#if 0 - { L"EXT2" , Ext2Format, Ext2Chkdsk }, - { L"EXT3" , Ext2Format, Ext2Chkdsk }, - { L"EXT4" , Ext2Format, Ext2Chkdsk }, - { L"FFS" , FfsFormat , FfsChkdsk }, - { L"REISERFS", ReiserfsFormat, ReiserfsChkdsk }, -#endif -}; - - /* FUNCTIONS ****************************************************************/ -/** QueryAvailableFileSystemFormat() **/ -BOOLEAN -GetRegisteredFileSystems( - IN ULONG Index, - OUT PCWSTR* FileSystemName) -{ - if (Index >= ARRAYSIZE(RegisteredFileSystems)) - return FALSE; - - *FileSystemName = RegisteredFileSystems[Index].FileSystemName; - - return TRUE; -} - - -/** GetProvider() **/ -static PFILE_SYSTEM -GetFileSystemByName( - IN PCWSTR FileSystemName) -{ -#if 0 // Reenable when the list of registered FSes will again be dynamic - - PLIST_ENTRY ListEntry; - PFILE_SYSTEM_ITEM Item; - - ListEntry = List->ListHead.Flink; - while (ListEntry != &List->ListHead) - { - Item = CONTAINING_RECORD(ListEntry, FILE_SYSTEM_ITEM, ListEntry); - if (Item->FileSystemName && - (wcsicmp(FileSystemName, Item->FileSystemName) == 0 || - /* Map FAT32 back to FAT */ - (wcsicmp(FileSystemName, L"FAT32") == 0 && wcsicmp(Item->FileSystemName, L"FAT") == 0))) - { - return Item; - } - - ListEntry = ListEntry->Flink; - } - -#else - - ULONG Count = ARRAYSIZE(RegisteredFileSystems); - PFILE_SYSTEM FileSystems = RegisteredFileSystems; - - ASSERT(FileSystems && Count != 0); - - while (Count--) - { - if (FileSystems->FileSystemName && - (wcsicmp(FileSystemName, FileSystems->FileSystemName) == 0 || - /* Map FAT32 back to FAT */ - (wcsicmp(FileSystemName, L"FAT32") == 0 && wcsicmp(FileSystems->FileSystemName, L"FAT") == 0))) - { - return FileSystems; - } - - ++FileSystems; - } - -#endif - - return NULL; -} - - -// -// FileSystem recognition, using NT OS functionality -// - /* NOTE: Ripped & adapted from base/system/autochk/autochk.c */ NTSTATUS GetFileSystemNameByHandle( @@ -344,115 +230,6 @@ InferFileSystem( return Status; } -/** ChkdskEx() **/ -NTSTATUS -ChkdskFileSystem_UStr( - IN PUNICODE_STRING DriveRoot, - IN PCWSTR FileSystemName, - IN BOOLEAN FixErrors, - IN BOOLEAN Verbose, - IN BOOLEAN CheckOnlyIfDirty, - IN BOOLEAN ScanDrive, - IN PFMIFSCALLBACK Callback) -{ - PFILE_SYSTEM FileSystem; - - FileSystem = GetFileSystemByName(FileSystemName); - - if (!FileSystem || !FileSystem->ChkdskFunc) - { - // BOOLEAN Argument = FALSE; - // Callback(DONE, 0, &Argument); - return STATUS_NOT_SUPPORTED; - } - - return FileSystem->ChkdskFunc(DriveRoot, - FixErrors, - Verbose, - CheckOnlyIfDirty, - ScanDrive, - Callback); -} - -NTSTATUS -ChkdskFileSystem( - IN PCWSTR DriveRoot, - IN PCWSTR FileSystemName, - IN BOOLEAN FixErrors, - IN BOOLEAN Verbose, - IN BOOLEAN CheckOnlyIfDirty, - IN BOOLEAN ScanDrive, - IN PFMIFSCALLBACK Callback) -{ - UNICODE_STRING DriveRootU; - - RtlInitUnicodeString(&DriveRootU, DriveRoot); - return ChkdskFileSystem_UStr(&DriveRootU, - FileSystemName, - FixErrors, - Verbose, - CheckOnlyIfDirty, - ScanDrive, - Callback); -} - - -/** FormatEx() **/ -NTSTATUS -FormatFileSystem_UStr( - IN PUNICODE_STRING DriveRoot, - IN PCWSTR FileSystemName, - IN FMIFS_MEDIA_FLAG MediaFlag, - IN PUNICODE_STRING Label, - IN BOOLEAN QuickFormat, - IN ULONG ClusterSize, - IN PFMIFSCALLBACK Callback) -{ - PFILE_SYSTEM FileSystem; - - FileSystem = GetFileSystemByName(FileSystemName); - - if (!FileSystem || !FileSystem->FormatFunc) - { - // BOOLEAN Argument = FALSE; - // Callback(DONE, 0, &Argument); - return STATUS_NOT_SUPPORTED; - } - - return FileSystem->FormatFunc(DriveRoot, - MediaFlag, - Label, - QuickFormat, - ClusterSize, - Callback); -} - -NTSTATUS -FormatFileSystem( - IN PCWSTR DriveRoot, - IN PCWSTR FileSystemName, - IN FMIFS_MEDIA_FLAG MediaFlag, - IN PCWSTR Label, - IN BOOLEAN QuickFormat, - IN ULONG ClusterSize, - IN PFMIFSCALLBACK Callback) -{ - UNICODE_STRING DriveRootU; - UNICODE_STRING LabelU; - - RtlInitUnicodeString(&DriveRootU, DriveRoot); - RtlInitUnicodeString(&LabelU, Label); - - return FormatFileSystem_UStr(&DriveRootU, - FileSystemName, - MediaFlag, - &LabelU, - QuickFormat, - ClusterSize, - Callback); -} - - UCHAR FileSystemToPartitionType( IN PCWSTR FileSystem, @@ -527,45 +304,4 @@ FileSystemToPartitionType( } } - -// -// Formatting routines -// - -BOOLEAN -PreparePartitionForFormatting( - IN struct _PARTENTRY* PartEntry, - IN PCWSTR FileSystemName) -{ - UCHAR PartitionType; - - if (!FileSystemName || !*FileSystemName) - { - DPRINT1("No file system specified?\n"); - return FALSE; - } - - PartitionType = FileSystemToPartitionType(FileSystemName, - &PartEntry->StartSector, - &PartEntry->SectorCount); - if (PartitionType == PARTITION_ENTRY_UNUSED) - { - /* Unknown file system */ - DPRINT1("Unknown file system '%S'\n", FileSystemName); - return FALSE; - } - - SetPartitionType(PartEntry, PartitionType); - -// -// FIXME: Do this now, or after the partition was actually formatted?? -// - /* Set the new partition's file system proper */ - RtlStringCbCopyW(PartEntry->FileSystem, - sizeof(PartEntry->FileSystem), - FileSystemName); - - return TRUE; -} - /* EOF */ diff --git a/base/setup/lib/utils/fsrec.h b/base/setup/lib/utils/fsrec.h new file mode 100644 index 00000000000..197cdd6e9f6 --- /dev/null +++ b/base/setup/lib/utils/fsrec.h @@ -0,0 +1,49 @@ +/* + * PROJECT: ReactOS Setup Library + * LICENSE: GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+) + * PURPOSE: Filesystem Recognition support functions, + * using NT OS functionality. + * COPYRIGHT: Copyright 2017-2020 Hermes Belusca-Maito + */ + +#pragma once + +NTSTATUS +GetFileSystemNameByHandle( + IN HANDLE PartitionHandle, + IN OUT PWSTR FileSystemName, + IN SIZE_T FileSystemNameSize); + +NTSTATUS +GetFileSystemName_UStr( + IN PUNICODE_STRING PartitionPath, + IN OUT PWSTR FileSystemName, + IN SIZE_T FileSystemNameSize); + +NTSTATUS +GetFileSystemName( + IN PCWSTR Partition, + IN OUT PWSTR FileSystemName, + IN SIZE_T FileSystemNameSize); + +NTSTATUS +InferFileSystemByHandle( + IN HANDLE PartitionHandle, + IN UCHAR PartitionType, + IN OUT PWSTR FileSystemName, + IN SIZE_T FileSystemNameSize); + +NTSTATUS +InferFileSystem( + IN PCWSTR Partition, + IN UCHAR PartitionType, + IN OUT PWSTR FileSystemName, + IN SIZE_T FileSystemNameSize); + +UCHAR +FileSystemToPartitionType( + IN PCWSTR FileSystem, + IN PULARGE_INTEGER StartSector, + IN PULARGE_INTEGER SectorCount); + +/* EOF */ diff --git a/base/setup/lib/utils/partlist.c b/base/setup/lib/utils/partlist.c index 2e635954134..3837a83e255 100644 --- a/base/setup/lib/utils/partlist.c +++ b/base/setup/lib/utils/partlist.c @@ -10,7 +10,7 @@ #include <ntddscsi.h> #include "partlist.h" -#include "fsutil.h" +#include "fsrec.h" #include "registry.h" #define NDEBUG

1 0

[reactos] 02/02: [FREELDR] Add variable for default text color
by Stanislav Motylkov 17 Oct '20

17 Oct '20

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=8a4273b6ee25c2809bcb0… commit 8a4273b6ee25c2809bcb0d6e165815917fd10d36 Author: Stanislav Motylkov <x86corez(a)gmail.com> AuthorDate: Sat Oct 17 00:46:06 2020 +0300 Commit: Stanislav Motylkov <x86corez(a)gmail.com> CommitDate: Sat Oct 17 19:28:08 2020 +0300 [FREELDR] Add variable for default text color On PC/AT-compatible machines it's Gray, and on NEC PC-98 series it's White. --- base/setup/lib/utils/bldrsup.c | 8 ++++---- boot/bootdata/bootcd.ini | 6 +++--- boot/bootdata/floppy_pc98.ini | 6 +++--- boot/bootdata/hybridcd.ini | 6 +++--- boot/bootdata/livecd.ini | 6 +++--- boot/freeldr/FREELDR.INI | 5 ++++- boot/freeldr/freeldr/arch/i386/pc/pcvideo.c | 2 ++ boot/freeldr/freeldr/arch/i386/pc98/pc98video.c | 2 ++ boot/freeldr/freeldr/arch/i386/xbox/xboxvideo.c | 2 ++ boot/freeldr/freeldr/ui/tui.c | 4 ++++ 10 files changed, 30 insertions(+), 17 deletions(-) diff --git a/base/setup/lib/utils/bldrsup.c b/base/setup/lib/utils/bldrsup.c index 0040d77180c..ac1d2008ab8 100644 --- a/base/setup/lib/utils/bldrsup.c +++ b/base/setup/lib/utils/bldrsup.c @@ -277,7 +277,7 @@ CreateCommonFreeLdrSections( /* MenuTextColor=White */ IniCacheInsertKey(IniSection, NULL, INSERT_LAST, - L"MenuTextColor", L"Gray"); + L"MenuTextColor", L"Default"); /* MenuColor=Blue */ IniCacheInsertKey(IniSection, NULL, INSERT_LAST, @@ -285,15 +285,15 @@ CreateCommonFreeLdrSections( /* TextColor=Yellow */ IniCacheInsertKey(IniSection, NULL, INSERT_LAST, - L"TextColor", L"Gray"); + L"TextColor", L"Default"); /* SelectedTextColor=Black */ IniCacheInsertKey(IniSection, NULL, INSERT_LAST, L"SelectedTextColor", L"Black"); - /* SelectedColor=Gray */ + /* SelectedColor=Default */ IniCacheInsertKey(IniSection, NULL, INSERT_LAST, - L"SelectedColor", L"Gray"); + L"SelectedColor", L"Default"); /* ShowTime=Yes */ IniCacheInsertKey(IniSection, NULL, INSERT_LAST, diff --git a/boot/bootdata/bootcd.ini b/boot/bootdata/bootcd.ini index 588dd8d39c0..4f2017c5939 100644 --- a/boot/bootdata/bootcd.ini +++ b/boot/bootdata/bootcd.ini @@ -13,11 +13,11 @@ TitleBoxTextColor=White TitleBoxColor=Red MessageBoxTextColor=White MessageBoxColor=Blue -MenuTextColor=Gray +MenuTextColor=Default MenuColor=Black -TextColor=Gray +TextColor=Default SelectedTextColor=Black -SelectedColor=Gray +SelectedColor=Default ShowTime=No MenuBox=No CenterMenu=No diff --git a/boot/bootdata/floppy_pc98.ini b/boot/bootdata/floppy_pc98.ini index a46489687e4..3828cee347d 100644 --- a/boot/bootdata/floppy_pc98.ini +++ b/boot/bootdata/floppy_pc98.ini @@ -13,11 +13,11 @@ TitleBoxTextColor=White TitleBoxColor=Red MessageBoxTextColor=White MessageBoxColor=Blue -MenuTextColor=Gray +MenuTextColor=Default MenuColor=Black -TextColor=Gray +TextColor=Default SelectedTextColor=Black -SelectedColor=Gray +SelectedColor=Default ShowTime=No MenuBox=No CenterMenu=No diff --git a/boot/bootdata/hybridcd.ini b/boot/bootdata/hybridcd.ini index d53ab953f65..28697d30b36 100644 --- a/boot/bootdata/hybridcd.ini +++ b/boot/bootdata/hybridcd.ini @@ -13,11 +13,11 @@ TitleBoxTextColor=White TitleBoxColor=Red MessageBoxTextColor=White MessageBoxColor=Blue -MenuTextColor=Gray +MenuTextColor=Default MenuColor=Black -TextColor=Gray +TextColor=Default SelectedTextColor=Black -SelectedColor=Gray +SelectedColor=Default ShowTime=No MenuBox=No CenterMenu=No diff --git a/boot/bootdata/livecd.ini b/boot/bootdata/livecd.ini index 914ebf66fc6..d4b37b646c9 100644 --- a/boot/bootdata/livecd.ini +++ b/boot/bootdata/livecd.ini @@ -13,11 +13,11 @@ TitleBoxTextColor=White TitleBoxColor=Red MessageBoxTextColor=White MessageBoxColor=Blue -MenuTextColor=Gray +MenuTextColor=Default MenuColor=Black -TextColor=Gray +TextColor=Default SelectedTextColor=Black -SelectedColor=Gray +SelectedColor=Default ShowTime=No MenuBox=No CenterMenu=No diff --git a/boot/freeldr/FREELDR.INI b/boot/freeldr/FREELDR.INI index ac63ff653bd..0bd420d06dc 100644 --- a/boot/freeldr/FREELDR.INI +++ b/boot/freeldr/FREELDR.INI @@ -50,7 +50,10 @@ ; ; Text colors can be any one of the background colors and any of the following: ; DarkGray, LightBlue, LightGreen, LightCyan, LightRed, LightMagenta, -; Yellow, White. +; Yellow, White, Default. +; +; Default color is the one that is being used by BIOS firmware by default. +; On PC/AT-compatible machines it's Gray, and on NEC PC-98 series it's White. ; [OS-General] Section Commands: ; diff --git a/boot/freeldr/freeldr/arch/i386/pc/pcvideo.c b/boot/freeldr/freeldr/arch/i386/pc/pcvideo.c index 05252936545..7050cf3b64d 100644 --- a/boot/freeldr/freeldr/arch/i386/pc/pcvideo.c +++ b/boot/freeldr/freeldr/arch/i386/pc/pcvideo.c @@ -108,6 +108,8 @@ typedef struct } SVGA_MODE_INFORMATION, *PSVGA_MODE_INFORMATION; #include <poppack.h> +UCHAR MachDefaultTextColor = COLOR_GRAY; + static USHORT BiosVideoMode; /* Current video mode as known by BIOS */ static ULONG ScreenWidth = 80; /* Screen Width in characters */ static ULONG ScreenHeight = 25; /* Screen Height in characters */ diff --git a/boot/freeldr/freeldr/arch/i386/pc98/pc98video.c b/boot/freeldr/freeldr/arch/i386/pc98/pc98video.c index 0d9b3b34423..5b6f2f7af3d 100644 --- a/boot/freeldr/freeldr/arch/i386/pc98/pc98video.c +++ b/boot/freeldr/freeldr/arch/i386/pc98/pc98video.c @@ -35,6 +35,8 @@ static BOOLEAN UseCGFont = TRUE; * This option is possible only with BIOS fonts enabled. */ static BOOLEAN CGAccelDraw = TRUE; +UCHAR MachDefaultTextColor = COLOR_WHITE; + ULONG VramText; static ULONG VramPlaneB; static ULONG VramPlaneG; diff --git a/boot/freeldr/freeldr/arch/i386/xbox/xboxvideo.c b/boot/freeldr/freeldr/arch/i386/xbox/xboxvideo.c index 435ad2a59aa..34420177c6b 100644 --- a/boot/freeldr/freeldr/arch/i386/xbox/xboxvideo.c +++ b/boot/freeldr/freeldr/arch/i386/xbox/xboxvideo.c @@ -33,6 +33,8 @@ static ULONG BytesPerPixel; static ULONG Delta; extern multiboot_info_t * MultibootInfoPtr; +UCHAR MachDefaultTextColor = COLOR_GRAY; + #define CHAR_WIDTH 8 #define CHAR_HEIGHT 16 diff --git a/boot/freeldr/freeldr/ui/tui.c b/boot/freeldr/freeldr/ui/tui.c index d8fa4028b4c..b9327950f4c 100644 --- a/boot/freeldr/freeldr/ui/tui.c +++ b/boot/freeldr/freeldr/ui/tui.c @@ -23,6 +23,7 @@ #define TAG_TAG_TUI_PALETTE 'PiuT' PVOID TextVideoBuffer = NULL; +extern UCHAR MachDefaultTextColor; /* * TuiPrintf() @@ -724,6 +725,9 @@ UCHAR TuiTextToColor(PCSTR ColorText) }; ULONG i; + if (_stricmp(ColorText, "Default") == 0) + return MachDefaultTextColor; + for (i = 0; i < sizeof(Colors)/sizeof(Colors[0]); ++i) { if (_stricmp(ColorText, Colors[i].ColorName) == 0)

1 0

[reactos] 01/02: [FREELDR] Use BIOS font and accelerated text drawing on NEC PC-98
by Stanislav Motylkov 17 Oct '20

17 Oct '20

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=db1b04340f6661037b1fe… commit db1b04340f6661037b1fe5175a83597a03517e8e Author: Stanislav Motylkov <x86corez(a)gmail.com> AuthorDate: Sat Oct 17 00:32:38 2020 +0300 Commit: Stanislav Motylkov <x86corez(a)gmail.com> CommitDate: Sat Oct 17 19:28:05 2020 +0300 [FREELDR] Use BIOS font and accelerated text drawing on NEC PC-98 Both features are switchable via global variables. --- boot/freeldr/freeldr/arch/i386/pc98/pc98video.c | 125 ++++++++++++++++++++++++ 1 file changed, 125 insertions(+) diff --git a/boot/freeldr/freeldr/arch/i386/pc98/pc98video.c b/boot/freeldr/freeldr/arch/i386/pc98/pc98video.c index 7f038a03870..0d9b3b34423 100644 --- a/boot/freeldr/freeldr/arch/i386/pc98/pc98video.c +++ b/boot/freeldr/freeldr/arch/i386/pc98/pc98video.c @@ -28,6 +28,13 @@ UCHAR TextLines; #define SCREEN_HEIGHT 400 #define BYTES_PER_SCANLINE (SCREEN_WIDTH / 8) +/* Use BIOS font; set to FALSE for built-in VGA font. */ +static BOOLEAN UseCGFont = TRUE; +/* Hardware accelerated text drawing; set to FALSE for non-accelerated + * self-drawing, which will allow more than 8 colors for text though. + * This option is possible only with BIOS fonts enabled. */ +static BOOLEAN CGAccelDraw = TRUE; + ULONG VramText; static ULONG VramPlaneB; static ULONG VramPlaneG; @@ -232,6 +239,77 @@ Pc98VideoHideShowTextCursor(BOOLEAN Show) WRITE_GDC_CSRFORM((PUCHAR)GDC1_IO_o_PARAM, &CursorParameters); } +static +UCHAR +Pc98VideoAttrToGdcAttr(UCHAR Attr) +{ + switch (Attr & 0xF) + { + case COLOR_BLACK: + return GDC_ATTR_BLACK; + case COLOR_BLUE: + return GDC_ATTR_BLUE; + case COLOR_GREEN: + case COLOR_LIGHTGREEN: + return GDC_ATTR_GREEN; + case COLOR_CYAN: + case COLOR_GRAY: + case COLOR_DARKGRAY: + case COLOR_WHITE: + return GDC_ATTR_WHITE; + case COLOR_RED: + case COLOR_LIGHTRED: + return GDC_ATTR_RED; + case COLOR_MAGENTA: + case COLOR_LIGHTMAGENTA: + return GDC_ATTR_PURPLE; + case COLOR_BROWN: + case COLOR_YELLOW: + return GDC_ATTR_YELLOW; + case COLOR_LIGHTBLUE: + case COLOR_LIGHTCYAN: + return GDC_ATTR_LIGHTBLUE; + default: + return GDC_ATTR_BLACK; + } +} + +static +USHORT +Pc98AsciiToJisX(int Ch) +{ + switch (Ch) + { + /* Only characters required for pseudographic are handled here */ + case 0x18: return 0x1E; + case 0x19: return 0x1F; + case 0xB3: return 0x260B; + case 0xB6: return 0x4C0B; + case 0xBA: return 0x270B; + case 0xBB: return 0x370B; + case 0xBC: return 0x3F0B; + case 0xBF: return 0x340B; + case 0xC0: return 0x380B; + case 0xC4: return 0x240B; + case 0xC7: return 0x440B; + case 0xC8: return 0x3B0B; + case 0xC9: return 0x330B; + case 0xCD: return 0x250B; + case 0xD9: return 0x3C0B; + case 0xDA: return 0x300B; + case 0xDB: return 0x87; + default: return Ch; + } +} + +static +VOID +Pc98VideoTextRamPutChar(int Ch, UCHAR Attr, unsigned X, unsigned Y) +{ + *(PUSHORT)(VramText + (X + Y * TextCols) * TEXT_CHAR_SIZE) = Ch; + *(PUCHAR)(VramText + VRAM_TEXT_ATTR_OFFSET + (X + Y * TextCols) * TEXT_CHAR_SIZE) = Pc98VideoAttrToGdcAttr(Attr) | GDC_ATTR_VISIBLE; +} + VOID Pc98VideoPutChar(int Ch, UCHAR Attr, unsigned X, unsigned Y) { @@ -242,9 +320,46 @@ Pc98VideoPutChar(int Ch, UCHAR Attr, unsigned X, unsigned Y) UCHAR I = (Attr & 0x80) ? 0xFF : 0; ULONG VramOffset = X + (Y * CHAR_HEIGHT) * BYTES_PER_SCANLINE; PUCHAR FontPtr = BitmapFont8x16 + Ch * 16; + BOOLEAN CGFont = UseCGFont && (Ch != LIGHT_FILL && Ch != MEDIUM_FILL && Ch != DARK_FILL); + + if (CGFont) + { + Ch = Pc98AsciiToJisX(Ch); + + if (CGAccelDraw) + { + Pc98VideoTextRamPutChar(Ch, Attr, X, Y); + } + else + { + /* Set needed character code to obtain glyph from CG Window */ + WRITE_PORT_UCHAR((PUCHAR)KCG_IO_o_CHARCODE_LOW, Ch); + WRITE_PORT_UCHAR((PUCHAR)KCG_IO_o_CHARCODE_HIGH, Ch >> 8); + } + } + else if (UseCGFont && CGAccelDraw) + { + /* Clear character at this place in Text RAM */ + Pc98VideoTextRamPutChar(' ', Attr, X, Y); + } for (Line = 0; Line < CHAR_HEIGHT; Line++) { + if (CGFont) + { + if (CGAccelDraw) + { + /* Character is already displayed by GDC (Text RAM), + * so display only background for it. */ + FontPtr[Line] = 0; + } + else + { + /* Obtain glyph data from CG Window */ + WRITE_PORT_UCHAR((PUCHAR)KCG_IO_o_LINE, Line | 0x20); + FontPtr[Line] = READ_PORT_UCHAR((PUCHAR)KCG_IO_i_PATTERN); + } + } if (Attr & 0x0F) { *(PUCHAR)(VramPlaneB + VramOffset + Line * BYTES_PER_SCANLINE) = B | ((Attr & 0x01) ? FontPtr[Line] : 0); @@ -336,4 +451,14 @@ Pc98VideoPrepareForReactOS(VOID) Int386(0x18, &Regs, &Regs); Pc98VideoHideShowTextCursor(FALSE); + + if (UseCGFont && CGAccelDraw) + { + /* Clear the text screen, resetting to default attributes */ + for (USHORT i = 0; i < VRAM_TEXT_SIZE; i += TEXT_CHAR_SIZE) + { + *(PUSHORT)(VramText + i) = ' '; + *(PUCHAR)(VramText + VRAM_TEXT_ATTR_OFFSET + i) = GDC_ATTR_WHITE | GDC_ATTR_VISIBLE; + } + } }

1 0

[reactos] 01/01: [NTOSKRNL] include/config.h: Sync it to current code (#3263)
by Serge Gautherie 17 Oct '20

17 Oct '20

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=90a6086f17114bc6f1d75… commit 90a6086f17114bc6f1d75e90ac5fda2c3f64a2c7 Author: Serge Gautherie <32623169+SergeGautherie(a)users.noreply.github.com> AuthorDate: Sat Oct 17 18:09:11 2020 +0200 Commit: GitHub <noreply(a)github.com> CommitDate: Sat Oct 17 18:09:11 2020 +0200 [NTOSKRNL] include/config.h: Sync it to current code (#3263) * SERIALIZE_DBGPRINT: Removed on c15e04c (r18078). * ENABLE_VALIDATE_POOL: Removed on 5899e14 (r42249). * TAG_STATISTICS_TRACKING: Removed on 5899e14 (r42249). * POOL_DEBUG_APIS: Removed on 5899e14 (r42249). * R_RZ: Removed on 7d21cf7 (r48999). * R_STACK: Removed on 7d21cf7 (r48999). * WHOLE_PAGE_ALLOCATIONS: Removed on b431563 (r17306). + * _GLOBAL_PAGES_ARE_AWESOME_: Move it here. --- ntoskrnl/include/config.h | 40 ++-------------------------------------- ntoskrnl/include/ntoskrnl.h | 9 +-------- 2 files changed, 3 insertions(+), 46 deletions(-) diff --git a/ntoskrnl/include/config.h b/ntoskrnl/include/config.h index 7e925ef419a..a98c36974aa 100644 --- a/ntoskrnl/include/config.h +++ b/ntoskrnl/include/config.h @@ -1,40 +1,4 @@ #pragma once -/********** dbg/print.c **********/ - -/* Enable serialization of debug messages printed with DbgPrint - * - * If this is enabled DbgPrint will queue messages if another thread is already - * printing a message, and immediately returns. The other thread will print - * queued messages before it returns. - * It could happen that some messages are lost if the processor is halted before - * the message queue was flushed. - */ -#undef SERIALIZE_DBGPRINT - -/********** mm/ppool.c **********/ - -/* Disable Debugging Features */ -#if !DBG - /* Enable strict checking of the nonpaged pool on every allocation */ - #undef ENABLE_VALIDATE_POOL - - /* Enable tracking of statistics about the tagged blocks in the pool */ - #undef TAG_STATISTICS_TRACKING - - /* Enable Memory Debugging Features/Helpers */ - #undef POOL_DEBUG_APIS - - /* Enable Redzone */ - #define R_RZ 0 - - /* Enable Allocator Stack */ - #define R_STACK 0 - - /* - * Put each block in its own range of pages and position the block at the - * end of the range so any accesses beyond the end of block are to invalid - * memory locations. - */ - #undef WHOLE_PAGE_ALLOCATIONS -#endif +// Enable global page support. +// #define _GLOBAL_PAGES_ARE_AWESOME_ diff --git a/ntoskrnl/include/ntoskrnl.h b/ntoskrnl/include/ntoskrnl.h index 85970d59892..74921c4ac97 100644 --- a/ntoskrnl/include/ntoskrnl.h +++ b/ntoskrnl/include/ntoskrnl.h @@ -108,16 +108,9 @@ C_ASSERT(MAX_WIN32_PATH == MAX_PATH); #undef MAX_PATH -// -// Switch for enabling global page support -// - -//#define _GLOBAL_PAGES_ARE_AWESOME_ - - /* Internal Headers */ -#include "internal/ntoskrnl.h" #include "config.h" +#include "internal/ntoskrnl.h" #include <reactos/probe.h> #include "internal/probe.h"

1 0

[reactos] 01/01: [BASESRV] Use the correct value for the last parameter of a CsrValidateMessageBuffer() call.
by Hermès Bélusca-Maïto 17 Oct '20

17 Oct '20

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=c7c0b09eb6ea18e180d77… commit c7c0b09eb6ea18e180d77d38224ed535699001aa Author: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> AuthorDate: Sat Oct 17 16:55:56 2020 +0200 Commit: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> CommitDate: Sat Oct 17 16:55:56 2020 +0200 [BASESRV] Use the correct value for the last parameter of a CsrValidateMessageBuffer() call. --- subsystems/win/basesrv/nls.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/subsystems/win/basesrv/nls.c b/subsystems/win/basesrv/nls.c index de4027bbeb2..ef918667188 100644 --- a/subsystems/win/basesrv/nls.c +++ b/subsystems/win/basesrv/nls.c @@ -338,7 +338,7 @@ CSR_API(BaseSrvNlsGetUserInfo) PBASE_NLS_GET_USER_INFO NlsMsg = &((PBASE_API_MESSAGE)ApiMessage)->Data.NlsGetUserInfo; /* Make sure the buffer is valid and of the right size */ - if ((CsrValidateMessageBuffer(ApiMessage, &NlsMsg->NlsUserInfo, NlsMsg->Size, TRUE)) && + if ((CsrValidateMessageBuffer(ApiMessage, &NlsMsg->NlsUserInfo, NlsMsg->Size, sizeof(BYTE))) && (NlsMsg->Size == sizeof(NLS_USER_INFO))) { /* Acquire the lock to prevent updates while we copy */

1 0

[reactos] 01/01: [NTOS:IO] Some fixes for IoRaiseHardError(). (#3302) CORE-14037
by Hermès Bélusca-Maïto 17 Oct '20

17 Oct '20

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=bd2a40d57b6c13e76ba46… commit bd2a40d57b6c13e76ba4659997d9a19cb4e5d8f1 Author: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> AuthorDate: Sat Oct 10 17:41:44 2020 +0200 Commit: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> CommitDate: Sat Oct 17 16:13:05 2020 +0200 [NTOS:IO] Some fixes for IoRaiseHardError(). (#3302) CORE-14037 - Fix buggy retrieval of the current calling Irp->Tail.Overlay.Thread. - The 4th argument (KernelRoutine) to the KeInitializeApc() is **NOT** optional; however its 5th argument (RundownRoutine) is. So use the mandatory routine for freeing the allocated APC instead. We don't use the rundown routine yet. - Check whether the ExAllocatePoolWithTag() call failed or not before queueing the allocated APC. --- ntoskrnl/io/iomgr/error.c | 36 ++++++++++++++++++++++++++---------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/ntoskrnl/io/iomgr/error.c b/ntoskrnl/io/iomgr/error.c index 171f02eac80..312b29f942a 100644 --- a/ntoskrnl/io/iomgr/error.c +++ b/ntoskrnl/io/iomgr/error.c @@ -484,14 +484,22 @@ IopLogWorker(IN PVOID Parameter) ExFreePoolWithTag(Message, TAG_IO); } +static VOID NTAPI -IopFreeApc(IN PKAPC Apc) +IopFreeApc(IN PKAPC Apc, + IN OUT PKNORMAL_ROUTINE* NormalRoutine, + IN OUT PVOID* NormalContext, + IN OUT PVOID* SystemArgument1, + IN OUT PVOID* SystemArgument2) { + PAGED_CODE(); + /* Free the APC */ - ExFreePool(Apc); + ExFreePoolWithTag(Apc, TAG_APC); } +static VOID NTAPI IopRaiseHardError(IN PVOID NormalContext, @@ -657,7 +665,7 @@ IoRaiseHardError(IN PIRP Irp, IN PVPB Vpb, IN PDEVICE_OBJECT RealDeviceObject) { - PETHREAD Thread = (PETHREAD)&Irp->Tail.Overlay.Thread; + PETHREAD Thread = Irp->Tail.Overlay.Thread; PKAPC ErrorApc; /* Don't do anything if hard errors are disabled on the thread */ @@ -669,21 +677,29 @@ IoRaiseHardError(IN PIRP Irp, return; } - /* Setup an APC */ - ErrorApc = ExAllocatePoolWithTag(NonPagedPool, - sizeof(KAPC), - TAG_APC); + // TODO: In case we were called in the context of a paging I/O or for + // a synchronous operation, that happens with APCs disabled, queue the + // hard-error call for later processing (see also IofCompleteRequest). + + /* Setup an APC and queue it to deal with the error (see OSR documentation) */ + ErrorApc = ExAllocatePoolWithTag(NonPagedPool, sizeof(*ErrorApc), TAG_APC); + if (!ErrorApc) + { + /* Fail */ + IoCompleteRequest(Irp, IO_DISK_INCREMENT); + return; + } + KeInitializeApc(ErrorApc, &Thread->Tcb, Irp->ApcEnvironment, - NULL, IopFreeApc, + NULL, IopRaiseHardError, KernelMode, Irp); - /* Queue an APC to deal with the error (see osr documentation) */ - KeInsertQueueApc(ErrorApc, Vpb, RealDeviceObject, 0); + KeInsertQueueApc(ErrorApc, Vpb, RealDeviceObject, IO_NO_INCREMENT); } /*

1 0

[reactos] 01/01: [NTOS:EX] ExUuidCreate(): Correctly fill Uuid->Data4
by Serge Gautherie 17 Oct '20

17 Oct '20

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=7790670dd80c5d4cf3c4b… commit 7790670dd80c5d4cf3c4b68f8327fe97126c6229 Author: Serge Gautherie <reactos-git_serge_171003(a)gautherie.fr> AuthorDate: Wed Sep 9 03:46:56 2020 +0200 Commit: Timo Kreuzer <timo.kreuzer(a)reactos.org> CommitDate: Sat Oct 17 15:00:19 2020 +0200 [NTOS:EX] ExUuidCreate(): Correctly fill Uuid->Data4 ROSTESTS-359 Co-authored-by: Nguyen Trung Khanh <nguyentrungkhanh97(a)gmail.com> --- ntoskrnl/ex/uuid.c | 10 ++++++---- ntoskrnl/include/internal/ex.h | 13 ++++++++++--- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/ntoskrnl/ex/uuid.c b/ntoskrnl/ex/uuid.c index 0d198fbe4fe..b69200b1a86 100644 --- a/ntoskrnl/ex/uuid.c +++ b/ntoskrnl/ex/uuid.c @@ -42,7 +42,7 @@ LARGE_INTEGER ExpUuidLastTimeAllocated; ULONG ExpUuidSequenceNumber = 0; BOOLEAN ExpUuidSequenceNumberValid; BOOLEAN ExpUuidSequenceNumberNotSaved = FALSE; -UUID_CACHED_VALUES_STRUCT ExpUuidCachedValues = {0ULL, 0xFFFFFFFF, 0, 0, { 0x80, 0x6E, 0x6F, 0x6E, 0x69, 0x63}}; +UUID_CACHED_VALUES_STRUCT ExpUuidCachedValues = {0ULL, 0xFFFFFFFF, {{0, 0, {0x80, 0x6E, 0x6F, 0x6E, 0x69, 0x63}}}}; BOOLEAN ExpUuidCacheValid = FALSE; ULONG ExpLuidIncrement = 1; LARGE_INTEGER ExpLuid = {{0x3e9, 0x0}}; @@ -400,9 +400,11 @@ ExUuidCreate(OUT UUID *Uuid) { Time.QuadPart = ExpUuidCachedValues.Time; - RtlCopyMemory(&Uuid->Data4[0], - &ExpUuidCachedValues.NodeId[0], - SEED_BUFFER_SIZE); + C_ASSERT(sizeof(ExpUuidCachedValues.GuidInit) == sizeof(Uuid->Data4)); + RtlCopyMemory(Uuid->Data4, + ExpUuidCachedValues.GuidInit, + sizeof(Uuid->Data4)); + Valid = ExpUuidCacheValid; AllocatedCount = InterlockedDecrement(&ExpUuidCachedValues.AllocatedCount); } diff --git a/ntoskrnl/include/internal/ex.h b/ntoskrnl/include/internal/ex.h index 52e58bffbef..0690b7b9801 100644 --- a/ntoskrnl/include/internal/ex.h +++ b/ntoskrnl/include/internal/ex.h @@ -171,9 +171,16 @@ typedef struct _UUID_CACHED_VALUES_STRUCT { ULONGLONG Time; LONG AllocatedCount; - UCHAR ClockSeqHiAndReserved; - UCHAR ClockSeqLow; - UCHAR NodeId [ 6 ] ; + union + { + struct + { + UCHAR ClockSeqHiAndReserved; + UCHAR ClockSeqLow; + UCHAR NodeId[6 /*SEED_BUFFER_SIZE*/]; + }; + UCHAR GuidInit[8]; /* Match GUID.Data4 */ + }; } UUID_CACHED_VALUES_STRUCT, *PUUID_CACHED_VALUES_STRUCT; /* INITIALIZATION FUNCTIONS *************************************************/

1 0

[reactos] 01/01: [BROWSEUI] Implement CLSID_ACListISF (#3298)
by Katayama Hirofumi MZ 17 Oct '20

17 Oct '20

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=24833a6dde324dddce1a7… commit 24833a6dde324dddce1a7316ffaefc0233daf903 Author: Katayama Hirofumi MZ <katayama.hirofumi.mz(a)gmail.com> AuthorDate: Sat Oct 17 17:49:24 2020 +0900 Commit: GitHub <noreply(a)github.com> CommitDate: Sat Oct 17 17:49:24 2020 +0900 [BROWSEUI] Implement CLSID_ACListISF (#3298) Implement enumeration of IShellFolder items of auto-completion. CORE-9281 --- dll/win32/browseui/aclistisf.cpp | 352 +++++++++++++++++++++++++++++++++++++-- dll/win32/browseui/aclistisf.h | 52 ++++-- 2 files changed, 375 insertions(+), 29 deletions(-) diff --git a/dll/win32/browseui/aclistisf.cpp b/dll/win32/browseui/aclistisf.cpp index 72045b3a14e..533a7af814b 100644 --- a/dll/win32/browseui/aclistisf.cpp +++ b/dll/win32/browseui/aclistisf.cpp @@ -2,6 +2,7 @@ * Shell AutoComplete list * * Copyright 2015 Thomas Faber + * Copyright 2020 Katayama Hirofumi MZ * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public @@ -20,8 +21,10 @@ #include "precomp.h" -CACListISF::CACListISF() : - m_dwOptions(0) +CACListISF::CACListISF() + : m_dwOptions(ACLO_CURRENTDIR | ACLO_MYCOMPUTER) + , m_iNextLocation(LT_DIRECTORY) + , m_fShowHidden(FALSE) { } @@ -29,26 +32,290 @@ CACListISF::~CACListISF() { } +HRESULT CACListISF::NextLocation() +{ + TRACE("(%p)\n", this); + HRESULT hr; + switch (m_iNextLocation) + { + case LT_DIRECTORY: + m_iNextLocation = LT_DESKTOP; + if (!ILIsEmpty(m_pidlCurDir) && (m_dwOptions & ACLO_CURRENTDIR)) + { + CComHeapPtr<ITEMIDLIST> pidl(ILClone(m_pidlCurDir)); + hr = SetLocation(pidl.Detach()); + if (SUCCEEDED(hr)) + { + TRACE("LT_DIRECTORY\n"); + return hr; + } + } + // FALL THROUGH + case LT_DESKTOP: + m_iNextLocation = LT_MYCOMPUTER; + if (m_dwOptions & ACLO_DESKTOP) + { + CComHeapPtr<ITEMIDLIST> pidl; + hr = SHGetSpecialFolderLocation(NULL, CSIDL_DESKTOP, &pidl); + if (FAILED_UNEXPECTEDLY(hr)) + return S_FALSE; + hr = SetLocation(pidl.Detach()); + if (SUCCEEDED(hr)) + { + TRACE("LT_DESKTOP\n"); + return hr; + } + } + // FALL THROUGH + case LT_MYCOMPUTER: + m_iNextLocation = LT_FAVORITES; + if (m_dwOptions & ACLO_MYCOMPUTER) + { + CComHeapPtr<ITEMIDLIST> pidl; + hr = SHGetSpecialFolderLocation(NULL, CSIDL_DRIVES, &pidl); + if (FAILED_UNEXPECTEDLY(hr)) + return S_FALSE; + hr = SetLocation(pidl.Detach()); + if (SUCCEEDED(hr)) + { + TRACE("LT_MYCOMPUTER\n"); + return hr; + } + } + // FALL THROUGH + case LT_FAVORITES: + m_iNextLocation = LT_MAX; + if (m_dwOptions & ACLO_FAVORITES) + { + CComHeapPtr<ITEMIDLIST> pidl; + hr = SHGetSpecialFolderLocation(NULL, CSIDL_FAVORITES, &pidl); + if (FAILED_UNEXPECTEDLY(hr)) + return S_FALSE; + hr = SetLocation(pidl.Detach()); + if (SUCCEEDED(hr)) + { + TRACE("LT_FAVORITES\n"); + return hr; + } + } + // FALL THROUGH + case LT_MAX: + default: + TRACE("LT_MAX\n"); + return S_FALSE; + } +} + +HRESULT CACListISF::SetLocation(LPITEMIDLIST pidl) +{ + TRACE("(%p, %p)\n", this, pidl); + + m_pEnumIDList.Release(); + m_pShellFolder.Release(); + m_pidlLocation.Free(); + + if (!pidl) + return E_FAIL; + + m_pidlLocation.Attach(pidl); + + CComPtr<IShellFolder> pFolder; + HRESULT hr = SHGetDesktopFolder(&pFolder); + if (FAILED_UNEXPECTEDLY(hr)) + return hr; + + if (!ILIsEmpty(pidl)) + { + hr = pFolder->BindToObject(pidl, NULL, IID_PPV_ARG(IShellFolder, &m_pShellFolder)); + if (FAILED_UNEXPECTEDLY(hr)) + return hr; + } + else + { + m_pShellFolder.Attach(pFolder.Detach()); + } + + SHCONTF Flags = SHCONTF_FOLDERS | SHCONTF_INIT_ON_FIRST_NEXT; + if (m_fShowHidden) + Flags |= SHCONTF_INCLUDEHIDDEN; + if (!(m_dwOptions & ACLO_FILESYSDIRS)) + Flags |= SHCONTF_NONFOLDERS; + + hr = m_pShellFolder->EnumObjects(NULL, Flags, &m_pEnumIDList); + if (hr != S_OK) + { + ERR("EnumObjects failed: 0x%lX\n", hr); + hr = E_FAIL; + } + return hr; +} + +HRESULT CACListISF::GetDisplayName(LPCITEMIDLIST pidlChild, CComHeapPtr<WCHAR>& pszChild) +{ + TRACE("(%p, %p)\n", this, pidlChild); + pszChild.Free(); + + STRRET StrRet; + DWORD dwFlags = SHGDN_INFOLDER | SHGDN_FORPARSING | SHGDN_FORADDRESSBAR; + HRESULT hr = m_pShellFolder->GetDisplayNameOf(pidlChild, dwFlags, &StrRet); + if (FAILED(hr)) + { + dwFlags = SHGDN_INFOLDER | SHGDN_FORPARSING; + hr = m_pShellFolder->GetDisplayNameOf(pidlChild, dwFlags, &StrRet); + if (FAILED_UNEXPECTEDLY(hr)) + return hr; + } + + hr = StrRetToStrW(&StrRet, NULL, &pszChild); + if (FAILED_UNEXPECTEDLY(hr)) + return hr; + + TRACE("pszChild: '%S'\n", static_cast<LPCWSTR>(pszChild)); + return hr; +} + +HRESULT CACListISF::GetPathName(LPCITEMIDLIST pidlChild, CComHeapPtr<WCHAR>& pszPath) +{ + TRACE("(%p, %p)\n", this, pidlChild); + + CComHeapPtr<WCHAR> pszChild; + HRESULT hr = GetDisplayName(pidlChild, pszChild); + if (FAILED_UNEXPECTEDLY(hr)) + return hr; + + CStringW szPath; + if (m_szExpand.GetLength() && m_iNextLocation == LT_DIRECTORY) + { + INT cchExpand = m_szExpand.GetLength(); + if (StrCmpNIW(pszChild, m_szExpand, cchExpand) != 0 || + pszChild[0] != L'\\' || pszChild[1] != L'\\') + { + szPath = m_szExpand; + } + } + szPath += pszChild; + + INT cchMax = szPath.GetLength() + 1; + CComHeapPtr<WCHAR> pszFullPath; + if (!pszFullPath.Allocate(cchMax)) + { + ERR("Out of memory\n"); + return E_OUTOFMEMORY; + } + + StringCchCopyW(pszFullPath, cchMax, szPath); + pszPath.Attach(pszFullPath.Detach()); + TRACE("pszPath: '%S'\n", static_cast<LPCWSTR>(pszPath)); + return S_OK; +} + // *** IEnumString methods *** -HRESULT STDMETHODCALLTYPE CACListISF::Next(ULONG celt, LPOLESTR *rgelt, ULONG *pceltFetched) +STDMETHODIMP CACListISF::Next(ULONG celt, LPOLESTR *rgelt, ULONG *pceltFetched) { TRACE("(%p, %d, %p, %p)\n", this, celt, rgelt, pceltFetched); - return E_NOTIMPL; + + if (celt == 0) + return S_OK; + if (!rgelt) + return S_FALSE; + + *rgelt = NULL; + if (pceltFetched) + *pceltFetched = 0; + + if (!m_pEnumIDList) + { + NextLocation(); + if (!m_pEnumIDList) + return S_FALSE; + } + + HRESULT hr; + CComHeapPtr<ITEMIDLIST> pidlChild; + CComHeapPtr<WCHAR> pszPathName; + + do + { + for (;;) + { + pidlChild.Free(); + hr = m_pEnumIDList->Next(1, &pidlChild, NULL); + if (hr != S_OK) + break; + + pszPathName.Free(); + GetPathName(pidlChild, pszPathName); + if (!pszPathName) + continue; + + if (m_dwOptions & (ACLO_FILESYSONLY | ACLO_FILESYSDIRS)) + { + DWORD attrs = SFGAO_FILESYSANCESTOR | SFGAO_FILESYSTEM; + hr = m_pShellFolder->GetAttributesOf(1, const_cast<LPCITEMIDLIST *>(&pidlChild), &attrs); + if (SUCCEEDED(hr)) + { + if (!(attrs & (SFGAO_FILESYSTEM | SFGAO_FILESYSANCESTOR))) + continue; + } + } + + if ((m_dwOptions & ACLO_FILESYSDIRS) && !PathIsDirectoryW(pszPathName)) + continue; + + hr = S_OK; + break; + } + } while (hr == S_FALSE && NextLocation() == S_OK); + + if (hr == S_OK) + { + *rgelt = pszPathName.Detach(); + if (pceltFetched) + *pceltFetched = 1; + } + else + { + hr = S_FALSE; + } + + TRACE("*rgelt: %S\n", *rgelt); + return hr; } -HRESULT STDMETHODCALLTYPE CACListISF::Reset() +STDMETHODIMP CACListISF::Reset() { TRACE("(%p)\n", this); - return E_NOTIMPL; + + m_iNextLocation = LT_DIRECTORY; + m_szExpand = L""; + + SHELLSTATE ss = { 0 }; + SHGetSetSettings(&ss, SSF_SHOWALLOBJECTS, FALSE); + m_fShowHidden = ss.fShowAllObjects; + + if (m_dwOptions & ACLO_CURRENTDIR) + { + CComHeapPtr<ITEMIDLIST> pidl; + if (m_pBrowserService) + { + m_pBrowserService->GetPidl(&pidl); + if (pidl) + Initialize(pidl); + } + HRESULT hr = SetLocation(pidl.Detach()); + if (FAILED_UNEXPECTEDLY(hr)) + return S_FALSE; + } + return S_OK; } -HRESULT STDMETHODCALLTYPE CACListISF::Skip(ULONG celt) +STDMETHODIMP CACListISF::Skip(ULONG celt) { TRACE("(%p, %d)\n", this, celt); return E_NOTIMPL; } -HRESULT STDMETHODCALLTYPE CACListISF::Clone(IEnumString **ppOut) +STDMETHODIMP CACListISF::Clone(IEnumString **ppOut) { TRACE("(%p, %p)\n", this, ppOut); *ppOut = NULL; @@ -56,36 +323,54 @@ HRESULT STDMETHODCALLTYPE CACListISF::Clone(IEnumString **ppOut) } // *** IACList methods *** -HRESULT STDMETHODCALLTYPE CACListISF::Expand(LPCOLESTR pszExpand) +STDMETHODIMP CACListISF::Expand(LPCOLESTR pszExpand) { TRACE("(%p, %ls)\n", this, pszExpand); - return E_NOTIMPL; + + m_szExpand = pszExpand; + + m_iNextLocation = LT_DIRECTORY; + CComHeapPtr<ITEMIDLIST> pidl; + HRESULT hr = SHParseDisplayName(m_szExpand, NULL, &pidl, NULL, NULL); + if (SUCCEEDED(hr)) + { + hr = SetLocation(pidl.Detach()); + if (FAILED_UNEXPECTEDLY(hr)) + m_szExpand = L""; + } + return hr; } // *** IACList2 methods *** -HRESULT STDMETHODCALLTYPE CACListISF::SetOptions(DWORD dwFlag) +STDMETHODIMP CACListISF::SetOptions(DWORD dwFlag) { TRACE("(%p, %lu)\n", this, dwFlag); m_dwOptions = dwFlag; return S_OK; } -HRESULT STDMETHODCALLTYPE CACListISF::GetOptions(DWORD* pdwFlag) +STDMETHODIMP CACListISF::GetOptions(DWORD* pdwFlag) { TRACE("(%p, %p)\n", this, pdwFlag); - *pdwFlag = m_dwOptions; - return S_OK; + if (pdwFlag) + { + *pdwFlag = m_dwOptions; + return S_OK; + } + return E_INVALIDARG; } // *** IShellService methods *** -HRESULT STDMETHODCALLTYPE CACListISF::SetOwner(IUnknown *punkOwner) +STDMETHODIMP CACListISF::SetOwner(IUnknown *punkOwner) { TRACE("(%p, %p)\n", this, punkOwner); - return E_NOTIMPL; + m_pBrowserService.Release(); + punkOwner->QueryInterface(IID_PPV_ARG(IBrowserService, &m_pBrowserService)); + return S_OK; } // *** IPersist methods *** -HRESULT STDMETHODCALLTYPE CACListISF::GetClassID(CLSID *pClassID) +STDMETHODIMP CACListISF::GetClassID(CLSID *pClassID) { TRACE("(%p, %p)\n", this, pClassID); if (pClassID == NULL) @@ -95,8 +380,39 @@ HRESULT STDMETHODCALLTYPE CACListISF::GetClassID(CLSID *pClassID) } // *** IPersistFolder methods *** -HRESULT STDMETHODCALLTYPE CACListISF::Initialize(PCIDLIST_ABSOLUTE pidl) +STDMETHODIMP CACListISF::Initialize(PCIDLIST_ABSOLUTE pidl) { TRACE("(%p, %p)\n", this, pidl); + m_pidlCurDir.Free(); + if (!pidl) + return S_OK; + + LPITEMIDLIST pidlClone = ILClone(pidl); + if (!pidlClone) + { + ERR("Out of memory\n"); + return E_OUTOFMEMORY; + } + m_pidlCurDir.Attach(pidlClone); + return S_OK; +} + +// *** ICurrentWorkingDirectory methods *** +STDMETHODIMP CACListISF::GetDirectory(LPWSTR pwzPath, DWORD cchSize) +{ + TRACE("(%p, %p, %ld)\n", this, pwzPath, cchSize); + return E_NOTIMPL; +} + +STDMETHODIMP CACListISF::SetDirectory(LPCWSTR pwzPath) +{ + TRACE("(%p, %ls, %ld)\n", this, pwzPath); + LPITEMIDLIST pidl = ILCreateFromPathW(pwzPath); + if (!pidl) + { + ERR("Out of memory\n"); + return E_OUTOFMEMORY; + } + m_pidlCurDir.Attach(pidl); return S_OK; } diff --git a/dll/win32/browseui/aclistisf.h b/dll/win32/browseui/aclistisf.h index ddb530946da..abc63efd45c 100644 --- a/dll/win32/browseui/aclistisf.h +++ b/dll/win32/browseui/aclistisf.h @@ -2,6 +2,7 @@ * Shell AutoComplete list * * Copyright 2015 Thomas Faber + * Copyright 2020 Katayama Hirofumi MZ * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public @@ -25,40 +26,68 @@ class CACListISF : public CComObjectRootEx<CComMultiThreadModelNoCS>, public IEnumString, public IACList2, + public ICurrentWorkingDirectory, public IShellService, public IPersistFolder { private: + enum LOCATION_TYPE + { + LT_DIRECTORY, + LT_DESKTOP, + LT_MYCOMPUTER, + LT_FAVORITES, + LT_MAX + }; + DWORD m_dwOptions; + LOCATION_TYPE m_iNextLocation; + BOOL m_fShowHidden; + CStringW m_szExpand; + CComHeapPtr<ITEMIDLIST> m_pidlLocation; + CComHeapPtr<ITEMIDLIST> m_pidlCurDir; + CComPtr<IEnumIDList> m_pEnumIDList; + CComPtr<IShellFolder> m_pShellFolder; + CComPtr<IBrowserService> m_pBrowserService; public: CACListISF(); ~CACListISF(); + HRESULT NextLocation(); + HRESULT SetLocation(LPITEMIDLIST pidl); + HRESULT GetDisplayName(LPCITEMIDLIST pidlChild, CComHeapPtr<WCHAR>& pszChild); + HRESULT GetPathName(LPCITEMIDLIST pidlChild, CComHeapPtr<WCHAR>& pszPath); + // *** IEnumString methods *** - virtual HRESULT STDMETHODCALLTYPE Next(ULONG celt, LPOLESTR *rgelt, ULONG *pceltFetched); - virtual HRESULT STDMETHODCALLTYPE Skip(ULONG celt); - virtual HRESULT STDMETHODCALLTYPE Reset(); - virtual HRESULT STDMETHODCALLTYPE Clone(IEnumString **ppenum); + STDMETHODIMP Next(ULONG celt, LPOLESTR *rgelt, ULONG *pceltFetched) override; + STDMETHODIMP Skip(ULONG celt) override; + STDMETHODIMP Reset() override; + STDMETHODIMP Clone(IEnumString **ppenum) override; // *** IACList methods *** - virtual HRESULT STDMETHODCALLTYPE Expand(LPCOLESTR pszExpand); + STDMETHODIMP Expand(LPCOLESTR pszExpand) override; // *** IACList2 methods *** - virtual HRESULT STDMETHODCALLTYPE SetOptions(DWORD dwFlag); - virtual HRESULT STDMETHODCALLTYPE GetOptions(DWORD* pdwFlag); + STDMETHODIMP SetOptions(DWORD dwFlag) override; + STDMETHODIMP GetOptions(DWORD* pdwFlag) override; + + // FIXME: These virtual keywords below should be removed. // *** IShellService methods *** - virtual HRESULT STDMETHODCALLTYPE SetOwner(IUnknown *); + virtual STDMETHODIMP SetOwner(IUnknown *punkOwner) override; // *** IPersist methods *** - virtual HRESULT STDMETHODCALLTYPE GetClassID(CLSID *pClassID); + virtual STDMETHODIMP GetClassID(CLSID *pClassID) override; // *** IPersistFolder methods *** - virtual HRESULT STDMETHODCALLTYPE Initialize(PCIDLIST_ABSOLUTE pidl); + virtual STDMETHODIMP Initialize(PCIDLIST_ABSOLUTE pidl) override; -public: + // *** ICurrentWorkingDirectory methods *** + STDMETHODIMP GetDirectory(LPWSTR pwzPath, DWORD cchSize) override; + STDMETHODIMP SetDirectory(LPCWSTR pwzPath) override; +public: DECLARE_REGISTRY_RESOURCEID(IDR_ACLISTISF) DECLARE_NOT_AGGREGATABLE(CACListISF) @@ -72,5 +101,6 @@ public: // Windows doesn't return this //COM_INTERFACE_ENTRY_IID(IID_IPersist, IPersist) COM_INTERFACE_ENTRY_IID(IID_IPersistFolder, IPersistFolder) + COM_INTERFACE_ENTRY_IID(IID_ICurrentWorkingDirectory, ICurrentWorkingDirectory) END_COM_MAP() };

1 0

[reactos] 01/01: [SCSIPORT] Split scsiport.c file into several ones, prepare for the refactoring
by Victor Perevertkin 17 Oct '20

17 Oct '20

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=1b45d9ee4b66768e569a1… commit 1b45d9ee4b66768e569a1f3e06f92897c0957f01 Author: Victor Perevertkin <victor.perevertkin(a)reactos.org> AuthorDate: Sat Oct 17 04:06:36 2020 +0300 Commit: Victor Perevertkin <victor.perevertkin(a)reactos.org> CommitDate: Sat Oct 17 04:06:36 2020 +0300 [SCSIPORT] Split scsiport.c file into several ones, prepare for the refactoring CORE-17132 --- drivers/storage/port/scsiport/CMakeLists.txt | 5 + drivers/storage/port/scsiport/fdo.c | 694 +++++ drivers/storage/port/scsiport/ioctl.c | 255 ++ drivers/storage/port/scsiport/pdo.c | 124 + drivers/storage/port/scsiport/registry.c | 520 ++++ drivers/storage/port/scsiport/scsi.c | 1768 +++++++++++++ drivers/storage/port/scsiport/scsiport.c | 3539 +------------------------- drivers/storage/port/scsiport/scsiport.h | 96 +- 8 files changed, 3541 insertions(+), 3460 deletions(-) diff --git a/drivers/storage/port/scsiport/CMakeLists.txt b/drivers/storage/port/scsiport/CMakeLists.txt index 74304049d99..13c4407e4d9 100644 --- a/drivers/storage/port/scsiport/CMakeLists.txt +++ b/drivers/storage/port/scsiport/CMakeLists.txt @@ -2,6 +2,11 @@ spec2def(scsiport.sys scsiport.spec ADD_IMPORTLIB) list(APPEND SOURCE + fdo.c + ioctl.c + pdo.c + registry.c + scsi.c scsiport.c stubs.c) diff --git a/drivers/storage/port/scsiport/fdo.c b/drivers/storage/port/scsiport/fdo.c new file mode 100644 index 00000000000..95a0f3b4ed5 --- /dev/null +++ b/drivers/storage/port/scsiport/fdo.c @@ -0,0 +1,694 @@ +/* + * PROJECT: ReactOS Storage Stack / SCSIPORT storage port library + * LICENSE: GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later) + * PURPOSE: Adapter device object (FDO) support routines + * COPYRIGHT: Eric Kohl (eric.kohl(a)reactos.org) + * Aleksey Bragin (aleksey(a)reactos.org) + */ + +#include "scsiport.h" + +#define NDEBUG +#include <debug.h> + + +static +NTSTATUS +SpiSendInquiry( + _In_ PDEVICE_OBJECT DeviceObject, + _Inout_ PSCSI_LUN_INFO LunInfo) +{ + IO_STATUS_BLOCK IoStatusBlock; + PIO_STACK_LOCATION IrpStack; + KEVENT Event; + KIRQL Irql; + PIRP Irp; + NTSTATUS Status; + PINQUIRYDATA InquiryBuffer; + PSENSE_DATA SenseBuffer; + BOOLEAN KeepTrying = TRUE; + ULONG RetryCount = 0; + SCSI_REQUEST_BLOCK Srb; + PCDB Cdb; + PSCSI_PORT_LUN_EXTENSION LunExtension; + PSCSI_PORT_DEVICE_EXTENSION DeviceExtension; + + DPRINT("SpiSendInquiry() called\n"); + + DeviceExtension = (PSCSI_PORT_DEVICE_EXTENSION)DeviceObject->DeviceExtension; + + InquiryBuffer = ExAllocatePoolWithTag(NonPagedPool, INQUIRYDATABUFFERSIZE, TAG_SCSIPORT); + if (InquiryBuffer == NULL) + return STATUS_INSUFFICIENT_RESOURCES; + + SenseBuffer = ExAllocatePoolWithTag(NonPagedPool, SENSE_BUFFER_SIZE, TAG_SCSIPORT); + if (SenseBuffer == NULL) + { + ExFreePoolWithTag(InquiryBuffer, TAG_SCSIPORT); + return STATUS_INSUFFICIENT_RESOURCES; + } + + while (KeepTrying) + { + /* Initialize event for waiting */ + KeInitializeEvent(&Event, + NotificationEvent, + FALSE); + + /* Create an IRP */ + Irp = IoBuildDeviceIoControlRequest(IOCTL_SCSI_EXECUTE_IN, + DeviceObject, + NULL, + 0, + InquiryBuffer, + INQUIRYDATABUFFERSIZE, + TRUE, + &Event, + &IoStatusBlock); + if (Irp == NULL) + { + DPRINT("IoBuildDeviceIoControlRequest() failed\n"); + + /* Quit the loop */ + Status = STATUS_INSUFFICIENT_RESOURCES; + KeepTrying = FALSE; + continue; + } + + /* Prepare SRB */ + RtlZeroMemory(&Srb, sizeof(SCSI_REQUEST_BLOCK)); + + Srb.Length = sizeof(SCSI_REQUEST_BLOCK); + Srb.OriginalRequest = Irp; + Srb.PathId = LunInfo->PathId; + Srb.TargetId = LunInfo->TargetId; + Srb.Lun = LunInfo->Lun; + Srb.Function = SRB_FUNCTION_EXECUTE_SCSI; + Srb.SrbFlags = SRB_FLAGS_DATA_IN | SRB_FLAGS_DISABLE_SYNCH_TRANSFER; + Srb.TimeOutValue = 4; + Srb.CdbLength = 6; + + Srb.SenseInfoBuffer = SenseBuffer; + Srb.SenseInfoBufferLength = SENSE_BUFFER_SIZE; + + Srb.DataBuffer = InquiryBuffer; + Srb.DataTransferLength = INQUIRYDATABUFFERSIZE; + + /* Attach Srb to the Irp */ + IrpStack = IoGetNextIrpStackLocation (Irp); + IrpStack->Parameters.Scsi.Srb = &Srb; + + /* Fill in CDB */ + Cdb = (PCDB)Srb.Cdb; + Cdb->CDB6INQUIRY.OperationCode = SCSIOP_INQUIRY; + Cdb->CDB6INQUIRY.LogicalUnitNumber = LunInfo->Lun; + Cdb->CDB6INQUIRY.AllocationLength = INQUIRYDATABUFFERSIZE; + + /* Call the driver */ + Status = IoCallDriver(DeviceObject, Irp); + + /* Wait for it to complete */ + if (Status == STATUS_PENDING) + { + DPRINT("SpiSendInquiry(): Waiting for the driver to process request...\n"); + KeWaitForSingleObject(&Event, + Executive, + KernelMode, + FALSE, + NULL); + Status = IoStatusBlock.Status; + } + + DPRINT("SpiSendInquiry(): Request processed by driver, status = 0x%08X\n", Status); + + if (SRB_STATUS(Srb.SrbStatus) == SRB_STATUS_SUCCESS) + { + /* All fine, copy data over */ + RtlCopyMemory(LunInfo->InquiryData, + InquiryBuffer, + INQUIRYDATABUFFERSIZE); + + /* Quit the loop */ + Status = STATUS_SUCCESS; + KeepTrying = FALSE; + continue; + } + + DPRINT("Inquiry SRB failed with SrbStatus 0x%08X\n", Srb.SrbStatus); + + /* Check if the queue is frozen */ + if (Srb.SrbStatus & SRB_STATUS_QUEUE_FROZEN) + { + /* Something weird happened, deal with it (unfreeze the queue) */ + KeepTrying = FALSE; + + DPRINT("SpiSendInquiry(): the queue is frozen at TargetId %d\n", Srb.TargetId); + + LunExtension = SpiGetLunExtension(DeviceExtension, + LunInfo->PathId, + LunInfo->TargetId, + LunInfo->Lun); + + /* Clear frozen flag */ + LunExtension->Flags &= ~LUNEX_FROZEN_QUEUE; + + /* Acquire the spinlock */ + KeAcquireSpinLock(&DeviceExtension->SpinLock, &Irql); + + /* Process the request */ + SpiGetNextRequestFromLun(DeviceObject->DeviceExtension, LunExtension); + + /* SpiGetNextRequestFromLun() releases the spinlock, + so we just lower irql back to what it was before */ + KeLowerIrql(Irql); + } + + /* Check if data overrun happened */ + if (SRB_STATUS(Srb.SrbStatus) == SRB_STATUS_DATA_OVERRUN) + { + DPRINT("Data overrun at TargetId %d\n", LunInfo->TargetId); + + /* Nothing dramatic, just copy data, but limiting the size */ + RtlCopyMemory(LunInfo->InquiryData, + InquiryBuffer, + (Srb.DataTransferLength > INQUIRYDATABUFFERSIZE) ? + INQUIRYDATABUFFERSIZE : Srb.DataTransferLength); + + /* Quit the loop */ + Status = STATUS_SUCCESS; + KeepTrying = FALSE; + } + else if ((Srb.SrbStatus & SRB_STATUS_AUTOSENSE_VALID) && + SenseBuffer->SenseKey == SCSI_SENSE_ILLEGAL_REQUEST) + { + /* LUN is not valid, but some device responds there. + Mark it as invalid anyway */ + + /* Quit the loop */ + Status = STATUS_INVALID_DEVICE_REQUEST; + KeepTrying = FALSE; + } + else + { + /* Retry a couple of times if no timeout happened */ + if ((RetryCount < 2) && + (SRB_STATUS(Srb.SrbStatus) != SRB_STATUS_NO_DEVICE) && + (SRB_STATUS(Srb.SrbStatus) != SRB_STATUS_SELECTION_TIMEOUT)) + { + RetryCount++; + KeepTrying = TRUE; + } + else + { + /* That's all, quit the loop */ + KeepTrying = FALSE; + + /* Set status according to SRB status */ + if (SRB_STATUS(Srb.SrbStatus) == SRB_STATUS_BAD_FUNCTION || + SRB_STATUS(Srb.SrbStatus) == SRB_STATUS_BAD_SRB_BLOCK_LENGTH) + { + Status = STATUS_INVALID_DEVICE_REQUEST; + } + else + { + Status = STATUS_IO_DEVICE_ERROR; + } + } + } + } + + /* Free buffers */ + ExFreePoolWithTag(InquiryBuffer, TAG_SCSIPORT); + ExFreePoolWithTag(SenseBuffer, TAG_SCSIPORT); + + DPRINT("SpiSendInquiry() done with Status 0x%08X\n", Status); + + return Status; +} + +/* Scans all SCSI buses */ +VOID +SpiScanAdapter( + _In_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension) +{ + PSCSI_PORT_LUN_EXTENSION LunExtension; + ULONG Bus; + ULONG Target; + ULONG Lun; + PSCSI_BUS_SCAN_INFO BusScanInfo; + PSCSI_LUN_INFO LastLunInfo, LunInfo, LunInfoExists; + BOOLEAN DeviceExists; + ULONG Hint; + NTSTATUS Status; + ULONG DevicesFound; + + DPRINT("SpiScanAdapter() called\n"); + + /* Scan all buses */ + for (Bus = 0; Bus < DeviceExtension->BusNum; Bus++) + { + DPRINT(" Scanning bus %d\n", Bus); + DevicesFound = 0; + + /* Get pointer to the scan information */ + BusScanInfo = DeviceExtension->BusesConfig->BusScanInfo[Bus]; + + if (BusScanInfo) + { + /* Find the last LUN info in the list */ + LunInfo = DeviceExtension->BusesConfig->BusScanInfo[Bus]->LunInfo; + LastLunInfo = LunInfo; + + while (LunInfo != NULL) + { + LastLunInfo = LunInfo; + LunInfo = LunInfo->Next; + } + } + else + { + /* We need to allocate this buffer */ + BusScanInfo = ExAllocatePoolWithTag(NonPagedPool, sizeof(SCSI_BUS_SCAN_INFO), TAG_SCSIPORT); + if (!BusScanInfo) + { + DPRINT1("Out of resources!\n"); + return; + } + + /* Store the pointer in the BusScanInfo array */ + DeviceExtension->BusesConfig->BusScanInfo[Bus] = BusScanInfo; + + /* Fill this struct (length and bus ids for now) */ + BusScanInfo->Length = sizeof(SCSI_BUS_SCAN_INFO); + BusScanInfo->LogicalUnitsCount = 0; + BusScanInfo->BusIdentifier = DeviceExtension->PortConfig->InitiatorBusId[Bus]; + BusScanInfo->LunInfo = NULL; + + /* Set pointer to the last LUN info to NULL */ + LastLunInfo = NULL; + } + + /* Create LUN information structure */ + LunInfo = ExAllocatePoolWithTag(PagedPool, sizeof(SCSI_LUN_INFO), TAG_SCSIPORT); + if (!LunInfo) + { + DPRINT1("Out of resources!\n"); + return; + } + + RtlZeroMemory(LunInfo, sizeof(SCSI_LUN_INFO)); + + /* Create LunExtension */ + LunExtension = SpiAllocateLunExtension(DeviceExtension); + + /* And send INQUIRY to every target */ + for (Target = 0; Target < DeviceExtension->PortConfig->MaximumNumberOfTargets; Target++) + { + /* TODO: Support scan bottom-up */ + + /* Skip if it's the same address */ + if (Target == BusScanInfo->BusIdentifier) + continue; + + /* Try to find an existing device here */ + DeviceExists = FALSE; + LunInfoExists = BusScanInfo->LunInfo; + + /* Find matching address on this bus */ + while (LunInfoExists) + { + if (LunInfoExists->TargetId == Target) + { + DeviceExists = TRUE; + break; + } + + /* Advance to the next one */ + LunInfoExists = LunInfoExists->Next; + } + + /* No need to bother rescanning, since we already did that before */ + if (DeviceExists) + continue; + + /* Scan all logical units */ + for (Lun = 0; Lun < SCSI_MAXIMUM_LOGICAL_UNITS; Lun++) + { + if ((!LunExtension) || (!LunInfo)) + break; + + /* Add extension to the list */ + Hint = (Target + Lun) % LUS_NUMBER; + LunExtension->Next = DeviceExtension->LunExtensionList[Hint]; + DeviceExtension->LunExtensionList[Hint] = LunExtension; + + /* Fill Path, Target, Lun fields */ + LunExtension->PathId = LunInfo->PathId = (UCHAR)Bus; + LunExtension->TargetId = LunInfo->TargetId = (UCHAR)Target; + LunExtension->Lun = LunInfo->Lun = (UCHAR)Lun; + + /* Set flag to prevent race conditions */ + LunExtension->Flags |= SCSI_PORT_SCAN_IN_PROGRESS; + + /* Zero LU extension contents */ + if (DeviceExtension->LunExtensionSize) + { + RtlZeroMemory(LunExtension + 1, + DeviceExtension->LunExtensionSize); + } + + /* Finally send the inquiry command */ + Status = SpiSendInquiry(DeviceExtension->DeviceObject, LunInfo); + + if (NT_SUCCESS(Status)) + { + /* Let's see if we really found a device */ + PINQUIRYDATA InquiryData = (PINQUIRYDATA)LunInfo->InquiryData; + + /* Check if this device is unsupported */ + if (InquiryData->DeviceTypeQualifier == DEVICE_QUALIFIER_NOT_SUPPORTED) + { + DeviceExtension->LunExtensionList[Hint] = + DeviceExtension->LunExtensionList[Hint]->Next; + + continue; + } + + /* Clear the "in scan" flag */ + LunExtension->Flags &= ~SCSI_PORT_SCAN_IN_PROGRESS; + + DPRINT("SpiScanAdapter(): Found device of type %d at bus %d tid %d lun %d\n", + InquiryData->DeviceType, Bus, Target, Lun); + + /* + * Cache the inquiry data into the LUN extension (or alternatively + * we could save a pointer to LunInfo within the LunExtension?) + */ + RtlCopyMemory(&LunExtension->InquiryData, + InquiryData, + INQUIRYDATABUFFERSIZE); + + /* Add this info to the linked list */ + LunInfo->Next = NULL; + if (LastLunInfo) + LastLunInfo->Next = LunInfo; + else + BusScanInfo->LunInfo = LunInfo; + + /* Store the last LUN info */ + LastLunInfo = LunInfo; + + /* Store DeviceObject */ + LunInfo->DeviceObject = DeviceExtension->DeviceObject; + + /* Allocate another buffer */ + LunInfo = ExAllocatePoolWithTag(PagedPool, sizeof(SCSI_LUN_INFO), TAG_SCSIPORT); + if (!LunInfo) + { + DPRINT1("Out of resources!\n"); + break; + } + + RtlZeroMemory(LunInfo, sizeof(SCSI_LUN_INFO)); + + /* Create a new LU extension */ + LunExtension = SpiAllocateLunExtension(DeviceExtension); + + DevicesFound++; + } + else + { + /* Remove this LUN from the list */ + DeviceExtension->LunExtensionList[Hint] = + DeviceExtension->LunExtensionList[Hint]->Next; + + /* Decide whether we are continuing or not */ + if (Status == STATUS_INVALID_DEVICE_REQUEST) + continue; + else + break; + } + } + } + + /* Free allocated buffers */ + if (LunExtension) + ExFreePoolWithTag(LunExtension, TAG_SCSIPORT); + + if (LunInfo) + ExFreePoolWithTag(LunInfo, TAG_SCSIPORT); + + /* Sum what we found */ + BusScanInfo->LogicalUnitsCount += (UCHAR)DevicesFound; + DPRINT(" Found %d devices on bus %d\n", DevicesFound, Bus); + } + + DPRINT("SpiScanAdapter() done\n"); +} + +/** + * @brief Calls HwInitialize routine of the miniport and sets up interrupts + * Should be called inside ScsiPortInitialize (for legacy drivers) + * or inside IRP_MN_START_DEVICE for pnp drivers + * + * @param[in] DeviceExtension The device extension + * + * @return NTSTATUS of the operation + */ +NTSTATUS +CallHWInitialize( + _In_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension) +{ + PPORT_CONFIGURATION_INFORMATION PortConfig = DeviceExtension->PortConfig; + NTSTATUS Status = STATUS_SUCCESS; + KIRQL OldIrql; + + /* Deal with interrupts */ + if (DeviceExtension->HwInterrupt == NULL || + (PortConfig->BusInterruptLevel == 0 && PortConfig->BusInterruptVector == 0)) + { + /* No interrupts */ + DeviceExtension->InterruptCount = 0; + + DPRINT1("Interrupt Count: 0\n"); + + UNIMPLEMENTED; + + /* This code path will ALWAYS crash so stop it now */ + __debugbreak(); + } + else + { + BOOLEAN InterruptShareable; + KINTERRUPT_MODE InterruptMode[2]; + ULONG InterruptVector[2], i, MappedIrq[2]; + KIRQL Dirql[2], MaxDirql; + KAFFINITY Affinity[2]; + + DeviceExtension->InterruptLevel[0] = PortConfig->BusInterruptLevel; + DeviceExtension->InterruptLevel[1] = PortConfig->BusInterruptLevel2; + + InterruptVector[0] = PortConfig->BusInterruptVector; + InterruptVector[1] = PortConfig->BusInterruptVector2; + + InterruptMode[0] = PortConfig->InterruptMode; + InterruptMode[1] = PortConfig->InterruptMode2; + + DeviceExtension->InterruptCount = + (PortConfig->BusInterruptLevel2 != 0 || + PortConfig->BusInterruptVector2 != 0) ? 2 : 1; + + for (i = 0; i < DeviceExtension->InterruptCount; i++) + { + /* Register an interrupt handler for this device */ + MappedIrq[i] = HalGetInterruptVector( + PortConfig->AdapterInterfaceType, PortConfig->SystemIoBusNumber, + DeviceExtension->InterruptLevel[i], InterruptVector[i], &Dirql[i], + &Affinity[i]); + } + + if (DeviceExtension->InterruptCount == 1 || Dirql[0] > Dirql[1]) + MaxDirql = Dirql[0]; + else + MaxDirql = Dirql[1]; + + for (i = 0; i < DeviceExtension->InterruptCount; i++) + { + /* Determine IRQ sharability as usual */ + if (PortConfig->AdapterInterfaceType == MicroChannel || + InterruptMode[i] == LevelSensitive) + { + InterruptShareable = TRUE; + } + else + { + InterruptShareable = FALSE; + } + + Status = IoConnectInterrupt( + &DeviceExtension->Interrupt[i], (PKSERVICE_ROUTINE)ScsiPortIsr, DeviceExtension, + &DeviceExtension->IrqLock, MappedIrq[i], Dirql[i], MaxDirql, InterruptMode[i], + InterruptShareable, Affinity[i], FALSE); + + if (!(NT_SUCCESS(Status))) + { + DPRINT1("Could not connect interrupt %d\n", InterruptVector[i]); + DeviceExtension->Interrupt[i] = NULL; + return Status; + } + } + + if (!NT_SUCCESS(Status)) + return Status; + } + + /* Save IoAddress (from access ranges) */ + if (PortConfig->NumberOfAccessRanges != 0) + { + DeviceExtension->IoAddress = ((*(PortConfig->AccessRanges))[0]).RangeStart.LowPart; + + DPRINT("Io Address %x\n", DeviceExtension->IoAddress); + } + + /* Set flag that it's allowed to disconnect during this command */ + DeviceExtension->Flags |= SCSI_PORT_DISCONNECT_ALLOWED; + + /* Initialize counter of active requests (-1 means there are none) */ + DeviceExtension->ActiveRequestCounter = -1; + + /* Analyze what we have about DMA */ + if (DeviceExtension->AdapterObject != NULL && PortConfig->Master && + PortConfig->NeedPhysicalAddresses) + { + DeviceExtension->MapRegisters = TRUE; + } + else + { + DeviceExtension->MapRegisters = FALSE; + } + + /* Call HwInitialize at DISPATCH_LEVEL */ + KeRaiseIrql(DISPATCH_LEVEL, &OldIrql); + + if (!KeSynchronizeExecution( + DeviceExtension->Interrupt[0], DeviceExtension->HwInitialize, + DeviceExtension->MiniPortDeviceExtension)) + { + DPRINT1("HwInitialize() failed!\n"); + KeLowerIrql(OldIrql); + return STATUS_ADAPTER_HARDWARE_ERROR; + } + + /* Check if a notification is needed */ + if (DeviceExtension->InterruptData.Flags & SCSI_PORT_NOTIFICATION_NEEDED) + { + /* Call DPC right away, because we're already at DISPATCH_LEVEL */ + ScsiPortDpcForIsr(NULL, DeviceExtension->DeviceObject, NULL, NULL); + } + + /* Lower irql back to what it was */ + KeLowerIrql(OldIrql); + + return Status; +} + +VOID +SpiCleanupAfterInit( + _In_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension) +{ + PSCSI_LUN_INFO LunInfo; + PVOID Ptr; + ULONG Bus, Lun; + + /* Check if we have something to clean up */ + if (DeviceExtension == NULL) + return; + + /* Stop the timer */ + IoStopTimer(DeviceExtension->DeviceObject); + + /* Disconnect the interrupts */ + while (DeviceExtension->InterruptCount) + { + if (DeviceExtension->Interrupt[--DeviceExtension->InterruptCount]) + IoDisconnectInterrupt(DeviceExtension->Interrupt[DeviceExtension->InterruptCount]); + } + + /* Delete ConfigInfo */ + if (DeviceExtension->BusesConfig) + { + for (Bus = 0; Bus < DeviceExtension->BusNum; Bus++) + { + if (!DeviceExtension->BusesConfig->BusScanInfo[Bus]) + continue; + + LunInfo = DeviceExtension->BusesConfig->BusScanInfo[Bus]->LunInfo; + + while (LunInfo) + { + /* Free current, but save pointer to the next one */ + Ptr = LunInfo->Next; + ExFreePool(LunInfo); + LunInfo = Ptr; + } + + ExFreePool(DeviceExtension->BusesConfig->BusScanInfo[Bus]); + } + + ExFreePool(DeviceExtension->BusesConfig); + } + + /* Free PortConfig */ + if (DeviceExtension->PortConfig) + ExFreePool(DeviceExtension->PortConfig); + + /* Free LUNs*/ + for(Lun = 0; Lun < LUS_NUMBER; Lun++) + { + while (DeviceExtension->LunExtensionList[Lun]) + { + Ptr = DeviceExtension->LunExtensionList[Lun]; + DeviceExtension->LunExtensionList[Lun] = DeviceExtension->LunExtensionList[Lun]->Next; + + ExFreePool(Ptr); + } + } + + /* Free common buffer (if it exists) */ + if (DeviceExtension->SrbExtensionBuffer != NULL && + DeviceExtension->CommonBufferLength != 0) + { + if (!DeviceExtension->AdapterObject) + { + ExFreePool(DeviceExtension->SrbExtensionBuffer); + } + else + { + HalFreeCommonBuffer(DeviceExtension->AdapterObject, + DeviceExtension->CommonBufferLength, + DeviceExtension->PhysicalAddress, + DeviceExtension->SrbExtensionBuffer, + FALSE); + } + } + + /* Free SRB info */ + if (DeviceExtension->SrbInfo != NULL) + ExFreePool(DeviceExtension->SrbInfo); + + /* Unmap mapped addresses */ + while (DeviceExtension->MappedAddressList != NULL) + { + MmUnmapIoSpace(DeviceExtension->MappedAddressList->MappedAddress, + DeviceExtension->MappedAddressList->NumberOfBytes); + + Ptr = DeviceExtension->MappedAddressList; + DeviceExtension->MappedAddressList = DeviceExtension->MappedAddressList->NextMappedAddress; + + ExFreePool(Ptr); + } + + /* Finally delete the device object */ + DPRINT("Deleting device %p\n", DeviceExtension->DeviceObject); + IoDeleteDevice(DeviceExtension->DeviceObject); +} diff --git a/drivers/storage/port/scsiport/ioctl.c b/drivers/storage/port/scsiport/ioctl.c new file mode 100644 index 00000000000..08de2260961 --- /dev/null +++ b/drivers/storage/port/scsiport/ioctl.c @@ -0,0 +1,255 @@ +/* + * PROJECT: ReactOS Storage Stack / SCSIPORT storage port library + * LICENSE: GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later) + * PURPOSE: IOCTL handlers + * COPYRIGHT: Eric Kohl (eric.kohl(a)reactos.org) + * Aleksey Bragin (aleksey(a)reactos.org) + */ + +#include "scsiport.h" + +#define NDEBUG +#include <debug.h> + + +static +NTSTATUS +SpiGetInquiryData( + _In_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, + _In_ PIRP Irp) +{ + ULONG InquiryDataSize; + PSCSI_LUN_INFO LunInfo; + ULONG BusCount, LunCount, Length; + PIO_STACK_LOCATION IrpStack; + PSCSI_ADAPTER_BUS_INFO AdapterBusInfo; + PSCSI_INQUIRY_DATA InquiryData; + PSCSI_BUS_DATA BusData; + ULONG Bus; + PUCHAR Buffer; + + DPRINT("SpiGetInquiryData() called\n"); + + /* Get pointer to the buffer */ + IrpStack = IoGetCurrentIrpStackLocation(Irp); + Buffer = Irp->AssociatedIrp.SystemBuffer; + + /* Initialize bus and LUN counters */ + BusCount = DeviceExtension->BusesConfig->NumberOfBuses; + LunCount = 0; + + /* Calculate total number of LUNs */ + for (Bus = 0; Bus < BusCount; Bus++) + LunCount += DeviceExtension->BusesConfig->BusScanInfo[Bus]->LogicalUnitsCount; + + /* Calculate size of inquiry data, rounding up to sizeof(ULONG) */ + InquiryDataSize = + ((sizeof(SCSI_INQUIRY_DATA) - 1 + INQUIRYDATABUFFERSIZE + + sizeof(ULONG) - 1) & ~(sizeof(ULONG) - 1)); + + /* Calculate data size */ + Length = sizeof(SCSI_ADAPTER_BUS_INFO) + (BusCount - 1) * sizeof(SCSI_BUS_DATA); + + Length += InquiryDataSize * LunCount; + + /* Check, if all data is going to fit into provided buffer */ + if (IrpStack->Parameters.DeviceIoControl.OutputBufferLength < Length) + { + Irp->IoStatus.Status = STATUS_BUFFER_TOO_SMALL; + return STATUS_BUFFER_TOO_SMALL; + } + + /* Store data size in the IRP */ + Irp->IoStatus.Information = Length; + + DPRINT("Data size: %lu\n", Length); + + AdapterBusInfo = (PSCSI_ADAPTER_BUS_INFO)Buffer; + + AdapterBusInfo->NumberOfBuses = (UCHAR)BusCount; + + /* Point InquiryData to the corresponding place inside Buffer */ + InquiryData = (PSCSI_INQUIRY_DATA)(Buffer + sizeof(SCSI_ADAPTER_BUS_INFO) + + (BusCount - 1) * sizeof(SCSI_BUS_DATA)); + + /* Loop each bus */ + for (Bus = 0; Bus < BusCount; Bus++) + { + BusData = &AdapterBusInfo->BusData[Bus]; + + /* Calculate and save an offset of the inquiry data */ + BusData->InquiryDataOffset = (ULONG)((PUCHAR)InquiryData - Buffer); + + /* Get a pointer to the LUN information structure */ + LunInfo = DeviceExtension->BusesConfig->BusScanInfo[Bus]->LunInfo; + + /* Store Initiator Bus Id */ + BusData->InitiatorBusId = + DeviceExtension->BusesConfig->BusScanInfo[Bus]->BusIdentifier; + + /* Store LUN count */ + BusData->NumberOfLogicalUnits = + DeviceExtension->BusesConfig->BusScanInfo[Bus]->LogicalUnitsCount; + + /* Loop all LUNs */ + while (LunInfo != NULL) + { + DPRINT("(Bus %lu Target %lu Lun %lu)\n", + Bus, LunInfo->TargetId, LunInfo->Lun); + + /* Fill InquiryData with values */ + InquiryData->PathId = LunInfo->PathId; + InquiryData->TargetId = LunInfo->TargetId; + InquiryData->Lun = LunInfo->Lun; + InquiryData->InquiryDataLength = INQUIRYDATABUFFERSIZE; + InquiryData->DeviceClaimed = LunInfo->DeviceClaimed; + InquiryData->NextInquiryDataOffset = + (ULONG)((PUCHAR)InquiryData + InquiryDataSize - Buffer); + + /* Copy data in it */ + RtlCopyMemory(InquiryData->InquiryData, + LunInfo->InquiryData, + INQUIRYDATABUFFERSIZE); + + /* Move to the next LUN */ + LunInfo = LunInfo->Next; + InquiryData = (PSCSI_INQUIRY_DATA) ((PCHAR)InquiryData + InquiryDataSize); + } + + /* Either mark the end, or set offset to 0 */ + if (BusData->NumberOfLogicalUnits != 0) + ((PSCSI_INQUIRY_DATA) ((PCHAR)InquiryData - InquiryDataSize))->NextInquiryDataOffset = 0; + else + BusData->InquiryDataOffset = 0; + } + + /* Finish with success */ + Irp->IoStatus.Status = STATUS_SUCCESS; + return STATUS_SUCCESS; +} + +/********************************************************************** + * NAME INTERNAL + * ScsiPortDeviceControl + * + * DESCRIPTION + * Answer requests for device control calls + * + * RUN LEVEL + * PASSIVE_LEVEL + * + * ARGUMENTS + * Standard dispatch arguments + * + * RETURNS + * NTSTATUS + */ + +NTSTATUS +NTAPI +ScsiPortDeviceControl( + _In_ PDEVICE_OBJECT DeviceObject, + _In_ PIRP Irp) +{ + PIO_STACK_LOCATION Stack; + PSCSI_PORT_DEVICE_EXTENSION DeviceExtension; + PDUMP_POINTERS DumpPointers; + NTSTATUS Status; + + DPRINT("ScsiPortDeviceControl()\n"); + + Irp->IoStatus.Information = 0; + + Stack = IoGetCurrentIrpStackLocation(Irp); + DeviceExtension = DeviceObject->DeviceExtension; + + switch (Stack->Parameters.DeviceIoControl.IoControlCode) + { + case IOCTL_SCSI_GET_DUMP_POINTERS: + DPRINT(" IOCTL_SCSI_GET_DUMP_POINTERS\n"); + + if (Stack->Parameters.DeviceIoControl.OutputBufferLength < sizeof(DUMP_POINTERS)) + { + Status = STATUS_BUFFER_OVERFLOW; + Irp->IoStatus.Information = sizeof(DUMP_POINTERS); + break; + } + + DumpPointers = Irp->AssociatedIrp.SystemBuffer; + DumpPointers->DeviceObject = DeviceObject; + /* More data.. ? */ + + Status = STATUS_SUCCESS; + Irp->IoStatus.Information = sizeof(DUMP_POINTERS); + break; + + case IOCTL_SCSI_GET_CAPABILITIES: + DPRINT(" IOCTL_SCSI_GET_CAPABILITIES\n"); + if (Stack->Parameters.DeviceIoControl.OutputBufferLength == sizeof(PVOID)) + { + *((PVOID *)Irp->AssociatedIrp.SystemBuffer) = &DeviceExtension->PortCapabilities; + + Irp->IoStatus.Information = sizeof(PVOID); + Status = STATUS_SUCCESS; + break; + } + + if (Stack->Parameters.DeviceIoControl.OutputBufferLength < sizeof(IO_SCSI_CAPABILITIES)) + { + Status = STATUS_BUFFER_TOO_SMALL; + break; + } + + RtlCopyMemory(Irp->AssociatedIrp.SystemBuffer, + &DeviceExtension->PortCapabilities, + sizeof(IO_SCSI_CAPABILITIES)); + + Irp->IoStatus.Information = sizeof(IO_SCSI_CAPABILITIES); + Status = STATUS_SUCCESS; + break; + + case IOCTL_SCSI_GET_INQUIRY_DATA: + DPRINT(" IOCTL_SCSI_GET_INQUIRY_DATA\n"); + + /* Copy inquiry data to the port device extension */ + Status = SpiGetInquiryData(DeviceExtension, Irp); + break; + + case IOCTL_SCSI_MINIPORT: + DPRINT1("IOCTL_SCSI_MINIPORT unimplemented!\n"); + Status = STATUS_NOT_IMPLEMENTED; + break; + + case IOCTL_SCSI_PASS_THROUGH: + DPRINT1("IOCTL_SCSI_PASS_THROUGH unimplemented!\n"); + Status = STATUS_NOT_IMPLEMENTED; + break; + + default: + if (DEVICE_TYPE_FROM_CTL_CODE(Stack->Parameters.DeviceIoControl.IoControlCode) == MOUNTDEVCONTROLTYPE) + { + switch (Stack->Parameters.DeviceIoControl.IoControlCode) + { + case IOCTL_MOUNTDEV_QUERY_DEVICE_NAME: + DPRINT1("Got unexpected IOCTL_MOUNTDEV_QUERY_DEVICE_NAME\n"); + break; + case IOCTL_MOUNTDEV_QUERY_UNIQUE_ID: + DPRINT1("Got unexpected IOCTL_MOUNTDEV_QUERY_UNIQUE_ID\n"); + break; + default: + DPRINT(" got ioctl intended for the mount manager: 0x%lX\n", Stack->Parameters.DeviceIoControl.IoControlCode); + break; + } + } else { + DPRINT1(" unknown ioctl code: 0x%lX\n", Stack->Parameters.DeviceIoControl.IoControlCode); + } + Status = STATUS_NOT_IMPLEMENTED; + break; + } + + /* Complete the request with the given status */ + Irp->IoStatus.Status = Status; + IoCompleteRequest(Irp, IO_NO_INCREMENT); + + return Status; +} diff --git a/drivers/storage/port/scsiport/pdo.c b/drivers/storage/port/scsiport/pdo.c new file mode 100644 index 00000000000..7365f42e443 --- /dev/null +++ b/drivers/storage/port/scsiport/pdo.c @@ -0,0 +1,124 @@ +/* + * PROJECT: ReactOS Storage Stack / SCSIPORT storage port library + * LICENSE: GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later) + * PURPOSE: Logical Unit (PDO) functions + * COPYRIGHT: Eric Kohl (eric.kohl(a)reactos.org) + * Aleksey Bragin (aleksey(a)reactos.org) + */ + +#include "scsiport.h" + +#define NDEBUG +#include <debug.h> + + +PSCSI_PORT_LUN_EXTENSION +SpiAllocateLunExtension( + _In_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension) +{ + PSCSI_PORT_LUN_EXTENSION LunExtension; + ULONG LunExtensionSize; + + DPRINT("SpiAllocateLunExtension(%p)\n", DeviceExtension); + + /* Round LunExtensionSize first to the sizeof LONGLONG */ + LunExtensionSize = (DeviceExtension->LunExtensionSize + + sizeof(LONGLONG) - 1) & ~(sizeof(LONGLONG) - 1); + + LunExtensionSize += sizeof(SCSI_PORT_LUN_EXTENSION); + DPRINT("LunExtensionSize %lu\n", LunExtensionSize); + + LunExtension = ExAllocatePoolWithTag(NonPagedPool, LunExtensionSize, TAG_SCSIPORT); + if (LunExtension == NULL) + { + DPRINT1("Out of resources!\n"); + return NULL; + } + + /* Zero everything */ + RtlZeroMemory(LunExtension, LunExtensionSize); + + /* Initialize a list of requests */ + InitializeListHead(&LunExtension->SrbInfo.Requests); + + /* Initialize timeout counter */ + LunExtension->RequestTimeout = -1; + + /* Set maximum queue size */ + LunExtension->MaxQueueCount = 256; + + /* Initialize request queue */ + KeInitializeDeviceQueue(&LunExtension->DeviceQueue); + + return LunExtension; +} + +PSCSI_PORT_LUN_EXTENSION +SpiGetLunExtension( + _In_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, + _In_ UCHAR PathId, + _In_ UCHAR TargetId, + _In_ UCHAR Lun) +{ + PSCSI_PORT_LUN_EXTENSION LunExtension; + + DPRINT("SpiGetLunExtension(%p %u %u %u) called\n", + DeviceExtension, PathId, TargetId, Lun); + + /* Get appropriate list */ + LunExtension = DeviceExtension->LunExtensionList[(TargetId + Lun) % LUS_NUMBER]; + + /* Iterate it until we find what we need */ + while (LunExtension) + { + if (LunExtension->TargetId == TargetId && + LunExtension->Lun == Lun && + LunExtension->PathId == PathId) + { + /* All matches, return */ + return LunExtension; + } + + /* Advance to the next item */ + LunExtension = LunExtension->Next; + } + + /* We did not find anything */ + DPRINT("Nothing found\n"); + return NULL; +} + +PSCSI_REQUEST_BLOCK_INFO +SpiGetSrbData( + _In_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, + _In_ UCHAR PathId, + _In_ UCHAR TargetId, + _In_ UCHAR Lun, + _In_ UCHAR QueueTag) +{ + PSCSI_PORT_LUN_EXTENSION LunExtension; + + if (QueueTag == SP_UNTAGGED) + { + /* Untagged request, get LU and return pointer to SrbInfo */ + LunExtension = SpiGetLunExtension(DeviceExtension, + PathId, + TargetId, + Lun); + + /* Return NULL in case of error */ + if (!LunExtension) + return(NULL); + + /* Return the pointer to SrbInfo */ + return &LunExtension->SrbInfo; + } + else + { + /* Make sure the tag is valid, if it is - return the data */ + if (QueueTag > DeviceExtension->SrbDataCount || QueueTag < 1) + return NULL; + else + return &DeviceExtension->SrbInfo[QueueTag -1]; + } +} diff --git a/drivers/storage/port/scsiport/registry.c b/drivers/storage/port/scsiport/registry.c new file mode 100644 index 00000000000..5deaf85c8e9 --- /dev/null +++ b/drivers/storage/port/scsiport/registry.c @@ -0,0 +1,520 @@ +/* + * PROJECT: ReactOS Storage Stack / SCSIPORT storage port library + * LICENSE: GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later) + * PURPOSE: Registry operations + * COPYRIGHT: Eric Kohl (eric.kohl(a)reactos.org) + * Aleksey Bragin (aleksey(a)reactos.org) + */ + +#include "scsiport.h" + +#define NDEBUG +#include <debug.h> + + +VOID +SpiInitOpenKeys( + _Inout_ PCONFIGURATION_INFO ConfigInfo, + _In_ PUNICODE_STRING RegistryPath) +{ + OBJECT_ATTRIBUTES ObjectAttributes; + UNICODE_STRING KeyName; + NTSTATUS Status; + + /* Open the service key */ + InitializeObjectAttributes(&ObjectAttributes, + RegistryPath, + OBJ_CASE_INSENSITIVE, + NULL, + NULL); + + Status = ZwOpenKey(&ConfigInfo->ServiceKey, + KEY_READ, + &ObjectAttributes); + + if (!NT_SUCCESS(Status)) + { + DPRINT("Unable to open driver's registry key %wZ, status 0x%08x\n", RegistryPath, Status); + ConfigInfo->ServiceKey = NULL; + } + + /* If we could open driver's service key, then proceed to the Parameters key */ + if (ConfigInfo->ServiceKey != NULL) + { + RtlInitUnicodeString(&KeyName, L"Parameters"); + InitializeObjectAttributes(&ObjectAttributes, + &KeyName, + OBJ_CASE_INSENSITIVE, + ConfigInfo->ServiceKey, + (PSECURITY_DESCRIPTOR) NULL); + + /* Try to open it */ + Status = ZwOpenKey(&ConfigInfo->DeviceKey, + KEY_READ, + &ObjectAttributes); + + if (NT_SUCCESS(Status)) + { + /* Yes, Parameters key exist, and it must be used instead of + the Service key */ + ZwClose(ConfigInfo->ServiceKey); + ConfigInfo->ServiceKey = ConfigInfo->DeviceKey; + ConfigInfo->DeviceKey = NULL; + } + } + + if (ConfigInfo->ServiceKey != NULL) + { + /* Open the Device key */ + RtlInitUnicodeString(&KeyName, L"Device"); + InitializeObjectAttributes(&ObjectAttributes, + &KeyName, + OBJ_CASE_INSENSITIVE, + ConfigInfo->ServiceKey, + NULL); + + /* We don't check for failure here - not needed */ + ZwOpenKey(&ConfigInfo->DeviceKey, + KEY_READ, + &ObjectAttributes); + } +} + +/********************************************************************** + * NAME INTERNAL + * SpiBuildDeviceMap + * + * DESCRIPTION + * Builds the registry device map of all device which are attached + * to the given SCSI HBA port. The device map is located at: + * \Registry\Machine\DeviceMap\Scsi + * + * RUN LEVEL + * PASSIVE_LEVEL + * + * ARGUMENTS + * DeviceExtension + * ... + * + * RegistryPath + * Name of registry driver service key. + * + * RETURNS + * NTSTATUS + */ + +NTSTATUS +SpiBuildDeviceMap( + _In_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, + _In_ PUNICODE_STRING RegistryPath) +{ + PSCSI_PORT_LUN_EXTENSION LunExtension; + OBJECT_ATTRIBUTES ObjectAttributes; + UNICODE_STRING KeyName; + UNICODE_STRING ValueName; + WCHAR NameBuffer[64]; + ULONG Disposition; + HANDLE ScsiKey; + HANDLE ScsiPortKey = NULL; + HANDLE ScsiBusKey = NULL; + HANDLE ScsiInitiatorKey = NULL; + HANDLE ScsiTargetKey = NULL; + HANDLE ScsiLunKey = NULL; + ULONG BusNumber; + ULONG Target; + ULONG CurrentTarget; + ULONG Lun; + PWCHAR DriverName; + ULONG UlongData; + PWCHAR TypeName; + NTSTATUS Status; + + DPRINT("SpiBuildDeviceMap() called\n"); + + if (DeviceExtension == NULL || RegistryPath == NULL) + { + DPRINT1("Invalid parameter\n"); + return STATUS_INVALID_PARAMETER; + } + + /* Open or create the 'Scsi' subkey */ + RtlInitUnicodeString(&KeyName, + L"\\Registry\\Machine\\Hardware\\DeviceMap\\Scsi"); + InitializeObjectAttributes(&ObjectAttributes, + &KeyName, + OBJ_CASE_INSENSITIVE | OBJ_OPENIF | OBJ_KERNEL_HANDLE, + 0, + NULL); + Status = ZwCreateKey(&ScsiKey, + KEY_ALL_ACCESS, + &ObjectAttributes, + 0, + NULL, + REG_OPTION_VOLATILE, + &Disposition); + if (!NT_SUCCESS(Status)) + { + DPRINT("ZwCreateKey() failed (Status %lx)\n", Status); + return Status; + } + + /* Create new 'Scsi Port X' subkey */ + DPRINT("Scsi Port %lu\n", DeviceExtension->PortNumber); + + swprintf(NameBuffer, + L"Scsi Port %lu", + DeviceExtension->PortNumber); + RtlInitUnicodeString(&KeyName, NameBuffer); + InitializeObjectAttributes(&ObjectAttributes, + &KeyName, + OBJ_KERNEL_HANDLE, + ScsiKey, + NULL); + Status = ZwCreateKey(&ScsiPortKey, + KEY_ALL_ACCESS, + &ObjectAttributes, + 0, + NULL, + REG_OPTION_VOLATILE, + &Disposition); + ZwClose(ScsiKey); + if (!NT_SUCCESS(Status)) + { + DPRINT("ZwCreateKey() failed (Status %lx)\n", Status); + return Status; + } + + /* + * Create port-specific values + */ + + /* Set 'DMA Enabled' (REG_DWORD) value */ + UlongData = (ULONG)!DeviceExtension->PortCapabilities.AdapterUsesPio; + DPRINT(" DMA Enabled = %s\n", UlongData ? "TRUE" : "FALSE"); + RtlInitUnicodeString(&ValueName, L"DMA Enabled"); + Status = ZwSetValueKey(ScsiPortKey, + &ValueName, + 0, + REG_DWORD, + &UlongData, + sizeof(UlongData)); + if (!NT_SUCCESS(Status)) + { + DPRINT("ZwSetValueKey('DMA Enabled') failed (Status %lx)\n", Status); + ZwClose(ScsiPortKey); + return Status; + } + + /* Set 'Driver' (REG_SZ) value */ + DriverName = wcsrchr(RegistryPath->Buffer, L'\\') + 1; + RtlInitUnicodeString(&ValueName, L"Driver"); + Status = ZwSetValueKey(ScsiPortKey, + &ValueName, + 0, + REG_SZ, + DriverName, + (ULONG)((wcslen(DriverName) + 1) * sizeof(WCHAR))); + if (!NT_SUCCESS(Status)) + { + DPRINT("ZwSetValueKey('Driver') failed (Status %lx)\n", Status); + ZwClose(ScsiPortKey); + return Status; + } + + /* Set 'Interrupt' (REG_DWORD) value (NT4 only) */ + UlongData = (ULONG)DeviceExtension->PortConfig->BusInterruptLevel; + DPRINT(" Interrupt = %lu\n", UlongData); + RtlInitUnicodeString(&ValueName, L"Interrupt"); + Status = ZwSetValueKey(ScsiPortKey, + &ValueName, + 0, + REG_DWORD, + &UlongData, + sizeof(UlongData)); + if (!NT_SUCCESS(Status)) + { + DPRINT("ZwSetValueKey('Interrupt') failed (Status %lx)\n", Status); + ZwClose(ScsiPortKey); + return Status; + } + + /* Set 'IOAddress' (REG_DWORD) value (NT4 only) */ + UlongData = ScsiPortConvertPhysicalAddressToUlong((*DeviceExtension->PortConfig->AccessRanges)[0].RangeStart); + DPRINT(" IOAddress = %lx\n", UlongData); + RtlInitUnicodeString(&ValueName, L"IOAddress"); + Status = ZwSetValueKey(ScsiPortKey, + &ValueName, + 0, + REG_DWORD, + &UlongData, + sizeof(UlongData)); + if (!NT_SUCCESS(Status)) + { + DPRINT("ZwSetValueKey('IOAddress') failed (Status %lx)\n", Status); + ZwClose(ScsiPortKey); + return Status; + } + + /* Enumerate buses */ + for (BusNumber = 0; BusNumber < DeviceExtension->PortConfig->NumberOfBuses; BusNumber++) + { + /* Create 'Scsi Bus X' key */ + DPRINT(" Scsi Bus %lu\n", BusNumber); + swprintf(NameBuffer, + L"Scsi Bus %lu", + BusNumber); + RtlInitUnicodeString(&KeyName, NameBuffer); + InitializeObjectAttributes(&ObjectAttributes, + &KeyName, + 0, + ScsiPortKey, + NULL); + Status = ZwCreateKey(&ScsiBusKey, + KEY_ALL_ACCESS, + &ObjectAttributes, + 0, + NULL, + REG_OPTION_VOLATILE, + &Disposition); + if (!NT_SUCCESS(Status)) + { + DPRINT("ZwCreateKey() failed (Status %lx)\n", Status); + goto ByeBye; + } + + /* Create 'Initiator Id X' key */ + DPRINT(" Initiator Id %lu\n", + DeviceExtension->PortConfig->InitiatorBusId[BusNumber]); + swprintf(NameBuffer, + L"Initiator Id %lu", + (ULONG)(UCHAR)DeviceExtension->PortConfig->InitiatorBusId[BusNumber]); + RtlInitUnicodeString(&KeyName, NameBuffer); + InitializeObjectAttributes(&ObjectAttributes, + &KeyName, + 0, + ScsiBusKey, + NULL); + Status = ZwCreateKey(&ScsiInitiatorKey, + KEY_ALL_ACCESS, + &ObjectAttributes, + 0, + NULL, + REG_OPTION_VOLATILE, + &Disposition); + if (!NT_SUCCESS(Status)) + { + DPRINT("ZwCreateKey() failed (Status %lx)\n", Status); + goto ByeBye; + } + + /* FIXME: Are there any initiator values (??) */ + + ZwClose(ScsiInitiatorKey); + ScsiInitiatorKey = NULL; + + + /* Enumerate targets */ + CurrentTarget = (ULONG)-1; + ScsiTargetKey = NULL; + for (Target = 0; Target < DeviceExtension->PortConfig->MaximumNumberOfTargets; Target++) + { + for (Lun = 0; Lun < SCSI_MAXIMUM_LOGICAL_UNITS; Lun++) + { + LunExtension = SpiGetLunExtension(DeviceExtension, + (UCHAR)BusNumber, + (UCHAR)Target, + (UCHAR)Lun); + if (LunExtension == NULL) + continue; + + if (Target != CurrentTarget) + { + /* Close old target key */ + if (ScsiTargetKey != NULL) + { + ZwClose(ScsiTargetKey); + ScsiTargetKey = NULL; + } + + /* Create 'Target Id X' key */ + DPRINT(" Target Id %lu\n", Target); + swprintf(NameBuffer, + L"Target Id %lu", + Target); + RtlInitUnicodeString(&KeyName, NameBuffer); + InitializeObjectAttributes(&ObjectAttributes, + &KeyName, + 0, + ScsiBusKey, + NULL); + Status = ZwCreateKey(&ScsiTargetKey, + KEY_ALL_ACCESS, + &ObjectAttributes, + 0, + NULL, + REG_OPTION_VOLATILE, + &Disposition); + if (!NT_SUCCESS(Status)) + { + DPRINT("ZwCreateKey() failed (Status %lx)\n", Status); + goto ByeBye; + } + + CurrentTarget = Target; + } + + /* Create 'Logical Unit Id X' key */ + DPRINT(" Logical Unit Id %lu\n", Lun); + swprintf(NameBuffer, + L"Logical Unit Id %lu", + Lun); + RtlInitUnicodeString(&KeyName, NameBuffer); + InitializeObjectAttributes(&ObjectAttributes, + &KeyName, + 0, + ScsiTargetKey, + NULL); + Status = ZwCreateKey(&ScsiLunKey, + KEY_ALL_ACCESS, + &ObjectAttributes, + 0, + NULL, + REG_OPTION_VOLATILE, + &Disposition); + if (!NT_SUCCESS(Status)) + { + DPRINT("ZwCreateKey() failed (Status %lx)\n", Status); + goto ByeBye; + } + + /* Set 'Identifier' (REG_SZ) value */ + swprintf(NameBuffer, + L"%.8S%.16S%.4S", + LunExtension->InquiryData.VendorId, + LunExtension->InquiryData.ProductId, + LunExtension->InquiryData.ProductRevisionLevel); + DPRINT(" Identifier = '%S'\n", NameBuffer); + RtlInitUnicodeString(&ValueName, L"Identifier"); + Status = ZwSetValueKey(ScsiLunKey, + &ValueName, + 0, + REG_SZ, + NameBuffer, + (ULONG)((wcslen(NameBuffer) + 1) * sizeof(WCHAR))); + if (!NT_SUCCESS(Status)) + { + DPRINT("ZwSetValueKey('Identifier') failed (Status %lx)\n", Status); + goto ByeBye; + } + + /* Set 'Type' (REG_SZ) value */ + /* + * See https://docs.microsoft.com/en-us/windows-hardware/drivers/install/identifie… + * and https://docs.microsoft.com/en-us/windows-hardware/drivers/install/identifie… + * for a list of types with their human-readable forms. + */ + switch (LunExtension->InquiryData.DeviceType) + { + case 0: + TypeName = L"DiskPeripheral"; + break; + case 1: + TypeName = L"TapePeripheral"; + break; + case 2: + TypeName = L"PrinterPeripheral"; + break; + // case 3: "ProcessorPeripheral", classified as 'other': fall back to default case. + case 4: + TypeName = L"WormPeripheral"; + break; + case 5: + TypeName = L"CdRomPeripheral"; + break; + case 6: + TypeName = L"ScannerPeripheral"; + break; + case 7: + TypeName = L"OpticalDiskPeripheral"; + break; + case 8: + TypeName = L"MediumChangerPeripheral"; + break; + case 9: + TypeName = L"CommunicationsPeripheral"; + break; + + /* New peripheral types (SCSI only) */ + case 10: case 11: + TypeName = L"ASCPrePressGraphicsPeripheral"; + break; + case 12: + TypeName = L"ArrayPeripheral"; + break; + case 13: + TypeName = L"EnclosurePeripheral"; + break; + case 14: + TypeName = L"RBCPeripheral"; + break; + case 15: + TypeName = L"CardReaderPeripheral"; + break; + case 16: + TypeName = L"BridgePeripheral"; + break; + + default: + TypeName = L"OtherPeripheral"; + break; + } + DPRINT(" Type = '%S'\n", TypeName); + RtlInitUnicodeString(&ValueName, L"Type"); + Status = ZwSetValueKey(ScsiLunKey, + &ValueName, + 0, + REG_SZ, + TypeName, + (ULONG)((wcslen(TypeName) + 1) * sizeof(WCHAR))); + if (!NT_SUCCESS(Status)) + { + DPRINT("ZwSetValueKey('Type') failed (Status %lx)\n", Status); + goto ByeBye; + } + + ZwClose(ScsiLunKey); + ScsiLunKey = NULL; + } + + /* Close old target key */ + if (ScsiTargetKey != NULL) + { + ZwClose(ScsiTargetKey); + ScsiTargetKey = NULL; + } + } + + ZwClose(ScsiBusKey); + ScsiBusKey = NULL; + } + +ByeBye: + if (ScsiLunKey != NULL) + ZwClose(ScsiLunKey); + + if (ScsiInitiatorKey != NULL) + ZwClose(ScsiInitiatorKey); + + if (ScsiTargetKey != NULL) + ZwClose(ScsiTargetKey); + + if (ScsiBusKey != NULL) + ZwClose(ScsiBusKey); + + if (ScsiPortKey != NULL) + ZwClose(ScsiPortKey); + + DPRINT("SpiBuildDeviceMap() done\n"); + + return Status; +} diff --git a/drivers/storage/port/scsiport/scsi.c b/drivers/storage/port/scsiport/scsi.c new file mode 100644 index 00000000000..7feb6da5cdf --- /dev/null +++ b/drivers/storage/port/scsiport/scsi.c @@ -0,0 +1,1768 @@ +/* + * PROJECT: ReactOS Storage Stack + * LICENSE: GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later) + * PURPOSE: SCSI Port driver SCSI requests handling + * COPYRIGHT: Eric Kohl (eric.kohl(a)reactos.org) + * Aleksey Bragin (aleksey(a)reactos.org) + * 2020 Victor Perevertkin (victor.perevertkin(a)reactos.org) + */ + +#include "scsiport.h" + +#define NDEBUG +#include <debug.h> + + +static +NTSTATUS +SpiStatusSrbToNt( + _In_ UCHAR SrbStatus) +{ + switch (SRB_STATUS(SrbStatus)) + { + case SRB_STATUS_TIMEOUT: + case SRB_STATUS_COMMAND_TIMEOUT: + return STATUS_IO_TIMEOUT; + + case SRB_STATUS_BAD_SRB_BLOCK_LENGTH: + case SRB_STATUS_BAD_FUNCTION: + return STATUS_INVALID_DEVICE_REQUEST; + + case SRB_STATUS_NO_DEVICE: + case SRB_STATUS_INVALID_LUN: + case SRB_STATUS_INVALID_TARGET_ID: + case SRB_STATUS_NO_HBA: + return STATUS_DEVICE_DOES_NOT_EXIST; + + case SRB_STATUS_DATA_OVERRUN: + return STATUS_BUFFER_OVERFLOW; + + case SRB_STATUS_SELECTION_TIMEOUT: + return STATUS_DEVICE_NOT_CONNECTED; + + default: + return STATUS_IO_DEVICE_ERROR; + } + + return STATUS_IO_DEVICE_ERROR; +} + +static +NTSTATUS +SpiHandleAttachRelease( + _In_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, + _Inout_ PIRP Irp) +{ + PSCSI_LUN_INFO LunInfo; + PIO_STACK_LOCATION IrpStack; + PDEVICE_OBJECT DeviceObject; + PSCSI_REQUEST_BLOCK Srb; + KIRQL Irql; + + /* Get pointer to the SRB */ + IrpStack = IoGetCurrentIrpStackLocation(Irp); + Srb = (PSCSI_REQUEST_BLOCK)IrpStack->Parameters.Others.Argument1; + + /* Check if PathId matches number of buses */ + if (DeviceExtension->BusesConfig == NULL || + DeviceExtension->BusesConfig->NumberOfBuses <= Srb->PathId) + { + Srb->SrbStatus = SRB_STATUS_NO_DEVICE; + return STATUS_DEVICE_DOES_NOT_EXIST; + } + + /* Get pointer to LunInfo */ + LunInfo = DeviceExtension->BusesConfig->BusScanInfo[Srb->PathId]->LunInfo; + + /* Find matching LunInfo */ + while (LunInfo) + { + if (LunInfo->PathId == Srb->PathId && + LunInfo->TargetId == Srb->TargetId && + LunInfo->Lun == Srb->Lun) + { + break; + } + + LunInfo = LunInfo->Next; + } + + /* If we couldn't find it - exit */ + if (LunInfo == NULL) + return STATUS_DEVICE_DOES_NOT_EXIST; + + + /* Get spinlock */ + KeAcquireSpinLock(&DeviceExtension->SpinLock, &Irql); + + /* Release, if asked */ + if (Srb->Function == SRB_FUNCTION_RELEASE_DEVICE) + { + LunInfo->DeviceClaimed = FALSE; + KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); + Srb->SrbStatus = SRB_STATUS_SUCCESS; + + return STATUS_SUCCESS; + } + + /* Attach, if not already claimed */ + if (LunInfo->DeviceClaimed) + { + KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); + Srb->SrbStatus = SRB_STATUS_BUSY; + + return STATUS_DEVICE_BUSY; + } + + /* Save the device object */ + DeviceObject = LunInfo->DeviceObject; + + if (Srb->Function == SRB_FUNCTION_CLAIM_DEVICE) + LunInfo->DeviceClaimed = TRUE; + + if (Srb->Function == SRB_FUNCTION_ATTACH_DEVICE) + LunInfo->DeviceObject = Srb->DataBuffer; + + Srb->DataBuffer = DeviceObject; + + KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); + Srb->SrbStatus = SRB_STATUS_SUCCESS; + + return STATUS_SUCCESS; +} + +/********************************************************************** + * NAME INTERNAL + * ScsiPortDispatchScsi + * + * DESCRIPTION + * Answer requests for SCSI calls + * + * RUN LEVEL + * PASSIVE_LEVEL + * + * ARGUMENTS + * Standard dispatch arguments + * + * RETURNS + * NTSTATUS + */ + +NTSTATUS +NTAPI +ScsiPortDispatchScsi( + _In_ PDEVICE_OBJECT DeviceObject, + _Inout_ PIRP Irp) +{ + PSCSI_PORT_DEVICE_EXTENSION DeviceExtension; + PSCSI_PORT_LUN_EXTENSION LunExtension; + PIO_STACK_LOCATION Stack; + PSCSI_REQUEST_BLOCK Srb; + KIRQL Irql; + NTSTATUS Status = STATUS_SUCCESS; + PIRP NextIrp, IrpList; + PKDEVICE_QUEUE_ENTRY Entry; + + DPRINT("ScsiPortDispatchScsi(DeviceObject %p Irp %p)\n", DeviceObject, Irp); + + DeviceExtension = DeviceObject->DeviceExtension; + Stack = IoGetCurrentIrpStackLocation(Irp); + + Srb = Stack->Parameters.Scsi.Srb; + if (Srb == NULL) + { + DPRINT1("ScsiPortDispatchScsi() called with Srb = NULL!\n"); + Status = STATUS_UNSUCCESSFUL; + + Irp->IoStatus.Status = Status; + Irp->IoStatus.Information = 0; + + IoCompleteRequest(Irp, IO_NO_INCREMENT); + + return (Status); + } + + DPRINT("Srb: %p\n", Srb); + DPRINT("Srb->Function: %lu\n", Srb->Function); + DPRINT("PathId: %lu TargetId: %lu Lun: %lu\n", Srb->PathId, Srb->TargetId, Srb->Lun); + + LunExtension = SpiGetLunExtension(DeviceExtension, Srb->PathId, Srb->TargetId, Srb->Lun); + if (LunExtension == NULL) + { + DPRINT("ScsiPortDispatchScsi() called with an invalid LUN\n"); + Status = STATUS_NO_SUCH_DEVICE; + + Srb->SrbStatus = SRB_STATUS_NO_DEVICE; + Irp->IoStatus.Status = Status; + Irp->IoStatus.Information = 0; + + IoCompleteRequest(Irp, IO_NO_INCREMENT); + + return (Status); + } + + switch (Srb->Function) + { + case SRB_FUNCTION_SHUTDOWN: + case SRB_FUNCTION_FLUSH: + DPRINT(" SRB_FUNCTION_SHUTDOWN or FLUSH\n"); + if (DeviceExtension->CachesData == FALSE) + { + /* All success here */ + Srb->SrbStatus = SRB_STATUS_SUCCESS; + Irp->IoStatus.Status = STATUS_SUCCESS; + IoCompleteRequest(Irp, IO_NO_INCREMENT); + return STATUS_SUCCESS; + } + /* Fall through to a usual execute operation */ + + case SRB_FUNCTION_EXECUTE_SCSI: + case SRB_FUNCTION_IO_CONTROL: + DPRINT(" SRB_FUNCTION_EXECUTE_SCSI or SRB_FUNCTION_IO_CONTROL\n"); + /* Mark IRP as pending in all cases */ + IoMarkIrpPending(Irp); + + if (Srb->SrbFlags & SRB_FLAGS_BYPASS_FROZEN_QUEUE) + { + /* Start IO directly */ + IoStartPacket(DeviceObject, Irp, NULL, NULL); + } + else + { + KIRQL oldIrql; + + /* We need to be at DISPATCH_LEVEL */ + KeRaiseIrql(DISPATCH_LEVEL, &oldIrql); + + /* Insert IRP into the queue */ + if (!KeInsertByKeyDeviceQueue( + &LunExtension->DeviceQueue, + &Irp->Tail.Overlay.DeviceQueueEntry, + Srb->QueueSortKey)) + { + /* It means the queue is empty, and we just start this request */ + IoStartPacket(DeviceObject, Irp, NULL, NULL); + } + + /* Back to the old IRQL */ + KeLowerIrql(oldIrql); + } + return STATUS_PENDING; + + case SRB_FUNCTION_CLAIM_DEVICE: + case SRB_FUNCTION_ATTACH_DEVICE: + DPRINT(" SRB_FUNCTION_CLAIM_DEVICE or ATTACH\n"); + + /* Reference device object and keep the device object */ + Status = SpiHandleAttachRelease(DeviceExtension, Irp); + break; + + case SRB_FUNCTION_RELEASE_DEVICE: + DPRINT(" SRB_FUNCTION_RELEASE_DEVICE\n"); + + /* Dereference device object and clear the device object */ + Status = SpiHandleAttachRelease(DeviceExtension, Irp); + break; + + case SRB_FUNCTION_RELEASE_QUEUE: + DPRINT(" SRB_FUNCTION_RELEASE_QUEUE\n"); + + /* Guard with the spinlock */ + KeAcquireSpinLock(&DeviceExtension->SpinLock, &Irql); + + if (!(LunExtension->Flags & LUNEX_FROZEN_QUEUE)) + { + DPRINT("Queue is not frozen really\n"); + + KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); + Srb->SrbStatus = SRB_STATUS_SUCCESS; + Status = STATUS_SUCCESS; + break; + } + + /* Unfreeze the queue */ + LunExtension->Flags &= ~LUNEX_FROZEN_QUEUE; + + if (LunExtension->SrbInfo.Srb == NULL) + { + /* Get next logical unit request */ + SpiGetNextRequestFromLun(DeviceExtension, LunExtension); + + /* SpiGetNextRequestFromLun() releases the spinlock */ + KeLowerIrql(Irql); + } + else + { + DPRINT("The queue has active request\n"); + KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); + } + + Srb->SrbStatus = SRB_STATUS_SUCCESS; + Status = STATUS_SUCCESS; + break; + + case SRB_FUNCTION_FLUSH_QUEUE: + DPRINT(" SRB_FUNCTION_FLUSH_QUEUE\n"); + + /* Guard with the spinlock */ + KeAcquireSpinLock(&DeviceExtension->SpinLock, &Irql); + + if (!(LunExtension->Flags & LUNEX_FROZEN_QUEUE)) + { + DPRINT("Queue is not frozen really\n"); + + KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); + Status = STATUS_INVALID_DEVICE_REQUEST; + break; + } + + /* Make sure there is no active request */ + ASSERT(LunExtension->SrbInfo.Srb == NULL); + + /* Compile a list from the device queue */ + IrpList = NULL; + while ((Entry = KeRemoveDeviceQueue(&LunExtension->DeviceQueue)) != NULL) + { + NextIrp = CONTAINING_RECORD(Entry, IRP, Tail.Overlay.DeviceQueueEntry); + + /* Get the Srb */ + Stack = IoGetCurrentIrpStackLocation(NextIrp); + Srb = Stack->Parameters.Scsi.Srb; + + /* Set statuse */ + Srb->SrbStatus = SRB_STATUS_REQUEST_FLUSHED; + NextIrp->IoStatus.Status = STATUS_UNSUCCESSFUL; + + /* Add then to the list */ + NextIrp->Tail.Overlay.ListEntry.Flink = (PLIST_ENTRY)IrpList; + IrpList = NextIrp; + } + + /* Unfreeze the queue */ + LunExtension->Flags &= ~LUNEX_FROZEN_QUEUE; + + /* Release the spinlock */ + KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); + + /* Complete those requests */ + while (IrpList) + { + NextIrp = IrpList; + IrpList = (PIRP)NextIrp->Tail.Overlay.ListEntry.Flink; + + IoCompleteRequest(NextIrp, 0); + } + + Status = STATUS_SUCCESS; + break; + + default: + DPRINT1("SRB function not implemented (Function %lu)\n", Srb->Function); + Status = STATUS_NOT_IMPLEMENTED; + break; + } + + Irp->IoStatus.Status = Status; + IoCompleteRequest(Irp, IO_NO_INCREMENT); + + return Status; +} + +VOID +SpiGetNextRequestFromLun( + _In_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, + _Inout_ PSCSI_PORT_LUN_EXTENSION LunExtension) +{ + PIO_STACK_LOCATION IrpStack; + PIRP NextIrp; + PKDEVICE_QUEUE_ENTRY Entry; + PSCSI_REQUEST_BLOCK Srb; + + + /* If LUN is not active or queue is more than maximum allowed */ + if (LunExtension->QueueCount >= LunExtension->MaxQueueCount || + !(LunExtension->Flags & SCSI_PORT_LU_ACTIVE)) + { + /* Release the spinlock and exit */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + return; + } + + /* Check if we can get a next request */ + if (LunExtension->Flags & + (LUNEX_NEED_REQUEST_SENSE | LUNEX_BUSY | + LUNEX_FULL_QUEUE | LUNEX_FROZEN_QUEUE | LUNEX_REQUEST_PENDING)) + { + /* Pending requests can only be started if the queue is empty */ + if (IsListEmpty(&LunExtension->SrbInfo.Requests) && + !(LunExtension->Flags & + (LUNEX_BUSY | LUNEX_FROZEN_QUEUE | LUNEX_FULL_QUEUE | LUNEX_NEED_REQUEST_SENSE))) + { + /* Make sure we have SRB */ + ASSERT(LunExtension->SrbInfo.Srb == NULL); + + /* Clear active and pending flags */ + LunExtension->Flags &= ~(LUNEX_REQUEST_PENDING | SCSI_PORT_LU_ACTIVE); + + /* Get next Irp, and clear pending requests list */ + NextIrp = LunExtension->PendingRequest; + LunExtension->PendingRequest = NULL; + + /* Set attempt counter to zero */ + LunExtension->AttemptCount = 0; + + /* Release the spinlock */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + + /* Start the next pending request */ + IoStartPacket(DeviceExtension->DeviceObject, NextIrp, (PULONG)NULL, NULL); + + return; + } + else + { + /* Release the spinlock, without clearing any flags and exit */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + + return; + } + } + + /* Reset active flag */ + LunExtension->Flags &= ~SCSI_PORT_LU_ACTIVE; + + /* Set attempt counter to zero */ + LunExtension->AttemptCount = 0; + + /* Remove packet from the device queue */ + Entry = KeRemoveByKeyDeviceQueue(&LunExtension->DeviceQueue, LunExtension->SortKey); + + if (Entry != NULL) + { + /* Get pointer to the next irp */ + NextIrp = CONTAINING_RECORD(Entry, IRP, Tail.Overlay.DeviceQueueEntry); + + /* Get point to the SRB */ + IrpStack = IoGetCurrentIrpStackLocation(NextIrp); + Srb = (PSCSI_REQUEST_BLOCK)IrpStack->Parameters.Others.Argument1; + + /* Set new key*/ + LunExtension->SortKey = Srb->QueueSortKey; + LunExtension->SortKey++; + + /* Release the spinlock */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + + /* Start the next pending request */ + IoStartPacket(DeviceExtension->DeviceObject, NextIrp, (PULONG)NULL, NULL); + } + else + { + /* Release the spinlock */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + } +} + +IO_COMPLETION_ROUTINE SpiSenseCompletionRoutine; + +NTSTATUS +NTAPI +SpiSenseCompletionRoutine( + _In_ PDEVICE_OBJECT DeviceObject, + _In_ PIRP Irp, + _In_opt_ PVOID Context) +{ + PSCSI_REQUEST_BLOCK Srb = (PSCSI_REQUEST_BLOCK)Context; + PSCSI_REQUEST_BLOCK InitialSrb; + PIRP InitialIrp; + + DPRINT("SpiCompletionRoutine() entered, IRP %p \n", Irp); + + if ((Srb->Function == SRB_FUNCTION_RESET_BUS) || + (Srb->Function == SRB_FUNCTION_ABORT_COMMAND)) + { + /* Deallocate SRB and IRP and exit */ + ExFreePool(Srb); + IoFreeIrp(Irp); + + return STATUS_MORE_PROCESSING_REQUIRED; + } + + /* Get a pointer to the SRB and IRP which were initially sent */ + InitialSrb = *((PVOID *)(Srb+1)); + InitialIrp = InitialSrb->OriginalRequest; + + if ((SRB_STATUS(Srb->SrbStatus) == SRB_STATUS_SUCCESS) || + (SRB_STATUS(Srb->SrbStatus) == SRB_STATUS_DATA_OVERRUN)) + { + /* Sense data is OK */ + InitialSrb->SrbStatus |= SRB_STATUS_AUTOSENSE_VALID; + + /* Set length to be the same */ + InitialSrb->SenseInfoBufferLength = (UCHAR)Srb->DataTransferLength; + } + + /* Make sure initial SRB's queue is frozen */ + ASSERT(InitialSrb->SrbStatus & SRB_STATUS_QUEUE_FROZEN); + + /* Complete this request */ + IoCompleteRequest(InitialIrp, IO_DISK_INCREMENT); + + /* Deallocate everything (internal) */ + ExFreePool(Srb); + + if (Irp->MdlAddress != NULL) + { + MmUnlockPages(Irp->MdlAddress); + IoFreeMdl(Irp->MdlAddress); + Irp->MdlAddress = NULL; + } + + IoFreeIrp(Irp); + return STATUS_MORE_PROCESSING_REQUIRED; +} + +static +VOID +SpiSendRequestSense( + _In_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, + _In_ PSCSI_REQUEST_BLOCK InitialSrb) +{ + PSCSI_REQUEST_BLOCK Srb; + PCDB Cdb; + PIRP Irp; + PIO_STACK_LOCATION IrpStack; + LARGE_INTEGER LargeInt; + PVOID *Ptr; + + DPRINT("SpiSendRequestSense() entered, InitialSrb %p\n", InitialSrb); + + /* Allocate Srb */ + Srb = ExAllocatePoolWithTag(NonPagedPool, sizeof(SCSI_REQUEST_BLOCK) + sizeof(PVOID), TAG_SCSIPORT); + RtlZeroMemory(Srb, sizeof(SCSI_REQUEST_BLOCK)); + + /* Allocate IRP */ + LargeInt.QuadPart = (LONGLONG) 1; + Irp = IoBuildAsynchronousFsdRequest(IRP_MJ_READ, + DeviceExtension->DeviceObject, + InitialSrb->SenseInfoBuffer, + InitialSrb->SenseInfoBufferLength, + &LargeInt, + NULL); + + IoSetCompletionRoutine(Irp, + SpiSenseCompletionRoutine, + Srb, + TRUE, + TRUE, + TRUE); + + if (!Srb) + { + DPRINT("SpiSendRequestSense() failed, Srb %p\n", Srb); + return; + } + + IrpStack = IoGetNextIrpStackLocation(Irp); + IrpStack->MajorFunction = IRP_MJ_SCSI; + + /* Put Srb address into Irp... */ + IrpStack->Parameters.Others.Argument1 = (PVOID)Srb; + + /* ...and vice versa */ + Srb->OriginalRequest = Irp; + + /* Save Srb */ + Ptr = (PVOID *)(Srb+1); + *Ptr = InitialSrb; + + /* Build CDB for REQUEST SENSE */ + Srb->CdbLength = 6; + Cdb = (PCDB)Srb->Cdb; + + Cdb->CDB6INQUIRY.OperationCode = SCSIOP_REQUEST_SENSE; + Cdb->CDB6INQUIRY.LogicalUnitNumber = 0; + Cdb->CDB6INQUIRY.Reserved1 = 0; + Cdb->CDB6INQUIRY.PageCode = 0; + Cdb->CDB6INQUIRY.IReserved = 0; + Cdb->CDB6INQUIRY.AllocationLength = (UCHAR)InitialSrb->SenseInfoBufferLength; + Cdb->CDB6INQUIRY.Control = 0; + + /* Set address */ + Srb->TargetId = InitialSrb->TargetId; + Srb->Lun = InitialSrb->Lun; + Srb->PathId = InitialSrb->PathId; + + Srb->Function = SRB_FUNCTION_EXECUTE_SCSI; + Srb->Length = sizeof(SCSI_REQUEST_BLOCK); + + /* Timeout will be 2 seconds */ + Srb->TimeOutValue = 2; + + /* No auto request sense */ + Srb->SenseInfoBufferLength = 0; + Srb->SenseInfoBuffer = NULL; + + /* Set necessary flags */ + Srb->SrbFlags = SRB_FLAGS_DATA_IN | SRB_FLAGS_BYPASS_FROZEN_QUEUE | + SRB_FLAGS_DISABLE_DISCONNECT; + + /* Transfer disable synch transfer flag */ + if (InitialSrb->SrbFlags & SRB_FLAGS_DISABLE_SYNCH_TRANSFER) + Srb->SrbFlags |= SRB_FLAGS_DISABLE_SYNCH_TRANSFER; + + Srb->DataBuffer = InitialSrb->SenseInfoBuffer; + + /* Fill the transfer length */ + Srb->DataTransferLength = InitialSrb->SenseInfoBufferLength; + + /* Clear statuses */ + Srb->ScsiStatus = Srb->SrbStatus = 0; + Srb->NextSrb = 0; + + /* Call the driver */ + (VOID)IoCallDriver(DeviceExtension->DeviceObject, Irp); + + DPRINT("SpiSendRequestSense() done\n"); +} + + +static +VOID +SpiProcessCompletedRequest( + _In_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, + _Inout_ PSCSI_REQUEST_BLOCK_INFO SrbInfo, + _Out_ PBOOLEAN NeedToCallStartIo) +{ + PSCSI_REQUEST_BLOCK Srb; + PSCSI_PORT_LUN_EXTENSION LunExtension; + LONG Result; + PIRP Irp; + //ULONG SequenceNumber; + + Srb = SrbInfo->Srb; + Irp = Srb->OriginalRequest; + + /* Get Lun extension */ + LunExtension = SpiGetLunExtension(DeviceExtension, + Srb->PathId, + Srb->TargetId, + Srb->Lun); + + if (Srb->SrbFlags & SRB_FLAGS_UNSPECIFIED_DIRECTION && + DeviceExtension->MapBuffers && + Irp->MdlAddress) + { + /* MDL is shared if transfer is broken into smaller parts */ + Srb->DataBuffer = (PCCHAR)MmGetMdlVirtualAddress(Irp->MdlAddress) + + ((PCCHAR)Srb->DataBuffer - SrbInfo->DataOffset); + + /* In case of data going in, flush the buffers */ + if (Srb->SrbFlags & SRB_FLAGS_DATA_IN) + { + KeFlushIoBuffers(Irp->MdlAddress, + TRUE, + FALSE); + } + } + + /* Flush adapter if needed */ + if (SrbInfo->BaseOfMapRegister) + { + /* TODO: Implement */ + ASSERT(FALSE); + } + + /* Clear the request */ + SrbInfo->Srb = NULL; + + /* If disconnect is disabled... */ + if (Srb->SrbFlags & SRB_FLAGS_DISABLE_DISCONNECT) + { + /* Acquire the spinlock since we mess with flags */ + KeAcquireSpinLockAtDpcLevel(&DeviceExtension->SpinLock); + + /* Set corresponding flag */ + DeviceExtension->Flags |= SCSI_PORT_DISCONNECT_ALLOWED; + + /* Clear the timer if needed */ + if (!(DeviceExtension->InterruptData.Flags & SCSI_PORT_RESET)) + DeviceExtension->TimerCount = -1; + + /* Spinlock is not needed anymore */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + + if (!(DeviceExtension->Flags & SCSI_PORT_REQUEST_PENDING) && + !(DeviceExtension->Flags & SCSI_PORT_DEVICE_BUSY) && + !(*NeedToCallStartIo)) + { + /* We're not busy, but we have a request pending */ + IoStartNextPacket(DeviceExtension->DeviceObject, FALSE); + } + } + + /* Scatter/gather */ + if (Srb->SrbFlags & SRB_FLAGS_SGLIST_FROM_POOL) + { + /* TODO: Implement */ + ASSERT(FALSE); + } + + /* Acquire spinlock (we're freeing SrbExtension) */ + KeAcquireSpinLockAtDpcLevel(&DeviceExtension->SpinLock); + + /* Free it (if needed) */ + if (Srb->SrbExtension) + { + if (Srb->SenseInfoBuffer != NULL && DeviceExtension->SupportsAutoSense) + { + ASSERT(Srb->SenseInfoBuffer == NULL || SrbInfo->SaveSenseRequest != NULL); + + if (Srb->SrbStatus & SRB_STATUS_AUTOSENSE_VALID) + { + /* Copy sense data to the buffer */ + RtlCopyMemory(SrbInfo->SaveSenseRequest, + Srb->SenseInfoBuffer, + Srb->SenseInfoBufferLength); + } + + /* And restore the pointer */ + Srb->SenseInfoBuffer = SrbInfo->SaveSenseRequest; + } + + /* Put it into the free srb extensions list */ + *((PVOID *)Srb->SrbExtension) = DeviceExtension->FreeSrbExtensions; + DeviceExtension->FreeSrbExtensions = Srb->SrbExtension; + } + + /* Save transfer length in the IRP */ + Irp->IoStatus.Information = Srb->DataTransferLength; + + //SequenceNumber = SrbInfo->SequenceNumber; + SrbInfo->SequenceNumber = 0; + + /* Decrement the queue count */ + LunExtension->QueueCount--; + + /* Free Srb, if needed*/ + if (Srb->QueueTag != SP_UNTAGGED) + { + /* Put it into the free list */ + SrbInfo->Requests.Blink = NULL; + SrbInfo->Requests.Flink = (PLIST_ENTRY)DeviceExtension->FreeSrbInfo; + DeviceExtension->FreeSrbInfo = SrbInfo; + } + + /* SrbInfo is not used anymore */ + SrbInfo = NULL; + + if (DeviceExtension->Flags & SCSI_PORT_REQUEST_PENDING) + { + /* Clear the flag */ + DeviceExtension->Flags &= ~SCSI_PORT_REQUEST_PENDING; + + /* Note the caller about StartIo */ + *NeedToCallStartIo = TRUE; + } + + if (SRB_STATUS(Srb->SrbStatus) == SRB_STATUS_SUCCESS) + { + /* Start the packet */ + Irp->IoStatus.Status = STATUS_SUCCESS; + + if (!(Srb->SrbFlags & SRB_FLAGS_BYPASS_FROZEN_QUEUE) && + LunExtension->RequestTimeout == -1) + { + /* Start the next packet */ + SpiGetNextRequestFromLun(DeviceExtension, LunExtension); + } + else + { + /* Release the spinlock */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + } + + DPRINT("IoCompleting request IRP 0x%p\n", Irp); + + IoCompleteRequest(Irp, IO_DISK_INCREMENT); + + /* Decrement number of active requests, and analyze the result */ + Result = InterlockedDecrement(&DeviceExtension->ActiveRequestCounter); + + if (Result < 0 && + !DeviceExtension->MapRegisters && + DeviceExtension->AdapterObject != NULL) + { + /* Nullify map registers */ + DeviceExtension->MapRegisterBase = NULL; + IoFreeAdapterChannel(DeviceExtension->AdapterObject); + } + + /* Exit, we're done */ + return; + } + + /* Decrement number of active requests, and analyze the result */ + Result = InterlockedDecrement(&DeviceExtension->ActiveRequestCounter); + + if (Result < 0 && + !DeviceExtension->MapRegisters && + DeviceExtension->AdapterObject != NULL) + { + /* Result is negative, so this is a slave, free map registers */ + DeviceExtension->MapRegisterBase = NULL; + IoFreeAdapterChannel(DeviceExtension->AdapterObject); + } + + /* Convert status */ + Irp->IoStatus.Status = SpiStatusSrbToNt(Srb->SrbStatus); + + /* It's not a bypass, it's busy or the queue is full? */ + if ((Srb->ScsiStatus == SCSISTAT_BUSY || + Srb->SrbStatus == SRB_STATUS_BUSY || + Srb->ScsiStatus == SCSISTAT_QUEUE_FULL) && + !(Srb->SrbFlags & SRB_FLAGS_BYPASS_FROZEN_QUEUE)) + { + + DPRINT("Busy SRB status %x\n", Srb->SrbStatus); + + /* Requeue, if needed */ + if (LunExtension->Flags & (LUNEX_FROZEN_QUEUE | LUNEX_BUSY)) + { + DPRINT("it's being requeued\n"); + + Srb->SrbStatus = SRB_STATUS_PENDING; + Srb->ScsiStatus = 0; + + if (!KeInsertByKeyDeviceQueue(&LunExtension->DeviceQueue, + &Irp->Tail.Overlay.DeviceQueueEntry, + Srb->QueueSortKey)) + { + /* It's a big f.ck up if we got here */ + Srb->SrbStatus = SRB_STATUS_ERROR; + Srb->ScsiStatus = SCSISTAT_BUSY; + + ASSERT(FALSE); + goto Error; + } + + /* Release the spinlock */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + + } + else if (LunExtension->AttemptCount++ < 20) + { + /* LUN is still busy */ + Srb->ScsiStatus = 0; + Srb->SrbStatus = SRB_STATUS_PENDING; + + LunExtension->BusyRequest = Irp; + LunExtension->Flags |= LUNEX_BUSY; + + /* Release the spinlock */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + } + else + { +Error: + /* Freeze the queue*/ + Srb->SrbStatus |= SRB_STATUS_QUEUE_FROZEN; + LunExtension->Flags |= LUNEX_FROZEN_QUEUE; + + /* "Unfull" the queue */ + LunExtension->Flags &= ~LUNEX_FULL_QUEUE; + + /* Release the spinlock */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + + /* Return status that the device is not ready */ + Irp->IoStatus.Status = STATUS_DEVICE_NOT_READY; + IoCompleteRequest(Irp, IO_DISK_INCREMENT); + } + + return; + } + + /* Start the next request, if LUN is idle, and this is sense request */ + if (((Srb->ScsiStatus != SCSISTAT_CHECK_CONDITION) || + (Srb->SrbStatus & SRB_STATUS_AUTOSENSE_VALID) || + !Srb->SenseInfoBuffer || !Srb->SenseInfoBufferLength) + && (Srb->SrbFlags & SRB_FLAGS_NO_QUEUE_FREEZE)) + { + if (LunExtension->RequestTimeout == -1) + SpiGetNextRequestFromLun(DeviceExtension, LunExtension); + else + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + } + else + { + /* Freeze the queue */ + Srb->SrbStatus |= SRB_STATUS_QUEUE_FROZEN; + LunExtension->Flags |= LUNEX_FROZEN_QUEUE; + + /* Do we need a request sense? */ + if (Srb->ScsiStatus == SCSISTAT_CHECK_CONDITION && + !(Srb->SrbStatus & SRB_STATUS_AUTOSENSE_VALID) && + Srb->SenseInfoBuffer && Srb->SenseInfoBufferLength) + { + /* If LUN is busy, we have to requeue it in order to allow request sense */ + if (LunExtension->Flags & LUNEX_BUSY) + { + DPRINT("Requeuing busy request to allow request sense\n"); + + if (!KeInsertByKeyDeviceQueue(&LunExtension->DeviceQueue, + &LunExtension->BusyRequest->Tail.Overlay.DeviceQueueEntry, + Srb->QueueSortKey)) + { + /* We should never get here */ + ASSERT(FALSE); + + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + IoCompleteRequest(Irp, IO_DISK_INCREMENT); + return; + + } + + /* Clear busy flags */ + LunExtension->Flags &= ~(LUNEX_FULL_QUEUE | LUNEX_BUSY); + } + + /* Release the spinlock */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + + /* Send RequestSense */ + SpiSendRequestSense(DeviceExtension, Srb); + + /* Exit */ + return; + } + + /* Release the spinlock */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + } + + /* Complete the request */ + IoCompleteRequest(Irp, IO_DISK_INCREMENT); +} + +BOOLEAN +NTAPI +ScsiPortStartPacket( + _In_ PVOID Context) +{ + PSCSI_PORT_DEVICE_EXTENSION DeviceExtension; + PIO_STACK_LOCATION IrpStack; + PSCSI_REQUEST_BLOCK Srb; + PDEVICE_OBJECT DeviceObject = (PDEVICE_OBJECT)Context; + PSCSI_PORT_LUN_EXTENSION LunExtension; + PSCSI_REQUEST_BLOCK_INFO SrbInfo; + BOOLEAN Result; + BOOLEAN StartTimer; + + DPRINT("ScsiPortStartPacket() called\n"); + + DeviceExtension = (PSCSI_PORT_DEVICE_EXTENSION)DeviceObject->DeviceExtension; + + IrpStack = IoGetCurrentIrpStackLocation(DeviceObject->CurrentIrp); + Srb = IrpStack->Parameters.Scsi.Srb; + + /* Get LUN extension */ + LunExtension = SpiGetLunExtension(DeviceExtension, + Srb->PathId, + Srb->TargetId, + Srb->Lun); + + /* Check if we are in a reset state */ + if (DeviceExtension->InterruptData.Flags & SCSI_PORT_RESET) + { + /* Mark the we've got requests while being in the reset state */ + DeviceExtension->InterruptData.Flags |= SCSI_PORT_RESET_REQUEST; + return TRUE; + } + + /* Set the time out value */ + DeviceExtension->TimerCount = Srb->TimeOutValue; + + /* We are busy */ + DeviceExtension->Flags |= SCSI_PORT_DEVICE_BUSY; + + if (LunExtension->RequestTimeout != -1) + { + /* Timer already active */ + StartTimer = FALSE; + } + else + { + /* It hasn't been initialized yet */ + LunExtension->RequestTimeout = Srb->TimeOutValue; + StartTimer = TRUE; + } + + if (Srb->SrbFlags & SRB_FLAGS_BYPASS_FROZEN_QUEUE) + { + /* Handle bypass-requests */ + + /* Is this an abort request? */ + if (Srb->Function == SRB_FUNCTION_ABORT_COMMAND) + { + /* Get pointer to SRB info structure */ + SrbInfo = SpiGetSrbData(DeviceExtension, + Srb->PathId, + Srb->TargetId, + Srb->Lun, + Srb->QueueTag); + + /* Check if the request is still "active" */ + if (SrbInfo == NULL || + SrbInfo->Srb == NULL || + !(SrbInfo->Srb->SrbFlags & SRB_FLAGS_IS_ACTIVE)) + { + /* It's not, mark it as active then */ + Srb->SrbFlags |= SRB_FLAGS_IS_ACTIVE; + + if (StartTimer) + LunExtension->RequestTimeout = -1; + + DPRINT("Request has been already completed, but abort request came\n"); + Srb->SrbStatus = SRB_STATUS_ABORT_FAILED; + + /* Notify about request complete */ + ScsiPortNotification(RequestComplete, + DeviceExtension->MiniPortDeviceExtension, + Srb); + + /* and about readiness for the next request */ + ScsiPortNotification(NextRequest, + DeviceExtension->MiniPortDeviceExtension); + + /* They might ask for some work, so queue the DPC for them */ + IoRequestDpc(DeviceExtension->DeviceObject, NULL, NULL); + + /* We're done in this branch */ + return TRUE; + } + } + else + { + /* Add number of queued requests */ + LunExtension->QueueCount++; + } + + /* Bypass requests don't need request sense */ + LunExtension->Flags &= ~LUNEX_NEED_REQUEST_SENSE; + + /* Is disconnect disabled for this request? */ + if (Srb->SrbFlags & SRB_FLAGS_DISABLE_DISCONNECT) + { + /* Set the corresponding flag */ + DeviceExtension->Flags &= ~SCSI_PORT_DISCONNECT_ALLOWED; + } + + /* Transfer timeout value from Srb to Lun */ + LunExtension->RequestTimeout = Srb->TimeOutValue; + } + else + { + if (Srb->SrbFlags & SRB_FLAGS_DISABLE_DISCONNECT) + { + /* It's a disconnect, so no more requests can go */ + DeviceExtension->Flags &= ~SCSI_PORT_DISCONNECT_ALLOWED; + } + + LunExtension->Flags |= SCSI_PORT_LU_ACTIVE; + + /* Increment queue count */ + LunExtension->QueueCount++; + + /* If it's tagged - special thing */ + if (Srb->QueueTag != SP_UNTAGGED) + { + SrbInfo = &DeviceExtension->SrbInfo[Srb->QueueTag - 1]; + + /* Chek for consistency */ + ASSERT(SrbInfo->Requests.Blink == NULL); + + /* Insert it into the list of requests */ + InsertTailList(&LunExtension->SrbInfo.Requests, &SrbInfo->Requests); + } + } + + /* Mark this Srb active */ + Srb->SrbFlags |= SRB_FLAGS_IS_ACTIVE; + + /* Call HwStartIo routine */ + Result = DeviceExtension->HwStartIo(&DeviceExtension->MiniPortDeviceExtension, + Srb); + + /* If notification is needed, then request a DPC */ + if (DeviceExtension->InterruptData.Flags & SCSI_PORT_NOTIFICATION_NEEDED) + IoRequestDpc(DeviceExtension->DeviceObject, NULL, NULL); + + return Result; +} + +BOOLEAN +NTAPI +SpiSaveInterruptData(IN PVOID Context) +{ + PSCSI_PORT_SAVE_INTERRUPT InterruptContext = Context; + PSCSI_PORT_LUN_EXTENSION LunExtension; + PSCSI_REQUEST_BLOCK Srb; + PSCSI_REQUEST_BLOCK_INFO SrbInfo, NextSrbInfo; + PSCSI_PORT_DEVICE_EXTENSION DeviceExtension; + BOOLEAN IsTimed; + + /* Get pointer to the device extension */ + DeviceExtension = InterruptContext->DeviceExtension; + + /* If we don't have anything pending - return */ + if (!(DeviceExtension->InterruptData.Flags & SCSI_PORT_NOTIFICATION_NEEDED)) + return FALSE; + + /* Actually save the interrupt data */ + *InterruptContext->InterruptData = DeviceExtension->InterruptData; + + /* Clear the data stored in the device extension */ + DeviceExtension->InterruptData.Flags &= + (SCSI_PORT_RESET | SCSI_PORT_RESET_REQUEST | SCSI_PORT_DISABLE_INTERRUPTS); + DeviceExtension->InterruptData.CompletedAbort = NULL; + DeviceExtension->InterruptData.ReadyLun = NULL; + DeviceExtension->InterruptData.CompletedRequests = NULL; + + /* Loop through the list of completed requests */ + SrbInfo = InterruptContext->InterruptData->CompletedRequests; + + while (SrbInfo) + { + /* Make sure we have SRV */ + ASSERT(SrbInfo->Srb); + + /* Get SRB and LunExtension */ + Srb = SrbInfo->Srb; + + LunExtension = SpiGetLunExtension(DeviceExtension, + Srb->PathId, + Srb->TargetId, + Srb->Lun); + + /* We have to check special cases if request is unsuccessful*/ + if (Srb->SrbStatus != SRB_STATUS_SUCCESS) + { + /* Check if we need request sense by a few conditions */ + if (Srb->SenseInfoBuffer && Srb->SenseInfoBufferLength && + Srb->ScsiStatus == SCSISTAT_CHECK_CONDITION && + !(Srb->SrbStatus & SRB_STATUS_AUTOSENSE_VALID)) + { + if (LunExtension->Flags & LUNEX_NEED_REQUEST_SENSE) + { + /* It means: we tried to send REQUEST SENSE, but failed */ + + Srb->ScsiStatus = 0; + Srb->SrbStatus = SRB_STATUS_REQUEST_SENSE_FAILED; + } + else + { + /* Set the corresponding flag, so that REQUEST SENSE + will be sent */ + LunExtension->Flags |= LUNEX_NEED_REQUEST_SENSE; + } + + } + + /* Check for a full queue */ + if (Srb->ScsiStatus == SCSISTAT_QUEUE_FULL) + { + /* TODO: Implement when it's encountered */ + ASSERT(FALSE); + } + } + + /* Let's decide if we need to watch timeout or not */ + if (Srb->QueueTag == SP_UNTAGGED) + { + IsTimed = TRUE; + } + else + { + if (LunExtension->SrbInfo.Requests.Flink == &SrbInfo->Requests) + IsTimed = TRUE; + else + IsTimed = FALSE; + + /* Remove it from the queue */ + RemoveEntryList(&SrbInfo->Requests); + } + + if (IsTimed) + { + /* We have to maintain timeout counter */ + if (IsListEmpty(&LunExtension->SrbInfo.Requests)) + { + LunExtension->RequestTimeout = -1; + } + else + { + NextSrbInfo = CONTAINING_RECORD(LunExtension->SrbInfo.Requests.Flink, + SCSI_REQUEST_BLOCK_INFO, + Requests); + + Srb = NextSrbInfo->Srb; + + /* Update timeout counter */ + LunExtension->RequestTimeout = Srb->TimeOutValue; + } + } + + SrbInfo = SrbInfo->CompletedRequests; + } + + return TRUE; +} + +VOID +NTAPI +ScsiPortDpcForIsr( + _In_ PKDPC Dpc, + _In_ PDEVICE_OBJECT DpcDeviceObject, + _Inout_ PIRP DpcIrp, + _In_opt_ PVOID DpcContext) +{ + PSCSI_PORT_DEVICE_EXTENSION DeviceExtension = DpcDeviceObject->DeviceExtension; + SCSI_PORT_INTERRUPT_DATA InterruptData; + SCSI_PORT_SAVE_INTERRUPT Context; + PSCSI_PORT_LUN_EXTENSION LunExtension; + BOOLEAN NeedToStartIo; + PSCSI_REQUEST_BLOCK_INFO SrbInfo; + LARGE_INTEGER TimerValue; + + DPRINT("ScsiPortDpcForIsr(Dpc %p DpcDeviceObject %p DpcIrp %p DpcContext %p)\n", + Dpc, DpcDeviceObject, DpcIrp, DpcContext); + + /* We need to acquire spinlock */ + KeAcquireSpinLockAtDpcLevel(&DeviceExtension->SpinLock); + + RtlZeroMemory(&InterruptData, sizeof(SCSI_PORT_INTERRUPT_DATA)); + +TryAgain: + + /* Interrupt structure must be snapshotted, and only then analyzed */ + Context.InterruptData = &InterruptData; + Context.DeviceExtension = DeviceExtension; + + if (!KeSynchronizeExecution(DeviceExtension->Interrupt[0], + SpiSaveInterruptData, + &Context)) + { + /* Nothing - just return (don't forget to release the spinlock */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + DPRINT("ScsiPortDpcForIsr() done\n"); + return; + } + + /* If flush of adapters is needed - do it */ + if (InterruptData.Flags & SCSI_PORT_FLUSH_ADAPTERS) + { + /* TODO: Implement */ + ASSERT(FALSE); + } + + /* Check for IoMapTransfer */ + if (InterruptData.Flags & SCSI_PORT_MAP_TRANSFER) + { + /* TODO: Implement */ + ASSERT(FALSE); + } + + /* Check if timer is needed */ + if (InterruptData.Flags & SCSI_PORT_TIMER_NEEDED) + { + /* Save the timer routine */ + DeviceExtension->HwScsiTimer = InterruptData.HwScsiTimer; + + if (InterruptData.MiniportTimerValue == 0) + { + /* Cancel the timer */ + KeCancelTimer(&DeviceExtension->MiniportTimer); + } + else + { + /* Convert timer value */ + TimerValue.QuadPart = Int32x32To64(InterruptData.MiniportTimerValue, -10); + + /* Set the timer */ + KeSetTimer(&DeviceExtension->MiniportTimer, + TimerValue, + &DeviceExtension->MiniportTimerDpc); + } + } + + /* If it's ready for the next request */ + if (InterruptData.Flags & SCSI_PORT_NEXT_REQUEST_READY) + { + /* Check for a duplicate request (NextRequest+NextLuRequest) */ + if ((DeviceExtension->Flags & + (SCSI_PORT_DEVICE_BUSY | SCSI_PORT_DISCONNECT_ALLOWED)) == + (SCSI_PORT_DEVICE_BUSY | SCSI_PORT_DISCONNECT_ALLOWED)) + { + /* Clear busy flag set by ScsiPortStartPacket() */ + DeviceExtension->Flags &= ~SCSI_PORT_DEVICE_BUSY; + + if (!(InterruptData.Flags & SCSI_PORT_RESET)) + { + /* Ready for next, and no reset is happening */ + DeviceExtension->TimerCount = -1; + } + } + else + { + /* Not busy, but not ready for the next request */ + DeviceExtension->Flags &= ~SCSI_PORT_DEVICE_BUSY; + InterruptData.Flags &= ~SCSI_PORT_NEXT_REQUEST_READY; + } + } + + /* Any resets? */ + if (InterruptData.Flags & SCSI_PORT_RESET_REPORTED) + { + /* Hold for a bit */ + DeviceExtension->TimerCount = 4; + } + + /* Any ready LUN? */ + if (InterruptData.ReadyLun != NULL) + { + + /* Process all LUNs from the list*/ + while (TRUE) + { + /* Remove it from the list first (as processed) */ + LunExtension = InterruptData.ReadyLun; + InterruptData.ReadyLun = LunExtension->ReadyLun; + LunExtension->ReadyLun = NULL; + + /* Get next request for this LUN */ + SpiGetNextRequestFromLun(DeviceExtension, LunExtension); + + /* Still ready requests exist? + If yes - get spinlock, if no - stop here */ + if (InterruptData.ReadyLun != NULL) + KeAcquireSpinLockAtDpcLevel(&DeviceExtension->SpinLock); + else + break; + } + } + else + { + /* Release the spinlock */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + } + + /* If we ready for next packet, start it */ + if (InterruptData.Flags & SCSI_PORT_NEXT_REQUEST_READY) + IoStartNextPacket(DeviceExtension->DeviceObject, FALSE); + + NeedToStartIo = FALSE; + + /* Loop the completed request list */ + while (InterruptData.CompletedRequests) + { + /* Remove the request */ + SrbInfo = InterruptData.CompletedRequests; + InterruptData.CompletedRequests = SrbInfo->CompletedRequests; + SrbInfo->CompletedRequests = NULL; + + /* Process it */ + SpiProcessCompletedRequest(DeviceExtension, + SrbInfo, + &NeedToStartIo); + } + + /* Loop abort request list */ + while (InterruptData.CompletedAbort) + { + LunExtension = InterruptData.CompletedAbort; + + /* Remove the request */ + InterruptData.CompletedAbort = LunExtension->CompletedAbortRequests; + + /* Get spinlock since we're going to change flags */ + KeAcquireSpinLockAtDpcLevel(&DeviceExtension->SpinLock); + + /* TODO: Put SrbExtension to the list of free extensions */ + ASSERT(FALSE); + } + + /* If we need - call StartIo routine */ + if (NeedToStartIo) + { + /* Make sure CurrentIrp is not null! */ + ASSERT(DpcDeviceObject->CurrentIrp != NULL); + ScsiPortStartIo(DpcDeviceObject, DpcDeviceObject->CurrentIrp); + } + + /* Everything has been done, check */ + if (InterruptData.Flags & SCSI_PORT_ENABLE_INT_REQUEST) + { + /* Synchronize using spinlock */ + KeAcquireSpinLockAtDpcLevel(&DeviceExtension->SpinLock); + + /* Request an interrupt */ + DeviceExtension->HwInterrupt(DeviceExtension->MiniPortDeviceExtension); + + ASSERT(DeviceExtension->Flags & SCSI_PORT_DISABLE_INT_REQUESET); + + /* Should interrupts be enabled again? */ + if (DeviceExtension->Flags & SCSI_PORT_DISABLE_INT_REQUESET) + { + /* Clear this flag */ + DeviceExtension->Flags &= ~SCSI_PORT_DISABLE_INT_REQUESET; + + /* Call a special routine to do this */ + ASSERT(FALSE); +#if 0 + KeSynchronizeExecution(DeviceExtension->Interrupt, + SpiEnableInterrupts, + DeviceExtension); +#endif + } + + /* If we need a notification again - loop */ + if (DeviceExtension->InterruptData.Flags & SCSI_PORT_NOTIFICATION_NEEDED) + goto TryAgain; + + /* Release the spinlock */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + } + + DPRINT("ScsiPortDpcForIsr() done\n"); +} + +static +PSCSI_REQUEST_BLOCK_INFO +SpiAllocateSrbStructures( + _Inout_ PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, + _Inout_ PSCSI_PORT_LUN_EXTENSION LunExtension, + _Inout_ PSCSI_REQUEST_BLOCK Srb) +{ + PCHAR SrbExtension; + PSCSI_REQUEST_BLOCK_INFO SrbInfo; + + /* Spinlock must be held while this function executes */ + KeAcquireSpinLockAtDpcLevel(&DeviceExtension->SpinLock); + + /* Allocate SRB data structure */ + if (DeviceExtension->NeedSrbDataAlloc) + { + /* Treat the abort request in a special way */ + if (Srb->Function == SRB_FUNCTION_ABORT_COMMAND) + { + SrbInfo = SpiGetSrbData(DeviceExtension, + Srb->PathId, + Srb->TargetId, + Srb->Lun, + Srb->QueueTag); + } + else if (Srb->SrbFlags & + (SRB_FLAGS_QUEUE_ACTION_ENABLE | SRB_FLAGS_NO_QUEUE_FREEZE) && + !(Srb->SrbFlags & SRB_FLAGS_DISABLE_DISCONNECT) + ) + { + /* Do not process tagged commands if need request sense is set */ + if (LunExtension->Flags & LUNEX_NEED_REQUEST_SENSE) + { + ASSERT(!(LunExtension->Flags & LUNEX_REQUEST_PENDING)); + + LunExtension->PendingRequest = Srb->OriginalRequest; + LunExtension->Flags |= LUNEX_REQUEST_PENDING | SCSI_PORT_LU_ACTIVE; + + /* Release the spinlock and return */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + return NULL; + } + + ASSERT(LunExtension->SrbInfo.Srb == NULL); + SrbInfo = DeviceExtension->FreeSrbInfo; + + if (SrbInfo == NULL) + { + /* No SRB structures left in the list. We have to leave + and wait while we are called again */ + + DeviceExtension->Flags |= SCSI_PORT_REQUEST_PENDING; + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + return NULL; + } + + DeviceExtension->FreeSrbInfo = (PSCSI_REQUEST_BLOCK_INFO)SrbInfo->Requests.Flink; + + /* QueueTag must never be 0, so +1 to it */ + Srb->QueueTag = (UCHAR)(SrbInfo - DeviceExtension->SrbInfo) + 1; + } + else + { + /* Usual untagged command */ + if ( + (!IsListEmpty(&LunExtension->SrbInfo.Requests) || + LunExtension->Flags & LUNEX_NEED_REQUEST_SENSE) && + !(Srb->SrbFlags & SRB_FLAGS_BYPASS_FROZEN_QUEUE) + ) + { + /* Mark it as pending and leave */ + ASSERT(!(LunExtension->Flags & LUNEX_REQUEST_PENDING)); + LunExtension->Flags |= LUNEX_REQUEST_PENDING | SCSI_PORT_LU_ACTIVE; + LunExtension->PendingRequest = Srb->OriginalRequest; + + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + return(NULL); + } + + Srb->QueueTag = SP_UNTAGGED; + SrbInfo = &LunExtension->SrbInfo; + } + } + else + { + Srb->QueueTag = SP_UNTAGGED; + SrbInfo = &LunExtension->SrbInfo; + } + + /* Allocate SRB extension structure */ + if (DeviceExtension->NeedSrbExtensionAlloc) + { + /* Check the list of free extensions */ + SrbExtension = DeviceExtension->FreeSrbExtensions; + + /* If no free extensions... */ + if (SrbExtension == NULL) + { + /* Free SRB data */ + if (Srb->Function != SRB_FUNCTION_ABORT_COMMAND && + Srb->QueueTag != SP_UNTAGGED) + { + SrbInfo->Requests.Blink = NULL; + SrbInfo->Requests.Flink = (PLIST_ENTRY)DeviceExtension->FreeSrbInfo; + DeviceExtension->FreeSrbInfo = SrbInfo; + } + + /* Return, in order to be called again later */ + DeviceExtension->Flags |= SCSI_PORT_REQUEST_PENDING; + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + return NULL; + } + + /* Remove that free SRB extension from the list (since + we're going to use it) */ + DeviceExtension->FreeSrbExtensions = *((PVOID *)SrbExtension); + + /* Spinlock can be released now */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + + Srb->SrbExtension = SrbExtension; + + if (Srb->SenseInfoBuffer != NULL && + DeviceExtension->SupportsAutoSense) + { + /* Store pointer to the SenseInfo buffer */ + SrbInfo->SaveSenseRequest = Srb->SenseInfoBuffer; + + /* Does data fit the buffer? */ + if (Srb->SenseInfoBufferLength > sizeof(SENSE_DATA)) + { + /* No, disabling autosense at all */ + Srb->SrbFlags |= SRB_FLAGS_DISABLE_AUTOSENSE; + } + else + { + /* Yes, update the buffer pointer */ + Srb->SenseInfoBuffer = SrbExtension + DeviceExtension->SrbExtensionSize; + } + } + } + else + { + /* Cleanup... */ + Srb->SrbExtension = NULL; + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + } + + return SrbInfo; +} + +VOID +NTAPI +ScsiPortStartIo( + _Inout_ PDEVICE_OBJECT DeviceObject, + _Inout_ PIRP Irp) +{ + PSCSI_PORT_DEVICE_EXTENSION DeviceExtension; + PSCSI_PORT_LUN_EXTENSION LunExtension; + PIO_STACK_LOCATION IrpStack; + PSCSI_REQUEST_BLOCK Srb; + PSCSI_REQUEST_BLOCK_INFO SrbInfo; + LONG CounterResult; + NTSTATUS Status; + + DPRINT("ScsiPortStartIo() called!\n"); + + DeviceExtension = DeviceObject->DeviceExtension; + IrpStack = IoGetCurrentIrpStackLocation(Irp); + + DPRINT("DeviceExtension %p\n", DeviceExtension); + + Srb = IrpStack->Parameters.Scsi.Srb; + + /* Apply "default" flags */ + Srb->SrbFlags |= DeviceExtension->SrbFlags; + + /* Get LUN extension */ + LunExtension = SpiGetLunExtension(DeviceExtension, + Srb->PathId, + Srb->TargetId, + Srb->Lun); + + if (DeviceExtension->NeedSrbDataAlloc || + DeviceExtension->NeedSrbExtensionAlloc) + { + /* Allocate them */ + SrbInfo = SpiAllocateSrbStructures(DeviceExtension, + LunExtension, + Srb); + + /* Couldn't alloc one or both data structures, return */ + if (SrbInfo == NULL) + { + /* We have to call IoStartNextPacket, because this request + was not started */ + if (LunExtension->Flags & LUNEX_REQUEST_PENDING) + IoStartNextPacket(DeviceObject, FALSE); + + return; + } + } + else + { + /* No allocations are needed */ + SrbInfo = &LunExtension->SrbInfo; + Srb->SrbExtension = NULL; + Srb->QueueTag = SP_UNTAGGED; + } + + /* Increase sequence number of SRB */ + if (!SrbInfo->SequenceNumber) + { + /* Increase global sequence number */ + DeviceExtension->SequenceNumber++; + + /* Assign it */ + SrbInfo->SequenceNumber = DeviceExtension->SequenceNumber; + } + + /* Check some special SRBs */ + if (Srb->Function == SRB_FUNCTION_ABORT_COMMAND) + { + /* Some special handling */ + DPRINT1("Abort command! Unimplemented now\n"); + } + else + { + SrbInfo->Srb = Srb; + } + + if (Srb->SrbFlags & SRB_FLAGS_UNSPECIFIED_DIRECTION) + { + // Store the MDL virtual address in SrbInfo structure + SrbInfo->DataOffset = MmGetMdlVirtualAddress(Irp->MdlAddress); + + if (DeviceExtension->MapBuffers) + { + /* Calculate offset within DataBuffer */ + SrbInfo->DataOffset = MmGetSystemAddressForMdl(Irp->MdlAddress); + Srb->DataBuffer = SrbInfo->DataOffset + + (ULONG)((PUCHAR)Srb->DataBuffer - + (PUCHAR)MmGetMdlVirtualAddress(Irp->MdlAddress)); + } + + if (DeviceExtension->AdapterObject) + { + /* Flush buffers */ + KeFlushIoBuffers(Irp->MdlAddress, + Srb->SrbFlags & SRB_FLAGS_DATA_IN ? TRUE : FALSE, + TRUE); + } + + if (DeviceExtension->MapRegisters) + { + /* Calculate number of needed map registers */ + SrbInfo->NumberOfMapRegisters = ADDRESS_AND_SIZE_TO_SPAN_PAGES( + Srb->DataBuffer, + Srb->DataTransferLength); + + /* Allocate adapter channel */ + Status = IoAllocateAdapterChannel(DeviceExtension->AdapterObject, + DeviceExtension->DeviceObject, + SrbInfo->NumberOfMapRegisters, + SpiAdapterControl, + SrbInfo); + + if (!NT_SUCCESS(Status)) + { + DPRINT1("IoAllocateAdapterChannel() failed!\n"); + + Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST; + ScsiPortNotification(RequestComplete, + DeviceExtension + 1, + Srb); + + ScsiPortNotification(NextRequest, + DeviceExtension + 1); + + /* Request DPC for that work */ + IoRequestDpc(DeviceExtension->DeviceObject, NULL, NULL); + } + + /* Control goes to SpiAdapterControl */ + return; + } + } + + /* Increase active request counter */ + CounterResult = InterlockedIncrement(&DeviceExtension->ActiveRequestCounter); + + if (CounterResult == 0 && + DeviceExtension->AdapterObject != NULL && + !DeviceExtension->MapRegisters) + { + IoAllocateAdapterChannel( + DeviceExtension->AdapterObject, + DeviceObject, + DeviceExtension->PortCapabilities.MaximumPhysicalPages, + ScsiPortAllocateAdapterChannel, + LunExtension + ); + + return; + } + + KeAcquireSpinLockAtDpcLevel(&DeviceExtension->SpinLock); + + if (!KeSynchronizeExecution(DeviceExtension->Interrupt[0], + ScsiPortStartPacket, + DeviceObject)) + { + DPRINT("Synchronization failed!\n"); + + Irp->IoStatus.Status = STATUS_UNSUCCESSFUL; + Irp->IoStatus.Information = 0; + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + + IoCompleteRequest(Irp, IO_NO_INCREMENT); + } + else + { + /* Release the spinlock only */ + KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); + } + + + DPRINT("ScsiPortStartIo() done\n"); +} diff --git a/drivers/storage/port/scsiport/scsiport.c b/drivers/storage/port/scsiport/scsiport.c index 2155a2c069d..1f527947d25 100644 --- a/drivers/storage/port/scsiport/scsiport.c +++ b/drivers/storage/port/scsiport/scsiport.c @@ -1,7 +1,7 @@ /* - * PROJECT: ReactOS Storage Stack + * PROJECT: ReactOS Storage Stack / SCSIPORT storage port library * LICENSE: GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later) - * PURPOSE: SCSI Port driver SCSI requests handling + * PURPOSE: Main and exported functions * COPYRIGHT: Eric Kohl (eric.kohl(a)reactos.org) * Aleksey Bragin (aleksey(a)reactos.org) */ @@ -32,108 +32,10 @@ static NTSTATUS NTAPI ScsiPortCreateClose(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp); -static DRIVER_DISPATCH ScsiPortDispatchScsi; -static NTSTATUS NTAPI -ScsiPortDispatchScsi(IN PDEVICE_OBJECT DeviceObject, - IN PIRP Irp); - -static NTSTATUS NTAPI -ScsiPortDeviceControl(IN PDEVICE_OBJECT DeviceObject, - IN PIRP Irp); - -static DRIVER_STARTIO ScsiPortStartIo; -static VOID NTAPI -ScsiPortStartIo(IN PDEVICE_OBJECT DeviceObject, - IN PIRP Irp); - -static BOOLEAN NTAPI -ScsiPortStartPacket(IN OUT PVOID Context); - -IO_ALLOCATION_ACTION -NTAPI -SpiAdapterControl(PDEVICE_OBJECT DeviceObject, PIRP Irp, - PVOID MapRegisterBase, PVOID Context); - -static PSCSI_PORT_LUN_EXTENSION -SpiAllocateLunExtension(IN PSCSI_PORT_DEVICE_EXTENSION DeviceExtension); - -static PSCSI_PORT_LUN_EXTENSION -SpiGetLunExtension (IN PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, - IN UCHAR PathId, - IN UCHAR TargetId, - IN UCHAR Lun); - -static PSCSI_REQUEST_BLOCK_INFO -SpiAllocateSrbStructures(PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, - PSCSI_PORT_LUN_EXTENSION LunExtension, - PSCSI_REQUEST_BLOCK Srb); - -static NTSTATUS -SpiSendInquiry(IN PDEVICE_OBJECT DeviceObject, - IN OUT PSCSI_LUN_INFO LunInfo); - -static VOID -SpiScanAdapter(IN PSCSI_PORT_DEVICE_EXTENSION DeviceExtension); - -static NTSTATUS -SpiGetInquiryData (IN PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, - IN PIRP Irp); - -static PSCSI_REQUEST_BLOCK_INFO -SpiGetSrbData(IN PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, - IN UCHAR PathId, - IN UCHAR TargetId, - IN UCHAR Lun, - IN UCHAR QueueTag); - -static BOOLEAN NTAPI -ScsiPortIsr(IN PKINTERRUPT Interrupt, - IN PVOID ServiceContext); - -static VOID NTAPI -ScsiPortDpcForIsr(IN PKDPC Dpc, - IN PDEVICE_OBJECT DpcDeviceObject, - IN PIRP DpcIrp, - IN PVOID DpcContext); - static VOID NTAPI ScsiPortIoTimer(PDEVICE_OBJECT DeviceObject, PVOID Context); -IO_ALLOCATION_ACTION -NTAPI -ScsiPortAllocateAdapterChannel(IN PDEVICE_OBJECT DeviceObject, - IN PIRP Irp, - IN PVOID MapRegisterBase, - IN PVOID Context); - -static NTSTATUS -SpiBuildDeviceMap(IN PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, - IN PUNICODE_STRING RegistryPath); - -static NTSTATUS -SpiStatusSrbToNt(UCHAR SrbStatus); - -static VOID -SpiSendRequestSense(IN PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, - IN PSCSI_REQUEST_BLOCK Srb); - -static IO_COMPLETION_ROUTINE SpiCompletionRoutine; -NTSTATUS NTAPI -SpiCompletionRoutine(PDEVICE_OBJECT DeviceObject, - PIRP Irp, - PVOID Context); - -static VOID -NTAPI -SpiProcessCompletedRequest(IN PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, - IN PSCSI_REQUEST_BLOCK_INFO SrbInfo, - OUT PBOOLEAN NeedToCallStartIo); - -VOID NTAPI -SpiGetNextRequestFromLun(IN PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, - IN PSCSI_PORT_LUN_EXTENSION LunExtension); - VOID NTAPI SpiMiniportTimerDpc(IN struct _KDPC *Dpc, IN PVOID DeviceObject, @@ -176,13 +78,6 @@ static PCM_RESOURCE_LIST SpiConfigToResource(PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, PPORT_CONFIGURATION_INFORMATION PortConfig); -static VOID -SpiCleanupAfterInit(PSCSI_PORT_DEVICE_EXTENSION DeviceExtension); - -static NTSTATUS -SpiHandleAttachRelease(PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, - PIRP Irp); - static NTSTATUS SpiAllocateCommonBuffer(PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, ULONG NonCachedSize); @@ -880,73 +775,6 @@ ScsiPortGetVirtualAddress(IN PVOID HwDeviceExtension, return (PVOID)((ULONG_PTR)DeviceExtension->SrbExtensionBuffer + Offset); } -static VOID -SpiInitOpenKeys(PCONFIGURATION_INFO ConfigInfo, PUNICODE_STRING RegistryPath) -{ - OBJECT_ATTRIBUTES ObjectAttributes; - UNICODE_STRING KeyName; - NTSTATUS Status; - - /* Open the service key */ - InitializeObjectAttributes(&ObjectAttributes, - RegistryPath, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = ZwOpenKey(&ConfigInfo->ServiceKey, - KEY_READ, - &ObjectAttributes); - - if (!NT_SUCCESS(Status)) - { - DPRINT("Unable to open driver's registry key %wZ, status 0x%08x\n", RegistryPath, Status); - ConfigInfo->ServiceKey = NULL; - } - - /* If we could open driver's service key, then proceed to the Parameters key */ - if (ConfigInfo->ServiceKey != NULL) - { - RtlInitUnicodeString(&KeyName, L"Parameters"); - InitializeObjectAttributes(&ObjectAttributes, - &KeyName, - OBJ_CASE_INSENSITIVE, - ConfigInfo->ServiceKey, - (PSECURITY_DESCRIPTOR) NULL); - - /* Try to open it */ - Status = ZwOpenKey(&ConfigInfo->DeviceKey, - KEY_READ, - &ObjectAttributes); - - if (NT_SUCCESS(Status)) - { - /* Yes, Parameters key exist, and it must be used instead of - the Service key */ - ZwClose(ConfigInfo->ServiceKey); - ConfigInfo->ServiceKey = ConfigInfo->DeviceKey; - ConfigInfo->DeviceKey = NULL; - } - } - - if (ConfigInfo->ServiceKey != NULL) - { - /* Open the Device key */ - RtlInitUnicodeString(&KeyName, L"Device"); - InitializeObjectAttributes(&ObjectAttributes, - &KeyName, - OBJ_CASE_INSENSITIVE, - ConfigInfo->ServiceKey, - NULL); - - /* We don't check for failure here - not needed */ - ZwOpenKey(&ConfigInfo->DeviceKey, - KEY_READ, - &ObjectAttributes); - } -} - - /********************************************************************** * NAME EXPORTED * ScsiPortInitialize @@ -1007,7 +835,6 @@ ScsiPortInitialize( UNICODE_STRING DosDeviceName; PIO_SCSI_CAPABILITIES PortCapabilities; - KIRQL OldIrql; PCM_RESOURCE_LIST ResourceList; BOOLEAN Conflict; SIZE_T BusConfigSize; @@ -1456,132 +1283,7 @@ CreatePortConfig: } } - /* Deal with interrupts */ - if (DeviceExtension->HwInterrupt == NULL || - (PortConfig->BusInterruptLevel == 0 && PortConfig->BusInterruptVector == 0)) - { - /* No interrupts */ - DeviceExtension->InterruptCount = 0; - - DPRINT1("Interrupt Count: 0\n"); - - UNIMPLEMENTED; - - /* This code path will ALWAYS crash so stop it now */ - while (TRUE); - } - else - { - BOOLEAN InterruptShareable; - KINTERRUPT_MODE InterruptMode[2]; - ULONG InterruptVector[2], i, MappedIrq[2]; - KIRQL Dirql[2], MaxDirql; - KAFFINITY Affinity[2]; - - DeviceExtension->InterruptLevel[0] = PortConfig->BusInterruptLevel; - DeviceExtension->InterruptLevel[1] = PortConfig->BusInterruptLevel2; - - InterruptVector[0] = PortConfig->BusInterruptVector; - InterruptVector[1] = PortConfig->BusInterruptVector2; - - InterruptMode[0] = PortConfig->InterruptMode; - InterruptMode[1] = PortConfig->InterruptMode2; - - DeviceExtension->InterruptCount = - (PortConfig->BusInterruptLevel2 != 0 || - PortConfig->BusInterruptVector2 != 0) ? 2 : 1; - - for (i = 0; i < DeviceExtension->InterruptCount; i++) - { - /* Register an interrupt handler for this device */ - MappedIrq[i] = HalGetInterruptVector( - PortConfig->AdapterInterfaceType, PortConfig->SystemIoBusNumber, - DeviceExtension->InterruptLevel[i], InterruptVector[i], &Dirql[i], - &Affinity[i]); - } - - if (DeviceExtension->InterruptCount == 1 || Dirql[0] > Dirql[1]) - MaxDirql = Dirql[0]; - else - MaxDirql = Dirql[1]; - - for (i = 0; i < DeviceExtension->InterruptCount; i++) - { - /* Determine IRQ sharability as usual */ - if (PortConfig->AdapterInterfaceType == MicroChannel || - InterruptMode[i] == LevelSensitive) - { - InterruptShareable = TRUE; - } - else - { - InterruptShareable = FALSE; - } - - Status = IoConnectInterrupt( - &DeviceExtension->Interrupt[i], (PKSERVICE_ROUTINE)ScsiPortIsr, DeviceExtension, - &DeviceExtension->IrqLock, MappedIrq[i], Dirql[i], MaxDirql, InterruptMode[i], - InterruptShareable, Affinity[i], FALSE); - - if (!(NT_SUCCESS(Status))) - { - DPRINT1("Could not connect interrupt %d\n", InterruptVector[i]); - DeviceExtension->Interrupt[i] = NULL; - break; - } - } - - if (!NT_SUCCESS(Status)) - break; - } - - /* Save IoAddress (from access ranges) */ - if (HwInitializationData->NumberOfAccessRanges != 0) - { - DeviceExtension->IoAddress = ((*(PortConfig->AccessRanges))[0]).RangeStart.LowPart; - - DPRINT("Io Address %x\n", DeviceExtension->IoAddress); - } - - /* Set flag that it's allowed to disconnect during this command */ - DeviceExtension->Flags |= SCSI_PORT_DISCONNECT_ALLOWED; - - /* Initialize counter of active requests (-1 means there are none) */ - DeviceExtension->ActiveRequestCounter = -1; - - /* Analyze what we have about DMA */ - if (DeviceExtension->AdapterObject != NULL && PortConfig->Master && - PortConfig->NeedPhysicalAddresses) - { - DeviceExtension->MapRegisters = TRUE; - } - else - { - DeviceExtension->MapRegisters = FALSE; - } - - /* Call HwInitialize at DISPATCH_LEVEL */ - KeRaiseIrql(DISPATCH_LEVEL, &OldIrql); - - if (!KeSynchronizeExecution( - DeviceExtension->Interrupt[0], DeviceExtension->HwInitialize, - DeviceExtension->MiniPortDeviceExtension)) - { - DPRINT1("HwInitialize() failed!\n"); - KeLowerIrql(OldIrql); - Status = STATUS_ADAPTER_HARDWARE_ERROR; - break; - } - - /* Check if a notification is needed */ - if (DeviceExtension->InterruptData.Flags & SCSI_PORT_NOTIFICATION_NEEDED) - { - /* Call DPC right away, because we're already at DISPATCH_LEVEL */ - ScsiPortDpcForIsr(NULL, DeviceExtension->DeviceObject, NULL, NULL); - } - - /* Lower irql back to what it was */ - KeLowerIrql(OldIrql); + CallHWInitialize(DeviceExtension); /* Start our timer */ IoStartTimer(PortDeviceObject); @@ -1656,106 +1358,6 @@ CreatePortConfig: return (DeviceFound == FALSE) ? Status : STATUS_SUCCESS; } -static VOID -SpiCleanupAfterInit(PSCSI_PORT_DEVICE_EXTENSION DeviceExtension) -{ - PSCSI_LUN_INFO LunInfo; - PVOID Ptr; - ULONG Bus, Lun; - - /* Check if we have something to clean up */ - if (DeviceExtension == NULL) - return; - - /* Stop the timer */ - IoStopTimer(DeviceExtension->DeviceObject); - - /* Disconnect the interrupts */ - while (DeviceExtension->InterruptCount) - { - if (DeviceExtension->Interrupt[--DeviceExtension->InterruptCount]) - IoDisconnectInterrupt(DeviceExtension->Interrupt[DeviceExtension->InterruptCount]); - } - - /* Delete ConfigInfo */ - if (DeviceExtension->BusesConfig) - { - for (Bus = 0; Bus < DeviceExtension->BusNum; Bus++) - { - if (!DeviceExtension->BusesConfig->BusScanInfo[Bus]) - continue; - - LunInfo = DeviceExtension->BusesConfig->BusScanInfo[Bus]->LunInfo; - - while (LunInfo) - { - /* Free current, but save pointer to the next one */ - Ptr = LunInfo->Next; - ExFreePool(LunInfo); - LunInfo = Ptr; - } - - ExFreePool(DeviceExtension->BusesConfig->BusScanInfo[Bus]); - } - - ExFreePool(DeviceExtension->BusesConfig); - } - - /* Free PortConfig */ - if (DeviceExtension->PortConfig) - ExFreePool(DeviceExtension->PortConfig); - - /* Free LUNs*/ - for(Lun = 0; Lun < LUS_NUMBER; Lun++) - { - while (DeviceExtension->LunExtensionList[Lun]) - { - Ptr = DeviceExtension->LunExtensionList[Lun]; - DeviceExtension->LunExtensionList[Lun] = DeviceExtension->LunExtensionList[Lun]->Next; - - ExFreePool(Ptr); - } - } - - /* Free common buffer (if it exists) */ - if (DeviceExtension->SrbExtensionBuffer != NULL && - DeviceExtension->CommonBufferLength != 0) - { - if (!DeviceExtension->AdapterObject) - { - ExFreePool(DeviceExtension->SrbExtensionBuffer); - } - else - { - HalFreeCommonBuffer(DeviceExtension->AdapterObject, - DeviceExtension->CommonBufferLength, - DeviceExtension->PhysicalAddress, - DeviceExtension->SrbExtensionBuffer, - FALSE); - } - } - - /* Free SRB info */ - if (DeviceExtension->SrbInfo != NULL) - ExFreePool(DeviceExtension->SrbInfo); - - /* Unmap mapped addresses */ - while (DeviceExtension->MappedAddressList != NULL) - { - MmUnmapIoSpace(DeviceExtension->MappedAddressList->MappedAddress, - DeviceExtension->MappedAddressList->NumberOfBytes); - - Ptr = DeviceExtension->MappedAddressList; - DeviceExtension->MappedAddressList = DeviceExtension->MappedAddressList->NextMappedAddress; - - ExFreePool(Ptr); - } - - /* Finally delete the device object */ - DPRINT("Deleting device %p\n", DeviceExtension->DeviceObject); - IoDeleteDevice(DeviceExtension->DeviceObject); -} - /* * @unimplemented */ @@ -2392,2619 +1994,122 @@ ScsiPortCreateClose(IN PDEVICE_OBJECT DeviceObject, return STATUS_SUCCESS; } -static NTSTATUS -SpiHandleAttachRelease(PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, - PIRP Irp) +IO_ALLOCATION_ACTION +NTAPI +SpiAdapterControl(PDEVICE_OBJECT DeviceObject, + PIRP Irp, + PVOID MapRegisterBase, + PVOID Context) { - PSCSI_LUN_INFO LunInfo; - PIO_STACK_LOCATION IrpStack; - PDEVICE_OBJECT DeviceObject; PSCSI_REQUEST_BLOCK Srb; - KIRQL Irql; + PSCSI_SG_ADDRESS ScatterGatherList; + KIRQL CurrentIrql; + PIO_STACK_LOCATION IrpStack; + ULONG TotalLength = 0; + PSCSI_REQUEST_BLOCK_INFO SrbInfo; + PSCSI_PORT_DEVICE_EXTENSION DeviceExtension; + PUCHAR DataVA; + BOOLEAN WriteToDevice; + + /* Get pointers to SrbInfo and DeviceExtension */ + SrbInfo = (PSCSI_REQUEST_BLOCK_INFO)Context; + DeviceExtension = DeviceObject->DeviceExtension; - /* Get pointer to the SRB */ + /* Get pointer to SRB */ IrpStack = IoGetCurrentIrpStackLocation(Irp); Srb = (PSCSI_REQUEST_BLOCK)IrpStack->Parameters.Others.Argument1; - /* Check if PathId matches number of buses */ - if (DeviceExtension->BusesConfig == NULL || - DeviceExtension->BusesConfig->NumberOfBuses <= Srb->PathId) + /* Depending on the map registers number, we allocate + either from NonPagedPool, or from our static list */ + if (SrbInfo->NumberOfMapRegisters > MAX_SG_LIST) { - Srb->SrbStatus = SRB_STATUS_NO_DEVICE; - return STATUS_DEVICE_DOES_NOT_EXIST; - } + SrbInfo->ScatterGather = ExAllocatePoolWithTag( + NonPagedPool, SrbInfo->NumberOfMapRegisters * sizeof(SCSI_SG_ADDRESS), TAG_SCSIPORT); - /* Get pointer to LunInfo */ - LunInfo = DeviceExtension->BusesConfig->BusScanInfo[Srb->PathId]->LunInfo; + if (SrbInfo->ScatterGather == NULL) + ASSERT(FALSE); - /* Find matching LunInfo */ - while (LunInfo) + Srb->SrbFlags |= SRB_FLAGS_SGLIST_FROM_POOL; + } + else { - if (LunInfo->PathId == Srb->PathId && - LunInfo->TargetId == Srb->TargetId && - LunInfo->Lun == Srb->Lun) - { - break; - } - - LunInfo = LunInfo->Next; + SrbInfo->ScatterGather = SrbInfo->ScatterGatherList; } - /* If we couldn't find it - exit */ - if (LunInfo == NULL) - return STATUS_DEVICE_DOES_NOT_EXIST; - + /* Use chosen SG list source */ + ScatterGatherList = SrbInfo->ScatterGather; - /* Get spinlock */ - KeAcquireSpinLock(&DeviceExtension->SpinLock, &Irql); + /* Save map registers base */ + SrbInfo->BaseOfMapRegister = MapRegisterBase; - /* Release, if asked */ - if (Srb->Function == SRB_FUNCTION_RELEASE_DEVICE) - { - LunInfo->DeviceClaimed = FALSE; - KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); - Srb->SrbStatus = SRB_STATUS_SUCCESS; + /* Determine WriteToDevice flag */ + WriteToDevice = Srb->SrbFlags & SRB_FLAGS_DATA_OUT ? TRUE : FALSE; - return STATUS_SUCCESS; - } + /* Get virtual address of the data buffer */ + DataVA = (PUCHAR)MmGetMdlVirtualAddress(Irp->MdlAddress) + + ((PCHAR)Srb->DataBuffer - SrbInfo->DataOffset); - /* Attach, if not already claimed */ - if (LunInfo->DeviceClaimed) + /* Build the actual SG list */ + while (TotalLength < Srb->DataTransferLength) { - KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); - Srb->SrbStatus = SRB_STATUS_BUSY; - - return STATUS_DEVICE_BUSY; - } + if (!ScatterGatherList) + break; - /* Save the device object */ - DeviceObject = LunInfo->DeviceObject; + ScatterGatherList->Length = Srb->DataTransferLength - TotalLength; + ScatterGatherList->PhysicalAddress = IoMapTransfer(DeviceExtension->AdapterObject, + Irp->MdlAddress, + MapRegisterBase, + DataVA + TotalLength, + &ScatterGatherList->Length, + WriteToDevice); - if (Srb->Function == SRB_FUNCTION_CLAIM_DEVICE) - LunInfo->DeviceClaimed = TRUE; + TotalLength += ScatterGatherList->Length; + ScatterGatherList++; + } - if (Srb->Function == SRB_FUNCTION_ATTACH_DEVICE) - LunInfo->DeviceObject = Srb->DataBuffer; + /* Schedule an active request */ + InterlockedIncrement(&DeviceExtension->ActiveRequestCounter ); + KeAcquireSpinLock(&DeviceExtension->SpinLock, &CurrentIrql); + KeSynchronizeExecution(DeviceExtension->Interrupt[0], + ScsiPortStartPacket, + DeviceObject); + KeReleaseSpinLock(&DeviceExtension->SpinLock, CurrentIrql); - Srb->DataBuffer = DeviceObject; + return DeallocateObjectKeepRegisters; +} - KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); - Srb->SrbStatus = SRB_STATUS_SUCCESS; - - return STATUS_SUCCESS; -} - - -/********************************************************************** - * NAME INTERNAL - * ScsiPortDispatchScsi - * - * DESCRIPTION - * Answer requests for SCSI calls - * - * RUN LEVEL - * PASSIVE_LEVEL - * - * ARGUMENTS - * Standard dispatch arguments - * - * RETURNS - * NTSTATUS - */ - -static NTSTATUS NTAPI -ScsiPortDispatchScsi(IN PDEVICE_OBJECT DeviceObject, IN PIRP Irp) -{ - PSCSI_PORT_DEVICE_EXTENSION DeviceExtension; - PSCSI_PORT_LUN_EXTENSION LunExtension; - PIO_STACK_LOCATION Stack; - PSCSI_REQUEST_BLOCK Srb; - KIRQL Irql; - NTSTATUS Status = STATUS_SUCCESS; - PIRP NextIrp, IrpList; - PKDEVICE_QUEUE_ENTRY Entry; - - DPRINT("ScsiPortDispatchScsi(DeviceObject %p Irp %p)\n", DeviceObject, Irp); - - DeviceExtension = DeviceObject->DeviceExtension; - Stack = IoGetCurrentIrpStackLocation(Irp); - - Srb = Stack->Parameters.Scsi.Srb; - if (Srb == NULL) - { - DPRINT1("ScsiPortDispatchScsi() called with Srb = NULL!\n"); - Status = STATUS_UNSUCCESSFUL; - - Irp->IoStatus.Status = Status; - Irp->IoStatus.Information = 0; - - IoCompleteRequest(Irp, IO_NO_INCREMENT); - - return (Status); - } - - DPRINT("Srb: %p\n", Srb); - DPRINT("Srb->Function: %lu\n", Srb->Function); - DPRINT("PathId: %lu TargetId: %lu Lun: %lu\n", Srb->PathId, Srb->TargetId, Srb->Lun); - - LunExtension = SpiGetLunExtension(DeviceExtension, Srb->PathId, Srb->TargetId, Srb->Lun); - if (LunExtension == NULL) - { - DPRINT("ScsiPortDispatchScsi() called with an invalid LUN\n"); - Status = STATUS_NO_SUCH_DEVICE; - - Srb->SrbStatus = SRB_STATUS_NO_DEVICE; - Irp->IoStatus.Status = Status; - Irp->IoStatus.Information = 0; - - IoCompleteRequest(Irp, IO_NO_INCREMENT); - - return (Status); - } - - switch (Srb->Function) - { - case SRB_FUNCTION_SHUTDOWN: - case SRB_FUNCTION_FLUSH: - DPRINT(" SRB_FUNCTION_SHUTDOWN or FLUSH\n"); - if (DeviceExtension->CachesData == FALSE) - { - /* All success here */ - Srb->SrbStatus = SRB_STATUS_SUCCESS; - Irp->IoStatus.Status = STATUS_SUCCESS; - IoCompleteRequest(Irp, IO_NO_INCREMENT); - return STATUS_SUCCESS; - } - /* Fall through to a usual execute operation */ - - case SRB_FUNCTION_EXECUTE_SCSI: - case SRB_FUNCTION_IO_CONTROL: - DPRINT(" SRB_FUNCTION_EXECUTE_SCSI or SRB_FUNCTION_IO_CONTROL\n"); - /* Mark IRP as pending in all cases */ - IoMarkIrpPending(Irp); - - if (Srb->SrbFlags & SRB_FLAGS_BYPASS_FROZEN_QUEUE) - { - /* Start IO directly */ - IoStartPacket(DeviceObject, Irp, NULL, NULL); - } - else - { - KIRQL oldIrql; - - /* We need to be at DISPATCH_LEVEL */ - KeRaiseIrql(DISPATCH_LEVEL, &oldIrql); - - /* Insert IRP into the queue */ - if (!KeInsertByKeyDeviceQueue( - &LunExtension->DeviceQueue, - &Irp->Tail.Overlay.DeviceQueueEntry, - Srb->QueueSortKey)) - { - /* It means the queue is empty, and we just start this request */ - IoStartPacket(DeviceObject, Irp, NULL, NULL); - } - - /* Back to the old IRQL */ - KeLowerIrql(oldIrql); - } - return STATUS_PENDING; - - case SRB_FUNCTION_CLAIM_DEVICE: - case SRB_FUNCTION_ATTACH_DEVICE: - DPRINT(" SRB_FUNCTION_CLAIM_DEVICE or ATTACH\n"); - - /* Reference device object and keep the device object */ - Status = SpiHandleAttachRelease(DeviceExtension, Irp); - break; - - case SRB_FUNCTION_RELEASE_DEVICE: - DPRINT(" SRB_FUNCTION_RELEASE_DEVICE\n"); - - /* Dereference device object and clear the device object */ - Status = SpiHandleAttachRelease(DeviceExtension, Irp); - break; - - case SRB_FUNCTION_RELEASE_QUEUE: - DPRINT(" SRB_FUNCTION_RELEASE_QUEUE\n"); - - /* Guard with the spinlock */ - KeAcquireSpinLock(&DeviceExtension->SpinLock, &Irql); - - if (!(LunExtension->Flags & LUNEX_FROZEN_QUEUE)) - { - DPRINT("Queue is not frozen really\n"); - - KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); - Srb->SrbStatus = SRB_STATUS_SUCCESS; - Status = STATUS_SUCCESS; - break; - } - - /* Unfreeze the queue */ - LunExtension->Flags &= ~LUNEX_FROZEN_QUEUE; - - if (LunExtension->SrbInfo.Srb == NULL) - { - /* Get next logical unit request */ - SpiGetNextRequestFromLun(DeviceExtension, LunExtension); - - /* SpiGetNextRequestFromLun() releases the spinlock */ - KeLowerIrql(Irql); - } - else - { - DPRINT("The queue has active request\n"); - KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); - } - - Srb->SrbStatus = SRB_STATUS_SUCCESS; - Status = STATUS_SUCCESS; - break; - - case SRB_FUNCTION_FLUSH_QUEUE: - DPRINT(" SRB_FUNCTION_FLUSH_QUEUE\n"); - - /* Guard with the spinlock */ - KeAcquireSpinLock(&DeviceExtension->SpinLock, &Irql); - - if (!(LunExtension->Flags & LUNEX_FROZEN_QUEUE)) - { - DPRINT("Queue is not frozen really\n"); - - KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); - Status = STATUS_INVALID_DEVICE_REQUEST; - break; - } - - /* Make sure there is no active request */ - ASSERT(LunExtension->SrbInfo.Srb == NULL); - - /* Compile a list from the device queue */ - IrpList = NULL; - while ((Entry = KeRemoveDeviceQueue(&LunExtension->DeviceQueue)) != NULL) - { - NextIrp = CONTAINING_RECORD(Entry, IRP, Tail.Overlay.DeviceQueueEntry); - - /* Get the Srb */ - Stack = IoGetCurrentIrpStackLocation(NextIrp); - Srb = Stack->Parameters.Scsi.Srb; - - /* Set statuse */ - Srb->SrbStatus = SRB_STATUS_REQUEST_FLUSHED; - NextIrp->IoStatus.Status = STATUS_UNSUCCESSFUL; - - /* Add then to the list */ - NextIrp->Tail.Overlay.ListEntry.Flink = (PLIST_ENTRY)IrpList; - IrpList = NextIrp; - } - - /* Unfreeze the queue */ - LunExtension->Flags &= ~LUNEX_FROZEN_QUEUE; - - /* Release the spinlock */ - KeReleaseSpinLock(&DeviceExtension->SpinLock, Irql); - - /* Complete those requests */ - while (IrpList) - { - NextIrp = IrpList; - IrpList = (PIRP)NextIrp->Tail.Overlay.ListEntry.Flink; - - IoCompleteRequest(NextIrp, 0); - } - - Status = STATUS_SUCCESS; - break; - - default: - DPRINT1("SRB function not implemented (Function %lu)\n", Srb->Function); - Status = STATUS_NOT_IMPLEMENTED; - break; - } - - Irp->IoStatus.Status = Status; - IoCompleteRequest(Irp, IO_NO_INCREMENT); - - return Status; -} - - -/********************************************************************** - * NAME INTERNAL - * ScsiPortDeviceControl - * - * DESCRIPTION - * Answer requests for device control calls - * - * RUN LEVEL - * PASSIVE_LEVEL - * - * ARGUMENTS - * Standard dispatch arguments - * - * RETURNS - * NTSTATUS - */ - -static NTSTATUS NTAPI -ScsiPortDeviceControl(IN PDEVICE_OBJECT DeviceObject, - IN PIRP Irp) -{ - PIO_STACK_LOCATION Stack; - PSCSI_PORT_DEVICE_EXTENSION DeviceExtension; - PDUMP_POINTERS DumpPointers; - NTSTATUS Status; - - DPRINT("ScsiPortDeviceControl()\n"); - - Irp->IoStatus.Information = 0; - - Stack = IoGetCurrentIrpStackLocation(Irp); - DeviceExtension = DeviceObject->DeviceExtension; - - switch (Stack->Parameters.DeviceIoControl.IoControlCode) - { - case IOCTL_SCSI_GET_DUMP_POINTERS: - DPRINT(" IOCTL_SCSI_GET_DUMP_POINTERS\n"); - - if (Stack->Parameters.DeviceIoControl.OutputBufferLength < sizeof(DUMP_POINTERS)) - { - Status = STATUS_BUFFER_OVERFLOW; - Irp->IoStatus.Information = sizeof(DUMP_POINTERS); - break; - } - - DumpPointers = Irp->AssociatedIrp.SystemBuffer; - DumpPointers->DeviceObject = DeviceObject; - /* More data.. ? */ - - Status = STATUS_SUCCESS; - Irp->IoStatus.Information = sizeof(DUMP_POINTERS); - break; - - case IOCTL_SCSI_GET_CAPABILITIES: - DPRINT(" IOCTL_SCSI_GET_CAPABILITIES\n"); - if (Stack->Parameters.DeviceIoControl.OutputBufferLength == sizeof(PVOID)) - { - *((PVOID *)Irp->AssociatedIrp.SystemBuffer) = &DeviceExtension->PortCapabilities; - - Irp->IoStatus.Information = sizeof(PVOID); - Status = STATUS_SUCCESS; - break; - } - - if (Stack->Parameters.DeviceIoControl.OutputBufferLength < sizeof(IO_SCSI_CAPABILITIES)) - { - Status = STATUS_BUFFER_TOO_SMALL; - break; - } - - RtlCopyMemory(Irp->AssociatedIrp.SystemBuffer, - &DeviceExtension->PortCapabilities, - sizeof(IO_SCSI_CAPABILITIES)); - - Irp->IoStatus.Information = sizeof(IO_SCSI_CAPABILITIES); - Status = STATUS_SUCCESS; - break; - - case IOCTL_SCSI_GET_INQUIRY_DATA: - DPRINT(" IOCTL_SCSI_GET_INQUIRY_DATA\n"); - - /* Copy inquiry data to the port device extension */ - Status = SpiGetInquiryData(DeviceExtension, Irp); - break; - - case IOCTL_SCSI_MINIPORT: - DPRINT1("IOCTL_SCSI_MINIPORT unimplemented!\n"); - Status = STATUS_NOT_IMPLEMENTED; - break; - - case IOCTL_SCSI_PASS_THROUGH: - DPRINT1("IOCTL_SCSI_PASS_THROUGH unimplemented!\n"); - Status = STATUS_NOT_IMPLEMENTED; - break; - - default: - if (DEVICE_TYPE_FROM_CTL_CODE(Stack->Parameters.DeviceIoControl.IoControlCode) == MOUNTDEVCONTROLTYPE) - { - switch (Stack->Parameters.DeviceIoControl.IoControlCode) - { - case IOCTL_MOUNTDEV_QUERY_DEVICE_NAME: - DPRINT1("Got unexpected IOCTL_MOUNTDEV_QUERY_DEVICE_NAME\n"); - break; - case IOCTL_MOUNTDEV_QUERY_UNIQUE_ID: - DPRINT1("Got unexpected IOCTL_MOUNTDEV_QUERY_UNIQUE_ID\n"); - break; - default: - DPRINT(" got ioctl intended for the mount manager: 0x%lX\n", Stack->Parameters.DeviceIoControl.IoControlCode); - break; - } - } else { - DPRINT1(" unknown ioctl code: 0x%lX\n", Stack->Parameters.DeviceIoControl.IoControlCode); - } - Status = STATUS_NOT_IMPLEMENTED; - break; - } - - /* Complete the request with the given status */ - Irp->IoStatus.Status = Status; - IoCompleteRequest(Irp, IO_NO_INCREMENT); - - return Status; -} - - -static VOID NTAPI -ScsiPortStartIo(IN PDEVICE_OBJECT DeviceObject, - IN PIRP Irp) -{ - PSCSI_PORT_DEVICE_EXTENSION DeviceExtension; - PSCSI_PORT_LUN_EXTENSION LunExtension; - PIO_STACK_LOCATION IrpStack; - PSCSI_REQUEST_BLOCK Srb; - PSCSI_REQUEST_BLOCK_INFO SrbInfo; - LONG CounterResult; - NTSTATUS Status; - - DPRINT("ScsiPortStartIo() called!\n"); - - DeviceExtension = DeviceObject->DeviceExtension; - IrpStack = IoGetCurrentIrpStackLocation(Irp); - - DPRINT("DeviceExtension %p\n", DeviceExtension); - - Srb = IrpStack->Parameters.Scsi.Srb; - - /* Apply "default" flags */ - Srb->SrbFlags |= DeviceExtension->SrbFlags; - - /* Get LUN extension */ - LunExtension = SpiGetLunExtension(DeviceExtension, - Srb->PathId, - Srb->TargetId, - Srb->Lun); - - if (DeviceExtension->NeedSrbDataAlloc || - DeviceExtension->NeedSrbExtensionAlloc) - { - /* Allocate them */ - SrbInfo = SpiAllocateSrbStructures(DeviceExtension, - LunExtension, - Srb); - - /* Couldn't alloc one or both data structures, return */ - if (SrbInfo == NULL) - { - /* We have to call IoStartNextPacket, because this request - was not started */ - if (LunExtension->Flags & LUNEX_REQUEST_PENDING) - IoStartNextPacket(DeviceObject, FALSE); - - return; - } - } - else - { - /* No allocations are needed */ - SrbInfo = &LunExtension->SrbInfo; - Srb->SrbExtension = NULL; - Srb->QueueTag = SP_UNTAGGED; - } - - /* Increase sequence number of SRB */ - if (!SrbInfo->SequenceNumber) - { - /* Increase global sequence number */ - DeviceExtension->SequenceNumber++; - - /* Assign it */ - SrbInfo->SequenceNumber = DeviceExtension->SequenceNumber; - } - - /* Check some special SRBs */ - if (Srb->Function == SRB_FUNCTION_ABORT_COMMAND) - { - /* Some special handling */ - DPRINT1("Abort command! Unimplemented now\n"); - } - else - { - SrbInfo->Srb = Srb; - } - - if (Srb->SrbFlags & SRB_FLAGS_UNSPECIFIED_DIRECTION) - { - // Store the MDL virtual address in SrbInfo structure - SrbInfo->DataOffset = MmGetMdlVirtualAddress(Irp->MdlAddress); - - if (DeviceExtension->MapBuffers) - { - /* Calculate offset within DataBuffer */ - SrbInfo->DataOffset = MmGetSystemAddressForMdl(Irp->MdlAddress); - Srb->DataBuffer = SrbInfo->DataOffset + - (ULONG)((PUCHAR)Srb->DataBuffer - - (PUCHAR)MmGetMdlVirtualAddress(Irp->MdlAddress)); - } - - if (DeviceExtension->AdapterObject) - { - /* Flush buffers */ - KeFlushIoBuffers(Irp->MdlAddress, - Srb->SrbFlags & SRB_FLAGS_DATA_IN ? TRUE : FALSE, - TRUE); - } - - if (DeviceExtension->MapRegisters) - { - /* Calculate number of needed map registers */ - SrbInfo->NumberOfMapRegisters = ADDRESS_AND_SIZE_TO_SPAN_PAGES( - Srb->DataBuffer, - Srb->DataTransferLength); - - /* Allocate adapter channel */ - Status = IoAllocateAdapterChannel(DeviceExtension->AdapterObject, - DeviceExtension->DeviceObject, - SrbInfo->NumberOfMapRegisters, - SpiAdapterControl, - SrbInfo); - - if (!NT_SUCCESS(Status)) - { - DPRINT1("IoAllocateAdapterChannel() failed!\n"); - - Srb->SrbStatus = SRB_STATUS_INVALID_REQUEST; - ScsiPortNotification(RequestComplete, - DeviceExtension + 1, - Srb); - - ScsiPortNotification(NextRequest, - DeviceExtension + 1); - - /* Request DPC for that work */ - IoRequestDpc(DeviceExtension->DeviceObject, NULL, NULL); - } - - /* Control goes to SpiAdapterControl */ - return; - } - } - - /* Increase active request counter */ - CounterResult = InterlockedIncrement(&DeviceExtension->ActiveRequestCounter); - - if (CounterResult == 0 && - DeviceExtension->AdapterObject != NULL && - !DeviceExtension->MapRegisters) - { - IoAllocateAdapterChannel( - DeviceExtension->AdapterObject, - DeviceObject, - DeviceExtension->PortCapabilities.MaximumPhysicalPages, - ScsiPortAllocateAdapterChannel, - LunExtension - ); - - return; - } - - KeAcquireSpinLockAtDpcLevel(&DeviceExtension->SpinLock); - - if (!KeSynchronizeExecution(DeviceExtension->Interrupt[0], - ScsiPortStartPacket, - DeviceObject)) - { - DPRINT("Synchronization failed!\n"); - - Irp->IoStatus.Status = STATUS_UNSUCCESSFUL; - Irp->IoStatus.Information = 0; - KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); - - IoCompleteRequest(Irp, IO_NO_INCREMENT); - } - else - { - /* Release the spinlock only */ - KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); - } - - - DPRINT("ScsiPortStartIo() done\n"); -} - - -static BOOLEAN NTAPI -ScsiPortStartPacket(IN OUT PVOID Context) -{ - PSCSI_PORT_DEVICE_EXTENSION DeviceExtension; - PIO_STACK_LOCATION IrpStack; - PSCSI_REQUEST_BLOCK Srb; - PDEVICE_OBJECT DeviceObject = (PDEVICE_OBJECT)Context; - PSCSI_PORT_LUN_EXTENSION LunExtension; - PSCSI_REQUEST_BLOCK_INFO SrbInfo; - BOOLEAN Result; - BOOLEAN StartTimer; - - DPRINT("ScsiPortStartPacket() called\n"); - - DeviceExtension = (PSCSI_PORT_DEVICE_EXTENSION)DeviceObject->DeviceExtension; - - IrpStack = IoGetCurrentIrpStackLocation(DeviceObject->CurrentIrp); - Srb = IrpStack->Parameters.Scsi.Srb; - - /* Get LUN extension */ - LunExtension = SpiGetLunExtension(DeviceExtension, - Srb->PathId, - Srb->TargetId, - Srb->Lun); - - /* Check if we are in a reset state */ - if (DeviceExtension->InterruptData.Flags & SCSI_PORT_RESET) - { - /* Mark the we've got requests while being in the reset state */ - DeviceExtension->InterruptData.Flags |= SCSI_PORT_RESET_REQUEST; - return TRUE; - } - - /* Set the time out value */ - DeviceExtension->TimerCount = Srb->TimeOutValue; - - /* We are busy */ - DeviceExtension->Flags |= SCSI_PORT_DEVICE_BUSY; - - if (LunExtension->RequestTimeout != -1) - { - /* Timer already active */ - StartTimer = FALSE; - } - else - { - /* It hasn't been initialized yet */ - LunExtension->RequestTimeout = Srb->TimeOutValue; - StartTimer = TRUE; - } - - if (Srb->SrbFlags & SRB_FLAGS_BYPASS_FROZEN_QUEUE) - { - /* Handle bypass-requests */ - - /* Is this an abort request? */ - if (Srb->Function == SRB_FUNCTION_ABORT_COMMAND) - { - /* Get pointer to SRB info structure */ - SrbInfo = SpiGetSrbData(DeviceExtension, - Srb->PathId, - Srb->TargetId, - Srb->Lun, - Srb->QueueTag); - - /* Check if the request is still "active" */ - if (SrbInfo == NULL || - SrbInfo->Srb == NULL || - !(SrbInfo->Srb->SrbFlags & SRB_FLAGS_IS_ACTIVE)) - { - /* It's not, mark it as active then */ - Srb->SrbFlags |= SRB_FLAGS_IS_ACTIVE; - - if (StartTimer) - LunExtension->RequestTimeout = -1; - - DPRINT("Request has been already completed, but abort request came\n"); - Srb->SrbStatus = SRB_STATUS_ABORT_FAILED; - - /* Notify about request complete */ - ScsiPortNotification(RequestComplete, - DeviceExtension->MiniPortDeviceExtension, - Srb); - - /* and about readiness for the next request */ - ScsiPortNotification(NextRequest, - DeviceExtension->MiniPortDeviceExtension); - - /* They might ask for some work, so queue the DPC for them */ - IoRequestDpc(DeviceExtension->DeviceObject, NULL, NULL); - - /* We're done in this branch */ - return TRUE; - } - } - else - { - /* Add number of queued requests */ - LunExtension->QueueCount++; - } - - /* Bypass requests don't need request sense */ - LunExtension->Flags &= ~LUNEX_NEED_REQUEST_SENSE; - - /* Is disconnect disabled for this request? */ - if (Srb->SrbFlags & SRB_FLAGS_DISABLE_DISCONNECT) - { - /* Set the corresponding flag */ - DeviceExtension->Flags &= ~SCSI_PORT_DISCONNECT_ALLOWED; - } - - /* Transfer timeout value from Srb to Lun */ - LunExtension->RequestTimeout = Srb->TimeOutValue; - } - else - { - if (Srb->SrbFlags & SRB_FLAGS_DISABLE_DISCONNECT) - { - /* It's a disconnect, so no more requests can go */ - DeviceExtension->Flags &= ~SCSI_PORT_DISCONNECT_ALLOWED; - } - - LunExtension->Flags |= SCSI_PORT_LU_ACTIVE; - - /* Increment queue count */ - LunExtension->QueueCount++; - - /* If it's tagged - special thing */ - if (Srb->QueueTag != SP_UNTAGGED) - { - SrbInfo = &DeviceExtension->SrbInfo[Srb->QueueTag - 1]; - - /* Chek for consistency */ - ASSERT(SrbInfo->Requests.Blink == NULL); - - /* Insert it into the list of requests */ - InsertTailList(&LunExtension->SrbInfo.Requests, &SrbInfo->Requests); - } - } - - /* Mark this Srb active */ - Srb->SrbFlags |= SRB_FLAGS_IS_ACTIVE; - - /* Call HwStartIo routine */ - Result = DeviceExtension->HwStartIo(&DeviceExtension->MiniPortDeviceExtension, - Srb); - - /* If notification is needed, then request a DPC */ - if (DeviceExtension->InterruptData.Flags & SCSI_PORT_NOTIFICATION_NEEDED) - IoRequestDpc(DeviceExtension->DeviceObject, NULL, NULL); - - return Result; -} - -IO_ALLOCATION_ACTION -NTAPI -SpiAdapterControl(PDEVICE_OBJECT DeviceObject, - PIRP Irp, - PVOID MapRegisterBase, - PVOID Context) -{ - PSCSI_REQUEST_BLOCK Srb; - PSCSI_SG_ADDRESS ScatterGatherList; - KIRQL CurrentIrql; - PIO_STACK_LOCATION IrpStack; - ULONG TotalLength = 0; - PSCSI_REQUEST_BLOCK_INFO SrbInfo; - PSCSI_PORT_DEVICE_EXTENSION DeviceExtension; - PUCHAR DataVA; - BOOLEAN WriteToDevice; - - /* Get pointers to SrbInfo and DeviceExtension */ - SrbInfo = (PSCSI_REQUEST_BLOCK_INFO)Context; - DeviceExtension = DeviceObject->DeviceExtension; - - /* Get pointer to SRB */ - IrpStack = IoGetCurrentIrpStackLocation(Irp); - Srb = (PSCSI_REQUEST_BLOCK)IrpStack->Parameters.Others.Argument1; - - /* Depending on the map registers number, we allocate - either from NonPagedPool, or from our static list */ - if (SrbInfo->NumberOfMapRegisters > MAX_SG_LIST) - { - SrbInfo->ScatterGather = ExAllocatePoolWithTag( - NonPagedPool, SrbInfo->NumberOfMapRegisters * sizeof(SCSI_SG_ADDRESS), TAG_SCSIPORT); - - if (SrbInfo->ScatterGather == NULL) - ASSERT(FALSE); - - Srb->SrbFlags |= SRB_FLAGS_SGLIST_FROM_POOL; - } - else - { - SrbInfo->ScatterGather = SrbInfo->ScatterGatherList; - } - - /* Use chosen SG list source */ - ScatterGatherList = SrbInfo->ScatterGather; - - /* Save map registers base */ - SrbInfo->BaseOfMapRegister = MapRegisterBase; - - /* Determine WriteToDevice flag */ - WriteToDevice = Srb->SrbFlags & SRB_FLAGS_DATA_OUT ? TRUE : FALSE; - - /* Get virtual address of the data buffer */ - DataVA = (PUCHAR)MmGetMdlVirtualAddress(Irp->MdlAddress) + - ((PCHAR)Srb->DataBuffer - SrbInfo->DataOffset); - - /* Build the actual SG list */ - while (TotalLength < Srb->DataTransferLength) - { - if (!ScatterGatherList) - break; - - ScatterGatherList->Length = Srb->DataTransferLength - TotalLength; - ScatterGatherList->PhysicalAddress = IoMapTransfer(DeviceExtension->AdapterObject, - Irp->MdlAddress, - MapRegisterBase, - DataVA + TotalLength, - &ScatterGatherList->Length, - WriteToDevice); - - TotalLength += ScatterGatherList->Length; - ScatterGatherList++; - } - - /* Schedule an active request */ - InterlockedIncrement(&DeviceExtension->ActiveRequestCounter ); - KeAcquireSpinLock(&DeviceExtension->SpinLock, &CurrentIrql); - KeSynchronizeExecution(DeviceExtension->Interrupt[0], - ScsiPortStartPacket, - DeviceObject); - KeReleaseSpinLock(&DeviceExtension->SpinLock, CurrentIrql); - - return DeallocateObjectKeepRegisters; -} - -static PSCSI_PORT_LUN_EXTENSION -SpiAllocateLunExtension(IN PSCSI_PORT_DEVICE_EXTENSION DeviceExtension) -{ - PSCSI_PORT_LUN_EXTENSION LunExtension; - ULONG LunExtensionSize; - - DPRINT("SpiAllocateLunExtension(%p)\n", DeviceExtension); - - /* Round LunExtensionSize first to the sizeof LONGLONG */ - LunExtensionSize = (DeviceExtension->LunExtensionSize + - sizeof(LONGLONG) - 1) & ~(sizeof(LONGLONG) - 1); - - LunExtensionSize += sizeof(SCSI_PORT_LUN_EXTENSION); - DPRINT("LunExtensionSize %lu\n", LunExtensionSize); - - LunExtension = ExAllocatePoolWithTag(NonPagedPool, LunExtensionSize, TAG_SCSIPORT); - if (LunExtension == NULL) - { - DPRINT1("Out of resources!\n"); - return NULL; - } - - /* Zero everything */ - RtlZeroMemory(LunExtension, LunExtensionSize); - - /* Initialize a list of requests */ - InitializeListHead(&LunExtension->SrbInfo.Requests); - - /* Initialize timeout counter */ - LunExtension->RequestTimeout = -1; - - /* Set maximum queue size */ - LunExtension->MaxQueueCount = 256; - - /* Initialize request queue */ - KeInitializeDeviceQueue(&LunExtension->DeviceQueue); - - return LunExtension; -} - -static PSCSI_PORT_LUN_EXTENSION -SpiGetLunExtension (IN PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, - IN UCHAR PathId, - IN UCHAR TargetId, - IN UCHAR Lun) -{ - PSCSI_PORT_LUN_EXTENSION LunExtension; - - DPRINT("SpiGetLunExtension(%p %u %u %u) called\n", - DeviceExtension, PathId, TargetId, Lun); - - /* Get appropriate list */ - LunExtension = DeviceExtension->LunExtensionList[(TargetId + Lun) % LUS_NUMBER]; - - /* Iterate it until we find what we need */ - while (LunExtension) - { - if (LunExtension->TargetId == TargetId && - LunExtension->Lun == Lun && - LunExtension->PathId == PathId) - { - /* All matches, return */ - return LunExtension; - } - - /* Advance to the next item */ - LunExtension = LunExtension->Next; - } - - /* We did not find anything */ - DPRINT("Nothing found\n"); - return NULL; -} - -static PSCSI_REQUEST_BLOCK_INFO -SpiAllocateSrbStructures(PSCSI_PORT_DEVICE_EXTENSION DeviceExtension, - PSCSI_PORT_LUN_EXTENSION LunExtension, - PSCSI_REQUEST_BLOCK Srb) -{ - PCHAR SrbExtension; - PSCSI_REQUEST_BLOCK_INFO SrbInfo; - - /* Spinlock must be held while this function executes */ - KeAcquireSpinLockAtDpcLevel(&DeviceExtension->SpinLock); - - /* Allocate SRB data structure */ - if (DeviceExtension->NeedSrbDataAlloc) - { - /* Treat the abort request in a special way */ - if (Srb->Function == SRB_FUNCTION_ABORT_COMMAND) - { - SrbInfo = SpiGetSrbData(DeviceExtension, - Srb->PathId, - Srb->TargetId, - Srb->Lun, - Srb->QueueTag); - } - else if (Srb->SrbFlags & - (SRB_FLAGS_QUEUE_ACTION_ENABLE | SRB_FLAGS_NO_QUEUE_FREEZE) && - !(Srb->SrbFlags & SRB_FLAGS_DISABLE_DISCONNECT) - ) - { - /* Do not process tagged commands if need request sense is set */ - if (LunExtension->Flags & LUNEX_NEED_REQUEST_SENSE) - { - ASSERT(!(LunExtension->Flags & LUNEX_REQUEST_PENDING)); - - LunExtension->PendingRequest = Srb->OriginalRequest; - LunExtension->Flags |= LUNEX_REQUEST_PENDING | SCSI_PORT_LU_ACTIVE; - - /* Release the spinlock and return */ - KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); - return NULL; - } - - ASSERT(LunExtension->SrbInfo.Srb == NULL); - SrbInfo = DeviceExtension->FreeSrbInfo; - - if (SrbInfo == NULL) - { - /* No SRB structures left in the list. We have to leave - and wait while we are called again */ - - DeviceExtension->Flags |= SCSI_PORT_REQUEST_PENDING; - KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); - return NULL; - } - - DeviceExtension->FreeSrbInfo = (PSCSI_REQUEST_BLOCK_INFO)SrbInfo->Requests.Flink; - - /* QueueTag must never be 0, so +1 to it */ - Srb->QueueTag = (UCHAR)(SrbInfo - DeviceExtension->SrbInfo) + 1; - } - else - { - /* Usual untagged command */ - if ( - (!IsListEmpty(&LunExtension->SrbInfo.Requests) || - LunExtension->Flags & LUNEX_NEED_REQUEST_SENSE) && - !(Srb->SrbFlags & SRB_FLAGS_BYPASS_FROZEN_QUEUE) - ) - { - /* Mark it as pending and leave */ - ASSERT(!(LunExtension->Flags & LUNEX_REQUEST_PENDING)); - LunExtension->Flags |= LUNEX_REQUEST_PENDING | SCSI_PORT_LU_ACTIVE; - LunExtension->PendingRequest = Srb->OriginalRequest; - - KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); - return(NULL); - } - - Srb->QueueTag = SP_UNTAGGED; - SrbInfo = &LunExtension->SrbInfo; - } - } - else - { - Srb->QueueTag = SP_UNTAGGED; - SrbInfo = &LunExtension->SrbInfo; - } - - /* Allocate SRB extension structure */ - if (DeviceExtension->NeedSrbExtensionAlloc) - { - /* Check the list of free extensions */ - SrbExtension = DeviceExtension->FreeSrbExtensions; - - /* If no free extensions... */ - if (SrbExtension == NULL) - { - /* Free SRB data */ - if (Srb->Function != SRB_FUNCTION_ABORT_COMMAND && - Srb->QueueTag != SP_UNTAGGED) - { - SrbInfo->Requests.Blink = NULL; - SrbInfo->Requests.Flink = (PLIST_ENTRY)DeviceExtension->FreeSrbInfo; - DeviceExtension->FreeSrbInfo = SrbInfo; - } - - /* Return, in order to be called again later */ - DeviceExtension->Flags |= SCSI_PORT_REQUEST_PENDING; - KeReleaseSpinLockFromDpcLevel(&DeviceExtension->SpinLock); - return NULL; - } - - /* Remove that free SRB extension from the list (since - we're going to use it) */ - DeviceExtension->FreeSrbExtensions = *((PVOID *)SrbExtension); ... 2187 lines suppressed ...

1 0

Jump to page:

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

Ros-diffs