Merge branch 'master' into pvt-sxs

Changelog.md

@@ -1,10 +1,12 @@
 # Changelog
 
 
-## v1.12 (2023)
+## v1.12B1 (2022.2)
 
 - [NEW] A new registry setting `MountUseMountmgrFromFSD` has been added. See [WinFsp Registry Settings](https://github.com/winfsp/winfsp/wiki/WinFsp-Registry-Settings) for details.
 
+- [BUILD] Product configuration for the relative paths to the File System Driver, Network Provider and EventLog is now possible via the file `build.version.props` located in `build\VStudio`.
+
 
 ## v1.11 (2022+ARM64)
 

build/VStudio/build.common.props

@@ -3,10 +3,10 @@
     <Import Project="$(MsbuildThisFileDirectory)\build.version.props" />
     <ItemDefinitionGroup>
         <ClCompile>
-            <PreprocessorDefinitions>NTDDI_VERSION=0x06010000;_WIN32_WINNT=0x0601;MyProductName=$(MyProductName);MyProductFileName=$(MyProductFileName);MyDescription=$(MyDescription);MyCompanyName=$(MyCompanyName);MyCopyright=$(MyCopyright);MyProductVersion=$(MyProductVersion);MyProductStage=$(MyProductStage);MyVersion=$(MyVersion);MyVersionWithCommas=$(MyVersionWithCommas);MyFullVersion=$(MyFullVersion);MyFspFsctlDeviceClassGuid=$(MyFspFsctlDeviceClassGuid);MyFspFsvrtDeviceClassGuid=$(MyFspFsvrtDeviceClassGuid)</PreprocessorDefinitions>
+            <PreprocessorDefinitions>NTDDI_VERSION=0x06010000;_WIN32_WINNT=0x0601;MyProductName=$(MyProductName);MyProductFileName=$(MyProductFileName);MyDescription=$(MyDescription);MyCompanyName=$(MyCompanyName);MyCopyright=$(MyCopyright);MyProductVersion=$(MyProductVersion);MyProductStage=$(MyProductStage);MyVersion=$(MyVersion);MyVersionWithCommas=$(MyVersionWithCommas);MyFullVersion=$(MyFullVersion);MyFspFsctlDeviceClassGuid=$(MyFspFsctlDeviceClassGuid);MyFspFsvrtDeviceClassGuid=$(MyFspFsvrtDeviceClassGuid);MyFsctlRegisterPath=$(MyFsctlRegisterPath);MyNpRegisterPath=$(MyNpRegisterPath);MyEventLogRegisterPath=$(MyEventLogRegisterPath)</PreprocessorDefinitions>
         </ClCompile>
         <ResourceCompile>
-            <PreprocessorDefinitions>MyProductName=$(MyProductName);MyProductFileName=$(MyProductFileName);MyDescription=$(MyDescription);MyCompanyName=$(MyCompanyName);MyCopyright=$(MyCopyright);MyProductVersion=$(MyProductVersion);MyProductStage=$(MyProductStage);MyVersion=$(MyVersion);MyVersionWithCommas=$(MyVersionWithCommas);MyFullVersion=$(MyFullVersion);MyFspFsctlDeviceClassGuid=$(MyFspFsctlDeviceClassGuid);MyFspFsvrtDeviceClassGuid=$(MyFspFsvrtDeviceClassGuid)</PreprocessorDefinitions>
+            <PreprocessorDefinitions>MyProductName=$(MyProductName);MyProductFileName=$(MyProductFileName);MyDescription=$(MyDescription);MyCompanyName=$(MyCompanyName);MyCopyright=$(MyCopyright);MyProductVersion=$(MyProductVersion);MyProductStage=$(MyProductStage);MyVersion=$(MyVersion);MyVersionWithCommas=$(MyVersionWithCommas);MyFullVersion=$(MyFullVersion);MyFspFsctlDeviceClassGuid=$(MyFspFsctlDeviceClassGuid);MyFspFsvrtDeviceClassGuid=$(MyFspFsvrtDeviceClassGuid);MyFsctlRegisterPath=$(MyFsctlRegisterPath);MyNpRegisterPath=$(MyNpRegisterPath);MyEventLogRegisterPath=$(MyEventLogRegisterPath)</PreprocessorDefinitions>
         </ResourceCompile>
     </ItemDefinitionGroup>
     <ItemDefinitionGroup Condition="'$(IsKernelModeToolset)'=='true'">

build/VStudio/build.version.props

@@ -20,7 +20,7 @@
 
         <MyCanonicalVersion>1.12</MyCanonicalVersion>
 
-        <MyProductVersion>2023</MyProductVersion>
+        <MyProductVersion>2022.2 Beta1</MyProductVersion>
         <MyProductStage>Beta</MyProductStage>
 
         <MyCrossCert>DigiCertGlobalG3CodeSigningECCSHA3842021CA1.cer</MyCrossCert>
@@ -40,5 +40,37 @@
         <!-- When rebranding WinFsp you MUST change the following GUIDs - use VS "Create GUID" tool -->
         <MyFspFsctlDeviceClassGuid>{ 0x6f9d25fa, 0x6dee, 0x4a9d, { 0x80, 0xf5, 0xe9, 0x8e, 0x14, 0xf3, 0x5e, 0x54 } }</MyFspFsctlDeviceClassGuid>
         <MyFspFsvrtDeviceClassGuid>{ 0xb48171c3, 0xdd50, 0x4852, { 0x83, 0xa3, 0x34, 0x4c, 0x50, 0xd9, 0x3b, 0x17 } }</MyFspFsvrtDeviceClassGuid>
+
+        <!--
+            Configure paths used for registration via DllRegisterServer:
+
+            - MyFsctlRegisterPath: File System Driver registration path
+            - MyNpRegisterPath: Network Provider registration path
+            - MyEventLogRegisterPath: Event Log registration path
+
+            These paths are assumed to be relative to the location of the WinFsp DLL during
+            registration: during DLLRegisterServer the DLL uses PathCombineW to combine its own
+            location with these paths to produce the final locations to be used for registration.
+
+            For example, if the DLL location is `C:\Program Files (x86)\WinFsp\bin\winfsp-x64.dll`:
+
+            - Combining with the path "." will produce the original DLL location:
+                `C:\Program Files (x86)\WinFsp\bin\winfsp-x64.dll`
+
+            - Combining with the path "..\\NetworkProvider.dll" will produce:
+                `C:\Program Files (x86)\WinFsp\bin\NetworkProvider.dll`
+
+            - For Network Provider registrations only it is allowed to use environment variables
+            in the path. For example combining the above DLL location with the path
+            "..\\NetworkProvider-\x25PROCESSOR_ARCHITECTURE\x25.dll" will produce:
+                `C:\Program Files (x86)\WinFsp\bin\NetworkProvider-%PROCESSOR_ARCHITECTURE%.dll`
+
+            (Note that the \x25 escape sequence must be used otherwise the VS build system will
+            try to interpret the string %PROCESSOR_ARCHITECTURE% as an environment variable during
+            the build.)
+        -->
+        <MyFsctlRegisterPath>"."</MyFsctlRegisterPath>
+        <MyNpRegisterPath>"."</MyNpRegisterPath>
+        <MyEventLogRegisterPath>"."</MyEventLogRegisterPath>
     </PropertyGroup>
 </Project>

build/VStudio/winfsp_dll.vcxproj

@@ -289,7 +289,7 @@ copy /b $(OutDir)fuse3-$(MyProductFileArch).pc + %(FullPath) $(OutDir)fuse3-$(My
       <MapFileName>$(OutDir)$(TargetFileName).map</MapFileName>
       <IgnoreAllDefaultLibraries>false</IgnoreAllDefaultLibraries>
       <ModuleDefinitionFile>..\..\src\dll\library.def</ModuleDefinitionFile>
-      <AdditionalDependencies>%(AdditionalDependencies);rpcrt4.lib;credui.lib;secur32.lib;version.lib;netapi32.lib;wldap32.lib</AdditionalDependencies>
+      <AdditionalDependencies>%(AdditionalDependencies);credui.lib;netapi32.lib;rpcrt4.lib;secur32.lib;shlwapi.lib;version.lib;wldap32.lib</AdditionalDependencies>
       <StripPrivateSymbols>$(OutDir)$(TargetFileName).public.pdb</StripPrivateSymbols>
     </Link>
   </ItemDefinitionGroup>
@@ -316,7 +316,7 @@ copy /b $(OutDir)fuse3-$(MyProductFileArch).pc + %(FullPath) $(OutDir)fuse3-$(My
       <MapFileName>$(OutDir)$(TargetFileName).map</MapFileName>
       <IgnoreAllDefaultLibraries>true</IgnoreAllDefaultLibraries>
       <ModuleDefinitionFile>..\..\src\dll\library.def</ModuleDefinitionFile>
-      <AdditionalDependencies>%(AdditionalDependencies);rpcrt4.lib;credui.lib;secur32.lib;version.lib;netapi32.lib;wldap32.lib</AdditionalDependencies>
+      <AdditionalDependencies>%(AdditionalDependencies);credui.lib;netapi32.lib;rpcrt4.lib;secur32.lib;shlwapi.lib;version.lib;wldap32.lib</AdditionalDependencies>
       <StripPrivateSymbols>$(OutDir)$(TargetFileName).public.pdb</StripPrivateSymbols>
     </Link>
   </ItemDefinitionGroup>
@@ -343,7 +343,7 @@ copy /b $(OutDir)fuse3-$(MyProductFileArch).pc + %(FullPath) $(OutDir)fuse3-$(My
       <MapFileName>$(OutDir)$(TargetFileName).map</MapFileName>
       <IgnoreAllDefaultLibraries>true</IgnoreAllDefaultLibraries>
       <ModuleDefinitionFile>..\..\src\dll\library.def</ModuleDefinitionFile>
-      <AdditionalDependencies>%(AdditionalDependencies);rpcrt4.lib;credui.lib;secur32.lib;version.lib;netapi32.lib;wldap32.lib</AdditionalDependencies>
+      <AdditionalDependencies>%(AdditionalDependencies);credui.lib;netapi32.lib;rpcrt4.lib;secur32.lib;shlwapi.lib;version.lib;wldap32.lib</AdditionalDependencies>
       <StripPrivateSymbols>$(OutDir)$(TargetFileName).public.pdb</StripPrivateSymbols>
     </Link>
   </ItemDefinitionGroup>
@@ -373,7 +373,7 @@ copy /b $(OutDir)fuse3-$(MyProductFileArch).pc + %(FullPath) $(OutDir)fuse3-$(My
       <MapFileName>$(OutDir)$(TargetFileName).map</MapFileName>
       <IgnoreAllDefaultLibraries>false</IgnoreAllDefaultLibraries>
       <ModuleDefinitionFile>..\..\src\dll\library.def</ModuleDefinitionFile>
-      <AdditionalDependencies>%(AdditionalDependencies);rpcrt4.lib;credui.lib;secur32.lib;version.lib;netapi32.lib;wldap32.lib</AdditionalDependencies>
+      <AdditionalDependencies>%(AdditionalDependencies);credui.lib;netapi32.lib;rpcrt4.lib;secur32.lib;shlwapi.lib;version.lib;wldap32.lib</AdditionalDependencies>
       <StripPrivateSymbols>$(OutDir)$(TargetFileName).public.pdb</StripPrivateSymbols>
       <AdditionalOptions>/PDBALTPATH:$(TargetFileName).pdb %(AdditionalOptions)</AdditionalOptions>
     </Link>
@@ -404,7 +404,7 @@ copy /b $(OutDir)fuse3-$(MyProductFileArch).pc + %(FullPath) $(OutDir)fuse3-$(My
       <MapFileName>$(OutDir)$(TargetFileName).map</MapFileName>
       <IgnoreAllDefaultLibraries>true</IgnoreAllDefaultLibraries>
       <ModuleDefinitionFile>..\..\src\dll\library.def</ModuleDefinitionFile>
-      <AdditionalDependencies>%(AdditionalDependencies);rpcrt4.lib;credui.lib;secur32.lib;version.lib;netapi32.lib;wldap32.lib</AdditionalDependencies>
+      <AdditionalDependencies>%(AdditionalDependencies);credui.lib;netapi32.lib;rpcrt4.lib;secur32.lib;shlwapi.lib;version.lib;wldap32.lib</AdditionalDependencies>
       <StripPrivateSymbols>$(OutDir)$(TargetFileName).public.pdb</StripPrivateSymbols>
       <AdditionalOptions>/PDBALTPATH:$(TargetFileName).pdb %(AdditionalOptions)</AdditionalOptions>
     </Link>
@@ -435,7 +435,7 @@ copy /b $(OutDir)fuse3-$(MyProductFileArch).pc + %(FullPath) $(OutDir)fuse3-$(My
       <MapFileName>$(OutDir)$(TargetFileName).map</MapFileName>
       <IgnoreAllDefaultLibraries>true</IgnoreAllDefaultLibraries>
       <ModuleDefinitionFile>..\..\src\dll\library.def</ModuleDefinitionFile>
-      <AdditionalDependencies>%(AdditionalDependencies);rpcrt4.lib;credui.lib;secur32.lib;version.lib;netapi32.lib;wldap32.lib</AdditionalDependencies>
+      <AdditionalDependencies>%(AdditionalDependencies);credui.lib;netapi32.lib;rpcrt4.lib;secur32.lib;shlwapi.lib;version.lib;wldap32.lib</AdditionalDependencies>
       <StripPrivateSymbols>$(OutDir)$(TargetFileName).public.pdb</StripPrivateSymbols>
       <AdditionalOptions>/PDBALTPATH:$(TargetFileName).pdb %(AdditionalOptions)</AdditionalOptions>
     </Link>

src/dll/eventlog.c

@@ -100,9 +100,11 @@ NTSTATUS FspEventLogRegister(VOID)
     WCHAR Path[MAX_PATH];
     DWORD RegResult, DwordValue;
     HKEY RegKey;
+    NTSTATUS Result;
 
-    if (0 == GetModuleFileNameW(DllInstance, Path, MAX_PATH))
+    Result = FspGetModuleFileName(DllInstance, Path, MAX_PATH, L"" MyEventLogRegisterPath);
-        return FspNtStatusFromWin32(GetLastError());
+    if (!NT_SUCCESS(Result))
+        return Result;
 
     RegResult = RegCreateKeyExW(
         HKEY_LOCAL_MACHINE, L"SYSTEM\\CurrentControlSet\\Services\\EventLog\\Application\\" FSP_EVENTLOG_NAME,

src/dll/fsctl.c

@@ -730,8 +730,9 @@ NTSTATUS FspFsctlRegister(VOID)
 
     FspSxsAppendSuffix(DriverName, sizeof DriverName, L"" FSP_FSCTL_DRIVER_NAME);
 
-    if (0 == GetModuleFileNameW(DllInstance, DriverPath, MAX_PATH))
+    Result = FspGetModuleFileName(DllInstance, DriverPath, MAX_PATH, L"" MyFsctlRegisterPath);
-        return FspNtStatusFromWin32(GetLastError());
+    if (!NT_SUCCESS(Result))
+        return Result;
 
     Size = lstrlenW(DriverPath);
     if (4 < Size &&
@@ -745,6 +746,14 @@ NTSTATUS FspFsctlRegister(VOID)
         DriverPath[Size - 2] = L'y';
         DriverPath[Size - 1] = L's';
     }
+    else if (4 < Size &&
+        (L'.' == DriverPath[Size - 4]) &&
+        (L'S' == DriverPath[Size - 3] || L's' == DriverPath[Size - 3]) &&
+        (L'Y' == DriverPath[Size - 2] || L'y' == DriverPath[Size - 2]) &&
+        (L'S' == DriverPath[Size - 1] || L's' == DriverPath[Size - 1]) &&
+        (L'\0' == DriverPath[Size]))
+    {
+    }
     else
         /* should not happen! */
         return STATUS_NO_SUCH_DEVICE;

src/dll/library.h

@@ -94,6 +94,11 @@ ULONG FspLdapGetTrustPosixOffset(PVOID Ldap, PWSTR Context, PWSTR Domain, PWSTR
 
 PWSTR FspDiagIdent(VOID);
 NTSTATUS FspGetModuleVersion(PWSTR ModuleFileName, PUINT32 PVersion);
+NTSTATUS FspGetModuleFileName(
+    HMODULE Module,
+    PWSTR FileName,
+    ULONG Size,
+    PWSTR RelativePath);
 
 #define FspFileSystemDirectoryBufferEntryInvalid ((ULONG)-1)
 VOID FspFileSystemPeekInDirectoryBuffer(PVOID *PDirBuffer,

src/dll/np.c

@@ -1152,15 +1152,34 @@ DWORD APIENTRY NPCloseEnum(HANDLE hEnum)
 NTSTATUS FspNpRegister(VOID)
 {
     extern HINSTANCE DllInstance;
-    WCHAR ProviderPath[MAX_PATH];
+    WCHAR DllPath[MAX_PATH], ProviderPath[MAX_PATH];
+    PWSTR VersionInfoPath;
+    BOOLEAN HasPercent;
     WCHAR RegBuffer[1024];
     PWSTR P, Part;
     DWORD RegResult, RegType, RegBufferSize, RegBufferOffset;
     HKEY RegKey;
     BOOLEAN FoundProvider;
+    NTSTATUS Result;
 
-    if (0 == GetModuleFileNameW(DllInstance, ProviderPath, MAX_PATH))
+    VersionInfoPath = ProviderPath;
+    HasPercent = FALSE;
+    for (P = L"" MyNpRegisterPath; *P; P++)
+        if ('%' == *P)
+        {
+            HasPercent = TRUE;
+            break;
+        }
+    if (HasPercent)
+    {
+        VersionInfoPath = DllPath;
+        if (0 == GetModuleFileNameW(DllInstance, DllPath, MAX_PATH))
             return FspNtStatusFromWin32(GetLastError());
+    }
+
+    Result = FspGetModuleFileName(DllInstance, ProviderPath, MAX_PATH, L"" MyNpRegisterPath);
+    if (!NT_SUCCESS(Result))
+        return Result;
 
     RegResult = RegCreateKeyExW(
         HKEY_LOCAL_MACHINE, L"SYSTEM\\CurrentControlSet\\Services\\" FSP_NP_NAME,
@@ -1187,12 +1206,12 @@ NTSTATUS FspNpRegister(VOID)
         DWORD Size;
         PWSTR Description;
 
-        Size = GetFileVersionInfoSizeW(ProviderPath, &Size/*dummy*/);
+        Size = GetFileVersionInfoSizeW(VersionInfoPath, &Size/*dummy*/);
         if (0 < Size)
         {
             VersionInfo = MemAlloc(Size);
             if (0 != VersionInfo &&
-                GetFileVersionInfoW(ProviderPath, 0, Size, VersionInfo) &&
+                GetFileVersionInfoW(VersionInfoPath, 0, Size, VersionInfo) &&
                 VerQueryValueW(VersionInfo, L"\\StringFileInfo\\040904b0\\FileDescription",
                     &Description, &Size))
             {
@@ -1208,7 +1227,8 @@ NTSTATUS FspNpRegister(VOID)
         goto close_and_exit;
 
     RegResult = RegSetValueExW(RegKey,
-        L"ProviderPath", 0, REG_SZ, (PVOID)ProviderPath, (lstrlenW(ProviderPath) + 1) * sizeof(WCHAR));
+        L"ProviderPath", 0, HasPercent ? REG_EXPAND_SZ : REG_SZ,
+        (PVOID)ProviderPath, (lstrlenW(ProviderPath) + 1) * sizeof(WCHAR));
     if (ERROR_SUCCESS != RegResult)
         goto close_and_exit;
 

src/dll/util.c

@@ -21,6 +21,7 @@
 
 #include <dll/library.h>
 #include <aclapi.h>
+#include <shlwapi.h>
 
 static INIT_ONCE FspDiagIdentInitOnce = INIT_ONCE_STATIC_INIT;
 static WCHAR FspDiagIdentBuf[20] = L"UNKNOWN";
@@ -248,3 +249,33 @@ NTSTATUS FspGetModuleVersion(PWSTR ModuleFileName, PUINT32 PVersion)
 
     return STATUS_SUCCESS;
 }
+
+NTSTATUS FspGetModuleFileName(
+    HMODULE Module,
+    PWSTR FileName,
+    ULONG Size,
+    PWSTR RelativePath)
+{
+    if (MAX_PATH > Size)
+        return STATUS_BUFFER_TOO_SMALL;
+
+    if (0 != RelativePath &&
+        L'\0' != RelativePath[0] &&
+        (L'.' != RelativePath[0] || L'\0' != RelativePath[1]))
+    {
+        WCHAR Temp[MAX_PATH];
+
+        if (0 == GetModuleFileNameW(Module, Temp, MAX_PATH))
+            return FspNtStatusFromWin32(GetLastError());
+
+        if (0 == PathCombineW(FileName, Temp, RelativePath))
+            return STATUS_UNSUCCESSFUL;
+    }
+    else
+    {
+        if (0 == GetModuleFileNameW(Module, FileName, MAX_PATH))
+            return FspNtStatusFromWin32(GetLastError());
+    }
+
+    return STATUS_SUCCESS;
+}