From 69f8722e795b0d76b84efa4de52e199e9441fca7 Mon Sep 17 00:00:00 2001
From: mageven <62494521+mageven@users.noreply.github.com>
Date: Tue, 23 Mar 2021 00:10:07 +0530
Subject: Fix inconsistencies in progress reporting (#2129)

Signal and setup events correctly
Eliminate possible races
Use a single event
Mark volatiles and reduce scope of waithandles
Common handler
100ms -> 50ms
---
 ARMeilleure/Translation/PTC/Ptc.cs             | 57 ++++++++++++++++----------
 ARMeilleure/Translation/PTC/PtcLoadingState.cs |  9 ++++
 2 files changed, 44 insertions(+), 22 deletions(-)
 create mode 100644 ARMeilleure/Translation/PTC/PtcLoadingState.cs

(limited to 'ARMeilleure/Translation')

diff --git a/ARMeilleure/Translation/PTC/Ptc.cs b/ARMeilleure/Translation/PTC/Ptc.cs
index c931aaea..3065757d 100644
--- a/ARMeilleure/Translation/PTC/Ptc.cs
+++ b/ARMeilleure/Translation/PTC/Ptc.cs
@@ -52,14 +52,10 @@ namespace ARMeilleure.Translation.PTC
 
         private static readonly ManualResetEvent _waitEvent;
 
-        private static readonly AutoResetEvent _loggerEvent;
-
         private static readonly object _lock;
 
         private static bool _disposed;
 
-        private static volatile int _translateCount;
-
         internal static PtcJumpTable PtcJumpTable { get; private set; }
 
         internal static string TitleIdText { get; private set; }
@@ -70,9 +66,10 @@ namespace ARMeilleure.Translation.PTC
 
         internal static PtcState State { get; private set; }
 
-        // Progress update events
-        public static event Action<bool> PtcTranslationStateChanged;
-        public static event Action<int, int> PtcTranslationProgressChanged;
+        // Progress reporting helpers
+        private static volatile int _translateCount;
+        private static volatile int _translateTotalCount;
+        public static event Action<PtcLoadingState, int, int> PtcStateChanged;
 
         static Ptc()
         {
@@ -82,8 +79,6 @@ namespace ARMeilleure.Translation.PTC
 
             _waitEvent = new ManualResetEvent(true);
 
-            _loggerEvent = new AutoResetEvent(false);
-
             _lock = new object();
 
             _disposed = false;
@@ -773,10 +768,20 @@ namespace ARMeilleure.Translation.PTC
             }
 
             _translateCount = 0;
+            _translateTotalCount = profiledFuncsToTranslate.Count;
+
+            PtcStateChanged?.Invoke(PtcLoadingState.Start, _translateCount, _translateTotalCount);
 
-            ThreadPool.QueueUserWorkItem(TranslationLogger, profiledFuncsToTranslate.Count);
+            using AutoResetEvent progressReportEvent = new AutoResetEvent(false);
+
+            Thread progressReportThread = new Thread(ReportProgress)
+            {
+                Name = "Ptc.ProgressReporter",
+                Priority = ThreadPriority.Lowest,
+                IsBackground = true
+            };
 
-            PtcTranslationStateChanged?.Invoke(true);
+            progressReportThread.Start(progressReportEvent);
 
             void TranslateFuncs()
             {
@@ -825,8 +830,12 @@ namespace ARMeilleure.Translation.PTC
 
             threads.Clear();
 
-            _loggerEvent.Set();
-            PtcTranslationStateChanged?.Invoke(false);
+            progressReportEvent.Set();
+            progressReportThread.Join();
+
+            PtcStateChanged?.Invoke(PtcLoadingState.Loaded, _translateCount, _translateTotalCount);
+
+            Logger.Info?.Print(LogClass.Ptc, $"{_translateCount} of {_translateTotalCount} functions translated");
 
             PtcJumpTable.Initialize(jumpTable);
 
@@ -838,19 +847,25 @@ namespace ARMeilleure.Translation.PTC
             preSaveThread.Start();
         }
 
-        private static void TranslationLogger(object state)
+        private static void ReportProgress(object state)
         {
-            const int refreshRate = 100; // ms
+            const int refreshRate = 50; // ms
 
-            int profiledFuncsToTranslateCount = (int)state;
+            AutoResetEvent endEvent = (AutoResetEvent)state;
+
+            int count = 0;
 
             do
             {
-                PtcTranslationProgressChanged?.Invoke(_translateCount, profiledFuncsToTranslateCount);
-            }
-            while (!_loggerEvent.WaitOne(refreshRate));
+                int newCount = _translateCount;
 
-            Logger.Info?.Print(LogClass.Ptc, $"{_translateCount} of {profiledFuncsToTranslateCount} functions translated");
+                if (count != newCount)
+                {
+                    PtcStateChanged?.Invoke(PtcLoadingState.Loading, newCount, _translateTotalCount);
+                    count = newCount;
+                }
+            }
+            while (!endEvent.WaitOne(refreshRate));
         }
 
         internal static void WriteInfoCodeRelocUnwindInfo(ulong address, ulong guestSize, bool highCq, PtcInfo ptcInfo)
@@ -968,8 +983,6 @@ namespace ARMeilleure.Translation.PTC
                 Wait();
                 _waitEvent.Dispose();
 
-                _loggerEvent.Dispose();
-
                 DisposeMemoryStreams();
             }
         }
diff --git a/ARMeilleure/Translation/PTC/PtcLoadingState.cs b/ARMeilleure/Translation/PTC/PtcLoadingState.cs
new file mode 100644
index 00000000..526cf91f
--- /dev/null
+++ b/ARMeilleure/Translation/PTC/PtcLoadingState.cs
@@ -0,0 +1,9 @@
+namespace ARMeilleure.Translation.PTC
+{
+    public enum PtcLoadingState
+    {
+        Start,
+        Loading,
+        Loaded
+    }
+}
\ No newline at end of file
-- 
cgit v1.2.3