IDokanOperations2 library implementation (#374)

IDokanOperations2 library implementation

* IDokanOperations2 is a new way to implement Dokan file systems in .NET with less CPU and memory pressure.
* Includes several other minor optimizations as well.
* Existing IDokanOperation and IDokanOperationUnsafe implementations get wrapped in a compatibility layer called DokanOperationsAdapter, that in turn implements the new IDokanOperations2 interface.
* Removed "-windows" suffix from target frameworks to allow library to be consumed by applicaitons that chose between Windows and other OS implementations at runtime.
* Removed .NET Framework 4.0 from target frameworks and added 4.6 and 4.8 (last supported on Windows Vista and last supported on Windows 7).
* DokanNetMirror with IDokanOperations2. Old DokanNetMirror moved to DokanNetMirrorLegacy.
* Added some logic to keep a reference to DokanInstance and associated operations alive while file system is mounted, to avoid crashes in native code if the last reference is collected by GC.

Author: Liryna

Directory.Build.props

@@ -0,0 +1,9 @@
+<Project>
+
+  <PropertyGroup>
+    <LangVersion>latest</LangVersion>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+  
+</Project>
+

DokanNet.Tests/BufferPoolTests.cs

@@ -42,7 +42,7 @@ public void BufferPoolBasicTest()
             for (int i = 0; i < 1000; i++)
             {
                 int size = random.Next(0, 2 * MB);
-                buffer = pool.RentBuffer((uint)size, logger);
+                buffer = pool.RentBuffer(size, logger);
                 Assert.AreEqual(size, buffer.Length, "Wrong buffer size.");
                 pool.ReturnBuffer(buffer, logger);
             }

DokanNet.Tests/ContextTests.cs

@@ -24,11 +24,15 @@ public static void ClassInitialize(TestContext context)
         {
             smallData = new byte[4096];
             for (var i = 0; i < smallData.Length; ++i)
-                smallData[i] = (byte) (i%256);
+            {
+                smallData[i] = (byte)(i % 256);
+            }
 
-            largeData = new byte[5*FILE_BUFFER_SIZE + 65536];
+            largeData = new byte[5 * FILE_BUFFER_SIZE + 65536];
             for (var i = 0; i < largeData.Length; ++i)
-                largeData[i] = (byte) (i%251);
+            {
+                largeData[i] = (byte)(i % 251);
+            }
         }
 
         [ClassCleanup]
@@ -131,6 +135,11 @@ public void OpenRead_WithLargeFile_PassesContextCorrectly()
                 do
                 {
                     totalReadBytes += stream.Read(target, totalReadBytes, target.Length - totalReadBytes);
+
+                    if (totalReadBytes == 0)
+                    {
+                        throw new EndOfStreamException("Unexpected end of file");
+                    }
                 } while (totalReadBytes < largeData.Length);
             }
 
@@ -163,7 +172,7 @@ public void OpenRead_WithLargeFile_InParallel_PassesContextCorrectly()
 
                 Parallel.For(0, DokanOperationsFixture.NumberOfChunks(FILE_BUFFER_SIZE, largeData.Length), i =>
                 {
-                    var origin = i*FILE_BUFFER_SIZE;
+                    var origin = i * FILE_BUFFER_SIZE;
                     var count = Math.Min(FILE_BUFFER_SIZE, target.Length - origin);
                     lock (stream)
                     {
@@ -267,7 +276,7 @@ public void OpenWrite_WithLargeFile_InParallel_PassesContextCorrectly()
 
                 Parallel.For(0, DokanOperationsFixture.NumberOfChunks(FILE_BUFFER_SIZE, largeData.Length), i =>
                 {
-                    var origin = i*FILE_BUFFER_SIZE;
+                    var origin = i * FILE_BUFFER_SIZE;
                     var count = Math.Min(FILE_BUFFER_SIZE, largeData.Length - origin);
                     lock (stream)
                     {

DokanNet.Tests/DirectoryInfoTest.cs

@@ -219,15 +219,15 @@ public void Create_WhereTargetIsFile_CallsApiCorrectly()
             fixture.ExpectCreateFile(path.AsRootedPath(), ReadAttributesAccess, ReadWriteShare, FileMode.Open);
             fixture.ExpectGetFileInformation(path.AsRootedPath(), FileAttributes.Normal);
             fixture.ExpectOpenDirectory(DokanOperationsFixture.RootName, FileAccess.Synchronize, FileShare.None);
-            fixture.ExpectFindFiles(DokanOperationsFixture.RootName, new[]
-            {
+            fixture.ExpectFindFiles(DokanOperationsFixture.RootName,
+            [
                 new FileInformation()
                 {
                     FileName = path, Attributes = FileAttributes.Normal,
                     Length = 0,
                     CreationTime = DateTime.Today, LastWriteTime = DateTime.Today, LastAccessTime = DateTime.Today
                 }
-            });
+            ]);
             fixture.ExpectCreateDirectoryToFail(path.AsRootedPath(), DokanResult.FileExists);
 #endif
 
@@ -340,7 +340,7 @@ public void Delete_WhereRecurseIsFalse_CallsApiCorrectly()
         }
 
         public static IEnumerable<object[]> ConfigFindFilesData
-            => new object[][] { new object[] { true }, new object[] { false } };
+            => [[true], [false]];
 
         [DataTestMethod, TestCategory(TestCategories.Success), DynamicData(nameof(ConfigFindFilesData))]
         public void Delete_WhereRecurseIsTrueAndDirectoryIsNonempty_CallsApiCorrectly(bool supportsPatternSearch)
@@ -358,29 +358,30 @@ public void Delete_WhereRecurseIsTrueAndDirectoryIsNonempty_CallsApiCorrectly(bo
             fixture.ExpectOpenDirectory(path);
             if (supportsPatternSearch)
             {
-                fixture.ExpectFindFilesWithPattern(path, "*", DokanOperationsFixture.GetEmptyDirectoryDefaultFiles().Concat(new[]
-                    {
+                fixture.ExpectFindFilesWithPattern(path, "*", DokanOperationsFixture.GetEmptyDirectoryDefaultFiles().Concat(
+                    [
                         new FileInformation()
                         {
                             FileName = subFileName, Attributes = FileAttributes.Normal,
                             Length = 100,
                             CreationTime = DateTime.Today, LastWriteTime = DateTime.Today, LastAccessTime = DateTime.Today
                         }
-                    }).ToArray());
+                    ]).ToArray());
             }
             else
             {
                 fixture.ExpectFindFilesWithPatternToFail(path, "*", DokanResult.NotImplemented);
-                fixture.ExpectFindFiles(path, DokanOperationsFixture.GetEmptyDirectoryDefaultFiles().Concat(new[]
-                {
+                fixture.ExpectFindFiles(path, DokanOperationsFixture.GetEmptyDirectoryDefaultFiles().Concat(
+                [
                     new FileInformation()
                     {
                         FileName = subFileName, Attributes = FileAttributes.Normal,
                         Length = 100,
                         CreationTime = DateTime.Today, LastWriteTime = DateTime.Today, LastAccessTime = DateTime.Today
                     }
-                }).ToArray());
+                ]).ToArray());
             }
+
             fixture.ExpectCreateFile(path + subFilePath, DeleteAccess, ReadWriteShare, FileMode.Open, deleteOnClose: true);
             fixture.ExpectGetFileInformation(path + subFilePath, FileAttributes.Normal);
             fixture.ExpectDeleteFile(path + subFilePath);
@@ -418,6 +419,7 @@ public void Delete_WhereRecurseIsTrueAndDirectoryIsEmpty_CallsApiCorrectly(bool
                 fixture.ExpectFindFilesWithPatternToFail(path, "*", DokanResult.NotImplemented);
                 fixture.ExpectFindFiles(path, DokanOperationsFixture.GetEmptyDirectoryDefaultFiles());
             }
+
             fixture.ExpectOpenDirectory(path, DeleteFromDirectoryAccess);
             fixture.ExpectDeleteDirectory(path);
 #endif
@@ -939,6 +941,7 @@ public void MoveTo_WhereParentIsDirectory_CallsApiCorrectly()
                 destination = Path.Combine(fixture.DestinationDirectoryName, fixture.DestinationSubDirectoryName),
                 path = origin.AsRootedPath(),
                 destinationPath = destination.AsRootedPath();
+
 #if LOGONLY
             fixture.PermitAny();
 #else
@@ -1026,13 +1029,14 @@ public void SetAccessControl_CallsApiCorrectly(bool supportsPatternSearch)
             fixture.ExpectOpenDirectory(path.AsRootedPath(), share: FileShare.ReadWrite);
             if (supportsPatternSearch)
             {
-                fixture.ExpectFindFilesWithPattern(path.AsRootedPath(), "*", new FileInformation[0]);
+                fixture.ExpectFindFilesWithPattern(path.AsRootedPath(), "*", []);
             }
             else
             {
                 fixture.ExpectFindFilesWithPatternToFail(path.AsRootedPath(), "*", DokanResult.NotImplemented);
-                fixture.ExpectFindFiles(path.AsRootedPath(), new FileInformation[0]);
+                fixture.ExpectFindFiles(path.AsRootedPath(), []);
             }
+
             fixture.ExpectSetFileSecurity(path.AsRootedPath(), security);
             fixture.ExpectCreateFile(DokanOperationsFixture.RootName, ReadPermissionsAccess, ReadWriteShare, FileMode.Open);
             fixture.ExpectGetFileInformation(DokanOperationsFixture.RootName, FileAttributes.Directory);

DokanNet.Tests/DokanNet.Tests.csproj

@@ -15,41 +15,36 @@
     net4.6              net4.6
     netstandard1.3      <missing>
     -->
-    <TargetFrameworks>net462</TargetFrameworks>
-
+    <TargetFrameworks>net48</TargetFrameworks>
     <!--Add the Target Framework to the output file names. -->
-    <AssemblyName>$(MSBuildProjectName).$(TargetFramework)</AssemblyName>
+    <AssemblyName>$(MSBuildProjectName)</AssemblyName>
     <CLSCompliant>True</CLSCompliant>
+    <Nullable>disable</Nullable>
     <!-- We need to sign the test assembly to use it in InternalsVisibleTo for DokanNet.dll. -->
-    <SignAssembly>true</SignAssembly>
+    <SignAssembly>false</SignAssembly>
     <AssemblyOriginatorKeyFile>..\DokanNet\Dokan.snk</AssemblyOriginatorKeyFile>
   </PropertyGroup>
-
   <ItemGroup>
     <Content Include="OverlappedTests.Configuration.xml">
       <DependentUpon>OverlappedTests.cs</DependentUpon>
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
   </ItemGroup>
-
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
     <PackageReference Include="Moq" Version="4.7.1" />
-    <PackageReference Include="MSTest.TestAdapter" Version="2.2.8" />
-    <PackageReference Include="MSTest.TestFramework" Version="2.2.8" />
+    <PackageReference Include="MSTest.TestAdapter" Version="3.8.3" />
+    <PackageReference Include="MSTest.TestFramework" Version="3.8.3" />
   </ItemGroup>
-
   <ItemGroup>
     <ProjectReference Include="..\DokanNet\DokanNet.csproj" />
   </ItemGroup>
-
   <ItemGroup>
     <Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
   </ItemGroup>
-
   <PropertyGroup Condition="'$(Configuration)' == 'Release'">
     <CodeAnalysisRuleSet>DokanNet.Tests.ruleset</CodeAnalysisRuleSet>
     <!--Set to True to run Code Analysis-->
     <RunCodeAnalysis>False</RunCodeAnalysis>
   </PropertyGroup>
-</Project>
+</Project>