WPERF-987 Spe detection

See merge request Linaro/WindowsPerf/vs-extension!106

=== ChangeLog ===

* chore: update lookup function to StartsWith instead of Contains

* feat: check for SPE support at launch

* refactor: wperfOptions

* feat: add check SPE support client method

* feat: add SPE support attribute in WperfDefaults

* feat: update wperf version output parser

Author: nader-zouaoui

WindowsPerfGUI/Options/WPerfOptions.cs

@@ -32,6 +32,7 @@
 using System.ComponentModel;
 using System.Runtime.InteropServices;
 using WindowsPerfGUI.SDK.WperfOutputs;
+using WindowsPerfGUI.ToolWindows.SamplingSetting;
 
 namespace WindowsPerfGUI.Options
 {
@@ -50,8 +51,45 @@ public class WPerfOptions : BaseOptionModel<WPerfOptions>
         public string WperfPath { get; set; } = "wperf.exe";
         public bool WperfVersionCheckIgnore { get; set; } = false;
         public bool IsWperfInitialized { get; set; } = false;
-
+        public bool HasSPESupport { get; set; } = false;
         public WperfVersion WperfCurrentVersion { get; set; }
         public WperfList WperfList { get; set; }
+        public void UpdateWperfVersion(WperfVersion wperfVersion)
+        {
+            IsWperfInitialized = true;
+            WperfCurrentVersion = wperfVersion;
+        }
+        public void UpdateWperfOptions(WperfVersion wperfVersion, WperfList wperfList)
+        {
+            UpdateWperfVersion(wperfVersion);
+            if (wperfList != null)
+            {
+                WperfList = wperfList;
+            }
+            Save();
+        }
+        public void UpdateWperfOptions(WperfVersion wperfVersion, bool hasSPESupport)
+        {
+            UpdateWperfVersion(wperfVersion);
+
+            HasSPESupport = hasSPESupport;
+            WperfDefaults.HasSPESupport = hasSPESupport;
+            Save();
+        }
+#nullable enable
+        public void UpdateWperfOptions(WperfVersion wperfVersion, WperfList? wperfList, bool? hasSPESupport)
+        {
+            UpdateWperfVersion(wperfVersion);
+            if (wperfList != null)
+            {
+                WperfList = wperfList;
+            }
+            if (hasSPESupport != null)
+            {
+                HasSPESupport = (bool)hasSPESupport;
+            }
+            Save();
+        }
+#nullable disable
     }
 }

WindowsPerfGUI/Options/WPerfPath.xaml.cs

@@ -96,6 +96,7 @@ private void ValidateButton_Click(object sender, RoutedEventArgs e)
                 if (errorWperfList != "")
                     throw new Exception(errorWperfList);
                 SetPredefinedEventsAndMetrics(wperfList, shouldForce: true);
+                WPerfOptions.Instance.UpdateWperfOptions(versions, wperfList);
             }
             catch (Exception ex)
             {
@@ -123,12 +124,13 @@ private void SetWperfVersion(WperfVersion wperfVersion, bool shouldForce = false
                 string component = item.component.Component;
                 string componentVersion = item.component.ComponentVersion;
                 string gitVersion = item.component.GitVersion;
+                string featureString = item.component.FeatureString;
 
                 MainStack.RowDefinitions.Add(new RowDefinition() { Height = GridLength.Auto });
 
                 TextBlock componentLabel = TextBlockFactory(component, offset);
                 TextBlock componentVersionLabel = TextBlockFactory(
-                    $"{componentVersion} ({gitVersion})",
+                    $"{componentVersion} ({gitVersion}) -- ${featureString}",
                     offset,
                     true
                 );
@@ -142,9 +144,6 @@ private void SetWperfVersion(WperfVersion wperfVersion, bool shouldForce = false
                 return;
             }
 
-            WPerfOptions.Instance.IsWperfInitialized = true;
-            WPerfOptions.Instance.WperfCurrentVersion = wperfVersion;
-            WPerfOptions.Instance.Save();
         }
 
         private void SetPredefinedEventsAndMetrics(WperfList wperfList, bool shouldForce = false)
@@ -156,8 +155,7 @@ private void SetPredefinedEventsAndMetrics(WperfList wperfList, bool shouldForce
                 return;
             }
 
-            WPerfOptions.Instance.WperfList = wperfList;
-            WPerfOptions.Instance.Save();
+
         }
 
         public static TextBlock TextBlockFactory(string text, int offset, bool isRight = false)

WindowsPerfGUI/SDK/WperfClient.cs

@@ -117,6 +117,35 @@ protected void InitProcess()
             return (serializedOutput, stdError);
         }
 
+        /// <summary>
+        /// This returns wether or not SPE is supported on this machine
+        /// it runs the command wperf -version --json and wperf test --json
+        /// it then checks for "spe_device.version_name" in the test results and the feature string in the version results
+        /// </summary>
+        /// <returns>
+        ///     bool
+        /// </returns>
+        public bool CheckIsSPESupported()
+        {
+            (WperfVersion versionSerializedOutput, _) = GetVersion();
+            foreach (var component in versionSerializedOutput.Components)
+            {
+                if (!component.FeatureString.Contains("+spe"))
+                {
+                    return false;
+                }
+            }
+
+            (WperfTest testSerializedOutput, _) = GetTest();
+
+            TestResult speDeviceConf = testSerializedOutput
+                .TestResults.Find(el => el.TestName == "spe_device.version_name");
+            if (speDeviceConf == null) { return false; }
+
+            return speDeviceConf.Result.StartsWith("FEAT_SPE");
+
+        }
+
         /// <summary>
         /// This returns the list of Wperf's predefined events and metrics
         /// it runs the command wperf list -v --json
@@ -219,7 +248,7 @@ public async Task StartCountingAsync()
             }
         }
 
-        static public List<CountingEvent> GetCountingEventsFromJSONFile(string filePath)
+        public static List<CountingEvent> GetCountingEventsFromJSONFile(string filePath)
         {
             List<CountingEvent> countingEvents = new();
 
@@ -244,7 +273,7 @@ static public List<CountingEvent> GetCountingEventsFromJSONFile(string filePath)
             return countingEvents;
         }
 
-        static private void ProcessSingleCount(
+        private static void ProcessSingleCount(
             WperfCounting count,
             List<CountingEvent> countingEvents,
             bool accumulatePerCoreAndEvent = false
@@ -284,12 +313,14 @@ static private void ProcessSingleCount(
         public EventHandler<(
             WperfSampling serializedOutput,
             string stdError
-        )> OnSamplingFinished { get; set; }
+        )> OnSamplingFinished
+        { get; set; }
 
         public EventHandler<(
             List<CountingEvent> countingEvents,
             string stdError
-        )> OnCountingFinished { get; set; }
+        )> OnCountingFinished
+        { get; set; }
 
         public (WperfSampling serializedOutput, string stdError) StopSampling()
         {

WindowsPerfGUI/SDK/WperfOutputs/WperfVersion.cs

@@ -28,8 +28,8 @@
 // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-using System.Collections.Generic;
 using Newtonsoft.Json;
+using System.Collections.Generic;
 
 namespace WindowsPerfGUI.SDK.WperfOutputs
 {
@@ -49,6 +49,9 @@ public partial class Version
 
         [JsonProperty("GitVer")]
         public string GitVersion { get; set; }
+
+        [JsonProperty("FeatureString")]
+        public string FeatureString { get; set; }
     }
 
     public partial class WperfVersion

WindowsPerfGUI/ToolWindows/MyToolWindowControl.xaml

@@ -57,6 +57,5 @@
             Padding="4"
             Placeholder="File path... " />
         <Button Click="Button_Click" Content="{x:Static resx:MainLanguagePack.ToolWindow}" />
-        <Button Click="Button_Click_1" Content="Reset" />
     </StackPanel>
 </UserControl>

WindowsPerfGUI/ToolWindows/MyToolWindowControl.xaml.cs

@@ -30,9 +30,7 @@
 
 
 using System.Windows.Controls;
-using WindowsPerfGUI.SDK.WperfOutputs;
-using WindowsPerfGUI.ToolWindows.SamplingExplorer;
-using WindowsPerfGUI.ToolWindows.SamplingExplorer.LineHighlighting;
+using WindowsPerfGUI.Options;
 
 namespace WindowsPerfGUI.ToolWindows
 {
@@ -42,48 +40,10 @@ public MyToolWindowControl()
         {
             InitializeComponent();
         }
-
-        private static readonly FormattedSamplingResults FormattedSamplingResults = new();
-
-        private static void HighlightEditor(SamplingSection samplingSection)
-        {
-            if (
-                samplingSection.SectionType
-                != SamplingSection.SamplingSectionType.SAMPLE_SOURCE_CODE
-            )
-            {
-                foreach (SamplingSection child in samplingSection.Children)
-                {
-                    HighlightEditor(child);
-                }
-            }
-
-            if (!samplingSection.IsFileExists)
-            {
-                return;
-            }
-
-            HighlighterDict.AddFileToHighlight(samplingSection);
-        }
-
-        private void Test()
-        {
-            FormattedSamplingResults.FormatSamplingResults(
-                WperfSampling.FromJson(
-                    "{\r\n\"sampling\": {\r\n\"pe_file\": \"C:\\\\Users\\\\nader\\\\OneDrive\\\\Desktop\\\\sampling\\\\windowsPerfSample\\\\WindowsPerfSample.exe\",\r\n\"pdb_file\": \"C:\\\\Users\\\\nader\\\\OneDrive\\\\Desktop\\\\sampling\\\\windowsPerfSample\\\\WindowsPerfSample.pdb\",\r\n\"sample_display_row\": 50,\r\n\"samples_generated\": 60,\r\n\"samples_dropped\": 0,\r\n\"base_address\": 140697426990076,\r\n\"runtime_delta\": 140692058210304,\r\n\"modules\":[{\"name\":\"KERNEL32.DLL\",\"address\":140726913466368,\"path\":\"C:\\\\Windows\\\\System32\\\\KERNEL32.DLL\"},{\"name\":\"KERNELBASE.dll\",\"address\":140726849830912,\"path\":\"C:\\\\Windows\\\\System32\\\\KERNELBASE.dll\"},{\"name\":\"VCRUNTIME140D.dll\",\"address\":140721964122112,\"path\":\"C:\\\\Windows\\\\SYSTEM32\\\\VCRUNTIME140D.dll\"},{\"name\":\"WindowsPerfSample.exe\",\"address\":140697426919424,\"path\":\"C:\\\\Users\\\\nader\\\\OneDrive\\\\Desktop\\\\sampling\\\\windowsPerfSample\\\\WindowsPerfSample.exe\"},{\"name\":\"ntdll.dll\",\"address\":140726927622144,\"path\":\"C:\\\\Windows\\\\SYSTEM32\\\\ntdll.dll\"},{\"name\":\"ucrtbased.dll\",\"address\":140721524113408,\"path\":\"C:\\\\Windows\\\\SYSTEM32\\\\ucrtbased.dll\"}],\r\n\"modules_info\": [{\"sections\":[{\"section\":\".textbss\",\"offset\":4096,\"virtual_size\":65536},{\"section\":\".text\",\"offset\":69632,\"virtual_size\":30657},{\"section\":\".rdata\",\"offset\":102400,\"virtual_size\":6791},{\"section\":\".data\",\"offset\":110592,\"virtual_size\":528},{\"section\":\".pdata\",\"offset\":114688,\"virtual_size\":5360},{\"section\":\".idata\",\"offset\":122880,\"virtual_size\":2559},{\"section\":\".msvcjmc\",\"offset\":126976,\"virtual_size\":275},{\"section\":\".00cfg\",\"offset\":131072,\"virtual_size\":337},{\"section\":\".rsrc\",\"offset\":135168,\"virtual_size\":1084},{\"section\":\".reloc\",\"offset\":139264,\"virtual_size\":431}],\"module\":\"WindowsPerfSample.exe\",\"pdb_file\":\"C:\\\\Users\\\\nader\\\\OneDrive\\\\Desktop\\\\sampling\\\\windowsPerfSample\\\\WindowsPerfSample.pdb\",\"pe_name\":\"C:\\\\Users\\\\nader\\\\OneDrive\\\\Desktop\\\\sampling\\\\windowsPerfSample\\\\WindowsPerfSample.exe\"}],\r\n\"events\": [{\"type\":\"vfp_spec\",\"samples\":[{\"overhead\":65,\"count\":39,\"symbol\":\"simd_hot\"},{\"overhead\":30,\"count\":18,\"symbol\":\"df_hot\"},{\"overhead\":3.33333,\"count\":2,\"symbol\":\"__CheckForDebuggerJustMyCode\"},{\"overhead\":1.66667,\"count\":1,\"symbol\":\"unknown\"}],\"interval\":200000,\"printed_sample_num\":4,\r\n\"pcs\":[{\"address\":140697426997464,\"count\":9},{\"address\":140697426997508,\"count\":7},{\"address\":140697426997500,\"count\":5},{\"address\":140697426997480,\"count\":4},{\"address\":140697426997468,\"count\":4},{\"address\":140697426997488,\"count\":2},{\"address\":140697426997460,\"count\":2},{\"address\":140697426997496,\"count\":2},{\"address\":140697426997492,\"count\":1},{\"address\":140697426997516,\"count\":1},{\"address\":140697426997188,\"count\":14},{\"address\":140697426997176,\"count\":1},{\"address\":140697426997216,\"count\":1},{\"address\":140697426997196,\"count\":1},{\"address\":140697426997192,\"count\":1},{\"address\":140697426998368,\"count\":1},{\"address\":140697426998452,\"count\":1},{\"address\":140726745318480,\"count\":1}],\r\n\"annotate\": [{\"function_name\": \"simd_hot\",\r\n\"source_code\":[{\"line_number\":53,\"hits\":37,\"filename\":\"C:\\\\Users\\\\nader\\\\source\\\\repos\\\\windowsperfsample\\\\lib.c\"},{\"line_number\":52,\"hits\":2,\"filename\":\"C:\\\\Users\\\\nader\\\\source\\\\repos\\\\windowsperfsample\\\\lib.c\"}]},\r\n{\"function_name\": \"df_hot\",\r\n\"source_code\":[{\"line_number\":15732480,\"hits\":18,\"filename\":\"C:\\\\Users\\\\nader\\\\source\\\\repos\\\\windowsperfsample\\\\lib.c\"}]},\r\n{\"function_name\": \"__CheckForDebuggerJustMyCode\",\r\n\"source_code\":[{\"line_number\":23,\"hits\":1,\"filename\":\"D:\\\\a\\\\_work\\\\1\\\\s\\\\src\\\\vctools\\\\crt\\\\vcstartup\\\\src\\\\misc\\\\debugger_jmc.c\"},{\"line_number\":27,\"hits\":1,\"filename\":\"D:\\\\a\\\\_work\\\\1\\\\s\\\\src\\\\vctools\\\\crt\\\\vcstartup\\\\src\\\\misc\\\\debugger_jmc.c\"}]}]}\r\n]}\r\n}"
-                )
-            );
-            FormattedSamplingResults.RootSampledEvent.ForEach(HighlightEditor);
-        }
-
         private void Button_Click(object sender, System.Windows.RoutedEventArgs e)
         {
-            Test();
-        }
-
-        private void Button_Click_1(object sender, System.Windows.RoutedEventArgs e)
-        {
-            HighlighterDict.Clear();
+            bool speSupport = WPerfOptions.Instance.HasSPESupport;
+            Debug.WriteLine(speSupport);
         }
     }
 }

WindowsPerfGUI/Utils/WperfDefaults.cs

@@ -33,7 +33,7 @@ namespace WindowsPerfGUI.ToolWindows.SamplingSetting
     static class WperfDefaults
     {
         public const string WPERF_MIN_VERSION = "3.8.0";
-
+        public static bool HasSPESupport = false;
 #nullable enable
         public static string? Frequency;
         public static int? TotalGPCNum;

WindowsPerfGUI/WindowsPerfGUIPackage.cs

@@ -107,9 +107,8 @@ protected override async Task OnAfterPackageLoadedAsync(CancellationToken cancel
                 {
                     (WperfVersion versions, string stdVersionError) = wperfClient.GetVersion();
                     if (!string.IsNullOrEmpty(stdVersionError)) throw new Exception("Unable to get WindowsPerf version");
-
-                    WPerfOptions.Instance.WperfCurrentVersion = versions;
-                    await WPerfOptions.Instance.SaveAsync();
+                    bool speSupport = wperfClient.CheckIsSPESupported();
+                    WPerfOptions.Instance.UpdateWperfOptions(versions, speSupport);
                     string wperfVersion = versions.Components.FirstOrDefault().ComponentVersion;
                     if (wperfVersion != WperfDefaults.WPERF_MIN_VERSION)
                         await VS.MessageBox.ShowWarningAsync(