Small performance updates for NVMe SSDs

- Added option to change file scan parallelization to actually making better use of SSD's nature of random access.
- Fixed typo and some more Launcher settings explanations.

Author: Leayal

LauncherCore/Classes/ConfigurationFile.cs

@@ -192,6 +192,20 @@ public int DownloaderConcurrentCount
             set => this.Set("pso2_downloaderconcurrentcount", value);
         }
 
+        /// <summary>The number of threads used for file scanning, </summary>
+        public int FileScannerConcurrentCount
+        {
+            get
+            {
+                if (this.TryGetRaw("pso2_filescanconcurrentlevel", out var val) && val.ValueKind == System.Text.Json.JsonValueKind.Number)
+                {
+                    return Math.Clamp((int)val.Value, 1, 16);
+                }
+                return 1;
+            }
+            set => this.Set("pso2_filescanconcurrentlevel", value);
+        }
+
         /// <summary>
         /// Simple throttle (file per second) way. Inaccurate timer but it works close enough and the off-value ain't much.
         /// </summary>

LauncherCore/Classes/PSO2/GameClientUpdater.Downloader.cs

@@ -2,24 +2,63 @@
 using Leayal.Shared;
 using System;
 using System.Collections.Concurrent;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 using System.Threading;
 using System.Threading.Tasks;
-using System.Xaml.Schema;
 
 namespace Leayal.PSO2Launcher.Core.Classes.PSO2
 {
     partial class GameClientUpdater
     {
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="collections"></param>
+        /// <param name="item">A <seealso cref="DownloadItem"/> if an item is taken from any collection, otherwise <see langword="null"/></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns><see langword="true"/> if any of the <paramref name="collections"/> are still not completed, or <see langword="false"/> if all the collections are completed and will never be able to yield any items.</returns>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        static bool TryTakeFromAnyBlockingCollection(BlockingCollection<DownloadItem>[] collections, out DownloadItem? item, CancellationToken cancellationToken)
+        {
+            // Because BlockingCollection<T>.TryTakeFromAny is still not clear enough for me.
+            int completedCount = 0, collectionCount = collections.Length;
+            for (int i = 0; i < collectionCount; i++)
+            {
+                var current = collections[i];
+                if (current == null)
+                {
+                    completedCount++;
+                }
+                else
+                {
+                    var isItemTaken = current.TryTake(out item, 0, cancellationToken);
+                    if (isItemTaken)
+                    {
+                        return true;
+                    }
+                    else
+                    {
+                        item = null;
+                        if (current.IsCompleted) completedCount++;
+                    }
+                }
+            }
+
+            item = null;
+            return (completedCount != collectionCount);
+        }
+
         [MethodImpl(MethodImplOptions.AggressiveOptimization)]
-        private async Task InnerDownloadSingleFile(int id, BlockingCollection<DownloadItem> pendingFiles, IFileCheckHashCache duhB, DownloadFinishCallback onFinished, CancellationToken cancellationToken)
+        private async Task InnerDownloadSingleFile(int id, BlockingCollection<DownloadItem>[] pendingFiles, IFileCheckHashCache duhB, DownloadFinishCallback onFinished, CancellationToken cancellationToken)
         {
             // var downloadbuffer = new byte[4096];
             // var downloadbuffer = new byte[1024 * 1024]; // Increase buffer size to 1MB due to async's overhead.
             byte[] downloadbuffer;
-            var amISnail = this.SnailMode;
+            // var amISnail = this.SnailMode;
+            const bool amISnail = false; // For not, let's not doing anything of this.
             int chunkCount;
             if (amISnail)
             {
@@ -38,12 +77,14 @@ private async Task InnerDownloadSingleFile(int id, BlockingCollection<DownloadIt
             }
             try
             {
+
                 using (var md5engine = System.Security.Cryptography.IncrementalHash.CreateHash(System.Security.Cryptography.HashAlgorithmName.MD5))
                 {
-                    // GetConsumingEnumerable() blocks the thread. No good now.
-                    while (!pendingFiles.IsCompleted && !cancellationToken.IsCancellationRequested)
+                    while (!cancellationToken.IsCancellationRequested)
                     {
-                        if (pendingFiles.TryTake(out var downloadItem))
+                        // GetConsumingEnumerable() blocks the thread. No good now.
+                        var isAllCompleted = !TryTakeFromAnyBlockingCollection(pendingFiles, out var downloadItem, cancellationToken);
+                        if (downloadItem != null)
                         {
                             if (cancellationToken.IsCancellationRequested)
                             {
@@ -306,7 +347,7 @@ private async Task InnerDownloadSingleFile(int id, BlockingCollection<DownloadIt
                         }
                         else
                         {
-                            if (pendingFiles.IsAddingCompleted)
+                            if (isAllCompleted)
                             {
                                 // Exit loop because the collection is marked as completed adding (can no longer add item into the queue).
                                 // So if we can't dequeue an item, that means there's no more work to do **for this Downloader Task**, hence stop the loop and complete this Task.

LauncherCore/Classes/PSO2/GameClientUpdater.FileScan.cs

@@ -274,7 +274,7 @@ static void TryDelEmptyBackupFolder(string path)
         }
 
         [MethodImpl(MethodImplOptions.AggressiveOptimization)]
-        private async Task InnerScanForFilesNeedToDownload(BlockingCollection<DownloadItem> pendingFiles, string dir_pso2bin, string? dir_classic_data, PSO2TweakerHashCache? tweakerHashCache, GameClientSelection selection, FileScanFlags fScanReboot, FileScanFlags fScanClassic, IFileCheckHashCache duhB, PatchListBase headacheMatterAgain, InnerDownloadQueueAddCallback onDownloadQueueAdd, CancellationToken cancellationToken)
+        private async Task InnerScanForFilesNeedToDownload(BlockingCollection<DownloadItem> pendingFiles, UglyWrapper_Obj_ScannerProgress scannerProgress, string dir_pso2bin, string? dir_classic_data, PSO2TweakerHashCache? tweakerHashCache, GameClientSelection selection, FileScanFlags fScanReboot, FileScanFlags fScanClassic, IFileCheckHashCache duhB, IReadOnlyCollection<PatchListItem> headacheMatterAgain, InnerDownloadQueueAddCallback onDownloadQueueAdd, CancellationToken cancellationToken)
         {
             if (fScanClassic == FileScanFlags.None)
             {
@@ -296,37 +296,6 @@ private async Task InnerScanForFilesNeedToDownload(BlockingCollection<DownloadIt
             }
 
             // var t_alwaysList = this.webclient.GetPatchListAlwaysAsync(patchInfoRoot, cancellationToken);
-            var tasksOfLists = new List<Task<PatchListMemory>>(4);
-            // Begin file check
-
-            /*
-            static long GetFileSize(ref FileStream fs, string filename)
-            {
-                if (fs == null)
-                {
-                    fs = OpenToScan(filename);
-                }
-                return fs.Length;
-            }
-
-            static Task<string> GetFileMD5(ref FileStream fs, MD5 hashal, string filename, in CancellationToken cancellationToken)
-            {
-                if (fs == null)
-                {
-                    fs = OpenToScan(filename);
-                }
-                hashal.Initialize();
-                return ___GetFileMD5(fs, hashal, cancellationToken);
-            }
-
-            static async Task<string> ___GetFileMD5(FileStream fs, MD5 hashal, CancellationToken cancellationToken)
-            {
-                var buffer = await hashal.ComputeHashAsync(fs, cancellationToken);
-                return Convert.ToHexString(buffer);
-            }
-            */
-
-            int processedFiles = 0;
 
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
             static bool IsHashTableFile(PatchListItem item) => (MemoryExtensions.Equals(item.GetSpanFilenameWithoutAffix(), __Filename_HashTableRelativePath, StringComparison.OrdinalIgnoreCase) || MemoryExtensions.Equals(item.GetSpanFilenameWithoutAffix(), __Filename_HashTableRelativePath.AsSpan(11), StringComparison.OrdinalIgnoreCase));
@@ -401,7 +370,7 @@ static async Task<ReadOnlyMemory<byte>> Md5ComputeHash(IncrementalHash engine, F
                 string hashBuffer = new string(char.MinValue, 32);
                 try
                 {
-                    foreach (var patchItem in headacheMatterAgain)
+                    foreach (var patchItem in ((headacheMatterAgain is BlockingCollection<PatchListItem> syncCollection) ? syncCollection.GetConsumingEnumerable() : headacheMatterAgain))
                     {
                         if (cancellationToken.IsCancellationRequested)
                         {
@@ -479,7 +448,9 @@ static async Task<ReadOnlyMemory<byte>> Md5ComputeHash(IncrementalHash engine, F
                                         }
                                     }
                                 }
-                                this.OnFileCheckReport(Interlocked.Increment(ref processedFiles));
+
+                                scannerProgress.IncreaseProgressByOne();
+                                // this.OnFileCheckReport(Interlocked.Increment(ref processedFiles));
 
                                 if (throttleWaiter != null)
                                 {
@@ -525,7 +496,8 @@ static async Task<ReadOnlyMemory<byte>> Md5ComputeHash(IncrementalHash engine, F
                                     AddItemToQueue(pendingFiles, onDownloadQueueAdd, patchItem, localFilePath, dir_pso2bin, dir_classic_data, cancellationToken);
                                 }
 
-                                this.OnFileCheckReport(Interlocked.Increment(ref processedFiles));
+                                scannerProgress.IncreaseProgressByOne();
+                                // this.OnFileCheckReport(Interlocked.Increment(ref processedFiles));
 
                                 if (throttleWaiter != null)
                                 {
@@ -633,7 +605,9 @@ static async Task<ReadOnlyMemory<byte>> Md5ComputeHash(IncrementalHash engine, F
                                         fs?.Dispose();
                                     }
                                 }
-                                this.OnFileCheckReport(Interlocked.Increment(ref processedFiles));
+
+                                scannerProgress.IncreaseProgressByOne();
+                                // this.OnFileCheckReport(Interlocked.Increment(ref processedFiles));
 
                                 if (throttleWaiter != null)
                                 {