Skip to content
This repository has been archived by the owner on Dec 17, 2024. It is now read-only.

Release 3.1.2 - WindowsPerf GUI Extension Release Notes

Latest
Compare
Choose a tag to compare
@PrzemekWirkus PrzemekWirkus released this 29 Nov 15:40
dbcfd0a

Release Notes: WindowsPerf Visual Studio Extension v3.1.2

We are excited to announce the release of WindowsPerf Visual Studio Extension v3.0.1, which introduces significant new features and enhancements.

This version of the extension is compatible with WindowsPerf 3.8.0 only!

How to install the extension

See Getting started section of the main docs for more details.

Changes added in version 3.1.2

New Features

  • Add support for man command (#13)
  • Add support for WINDOWSPERF_PATH env variable (#17)
  • Add support for sample-display-long flag (#20)
  • Add support for displaying counting timeline iterations (#23)
  • Add support for sample-display-row flag (#24)
  • Add support for time units in timeline interval and timeout (#26)
  • Disassembly syntax highlighting (#30)
  • Add support for record_spawn_delay flag (#33)
  • Annotated symbols syntax highlighting (#34)

Bug fixes

  • Correctly handle null response of predefined groups of metrics (#12)
  • Fix filterable ComboBox key handeling (#16)
  • Fix importing of SPE json output (#31)
  • Make Sampling Settings dialog scrollable (#38)
  • Fix wperf.exe path selection from directory picker (#39)
  • Remove -- from generated command when there are no extra args or payload (#40)
  • Use PMU_CTL_QUERY_HW_CFG [core_num] to get cpu core count (#42)
  • Fix reading spe.data from inaccessible path (#44)

Documentation

  • Added source code annotations (#2)

Test

  • Added JSON parser tests (#35)

Arm Statistical Profiling Extension (SPE) sampling support

The extension now supports SPE sampling and SPE filters.

To run a SPE sample all you need to do is open the sampling settings ( View -> Sampling Explorer -> Sampling Settings (Cog wheel button)) then click on Enable SPE mode checkbox. This will change the event list dropbox to a filter list for the SPE command.

image

Prerequisites

To be able to run SPE on a device you need to satisfy a few conditions.

  1. You need to install WindowsPerf and WindowsPerf driver with SPE flag enabled. To do so you can download WindowsPerf from the release page and install the version under the SPE folder.
  2. Your arm CPU must have a Statistical Profiling Extension which has been available since the introduction of the Neoverse N1 CPU platform in 2019.
  3. You need to be running Windows On arm in Test Mode

Improved Windows Performance Analyzer (WPA) integration

In this version we added a new options page for setting WPA search directories. This helps the extension load our plugins from the correct directory
Also when opening a count in WPA we now check for the existence of our plugin under the name of WindowsPerf WPA plugin if the latter was not found we show an error message saying:

Could not detect WindowsPerf WPA Plugin. Please make sure the plugin is installed correctly..

or if WPA itself is not found:

WPA is not installed. Please make sure it's installed correctly and added to the PATH environment variable..

image

A new environment variable was introduced in the WindowsPerf installer that points to said folder under the name of: WPA_ADDITIONAL_SEARCH_DIRECTORIES this is the default option used by the extension

Other improvements:

  • Enhanced the list of metrics with the list of groups of metrics
  • Hardcoded the list of SPE filters in case WindowsPerf list version that is used still does not support the list of SPE filters.

Compatibility and Requirements

  • This version is compatible with Visual Studio 2022 (amd64) and 2022 (Arm64).

Documentation

  • You can find all the updated documentation and new tutorials in our Wiki.