ZC v791 : Enabled ETL tracing and minor bug fixes

Author: sraman4

DVInstaller.ps1

@@ -42,7 +42,17 @@ else {
 	Write-Host "Start Zerocopy Driver installation..."
 	pnputil.exe /add-driver .\DVServer\DVServerKMD.inf /install
 
-	Timeout /T 10
+	Write-Host "Checking DVServer loaded successfully..."
+	while($true){
+		$count= (Get-Process WUDFHost | select -ExpandProperty modules | group -Property FileName | select name | Select-String -Pattern 'dvserver.dll' -AllMatches).matches.count
+		if ($count -eq 1) {
+			break
+		}
+		else{
+			continue
+		}
+	}
+	
 	Write-Host "Running DVEnabler..."
 	& ".\DVEnabler.exe"
 	if ($LASTEXITCODE -eq 0) {

DVServerKMD/DVServerKMD.vcxproj

@@ -19,6 +19,7 @@
     <ClCompile Include="Device.cpp" />
     <ClCompile Include="Driver.cpp" />
     <ClCompile Include="Queue.cpp" />
+    <ClCompile Include="Tracing.cpp" />
     <ClCompile Include="viogpulite.cpp" />
     <ClCompile Include="viogpu_idr.cpp" />
     <ClCompile Include="viogpu_pci.cpp" />
@@ -27,7 +28,6 @@
   <ItemGroup>
     <ClInclude Include="baseobj.h" />
     <ClInclude Include="bitops.h" />
-    <ClInclude Include="debug.h" />
     <ClInclude Include="Device.h" />
     <ClInclude Include="Driver.h" />
     <ClInclude Include="edid.h" />
@@ -92,7 +92,7 @@
     <ClCompile>
       <WppEnabled>true</WppEnabled>
       <WppRecorderEnabled>true</WppRecorderEnabled>
-      <WppScanConfigurationData Condition="'%(ClCompile.ScanConfigurationData)' == ''">trace.h</WppScanConfigurationData>
+      <WppScanConfigurationData Condition="'%(ClCompile.ScanConfigurationData)' == ''">Trace.h</WppScanConfigurationData>
       <WppKernelMode>true</WppKernelMode>
       <AdditionalIncludeDirectories>C:\Program Files %28x86%29\Windows Kits\10\Include\10.0.19041.0\um;C:\Program Files %28x86%29\Windows Kits\10\Include\10.0.19041.0\km;..\VirtIO;..\EDIDParser;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
       <PreprocessorDefinitions>_WIN64;_AMD64_;AMD64;%(PreprocessorDefinitions);__DEBUG</PreprocessorDefinitions>

DVServerKMD/DVServerKMD.vcxproj.filters

@@ -72,9 +72,6 @@
     <ClInclude Include="edid.h">
       <Filter>Header Files</Filter>
     </ClInclude>
-    <ClInclude Include="debug.h">
-      <Filter>Header Files</Filter>
-    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="baseobj.cpp">
@@ -104,6 +101,9 @@
     <ClCompile Include="viogpulite.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="Tracing.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <Text Include="DVServerKMD_Version.txt" />

DVServerKMD/DVServerKMD_Version.txt

@@ -8,4 +8,4 @@
 ;   This file will have the DVServerKMD version 
 ;--------------------------------------------------------------------------*/
 
-DVServerKMD_Version = 3.3.0
+DVServerKMD_Version = 3.4.0

DVServerKMD/Device.cpp

@@ -15,9 +15,10 @@ Module Name:
 --*/
 
 #include "driver.h"
-#include "debug.h"
 #include "baseobj.h"
 #include "viogpulite.h"
+#include "Trace.h"
+#include <Device.tmh>
 
 #ifdef ALLOC_PRAGMA
 #pragma alloc_text (PAGE, DVServerKMDCreateDevice)
@@ -234,10 +235,13 @@ Return Value:
 --*/
 {
     NTSTATUS status = STATUS_SUCCESS;
+    PDEVICE_CONTEXT pDeviceContext;
     TRACING();
     UNREFERENCED_PARAMETER(Device);
     UNREFERENCED_PARAMETER(ResourcesTranslated);
 
+    pDeviceContext = DeviceGetContext(Device);
+    delete (VioGpuAdapterLite*)pDeviceContext->pvDeviceExtension;
     return status;
 }
 

DVServerKMD/Driver.cpp

@@ -15,7 +15,8 @@ Module Name:
 --*/
 
 #include "driver.h"
-#include "debug.h"
+#include "Trace.h"
+#include <Driver.tmh>
 extern "C" {
 #include "kdebugprint.h"
     tDebugPrintFunc VirtioDebugPrintProc;
@@ -35,8 +36,11 @@ char module_name[80] = "KMD";
 #pragma alloc_text (PAGE, DVServerKMDEvtReleaseHardware)
 #pragma alloc_text (PAGE, DVServerKMDEvtD0Entry)
 #pragma alloc_text (PAGE, DVServerKMDEvtD0Exit)
+#pragma alloc_text (PAGE, DVServerKMDEvtDriverUnload)
 #endif
 
+
+
 NTSTATUS
 DriverEntry(
     _In_ PDRIVER_OBJECT  DriverObject,
@@ -71,7 +75,7 @@ Return Value:
     WDF_DRIVER_CONFIG config;
     NTSTATUS status;
     WDF_OBJECT_ATTRIBUTES attributes;
-    TRACING();
+    
     //
     // Initialize WPP Tracing
     //
@@ -81,11 +85,14 @@ Return Value:
     //
     WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
     attributes.EvtCleanupCallback = DVServerKMDEvtDriverContextCleanup;
+    
+    WPP_INIT_TRACING(DriverObject, RegistryPath);
+    TRACING();
 
     WDF_DRIVER_CONFIG_INIT(&config,
                            DVServerKMDEvtDeviceAdd
                            );
-
+    config.EvtDriverUnload = DVServerKMDEvtDriverUnload;
     status = WdfDriverCreate(DriverObject,
                              RegistryPath,
                              &attributes,
@@ -94,12 +101,37 @@ Return Value:
                              );
 
     if (!NT_SUCCESS(status)) {
-	    return status;
+        WPP_CLEANUP(DriverObject);
+        return status;
     }
-    
+
     return status;
 }
 
+VOID
+DVServerKMDEvtDriverUnload(
+    _In_ WDFDRIVER driver
+)
+/*++
+Routine Description:
+
+    OnDriverUnload is called by the framework when the driver unloads.
+
+Arguments:
+
+    Driver - Handle to a framework driver object created in DriverEntry.
+
+Return Value:
+
+    void
+
+--*/
+{
+    WPP_CLEANUP(WdfDriverWdmGetDriverObject(driver));
+
+    return;
+}
+
 NTSTATUS
 DVServerKMDEvtDeviceAdd(
     _In_    WDFDRIVER       Driver,
@@ -192,4 +224,4 @@ Return Value:
 
     PAGED_CODE();
     TRACING();
- }
+}

DVServerKMD/Driver.h

@@ -31,6 +31,7 @@ EXTERN_C_START
 DRIVER_INITIALIZE DriverEntry;
 EVT_WDF_DRIVER_DEVICE_ADD DVServerKMDEvtDeviceAdd;
 EVT_WDF_OBJECT_CONTEXT_CLEANUP DVServerKMDEvtDriverContextCleanup;
+EVT_WDF_DRIVER_UNLOAD DVServerKMDEvtDriverUnload;
 
 #define ENABLE_FRAME_TRACE
 #define ENABLE_CURSOR_TRACE

DVServerKMD/Queue.cpp

@@ -22,8 +22,8 @@ Module Name:
 #include "viogpulite.h"
 #include "Public.h"
 #include "edid.h"
-#include "debug.h"
-
+#include "Trace.h"
+#include <Queue.tmh>
 extern "C" {
 #include "..\EDIDParser\edidshared.h"
 }

DVServerKMD/Trace.h

@@ -1,62 +1,50 @@
-/*++
+#pragma once
 
-Module Name:
+#define WPP_CONTROL_GUIDS WPP_DEFINE_CONTROL_GUID(DVserverKMDGuid, (DB7C7BAE, 6D56, 4DF0, 8807, 48F2FB30E3D1), \
+									 WPP_DEFINE_BIT(verbose) \
+									 WPP_DEFINE_BIT(information) \
+									 WPP_DEFINE_BIT(error) \
+									 WPP_DEFINE_BIT(ftrace) \
+									 WPP_DEFINE_BIT(warning))
 
-    Trace.h
-
-Abstract:
-
-    Header file for the debug tracing related function defintions and macros.
-
-Environment:
-
-    Kernel mode
-
---*/
-
-//
-// Define the tracing flags.
-//
-// Tracing GUID - a2893be8-687f-4adc-9b03-46e5114d0a1e
-//
-
-#define WPP_CONTROL_GUIDS                                              \
-    WPP_DEFINE_CONTROL_GUID(                                           \
-        DVServerKMDTraceGuid, (a2893be8,687f,4adc,9b03,46e5114d0a1e), \
-                                                                            \
-        WPP_DEFINE_BIT(MYDRIVER_ALL_INFO)                              \
-        WPP_DEFINE_BIT(TRACE_DRIVER)                                   \
-        WPP_DEFINE_BIT(TRACE_DEVICE)                                   \
-        WPP_DEFINE_BIT(TRACE_QUEUE)                                    \
-        )                             
-
-#define WPP_FLAG_LEVEL_LOGGER(flag, level)                                  \
+#define WPP_FLAG_LEVEL_LOGGER(flag, level)                             \
     WPP_LEVEL_LOGGER(flag)
 
-#define WPP_FLAG_LEVEL_ENABLED(flag, level)                                 \
-    (WPP_LEVEL_ENABLED(flag) &&                                             \
+#define WPP_FLAG_LEVEL_ENABLED(flag, level)                            \
+    (WPP_LEVEL_ENABLED(flag) &&                                        \
      WPP_CONTROL(WPP_BIT_ ## flag).Level >= level)
 
-#define WPP_LEVEL_FLAGS_LOGGER(lvl,flags) \
+#define WPP_LEVEL_FLAGS_LOGGER(lvl,flags)                              \
            WPP_LEVEL_LOGGER(flags)
-               
-#define WPP_LEVEL_FLAGS_ENABLED(lvl, flags) \
+
+#define WPP_LEVEL_FLAGS_ENABLED(lvl, flags)                            \
            (WPP_LEVEL_ENABLED(flags) && WPP_CONTROL(WPP_BIT_ ## flags).Level >= lvl)
 
-//           
-// WPP orders static parameters before dynamic parameters. To support the Trace function
-// defined below which sets FLAGS=MYDRIVER_ALL_INFO, a custom macro must be defined to
-// reorder the arguments to what the .tpl configuration file expects.
-//
-#define WPP_RECORDER_FLAGS_LEVEL_ARGS(flags, lvl) WPP_RECORDER_LEVEL_FLAGS_ARGS(lvl, flags)
-#define WPP_RECORDER_FLAGS_LEVEL_FILTER(flags, lvl) WPP_RECORDER_LEVEL_FLAGS_FILTER(lvl, flags)
+
+class tracer {
+private:
+	char* m_func_name;
+public:
+	tracer(const char* func_name);
+	~tracer();
+};
+#define TRACING() tracer trace(__FUNCTION__)
 
 //
 // This comment block is scanned by the trace preprocessor to define our
 // Trace function.
 //
 // begin_wpp config
-// FUNC Trace{FLAGS=MYDRIVER_ALL_INFO}(LEVEL, MSG, ...);
-// FUNC TraceEvents(LEVEL, FLAGS, MSG, ...);
+// FUNC ERR{LEVEL=TRACE_LEVEL_ERROR,FLAGS=error}(MSG,...);
+// FUNC WARN{LEVEL=TRACE_LEVEL_WARNING,FLAGS=warning}(MSG,...);
+// FUNC WARNING{LEVEL=TRACE_LEVEL_WARNING,FLAGS=warning}(MSG,...);
+// FUNC INFO{LEVEL=TRACE_LEVEL_INFORMATION,FLAGS=information}(MSG,...);
+// FUNC DBGPRINT{LEVEL=TRACE_LEVEL_INFORMATION,FLAGS=verbose}(MSG,...);
+// FUNC FuncTrace{LEVEL=TRACE_LEVEL_INFORMATION,FLAGS=ftrace}(MSG, ...);
+// USEPREFIX(ERR, "%!STDPREFIX! [%!FUNC!:%!LINE!] [ERR] \t");
+// USEPREFIX(WARN, "%!STDPREFIX! [%!FUNC!:%!LINE!] [WARN] \t");
+// USEPREFIX(WARNING, "%!STDPREFIX! [%!FUNC!:%!LINE!] [WARN] \t");
+// USEPREFIX(DBGPRINT, "%!STDPREFIX! [%!FUNC!:%!LINE!] [DBG] \t");
+// USEPREFIX(INFO, "%!STDPREFIX! [%!FUNC!:%!LINE!] [INFO] \t");
 // end_wpp
-//
+

DVServerKMD/Tracing.cpp

@@ -0,0 +1,54 @@
+/*++
+*
+* Copyright (C) 2021 Intel Corporation
+* SPDX-License-Identifier: MS-PL
+
+Module Name:
+
+    Tracing.cpp
+
+Abstract:
+
+    This file contains the function tracing entry and exits.
+
+Environment:
+
+    Kernel-mode Driver Framework
+
+--*/
+#include "Driver.h"
+#include "Trace.h"
+#include "tracing.tmh"
+
+
+/*******************************************************************************
+*
+* Description
+*
+* tracer is a constructor member function of the class tracer called to mark the entry of the function.
+*
+* Parameters
+*   func_name - Function name.
+*
+*
+******************************************************************************/
+tracer::tracer(const char* func_name)
+{
+    FuncTrace(">>> %s\n", func_name);
+    m_func_name = (char*)func_name;
+}
+/*******************************************************************************
+*
+* Description
+*
+* tracer is a destructor member function of the class tracer called to mark exit of the function.
+*
+* Parameters
+*   func_name - Function name.
+*
+*
+******************************************************************************/
+tracer::~tracer()
+{
+    FuncTrace("<<< %s\n", m_func_name);
+}