Improvements in profiler host processors (#3114)

***NO_CI***

(cherry picked from commit 4d74775)

Author: josesimoes

targets/netcore/nanoFramework.nanoCLR.Host/NanoClrHostBuilder.cs

@@ -143,6 +143,7 @@ public nanoCLRHost Build()
             s_nanoClrHost.WireProtocolPort = _wireProtocolPort;
             s_nanoClrHost.ConfigureSteps.AddRange(_configureSteps);
             s_nanoClrHost.PreInitConfigureSteps.AddRange(_preInitConfigureSteps);
+            s_nanoClrHost.CleanupSteps.AddRange(_cleanupSteps);
 
             s_nanoClrHost.nanoCLRSettings = new nanoCLRSettings
             {

targets/netcore/nanoFramework.nanoCLR.Host/Profiler/ProfilerLogFileProcessor.cs

@@ -13,26 +13,28 @@ namespace nanoFramework.nanoCLR.Host.Profiler
     internal class ProfilerLogFileProcessor : IDisposable
     {
         private readonly StreamWriter _profilerDumpWriter;
+        private readonly string _logFilePath;
+        private bool _disposedValue;
 
         public ProfilerLogFileProcessor()
         {
             // create output file for profiler binary dump
             string _profileBinaryFileName = $"{Guid.NewGuid()}_{DateTime.Now.ToString("s").Replace(":", "_")}.log";
 
-            string logFilePath = Path.Combine(Path.GetTempPath(), _profileBinaryFileName);
+            _logFilePath = Path.Combine(Path.GetTempPath(), _profileBinaryFileName);
 
             // inform user about the binary file
-            Console.WriteLine($"Profiler log file: {logFilePath}");
+            Console.WriteLine($"{Environment.NewLine}Profiler log file: {_logFilePath}{Environment.NewLine}");
 
             try
             {
                 _profilerDumpWriter = new StreamWriter(
-                    logFilePath,
+                    _logFilePath,
                     new FileStreamOptions() { Mode = FileMode.Create, Access = FileAccess.ReadWrite, Options = FileOptions.WriteThrough, Share = FileShare.ReadWrite });
             }
             catch (IOException ex)
             {
-                throw new IOException($"Failed to create profiler message log file at {logFilePath}", ex);
+                throw new IOException($"Failed to create profiler message log file at {_logFilePath}", ex);
             }
         }
 
@@ -44,6 +46,30 @@ internal void MessageHandler(byte[] data, int length)
 
         }
 
-        public void Dispose() => ((IDisposable)_profilerDumpWriter).Dispose();
+        #region Dispose implementation
+
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!_disposedValue)
+            {
+                if (disposing)
+                {
+                    // output the file path so user can find it (usefull in case of long running)
+                    Console.WriteLine($"{Environment.NewLine}Profiler log file: {_logFilePath}{Environment.NewLine}");
+
+                    _profilerDumpWriter.Dispose();
+                }
+
+                _disposedValue = true;
+            }
+        }
+
+        public void Dispose()
+        {
+            Dispose(disposing: true);
+            GC.SuppressFinalize(this);
+        }
+
+        #endregion
     }
 }

targets/netcore/nanoFramework.nanoCLR.Host/Profiler/ProfilerMessageProcessor.cs

@@ -14,33 +14,61 @@ namespace nanoFramework.nanoCLR.Host.Profiler
     internal class ProfilerMessageProcessor : IDisposable
     {
         private readonly StreamWriter _profileLogWriter;
+        private readonly string _logFilePath;
+        private bool _disposedValue;
 
         public ProfilerMessageProcessor()
         {
             // create output file for profiler messages
-            string _profileLogFileName = $"{Guid.NewGuid()}_{DateTime.Now.ToString("s").Replace(":", "_")}.log";
+            string _profileLogFileName = $"{Guid.NewGuid()}_{DateTime.Now.ToString("s").Replace(":", "_")}.txt";
 
-            string logFilePath = Path.Combine(Path.GetTempPath(), _profileLogFileName);
+            _logFilePath = Path.Combine(Path.GetTempPath(), _profileLogFileName);
 
             // inform user about the log file
-            Console.WriteLine($"Profiler output file: {logFilePath}");
+            Console.WriteLine($"{Environment.NewLine}Profiler output file: {_logFilePath}{Environment.NewLine}");
 
             try
             {
                 _profileLogWriter = new StreamWriter(
-                    logFilePath,
+                    _logFilePath,
                     new FileStreamOptions() { Mode = FileMode.Create, Access = FileAccess.ReadWrite, Options = FileOptions.WriteThrough, Share = FileShare.ReadWrite });
             }
             catch (IOException ex)
             {
-                throw new IOException($"Failed to create profiler log file at {logFilePath}", ex);
+                throw new IOException($"Failed to create profiler log file at {_logFilePath}", ex);
             }
         }
         internal void MessageHandler(string message)
         {
             _profileLogWriter.WriteLine(message);
+            // Ensure message is written immediately
+            _profileLogWriter.Flush();
         }
 
-        public void Dispose() => ((IDisposable)_profileLogWriter).Dispose();
+        #region Dispose implementation
+
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!_disposedValue)
+            {
+                if (disposing)
+                {
+                    // output the file path so user can find it (usefull in case of long running)
+                    Console.WriteLine($"{Environment.NewLine}Profiler output file: {_logFilePath}{Environment.NewLine}");
+
+                    _profileLogWriter.Dispose();
+                }
+
+                _disposedValue = true;
+            }
+        }
+
+        public void Dispose()
+        {
+            Dispose(disposing: true);
+            GC.SuppressFinalize(this);
+        }
+
+        #endregion
     }
 }