Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[vioscsi] DriverEntry() improved tracing #1215

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[vioscsi] DriverEntry() improved tracing #1215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions vioscsi/ntddi_ver.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/*
* This file contains NTDDI_ globals
*
* Copyright (c) 2012-2024 Red Hat, Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met :
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and / or other materials provided with the distribution.
* 3. Neither the names of the copyright holders nor the names of their contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED.IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/

#ifndef ___NTDDIVER_H__
#define ___NTDDIVER_H__

// #include <sdkddkver.h>

// The following are additional definitions not found in current EWDK(s)
// at <drive:>\Program Files\Windows Kits\10\Include\10.0.<build>.0\shared\sdkddkver.h

#ifndef NTDDI_WINTHRESHOLD
#define NTDDI_WINTHRESHOLD 0x0A000000 /* ABRACADABRA_THRESHOLD */
#endif

#define NTDDI_THRESHOLD NTDDI_WINTHRESHOLD

#ifndef NTDDI_WIN10_NI
#define NTDDI_WIN10_NI 0x0A00000C // Windows 10.0.22449-22631 / Nickel / 22H2
#define NTDDI_WIN10_CU 0x0A00000D // Windows 10.0.25057-25236 / Copper / 23H1
#endif

#ifndef NTDDI_WIN11
#define NTDDI_WIN11 NTDDI_WIN10_CO
#define NTDDI_WIN11_CO NTDDI_WIN10_CO // Windows 10.0.21277-22000 / Cobalt / 21H2
#define NTDDI_WIN11_NI NTDDI_WIN10_NI // Windows 10.0.22449-22631 / Nickel / 22H2
#define NTDDI_WIN11_CU NTDDI_WIN10_CU // Windows 10.0.25057-25236 / Copper / 23H1
#endif

#ifndef NTDDI_WIN11_ZN
#define NTDDI_WIN11_ZN 0x0A00000E // Windows 10.0.25246-25398 / Zinc / 23H2
#define NTDDI_WIN11_GA 0x0A00000F // Windows 10.0.25905-25941 / Gallium / 24H1
#define NTDDI_WIN11_GE 0x0A000010 // Windows 10.0.25947-26100 / Germanium / 24H2
#endif

#ifndef NTDDI_WIN11_DT
#define NTDDI_WIN11_DT 0x0A000011 // Windows 10.0.27686-27691 / Dilithium / 25H1
#define NTDDI_WIN11_SE 0x0A000012 // Windows 10.0.27764 / Selenium / 25H2
#endif

#endif ___NTDDIVER_H__
86 changes: 84 additions & 2 deletions vioscsi/vioscsi.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,53 @@ USHORT CopyBufferToAnsiString(void *_pDest, const void *_pSrc, const char delimi
return _length;
}

const char *GetNtddiDesc()
{
switch (NTDDI_VERSION)
{
case NTDDI_WIN10:
return "NTDDI_VERSION : THRESHOLD | Windows 10.0.10240 | 1507 | Threshold 1 \n";
case NTDDI_WIN10_TH2:
return "NTDDI_VERSION : WIN10_TH2 | Windows 10.0.10586 | 1511 | Threshold 2 \n";
case NTDDI_WIN10_RS1:
return "NTDDI_VERSION : WIN10_RS1 | Windows 10.0.14393 | 1607 | Redstone 1 \n";
case NTDDI_WIN10_RS2:
return "NTDDI_VERSION : WIN10_RS2 | Windows 10.0.15063 | 1703 | Redstone 2 \n";
case NTDDI_WIN10_RS3:
return "NTDDI_VERSION : WIN10_RS3 | Windows 10.0.16299 | 1709 | Redstone 3 \n";
case NTDDI_WIN10_RS4:
return "NTDDI_VERSION : WIN10_RS4 | Windows 10.0.17134 | 1803 | Redstone 4 \n";
case NTDDI_WIN10_RS5:
return "NTDDI_VERSION : WIN10_RS5 | Windows 10.0.17763 | 1809 | Redstone 5 \n";
case NTDDI_WIN10_19H1:
return "NTDDI_VERSION : WIN10_19H1 | Windows 10.0.18362 | 19H1 | Titanium \n";
case NTDDI_WIN10_VB:
return "NTDDI_VERSION : WIN10_VB | Windows 10.0.19041 | 2004 | Vibranium \n";
case NTDDI_WIN10_MN:
return "NTDDI_VERSION : WIN10_MN | Windows 10.0.19042 | 20H2 | Manganese \n";
case NTDDI_WIN10_FE:
return "NTDDI_VERSION : WIN10_FE | Windows 10.0.19043 | 21H1 | Iron \n";
case NTDDI_WIN10_CO:
return "NTDDI_VERSION : WIN10_CO | Windows 10.0.19044-22000 | 21H2 | Cobalt \n";
case NTDDI_WIN10_NI:
return "NTDDI_VERSION : WIN10_NI | Windows 10.0.22449-22631 | 22H2 | Nickel \n";
case NTDDI_WIN10_CU:
return "NTDDI_VERSION : WIN10_CU | Windows 10.0.25057-25236 | 23H1 | Copper \n";
case NTDDI_WIN11_ZN:
return "NTDDI_VERSION : WIN11_ZN | Windows 10.0.25246-25398 | 23H2 | Zinc \n";
case NTDDI_WIN11_GA:
return "NTDDI_VERSION : WIN11_GA | Windows 10.0.25905-25941 | 24H1 | Gallium \n";
case NTDDI_WIN11_GE:
return "NTDDI_VERSION : WIN11_GE | Windows 10.0.25947-26100 | 24H2 | Germanium \n";
case NTDDI_WIN11_DT:
return "NTDDI_VERSION : WIN11_DT | Windows 10.0.27686-27691 | 25H1 | Dilithium \n";
case NTDDI_WIN11_SE:
return "NTDDI_VERSION : WIN11_SE | Windows 10.0.27764 | 25H2 | Selenium \n";
default:
return "UNKNOWN";
}
}

BOOLEAN VioScsiReadRegistryParameter(IN PVOID DeviceExtension, IN PUCHAR ValueName, IN LONG offset)
{
BOOLEAN Ret = FALSE;
Expand Down Expand Up @@ -257,6 +304,8 @@ DriverEntry(IN PVOID DriverObject, IN PVOID RegistryPath)

HW_INITIALIZATION_DATA hwInitData;
ULONG initResult;
ANSI_STRING aRegistryPath;
NTSTATUS u2a_status;

#ifdef EVENT_TRACING
STORAGE_TRACE_INIT_INFO initInfo;
Expand All @@ -265,11 +314,22 @@ DriverEntry(IN PVOID DriverObject, IN PVOID RegistryPath)
InitializeDebugPrints((PDRIVER_OBJECT)DriverObject, (PUNICODE_STRING)RegistryPath);

IsCrashDumpMode = FALSE;
RhelDbgPrint(TRACE_LEVEL_FATAL, " Vioscsi driver started...built on %s %s\n", __DATE__, __TIME__);
#if !defined(RUN_UNCHECKED)
RhelDbgPrint(TRACE_LEVEL_FATAL, " VIOSCSI driver started...built on %s %s\n", __DATE__, __TIME__);
memset(&aRegistryPath, 0, sizeof(aRegistryPath));
u2a_status = RtlUnicodeStringToAnsiString(&aRegistryPath, RegistryPath, TRUE);
if (u2a_status == STATUS_SUCCESS)
{
RhelDbgPrint(TRACE_LEVEL_VERBOSE, " RegistryPath : %s \n", aRegistryPath.Buffer);
RtlFreeAnsiString(&aRegistryPath);
}
#endif
if (RegistryPath == NULL)
{
IsCrashDumpMode = TRUE;
#if !defined(RUN_UNCHECKED)
RhelDbgPrint(TRACE_LEVEL_INFORMATION, " Crash dump mode\n");
#endif
}

RtlZeroMemory(&hwInitData, sizeof(HW_INITIALIZATION_DATA));
Expand Down Expand Up @@ -325,8 +385,30 @@ DriverEntry(IN PVOID DriverObject, IN PVOID RegistryPath)
}
#endif

RhelDbgPrint(TRACE_LEVEL_VERBOSE, " Initialize returned 0x%x\n", initResult);
#if !defined(RUN_UNCHECKED)
RhelDbgPrint(TRACE_LEVEL_NONE, " VIOSCSI driver starting...");
RhelDbgPrint(TRACE_LEVEL_NONE, " Built on %s at %s \n", __DATE__, __TIME__);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, why not to print this alway?
This is not a "performance path," and it is degrading existing behavior.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mechanism provides a means to run without WPP which can result in an approx. 80-100 μs latency improvement and an increase of 20-50k IOPS for 4KiB random I/O (with 32 queues, 16 threads on 4KiB segments). When WPP is turned off, these macros stop compile-time errors when building.

The mechanism is also quite useful during development to help determine the overhead of various tracing changes.

memset(&aRegistryPath, 0, sizeof(aRegistryPath));
u2a_status = RtlUnicodeStringToAnsiString(&aRegistryPath, RegistryPath, TRUE);
if (u2a_status == STATUS_SUCCESS)
{
RhelDbgPrint(TRACE_LEVEL_VERBOSE, " RegistryPath : %s \n", aRegistryPath.Buffer);
RtlFreeAnsiString(&aRegistryPath);
}
RhelDbgPrint(TRACE_LEVEL_INFORMATION,
" Crash dump mode : %s \n",
(IsCrashDumpMode) ? "ACTIVATED" : "NOT ACTIVATED");
RhelDbgPrint(TRACE_LEVEL_VERBOSE, " StorPortInitialize() returned : 0x%x (%lu) \n", initResult, initResult);

if (strcmp(GetNtddiDesc(), "UNKNOWN") == 0)
{
RhelDbgPrint(TRACE_LEVEL_VERBOSE, " NTDDI_VERSION : 0x%x \n", NTDDI_VERSION);
}
else
{
RhelDbgPrint(TRACE_LEVEL_VERBOSE, " %s", GetNtddiDesc());
}
#endif
return initResult;
}

Expand Down
9 changes: 3 additions & 6 deletions vioscsi/vioscsi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,15 @@
#include "scsiwmi.h"

#include "osdep.h"
#include "ntddi_ver.h"
#include "virtio_pci.h"
#include "virtio.h"
#include "virtio_ring.h"

typedef struct VirtIOBufferDescriptor VIO_SG, *PVIO_SG;

#define VIRTIO_SCSI_CDB_SIZE 32
#define VIRTIO_SCSI_SENSE_SIZE 96

#ifndef NTDDI_WINTHRESHOLD
#define NTDDI_WINTHRESHOLD 0x0A000000 /* ABRACADABRA_THRESHOLD */
#endif
#define VIRTIO_SCSI_CDB_SIZE 32
#define VIRTIO_SCSI_SENSE_SIZE 96

#define PHYS_SEGMENTS 32
#define MAX_PHYS_SEGMENTS 512
Expand Down