moved driver name to GetDebugviewDriverLocation and silently fail if driver can't be deleted

Author: Jan Wilmans

CMakeLists.txt

@@ -61,7 +61,7 @@ target_link_options(msvc_gui_link_options INTERFACE /SUBSYSTEM:WINDOWS /NOLOGO /
 target_link_options(msvc_console_link_options INTERFACE /SUBSYSTEM:CONSOLE /NOLOGO /RELEASE)
 
 # warnings (the project picked up a bunch of unresolved warnings with migrating to new VS versions and when {fmt} was added, work in progress...)
-target_compile_options(project_compile_options INTERFACE /W4 /w14242 /w14254 /w14263 /w14265 /w14287 /w14289 /w14296 /w14311 /w14545 /w14546 /w14547 /w14549 /w14555 /w14640 /w14826 /w14905 /w14906 /w14928)
+target_compile_options(project_compile_options INTERFACE /W4 /w14242 /w14254 /w14263 /w14265 /w14287 /w14289 /w14296 /w14311 /w14545 /w14546 /w14547 /w14549 /w14555 /w14640 /w14826 /w14905 /w14906 /w14928 /we4715)
 
 add_library(project::definitions ALIAS project_definitions)
 add_library(project::compile_features ALIAS project_compile_features)

application/DebugViewpp/DebugView++.cpp

@@ -22,8 +22,6 @@
 #include "crashpad.h"
 #endif
 
-//#define CONSOLE_DEBUG
-
 CAppModule _Module;
 
 namespace fusion {

application/DebugViewpp/MainFrame.cpp

@@ -7,6 +7,8 @@
 #include <filesystem>
 #include <optional>
 #include <iostream>
+#include <format>
+#include <cstdio>
 
 #include <boost/optional.hpp>
 #include <boost/algorithm/string.hpp>
@@ -1474,15 +1476,15 @@ void CMainFrame::Resume()
         {
             m_pKernelReader = m_logSources.AddKernelReader();
         }
-        catch (std::exception&)
+        catch (std::exception& e)
         {
-            MessageBox(L"Unable to capture Kernel Messages.\n"
-                       L"\n"
-                       L"Make sure you have appropriate permissions.\n"
-                       L"\n"
-                       L"You may need to start this application by right-clicking it and selecting\n"
-                       L"'Run As Administator' even if you have administrator rights.",
-                m_applicationName.c_str(), MB_ICONERROR | MB_OK);
+            const auto message = std::format("Unable to capture Kernel Messages.\n"
+                       "({})\n\n"
+                       "Make sure you have appropriate permissions.\n"
+                       "\n"
+                       "You may need to start this application by right-clicking it and selecting\n"
+                       "'Run As Administator' even if you have administrator rights.", e.what());
+            MessageBox(WStr(message), m_applicationName.c_str(), MB_ICONERROR | MB_OK);
             m_tryKernel = false;
         }
     }
@@ -1517,11 +1519,9 @@ void CMainFrame::OnLogGlobal(UINT /*uNotifyCode*/, int /*nID*/, CWindow /*wndCtl
     UpdateTitle();
 }
 
-static const auto driver_name = "C:\\Windows\\System32\\drivers\\dbgvpp.sys";
-
-void WriteDriverFromResource()
+void CMainFrame::WriteDriverFromResource()
 {
-    if (std::filesystem::exists(driver_name))
+    if (std::filesystem::exists(m_driverLocation))
     {
         return;
     }
@@ -1535,18 +1535,18 @@ void WriteDriverFromResource()
             void* pLockedRes = LockResource(hLoadedRes);
             if (pLockedRes)
             {
-                std::cout << "write to " << driver_name << "\n";
-                std::ofstream outFile(driver_name, std::ios::binary);
+                std::ofstream outFile(m_driverLocation.c_str(), std::ios::binary);
                 outFile.write(static_cast<const char*>(pLockedRes), dwSize);
                 outFile.close();
             }
         }
     }
 }
 
-void RemoveDriver()
+void CMainFrame::RemoveDriver()
 {
-    std::filesystem::remove(driver_name);
+    // can fail silently
+    std::remove(m_driverLocation.c_str());
 }
 
 void CMainFrame::OnLogKernel(UINT /*uNotifyCode*/, int /*nID*/, CWindow /*wndCtl*/)

application/DebugViewpp/MainFrame.h

@@ -204,6 +204,9 @@ class CMainFrame : public CTabbedFrameImpl<CMainFrame, CDotNetTabCtrl<SelectedTa
     void AddLogSource(const SourceInfo& info);
     void CloseView(int i);
 
+    void WriteDriverFromResource();
+    void RemoveDriver();
+
     CCommandBarCtrl m_cmdBar;
     CMultiPaneStatusBarCtrl m_statusBar;
 
@@ -237,6 +240,7 @@ class CMainFrame : public CTabbedFrameImpl<CMainFrame, CDotNetTabCtrl<SelectedTa
     Win32::Handle m_httpMonitorHandle;
     std::deque<Lines> m_incomingMessages;
     int m_showCmd = SW_SHOWDEFAULT;
+    std::string m_driverLocation = GetDebugviewDriverLocation();
 };
 
 } // namespace debugviewpp

application/DebugViewpp/version.h

@@ -1,2 +1,2 @@
-#define VERSION 1,9,0,64 
-#define VERSION_STR "1.9.0.64" 
+#define VERSION 1,9,0,65 
+#define VERSION_STR "1.9.0.65" 

application/DebugViewpp/version.wxi

@@ -3,6 +3,6 @@
     <?define ProductVersion.Major="1" ?> 
     <?define ProductVersion.Minor="9" ?> 
     <?define ProductVersion.Revision="0" ?> 
-    <?define ProductVersion.Build="64" ?> 
-    <?define ProductVersion="1.9.0.64" ?> 
+    <?define ProductVersion.Build="65" ?> 
+    <?define ProductVersion="1.9.0.65" ?> 
 </Include> 

application/DebugViewppLib/Debugview_kernel_client.cpp

@@ -68,7 +68,7 @@ bool StopDriverSvc()
     return true;
 }
 
-void InstallKernelMessagesDriver()
+void InstallKernelMessagesDriver(const std::string& driverLocation)
 {
     // try to uninstall first, in case the driver is somehow still loaded.
     UninstallKernelMessagesDriver();
@@ -90,7 +90,7 @@ void InstallKernelMessagesDriver()
         SERVICE_KERNEL_DRIVER,
         SERVICE_DEMAND_START,
         SERVICE_ERROR_NORMAL,
-        driverPath.c_str(),
+        driverLocation.c_str(),
         NULL, NULL, NULL, NULL, NULL
     );
 

application/DebugViewppLib/KernelReader.cpp

@@ -9,9 +9,28 @@
 #include "DebugViewppLib/LineBuffer.h"
 #include "DebugViewppLib/Debugview_kernel_client.h"
 
+#include <filesystem>
+#include <format>
 namespace fusion {
 namespace debugviewpp {
 
+std::string GetDebugviewDriverLocation()
+{
+    const auto driver_name = "dbgvpp.sys";
+    // this has issues, because there could already be an existing file
+    // in that case we would load a possibly different driver verion?
+    // an we also do not seem to be able to (always?) remove it ?
+    // windows something reports it is 'in-use' even through we unloaded it.
+
+    std::filesystem::path driverLocation = driver_name;
+    const auto systemRoot = std::getenv("SystemRoot");
+    if (systemRoot != nullptr)
+    {
+        driverLocation = std::format("{}\\System32\\driver\\{}", systemRoot, driver_name);
+    }
+    return driverLocation.string();
+}
+
 void KernelReader::StartListening()
 {
     Win32::Handle handle(::CreateFile(strDbgviewKernelDriverDeviceName,
@@ -56,7 +75,7 @@ KernelReader::KernelReader(Timer& timer, ILineBuffer& linebuffer) :
     PolledLogSource(timer, SourceType::Pipe, linebuffer, 1)
 {
     SetDescription(L"Kernel Message Reader");
-    InstallKernelMessagesDriver();
+    InstallKernelMessagesDriver(GetDebugviewDriverLocation());
     Signal();
     StartListening();
     StartThread();

application/include/DebugViewppLib/Debugview_kernel_client.h

@@ -5,9 +5,6 @@
 
 #pragma once
 
-void InstallKernelMessagesDriver();
-void UninstallKernelMessagesDriver();
-
 #include <windows.h>
 #include <tchar.h>
 #include <winioctl.h>
@@ -69,3 +66,5 @@ typedef struct
 constexpr const wchar_t * strDbgviewKernelDriverDeviceName = L"\\\\.\\dbgv";
 constexpr const DWORD kernelMessageBufferSize = 0x10000;
 
+void InstallKernelMessagesDriver(const std::string& driverLocation);
+void UninstallKernelMessagesDriver();

application/include/DebugViewppLib/KernelReader.h

@@ -15,6 +15,8 @@
 namespace fusion {
 namespace debugviewpp {
 
+std::string GetDebugviewDriverLocation();
+
 class ILineBuffer;
 
 class KernelReader : public PolledLogSource