Merge pull request #1385 from microsoft/revert-1384-main

Revert "Merge main into 'release-cpptools' for v1.15.0"

Author: gc46

src/AndroidDebugLauncher/Launcher.cs

@@ -459,7 +459,7 @@ private LaunchOptions SetupForDebuggingWorker(CancellationToken token)
 
                 launchOptions.DebuggerMIMode = MIMode.Gdb;
 
-                launchOptions.VisualizerFiles.Add("Microsoft.Android.natvis");
+                launchOptions.VisualizerFile = "Microsoft.Android.natvis";
                 launchOptions.WaitDynamicLibLoad = _launchOptions.WaitDynamicLibLoad;
 
                 return launchOptions;

src/DebugEngineHost/HostNatvisProject.cs

@@ -104,7 +104,7 @@ public static IDisposable WatchNatvisOptionSetting(HostConfigurationStore config
                             IDisposable disposable = rmw.CurrentMonitor;
 
                             // Watch NatvisDiagnostic section
-                            rmw = new RegisterMonitorWrapper(CreateAndStartNatvisDiagnosticMonitor(checkForSection, natvisLogger));
+                            rmw = new RegisterMonitorWrapper(CreateAndStartNatvisDiagnosticMonitor(natvisDiagnosticSection, natvisLogger));
 
                             disposable.Dispose();
                         }

src/DebugEngineHost/RegistryMonitor.cs

@@ -47,15 +47,14 @@ private static extern int RegNotifyChangeKeyValue(SafeRegistryHandle hKey, bool
 
         #endregion
 
-        private readonly HostConfigurationSection _section;
+        private HostConfigurationSection _section;
         private readonly bool _watchSubtree;
 
-        // Set when monitoring is stopped
-        private AutoResetEvent _stoppedEvent;
+        // Set when registry value is changed
+        private AutoResetEvent m_changeEvent;
 
-        // Members to handle multiple stop calls.
-        private bool _isStopped = false;
-        private readonly object _stopLock = new object();
+        // Set when monitoring is stopped
+        private AutoResetEvent m_stoppedEvent;
 
         /// <summary>
         /// Occurs when the specified registry key has changed.
@@ -81,13 +80,9 @@ public void Start()
 
         public void Stop()
         {
-            lock (_stopLock)
+            if (m_stoppedEvent != null)
             {
-                if (!_isStopped)
-                {
-                    _stoppedEvent?.Set();
-                    _isStopped = true;
-                }
+                m_stoppedEvent.Set();
             }
         }
 
@@ -98,52 +93,53 @@ private void Monitor()
             bool stopped = false;
             try
             {
-                _stoppedEvent = new AutoResetEvent(false);
-                using (AutoResetEvent registryChangedEvent = new AutoResetEvent(false))
-                {
-                    IntPtr handle = registryChangedEvent.SafeWaitHandle.DangerousGetHandle();
+                m_stoppedEvent = new AutoResetEvent(false);
+                m_changeEvent = new AutoResetEvent(false);
 
-                    int errorCode = RegNotifyChangeKeyValue(_section.Handle, _watchSubtree, RegChangeNotifyFilter.REG_NOTIFY_CHANGE_NAME | RegChangeNotifyFilter.REG_NOTIFY_CHANGE_LAST_SET, handle, true);
-                    if (errorCode != 0) // 0 is ERROR_SUCCESS
-                    {
-                        _nativsLogger?.WriteLine(LogLevel.Error, Resource.Error_WatchRegistry, errorCode);
-                    }
-                    else
+                IntPtr handle = m_changeEvent.SafeWaitHandle.DangerousGetHandle();
+
+                int errorCode = RegNotifyChangeKeyValue(_section.Handle, _watchSubtree, RegChangeNotifyFilter.REG_NOTIFY_CHANGE_NAME | RegChangeNotifyFilter.REG_NOTIFY_CHANGE_LAST_SET, handle, true);
+                if (errorCode != 0) // 0 is ERROR_SUCCESS
+                {
+                    _nativsLogger?.WriteLine(LogLevel.Error, Resource.Error_WatchRegistry, errorCode);
+                }
+                else
+                {
+                    while (!stopped)
                     {
-                        while (!stopped)
-                        {
-                            int waitResult = WaitHandle.WaitAny(new WaitHandle[] { _stoppedEvent, registryChangedEvent });
+                        int waitResult = WaitHandle.WaitAny(new WaitHandle[] { m_stoppedEvent, m_changeEvent });
 
-                            if (waitResult == 0)
-                            {
-                                stopped = true;
-                            }
-                            else
+                        if (waitResult == 0)
+                        {
+                            stopped = true;
+                        }
+                        else
+                        {
+                            errorCode = RegNotifyChangeKeyValue(_section.Handle, _watchSubtree, RegChangeNotifyFilter.REG_NOTIFY_CHANGE_NAME | RegChangeNotifyFilter.REG_NOTIFY_CHANGE_LAST_SET, handle, true);
+                            if (errorCode != 0) // 0 is ERROR_SUCCESS
                             {
-                                errorCode = RegNotifyChangeKeyValue(_section.Handle, _watchSubtree, RegChangeNotifyFilter.REG_NOTIFY_CHANGE_NAME | RegChangeNotifyFilter.REG_NOTIFY_CHANGE_LAST_SET, handle, true);
-                                if (errorCode != 0) // 0 is ERROR_SUCCESS
-                                {
-                                    _nativsLogger?.WriteLine(LogLevel.Error, Resource.Error_WatchRegistry, errorCode);
-                                    break;
-                                }
-                                RegChanged?.Invoke(this, null);
+                                _nativsLogger?.WriteLine(LogLevel.Error, Resource.Error_WatchRegistry, errorCode);
+                                break;
                             }
+                            RegChanged?.Invoke(this, null);
                         }
                     }
                 }
             }
             finally
             {
-                _stoppedEvent.Dispose();
-                _stoppedEvent = null;
-
                 _section.Dispose();
+                m_stoppedEvent?.Dispose();
+                m_changeEvent?.Dispose();
+
+                m_stoppedEvent = null;
+                m_changeEvent = null;
             }
         }
 
         public void Dispose()
         {
-            Stop(); // Stopping the monitor will dispose of the AutoResetEvent and HostConfigurationSection
+            m_stoppedEvent?.Dispose();
         }
     }
 }

src/MICore/JsonLaunchOptions.cs

@@ -39,11 +39,10 @@ public abstract partial class BaseOptions
         public string TargetArchitecture { get; set; }
 
         /// <summary>
-        /// .natvis files to be used when debugging this process. This option is not compatible with GDB pretty printing. Please also see "showDisplayString" if using this setting.
+        /// .natvis file to be used when debugging this process. This option is not compatible with GDB pretty printing. Please also see "showDisplayString" if using this setting.
         /// </summary>
         [JsonProperty("visualizerFile", DefaultValueHandling = DefaultValueHandling.Ignore)]
-        [JsonConverter(typeof(VisualizerFileConverter))]
-        public List<string> VisualizerFile { get; set; }
+        public string VisualizerFile { get; set; }
 
         /// <summary>
         /// When a visualizerFile is specified, showDisplayString will enable the display string. Turning this option on can cause slower performance during debugging.
@@ -124,37 +123,6 @@ public abstract partial class BaseOptions
         public UnknownBreakpointHandling? UnknownBreakpointHandling { get; set; }
     }
 
-    internal class VisualizerFileConverter : JsonConverter
-    {
-        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
-        {
-            List<string> visualizerFile = new List<string>();
-            if (reader.TokenType == JsonToken.StartArray)
-            {
-                visualizerFile = serializer.Deserialize<List<string>>(reader);
-            }
-            else if (reader.TokenType == JsonToken.String)
-            {
-                visualizerFile.Add(reader.Value.ToString());
-            }
-            else
-            {
-                throw new JsonReaderException(MICoreResources.Error_IncorrectVisualizerFileFormat);
-            }
-            return visualizerFile;
-        }
-
-        public override bool CanConvert(Type objectType)
-        {
-            throw new NotImplementedException();
-        }
-
-        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
-        {
-            throw new NotImplementedException();
-        }
-    }
-
     public partial class AttachOptions : BaseOptions
     {
         #region Public Properties for Serialization
@@ -176,7 +144,7 @@ public AttachOptions(
             int processId,
             string type = null,
             string targetArchitecture = null,
-            List<string> visualizerFile = null,
+            string visualizerFile = null,
             bool? showDisplayString = null,
             string additionalSOLibSearchPath = null,
             string MIMode = null,
@@ -440,7 +408,7 @@ public LaunchOptions(
             List<SetupCommand> postRemoteConnectCommands = null,
             List<SetupCommand> customLaunchSetupCommands = null,
             LaunchCompleteCommand? launchCompleteCommand = null,
-            List<string> visualizerFile = null,
+            string visualizerFile = null,
             bool? showDisplayString = null,
             List<Environment> environment = null,
             string additionalSOLibSearchPath = null,

src/MICore/LaunchOptions.cs

@@ -960,10 +960,19 @@ public string AdditionalSOLibSearchPath
             }
         }
 
+        private string _visualizerFile;
         /// <summary>
-        /// Collection of natvis files to use when evaluating
+        /// [Optional] Natvis file name - from install location
         /// </summary>
-        public List<string> VisualizerFiles { get; } = new List<string>();
+        public string VisualizerFile
+        {
+            get { return _visualizerFile; }
+            set
+            {
+                VerifyCanModifyProperty(nameof(VisualizerFile));
+                _visualizerFile = value;
+            }
+        }
 
         private bool _waitDynamicLibLoad = true;
         /// <summary>
@@ -1570,9 +1579,9 @@ private void Merge(AttachOptionsForConnection suppOptions)
             {
                 DebugChildProcesses = suppOptions.DebugChildProcesses;
             }
-            if (!this.VisualizerFiles.Contains(suppOptions.VisualizerFile))
+            if (string.IsNullOrWhiteSpace(VisualizerFile))
             {
-                this.VisualizerFiles.Add(suppOptions.VisualizerFile);
+                VisualizerFile = suppOptions.VisualizerFile;
             }
             if (suppOptions.ShowDisplayStringSpecified)
             {
@@ -1762,10 +1771,7 @@ protected void InitializeCommonOptions(Json.LaunchOptions.BaseOptions options)
                 this.TargetArchitecture = ConvertTargetArchitectureAttribute(options.TargetArchitecture);
             }
 
-            if (options.VisualizerFile != null && options.VisualizerFile.Count > 0)
-            {
-                this.VisualizerFiles.AddRange(options.VisualizerFile);
-            }
+            this.VisualizerFile = options.VisualizerFile;
             this.ShowDisplayString = options.ShowDisplayString.GetValueOrDefault(false);
 
             this.AdditionalSOLibSearchPath = String.IsNullOrEmpty(this.AdditionalSOLibSearchPath) ?
@@ -1835,8 +1841,8 @@ protected void InitializeCommonOptions(Xml.LaunchOptions.BaseLaunchOptions sourc
             if (string.IsNullOrEmpty(this.WorkingDirectory))
                 this.WorkingDirectory = source.WorkingDirectory;
 
-            if (!string.IsNullOrEmpty(source.VisualizerFile))
-                this.VisualizerFiles.Add(source.VisualizerFile);
+            if (string.IsNullOrEmpty(this.VisualizerFile))
+                this.VisualizerFile = source.VisualizerFile;
 
             this.ShowDisplayString = source.ShowDisplayString;
             this.WaitDynamicLibLoad = source.WaitDynamicLibLoad;

src/MICore/MICoreResources.Designer.cs

@@ -326,7 +326,4 @@ Error: {1}</value>
   <data name="Error_SourceFileMapInvalidEditorPath" xml:space="preserve">
     <value>'editorPath' can not be null or empty</value>
   </data>
-  <data name="Error_IncorrectVisualizerFileFormat" xml:space="preserve">
-    <value>'visualizerFile' must be a string or array of strings.</value>
-  </data>
 </root>

src/MICore/MICoreResources.resx

@@ -263,7 +263,7 @@ internal void VerifyCoreApisPresent()
             launchOptions.WorkingDirectory = "/home/user";
             launchOptions.DebuggerMIMode = MIMode.Gdb;
             launchOptions.WaitDynamicLibLoad = false;
-            launchOptions.VisualizerFiles.Add(@"c:\myproject\file.natvis");
+            launchOptions.VisualizerFile = @"c:\myproject\file.natvis";
             launchOptions.SourceMap = new ReadOnlyCollection<SourceMapEntry>(new List<SourceMapEntry>());
             launchOptions.Environment = new ReadOnlyCollection<EnvironmentEntry>(new List<EnvironmentEntry>());
             Microsoft.DebugEngineHost.HostConfigurationStore configStore = null;

src/MICoreUnitTests/BasicLaunchOptionsTests.cs

@@ -543,7 +543,7 @@ private async Task EnsureModulesLoaded()
         public async Task Initialize(HostWaitLoop waitLoop, CancellationToken token)
         {
             bool success = false;
-            Natvis.Initialize(_launchOptions.VisualizerFiles);
+            Natvis.Initialize(_launchOptions.VisualizerFile);
             int total = 1;
 
             await this.WaitForConsoleDebuggerInitialize(token);